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

chore(docs): Generated References (#8461)

Browse Source 
Generated the following references:
- `medusa`
- `modules`
- `types`
This commit is contained in:
github-actions[bot] authored and GitHub committed 2024-08-06 07:07:15 +00:00
1 parent caf1bfd23b
commit 413e29837c
19 files changed
+20264 -20088
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/utils/generated/typedoc-json-output/0-medusa.json
+708 -1005
View File
File diff suppressed because it is too large. Load diff
www/utils/generated/typedoc-json-output/0-types.json
+15649 -15573
View File
File diff suppressed because it is too large. Load diff
www/utils/generated/typedoc-json-output/helper-steps.json
+326
View File
@@ -788,6 +788,287 @@
},
"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,
"name": "removeRemoteLinkStepId",
@@ -1984,6 +2265,7 @@
"children": [
13694,
13707,
13732,
13719,
13764
]
@@ -2151,6 +2433,50 @@
"sourceFileName": "../../../../packages/core/core-flows/src/common/steps/emit-event.ts",
"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": {
"sourceFileName": "../../../../packages/core/core-flows/src/common/steps/use-remote-query.ts",
"qualifiedName": "RemoteStepInput"
www/utils/generated/typedoc-json-output/modules-sdk.json
+2555 -2555
View File
File diff suppressed because it is too large. Load diff
www/utils/generated/typedoc-json-output/tax-provider.json
+41 -41
View File
@@ -1,12 +1,12 @@
{
"id": 14850,
"id": 14835,
"name": "tax-provider",
"variant": "project",
"kind": 1,
"flags": {},
"children": [
{
"id": 14851,
"id": 14836,
"name": "ShippingTaxCalculationLine",
"variant": "declaration",
"kind": 2097152,
@@ -22,14 +22,14 @@
"type": {
"type": "reflection",
"declaration": {
"id": 14852,
"id": 14837,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 14853,
"id": 14838,
"name": "shipping_line",
"variant": "declaration",
"kind": 1024,
@@ -53,7 +53,7 @@
}
},
{
"id": 14854,
"id": 14839,
"name": "rates",
"variant": "declaration",
"kind": 1024,
@@ -84,8 +84,8 @@
{
"title": "Properties",
"children": [
14853,
14854
14838,
14839
]
}
]
@@ -93,7 +93,7 @@
}
},
{
"id": 14855,
"id": 14840,
"name": "ItemTaxCalculationLine",
"variant": "declaration",
"kind": 2097152,
@@ -109,14 +109,14 @@
"type": {
"type": "reflection",
"declaration": {
"id": 14856,
"id": 14841,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 14857,
"id": 14842,
"name": "line_item",
"variant": "declaration",
"kind": 1024,
@@ -140,7 +140,7 @@
}
},
{
"id": 14858,
"id": 14843,
"name": "rates",
"variant": "declaration",
"kind": 1024,
@@ -171,8 +171,8 @@
{
"title": "Properties",
"children": [
14857,
14858
14842,
14843
]
}
]
@@ -180,7 +180,7 @@
}
},
{
"id": 14859,
"id": 14844,
"name": "ITaxProvider",
"variant": "declaration",
"kind": 256,
@@ -283,14 +283,14 @@
},
"children": [
{
"id": 14862,
"id": 14847,
"name": "getTaxLines",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 14863,
"id": 14848,
"name": "getTaxLines",
"variant": "signature",
"kind": 4096,
@@ -361,7 +361,7 @@
},
"parameters": [
{
"id": 14864,
"id": 14849,
"name": "itemLines",
"variant": "param",
"kind": 32768,
@@ -378,14 +378,14 @@
"type": "array",
"elementType": {
"type": "reference",
"target": 14855,
"target": 14840,
"name": "ItemTaxCalculationLine",
"package": "@medusajs/types"
}
}
},
{
"id": 14865,
"id": 14850,
"name": "shippingLines",
"variant": "param",
"kind": 32768,
@@ -402,14 +402,14 @@
"type": "array",
"elementType": {
"type": "reference",
"target": 14851,
"target": 14836,
"name": "ShippingTaxCalculationLine",
"package": "@medusajs/types"
}
}
},
{
"id": 14866,
"id": 14851,
"name": "context",
"variant": "param",
"kind": 32768,
@@ -478,7 +478,7 @@
{
"title": "Methods",
"children": [
14862
14847
]
}
]
@@ -488,76 +488,76 @@
{
"title": "Interfaces",
"children": [
14859
14844
]
},
{
"title": "Type Aliases",
"children": [
14851,
14855
14836,
14840
]
}
],
"packageName": "@medusajs/types",
"symbolIdMap": {
"14850": {
"14835": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": ""
},
"14851": {
"14836": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "ShippingTaxCalculationLine"
},
"14852": {
"14837": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "__type"
},
"14853": {
"14838": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "__type.shipping_line"
},
"14854": {
"14839": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "__type.rates"
},
"14855": {
"14840": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "ItemTaxCalculationLine"
},
"14856": {
"14841": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "__type"
},
"14857": {
"14842": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "__type.line_item"
},
"14858": {
"14843": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "__type.rates"
},
"14859": {
"14844": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "ITaxProvider"
},
"14862": {
"14847": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "ITaxProvider.getTaxLines"
},
"14863": {
"14848": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "ITaxProvider.getTaxLines"
},
"14864": {
"14849": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "itemLines"
},
"14865": {
"14850": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "shippingLines"
},
"14866": {
"14851": {
"sourceFileName": "../../../../packages/core/types/src/tax/provider.ts",
"qualifiedName": "context"
}
@@ -567,7 +567,7 @@
"1": "../../../../packages/core/types/src/tax/provider.ts"
},
"reflections": {
"1": 14850
"1": 14835
}
}
}
www/utils/generated/typedoc-json-output/workflows.json
+908 -908
View File
File diff suppressed because it is too large. Load diff