@snowcone-app/sdk 0.2.2 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.3.1
+
+### Patch Changes
+
+- [#258](https://github.com/snowcone-app/snowcone-monorepo/pull/258) [`a6d53d8`](https://github.com/snowcone-app/snowcone-monorepo/commit/a6d53d82a18d6dbbb55be4525637cd8372aed760) Thanks [@kevinsproles](https://github.com/kevinsproles)! - Move `zod` from `peerDependencies` to `dependencies`. The SDK uses zod internally (to validate catalog responses) and never asks the consumer to supply a zod schema across the API boundary, so it should bring its own zod rather than demand one as a peer. This removes the unmet-peer warning consumers saw on npm (which is on zod 4 while the SDK targets zod 3).
+
+## 0.3.0
+
+### Minor Changes
+
+- [#256](https://github.com/snowcone-app/snowcone-monorepo/pull/256) [`49f18e2`](https://github.com/snowcone-app/snowcone-monorepo/commit/49f18e221b49422e88f6aa6a06a1de153f170ff3) Thanks [@kevinsproles](https://github.com/kevinsproles)! - Surface the renderer's required-placement contract on `getProduct()`. The catalog
+  product now carries a `requiredPlacements` array — `{ label, key?, type: "image" |
+"color", autoFilledByVariant }` — so a developer can read exactly which placements
+  `renderState` will demand (and which are auto-filled from `variantId`) instead of
+  reverse-engineering it from a runtime timeout error. Image placements also no longer
+  report `type: null`; they default to `"image"`.
+
 ## 0.2.2
 
 ### Patch Changes

package/dist/index.cjs

@@ -217,6 +217,18 @@ var CatalogProductSchema = import_zod.z.object({
       offsetY: import_zod.z.number().optional()
     })
   ).optional(),
+  // The renderer's required-placement contract, surfaced by the catalog so a
+  // dev reads exactly which placements renderState will demand. Image
+  // placements + variant-auto-filled color placements. Optional — older catalog
+  // docs predate it.
+  requiredPlacements: import_zod.z.array(
+    import_zod.z.object({
+      label: import_zod.z.string(),
+      key: import_zod.z.string().optional(),
+      type: import_zod.z.enum(["image", "color"]),
+      autoFilledByVariant: import_zod.z.boolean()
+    })
+  ).optional(),
   defaultGvid: import_zod.z.string().optional()
 });
 

package/dist/index.d.cts

@@ -80,6 +80,21 @@ interface CatalogProduct$2 {
         offsetX?: number;
         offsetY?: number;
     }[];
+    /**
+     * The renderer's required-placement contract, surfaced so a developer reads exactly which placements `renderState` will demand. Image placements are always sent by the caller; color placements (autoFilledByVariant: true) are filled from `variantId` — omit them when you pass a variantId, send them otherwise.
+     */
+    requiredPlacements?: {
+        label: string;
+        /**
+         * URL-safe slug derived from `label`. Present for image placements.
+         */
+        key?: string;
+        type: 'image' | 'color';
+        /**
+         * When true, this (color) placement is auto-filled from the variant's option choice when a `variantId` is sent; otherwise the caller must send it explicitly.
+         */
+        autoFilledByVariant: boolean;
+    }[];
     defaultGvid?: string | null;
 }
 

package/dist/index.d.ts

@@ -80,6 +80,21 @@ interface CatalogProduct$2 {
         offsetX?: number;
         offsetY?: number;
     }[];
+    /**
+     * The renderer's required-placement contract, surfaced so a developer reads exactly which placements `renderState` will demand. Image placements are always sent by the caller; color placements (autoFilledByVariant: true) are filled from `variantId` — omit them when you pass a variantId, send them otherwise.
+     */
+    requiredPlacements?: {
+        label: string;
+        /**
+         * URL-safe slug derived from `label`. Present for image placements.
+         */
+        key?: string;
+        type: 'image' | 'color';
+        /**
+         * When true, this (color) placement is auto-filled from the variant's option choice when a `variantId` is sent; otherwise the caller must send it explicitly.
+         */
+        autoFilledByVariant: boolean;
+    }[];
     defaultGvid?: string | null;
 }
 

package/dist/index.js

@@ -72,6 +72,18 @@ var CatalogProductSchema = z.object({
       offsetY: z.number().optional()
     })
   ).optional(),
+  // The renderer's required-placement contract, surfaced by the catalog so a
+  // dev reads exactly which placements renderState will demand. Image
+  // placements + variant-auto-filled color placements. Optional — older catalog
+  // docs predate it.
+  requiredPlacements: z.array(
+    z.object({
+      label: z.string(),
+      key: z.string().optional(),
+      type: z.enum(["image", "color"]),
+      autoFilledByVariant: z.boolean()
+    })
+  ).optional(),
   defaultGvid: z.string().optional()
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snowcone-app/sdk",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "description": "Snowcone SDK for product mockups and print-on-demand",
   "keywords": [
     "merch",
@@ -56,7 +56,6 @@
   },
   "sideEffects": false,
   "peerDependencies": {
-    "zod": "^3.0.0",
     "react": "^18 || ^19"
   },
   "peerDependenciesMeta": {
@@ -64,14 +63,15 @@
       "optional": true
     }
   },
-  "dependencies": {},
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
   "devDependencies": {
     "@types/node": "^20.11.0",
     "@types/react": "^18.3.0",
     "tsup": "^8.1.0",
     "typescript": "^5.5.4",
     "vitest": "^2.0.5",
-    "zod": "^3.23.8",
     "@snowcone-app/mockup-url": "0.1.0"
   },
   "engines": {