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

chore: fixes to tsdocs + docs-util related to providers

Browse Source
This commit is contained in:
Shahed Nasser
2024-12-11 17:27:32 +02:00
parent dc5e73af4d
commit c3b2b4b438
15 changed files with 444 additions and 451 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/core/types/src/notification/common.ts
View File

@@ -20,7 +20,7 @@ export interface Attachment {
*/
content_type?: string
/**
* The disposition of the attachment, e.g., "inline" or "attachment".
* The disposition of the attachment, For example, "inline" or "attachment".
*/
disposition?: string
/**

12
packages/core/utils/src/fulfillment/provider.ts
View File

@@ -20,7 +20,7 @@ import {
*
* #### Example
*
* ```ts
* ```ts title="src/modules/my-fulfillment/service.ts"
* import { AbstractFulfillmentProviderService } from "@medusajs/framework/utils"
* import { Logger } from "@medusajs/framework/types"
*
@@ -56,13 +56,11 @@ export class AbstractFulfillmentProviderService
implements IFulfillmentProvider
{
/**
* The `identifier` property holds a unique identifier of the fulfillment module provider.
* Each fulfillment provider has a unique identifier defined in its class. The provider's ID
* will be stored as `fp_{identifier}_{id}`, where `{id}` is the provider's `id`
* property in the `medusa-config.ts`.
*
* You can use the kebab-case name of the provider as its value.
*
* For example:
*
* ```ts
* @example
* class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
* static identifier = "my-fulfillment"
*

9
packages/core/utils/src/payment/abstract-payment-provider.ts
View File

@@ -12,6 +12,9 @@ import {
export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>>
implements IPaymentProvider
{
/**
* @ignore
*/
protected readonly container: Record<string, unknown>
/**
* This method validates the options of the provider set in `medusa-config.ts`.
@@ -44,7 +47,7 @@ export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>>
* The provider can also access the module's options as a second parameter.
*
* @param {Record<string, unknown>} cradle - The module's container cradle used to resolve resources.
* @param {Record<string, unknown>} config - The options passed to the payment module provider.
* @param {Record<string, unknown>} config - The options passed to the Payment Module provider.
*
* @example
* ```ts
@@ -93,6 +96,9 @@ export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>>
*/
protected constructor(
cradle: Record<string, unknown>,
/**
* @ignore
*/
protected readonly config: TConfig = {} as TConfig // eslint-disable-next-line @typescript-eslint/no-empty-function
) {
this.container = cradle
@@ -122,7 +128,6 @@ export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>>
* static identifier = "my-payment"
* // ...
* }
* ```
*/
public static identifier: string

37
www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx
View File

@@ -77,7 +77,33 @@ class MyAuthProviderService extends AbstractAuthModuleProvider {
export default MyAuthProviderService
```
### constructor
### identifier
Every auth provider must have an `identifier` static property. The provider's ID
will be stored as `au_{identifier}_{id}`, where `{id}` is the provider's `id`
property in the `medusa-config.ts`.
#### Example
```ts
class MyAuthProviderService extends AbstractAuthModuleProvider {
static identifier = "my-auth"
// ...
}
```
### DISPLAY\_NAME
This property indicates the name used when displaying the provider on a frontend application.
#### Example
```ts
class MyAuthProviderService extends AbstractAuthModuleProvider {
static DISPLAY_NAME = "My Auth"
// ...
}
```
### validateOptions
@@ -441,10 +467,6 @@ This exports the module's definition, indicating that the `MyAuthProviderService
To use your Auth Module Provider, add it to the `providers` array of the Auth Module in `medusa-config.ts`:
```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [
@@ -452,6 +474,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/auth",
options: {
providers: [
// default provider
{
resolve: "@medusajs/medusa/auth-emailpass",
id: "emailpass",
},
{
resolve: "./src/modules/my-auth",
id: "my-auth",

24
www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx
View File

@@ -75,7 +75,20 @@ class MyFileProviderService extends AbstractFileProviderService {
export default MyFileProviderService
```
### constructor
### identifier
Each file provider has a unique ID used to identify it. The provider's ID
will be stored as `fs_{identifier}_{id}`, where `{id}` is the provider's `id`
property in the `medusa-config.ts`.
#### Example
```ts
class MyFileProviderService extends AbstractFileProviderService {
static identifier = "my-file"
// ...
}
```
### validateOptions
@@ -229,10 +242,6 @@ The File Module accepts one provider only.
</Note>
```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [
@@ -240,6 +249,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/file",
options: {
providers: [
// default provider
{
resolve: "@medusajs/medusa/file-local",
id: "local",
},
{
resolve: "./src/modules/my-file",
id: "my-file",

29
www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx
View File

@@ -45,7 +45,7 @@ If you're creating a client or establishing a connection with a third-party serv
#### Example
```ts
```ts title="src/modules/my-fulfillment/service.ts"
import { AbstractFulfillmentProviderService } from "@medusajs/framework/utils"
import { Logger } from "@medusajs/framework/types"
@@ -77,7 +77,21 @@ class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
export default MyFulfillmentProviderService
```
### constructor
### identifier
Each fulfillment provider has a unique identifier defined in its class. The provider's ID
will be stored as `fp_{identifier}_{id}`, where `{id}` is the provider's `id`
property in the `medusa-config.ts`.
#### Example
```ts
class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
static identifier = "my-fulfillment"
// ...
}
```
### getFulfillmentOptions
@@ -226,7 +240,7 @@ class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
#### Returns
<TypeList types={[{"name":"Promise","type":"Promise&#60;number&#62;","optional":false,"defaultValue":"","description":"The calculated price","expandable":false,"children":[{"name":"number","type":"`number`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="calculatePrice"/>
<TypeList types={[{"name":"Promise","type":"Promise&#60;CalculatedShippingOptionPrice&#62;","optional":false,"defaultValue":"","description":"The calculated price","expandable":false,"children":[{"name":"CalculatedShippingOptionPrice","type":"`CalculatedShippingOptionPrice`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="calculatePrice"/>
### createFulfillment
@@ -473,10 +487,6 @@ This exports the module's definition, indicating that the `MyFulfillmentProvider
To use your Fulfillment Module Provider, add it to the `providers` array of the Fulfillment Module in `medusa-config.ts`:
```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [
@@ -484,6 +494,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/fulfillment",
options: {
providers: [
// default provider
{
resolve: "@medusajs/medusa/fulfillment-manual",
id: "manual",
},
{
resolve: "./src/modules/my-fulfillment",
id: "my-fulfillment",

15
www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx
View File

@@ -78,8 +78,6 @@ class MyNotificationProviderService extends AbstractNotificationProviderService
export default MyNotificationProviderService
```
### constructor
### validateOptions
This method validates the options of the provider set in `medusa-config.ts`.
@@ -181,10 +179,6 @@ The Notification Module accepts one provider per channel.
</Note>
```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [
@@ -192,6 +186,15 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/notification",
options: {
providers: [
// default provider
{
resolve: "@medusajs/medusa/notification-local",
id: "local",
options: {
name: "Local Notification Provider",
channels: ["feed"],
},
},
{
resolve: "./src/modules/my-notification",
id: "my-notification",

58
www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx
View File

@@ -36,69 +36,23 @@ class MyPaymentProviderService extends AbstractPaymentProvider<
export default MyPaymentProviderService
```
### Type parameters
### identifier
<TypeList types={[{"name":"TConfig","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AbstractPaymentProvider"/>
### constructor
You can use the `constructor` of the provider's service to access resources in your module's container.
You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs,
you can initialize it in the constructor and use it in other methods in the service.
The provider can also access the module's options as a second parameter.
Each payment provider has a unique identifier defined in its class. The provider's ID
will be stored as `pp_{identifier}_{id}`, where `{id}` is the provider's `id`
property in the `medusa-config.ts`.
#### Example
```ts
import {
AbstractPaymentProvider
} from "@medusajs/framework/utils"
import { Logger } from "@medusajs/framework/types"
type InjectedDependencies = {
logger: Logger
}
type Options = {
apiKey: string
}
class MyPaymentProviderService extends AbstractPaymentProvider<
Options
> {
static identifier = "my-payment"
protected logger_: Logger
protected options_: Options
// Assuming you're using a client to integrate
// with a third-party service
protected client
constructor(
{ logger }: InjectedDependencies,
options: Options
) {
// @ts-ignore
super(...arguments)
this.logger_ = logger
this.options_ = options
// Assuming you're initializing a client
this.client = new Client(options)
}
// ...
}
export default MyPaymentProviderService
```
#### Parameters
<TypeList types={[{"name":"cradle","type":"`Record<string, unknown>`","description":"The module's container cradle used to resolve resources.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"TConfig","description":"The options passed to the payment module provider.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new AbstractPaymentProvider"/>
### validateOptions
This method validates the options of the provider set in `medusa-config.ts`.
@@ -719,10 +673,6 @@ This exports the module's definition, indicating that the `MyPaymentProviderServ
To use your Payment Module Provider, add it to the `providers` array of the Payment Module in `medusa-config.ts`:
```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [

274
www/utils/generated/typedoc-json-output/fulfillment-provider.json
View File

@@ -1,12 +1,12 @@
{
"id": 40206,
"id": 0,
"name": "fulfillment-provider",
"variant": "project",
"kind": 1,
"flags": {},
"children": [
{
"id": 40207,
"id": 1,
"name": "AbstractFulfillmentProviderService",
"variant": "declaration",
"kind": 128,
@@ -19,13 +19,13 @@
},
{
"kind": "code",
"text": "```ts\nimport { AbstractFulfillmentProviderService } from \"@medusajs/framework/utils\"\nimport { Logger } from \"@medusajs/framework/types\"\n\ntype InjectedDependencies = {\n logger: Logger\n}\n\ntype Options = {\n apiKey: string\n}\n\nclass MyFulfillmentProviderService extends AbstractFulfillmentProviderService {\n protected logger_: Logger\n protected options_: Options\n // assuming you're initializing a client\n protected client\n\n constructor(\n { logger }: InjectedDependencies,\n options: Options\n ) {\n super()\n\n this.logger_ = logger\n this.options_ = options\n }\n}\n\nexport default MyFulfillmentProviderService\n```"
"text": "```ts title=\"src/modules/my-fulfillment/service.ts\"\nimport { AbstractFulfillmentProviderService } from \"@medusajs/framework/utils\"\nimport { Logger } from \"@medusajs/framework/types\"\n\ntype InjectedDependencies = {\n logger: Logger\n}\n\ntype Options = {\n apiKey: string\n}\n\nclass MyFulfillmentProviderService extends AbstractFulfillmentProviderService {\n protected logger_: Logger\n protected options_: Options\n // assuming you're initializing a client\n protected client\n\n constructor(\n { logger }: InjectedDependencies,\n options: Options\n ) {\n super()\n\n this.logger_ = logger\n this.options_ = options\n }\n}\n\nexport default MyFulfillmentProviderService\n```"
}
]
},
"children": [
{
"id": 40208,
"id": 2,
"name": "identifier",
"variant": "declaration",
"kind": 1024,
@@ -36,19 +36,50 @@
"summary": [
{
"kind": "text",
"text": "The "
"text": "Each fulfillment provider has a unique identifier defined in its class. The provider's ID\nwill be stored as "
},
{
"kind": "code",
"text": "`identifier`"
"text": "`fp_{identifier}_{id}`"
},
{
"kind": "text",
"text": " property holds a unique identifier of the fulfillment module provider.\n\nYou can use the kebab-case name of the provider as its value.\n\nFor example:\n\n"
"text": ", where "
},
{
"kind": "code",
"text": "```ts\nclass MyFulfillmentProviderService extends AbstractFulfillmentProviderService {\n static identifier = \"my-fulfillment\"\n\n // ...\n}"
"text": "`{id}`"
},
{
"kind": "text",
"text": " is the provider's "
},
{
"kind": "code",
"text": "`id`"
},
{
"kind": "text",
"text": "\nproperty in the "
},
{
"kind": "code",
"text": "`medusa-config.ts`"
},
{
"kind": "text",
"text": "."
}
],
"blockTags": [
{
"tag": "@example",
"content": [
{
"kind": "code",
"text": "```ts\nclass MyFulfillmentProviderService extends AbstractFulfillmentProviderService {\n static identifier = \"my-fulfillment\"\n\n // ...\n}\n```"
}
]
}
]
},
@@ -58,21 +89,21 @@
}
},
{
"id": 40213,
"id": 7,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 40214,
"id": 8,
"name": "new AbstractFulfillmentProviderService",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 40207,
"target": 1,
"name": "AbstractFulfillmentProviderService",
"package": "@medusajs/utils"
}
@@ -80,14 +111,14 @@
]
},
{
"id": 40217,
"id": 11,
"name": "getFulfillmentOptions",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40218,
"id": 12,
"name": "getFulfillmentOptions",
"variant": "signature",
"kind": 4096,
@@ -157,14 +188,14 @@
}
},
{
"id": 40219,
"id": 13,
"name": "validateFulfillmentData",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40220,
"id": 14,
"name": "validateFulfillmentData",
"variant": "signature",
"kind": 4096,
@@ -231,7 +262,7 @@
},
"parameters": [
{
"id": 40221,
"id": 15,
"name": "optionData",
"variant": "param",
"kind": 32768,
@@ -273,7 +304,7 @@
}
},
{
"id": 40222,
"id": 16,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -315,7 +346,7 @@
}
},
{
"id": 40223,
"id": 17,
"name": "context",
"variant": "param",
"kind": 32768,
@@ -378,14 +409,14 @@
}
},
{
"id": 40224,
"id": 18,
"name": "validateOption",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40225,
"id": 19,
"name": "validateOption",
"variant": "signature",
"kind": 4096,
@@ -444,7 +475,7 @@
},
"parameters": [
{
"id": 40226,
"id": 20,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -507,14 +538,14 @@
}
},
{
"id": 40227,
"id": 21,
"name": "canCalculate",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40228,
"id": 22,
"name": "canCalculate",
"variant": "signature",
"kind": 4096,
@@ -549,7 +580,7 @@
},
"parameters": [
{
"id": 40229,
"id": 23,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -620,14 +651,14 @@
}
},
{
"id": 40230,
"id": 24,
"name": "calculatePrice",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40231,
"id": 25,
"name": "calculatePrice",
"variant": "signature",
"kind": 4096,
@@ -642,7 +673,7 @@
"kind": "inline-tag",
"tag": "@link",
"text": "canCalculate",
"target": 40227,
"target": 21,
"tsLinkText": ""
},
{
@@ -681,7 +712,7 @@
},
"parameters": [
{
"id": 40232,
"id": 26,
"name": "optionData",
"variant": "param",
"kind": 32768,
@@ -723,7 +754,7 @@
}
},
{
"id": 40233,
"id": 27,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -765,7 +796,7 @@
}
},
{
"id": 40234,
"id": 28,
"name": "context",
"variant": "param",
"kind": 32768,
@@ -799,8 +830,13 @@
},
"typeArguments": [
{
"type": "intrinsic",
"name": "number"
"type": "reference",
"target": {
"sourceFileName": "../../../../packages/core/types/src/fulfillment/provider.ts",
"qualifiedName": "CalculatedShippingOptionPrice"
},
"name": "CalculatedShippingOptionPrice",
"package": "@medusajs/types"
}
],
"name": "Promise",
@@ -820,14 +856,14 @@
}
},
{
"id": 40235,
"id": 29,
"name": "createFulfillment",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40236,
"id": 30,
"name": "createFulfillment",
"variant": "signature",
"kind": 4096,
@@ -894,7 +930,7 @@
},
"parameters": [
{
"id": 40237,
"id": 31,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -921,7 +957,7 @@
}
},
{
"id": 40238,
"id": 32,
"name": "items",
"variant": "param",
"kind": 32768,
@@ -943,7 +979,7 @@
}
},
{
"id": 40239,
"id": 33,
"name": "order",
"variant": "param",
"kind": 32768,
@@ -971,7 +1007,7 @@
}
},
{
"id": 40240,
"id": 34,
"name": "fulfillment",
"variant": "param",
"kind": 32768,
@@ -1034,14 +1070,14 @@
}
},
{
"id": 40241,
"id": 35,
"name": "cancelFulfillment",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40242,
"id": 36,
"name": "cancelFulfillment",
"variant": "signature",
"kind": 4096,
@@ -1067,7 +1103,7 @@
},
"parameters": [
{
"id": 40243,
"id": 37,
"name": "fulfillment",
"variant": "param",
"kind": 32768,
@@ -1130,14 +1166,14 @@
}
},
{
"id": 40244,
"id": 38,
"name": "getFulfillmentDocuments",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40245,
"id": 39,
"name": "getFulfillmentDocuments",
"variant": "signature",
"kind": 4096,
@@ -1172,7 +1208,7 @@
},
"parameters": [
{
"id": 40246,
"id": 40,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -1246,14 +1282,14 @@
}
},
{
"id": 40247,
"id": 41,
"name": "createReturnFulfillment",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40248,
"id": 42,
"name": "createReturnFulfillment",
"variant": "signature",
"kind": 4096,
@@ -1320,7 +1356,7 @@
},
"parameters": [
{
"id": 40249,
"id": 43,
"name": "fulfillment",
"variant": "param",
"kind": 32768,
@@ -1383,14 +1419,14 @@
}
},
{
"id": 40250,
"id": 44,
"name": "getReturnDocuments",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40251,
"id": 45,
"name": "getReturnDocuments",
"variant": "signature",
"kind": 4096,
@@ -1425,7 +1461,7 @@
},
"parameters": [
{
"id": 40252,
"id": 46,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -1499,14 +1535,14 @@
}
},
{
"id": 40253,
"id": 47,
"name": "getShipmentDocuments",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40254,
"id": 48,
"name": "getShipmentDocuments",
"variant": "signature",
"kind": 4096,
@@ -1541,7 +1577,7 @@
},
"parameters": [
{
"id": 40255,
"id": 49,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -1615,14 +1651,14 @@
}
},
{
"id": 40256,
"id": 50,
"name": "retrieveDocuments",
"variant": "declaration",
"kind": 2048,
"flags": {},
"signatures": [
{
"id": 40257,
"id": 51,
"name": "retrieveDocuments",
"variant": "signature",
"kind": 4096,
@@ -1657,7 +1693,7 @@
},
"parameters": [
{
"id": 40258,
"id": 52,
"name": "fulfillmentData",
"variant": "param",
"kind": 32768,
@@ -1699,7 +1735,7 @@
}
},
{
"id": 40259,
"id": 53,
"name": "documentType",
"variant": "param",
"kind": 32768,
@@ -1759,30 +1795,30 @@
{
"title": "Constructors",
"children": [
40213
7
]
},
{
"title": "Properties",
"children": [
40208
2
]
},
{
"title": "Methods",
"children": [
40217,
40219,
40224,
40227,
40230,
40235,
40241,
40244,
40247,
40250,
40253,
40256
11,
13,
18,
21,
24,
29,
35,
38,
41,
44,
47,
50
]
}
],
@@ -1803,193 +1839,193 @@
{
"title": "Classes",
"children": [
40207
1
]
}
],
"packageName": "@medusajs/utils",
"symbolIdMap": {
"40206": {
"0": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": ""
},
"40207": {
"1": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService"
},
"40208": {
"2": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.identifier"
},
"40217": {
"11": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentOptions"
},
"40218": {
"12": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentOptions"
},
"40219": {
"13": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.validateFulfillmentData"
},
"40220": {
"14": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.validateFulfillmentData"
},
"40221": {
"15": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "optionData"
},
"40222": {
"16": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data"
},
"40223": {
"17": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "context"
},
"40224": {
"18": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.validateOption"
},
"40225": {
"19": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.validateOption"
},
"40226": {
"20": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data"
},
"40227": {
"21": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.canCalculate"
},
"40228": {
"22": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.canCalculate"
},
"40229": {
"23": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data"
},
"40230": {
"24": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.calculatePrice"
},
"40231": {
"25": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.calculatePrice"
},
"40232": {
"26": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "optionData"
},
"40233": {
"27": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data"
},
"40234": {
"28": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "context"
},
"40235": {
"29": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.createFulfillment"
},
"40236": {
"30": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.createFulfillment"
},
"40237": {
"31": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data"
},
"40238": {
"32": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "items"
},
"40239": {
"33": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "order"
},
"40240": {
"34": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "fulfillment"
},
"40241": {
"35": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.cancelFulfillment"
},
"40242": {
"36": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.cancelFulfillment"
},
"40243": {
"37": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "fulfillment"
},
"40244": {
"38": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentDocuments"
},
"40245": {
"39": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentDocuments"
},
"40246": {
"40": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data"
},
"40247": {
"41": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.createReturnFulfillment"
},
"40248": {
"42": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.createReturnFulfillment"
},
"40249": {
"43": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "fulfillment"
},
"40250": {
"44": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getReturnDocuments"
},
"40251": {
"45": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getReturnDocuments"
},
"40252": {
"46": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data"
},
"40253": {
"47": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getShipmentDocuments"
},
"40254": {
"48": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getShipmentDocuments"
},
"40255": {
"49": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data"
},
"40256": {
"50": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.retrieveDocuments"
},
"40257": {
"51": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.retrieveDocuments"
},
"40258": {
"52": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "fulfillmentData"
},
"40259": {
"53": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "documentType"
}
@@ -1999,7 +2035,7 @@
"1": "../../../../packages/core/utils/src/fulfillment/provider.ts"
},
"reflections": {
"1": 40206
"1": 0
}
}
}

346
www/utils/generated/typedoc-json-output/payment-provider.json
View File

@@ -1,12 +1,12 @@
{
"id": 43212,
"id": 0,
"name": "payment-provider",
"variant": "project",
"kind": 1,
"flags": {},
"children": [
{
"id": 43216,
"id": 4,
"name": "AbstractPaymentProvider",
"variant": "declaration",
"kind": 128,
@@ -15,36 +15,7 @@
},
"children": [
{
"id": 43230,
"name": "container",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isReadonly": true
},
"type": {
"type": "reference",
"target": {
"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "Record"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "unknown"
}
],
"name": "Record",
"package": "typescript"
}
},
{
"id": 43217,
"id": 5,
"name": "validateOptions",
"variant": "declaration",
"kind": 2048,
@@ -53,7 +24,7 @@
},
"signatures": [
{
"id": 43218,
"id": 6,
"name": "validateOptions",
"variant": "signature",
"kind": 4096,
@@ -87,7 +58,7 @@
},
"parameters": [
{
"id": 43219,
"id": 7,
"name": "options",
"variant": "param",
"kind": 32768,
@@ -129,7 +100,7 @@
]
},
{
"id": 43225,
"id": 13,
"name": "constructor",
"variant": "declaration",
"kind": 512,
@@ -138,7 +109,7 @@
},
"signatures": [
{
"id": 43226,
"id": 14,
"name": "new AbstractPaymentProvider",
"variant": "signature",
"kind": 16384,
@@ -172,7 +143,7 @@
},
"typeParameters": [
{
"id": 43227,
"id": 15,
"name": "TConfig",
"variant": "typeParam",
"kind": 131072,
@@ -200,7 +171,7 @@
],
"parameters": [
{
"id": 43228,
"id": 16,
"name": "cradle",
"variant": "param",
"kind": 32768,
@@ -232,39 +203,15 @@
"name": "Record",
"package": "typescript"
}
},
{
"id": 43229,
"name": "config",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The options passed to the payment module provider."
}
]
},
"type": {
"type": "reference",
"target": 43227,
"name": "TConfig",
"package": "@medusajs/utils",
"qualifiedName": "AbstractPaymentProvider.TConfig",
"refersToTypeParameter": true
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"target": 43216,
"target": 4,
"typeArguments": [
{
"type": "reference",
"target": 43227,
"target": 15,
"name": "TConfig",
"package": "@medusajs/utils",
"qualifiedName": "AbstractPaymentProvider.TConfig",
@@ -278,34 +225,7 @@
]
},
{
"id": 43231,
"name": "config",
"variant": "declaration",
"kind": 1024,
"flags": {
"isProtected": true,
"isReadonly": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The options passed to the payment module provider."
}
]
},
"type": {
"type": "reference",
"target": 43227,
"name": "TConfig",
"package": "@medusajs/utils",
"qualifiedName": "AbstractPaymentProvider.TConfig",
"refersToTypeParameter": true
},
"defaultValue": "..."
},
{
"id": 43224,
"id": 12,
"name": "identifier",
"variant": "declaration",
"kind": 1024,
@@ -358,7 +278,7 @@
"content": [
{
"kind": "code",
"text": "```ts\nclass MyPaymentProviderService extends AbstractPaymentProvider<\n Options\n> {\n static identifier = \"my-payment\"\n // ...\n}\n```\n```"
"text": "```ts\nclass MyPaymentProviderService extends AbstractPaymentProvider<\n Options\n> {\n static identifier = \"my-payment\"\n // ...\n}\n```"
}
]
}
@@ -370,7 +290,7 @@
}
},
{
"id": 43234,
"id": 22,
"name": "capturePayment",
"variant": "declaration",
"kind": 2048,
@@ -379,7 +299,7 @@
},
"signatures": [
{
"id": 43235,
"id": 23,
"name": "capturePayment",
"variant": "signature",
"kind": 4096,
@@ -394,7 +314,7 @@
"kind": "inline-tag",
"tag": "@link",
"text": "authorizePayment",
"target": 43237,
"target": 25,
"tsLinkText": ""
},
{
@@ -441,7 +361,7 @@
},
"parameters": [
{
"id": 43236,
"id": 24,
"name": "paymentData",
"variant": "param",
"kind": 32768,
@@ -541,7 +461,7 @@
}
},
{
"id": 43237,
"id": 25,
"name": "authorizePayment",
"variant": "declaration",
"kind": 2048,
@@ -550,7 +470,7 @@
},
"signatures": [
{
"id": 43238,
"id": 26,
"name": "authorizePayment",
"variant": "signature",
"kind": 4096,
@@ -565,7 +485,7 @@
"kind": "inline-tag",
"tag": "@link",
"text": "capturePayment",
"target": 43234,
"target": 22,
"tsLinkText": ""
},
{
@@ -620,7 +540,7 @@
},
"parameters": [
{
"id": 43239,
"id": 27,
"name": "paymentSessionData",
"variant": "param",
"kind": 32768,
@@ -662,7 +582,7 @@
}
},
{
"id": 43240,
"id": 28,
"name": "context",
"variant": "param",
"kind": 32768,
@@ -726,14 +646,14 @@
{
"type": "reflection",
"declaration": {
"id": 43241,
"id": 29,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 43242,
"id": 30,
"name": "status",
"variant": "declaration",
"kind": 1024,
@@ -757,7 +677,7 @@
}
},
{
"id": 43243,
"id": 31,
"name": "data",
"variant": "declaration",
"kind": 1024,
@@ -803,8 +723,8 @@
{
"title": "Properties",
"children": [
43242,
43243
30,
31
]
}
]
@@ -830,7 +750,7 @@
}
},
{
"id": 43244,
"id": 32,
"name": "cancelPayment",
"variant": "declaration",
"kind": 2048,
@@ -839,7 +759,7 @@
},
"signatures": [
{
"id": 43245,
"id": 33,
"name": "cancelPayment",
"variant": "signature",
"kind": 4096,
@@ -874,7 +794,7 @@
},
"parameters": [
{
"id": 43246,
"id": 34,
"name": "paymentData",
"variant": "param",
"kind": 32768,
@@ -974,7 +894,7 @@
}
},
{
"id": 43247,
"id": 35,
"name": "initiatePayment",
"variant": "declaration",
"kind": 2048,
@@ -983,7 +903,7 @@
},
"signatures": [
{
"id": 43248,
"id": 36,
"name": "initiatePayment",
"variant": "signature",
"kind": 4096,
@@ -1034,7 +954,7 @@
},
"parameters": [
{
"id": 43249,
"id": 37,
"name": "context",
"variant": "param",
"kind": 32768,
@@ -1106,7 +1026,7 @@
}
},
{
"id": 43250,
"id": 38,
"name": "deletePayment",
"variant": "declaration",
"kind": 2048,
@@ -1115,7 +1035,7 @@
},
"signatures": [
{
"id": 43251,
"id": 39,
"name": "deletePayment",
"variant": "signature",
"kind": 4096,
@@ -1150,7 +1070,7 @@
},
"parameters": [
{
"id": 43252,
"id": 40,
"name": "paymentSessionData",
"variant": "param",
"kind": 32768,
@@ -1250,7 +1170,7 @@
}
},
{
"id": 43253,
"id": 41,
"name": "getPaymentStatus",
"variant": "declaration",
"kind": 2048,
@@ -1259,7 +1179,7 @@
},
"signatures": [
{
"id": 43254,
"id": 42,
"name": "getPaymentStatus",
"variant": "signature",
"kind": 4096,
@@ -1294,7 +1214,7 @@
},
"parameters": [
{
"id": 43255,
"id": 43,
"name": "paymentSessionData",
"variant": "param",
"kind": 32768,
@@ -1370,7 +1290,7 @@
}
},
{
"id": 43256,
"id": 44,
"name": "refundPayment",
"variant": "declaration",
"kind": 2048,
@@ -1379,7 +1299,7 @@
},
"signatures": [
{
"id": 43257,
"id": 45,
"name": "refundPayment",
"variant": "signature",
"kind": 4096,
@@ -1422,7 +1342,7 @@
},
"parameters": [
{
"id": 43258,
"id": 46,
"name": "paymentData",
"variant": "param",
"kind": 32768,
@@ -1464,7 +1384,7 @@
}
},
{
"id": 43259,
"id": 47,
"name": "refundAmount",
"variant": "param",
"kind": 32768,
@@ -1541,7 +1461,7 @@
}
},
{
"id": 43260,
"id": 48,
"name": "retrievePayment",
"variant": "declaration",
"kind": 2048,
@@ -1550,7 +1470,7 @@
},
"signatures": [
{
"id": 43261,
"id": 49,
"name": "retrievePayment",
"variant": "signature",
"kind": 4096,
@@ -1593,7 +1513,7 @@
},
"parameters": [
{
"id": 43262,
"id": 50,
"name": "paymentSessionData",
"variant": "param",
"kind": 32768,
@@ -1693,7 +1613,7 @@
}
},
{
"id": 43263,
"id": 51,
"name": "updatePayment",
"variant": "declaration",
"kind": 2048,
@@ -1702,7 +1622,7 @@
},
"signatures": [
{
"id": 43264,
"id": 52,
"name": "updatePayment",
"variant": "signature",
"kind": 4096,
@@ -1717,7 +1637,7 @@
"kind": "inline-tag",
"tag": "@link",
"text": "initiatePayment",
"target": 43247,
"target": 35,
"tsLinkText": ""
},
{
@@ -1764,7 +1684,7 @@
},
"parameters": [
{
"id": 43265,
"id": 53,
"name": "context",
"variant": "param",
"kind": 32768,
@@ -1836,7 +1756,7 @@
}
},
{
"id": 43266,
"id": 54,
"name": "getWebhookActionAndData",
"variant": "declaration",
"kind": 2048,
@@ -1845,7 +1765,7 @@
},
"signatures": [
{
"id": 43267,
"id": 55,
"name": "getWebhookActionAndData",
"variant": "signature",
"kind": 4096,
@@ -1912,7 +1832,7 @@
},
"parameters": [
{
"id": 43268,
"id": 56,
"name": "data",
"variant": "param",
"kind": 32768,
@@ -1928,14 +1848,14 @@
"type": {
"type": "reflection",
"declaration": {
"id": 43269,
"id": 57,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"children": [
{
"id": 43270,
"id": 58,
"name": "data",
"variant": "declaration",
"kind": 1024,
@@ -1969,7 +1889,7 @@
}
},
{
"id": 43271,
"id": 59,
"name": "rawData",
"variant": "declaration",
"kind": 1024,
@@ -2003,7 +1923,7 @@
}
},
{
"id": 43272,
"id": 60,
"name": "headers",
"variant": "declaration",
"kind": 1024,
@@ -2041,9 +1961,9 @@
{
"title": "Properties",
"children": [
43270,
43271,
43272
58,
59,
60
]
}
]
@@ -2089,37 +2009,35 @@
{
"title": "Constructors",
"children": [
43225
13
]
},
{
"title": "Properties",
"children": [
43230,
43231,
43224
12
]
},
{
"title": "Methods",
"children": [
43217,
43234,
43237,
43244,
43247,
43250,
43253,
43256,
43260,
43263,
43266
5,
22,
25,
32,
35,
38,
41,
44,
48,
51,
54
]
}
],
"typeParameters": [
{
"id": 43273,
"id": 61,
"name": "TConfig",
"variant": "typeParam",
"kind": 131072,
@@ -2162,221 +2080,209 @@
{
"title": "Classes",
"children": [
43216
4
]
}
],
"packageName": "@medusajs/utils",
"symbolIdMap": {
"43212": {
"0": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": ""
},
"43216": {
"4": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider"
},
"43217": {
"5": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.validateOptions"
},
"43218": {
"6": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.validateOptions"
},
"43219": {
"7": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "options"
},
"43224": {
"12": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.identifier"
},
"43225": {
"13": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.__constructor"
},
"43226": {
"14": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider"
},
"43227": {
"15": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.TConfig"
},
"43228": {
"16": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "cradle"
},
"43229": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "config"
},
"43230": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.container"
},
"43231": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.config"
},
"43234": {
"22": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.capturePayment"
},
"43235": {
"23": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.capturePayment"
},
"43236": {
"24": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentData"
},
"43237": {
"25": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.authorizePayment"
},
"43238": {
"26": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.authorizePayment"
},
"43239": {
"27": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentSessionData"
},
"43240": {
"28": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "context"
},
"43241": {
"29": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "__type"
},
"43242": {
"30": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "__type.status"
},
"43243": {
"31": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "__type.data"
},
"43244": {
"32": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.cancelPayment"
},
"43245": {
"33": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.cancelPayment"
},
"43246": {
"34": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentData"
},
"43247": {
"35": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.initiatePayment"
},
"43248": {
"36": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.initiatePayment"
},
"43249": {
"37": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "context"
},
"43250": {
"38": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.deletePayment"
},
"43251": {
"39": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.deletePayment"
},
"43252": {
"40": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentSessionData"
},
"43253": {
"41": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.getPaymentStatus"
},
"43254": {
"42": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.getPaymentStatus"
},
"43255": {
"43": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentSessionData"
},
"43256": {
"44": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.refundPayment"
},
"43257": {
"45": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.refundPayment"
},
"43258": {
"46": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentData"
},
"43259": {
"47": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "refundAmount"
},
"43260": {
"48": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.retrievePayment"
},
"43261": {
"49": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.retrievePayment"
},
"43262": {
"50": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentSessionData"
},
"43263": {
"51": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.updatePayment"
},
"43264": {
"52": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.updatePayment"
},
"43265": {
"53": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "context"
},
"43266": {
"54": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.getWebhookActionAndData"
},
"43267": {
"55": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.getWebhookActionAndData"
},
"43268": {
"56": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "data"
},
"43269": {
"57": {
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
"qualifiedName": "__type"
},
"43270": {
"58": {
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
"qualifiedName": "__type.data"
},
"43271": {
"59": {
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
"qualifiedName": "__type.rawData"
},
"43272": {
"60": {
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
"qualifiedName": "__type.headers"
},
"43273": {
"61": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.TConfig"
}
@@ -2386,7 +2292,7 @@
"1": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts"
},
"reflections": {
"1": 43212
"1": 0
}
}
}

18
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/auth-provider.ts
View File

@@ -1,9 +1,10 @@
import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const authProviderOptions: FormattingOptionsType = {
"^auth_provider/.*AbstractAuthModuleProvider": {
reflectionGroups: {
Properties: false,
Constructors: false,
},
reflectionDescription: `In this document, you’ll learn how to create an auth provider module and the methods you must implement in its main service.`,
frontmatterData: {
@@ -14,6 +15,12 @@ const authProviderOptions: FormattingOptionsType = {
},
shouldIncrementAfterStartSections: true,
expandMembers: true,
expandProperties: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [
`## 1. Create Module Directory
@@ -55,10 +62,6 @@ This exports the module's definition, indicating that the \`MyAuthProviderServic
To use your Auth Module Provider, add it to the \`providers\` array of the Auth Module in \`medusa-config.ts\`:
\`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [
@@ -66,6 +69,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/auth",
options: {
providers: [
// default provider
{
resolve: "@medusajs/medusa/auth-emailpass",
id: "emailpass",
},
{
resolve: "./src/modules/my-auth",
id: "my-auth",

18
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/file.ts
View File

@@ -1,9 +1,10 @@
import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const fileOptions: FormattingOptionsType = {
"^file/.*AbstractFileProviderService": {
reflectionGroups: {
Properties: false,
Constructors: false,
},
reflectionDescription: `In this document, you’ll learn how to create a file provider module and the methods you must implement in its main service.`,
frontmatterData: {
@@ -14,6 +15,12 @@ const fileOptions: FormattingOptionsType = {
},
shouldIncrementAfterStartSections: true,
expandMembers: true,
expandProperties: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [
`## 1. Create Module Directory
@@ -61,10 +68,6 @@ The File Module accepts one provider only.
</Note>
\`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [
@@ -72,6 +75,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/file",
options: {
providers: [
// default provider
{
resolve: "@medusajs/medusa/file-local",
id: "local",
},
{
resolve: "./src/modules/my-file",
id: "my-file",

18
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/fulfillment-provider.ts
View File

@@ -1,9 +1,10 @@
import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const fulfillmentProviderOptions: FormattingOptionsType = {
"^fulfillment_provider/.*AbstractFulfillmentProviderService": {
reflectionGroups: {
Properties: false,
Constructors: false,
},
reflectionDescription: `In this document, you’ll learn how to create a fulfillment provider module and the methods you must implement in its main service.`,
frontmatterData: {
@@ -14,6 +15,12 @@ const fulfillmentProviderOptions: FormattingOptionsType = {
},
shouldIncrementAfterStartSections: true,
expandMembers: true,
expandProperties: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [
`## 1. Create Module Directory
@@ -55,10 +62,6 @@ This exports the module's definition, indicating that the \`MyFulfillmentProvide
To use your Fulfillment Module Provider, add it to the \`providers\` array of the Fulfillment Module in \`medusa-config.ts\`:
\`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [
@@ -66,6 +69,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/fulfillment",
options: {
providers: [
// default provider
{
resolve: "@medusajs/medusa/fulfillment-manual",
id: "manual",
},
{
resolve: "./src/modules/my-fulfillment",
id: "my-fulfillment",

22
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/notification.ts
View File

@@ -1,9 +1,10 @@
import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const notificationOptions: FormattingOptionsType = {
"^notification/.*AbstractNotificationProviderService": {
reflectionGroups: {
Properties: false,
Constructors: false,
},
reflectionDescription: `In this document, you’ll learn how to create a notification provider module and the methods you must implement in it.`,
frontmatterData: {
@@ -14,6 +15,12 @@ const notificationOptions: FormattingOptionsType = {
},
shouldIncrementAfterStartSections: true,
expandMembers: true,
expandProperties: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [
`## 1. Create Module Directory
@@ -65,10 +72,6 @@ The Notification Module accepts one provider per channel.
</Note>
\`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [
@@ -76,6 +79,15 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/notification",
options: {
providers: [
// default provider
{
resolve: "@medusajs/medusa/notification-local",
id: "local",
options: {
name: "Local Notification Provider",
channels: ["feed"],
},
},
{
resolve: "./src/modules/my-notification",
id: "my-notification",

13
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/payment-provider.ts
View File

@@ -1,4 +1,5 @@
import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const paymentProviderOptions: FormattingOptionsType = {
"^payment_provider": {
@@ -13,10 +14,16 @@ const paymentProviderOptions: FormattingOptionsType = {
fullReplacement: "How to Create a Payment Provider",
},
reflectionGroups: {
Properties: false,
Constructors: false,
},
shouldIncrementAfterStartSections: true,
expandMembers: true,
expandProperties: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [
`## 1. Create Module Directory
@@ -64,10 +71,6 @@ This exports the module's definition, indicating that the \`MyPaymentProviderSer
To use your Payment Module Provider, add it to the \`providers\` array of the Payment Module in \`medusa-config.ts\`:
\`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({
// ...
modules: [