ce-storefront 0.4.6 → 0.4.8

package/src/models/components/productcategory.ts

@@ -7,103 +7,24 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-export type ChildCategories = {
-  id: string;
-  name: string;
-  description: string | null;
-  parentCategoryId: string | null;
-  productCount: number;
-  active: boolean;
-};
+import {
+  Category,
+  Category$inboundSchema,
+  Category$Outbound,
+  Category$outboundSchema,
+} from "./category.js";
 
 export type ProductCategory = {
   id: string;
   name: string;
+  slug: string;
   description: string | null;
   parentCategoryId: string | null;
   productCount: number;
   active: boolean;
-  childCategories: Array<ChildCategories> | null;
+  childCategories: Array<Category> | null;
 };
 
-/** @internal */
-export const ChildCategories$inboundSchema: z.ZodType<
-  ChildCategories,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  id: z.string(),
-  name: z.string(),
-  description: z.nullable(z.string()),
-  parent_category_id: z.nullable(z.string()),
-  product_count: z.number().int(),
-  active: z.boolean(),
-}).transform((v) => {
-  return remap$(v, {
-    "parent_category_id": "parentCategoryId",
-    "product_count": "productCount",
-  });
-});
-
-/** @internal */
-export type ChildCategories$Outbound = {
-  id: string;
-  name: string;
-  description: string | null;
-  parent_category_id: string | null;
-  product_count: number;
-  active: boolean;
-};
-
-/** @internal */
-export const ChildCategories$outboundSchema: z.ZodType<
-  ChildCategories$Outbound,
-  z.ZodTypeDef,
-  ChildCategories
-> = z.object({
-  id: z.string(),
-  name: z.string(),
-  description: z.nullable(z.string()),
-  parentCategoryId: z.nullable(z.string()),
-  productCount: z.number().int(),
-  active: z.boolean(),
-}).transform((v) => {
-  return remap$(v, {
-    parentCategoryId: "parent_category_id",
-    productCount: "product_count",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace ChildCategories$ {
-  /** @deprecated use `ChildCategories$inboundSchema` instead. */
-  export const inboundSchema = ChildCategories$inboundSchema;
-  /** @deprecated use `ChildCategories$outboundSchema` instead. */
-  export const outboundSchema = ChildCategories$outboundSchema;
-  /** @deprecated use `ChildCategories$Outbound` instead. */
-  export type Outbound = ChildCategories$Outbound;
-}
-
-export function childCategoriesToJSON(
-  childCategories: ChildCategories,
-): string {
-  return JSON.stringify(ChildCategories$outboundSchema.parse(childCategories));
-}
-
-export function childCategoriesFromJSON(
-  jsonString: string,
-): SafeParseResult<ChildCategories, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ChildCategories$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ChildCategories' from JSON`,
-  );
-}
-
 /** @internal */
 export const ProductCategory$inboundSchema: z.ZodType<
   ProductCategory,
@@ -112,13 +33,12 @@ export const ProductCategory$inboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   name: z.string(),
+  slug: z.string(),
   description: z.nullable(z.string()),
   parent_category_id: z.nullable(z.string()),
   product_count: z.number().int(),
   active: z.boolean(),
-  child_categories: z.nullable(
-    z.array(z.lazy(() => ChildCategories$inboundSchema)),
-  ),
+  child_categories: z.nullable(z.array(Category$inboundSchema)),
 }).transform((v) => {
   return remap$(v, {
     "parent_category_id": "parentCategoryId",
@@ -131,11 +51,12 @@ export const ProductCategory$inboundSchema: z.ZodType<
 export type ProductCategory$Outbound = {
   id: string;
   name: string;
+  slug: string;
   description: string | null;
   parent_category_id: string | null;
   product_count: number;
   active: boolean;
-  child_categories: Array<ChildCategories$Outbound> | null;
+  child_categories: Array<Category$Outbound> | null;
 };
 
 /** @internal */
@@ -146,13 +67,12 @@ export const ProductCategory$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   name: z.string(),
+  slug: z.string(),
   description: z.nullable(z.string()),
   parentCategoryId: z.nullable(z.string()),
   productCount: z.number().int(),
   active: z.boolean(),
-  childCategories: z.nullable(
-    z.array(z.lazy(() => ChildCategories$outboundSchema)),
-  ),
+  childCategories: z.nullable(z.array(Category$outboundSchema)),
 }).transform((v) => {
   return remap$(v, {
     parentCategoryId: "parent_category_id",

package/src/models/components/productdetail.ts

@@ -91,7 +91,7 @@ export type ProductDetail = {
   id: string;
   sku: string | null;
   name: string;
-  slug: string | null;
+  slug: string;
   shortDescription: string | null;
   productType: ProductDetailProductType;
   active: boolean;
@@ -176,7 +176,7 @@ export const ProductDetail$inboundSchema: z.ZodType<
   id: z.string(),
   sku: z.nullable(z.string()),
   name: z.string(),
-  slug: z.nullable(z.string()),
+  slug: z.string(),
   short_description: z.nullable(z.string()),
   product_type: ProductDetailProductType$inboundSchema,
   active: z.boolean(),
@@ -230,7 +230,7 @@ export type ProductDetail$Outbound = {
   id: string;
   sku: string | null;
   name: string;
-  slug: string | null;
+  slug: string;
   short_description: string | null;
   product_type: string;
   active: boolean;
@@ -270,7 +270,7 @@ export const ProductDetail$outboundSchema: z.ZodType<
   id: z.string(),
   sku: z.nullable(z.string()),
   name: z.string(),
-  slug: z.nullable(z.string()),
+  slug: z.string(),
   shortDescription: z.nullable(z.string()),
   productType: ProductDetailProductType$outboundSchema,
   active: z.boolean(),

package/src/models/components/productpricing.ts

@@ -5,18 +5,12 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const TaxType = {
-  Gst: "GST",
-} as const;
-export type TaxType = ClosedEnum<typeof TaxType>;
-
 export type ProductPricing = {
   currency: string;
-  taxType: TaxType;
+  taxType?: "GST" | undefined;
   taxRate: number;
   priceIncludingTax: boolean;
   listingPrice: number;
@@ -27,25 +21,6 @@ export type ProductPricing = {
   sellingPriceExcludingTax: number;
 };
 
-/** @internal */
-export const TaxType$inboundSchema: z.ZodNativeEnum<typeof TaxType> = z
-  .nativeEnum(TaxType);
-
-/** @internal */
-export const TaxType$outboundSchema: z.ZodNativeEnum<typeof TaxType> =
-  TaxType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace TaxType$ {
-  /** @deprecated use `TaxType$inboundSchema` instead. */
-  export const inboundSchema = TaxType$inboundSchema;
-  /** @deprecated use `TaxType$outboundSchema` instead. */
-  export const outboundSchema = TaxType$outboundSchema;
-}
-
 /** @internal */
 export const ProductPricing$inboundSchema: z.ZodType<
   ProductPricing,
@@ -53,7 +28,7 @@ export const ProductPricing$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   currency: z.string(),
-  tax_type: TaxType$inboundSchema,
+  tax_type: z.literal("GST").optional(),
   tax_rate: z.number(),
   price_including_tax: z.boolean(),
   listing_price: z.number(),
@@ -79,7 +54,7 @@ export const ProductPricing$inboundSchema: z.ZodType<
 /** @internal */
 export type ProductPricing$Outbound = {
   currency: string;
-  tax_type: string;
+  tax_type: "GST";
   tax_rate: number;
   price_including_tax: boolean;
   listing_price: number;
@@ -97,7 +72,7 @@ export const ProductPricing$outboundSchema: z.ZodType<
   ProductPricing
 > = z.object({
   currency: z.string(),
-  taxType: TaxType$outboundSchema,
+  taxType: z.literal("GST").default("GST" as const),
   taxRate: z.number(),
   priceIncludingTax: z.boolean(),
   listingPrice: z.number(),

package/src/models/components/searchproduct.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Payload for searching products.
+ */
+export type SearchProduct = {
+  /**
+   * String for searching products, considers the first ten words of any given search query.
+   */
+  query: string;
+  /**
+   * To request a specific page of results.
+   */
+  page?: number | undefined;
+  /**
+   * Maximum number of records returned for a page.
+   */
+  limit?: number | undefined;
+  /**
+   * to return pricing, promotion and subscriptions data for a specific customer group. Otherwise it will return data as per default customer group.
+   */
+  customerGroupId?: string | undefined;
+  /**
+   * provide list of attributes for specific facets or * for all facets.
+   *
+   * @remarks
+   * ```json
+   * For specific facets: ["size", "color", "brand"]
+   * ```
+   * ```json
+   * For all facets: ["*"]
+   * ```
+   */
+  facets?: Array<string> | undefined;
+};
+
+/** @internal */
+export const SearchProduct$inboundSchema: z.ZodType<
+  SearchProduct,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  query: z.string(),
+  page: z.number().int().default(1),
+  limit: z.number().int().default(25),
+  customer_group_id: z.string().optional(),
+  facets: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "customer_group_id": "customerGroupId",
+  });
+});
+
+/** @internal */
+export type SearchProduct$Outbound = {
+  query: string;
+  page: number;
+  limit: number;
+  customer_group_id?: string | undefined;
+  facets?: Array<string> | undefined;
+};
+
+/** @internal */
+export const SearchProduct$outboundSchema: z.ZodType<
+  SearchProduct$Outbound,
+  z.ZodTypeDef,
+  SearchProduct
+> = z.object({
+  query: z.string(),
+  page: z.number().int().default(1),
+  limit: z.number().int().default(25),
+  customerGroupId: z.string().optional(),
+  facets: z.array(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    customerGroupId: "customer_group_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchProduct$ {
+  /** @deprecated use `SearchProduct$inboundSchema` instead. */
+  export const inboundSchema = SearchProduct$inboundSchema;
+  /** @deprecated use `SearchProduct$outboundSchema` instead. */
+  export const outboundSchema = SearchProduct$outboundSchema;
+  /** @deprecated use `SearchProduct$Outbound` instead. */
+  export type Outbound = SearchProduct$Outbound;
+}
+
+export function searchProductToJSON(searchProduct: SearchProduct): string {
+  return JSON.stringify(SearchProduct$outboundSchema.parse(searchProduct));
+}
+
+export function searchProductFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchProduct, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchProduct$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchProduct' from JSON`,
+  );
+}

package/src/models/components/seo.ts

@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type Seo = {
-  slug: string | null;
+  slug: string;
   title: string | null;
   description: string | null;
   keywords: Array<string> | null;
@@ -17,7 +17,7 @@ export type Seo = {
 /** @internal */
 export const Seo$inboundSchema: z.ZodType<Seo, z.ZodTypeDef, unknown> = z
   .object({
-    slug: z.nullable(z.string()),
+    slug: z.string(),
     title: z.nullable(z.string()),
     description: z.nullable(z.string()),
     keywords: z.nullable(z.array(z.string())),
@@ -25,7 +25,7 @@ export const Seo$inboundSchema: z.ZodType<Seo, z.ZodTypeDef, unknown> = z
 
 /** @internal */
 export type Seo$Outbound = {
-  slug: string | null;
+  slug: string;
   title: string | null;
   description: string | null;
   keywords: Array<string> | null;
@@ -34,7 +34,7 @@ export type Seo$Outbound = {
 /** @internal */
 export const Seo$outboundSchema: z.ZodType<Seo$Outbound, z.ZodTypeDef, Seo> = z
   .object({
-    slug: z.nullable(z.string()),
+    slug: z.string(),
     title: z.nullable(z.string()),
     description: z.nullable(z.string()),
     keywords: z.nullable(z.array(z.string())),

package/src/models/components/sku.ts

@@ -56,7 +56,7 @@ export type Sku = {
   productId: string;
   variantId: string | null;
   sku: string;
-  slug: string | null;
+  slug: string;
   productName: string;
   variantName: string | null;
   productType: SKUProductType;
@@ -108,7 +108,7 @@ export const Sku$inboundSchema: z.ZodType<Sku, z.ZodTypeDef, unknown> = z
     product_id: z.string(),
     variant_id: z.nullable(z.string()),
     sku: z.string(),
-    slug: z.nullable(z.string()),
+    slug: z.string(),
     product_name: z.string(),
     variant_name: z.nullable(z.string()),
     product_type: SKUProductType$inboundSchema,
@@ -152,7 +152,7 @@ export type Sku$Outbound = {
   product_id: string;
   variant_id: string | null;
   sku: string;
-  slug: string | null;
+  slug: string;
   product_name: string;
   variant_name: string | null;
   product_type: string;
@@ -180,7 +180,7 @@ export const Sku$outboundSchema: z.ZodType<Sku$Outbound, z.ZodTypeDef, Sku> = z
     productId: z.string(),
     variantId: z.nullable(z.string()),
     sku: z.string(),
-    slug: z.nullable(z.string()),
+    slug: z.string(),
     productName: z.string(),
     variantName: z.nullable(z.string()),
     productType: SKUProductType$outboundSchema,

package/src/models/components/variant.ts

@@ -51,7 +51,7 @@ export type Variant = {
    * variant sku
    */
   sku: string | null;
-  slug: string | null;
+  slug: string;
   /**
    * variant name
    */
@@ -89,7 +89,7 @@ export const Variant$inboundSchema: z.ZodType<Variant, z.ZodTypeDef, unknown> =
     id: z.string(),
     product_id: z.string(),
     sku: z.nullable(z.string()),
-    slug: z.nullable(z.string()),
+    slug: z.string(),
     name: z.string(),
     product_name: z.string(),
     short_description: z.nullable(z.string()),
@@ -123,7 +123,7 @@ export type Variant$Outbound = {
   id: string;
   product_id: string;
   sku: string | null;
-  slug: string | null;
+  slug: string;
   name: string;
   product_name: string;
   short_description: string | null;
@@ -149,7 +149,7 @@ export const Variant$outboundSchema: z.ZodType<
   id: z.string(),
   productId: z.string(),
   sku: z.nullable(z.string()),
-  slug: z.nullable(z.string()),
+  slug: z.string(),
   name: z.string(),
   productName: z.string(),
   shortDescription: z.nullable(z.string()),

package/src/models/components/variantdetail.ts

@@ -91,7 +91,7 @@ export type VariantDetail = {
    * variant sku
    */
   sku: string | null;
-  slug: string | null;
+  slug: string;
   /**
    * variant name
    */
@@ -167,7 +167,7 @@ export const VariantDetail$inboundSchema: z.ZodType<
   id: z.string(),
   product_id: z.string(),
   sku: z.nullable(z.string()),
-  slug: z.nullable(z.string()),
+  slug: z.string(),
   name: z.string(),
   product_name: z.string(),
   short_description: z.nullable(z.string()),
@@ -223,7 +223,7 @@ export type VariantDetail$Outbound = {
   id: string;
   product_id: string;
   sku: string | null;
-  slug: string | null;
+  slug: string;
   name: string;
   product_name: string;
   short_description: string | null;
@@ -263,7 +263,7 @@ export const VariantDetail$outboundSchema: z.ZodType<
   id: z.string(),
   productId: z.string(),
   sku: z.nullable(z.string()),
-  slug: z.nullable(z.string()),
+  slug: z.string(),
   name: z.string(),
   productName: z.string(),
   shortDescription: z.nullable(z.string()),