chore(docs): Generated References (#8461)
Generated the following references: - `medusa` - `modules` - `types`
This commit is contained in:
1 parent
caf1bfd23b
commit
413e29837c
19 files changed
+23490
-23314
No files matched your search
@@ -3239,6 +3239,10 @@ export const filesMap = [
|
|||||||
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx",
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx",
|
||||||
"pathname": "/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep"
|
"pathname": "/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.emitEventStep/page.mdx",
|
||||||
|
"pathname": "/references/helper_steps/functions/helper_steps.emitEventStep"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.removeRemoteLinkStep/page.mdx",
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.removeRemoteLinkStep/page.mdx",
|
||||||
"pathname": "/references/helper_steps/functions/helper_steps.removeRemoteLinkStep"
|
"pathname": "/references/helper_steps/functions/helper_steps.removeRemoteLinkStep"
|
||||||
@@ -9535,6 +9539,10 @@ export const filesMap = [
|
|||||||
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreFile/page.mdx",
|
"filePath": "/www/apps/resources/references/types/HttpTypes/interfaces/types.HttpTypes.StoreFile/page.mdx",
|
||||||
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreFile"
|
"pathname": "/references/types/HttpTypes/interfaces/types.HttpTypes.StoreFile"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"filePath": "/www/apps/resources/references/types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx",
|
||||||
|
"pathname": "/references/types/HttpTypes/types/types.HttpTypes.AdditionalData"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"filePath": "/www/apps/resources/references/types/HttpTypes/types/types.HttpTypes.AdminAcceptInvite/page.mdx",
|
"filePath": "/www/apps/resources/references/types/HttpTypes/types/types.HttpTypes.AdminAcceptInvite/page.mdx",
|
||||||
"pathname": "/references/types/HttpTypes/types/types.HttpTypes.AdminAcceptInvite"
|
"pathname": "/references/types/HttpTypes/types/types.HttpTypes.AdminAcceptInvite"
|
||||||
|
|||||||
@@ -7599,6 +7599,13 @@ export const generatedSidebar = [
|
|||||||
"title": "dismissRemoteLinkStep",
|
"title": "dismissRemoteLinkStep",
|
||||||
"children": []
|
"children": []
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"loaded": true,
|
||||||
|
"isPathHref": true,
|
||||||
|
"path": "/references/helper-steps/emitEventStep",
|
||||||
|
"title": "emitEventStep",
|
||||||
|
"children": []
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"loaded": true,
|
"loaded": true,
|
||||||
"isPathHref": true,
|
"isPathHref": true,
|
||||||
|
|||||||
@@ -1109,6 +1109,11 @@ export const slugChanges = [
|
|||||||
"newSlug": "/references/helper-steps/dismissRemoteLinkStep",
|
"newSlug": "/references/helper-steps/dismissRemoteLinkStep",
|
||||||
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx"
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"origSlug": "/references/helper_steps/functions/helper_steps.emitEventStep",
|
||||||
|
"newSlug": "/references/helper-steps/emitEventStep",
|
||||||
|
"filePath": "/www/apps/resources/references/helper_steps/functions/helper_steps.emitEventStep/page.mdx"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"origSlug": "/references/helper_steps/functions/helper_steps.removeRemoteLinkStep",
|
"origSlug": "/references/helper_steps/functions/helper_steps.removeRemoteLinkStep",
|
||||||
"newSlug": "/references/helper-steps/removeRemoteLinkStep",
|
"newSlug": "/references/helper-steps/removeRemoteLinkStep",
|
||||||
|
|||||||
+37
@@ -0,0 +1,37 @@
|
|||||||
|
---
|
||||||
|
slug: /references/helper-steps/emitEventStep
|
||||||
|
sidebar_label: emitEventStep
|
||||||
|
---
|
||||||
|
|
||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# emitEventStep - Helper Steps API Reference
|
||||||
|
|
||||||
|
This documentation provides a reference to the `emitEventStep` step. It belongs to the `@medusajs/core-flows` package.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import {
|
||||||
|
createWorkflow
|
||||||
|
} from "@medusajs/workflows-sdk"
|
||||||
|
import {
|
||||||
|
emitEventStep
|
||||||
|
} from "@medusajs/core-flows"
|
||||||
|
|
||||||
|
const helloWorldWorkflow = createWorkflow(
|
||||||
|
"hello-world",
|
||||||
|
() => {
|
||||||
|
emitEventStep({
|
||||||
|
eventName: "custom.created",
|
||||||
|
data: {
|
||||||
|
id: "123"
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"Input","type":"`Input`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="emitEventStep"/>
|
||||||
+1
-1
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_context","type":"[AuthContext](../medusa.AuthContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"actor_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actor_type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"","optional":false,"defaultValue":"Line truncated
|
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_context","type":"[AuthContext](../medusa.AuthContext/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"actor_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"actor_type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"","optional":false,"defaultValue":"Line truncated
|
||||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"customer_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"userId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
|
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"customer_id","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"userId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"nLine truncated
|
||||||
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An arrLine truncated
|
<TypeList types={[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"retrieveConfig","type":"[FindConfig](../medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"keyof Entity[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fields","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"pagination","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../../types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An arrLine truncated
|
||||||
+1
-1
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
<TypeList types={[{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extendedValidators","type":"`object`","description":"Custom validators for the request body and query params that will be\nmerged with the original validator of the route.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
<TypeList types={[{"name":"error","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest-1/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extendedValidators","type":"`object`","description":"Custom validators for the request body and query params that will be\nmerged with the original validator of the route.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse-1/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest-1/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig-1/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse-1/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ import { TypeList } from "docs-ui"
|
|||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"extendedValidators","type":"`object`","description":"Custom validators for the request body and query params that will be\nmerged with the original validator of the route.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
<TypeList types={[{"name":"req","type":"[MedusaRequest](../../interfaces/medusa.MedusaRequest/page.mdx)<Body>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"validatedBody","type":"Body","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"validatedQuery","type":"[RequestQueryFields](../../interfaces/medusa.RequestQueryFields/page.mdx) & `Record<string, unknown>`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedProperties","type":"`string`[]","description":"TODO: shouldn't this correspond to returnable fields instead of allowed fields? also it is used by the cleanResponseData util","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"listConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation, skip, take and order to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"retrieveConfig","type":"[FindConfig](../../interfaces/medusa.FindConfig/page.mdx)<unknown>","description":"An object containing the select, relation to be used with medusa internal services","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"remoteQueryConfig","type":"`object`","description":"An object containing fields and variables to be used with the remoteQuery","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"filterableFields","type":"`Record<string, unknown>`","description":"An object containing the fields that are filterable e.g `{ id: Any<String> }`","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"scope","type":"[MedusaContainer](../medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes","type":"`Record<string, boolean>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowedFields","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allowed","type":"`string`[]","description":"An array of fields and relations that are allowed to be queried, this can be set by the\nconsumer as part of a middleware and it will take precedence over the defaultAllowedFields set\nby the api","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"session","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rawBody","type":"`any`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pricingContext","type":"[MedusaPricingContext](../medusa.MedusaPricingContext/page.mdx)","description":"An object that carries the context that is used to calculate prices for variants","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record<string, any>`","description":"A generic context object that can be used across the request lifecycle","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"additionalDataValidator","type":"ZodObject<any, any, ZodTypeAny, object, object>","description":"Custom validator to validate the `additional_data` property in\nrequests that allows for additional\\_data","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"res","type":"[MedusaResponse](../medusa.MedusaResponse/page.mdx)<Res>","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"next","type":"[MedusaNextFunction](../medusa.MedusaNextFunction/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records" sectionTitle="__type"/>
|
||||||
|
|
||||||
### Returns
|
### Returns
|
||||||
|
|
||||||
|
|||||||
@@ -12,5 +12,6 @@ This section of the documentation provides a reference to utility steps that you
|
|||||||
|
|
||||||
- [createRemoteLinkStep](../../helper_steps/functions/helper_steps.createRemoteLinkStep/page.mdx)
|
- [createRemoteLinkStep](../../helper_steps/functions/helper_steps.createRemoteLinkStep/page.mdx)
|
||||||
- [dismissRemoteLinkStep](../../helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx)
|
- [dismissRemoteLinkStep](../../helper_steps/functions/helper_steps.dismissRemoteLinkStep/page.mdx)
|
||||||
|
- [emitEventStep](../../helper_steps/functions/helper_steps.emitEventStep/page.mdx)
|
||||||
- [removeRemoteLinkStep](../../helper_steps/functions/helper_steps.removeRemoteLinkStep/page.mdx)
|
- [removeRemoteLinkStep](../../helper_steps/functions/helper_steps.removeRemoteLinkStep/page.mdx)
|
||||||
- [useRemoteQueryStep](../../helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx)
|
- [useRemoteQueryStep](../../helper_steps/functions/helper_steps.useRemoteQueryStep/page.mdx)
|
||||||
+12
@@ -0,0 +1,12 @@
|
|||||||
|
import { TypeList } from "docs-ui"
|
||||||
|
|
||||||
|
# AdditionalData
|
||||||
|
|
||||||
|
**AdditionalData**: `Object`
|
||||||
|
|
||||||
|
Represents the additional\_data property accepted in HTTP
|
||||||
|
requests to allow arbitrary values
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
<TypeList types={[{"name":"additional_data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="AdditionalData"/>
|
||||||
@@ -185,6 +185,7 @@ import { TypeList } from "docs-ui"
|
|||||||
## Type Aliases
|
## Type Aliases
|
||||||
|
|
||||||
- [AdminCampaignListResponse](../HttpTypes/types/types.HttpTypes.AdminCampaignListResponse/page.mdx)
|
- [AdminCampaignListResponse](../HttpTypes/types/types.HttpTypes.AdminCampaignListResponse/page.mdx)
|
||||||
|
- [AdditionalData](../HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)
|
||||||
- [DeleteResponse](../HttpTypes/types/types.HttpTypes.DeleteResponse/page.mdx)
|
- [DeleteResponse](../HttpTypes/types/types.HttpTypes.DeleteResponse/page.mdx)
|
||||||
- [PaginatedResponse](../HttpTypes/types/types.HttpTypes.PaginatedResponse/page.mdx)
|
- [PaginatedResponse](../HttpTypes/types/types.HttpTypes.PaginatedResponse/page.mdx)
|
||||||
- [AdminUploadFile](../HttpTypes/types/types.HttpTypes.AdminUploadFile/page.mdx)
|
- [AdminUploadFile](../HttpTypes/types/types.HttpTypes.AdminUploadFile/page.mdx)
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -788,6 +788,287 @@
|
|||||||
},
|
},
|
||||||
"defaultValue": "\"emit-event-step\""
|
"defaultValue": "\"emit-event-step\""
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"id": 13732,
|
||||||
|
"name": "emitEventStep",
|
||||||
|
"variant": "declaration",
|
||||||
|
"kind": 64,
|
||||||
|
"flags": {},
|
||||||
|
"comment": {
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"kind": "text",
|
||||||
|
"text": "Emit an event."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"blockTags": [
|
||||||
|
{
|
||||||
|
"tag": "@example",
|
||||||
|
"content": [
|
||||||
|
{
|
||||||
|
"kind": "code",
|
||||||
|
"text": "```ts\nimport { \n createWorkflow\n} from \"@medusajs/workflows-sdk\"\nimport {\n emitEventStep\n} from \"@medusajs/core-flows\"\n\nconst helloWorldWorkflow = createWorkflow(\n \"hello-world\",\n () => {\n emitEventStep({\n eventName: \"custom.created\",\n data: {\n id: \"123\"\n }\n })\n }\n)\n```"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"children": [
|
||||||
|
{
|
||||||
|
"id": 13741,
|
||||||
|
"name": "__type",
|
||||||
|
"variant": "declaration",
|
||||||
|
"kind": 1024,
|
||||||
|
"flags": {},
|
||||||
|
"type": {
|
||||||
|
"type": "intrinsic",
|
||||||
|
"name": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": 13742,
|
||||||
|
"name": "__step__",
|
||||||
|
"variant": "declaration",
|
||||||
|
"kind": 1024,
|
||||||
|
"flags": {},
|
||||||
|
"type": {
|
||||||
|
"type": "intrinsic",
|
||||||
|
"name": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"groups": [
|
||||||
|
{
|
||||||
|
"title": "Properties",
|
||||||
|
"children": [
|
||||||
|
13741,
|
||||||
|
13742
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"signatures": [
|
||||||
|
{
|
||||||
|
"id": 13733,
|
||||||
|
"name": "emitEventStep",
|
||||||
|
"variant": "signature",
|
||||||
|
"kind": 4096,
|
||||||
|
"flags": {},
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"id": 13734,
|
||||||
|
"name": "input",
|
||||||
|
"variant": "param",
|
||||||
|
"kind": 32768,
|
||||||
|
"flags": {},
|
||||||
|
"type": {
|
||||||
|
"type": "union",
|
||||||
|
"types": [
|
||||||
|
{
|
||||||
|
"type": "reference",
|
||||||
|
"target": {
|
||||||
|
"sourceFileName": "../../../../packages/core/core-flows/src/common/steps/emit-event.ts",
|
||||||
|
"qualifiedName": "Input"
|
||||||
|
},
|
||||||
|
"name": "Input",
|
||||||
|
"package": "@medusajs/core-flows"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "reference",
|
||||||
|
"target": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "WorkflowData"
|
||||||
|
},
|
||||||
|
"typeArguments": [
|
||||||
|
{
|
||||||
|
"type": "reference",
|
||||||
|
"target": {
|
||||||
|
"sourceFileName": "../../../../packages/core/core-flows/src/common/steps/emit-event.ts",
|
||||||
|
"qualifiedName": "Input"
|
||||||
|
},
|
||||||
|
"name": "Input",
|
||||||
|
"package": "@medusajs/core-flows"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "WorkflowData",
|
||||||
|
"package": "@medusajs/workflows-sdk"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"type": {
|
||||||
|
"type": "intersection",
|
||||||
|
"types": [
|
||||||
|
{
|
||||||
|
"type": "reference",
|
||||||
|
"target": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "WorkflowDataProperties"
|
||||||
|
},
|
||||||
|
"typeArguments": [
|
||||||
|
{
|
||||||
|
"type": "intrinsic",
|
||||||
|
"name": "unknown"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "WorkflowDataProperties",
|
||||||
|
"package": "@medusajs/workflows-sdk"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "reflection",
|
||||||
|
"declaration": {
|
||||||
|
"id": 13735,
|
||||||
|
"name": "__type",
|
||||||
|
"variant": "declaration",
|
||||||
|
"kind": 65536,
|
||||||
|
"flags": {},
|
||||||
|
"children": [
|
||||||
|
{
|
||||||
|
"id": 13736,
|
||||||
|
"name": "config",
|
||||||
|
"variant": "declaration",
|
||||||
|
"kind": 2048,
|
||||||
|
"flags": {},
|
||||||
|
"signatures": [
|
||||||
|
{
|
||||||
|
"id": 13737,
|
||||||
|
"name": "config",
|
||||||
|
"variant": "signature",
|
||||||
|
"kind": 4096,
|
||||||
|
"flags": {},
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"id": 13738,
|
||||||
|
"name": "config",
|
||||||
|
"variant": "param",
|
||||||
|
"kind": 32768,
|
||||||
|
"flags": {},
|
||||||
|
"type": {
|
||||||
|
"type": "intersection",
|
||||||
|
"types": [
|
||||||
|
{
|
||||||
|
"type": "reflection",
|
||||||
|
"declaration": {
|
||||||
|
"id": 13739,
|
||||||
|
"name": "__type",
|
||||||
|
"variant": "declaration",
|
||||||
|
"kind": 65536,
|
||||||
|
"flags": {},
|
||||||
|
"children": [
|
||||||
|
{
|
||||||
|
"id": 13740,
|
||||||
|
"name": "name",
|
||||||
|
"variant": "declaration",
|
||||||
|
"kind": 1024,
|
||||||
|
"flags": {
|
||||||
|
"isOptional": true
|
||||||
|
},
|
||||||
|
"type": {
|
||||||
|
"type": "intrinsic",
|
||||||
|
"name": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"groups": [
|
||||||
|
{
|
||||||
|
"title": "Properties",
|
||||||
|
"children": [
|
||||||
|
13740
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "reference",
|
||||||
|
"target": {
|
||||||
|
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
|
||||||
|
"qualifiedName": "Omit"
|
||||||
|
},
|
||||||
|
"typeArguments": [
|
||||||
|
{
|
||||||
|
"type": "reference",
|
||||||
|
"target": {
|
||||||
|
"sourceFileName": "../../../../packages/core/orchestration/src/transaction/types.ts",
|
||||||
|
"qualifiedName": "TransactionStepsDefinition"
|
||||||
|
},
|
||||||
|
"name": "TransactionStepsDefinition",
|
||||||
|
"package": "@medusajs/orchestration"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "union",
|
||||||
|
"types": [
|
||||||
|
{
|
||||||
|
"type": "literal",
|
||||||
|
"value": "next"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "literal",
|
||||||
|
"value": "uuid"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "literal",
|
||||||
|
"value": "action"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "Omit",
|
||||||
|
"package": "typescript"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"type": {
|
||||||
|
"type": "reference",
|
||||||
|
"target": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "WorkflowData"
|
||||||
|
},
|
||||||
|
"typeArguments": [
|
||||||
|
{
|
||||||
|
"type": "intrinsic",
|
||||||
|
"name": "unknown"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "WorkflowData",
|
||||||
|
"package": "@medusajs/workflows-sdk"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"groups": [
|
||||||
|
{
|
||||||
|
"title": "Methods",
|
||||||
|
"children": [
|
||||||
|
13736
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "reference",
|
||||||
|
"target": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "StepFunctionReturnConfig"
|
||||||
|
},
|
||||||
|
"typeArguments": [
|
||||||
|
{
|
||||||
|
"type": "intrinsic",
|
||||||
|
"name": "unknown"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"name": "StepFunctionReturnConfig",
|
||||||
|
"package": "@medusajs/workflows-sdk"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"id": 13718,
|
"id": 13718,
|
||||||
"name": "removeRemoteLinkStepId",
|
"name": "removeRemoteLinkStepId",
|
||||||
@@ -1984,6 +2265,7 @@
|
|||||||
"children": [
|
"children": [
|
||||||
13694,
|
13694,
|
||||||
13707,
|
13707,
|
||||||
|
13732,
|
||||||
13719,
|
13719,
|
||||||
13764
|
13764
|
||||||
]
|
]
|
||||||
@@ -2151,6 +2433,50 @@
|
|||||||
"sourceFileName": "../../../../packages/core/core-flows/src/common/steps/emit-event.ts",
|
"sourceFileName": "../../../../packages/core/core-flows/src/common/steps/emit-event.ts",
|
||||||
"qualifiedName": "emitEventStepId"
|
"qualifiedName": "emitEventStepId"
|
||||||
},
|
},
|
||||||
|
"13732": {
|
||||||
|
"sourceFileName": "../../../../packages/core/core-flows/src/common/steps/emit-event.ts",
|
||||||
|
"qualifiedName": "emitEventStep"
|
||||||
|
},
|
||||||
|
"13733": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "emitEventStep"
|
||||||
|
},
|
||||||
|
"13734": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "input"
|
||||||
|
},
|
||||||
|
"13735": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "__type"
|
||||||
|
},
|
||||||
|
"13736": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "__type.config"
|
||||||
|
},
|
||||||
|
"13737": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "__type.config"
|
||||||
|
},
|
||||||
|
"13738": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "config"
|
||||||
|
},
|
||||||
|
"13739": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "__type"
|
||||||
|
},
|
||||||
|
"13740": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "__type.name"
|
||||||
|
},
|
||||||
|
"13741": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "__type.__type"
|
||||||
|
},
|
||||||
|
"13742": {
|
||||||
|
"sourceFileName": "../../../../packages/core/workflows-sdk/src/utils/composer/type.ts",
|
||||||
|
"qualifiedName": "__type.__step__"
|
||||||
|
},
|
||||||
"13743": {
|
"13743": {
|
||||||
"sourceFileName": "../../../../packages/core/core-flows/src/common/steps/use-remote-query.ts",
|
"sourceFileName": "../../../../packages/core/core-flows/src/common/steps/use-remote-query.ts",
|
||||||
"qualifiedName": "RemoteStepInput"
|
"qualifiedName": "RemoteStepInput"
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"id": 14850,
|
"id": 14835,
|
||||||
"name": "tax-provider",
|
"name": "tax-provider",
|
||||||
"variant": "project",
|
"variant": "project",
|
||||||
"kind": 1,
|
"kind": 1,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 14851,
|
"id": 14836,
|
||||||
"name": "ShippingTaxCalculationLine",
|
"name": "ShippingTaxCalculationLine",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 2097152,
|
"kind": 2097152,
|
||||||
@@ -22,14 +22,14 @@
|
|||||||
"type": {
|
"type": {
|
||||||
"type": "reflection",
|
"type": "reflection",
|
||||||
"declaration": {
|
"declaration": {
|
||||||
"id": 14852,
|
"id": 14837,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 65536,
|
"kind": 65536,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 14853,
|
"id": 14838,
|
||||||
"name": "shipping_line",
|
"name": "shipping_line",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -53,7 +53,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 14854,
|
"id": 14839,
|
||||||
"name": "rates",
|
"name": "rates",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -84,8 +84,8 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
14853,
|
14838,
|
||||||
14854
|
14839
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -93,7 +93,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 14855,
|
"id": 14840,
|
||||||
"name": "ItemTaxCalculationLine",
|
"name": "ItemTaxCalculationLine",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 2097152,
|
"kind": 2097152,
|
||||||
@@ -109,14 +109,14 @@
|
|||||||
"type": {
|
"type": {
|
||||||
"type": "reflection",
|
"type": "reflection",
|
||||||
"declaration": {
|
"declaration": {
|
||||||
"id": 14856,
|
"id": 14841,
|
||||||
"name": "__type",
|
"name": "__type",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 65536,
|
"kind": 65536,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 14857,
|
"id": 14842,
|
||||||
"name": "line_item",
|
"name": "line_item",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -140,7 +140,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 14858,
|
"id": 14843,
|
||||||
"name": "rates",
|
"name": "rates",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 1024,
|
"kind": 1024,
|
||||||
@@ -171,8 +171,8 @@
|
|||||||
{
|
{
|
||||||
"title": "Properties",
|
"title": "Properties",
|
||||||
"children": [
|
"children": [
|
||||||
14857,
|
14842,
|
||||||
14858
|
14843
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -180,7 +180,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 14859,
|
"id": 14844,
|
||||||
"name": "ITaxProvider",
|
"name": "ITaxProvider",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 256,
|
"kind": 256,
|
||||||
@@ -283,14 +283,14 @@
|
|||||||
},
|
},
|
||||||
"children": [
|
"children": [
|
||||||
{
|
{
|
||||||
"id": 14862,
|
"id": 14847,
|
||||||
"name": "getTaxLines",
|
"name": "getTaxLines",
|
||||||
"variant": "declaration",
|
"variant": "declaration",
|
||||||
"kind": 2048,
|
"kind": 2048,
|
||||||
"flags": {},
|
"flags": {},
|
||||||
"signatures": [
|
"signatures": [
|
||||||
{
|
{
|
||||||
"id": 14863,
|
"id": 14848,
|
||||||
"name": "getTaxLines",
|
"name": "getTaxLines",
|
||||||
"variant": "signature",
|
"variant": "signature",
|
||||||
"kind": 4096,
|
"kind": 4096,
|
||||||
@@ -361,7 +361,7 @@
|
|||||||
},
|
},
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
"id": 14864,
|
"id": 14849,
|
||||||
"name": "itemLines",
|
"name": "itemLines",
|
||||||
"variant": "param",
|
"variant": "param",
|
||||||
"kind": 32768,
|
"kind": 32768,
|
||||||
@@ -378,14 +378,14 @@
|
|||||||
"type": "array",
|
"type": "array",
|
||||||
"elementType": {
|
"elementType": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": 14855,
|
"target": 14840,
|
||||||
"name": "ItemTaxCalculationLine",
|
"name": "ItemTaxCalculationLine",
|
||||||
"package": "@medusajs/types"
|
"package": "@medusajs/types"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 14865,
|
"id": 14850,
|
||||||
"name": "shippingLines",
|
"name": "shippingLines",
|
||||||
"variant": "param",
|
"variant": "param",
|
||||||
"kind": 32768,
|
"kind": 32768,
|
||||||
@@ -402,14 +402,14 @@
|
|||||||
"type": "array",
|
"type": "array",
|
||||||
"elementType": {
|
"elementType": {
|
||||||
"type": "reference",
|
"type": "reference",
|
||||||
"target": 14851,
|
"target": 14836,
|
||||||
"name": "ShippingTaxCalculationLine",
|
"name": "ShippingTaxCalculationLine",
|
||||||
"package": "@medusajs/types"
|
"package": "@medusajs/types"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": 14866,
|
"id": 14851,
|
||||||
"name": "context",
|
"name": "context",
|
||||||
"variant": "param",
|
"variant": "param",
|
||||||
"kind": 32768,
|
"kind": 32768,
|
||||||
@@ -478,7 +478,7 @@
|
|||||||
{
|
{
|
||||||
"title": "Methods",
|
"title": "Methods",
|
||||||
"children": [
|
"children": [
|
||||||
14862
|
14847
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
@@ -488,76 +488,76 @@
|
|||||||
{
|
{
|
||||||
"title": "Interfaces",
|
"title": "Interfaces",
|
||||||
"children": [
|
"children": [
|
||||||
14859
|
14844
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"title": "Type Aliases",
|
"title": "Type Aliases",
|
||||||
"children": [
|
"children": [
|
||||||
14851,
|
14836,
|
||||||
14855
|
14840
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"packageName": "@medusajs/types",
|
"packageName": "@medusajs/types",
|
||||||
"symbolIdMap": {
|
"symbolIdMap": {
|
||||||
"14850": {
|
"14835": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": ""
|
"qualifiedName": ""
|
||||||
},
|
},
|
||||||
"14851": {
|
"14836": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "ShippingTaxCalculationLine"
|
"qualifiedName": "ShippingTaxCalculationLine"
|
||||||
},
|
},
|
||||||
"14852": {
|
"14837": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"14853": {
|
"14838": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type.shipping_line"
|
"qualifiedName": "__type.shipping_line"
|
||||||
},
|
},
|
||||||
"14854": {
|
"14839": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type.rates"
|
"qualifiedName": "__type.rates"
|
||||||
},
|
},
|
||||||
"14855": {
|
"14840": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "ItemTaxCalculationLine"
|
"qualifiedName": "ItemTaxCalculationLine"
|
||||||
},
|
},
|
||||||
"14856": {
|
"14841": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type"
|
"qualifiedName": "__type"
|
||||||
},
|
},
|
||||||
"14857": {
|
"14842": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type.line_item"
|
"qualifiedName": "__type.line_item"
|
||||||
},
|
},
|
||||||
"14858": {
|
"14843": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "__type.rates"
|
"qualifiedName": "__type.rates"
|
||||||
},
|
},
|
||||||
"14859": {
|
"14844": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "ITaxProvider"
|
"qualifiedName": "ITaxProvider"
|
||||||
},
|
},
|
||||||
"14862": {
|
"14847": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "ITaxProvider.getTaxLines"
|
"qualifiedName": "ITaxProvider.getTaxLines"
|
||||||
},
|
},
|
||||||
"14863": {
|
"14848": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "ITaxProvider.getTaxLines"
|
"qualifiedName": "ITaxProvider.getTaxLines"
|
||||||
},
|
},
|
||||||
"14864": {
|
"14849": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "itemLines"
|
"qualifiedName": "itemLines"
|
||||||
},
|
},
|
||||||
"14865": {
|
"14850": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "shippingLines"
|
"qualifiedName": "shippingLines"
|
||||||
},
|
},
|
||||||
"14866": {
|
"14851": {
|
||||||
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
|
||||||
"qualifiedName": "context"
|
"qualifiedName": "context"
|
||||||
}
|
}
|
||||||
@@ -567,7 +567,7 @@
|
|||||||
"1": "../../../../packages/core/types/src/tax/provider.ts"
|
"1": "../../../../packages/core/types/src/tax/provider.ts"
|
||||||
},
|
},
|
||||||
"reflections": {
|
"reflections": {
|
||||||
"1": 14850
|
"1": 14835
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
File diff suppressed because it is too large.
Load diff
Reference in new issue
Block a user