@lodashventure/medusa-campaign 1.1.0 → 1.1.1

package/src/modules/custom-campaigns/migrations/.snapshot-medusa-custom-campaign.json

@@ -0,0 +1,235 @@
+{
+  "namespaces": [
+    "public"
+  ],
+  "name": "public",
+  "tables": [
+    {
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        },
+        "campaign_id": {
+          "name": "campaign_id",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        },
+        "type": {
+          "name": "type",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "enumItems": [
+            "flash-sale"
+          ],
+          "mappedType": "enum"
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "length": 6,
+          "default": "now()",
+          "mappedType": "datetime"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "length": 6,
+          "default": "now()",
+          "mappedType": "datetime"
+        },
+        "deleted_at": {
+          "name": "deleted_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
+        }
+      },
+      "name": "custom_campaign_type",
+      "schema": "public",
+      "indexes": [
+        {
+          "keyName": "IDX_custom_campaign_type_campaign_id_unique",
+          "columnNames": [],
+          "composite": false,
+          "constraint": false,
+          "primary": false,
+          "unique": false,
+          "expression": "CREATE UNIQUE INDEX IF NOT EXISTS \"IDX_custom_campaign_type_campaign_id_unique\" ON \"custom_campaign_type\" (campaign_id) WHERE deleted_at IS NULL"
+        },
+        {
+          "keyName": "IDX_custom_campaign_type_deleted_at",
+          "columnNames": [],
+          "composite": false,
+          "constraint": false,
+          "primary": false,
+          "unique": false,
+          "expression": "CREATE INDEX IF NOT EXISTS \"IDX_custom_campaign_type_deleted_at\" ON \"custom_campaign_type\" (deleted_at) WHERE deleted_at IS NULL"
+        },
+        {
+          "keyName": "custom_campaign_type_pkey",
+          "columnNames": [
+            "id"
+          ],
+          "composite": false,
+          "constraint": true,
+          "primary": true,
+          "unique": true
+        }
+      ],
+      "checks": [],
+      "foreignKeys": {},
+      "nativeEnums": {}
+    },
+    {
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        },
+        "campaign_id": {
+          "name": "campaign_id",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        },
+        "promotion_id": {
+          "name": "promotion_id",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        },
+        "product_id": {
+          "name": "product_id",
+          "type": "text",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "text"
+        },
+        "limit": {
+          "name": "limit",
+          "type": "integer",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "integer"
+        },
+        "used": {
+          "name": "used",
+          "type": "integer",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "mappedType": "integer"
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "length": 6,
+          "default": "now()",
+          "mappedType": "datetime"
+        },
+        "updated_at": {
+          "name": "updated_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": false,
+          "length": 6,
+          "default": "now()",
+          "mappedType": "datetime"
+        },
+        "deleted_at": {
+          "name": "deleted_at",
+          "type": "timestamptz",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "length": 6,
+          "mappedType": "datetime"
+        }
+      },
+      "name": "promotion_usage_limit",
+      "schema": "public",
+      "indexes": [
+        {
+          "keyName": "IDX_promotion_usage_limit_deleted_at",
+          "columnNames": [],
+          "composite": false,
+          "constraint": false,
+          "primary": false,
+          "unique": false,
+          "expression": "CREATE INDEX IF NOT EXISTS \"IDX_promotion_usage_limit_deleted_at\" ON \"promotion_usage_limit\" (deleted_at) WHERE deleted_at IS NULL"
+        },
+        {
+          "keyName": "IDX_promotion_usage_limit_campaign_id_promotion_id_unique",
+          "columnNames": [],
+          "composite": false,
+          "constraint": false,
+          "primary": false,
+          "unique": false,
+          "expression": "CREATE UNIQUE INDEX IF NOT EXISTS \"IDX_promotion_usage_limit_campaign_id_promotion_id_unique\" ON \"promotion_usage_limit\" (campaign_id, promotion_id) WHERE deleted_at IS NULL"
+        },
+        {
+          "keyName": "promotion_usage_limit_pkey",
+          "columnNames": [
+            "id"
+          ],
+          "composite": false,
+          "constraint": true,
+          "primary": true,
+          "unique": true
+        }
+      ],
+      "checks": [],
+      "foreignKeys": {},
+      "nativeEnums": {}
+    }
+  ],
+  "nativeEnums": {}
+}

package/src/modules/custom-campaigns/migrations/Migration20250524150901.ts

