docs: update docusaurus to v3 (#5625)

* update dependencies * update onboarding mdx * fixes for mdx issues * fixes for mdx compatibility * resolve mdx errors * fixes in reference * fix check errors * revert change in vale action * fix node version in action * fix summary in markdown
2023-11-13 20:11:50 +02:00
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
@@ -10,14 +10,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"

 ### constructor

-**new PaymentCollectionService**(`«destructured»`)
+`**new PaymentCollectionService**(«destructured»)`

 #### Parameters

 <ParameterTypes parameters={[
  {
    "name": "__namedParameters",
-    "type": "[`InjectedDependencies`](../types/InjectedDependencies-23.mdx)",
+    "type": "[InjectedDependencies](../types/InjectedDependencies-23.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
@@ -31,7 +31,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
 <ParameterTypes parameters={[
  {
    "name": "__configModule__",
-    "type": "Record<`string`, `unknown`\\>",
+    "type": "`Record<string, unknown>`",
    "description": "",
    "optional": true,
    "defaultValue": "",
@@ -49,7 +49,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
  },
  {
    "name": "__moduleDeclaration__",
-    "type": "Record<`string`, `unknown`\\>",
+    "type": "`Record<string, unknown>`",
    "description": "",
    "optional": true,
    "defaultValue": "",
@@ -58,7 +58,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
  },
  {
    "name": "customerService_",
-    "type": "[`CustomerService`](CustomerService.mdx)",
+    "type": "[CustomerService](CustomerService.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
@@ -67,7 +67,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
  },
  {
    "name": "eventBusService_",
-    "type": "[`EventBusService`](EventBusService.mdx)",
+    "type": "[EventBusService](EventBusService.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
@@ -76,7 +76,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
  },
  {
    "name": "manager_",
-    "type": "`EntityManager`",
+    "type": "EntityManager",
    "description": "",
    "optional": false,
    "defaultValue": "",
@@ -85,7 +85,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
  },
  {
    "name": "paymentCollectionRepository_",
-    "type": "`Repository`<[`PaymentCollection`](PaymentCollection.mdx)\\> & { `getPaymentCollectionIdByPaymentId`: Method getPaymentCollectionIdByPaymentId ; `getPaymentCollectionIdBySessionId`: Method getPaymentCollectionIdBySessionId  }",
+    "type": "Repository&#60;[PaymentCollection](PaymentCollection.mdx)&#62; & `&#123; getPaymentCollectionIdByPaymentId: Method getPaymentCollectionIdByPaymentId ; getPaymentCollectionIdBySessionId: Method getPaymentCollectionIdBySessionId  &#125;`",
    "description": "",
    "optional": false,
    "defaultValue": "",
@@ -94,7 +94,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
  },
  {
    "name": "paymentProviderService_",
-    "type": "[`PaymentProviderService`](PaymentProviderService.mdx)",
+    "type": "[PaymentProviderService](PaymentProviderService.mdx)",
    "description": "",
    "optional": false,
    "defaultValue": "",
@@ -103,7 +103,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
  },
  {
    "name": "transactionManager_",
-    "type": "`undefined` \\| `EntityManager`",
+    "type": "`undefined` \\| EntityManager",
    "description": "",
    "optional": false,
    "defaultValue": "",
@@ -161,16 +161,16 @@ import ParameterTypes from "@site/src/components/ParameterTypes"

 ### activeManager\_

-`Protected` `get` **activeManager_**(): `EntityManager`
+`Protected get**activeManager_**(): EntityManager`

 #### Returns

-`EntityManager`
+EntityManager

 <ParameterTypes parameters={[
  {
    "name": "EntityManager",
-    "type": "`EntityManager`",
+    "type": "EntityManager",
    "optional": false,
    "defaultValue": "",
    "description": "",
@@ -183,7 +183,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"

 ### atomicPhase\_

-`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
+`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`

 Wraps some work within a transactional block. If the service already has
 a transaction manager attached this will be reused, otherwise a new
@@ -215,7 +215,7 @@ transaction manager is created.
 <ParameterTypes parameters={[
  {
    "name": "work",
-    "type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
+    "type": "(`transactionManager`: EntityManager) => Promise&#60;TResult&#62;",
    "description": "the transactional work to be done",
    "optional": false,
    "defaultValue": "",
@@ -224,7 +224,7 @@ transaction manager is created.
  },
  {
    "name": "isolationOrErrorHandler",
-    "type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
+    "type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
    "description": "the isolation level to be used for the work.",
    "optional": true,
    "defaultValue": "",
@@ -233,7 +233,7 @@ transaction manager is created.
  },
  {
    "name": "maybeErrorHandlerOrDontFail",
-    "type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
+    "type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
    "description": "Potential error handler",
    "optional": true,
    "defaultValue": "",
@@ -244,12 +244,12 @@ transaction manager is created.

 #### Returns

-`Promise`<`TResult`\>
+Promise&#60;TResult&#62;

 <ParameterTypes parameters={[
  {
    "name": "Promise",
-    "type": "`Promise`<`TResult`\\>",
+    "type": "Promise&#60;TResult&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the result of the transactional work",
@@ -262,7 +262,7 @@ ___

 ### authorizePaymentSessions

-**authorizePaymentSessions**(`paymentCollectionId`, `sessionIds`, `context?`): `Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+`**authorizePaymentSessions**(paymentCollectionId, sessionIds, context?): Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;`

 Authorizes the payment sessions of a payment collection.

@@ -289,7 +289,7 @@ Authorizes the payment sessions of a payment collection.
  },
  {
    "name": "context",
-    "type": "Record<`string`, `unknown`\\>",
+    "type": "`Record<string, unknown>`",
    "description": "additional data required by payment providers",
    "optional": false,
    "defaultValue": "{}",
@@ -300,12 +300,12 @@ Authorizes the payment sessions of a payment collection.

 #### Returns

-`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;

 <ParameterTypes parameters={[
  {
    "name": "Promise",
-    "type": "`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\\>",
+    "type": "Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the payment collection and its payment session.",
@@ -318,7 +318,7 @@ ___

 ### create

-**create**(`data`): `Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+`**create**(data): Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;`

 Creates a new payment collection.

@@ -327,7 +327,7 @@ Creates a new payment collection.
 <ParameterTypes parameters={[
  {
    "name": "data",
-    "type": "[`CreatePaymentCollectionInput`](../types/CreatePaymentCollectionInput.mdx)",
+    "type": "[CreatePaymentCollectionInput](../types/CreatePaymentCollectionInput.mdx)",
    "description": "info to create the payment collection",
    "optional": false,
    "defaultValue": "",
@@ -338,12 +338,12 @@ Creates a new payment collection.

 #### Returns

-`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;

 <ParameterTypes parameters={[
  {
    "name": "Promise",
-    "type": "`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\\>",
+    "type": "Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the payment collection created.",
@@ -356,7 +356,7 @@ ___

 ### delete

-**delete**(`paymentCollectionId`): `Promise`<`undefined` \| [`PaymentCollection`](PaymentCollection.mdx)\>
+`**delete**(paymentCollectionId): Promise&#60;undefined \| [PaymentCollection](PaymentCollection.mdx)&#62;`

 Deletes a payment collection.

@@ -376,12 +376,12 @@ Deletes a payment collection.

 #### Returns

-`Promise`<`undefined` \| [`PaymentCollection`](PaymentCollection.mdx)\>
+Promise&#60;undefined \| [PaymentCollection](PaymentCollection.mdx)&#62;

 <ParameterTypes parameters={[
  {
    "name": "Promise",
-    "type": "`Promise`<`undefined` \\| [`PaymentCollection`](PaymentCollection.mdx)\\>",
+    "type": "Promise&#60;undefined \\| [PaymentCollection](PaymentCollection.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the payment collection removed.",
@@ -394,7 +394,7 @@ ___

 ### isValidTotalAmount

-`Private` **isValidTotalAmount**(`total`, `sessionsInput`): `boolean`
+`Private **isValidTotalAmount**(total, sessionsInput): boolean`

 #### Parameters

@@ -410,7 +410,7 @@ ___
  },
  {
    "name": "sessionsInput",
-    "type": "[`PaymentCollectionsSessionsBatchInput`](../types/PaymentCollectionsSessionsBatchInput.mdx)[]",
+    "type": "[PaymentCollectionsSessionsBatchInput](../types/PaymentCollectionsSessionsBatchInput.mdx)[]",
    "description": "",
    "optional": false,
    "defaultValue": "",
@@ -439,7 +439,7 @@ ___

 ### markAsAuthorized

-**markAsAuthorized**(`paymentCollectionId`): `Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+`**markAsAuthorized**(paymentCollectionId): Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;`

 Marks a payment collection as authorized bypassing the payment flow.

@@ -459,12 +459,12 @@ Marks a payment collection as authorized bypassing the payment flow.

 #### Returns

-`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;

 <ParameterTypes parameters={[
  {
    "name": "Promise",
-    "type": "`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\\>",
+    "type": "Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the payment session authorized.",
@@ -477,7 +477,7 @@ ___

 ### refreshPaymentSession

-**refreshPaymentSession**(`paymentCollectionId`, `sessionId`, `customerId`): `Promise`<[`PaymentSession`](PaymentSession.mdx)\>
+`**refreshPaymentSession**(paymentCollectionId, sessionId, customerId): Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;`

 Removes and recreate a payment session of a payment collection.

@@ -515,12 +515,12 @@ Removes and recreate a payment session of a payment collection.

 #### Returns

-`Promise`<[`PaymentSession`](PaymentSession.mdx)\>
+Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;

 <ParameterTypes parameters={[
  {
    "name": "Promise",
-    "type": "`Promise`<[`PaymentSession`](PaymentSession.mdx)\\>",
+    "type": "Promise&#60;[PaymentSession](PaymentSession.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the new payment session created.",
@@ -533,7 +533,7 @@ ___

 ### retrieve

-**retrieve**(`paymentCollectionId`, `config?`): `Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+`**retrieve**(paymentCollectionId, config?): Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;`

 Retrieves a payment collection by id.

@@ -551,7 +551,7 @@ Retrieves a payment collection by id.
  },
  {
    "name": "config",
-    "type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`PaymentCollection`](PaymentCollection.mdx)\\>",
+    "type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[PaymentCollection](PaymentCollection.mdx)&#62;",
    "description": "the config to retrieve the payment collection",
    "optional": false,
    "defaultValue": "{}",
@@ -562,12 +562,12 @@ Retrieves a payment collection by id.

 #### Returns

-`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;

 <ParameterTypes parameters={[
  {
    "name": "Promise",
-    "type": "`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\\>",
+    "type": "Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the payment collection.",
@@ -580,7 +580,7 @@ ___

 ### setPaymentSession

-**setPaymentSession**(`paymentCollectionId`, `sessionInput`, `customerId`): `Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+`**setPaymentSession**(paymentCollectionId, sessionInput, customerId): Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;`

 Manages a single payment sessions of a payment collection.

@@ -598,7 +598,7 @@ Manages a single payment sessions of a payment collection.
  },
  {
    "name": "sessionInput",
-    "type": "[`PaymentCollectionsSessionsInput`](../types/PaymentCollectionsSessionsInput.mdx)",
+    "type": "[PaymentCollectionsSessionsInput](../types/PaymentCollectionsSessionsInput.mdx)",
    "description": "object containing payment session info",
    "optional": false,
    "defaultValue": "",
@@ -618,12 +618,12 @@ Manages a single payment sessions of a payment collection.

 #### Returns

-`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;

 <ParameterTypes parameters={[
  {
    "name": "Promise",
-    "type": "`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\\>",
+    "type": "Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the payment collection and its payment session.",
@@ -636,7 +636,7 @@ ___

 ### setPaymentSessionsBatch

-**setPaymentSessionsBatch**(`paymentCollectionOrId`, `sessionsInput`, `customerId`): `Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+`**setPaymentSessionsBatch**(paymentCollectionOrId, sessionsInput, customerId): Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;`

 Manages multiple payment sessions of a payment collection.

@@ -645,7 +645,7 @@ Manages multiple payment sessions of a payment collection.
 <ParameterTypes parameters={[
  {
    "name": "paymentCollectionOrId",
-    "type": "`string` \\| [`PaymentCollection`](PaymentCollection.mdx)",
+    "type": "`string` \\| [PaymentCollection](PaymentCollection.mdx)",
    "description": "the id of the payment collection",
    "optional": false,
    "defaultValue": "",
@@ -654,7 +654,7 @@ Manages multiple payment sessions of a payment collection.
  },
  {
    "name": "sessionsInput",
-    "type": "[`PaymentCollectionsSessionsBatchInput`](../types/PaymentCollectionsSessionsBatchInput.mdx)[]",
+    "type": "[PaymentCollectionsSessionsBatchInput](../types/PaymentCollectionsSessionsBatchInput.mdx)[]",
    "description": "array containing payment session info",
    "optional": false,
    "defaultValue": "",
@@ -674,12 +674,12 @@ Manages multiple payment sessions of a payment collection.

 #### Returns

-`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;

 <ParameterTypes parameters={[
  {
    "name": "Promise",
-    "type": "`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\\>",
+    "type": "Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the payment collection and its payment sessions.",
@@ -692,14 +692,14 @@ ___

 ### shouldRetryTransaction\_

-`Protected` **shouldRetryTransaction_**(`err`): `boolean`
+`Protected **shouldRetryTransaction_**(err): boolean`

 #### Parameters

 <ParameterTypes parameters={[
  {
    "name": "err",
-    "type": "Record<`string`, `unknown`\\> \\| { `code`: `string`  }",
+    "type": "`Record<string, unknown>` \\| `&#123; code: string  &#125;`",
    "description": "",
    "optional": false,
    "defaultValue": "",
@@ -728,7 +728,7 @@ ___

 ### update

-**update**(`paymentCollectionId`, `data`): `Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+`**update**(paymentCollectionId, data): Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;`

 Updates a payment collection.

@@ -746,7 +746,7 @@ Updates a payment collection.
  },
  {
    "name": "data",
-    "type": "`DeepPartial`<[`PaymentCollection`](PaymentCollection.mdx)\\>",
+    "type": "DeepPartial&#60;[PaymentCollection](PaymentCollection.mdx)&#62;",
    "description": "info to be updated",
    "optional": false,
    "defaultValue": "",
@@ -757,12 +757,12 @@ Updates a payment collection.

 #### Returns

-`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\>
+Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;

 <ParameterTypes parameters={[
  {
    "name": "Promise",
-    "type": "`Promise`<[`PaymentCollection`](PaymentCollection.mdx)\\>",
+    "type": "Promise&#60;[PaymentCollection](PaymentCollection.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "the payment collection updated.",
@@ -775,14 +775,14 @@ ___

 ### withTransaction

-**withTransaction**(`transactionManager?`): [`PaymentCollectionService`](PaymentCollectionService.mdx)
+`**withTransaction**(transactionManager?): [PaymentCollectionService](PaymentCollectionService.mdx)`

 #### Parameters

 <ParameterTypes parameters={[
  {
    "name": "transactionManager",
-    "type": "`EntityManager`",
+    "type": "EntityManager",
    "description": "",
    "optional": true,
    "defaultValue": "",
@@ -793,12 +793,12 @@ ___

 #### Returns

-[`PaymentCollectionService`](PaymentCollectionService.mdx)
+[PaymentCollectionService](PaymentCollectionService.mdx)

 <ParameterTypes parameters={[
  {
    "name": "default",
-    "type": "[`PaymentCollectionService`](PaymentCollectionService.mdx)",
+    "type": "[PaymentCollectionService](PaymentCollectionService.mdx)",
    "optional": false,
    "defaultValue": "",
    "description": "",