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
www/apps/docs/content/references/workflows/functions/workflows.createStep.mdx
+3 -69
View File
@@ -56,78 +56,12 @@ export const createProductStep = createStep(
## Type Parameters
<ParameterTypes parameters={[
{
"name": "TInvokeInput",
"type": "`object`",
"description": "The type of the expected input parameter to the invocation function.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TInvokeResultOutput",
"type": "`object`",
"description": "The type of the expected output parameter of the invocation function.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TInvokeResultCompensateInput",
"type": "`object`",
"description": "The type of the expected input parameter to the compensation function.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TInvokeInput","type":"`object`","description":"The type of the expected input parameter to the invocation function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TInvokeResultOutput","type":"`object`","description":"The type of the expected output parameter of the invocation function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TInvokeResultCompensateInput","type":"`object`","description":"The type of the expected input parameter to the compensation function.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
## Parameters
<ParameterTypes parameters={[
{
"name": "name",
"type": "`string`",
"description": "The name of the step.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "invokeFn",
"type": "InvokeFn&#60;TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput&#62;",
"description": "An invocation function that will be executed when the workflow is executed. The function must return an instance of [StepResponse](../classes/workflows.StepResponse.mdx). The constructor of [StepResponse](../classes/workflows.StepResponse.mdx)\naccepts the output of the step as a first argument, and optionally as a second argument the data to be passed to the compensation function as a parameter.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "compensateFn",
"type": "CompensateFn&#60;TInvokeResultCompensateInput&#62;",
"description": "A compensation function that's executed if an error occurs in the workflow. It's used to roll-back actions when errors occur.\nIt accepts as a parameter the second argument passed to the constructor of the [StepResponse](../classes/workflows.StepResponse.mdx) instance returned by the invocation function. If the\ninvocation function doesn't pass the second argument to `StepResponse` constructor, the compensation function receives the first argument\npassed to the `StepResponse` constructor instead.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"name","type":"`string`","description":"The name of the step.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"invokeFn","type":"InvokeFn&#60;TInvokeInput, TInvokeResultOutput, TInvokeResultCompensateInput&#62;","description":"An invocation function that will be executed when the workflow is executed. The function must return an instance of [StepResponse](../classes/workflows.StepResponse.mdx). The constructor of [StepResponse](../classes/workflows.StepResponse.mdx)\naccepts the output of the step as a first argument, and optionally as a second argument the data to be passed to the compensation function as a parameter.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"compensateFn","type":"CompensateFn&#60;TInvokeResultCompensateInput&#62;","description":"A compensation function that's executed if an error occurs in the workflow. It's used to roll-back actions when errors occur.\nIt accepts as a parameter the second argument passed to the constructor of the [StepResponse](../classes/workflows.StepResponse.mdx) instance returned by the invocation function. If the\ninvocation function doesn't pass the second argument to `StepResponse` constructor, the compensation function receives the first argument\npassed to the `StepResponse` constructor instead.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} />
## Returns
<ParameterTypes parameters={[
{
"name": "StepFunction",
"type": "[StepFunction](../types/workflows.StepFunction.mdx)&#60;TInvokeInput, TInvokeResultOutput&#62;",
"optional": false,
"defaultValue": "",
"description": "A step function to be used in a workflow.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"StepFunction","type":"[StepFunction](../types/workflows.StepFunction.mdx)&#60;TInvokeInput, TInvokeResultOutput&#62;","optional":false,"defaultValue":"","description":"A step function to be used in a workflow.","expandable":false,"children":[]}]} />
www/apps/docs/content/references/workflows/functions/workflows.createWorkflow.mdx
+3 -60
View File
@@ -62,69 +62,12 @@ export async function GET(
## Type Parameters
<ParameterTypes parameters={[
{
"name": "TData",
"type": "`object`",
"description": "The type of the input passed to the composer function.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TResult",
"type": "`object`",
"description": "The type of the output returned by the composer function.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "THooks",
"type": "`Record<string, Function>`",
"description": "The type of hooks defined in the workflow.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TData","type":"`object`","description":"The type of the input passed to the composer function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TResult","type":"`object`","description":"The type of the output returned by the composer function.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"THooks","type":"`Record<string, Function>`","description":"The type of hooks defined in the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
## Parameters
<ParameterTypes parameters={[
{
"name": "name",
"type": "`string`",
"description": "The name of the workflow.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "composer",
"type": "(`input`: [WorkflowData](../types/workflows.WorkflowData.mdx)&#60;TData&#62;) => `void` \\| [WorkflowData](../types/workflows.WorkflowData.mdx)&#60;TResult&#62; \\| &#123; [K in string \\| number \\| symbol]: WorkflowDataProperties&#60;TResult[K]&#62; \\| WorkflowData&#60;TResult[K]&#62; &#125;",
"description": "The constructor function that is executed when the `run` method in ReturnWorkflow is used.\nThe function can't be an arrow function or an asynchronus function. It also can't directly manipulate data.\nYou'll have to use the [transform](workflows.transform.mdx) function if you need to directly manipulate data.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"name","type":"`string`","description":"The name of the workflow.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"composer","type":"(`input`: [WorkflowData](../types/workflows.WorkflowData.mdx)&#60;TData&#62;) => `void` \\| [WorkflowData](../types/workflows.WorkflowData.mdx)&#60;TResult&#62; \\| &#123; [K in string \\| number \\| symbol]: WorkflowDataProperties&#60;TResult[K]&#62; \\| WorkflowData&#60;TResult[K]&#62; &#125;","description":"The constructor function that is executed when the `run` method in ReturnWorkflow is used.\nThe function can't be an arrow function or an asynchronus function. It also can't directly manipulate data.\nYou'll have to use the [transform](workflows.transform.mdx) function if you need to directly manipulate data.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
## Returns
<ParameterTypes parameters={[
{
"name": "ReturnWorkflow",
"type": "ReturnWorkflow&#60;TData, TResult, THooks&#62;",
"optional": false,
"defaultValue": "",
"description": "The created workflow. You can later execute the workflow by invoking it, then using its `run` method.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"ReturnWorkflow","type":"ReturnWorkflow&#60;TData, TResult, THooks&#62;","optional":false,"defaultValue":"","description":"The created workflow. You can later execute the workflow by invoking it, then using its `run` method.","expandable":false,"children":[]}]} />
www/apps/docs/content/references/workflows/functions/workflows.parallelize.mdx
+3 -33
View File
@@ -49,42 +49,12 @@ const myWorkflow = createWorkflow<
## Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "[WorkflowDataProperties](../types/workflows.WorkflowDataProperties.mdx)&#60;unknown&#62;[]",
"description": "The type of the expected result.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"[WorkflowDataProperties](../types/workflows.WorkflowDataProperties.mdx)&#60;unknown&#62;[]","description":"The type of the expected result.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
## Parameters
<ParameterTypes parameters={[
{
"name": "steps",
"type": "`TResult`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"steps","type":"`TResult`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
## Returns
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`TResult`",
"optional": false,
"defaultValue": "",
"description": "The step results. The results are ordered in the array by the order they're passed in the function's parameter.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"TResult","type":"`TResult`","optional":false,"defaultValue":"","description":"The step results. The results are ordered in the array by the order they're passed in the function's parameter.","expandable":false,"children":[]}]} />
www/apps/docs/content/references/workflows/functions/workflows.transform.mdx
+3 -51
View File
@@ -55,60 +55,12 @@ const myWorkflow = createWorkflow<
## Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
"type": "`object` \\| [WorkflowDataProperties](../types/workflows.WorkflowDataProperties.mdx)&#60;unknown&#62;",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "RFinal",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"T","type":"`object` \\| [WorkflowDataProperties](../types/workflows.WorkflowDataProperties.mdx)&#60;unknown&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"RFinal","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
## Parameters
<ParameterTypes parameters={[
{
"name": "values",
"type": "`T`",
"description": "The output(s) of other step functions.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "func",
"type": "[Func1&#60;T, RFinal&#62;]",
"description": "The transform function used to perform action on the runtime values of the provided `values`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"values","type":"`T`","description":"The output(s) of other step functions.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"func","type":"[Func1&#60;T, RFinal&#62;]","description":"The transform function used to perform action on the runtime values of the provided `values`.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} />
## Returns
<ParameterTypes parameters={[
{
"name": "WorkflowData",
"type": "[WorkflowData](../types/workflows.WorkflowData.mdx)&#60;RFinal&#62;",
"optional": false,
"defaultValue": "",
"description": "There's no expected value to be returned by the `transform` function.",
"expandable": false,
"children": []
}
]} />
<ParameterTypes parameters={[{"name":"WorkflowData","type":"[WorkflowData](../types/workflows.WorkflowData.mdx)&#60;RFinal&#62;","optional":false,"defaultValue":"","description":"There's no expected value to be returned by the `transform` function.","expandable":false,"children":[]}]} />