docs: generate references manually for 2.12.3 (#14340)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-12-17 18:20:19 +02:00
1 parent 52e965f411
commit 1c4c4b8e9a
1080 files changed
+394731 -361464

No files matched your search

@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# BaseResourceData
## Properties
<TypeList types={[{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sourcePath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="BaseResourceData"/>
@@ -0,0 +1,51 @@
import { TypeList } from "docs-ui"
# ResourceTypeHandler
## Type parameters
<TypeList types={[{"name":"T","type":"[BaseResourceData](../utils.DevServerUtils.BaseResourceData/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sourcePath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ResourceTypeHandler"/>
## Properties
<TypeList types={[{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ResourceTypeHandler"/>
___
## Methods
### validate
#### Parameters
<TypeList types={[{"name":"data","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validate"/>
### resolveSourcePath
#### Parameters
<TypeList types={[{"name":"data","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="resolveSourcePath"/>
#### Returns
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="resolveSourcePath"/>
### createEntry
#### Parameters
<TypeList types={[{"name":"data","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createEntry"/>
#### Returns
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createEntry"/>
### getInverseKey
#### Parameters
<TypeList types={[{"name":"data","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getInverseKey"/>
#### Returns
<TypeList types={[{"name":"string","type":"`string`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="getInverseKey"/>
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# ResourceEntry
**ResourceEntry**: `Object`
## Properties
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ResourceEntry"/>
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# ResourceMap
**ResourceMap**: Map&#60;string, [ResourceEntry](../utils.DevServerUtils.ResourceEntry/page.mdx)[]&#62;
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# ResourcePath
**ResourcePath**: `string`
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# ResourceType
**ResourceType**: `string`
@@ -0,0 +1,9 @@
import { TypeList } from "docs-ui"
# TranslationWorkflowEvents
`Const` **TranslationWorkflowEvents**: `Object`
## Properties
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when translations are created.","optional":false,"defaultValue":"\"translation.created\"","expandable":false,"featureFlag":"translation","children":[],"since":"2.12.3"},{"name":"UPDATED","type":"`string`","description":"Emitted when translations are updated.","optional":false,"defaultValue":"\"translation.updated\"","expandable":false,"featureFlag":"translation","children":[],"since":"2.12.3"},{"name":"DELETED","type":"`string`","description":"Emitted when translations are deleted.","optional":false,"defaultValue":"\"translation.deleted\"","expandable":false,"featureFlag":"translation","children":[],"since":"2.12.3"}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="TranslationWorkflowEvents"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# StepResourceData
## Properties
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`\"step\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sourcePath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="StepResourceData"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# SubscriberResourceData
## Properties
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`\"subscriber\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sourcePath","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subscriberId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"events","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="SubscriberResourceData"/>
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# WorkflowResourceData
## Properties
<TypeList types={[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`\"workflow\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sourcePath","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="WorkflowResourceData"/>
@@ -0,0 +1,5 @@
import { TypeList } from "docs-ui"
# ResourceRegistrationData
**ResourceRegistrationData**: [WorkflowResourceData](../../interfaces/utils.WorkflowResourceData/page.mdx) \| [StepResourceData](../../interfaces/utils.StepResourceData/page.mdx) \| [SubscriberResourceData](../../interfaces/utils.SubscriberResourceData/page.mdx)
@@ -43,7 +43,7 @@ This function is used to cache the result of a function call.
#### Parameters
<TypeList types={[{"name":"cb","type":"(...`args`: `any`[]) => Promise&#60;T&#62;","description":"The callback to execute.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"The options for the cache.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string` \\| `any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"enable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ttl","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"autoInvalidate","type":"`boolean`","description":"Whethere the default strategy should auto invalidate the cache whenever it is possible.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"providers","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useCache"/>
<TypeList types={[{"name":"cb","type":"(...`args`: `any`[]) => Promise&#60;T&#62;","description":"The callback to execute.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`object`","description":"The options for the cache.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"key","type":"`string` \\| `any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to\nprovide dependency injection functionalities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"enable","type":"`boolean`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ttl","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"autoInvalidate","type":"`boolean`","description":"Whethere the default strategy should auto invalidate the cache whenever it is possible.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"providers","type":"`string`[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="useCache"/>
#### Returns
@@ -22,6 +22,7 @@ import { TypeList } from "docs-ui"
- [RegionWorkflowEvents](../Region/variables/utils.Region.RegionWorkflowEvents/page.mdx)
- [SalesChannelWorkflowEvents](../Sales_Channel/variables/utils.Sales_Channel.SalesChannelWorkflowEvents/page.mdx)
- [ShippingOptionTypeWorkflowEvents](../Fulfillment/variables/utils.Fulfillment.ShippingOptionTypeWorkflowEvents/page.mdx)
- [TranslationWorkflowEvents](../Translation/variables/utils.Translation.TranslationWorkflowEvents/page.mdx)
- [UserWorkflowEvents](../User/variables/utils.User.UserWorkflowEvents/page.mdx)
___
@@ -59,3 +60,5 @@ ___
___
___
___
@@ -0,0 +1,148 @@
import { TypeList } from "docs-ui"
# DevServerUtils
## Functions
- [registerDevServerResource](page.mdx#registerdevserverresource)
- [registerResourceTypeHandler](page.mdx#registerresourcetypehandler)
## Interfaces
- [BaseResourceData](../DevServerUtils/interfaces/utils.DevServerUtils.BaseResourceData/page.mdx)
- [ResourceTypeHandler](../DevServerUtils/interfaces/utils.DevServerUtils.ResourceTypeHandler/page.mdx)
## Type Aliases
- [ResourceEntry](../DevServerUtils/types/utils.DevServerUtils.ResourceEntry/page.mdx)
- [ResourceMap](../DevServerUtils/types/utils.DevServerUtils.ResourceMap/page.mdx)
- [ResourcePath](../DevServerUtils/types/utils.DevServerUtils.ResourcePath/page.mdx)
- [ResourceType](../DevServerUtils/types/utils.DevServerUtils.ResourceType/page.mdx)
## Variables
- [globalDevServerRegistry](page.mdx#globaldevserverregistry)
- [inverseDevServerRegistry](page.mdx#inversedevserverregistry)
## Functions
### registerDevServerResource
`**registerDevServerResource**(data): `void``
Register a resource in the dev server for hot module reloading
This function uses a strategy pattern where each resource type has its own handler.
The handler is responsible for:
- Validating the registration data
- Resolving the source path
- Creating the registry entry
- Generating the inverse registry key
#### Example
```typescript
// Register a workflow
registerDevServerResource({
type: "workflow",
id: "create-product",
sourcePath: "/src/workflows/create-product.ts"
})
// Register a step
registerDevServerResource({
type: "step",
id: "validate-product",
workflowId: "create-product"
})
```
#### Parameters
<TypeList types={[{"name":"data","type":"[ResourceRegistrationData](../types/utils.ResourceRegistrationData/page.mdx)","description":"Resource registration data","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`\"workflow\"`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sourcePath","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subscriberId","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"events","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"workflowId","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerDevServerResource"/>
#### Throws
Error if validation fails or handler is not found
`**registerDevServerResource**<TypeParameter T>(data): `void``
Register a resource in the dev server for hot module reloading
This function uses a strategy pattern where each resource type has its own handler.
The handler is responsible for:
- Validating the registration data
- Resolving the source path
- Creating the registry entry
- Generating the inverse registry key
#### Example
```typescript
// Register a workflow
registerDevServerResource({
type: "workflow",
id: "create-product",
sourcePath: "/src/workflows/create-product.ts"
})
// Register a step
registerDevServerResource({
type: "step",
id: "validate-product",
workflowId: "create-product"
})
```
#### Type Parameters
<TypeList types={[{"name":"T","type":"[BaseResourceData](../DevServerUtils/interfaces/utils.DevServerUtils.BaseResourceData/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sourcePath","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerDevServerResource"/>
#### Parameters
<TypeList types={[{"name":"data","type":"T","description":"Resource registration data","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerDevServerResource"/>
#### Throws
Error if validation fails or handler is not found
### registerResourceTypeHandler
Register a resource type handler
#### Example
```typescript
class RouteHandler implements ResourceTypeHandler<RouteData> {
readonly type = "route"
validate(data: RouteData): void { ... }
resolveSourcePath(data: RouteData): string { ... }
createEntry(data: RouteData): ResourceEntry { ... }
getInverseKey(data: RouteData): string { ... }
}
registerResourceTypeHandler(new RouteHandler())
```
#### Parameters
<TypeList types={[{"name":"handler","type":"[ResourceTypeHandler](../DevServerUtils/interfaces/utils.DevServerUtils.ResourceTypeHandler/page.mdx)&#60;[BaseResourceData](../DevServerUtils/interfaces/utils.DevServerUtils.BaseResourceData/page.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="registerResourceTypeHandler"/>
___
## Variables
### globalDevServerRegistry
`Const` **globalDevServerRegistry**: Map&#60;string, [ResourceMap](../DevServerUtils/types/utils.DevServerUtils.ResourceMap/page.mdx)&#62;
Maps source file paths to their registered resources
Structure: sourcePath -&#62; Map&#60;resourceType, ResourceEntry[]&#62;
### inverseDevServerRegistry
`Const` **inverseDevServerRegistry**: Map&#60;string, string[]&#62;
Inverse registry for looking up source paths by resource
Structure: "type:id" -&#62; sourcePath[]
Used to find which files contain a specific resource
@@ -0,0 +1,7 @@
import { TypeList } from "docs-ui"
# Translation
## Variables
- [TranslationWorkflowEvents](../Translation/variables/utils.Translation.TranslationWorkflowEvents/page.mdx)
@@ -0,0 +1,19 @@
import { TypeList } from "docs-ui"
# TranslationsUtils
## Functions
- [applyTranslations](page.mdx#applytranslations)
## Functions
### applyTranslations
#### Parameters
<TypeList types={[{"name":"__namedParameters","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"localeCode","type":"`undefined` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"objects","type":"`Record<string, any>`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"container","type":"[MedusaContainer](../../medusa/types/medusa.MedusaContainer/page.mdx)","description":"The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to\nprovide dependency injection functionalities.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="applyTranslations"/>
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="applyTranslations"/>