chore(docs): Generated References (automated) (#9436)

Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
authored and GitHub committed 2024-10-03 11:03:35 +03:00
1 parent bffb36cd11
commit c536f7caf5
637 files changed
+340776 -501155

No files matched your search

File diff suppressed because it is too large. Load diff
@@ -90,6 +90,7 @@ import { TypeList } from "docs-ui"
## Type Aliases
- [MetadataType](../../fulfillment/types/fulfillment.MetadataType/page.mdx)
- [RuleOperatorType](../../fulfillment/types/fulfillment.RuleOperatorType/page.mdx)
- [Query](../../fulfillment/types/fulfillment.Query/page.mdx)
- [ExpandScalar](../../fulfillment/types/fulfillment.ExpandScalar/page.mdx)
@@ -114,7 +115,11 @@ import { TypeList } from "docs-ui"
- [ModuleJoinerConfig](../../fulfillment/types/fulfillment.ModuleJoinerConfig/page.mdx)
- [ModuleJoinerRelationship](../../fulfillment/types/fulfillment.ModuleJoinerRelationship/page.mdx)
- [ChangeActionType](../../fulfillment/types/fulfillment.ChangeActionType/page.mdx)
- [OrderChangeStatus](../../fulfillment/types/fulfillment.OrderChangeStatus/page.mdx)
- [OrderStatus](../../fulfillment/types/fulfillment.OrderStatus/page.mdx)
- [ReturnStatus](../../fulfillment/types/fulfillment.ReturnStatus/page.mdx)
- [OrderClaimType](../../fulfillment/types/fulfillment.OrderClaimType/page.mdx)
- [StockLocationAddressDTO](../../fulfillment/types/fulfillment.StockLocationAddressDTO/page.mdx)
- [StockLocationDTO](../../fulfillment/types/fulfillment.StockLocationDTO/page.mdx)
- [BigNumberRawValue](../../fulfillment/types/fulfillment.BigNumberRawValue/page.mdx)
- [BigNumberValue](../../fulfillment/types/fulfillment.BigNumberValue/page.mdx)
@@ -51,10 +51,8 @@ import { TypeList } from "docs-ui"
- [MedusaAppMigrateGenerate](page.mdx#medusaappmigrategenerate)
- [MedusaAppGetLinksExecutionPlanner](page.mdx#medusaappgetlinksexecutionplanner)
- [createQuery](page.mdx#createquery)
- [cleanGraphQLSchema](page.mdx#cleangraphqlschema)
- [gqlGetFieldsAndRelations](page.mdx#gqlgetfieldsandrelations)
- [gqlSchemaToTypes](page.mdx#gqlschematotypes)
- [graphqlSchemaToFields](page.mdx#graphqlschematofields)
- [convertRecordsToLinkDefinition](page.mdx#convertrecordstolinkdefinition)
- [linkingErrorMessage](page.mdx#linkingerrormessage)
___
@@ -66,7 +64,7 @@ ___
#### Properties
<TypeList types={[{"name":"Auth","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/auth\"","expandable":false,"children":[]},{"name":"Cache","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":"Inventory","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":"Pricing","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/pricing\"","expandable":false,"children":[]},{"name":"Product","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":"StockLocation","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":[]},{"name":"Index","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/index\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MODULE_PACKAGE_NAMES"/>
<TypeList types={[{"name":"Auth","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/auth\"","expandable":false,"children":[]},{"name":"Cache","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/cache-inmemory\"","expandable":false,"children":[]},{"name":"Cart","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/cart\"","expandable":false,"children":[]},{"name":"Customer","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/customer\"","expandable":false,"children":[]},{"name":"EventBus","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/event-bus-local\"","expandable":false,"children":[]},{"name":"Inventory","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/inventory-next\"","expandable":false,"children":[]},{"name":"LinkModules","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/link-modules\"","expandable":false,"children":[]},{"name":"Payment","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/payment\"","expandable":false,"children":[]},{"name":"Pricing","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/pricing\"","expandable":false,"children":[]},{"name":"Product","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/product\"","expandable":false,"children":[]},{"name":"Promotion","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/promotion\"","expandable":false,"children":[]},{"name":"SalesChannel","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/sales-channel\"","expandable":false,"children":[]},{"name":"Fulfillment","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/fulfillment\"","expandable":false,"children":[]},{"name":"StockLocation","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/stock-location-next\"","expandable":false,"children":[]},{"name":"Tax","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/tax\"","expandable":false,"children":[]},{"name":"User","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/user\"","expandable":false,"children":[]},{"name":"Workflows","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/workflow-engine-inmemory\"","expandable":false,"children":[]},{"name":"Region","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/region\"","expandable":false,"children":[]},{"name":"Order","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/order\"","expandable":false,"children":[]},{"name":"ApiKey","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/api-key\"","expandable":false,"children":[]},{"name":"Store","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/store\"","expandable":false,"children":[]},{"name":"Currency","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/currency\"","expandable":false,"children":[]},{"name":"File","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/file\"","expandable":false,"children":[]},{"name":"Notification","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/notification\"","expandable":false,"children":[]},{"name":"Index","type":"`string`","description":"","optional":false,"defaultValue":"\"@medusajs/medusa/index-module\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MODULE_PACKAGE_NAMES"/>
### ModulesDefinition
@@ -88,7 +86,7 @@ ___
#### Parameters
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleResolutions","type":"`Record<string, [ModuleResolution](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolutionPath","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"logger","type":"[Logger](../../types/LoggerTypes/interfaces/types.LoggerTypes.Logger/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"panic","type":"(`data`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shouldLog","type":"(`level`: `string`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"setLogLevel","type":"(`level`: `string`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unsetLogLevel","type":"() => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"activity","type":"(`message`: `string`, `config?`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"error","type":"(`messageOrError`: `any`, `error?`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failure","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"success","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"log","type":"(...`args`: `any`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"migrationOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"loaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="moduleLoader"/>
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"moduleResolutions","type":"`Record<string, [ModuleResolution](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleResolution/page.mdx)>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolutionPath","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"logger","type":"[Logger](../../types/LoggerTypes/interfaces/types.LoggerTypes.Logger/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"panic","type":"(`data`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shouldLog","type":"(`level`: `string`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"setLogLevel","type":"(`level`: `string`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unsetLogLevel","type":"() => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"activity","type":"(`message`: `string`, `config?`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"error","type":"(`messageOrError`: `any`, `error?`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"failure","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"success","type":"(`activityId`: `any`, `message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"debug","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"info","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"warn","type":"(`message`: `any`) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"log","type":"(...`args`: `any`[]) => `void`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"migrationOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"loaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="moduleLoader"/>
#### Returns
@@ -98,7 +96,7 @@ ___
#### Parameters
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providers","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"registerServiceFn","type":"(`klass`: `any`, `container`: [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx), `moduleDetails`: `any`) => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="moduleProviderLoader"/>
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"providers","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"registerServiceFn","type":"(`klass`: `any`, `container`: [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx), `moduleDetails`: `any`) => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="moduleProviderLoader"/>
#### Returns
@@ -108,7 +106,7 @@ ___
#### Parameters
<TypeList types={[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"services","type":"[Constructor](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;any&#62;[]","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&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadModuleProvider"/>
<TypeList types={[{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider","type":"[ModuleProvider](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProvider/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"resolve","type":"`string` \\| [ModuleProviderExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleProviderExports/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"services","type":"[Constructor](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.Constructor/page.mdx)&#60;any&#62;[]","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&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadModuleProvider"/>
#### Returns
@@ -118,47 +116,47 @@ ___
#### Parameters
<TypeList types={[{"name":"moduleKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleDeclaration","type":"`string` \\| `false` \\| Partial&#60;[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"worker_mode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"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,"defaultValueLine truncated
<TypeList types={[{"name":"moduleKey","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleDeclaration","type":"`string` \\| `false` \\| Partial&#60;[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx)&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"moduleExports","type":"[ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"service","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"loaders","type":"[ModuleLoaderFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleLoaderFunction/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discoveryPath","type":"`string`","description":"Explicitly set the the true location of the module resources.\nCan be used to re-export the module from a different location and specify its original location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"worker_mode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"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":Line truncated
#### Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [ModuleResolution](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resources","type":"`\"shared\"` \\| `\"isolated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"`\"external\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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 Line truncated
<TypeList types={[{"name":"Record","type":"`Record<string, [ModuleResolution](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resources","type":"`\"shared\"` \\| `\"isolated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"`\"external\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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 Line truncated
### registerMedusaLinkModule
#### Parameters
<TypeList types={[{"name":"definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"worker_mode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"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&#60;[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx)&#62;","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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","descriLine truncated
<TypeList types={[{"name":"definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleExports/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"alias","type":"`string`","description":"If multiple modules are registered with the same key, the alias can be used to differentiate them","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"main","type":"`boolean`","description":"If the module is the main module for the key when multiple ones are registered","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"worker_mode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"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&#60;[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx)&#62;","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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","descriLine truncated
#### Returns
<TypeList types={[{"name":"Record","type":"`Record<string, [ModuleResolution](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resources","type":"`\"shared\"` \\| `\"isolated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"`\"external\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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 Line truncated
<TypeList types={[{"name":"Record","type":"`Record<string, [ModuleResolution](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ExternalModuleDeclaration/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"scope","type":"`\"internal\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resources","type":"`\"shared\"` \\| `\"isolated\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"`\"external\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dependencies","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"definition","type":"[CustomModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.CustomModuleDefinition/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resolve","type":"`string` \\| [ModuleExports](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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 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":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadModules"/>
<TypeList types={[{"name":"args","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"migrationOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"loaderOnly","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadModules"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;object&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="loadModules"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;any&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" 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](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStartCb","type":"() => `void`","description":"","optional":true,"defaultValue":"","expandable":false,"childreLine truncated
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"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":Line truncated
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;[MedusaAppOutput](../../modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"MedusaAppOutput","type":"[MedusaAppOutput](../../modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"modules","type":"`Record<string, [LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx) \\| [LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"link","type":"[RemoteLink](../../modules_sdk/classes/modules_sdk.RemoteLink/page.mdx) \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[RemoteQueryFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"graph","type":"[QueryGraphFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx)","description":"Graph function uses the remoteQuery under the hood and\nreturns a result set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gql","type":"(`query`: `string`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise&#60;any&#62;","description":"Query wrapper to provide specific GraphQL like API around remoteQuery.query","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"runMigrations","type":"[RunMigrationFn](../../modules_sdk/types/modules_sdk.RunMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigrations","type":"[RevertMigrationFn](../../modules_sdk/types/modules_sdk.RevertMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigrations","type":"[GenerateMigrations](../../modules_sdk/types/modules_sdk.GenerateMigrations/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"linkMigrationExecutionPlanner","type":"[GetLinkExecutionPlanner](../../modules_sdk/types/modules_sdk.GetLinkExecutionPlanner/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise&#60;void&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise&#60;void&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStart","type":"() => Promise&#60;void&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entitiesMap","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gqlSchema","type":"`GraphQLSchema`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record&#60;string, string&#62;>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaApp"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;[MedusaAppOutput](../../modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"MedusaAppOutput","type":"[MedusaAppOutput](../../modules_sdk/types/modules_sdk.MedusaAppOutput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"modules","type":"`Record<string, [LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx) \\| [LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"link","type":"[RemoteLink](../../modules_sdk/classes/modules_sdk.RemoteLink/page.mdx) \\| `undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"[RemoteQueryFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"graph","type":"[QueryGraphFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx)","description":"Graph function uses the remoteQuery under the hood and\nreturns a result set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gql","type":"(`query`: `string`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise&#60;any&#62;","description":"Query wrapper to provide specific GraphQL like API around remoteQuery.query","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"runMigrations","type":"[RunMigrationFn](../../modules_sdk/types/modules_sdk.RunMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"revertMigrations","type":"[RevertMigrationFn](../../modules_sdk/types/modules_sdk.RevertMigrationFn/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"generateMigrations","type":"[GenerateMigrations](../../modules_sdk/types/modules_sdk.GenerateMigrations/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"linkMigrationExecutionPlanner","type":"[GetLinkExecutionPlanner](../../modules_sdk/types/modules_sdk.GetLinkExecutionPlanner/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise&#60;void&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise&#60;void&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStart","type":"() => Promise&#60;void&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entitiesMap","type":"`Record<string, any>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gqlSchema","type":"`GraphQLUtils.GraphQLSchema`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record&#60;string, string&#62;>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="MedusaApp"/>
### MedusaAppMigrateUp
#### Parameters
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStartCb","type":"() => `void`","description":"","optional":true,"defaultValue":"","expandable":false,"childreLine truncated
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"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":Line truncated
#### Returns
@@ -168,7 +166,7 @@ ___
#### Parameters
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"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](../../moduleLine truncated
#### Returns
@@ -178,7 +176,7 @@ ___
#### Parameters
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
<TypeList types={[{"name":"moduleNames","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"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](../../moduleLine truncated
#### Returns
@@ -188,7 +186,7 @@ ___
#### Parameters
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"modulesConfigPath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfigFileName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesConfig","type":"[MedusaModuleConfig](../../modules_sdk/types/modules_sdk.MedusaModuleConfig/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkModules","type":"[RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx) \\| [RegisterModuleJoinerConfig](../../modules_sdk/types/modules_sdk.RegisterModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"injectedDependencies","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationStartCb","type":"() => `void`","description":"","optional":true,"defaultValue":"","expandable":false,"childreLine truncated
<TypeList types={[{"name":"options","type":"[MedusaAppOptions](../../modules_sdk/types/modules_sdk.MedusaAppOptions/page.mdx)","description":"","optional":false,"defaultValue":"{}","expandable":false,"children":[{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContainer","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"registerAdd","type":"`<T>`(`name`: `string`, `registration`: T) => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedResourcesConfig","type":"[SharedResources](../../modules_sdk/types/modules_sdk.SharedResources/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"database","type":"[ModuleServiceInitializeOptions](../../types/ModulesSdkTypes/interfaces/types.ModulesSdkTypes.ModuleServiceInitializeOptions/page.mdx)[`\"database\"`] & `object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"loadedModules","type":"[LoadedModule](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LoadedModule/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"servicesConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"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":Line truncated
#### Returns
@@ -206,98 +204,22 @@ API wrapper around the remoteQuery with backward compatibility support
<TypeList types={[{"name":"Omit","type":"Omit&#60;[RemoteQueryFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx), symbol&#62;","optional":false,"defaultValue":"","description":"API wrapper around the remoteQuery with backward compatibility support","expandable":false,"children":[{"name":"RemoteQueryFunction","type":"[RemoteQueryFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.RemoteQueryFunction/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"graph","type":"[QueryGraphFunction](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.QueryGraphFunction/page.mdx)","description":"Graph function uses the remoteQuery under the hood and\nreturns a result set","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gql","type":"(`query`: `string`, `variables?`: `Record<string, unknown>`, `options?`: [RemoteJoinerOptions](../../types/interfaces/types.RemoteJoinerOptions/page.mdx)) => Promise&#60;any&#62;","description":"Query wrapper to provide specific GraphQL like API around remoteQuery.query","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"symbol","type":"`symbol`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createQuery"/>
### cleanGraphQLSchema
### convertRecordsToLinkDefinition
#### Parameters
<TypeList types={[{"name":"schema","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cleanGraphQLSchema"/>
<TypeList types={[{"name":"links","type":"`object`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"service","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"alias","type":"[JoinerServiceConfigAlias](../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx) \\| [JoinerServiceConfigAlias](../../types/interfaces/types.JoinerServiceConfigAlias/page.mdx)[]","description":"Property name to use as entrypoint to the service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fieldAlias","type":"`Record<string, string \\| object>`","description":"alias for deeper nested relationships (e.g. &#123; 'price': 'prices.calculated\\_price\\_set.amount' &#125;)","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"args","type":"`Record<string, any>`","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"Product\" being the entity it refers to","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isReadOnlyLink","type":"`boolean`","description":"If true it expands a RemoteQuery property but doesn't create a pivot table","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extraDataFields","type":"`string`[]","description":"Fields that will be part of the link record aside from the primary keys that can be updated\nIf not explicitly defined, this array will be populated by databaseConfig.extraFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"__definition","type":"[ModuleDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleDefinition/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultPackage","type":"`string` \\| `false`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"defaultModuleDeclaration","type":"[InternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.InternalModuleDeclaration/page.mdx) \\| [ExternalModuleDeclaration](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.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":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="convertRecordsToLinkDefinition"/>
#### Returns
<TypeList types={[{"name":"schema","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record&#60;string, string&#62;>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cleanGraphQLSchema"/>
<TypeList types={[{"name":"LinkDefinition[]","type":"[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"LinkDefinition","type":"[LinkDefinition](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.LinkDefinition/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="convertRecordsToLinkDefinition"/>
<TypeList types={[{"name":"schema","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record&#60;string, string&#62;>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cleanGraphQLSchema"/>
### gqlGetFieldsAndRelations
Generate a list of fields and fields relations for a given type with the requested relations
### linkingErrorMessage
#### Parameters
<TypeList types={[{"name":"schemaTypeMap","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"typeName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":false,"defaultValue":"[]","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlGetFieldsAndRelations"/>
<TypeList types={[{"name":"input","type":"`LinkingErrorMessageInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="linkingErrorMessage"/>
#### Returns
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"Generate a list of fields and fields relations for a given type with the requested relations","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlGetFieldsAndRelations"/>
### gqlSchemaToTypes
#### Parameters
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`GraphQLSchema`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"outputDir","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filename","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlSchemaToTypes"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlSchemaToTypes"/>
### graphqlSchemaToFields
From graphql schema get all the fields for the requested type and relations
#### Example
```ts
const userModule = `
type User {
id: ID!
name: String!
blabla: WHATEVER
}
type Post {
author: User!
}
`
const postModule = `
type Post {
id: ID!
title: String!
date: String
}
type User {
posts: [Post!]!
}
type WHATEVER {
random_field: String
post: Post
}
`
const mergedSchema = mergeTypeDefs([userModule, postModule])
const schema = makeExecutableSchema({
typeDefs: mergedSchema,
})
const fields = graphqlSchemaToFields(types, "User", ["posts"])
console.log(fields)
// [
// "id",
// "name",
// "posts.id",
// "posts.title",
// "posts.date",
// ]
```
#### Parameters
<TypeList types={[{"name":"schemaTypeMap","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"typeName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":false,"defaultValue":"[]","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="graphqlSchemaToFields"/>
#### Returns
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"From graphql schema get all the fields for the requested type and relations","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="graphqlSchemaToFields"/>
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="linkingErrorMessage"/>
@@ -133,6 +133,7 @@ import { TypeList } from "docs-ui"
- [ModuleJoinerConfig](../../order/types/order.ModuleJoinerConfig/page.mdx)
- [ModuleJoinerRelationship](../../order/types/order.ModuleJoinerRelationship/page.mdx)
- [ChangeActionType](../../order/types/order.ChangeActionType/page.mdx)
- [OrderChangeStatus](../../order/types/order.OrderChangeStatus/page.mdx)
- [OrderStatus](../../order/types/order.OrderStatus/page.mdx)
- [ReturnStatus](../../order/types/order.ReturnStatus/page.mdx)
- [ReturnStatus](../../order/types/order.ReturnStatus-1/page.mdx)
@@ -6,6 +6,7 @@ import { TypeList } from "docs-ui"
- [CoreFlowsUitls](../../utils/utils.CoreFlowsUitls/page.mdx)
- [FulfillmentUtils](../../utils/utils.FulfillmentUtils/page.mdx)
- [GraphQLUtils](../../utils/utils.GraphQLUtils/page.mdx)
- [InventoryUtils](../../utils/utils.InventoryUtils/page.mdx)
- [LinkUtils](../../utils/utils.LinkUtils/page.mdx)
- [OrderUtils](../../utils/utils.OrderUtils/page.mdx)
@@ -24,6 +25,19 @@ import { TypeList } from "docs-ui"
- [PriceListStatus](../../utils/enums/utils.PriceListStatus/page.mdx)
- [PriceListType](../../utils/enums/utils.PriceListType/page.mdx)
## Classes
- [GraphQLParser](../../utils/classes/utils.GraphQLParser/page.mdx)
## Interfaces
- [JoinerArgument](../../utils/interfaces/utils.JoinerArgument/page.mdx)
- [JoinerDirective](../../utils/interfaces/utils.JoinerDirective/page.mdx)
- [RemoteJoinerQuery](../../utils/interfaces/utils.RemoteJoinerQuery/page.mdx)
- [Argument](../../utils/interfaces/utils.Argument/page.mdx)
- [Directive](../../utils/interfaces/utils.Directive/page.mdx)
- [Entity](../../utils/interfaces/utils.Entity/page.mdx)
## Variables
- [MedusaModuleType](page.mdx#medusamoduletype)
@@ -34,6 +48,11 @@ import { TypeList } from "docs-ui"
## Functions
- [generateJwtToken](page.mdx#generatejwttoken)
- [cleanGraphQLSchema](page.mdx#cleangraphqlschema)
- [extractRelationsFromGQL](page.mdx#extractrelationsfromgql)
- [gqlGetFieldsAndRelations](page.mdx#gqlgetfieldsandrelations)
- [graphqlSchemaToFields](page.mdx#graphqlschematofields)
- [gqlSchemaToTypes](page.mdx#gqlschematotypes)
- [parseConnectionString](page.mdx#parseconnectionstring)
- [createClient](page.mdx#createclient)
- [createDb](page.mdx#createdb)
@@ -77,6 +96,114 @@ ___
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="generateJwtToken"/>
### cleanGraphQLSchema
#### Parameters
<TypeList types={[{"name":"schema","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cleanGraphQLSchema"/>
#### Returns
<TypeList types={[{"name":"schema","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record&#60;string, string&#62;>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cleanGraphQLSchema"/>
<TypeList types={[{"name":"schema","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"notFound","type":"`Record<string, Record&#60;string, string&#62;>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cleanGraphQLSchema"/>
### extractRelationsFromGQL
Extracts only the relation fields from the GraphQL type map.
#### Parameters
<TypeList types={[{"name":"typeMap","type":"Map&#60;string, any&#62;","description":"The GraphQL schema TypeMap.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="extractRelationsFromGQL"/>
#### Returns
<TypeList types={[{"name":"Map","type":"Map&#60;string, Map&#60;string, string&#62;&#62;","optional":false,"defaultValue":"","description":"A map where each key is an entity name, and the values are a map of relation fields and their corresponding entity type.","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"Map","type":"Map&#60;string, string&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="extractRelationsFromGQL"/>
### gqlGetFieldsAndRelations
Generate a list of fields and fields relations for a given type with the requested relations
#### Parameters
<TypeList types={[{"name":"schemaTypeMap","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"typeName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":false,"defaultValue":"[]","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlGetFieldsAndRelations"/>
#### Returns
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"Generate a list of fields and fields relations for a given type with the requested relations","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlGetFieldsAndRelations"/>
### graphqlSchemaToFields
From graphql schema get all the fields for the requested type and relations
#### Example
```ts
const userModule = `
type User {
id: ID!
name: String!
blabla: WHATEVER
}
type Post {
author: User!
}
`
const postModule = `
type Post {
id: ID!
title: String!
date: String
}
type User {
posts: [Post!]!
}
type WHATEVER {
random_field: String
post: Post
}
`
const mergedSchema = mergeTypeDefs([userModule, postModule])
const schema = makeExecutableSchema({
typeDefs: mergedSchema,
})
const fields = graphqlSchemaToFields(types, "User", ["posts"])
console.log(fields)
// [
// "id",
// "name",
// "posts.id",
// "posts.title",
// "posts.date",
// ]
```
#### Parameters
<TypeList types={[{"name":"schemaTypeMap","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"typeName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":false,"defaultValue":"[]","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="graphqlSchemaToFields"/>
#### Returns
<TypeList types={[{"name":"string[]","type":"`string`[]","optional":false,"defaultValue":"","description":"From graphql schema get all the fields for the requested type and relations","expandable":false,"children":[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="graphqlSchemaToFields"/>
### gqlSchemaToTypes
#### Parameters
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`GraphQLSchema`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"outputDir","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filename","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"joinerConfigs","type":"[ModuleJoinerConfig](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerConfig/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"schema","type":"`string`","description":"GraphQL schema for the all module's available entities and fields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relationships","type":"[ModuleJoinerRelationship](../../types/ModulesSdkTypes/types/types.ModulesSdkTypes.ModuleJoinerRelationship/page.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extends","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"serviceName","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"primaryKeys","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isLink","type":"`boolean`","description":"If the module is a link module","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"linkableKeys","type":"`Record<string, string>`","description":"Keys that can be used to link to other modules. e.g &#123; product\\_id: \"Product\" &#125; \"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":"interfaceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlSchemaToTypes"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="gqlSchemaToTypes"/>
### parseConnectionString
Parsers the database connection string into an object