docs: update imports and package names across docs (#9375)

* docs: update imports and package names across docs + reference configs * generate files * fix import * change preview to rc
2024-10-01 11:03:42 +02:00
parent c726ed54f5
commit 2e16949979
196 changed files with 1379 additions and 1491 deletions
@@ -7,7 +7,7 @@ import { TypeList } from "docs-ui"

 # createHook - Workflows API Reference

-This documentation provides a reference to the `createHook` . It belongs to the `@medusajs/workflows-sdk` package.
+This documentation provides a reference to the `createHook` . It belongs to the `@medusajs/framework/workflows-sdk` package.

 Expose a hook in your workflow where you can inject custom functionality as a step function.

@@ -23,7 +23,7 @@ import {
  createHook,
  createWorkflow,
  WorkflowResponse,
-} from "@medusajs/workflows-sdk"
+} from "@medusajs/framework/workflows-sdk"
 import { createProductStep } from "./steps/create-product"

 export const myWorkflow = createWorkflow(
@@ -7,7 +7,7 @@ import { TypeList } from "docs-ui"

 # createStep - Workflows API Reference

-This documentation provides a reference to the `createStep` . It belongs to the `@medusajs/workflows-sdk` package.
+This documentation provides a reference to the `createStep` . It belongs to the `@medusajs/framework/workflows-sdk` package.

 This function creates a [StepFunction](../../types/workflows.StepFunction/page.mdx) that can be used as a step in a workflow constructed by the [createWorkflow](../workflows.createWorkflow/page.mdx) function.

@@ -19,7 +19,7 @@ import {
  StepResponse,
  StepExecutionContext,
  WorkflowData
-} from "@medusajs/workflows-sdk"
+} from "@medusajs/framework/workflows-sdk"

 interface CreateProductInput {
  title: string
@@ -7,7 +7,7 @@ import { TypeList } from "docs-ui"

 # createWorkflow - Workflows API Reference

-This documentation provides a reference to the `createWorkflow` . It belongs to the `@medusajs/workflows-sdk` package.
+This documentation provides a reference to the `createWorkflow` . It belongs to the `@medusajs/framework/workflows-sdk` package.

 This function creates a workflow with the provided name and a constructor function.
 The constructor function builds the workflow from steps created by the [createStep](../workflows.createStep/page.mdx) function.
@@ -17,7 +17,7 @@ invoke the exported workflow, then run its `run` method.
 ## Example

 ```ts
-import { createWorkflow } from "@medusajs/workflows-sdk"
+import { createWorkflow } from "@medusajs/framework/workflows-sdk"
 import { MedusaRequest, MedusaResponse, Product } from "@medusajs/medusa"
 import {
  createProductStep,
@@ -7,7 +7,7 @@ import { TypeList } from "docs-ui"

 # parallelize - Workflows API Reference

-This documentation provides a reference to the `parallelize` . It belongs to the `@medusajs/workflows-sdk` package.
+This documentation provides a reference to the `parallelize` . It belongs to the `@medusajs/framework/workflows-sdk` package.

 This function is used to run multiple steps in parallel. The result of each step will be returned as part of the result array.

@@ -17,7 +17,7 @@ This function is used to run multiple steps in parallel. The result of each step
 import {
  createWorkflow,
  parallelize
-} from "@medusajs/workflows-sdk"
+} from "@medusajs/framework/workflows-sdk"
 import {
  createProductStep,
  getProductStep,
@@ -7,7 +7,7 @@ import { TypeList } from "docs-ui"

 # transform - Workflows API Reference

-This documentation provides a reference to the `transform` . It belongs to the `@medusajs/workflows-sdk` package.
+This documentation provides a reference to the `transform` . It belongs to the `@medusajs/framework/workflows-sdk` package.

 This function transforms the output of other utility functions.

@@ -24,7 +24,7 @@ If you're also retrieving the output of a hook and want to check if its value is
 import {
  createWorkflow,
  transform
-} from "@medusajs/workflows-sdk"
+} from "@medusajs/framework/workflows-sdk"
 import { step1, step2 } from "./steps"

 type WorkflowInput = {
@@ -7,7 +7,7 @@ import { TypeList } from "docs-ui"

 # when - Workflows API Reference

-This documentation provides a reference to the `when` . It belongs to the `@medusajs/workflows-sdk` package.
+This documentation provides a reference to the `when` . It belongs to the `@medusajs/framework/workflows-sdk` package.

 ## Type Parameters