chore(docs): Generated References (#9267)
Generated the following references: - `medusa` - `modules` - `modules_sdk` - `payment_provider` - `workflows`
This commit is contained in:
github-actions[bot] authored and 
GitHub committed
1 parent
64c4c828b6
commit
657a9fb90b
29 files changed
+32476
-32467
No files matched your search
@@ -474,14 +474,14 @@ export const generatedEditDates = {
|
||||
"references/medusa_config/interfaces/medusa_config.ConfigModule/page.mdx": "2024-09-03T00:11:20.891Z",
|
||||
"references/medusa_config/interfaces/medusa_config.ProjectConfigOptions/page.mdx": "2024-08-28T00:11:31.266Z",
|
||||
"references/modules/auth/page.mdx": "2024-08-28T00:11:06.310Z",
|
||||
"references/modules/modules_sdk/page.mdx": "2024-09-23T00:12:00.557Z",
|
||||
"references/modules/modules_sdk/page.mdx": "2024-09-24T00:12:08.445Z",
|
||||
"references/modules_sdk/classes/modules_sdk.RemoteLink/page.mdx": "2024-09-17T00:11:24.823Z",
|
||||
"references/modules_sdk/classes/modules_sdk.RemoteQuery/page.mdx": "2024-09-23T00:12:00.621Z",
|
||||
"references/modules_sdk/types/modules_sdk.LinkModuleBootstrapOptions/page.mdx": "2024-09-17T00:11:24.803Z",
|
||||
"references/modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx": "2024-09-17T00:11:24.799Z",
|
||||
"references/modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx": "2024-09-17T00:11:24.795Z",
|
||||
"references/modules_sdk/types/modules_sdk.MigrationOptions/page.mdx": "2024-08-28T00:11:31.326Z",
|
||||
"references/modules_sdk/types/modules_sdk.ModuleBootstrapOptions/page.mdx": "2024-09-17T00:11:24.803Z",
|
||||
"references/modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx": "2024-09-24T00:12:08.461Z",
|
||||
"references/modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx": "2024-09-24T00:12:08.458Z",
|
||||
"references/modules_sdk/types/modules_sdk.MigrationOptions/page.mdx": "2024-09-24T00:12:08.464Z",
|
||||
"references/modules_sdk/types/modules_sdk.ModuleBootstrapOptions/page.mdx": "2024-09-24T00:12:08.466Z",
|
||||
"references/modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx": "2024-08-28T00:11:31.334Z",
|
||||
"references/modules_sdk/types/modules_sdk.SharedResources/page.mdx": "2024-08-28T00:11:31.318Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.cancelClaim/page.mdx": "2024-09-17T00:11:26.555Z",
|
||||
@@ -1017,7 +1017,7 @@ export const generatedEditDates = {
|
||||
"references/core_flows/core_flows.Steps_Auth/page.mdx": "2024-09-17T00:11:05.131Z",
|
||||
"references/core_flows/types/core_flows.CreateOrderClaimItemsFromActionsInput/page.mdx": "2024-09-17T00:11:22.999Z",
|
||||
"references/core_flows/types/core_flows.CreateOrderExchangeItemsFromActionsInput/page.mdx": "2024-09-17T00:11:23.007Z",
|
||||
"references/modules/medusa/page.mdx": "2024-09-18T00:11:06.819Z",
|
||||
"references/modules/medusa/page.mdx": "2024-09-24T00:11:41.120Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.addOrderAction/page.mdx": "2024-09-17T00:11:26.215Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.retrieveOrderChangeAction/page.mdx": "2024-09-17T00:11:26.199Z",
|
||||
"references/order/IOrderModuleService/methods/order.IOrderModuleService.updateOrderChangeActions/page.mdx": "2024-09-17T00:11:26.207Z",
|
||||
@@ -1454,7 +1454,7 @@ export const generatedEditDates = {
|
||||
"references/payment/interfaces/payment.JoinerServiceConfig/page.mdx": "2024-09-17T00:11:26.727Z",
|
||||
"references/payment/interfaces/payment.JoinerServiceConfigAlias/page.mdx": "2024-09-17T00:11:26.723Z",
|
||||
"references/payment/types/payment.JoinerRelationship/page.mdx": "2024-09-17T00:11:26.723Z",
|
||||
"references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx": "2024-09-17T00:11:26.687Z",
|
||||
"references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx": "2024-09-24T00:12:10.405Z",
|
||||
"references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.addPriceListPrices/page.mdx": "2024-09-17T00:11:27.255Z",
|
||||
"references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.addPrices/page.mdx": "2024-09-17T00:11:27.199Z",
|
||||
"references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.calculatePrices/page.mdx": "2024-09-17T00:11:27.171Z",
|
||||
@@ -1739,10 +1739,10 @@ export const generatedEditDates = {
|
||||
"references/utils/utils.FulfillmentUtils/page.mdx": "2024-09-17T00:10:59.403Z",
|
||||
"references/utils/utils.LinkUtils/page.mdx": "2024-09-17T00:10:59.415Z",
|
||||
"references/utils/utils.OrderUtils/page.mdx": "2024-09-17T00:10:59.419Z",
|
||||
"references/workflows/interfaces/workflows.StepExecutionContext/page.mdx": "2024-09-17T00:11:28.859Z",
|
||||
"references/workflows/types/workflows.CompensateFn/page.mdx": "2024-09-17T00:11:28.827Z",
|
||||
"references/workflows/interfaces/workflows.StepExecutionContext/page.mdx": "2024-09-24T00:12:12.647Z",
|
||||
"references/workflows/types/workflows.CompensateFn/page.mdx": "2024-09-24T00:12:12.619Z",
|
||||
"references/workflows/types/workflows.CreateWorkflowComposerContext/page.mdx": "2024-09-17T00:11:28.859Z",
|
||||
"references/workflows/types/workflows.InvokeFn/page.mdx": "2024-09-17T00:11:28.827Z",
|
||||
"references/workflows/types/workflows.InvokeFn/page.mdx": "2024-09-24T00:12:12.616Z",
|
||||
"references/workflows/types/workflows.StepFunctionResult/page.mdx": "2024-09-17T00:11:28.847Z",
|
||||
"references/types/IndexTypes/interfaces/types.IndexTypes.IIndexService/page.mdx": "2024-09-23T00:11:34.530Z",
|
||||
"references/types/types.IndexTypes/page.mdx": "2024-09-23T00:11:34.508Z",
|
||||
@@ -1782,5 +1782,14 @@ export const generatedEditDates = {
|
||||
"references/types/types/types.ProductVariant-1/page.mdx": "2024-09-23T00:11:34.700Z",
|
||||
"references/types/types/types.RawBigNumberPrefix-1/page.mdx": "2024-09-23T00:11:34.851Z",
|
||||
"references/types/types/types.Scalars-1/page.mdx": "2024-09-23T00:11:34.695Z",
|
||||
"references/types/types/types.TypeOnly-2/page.mdx": "2024-09-23T00:11:34.858Z"
|
||||
"references/types/types/types.TypeOnly-2/page.mdx": "2024-09-23T00:11:34.858Z",
|
||||
"references/medusa/interfaces/medusa.AuthenticatedMedusaRequest/page.mdx": "2024-09-24T00:11:41.184Z",
|
||||
"references/medusa/interfaces/medusa.MedusaRequest-1/page.mdx": "2024-09-24T00:11:41.177Z",
|
||||
"references/medusa/interfaces/medusa.MedusaRequest/page.mdx": "2024-09-24T00:11:41.148Z",
|
||||
"references/medusa/types/medusa.MedusaContainer-2/page.mdx": "2024-09-24T00:11:41.170Z",
|
||||
"references/medusa/types/medusa.MedusaErrorHandlerFunction/page.mdx": "2024-09-24T00:11:41.137Z",
|
||||
"references/medusa/types/medusa.MedusaRequestHandler-1/page.mdx": "2024-09-24T00:11:41.190Z",
|
||||
"references/medusa/types/medusa.MedusaRequestHandler/page.mdx": "2024-09-24T00:11:41.155Z",
|
||||
"references/medusa/types/medusa.SubscriberArgs/page.mdx": "2024-09-24T00:11:41.195Z",
|
||||
"references/workflows/types/workflows.ReturnWorkflow/page.mdx": "2024-09-24T00:12:12.649Z"
|
||||
}
|
||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_context","type":"[AuthContext](../medusa.AuthContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"actor_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actor_type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"","optional":false,"defaultValue":"Line truncated
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_context","type":"[AuthContext](../medusa.AuthContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"actor_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actor_type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"","optional":false,"defaultValue"Line truncated
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"customer_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"userId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"customer_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"userId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{Line truncated
|
||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An arrLine truncated
|
||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An arrayLine truncated
|
||||
@@ -2,4 +2,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# MedusaContainer
|
||||
|
||||
**MedusaContainer**: [MedusaContainer](../medusa.MedusaContainer/page.mdx)
|
||||
**MedusaContainer**: [MedusaContainer](../medusa.MedusaContainer-1/page.mdx)
|
||||
+1
-1
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest-1/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse-1/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest-1/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse-1/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"event","type":"[Event](../medusa.Event/page.mdx)<T>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../medusa.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"container","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pluginOptions","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="SubscriberArgs"/>
|
||||
<TypeList types={[{"name":"event","type":"[Event](../medusa.Event/page.mdx)<T>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"TData","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[EventMetadata](../medusa.EventMetadata/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"container","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pluginOptions","type":"`Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="SubscriberArgs"/>
|
||||
@@ -4,10 +4,10 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [RequestQueryFields](../../medusa/interfaces/medusa.RequestQueryFields/page.mdx)
|
||||
- [ModuleImplementations](../../medusa/interfaces/medusa.ModuleImplementations/page.mdx)
|
||||
- [FindConfig](../../medusa/interfaces/medusa.FindConfig/page.mdx)
|
||||
- [MedusaRequest](../../medusa/interfaces/medusa.MedusaRequest/page.mdx)
|
||||
- [RequestQueryFields](../../medusa/interfaces/medusa.RequestQueryFields/page.mdx)
|
||||
- [FindConfig](../../medusa/interfaces/medusa.FindConfig-1/page.mdx)
|
||||
- [MedusaRequest](../../medusa/interfaces/medusa.MedusaRequest-1/page.mdx)
|
||||
- [AuthContext](../../medusa/interfaces/medusa.AuthContext/page.mdx)
|
||||
@@ -16,12 +16,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Type Aliases
|
||||
|
||||
- [TransformObjectMethodToAsync](../../medusa/types/medusa.TransformObjectMethodToAsync/page.mdx)
|
||||
- [MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)
|
||||
- [EventMetadata](../../medusa/types/medusa.EventMetadata/page.mdx)
|
||||
- [Event](../../medusa/types/medusa.Event/page.mdx)
|
||||
- [MedusaPricingContext](../../medusa/types/medusa.MedusaPricingContext/page.mdx)
|
||||
- [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)
|
||||
- [RouteVerb](../../medusa/types/medusa.RouteVerb/page.mdx)
|
||||
- [MiddlewareVerb](../../medusa/types/medusa.MiddlewareVerb/page.mdx)
|
||||
- [MiddlewareFunction](../../medusa/types/medusa.MiddlewareFunction/page.mdx)
|
||||
@@ -33,6 +28,11 @@ import { TypeList } from "docs-ui"
|
||||
- [MedusaResponse](../../medusa/types/medusa.MedusaResponse/page.mdx)
|
||||
- [MedusaNextFunction](../../medusa/types/medusa.MedusaNextFunction/page.mdx)
|
||||
- [MedusaRequestHandler](../../medusa/types/medusa.MedusaRequestHandler/page.mdx)
|
||||
- [TransformObjectMethodToAsync](../../medusa/types/medusa.TransformObjectMethodToAsync/page.mdx)
|
||||
- [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)
|
||||
- [EventMetadata](../../medusa/types/medusa.EventMetadata/page.mdx)
|
||||
- [Event](../../medusa/types/medusa.Event/page.mdx)
|
||||
- [MedusaPricingContext](../../medusa/types/medusa.MedusaPricingContext/page.mdx)
|
||||
- [QueryConfig](../../medusa/types/medusa.QueryConfig/page.mdx)
|
||||
- [ClassConstructor](../../medusa/types/medusa.ClassConstructor/page.mdx)
|
||||
- [MedusaContainer](../../medusa/types/medusa.MedusaContainer-2/page.mdx)
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleResolutions","type":"`Record<string, [ModuleResolution](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolutionPath","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"logger","type":"[Logger](../../types/LoggerTypes/interfaces/types.LoggerTypes.Logger/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"panic","type":"(`data`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shouldLog","type":"(`level`: `string`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"setLogLevel","type":"(`level`: `string`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unsetLogLevel","type":"() => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"activity","type":"(`message`: `string`, `config?`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"error","type":"(`messageOrError`: `any`, `error?`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failure","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"success","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"log","type":"(...`args`: `any`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"migrationOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"loaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="moduleLoader"/>
|
||||
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleResolutions","type":"`Record<string, [ModuleResolution](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolutionPath","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"logger","type":"[Logger](../../types/LoggerTypes/interfaces/types.LoggerTypes.Logger/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"panic","type":"(`data`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shouldLog","type":"(`level`: `string`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"setLogLevel","type":"(`level`: `string`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unsetLogLevel","type":"() => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"activity","type":"(`message`: `string`, `config?`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"error","type":"(`messageOrError`: `any`, `error?`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failure","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"success","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"log","type":"(...`args`: `any`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"migrationOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"loaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="moduleLoader"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providers","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"registerServiceFn","type":"(`klass`: `any`, `container`: [MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx), `moduleDetails`: `any`) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="moduleProviderLoader"/>
|
||||
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providers","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"registerServiceFn","type":"(`klass`: `any`, `container`: [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx), `moduleDetails`: `any`) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="moduleProviderLoader"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"services","type":"[Constructor](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)<any>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"registerServiceFn","type":"(`klass`: `any`, `container`: `any`, `moduleDetails`: `any`) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadModuleProvider"/>
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"services","type":"[Constructor](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)<any>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"registerServiceFn","type":"(`klass`: `any`, `container`: `any`, `moduleDetails`: `any`) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadModuleProvider"/>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -148,17 +148,17 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStartCb","type":"() => `void`","description":"","optional":true,"defaultValue":"","expandable":false,"children"Line truncated
|
||||
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStartCb","type":"() => `void`","description":"","optional":true,"defaultValue":"","expandable":false,"childreLine truncated
|
||||
|
||||
#### Returns
|
||||
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[MedusaAppOutput](../../modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"MedusaAppOutput","type":"[MedusaAppOutput](../../modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"modules","type":"`Record<string, [LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx) \\| [LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"link","type":"[RemoteLink](../../modules_sdk/classes/modules_sdk.RemoteLink/page.mdx) \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[RemoteQueryFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"graph","type":"[QueryGraphFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx)","description":"Graph function uses the remoteQuery under the hood and\nreturns a result set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gql","type":"(`query`: `string`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise<any>","description":"Query wrapper to provide specific GraphQL like API around remoteQuery.query","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"runMigrations","type":"[RunMigrationFn](../../modules_sdk/types/modules_sdk.RunMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigrations","type":"[RevertMigrationFn](../../modules_sdk/types/modules_sdk.RevertMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigrations","type":"[GenerateMigrations](../../modules_sdk/types/modules_sdk.GenerateMigrations/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"linkMigrationExecutionPlanner","type":"[GetLinkExecutionPlanner](../../modules_sdk/types/modules_sdk.GetLinkExecutionPlanner/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStart","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entitiesMap","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gqlSchema","type":"`GraphQLSchema`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record<string, string>>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaApp"/>
|
||||
<TypeList types={[{"name":"Promise","type":"Promise<[MedusaAppOutput](../../modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"MedusaAppOutput","type":"[MedusaAppOutput](../../modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"modules","type":"`Record<string, [LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx) \\| [LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"link","type":"[RemoteLink](../../modules_sdk/classes/modules_sdk.RemoteLink/page.mdx) \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[RemoteQueryFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"graph","type":"[QueryGraphFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx)","description":"Graph function uses the remoteQuery under the hood and\nreturns a result set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gql","type":"(`query`: `string`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise<any>","description":"Query wrapper to provide specific GraphQL like API around remoteQuery.query","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"runMigrations","type":"[RunMigrationFn](../../modules_sdk/types/modules_sdk.RunMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigrations","type":"[RevertMigrationFn](../../modules_sdk/types/modules_sdk.RevertMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigrations","type":"[GenerateMigrations](../../modules_sdk/types/modules_sdk.GenerateMigrations/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"linkMigrationExecutionPlanner","type":"[GetLinkExecutionPlanner](../../modules_sdk/types/modules_sdk.GetLinkExecutionPlanner/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStart","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entitiesMap","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gqlSchema","type":"`GraphQLSchema`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record<string, string>>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaApp"/>
|
||||
|
||||
### MedusaAppMigrateUp
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStartCb","type":"() => `void`","description":"","optional":true,"defaultValue":"","expandable":false,"children"Line truncated
|
||||
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStartCb","type":"() => `void`","description":"","optional":true,"defaultValue":"","expandable":false,"childreLine truncated
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -168,7 +168,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"namLine truncated
|
||||
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -178,7 +178,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"namLine truncated
|
||||
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -188,7 +188,7 @@ ___
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStartCb","type":"() => `void`","description":"","optional":true,"defaultValue":"","expandable":false,"children"Line truncated
|
||||
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStartCb","type":"() => `void`","description":"","optional":true,"defaultValue":"","expandable":false,"childreLine truncated
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
+1
-1
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"pool","type":"`Record<string, unknown>`","description":"{\n name?: string\n afterCreate?: Function\n min?: number\n max?: number\n refreshIdle?: boolean\n idleTimeoutMillis?: number\n reapIntervalMillis?: number\n returnToHead?: boolean\n priorityRange?: number\n log?: (message: string, logLevel: string) => void\n}","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"loadedModules","type":"[LoadedModule](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"[JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"__definition","type":"[ModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","typeLine truncated
|
||||
<TypeList types={[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"pool","type":"`Record<string, unknown>`","description":"{\n name?: string\n afterCreate?: Function\n min?: number\n max?: number\n refreshIdle?: boolean\n idleTimeoutMillis?: number\n reapIntervalMillis?: number\n returnToHead?: boolean\n priorityRange?: number\n log?: (message: string, logLevel: string) => void\n}","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"loadedModules","type":"[LoadedModule](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"[JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. { 'price': 'prices.calculated\\_price\\_set.amount' })","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g { product\\_id: \"Product\" } \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"__definition","type":"[ModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","tyLine truncated
|
||||
+1
-1
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"modules","type":"`Record<string, [LoadedModule](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx) \\| [LoadedModule](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"link","type":"[RemoteLink](../../classes/modules_sdk.RemoteLink/page.mdx) \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[RemoteQueryFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"graph","type":"[QueryGraphFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx)","description":"Graph function uses the remoteQuery under the hood and\nreturns a result set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gql","type":"(`query`: `string`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise<any>","description":"Query wrapper to provide specific GraphQL like API around remoteQuery.query","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"runMigrations","type":"[RunMigrationFn](../modules_sdk.RunMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigrations","type":"[RevertMigrationFn](../modules_sdk.RevertMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigrations","type":"[GenerateMigrations](../modules_sdk.GenerateMigrations/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"linkMigrationExecutionPlanner","type":"[GetLinkExecutionPlanner](../modules_sdk.GetLinkExecutionPlanner/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStart","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entitiesMap","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gqlSchema","type":"`GraphQLSchema`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record<string, string>>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaAppOutput"/>
|
||||
<TypeList types={[{"name":"modules","type":"`Record<string, [LoadedModule](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx) \\| [LoadedModule](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"link","type":"[RemoteLink](../../classes/modules_sdk.RemoteLink/page.mdx) \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[RemoteQueryFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"graph","type":"[QueryGraphFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx)","description":"Graph function uses the remoteQuery under the hood and\nreturns a result set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gql","type":"(`query`: `string`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise<any>","description":"Query wrapper to provide specific GraphQL like API around remoteQuery.query","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"runMigrations","type":"[RunMigrationFn](../modules_sdk.RunMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigrations","type":"[RevertMigrationFn](../modules_sdk.RevertMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigrations","type":"[GenerateMigrations](../modules_sdk.GenerateMigrations/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"linkMigrationExecutionPlanner","type":"[GetLinkExecutionPlanner](../modules_sdk.GetLinkExecutionPlanner/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStart","type":"() => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entitiesMap","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gqlSchema","type":"`GraphQLSchema`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record<string, string>>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaAppOutput"/>
|
||||
+1
-1
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"moduleKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"modulePath","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MigrationOptions"/>
|
||||
<TypeList types={[{"name":"moduleKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"modulePath","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MigrationOptions"/>
|
||||
+1
-1
@@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
## Properties
|
||||
|
||||
<TypeList types={[{"name":"moduleKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPath","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declaration","type":"[ModuleBootstrapDeclaration](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleBootstrapDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resources","type":"`\"shared\"` \\| `\"isolated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"`\"external\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isQueryable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"worker_mode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isQueryable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"server","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`\"http\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"keepAlive","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"moduleExports","type":"[ModuleExports](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"childrLine truncated
|
||||
<TypeList types={[{"name":"moduleKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPath","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"declaration","type":"[ModuleBootstrapDeclaration](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleBootstrapDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resources","type":"`\"shared\"` \\| `\"isolated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"`\"external\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isQueryable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"worker_mode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isQueryable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"server","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`\"http\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"url","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"keepAlive","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"moduleExports","type":"[ModuleExports](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"childrLine truncated
|
||||
+1
-1
@@ -96,7 +96,7 @@ export default MyPaymentProviderService
|
||||
|
||||
#### Parameters
|
||||
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The module's container used to resolve resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"TConfig","description":"The options passed to the payment module provider.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new AbstractPaymentProvider"/>
|
||||
<TypeList types={[{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"The module's container used to resolve resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"TConfig","description":"The options passed to the payment module provider.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new AbstractPaymentProvider"/>
|
||||
|
||||
### validateOptions
|
||||
|
||||
|
||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
The step's context.
|
||||
|
||||
<TypeList types={[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/interfaces/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="StepExecutionContext"/>
|
||||
<TypeList types={[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../types/interfaces/types.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="StepExecutionContext"/>
|
||||
@@ -14,7 +14,7 @@ The type of compensation function passed to a step.
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"T \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"input","type":"T \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ The type of invocation function passed to a step.
|
||||
|
||||
### Parameters
|
||||
|
||||
<TypeList types={[{"name":"input","type":"TInput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
<TypeList types={[{"name":"input","type":"TInput","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[StepExecutionContext](../../interfaces/workflows.StepExecutionContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"workflowId","type":"`string`","description":"The ID of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attempt","type":"`number`","description":"The attempt number of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"The idempoency key of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stepName","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"action","type":"`\"invoke\"` \\| `\"compensate\"`","description":"The action of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"The container used to access resources, such as services, in the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`TransactionMetadata`","description":"Metadata passed in the input.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"The idempoency key of the parent step.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
|
||||
|
||||
### Returns
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
# ReturnWorkflow
|
||||
|
||||
**ReturnWorkflow**: `<TDataOverride, TResultOverride>`(`container?`: [MedusaContainer](../../../medusa/types/medusa.MedusaContainer/page.mdx) \| ``{ __joinerConfig: [ModuleJoinerConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx) ; __definition: [ModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx) }``[]) => Omit<LocalWorkflow, "run" \| "registerStepSuccess" \| "registerStepFailure" \| "cancel"> & ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride> & `object`
|
||||
**ReturnWorkflow**: `<TDataOverride, TResultOverride>`(`container?`: [MedusaContainer](../../../medusa/types/medusa.MedusaContainer-1/page.mdx) \| ``{ __joinerConfig: [ModuleJoinerConfig](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx) ; __definition: [ModuleDefinition](../../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx) }``[]) => Omit<LocalWorkflow, "run" \| "registerStepSuccess" \| "registerStepFailure" \| "cancel"> & ExportedWorkflow<TData, TResult, TDataOverride, TResultOverride> & `object`
|
||||
|
||||
An exported workflow, which is the type of a workflow constructed by the [createWorkflow](../../functions/workflows.createWorkflow/page.mdx) function. The exported workflow can be invoked to create
|
||||
an executable workflow, optionally within a specified container. So, to execute the workflow, you must invoke the exported workflow, then run the
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"id": 35464,
|
||||
"id": 35403,
|
||||
"name": "notification",
|
||||
"variant": "project",
|
||||
"kind": 1,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 35465,
|
||||
"id": 35404,
|
||||
"name": "AbstractNotificationProviderService",
|
||||
"variant": "declaration",
|
||||
"kind": 128,
|
||||
@@ -25,7 +25,7 @@
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"id": 35466,
|
||||
"id": 35405,
|
||||
"name": "validateOptions",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -34,7 +34,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35467,
|
||||
"id": 35406,
|
||||
"name": "validateOptions",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -49,7 +49,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35468,
|
||||
"id": 35407,
|
||||
"name": "options",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -83,21 +83,21 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 35469,
|
||||
"id": 35408,
|
||||
"name": "constructor",
|
||||
"variant": "declaration",
|
||||
"kind": 512,
|
||||
"flags": {},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35470,
|
||||
"id": 35409,
|
||||
"name": "new AbstractNotificationProviderService",
|
||||
"variant": "signature",
|
||||
"kind": 16384,
|
||||
"flags": {},
|
||||
"type": {
|
||||
"type": "reference",
|
||||
"target": 35465,
|
||||
"target": 35404,
|
||||
"name": "AbstractNotificationProviderService",
|
||||
"package": "@medusajs/utils"
|
||||
}
|
||||
@@ -105,14 +105,14 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 35471,
|
||||
"id": 35410,
|
||||
"name": "send",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
"flags": {},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35472,
|
||||
"id": 35411,
|
||||
"name": "send",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -147,7 +147,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35473,
|
||||
"id": 35412,
|
||||
"name": "notification",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -209,14 +209,14 @@
|
||||
{
|
||||
"title": "Constructors",
|
||||
"children": [
|
||||
35469
|
||||
35408
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Methods",
|
||||
"children": [
|
||||
35466,
|
||||
35471
|
||||
35405,
|
||||
35410
|
||||
]
|
||||
}
|
||||
],
|
||||
@@ -237,41 +237,41 @@
|
||||
{
|
||||
"title": "Classes",
|
||||
"children": [
|
||||
35465
|
||||
35404
|
||||
]
|
||||
}
|
||||
],
|
||||
"packageName": "@medusajs/utils",
|
||||
"symbolIdMap": {
|
||||
"35464": {
|
||||
"35403": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/notification/abstract-notification-provider.ts",
|
||||
"qualifiedName": ""
|
||||
},
|
||||
"35465": {
|
||||
"35404": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/notification/abstract-notification-provider.ts",
|
||||
"qualifiedName": "AbstractNotificationProviderService"
|
||||
},
|
||||
"35466": {
|
||||
"35405": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/notification/abstract-notification-provider.ts",
|
||||
"qualifiedName": "AbstractNotificationProviderService.validateOptions"
|
||||
},
|
||||
"35467": {
|
||||
"35406": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/notification/abstract-notification-provider.ts",
|
||||
"qualifiedName": "AbstractNotificationProviderService.validateOptions"
|
||||
},
|
||||
"35468": {
|
||||
"35407": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/notification/abstract-notification-provider.ts",
|
||||
"qualifiedName": "options"
|
||||
},
|
||||
"35471": {
|
||||
"35410": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/notification/abstract-notification-provider.ts",
|
||||
"qualifiedName": "AbstractNotificationProviderService.send"
|
||||
},
|
||||
"35472": {
|
||||
"35411": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/notification/abstract-notification-provider.ts",
|
||||
"qualifiedName": "AbstractNotificationProviderService.send"
|
||||
},
|
||||
"35473": {
|
||||
"35412": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/notification/abstract-notification-provider.ts",
|
||||
"qualifiedName": "notification"
|
||||
}
|
||||
@@ -281,7 +281,7 @@
|
||||
"1": "../../../../packages/core/utils/src/notification/abstract-notification-provider.ts"
|
||||
},
|
||||
"reflections": {
|
||||
"1": 35464
|
||||
"1": 35403
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"id": 35474,
|
||||
"id": 35413,
|
||||
"name": "payment-provider",
|
||||
"variant": "project",
|
||||
"kind": 1,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 35478,
|
||||
"id": 35417,
|
||||
"name": "AbstractPaymentProvider",
|
||||
"variant": "declaration",
|
||||
"kind": 128,
|
||||
@@ -15,7 +15,7 @@
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"id": 35479,
|
||||
"id": 35418,
|
||||
"name": "validateOptions",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -24,7 +24,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35480,
|
||||
"id": 35419,
|
||||
"name": "validateOptions",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -39,7 +39,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35481,
|
||||
"id": 35420,
|
||||
"name": "options",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -73,7 +73,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 35487,
|
||||
"id": 35426,
|
||||
"name": "constructor",
|
||||
"variant": "declaration",
|
||||
"kind": 512,
|
||||
@@ -82,7 +82,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35488,
|
||||
"id": 35427,
|
||||
"name": "new AbstractPaymentProvider",
|
||||
"variant": "signature",
|
||||
"kind": 16384,
|
||||
@@ -116,7 +116,7 @@
|
||||
},
|
||||
"typeParameters": [
|
||||
{
|
||||
"id": 35489,
|
||||
"id": 35428,
|
||||
"name": "TConfig",
|
||||
"variant": "typeParam",
|
||||
"kind": 131072,
|
||||
@@ -144,7 +144,7 @@
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35490,
|
||||
"id": 35429,
|
||||
"name": "container",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -168,7 +168,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35491,
|
||||
"id": 35430,
|
||||
"name": "config",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -183,7 +183,7 @@
|
||||
},
|
||||
"type": {
|
||||
"type": "reference",
|
||||
"target": 35489,
|
||||
"target": 35428,
|
||||
"name": "TConfig",
|
||||
"package": "@medusajs/utils",
|
||||
"qualifiedName": "AbstractPaymentProvider.TConfig",
|
||||
@@ -194,11 +194,11 @@
|
||||
],
|
||||
"type": {
|
||||
"type": "reference",
|
||||
"target": 35478,
|
||||
"target": 35417,
|
||||
"typeArguments": [
|
||||
{
|
||||
"type": "reference",
|
||||
"target": 35489,
|
||||
"target": 35428,
|
||||
"name": "TConfig",
|
||||
"package": "@medusajs/utils",
|
||||
"qualifiedName": "AbstractPaymentProvider.TConfig",
|
||||
@@ -212,7 +212,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 35492,
|
||||
"id": 35431,
|
||||
"name": "container",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -239,7 +239,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35493,
|
||||
"id": 35432,
|
||||
"name": "config",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -257,7 +257,7 @@
|
||||
},
|
||||
"type": {
|
||||
"type": "reference",
|
||||
"target": 35489,
|
||||
"target": 35428,
|
||||
"name": "TConfig",
|
||||
"package": "@medusajs/utils",
|
||||
"qualifiedName": "AbstractPaymentProvider.TConfig",
|
||||
@@ -266,7 +266,7 @@
|
||||
"defaultValue": "..."
|
||||
},
|
||||
{
|
||||
"id": 35486,
|
||||
"id": 35425,
|
||||
"name": "identifier",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -299,7 +299,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35496,
|
||||
"id": 35435,
|
||||
"name": "capturePayment",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -308,7 +308,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35497,
|
||||
"id": 35436,
|
||||
"name": "capturePayment",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -323,7 +323,7 @@
|
||||
"kind": "inline-tag",
|
||||
"tag": "@link",
|
||||
"text": "authorizePayment",
|
||||
"target": 35499,
|
||||
"target": 35438,
|
||||
"tsLinkText": ""
|
||||
},
|
||||
{
|
||||
@@ -370,7 +370,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35498,
|
||||
"id": 35437,
|
||||
"name": "paymentData",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -470,7 +470,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35499,
|
||||
"id": 35438,
|
||||
"name": "authorizePayment",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -479,7 +479,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35500,
|
||||
"id": 35439,
|
||||
"name": "authorizePayment",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -494,7 +494,7 @@
|
||||
"kind": "inline-tag",
|
||||
"tag": "@link",
|
||||
"text": "capturePayment",
|
||||
"target": 35496,
|
||||
"target": 35435,
|
||||
"tsLinkText": ""
|
||||
},
|
||||
{
|
||||
@@ -549,7 +549,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35501,
|
||||
"id": 35440,
|
||||
"name": "paymentSessionData",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -591,7 +591,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35502,
|
||||
"id": 35441,
|
||||
"name": "context",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -655,14 +655,14 @@
|
||||
{
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 35503,
|
||||
"id": 35442,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 35504,
|
||||
"id": 35443,
|
||||
"name": "status",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -686,7 +686,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35505,
|
||||
"id": 35444,
|
||||
"name": "data",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -732,8 +732,8 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
35504,
|
||||
35505
|
||||
35443,
|
||||
35444
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -759,7 +759,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35506,
|
||||
"id": 35445,
|
||||
"name": "cancelPayment",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -768,7 +768,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35507,
|
||||
"id": 35446,
|
||||
"name": "cancelPayment",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -803,7 +803,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35508,
|
||||
"id": 35447,
|
||||
"name": "paymentData",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -903,7 +903,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35509,
|
||||
"id": 35448,
|
||||
"name": "initiatePayment",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -912,7 +912,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35510,
|
||||
"id": 35449,
|
||||
"name": "initiatePayment",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -963,7 +963,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35511,
|
||||
"id": 35450,
|
||||
"name": "context",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1035,7 +1035,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35512,
|
||||
"id": 35451,
|
||||
"name": "deletePayment",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -1044,7 +1044,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35513,
|
||||
"id": 35452,
|
||||
"name": "deletePayment",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -1079,7 +1079,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35514,
|
||||
"id": 35453,
|
||||
"name": "paymentSessionData",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1179,7 +1179,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35515,
|
||||
"id": 35454,
|
||||
"name": "getPaymentStatus",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -1188,7 +1188,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35516,
|
||||
"id": 35455,
|
||||
"name": "getPaymentStatus",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -1223,7 +1223,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35517,
|
||||
"id": 35456,
|
||||
"name": "paymentSessionData",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1299,7 +1299,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35518,
|
||||
"id": 35457,
|
||||
"name": "refundPayment",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -1308,7 +1308,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35519,
|
||||
"id": 35458,
|
||||
"name": "refundPayment",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -1351,7 +1351,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35520,
|
||||
"id": 35459,
|
||||
"name": "paymentData",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1393,7 +1393,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35521,
|
||||
"id": 35460,
|
||||
"name": "refundAmount",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1470,7 +1470,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35522,
|
||||
"id": 35461,
|
||||
"name": "retrievePayment",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -1479,7 +1479,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35523,
|
||||
"id": 35462,
|
||||
"name": "retrievePayment",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -1522,7 +1522,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35524,
|
||||
"id": 35463,
|
||||
"name": "paymentSessionData",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1622,7 +1622,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35525,
|
||||
"id": 35464,
|
||||
"name": "updatePayment",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -1631,7 +1631,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35526,
|
||||
"id": 35465,
|
||||
"name": "updatePayment",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -1646,7 +1646,7 @@
|
||||
"kind": "inline-tag",
|
||||
"tag": "@link",
|
||||
"text": "initiatePayment",
|
||||
"target": 35509,
|
||||
"target": 35448,
|
||||
"tsLinkText": ""
|
||||
},
|
||||
{
|
||||
@@ -1693,7 +1693,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35527,
|
||||
"id": 35466,
|
||||
"name": "context",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1765,7 +1765,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35528,
|
||||
"id": 35467,
|
||||
"name": "getWebhookActionAndData",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -1774,7 +1774,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35529,
|
||||
"id": 35468,
|
||||
"name": "getWebhookActionAndData",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -1841,7 +1841,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35530,
|
||||
"id": 35469,
|
||||
"name": "data",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1857,14 +1857,14 @@
|
||||
"type": {
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 35531,
|
||||
"id": 35470,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 35532,
|
||||
"id": 35471,
|
||||
"name": "data",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1898,7 +1898,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35533,
|
||||
"id": 35472,
|
||||
"name": "rawData",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1932,7 +1932,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35534,
|
||||
"id": 35473,
|
||||
"name": "headers",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -1970,9 +1970,9 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
35532,
|
||||
35533,
|
||||
35534
|
||||
35471,
|
||||
35472,
|
||||
35473
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -2018,37 +2018,37 @@
|
||||
{
|
||||
"title": "Constructors",
|
||||
"children": [
|
||||
35487
|
||||
35426
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
35492,
|
||||
35493,
|
||||
35486
|
||||
35431,
|
||||
35432,
|
||||
35425
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Methods",
|
||||
"children": [
|
||||
35479,
|
||||
35496,
|
||||
35499,
|
||||
35506,
|
||||
35509,
|
||||
35512,
|
||||
35515,
|
||||
35518,
|
||||
35522,
|
||||
35525,
|
||||
35528
|
||||
35418,
|
||||
35435,
|
||||
35438,
|
||||
35445,
|
||||
35448,
|
||||
35451,
|
||||
35454,
|
||||
35457,
|
||||
35461,
|
||||
35464,
|
||||
35467
|
||||
]
|
||||
}
|
||||
],
|
||||
"typeParameters": [
|
||||
{
|
||||
"id": 35535,
|
||||
"id": 35474,
|
||||
"name": "TConfig",
|
||||
"variant": "typeParam",
|
||||
"kind": 131072,
|
||||
@@ -2091,221 +2091,221 @@
|
||||
{
|
||||
"title": "Classes",
|
||||
"children": [
|
||||
35478
|
||||
35417
|
||||
]
|
||||
}
|
||||
],
|
||||
"packageName": "@medusajs/utils",
|
||||
"symbolIdMap": {
|
||||
"35474": {
|
||||
"35413": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": ""
|
||||
},
|
||||
"35478": {
|
||||
"35417": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider"
|
||||
},
|
||||
"35479": {
|
||||
"35418": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.validateOptions"
|
||||
},
|
||||
"35480": {
|
||||
"35419": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.validateOptions"
|
||||
},
|
||||
"35481": {
|
||||
"35420": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "options"
|
||||
},
|
||||
"35486": {
|
||||
"35425": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.identifier"
|
||||
},
|
||||
"35487": {
|
||||
"35426": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.__constructor"
|
||||
},
|
||||
"35488": {
|
||||
"35427": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider"
|
||||
},
|
||||
"35489": {
|
||||
"35428": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.TConfig"
|
||||
},
|
||||
"35490": {
|
||||
"35429": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "container"
|
||||
},
|
||||
"35491": {
|
||||
"35430": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "config"
|
||||
},
|
||||
"35492": {
|
||||
"35431": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.container"
|
||||
},
|
||||
"35493": {
|
||||
"35432": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.config"
|
||||
},
|
||||
"35496": {
|
||||
"35435": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.capturePayment"
|
||||
},
|
||||
"35497": {
|
||||
"35436": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.capturePayment"
|
||||
},
|
||||
"35498": {
|
||||
"35437": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "paymentData"
|
||||
},
|
||||
"35499": {
|
||||
"35438": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.authorizePayment"
|
||||
},
|
||||
"35500": {
|
||||
"35439": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.authorizePayment"
|
||||
},
|
||||
"35501": {
|
||||
"35440": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "paymentSessionData"
|
||||
},
|
||||
"35502": {
|
||||
"35441": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "context"
|
||||
},
|
||||
"35503": {
|
||||
"35442": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"35504": {
|
||||
"35443": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "__type.status"
|
||||
},
|
||||
"35505": {
|
||||
"35444": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "__type.data"
|
||||
},
|
||||
"35506": {
|
||||
"35445": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.cancelPayment"
|
||||
},
|
||||
"35507": {
|
||||
"35446": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.cancelPayment"
|
||||
},
|
||||
"35508": {
|
||||
"35447": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "paymentData"
|
||||
},
|
||||
"35509": {
|
||||
"35448": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.initiatePayment"
|
||||
},
|
||||
"35510": {
|
||||
"35449": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.initiatePayment"
|
||||
},
|
||||
"35511": {
|
||||
"35450": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "context"
|
||||
},
|
||||
"35512": {
|
||||
"35451": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.deletePayment"
|
||||
},
|
||||
"35513": {
|
||||
"35452": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.deletePayment"
|
||||
},
|
||||
"35514": {
|
||||
"35453": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "paymentSessionData"
|
||||
},
|
||||
"35515": {
|
||||
"35454": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.getPaymentStatus"
|
||||
},
|
||||
"35516": {
|
||||
"35455": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.getPaymentStatus"
|
||||
},
|
||||
"35517": {
|
||||
"35456": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "paymentSessionData"
|
||||
},
|
||||
"35518": {
|
||||
"35457": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.refundPayment"
|
||||
},
|
||||
"35519": {
|
||||
"35458": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.refundPayment"
|
||||
},
|
||||
"35520": {
|
||||
"35459": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "paymentData"
|
||||
},
|
||||
"35521": {
|
||||
"35460": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "refundAmount"
|
||||
},
|
||||
"35522": {
|
||||
"35461": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.retrievePayment"
|
||||
},
|
||||
"35523": {
|
||||
"35462": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.retrievePayment"
|
||||
},
|
||||
"35524": {
|
||||
"35463": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "paymentSessionData"
|
||||
},
|
||||
"35525": {
|
||||
"35464": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.updatePayment"
|
||||
},
|
||||
"35526": {
|
||||
"35465": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.updatePayment"
|
||||
},
|
||||
"35527": {
|
||||
"35466": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "context"
|
||||
},
|
||||
"35528": {
|
||||
"35467": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.getWebhookActionAndData"
|
||||
},
|
||||
"35529": {
|
||||
"35468": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.getWebhookActionAndData"
|
||||
},
|
||||
"35530": {
|
||||
"35469": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "data"
|
||||
},
|
||||
"35531": {
|
||||
"35470": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"35532": {
|
||||
"35471": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
|
||||
"qualifiedName": "__type.data"
|
||||
},
|
||||
"35533": {
|
||||
"35472": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
|
||||
"qualifiedName": "__type.rawData"
|
||||
},
|
||||
"35534": {
|
||||
"35473": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
|
||||
"qualifiedName": "__type.headers"
|
||||
},
|
||||
"35535": {
|
||||
"35474": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
|
||||
"qualifiedName": "AbstractPaymentProvider.TConfig"
|
||||
}
|
||||
@@ -2315,7 +2315,7 @@
|
||||
"1": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts"
|
||||
},
|
||||
"reflections": {
|
||||
"1": 35474
|
||||
"1": 35413
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"id": 35536,
|
||||
"id": 35475,
|
||||
"name": "search",
|
||||
"variant": "project",
|
||||
"kind": 1,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 35537,
|
||||
"id": 35476,
|
||||
"name": "AbstractSearchService",
|
||||
"variant": "declaration",
|
||||
"kind": 128,
|
||||
@@ -111,7 +111,7 @@
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"id": 35546,
|
||||
"id": 35485,
|
||||
"name": "isDefault",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -149,7 +149,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35547,
|
||||
"id": 35486,
|
||||
"name": "options_",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -186,7 +186,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35542,
|
||||
"id": 35481,
|
||||
"name": "constructor",
|
||||
"variant": "declaration",
|
||||
"kind": 512,
|
||||
@@ -195,7 +195,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35543,
|
||||
"id": 35482,
|
||||
"name": "new AbstractSearchService",
|
||||
"variant": "signature",
|
||||
"kind": 16384,
|
||||
@@ -237,7 +237,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35544,
|
||||
"id": 35483,
|
||||
"name": "container",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -264,7 +264,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35545,
|
||||
"id": 35484,
|
||||
"name": "options",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -285,7 +285,7 @@
|
||||
],
|
||||
"type": {
|
||||
"type": "reference",
|
||||
"target": 35537,
|
||||
"target": 35476,
|
||||
"name": "AbstractSearchService",
|
||||
"package": "@medusajs/utils"
|
||||
}
|
||||
@@ -293,7 +293,7 @@
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 35550,
|
||||
"id": 35489,
|
||||
"name": "createIndex",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -302,7 +302,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35551,
|
||||
"id": 35490,
|
||||
"name": "createIndex",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -365,7 +365,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35552,
|
||||
"id": 35491,
|
||||
"name": "indexName",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -384,7 +384,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35553,
|
||||
"id": 35492,
|
||||
"name": "options",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -421,7 +421,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35554,
|
||||
"id": 35493,
|
||||
"name": "getIndex",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -430,7 +430,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35555,
|
||||
"id": 35494,
|
||||
"name": "getIndex",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -465,7 +465,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35556,
|
||||
"id": 35495,
|
||||
"name": "indexName",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -502,7 +502,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35557,
|
||||
"id": 35496,
|
||||
"name": "addDocuments",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -511,7 +511,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35558,
|
||||
"id": 35497,
|
||||
"name": "addDocuments",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -546,7 +546,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35559,
|
||||
"id": 35498,
|
||||
"name": "indexName",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -565,7 +565,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35560,
|
||||
"id": 35499,
|
||||
"name": "documents",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -593,7 +593,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35561,
|
||||
"id": 35500,
|
||||
"name": "type",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -638,7 +638,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35562,
|
||||
"id": 35501,
|
||||
"name": "replaceDocuments",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -647,7 +647,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35563,
|
||||
"id": 35502,
|
||||
"name": "replaceDocuments",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -682,7 +682,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35564,
|
||||
"id": 35503,
|
||||
"name": "indexName",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -701,7 +701,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35565,
|
||||
"id": 35504,
|
||||
"name": "documents",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -729,7 +729,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35566,
|
||||
"id": 35505,
|
||||
"name": "type",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -774,7 +774,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35567,
|
||||
"id": 35506,
|
||||
"name": "deleteDocument",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -783,7 +783,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35568,
|
||||
"id": 35507,
|
||||
"name": "deleteDocument",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -818,7 +818,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35569,
|
||||
"id": 35508,
|
||||
"name": "indexName",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -837,7 +837,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35570,
|
||||
"id": 35509,
|
||||
"name": "document_id",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -883,7 +883,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35571,
|
||||
"id": 35510,
|
||||
"name": "deleteAllDocuments",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -892,7 +892,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35572,
|
||||
"id": 35511,
|
||||
"name": "deleteAllDocuments",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -927,7 +927,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35573,
|
||||
"id": 35512,
|
||||
"name": "indexName",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -964,7 +964,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35574,
|
||||
"id": 35513,
|
||||
"name": "search",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -973,7 +973,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35575,
|
||||
"id": 35514,
|
||||
"name": "search",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -1008,7 +1008,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35576,
|
||||
"id": 35515,
|
||||
"name": "indexName",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1035,7 +1035,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35577,
|
||||
"id": 35516,
|
||||
"name": "query",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1063,7 +1063,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35578,
|
||||
"id": 35517,
|
||||
"name": "options",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1140,7 +1140,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35579,
|
||||
"id": 35518,
|
||||
"name": "updateSettings",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
@@ -1149,7 +1149,7 @@
|
||||
},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35580,
|
||||
"id": 35519,
|
||||
"name": "updateSettings",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -1184,7 +1184,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35581,
|
||||
"id": 35520,
|
||||
"name": "indexName",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1203,7 +1203,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35582,
|
||||
"id": 35521,
|
||||
"name": "settings",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -1244,27 +1244,27 @@
|
||||
{
|
||||
"title": "Constructors",
|
||||
"children": [
|
||||
35542
|
||||
35481
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
35546,
|
||||
35547
|
||||
35485,
|
||||
35486
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Methods",
|
||||
"children": [
|
||||
35550,
|
||||
35554,
|
||||
35557,
|
||||
35562,
|
||||
35567,
|
||||
35571,
|
||||
35574,
|
||||
35579
|
||||
35489,
|
||||
35493,
|
||||
35496,
|
||||
35501,
|
||||
35506,
|
||||
35510,
|
||||
35513,
|
||||
35518
|
||||
]
|
||||
}
|
||||
],
|
||||
@@ -1285,173 +1285,173 @@
|
||||
{
|
||||
"title": "Classes",
|
||||
"children": [
|
||||
35537
|
||||
35476
|
||||
]
|
||||
}
|
||||
],
|
||||
"packageName": "@medusajs/utils",
|
||||
"symbolIdMap": {
|
||||
"35536": {
|
||||
"35475": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": ""
|
||||
},
|
||||
"35537": {
|
||||
"35476": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService"
|
||||
},
|
||||
"35542": {
|
||||
"35481": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.__constructor"
|
||||
},
|
||||
"35543": {
|
||||
"35482": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService"
|
||||
},
|
||||
"35544": {
|
||||
"35483": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "container"
|
||||
},
|
||||
"35545": {
|
||||
"35484": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "options"
|
||||
},
|
||||
"35546": {
|
||||
"35485": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.isDefault"
|
||||
},
|
||||
"35547": {
|
||||
"35486": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.options_"
|
||||
},
|
||||
"35550": {
|
||||
"35489": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.createIndex"
|
||||
},
|
||||
"35551": {
|
||||
"35490": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.createIndex"
|
||||
},
|
||||
"35552": {
|
||||
"35491": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "indexName"
|
||||
},
|
||||
"35553": {
|
||||
"35492": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "options"
|
||||
},
|
||||
"35554": {
|
||||
"35493": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.getIndex"
|
||||
},
|
||||
"35555": {
|
||||
"35494": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.getIndex"
|
||||
},
|
||||
"35556": {
|
||||
"35495": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "indexName"
|
||||
},
|
||||
"35557": {
|
||||
"35496": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.addDocuments"
|
||||
},
|
||||
"35558": {
|
||||
"35497": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.addDocuments"
|
||||
},
|
||||
"35559": {
|
||||
"35498": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "indexName"
|
||||
},
|
||||
"35560": {
|
||||
"35499": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "documents"
|
||||
},
|
||||
"35561": {
|
||||
"35500": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "type"
|
||||
},
|
||||
"35562": {
|
||||
"35501": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.replaceDocuments"
|
||||
},
|
||||
"35563": {
|
||||
"35502": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.replaceDocuments"
|
||||
},
|
||||
"35564": {
|
||||
"35503": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "indexName"
|
||||
},
|
||||
"35565": {
|
||||
"35504": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "documents"
|
||||
},
|
||||
"35566": {
|
||||
"35505": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "type"
|
||||
},
|
||||
"35567": {
|
||||
"35506": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.deleteDocument"
|
||||
},
|
||||
"35568": {
|
||||
"35507": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.deleteDocument"
|
||||
},
|
||||
"35569": {
|
||||
"35508": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "indexName"
|
||||
},
|
||||
"35570": {
|
||||
"35509": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "document_id"
|
||||
},
|
||||
"35571": {
|
||||
"35510": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.deleteAllDocuments"
|
||||
},
|
||||
"35572": {
|
||||
"35511": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.deleteAllDocuments"
|
||||
},
|
||||
"35573": {
|
||||
"35512": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "indexName"
|
||||
},
|
||||
"35574": {
|
||||
"35513": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.search"
|
||||
},
|
||||
"35575": {
|
||||
"35514": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.search"
|
||||
},
|
||||
"35576": {
|
||||
"35515": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "indexName"
|
||||
},
|
||||
"35577": {
|
||||
"35516": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "query"
|
||||
},
|
||||
"35578": {
|
||||
"35517": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "options"
|
||||
},
|
||||
"35579": {
|
||||
"35518": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.updateSettings"
|
||||
},
|
||||
"35580": {
|
||||
"35519": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "AbstractSearchService.updateSettings"
|
||||
},
|
||||
"35581": {
|
||||
"35520": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "indexName"
|
||||
},
|
||||
"35582": {
|
||||
"35521": {
|
||||
"sourceFileName": "../../../../packages/core/utils/src/search/abstract-service.ts",
|
||||
"qualifiedName": "settings"
|
||||
}
|
||||
@@ -1461,7 +1461,7 @@
|
||||
"1": "../../../../packages/core/utils/src/search/abstract-service.ts"
|
||||
},
|
||||
"reflections": {
|
||||
"1": 35536
|
||||
"1": 35475
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"id": 35583,
|
||||
"id": 35522,
|
||||
"name": "tax-provider",
|
||||
"variant": "project",
|
||||
"kind": 1,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 35584,
|
||||
"id": 35523,
|
||||
"name": "ShippingTaxCalculationLine",
|
||||
"variant": "declaration",
|
||||
"kind": 2097152,
|
||||
@@ -22,14 +22,14 @@
|
||||
"type": {
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 35585,
|
||||
"id": 35524,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 35586,
|
||||
"id": 35525,
|
||||
"name": "shipping_line",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -53,7 +53,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35587,
|
||||
"id": 35526,
|
||||
"name": "rates",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -84,8 +84,8 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
35586,
|
||||
35587
|
||||
35525,
|
||||
35526
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -93,7 +93,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35588,
|
||||
"id": 35527,
|
||||
"name": "ItemTaxCalculationLine",
|
||||
"variant": "declaration",
|
||||
"kind": 2097152,
|
||||
@@ -109,14 +109,14 @@
|
||||
"type": {
|
||||
"type": "reflection",
|
||||
"declaration": {
|
||||
"id": 35589,
|
||||
"id": 35528,
|
||||
"name": "__type",
|
||||
"variant": "declaration",
|
||||
"kind": 65536,
|
||||
"flags": {},
|
||||
"children": [
|
||||
{
|
||||
"id": 35590,
|
||||
"id": 35529,
|
||||
"name": "line_item",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -140,7 +140,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35591,
|
||||
"id": 35530,
|
||||
"name": "rates",
|
||||
"variant": "declaration",
|
||||
"kind": 1024,
|
||||
@@ -171,8 +171,8 @@
|
||||
{
|
||||
"title": "Properties",
|
||||
"children": [
|
||||
35590,
|
||||
35591
|
||||
35529,
|
||||
35530
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -180,7 +180,7 @@
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35592,
|
||||
"id": 35531,
|
||||
"name": "ITaxProvider",
|
||||
"variant": "declaration",
|
||||
"kind": 256,
|
||||
@@ -283,14 +283,14 @@
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"id": 35595,
|
||||
"id": 35534,
|
||||
"name": "getTaxLines",
|
||||
"variant": "declaration",
|
||||
"kind": 2048,
|
||||
"flags": {},
|
||||
"signatures": [
|
||||
{
|
||||
"id": 35596,
|
||||
"id": 35535,
|
||||
"name": "getTaxLines",
|
||||
"variant": "signature",
|
||||
"kind": 4096,
|
||||
@@ -361,7 +361,7 @@
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"id": 35597,
|
||||
"id": 35536,
|
||||
"name": "itemLines",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -378,14 +378,14 @@
|
||||
"type": "array",
|
||||
"elementType": {
|
||||
"type": "reference",
|
||||
"target": 35588,
|
||||
"target": 35527,
|
||||
"name": "ItemTaxCalculationLine",
|
||||
"package": "@medusajs/types"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35598,
|
||||
"id": 35537,
|
||||
"name": "shippingLines",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -402,14 +402,14 @@
|
||||
"type": "array",
|
||||
"elementType": {
|
||||
"type": "reference",
|
||||
"target": 35584,
|
||||
"target": 35523,
|
||||
"name": "ShippingTaxCalculationLine",
|
||||
"package": "@medusajs/types"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 35599,
|
||||
"id": 35538,
|
||||
"name": "context",
|
||||
"variant": "param",
|
||||
"kind": 32768,
|
||||
@@ -478,7 +478,7 @@
|
||||
{
|
||||
"title": "Methods",
|
||||
"children": [
|
||||
35595
|
||||
35534
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -488,76 +488,76 @@
|
||||
{
|
||||
"title": "Interfaces",
|
||||
"children": [
|
||||
35592
|
||||
35531
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Type Aliases",
|
||||
"children": [
|
||||
35584,
|
||||
35588
|
||||
35523,
|
||||
35527
|
||||
]
|
||||
}
|
||||
],
|
||||
"packageName": "@medusajs/types",
|
||||
"symbolIdMap": {
|
||||
"35583": {
|
||||
"35522": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": ""
|
||||
},
|
||||
"35584": {
|
||||
"35523": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "ShippingTaxCalculationLine"
|
||||
},
|
||||
"35585": {
|
||||
"35524": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"35586": {
|
||||
"35525": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type.shipping_line"
|
||||
},
|
||||
"35587": {
|
||||
"35526": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type.rates"
|
||||
},
|
||||
"35588": {
|
||||
"35527": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "ItemTaxCalculationLine"
|
||||
},
|
||||
"35589": {
|
||||
"35528": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type"
|
||||
},
|
||||
"35590": {
|
||||
"35529": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type.line_item"
|
||||
},
|
||||
"35591": {
|
||||
"35530": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "__type.rates"
|
||||
},
|
||||
"35592": {
|
||||
"35531": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "ITaxProvider"
|
||||
},
|
||||
"35595": {
|
||||
"35534": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "ITaxProvider.getTaxLines"
|
||||
},
|
||||
"35596": {
|
||||
"35535": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "ITaxProvider.getTaxLines"
|
||||
},
|
||||
"35597": {
|
||||
"35536": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "itemLines"
|
||||
},
|
||||
"35598": {
|
||||
"35537": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "shippingLines"
|
||||
},
|
||||
"35599": {
|
||||
"35538": {
|
||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||
"qualifiedName": "context"
|
||||
}
|
||||
@@ -567,7 +567,7 @@
|
||||
"1": "../../../../packages/core/types/src/tax/provider.ts"
|
||||
},
|
||||
"reflections": {
|
||||
"1": 35583
|
||||
"1": 35522
|
||||
}
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large.
Load diff
Reference in new issue
Block a user