asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs-util: support models implemented with DML in typedoc custom plugins (#7847)

Browse Source 
- Support generating reference for models implemented with DML
- Support resolving and generating mermaid diagram for relations

The Currency Module was used an example so its reference is generated to showcase the work of this PR.
This commit is contained in:
Shahed Nasser
2024-07-01 10:34:51 +03:00
committed by GitHub
parent b62f23ea00
commit 1f360a3245
59 changed files with 1455 additions and 1005 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/generated/files-map.mjs
+20 -12
View File
@@ -1888,16 +1888,16 @@ export const filesMap = [
"pathname": "/references/cart_models/classes/cart_models.ShippingMethodTaxLine"
},
{
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.list/page.mdx",
"pathname": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.list"
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCountCurrencies/page.mdx",
"pathname": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCountCurrencies"
},
{
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCount/page.mdx",
"pathname": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCount"
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listCurrencies/page.mdx",
"pathname": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listCurrencies"
},
{
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.retrieve/page.mdx",
"pathname": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.retrieve"
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.retrieveCurrency/page.mdx",
"pathname": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.retrieveCurrency"
},
{
"filePath": "/www/apps/resources/references/currency/IMessageAggregator/methods/currency.IMessageAggregator.clearMessages/page.mdx",
@@ -1959,10 +1959,18 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/currency/interfaces/currency.MessageAggregatorFormat/page.mdx",
"pathname": "/references/currency/interfaces/currency.MessageAggregatorFormat"
},
{
"filePath": "/www/apps/resources/references/currency/types/currency.EventMetadata/page.mdx",
"pathname": "/references/currency/types/currency.EventMetadata"
},
{
"filePath": "/www/apps/resources/references/currency/types/currency.JoinerRelationship/page.mdx",
"pathname": "/references/currency/types/currency.JoinerRelationship"
},
{
"filePath": "/www/apps/resources/references/currency/types/currency.LinkModulesExtraFields/page.mdx",
"pathname": "/references/currency/types/currency.LinkModulesExtraFields"
},
{
"filePath": "/www/apps/resources/references/currency/types/currency.Message/page.mdx",
"pathname": "/references/currency/types/currency.Message"
@@ -1971,10 +1979,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/references/currency/types/currency.MessageBody/page.mdx",
"pathname": "/references/currency/types/currency.MessageBody"
},
{
"filePath": "/www/apps/resources/references/currency/types/currency.MessageFormat/page.mdx",
"pathname": "/references/currency/types/currency.MessageFormat"
},
{
"filePath": "/www/apps/resources/references/currency/types/currency.ModuleJoinerConfig/page.mdx",
"pathname": "/references/currency/types/currency.ModuleJoinerConfig"
@@ -1984,8 +1988,12 @@ export const filesMap = [
"pathname": "/references/currency/types/currency.ModuleJoinerRelationship"
},
{
"filePath": "/www/apps/resources/references/currency_models/classes/currency_models.Currency/page.mdx",
"pathname": "/references/currency_models/classes/currency_models.Currency"
"filePath": "/www/apps/resources/references/currency/types/currency.RawMessageFormat/page.mdx",
"pathname": "/references/currency/types/currency.RawMessageFormat"
},
{
"filePath": "/www/apps/resources/references/currency_models/variables/currency_models.Currency/page.mdx",
"pathname": "/references/currency_models/variables/currency_models.Currency"
},
{
"filePath": "/www/apps/resources/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.addAddresses/page.mdx",
www/apps/resources/generated/sidebar.mjs
+7 -7
View File
@@ -936,22 +936,22 @@ export const generatedSidebar = [
{
"loaded": true,
"isPathHref": true,
"path": "/references/currency/list",
"title": "list",
"path": "/references/currency/listAndCountCurrencies",
"title": "listAndCountCurrencies",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/currency/listAndCount",
"title": "listAndCount",
"path": "/references/currency/listCurrencies",
"title": "listCurrencies",
"children": []
},
{
"loaded": true,
"isPathHref": true,
"path": "/references/currency/retrieve",
"title": "retrieve",
"path": "/references/currency/retrieveCurrency",
"title": "retrieveCurrency",
"children": []
}
]
@@ -971,7 +971,7 @@ export const generatedSidebar = [
"isPathHref": true,
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/currency_models/classes",
"autogenerate_path": "/references/currency_models/variables",
"children": [
{
"loaded": true,
www/apps/resources/generated/slug-changes.mjs
+11 -11
View File
@@ -405,19 +405,19 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/cart_models/classes/cart_models.ShippingMethodTaxLine/page.mdx"
},
{
"origSlug": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.list",
"newSlug": "/references/currency/list",
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.list/page.mdx"
"origSlug": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCountCurrencies",
"newSlug": "/references/currency/listAndCountCurrencies",
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCountCurrencies/page.mdx"
},
{
"origSlug": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCount",
"newSlug": "/references/currency/listAndCount",
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listAndCount/page.mdx"
"origSlug": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listCurrencies",
"newSlug": "/references/currency/listCurrencies",
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.listCurrencies/page.mdx"
},
{
"origSlug": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.retrieve",
"newSlug": "/references/currency/retrieve",
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.retrieve/page.mdx"
"origSlug": "/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.retrieveCurrency",
"newSlug": "/references/currency/retrieveCurrency",
"filePath": "/www/apps/resources/references/currency/ICurrencyModuleService/methods/currency.ICurrencyModuleService.retrieveCurrency/page.mdx"
},
{
"origSlug": "/references/currency/interfaces/currency.ICurrencyModuleService",
@@ -425,9 +425,9 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/currency/interfaces/currency.ICurrencyModuleService/page.mdx"
},
{
"origSlug": "/references/currency_models/classes/currency_models.Currency",
"origSlug": "/references/currency_models/variables/currency_models.Currency",
"newSlug": "/references/currency/models/Currency",
"filePath": "/www/apps/resources/references/currency_models/classes/currency_models.Currency/page.mdx"
"filePath": "/www/apps/resources/references/currency_models/variables/currency_models.Currency/page.mdx"
},
{
"origSlug": "/references/customer/ICustomerModuleService/methods/customer.ICustomerModuleService.addAddresses",