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

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

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

No files matched your search

packages/core/types/src/notification/common.ts
+1 -1
View File
@@ -20,7 +20,7 @@ export interface Attachment {
*/ */
content_type?: string 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 disposition?: string
/** /**
packages/core/utils/src/fulfillment/provider.ts
+5 -7
View File
@@ -20,7 +20,7 @@ import {
* *
* #### Example * #### Example
* *
* ```ts * ```ts title="src/modules/my-fulfillment/service.ts"
* import { AbstractFulfillmentProviderService } from "@medusajs/framework/utils" * import { AbstractFulfillmentProviderService } from "@medusajs/framework/utils"
* import { Logger } from "@medusajs/framework/types" * import { Logger } from "@medusajs/framework/types"
* *
@@ -56,13 +56,11 @@ export class AbstractFulfillmentProviderService
implements IFulfillmentProvider 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. * @example
*
* For example:
*
* ```ts
* class MyFulfillmentProviderService extends AbstractFulfillmentProviderService { * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
* static identifier = "my-fulfillment" * static identifier = "my-fulfillment"
* *
packages/core/utils/src/payment/abstract-payment-provider.ts
+7 -2
View File
@@ -12,6 +12,9 @@ import {
export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>> export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>>
implements IPaymentProvider implements IPaymentProvider
{ {
/**
* @ignore
*/
protected readonly container: Record<string, unknown> protected readonly container: Record<string, unknown>
/** /**
* This method validates the options of the provider set in `medusa-config.ts`. * 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. * 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>} 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 * @example
* ```ts * ```ts
@@ -93,6 +96,9 @@ export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>>
*/ */
protected constructor( protected constructor(
cradle: Record<string, unknown>, cradle: Record<string, unknown>,
/**
* @ignore
*/
protected readonly config: TConfig = {} as TConfig // eslint-disable-next-line @typescript-eslint/no-empty-function protected readonly config: TConfig = {} as TConfig // eslint-disable-next-line @typescript-eslint/no-empty-function
) { ) {
this.container = cradle this.container = cradle
@@ -122,7 +128,6 @@ export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>>
* static identifier = "my-payment" * static identifier = "my-payment"
* // ... * // ...
* } * }
* ```
*/ */
public static identifier: string public static identifier: string
www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx
+32 -5
View File
@@ -77,7 +77,33 @@ class MyAuthProviderService extends AbstractAuthModuleProvider {
export default MyAuthProviderService 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 ### 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`: 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" ```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({ module.exports = defineConfig({
// ... // ...
modules: [ modules: [
@@ -452,6 +474,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/auth", resolve: "@medusajs/medusa/auth",
options: { options: {
providers: [ providers: [
// default provider
{
resolve: "@medusajs/medusa/auth-emailpass",
id: "emailpass",
},
{ {
resolve: "./src/modules/my-auth", resolve: "./src/modules/my-auth",
id: "my-auth", id: "my-auth",
www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx
+19 -5
View File
@@ -75,7 +75,20 @@ class MyFileProviderService extends AbstractFileProviderService {
export default MyFileProviderService 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 ### validateOptions
@@ -229,10 +242,6 @@ The File Module accepts one provider only.
</Note> </Note>
```ts title="medusa-config.ts" ```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({ module.exports = defineConfig({
// ... // ...
modules: [ modules: [
@@ -240,6 +249,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/file", resolve: "@medusajs/medusa/file",
options: { options: {
providers: [ providers: [
// default provider
{
resolve: "@medusajs/medusa/file-local",
id: "local",
},
{ {
resolve: "./src/modules/my-file", resolve: "./src/modules/my-file",
id: "my-file", id: "my-file",
www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx
+22 -7
View File
@@ -45,7 +45,7 @@ If you're creating a client or establishing a connection with a third-party serv
#### Example #### Example
```ts ```ts title="src/modules/my-fulfillment/service.ts"
import { AbstractFulfillmentProviderService } from "@medusajs/framework/utils" import { AbstractFulfillmentProviderService } from "@medusajs/framework/utils"
import { Logger } from "@medusajs/framework/types" import { Logger } from "@medusajs/framework/types"
@@ -77,7 +77,21 @@ class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
export default MyFulfillmentProviderService 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 ### getFulfillmentOptions
@@ -226,7 +240,7 @@ class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
#### Returns #### 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 ### 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`: 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" ```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({ module.exports = defineConfig({
// ... // ...
modules: [ modules: [
@@ -484,6 +494,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/fulfillment", resolve: "@medusajs/medusa/fulfillment",
options: { options: {
providers: [ providers: [
// default provider
{
resolve: "@medusajs/medusa/fulfillment-manual",
id: "manual",
},
{ {
resolve: "./src/modules/my-fulfillment", resolve: "./src/modules/my-fulfillment",
id: "my-fulfillment", id: "my-fulfillment",
www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx
+9 -6
View File
@@ -78,8 +78,6 @@ class MyNotificationProviderService extends AbstractNotificationProviderService
export default MyNotificationProviderService export default MyNotificationProviderService
``` ```
### constructor
### validateOptions ### validateOptions
This method validates the options of the provider set in `medusa-config.ts`. 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> </Note>
```ts title="medusa-config.ts" ```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({ module.exports = defineConfig({
// ... // ...
modules: [ modules: [
@@ -192,6 +186,15 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/notification", resolve: "@medusajs/medusa/notification",
options: { options: {
providers: [ providers: [
// default provider
{
resolve: "@medusajs/medusa/notification-local",
id: "local",
options: {
name: "Local Notification Provider",
channels: ["feed"],
},
},
{ {
resolve: "./src/modules/my-notification", resolve: "./src/modules/my-notification",
id: "my-notification", id: "my-notification",
www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx
+4 -54
View File
@@ -36,69 +36,23 @@ class MyPaymentProviderService extends AbstractPaymentProvider<
export default MyPaymentProviderService 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"/> 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`
### constructor property in the `medusa-config.ts`.
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.
#### Example #### Example
```ts ```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< class MyPaymentProviderService extends AbstractPaymentProvider<
Options Options
> { > {
static identifier = "my-payment" 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 ### validateOptions
This method validates the options of the provider set in `medusa-config.ts`. 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`: 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" ```ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({ module.exports = defineConfig({
// ... // ...
modules: [ modules: [
www/utils/generated/typedoc-json-output/fulfillment-provider.json
+155 -119
View File
@@ -1,12 +1,12 @@
{ {
"id": 40206, "id": 0,
"name": "fulfillment-provider", "name": "fulfillment-provider",
"variant": "project", "variant": "project",
"kind": 1, "kind": 1,
"flags": {}, "flags": {},
"children": [ "children": [
{ {
"id": 40207, "id": 1,
"name": "AbstractFulfillmentProviderService", "name": "AbstractFulfillmentProviderService",
"variant": "declaration", "variant": "declaration",
"kind": 128, "kind": 128,
@@ -19,13 +19,13 @@
}, },
{ {
"kind": "code", "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": [ "children": [
{ {
"id": 40208, "id": 2,
"name": "identifier", "name": "identifier",
"variant": "declaration", "variant": "declaration",
"kind": 1024, "kind": 1024,
@@ -36,19 +36,50 @@
"summary": [ "summary": [
{ {
"kind": "text", "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", "kind": "code",
"text": "`identifier`" "text": "`fp_{identifier}_{id}`"
}, },
{ {
"kind": "text", "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", "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", "name": "constructor",
"variant": "declaration", "variant": "declaration",
"kind": 512, "kind": 512,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40214, "id": 8,
"name": "new AbstractFulfillmentProviderService", "name": "new AbstractFulfillmentProviderService",
"variant": "signature", "variant": "signature",
"kind": 16384, "kind": 16384,
"flags": {}, "flags": {},
"type": { "type": {
"type": "reference", "type": "reference",
"target": 40207, "target": 1,
"name": "AbstractFulfillmentProviderService", "name": "AbstractFulfillmentProviderService",
"package": "@medusajs/utils" "package": "@medusajs/utils"
} }
@@ -80,14 +111,14 @@
] ]
}, },
{ {
"id": 40217, "id": 11,
"name": "getFulfillmentOptions", "name": "getFulfillmentOptions",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40218, "id": 12,
"name": "getFulfillmentOptions", "name": "getFulfillmentOptions",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -157,14 +188,14 @@
} }
}, },
{ {
"id": 40219, "id": 13,
"name": "validateFulfillmentData", "name": "validateFulfillmentData",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40220, "id": 14,
"name": "validateFulfillmentData", "name": "validateFulfillmentData",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -231,7 +262,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40221, "id": 15,
"name": "optionData", "name": "optionData",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -273,7 +304,7 @@
} }
}, },
{ {
"id": 40222, "id": 16,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -315,7 +346,7 @@
} }
}, },
{ {
"id": 40223, "id": 17,
"name": "context", "name": "context",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -378,14 +409,14 @@
} }
}, },
{ {
"id": 40224, "id": 18,
"name": "validateOption", "name": "validateOption",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40225, "id": 19,
"name": "validateOption", "name": "validateOption",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -444,7 +475,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40226, "id": 20,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -507,14 +538,14 @@
} }
}, },
{ {
"id": 40227, "id": 21,
"name": "canCalculate", "name": "canCalculate",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40228, "id": 22,
"name": "canCalculate", "name": "canCalculate",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -549,7 +580,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40229, "id": 23,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -620,14 +651,14 @@
} }
}, },
{ {
"id": 40230, "id": 24,
"name": "calculatePrice", "name": "calculatePrice",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40231, "id": 25,
"name": "calculatePrice", "name": "calculatePrice",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -642,7 +673,7 @@
"kind": "inline-tag", "kind": "inline-tag",
"tag": "@link", "tag": "@link",
"text": "canCalculate", "text": "canCalculate",
"target": 40227, "target": 21,
"tsLinkText": "" "tsLinkText": ""
}, },
{ {
@@ -681,7 +712,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40232, "id": 26,
"name": "optionData", "name": "optionData",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -723,7 +754,7 @@
} }
}, },
{ {
"id": 40233, "id": 27,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -765,7 +796,7 @@
} }
}, },
{ {
"id": 40234, "id": 28,
"name": "context", "name": "context",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -799,8 +830,13 @@
}, },
"typeArguments": [ "typeArguments": [
{ {
"type": "intrinsic", "type": "reference",
"name": "number" "target": {
"sourceFileName": "../../../../packages/core/types/src/fulfillment/provider.ts",
"qualifiedName": "CalculatedShippingOptionPrice"
},
"name": "CalculatedShippingOptionPrice",
"package": "@medusajs/types"
} }
], ],
"name": "Promise", "name": "Promise",
@@ -820,14 +856,14 @@
} }
}, },
{ {
"id": 40235, "id": 29,
"name": "createFulfillment", "name": "createFulfillment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40236, "id": 30,
"name": "createFulfillment", "name": "createFulfillment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -894,7 +930,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40237, "id": 31,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -921,7 +957,7 @@
} }
}, },
{ {
"id": 40238, "id": 32,
"name": "items", "name": "items",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -943,7 +979,7 @@
} }
}, },
{ {
"id": 40239, "id": 33,
"name": "order", "name": "order",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -971,7 +1007,7 @@
} }
}, },
{ {
"id": 40240, "id": 34,
"name": "fulfillment", "name": "fulfillment",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1034,14 +1070,14 @@
} }
}, },
{ {
"id": 40241, "id": 35,
"name": "cancelFulfillment", "name": "cancelFulfillment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40242, "id": 36,
"name": "cancelFulfillment", "name": "cancelFulfillment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1067,7 +1103,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40243, "id": 37,
"name": "fulfillment", "name": "fulfillment",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1130,14 +1166,14 @@
} }
}, },
{ {
"id": 40244, "id": 38,
"name": "getFulfillmentDocuments", "name": "getFulfillmentDocuments",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40245, "id": 39,
"name": "getFulfillmentDocuments", "name": "getFulfillmentDocuments",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1172,7 +1208,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40246, "id": 40,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1246,14 +1282,14 @@
} }
}, },
{ {
"id": 40247, "id": 41,
"name": "createReturnFulfillment", "name": "createReturnFulfillment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40248, "id": 42,
"name": "createReturnFulfillment", "name": "createReturnFulfillment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1320,7 +1356,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40249, "id": 43,
"name": "fulfillment", "name": "fulfillment",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1383,14 +1419,14 @@
} }
}, },
{ {
"id": 40250, "id": 44,
"name": "getReturnDocuments", "name": "getReturnDocuments",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40251, "id": 45,
"name": "getReturnDocuments", "name": "getReturnDocuments",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1425,7 +1461,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40252, "id": 46,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1499,14 +1535,14 @@
} }
}, },
{ {
"id": 40253, "id": 47,
"name": "getShipmentDocuments", "name": "getShipmentDocuments",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40254, "id": 48,
"name": "getShipmentDocuments", "name": "getShipmentDocuments",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1541,7 +1577,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40255, "id": 49,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1615,14 +1651,14 @@
} }
}, },
{ {
"id": 40256, "id": 50,
"name": "retrieveDocuments", "name": "retrieveDocuments",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
"flags": {}, "flags": {},
"signatures": [ "signatures": [
{ {
"id": 40257, "id": 51,
"name": "retrieveDocuments", "name": "retrieveDocuments",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1657,7 +1693,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 40258, "id": 52,
"name": "fulfillmentData", "name": "fulfillmentData",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1699,7 +1735,7 @@
} }
}, },
{ {
"id": 40259, "id": 53,
"name": "documentType", "name": "documentType",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1759,30 +1795,30 @@
{ {
"title": "Constructors", "title": "Constructors",
"children": [ "children": [
40213 7
] ]
}, },
{ {
"title": "Properties", "title": "Properties",
"children": [ "children": [
40208 2
] ]
}, },
{ {
"title": "Methods", "title": "Methods",
"children": [ "children": [
40217, 11,
40219, 13,
40224, 18,
40227, 21,
40230, 24,
40235, 29,
40241, 35,
40244, 38,
40247, 41,
40250, 44,
40253, 47,
40256 50
] ]
} }
], ],
@@ -1803,193 +1839,193 @@
{ {
"title": "Classes", "title": "Classes",
"children": [ "children": [
40207 1
] ]
} }
], ],
"packageName": "@medusajs/utils", "packageName": "@medusajs/utils",
"symbolIdMap": { "symbolIdMap": {
"40206": { "0": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "" "qualifiedName": ""
}, },
"40207": { "1": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService" "qualifiedName": "AbstractFulfillmentProviderService"
}, },
"40208": { "2": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.identifier" "qualifiedName": "AbstractFulfillmentProviderService.identifier"
}, },
"40217": { "11": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentOptions" "qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentOptions"
}, },
"40218": { "12": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentOptions" "qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentOptions"
}, },
"40219": { "13": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.validateFulfillmentData" "qualifiedName": "AbstractFulfillmentProviderService.validateFulfillmentData"
}, },
"40220": { "14": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.validateFulfillmentData" "qualifiedName": "AbstractFulfillmentProviderService.validateFulfillmentData"
}, },
"40221": { "15": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "optionData" "qualifiedName": "optionData"
}, },
"40222": { "16": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"40223": { "17": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "context" "qualifiedName": "context"
}, },
"40224": { "18": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.validateOption" "qualifiedName": "AbstractFulfillmentProviderService.validateOption"
}, },
"40225": { "19": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.validateOption" "qualifiedName": "AbstractFulfillmentProviderService.validateOption"
}, },
"40226": { "20": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"40227": { "21": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.canCalculate" "qualifiedName": "AbstractFulfillmentProviderService.canCalculate"
}, },
"40228": { "22": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.canCalculate" "qualifiedName": "AbstractFulfillmentProviderService.canCalculate"
}, },
"40229": { "23": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"40230": { "24": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.calculatePrice" "qualifiedName": "AbstractFulfillmentProviderService.calculatePrice"
}, },
"40231": { "25": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.calculatePrice" "qualifiedName": "AbstractFulfillmentProviderService.calculatePrice"
}, },
"40232": { "26": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "optionData" "qualifiedName": "optionData"
}, },
"40233": { "27": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"40234": { "28": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "context" "qualifiedName": "context"
}, },
"40235": { "29": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.createFulfillment" "qualifiedName": "AbstractFulfillmentProviderService.createFulfillment"
}, },
"40236": { "30": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.createFulfillment" "qualifiedName": "AbstractFulfillmentProviderService.createFulfillment"
}, },
"40237": { "31": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"40238": { "32": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "items" "qualifiedName": "items"
}, },
"40239": { "33": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "order" "qualifiedName": "order"
}, },
"40240": { "34": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "fulfillment" "qualifiedName": "fulfillment"
}, },
"40241": { "35": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.cancelFulfillment" "qualifiedName": "AbstractFulfillmentProviderService.cancelFulfillment"
}, },
"40242": { "36": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.cancelFulfillment" "qualifiedName": "AbstractFulfillmentProviderService.cancelFulfillment"
}, },
"40243": { "37": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "fulfillment" "qualifiedName": "fulfillment"
}, },
"40244": { "38": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentDocuments" "qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentDocuments"
}, },
"40245": { "39": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentDocuments" "qualifiedName": "AbstractFulfillmentProviderService.getFulfillmentDocuments"
}, },
"40246": { "40": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"40247": { "41": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.createReturnFulfillment" "qualifiedName": "AbstractFulfillmentProviderService.createReturnFulfillment"
}, },
"40248": { "42": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.createReturnFulfillment" "qualifiedName": "AbstractFulfillmentProviderService.createReturnFulfillment"
}, },
"40249": { "43": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "fulfillment" "qualifiedName": "fulfillment"
}, },
"40250": { "44": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getReturnDocuments" "qualifiedName": "AbstractFulfillmentProviderService.getReturnDocuments"
}, },
"40251": { "45": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getReturnDocuments" "qualifiedName": "AbstractFulfillmentProviderService.getReturnDocuments"
}, },
"40252": { "46": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"40253": { "47": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getShipmentDocuments" "qualifiedName": "AbstractFulfillmentProviderService.getShipmentDocuments"
}, },
"40254": { "48": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.getShipmentDocuments" "qualifiedName": "AbstractFulfillmentProviderService.getShipmentDocuments"
}, },
"40255": { "49": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"40256": { "50": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.retrieveDocuments" "qualifiedName": "AbstractFulfillmentProviderService.retrieveDocuments"
}, },
"40257": { "51": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "AbstractFulfillmentProviderService.retrieveDocuments" "qualifiedName": "AbstractFulfillmentProviderService.retrieveDocuments"
}, },
"40258": { "52": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "fulfillmentData" "qualifiedName": "fulfillmentData"
}, },
"40259": { "53": {
"sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts", "sourceFileName": "../../../../packages/core/utils/src/fulfillment/provider.ts",
"qualifiedName": "documentType" "qualifiedName": "documentType"
} }
@@ -1999,7 +2035,7 @@
"1": "../../../../packages/core/utils/src/fulfillment/provider.ts" "1": "../../../../packages/core/utils/src/fulfillment/provider.ts"
}, },
"reflections": { "reflections": {
"1": 40206 "1": 0
} }
} }
} }
www/utils/generated/typedoc-json-output/payment-provider.json
+126 -220
View File
@@ -1,12 +1,12 @@
{ {
"id": 43212, "id": 0,
"name": "payment-provider", "name": "payment-provider",
"variant": "project", "variant": "project",
"kind": 1, "kind": 1,
"flags": {}, "flags": {},
"children": [ "children": [
{ {
"id": 43216, "id": 4,
"name": "AbstractPaymentProvider", "name": "AbstractPaymentProvider",
"variant": "declaration", "variant": "declaration",
"kind": 128, "kind": 128,
@@ -15,36 +15,7 @@
}, },
"children": [ "children": [
{ {
"id": 43230, "id": 5,
"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,
"name": "validateOptions", "name": "validateOptions",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -53,7 +24,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43218, "id": 6,
"name": "validateOptions", "name": "validateOptions",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -87,7 +58,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43219, "id": 7,
"name": "options", "name": "options",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -129,7 +100,7 @@
] ]
}, },
{ {
"id": 43225, "id": 13,
"name": "constructor", "name": "constructor",
"variant": "declaration", "variant": "declaration",
"kind": 512, "kind": 512,
@@ -138,7 +109,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43226, "id": 14,
"name": "new AbstractPaymentProvider", "name": "new AbstractPaymentProvider",
"variant": "signature", "variant": "signature",
"kind": 16384, "kind": 16384,
@@ -172,7 +143,7 @@
}, },
"typeParameters": [ "typeParameters": [
{ {
"id": 43227, "id": 15,
"name": "TConfig", "name": "TConfig",
"variant": "typeParam", "variant": "typeParam",
"kind": 131072, "kind": 131072,
@@ -200,7 +171,7 @@
], ],
"parameters": [ "parameters": [
{ {
"id": 43228, "id": 16,
"name": "cradle", "name": "cradle",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -232,39 +203,15 @@
"name": "Record", "name": "Record",
"package": "typescript" "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": {
"type": "reference", "type": "reference",
"target": 43216, "target": 4,
"typeArguments": [ "typeArguments": [
{ {
"type": "reference", "type": "reference",
"target": 43227, "target": 15,
"name": "TConfig", "name": "TConfig",
"package": "@medusajs/utils", "package": "@medusajs/utils",
"qualifiedName": "AbstractPaymentProvider.TConfig", "qualifiedName": "AbstractPaymentProvider.TConfig",
@@ -278,34 +225,7 @@
] ]
}, },
{ {
"id": 43231, "id": 12,
"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,
"name": "identifier", "name": "identifier",
"variant": "declaration", "variant": "declaration",
"kind": 1024, "kind": 1024,
@@ -358,7 +278,7 @@
"content": [ "content": [
{ {
"kind": "code", "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", "name": "capturePayment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -379,7 +299,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43235, "id": 23,
"name": "capturePayment", "name": "capturePayment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -394,7 +314,7 @@
"kind": "inline-tag", "kind": "inline-tag",
"tag": "@link", "tag": "@link",
"text": "authorizePayment", "text": "authorizePayment",
"target": 43237, "target": 25,
"tsLinkText": "" "tsLinkText": ""
}, },
{ {
@@ -441,7 +361,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43236, "id": 24,
"name": "paymentData", "name": "paymentData",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -541,7 +461,7 @@
} }
}, },
{ {
"id": 43237, "id": 25,
"name": "authorizePayment", "name": "authorizePayment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -550,7 +470,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43238, "id": 26,
"name": "authorizePayment", "name": "authorizePayment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -565,7 +485,7 @@
"kind": "inline-tag", "kind": "inline-tag",
"tag": "@link", "tag": "@link",
"text": "capturePayment", "text": "capturePayment",
"target": 43234, "target": 22,
"tsLinkText": "" "tsLinkText": ""
}, },
{ {
@@ -620,7 +540,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43239, "id": 27,
"name": "paymentSessionData", "name": "paymentSessionData",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -662,7 +582,7 @@
} }
}, },
{ {
"id": 43240, "id": 28,
"name": "context", "name": "context",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -726,14 +646,14 @@
{ {
"type": "reflection", "type": "reflection",
"declaration": { "declaration": {
"id": 43241, "id": 29,
"name": "__type", "name": "__type",
"variant": "declaration", "variant": "declaration",
"kind": 65536, "kind": 65536,
"flags": {}, "flags": {},
"children": [ "children": [
{ {
"id": 43242, "id": 30,
"name": "status", "name": "status",
"variant": "declaration", "variant": "declaration",
"kind": 1024, "kind": 1024,
@@ -757,7 +677,7 @@
} }
}, },
{ {
"id": 43243, "id": 31,
"name": "data", "name": "data",
"variant": "declaration", "variant": "declaration",
"kind": 1024, "kind": 1024,
@@ -803,8 +723,8 @@
{ {
"title": "Properties", "title": "Properties",
"children": [ "children": [
43242, 30,
43243 31
] ]
} }
] ]
@@ -830,7 +750,7 @@
} }
}, },
{ {
"id": 43244, "id": 32,
"name": "cancelPayment", "name": "cancelPayment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -839,7 +759,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43245, "id": 33,
"name": "cancelPayment", "name": "cancelPayment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -874,7 +794,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43246, "id": 34,
"name": "paymentData", "name": "paymentData",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -974,7 +894,7 @@
} }
}, },
{ {
"id": 43247, "id": 35,
"name": "initiatePayment", "name": "initiatePayment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -983,7 +903,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43248, "id": 36,
"name": "initiatePayment", "name": "initiatePayment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1034,7 +954,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43249, "id": 37,
"name": "context", "name": "context",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1106,7 +1026,7 @@
} }
}, },
{ {
"id": 43250, "id": 38,
"name": "deletePayment", "name": "deletePayment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -1115,7 +1035,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43251, "id": 39,
"name": "deletePayment", "name": "deletePayment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1150,7 +1070,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43252, "id": 40,
"name": "paymentSessionData", "name": "paymentSessionData",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1250,7 +1170,7 @@
} }
}, },
{ {
"id": 43253, "id": 41,
"name": "getPaymentStatus", "name": "getPaymentStatus",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -1259,7 +1179,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43254, "id": 42,
"name": "getPaymentStatus", "name": "getPaymentStatus",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1294,7 +1214,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43255, "id": 43,
"name": "paymentSessionData", "name": "paymentSessionData",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1370,7 +1290,7 @@
} }
}, },
{ {
"id": 43256, "id": 44,
"name": "refundPayment", "name": "refundPayment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -1379,7 +1299,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43257, "id": 45,
"name": "refundPayment", "name": "refundPayment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1422,7 +1342,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43258, "id": 46,
"name": "paymentData", "name": "paymentData",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1464,7 +1384,7 @@
} }
}, },
{ {
"id": 43259, "id": 47,
"name": "refundAmount", "name": "refundAmount",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1541,7 +1461,7 @@
} }
}, },
{ {
"id": 43260, "id": 48,
"name": "retrievePayment", "name": "retrievePayment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -1550,7 +1470,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43261, "id": 49,
"name": "retrievePayment", "name": "retrievePayment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1593,7 +1513,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43262, "id": 50,
"name": "paymentSessionData", "name": "paymentSessionData",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1693,7 +1613,7 @@
} }
}, },
{ {
"id": 43263, "id": 51,
"name": "updatePayment", "name": "updatePayment",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -1702,7 +1622,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43264, "id": 52,
"name": "updatePayment", "name": "updatePayment",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1717,7 +1637,7 @@
"kind": "inline-tag", "kind": "inline-tag",
"tag": "@link", "tag": "@link",
"text": "initiatePayment", "text": "initiatePayment",
"target": 43247, "target": 35,
"tsLinkText": "" "tsLinkText": ""
}, },
{ {
@@ -1764,7 +1684,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43265, "id": 53,
"name": "context", "name": "context",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1836,7 +1756,7 @@
} }
}, },
{ {
"id": 43266, "id": 54,
"name": "getWebhookActionAndData", "name": "getWebhookActionAndData",
"variant": "declaration", "variant": "declaration",
"kind": 2048, "kind": 2048,
@@ -1845,7 +1765,7 @@
}, },
"signatures": [ "signatures": [
{ {
"id": 43267, "id": 55,
"name": "getWebhookActionAndData", "name": "getWebhookActionAndData",
"variant": "signature", "variant": "signature",
"kind": 4096, "kind": 4096,
@@ -1912,7 +1832,7 @@
}, },
"parameters": [ "parameters": [
{ {
"id": 43268, "id": 56,
"name": "data", "name": "data",
"variant": "param", "variant": "param",
"kind": 32768, "kind": 32768,
@@ -1928,14 +1848,14 @@
"type": { "type": {
"type": "reflection", "type": "reflection",
"declaration": { "declaration": {
"id": 43269, "id": 57,
"name": "__type", "name": "__type",
"variant": "declaration", "variant": "declaration",
"kind": 65536, "kind": 65536,
"flags": {}, "flags": {},
"children": [ "children": [
{ {
"id": 43270, "id": 58,
"name": "data", "name": "data",
"variant": "declaration", "variant": "declaration",
"kind": 1024, "kind": 1024,
@@ -1969,7 +1889,7 @@
} }
}, },
{ {
"id": 43271, "id": 59,
"name": "rawData", "name": "rawData",
"variant": "declaration", "variant": "declaration",
"kind": 1024, "kind": 1024,
@@ -2003,7 +1923,7 @@
} }
}, },
{ {
"id": 43272, "id": 60,
"name": "headers", "name": "headers",
"variant": "declaration", "variant": "declaration",
"kind": 1024, "kind": 1024,
@@ -2041,9 +1961,9 @@
{ {
"title": "Properties", "title": "Properties",
"children": [ "children": [
43270, 58,
43271, 59,
43272 60
] ]
} }
] ]
@@ -2089,37 +2009,35 @@
{ {
"title": "Constructors", "title": "Constructors",
"children": [ "children": [
43225 13
] ]
}, },
{ {
"title": "Properties", "title": "Properties",
"children": [ "children": [
43230, 12
43231,
43224
] ]
}, },
{ {
"title": "Methods", "title": "Methods",
"children": [ "children": [
43217, 5,
43234, 22,
43237, 25,
43244, 32,
43247, 35,
43250, 38,
43253, 41,
43256, 44,
43260, 48,
43263, 51,
43266 54
] ]
} }
], ],
"typeParameters": [ "typeParameters": [
{ {
"id": 43273, "id": 61,
"name": "TConfig", "name": "TConfig",
"variant": "typeParam", "variant": "typeParam",
"kind": 131072, "kind": 131072,
@@ -2162,221 +2080,209 @@
{ {
"title": "Classes", "title": "Classes",
"children": [ "children": [
43216 4
] ]
} }
], ],
"packageName": "@medusajs/utils", "packageName": "@medusajs/utils",
"symbolIdMap": { "symbolIdMap": {
"43212": { "0": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "" "qualifiedName": ""
}, },
"43216": { "4": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider" "qualifiedName": "AbstractPaymentProvider"
}, },
"43217": { "5": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.validateOptions" "qualifiedName": "AbstractPaymentProvider.validateOptions"
}, },
"43218": { "6": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.validateOptions" "qualifiedName": "AbstractPaymentProvider.validateOptions"
}, },
"43219": { "7": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "options" "qualifiedName": "options"
}, },
"43224": { "12": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.identifier" "qualifiedName": "AbstractPaymentProvider.identifier"
}, },
"43225": { "13": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.__constructor" "qualifiedName": "AbstractPaymentProvider.__constructor"
}, },
"43226": { "14": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider" "qualifiedName": "AbstractPaymentProvider"
}, },
"43227": { "15": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.TConfig" "qualifiedName": "AbstractPaymentProvider.TConfig"
}, },
"43228": { "16": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "cradle" "qualifiedName": "cradle"
}, },
"43229": { "22": {
"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": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.capturePayment" "qualifiedName": "AbstractPaymentProvider.capturePayment"
}, },
"43235": { "23": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.capturePayment" "qualifiedName": "AbstractPaymentProvider.capturePayment"
}, },
"43236": { "24": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentData" "qualifiedName": "paymentData"
}, },
"43237": { "25": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.authorizePayment" "qualifiedName": "AbstractPaymentProvider.authorizePayment"
}, },
"43238": { "26": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.authorizePayment" "qualifiedName": "AbstractPaymentProvider.authorizePayment"
}, },
"43239": { "27": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentSessionData" "qualifiedName": "paymentSessionData"
}, },
"43240": { "28": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "context" "qualifiedName": "context"
}, },
"43241": { "29": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "__type" "qualifiedName": "__type"
}, },
"43242": { "30": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "__type.status" "qualifiedName": "__type.status"
}, },
"43243": { "31": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "__type.data" "qualifiedName": "__type.data"
}, },
"43244": { "32": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.cancelPayment" "qualifiedName": "AbstractPaymentProvider.cancelPayment"
}, },
"43245": { "33": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.cancelPayment" "qualifiedName": "AbstractPaymentProvider.cancelPayment"
}, },
"43246": { "34": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentData" "qualifiedName": "paymentData"
}, },
"43247": { "35": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.initiatePayment" "qualifiedName": "AbstractPaymentProvider.initiatePayment"
}, },
"43248": { "36": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.initiatePayment" "qualifiedName": "AbstractPaymentProvider.initiatePayment"
}, },
"43249": { "37": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "context" "qualifiedName": "context"
}, },
"43250": { "38": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.deletePayment" "qualifiedName": "AbstractPaymentProvider.deletePayment"
}, },
"43251": { "39": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.deletePayment" "qualifiedName": "AbstractPaymentProvider.deletePayment"
}, },
"43252": { "40": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentSessionData" "qualifiedName": "paymentSessionData"
}, },
"43253": { "41": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.getPaymentStatus" "qualifiedName": "AbstractPaymentProvider.getPaymentStatus"
}, },
"43254": { "42": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.getPaymentStatus" "qualifiedName": "AbstractPaymentProvider.getPaymentStatus"
}, },
"43255": { "43": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentSessionData" "qualifiedName": "paymentSessionData"
}, },
"43256": { "44": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.refundPayment" "qualifiedName": "AbstractPaymentProvider.refundPayment"
}, },
"43257": { "45": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.refundPayment" "qualifiedName": "AbstractPaymentProvider.refundPayment"
}, },
"43258": { "46": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentData" "qualifiedName": "paymentData"
}, },
"43259": { "47": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "refundAmount" "qualifiedName": "refundAmount"
}, },
"43260": { "48": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.retrievePayment" "qualifiedName": "AbstractPaymentProvider.retrievePayment"
}, },
"43261": { "49": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.retrievePayment" "qualifiedName": "AbstractPaymentProvider.retrievePayment"
}, },
"43262": { "50": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "paymentSessionData" "qualifiedName": "paymentSessionData"
}, },
"43263": { "51": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.updatePayment" "qualifiedName": "AbstractPaymentProvider.updatePayment"
}, },
"43264": { "52": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.updatePayment" "qualifiedName": "AbstractPaymentProvider.updatePayment"
}, },
"43265": { "53": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "context" "qualifiedName": "context"
}, },
"43266": { "54": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.getWebhookActionAndData" "qualifiedName": "AbstractPaymentProvider.getWebhookActionAndData"
}, },
"43267": { "55": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.getWebhookActionAndData" "qualifiedName": "AbstractPaymentProvider.getWebhookActionAndData"
}, },
"43268": { "56": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "data" "qualifiedName": "data"
}, },
"43269": { "57": {
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts", "sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
"qualifiedName": "__type" "qualifiedName": "__type"
}, },
"43270": { "58": {
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts", "sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
"qualifiedName": "__type.data" "qualifiedName": "__type.data"
}, },
"43271": { "59": {
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts", "sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
"qualifiedName": "__type.rawData" "qualifiedName": "__type.rawData"
}, },
"43272": { "60": {
"sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts", "sourceFileName": "../../../../packages/core/types/src/payment/mutations.ts",
"qualifiedName": "__type.headers" "qualifiedName": "__type.headers"
}, },
"43273": { "61": {
"sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts", "sourceFileName": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts",
"qualifiedName": "AbstractPaymentProvider.TConfig" "qualifiedName": "AbstractPaymentProvider.TConfig"
} }
@@ -2386,7 +2292,7 @@
"1": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts" "1": "../../../../packages/core/utils/src/payment/abstract-payment-provider.ts"
}, },
"reflections": { "reflections": {
"1": 43212 "1": 0
} }
} }
} }
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/auth-provider.ts
+13 -5
View File
@@ -1,9 +1,10 @@
import { FormattingOptionsType } from "types" import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const authProviderOptions: FormattingOptionsType = { const authProviderOptions: FormattingOptionsType = {
"^auth_provider/.*AbstractAuthModuleProvider": { "^auth_provider/.*AbstractAuthModuleProvider": {
reflectionGroups: { 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.`, 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: { frontmatterData: {
@@ -14,6 +15,12 @@ const authProviderOptions: FormattingOptionsType = {
}, },
shouldIncrementAfterStartSections: true, shouldIncrementAfterStartSections: true,
expandMembers: true, expandMembers: true,
expandProperties: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [ startSections: [
`## 1. Create Module Directory `## 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\`: 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" \`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({ module.exports = defineConfig({
// ... // ...
modules: [ modules: [
@@ -66,6 +69,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/auth", resolve: "@medusajs/medusa/auth",
options: { options: {
providers: [ providers: [
// default provider
{
resolve: "@medusajs/medusa/auth-emailpass",
id: "emailpass",
},
{ {
resolve: "./src/modules/my-auth", resolve: "./src/modules/my-auth",
id: "my-auth", id: "my-auth",
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/file.ts
+13 -5
View File
@@ -1,9 +1,10 @@
import { FormattingOptionsType } from "types" import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const fileOptions: FormattingOptionsType = { const fileOptions: FormattingOptionsType = {
"^file/.*AbstractFileProviderService": { "^file/.*AbstractFileProviderService": {
reflectionGroups: { 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.`, 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: { frontmatterData: {
@@ -14,6 +15,12 @@ const fileOptions: FormattingOptionsType = {
}, },
shouldIncrementAfterStartSections: true, shouldIncrementAfterStartSections: true,
expandMembers: true, expandMembers: true,
expandProperties: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [ startSections: [
`## 1. Create Module Directory `## 1. Create Module Directory
@@ -61,10 +68,6 @@ The File Module accepts one provider only.
</Note> </Note>
\`\`\`ts title="medusa-config.ts" \`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({ module.exports = defineConfig({
// ... // ...
modules: [ modules: [
@@ -72,6 +75,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/file", resolve: "@medusajs/medusa/file",
options: { options: {
providers: [ providers: [
// default provider
{
resolve: "@medusajs/medusa/file-local",
id: "local",
},
{ {
resolve: "./src/modules/my-file", resolve: "./src/modules/my-file",
id: "my-file", id: "my-file",
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/fulfillment-provider.ts
+13 -5
View File
@@ -1,9 +1,10 @@
import { FormattingOptionsType } from "types" import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const fulfillmentProviderOptions: FormattingOptionsType = { const fulfillmentProviderOptions: FormattingOptionsType = {
"^fulfillment_provider/.*AbstractFulfillmentProviderService": { "^fulfillment_provider/.*AbstractFulfillmentProviderService": {
reflectionGroups: { 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.`, 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: { frontmatterData: {
@@ -14,6 +15,12 @@ const fulfillmentProviderOptions: FormattingOptionsType = {
}, },
shouldIncrementAfterStartSections: true, shouldIncrementAfterStartSections: true,
expandMembers: true, expandMembers: true,
expandProperties: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [ startSections: [
`## 1. Create Module Directory `## 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\`: 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" \`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({ module.exports = defineConfig({
// ... // ...
modules: [ modules: [
@@ -66,6 +69,11 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/fulfillment", resolve: "@medusajs/medusa/fulfillment",
options: { options: {
providers: [ providers: [
// default provider
{
resolve: "@medusajs/medusa/fulfillment-manual",
id: "manual",
},
{ {
resolve: "./src/modules/my-fulfillment", resolve: "./src/modules/my-fulfillment",
id: "my-fulfillment", id: "my-fulfillment",
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/notification.ts
+17 -5
View File
@@ -1,9 +1,10 @@
import { FormattingOptionsType } from "types" import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const notificationOptions: FormattingOptionsType = { const notificationOptions: FormattingOptionsType = {
"^notification/.*AbstractNotificationProviderService": { "^notification/.*AbstractNotificationProviderService": {
reflectionGroups: { 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.`, reflectionDescription: `In this document, you’ll learn how to create a notification provider module and the methods you must implement in it.`,
frontmatterData: { frontmatterData: {
@@ -14,6 +15,12 @@ const notificationOptions: FormattingOptionsType = {
}, },
shouldIncrementAfterStartSections: true, shouldIncrementAfterStartSections: true,
expandMembers: true, expandMembers: true,
expandProperties: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [ startSections: [
`## 1. Create Module Directory `## 1. Create Module Directory
@@ -65,10 +72,6 @@ The Notification Module accepts one provider per channel.
</Note> </Note>
\`\`\`ts title="medusa-config.ts" \`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({ module.exports = defineConfig({
// ... // ...
modules: [ modules: [
@@ -76,6 +79,15 @@ module.exports = defineConfig({
resolve: "@medusajs/medusa/notification", resolve: "@medusajs/medusa/notification",
options: { options: {
providers: [ providers: [
// default provider
{
resolve: "@medusajs/medusa/notification-local",
id: "local",
options: {
name: "Local Notification Provider",
channels: ["feed"],
},
},
{ {
resolve: "./src/modules/my-notification", resolve: "./src/modules/my-notification",
id: "my-notification", id: "my-notification",
www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/payment-provider.ts
+8 -5
View File
@@ -1,4 +1,5 @@
import { FormattingOptionsType } from "types" import { FormattingOptionsType } from "types"
import baseSectionsOptions from "../base-section-options.js"
const paymentProviderOptions: FormattingOptionsType = { const paymentProviderOptions: FormattingOptionsType = {
"^payment_provider": { "^payment_provider": {
@@ -13,10 +14,16 @@ const paymentProviderOptions: FormattingOptionsType = {
fullReplacement: "How to Create a Payment Provider", fullReplacement: "How to Create a Payment Provider",
}, },
reflectionGroups: { reflectionGroups: {
Properties: false, Constructors: false,
}, },
shouldIncrementAfterStartSections: true, shouldIncrementAfterStartSections: true,
expandMembers: true, expandMembers: true,
expandProperties: true,
sections: {
...baseSectionsOptions,
member_declaration_title: false,
reflection_typeParameters: false,
},
startSections: [ startSections: [
`## 1. Create Module Directory `## 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\`: 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" \`\`\`ts title="medusa-config.ts"
import { Modules } from "@medusajs/framework/utils"
// ...
module.exports = defineConfig({ module.exports = defineConfig({
// ... // ...
modules: [ modules: [