feat(medusa, link-modules): sales channel <> product module link

packages/link-modules/src/definitions/index.ts

@@ -2,3 +2,4 @@ export * from "./inventory-level-stock-location"
 export * from "./product-variant-inventory-item"
 export * from "./product-variant-price-set"
 export * from "./product-shipping-profile"
+export * from "./product-sales-channel"

packages/link-modules/src/definitions/product-sales-channel.ts

@@ -0,0 +1,62 @@
+import { Modules } from "@medusajs/modules-sdk"
+import { ModuleJoinerConfig } from "@medusajs/types"
+import { LINKS } from "../links"
+
+export const ProductSalesChannel: ModuleJoinerConfig = {
+  serviceName: LINKS.ProductSalesChannel,
+  isLink: true,
+  databaseConfig: {
+    tableName: "product_sales_channel",
+    idPrefix: "prodsc",
+  },
+  alias: [
+    {
+      name: "product_sales_channel",
+    },
+    {
+      name: "product_sales_channels",
+    },
+  ],
+  primaryKeys: ["id", "product_id", "sales_channel_id"],
+  relationships: [
+    {
+      serviceName: Modules.PRODUCT,
+      primaryKey: "id",
+      foreignKey: "product_id",
+      alias: "product",
+    },
+    {
+      serviceName: "salesChannelService",
+      isInternalService: true,
+      primaryKey: "id",
+      foreignKey: "sales_channel_id",
+      alias: "sales_channel",
+    },
+  ],
+  extends: [
+    {
+      serviceName: Modules.PRODUCT,
+      fieldAlias: {
+        sales_channels: "sales_channels_link.sales_channel",
+      },
+      relationship: {
+        serviceName: LINKS.ProductSalesChannel,
+        primaryKey: "product_id",
+        foreignKey: "id",
+        alias: "sales_channels_link",
+        isList: true,
+      },
+    },
+    {
+      serviceName: "salesChannelService",
+      relationship: {
+        serviceName: LINKS.ProductSalesChannel,
+        isInternalService: true,
+        primaryKey: "sales_channel_id",
+        foreignKey: "id",
+        alias: "products_link",
+        isList: true,
+      },
+    },
+  ],
+}

packages/link-modules/src/links.ts

@@ -22,4 +22,10 @@ export const LINKS = {
     "shippingProfileService",
     "profile_id"
   ),
+  ProductSalesChannel: composeLinkName(
+    Modules.PRODUCT,
+    "product_id",
+    "salesChannelService",
+    "sales_channel_id"
+  ),
 }

packages/medusa/src/joiner-configs/index.ts

@@ -1,4 +1,5 @@
 export * as cart from "./cart-service"
 export * as customer from "./customer-service"
 export * as region from "./region-service"
+export * as salesChannel from "./sales-channel-service"
 export * as shippingProfile from "./shipping-profile-service"

packages/medusa/src/joiner-configs/sales-channel-service.ts

@@ -0,0 +1,32 @@
+import { ModuleJoinerConfig } from "@medusajs/types"
+
+export default {
+  serviceName: "salesChannelService",
+  primaryKeys: ["id"],
+  linkableKeys: { sales_channel_id: "SalesChannel" },
+  schema: `
+      scalar Date
+      scalar JSON
+
+      type SalesChannel {
+        id: ID!
+        name: String!
+        description: String!
+        is_disabled: Boolean
+        created_at: Date!
+        updated_at: Date!  
+        deleted_at: Date
+        metadata: JSON
+      }
+    `,
+  alias: [
+    {
+      name: "sales_channel",
+      args: { entity: "SalesChannel" },
+    },
+    {
+      name: "sales_channels",
+      args: { entity: "SalesChannel" },
+    },
+  ],
+} as ModuleJoinerConfig

packages/medusa/src/migrations/1698056997411-product-sales-channels-link.ts

