From 35a8224497be592f6ccacc5f612d452464c34473 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 11 Dec 2024 11:20:07 +0200 Subject: [PATCH] fix lint errors --- .../api-routes/validation/page.mdx | 2 +- .../fundamentals/module-links/query/page.mdx | 2 +- .../workflows/conditions/page.mdx | 2 +- .../app/commerce-modules/cart/extend/page.mdx | 4 +- .../commerce-modules/customer/extend/page.mdx | 4 +- www/apps/resources/app/examples/page.mdx | 4 +- .../app/integrations/guides/sanity/page.mdx | 20 +++--- .../restock-notification/page.mdx | 62 +++++++++---------- .../troubleshooting/workflow-errors/page.mdx | 2 +- 9 files changed, 51 insertions(+), 51 deletions(-) diff --git a/www/apps/book/app/learn/fundamentals/api-routes/validation/page.mdx b/www/apps/book/app/learn/fundamentals/api-routes/validation/page.mdx index da66e40201..35a7745d0c 100644 --- a/www/apps/book/app/learn/fundamentals/api-routes/validation/page.mdx +++ b/www/apps/book/app/learn/fundamentals/api-routes/validation/page.mdx @@ -185,7 +185,7 @@ Add the `validateAndTransformQuery` middleware to the API route in the file `src ```ts title="src/api/middlewares.ts" import { validateAndTransformQuery, - defineMiddlewares + defineMiddlewares, } from "@medusajs/framework/http" import { PostStoreCustomSchema } from "./custom/validators" diff --git a/www/apps/book/app/learn/fundamentals/module-links/query/page.mdx b/www/apps/book/app/learn/fundamentals/module-links/query/page.mdx index f0589a27ff..7895b5c9d1 100644 --- a/www/apps/book/app/learn/fundamentals/module-links/query/page.mdx +++ b/www/apps/book/app/learn/fundamentals/module-links/query/page.mdx @@ -300,7 +300,7 @@ The first step is to use the `validateAndTransformQuery` middleware on the `GET` ```ts title="src/api/middlewares.ts" import { validateAndTransformQuery, - defineMiddlewares + defineMiddlewares, } from "@medusajs/framework/http" import { createFindParams } from "@medusajs/medusa/api/utils/validators" diff --git a/www/apps/book/app/learn/fundamentals/workflows/conditions/page.mdx b/www/apps/book/app/learn/fundamentals/workflows/conditions/page.mdx index 438d6e0e7e..8c60aa3caf 100644 --- a/www/apps/book/app/learn/fundamentals/workflows/conditions/page.mdx +++ b/www/apps/book/app/learn/fundamentals/workflows/conditions/page.mdx @@ -161,7 +161,7 @@ const { isActive } = when( const isActive = isActiveStep() return { - isActive + isActive, } }) ``` diff --git a/www/apps/resources/app/commerce-modules/cart/extend/page.mdx b/www/apps/resources/app/commerce-modules/cart/extend/page.mdx index 8d02193dab..d4520101f8 100644 --- a/www/apps/resources/app/commerce-modules/cart/extend/page.mdx +++ b/www/apps/resources/app/commerce-modules/cart/extend/page.mdx @@ -567,8 +567,8 @@ Next, replace the new `TODO` with the following: ```ts title="src/workflows/update-custom-from-cart/index.ts" const deleted = when( - "delete-cart-custom-link" - { + "delete-cart-custom-link", + { input, carts, }, (data) => diff --git a/www/apps/resources/app/commerce-modules/customer/extend/page.mdx b/www/apps/resources/app/commerce-modules/customer/extend/page.mdx index 0dc443c5d6..3a4b7941f5 100644 --- a/www/apps/resources/app/commerce-modules/customer/extend/page.mdx +++ b/www/apps/resources/app/commerce-modules/customer/extend/page.mdx @@ -542,8 +542,8 @@ Next, replace the `TODO` with the following: ```ts title="src/workflows/update-custom-from-customer/index.ts" const created = when( - "create-customer-custom-link" - { + "create-customer-custom-link", + { input, customers, }, (data) => diff --git a/www/apps/resources/app/examples/page.mdx b/www/apps/resources/app/examples/page.mdx index 32cce7c3ca..b496392427 100644 --- a/www/apps/resources/app/examples/page.mdx +++ b/www/apps/resources/app/examples/page.mdx @@ -334,7 +334,7 @@ export const PostStoreCustomSchema = z.object({ ```ts title="src/api/middlewares.ts" highlights={[["13", "validateAndTransformBody"]]} import { validateAndTransformBody, - defineMiddlewares + defineMiddlewares, } from "@medusajs/framework/http" import { PostStoreCustomSchema } from "./custom/validators" @@ -629,7 +629,7 @@ import type { MedusaNextFunction, MedusaRequest, MedusaResponse, - defineMiddlewares + defineMiddlewares, } from "@medusajs/framework/http" import { ConfigModule } from "@medusajs/framework/types" import { parseCorsOrigins } from "@medusajs/framework/utils" diff --git a/www/apps/resources/app/integrations/guides/sanity/page.mdx b/www/apps/resources/app/integrations/guides/sanity/page.mdx index 1c78208e15..02839c4ec1 100644 --- a/www/apps/resources/app/integrations/guides/sanity/page.mdx +++ b/www/apps/resources/app/integrations/guides/sanity/page.mdx @@ -695,17 +695,17 @@ export const syncStep = createStep( const sanityModule: SanityModuleService = container.resolve(SANITY_MODULE) const query = container.resolve(ContainerRegistrationKeys.QUERY) - let total = 0; + const total = 0 const upsertMap: { before: any after: any }[] = [] - const batchSize = 200; - let hasMore = true; - let offset = 0; - let filters = input.product_ids ? { - id: input.product_ids + const batchSize = 200 + const hasMore = true + const offset = 0 + const filters = input.product_ids ? { + id: input.product_ids, } : {} while (hasMore) { @@ -772,16 +772,16 @@ while (hasMore) { const after = await sanityModule.upsertSyncDocument( "product", prod as ProductDTO - ); + ) upsertMap.push({ // @ts-ignore before: prod.sanity_product, - after + after, }) return after - }), + }) ) } catch (e) { return StepResponse.permanentFailure( @@ -805,7 +805,7 @@ You also wrap the `promiseAll` function within a try-catch block. In the catch b Finally, after the `while` loop and at the end of the step, add the following return statement: ```ts title="src/workflows/sanity-sync-products/steps/sync.ts" -return new StepResponse({ total }, upsertMap); +return new StepResponse({ total }, upsertMap) ``` If no errors occur, the step returns an instance of `StepResponse`, which must be returned by any step. It accepts as a first parameter the data to return to the workflow that executed this step. diff --git a/www/apps/resources/app/recipes/commerce-automation/restock-notification/page.mdx b/www/apps/resources/app/recipes/commerce-automation/restock-notification/page.mdx index 4a0cf2410b..4be2c92ea3 100644 --- a/www/apps/resources/app/recipes/commerce-automation/restock-notification/page.mdx +++ b/www/apps/resources/app/recipes/commerce-automation/restock-notification/page.mdx @@ -440,7 +440,7 @@ export const validateVariantOutOfStockStep = createStep( const query = container.resolve("query") const availability = await getVariantAvailability(query, { variant_ids: [variant_id], - sales_channel_id + sales_channel_id, }) if (availability[variant_id].availability > 0) { @@ -623,10 +623,10 @@ export const createRestockSubscriptionWorkflow = createWorkflow( ({ variant_id, sales_channel_id, - customer + customer, }: CreateRestockSubscriptionWorkflowInput) => { const customerId = transform({ - customer + customer, }, (data) => { return data.customer.customer_id || "" }) @@ -643,8 +643,8 @@ export const createRestockSubscriptionWorkflow = createWorkflow( fields: ["email"], filters: { id: customerId }, options: { - throwIfKeyNotFound: true - } + throwIfKeyNotFound: true, + }, }).config({ name: "retrieve-customer" }) return data @@ -652,7 +652,7 @@ export const createRestockSubscriptionWorkflow = createWorkflow( const email = transform({ retrievedCustomer, - customer + customer, }, (data) => { return data.customer?.email ?? data.retrievedCustomer?.[0].email }) @@ -692,7 +692,7 @@ export const subscriptionWorkflow2Highlights = [ ```ts title="src/workflows/create-restock-subscription/index.ts" highlights={subscriptionWorkflow2Highlights} validateVariantOutOfStockStep({ variant_id, - sales_channel_id + sales_channel_id, }) // @ts-ignore @@ -702,8 +702,8 @@ const { data: restockSubscriptions } = useQueryGraphStep({ filters: { email, variant_id, - sales_channel_id - } + sales_channel_id, + }, }).config({ name: "retrieve-subscriptions" }) when({ restockSubscriptions }, ({ restockSubscriptions }) => { @@ -714,7 +714,7 @@ when({ restockSubscriptions }, ({ restockSubscriptions }) => { variant_id, sales_channel_id, email, - customer_id: customer.customer_id + customer_id: customer.customer_id, }) }) @@ -724,7 +724,7 @@ when({ restockSubscriptions }, ({ restockSubscriptions }) => { .then(() => { updateRestockSubscriptionStep({ id: restockSubscriptions[0].id, - customer_id: customer.customer_id + customer_id: customer.customer_id, }) }) @@ -735,8 +735,8 @@ const { data: restockSubscription } = useQueryGraphStep({ filters: { email, variant_id, - sales_channel_id - } + sales_channel_id, + }, }).config({ name: "retrieve-restock-subscription" }) return new WorkflowResponse( @@ -1120,12 +1120,12 @@ Before adding the step that does this, you'll add a method in the `RestockModule ```ts title="src/modules/restock/service.ts" // other imports... -import { InjectManager, MedusaContext } from "@medusajs/framework/utils"; +import { InjectManager, MedusaContext } from "@medusajs/framework/utils" import { Context } from "@medusajs/framework/types" -import { EntityManager } from "@mikro-orm/knex"; +import { EntityManager } from "@mikro-orm/knex" class RestockModuleService extends MedusaService({ - RestockSubscription + RestockSubscription, }) { // ... @InjectManager() @@ -1151,9 +1151,9 @@ You'll use this method in the step. To create the step, create the file `src/wor ![Directory structure of the Medusa application after adding the step.](https://res.cloudinary.com/dza7lstvk/image/upload/v1733399774/Medusa%20Resources/restock-dir-overview-22_kzchmm.jpg) ```ts title="src/workflows/send-restock-notifications/steps/get-distinct-subscriptions.ts" -import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk"; -import RestockModuleService from "../../../modules/restock/service"; -import { RESTOCK_MODULE } from "../../../modules/restock"; +import { createStep, StepResponse } from "@medusajs/framework/workflows-sdk" +import RestockModuleService from "../../../modules/restock/service" +import { RESTOCK_MODULE } from "../../../modules/restock" export const getDistinctSubscriptionsStep = createStep( "get-distinct-subscriptions", @@ -1198,7 +1198,7 @@ export const getRestockedStep = createStep( input.map(async (restockSubscription) => { const variantAvailability = await getVariantAvailability(query, { variant_ids: [restockSubscription.variant_id], - sales_channel_id: restockSubscription.sales_channel_id + sales_channel_id: restockSubscription.sales_channel_id, }) if (variantAvailability[restockSubscription.variant_id].availability > 0) { @@ -1322,12 +1322,12 @@ Create the file `src/workflows/send-restock-notifications/index.ts` with the fol ![The directory structure of the Medusa application after adding the workflow.](https://res.cloudinary.com/dza7lstvk/image/upload/v1733234507/Medusa%20Resources/restock-dir-overview-20_mcqkkx.jpg) ```ts title="src/workflows/send-restock-notifications/index.ts" -import { createWorkflow, transform, WorkflowResponse } from "@medusajs/framework/workflows-sdk"; -import { useQueryGraphStep } from "@medusajs/medusa/core-flows"; -import { getRestockedStep } from "./steps/get-restocked"; -import { sendRestockNotificationStep } from "./steps/send-restock-notification"; -import { deleteRestockSubscriptionStep } from "./steps/delete-restock-subscriptions"; -import { getDistinctSubscriptionsStep } from "./steps/get-distinct-subscriptions"; +import { createWorkflow, transform, WorkflowResponse } from "@medusajs/framework/workflows-sdk" +import { useQueryGraphStep } from "@medusajs/medusa/core-flows" +import { getRestockedStep } from "./steps/get-restocked" +import { sendRestockNotificationStep } from "./steps/send-restock-notification" +import { deleteRestockSubscriptionStep } from "./steps/delete-restock-subscriptions" +import { getDistinctSubscriptionsStep } from "./steps/get-distinct-subscriptions" export const sendRestockNotificationsWorkflow = createWorkflow( "send-restock-notifications", @@ -1338,11 +1338,11 @@ export const sendRestockNotificationsWorkflow = createWorkflow( const restockedSubscriptions = getRestockedStep(subscriptions) const { variant_ids, sales_channel_ids } = transform({ - restockedSubscriptions + restockedSubscriptions, }, (data) => { const filters: Record = { variant_ids: [], - sales_channel_ids: [] + sales_channel_ids: [], } data.restockedSubscriptions.map((subscription) => { filters.variant_ids.push(subscription.variant_id) @@ -1358,8 +1358,8 @@ export const sendRestockNotificationsWorkflow = createWorkflow( fields: ["*", "product_variant.*"], filters: { variant_id: variant_ids, - sales_channel_id: sales_channel_ids - } + sales_channel_id: sales_channel_ids, + }, }) // @ts-ignore @@ -1369,7 +1369,7 @@ export const sendRestockNotificationsWorkflow = createWorkflow( deleteRestockSubscriptionStep(restockedSubscriptionsWithEmails) return new WorkflowResponse({ - subscriptions: restockedSubscriptionsWithEmails + subscriptions: restockedSubscriptionsWithEmails, }) } ) diff --git a/www/apps/resources/app/troubleshooting/workflow-errors/page.mdx b/www/apps/resources/app/troubleshooting/workflow-errors/page.mdx index e09e5875b4..0de9db5ec8 100644 --- a/www/apps/resources/app/troubleshooting/workflow-errors/page.mdx +++ b/www/apps/resources/app/troubleshooting/workflow-errors/page.mdx @@ -16,7 +16,7 @@ This occurs if the `when-then` block doesn't return a step's result and doesn't ```ts const result = when( - "custom-when-condition", + "custom-when-condition" // ... rest of the parameters ) ```