From 2d127a4c677d61b2a343db47b5149c89a6ad252c Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 14 Dec 2023 18:28:23 +0000
Subject: [PATCH] chore(docs): Generated References (#5881)
Generated the following references:
- `EventBusTypes`
- `IPricingModuleService`
- `ModulesSdkTypes`
- `PriceListWorkflow`
- `fulfillment`
- `js_client`
- `medusa`
- `modules`
- `pricing`
- `services`
- `types`
- `workflows`
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
---
docs-util/packages/typedoc-config/_merger.js | 7 +++-
.../src/render-utils.ts | 4 +--
.../helpers/has-more-than-one-signature.ts | 5 ++-
.../src/resources/helpers/if-show-returns.ts | 6 +++-
.../src/resources/helpers/signature-title.ts | 4 +++
.../resources/partials/member.declaration.hbs | 2 +-
.../src/resources/partials/member.hbs | 2 +-
.../resources/partials/member.signature.hbs | 4 +--
.../get-correct-declaration-reflection.ts | 33 +++++++++++++++++++
...ricing.IPricingModuleService.addPrices.mdx | 16 ++++-----
...pricing.IPricingModuleService.addRules.mdx | 16 ++++-----
.../pricing.IPricingModuleService.create.mdx | 16 ++++-----
.../classes/medusa.AdminCreateCondition.mdx | 4 ---
.../classes/medusa.AdminCreateUserRequest.mdx | 4 ---
...eteCustomerGroupsGroupCustomerBatchReq.mdx | 4 ---
...DiscountConditionsConditionBatchParams.mdx | 4 ---
...ntsDiscountConditionsConditionBatchReq.mdx | 6 ----
...ountsDiscountConditionsConditionParams.mdx | 4 ---
...sa.AdminDeletePriceListPricesPricesReq.mdx | 4 ---
...ceListsPriceListProductsPricesBatchReq.mdx | 4 ---
...tCategoriesCategoryProductsBatchParams.mdx | 4 ---
...ductCategoriesCategoryProductsBatchReq.mdx | 4 ---
...a.AdminDeleteProductsFromCollectionReq.mdx | 4 ---
...PublishableApiKeySalesChannelsBatchReq.mdx | 4 ---
...teSalesChannelsChannelProductsBatchReq.mdx | 4 ---
...eSalesChannelsChannelStockLocationsReq.mdx | 4 ---
...eleteTaxRatesTaxRateProductTypesParams.mdx | 4 ---
...inDeleteTaxRatesTaxRateProductTypesReq.mdx | 6 ----
...minDeleteTaxRatesTaxRateProductsParams.mdx | 4 ---
....AdminDeleteTaxRatesTaxRateProductsReq.mdx | 4 ---
...teTaxRatesTaxRateShippingOptionsParams.mdx | 4 ---
...eleteTaxRatesTaxRateShippingOptionsReq.mdx | 4 ---
.../classes/medusa.AdminDeleteUploadsReq.mdx | 4 ---
.../medusa.AdminGetBatchPaginationParams.mdx | 4 ---
.../classes/medusa.AdminGetBatchParams.mdx | 4 ---
...sa.AdminGetCollectionsPaginationParams.mdx | 4 ---
.../medusa.AdminGetCollectionsParams.mdx | 4 ---
.../medusa.AdminGetCurrenciesParams.mdx | 4 ---
...dusa.AdminGetCustomerGroupsGroupParams.mdx | 4 ---
.../medusa.AdminGetCustomerGroupsParams.mdx | 4 ---
.../medusa.AdminGetCustomersParams.mdx | 4 ---
.../classes/medusa.AdminGetDiscountParams.mdx | 4 ---
...sa.AdminGetDiscountsDiscountCodeParams.mdx | 4 ---
...ountsDiscountConditionsConditionParams.mdx | 4 ---
...sa.AdminGetDiscountsDiscountRuleParams.mdx | 4 ---
.../medusa.AdminGetDiscountsParams.mdx | 18 ----------
.../medusa.AdminGetDraftOrdersParams.mdx | 4 ---
.../medusa.AdminGetGiftCardsParams.mdx | 4 ---
...InventoryItemsItemLocationLevelsParams.mdx | 4 ---
...edusa.AdminGetInventoryItemsItemParams.mdx | 4 ---
.../medusa.AdminGetInventoryItemsParams.mdx | 18 ----------
.../classes/medusa.AdminGetNotesParams.mdx | 4 ---
.../medusa.AdminGetNotificationsParams.mdx | 4 ---
.../medusa.AdminGetOrdersOrderParams.mdx | 4 ---
.../classes/medusa.AdminGetOrdersParams.mdx | 4 ---
...edusa.AdminGetPaymentCollectionsParams.mdx | 4 ---
...dusa.AdminGetPriceListPaginationParams.mdx | 4 ---
...inGetPriceListsPriceListProductsParams.mdx | 18 ----------
...medusa.AdminGetProductCategoriesParams.mdx | 18 ----------
.../medusa.AdminGetProductCategoryParams.mdx | 4 ---
.../classes/medusa.AdminGetProductParams.mdx | 4 ---
...sa.AdminGetProductTagsPaginationParams.mdx | 4 ---
.../medusa.AdminGetProductTagsParams.mdx | 4 ---
.../medusa.AdminGetProductTypesParams.mdx | 4 ---
.../classes/medusa.AdminGetProductsParams.mdx | 4 ---
.../medusa.AdminGetProductsVariantsParams.mdx | 4 ---
...medusa.AdminGetRegionsPaginationParams.mdx | 4 ---
.../classes/medusa.AdminGetRegionsParams.mdx | 4 ---
...nGetRegionsRegionFulfillmentOptionsRes.mdx | 6 ----
.../medusa.AdminGetReservationsParams.mdx | 18 ----------
.../classes/medusa.AdminGetReturnsParams.mdx | 4 ---
.../medusa.AdminGetSalesChannelsParams.mdx | 18 ----------
.../medusa.AdminGetShippingOptionsParams.mdx | 4 ---
...a.AdminGetStockLocationsLocationParams.mdx | 4 ---
.../medusa.AdminGetStockLocationsParams.mdx | 18 ----------
.../classes/medusa.AdminGetSwapsParams.mdx | 4 ---
.../classes/medusa.AdminGetTaxRatesParams.mdx | 4 ---
.../medusa.AdminGetTaxRatesTaxRateParams.mdx | 4 ---
.../classes/medusa.AdminGetVariantParams.mdx | 4 ---
.../classes/medusa.AdminGetVariantsParams.mdx | 4 ---
.../medusa.AdminListCustomerSelector.mdx | 4 ---
.../medusa.AdminListOrdersSelector.mdx | 4 ---
...nPostAnalyticsConfigAnalyticsConfigReq.mdx | 4 ---
.../medusa.AdminPostAnalyticsConfigReq.mdx | 4 ---
.../classes/medusa.AdminPostAuthReq.mdx | 4 ---
.../classes/medusa.AdminPostBatchesReq.mdx | 4 ---
...dusa.AdminPostCollectionsCollectionReq.mdx | 4 ---
.../medusa.AdminPostCollectionsReq.mdx | 4 ---
.../medusa.AdminPostCurrenciesCurrencyReq.mdx | 4 ---
...stCustomerGroupsGroupCustomersBatchReq.mdx | 4 ---
...medusa.AdminPostCustomerGroupsGroupReq.mdx | 4 ---
.../medusa.AdminPostCustomerGroupsReq.mdx | 4 ---
.../medusa.AdminPostCustomersCustomerReq.mdx | 4 ---
.../classes/medusa.AdminPostCustomersReq.mdx | 4 ---
...a.AdminPostDiscountsDiscountConditions.mdx | 4 ---
...stDiscountsDiscountConditionsCondition.mdx | 4 ---
...DiscountConditionsConditionBatchParams.mdx | 4 ---
...ntsDiscountConditionsConditionBatchReq.mdx | 4 ---
...ountsDiscountConditionsConditionParams.mdx | 4 ---
...nPostDiscountsDiscountConditionsParams.mdx | 4 ---
...inPostDiscountsDiscountDynamicCodesReq.mdx | 4 ---
...edusa.AdminPostDiscountsDiscountParams.mdx | 4 ---
.../medusa.AdminPostDiscountsDiscountReq.mdx | 4 ---
.../medusa.AdminPostDiscountsDiscountRule.mdx | 4 ---
.../medusa.AdminPostDiscountsParams.mdx | 4 ---
.../classes/medusa.AdminPostDiscountsReq.mdx | 4 ---
...tDraftOrdersDraftOrderLineItemsItemReq.mdx | 4 ---
...nPostDraftOrdersDraftOrderLineItemsReq.mdx | 4 ---
...dusa.AdminPostDraftOrdersDraftOrderReq.mdx | 4 ---
.../medusa.AdminPostDraftOrdersReq.mdx | 4 ---
.../medusa.AdminPostGiftCardsGiftCardReq.mdx | 4 ---
.../classes/medusa.AdminPostGiftCardsReq.mdx | 4 ---
...nPostInventoryItemsInventoryItemParams.mdx | 4 ---
...dminPostInventoryItemsInventoryItemReq.mdx | 6 ----
...toryItemsItemLocationLevelsLevelParams.mdx | 4 ---
...ventoryItemsItemLocationLevelsLevelReq.mdx | 4 ---
...InventoryItemsItemLocationLevelsParams.mdx | 4 ---
...ostInventoryItemsItemLocationLevelsReq.mdx | 4 ---
.../medusa.AdminPostInventoryItemsParams.mdx | 4 ---
.../medusa.AdminPostInventoryItemsReq.mdx | 4 ---
...medusa.AdminPostInvitesInviteAcceptReq.mdx | 6 ----
...sa.AdminPostInvitesInviteAcceptUserReq.mdx | 4 ---
.../classes/medusa.AdminPostInvitesReq.mdx | 4 ---
.../classes/medusa.AdminPostNotesNoteReq.mdx | 4 ---
.../classes/medusa.AdminPostNotesReq.mdx | 4 ---
...PostNotificationsNotificationResendReq.mdx | 4 ---
...PostOrderEditsEditLineItemsLineItemReq.mdx | 4 ---
...sa.AdminPostOrderEditsEditLineItemsReq.mdx | 4 ---
...medusa.AdminPostOrderEditsOrderEditReq.mdx | 4 ---
.../classes/medusa.AdminPostOrderEditsReq.mdx | 4 ---
...inPostOrderEditsRequestConfirmationReq.mdx | 4 ---
.../medusa.AdminPostOrdersClaimCancel.mdx | 4 ---
...ostOrdersClaimFulfillmentsCancelParams.mdx | 4 ---
...dusa.AdminPostOrdersOrderArchiveParams.mdx | 4 ---
.../medusa.AdminPostOrdersOrderCancel.mdx | 4 ---
...dusa.AdminPostOrdersOrderCaptureParams.mdx | 4 ---
...dersOrderClaimsClaimFulfillmentsParams.mdx | 4 ---
...tOrdersOrderClaimsClaimFulfillmentsReq.mdx | 4 ---
....AdminPostOrdersOrderClaimsClaimParams.mdx | 4 ---
...usa.AdminPostOrdersOrderClaimsClaimReq.mdx | 4 ---
...tOrdersOrderClaimsClaimShipmentsParams.mdx | 4 ---
...PostOrdersOrderClaimsClaimShipmentsReq.mdx | 4 ---
...edusa.AdminPostOrdersOrderClaimsParams.mdx | 4 ---
.../medusa.AdminPostOrdersOrderClaimsReq.mdx | 6 ----
...usa.AdminPostOrdersOrderCompleteParams.mdx | 4 ---
...stOrdersOrderFulfillementsCancelParams.mdx | 4 ---
...AdminPostOrdersOrderFulfillmentsParams.mdx | 4 ---
...sa.AdminPostOrdersOrderFulfillmentsReq.mdx | 6 ----
.../medusa.AdminPostOrdersOrderParams.mdx | 4 ---
...dusa.AdminPostOrdersOrderRefundsParams.mdx | 4 ---
.../medusa.AdminPostOrdersOrderRefundsReq.mdx | 4 ---
.../medusa.AdminPostOrdersOrderReq.mdx | 4 ---
...dusa.AdminPostOrdersOrderReturnsParams.mdx | 4 ---
.../medusa.AdminPostOrdersOrderReturnsReq.mdx | 4 ---
...usa.AdminPostOrdersOrderShipmentParams.mdx | 4 ---
...medusa.AdminPostOrdersOrderShipmentReq.mdx | 4 ---
...inPostOrdersOrderShippingMethodsParams.mdx | 4 ---
...AdminPostOrdersOrderShippingMethodsReq.mdx | 6 ----
...dersOrderSwapFulfillementsCancelParams.mdx | 4 ---
...medusa.AdminPostOrdersOrderSwapsParams.mdx | 4 ---
.../medusa.AdminPostOrdersOrderSwapsReq.mdx | 4 ---
...OrdersOrderSwapsSwapFulfillmentsParams.mdx | 4 ---
...ostOrdersOrderSwapsSwapFulfillmentsReq.mdx | 4 ---
...dersOrderSwapsSwapProcessPaymentParams.mdx | 4 ---
...ostOrdersOrderSwapsSwapShipmentsParams.mdx | 4 ---
...inPostOrdersOrderSwapsSwapShipmentsReq.mdx | 4 ---
...medusa.AdminPostOrdersSwapCancelParams.mdx | 4 ---
.../medusa.AdminPostPaymentRefundsReq.mdx | 4 ---
...dusa.AdminPostPriceListPricesPricesReq.mdx | 4 ---
...minPostPriceListsPriceListPriceListReq.mdx | 4 ---
...medusa.AdminPostPriceListsPriceListReq.mdx | 4 ---
...minPostProductCategoriesCategoryParams.mdx | 4 ---
...tCategoriesCategoryProductsBatchParams.mdx | 4 ---
...ductCategoriesCategoryProductsBatchReq.mdx | 4 ---
....AdminPostProductCategoriesCategoryReq.mdx | 4 ---
...edusa.AdminPostProductCategoriesParams.mdx | 4 ---
.../medusa.AdminPostProductCategoriesReq.mdx | 4 ---
...sa.AdminPostProductsProductMetadataReq.mdx | 4 ---
....AdminPostProductsProductOptionsOption.mdx | 4 ---
...usa.AdminPostProductsProductOptionsReq.mdx | 4 ---
.../medusa.AdminPostProductsProductReq.mdx | 4 ---
...sa.AdminPostProductsProductVariantsReq.mdx | 4 ---
...nPostProductsProductVariantsVariantReq.mdx | 4 ---
.../classes/medusa.AdminPostProductsReq.mdx | 4 ---
...edusa.AdminPostProductsToCollectionReq.mdx | 4 ---
...PublishableApiKeySalesChannelsBatchReq.mdx | 4 ---
...PublishableApiKeysPublishableApiKeyReq.mdx | 4 ---
.../medusa.AdminPostPublishableApiKeysReq.mdx | 4 ---
...usa.AdminPostRegionsRegionCountriesReq.mdx | 4 ---
...stRegionsRegionFulfillmentProvidersReq.mdx | 4 ---
...inPostRegionsRegionPaymentProvidersReq.mdx | 4 ---
.../medusa.AdminPostRegionsRegionReq.mdx | 4 ---
.../classes/medusa.AdminPostRegionsReq.mdx | 4 ---
.../medusa.AdminPostReservationsReq.mdx | 4 ---
...sa.AdminPostReservationsReservationReq.mdx | 4 ---
...medusa.AdminPostReturnReasonsReasonReq.mdx | 4 ---
.../medusa.AdminPostReturnReasonsReq.mdx | 4 ---
...edusa.AdminPostReturnsReturnReceiveReq.mdx | 4 ---
...stSalesChannelsChannelProductsBatchReq.mdx | 4 ---
...tSalesChannelsChannelStockLocationsReq.mdx | 4 ---
.../medusa.AdminPostSalesChannelsReq.mdx | 4 ---
....AdminPostSalesChannelsSalesChannelReq.mdx | 4 ---
...dusa.AdminPostShippingOptionsOptionReq.mdx | 4 ---
.../medusa.AdminPostShippingOptionsReq.mdx | 4 ---
...sa.AdminPostShippingProfilesProfileReq.mdx | 4 ---
.../medusa.AdminPostShippingProfilesReq.mdx | 4 ---
....AdminPostStockLocationsLocationParams.mdx | 4 ---
...usa.AdminPostStockLocationsLocationReq.mdx | 4 ---
.../medusa.AdminPostStockLocationsParams.mdx | 4 ---
.../medusa.AdminPostStockLocationsReq.mdx | 4 ---
.../classes/medusa.AdminPostStoreReq.mdx | 4 ---
.../medusa.AdminPostTaxRatesParams.mdx | 4 ---
.../classes/medusa.AdminPostTaxRatesReq.mdx | 4 ---
.../medusa.AdminPostTaxRatesTaxRateParams.mdx | 4 ---
...nPostTaxRatesTaxRateProductTypesParams.mdx | 4 ---
...dminPostTaxRatesTaxRateProductTypesReq.mdx | 6 ----
...AdminPostTaxRatesTaxRateProductsParams.mdx | 4 ---
...sa.AdminPostTaxRatesTaxRateProductsReq.mdx | 4 ---
.../medusa.AdminPostTaxRatesTaxRateReq.mdx | 4 ---
...stTaxRatesTaxRateShippingOptionsParams.mdx | 4 ---
...nPostTaxRatesTaxRateShippingOptionsReq.mdx | 4 ---
.../medusa.AdminPostUploadsDownloadUrlReq.mdx | 4 ---
.../medusa.AdminPriceListPricesCreateReq.mdx | 4 ---
.../medusa.AdminPriceListPricesUpdateReq.mdx | 4 ---
.../medusa.AdminPriceSelectionParams.mdx | 4 ---
.../medusa.AdminProductCategoriesReqBase.mdx | 4 ---
.../medusa.AdminResetPasswordRequest.mdx | 4 ---
.../medusa.AdminResetPasswordTokenRequest.mdx | 4 ---
.../medusa.AdminUpdateDiscountRule.mdx | 4 ---
...edusa.AdminUpdatePaymentCollectionsReq.mdx | 4 ---
.../classes/medusa.AdminUpdateUserRequest.mdx | 4 ---
.../classes/medusa.AdminUpsertCondition.mdx | 4 ---
.../medusa.AdminUpsertConditionsReq.mdx | 4 ---
.../medusa.StoreGetCollectionsParams.mdx | 4 ---
...ustomersCustomerOrdersPaginationParams.mdx | 4 ---
....StoreGetCustomersCustomerOrdersParams.mdx | 4 ---
.../classes/medusa.StoreGetOrdersParams.mdx | 4 ---
...edusa.StoreGetPaymentCollectionsParams.mdx | 4 ---
...toreGetProductCategoriesCategoryParams.mdx | 4 ---
...medusa.StoreGetProductCategoriesParams.mdx | 18 ----------
.../medusa.StoreGetProductTagsParams.mdx | 4 ---
.../medusa.StoreGetProductTypesParams.mdx | 4 ---
...edusa.StoreGetProductsPaginationParams.mdx | 4 ---
.../classes/medusa.StoreGetProductsParams.mdx | 4 ---
.../classes/medusa.StoreGetRegionsParams.mdx | 4 ---
.../medusa.StoreGetShippingOptionsParams.mdx | 4 ---
.../classes/medusa.StoreGetVariantsParams.mdx | 4 ---
.../medusa.StoreGetVariantsVariantParams.mdx | 4 ---
...dusa.StorePaymentCollectionSessionsReq.mdx | 4 ---
.../classes/medusa.StorePostAuthReq.mdx | 4 ---
.../classes/medusa.StorePostCartReq.mdx | 6 ----
...usa.StorePostCartsCartLineItemsItemReq.mdx | 4 ---
.../medusa.StorePostCartsCartLineItemsReq.mdx | 4 ---
...sa.StorePostCartsCartPaymentSessionReq.mdx | 4 ---
...rePostCartsCartPaymentSessionUpdateReq.mdx | 4 ---
.../classes/medusa.StorePostCartsCartReq.mdx | 4 ---
...sa.StorePostCartsCartShippingMethodReq.mdx | 4 ---
...orePostCustomersCustomerAcceptClaimReq.mdx | 4 ---
...stCustomersCustomerAddressesAddressReq.mdx | 4 ---
...StorePostCustomersCustomerAddressesReq.mdx | 4 ---
...torePostCustomersCustomerOrderClaimReq.mdx | 4 ---
...ePostCustomersCustomerPasswordTokenReq.mdx | 4 ---
.../medusa.StorePostCustomersCustomerReq.mdx | 4 ---
.../classes/medusa.StorePostCustomersReq.mdx | 4 ---
...usa.StorePostCustomersResetPasswordReq.mdx | 4 ---
...sa.StorePostOrderEditsOrderEditDecline.mdx | 4 ---
...ntCollectionsBatchSessionsAuthorizeReq.mdx | 4 ---
...PostPaymentCollectionsBatchSessionsReq.mdx | 4 ---
...StorePostPaymentCollectionsSessionsReq.mdx | 4 ---
.../classes/medusa.StorePostReturnsReq.mdx | 4 ---
.../classes/medusa.StorePostSearchReq.mdx | 4 ---
.../classes/medusa.StorePostSwapsReq.mdx | 4 ---
272 files changed, 82 insertions(+), 1205 deletions(-)
create mode 100644 docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/get-correct-declaration-reflection.ts
diff --git a/docs-util/packages/typedoc-config/_merger.js b/docs-util/packages/typedoc-config/_merger.js
index 9779688f8e..0af5346beb 100644
--- a/docs-util/packages/typedoc-config/_merger.js
+++ b/docs-util/packages/typedoc-config/_merger.js
@@ -221,9 +221,14 @@ module.exports = {
"https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records",
},
},
+ "^medusa/classes/medusa\\.(Store*|Admin*)": {
+ reflectionGroups: {
+ Constructors: false,
+ },
+ },
// PRICING CONFIG
- "^pricing": {
+ "^(pricing|IPricingModuleService)": {
...modulesOptions,
frontmatterData: {
displayed_sidebar: "pricingReference",
diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts
index 31c55c9a69..7bc755f056 100644
--- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts
+++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts
@@ -91,7 +91,7 @@ export function registerHelpers(theme: MarkdownTheme) {
ifShowBreadcrumbsHelper(theme)
ifShowNamedAnchorsHelper(theme)
ifShowPageTitleHelper(theme)
- ifShowReturnsHelper()
+ ifShowReturnsHelper(theme)
ifShowTypeHierarchyHelper()
indexSignatureTitleHelper()
parameterTableHelper()
@@ -126,6 +126,6 @@ export function registerHelpers(theme: MarkdownTheme) {
featureFlagHelper()
decrementCurrentTitleLevelHelper(theme)
incrementCurrentTitleLevelHelper(theme)
- hasMoreThanOneSignatureHelper()
+ hasMoreThanOneSignatureHelper(theme)
ifCanShowConstructorsTitleHelper()
}
diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/has-more-than-one-signature.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/has-more-than-one-signature.ts
index d24549f3d8..e7c5d0e365 100644
--- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/has-more-than-one-signature.ts
+++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/has-more-than-one-signature.ts
@@ -1,10 +1,13 @@
import { DeclarationReflection } from "typedoc"
import * as Handlebars from "handlebars"
+import getCorrectDeclarationReflection from "../../utils/get-correct-declaration-reflection"
+import { MarkdownTheme } from "../../theme"
-export default function () {
+export default function (theme: MarkdownTheme) {
Handlebars.registerHelper(
"hasMoreThanOneSignature",
function (model: DeclarationReflection) {
+ model = getCorrectDeclarationReflection(model, theme) || model
return (model?.signatures?.length || 0) > 1
}
)
diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-show-returns.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-show-returns.ts
index 30cc221fec..4ddb3d46fa 100644
--- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-show-returns.ts
+++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-show-returns.ts
@@ -1,10 +1,14 @@
import * as Handlebars from "handlebars"
import { ReflectionKind, SignatureReflection } from "typedoc"
+import getCorrectDeclarationReflection from "../../utils/get-correct-declaration-reflection"
+import { MarkdownTheme } from "../../theme"
-export default function () {
+export default function (theme: MarkdownTheme) {
Handlebars.registerHelper(
"ifShowReturns",
function (this: SignatureReflection, options: Handlebars.HelperOptions) {
+ this.parent =
+ getCorrectDeclarationReflection(this.parent, theme) || this.parent
return this.type && !this.parent?.kindOf(ReflectionKind.Constructor)
? options.fn(this)
: options.inverse(this)
diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/signature-title.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/signature-title.ts
index cce2772513..7d20368eb9 100644
--- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/signature-title.ts
+++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/signature-title.ts
@@ -7,6 +7,7 @@ import {
import { memberSymbol } from "../../utils"
import { MarkdownTheme } from "../../theme"
import { getHTMLChar } from "utils"
+import getCorrectDeclarationReflection from "../../utils/get-correct-declaration-reflection"
export default function (theme: MarkdownTheme) {
Handlebars.registerHelper(
@@ -14,6 +15,8 @@ export default function (theme: MarkdownTheme) {
function (this: SignatureReflection, accessor?: string, standalone = true) {
const { sections, expandMembers = false } =
theme.getFormattingOptionsForLocation()
+ this.parent =
+ getCorrectDeclarationReflection(this.parent, theme) || this.parent
const parentHasMoreThanOneSignature =
Handlebars.helpers.hasMoreThanOneSignature(this.parent)
if (
@@ -24,6 +27,7 @@ export default function (theme: MarkdownTheme) {
// only show title if there are more than one signatures
return ""
}
+
const md: string[] = []
if (!expandMembers) {
diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.declaration.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.declaration.hbs
index f9cbb59a86..695a8c19c9 100755
--- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.declaration.hbs
+++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.declaration.hbs
@@ -70,7 +70,7 @@
{{incrementCurrentTitleLevel}}
-{{> member.signature showSources=false }}
+{{> member.signature showSources=false parent=../type.declaration }}
{{decrementCurrentTitleLevel}}
diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs
index 30ac37c284..004ee43628 100644
--- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs
+++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs
@@ -16,7 +16,7 @@
{{#each signatures}}
-{{> member.signature showSources=true }}
+{{> member.signature showSources=true parent=.. }}
{{/each}}
diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs
index 15c12ac98d..fc3de65f07 100644
--- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs
+++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.signature.hbs
@@ -1,4 +1,4 @@
-{{{signatureTitle accessor}}}
+{{{signatureTitle accessor parent}}}
{{#if (getFormattingOption "expandMembers")}}
@@ -90,7 +90,7 @@
{{#each declaration.signatures}}
-{{> member.signature showSources=false }}
+{{> member.signature showSources=false parent=../declaration }}
{{/each}}
diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/get-correct-declaration-reflection.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/get-correct-declaration-reflection.ts
new file mode 100644
index 0000000000..a55d74e379
--- /dev/null
+++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/get-correct-declaration-reflection.ts
@@ -0,0 +1,33 @@
+import { DeclarationReflection } from "typedoc"
+import { MarkdownTheme } from "../theme"
+
+/**
+ * Some reflections are loaded as objects rather than instances
+ * of DeclarationReflection. This tries to reload the declaration reflection
+ * if that's the case.
+ */
+export default function getCorrectDeclarationReflection(
+ refl: unknown,
+ theme: MarkdownTheme
+): DeclarationReflection | undefined {
+ if (
+ refl &&
+ !(refl instanceof DeclarationReflection) &&
+ typeof refl === "object" &&
+ "id" in refl &&
+ refl.id
+ ) {
+ if (theme.reflection?.id === refl.id) {
+ refl = theme.reflection!
+ } else {
+ refl =
+ (theme.project?.getReflectionById(
+ refl.id as number
+ ) as DeclarationReflection) || refl
+ }
+ } else if (!refl && theme.reflection) {
+ refl = theme.reflection
+ }
+
+ return refl as DeclarationReflection | undefined
+}
diff --git a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx
index c5fa22ae65..49f1ee43f4 100644
--- a/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx
+++ b/www/apps/docs/content/references/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices.mdx
@@ -13,11 +13,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
This documentation provides a reference to the `addPrices` method. This belongs to the Pricing Module.
-`**addPrices**(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)>`
+## addPrices(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)>
This method adds prices to a price set.
-## Example
+### Example
To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`:
@@ -88,7 +88,7 @@ async function addPricesToPriceSet (priceSetId: string) {
}
```
-## Parameters
+### Parameters
-## Returns
+### Returns
-`**addPrices**(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>`
+## addPrices(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>
This method adds prices to multiple price sets.
-## Example
+### Example
To add a default price to a price set, don't pass it any rules and make sure to pass it the `currency_code`:
@@ -458,7 +458,7 @@ async function addPricesToPriceSet (priceSetId: string) {
}
```
-## Parameters
+### Parameters
-## Returns
+### Returns
-## Returns
+### Returns
-`**addRules**(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>`
+## addRules(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>
This method adds rules to multiple price sets.
-## Example
+### Example
```ts
import {
@@ -304,7 +304,7 @@ async function addRulesToPriceSet (priceSetId: string) {
}
```
-## Parameters
+### Parameters
-## Returns
+### Returns
-## Returns
+### Returns
-`**create**(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>`
+## create(data, sharedContext?): Promise<[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)[]>
This method is used to create multiple price sets.
-## Example
+### Example
To create price sets with a default price, don't pass any rules and make sure to pass the `currency_code` of the price. For example:
@@ -483,7 +483,7 @@ async function createPriceSets () {
}
```
-## Parameters
+### Parameters
-## Returns
+### Returns
-
-___
-
## Properties
-
-___
-
## Properties
-
-___
-
## Properties
-
-___
-
## Properties
-
-___
-
## Properties
-
-___
-
## Properties
-
-___
-
## Properties
-
-___
-
## Properties