@reactionary/provider-commercetools 0.3.11 → 0.3.13

package/core/initialize.js

@@ -16,7 +16,8 @@ import {
   CommercetoolsOrderProvider,
   CommercetoolsOrderSearchProvider,
   CommercetoolsProfileProvider,
-  CommercetoolsStoreProvider
+  CommercetoolsStoreProvider,
+  CommercetoolsProductReviewsProvider
 } from "../providers/index.js";
 import { CommercetoolsAPI } from "./client.js";
 function withCommercetoolsCapabilities(configuration, capabilities) {
@@ -49,6 +50,14 @@ function withCommercetoolsCapabilities(configuration, capabilities) {
         commercetoolsApi
       );
     }
+    if (caps.productReviews) {
+      client.productReviews = new CommercetoolsProductReviewsProvider(
+        config,
+        cache,
+        context,
+        commercetoolsApi
+      );
+    }
     if (caps.identity) {
       client.identity = new CommercetoolsIdentityProvider(
         config,

package/index.js

@@ -6,6 +6,7 @@ export * from "./providers/inventory.provider.js";
 export * from "./providers/order-search.provider.js";
 export * from "./providers/price.provider.js";
 export * from "./providers/product.provider.js";
+export * from "./providers/product-reviews.provider.js";
 export * from "./providers/product-search.provider.js";
 export * from "./schema/capabilities.schema.js";
 export * from "./schema/configuration.schema.js";

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@reactionary/provider-commercetools",
-  "version": "0.3.11",
+  "version": "0.3.13",
   "main": "index.js",
   "types": "src/index.d.ts",
   "dependencies": {
-    "@reactionary/core": "0.3.11",
+    "@reactionary/core": "0.3.13",
     "debug": "^4.4.3",
     "zod": "4.1.9",
     "@commercetools/ts-client": "^4.2.1",

package/providers/index.js

@@ -5,6 +5,7 @@ export * from "./inventory.provider.js";
 export * from "./order-search.provider.js";
 export * from "./price.provider.js";
 export * from "./product.provider.js";
+export * from "./product-reviews.provider.js";
 export * from "./profile.provider.js";
 export * from "./product-search.provider.js";
 export * from "./store.provider.js";

package/providers/product-reviews.provider.js

@@ -0,0 +1,183 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result)
+    __defProp(target, key, result);
+  return result;
+};
+import {
+  ProductReviewsProvider,
+  Reactionary,
+  success,
+  error,
+  ProductReviewSchema,
+  ProductRatingSummarySchema,
+  ProductReviewPaginatedResultSchema
+} from "@reactionary/core";
+class CommercetoolsProductReviewsProvider extends ProductReviewsProvider {
+  constructor(config, cache, context, commercetools) {
+    super(cache, context);
+    this.config = config;
+    this.commercetools = commercetools;
+  }
+  async getClient() {
+    const client = await this.commercetools.getClient();
+    return client.withProjectKey({ projectKey: this.config.projectKey });
+  }
+  async getAdminClient() {
+    const client = await this.commercetools.getAdminClient();
+    return client.withProjectKey({ projectKey: this.config.projectKey });
+  }
+  async getRatingSummary(query) {
+    const client = await this.getClient();
+    const response = await client.productProjections().withKey({ key: query.product.key }).get().execute().catch((e) => {
+      if (e.statusCode === 404) {
+        return null;
+      }
+      throw e;
+    });
+    if (response && response.body) {
+      const summary = {
+        identifier: {
+          product: query.product
+        },
+        averageRating: 0,
+        totalRatings: 0
+      };
+      if (response.body.reviewRatingStatistics) {
+        summary.averageRating = response.body.reviewRatingStatistics.averageRating;
+        summary.totalRatings = response.body.reviewRatingStatistics.count;
+        summary.ratingDistribution = {
+          "1": response.body.reviewRatingStatistics.ratingsDistribution["1"] ?? 0,
+          "2": response.body.reviewRatingStatistics.ratingsDistribution["2"] ?? 0,
+          "3": response.body.reviewRatingStatistics.ratingsDistribution["3"] ?? 0,
+          "4": response.body.reviewRatingStatistics.ratingsDistribution["4"] ?? 0,
+          "5": response.body.reviewRatingStatistics.ratingsDistribution["5"] ?? 0
+        };
+      }
+      return success(summary);
+    } else {
+      return success(this.createEmptyProductRatingSummary({ product: query.product }));
+    }
+  }
+  async findReviews(query) {
+    const client = await this.getClient();
+    const pageNumber = query.paginationOptions?.pageNumber ?? 1;
+    const pageSize = query.paginationOptions?.pageSize ?? 20;
+    const offset = (pageNumber - 1) * pageSize;
+    const product = await client.productProjections().withKey({ key: query.product.key }).get().execute().catch((e) => {
+      if (e.statusCode === 404) {
+        return null;
+      }
+      throw e;
+    });
+    if (!product || !product.body) {
+      return success({
+        items: [],
+        totalCount: 0,
+        pageSize,
+        pageNumber,
+        totalPages: 0
+      });
+    }
+    const whereClause = `target(typeId="product" and id="${product.body.id}")`;
+    const sort = ["createdAt desc"];
+    const response = await client.reviews().get({
+      queryArgs: {
+        where: whereClause,
+        limit: pageSize,
+        offset,
+        sort
+      }
+    }).execute();
+    const reviews = response.body.results.map(
+      (review) => this.parseSingle(review, query.product.key)
+    );
+    const returnedResult = {
+      items: reviews,
+      totalCount: response.body.total || reviews.length,
+      pageSize,
+      pageNumber,
+      totalPages: Math.ceil((response.body.total || reviews.length) / Math.max(pageSize, 1))
+    };
+    return success(returnedResult);
+  }
+  async submitReview(mutation) {
+    if (!(this.context.session.identityContext.identity.type === "Registered")) {
+      return error({ type: "InvalidInput", error: "Only registered users can submit reviews." });
+    }
+    const client = await this.getAdminClient();
+    const response = await client.reviews().post({
+      body: {
+        authorName: mutation.authorName,
+        title: mutation.title,
+        text: mutation.content,
+        rating: mutation.rating,
+        customer: {
+          typeId: "customer",
+          id: this.context.session.identityContext.identity.id.userId
+        },
+        target: {
+          typeId: "product",
+          id: mutation.product.key
+        },
+        locale: this.context.languageContext.locale
+      }
+    }).execute();
+    const review = this.parseSingle(response.body, mutation.product.key);
+    return success(review);
+  }
+  parseSingle(review, productKey) {
+    return {
+      identifier: {
+        key: review.key || ""
+      },
+      product: {
+        key: productKey
+      },
+      authorName: review.authorName ?? "Anonymous",
+      authorId: review.customer?.id,
+      rating: review.rating ?? 0,
+      title: review.title ?? "",
+      content: review.text ?? "",
+      createdAt: review.createdAt,
+      updatedAt: review.lastModifiedAt,
+      verified: !!review.customer
+      // Verified if linked to a customer
+    };
+  }
+}
+__decorateClass([
+  Reactionary({
+    outputSchema: ProductRatingSummarySchema,
+    cache: true,
+    cacheTimeToLiveInSeconds: 300,
+    currencyDependentCaching: false,
+    localeDependentCaching: false
+  })
+], CommercetoolsProductReviewsProvider.prototype, "getRatingSummary", 1);
+__decorateClass([
+  Reactionary({
+    outputSchema: ProductReviewPaginatedResultSchema,
+    cache: true,
+    cacheTimeToLiveInSeconds: 60,
+    currencyDependentCaching: false,
+    localeDependentCaching: true
+  })
+], CommercetoolsProductReviewsProvider.prototype, "findReviews", 1);
+__decorateClass([
+  Reactionary({
+    outputSchema: ProductReviewSchema,
+    cache: false,
+    cacheTimeToLiveInSeconds: 0,
+    currencyDependentCaching: false,
+    localeDependentCaching: false
+  })
+], CommercetoolsProductReviewsProvider.prototype, "submitReview", 1);
+export {
+  CommercetoolsProductReviewsProvider
+};

package/schema/capabilities.schema.js

@@ -2,6 +2,7 @@ import { CapabilitiesSchema } from "@reactionary/core";
 const CommercetoolsCapabilitiesSchema = CapabilitiesSchema.pick({
   product: true,
   productSearch: true,
+  productReviews: true,
   identity: true,
   cart: true,
   checkout: true,

package/src/index.d.ts

@@ -6,6 +6,7 @@ export * from './providers/inventory.provider.js';
 export * from './providers/order-search.provider.js';
 export * from './providers/price.provider.js';
 export * from './providers/product.provider.js';
+export * from './providers/product-reviews.provider.js';
 export * from './providers/product-search.provider.js';
 export * from './schema/capabilities.schema.js';
 export * from './schema/configuration.schema.js';

package/src/providers/index.d.ts

@@ -5,6 +5,7 @@ export * from './inventory.provider.js';
 export * from './order-search.provider.js';
 export * from './price.provider.js';
 export * from './product.provider.js';
+export * from './product-reviews.provider.js';
 export * from './profile.provider.js';
 export * from './product-search.provider.js';
 export * from './store.provider.js';

package/src/providers/product-reviews.provider.d.ts

@@ -0,0 +1,16 @@
+import { ProductReviewsProvider } from '@reactionary/core';
+import type { ProductReview, ProductRatingSummary, ProductReviewPaginatedResult, ProductReviewsListQuery, ProductReviewsGetRatingSummaryQuery, ProductReviewMutationSubmit, Result, RequestContext, Cache } from '@reactionary/core';
+import type { CommercetoolsConfiguration } from '../schema/configuration.schema.js';
+import type { CommercetoolsAPI } from '../core/client.js';
+import type { Review as CTReview } from '@commercetools/platform-sdk';
+export declare class CommercetoolsProductReviewsProvider extends ProductReviewsProvider {
+    protected config: CommercetoolsConfiguration;
+    protected commercetools: CommercetoolsAPI;
+    constructor(config: CommercetoolsConfiguration, cache: Cache, context: RequestContext, commercetools: CommercetoolsAPI);
+    protected getClient(): Promise<import("@commercetools/platform-sdk").ByProjectKeyRequestBuilder>;
+    protected getAdminClient(): Promise<import("@commercetools/platform-sdk").ByProjectKeyRequestBuilder>;
+    getRatingSummary(query: ProductReviewsGetRatingSummaryQuery): Promise<Result<ProductRatingSummary>>;
+    findReviews(query: ProductReviewsListQuery): Promise<Result<ProductReviewPaginatedResult>>;
+    submitReview(mutation: ProductReviewMutationSubmit): Promise<Result<ProductReview>>;
+    protected parseSingle(review: CTReview, productKey: string): ProductReview;
+}

package/src/schema/capabilities.schema.d.ts

@@ -1,7 +1,7 @@
 import type * as z from 'zod';
 export declare const CommercetoolsCapabilitiesSchema: z.ZodObject<{
-    price: z.ZodOptional<z.ZodBoolean>;
     product: z.ZodOptional<z.ZodBoolean>;
+    price: z.ZodOptional<z.ZodBoolean>;
     order: z.ZodOptional<z.ZodBoolean>;
     cart: z.ZodOptional<z.ZodBoolean>;
     checkout: z.ZodOptional<z.ZodBoolean>;
@@ -11,6 +11,7 @@ export declare const CommercetoolsCapabilitiesSchema: z.ZodObject<{
     profile: z.ZodOptional<z.ZodBoolean>;
     store: z.ZodOptional<z.ZodBoolean>;
     productSearch: z.ZodOptional<z.ZodBoolean>;
+    productReviews: z.ZodOptional<z.ZodBoolean>;
     orderSearch: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$loose>;
 export type CommercetoolsCapabilities = z.infer<typeof CommercetoolsCapabilitiesSchema>;