ce-storefront 0.3.4 → 0.3.6

package/src/models/components/{skuinfo.ts → product.ts}

@@ -32,180 +32,195 @@ import {
   ProductPromotion$Outbound,
   ProductPromotion$outboundSchema,
 } from "./productpromotion.js";
-import {
-  ProductShipping,
-  ProductShipping$inboundSchema,
-  ProductShipping$Outbound,
-  ProductShipping$outboundSchema,
-} from "./productshipping.js";
 import {
   ProductSubscription,
   ProductSubscription$inboundSchema,
   ProductSubscription$Outbound,
   ProductSubscription$outboundSchema,
 } from "./productsubscription.js";
+import {
+  Variant,
+  Variant$inboundSchema,
+  Variant$Outbound,
+  Variant$outboundSchema,
+} from "./variant.js";
+import {
+  VariantOption,
+  VariantOption$inboundSchema,
+  VariantOption$Outbound,
+  VariantOption$outboundSchema,
+} from "./variantoption.js";
 
-export const SkuInfoProductType = {
+export const ProductType = {
   Physical: "physical",
   Digital: "digital",
   Bundle: "bundle",
 } as const;
-export type SkuInfoProductType = ClosedEnum<typeof SkuInfoProductType>;
+export type ProductType = ClosedEnum<typeof ProductType>;
 
-export type SkuInfo = {
-  productId?: string | undefined;
-  productName?: string | undefined;
-  variantId?: string | undefined;
-  variantName?: string | undefined;
-  productType?: SkuInfoProductType | undefined;
+export type Product = {
+  /**
+   * The ULID of the product
+   */
+  id: string;
   sku?: string | undefined;
+  name: string;
+  slug: string;
+  shortDescription?: string | undefined;
+  productType: ProductType;
+  active?: boolean | undefined;
   stockAvailable?: boolean | undefined;
-  isFeatured?: boolean | undefined;
   onOffer?: boolean | undefined;
   onSubscription?: boolean | undefined;
   onPromotion?: boolean | undefined;
-  attributes?: Array<ProductAttribute> | undefined;
-  images?: Array<ProductImage> | undefined;
-  pricing?: ProductPricing | undefined;
-  shipping?: ProductShipping | undefined;
-  tags?: Array<string> | undefined;
+  hasVariant?: boolean | undefined;
+  tags?: Array<string> | null | undefined;
   categoryIds?: Array<string> | undefined;
   reviewsRatingSum?: number | undefined;
   reviewsCount?: number | undefined;
-  promotion?: Array<ProductPromotion> | undefined;
+  attributes?: Array<ProductAttribute> | undefined;
+  pricing?: ProductPricing | undefined;
+  /**
+   * this will be used if has_variant is true, to auto set default values.
+   */
+  variantOptions?: Array<VariantOption> | null | undefined;
+  promotion?: ProductPromotion | null | undefined;
+  images?: Array<ProductImage> | undefined;
   subscription?: Array<ProductSubscription> | undefined;
+  variants?: Array<Variant> | undefined;
 };
 
 /** @internal */
-export const SkuInfoProductType$inboundSchema: z.ZodNativeEnum<
-  typeof SkuInfoProductType
-> = z.nativeEnum(SkuInfoProductType);
+export const ProductType$inboundSchema: z.ZodNativeEnum<typeof ProductType> = z
+  .nativeEnum(ProductType);
 
 /** @internal */
-export const SkuInfoProductType$outboundSchema: z.ZodNativeEnum<
-  typeof SkuInfoProductType
-> = SkuInfoProductType$inboundSchema;
+export const ProductType$outboundSchema: z.ZodNativeEnum<typeof ProductType> =
+  ProductType$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace SkuInfoProductType$ {
-  /** @deprecated use `SkuInfoProductType$inboundSchema` instead. */
-  export const inboundSchema = SkuInfoProductType$inboundSchema;
-  /** @deprecated use `SkuInfoProductType$outboundSchema` instead. */
-  export const outboundSchema = SkuInfoProductType$outboundSchema;
+export namespace ProductType$ {
+  /** @deprecated use `ProductType$inboundSchema` instead. */
+  export const inboundSchema = ProductType$inboundSchema;
+  /** @deprecated use `ProductType$outboundSchema` instead. */
+  export const outboundSchema = ProductType$outboundSchema;
 }
 
 /** @internal */
-export const SkuInfo$inboundSchema: z.ZodType<SkuInfo, z.ZodTypeDef, unknown> =
+export const Product$inboundSchema: z.ZodType<Product, z.ZodTypeDef, unknown> =
   z.object({
-    product_id: z.string().optional(),
-    product_name: z.string().optional(),
-    variant_id: z.string().optional(),
-    variant_name: z.string().optional(),
-    product_type: SkuInfoProductType$inboundSchema.optional(),
+    id: z.string(),
     sku: z.string().optional(),
+    name: z.string(),
+    slug: z.string(),
+    short_description: z.string().optional(),
+    product_type: ProductType$inboundSchema,
+    active: z.boolean().default(true),
     stock_available: z.boolean().default(true),
-    is_featured: z.boolean().default(false),
     on_offer: z.boolean().default(false),
     on_subscription: z.boolean().default(false),
     on_promotion: z.boolean().default(false),
-    attributes: z.array(ProductAttribute$inboundSchema).optional(),
-    images: z.array(ProductImage$inboundSchema).optional(),
-    pricing: ProductPricing$inboundSchema.optional(),
-    shipping: ProductShipping$inboundSchema.optional(),
-    tags: z.array(z.string()).optional(),
+    has_variant: z.boolean().default(false),
+    tags: z.nullable(z.array(z.string())).optional(),
     category_ids: z.array(z.string()).optional(),
     reviews_rating_sum: z.number().optional(),
     reviews_count: z.number().int().optional(),
-    promotion: z.array(ProductPromotion$inboundSchema).optional(),
+    attributes: z.array(ProductAttribute$inboundSchema).optional(),
+    pricing: ProductPricing$inboundSchema.optional(),
+    variant_options: z.nullable(z.array(VariantOption$inboundSchema))
+      .optional(),
+    promotion: z.nullable(ProductPromotion$inboundSchema).optional(),
+    images: z.array(ProductImage$inboundSchema).optional(),
     subscription: z.array(ProductSubscription$inboundSchema).optional(),
+    variants: z.array(Variant$inboundSchema).optional(),
   }).transform((v) => {
     return remap$(v, {
-      "product_id": "productId",
-      "product_name": "productName",
-      "variant_id": "variantId",
-      "variant_name": "variantName",
+      "short_description": "shortDescription",
       "product_type": "productType",
       "stock_available": "stockAvailable",
-      "is_featured": "isFeatured",
       "on_offer": "onOffer",
       "on_subscription": "onSubscription",
       "on_promotion": "onPromotion",
+      "has_variant": "hasVariant",
       "category_ids": "categoryIds",
       "reviews_rating_sum": "reviewsRatingSum",
       "reviews_count": "reviewsCount",
+      "variant_options": "variantOptions",
     });
   });
 
 /** @internal */
-export type SkuInfo$Outbound = {
-  product_id?: string | undefined;
-  product_name?: string | undefined;
-  variant_id?: string | undefined;
-  variant_name?: string | undefined;
-  product_type?: string | undefined;
+export type Product$Outbound = {
+  id: string;
   sku?: string | undefined;
+  name: string;
+  slug: string;
+  short_description?: string | undefined;
+  product_type: string;
+  active: boolean;
   stock_available: boolean;
-  is_featured: boolean;
   on_offer: boolean;
   on_subscription: boolean;
   on_promotion: boolean;
-  attributes?: Array<ProductAttribute$Outbound> | undefined;
-  images?: Array<ProductImage$Outbound> | undefined;
-  pricing?: ProductPricing$Outbound | undefined;
-  shipping?: ProductShipping$Outbound | undefined;
-  tags?: Array<string> | undefined;
+  has_variant: boolean;
+  tags?: Array<string> | null | undefined;
   category_ids?: Array<string> | undefined;
   reviews_rating_sum?: number | undefined;
   reviews_count?: number | undefined;
-  promotion?: Array<ProductPromotion$Outbound> | undefined;
+  attributes?: Array<ProductAttribute$Outbound> | undefined;
+  pricing?: ProductPricing$Outbound | undefined;
+  variant_options?: Array<VariantOption$Outbound> | null | undefined;
+  promotion?: ProductPromotion$Outbound | null | undefined;
+  images?: Array<ProductImage$Outbound> | undefined;
   subscription?: Array<ProductSubscription$Outbound> | undefined;
+  variants?: Array<Variant$Outbound> | undefined;
 };
 
 /** @internal */
-export const SkuInfo$outboundSchema: z.ZodType<
-  SkuInfo$Outbound,
+export const Product$outboundSchema: z.ZodType<
+  Product$Outbound,
   z.ZodTypeDef,
-  SkuInfo
+  Product
 > = z.object({
-  productId: z.string().optional(),
-  productName: z.string().optional(),
-  variantId: z.string().optional(),
-  variantName: z.string().optional(),
-  productType: SkuInfoProductType$outboundSchema.optional(),
+  id: z.string(),
   sku: z.string().optional(),
+  name: z.string(),
+  slug: z.string(),
+  shortDescription: z.string().optional(),
+  productType: ProductType$outboundSchema,
+  active: z.boolean().default(true),
   stockAvailable: z.boolean().default(true),
-  isFeatured: z.boolean().default(false),
   onOffer: z.boolean().default(false),
   onSubscription: z.boolean().default(false),
   onPromotion: z.boolean().default(false),
-  attributes: z.array(ProductAttribute$outboundSchema).optional(),
-  images: z.array(ProductImage$outboundSchema).optional(),
-  pricing: ProductPricing$outboundSchema.optional(),
-  shipping: ProductShipping$outboundSchema.optional(),
-  tags: z.array(z.string()).optional(),
+  hasVariant: z.boolean().default(false),
+  tags: z.nullable(z.array(z.string())).optional(),
   categoryIds: z.array(z.string()).optional(),
   reviewsRatingSum: z.number().optional(),
   reviewsCount: z.number().int().optional(),
-  promotion: z.array(ProductPromotion$outboundSchema).optional(),
+  attributes: z.array(ProductAttribute$outboundSchema).optional(),
+  pricing: ProductPricing$outboundSchema.optional(),
+  variantOptions: z.nullable(z.array(VariantOption$outboundSchema)).optional(),
+  promotion: z.nullable(ProductPromotion$outboundSchema).optional(),
+  images: z.array(ProductImage$outboundSchema).optional(),
   subscription: z.array(ProductSubscription$outboundSchema).optional(),
+  variants: z.array(Variant$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
-    productId: "product_id",
-    productName: "product_name",
-    variantId: "variant_id",
-    variantName: "variant_name",
+    shortDescription: "short_description",
     productType: "product_type",
     stockAvailable: "stock_available",
-    isFeatured: "is_featured",
     onOffer: "on_offer",
     onSubscription: "on_subscription",
     onPromotion: "on_promotion",
+    hasVariant: "has_variant",
     categoryIds: "category_ids",
     reviewsRatingSum: "reviews_rating_sum",
     reviewsCount: "reviews_count",
+    variantOptions: "variant_options",
   });
 });
 
@@ -213,25 +228,25 @@ export const SkuInfo$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace SkuInfo$ {
-  /** @deprecated use `SkuInfo$inboundSchema` instead. */
-  export const inboundSchema = SkuInfo$inboundSchema;
-  /** @deprecated use `SkuInfo$outboundSchema` instead. */
-  export const outboundSchema = SkuInfo$outboundSchema;
-  /** @deprecated use `SkuInfo$Outbound` instead. */
-  export type Outbound = SkuInfo$Outbound;
+export namespace Product$ {
+  /** @deprecated use `Product$inboundSchema` instead. */
+  export const inboundSchema = Product$inboundSchema;
+  /** @deprecated use `Product$outboundSchema` instead. */
+  export const outboundSchema = Product$outboundSchema;
+  /** @deprecated use `Product$Outbound` instead. */
+  export type Outbound = Product$Outbound;
 }
 
-export function skuInfoToJSON(skuInfo: SkuInfo): string {
-  return JSON.stringify(SkuInfo$outboundSchema.parse(skuInfo));
+export function productToJSON(product: Product): string {
+  return JSON.stringify(Product$outboundSchema.parse(product));
 }
 
-export function skuInfoFromJSON(
+export function productFromJSON(
   jsonString: string,
-): SafeParseResult<SkuInfo, SDKValidationError> {
+): SafeParseResult<Product, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => SkuInfo$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'SkuInfo' from JSON`,
+    (x) => Product$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Product' from JSON`,
   );
 }