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

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

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andkodiakhq authored and GitHub committed 2024-09-18 08:07:01 +02:00
1 parent 26700821a2
commit a63f6910d0
23 files changed
+31509 -31051
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/resources/references/core_flows/Inventory/Workflows_Inventory/functions/core_flows.Inventory.Workflows_Inventory.bulkCreateDeleteLevelsWorkflow/page.mdx
+1 -1
View File
@@ -13,7 +13,7 @@ This workflow creates and deletes inventory levels.
## Steps
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../../../core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1},{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../../../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}} />
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"when","condition":"{\n return !!input.deletes?.length\n }","depth":"1","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../../../core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1}]},{"type":"when","condition":"{\n return !!input.creates?.length\n }","depth":"2","steps":[{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../../../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}]}} />
## Input
www/apps/resources/references/core_flows/Inventory/core_flows.Inventory.Workflows_Inventory/page.mdx
+1 -1
View File
@@ -8,7 +8,7 @@ This workflow creates and deletes inventory levels.
### Steps
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1},{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}} />
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"when","condition":"{\n return !!input.deletes?.length\n }","depth":"1","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1}]},{"type":"when","condition":"{\n return !!input.creates?.length\n }","depth":"2","steps":[{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}]}} />
### Input
www/apps/resources/references/core_flows/core_flows.Workflows_Inventory/page.mdx
+1 -1
View File
@@ -54,7 +54,7 @@ This workflow creates and deletes inventory levels.
### Steps
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"page.mdx#deleteinventorylevelsworkflow","depth":1},{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}} />
<WorkflowDiagram workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"when","condition":"{\n return !!input.deletes?.length\n }","depth":"1","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"page.mdx#deleteinventorylevelsworkflow","depth":1}]},{"type":"when","condition":"{\n return !!input.creates?.length\n }","depth":"2","steps":[{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}]}} />
### Input
www/apps/resources/references/modules/core_flows/page.mdx
+1 -1
View File
@@ -5289,7 +5289,7 @@ This workflow creates and deletes inventory levels.
#### Steps
<undefined workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../core_flows/core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1},{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}} />
<undefined workflow={{"name":"bulkCreateDeleteLevelsWorkflow","steps":[{"type":"when","condition":"{\n return !!input.deletes?.length\n }","depth":"1","steps":[{"type":"workflow","name":"deleteInventoryLevelsWorkflow","description":"This workflow deletes one or more inventory levels.","link":"../../core_flows/core_flows.Workflows_Inventory/page.mdx#deleteinventorylevelsworkflow","depth":1}]},{"type":"when","condition":"{\n return !!input.creates?.length\n }","depth":"2","steps":[{"type":"step","name":"createInventoryLevelsStep","description":"This step creates one or more inventory levels.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#createinventorylevelsstep","depth":2}]}]}} />
#### Input
www/apps/resources/references/modules/medusa/page.mdx
+15 -6
View File
@@ -52,6 +52,7 @@ import { TypeList } from "docs-ui"
- [instrumentHttpLayer](page.mdx#instrumenthttplayer)
- [instrumentRemoteQuery](page.mdx#instrumentremotequery)
- [instrumentWorkflows](page.mdx#instrumentworkflows)
- [registerOtel](page.mdx#registerotel)
___
@@ -70,20 +71,28 @@ ___
### instrumentHttpLayer
Instrumenting the first touch point of the HTTP layer to report traces to
Instrument the first touch point of the HTTP layer to report traces to
OpenTelemetry
#### Returns
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Instrumenting the first touch point of the HTTP layer to report traces to\nOpenTelemetry","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="instrumentHttpLayer"/>
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Instrument the first touch point of the HTTP layer to report traces to\nOpenTelemetry","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="instrumentHttpLayer"/>
### instrumentRemoteQuery
Instrumenting the queries made using the remote query
Instrument the queries made using the remote query
#### Returns
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Instrumenting the queries made using the remote query","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="instrumentRemoteQuery"/>
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Instrument the queries made using the remote query","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="instrumentRemoteQuery"/>
### instrumentWorkflows
Instrument the workflows and steps execution
#### Returns
<TypeList types={[{"name":"void","type":"`void`","optional":false,"defaultValue":"","description":"Instrument the workflows and steps execution","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="instrumentWorkflows"/>
### registerOtel
@@ -101,8 +110,8 @@ telemetry to work
#### Parameters
<TypeList types={[{"name":"options","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exporter","type":"`SpanExporter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"instrumentations","type":"Instrumentation&#60;InstrumentationConfig&#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="registerOtel"/>
<TypeList types={[{"name":"options","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"serviceName","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exporter","type":"`SpanExporter`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"instrument","type":"Partial&#60;object&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"http","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflows","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"db","type":"`boolean`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"instrumentations","type":"Instrumentation&#60;InstrumentationConfig&#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="registerOtel"/>
#### Returns
<TypeList types={[{"name":"NodeSDK","type":"`NodeSDK`","optional":false,"defaultValue":"","description":"A helper function to configure the OpenTelemetry SDK with some defaults.\nFor better/more control, please configure the SDK manually.\n\nYou will have to install the following packages within your app for\ntelemetry to work\n\n- @opentelemetry/sdk-node\n- @opentelemetry/resources\n- @opentelemetry/sdk-trace-node\n- @opentelemetry/instrumentation-pg\n- @opentelemetry/instrumentation","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOtel"/>
<TypeList types={[{"name":"any","type":"`any`","optional":false,"defaultValue":"","description":"A helper function to configure the OpenTelemetry SDK with some defaults.\nFor better/more control, please configure the SDK manually.\n\nYou will have to install the following packages within your app for\ntelemetry to work\n\n- @opentelemetry/sdk-node\n- @opentelemetry/resources\n- @opentelemetry/sdk-trace-node\n- @opentelemetry/instrumentation-pg\n- @opentelemetry/instrumentation","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerOtel"/>
www/apps/resources/references/modules_sdk/classes/modules_sdk.RemoteQuery/page.mdx
+7 -1
View File
@@ -6,7 +6,7 @@ import { TypeList } from "docs-ui"
### Parameters
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"modulesLoaded","type":"`object`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"__joinerConfig","type":"[ModuleJoinerConfig](../../../types/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":"customRemoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"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":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new RemoteQuery"/>
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"entitiesMap","type":"Map&#60;string, any&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"modulesLoaded","type":"`object`[]","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":"customRemoteFetchData","type":"`RemoteFetchDataCallback`","description":"","optional":true,"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":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new RemoteQuery"/>
___
@@ -18,6 +18,12 @@ ___
## Methods
### getEntitiesMap
#### Returns
<TypeList types={[{"name":"Map","type":"Map&#60;string, any&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"string","type":"`string`","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="getEntitiesMap"/>
### setFetchDataCallback
#### Parameters