@@ -0,0 +1,23 @@
+import { Migration } from '@mikro-orm/migrations';
+
+export class Migration20250524150901 extends Migration {
+
+  override async up(): Promise<void> {
+    this.addSql(`alter table if exists "promotion_usage_limit" drop constraint if exists "promotion_usage_limit_promotion_id_unique";`);
+    this.addSql(`alter table if exists "custom_campaign_type" drop constraint if exists "custom_campaign_type_campaign_id_unique";`);
+    this.addSql(`create table if not exists "custom_campaign_type" ("id" text not null, "campaign_id" text not null, "type" text check ("type" in ('flash-sale')) not null, "created_at" timestamptz not null default now(), "updated_at" timestamptz not null default now(), "deleted_at" timestamptz null, constraint "custom_campaign_type_pkey" primary key ("id"));`);
+    this.addSql(`CREATE UNIQUE INDEX IF NOT EXISTS "IDX_custom_campaign_type_campaign_id_unique" ON "custom_campaign_type" (campaign_id) WHERE deleted_at IS NULL;`);
+    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_custom_campaign_type_deleted_at" ON "custom_campaign_type" (deleted_at) WHERE deleted_at IS NULL;`);
+
+    this.addSql(`create table if not exists "promotion_usage_limit" ("id" text not null, "promotion_id" text not null, "limit" integer not null, "used" integer not null, "created_at" timestamptz not null default now(), "updated_at" timestamptz not null default now(), "deleted_at" timestamptz null, constraint "promotion_usage_limit_pkey" primary key ("id"));`);
+    this.addSql(`CREATE UNIQUE INDEX IF NOT EXISTS "IDX_promotion_usage_limit_promotion_id_unique" ON "promotion_usage_limit" (promotion_id) WHERE deleted_at IS NULL;`);
+    this.addSql(`CREATE INDEX IF NOT EXISTS "IDX_promotion_usage_limit_deleted_at" ON "promotion_usage_limit" (deleted_at) WHERE deleted_at IS NULL;`);
+  }
+
+  override async down(): Promise<void> {
+    this.addSql(`drop table if exists "custom_campaign_type" cascade;`);
+
+    this.addSql(`drop table if exists "promotion_usage_limit" cascade;`);
+  }
+
+}

package/src/modules/custom-campaigns/migrations/Migration20250526010310.ts

@@ -0,0 +1,20 @@
+import { Migration } from '@mikro-orm/migrations';
+
+export class Migration20250526010310 extends Migration {
+
+  override async up(): Promise<void> {
+    this.addSql(`alter table if exists "promotion_usage_limit" drop constraint if exists "promotion_usage_limit_campaign_id_promotion_id_unique";`);
+    this.addSql(`drop index if exists "IDX_promotion_usage_limit_promotion_id_unique";`);
+
+    this.addSql(`alter table if exists "promotion_usage_limit" add column if not exists "campaign_id" text not null;`);
+    this.addSql(`CREATE UNIQUE INDEX IF NOT EXISTS "IDX_promotion_usage_limit_campaign_id_promotion_id_unique" ON "promotion_usage_limit" (campaign_id, promotion_id) WHERE deleted_at IS NULL;`);
+  }
+
+  override async down(): Promise<void> {
+    this.addSql(`drop index if exists "IDX_promotion_usage_limit_campaign_id_promotion_id_unique";`);
+    this.addSql(`alter table if exists "promotion_usage_limit" drop column if exists "campaign_id";`);
+
+    this.addSql(`CREATE UNIQUE INDEX IF NOT EXISTS "IDX_promotion_usage_limit_promotion_id_unique" ON "promotion_usage_limit" (promotion_id) WHERE deleted_at IS NULL;`);
+  }
+
+}

package/src/modules/custom-campaigns/migrations/Migration20250529011904.ts

@@ -0,0 +1,13 @@
+import { Migration } from '@mikro-orm/migrations';
+
+export class Migration20250529011904 extends Migration {
+
+  override async up(): Promise<void> {
+    this.addSql(`alter table if exists "promotion_usage_limit" add column if not exists "product_id" text not null;`);
+  }
+
+  override async down(): Promise<void> {
+    this.addSql(`alter table if exists "promotion_usage_limit" drop column if exists "product_id";`);
+  }
+
+}

package/src/modules/custom-campaigns/models/custom-campaign-type.ts

@@ -0,0 +1,10 @@
+import { model } from "@medusajs/framework/utils";
+import { CampaignTypeEnum } from "../types/campaign-type.enum";
+
+const CustomCampaignType = model.define("custom_campaign_type", {
+  id: model.id().primaryKey(),
+  campaign_id: model.text().unique(),
+  type: model.enum(CampaignTypeEnum),
+});
+
+export default CustomCampaignType;

package/src/modules/custom-campaigns/models/promotion-usage-limit.ts

@@ -0,0 +1,14 @@
+import { model } from "@medusajs/framework/utils";
+
+const PromotionUsageLimit = model
+  .define("promotion_usage_limit", {
+    id: model.id().primaryKey(),
+    campaign_id: model.text(),
+    promotion_id: model.text(),
+    product_id: model.text(),
+    limit: model.number(),
+    used: model.number(),
+  })
+  .indexes([{ on: ["campaign_id", "promotion_id"], unique: true }]);
+
+export default PromotionUsageLimit;

package/src/modules/custom-campaigns/service.ts

@@ -0,0 +1,10 @@
+import { MedusaService } from "@medusajs/framework/utils";
+import CustomCampaignType from "./models/custom-campaign-type";
+import PromotionUsageLimit from "./models/promotion-usage-limit";
+
+class CustomCampaignModuleService extends MedusaService({
+  CustomCampaignType,
+  PromotionUsageLimit,
+}) {}
+
+export default CustomCampaignModuleService;

