shred-api-client 2.13.2 → 2.13.4

package/dist/index.d.ts

@@ -4880,6 +4880,23 @@ declare const ScoreRecapSchema: z.ZodObject<{
     /** The neighbouring months that can be opened, taken from `history`. Absent at either edge. */
     previousPeriod: z.ZodOptional<z.ZodString>;
     nextPeriod: z.ZodOptional<z.ZodString>;
+    /** The whole score scale, lowest first. */
+    bands: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        min: z.ZodNumber;
+        max: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    }, {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    }>, "many">;
 }, "strip", z.ZodTypeAny, {
     history: {
         value: number;
@@ -4927,6 +4944,12 @@ declare const ScoreRecapSchema: z.ZodObject<{
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
     };
+    bands: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    }[];
     previousPeriod?: string | undefined;
     nextPeriod?: string | undefined;
 }, {
@@ -4976,6 +4999,12 @@ declare const ScoreRecapSchema: z.ZodObject<{
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
     };
+    bands: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    }[];
     previousPeriod?: string | undefined;
     nextPeriod?: string | undefined;
 }>;
@@ -5056,21 +5085,62 @@ declare const ScoreGoalSchema: z.ZodObject<{
     average?: number | undefined;
     recommended?: string | undefined;
 }>;
+/** Same shape as the recap's: `weight` is the share the metric carries this month. */
 declare const ScoreProgressMetricSchema: z.ZodObject<{
+    /**
+     * Deliberately not the enum: a metric added API-side must not break a client that
+     * predates it. Render the array generically and switch on ScoreMetricKey only where
+     * a known metric needs special treatment.
+     */
     key: z.ZodString;
+    /** The share this metric actually carried, after unavailable ones were left out. */
+    weight: z.ZodNumber;
     value: z.ZodNumber;
     target: z.ZodNumber;
+    ratio: z.ZodNumber;
     available: z.ZodBoolean;
+    rating: z.ZodOptional<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        min: z.ZodNumber;
+        max: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    }, {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     value: number;
     key: string;
     target: number;
+    weight: number;
+    ratio: number;
     available: boolean;
+    rating?: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    } | undefined;
 }, {
     value: number;
     key: string;
     target: number;
+    weight: number;
+    ratio: number;
     available: boolean;
+    rating?: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    } | undefined;
 }>;
 declare const ScoreProjectionSchema: z.ZodObject<{
     value: z.ZodNumber;
@@ -5188,20 +5258,60 @@ declare const ScoreProgressSchema: z.ZodObject<{
         } | undefined;
     }>>;
     metrics: z.ZodArray<z.ZodObject<{
+        /**
+         * Deliberately not the enum: a metric added API-side must not break a client that
+         * predates it. Render the array generically and switch on ScoreMetricKey only where
+         * a known metric needs special treatment.
+         */
         key: z.ZodString;
+        /** The share this metric actually carried, after unavailable ones were left out. */
+        weight: z.ZodNumber;
         value: z.ZodNumber;
         target: z.ZodNumber;
+        ratio: z.ZodNumber;
         available: z.ZodBoolean;
+        rating: z.ZodOptional<z.ZodObject<{
+            key: z.ZodString;
+            label: z.ZodString;
+            min: z.ZodNumber;
+            max: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        }, {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        }>>;
     }, "strip", z.ZodTypeAny, {
         value: number;
         key: string;
         target: number;
+        weight: number;
+        ratio: number;
         available: boolean;
+        rating?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
     }, {
         value: number;
         key: string;
         target: number;
+        weight: number;
+        ratio: number;
         available: boolean;
+        rating?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
     }>, "many">;
     history: z.ZodArray<z.ZodObject<{
         period: z.ZodString;
@@ -5265,7 +5375,15 @@ declare const ScoreProgressSchema: z.ZodObject<{
         value: number;
         key: string;
         target: number;
+        weight: number;
+        ratio: number;
         available: boolean;
+        rating?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
     }[];
     day: number;
     daysInMonth: number;
@@ -5312,7 +5430,15 @@ declare const ScoreProgressSchema: z.ZodObject<{
         value: number;
         key: string;
         target: number;
+        weight: number;
+        ratio: number;
         available: boolean;
+        rating?: {
+            label: string;
+            min: number;
+            max: number;
+            key: string;
+        } | undefined;
     }[];
     day: number;
     daysInMonth: number;

package/dist/index.js

@@ -6356,7 +6356,9 @@ var ScoreRecapSchema = external_exports.object({
   history: external_exports.array(ScoreHistoryEntrySchema),
   /** The neighbouring months that can be opened, taken from `history`. Absent at either edge. */
   previousPeriod: external_exports.string().optional(),
-  nextPeriod: external_exports.string().optional()
+  nextPeriod: external_exports.string().optional(),
+  /** The whole score scale, lowest first. */
+  bands: external_exports.array(ScoreBandSchema)
 });
 var ScoreGoalOptionSchema = external_exports.object({
   key: external_exports.string(),
@@ -6376,12 +6378,7 @@ var ScoreGoalSchema = external_exports.object({
   /** The `key` of the option offered as recommended. */
   recommended: external_exports.string().optional()
 });
-var ScoreProgressMetricSchema = external_exports.object({
-  key: external_exports.string(),
-  value: external_exports.number(),
-  target: external_exports.number(),
-  available: external_exports.boolean()
-});
+var ScoreProgressMetricSchema = ScoreMetricSchema;
 var ScoreProjectionSchema = external_exports.object({
   value: external_exports.number(),
   band: ScoreBandSchema.optional()