chore(docs): Generated References (#8360)
Generated the following references: - `currency_models` - `medusa_config` - `region_models` - `types`
This commit is contained in:
1 parent
69ddd1e081
commit
aac906f058
86 files changed
+37867
-20774
No files matched your search
@@ -3215,6 +3215,58 @@ export const filesMap = [
|
|||||||
"filePath": "/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx",
|
"filePath": "/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx",
|
||||||
"pathname": "/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService"
|
"pathname": "/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.createRemoteLinkStep/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/functions/helper_steps.createRemoteLinkStep"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.removeRemoteLinkStep/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/functions/helper_steps.removeRemoteLinkStep"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/functions/helper_steps.useRemoteQueryStep"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/interfaces/helper_steps.EntryStepInput/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/interfaces/helper_steps.EntryStepInput"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/interfaces/helper_steps.RemoteStepInput/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/interfaces/helper_steps.RemoteStepInput"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/interfaces/helper_steps.ServiceStepInput/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/interfaces/helper_steps.ServiceStepInput"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/types/helper_steps.DismissRemoteLinksStepInput/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/types/helper_steps.DismissRemoteLinksStepInput"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/variables/helper_steps.createLinksStepId/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/variables/helper_steps.createLinksStepId"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/variables/helper_steps.dismissRemoteLinkStepId/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/variables/helper_steps.dismissRemoteLinkStepId"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/variables/helper_steps.emitEventStepId/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/variables/helper_steps.emitEventStepId"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/variables/helper_steps.removeRemoteLinkStepId/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/variables/helper_steps.removeRemoteLinkStepId"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/variables/helper_steps.useRemoteQueryStepId/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/variables/helper_steps.useRemoteQueryStepId"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"filePath": "/www/apps/resources/references/inventory_next/IBigNumber/methods/inventory_next.IBigNumber.toJSON/page.mdx",
|
"filePath": "/www/apps/resources/references/inventory_next/IBigNumber/methods/inventory_next.IBigNumber.toJSON/page.mdx",
|
||||||
"pathname": "/references/inventory_next/IBigNumber/methods/inventory_next.IBigNumber.toJSON"
|
"pathname": "/references/inventory_next/IBigNumber/methods/inventory_next.IBigNumber.toJSON"
|
||||||
@@ -3739,6 +3791,10 @@ export const filesMap = [
|
|||||||
"filePath": "/www/apps/resources/references/modules/fulfillment_provider/page.mdx",
|
"filePath": "/www/apps/resources/references/modules/fulfillment_provider/page.mdx",
|
||||||
"pathname": "/references/modules/fulfillment_provider"
|
"pathname": "/references/modules/fulfillment_provider"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules/helper_steps/page.mdx",
|
||||||
|
"pathname": "/references/modules/helper_steps"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"filePath": "/www/apps/resources/references/modules/inventory_next/page.mdx",
|
"filePath": "/www/apps/resources/references/modules/inventory_next/page.mdx",
|
||||||
"pathname": "/references/modules/inventory_next"
|
"pathname": "/references/modules/inventory_next"
|
||||||
@@ -3755,6 +3811,10 @@ export const filesMap = [
|
|||||||
"filePath": "/www/apps/resources/references/modules/medusa_config/page.mdx",
|
"filePath": "/www/apps/resources/references/modules/medusa_config/page.mdx",
|
||||||
"pathname": "/references/modules/medusa_config"
|
"pathname": "/references/modules/medusa_config"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules/modules_sdk/page.mdx",
|
||||||
|
"pathname": "/references/modules/modules_sdk"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"filePath": "/www/apps/resources/references/modules/notification/page.mdx",
|
"filePath": "/www/apps/resources/references/modules/notification/page.mdx",
|
||||||
"pathname": "/references/modules/notification"
|
"pathname": "/references/modules/notification"
|
||||||
@@ -3871,6 +3931,198 @@ export const filesMap = [
|
|||||||
"filePath": "/www/apps/resources/references/modules/workflows/page.mdx",
|
"filePath": "/www/apps/resources/references/modules/workflows/page.mdx",
|
||||||
"pathname": "/references/modules/workflows"
|
"pathname": "/references/modules/workflows"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/classes/modules_sdk.RemoteLink/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/classes/modules_sdk.RemoteLink"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/classes/modules_sdk.RemoteQuery/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/classes/modules_sdk.RemoteQuery"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/enums/modules_sdk.MODULE_RESOURCE_TYPE/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/enums/modules_sdk.MODULE_RESOURCE_TYPE"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/enums/modules_sdk.MODULE_SCOPE/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/enums/modules_sdk.MODULE_SCOPE"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/interfaces/modules_sdk.IMedusaInternalService/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/interfaces/modules_sdk.IMedusaInternalService"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/interfaces/modules_sdk.IModuleService/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/interfaces/modules_sdk.IModuleService"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/interfaces/modules_sdk.ModuleImplementations/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/interfaces/modules_sdk.ModuleImplementations"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/interfaces/modules_sdk.ModuleServiceInitializeOptions/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/interfaces/modules_sdk.ModuleServiceInitializeOptions"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.Constructor/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.Constructor"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ContainerLike/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ContainerLike"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.CustomModuleDefinition"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.DeleteEntityInput/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.DeleteEntityInput"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ExternalModuleDeclaration/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ExternalModuleDeclaration"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.GenerateMigrations/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.GenerateMigrations"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.GetLinkExecutionPlanner/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.GetLinkExecutionPlanner"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.InternalModuleDeclaration"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.LinkDefinition/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.LinkDefinition"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.LinkModuleBootstrapOptions/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.LinkModuleBootstrapOptions"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.LinkModuleDefinition/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.LinkModuleDefinition"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.LinkModulesExtraFields/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.LinkModulesExtraFields"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.LoadedModule/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.LoadedModule"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.LoaderOptions/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.LoaderOptions"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.LogLevel/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.LogLevel"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.LoggerOptions/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.LoggerOptions"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.MedusaAppOptions"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.MedusaAppOutput"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.MedusaContainer/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.MedusaContainer"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.MedusaModuleConfig"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.MigrationOptions/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.MigrationOptions"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleBootstrapDeclaration/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleBootstrapDeclaration"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleBootstrapOptions/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleBootstrapOptions"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleConfig/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleConfig"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleDefinition"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleExports/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleExports"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleJoinerConfig/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleJoinerConfig"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleJoinerRelationship/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleJoinerRelationship"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleLoaderFunction/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleLoaderFunction"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleProvider/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleProvider"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleProviderExports/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleProviderExports"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleResolution/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleResolution"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModuleServiceInitializeCustomDataLayerOptions/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModuleServiceInitializeCustomDataLayerOptions"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.ModulesResponse/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.ModulesResponse"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.RemoteQueryFunction/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.RemoteQueryFunction"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.RestoreEntityInput/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.RestoreEntityInput"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.RevertMigrationFn/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.RevertMigrationFn"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.RunMigrationFn/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.RunMigrationFn"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/modules_sdk/types/modules_sdk.SharedResources/page.mdx",
|
||||||
|
"pathname": "/references/modules_sdk/types/modules_sdk.SharedResources"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"filePath": "/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx",
|
"filePath": "/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx",
|
||||||
"pathname": "/references/notification/classes/notification.AbstractNotificationProviderService"
|
"pathname": "/references/notification/classes/notification.AbstractNotificationProviderService"
|
||||||
@@ -8511,6 +8763,10 @@ export const filesMap = [
|
|||||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBaseReturnItem/page.mdx",
|
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBaseReturnItem/page.mdx",
|
||||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBaseReturnItem"
|
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBaseReturnItem"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchLink/page.mdx",
|
||||||
|
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchLink"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchPriceListPrice/page.mdx",
|
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchPriceListPrice/page.mdx",
|
||||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchPriceListPrice"
|
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchPriceListPrice"
|
||||||
|
|||||||
@@ -1099,6 +1099,26 @@ export const slugChanges = [
|
|||||||
"newSlug": "/references/fulfillment/provider",
|
"newSlug": "/references/fulfillment/provider",
|
||||||
"filePath": "/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx"
|
"filePath": "/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"origSlug": "/references/helper_steps/functions/helper_steps.createRemoteLinkStep",
|
||||||
|
"newSlug": "/references/helper-steps/createRemoteLinkStep",
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.createRemoteLinkStep/page.mdx"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"origSlug": "/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep",
|
||||||
|
"newSlug": "/references/helper-steps/dismissRemoteLinkStep",
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"origSlug": "/references/helper_steps/functions/helper_steps.removeRemoteLinkStep",
|
||||||
|
"newSlug": "/references/helper-steps/removeRemoteLinkStep",
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.removeRemoteLinkStep/page.mdx"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"origSlug": "/references/helper_steps/functions/helper_steps.useRemoteQueryStep",
|
||||||
|
"newSlug": "/references/helper-steps/useRemoteQueryStep",
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"origSlug": "/references/inventory_next/IInventoryService/methods/inventory_next.IInventoryService.adjustInventory",
|
"origSlug": "/references/inventory_next/IInventoryService/methods/inventory_next.IInventoryService.adjustInventory",
|
||||||
"newSlug": "/references/inventory-next/adjustInventory",
|
"newSlug": "/references/inventory-next/adjustInventory",
|
||||||
@@ -1334,6 +1354,11 @@ export const slugChanges = [
|
|||||||
"newSlug": "/references/fulfillment/models",
|
"newSlug": "/references/fulfillment/models",
|
||||||
"filePath": "/www/apps/resources/references/modules/fulfillment_models/page.mdx"
|
"filePath": "/www/apps/resources/references/modules/fulfillment_models/page.mdx"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"origSlug": "/references/modules/helper_steps",
|
||||||
|
"newSlug": "/references/helper-steps",
|
||||||
|
"filePath": "/www/apps/resources/references/modules/helper_steps/page.mdx"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"origSlug": "/references/modules/inventory_next_models",
|
"origSlug": "/references/modules/inventory_next_models",
|
||||||
"newSlug": "/references/inventory-next/models",
|
"newSlug": "/references/inventory-next/models",
|
||||||
|
|||||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the Currency . This belongs to the Currency Module.
|
This documentation provides a reference to the Currency . This belongs to the Currency Module.
|
||||||
|
|
||||||
<TypeList types={[{"name":"code","type":"PrimaryKeyModifier<TextProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"decimal_digits","type":"`NumberProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rounding","type":"`BigNumberProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Currency"/>
|
<TypeList types={[{"name":"code","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 3-character currency code. For example, `USD`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`TextProperty`","description":"The symbol of the currency. For example, `$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`TextProperty`","description":"The native symbol of the currency, if it has a different local symbol.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"decimal_digits","type":"`NumberProperty`","description":"How many digits are after the decimal separator for prices in this currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rounding","type":"`BigNumberProperty`","description":"The rounding percision of prices in this currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Currency"/>
|
||||||
+18
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
slug: /references/helper-steps/createRemoteLinkStep
|
||||||
|
sidebar_label: createRemoteLinkStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# createRemoteLinkStep - Helper Steps API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `createRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="createRemoteLinkStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="createRemoteLinkStep"/>
|
||||||
+18
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
slug: /references/helper-steps/dismissRemoteLinkStep
|
||||||
|
sidebar_label: dismissRemoteLinkStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# dismissRemoteLinkStep - Helper Steps API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `dismissRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"DismissRemoteLinksStepInput","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx) \\| [LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="dismissRemoteLinkStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"`object` & `object`","description":"A link for two records of linked data models.\n\nThe keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="dismissRemoteLinkStep"/>
|
||||||
+18
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
slug: /references/helper-steps/removeRemoteLinkStep
|
||||||
|
sidebar_label: removeRemoteLinkStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# removeRemoteLinkStep - Helper Steps API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `removeRemoteLinkStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"RemoveRemoteLinksStepInput","type":"`RemoveRemoteLinksStepInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="removeRemoteLinkStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"DeleteEntityInput","type":"`object`","description":"The details of a data model's record whose linked records should be deleted. Usually used after the\ndata model's record is deleted.\n\nThe key is the data model's name. Its value is an object that has the ID of the data model's record.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="removeRemoteLinkStep"/>
|
||||||
+18
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
slug: /references/helper-steps/useRemoteQueryStep
|
||||||
|
sidebar_label: useRemoteQueryStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# useRemoteQueryStep - Helper Steps API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `useRemoteQueryStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"EntryStepInput \\| ServiceStepInput","type":"[EntryStepInput](../../interfaces/helper_steps.EntryStepInput/page.mdx) \\| [ServiceStepInput](../../interfaces/helper_steps.ServiceStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="useRemoteQueryStep"/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="useRemoteQueryStep"/>
|
||||||
+7
@@ -0,0 +1,7 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# EntryStepInput
|
||||||
|
|
||||||
|
The remote query's details.
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"fields","type":"`string`[]","description":"The fields to retrieve in the records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entry_point","type":"`string`","description":"The name of the data model to retrieve its records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variables","type":"`Record<string, any>`","description":"Filters, context variables, or pagination fields to apply when retrieving the records.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_key_not_found","type":"`boolean`","description":"Throw an error if a record isn't found matching an ID specified in the filters.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_relation_not_found","type":"`boolean` \\| `string`[]","description":"Throw an error if a specified relation isn't found.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"`boolean`","description":"Whether to retrieve the records as an array. If disabled, only one record is retrieved as an object.","optional":true,"defaultValue":"true","expandable":false,"children":[]}]} sectionTitle="EntryStepInput"/>
|
||||||
+7
@@ -0,0 +1,7 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# RemoteStepInput
|
||||||
|
|
||||||
|
The remote query's details.
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"fields","type":"`string`[]","description":"The fields to retrieve in the records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variables","type":"`Record<string, any>`","description":"Filters, context variables, or pagination fields to apply when retrieving the records.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_key_not_found","type":"`boolean`","description":"Throw an error if a record isn't found matching an ID specified in the filters.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_relation_not_found","type":"`boolean` \\| `string`[]","description":"Throw an error if a specified relation isn't found.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"`boolean`","description":"Whether to retrieve the records as an array. If disabled, only one record is retrieved as an object.","optional":true,"defaultValue":"true","expandable":false,"children":[]}]} sectionTitle="RemoteStepInput"/>
|
||||||
+7
@@ -0,0 +1,7 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ServiceStepInput
|
||||||
|
|
||||||
|
The remote query's details.
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"fields","type":"`string`[]","description":"The fields to retrieve in the records.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service","type":"`string`","description":"The name of the module's service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variables","type":"`Record<string, any>`","description":"Filters, context variables, or pagination fields to apply when retrieving the records.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_key_not_found","type":"`boolean`","description":"Throw an error if a record isn't found matching an ID specified in the filters.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throw_if_relation_not_found","type":"`boolean` \\| `string`[]","description":"Throw an error if a specified relation isn't found.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"`boolean`","description":"Whether to retrieve the records as an array. If disabled, only one record is retrieved as an object.","optional":true,"defaultValue":"true","expandable":false,"children":[]}]} sectionTitle="ServiceStepInput"/>
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# DismissRemoteLinksStepInput
|
||||||
|
|
||||||
|
**DismissRemoteLinksStepInput**: [LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx) \| [LinkDefinition](../../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)[]
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# createLinksStepId
|
||||||
|
|
||||||
|
`Const` **createLinksStepId**: `"create-remote-links"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# dismissRemoteLinkStepId
|
||||||
|
|
||||||
|
`Const` **dismissRemoteLinkStepId**: `"dismiss-remote-links"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# emitEventStepId
|
||||||
|
|
||||||
|
`Const` **emitEventStepId**: `"emit-event-step"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# removeRemoteLinkStepId
|
||||||
|
|
||||||
|
`Const` **removeRemoteLinkStepId**: `"remove-remote-links"`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# useRemoteQueryStepId
|
||||||
|
|
||||||
|
`Const` **useRemoteQueryStepId**: `"use-remote-query"`
|
||||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
Essential configurations related to the Medusa backend, such as database and CORS configurations.
|
Essential configurations related to the Medusa backend, such as database and CORS configurations.
|
||||||
|
|
||||||
<TypeList types={[{"name":"http","type":"`object`","description":"Configure the application's http-specific settings","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret` However, in production, if this configuration is not set an error, an\nerror is thrown and the backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. If not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret` However, in production, if this configuration is not set, an error is thrown and\nthe backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../medusa_config.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIts value is an object that has the following properties:\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"enabled","type":"`boolean`","description":"Whether HTTP compression is enabled. By default, it's `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"level","type":"`number`","description":"The level of zlib compression to apply to responses. A higher level will result in better compression but will take longer to complete.\nA lower level will result in less compression but will be much faster. The default value is `6`."Line truncated
|
<TypeList types={[{"name":"http","type":"`object`","description":"Configure the application's http-specific settings","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret` However, in production, if this configuration is not set an error, an\nerror is thrown and the backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. If not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret` However, in production, if this configuration is not set, an error is thrown and\nthe backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../medusa_config.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIts value is an object that has the following properties:\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"enabled","type":"`boolean`","description":"Whether HTTP compression is enabled. By default, it's `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"level","type":"`number`","description":"The level of zlib compression to apply to responses. A higher level will result in better compression but will take longer to complete.\nA lower level will result in less compression but will be much faster. The default value is `6`."Line truncated
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
---
|
||||||
|
slug: /references/helper-steps
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# Helper Steps API Reference
|
||||||
|
|
||||||
|
This section of the documentation provides a reference to utility steps that you can use in your workflows. These steps are imported from the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
- [createRemoteLinkStep](../../helper_steps/functions/helper_steps.createRemoteLinkStep/page.mdx)
|
||||||
|
- [dismissRemoteLinkStep](../../helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx)
|
||||||
|
- [removeRemoteLinkStep](../../helper_steps/functions/helper_steps.removeRemoteLinkStep/page.mdx)
|
||||||
|
- [useRemoteQueryStep](../../helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx)
|
||||||
@@ -0,0 +1,201 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# modules-sdk
|
||||||
|
|
||||||
|
## Enumerations
|
||||||
|
|
||||||
|
- [MODULE\_SCOPE](../../modules_sdk/enums/modules_sdk.MODULE_SCOPE/page.mdx)
|
||||||
|
- [MODULE\_RESOURCE\_TYPE](../../modules_sdk/enums/modules_sdk.MODULE_RESOURCE_TYPE/page.mdx)
|
||||||
|
|
||||||
|
## Classes
|
||||||
|
|
||||||
|
- [RemoteLink](../../modules_sdk/classes/modules_sdk.RemoteLink/page.mdx)
|
||||||
|
- [RemoteQuery](../../modules_sdk/classes/modules_sdk.RemoteQuery/page.mdx)
|
||||||
|
|
||||||
|
## Interfaces
|
||||||
|
|
||||||
|
- [ModuleImplementations](../../modules_sdk/interfaces/modules_sdk.ModuleImplementations/page.mdx)
|
||||||
|
- [ModuleServiceInitializeOptions](../../modules_sdk/interfaces/modules_sdk.ModuleServiceInitializeOptions/page.mdx)
|
||||||
|
- [IModuleService](../../modules_sdk/interfaces/modules_sdk.IModuleService/page.mdx)
|
||||||
|
- [IMedusaInternalService](../../modules_sdk/interfaces/modules_sdk.IMedusaInternalService/page.mdx)
|
||||||
|
|
||||||
|
## Type Aliases
|
||||||
|
|
||||||
|
- [RunMigrationFn](../../modules_sdk/types/modules_sdk.RunMigrationFn/page.mdx)
|
||||||
|
- [RevertMigrationFn](../../modules_sdk/types/modules_sdk.RevertMigrationFn/page.mdx)
|
||||||
|
- [GenerateMigrations](../../modules_sdk/types/modules_sdk.GenerateMigrations/page.mdx)
|
||||||
|
- [GetLinkExecutionPlanner](../../modules_sdk/types/modules_sdk.GetLinkExecutionPlanner/page.mdx)
|
||||||
|
- [MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)
|
||||||
|
- [SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)
|
||||||
|
- [MedusaAppOutput](../../modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx)
|
||||||
|
- [MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)
|
||||||
|
- [MigrationOptions](../../modules_sdk/types/modules_sdk.MigrationOptions/page.mdx)
|
||||||
|
- [ModuleBootstrapOptions](../../modules_sdk/types/modules_sdk.ModuleBootstrapOptions/page.mdx)
|
||||||
|
- [LinkModuleBootstrapOptions](../../modules_sdk/types/modules_sdk.LinkModuleBootstrapOptions/page.mdx)
|
||||||
|
- [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)
|
||||||
|
- [DeleteEntityInput](../../modules_sdk/types/modules_sdk.DeleteEntityInput/page.mdx)
|
||||||
|
- [RestoreEntityInput](../../modules_sdk/types/modules_sdk.RestoreEntityInput/page.mdx)
|
||||||
|
- [LinkDefinition](../../modules_sdk/types/modules_sdk.LinkDefinition/page.mdx)
|
||||||
|
- [MedusaContainer](../../modules_sdk/types/modules_sdk.MedusaContainer/page.mdx)
|
||||||
|
- [ContainerLike](../../modules_sdk/types/modules_sdk.ContainerLike/page.mdx)
|
||||||
|
- [Constructor](../../modules_sdk/types/modules_sdk.Constructor/page.mdx)
|
||||||
|
- [LogLevel](../../modules_sdk/types/modules_sdk.LogLevel/page.mdx)
|
||||||
|
- [LoggerOptions](../../modules_sdk/types/modules_sdk.LoggerOptions/page.mdx)
|
||||||
|
- [CustomModuleDefinition](../../modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx)
|
||||||
|
- [InternalModuleDeclaration](../../modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx)
|
||||||
|
- [ExternalModuleDeclaration](../../modules_sdk/types/modules_sdk.ExternalModuleDeclaration/page.mdx)
|
||||||
|
- [ModuleResolution](../../modules_sdk/types/modules_sdk.ModuleResolution/page.mdx)
|
||||||
|
- [ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)
|
||||||
|
- [LinkModuleDefinition](../../modules_sdk/types/modules_sdk.LinkModuleDefinition/page.mdx)
|
||||||
|
- [ModuleConfig](../../modules_sdk/types/modules_sdk.ModuleConfig/page.mdx)
|
||||||
|
- [LoadedModule](../../modules_sdk/types/modules_sdk.LoadedModule/page.mdx)
|
||||||
|
- [LoaderOptions](../../modules_sdk/types/modules_sdk.LoaderOptions/page.mdx)
|
||||||
|
- [ModuleLoaderFunction](../../modules_sdk/types/modules_sdk.ModuleLoaderFunction/page.mdx)
|
||||||
|
- [ModulesResponse](../../modules_sdk/types/modules_sdk.ModulesResponse/page.mdx)
|
||||||
|
- [LinkModulesExtraFields](../../modules_sdk/types/modules_sdk.LinkModulesExtraFields/page.mdx)
|
||||||
|
- [ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.ModuleJoinerConfig/page.mdx)
|
||||||
|
- [ModuleJoinerRelationship](../../modules_sdk/types/modules_sdk.ModuleJoinerRelationship/page.mdx)
|
||||||
|
- [ModuleExports](../../modules_sdk/types/modules_sdk.ModuleExports/page.mdx)
|
||||||
|
- [ModuleServiceInitializeCustomDataLayerOptions](../../modules_sdk/types/modules_sdk.ModuleServiceInitializeCustomDataLayerOptions/page.mdx)
|
||||||
|
- [ModuleBootstrapDeclaration](../../modules_sdk/types/modules_sdk.ModuleBootstrapDeclaration/page.mdx)
|
||||||
|
- [RemoteQueryFunction](../../modules_sdk/types/modules_sdk.RemoteQueryFunction/page.mdx)
|
||||||
|
- [ModuleProviderExports](../../modules_sdk/types/modules_sdk.ModuleProviderExports/page.mdx)
|
||||||
|
- [ModuleProvider](../../modules_sdk/types/modules_sdk.ModuleProvider/page.mdx)
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## Variables
|
||||||
|
|
||||||
|
### MODULE\_PACKAGE\_NAMES
|
||||||
|
|
||||||
|
`Const` **MODULE\_PACKAGE\_NAMES**: `Object`
|
||||||
|
|
||||||
|
#### Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"auth","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/auth\"","expandable":false,"children":[]},{"name":"cacheService","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/cache-inmemory\"","expandable":false,"children":[]},{"name":"cart","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/cart\"","expandable":false,"children":[]},{"name":"customer","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/customer\"","expandable":false,"children":[]},{"name":"eventBus","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/event-bus-local\"","expandable":false,"children":[]},{"name":"inventoryService","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/inventory-next\"","expandable":false,"children":[]},{"name":"linkModules","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/link-modules\"","expandable":false,"children":[]},{"name":"payment","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/payment\"","expandable":false,"children":[]},{"name":"pricingService","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/pricing\"","expandable":false,"children":[]},{"name":"productService","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/product\"","expandable":false,"children":[]},{"name":"promotion","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/promotion\"","expandable":false,"children":[]},{"name":"salesChannel","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/sales-channel\"","expandable":false,"children":[]},{"name":"fulfillment","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/fulfillment\"","expandable":false,"children":[]},{"name":"stockLocationService","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/stock-location-next\"","expandable":false,"children":[]},{"name":"tax","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/tax\"","expandable":false,"children":[]},{"name":"user","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/user\"","expandable":false,"children":[]},{"name":"workflows","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/workflow-engine-inmemory\"","expandable":false,"children":[]},{"name":"region","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/region\"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/order\"","expandable":false,"children":[]},{"name":"apiKey","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/api-key\"","expandable":false,"children":[]},{"name":"store","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/store\"","expandable":false,"children":[]},{"name":"currency","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/currency\"","expandable":false,"children":[]},{"name":"file","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/file\"","expandable":false,"children":[]},{"name":"notification","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/notification\"","expandable":false,"children":[]}]} sectionTitle="MODULE_PACKAGE_NAMES"/>
|
||||||
|
|
||||||
|
### ModulesDefinition
|
||||||
|
|
||||||
|
`Const` **ModulesDefinition**: `object`
|
||||||
|
|
||||||
|
### MODULE\_DEFINITIONS
|
||||||
|
|
||||||
|
`Const` **MODULE\_DEFINITIONS**: [ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)[]
|
||||||
|
|
||||||
|
### MedusaModule
|
||||||
|
|
||||||
|
`Const` **MedusaModule**: typeof `MedusaModule`
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## Functions
|
||||||
|
|
||||||
|
### moduleLoader
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../modules_sdk/types/modules_sdk.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleResolutions","type":"`Record<string, [ModuleResolution](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../modules_sdk/types/modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../../modules_sdk/types/modules_sdk.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":[]}]}]} sectionTitle="moduleLoader"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="moduleLoader"/>
|
||||||
|
|
||||||
|
### moduleProviderLoader
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../modules_sdk/types/modules_sdk.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providers","type":"[ModuleProvider](../../modules_sdk/types/modules_sdk.ModuleProvider/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/types/modules_sdk.MedusaContainer/page.mdx), `moduleDetails`: `any`) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="moduleProviderLoader"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="moduleProviderLoader"/>
|
||||||
|
|
||||||
|
### loadModuleProvider
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"container","type":"[MedusaContainer](../../modules_sdk/types/modules_sdk.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[ModuleProvider](../../modules_sdk/types/modules_sdk.ModuleProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../modules_sdk/types/modules_sdk.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"services","type":"[Constructor](../../modules_sdk/types/modules_sdk.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":[]}]} sectionTitle="loadModuleProvider"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<any[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"any[]","type":"`any`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="loadModuleProvider"/>
|
||||||
|
|
||||||
|
### registerMedusaModule
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"moduleKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleDeclaration","type":"`string` \\| `false` \\| Partial<[InternalModuleDeclaration](../../modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../modules_sdk/types/modules_sdk.ExternalModuleDeclaration/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/types/modules_sdk.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"definition","type":"[ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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","type":"[InternalModuleDeclaration](../../modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../modules_sdk/types/modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":false,"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](../../modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../modules_sdk/types/modules_sdk.ModuleExports/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](../../modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"server","type":"`object`","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":"isRequired","type":"`boolean`","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":[]}]}]} sectionTitle="registerMedLine truncated
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Record","type":"`Record<string, [ModuleResolution](../../modules_sdk/types/modules_sdk.ModuleResolution/page.mdx)>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"ModuleResolution","type":"[ModuleResolution](../../modules_sdk/types/modules_sdk.ModuleResolution/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"resolutionPath","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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","type":"[InternalModuleDeclaration](../../modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../modules_sdk/types/modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isRequired","type":"`boolean`","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":"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](../../modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../modules_sdk/types/modules_sdk.ExternalModuleDeclaration/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](../../modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../modules_sdk/types/modules_sdk.ModuleExports/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](../../modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"server","type":"`object`","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":"",Line truncated
|
||||||
|
|
||||||
|
### registerMedusaLinkModule
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"definition","type":"[ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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","type":"[InternalModuleDeclaration](../../modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../modules_sdk/types/modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":false,"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](../../modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../modules_sdk/types/modules_sdk.ModuleExports/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](../../modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"server","type":"`object`","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":"isRequired","type":"`boolean`","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":"moduleDeclaration","type":"Partial<[InternalModuleDeclaration](../../modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx)>","description":"","optional":false,"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":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","type":"`string`","description":"","optionaLine truncated
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Record","type":"`Record<string, [ModuleResolution](../../modules_sdk/types/modules_sdk.ModuleResolution/page.mdx)>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"ModuleResolution","type":"[ModuleResolution](../../modules_sdk/types/modules_sdk.ModuleResolution/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"resolutionPath","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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","type":"[InternalModuleDeclaration](../../modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../modules_sdk/types/modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isRequired","type":"`boolean`","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":"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](../../modules_sdk/types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../modules_sdk/types/modules_sdk.ExternalModuleDeclaration/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](../../modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../modules_sdk/types/modules_sdk.ModuleExports/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](../../modules_sdk/types/modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"server","type":"`object`","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":"",Line truncated
|
||||||
|
|
||||||
|
### loadModules
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"modulesConfig","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"migrationOnly","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"loaderOnly","type":"`boolean`","description":"","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":false,"defaultValue":"\"server\"","expandable":false,"children":[]}]} sectionTitle="loadModules"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="loadModules"/>
|
||||||
|
|
||||||
|
### MedusaApp
|
||||||
|
|
||||||
|
#### 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](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/interfaces/modules_sdk.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../modules_sdk/types/modules_sdk.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/types/modules_sdk.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":[]},{"name":"loaderOnly","type":"`boolean`","description":"Forces the modules bootstrapper to only run the moLine 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](../../modules_sdk/types/modules_sdk.LoadedModule/page.mdx) \\| [LoadedModule](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/types/modules_sdk.RemoteQueryFunction/page.mdx)","description":"","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":"notFound","type":"`Record<string, Record<string, string>>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../modules_sdk/types/modules_sdk.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} 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](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/interfaces/modules_sdk.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../modules_sdk/types/modules_sdk.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/types/modules_sdk.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":[]},{"name":"loaderOnly","type":"`boolean`","description":"Forces the modules bootstrapper to only run the moLine truncated
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="MedusaAppMigrateUp"/>
|
||||||
|
|
||||||
|
### MedusaAppMigrateDown
|
||||||
|
|
||||||
|
#### 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](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/interfaces/modules_sdk.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../modules_sdk/types/modules_sdk.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/types/modules_sdk.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":"","expandableLine truncated
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="MedusaAppMigrateDown"/>
|
||||||
|
|
||||||
|
### MedusaAppMigrateGenerate
|
||||||
|
|
||||||
|
#### 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](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/interfaces/modules_sdk.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../modules_sdk/types/modules_sdk.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/types/modules_sdk.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":"","expandableLine truncated
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="MedusaAppMigrateGenerate"/>
|
||||||
|
|
||||||
|
### MedusaAppGetLinksExecutionPlanner
|
||||||
|
|
||||||
|
#### 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](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/interfaces/modules_sdk.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../modules_sdk/types/modules_sdk.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../modules_sdk/types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../modules_sdk/types/modules_sdk.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](../../modules_sdk/types/modules_sdk.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":[]},{"name":"loaderOnly","type":"`boolean`","description":"Forces the modules bootstrapper to only run the moLine truncated
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[ILinkMigrationsPlanner](../../types/interfaces/types.ILinkMigrationsPlanner/page.mdx)>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ILinkMigrationsPlanner","type":"[ILinkMigrationsPlanner](../../types/interfaces/types.ILinkMigrationsPlanner/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"createPlan","type":"() => Promise<[LinkMigrationsPlannerAction](../../types/types/types.LinkMigrationsPlannerAction/page.mdx)[]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"executePlan","type":"(`actions`: [LinkMigrationsPlannerAction](../../types/types/types.LinkMigrationsPlannerAction/page.mdx)[]) => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="MedusaAppGetLinksExecutionPlanner"/>
|
||||||
@@ -0,0 +1,89 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# RemoteLink
|
||||||
|
|
||||||
|
## constructor
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"modulesLoaded","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/modules_sdk.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/modules_sdk.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/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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","type":"[InternalModuleDeclaration](../../types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isRequired","type":"`boolean`","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":[]}]}]}]} sectionTitle="new RemoteLink"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### addModule
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"mod","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/modules_sdk.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/modules_sdk.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/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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","type":"[InternalModuleDeclaration](../../types/modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isRequired","type":"`boolean`","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":[]}]}]}]} sectionTitle="addModule"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="addModule"/>
|
||||||
|
|
||||||
|
### getLinkModule
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"moduleA","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleAKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleB","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleBKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="getLinkModule"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"undefined \\| LoadedLinkModule","type":"`undefined` \\| `LoadedLinkModule`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="getLinkModule"/>
|
||||||
|
|
||||||
|
### getRelationships
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Map","type":"Map<string, Map<string, RemoteRelationship[]>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Map","type":"Map<string, RemoteRelationship[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"RemoteRelationship[]","type":"`RemoteRelationship`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="getRelationships"/>
|
||||||
|
|
||||||
|
### create
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx) \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="create"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<unknown[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"unknown[]","type":"`unknown`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"unknown","type":"`unknown`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="create"/>
|
||||||
|
|
||||||
|
### dismiss
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx) \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="dismiss"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<unknown[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"unknown[]","type":"`unknown`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"unknown","type":"`unknown`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="dismiss"/>
|
||||||
|
|
||||||
|
### delete
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"removedServices","type":"[DeleteEntityInput](../../types/modules_sdk.DeleteEntityInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[null \\| CascadeError[], RemovedIds]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"null \\| CascadeError[]","type":"`null` \\| `CascadeError`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"RemovedIds","type":"`RemovedIds`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
### restore
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"removedServices","type":"[DeleteEntityInput](../../types/modules_sdk.DeleteEntityInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="restore"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[null \\| CascadeError[], RemovedIds]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"null \\| CascadeError[]","type":"`null` \\| `CascadeError`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"RemovedIds","type":"`RemovedIds`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="restore"/>
|
||||||
|
|
||||||
|
### list
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"link","type":"[LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx) \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"options","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"asLinkDefinition","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="list"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<(object \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx))[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"(object \\| LinkDefinition)[]","type":"(`object` \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx))[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"object \\| LinkDefinition","type":"`object` \\| [LinkDefinition](../../types/modules_sdk.LinkDefinition/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="list"/>
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# RemoteQuery
|
||||||
|
|
||||||
|
## constructor
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"modulesLoaded","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/modules_sdk.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customRemoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/modules_sdk.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/modules_sdk.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":[]}]}]}]} sectionTitle="new RemoteQuery"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### setFetchDataCallback
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"remoteFetchData","type":"(`expand`: [RemoteExpandProperty](../../../types/interfaces/types.RemoteExpandProperty/page.mdx), `keyField`: `string`, `ids?`: `unknown`[], `relationship?`: `any`) => Promise<{ data: unknown[] \\| { [path: string]: unknown[]; } ; path?: string }>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="setFetchDataCallback"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="setFetchDataCallback"/>
|
||||||
|
|
||||||
|
### getAllFieldsAndRelations
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"expand","type":"[RemoteExpandProperty](../../../types/interfaces/types.RemoteExpandProperty/page.mdx) \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"property","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceConfig","type":"[InternalJoinerServiceConfig](../../../types/types/types.InternalJoinerServiceConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","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":"extends","type":"`object`[]","description":"","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":"relationships","type":"Map<string, [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parentConfig","type":"[InternalJoinerServiceConfig](../../../types/types/types.InternalJoinerServiceConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","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":"extends","type":"`object`[]","description":"","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":"relationships","type":"Map<string, [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fields","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"expands","type":"[RemoteNestedExpands](../../../types/interfaces/types.RemoteNestedExpands/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"expands","type":"[RemoteNestedExpandLine truncated
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"relations","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"select","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="getAllFieldsAndRelations"/>
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"relations","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"select","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="getAllFieldsAndRelations"/>
|
||||||
|
|
||||||
|
### remoteFetchData
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"expand","type":"[RemoteExpandProperty](../../../types/interfaces/types.RemoteExpandProperty/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"property","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceConfig","type":"[InternalJoinerServiceConfig](../../../types/types/types.InternalJoinerServiceConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","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":"extends","type":"`object`[]","description":"","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":"relationships","type":"Map<string, [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parentConfig","type":"[InternalJoinerServiceConfig](../../../types/types/types.InternalJoinerServiceConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","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":"extends","type":"`object`[]","description":"","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":"relationships","type":"Map<string, [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fields","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"expands","type":"[RemoteNestedExpands](../../../types/interfaces/types.RemoteNestedExpands/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"keyField","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ids","type":"`unknown`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationship","type":"[JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"foreignKey","type":"`string`","desLine truncated
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"data","type":"`unknown`[] \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"path","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="remoteFetchData"/>
|
||||||
|
|
||||||
|
### query
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"query","type":"`string` \\| `object` \\| [RemoteJoinerQuery](../../../types/interfaces/types.RemoteJoinerQuery/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expands","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"property","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"directives","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"directives","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variables","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"throwIfKeyNotFound","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throwIfRelationNotFound","type":"`boolean` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="query"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<any>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="query"/>
|
||||||
+13
@@ -0,0 +1,13 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# MODULE\_RESOURCE\_TYPE
|
||||||
|
|
||||||
|
## Enumeration Members
|
||||||
|
|
||||||
|
### SHARED
|
||||||
|
|
||||||
|
**SHARED** = `"shared"`
|
||||||
|
|
||||||
|
### ISOLATED
|
||||||
|
|
||||||
|
**ISOLATED** = `"isolated"`
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# MODULE\_SCOPE
|
||||||
|
|
||||||
|
## Enumeration Members
|
||||||
|
|
||||||
|
### INTERNAL
|
||||||
|
|
||||||
|
**INTERNAL** = `"internal"`
|
||||||
|
|
||||||
|
### EXTERNAL
|
||||||
|
|
||||||
|
**EXTERNAL** = `"external"`
|
||||||
+229
@@ -0,0 +1,229 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# IMedusaInternalService
|
||||||
|
|
||||||
|
## Type parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"TEntity","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TContainer","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="IMedusaInternalService"/>
|
||||||
|
|
||||||
|
## Accessors
|
||||||
|
|
||||||
|
### \_\_container\_\_
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"TContainer","type":"TContainer","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__container__"/>
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### retrieve
|
||||||
|
|
||||||
|
`**retrieve**(idOrObject, config?, sharedContext?): Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"idOrObject","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)<any>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="retrieve"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TEntity","type":"TEntity","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="retrieve"/>
|
||||||
|
|
||||||
|
`**retrieve**(idOrObject, config?, sharedContext?): Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"idOrObject","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)<any>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="retrieve"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TEntity","type":"TEntity","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="retrieve"/>
|
||||||
|
|
||||||
|
### list
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"filters","type":"`object` \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<object>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)<any>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":"`sLine truncated
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType<TEntity>[]","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="list"/>
|
||||||
|
|
||||||
|
### listAndCount
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"filters","type":"`object` \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<object>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"config","type":"[FindConfig](../../../types/CommonTypes/interfaces/types.CommonTypes.FindConfig/page.mdx)<any>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":"`sLine truncated
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[], number]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType<TEntity>[]","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="listAndCount"/>
|
||||||
|
|
||||||
|
### create
|
||||||
|
|
||||||
|
`**create**(data, sharedContext?): Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"data","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="create"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType<TEntity>[]","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="create"/>
|
||||||
|
|
||||||
|
`**create**(data, sharedContext?): Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"data","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="create"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TEntity","type":"TEntity","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="create"/>
|
||||||
|
|
||||||
|
### update
|
||||||
|
|
||||||
|
`**update**(data, sharedContext?): Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"data","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="update"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType<TEntity>[]","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="update"/>
|
||||||
|
|
||||||
|
`**update**(data, sharedContext?): Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"data","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="update"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TEntity","type":"TEntity","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="update"/>
|
||||||
|
|
||||||
|
`**update**(selectorAndData, sharedContext?): Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"selectorAndData","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"selector","type":"`object` \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="update"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType<TEntity>[]","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="update"/>
|
||||||
|
|
||||||
|
`**update**(selectorAndData, sharedContext?): Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"selectorAndData","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"selector","type":"`object` \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"data","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="update"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType<TEntity>[]","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="update"/>
|
||||||
|
|
||||||
|
### delete
|
||||||
|
|
||||||
|
`**delete**(idOrSelector, sharedContext?): Promise<void>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"idOrSelector","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
`**delete**(idOrSelector, sharedContext?): Promise<void>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"idOrSelector","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
`**delete**(idOrSelector, sharedContext?): Promise<void>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"idOrSelector","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
`**delete**(idOrSelector, sharedContext?): Promise<void>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"idOrSelector","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
`**delete**(idOrSelector, sharedContext?): Promise<void>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"idOrSelector","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"selector","type":"`object` \\| [BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<object>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../types/DAL/interfaces/types.DAL.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="delete"/>
|
||||||
|
|
||||||
|
### softDelete
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"idsOrFilter","type":"`string` \\| `string`[] \\| `object` \\| `object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="softDelete"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[], Record<string, unknown[]>]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType<TEntity>[]","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, unknown[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="softDelete"/>
|
||||||
|
|
||||||
|
### restore
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"idsOrFilter","type":"`string`[] \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="restore"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[], Record<string, unknown[]>]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType<TEntity>[]","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Record","type":"`Record<string, unknown[]>`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="restore"/>
|
||||||
|
|
||||||
|
### upsert
|
||||||
|
|
||||||
|
`**upsert**(data, sharedContext?): Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"data","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="upsert"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType<TEntity>[]","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="upsert"/>
|
||||||
|
|
||||||
|
`**upsert**(data, sharedContext?): Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"data","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="upsert"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"InferEntityType","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TEntity","type":"TEntity","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} sectionTitle="upsert"/>
|
||||||
|
|
||||||
|
### upsertWithReplace
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"data","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[UpsertWithReplaceConfig](../../../types/DAL/interfaces/types.DAL.UpsertWithReplaceConfig/page.mdx)<[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"relations","type":"keyof T[]","description":"The relationships that will be updated/created/deleted as part of the upsert","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../types/interfaces/types.Context/page.mdx)","description":"","optional":true,"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":[]}]}]} sectionTitle="upsertWithReplace"/>
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<object>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"entities","type":"[InferEntityType](../../../types/DmlTypes/types/types.DmlTypes.InferEntityType/page.mdx)<TEntity>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"performedActions","type":"[PerformedActions](../../../types/DAL/types/types.DAL.PerformedActions/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"created","type":"`Record<[EntityClassName](../../../types/types/types.EntityClassName/page.mdx), [EntityValues](../../../types/types/types.EntityValues/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated","type":"`Record<[EntityClassName](../../../types/types/types.EntityClassName/page.mdx), [EntityValues](../../../types/types/types.EntityValues/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted","type":"`Record<[EntityClassName](../../../types/types/types.EntityClassName/page.mdx), [EntityValues](../../../types/types/types.EntityValues/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="upsertWithReplace"/>
|
||||||
+3
@@ -0,0 +1,3 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# IModuleService
|
||||||
+6
@@ -0,0 +1,6 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleImplementations
|
||||||
|
|
||||||
|
The following interface acts as a bucket that other modules or the
|
||||||
|
utils package can fill using declaration merging
|
||||||
+7
@@ -0,0 +1,7 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleServiceInitializeOptions
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"database","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"connection","type":"`any`","description":"Forces to use a shared knex connection","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"clientUrl","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"host","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"port","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"database","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"driverOptions","type":"`Record<string, unknown>` & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"connection","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"debug","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pool","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="ModuleServiceInitializeOptions"/>
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# Constructor
|
||||||
|
|
||||||
|
**Constructor**: (...`args`: `any`[]) => T \| () => T
|
||||||
|
|
||||||
|
## Type Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Constructor"/>
|
||||||
|
|
||||||
|
## Type declaration
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ContainerLike
|
||||||
|
|
||||||
|
**ContainerLike**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"resolve","type":"`<T>`(`key`: `string`) => T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ContainerLike"/>
|
||||||
+9
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# CustomModuleDefinition
|
||||||
|
|
||||||
|
**CustomModuleDefinition**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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":[]}]} sectionTitle="CustomModuleDefinition"/>
|
||||||
+10
@@ -0,0 +1,10 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# DeleteEntityInput
|
||||||
|
|
||||||
|
**DeleteEntityInput**: `object`
|
||||||
|
|
||||||
|
The details of a data model's record whose linked records should be deleted. Usually used after the
|
||||||
|
data model's record is deleted.
|
||||||
|
|
||||||
|
The key is the data model's name. Its value is an object that has the ID of the data model's record.
|
||||||
+9
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ExternalModuleDeclaration
|
||||||
|
|
||||||
|
**ExternalModuleDeclaration**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"scope","type":"`\"external\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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":[]}]} sectionTitle="ExternalModuleDeclaration"/>
|
||||||
+15
@@ -0,0 +1,15 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# GenerateMigrations
|
||||||
|
|
||||||
|
**GenerateMigrations**: (`moduleNames`: `string`[]) => Promise<void>
|
||||||
|
|
||||||
|
## Type declaration
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||||
|
|
||||||
|
### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||||
+11
@@ -0,0 +1,11 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# GetLinkExecutionPlanner
|
||||||
|
|
||||||
|
**GetLinkExecutionPlanner**: () => [ILinkMigrationsPlanner](../../../types/interfaces/types.ILinkMigrationsPlanner/page.mdx)
|
||||||
|
|
||||||
|
## Type declaration
|
||||||
|
|
||||||
|
### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"createPlan","type":"() => Promise<[LinkMigrationsPlannerAction](../../../types/types/types.LinkMigrationsPlannerAction/page.mdx)[]>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"executePlan","type":"(`actions`: [LinkMigrationsPlannerAction](../../../types/types/types.LinkMigrationsPlannerAction/page.mdx)[]) => Promise<void>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||||
+9
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# InternalModuleDeclaration
|
||||||
|
|
||||||
|
**InternalModuleDeclaration**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resources","type":"`\"shared\"` \\| `\"isolated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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](../modules_sdk.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](../modules_sdk.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":[]}]} sectionTitle="InternalModuleDeclaration"/>
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# LinkDefinition
|
||||||
|
|
||||||
|
**LinkDefinition**: `object` & `object`
|
||||||
|
|
||||||
|
A link for two records of linked data models.
|
||||||
|
|
||||||
|
The keys are the names of each module, and their value is an object that holds the ID of the linked data model's record.
|
||||||
+9
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# LinkModuleBootstrapOptions
|
||||||
|
|
||||||
|
**LinkModuleBootstrapOptions**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"definition","type":"[LinkModuleDefinition](../modules_sdk.LinkModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx)","description":"","optional":false,"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":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../modules_sdk.ModuleExports/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":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"declaration","type":"[InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/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":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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](../modules_sdk.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](../modules_sdk.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":"moduleELine truncated
|
||||||
+9
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# LinkModuleDefinition
|
||||||
|
|
||||||
|
**LinkModuleDefinition**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx)","description":"","optional":false,"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":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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](../modules_sdk.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](../modules_sdk.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":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="LinkModuleDefinition"/>
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# LinkModulesExtraFields
|
||||||
|
|
||||||
|
**LinkModulesExtraFields**: `Record<string, object>`
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# LoadedModule
|
||||||
|
|
||||||
|
**LoadedModule**: `unknown` & `object`
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# LoaderOptions
|
||||||
|
|
||||||
|
**LoaderOptions**: `Object`
|
||||||
|
|
||||||
|
## Type Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"TOptions","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="LoaderOptions"/>
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"container","type":"[MedusaContainer](../modules_sdk.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"TOptions","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"logger","type":"[Logger](../../../types/LoggerTypes/interfaces/types.LoggerTypes.Logger/page.mdx)","description":"","optional":true,"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":"dataLoaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="LoaderOptions"/>
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# LogLevel
|
||||||
|
|
||||||
|
**LogLevel**: `"query"` \| `"schema"` \| `"error"` \| `"warn"` \| `"info"` \| `"log"` \| `"migration"`
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# LoggerOptions
|
||||||
|
|
||||||
|
**LoggerOptions**: `boolean` \| `"all"` \| [LogLevel](../modules_sdk.LogLevel/page.mdx)[]
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# MedusaAppOptions
|
||||||
|
|
||||||
|
**MedusaAppOptions**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../modules_sdk.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](../../interfaces/modules_sdk.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](../modules_sdk.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../modules_sdk.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](../modules_sdk.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](../modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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","type":"[InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternaLine truncated
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# MedusaAppOutput
|
||||||
|
|
||||||
|
**MedusaAppOutput**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"modules","type":"`Record<string, [LoadedModule](../modules_sdk.LoadedModule/page.mdx) \\| [LoadedModule](../modules_sdk.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](../modules_sdk.RemoteQueryFunction/page.mdx)","description":"","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":"notFound","type":"`Record<string, Record<string, string>>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../modules_sdk.MedusaContainer/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="MedusaAppOutput"/>
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# MedusaContainer
|
||||||
|
|
||||||
|
**MedusaContainer**: Omit<AwilixContainer, "resolve"> & `object`
|
||||||
|
|
||||||
|
The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to
|
||||||
|
provide dependency injection functionalities.
|
||||||
|
|
||||||
|
## Type Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Cradle","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="MedusaContainer"/>
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# MedusaModuleConfig
|
||||||
|
|
||||||
|
**MedusaModuleConfig**: `object`
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# MigrationOptions
|
||||||
|
|
||||||
|
**MigrationOptions**: `Object`
|
||||||
|
|
||||||
|
## 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](../modules_sdk.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](../modules_sdk.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](../modules_sdk.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="MigrationOptions"/>
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleBootstrapDeclaration
|
||||||
|
|
||||||
|
**ModuleBootstrapDeclaration**: [InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx) \| [ExternalModuleDeclaration](../modules_sdk.ExternalModuleDeclaration/page.mdx)
|
||||||
+9
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleBootstrapOptions
|
||||||
|
|
||||||
|
**ModuleBootstrapOptions**: `Object`
|
||||||
|
|
||||||
|
## 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](../modules_sdk.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](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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](../modules_sdk.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](../modules_sdk.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](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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](../modules_sdk.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":Line truncated
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleConfig
|
||||||
|
|
||||||
|
**ModuleConfig**: [ModuleDeclaration](../../../types/types/types.ModuleDeclaration/page.mdx) & `object`
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleDefinition
|
||||||
|
|
||||||
|
**ModuleDefinition**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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","type":"[InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":false,"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](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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](../modules_sdk.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](../modules_sdk.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](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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":"mainLine truncated
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleExports
|
||||||
|
|
||||||
|
**ModuleExports**: `Object`
|
||||||
|
|
||||||
|
## Type Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ModuleExports"/>
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../modules_sdk.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runMigrations","type":"(`options`: [LoaderOptions](../modules_sdk.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx)) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigration","type":"(`options`: [LoaderOptions](../modules_sdk.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx)) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigration","type":"(`options`: [LoaderOptions](../modules_sdk.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx)) => Promise<void>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ModuleExports"/>
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleJoinerConfig
|
||||||
|
|
||||||
|
**ModuleJoinerConfig**: Omit<[JoinerServiceConfig](../../../types/interfaces/types.JoinerServiceConfig/page.mdx), "serviceName" \| "primaryKeys" \| "relationships" \| "extends"> & `object`
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleJoinerRelationship
|
||||||
|
|
||||||
|
**ModuleJoinerRelationship**: [JoinerRelationship](../../../types/types/types.JoinerRelationship/page.mdx) & `object`
|
||||||
+15
@@ -0,0 +1,15 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleLoaderFunction
|
||||||
|
|
||||||
|
**ModuleLoaderFunction**: (`options`: [LoaderOptions](../modules_sdk.LoaderOptions/page.mdx)<any>, `moduleDeclaration?`: [InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx)) => Promise<void>
|
||||||
|
|
||||||
|
## Type declaration
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"options","type":"[LoaderOptions](../modules_sdk.LoaderOptions/page.mdx)<any>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../modules_sdk.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"TOptions","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"logger","type":"[Logger](../../../types/LoggerTypes/interfaces/types.LoggerTypes.Logger/page.mdx)","description":"","optional":true,"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":"dataLoaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"moduleDeclaration","type":"[InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/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":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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](../modules_sdk.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](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"Line truncated
|
||||||
|
|
||||||
|
### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleProvider
|
||||||
|
|
||||||
|
**ModuleProvider**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../modules_sdk.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"services","type":"[Constructor](../modules_sdk.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":[]}]} sectionTitle="ModuleProvider"/>
|
||||||
+9
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleProviderExports
|
||||||
|
|
||||||
|
**ModuleProviderExports**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"services","type":"[Constructor](../modules_sdk.Constructor/page.mdx)<any>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ModuleProviderExports"/>
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleResolution
|
||||||
|
|
||||||
|
**ModuleResolution**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"resolutionPath","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[ModuleDefinition](../modules_sdk.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"registrationName","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","type":"[InternalModuleDeclaration](../modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../modules_sdk.ExternalModuleDeclaration/page.mdx)","description":"","optional":false,"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](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../modules_sdk.ModuleExports/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](../modules_sdk.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"server","type":"`object`","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":"isRequired","type":"`boolean`","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":"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](../modules_sdk.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../modules_sdk.ExternalModuleDeclaration/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"Line truncated
|
||||||
+9
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModuleServiceInitializeCustomDataLayerOptions
|
||||||
|
|
||||||
|
**ModuleServiceInitializeCustomDataLayerOptions**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"manager","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"repositories","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="ModuleServiceInitializeCustomDataLayerOptions"/>
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# ModulesResponse
|
||||||
|
|
||||||
|
**ModulesResponse**: `object`[]
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# RegisterModuleJoinerConfig
|
||||||
|
|
||||||
|
**RegisterModuleJoinerConfig**: [ModuleJoinerConfig](../modules_sdk.ModuleJoinerConfig/page.mdx) \| (`modules`: [ModuleJoinerConfig](../modules_sdk.ModuleJoinerConfig/page.mdx)[]) => [ModuleJoinerConfig](../modules_sdk.ModuleJoinerConfig/page.mdx)
|
||||||
+15
@@ -0,0 +1,15 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# RemoteQueryFunction
|
||||||
|
|
||||||
|
**RemoteQueryFunction**: (`query`: `string` \| [RemoteJoinerQuery](../../../types/interfaces/types.RemoteJoinerQuery/page.mdx) \| `object`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise<any> \| `null`
|
||||||
|
|
||||||
|
## Type declaration
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"query","type":"`string` \\| [RemoteJoinerQuery](../../../types/interfaces/types.RemoteJoinerQuery/page.mdx) \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expands","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"property","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"directives","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"args","type":"[JoinerArgument](../../../types/interfaces/types.JoinerArgument/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"directives","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variables","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[RemoteJoinerOptions](../../../types/interfaces/types.RemoteJoinerOptions/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"throwIfKeyNotFound","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"throwIfRelationNotFound","type":"`boolean` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="__type"/>
|
||||||
|
|
||||||
|
### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise<any> \\| null","type":"Promise<any> \\| `null`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||||
+5
@@ -0,0 +1,5 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# RestoreEntityInput
|
||||||
|
|
||||||
|
**RestoreEntityInput**: [DeleteEntityInput](../modules_sdk.DeleteEntityInput/page.mdx)
|
||||||
+15
@@ -0,0 +1,15 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# RevertMigrationFn
|
||||||
|
|
||||||
|
**RevertMigrationFn**: (`moduleNames`: `string`[]) => Promise<void>
|
||||||
|
|
||||||
|
## Type declaration
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||||
|
|
||||||
|
### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# RunMigrationFn
|
||||||
|
|
||||||
|
**RunMigrationFn**: () => Promise<void>
|
||||||
|
|
||||||
|
## Type declaration
|
||||||
|
|
||||||
|
### Returns
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Promise","type":"Promise<void>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="__type"/>
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# SharedResources
|
||||||
|
|
||||||
|
**SharedResources**: `Object`
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"database","type":"[ModuleServiceInitializeOptions](../../interfaces/modules_sdk.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":[]}]}]} sectionTitle="SharedResources"/>
|
||||||
+1
-1
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the Country . This belongs to the Region Module.
|
This documentation provides a reference to the Country . This belongs to the Region Module.
|
||||||
|
|
||||||
<TypeList types={[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](../region_models.Region/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](../region_models.Region/page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Country"/>
|
<TypeList types={[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](../region_models.Region/page.mdx)>","description":"The region it belongs to.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](page.mdx)>","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](../region_models.Region/page.mdx)>","description":"The region it belongs to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Country"/>
|
||||||
@@ -10,4 +10,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
This documentation provides a reference to the Region . This belongs to the Region Module.
|
This documentation provides a reference to the Region . This belongs to the Region Module.
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](../region_models.Country/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](page.mdx)>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](../region_models.Country/page.mdx)>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Region"/>
|
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](../region_models.Country/page.mdx)>","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"iso_2","type":"PrimaryKeyModifier<TextProperty>","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"BelongsTo<[Region](page.mdx)>","description":"The region it belongs to.","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"PrimaryKeyModifier<IdProperty>","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany<[Country](../region_models.Country/page.mdx)>","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="Region"/>
|
||||||
+1
-1
@@ -44,4 +44,4 @@ setting the environment variables depends on the hosting provider.
|
|||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
<TypeList types={[{"name":"projectConfig","type":"[ProjectConfigOptions](../types.CommonTypes.ProjectConfigOptions/page.mdx)","description":"This property holds essential configurations related to the Medusa backend, such as database and CORS configurations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"http","type":"`object`","description":"Configure the application's http-specific settings","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret` However, in production, if this configuration is not set an error, an\nerror is thrown and the backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. If not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret` However, in production, if this configuration is not set, an error is thrown and\nthe backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIts value is an object that has the following properties:\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authMethodsPerActor","type":"`Record<string, string[]>`","description":"Optionally you can specify the supported authentication providers per aLine truncated
|
<TypeList types={[{"name":"projectConfig","type":"[ProjectConfigOptions](../types.CommonTypes.ProjectConfigOptions/page.mdx)","description":"This property holds essential configurations related to the Medusa backend, such as database and CORS configurations.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"http","type":"`object`","description":"Configure the application's http-specific settings","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret` However, in production, if this configuration is not set an error, an\nerror is thrown and the backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. If not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret` However, in production, if this configuration is not set, an error is thrown and\nthe backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIts value is an object that has the following properties:\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"authMethodsPerActor","type":"`Record<string, string[]>`","description":"Optionally you can specify the supported authentication providers per aLine truncated
|
||||||
+1
-1
@@ -6,4 +6,4 @@ Essential configurations related to the Medusa backend, such as database and COR
|
|||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
<TypeList types={[{"name":"http","type":"`object`","description":"Configure the application's http-specific settings","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret` However, in production, if this configuration is not set an error, an\nerror is thrown and the backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. If not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret` However, in production, if this configuration is not set, an error is thrown and\nthe backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIts value is an object that has the following properties:\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"enabled","type":"`boolean`","description":"Whether HTTP compression is enabled. By default, it's `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"level","type":"`number`","description":"The level of zlib compression to apply to responses. A higher level will result in better compression but will take longer to complete.\nA lower level will result in less compression but will be much faster. The default value is `Line truncated
|
<TypeList types={[{"name":"http","type":"`object`","description":"Configure the application's http-specific settings","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"authCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`cors` is a string used to specify the accepted URLs or patterns for API Routes starting with `/auth`. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"storeCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"adminCors","type":"`string`","description":"The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n`admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([/~@;%#'])(.*?)\\1([gimsuy]*)$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtSecret","type":"`string`","description":"A random string used to create authentication tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is `supersecret` However, in production, if this configuration is not set an error, an\nerror is thrown and the backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"jwtExpiresIn","type":"`string`","description":"The expiration time for the JWT token. If not provided, the default value is `24h`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cookieSecret","type":"`string`","description":"A random string used to create cookie tokens in the http layer. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is `supersecret` However, in production, if this configuration is not set, an error is thrown and\nthe backend crashes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"compression","type":"[HttpCompressionOptions](../types.CommonTypes.HttpCompressionOptions/page.mdx)","description":"Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIts value is an object that has the following properties:\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `\"x-no-compression\": true`.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"enabled","type":"`boolean`","description":"Whether HTTP compression is enabled. By default, it's `false`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"level","type":"`number`","description":"The level of zlib compression to apply to responses. A higher level will result in better compression but will take longer to complete.\nA lower level will result in less compression but will be much faster. The default value is `Line truncated
|
||||||
+7
@@ -0,0 +1,7 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# AdminBatchLink
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"add","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remove","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminBatchLink"/>
|
||||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
<TypeList types={[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminFulfillmentProviderListParams"/>
|
<TypeList types={[{"name":"fields","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stock_location_id","type":"`string` \\| `string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdminFulfillmentProviderListParams"/>
|
||||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[AdminGeoZone](../types.HttpTypes.AdminGeoZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[AdminShippingOption](../types.HttpTypes.AdminShippingOption/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminStockLocation"/>
|
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[AdminFulfillmentProvider](../types.HttpTypes.AdminFulfillmentProvider/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[AdminGeoZone](../types.HttpTypes.AdminGeoZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[AdminShippingOption](../types.HttpTypes.AdminShippingOption/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} sectionTitle="AdminStockLocation"/>
|
||||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
<TypeList types={[{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stock_locations","type":"[AdminStockLocation](../types.HttpTypes.AdminStockLocation/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AdminStockLocationListResponse"/>
|
<TypeList types={[{"name":"limit","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stock_locations","type":"[AdminStockLocation](../types.HttpTypes.AdminStockLocation/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[AdminFulfillmentProvider](../types.HttpTypes.AdminFulfillmentProvider/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AdminStockLocationListResponse"/>
|
||||||
+1
-1
@@ -4,4 +4,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
<TypeList types={[{"name":"stock_location","type":"[AdminStockLocation](../types.HttpTypes.AdminStockLocation/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AdminStockLocationResponse"/>
|
<TypeList types={[{"name":"stock_location","type":"[AdminStockLocation](../types.HttpTypes.AdminStockLocation/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address","type":"[AdminStockLocationAddress](../types.HttpTypes.AdminStockLocationAddress/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"`AdminSalesChannel`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[AdminFulfillmentProvider](../types.HttpTypes.AdminFulfillmentProvider/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_enabled","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillment_sets","type":"[AdminFulfillmentSet](../types.HttpTypes.AdminFulfillmentSet/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[AdminServiceZone](../types.HttpTypes.AdminServiceZone/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} sectionTitle="AdminStockLocationResponse"/>
|
||||||
@@ -21,6 +21,7 @@ import { TypeList } from "docs-ui"
|
|||||||
- [StoreCollectionFilters](../HttpTypes/interfaces/types.HttpTypes.StoreCollectionFilters/page.mdx)
|
- [StoreCollectionFilters](../HttpTypes/interfaces/types.HttpTypes.StoreCollectionFilters/page.mdx)
|
||||||
- [SelectParams](../HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)
|
- [SelectParams](../HttpTypes/interfaces/types.HttpTypes.SelectParams/page.mdx)
|
||||||
- [FindParams](../HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx)
|
- [FindParams](../HttpTypes/interfaces/types.HttpTypes.FindParams/page.mdx)
|
||||||
|
- [AdminBatchLink](../HttpTypes/interfaces/types.HttpTypes.AdminBatchLink/page.mdx)
|
||||||
- [AdminFile](../HttpTypes/interfaces/types.HttpTypes.AdminFile/page.mdx)
|
- [AdminFile](../HttpTypes/interfaces/types.HttpTypes.AdminFile/page.mdx)
|
||||||
- [StoreFile](../HttpTypes/interfaces/types.HttpTypes.StoreFile/page.mdx)
|
- [StoreFile](../HttpTypes/interfaces/types.HttpTypes.StoreFile/page.mdx)
|
||||||
- [AdminFulfillmentProvider](../HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProvider/page.mdx)
|
- [AdminFulfillmentProvider](../HttpTypes/interfaces/types.HttpTypes.AdminFulfillmentProvider/page.mdx)
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -36,6 +36,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The ISO 3-character currency code. For example, `USD`."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -64,6 +72,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The symbol of the currency. For example, `$`."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -81,6 +97,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The native symbol of the currency, if it has a different local symbol."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -98,6 +122,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The name of the currency"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -115,6 +147,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "How many digits are after the decimal separator for prices in this currency."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -132,6 +172,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The rounding percision of prices in this currency."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"id": 13688,
|
"id": 13765,
|
||||||
"name": "medusa-config",
|
"name": "medusa-config",
|
||||||
"variant": "project",
|
"variant": "project",
|
||||||
"kind": 1,
|
"kind": 1,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13689,
|
"id": 13766,
|
||||||
"name": "AdminOptions",
|
"name": "AdminOptions",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 256,
|
"kind": 256,
|
||||||
@@ -21,7 +21,7 @@
|
|||||||
},
|
},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13690,
|
"id": 13767,
|
||||||
"name": "disable",
|
"name": "disable",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -58,7 +58,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13691,
|
"id": 13768,
|
||||||
"name": "path",
|
"name": "path",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -124,7 +124,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13692,
|
"id": 13769,
|
||||||
"name": "outDir",
|
"name": "outDir",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -153,7 +153,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13693,
|
"id": 13770,
|
||||||
"name": "backendUrl",
|
"name": "backendUrl",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -174,7 +174,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13694,
|
"id": 13771,
|
||||||
"name": "vite",
|
"name": "vite",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -200,21 +200,21 @@
|
|||||||
"type": {
|
"type": {
|
||||||
"type": "reflection",
|
"type": "reflection",
|
||||||
"declaration": {
|
"declaration": {
|
||||||
"id": 13695,
|
"id": 13772,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 65536,
|
"kind": 65536,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"signatures": [
|
"signatures": [
|
||||||
{
|
{
|
||||||
"id": 13696,
|
"id": 13773,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "signature",
|
"variant": "signature",
|
||||||
"kind": 4096,
|
"kind": 4096,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"id": 13697,
|
"id": 13774,
|
||||||
"name": "config",
|
"name": "config",
|
||||||
"variant": "param",
|
"variant": "param",
|
||||||
"kind": 32768,
|
"kind": 32768,
|
||||||
@@ -249,17 +249,17 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13690,
|
13767,
|
||||||
13691,
|
13768,
|
||||||
13692,
|
13769,
|
||||||
13693,
|
13770,
|
||||||
13694
|
13771
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13698,
|
"id": 13775,
|
||||||
"name": "HttpCompressionOptions",
|
"name": "HttpCompressionOptions",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 256,
|
"kind": 256,
|
||||||
@@ -274,7 +274,7 @@
|
|||||||
},
|
},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13699,
|
"id": 13776,
|
||||||
"name": "enabled",
|
"name": "enabled",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -303,7 +303,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13700,
|
"id": 13777,
|
||||||
"name": "level",
|
"name": "level",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -332,7 +332,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13701,
|
"id": 13778,
|
||||||
"name": "memLevel",
|
"name": "memLevel",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -361,7 +361,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13702,
|
"id": 13779,
|
||||||
"name": "threshold",
|
"name": "threshold",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -403,16 +403,16 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13699,
|
13776,
|
||||||
13700,
|
13777,
|
||||||
13701,
|
13778,
|
||||||
13702
|
13779
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13703,
|
"id": 13780,
|
||||||
"name": "ProjectConfigOptions",
|
"name": "ProjectConfigOptions",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 256,
|
"kind": 256,
|
||||||
@@ -427,7 +427,7 @@
|
|||||||
},
|
},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13704,
|
"id": 13781,
|
||||||
"name": "databaseName",
|
"name": "databaseName",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -467,7 +467,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13705,
|
"id": 13782,
|
||||||
"name": "databaseUrl",
|
"name": "databaseUrl",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -607,7 +607,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13706,
|
"id": 13783,
|
||||||
"name": "databaseSchema",
|
"name": "databaseSchema",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -640,7 +640,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13707,
|
"id": 13784,
|
||||||
"name": "databaseLogging",
|
"name": "databaseLogging",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -749,7 +749,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13709,
|
"id": 13786,
|
||||||
"name": "databaseDriverOptions",
|
"name": "databaseDriverOptions",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -848,14 +848,14 @@
|
|||||||
{
|
{
|
||||||
"type": "reflection",
|
"type": "reflection",
|
||||||
"declaration": {
|
"declaration": {
|
||||||
"id": 13710,
|
"id": 13787,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 65536,
|
"kind": 65536,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13711,
|
"id": 13788,
|
||||||
"name": "connection",
|
"name": "connection",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -865,14 +865,14 @@
|
|||||||
"type": {
|
"type": {
|
||||||
"type": "reflection",
|
"type": "reflection",
|
||||||
"declaration": {
|
"declaration": {
|
||||||
"id": 13712,
|
"id": 13789,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 65536,
|
"kind": 65536,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13713,
|
"id": 13790,
|
||||||
"name": "ssl",
|
"name": "ssl",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -890,14 +890,14 @@
|
|||||||
"type": {
|
"type": {
|
||||||
"type": "reflection",
|
"type": "reflection",
|
||||||
"declaration": {
|
"declaration": {
|
||||||
"id": 13714,
|
"id": 13791,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 65536,
|
"kind": 65536,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13715,
|
"id": 13792,
|
||||||
"name": "rejectUnauthorized",
|
"name": "rejectUnauthorized",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -922,7 +922,7 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13715
|
13792
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -934,7 +934,7 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13713
|
13790
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -946,7 +946,7 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13711
|
13788
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -956,7 +956,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13716,
|
"id": 13793,
|
||||||
"name": "redisUrl",
|
"name": "redisUrl",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1004,7 +1004,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13717,
|
"id": 13794,
|
||||||
"name": "redisPrefix",
|
"name": "redisPrefix",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1052,7 +1052,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13718,
|
"id": 13795,
|
||||||
"name": "redisOptions",
|
"name": "redisOptions",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1089,7 +1089,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13719,
|
"id": 13796,
|
||||||
"name": "sessionOptions",
|
"name": "sessionOptions",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1126,7 +1126,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13721,
|
"id": 13798,
|
||||||
"name": "jobsBatchSize",
|
"name": "jobsBatchSize",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1166,7 +1166,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13722,
|
"id": 13799,
|
||||||
"name": "workerMode",
|
"name": "workerMode",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1267,7 +1267,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13723,
|
"id": 13800,
|
||||||
"name": "http",
|
"name": "http",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1294,14 +1294,14 @@
|
|||||||
"type": {
|
"type": {
|
||||||
"type": "reflection",
|
"type": "reflection",
|
||||||
"declaration": {
|
"declaration": {
|
||||||
"id": 13724,
|
"id": 13801,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 65536,
|
"kind": 65536,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13725,
|
"id": 13802,
|
||||||
"name": "jwtSecret",
|
"name": "jwtSecret",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1341,7 +1341,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13726,
|
"id": 13803,
|
||||||
"name": "jwtExpiresIn",
|
"name": "jwtExpiresIn",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1381,7 +1381,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13727,
|
"id": 13804,
|
||||||
"name": "cookieSecret",
|
"name": "cookieSecret",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1421,7 +1421,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13728,
|
"id": 13805,
|
||||||
"name": "authCors",
|
"name": "authCors",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1535,7 +1535,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13729,
|
"id": 13806,
|
||||||
"name": "compression",
|
"name": "compression",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1571,13 +1571,13 @@
|
|||||||
},
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": 13698,
|
"target": 13775,
|
||||||
"name": "HttpCompressionOptions",
|
"name": "HttpCompressionOptions",
|
||||||
"package": "@medusajs/types"
|
"package": "@medusajs/types"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13730,
|
"id": 13807,
|
||||||
"name": "storeCors",
|
"name": "storeCors",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1683,7 +1683,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13731,
|
"id": 13808,
|
||||||
"name": "adminCors",
|
"name": "adminCors",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1789,7 +1789,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13732,
|
"id": 13809,
|
||||||
"name": "authMethodsPerActor",
|
"name": "authMethodsPerActor",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -1879,14 +1879,14 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13725,
|
13802,
|
||||||
13726,
|
13803,
|
||||||
13727,
|
13804,
|
||||||
13728,
|
13805,
|
||||||
13729,
|
13806,
|
||||||
13730,
|
13807,
|
||||||
13731,
|
13808,
|
||||||
13732
|
13809
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -1898,24 +1898,24 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13704,
|
13781,
|
||||||
13705,
|
13782,
|
||||||
13706,
|
13783,
|
||||||
13707,
|
13784,
|
||||||
13709,
|
13786,
|
||||||
13716,
|
13793,
|
||||||
13717,
|
13794,
|
||||||
13718,
|
13795,
|
||||||
13719,
|
13796,
|
||||||
13721,
|
13798,
|
||||||
13722,
|
13799,
|
||||||
13723
|
13800
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13733,
|
"id": 13810,
|
||||||
"name": "ConfigModule",
|
"name": "ConfigModule",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 256,
|
"kind": 256,
|
||||||
@@ -1946,7 +1946,7 @@
|
|||||||
"kind": "inline-tag",
|
"kind": "inline-tag",
|
||||||
"tag": "@link",
|
"tag": "@link",
|
||||||
"text": "projectConfig",
|
"text": "projectConfig",
|
||||||
"target": 13734,
|
"target": 13811,
|
||||||
"tsLinkText": "projectConfig"
|
"tsLinkText": "projectConfig"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -1957,7 +1957,7 @@
|
|||||||
"kind": "inline-tag",
|
"kind": "inline-tag",
|
||||||
"tag": "@link",
|
"tag": "@link",
|
||||||
"text": "admin",
|
"text": "admin",
|
||||||
"target": 13735,
|
"target": 13812,
|
||||||
"tsLinkText": "admin"
|
"tsLinkText": "admin"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -1982,7 +1982,7 @@
|
|||||||
"kind": "inline-tag",
|
"kind": "inline-tag",
|
||||||
"tag": "@link",
|
"tag": "@link",
|
||||||
"text": "modules",
|
"text": "modules",
|
||||||
"target": 13740,
|
"target": 13817,
|
||||||
"tsLinkText": "modules"
|
"tsLinkText": "modules"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -1993,7 +1993,7 @@
|
|||||||
"kind": "inline-tag",
|
"kind": "inline-tag",
|
||||||
"tag": "@link",
|
"tag": "@link",
|
||||||
"text": "featureFlags",
|
"text": "featureFlags",
|
||||||
"target": 13741,
|
"target": 13818,
|
||||||
"tsLinkText": "featureFlags"
|
"tsLinkText": "featureFlags"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -2028,7 +2028,7 @@
|
|||||||
},
|
},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13734,
|
"id": 13811,
|
||||||
"name": "projectConfig",
|
"name": "projectConfig",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -2043,13 +2043,13 @@
|
|||||||
},
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": 13703,
|
"target": 13780,
|
||||||
"name": "ProjectConfigOptions",
|
"name": "ProjectConfigOptions",
|
||||||
"package": "@medusajs/types"
|
"package": "@medusajs/types"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13735,
|
"id": 13812,
|
||||||
"name": "admin",
|
"name": "admin",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -2077,13 +2077,13 @@
|
|||||||
},
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": 13689,
|
"target": 13766,
|
||||||
"name": "AdminOptions",
|
"name": "AdminOptions",
|
||||||
"package": "@medusajs/types"
|
"package": "@medusajs/types"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13740,
|
"id": 13817,
|
||||||
"name": "modules",
|
"name": "modules",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -2225,7 +2225,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13741,
|
"id": 13818,
|
||||||
"name": "featureFlags",
|
"name": "featureFlags",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -2290,6 +2290,25 @@
|
|||||||
{
|
{
|
||||||
"type": "intrinsic",
|
"type": "intrinsic",
|
||||||
"name": "boolean"
|
"name": "boolean"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "reference",
|
||||||
|
"target": {
|
||||||
|
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
|
||||||
|
"qualifiedName": "Record"
|
||||||
|
},
|
||||||
|
"typeArguments": [
|
||||||
|
{
|
||||||
|
"type": "intrinsic",
|
||||||
|
"name": "string"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "intrinsic",
|
||||||
|
"name": "boolean"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "Record",
|
||||||
|
"package": "typescript"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -2303,16 +2322,16 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13734,
|
13811,
|
||||||
13735,
|
13812,
|
||||||
13740,
|
13817,
|
||||||
13741
|
13818
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13742,
|
"id": 13819,
|
||||||
"name": "PluginDetails",
|
"name": "PluginDetails",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 2097152,
|
"kind": 2097152,
|
||||||
@@ -2320,14 +2339,14 @@
|
|||||||
"type": {
|
"type": {
|
||||||
"type": "reflection",
|
"type": "reflection",
|
||||||
"declaration": {
|
"declaration": {
|
||||||
"id": 13743,
|
"id": 13820,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 65536,
|
"kind": 65536,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13744,
|
"id": 13821,
|
||||||
"name": "resolve",
|
"name": "resolve",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -2338,7 +2357,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13745,
|
"id": 13822,
|
||||||
"name": "name",
|
"name": "name",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -2349,7 +2368,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13746,
|
"id": 13823,
|
||||||
"name": "id",
|
"name": "id",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -2360,7 +2379,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13747,
|
"id": 13824,
|
||||||
"name": "options",
|
"name": "options",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -2386,7 +2405,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13748,
|
"id": 13825,
|
||||||
"name": "version",
|
"name": "version",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -2401,11 +2420,11 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13744,
|
13821,
|
||||||
13745,
|
13822,
|
||||||
13746,
|
13823,
|
||||||
13747,
|
13824,
|
||||||
13748
|
13825
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -2417,238 +2436,238 @@
|
|||||||
{
|
{
|
||||||
"title": "Interfaces",
|
"title": "Interfaces",
|
||||||
"children": [
|
"children": [
|
||||||
13689,
|
13766,
|
||||||
13698,
|
13775,
|
||||||
13703,
|
13780,
|
||||||
13733
|
13810
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"title": "Type Aliases",
|
"title": "Type Aliases",
|
||||||
"children": [
|
"children": [
|
||||||
13742
|
13819
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"packageName": "@medusajs/types",
|
"packageName": "@medusajs/types",
|
||||||
"symbolIdMap": {
|
"symbolIdMap": {
|
||||||
"13688": {
|
"13765": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": ""
|
"qualifiedName": ""
|
||||||
},
|
},
|
||||||
"13689": {
|
"13766": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "AdminOptions"
|
"qualifiedName": "AdminOptions"
|
||||||
},
|
},
|
||||||
"13690": {
|
"13767": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.disable"
|
"qualifiedName": "__type.disable"
|
||||||
},
|
},
|
||||||
"13691": {
|
"13768": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.path"
|
"qualifiedName": "__type.path"
|
||||||
},
|
},
|
||||||
"13692": {
|
"13769": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.outDir"
|
"qualifiedName": "__type.outDir"
|
||||||
},
|
},
|
||||||
"13693": {
|
"13770": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.backendUrl"
|
"qualifiedName": "__type.backendUrl"
|
||||||
},
|
},
|
||||||
"13694": {
|
"13771": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.vite"
|
"qualifiedName": "__type.vite"
|
||||||
},
|
},
|
||||||
"13695": {
|
"13772": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"13696": {
|
"13773": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"13697": {
|
"13774": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "config"
|
"qualifiedName": "config"
|
||||||
},
|
},
|
||||||
"13698": {
|
"13775": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "HttpCompressionOptions"
|
"qualifiedName": "HttpCompressionOptions"
|
||||||
},
|
},
|
||||||
"13699": {
|
"13776": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.enabled"
|
"qualifiedName": "__type.enabled"
|
||||||
},
|
},
|
||||||
"13700": {
|
"13777": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.level"
|
"qualifiedName": "__type.level"
|
||||||
},
|
},
|
||||||
"13701": {
|
"13778": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.memLevel"
|
"qualifiedName": "__type.memLevel"
|
||||||
},
|
},
|
||||||
"13702": {
|
"13779": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.threshold"
|
"qualifiedName": "__type.threshold"
|
||||||
},
|
},
|
||||||
"13703": {
|
"13780": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "ProjectConfigOptions"
|
"qualifiedName": "ProjectConfigOptions"
|
||||||
},
|
},
|
||||||
"13704": {
|
"13781": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.databaseName"
|
"qualifiedName": "__type.databaseName"
|
||||||
},
|
},
|
||||||
"13705": {
|
"13782": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.databaseUrl"
|
"qualifiedName": "__type.databaseUrl"
|
||||||
},
|
},
|
||||||
"13706": {
|
"13783": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.databaseSchema"
|
"qualifiedName": "__type.databaseSchema"
|
||||||
},
|
},
|
||||||
"13707": {
|
"13784": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.databaseLogging"
|
"qualifiedName": "__type.databaseLogging"
|
||||||
},
|
},
|
||||||
"13709": {
|
"13786": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.databaseDriverOptions"
|
"qualifiedName": "__type.databaseDriverOptions"
|
||||||
},
|
},
|
||||||
"13710": {
|
"13787": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"13711": {
|
"13788": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.connection"
|
"qualifiedName": "__type.connection"
|
||||||
},
|
},
|
||||||
"13712": {
|
"13789": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"13713": {
|
"13790": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.ssl"
|
"qualifiedName": "__type.ssl"
|
||||||
},
|
},
|
||||||
"13714": {
|
"13791": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"13715": {
|
"13792": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.rejectUnauthorized"
|
"qualifiedName": "__type.rejectUnauthorized"
|
||||||
},
|
},
|
||||||
"13716": {
|
"13793": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.redisUrl"
|
"qualifiedName": "__type.redisUrl"
|
||||||
},
|
},
|
||||||
"13717": {
|
"13794": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.redisPrefix"
|
"qualifiedName": "__type.redisPrefix"
|
||||||
},
|
},
|
||||||
"13718": {
|
"13795": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.redisOptions"
|
"qualifiedName": "__type.redisOptions"
|
||||||
},
|
},
|
||||||
"13719": {
|
"13796": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.sessionOptions"
|
"qualifiedName": "__type.sessionOptions"
|
||||||
},
|
},
|
||||||
"13721": {
|
"13798": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.jobsBatchSize"
|
"qualifiedName": "__type.jobsBatchSize"
|
||||||
},
|
},
|
||||||
"13722": {
|
"13799": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.workerMode"
|
"qualifiedName": "__type.workerMode"
|
||||||
},
|
},
|
||||||
"13723": {
|
"13800": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.http"
|
"qualifiedName": "__type.http"
|
||||||
},
|
},
|
||||||
"13724": {
|
"13801": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"13725": {
|
"13802": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.jwtSecret"
|
"qualifiedName": "__type.jwtSecret"
|
||||||
},
|
},
|
||||||
"13726": {
|
"13803": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.jwtExpiresIn"
|
"qualifiedName": "__type.jwtExpiresIn"
|
||||||
},
|
},
|
||||||
"13727": {
|
"13804": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.cookieSecret"
|
"qualifiedName": "__type.cookieSecret"
|
||||||
},
|
},
|
||||||
"13728": {
|
"13805": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.authCors"
|
"qualifiedName": "__type.authCors"
|
||||||
},
|
},
|
||||||
"13729": {
|
"13806": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.compression"
|
"qualifiedName": "__type.compression"
|
||||||
},
|
},
|
||||||
"13730": {
|
"13807": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.storeCors"
|
"qualifiedName": "__type.storeCors"
|
||||||
},
|
},
|
||||||
"13731": {
|
"13808": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.adminCors"
|
"qualifiedName": "__type.adminCors"
|
||||||
},
|
},
|
||||||
"13732": {
|
"13809": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.authMethodsPerActor"
|
"qualifiedName": "__type.authMethodsPerActor"
|
||||||
},
|
},
|
||||||
"13733": {
|
"13810": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "ConfigModule"
|
"qualifiedName": "ConfigModule"
|
||||||
},
|
},
|
||||||
"13734": {
|
"13811": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.projectConfig"
|
"qualifiedName": "__type.projectConfig"
|
||||||
},
|
},
|
||||||
"13735": {
|
"13812": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.admin"
|
"qualifiedName": "__type.admin"
|
||||||
},
|
},
|
||||||
"13740": {
|
"13817": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.modules"
|
"qualifiedName": "__type.modules"
|
||||||
},
|
},
|
||||||
"13741": {
|
"13818": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.featureFlags"
|
"qualifiedName": "__type.featureFlags"
|
||||||
},
|
},
|
||||||
"13742": {
|
"13819": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "PluginDetails"
|
"qualifiedName": "PluginDetails"
|
||||||
},
|
},
|
||||||
"13743": {
|
"13820": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"13744": {
|
"13821": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.resolve"
|
"qualifiedName": "__type.resolve"
|
||||||
},
|
},
|
||||||
"13745": {
|
"13822": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.name"
|
"qualifiedName": "__type.name"
|
||||||
},
|
},
|
||||||
"13746": {
|
"13823": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.id"
|
"qualifiedName": "__type.id"
|
||||||
},
|
},
|
||||||
"13747": {
|
"13824": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.options"
|
"qualifiedName": "__type.options"
|
||||||
},
|
},
|
||||||
"13748": {
|
"13825": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
"sourceFileName": "../../../../packages/core/types/src/common/config-module.ts",
|
||||||
"qualifiedName": "__type.version"
|
"qualifiedName": "__type.version"
|
||||||
}
|
}
|
||||||
@@ -2658,7 +2677,7 @@
|
|||||||
"1": "../../../../packages/core/types/src/common/config-module.ts"
|
"1": "../../../../packages/core/types/src/common/config-module.ts"
|
||||||
},
|
},
|
||||||
"reflections": {
|
"reflections": {
|
||||||
"1": 13688
|
"1": 13765
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
File diff suppressed because it is too large.
Load diff
@@ -48,6 +48,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The ISO 2-character code of the country"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -76,6 +84,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The ISO 3-character code of the country"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -93,6 +109,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The ISO numeric code of the country"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -110,6 +134,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The name of the country"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -127,6 +159,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The display name of the country"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -146,6 +186,17 @@
|
|||||||
"flags": {
|
"flags": {
|
||||||
"isOptional": true
|
"isOptional": true
|
||||||
},
|
},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The region it belongs to."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"modifierTags": [
|
||||||
|
"@expandable"
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -172,6 +223,14 @@
|
|||||||
"flags": {
|
"flags": {
|
||||||
"isOptional": true
|
"isOptional": true
|
||||||
},
|
},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "Holds custom data in key-value pairs."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -856,6 +915,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The ID of the region."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -884,6 +951,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The name of the region"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -901,6 +976,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The ISO 3-character currency code of the region"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -918,6 +1001,14 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "Whether taxes are calculated automatically during checkout in the region."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -935,6 +1026,17 @@
|
|||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "The countries that belong to the region."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"modifierTags": [
|
||||||
|
"@expandable"
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
@@ -961,6 +1063,14 @@
|
|||||||
"flags": {
|
"flags": {
|
||||||
"isOptional": true
|
"isOptional": true
|
||||||
},
|
},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "Holds custom data in key-value pairs."
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"type": {
|
"type": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": {
|
"target": {
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"id": 13987,
|
"id": 14736,
|
||||||
"name": "tax-provider",
|
"name": "tax-provider",
|
||||||
"variant": "project",
|
"variant": "project",
|
||||||
"kind": 1,
|
"kind": 1,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13988,
|
"id": 14737,
|
||||||
"name": "ShippingTaxCalculationLine",
|
"name": "ShippingTaxCalculationLine",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 2097152,
|
"kind": 2097152,
|
||||||
@@ -22,14 +22,14 @@
|
|||||||
"type": {
|
"type": {
|
||||||
"type": "reflection",
|
"type": "reflection",
|
||||||
"declaration": {
|
"declaration": {
|
||||||
"id": 13989,
|
"id": 14738,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 65536,
|
"kind": 65536,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13990,
|
"id": 14739,
|
||||||
"name": "shipping_line",
|
"name": "shipping_line",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -53,7 +53,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13991,
|
"id": 14740,
|
||||||
"name": "rates",
|
"name": "rates",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -84,8 +84,8 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13990,
|
14739,
|
||||||
13991
|
14740
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -93,7 +93,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13992,
|
"id": 14741,
|
||||||
"name": "ItemTaxCalculationLine",
|
"name": "ItemTaxCalculationLine",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 2097152,
|
"kind": 2097152,
|
||||||
@@ -109,14 +109,14 @@
|
|||||||
"type": {
|
"type": {
|
||||||
"type": "reflection",
|
"type": "reflection",
|
||||||
"declaration": {
|
"declaration": {
|
||||||
"id": 13993,
|
"id": 14742,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 65536,
|
"kind": 65536,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13994,
|
"id": 14743,
|
||||||
"name": "line_item",
|
"name": "line_item",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -140,7 +140,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13995,
|
"id": 14744,
|
||||||
"name": "rates",
|
"name": "rates",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -171,8 +171,8 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
13994,
|
14743,
|
||||||
13995
|
14744
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -180,7 +180,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 13996,
|
"id": 14745,
|
||||||
"name": "ITaxProvider",
|
"name": "ITaxProvider",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 256,
|
"kind": 256,
|
||||||
@@ -283,14 +283,14 @@
|
|||||||
},
|
},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 13999,
|
"id": 14748,
|
||||||
"name": "getTaxLines",
|
"name": "getTaxLines",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 2048,
|
"kind": 2048,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"signatures": [
|
"signatures": [
|
||||||
{
|
{
|
||||||
"id": 14000,
|
"id": 14749,
|
||||||
"name": "getTaxLines",
|
"name": "getTaxLines",
|
||||||
"variant": "signature",
|
"variant": "signature",
|
||||||
"kind": 4096,
|
"kind": 4096,
|
||||||
@@ -361,7 +361,7 @@
|
|||||||
},
|
},
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"id": 14001,
|
"id": 14750,
|
||||||
"name": "itemLines",
|
"name": "itemLines",
|
||||||
"variant": "param",
|
"variant": "param",
|
||||||
"kind": 32768,
|
"kind": 32768,
|
||||||
@@ -378,14 +378,14 @@
|
|||||||
"type": "array",
|
"type": "array",
|
||||||
"elementType": {
|
"elementType": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": 13992,
|
"target": 14741,
|
||||||
"name": "ItemTaxCalculationLine",
|
"name": "ItemTaxCalculationLine",
|
||||||
"package": "@medusajs/types"
|
"package": "@medusajs/types"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 14002,
|
"id": 14751,
|
||||||
"name": "shippingLines",
|
"name": "shippingLines",
|
||||||
"variant": "param",
|
"variant": "param",
|
||||||
"kind": 32768,
|
"kind": 32768,
|
||||||
@@ -402,14 +402,14 @@
|
|||||||
"type": "array",
|
"type": "array",
|
||||||
"elementType": {
|
"elementType": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": 13988,
|
"target": 14737,
|
||||||
"name": "ShippingTaxCalculationLine",
|
"name": "ShippingTaxCalculationLine",
|
||||||
"package": "@medusajs/types"
|
"package": "@medusajs/types"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 14003,
|
"id": 14752,
|
||||||
"name": "context",
|
"name": "context",
|
||||||
"variant": "param",
|
"variant": "param",
|
||||||
"kind": 32768,
|
"kind": 32768,
|
||||||
@@ -478,7 +478,7 @@
|
|||||||
{
|
{
|
||||||
"title": "Methods",
|
"title": "Methods",
|
||||||
"children": [
|
"children": [
|
||||||
13999
|
14748
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -488,76 +488,76 @@
|
|||||||
{
|
{
|
||||||
"title": "Interfaces",
|
"title": "Interfaces",
|
||||||
"children": [
|
"children": [
|
||||||
13996
|
14745
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"title": "Type Aliases",
|
"title": "Type Aliases",
|
||||||
"children": [
|
"children": [
|
||||||
13988,
|
14737,
|
||||||
13992
|
14741
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"packageName": "@medusajs/types",
|
"packageName": "@medusajs/types",
|
||||||
"symbolIdMap": {
|
"symbolIdMap": {
|
||||||
"13987": {
|
"14736": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": ""
|
"qualifiedName": ""
|
||||||
},
|
},
|
||||||
"13988": {
|
"14737": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "ShippingTaxCalculationLine"
|
"qualifiedName": "ShippingTaxCalculationLine"
|
||||||
},
|
},
|
||||||
"13989": {
|
"14738": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"13990": {
|
"14739": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type.shipping_line"
|
"qualifiedName": "__type.shipping_line"
|
||||||
},
|
},
|
||||||
"13991": {
|
"14740": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type.rates"
|
"qualifiedName": "__type.rates"
|
||||||
},
|
},
|
||||||
"13992": {
|
"14741": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "ItemTaxCalculationLine"
|
"qualifiedName": "ItemTaxCalculationLine"
|
||||||
},
|
},
|
||||||
"13993": {
|
"14742": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"13994": {
|
"14743": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type.line_item"
|
"qualifiedName": "__type.line_item"
|
||||||
},
|
},
|
||||||
"13995": {
|
"14744": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type.rates"
|
"qualifiedName": "__type.rates"
|
||||||
},
|
},
|
||||||
"13996": {
|
"14745": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "ITaxProvider"
|
"qualifiedName": "ITaxProvider"
|
||||||
},
|
},
|
||||||
"13999": {
|
"14748": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "ITaxProvider.getTaxLines"
|
"qualifiedName": "ITaxProvider.getTaxLines"
|
||||||
},
|
},
|
||||||
"14000": {
|
"14749": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "ITaxProvider.getTaxLines"
|
"qualifiedName": "ITaxProvider.getTaxLines"
|
||||||
},
|
},
|
||||||
"14001": {
|
"14750": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "itemLines"
|
"qualifiedName": "itemLines"
|
||||||
},
|
},
|
||||||
"14002": {
|
"14751": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "shippingLines"
|
"qualifiedName": "shippingLines"
|
||||||
},
|
},
|
||||||
"14003": {
|
"14752": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "context"
|
"qualifiedName": "context"
|
||||||
}
|
}
|
||||||
@@ -567,7 +567,7 @@
|
|||||||
"1": "../../../../packages/core/types/src/tax/provider.ts"
|
"1": "../../../../packages/core/types/src/tax/provider.ts"
|
||||||
},
|
},
|
||||||
"reflections": {
|
"reflections": {
|
||||||
"1": 13987
|
"1": 14736
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
File diff suppressed because it is too large.
Load diff
Reference in new issue
Block a user