package/src/modules/custom-campaigns/types/campaign-type.enum.ts

@@ -0,0 +1,3 @@
+export enum CampaignTypeEnum {
+  FlashSale = "flash-sale",
+}

package/src/providers/README.md

@@ -0,0 +1,30 @@
+## Module Providers
+
+You can create module providers, such as Notification or File Module Providers under a sub-directory of this directory. For example, `src/providers/my-notification`.
+
+Then, you register them in the Medusa application as `plugin-name/providers/my-notification`:
+
+```ts
+module.exports = defineConfig({
+  // ...
+  modules: [
+    {
+      resolve: "@medusajs/medusa/notification",
+      options: {
+        providers: [
+          {
+            resolve: "@myorg/plugin-name/providers/my-notification",
+            id: "my-notification",
+            options: {
+              channels: ["email"],
+              // provider options...
+            },
+          },
+        ],
+      },
+    },
+  ],
+})
+```
+
+Learn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/plugins/create).

package/src/subscribers/README.md

@@ -0,0 +1,59 @@
+# Custom subscribers
+
+Subscribers handle events emitted in the Medusa application.
+
+The subscriber is created in a TypeScript or JavaScript file under the `src/subscribers` directory.
+
+For example, create the file `src/subscribers/product-created.ts` with the following content:
+
+```ts
+import {
+  type SubscriberConfig,
+} from "@medusajs/framework"
+
+// subscriber function
+export default async function productCreateHandler() {
+  console.log("A product was created")
+}
+
+// subscriber config
+export const config: SubscriberConfig = {
+  event: "product.created",
+}
+```
+
+A subscriber file must export:
+
+- The subscriber function that is an asynchronous function executed whenever the associated event is triggered.
+- A configuration object defining the event this subscriber is listening to.
+
+## Subscriber Parameters
+
+A subscriber receives an object having the following properties:
+
+- `event`: An object holding the event's details. It has a `data` property, which is the event's data payload.
+- `container`: The Medusa container. Use it to resolve modules' main services and other registered resources.
+
+```ts
+import type {
+  SubscriberArgs,
+  SubscriberConfig,
+} from "@medusajs/framework"
+
+export default async function productCreateHandler({
+  event: { data },
+  container,
+}: SubscriberArgs<{ id: string }>) {
+  const productId = data.id
+
+  const productModuleService = container.resolve("product")
+
+  const product = await productModuleService.retrieveProduct(productId)
+
+  console.log(`The product ${product.title} was created`)
+}
+
+export const config: SubscriberConfig = {
+  event: "product.created",
+}
+```

package/src/subscribers/order-placed.ts

@@ -0,0 +1,17 @@
+import { SubscriberArgs, type SubscriberConfig } from "@medusajs/framework";
+import { updatePromotionUsageWorkflow } from "../workflows/custom-campaign/updatePromotionUsageWorkflow";
+
+export default async function updatePromotionUsage({
+  event: { data },
+}: SubscriberArgs<{ id: string }>) {
+  // update promotion usage
+  await updatePromotionUsageWorkflow.run({
+    input: {
+      order_id: data.id,
+    },
+  });
+}
+
+export const config: SubscriberConfig = {
+  event: `order.placed`,
+};

package/src/workflows/README.md

@@ -0,0 +1,79 @@
+# Custom Workflows
+
+A workflow is a series of queries and actions that complete a task.
+
+The workflow is created in a TypeScript or JavaScript file under the `src/workflows` directory.
+
+For example:
+
+```ts
+import {
+  createStep,
+  createWorkflow,
+  WorkflowResponse,
+  StepResponse,
+} from "@medusajs/framework/workflows-sdk"
+
+const step1 = createStep("step-1", async () => {
+  return new StepResponse(`Hello from step one!`)
+})
+
+type WorkflowInput = {
+  name: string
+}
+
+const step2 = createStep(
+  "step-2",
+  async ({ name }: WorkflowInput) => {
+    return new StepResponse(`Hello ${name} from step two!`)
+  }
+)
+
+type WorkflowOutput = {
+  message1: string
+  message2: string
+}
+
+const helloWorldWorkflow = createWorkflow(
+  "hello-world",
+  (input: WorkflowInput) => {
+    const greeting1 = step1()
+    const greeting2 = step2(input)
+    
+    return new WorkflowResponse({
+      message1: greeting1,
+      message2: greeting2
+    })
+  }
+)
+
+export default helloWorldWorkflow
+```
+
+## Execute Workflow
+
+You can execute the workflow from other resources, such as API routes, scheduled jobs, or subscribers.
+
+For example, to execute the workflow in an API route:
+
+```ts
+import type {
+  MedusaRequest,
+  MedusaResponse,
+} from "@medusajs/framework"
+import myWorkflow from "../../../workflows/hello-world"
+
+export async function GET(
+  req: MedusaRequest,
+  res: MedusaResponse
+) {
+  const { result } = await myWorkflow(req.scope)
+    .run({
+      input: {
+        name: req.query.name as string,
+      },
+    })
+
+  res.send(result)
+}
+```