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

docs: update docusaurus to v3 (#5625)

Browse Source 
* 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
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.ILinkModule.mdx
+22 -22
View File
@@ -15,7 +15,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "ModuleJoinerConfig",
"type": "[`Omit`](../../internal/types/internal.Omit.mdx)<[`JoinerServiceConfig`](internal.internal-1.JoinerServiceConfig.mdx), ``\"serviceName\"`` \\| ``\"primaryKeys\"`` \\| ``\"relationships\"`` \\| ``\"extends\"``\\> & { `databaseConfig?`: { `extraFields?`: Record<`string`, { `defaultValue?`: `string` ; `nullable?`: `boolean` ; `options?`: Record<`string`, `unknown`\\> ; `type`: ``\"date\"`` \\| ``\"time\"`` \\| ``\"datetime\"`` \\| ``\"bigint\"`` \\| ``\"blob\"`` \\| ``\"uint8array\"`` \\| ``\"array\"`` \\| ``\"enumArray\"`` \\| ``\"enum\"`` \\| ``\"json\"`` \\| ``\"integer\"`` \\| ``\"smallint\"`` \\| ``\"tinyint\"`` \\| ``\"mediumint\"`` \\| ``\"float\"`` \\| ``\"double\"`` \\| ``\"boolean\"`` \\| ``\"decimal\"`` \\| ``\"string\"`` \\| ``\"uuid\"`` \\| ``\"text\"`` }\\> ; `idPrefix?`: `string` ; `tableName?`: `string` } ; `extends?`: { `fieldAlias?`: Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\> ; `relationship`: [`ModuleJoinerRelationship`](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx) ; `serviceName`: `string` }[] ; `isLink?`: `boolean` ; `isReadOnlyLink?`: `boolean` ; `linkableKeys?`: Record<`string`, `string`\\> ; `primaryKeys?`: `string`[] ; `relationships?`: [`ModuleJoinerRelationship`](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx)[] ; `schema?`: `string` ; `serviceName?`: `string` }",
"type": "[Omit](../../internal/types/internal.Omit.mdx)&#60;[JoinerServiceConfig](internal.internal-1.JoinerServiceConfig.mdx), `\"serviceName\"` \\| `\"primaryKeys\"` \\| `\"relationships\"` \\| `\"extends\"`&#62; & `&#123; databaseConfig?: &#123; extraFields?: Record&#60;string, &#123; defaultValue?: string ; nullable?: boolean ; options?: Record&#60;string, unknown&#62; ; type: `\"date\"` \\| `\"time\"` \\| `\"datetime\"` \\| `\"bigint\"` \\| `\"blob\"` \\| `\"uint8array\"` \\| `\"array\"` \\| `\"enumArray\"` \\| `\"enum\"` \\| `\"json\"` \\| `\"integer\"` \\| `\"smallint\"` \\| `\"tinyint\"` \\| `\"mediumint\"` \\| `\"float\"` \\| `\"double\"` \\| `\"boolean\"` \\| `\"decimal\"` \\| `\"string\"` \\| `\"uuid\"` \\| `\"text\"` &#125;&#62; ; idPrefix?: string ; tableName?: string &#125; ; extends?: &#123; fieldAlias?: Record&#60;string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;&#62; ; relationship: [ModuleJoinerRelationship](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx) ; serviceName: string &#125;[] ; isLink?: boolean ; isReadOnlyLink?: boolean ; linkableKeys?: Record&#60;string, string&#62; ; primaryKeys?: string[] ; relationships?: [ModuleJoinerRelationship](../../ModulesSdkTypes/types/internal.internal-1.ModulesSdkTypes.ModuleJoinerRelationship.mdx)[] ; schema?: string ; serviceName?: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -33,7 +33,7 @@ ___
<ParameterTypes parameters={[
{
"name": "primaryKeyOrBulkData",
"type": "`string` \\| `string`[] \\| [`string` \\| `string`[], `string`, Record<string, unknown\\\\>?][]",
"type": "`string` \\| `string`[] \\| [`string` \\| `string`[], `string`, Record&#60;string, unknown&#62;?][]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -51,7 +51,7 @@ ___
},
{
"name": "sharedContext",
"type": "[`Context`](internal.internal-1.Context.mdx)",
"type": "[Context](internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -65,7 +65,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`unknown`[]\\>",
"type": "Promise&#60;unknown[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -92,7 +92,7 @@ ___
},
{
"name": "sharedContext",
"type": "[`Context`](internal.internal-1.Context.mdx)",
"type": "[Context](internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -106,7 +106,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -142,7 +142,7 @@ ___
},
{
"name": "sharedContext",
"type": "[`Context`](internal.internal-1.Context.mdx)",
"type": "[Context](internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -156,7 +156,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`unknown`[]\\>",
"type": "Promise&#60;unknown[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -174,7 +174,7 @@ ___
<ParameterTypes parameters={[
{
"name": "filters",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -183,7 +183,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<`unknown`\\>",
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)&#60;unknown&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -192,7 +192,7 @@ ___
},
{
"name": "sharedContext",
"type": "[`Context`](internal.internal-1.Context.mdx)",
"type": "[Context](internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -206,7 +206,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`unknown`[]\\>",
"type": "Promise&#60;unknown[]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -224,7 +224,7 @@ ___
<ParameterTypes parameters={[
{
"name": "filters",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -233,7 +233,7 @@ ___
},
{
"name": "config",
"type": "[`FindConfig`](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)<`unknown`\\>",
"type": "[FindConfig](../../CommonTypes/interfaces/internal.internal-1.CommonTypes.FindConfig.mdx)&#60;unknown&#62;",
"description": "",
"optional": true,
"defaultValue": "",
@@ -242,7 +242,7 @@ ___
},
{
"name": "sharedContext",
"type": "[`Context`](internal.internal-1.Context.mdx)",
"type": "[Context](internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -256,7 +256,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`unknown`[], `number`]\\>",
"type": "Promise&#60;[unknown[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -283,7 +283,7 @@ ___
},
{
"name": "config",
"type": "[`RestoreReturn`](../../DAL/interfaces/internal.internal-1.DAL.RestoreReturn.mdx)",
"type": "[RestoreReturn](../../DAL/interfaces/internal.internal-1.DAL.RestoreReturn.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -292,7 +292,7 @@ ___
},
{
"name": "sharedContext",
"type": "[`Context`](internal.internal-1.Context.mdx)",
"type": "[Context](internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -306,7 +306,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| Record<`string`, `unknown`[]\\>\\>",
"type": "Promise&#60;void \\| Record&#60;string, unknown[]&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
@@ -333,7 +333,7 @@ ___
},
{
"name": "config",
"type": "[`SoftDeleteReturn`](../../DAL/interfaces/internal.internal-1.DAL.SoftDeleteReturn.mdx)",
"type": "[SoftDeleteReturn](../../DAL/interfaces/internal.internal-1.DAL.SoftDeleteReturn.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -342,7 +342,7 @@ ___
},
{
"name": "sharedContext",
"type": "[`Context`](internal.internal-1.Context.mdx)",
"type": "[Context](internal.internal-1.Context.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -356,7 +356,7 @@ ___
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void` \\| Record<`string`, `unknown`[]\\>\\>",
"type": "Promise&#60;void \\| Record&#60;string, unknown[]&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.JoinerServiceConfig.mdx
+6 -6
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "alias",
"type": "[`JoinerServiceConfigAlias`](internal.internal-1.JoinerServiceConfigAlias.mdx) \\| [`JoinerServiceConfigAlias`](internal.internal-1.JoinerServiceConfigAlias.mdx)[]",
"type": "[JoinerServiceConfigAlias](internal.internal-1.JoinerServiceConfigAlias.mdx) \\| [JoinerServiceConfigAlias](internal.internal-1.JoinerServiceConfigAlias.mdx)[]",
"description": "Property name to use as entrypoint to the service",
"optional": true,
"defaultValue": "",
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
@@ -29,7 +29,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "extends",
"type": "{ `relationship`: [`JoinerRelationship`](../types/internal.internal-1.JoinerRelationship.mdx) ; `serviceName`: `string` }[]",
"type": "`&#123; relationship: [JoinerRelationship](../types/internal.internal-1.JoinerRelationship.mdx) ; serviceName: string &#125;`[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -38,8 +38,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "fieldAlias",
"type": "Record<`string`, `string` \\| { `forwardArgumentsOnPath`: `string`[] ; `path`: `string` }\\>",
"description": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })",
"type": "`Record<string, string \\| &#123; forwardArgumentsOnPath: string[] ; path: string &#125;>`",
"description": "alias for deeper nested relationships (e.g. &#123; 'price': 'prices.calculated\\_price\\_set.amount' &#125;)",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -56,7 +56,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "relationships",
"type": "[`JoinerRelationship`](../types/internal.internal-1.JoinerRelationship.mdx)[]",
"type": "[JoinerRelationship](../types/internal.internal-1.JoinerRelationship.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.JoinerServiceConfigAlias.mdx
+1 -1
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "args",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Extra arguments to pass to the remoteFetchData callback",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.RemoteExpandProperty.mdx
+4 -4
View File
@@ -11,7 +11,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
<ParameterTypes parameters={[
{
"name": "args",
"type": "[`JoinerArgument`](internal.internal-1.JoinerArgument.mdx)[]",
"type": "[JoinerArgument](internal.internal-1.JoinerArgument.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "expands",
"type": "[`RemoteNestedExpands`](internal.internal-1.RemoteNestedExpands.mdx)",
"type": "[RemoteNestedExpands](internal.internal-1.RemoteNestedExpands.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -47,7 +47,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "parentConfig",
"type": "[`JoinerServiceConfig`](internal.internal-1.JoinerServiceConfig.mdx)",
"type": "[JoinerServiceConfig](internal.internal-1.JoinerServiceConfig.mdx)",
"description": "",
"optional": true,
"defaultValue": "",
@@ -65,7 +65,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "serviceConfig",
"type": "[`JoinerServiceConfig`](internal.internal-1.JoinerServiceConfig.mdx)",
"type": "[JoinerServiceConfig](internal.internal-1.JoinerServiceConfig.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.RemoteJoinerQuery.mdx
+2 -2
View File
@@ -20,7 +20,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "args",
"type": "[`JoinerArgument`](internal.internal-1.JoinerArgument.mdx)[]",
"type": "[JoinerArgument](internal.internal-1.JoinerArgument.mdx)[]",
"description": "",
"optional": true,
"defaultValue": "",
@@ -38,7 +38,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
},
{
"name": "expands",
"type": "{ `args?`: [`JoinerArgument`](internal.internal-1.JoinerArgument.mdx)[] ; `directives?`: { `[field: string]`: [`JoinerDirective`](internal.internal-1.JoinerDirective.mdx)[]; } ; `fields`: `string`[] ; `property`: `string` }[]",
"type": "`&#123; args?: [JoinerArgument](internal.internal-1.JoinerArgument.mdx)[] ; directives?: &#123; [field: string]: [JoinerDirective](internal.internal-1.JoinerDirective.mdx)[]; &#125; ; fields: string[] ; property: string &#125;`[]",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/js-client/internal-1/interfaces/internal.internal-1.RemoteNestedExpands.mdx
-4
View File
@@ -5,7 +5,3 @@ displayed_sidebar: jsClientSidebar
import ParameterTypes from "@site/src/components/ParameterTypes"
# RemoteNestedExpands
## Indexable
▪ [key: `string`]: { `args?`: [`JoinerArgument`](internal.internal-1.JoinerArgument.mdx)[] ; `expands?`: [`RemoteNestedExpands`](internal.internal-1.RemoteNestedExpands.mdx) ; `fields`: `string`[] }