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

docs: generate medusa-react reference (#6004)

Browse Source 
* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
This commit is contained in:
Shahed Nasser
2024-01-05 17:03:38 +02:00
committed by GitHub
parent 6fc6a9de6a
commit 7d650771d1
2811 changed files with 231856 additions and 455063 deletions
Download Patch File Download Diff File Expand all files Collapse all files

381
www/apps/docs/content/references/services/classes/services.IdempotencyKeyService.mdx
View File

@@ -10,78 +10,13 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "idempotencyKeyRepository_",
"type": "Repository&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKeyRepository_","type":"Repository&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -91,17 +26,7 @@ ___
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -115,72 +40,15 @@ transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: `TError`) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
@@ -192,31 +60,11 @@ identifier.
#### Parameters
<ParameterTypes parameters={[
{
"name": "payload",
"type": "`CreateIdempotencyKeyInput`",
"description": "payload of request to create idempotency key for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"payload","type":"`CreateIdempotencyKeyInput`","description":"payload of request to create idempotency key for","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the created idempotency key",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"the created idempotency key","expandable":false,"children":[]}]} />
___
@@ -226,58 +74,11 @@ Execute the initial steps in a idempotent request.
#### Parameters
<ParameterTypes parameters={[
{
"name": "headerKey",
"type": "`string`",
"description": "potential idempotency key from header",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reqMethod",
"type": "`string`",
"description": "method of request",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reqParams",
"type": "`Record<string, unknown>`",
"description": "params of request",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "reqPath",
"type": "`string`",
"description": "path of request",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"headerKey","type":"`string`","description":"potential idempotency key from header","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reqMethod","type":"`string`","description":"method of request","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reqParams","type":"`Record<string, unknown>`","description":"params of request","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reqPath","type":"`string`","description":"path of request","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the existing or created idempotency key",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"the existing or created idempotency key","expandable":false,"children":[]}]} />
___
@@ -287,31 +88,11 @@ Locks an idempotency.
#### Parameters
<ParameterTypes parameters={[
{
"name": "idempotencyKey",
"type": "`string`",
"description": "key to lock",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"idempotencyKey","type":"`string`","description":"key to lock","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "result of the update operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"result of the update operation","expandable":false,"children":[]}]} />
___
@@ -321,31 +102,11 @@ Retrieves an idempotency key
#### Parameters
<ParameterTypes parameters={[
{
"name": "idempotencyKeyOrSelector",
"type": "`string` \\| [Selector](../../medusa/types/medusa.Selector.mdx)&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"description": "key or selector to retrieve",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"idempotencyKeyOrSelector","type":"`string` \\| [Selector](../../medusa/types/medusa.Selector.mdx)&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","description":"key or selector to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "idempotency key",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"idempotency key","expandable":false,"children":[]}]} />
___
@@ -353,31 +114,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
@@ -387,40 +128,11 @@ Locks an idempotency.
#### Parameters
<ParameterTypes parameters={[
{
"name": "idempotencyKey",
"type": "`string`",
"description": "key to update",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "DeepPartial&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"description": "update object",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"idempotencyKey","type":"`string`","description":"key to update","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"DeepPartial&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","description":"update object","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "result of the update operation",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"result of the update operation","expandable":false,"children":[]}]} />
___
@@ -428,31 +140,11 @@ ___
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "IdempotencyKeyService",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"IdempotencyKeyService","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
___
@@ -466,37 +158,8 @@ always consist of 2 or more of these phases. The required phases are
#### Parameters
<ParameterTypes parameters={[
{
"name": "idempotencyKey",
"type": "`string`",
"description": "current idempotency key",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "callback",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;IdempotencyCallbackResult&#62;",
"description": "functionality to execute within the phase",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"idempotencyKey","type":"`string`","description":"current idempotency key","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"callback","type":"(`transactionManager`: `EntityManager`) => Promise&#60;IdempotencyCallbackResult&#62;","description":"functionality to execute within the phase","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "new updated idempotency key",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[IdempotencyKey](../../entities/classes/entities.IdempotencyKey.mdx)&#62;","optional":false,"defaultValue":"","description":"new updated idempotency key","expandable":false,"children":[]}]} />