@@ -0,0 +1,38 @@
+import { MigrationInterface, QueryRunner } from "typeorm"
+import IsolateProductDomain from "../loaders/feature-flags/isolate-product-domain"
+
+export const featureFlag = IsolateProductDomain.key
+
+export class ProductSalesChannelsLink1698056997411
+  implements MigrationInterface
+{
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+        ALTER TABLE "product_sales_channel" ADD COLUMN IF NOT EXISTS "id" text;
+        UPDATE "product_sales_channel" SET "id" = 'prodsc_' || substr(md5(random()::text), 0, 27) WHERE id is NULL;
+        ALTER TABLE "product_sales_channel" ALTER COLUMN "id" SET NOT NULL;
+
+        ALTER TABLE "product_sales_channel" DROP CONSTRAINT IF EXISTS "PK_fd29b6a8bd641052628dee19583";
+        ALTER TABLE "product_sales_channel" ADD CONSTRAINT "product_sales_channel_pk" PRIMARY KEY (id);
+        ALTER TABLE "product_sales_channel" ADD CONSTRAINT "product_sales_channel_product_id_sales_channel_id_unique" UNIQUE (product_id, sales_channel_id);
+
+        ALTER TABLE "product_sales_channel" ADD COLUMN IF NOT EXISTS "created_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now();
+        ALTER TABLE "product_sales_channel" ADD COLUMN IF NOT EXISTS "updated_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now();
+        ALTER TABLE "product_sales_channel" ADD COLUMN IF NOT EXISTS "deleted_at" TIMESTAMP WITH TIME ZONE;
+    `)
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+        ALTER TABLE product_sales_channel DROP CONSTRAINT IF EXISTS "product_sales_channel_pk";
+        ALTER TABLE product_sales_channel DROP CONSTRAINT IF EXISTS "product_sales_channel_product_id_sales_channel_id_unique";
+        ALTER TABLE product_sales_channel drop column "id";
+
+        ALTER TABLE "product_sales_channel" DROP COLUMN IF EXISTS "created_at";
+        ALTER TABLE "product_sales_channel" DROP COLUMN IF EXISTS "updated_at";
+        ALTER TABLE "product_sales_channel" DROP COLUMN IF EXISTS "deleted_at";
+
+        ALTER TABLE product_sales_channel ADD CONSTRAINT "PK_product_sales_channel" PRIMARY KEY (product_id, sales_channel_id);
+    `)
+  }
+}

packages/medusa/src/repositories/sales-channel.ts

@@ -8,12 +8,12 @@ const productSalesChannelTable = "product_sales_channel"
 export const SalesChannelRepository = dataSource
   .getRepository(SalesChannel)
   .extend({
-    async getFreeTextSearchResultsAndCount(
+    async getFreeTextSearchResults_(
       q: string,
-      options: ExtendedFindConfig<SalesChannel> = {
+      options: ExtendedFindConfig<SalesChannel> & { withCount?: boolean } = {
         where: {},
       }
-    ): Promise<[SalesChannel[], number]> {
+    ): Promise<SalesChannel[] | [SalesChannel[], number]> {
       const options_ = { ...options }
 
       options_.where = options_.where as FindOptionsWhere<SalesChannel>
@@ -41,7 +41,31 @@ export const SalesChannelRepository = dataSource
         qb = qb.withDeleted()
       }
 
-      return await qb.getManyAndCount()
+      return await (options_.withCount ? qb.getManyAndCount() : qb.getMany())
+    },
+
+    async getFreeTextSearchResultsAndCount(
+      q: string,
+      options: ExtendedFindConfig<SalesChannel> = {
+        where: {},
+      }
+    ): Promise<[SalesChannel[], number]> {
+      return (await this.getFreeTextSearchResults_(q, {
+        ...options,
+        withCount: true,
+      })) as [SalesChannel[], number]
+    },
+
+    async getFreeTextSearchResults(
+      q: string,
+      options: ExtendedFindConfig<SalesChannel> = {
+        where: {},
+      }
+    ): Promise<SalesChannel[]> {
+      return (await this.getFreeTextSearchResults_(
+        q,
+        options
+      )) as SalesChannel[]
     },
 
     async removeProducts(

packages/medusa/src/services/__tests__/sales-channel.ts

@@ -139,11 +139,9 @@ describe("SalesChannelService", () => {
         ...salesChannelData,
       })
 
-      expect(
-        salesChannelRepositoryMock.findOne
-      ).toHaveBeenLastCalledWith({
+      expect(salesChannelRepositoryMock.findOne).toHaveBeenLastCalledWith({
         where: { id: IdMap.getId("sales_channel_1") },
-        relationLoadStrategy: "query"
+        relationLoadStrategy: "query",
       })
     })
   })

packages/medusa/src/services/sales-channel.ts

@@ -125,8 +125,9 @@ class SalesChannelService extends TransactionBaseService {
   }
 
   /**
-   * Lists sales channels based on the provided parameters and includes the count of
+   * Lists sales channels based on the provided parameters and include the count of
    * sales channels that match the query.
+   *
    * @return an array containing the sales channels as
    *   the first element and the total count of sales channels that matches the query
    *   as the second element.
@@ -158,6 +159,38 @@ class SalesChannelService extends TransactionBaseService {
     return await salesChannelRepo.findAndCount(query)
   }
 
+  /**
+   * Lists sales channels based on the provided parameters.
+   *
+   * @return an array containing the sales channels
+   */
+  async list(
+    selector: QuerySelector<SalesChannel>,
+    config: FindConfig<SalesChannel> = {
+      skip: 0,
+      take: 20,
+    }
+  ): Promise<SalesChannel[]> {
+    const salesChannelRepo = this.activeManager_.withRepository(
+      this.salesChannelRepository_
+    )
+
+    const selector_ = { ...selector }
+    let q: string | undefined
+    if ("q" in selector_) {
+      q = selector_.q
+      delete selector_.q
+    }
+
+    const query = buildQuery(selector_, config)
+
+    if (q) {
+      return await salesChannelRepo.getFreeTextSearchResults(q, query)
+    }
+
+    return await salesChannelRepo.find(query)
+  }
+
   /**
    * Creates a SalesChannel
    *