@anuragpal02/zcl-contracts 0.50.0 → 0.51.0

package/dist/admin.d.ts

@@ -466,6 +466,74 @@ export type AdminJobStep = z.infer<typeof adminJobStepSchema>;
 export type AdminJobEvent = z.infer<typeof adminJobEventSchema>;
 export type AdminJobDetailResponse = z.infer<typeof adminJobDetailResponseSchema>;
 export type AdminUsageResponse = z.infer<typeof adminUsageResponseSchema>;
+/** What a captured credit was spent on: a generation job type, a frame iteration, or
+ * a capture whose reservation no longer resolves to either (`unlinked`). */
+export declare const freeCreditSpendTargetSchema: z.ZodUnion<readonly [z.ZodEnum<{
+    "image.generate": "image.generate";
+    "prompt.enhance": "prompt.enhance";
+    "image.edit": "image.edit";
+    "image.mask": "image.mask";
+    "image.export": "image.export";
+    "image.panel": "image.panel";
+    "video.loop": "video.loop";
+    "video.upscale": "video.upscale";
+    "video.smart": "video.smart";
+    "video.panel": "video.panel";
+}>, z.ZodLiteral<"frame_iteration">, z.ZodLiteral<"unlinked">]>;
+export declare const adminFreeCreditsResponseSchema: z.ZodObject<{
+    data: z.ZodObject<{
+        asOf: z.ZodString;
+        workspaces: z.ZodObject<{
+            total: z.ZodNumber;
+            neverPurchased: z.ZodNumber;
+            freeOnlyActive: z.ZodNumber;
+        }, z.core.$strip>;
+        given: z.ZodObject<{
+            signupBonus: z.ZodNumber;
+            adminTopups: z.ZodNumber;
+            total: z.ZodNumber;
+        }, z.core.$strip>;
+        purchased: z.ZodNumber;
+        otherGrants: z.ZodNumber;
+        spent: z.ZodObject<{
+            total: z.ZodNumber;
+            byFreeOnlyWorkspaces: z.ZodNumber;
+        }, z.core.$strip>;
+        freeBurnt: z.ZodObject<{
+            exact: z.ZodNumber;
+            lowerBound: z.ZodNumber;
+            upperBound: z.ZodNumber;
+        }, z.core.$strip>;
+        freeOnlySpendByType: z.ZodArray<z.ZodObject<{
+            type: z.ZodUnion<readonly [z.ZodEnum<{
+                "image.generate": "image.generate";
+                "prompt.enhance": "prompt.enhance";
+                "image.edit": "image.edit";
+                "image.mask": "image.mask";
+                "image.export": "image.export";
+                "image.panel": "image.panel";
+                "video.loop": "video.loop";
+                "video.upscale": "video.upscale";
+                "video.smart": "video.smart";
+                "video.panel": "video.panel";
+            }>, z.ZodLiteral<"frame_iteration">, z.ZodLiteral<"unlinked">]>;
+            captures: z.ZodNumber;
+            credits: z.ZodNumber;
+            estimatedUsd: z.ZodNumber;
+        }, z.core.$strip>>;
+        estimatedCostUsd: z.ZodObject<{
+            freeOnly: z.ZodNumber;
+            note: z.ZodString;
+        }, z.core.$strip>;
+        signupBonusesByMonth: z.ZodArray<z.ZodObject<{
+            month: z.ZodString;
+            bonuses: z.ZodNumber;
+            credits: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type FreeCreditSpendTarget = z.infer<typeof freeCreditSpendTargetSchema>;
+export type AdminFreeCreditsResponse = z.infer<typeof adminFreeCreditsResponseSchema>;
 export type AdminWorkspaceSummary = z.infer<typeof adminWorkspaceSummarySchema>;
 export type ListAdminWorkspacesResponse = z.infer<typeof listAdminWorkspacesResponseSchema>;
 //# sourceMappingURL=admin.d.ts.map

package/dist/admin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../src/admin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAOvB,eAAO,MAAM,sBAAsB;;;;;;;EAOjC,CAAA;AAGF,eAAO,MAAM,qBAAqB;;;;;;;iBAOjC,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;iBAQtC,CAAA;AAEF,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;iBAK7C,CAAA;AAED,eAAO,MAAM,sBAAsB;;;;;;;;iBAQjC,CAAA;AAEF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;iBAKxC,CAAA;AAGD,eAAO,MAAM,0BAA0B;;;;;;;;;;iBAKrC,CAAA;AAEF,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;iBAUzC,CAAA;AAED,eAAO,MAAM,sBAAsB;;;;;;;;;;;;iBAKjC,CAAA;AAEF,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiB9C,CAAA;AAGD,eAAO,MAAM,+BAA+B;;;iBAG1C,CAAA;AAEF,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;iBAK5C,CAAA;AAED,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AAEF,eAAO,MAAM,8BAA8B;;;;;;;;;;iBAA2C,CAAA;AAItF,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AAEF,eAAO,MAAM,6BAA6B;;;;;;;;;;iBAA2C,CAAA;AAIrF,eAAO,MAAM,qBAAqB;;;;;;;;;;iBAUhC,CAAA;AAEF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;iBAKxC,CAAA;AAED,eAAO,MAAM,oBAAoB;;;;;;EAAmE,CAAA;AAGpG,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAahC,CAAA;AAEF,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAKvC,CAAA;AAED,eAAO,MAAM,kBAAkB;;;;;;;;iBAQ7B,CAAA;AAEF,eAAO,MAAM,mBAAmB;;;;;;iBAM9B,CAAA;AAEF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMxC,CAAA;AAED,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA4CpC,CAAA;AAKD,eAAO,MAAM,yBAAyB;;;;;iBAKrC,CAAA;AAED,eAAO,MAAM,yBAAyB;;iBAEpC,CAAA;AAEF,eAAO,MAAM,0BAA0B;;;;iBAItC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC3E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC3E,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAE7E,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AACrE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AACnE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AACrE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AACjF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAC7E,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AACnF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AACrE,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAC7F,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AACvF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AACzF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AACnF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AACrF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AACjF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AACnF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AACnE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AACjF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AACnE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAC/E,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,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AACjF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AACzE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAC/E,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA"}
+{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../src/admin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAOvB,eAAO,MAAM,sBAAsB;;;;;;;EAOjC,CAAA;AAGF,eAAO,MAAM,qBAAqB;;;;;;;iBAOjC,CAAA;AAED,eAAO,MAAM,2BAA2B;;;;;;;;;;;iBAQtC,CAAA;AAEF,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;iBAK7C,CAAA;AAED,eAAO,MAAM,sBAAsB;;;;;;;;iBAQjC,CAAA;AAEF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;iBAKxC,CAAA;AAGD,eAAO,MAAM,0BAA0B;;;;;;;;;;iBAKrC,CAAA;AAEF,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;iBAUzC,CAAA;AAED,eAAO,MAAM,sBAAsB;;;;;;;;;;;;iBAKjC,CAAA;AAEF,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiB9C,CAAA;AAGD,eAAO,MAAM,+BAA+B;;;iBAG1C,CAAA;AAEF,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;iBAK5C,CAAA;AAED,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AAEF,eAAO,MAAM,8BAA8B;;;;;;;;;;iBAA2C,CAAA;AAItF,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AAEF,eAAO,MAAM,6BAA6B;;;;;;;;;;iBAA2C,CAAA;AAIrF,eAAO,MAAM,qBAAqB;;;;;;;;;;iBAUhC,CAAA;AAEF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;iBAKxC,CAAA;AAED,eAAO,MAAM,oBAAoB;;;;;;EAAmE,CAAA;AAGpG,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAahC,CAAA;AAEF,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAKvC,CAAA;AAED,eAAO,MAAM,kBAAkB;;;;;;;;iBAQ7B,CAAA;AAEF,eAAO,MAAM,mBAAmB;;;;;;iBAM9B,CAAA;AAEF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMxC,CAAA;AAED,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA4CpC,CAAA;AAKD,eAAO,MAAM,yBAAyB;;;;;iBAKrC,CAAA;AAED,eAAO,MAAM,yBAAyB;;iBAEpC,CAAA;AAEF,eAAO,MAAM,0BAA0B;;;;iBAItC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC3E,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC3E,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAE7E,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AACrE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AACnE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AACrE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AACjF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAC7E,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AACnF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AACrE,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAC7F,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AACvF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AACzF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AACnF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AACrF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AACjF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AACnF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AACnE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AACjF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AACnE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAC/E,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,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AACjF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAWzE;4EAC4E;AAC5E,eAAO,MAAM,2BAA2B;;;;;;;;;;;+DAItC,CAAA;AAEF,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA+C1C,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAC/E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AACrF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAC/E,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA"}

package/dist/admin.js

@@ -206,3 +206,60 @@ export const stepUpVerifyRequestSchema = z.object({
 export const stepUpVerifyResponseSchema = apiSuccessSchema(z.object({
     verifiedUntil: isoDateSchema
 }));
+// ─── Free credits: what ZCL has given away, and how much of it has been spent ──────
+//
+// LIFETIME figures (no window) — the question this answers is "how much have we burnt
+// on free credits so far". Free = signup bonuses + positive admin adjustments; paid =
+// Zero Store purchases. Balances are pooled per workspace, so a spent credit is not
+// labelled free or paid: `freeBurnt.exact` covers workspaces that never purchased (all
+// their spend is free), and the bounds bracket the rest by assuming free credits are
+// spent last (`lowerBound`) or first (`upperBound`).
+/** What a captured credit was spent on: a generation job type, a frame iteration, or
+ * a capture whose reservation no longer resolves to either (`unlinked`). */
+export const freeCreditSpendTargetSchema = z.union([
+    generationJobTypeSchema,
+    z.literal('frame_iteration'),
+    z.literal('unlinked')
+]);
+export const adminFreeCreditsResponseSchema = apiSuccessSchema(z.object({
+    asOf: isoDateSchema,
+    workspaces: z.object({
+        total: z.number().int(),
+        neverPurchased: z.number().int(),
+        /** Never purchased AND spent at least one credit. */
+        freeOnlyActive: z.number().int()
+    }),
+    given: z.object({
+        signupBonus: z.number().int(),
+        adminTopups: z.number().int(),
+        total: z.number().int()
+    }),
+    purchased: z.number().int(),
+    /** Grants that are neither a signup bonus nor a Zero Store order. Expected 0. */
+    otherGrants: z.number().int(),
+    spent: z.object({
+        total: z.number().int(),
+        byFreeOnlyWorkspaces: z.number().int()
+    }),
+    freeBurnt: z.object({
+        exact: z.number().int(),
+        lowerBound: z.number().int(),
+        upperBound: z.number().int()
+    }),
+    freeOnlySpendByType: z.array(z.object({
+        type: freeCreditSpendTargetSchema,
+        captures: z.number().int(),
+        credits: z.number().int(),
+        estimatedUsd: z.number()
+    })),
+    /** What the free-only spend cost ZCL in provider fees — list prices, approximate. */
+    estimatedCostUsd: z.object({
+        freeOnly: z.number(),
+        note: z.string()
+    }),
+    signupBonusesByMonth: z.array(z.object({
+        month: z.string().regex(/^\d{4}-\d{2}$/),
+        bonuses: z.number().int(),
+        credits: z.number().int()
+    }))
+}));

package/package.json

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