@anuragpal02/zcl-contracts 0.48.0 → 0.50.0

package/dist/common.d.ts

@@ -1,12 +1,31 @@
 import { z } from 'zod';
 export declare const idSchema: z.ZodString;
 export declare const isoDateSchema: z.ZodString;
+/**
+ * The machine-readable reason a request failed.
+ *
+ * These are the ONLY values a caller may branch on, and — because a UI turns a code
+ * into a sentence — each one has to mean a single thing. Two unrelated failures
+ * sharing a code produce a screen that lies:
+ *
+ * `POST /projects/:id/smart-video` used to answer 409 `conflict` both when another
+ * session had edited the wall AND when some panels simply had no image yet. The web
+ * app maps `conflict` to "Someone else changed this while you were working on it.
+ * Reload and try again." — advice that was useless in the second case, because
+ * reloading does not generate a missing still. `precondition_failed` exists to split
+ * those two apart.
+ *
+ * Adding a member is safe for consumers: both the web app and the BFF fall back to a
+ * generic sentence for a code they do not recognise, so an old client shows something
+ * vague rather than crashing. It is NOT safe to remove or rename one.
+ */
 export declare const apiErrorCodeSchema: z.ZodEnum<{
     bad_request: "bad_request";
     unauthorized: "unauthorized";
     forbidden: "forbidden";
     payment_required: "payment_required";
     conflict: "conflict";
+    precondition_failed: "precondition_failed";
     not_found: "not_found";
     validation_failed: "validation_failed";
     rate_limited: "rate_limited";
@@ -21,6 +40,7 @@ export declare const errorResponseSchema: z.ZodObject<{
             forbidden: "forbidden";
             payment_required: "payment_required";
             conflict: "conflict";
+            precondition_failed: "precondition_failed";
             not_found: "not_found";
             validation_failed: "validation_failed";
             rate_limited: "rate_limited";

package/dist/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,QAAQ,aAAoB,CAAA;AACzC,eAAO,MAAM,aAAa,aAAwB,CAAA;AAElD,eAAO,MAAM,kBAAkB;;;;;;;;;;;EAW7B,CAAA;AAEF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;iBAM9B,CAAA;AAEF,eAAO,MAAM,gBAAgB;;iBAE3B,CAAA;AAEF,wBAAgB,gBAAgB,CAAC,OAAO,SAAS,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO;;kBAE1E;AAED,wBAAgB,kBAAkB,CAAC,OAAO,SAAS,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO;;;;;kBAKhF;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAC7D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAC/D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,QAAQ,aAAoB,CAAA;AACzC,eAAO,MAAM,aAAa,aAAwB,CAAA;AAElD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAyB7B,CAAA;AAEF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;iBAM9B,CAAA;AAEF,eAAO,MAAM,gBAAgB;;iBAE3B,CAAA;AAEF,wBAAgB,gBAAgB,CAAC,OAAO,SAAS,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO;;kBAE1E;AAED,wBAAgB,kBAAkB,CAAC,OAAO,SAAS,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO;;;;;kBAKhF;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAC7D,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAC/D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}

package/dist/common.js

@@ -1,12 +1,44 @@
 import { z } from 'zod';
 export const idSchema = z.string().uuid();
 export const isoDateSchema = z.string().datetime();
+/**
+ * The machine-readable reason a request failed.
+ *
+ * These are the ONLY values a caller may branch on, and — because a UI turns a code
+ * into a sentence — each one has to mean a single thing. Two unrelated failures
+ * sharing a code produce a screen that lies:
+ *
+ * `POST /projects/:id/smart-video` used to answer 409 `conflict` both when another
+ * session had edited the wall AND when some panels simply had no image yet. The web
+ * app maps `conflict` to "Someone else changed this while you were working on it.
+ * Reload and try again." — advice that was useless in the second case, because
+ * reloading does not generate a missing still. `precondition_failed` exists to split
+ * those two apart.
+ *
+ * Adding a member is safe for consumers: both the web app and the BFF fall back to a
+ * generic sentence for a code they do not recognise, so an old client shows something
+ * vague rather than crashing. It is NOT safe to remove or rename one.
+ */
 export const apiErrorCodeSchema = z.enum([
     'bad_request',
     'unauthorized',
     'forbidden',
     'payment_required',
+    /**
+     * The resource changed underneath you: the version you loaded is no longer current.
+     * "Reload and try again" is honest advice, because reloading genuinely fixes it.
+     * Examples: a stale LED-map version, a guideline set edited since it was read.
+     */
     'conflict',
+    /**
+     * The resource exists and you may act on it, but it is not in a state that permits
+     * this operation yet. Reloading does NOT help — something has to be done first, and
+     * the accompanying `message` names it.
+     *
+     * Examples: panels that still have no generated still, a master job that has not
+     * finished, a reservation already captured.
+     */
+    'precondition_failed',
     'not_found',
     'validation_failed',
     'rate_limited',

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export * from './client.js';
 export * from './common.js';
 export * from './collection.js';
 export * from './credits.js';
+export * from './pricing.js';
 export * from './frame-iterator.js';
 export * from './generation.js';
 export * from './guidelines.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,cAAc,CAAA;AAC5B,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA"}

package/dist/index.js

@@ -6,6 +6,7 @@ export * from './client.js';
 export * from './common.js';
 export * from './collection.js';
 export * from './credits.js';
+export * from './pricing.js';
 export * from './frame-iterator.js';
 export * from './generation.js';
 export * from './guidelines.js';

package/dist/pricing.d.ts

@@ -0,0 +1,55 @@
+import { z } from 'zod';
+/**
+ * What the tools cost, served BY the API so a client never has to know.
+ *
+ * ── Why this exists ──────────────────────────────────────────────────────────
+ *
+ * The Loop Generator's price lived in three places: `LOOP_TOOL_CREDIT_COST` in
+ * zcl-api, a `creditsFor()` helper in the web app's hook, and a third copy as
+ * display strings in the markup. Nothing kept them in step, and they drifted — the
+ * UI quoted 250 / 1,250 while the API charged 188 / 313. At 4K that is FOUR TIMES
+ * the real price, shown to customers deciding whether they could afford it.
+ *
+ * The Frame Iterator has the identical shape (10 in the UI, 10 in the API) and is
+ * currently correct by luck rather than by construction — it drifts the moment
+ * either number moves.
+ *
+ * So the fix is not "correct the numbers", it is "have one number". The API owns
+ * the price because the API is what charges it; a client that displays a different
+ * figure is by definition wrong.
+ *
+ * ── Why it is public ─────────────────────────────────────────────────────────
+ *
+ * Both tools render for signed-out visitors, and they show the price before anyone
+ * has an account. A workspace-scoped shape could not serve that, and gating it
+ * behind auth would mean the signed-out UI going back to hardcoding — which is the
+ * bug this removes.
+ *
+ * Prices are already public information: they are on the pricing page.
+ */
+export declare const loopToolPricingSchema: z.ZodObject<{
+    '1080p': z.ZodNumber;
+    '4k': z.ZodNumber;
+}, z.core.$strip>;
+export declare const pricingSchema: z.ZodObject<{
+    loopTool: z.ZodObject<{
+        '1080p': z.ZodNumber;
+        '4k': z.ZodNumber;
+    }, z.core.$strip>;
+    frameIterationCredits: z.ZodNumber;
+    imageCredits: z.ZodNumber;
+}, z.core.$strip>;
+export declare const pricingResponseSchema: z.ZodObject<{
+    data: z.ZodObject<{
+        loopTool: z.ZodObject<{
+            '1080p': z.ZodNumber;
+            '4k': z.ZodNumber;
+        }, z.core.$strip>;
+        frameIterationCredits: z.ZodNumber;
+        imageCredits: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type LoopToolPricing = z.infer<typeof loopToolPricingSchema>;
+export type Pricing = z.infer<typeof pricingSchema>;
+export type PricingResponse = z.infer<typeof pricingResponseSchema>;
+//# sourceMappingURL=pricing.d.ts.map

package/dist/pricing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing.d.ts","sourceRoot":"","sources":["../src/pricing.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AAEF,eAAO,MAAM,aAAa;;;;;;;iBAUxB,CAAA;AAEF,eAAO,MAAM,qBAAqB;;;;;;;;;iBAAkC,CAAA;AAEpE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AACnE,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AACnD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA"}

package/dist/pricing.js

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+import { apiSuccessSchema } from './common.js';
+/**
+ * What the tools cost, served BY the API so a client never has to know.
+ *
+ * ── Why this exists ──────────────────────────────────────────────────────────
+ *
+ * The Loop Generator's price lived in three places: `LOOP_TOOL_CREDIT_COST` in
+ * zcl-api, a `creditsFor()` helper in the web app's hook, and a third copy as
+ * display strings in the markup. Nothing kept them in step, and they drifted — the
+ * UI quoted 250 / 1,250 while the API charged 188 / 313. At 4K that is FOUR TIMES
+ * the real price, shown to customers deciding whether they could afford it.
+ *
+ * The Frame Iterator has the identical shape (10 in the UI, 10 in the API) and is
+ * currently correct by luck rather than by construction — it drifts the moment
+ * either number moves.
+ *
+ * So the fix is not "correct the numbers", it is "have one number". The API owns
+ * the price because the API is what charges it; a client that displays a different
+ * figure is by definition wrong.
+ *
+ * ── Why it is public ─────────────────────────────────────────────────────────
+ *
+ * Both tools render for signed-out visitors, and they show the price before anyone
+ * has an account. A workspace-scoped shape could not serve that, and gating it
+ * behind auth would mean the signed-out UI going back to hardcoding — which is the
+ * bug this removes.
+ *
+ * Prices are already public information: they are on the pricing page.
+ */
+export const loopToolPricingSchema = z.object({
+    '1080p': z.number().int().positive(),
+    '4k': z.number().int().positive()
+});
+export const pricingSchema = z.object({
+    /** Standalone Loop Generator, keyed by the output resolution the user picks. */
+    loopTool: loopToolPricingSchema,
+    /** Frame Iterator, charged per variation — the client multiplies by the count. */
+    frameIterationCredits: z.number().int().positive(),
+    /**
+     * A single generated image: one concept variation, one panel, one edit. The wall
+     * flows multiply this by their own panel counts, which the client already knows.
+     */
+    imageCredits: z.number().int().positive()
+});
+export const pricingResponseSchema = apiSuccessSchema(pricingSchema);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anuragpal02/zcl-contracts",
-  "version": "0.48.0",
+  "version": "0.50.0",
   "private": false,
   "type": "module",
   "main": "./dist/index.js",