ce-storefront 0.13.2 → 0.14.0

package/src/models/errors/notfound.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { CeStorefrontError } from "./cestorefronterror.js";
 
 /**
  * Requested resource not found
@@ -16,18 +17,20 @@ export type NotFoundData = {
 /**
  * Requested resource not found
  */
-export class NotFound extends Error {
+export class NotFound extends CeStorefrontError {
   success: boolean;
   code: string;
 
   /** The original data that was passed to this error instance. */
   data$: NotFoundData;
 
-  constructor(err: NotFoundData) {
+  constructor(
+    err: NotFoundData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     this.success = err.success;
     this.code = err.code;
 
@@ -44,9 +47,16 @@ export const NotFound$inboundSchema: z.ZodType<
   message: z.string(),
   success: z.boolean(),
   code: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new NotFound(v);
+    return new NotFound(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { CeStorefrontError } from "./cestorefronterror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends CeStorefrontError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkvalidationerror.ts

@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";

package/src/models/errors/unauthorized.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { CeStorefrontError } from "./cestorefronterror.js";
 
 /**
  * Not authorized for given operation on the Resource
@@ -16,18 +17,20 @@ export type UnauthorizedData = {
 /**
  * Not authorized for given operation on the Resource
  */
-export class Unauthorized extends Error {
+export class Unauthorized extends CeStorefrontError {
   success?: boolean;
   code: string;
 
   /** The original data that was passed to this error instance. */
   data$: UnauthorizedData;
 
-  constructor(err: UnauthorizedData) {
+  constructor(
+    err: UnauthorizedData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = err.message || "API error occurred";
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
     if (err.success != null) this.success = err.success;
     this.code = err.code;
 
@@ -44,9 +47,16 @@ export const Unauthorized$inboundSchema: z.ZodType<
   message: z.string(),
   success: z.boolean().default(false),
   code: z.string(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new Unauthorized(v);
+    return new Unauthorized(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */

package/src/models/operations/getproductdetail.ts

@@ -11,9 +11,9 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetProductDetailRequest = {
   /**
-   * id of a particular product
+   * The unique identifier of the product. Can be either the product ID or the slug.
    */
-  productId?: string | undefined;
+  productIdOrSlug: string;
   /**
    * The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned.
    */
@@ -39,18 +39,18 @@ export const GetProductDetailRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  product_id: z.string().default("1"),
+  product_id_or_slug: z.string(),
   customer_group_id: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "product_id": "productId",
+    "product_id_or_slug": "productIdOrSlug",
     "customer_group_id": "customerGroupId",
   });
 });
 
 /** @internal */
 export type GetProductDetailRequest$Outbound = {
-  product_id: string;
+  product_id_or_slug: string;
   customer_group_id?: string | undefined;
 };
 
@@ -60,11 +60,11 @@ export const GetProductDetailRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetProductDetailRequest
 > = z.object({
-  productId: z.string().default("1"),
+  productIdOrSlug: z.string(),
   customerGroupId: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    productId: "product_id",
+    productIdOrSlug: "product_id_or_slug",
     customerGroupId: "customer_group_id",
   });
 });

package/src/models/operations/listcategories.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListCategoriesRequest = {
   /**
-   * To return child categories
+   * To return child categories using category id.
    */
   parentCategoryId?: string | undefined;
   /**
@@ -26,6 +26,10 @@ export type ListCategoriesRequest = {
    * JSON string format: {"field1":"asc", "field2":"desc"}
    */
   sortBy?: string | undefined;
+  /**
+   * To return child categories using category slug
+   */
+  parentCategorySlug?: string | undefined;
 };
 
 export type ListCategoriesContent = {
@@ -55,11 +59,13 @@ export const ListCategoriesRequest$inboundSchema: z.ZodType<
   nested_level: z.number().int().default(0),
   search: z.string().optional(),
   sort_by: z.string().optional(),
+  parent_category_slug: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "parent_category_id": "parentCategoryId",
     "nested_level": "nestedLevel",
     "sort_by": "sortBy",
+    "parent_category_slug": "parentCategorySlug",
   });
 });
 
@@ -69,6 +75,7 @@ export type ListCategoriesRequest$Outbound = {
   nested_level: number;
   search?: string | undefined;
   sort_by?: string | undefined;
+  parent_category_slug?: string | undefined;
 };
 
 /** @internal */
@@ -81,11 +88,13 @@ export const ListCategoriesRequest$outboundSchema: z.ZodType<
   nestedLevel: z.number().int().default(0),
   search: z.string().optional(),
   sortBy: z.string().optional(),
+  parentCategorySlug: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     parentCategoryId: "parent_category_id",
     nestedLevel: "nested_level",
     sortBy: "sort_by",
+    parentCategorySlug: "parent_category_slug",
   });
 });
 

package/src/models/operations/listproducts.ts

@@ -23,13 +23,17 @@ export type ListProductsRequest = {
    */
   sortBy?: string | undefined;
   /**
-   * filter products by categories
+   * filter products by categories ids
    */
   categoryId?: Array<string> | undefined;
   /**
    * The customer_group_id is used to determine product pricing, promotions, and subscription rates.  If a valid customer_group_id is provided, pricing details will be retrieved accordingly.  If no matching data is found for the specified customer_group_id, the system will fall back to the default customer_group_id.  If no data is found for the default group either, the highest applicable price will be returned.
    */
   customerGroupId?: string | undefined;
+  /**
+   * filter products by categories slugs
+   */
+  categorySlug?: Array<string> | undefined;
 };
 
 export type Content = {
@@ -60,11 +64,13 @@ export const ListProductsRequest$inboundSchema: z.ZodType<
   sort_by: z.string().optional(),
   category_id: z.array(z.string()).optional(),
   customer_group_id: z.string().optional(),
+  category_slug: z.array(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "sort_by": "sortBy",
     "category_id": "categoryId",
     "customer_group_id": "customerGroupId",
+    "category_slug": "categorySlug",
   });
 });
 
@@ -75,6 +81,7 @@ export type ListProductsRequest$Outbound = {
   sort_by?: string | undefined;
   category_id?: Array<string> | undefined;
   customer_group_id?: string | undefined;
+  category_slug?: Array<string> | undefined;
 };
 
 /** @internal */
@@ -88,11 +95,13 @@ export const ListProductsRequest$outboundSchema: z.ZodType<
   sortBy: z.string().optional(),
   categoryId: z.array(z.string()).optional(),
   customerGroupId: z.string().optional(),
+  categorySlug: z.array(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     sortBy: "sort_by",
     categoryId: "category_id",
     customerGroupId: "customer_group_id",
+    categorySlug: "category_slug",
   });
 });
 

package/src/sdk/catalog.ts

@@ -57,7 +57,7 @@ export class Catalog extends ClientSDK {
    * Retrieve a product detail
    *
    * @remarks
-   * Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Commerce Engine will return the corresponding product information.
+   * Retrieves the details of an existing product. Supply either the unique product ID or the unique slug, and Commerce Engine will return the corresponding product information.
    */
   async getProductDetail(
     request: operations.GetProductDetailRequest,