shred-api-client 2.13.1 → 2.13.3

package/dist/index.d.ts

@@ -5056,21 +5056,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;
@@ -5134,6 +5175,23 @@ declare const ScoreProgressSchema: z.ZodObject<{
         max: number;
         key: string;
     }>>;
+    /** The band above `band`. Absent at the top band and without data. */
+    nextBand: 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;
+    }>>;
     /** Where the month closes at the pace so far. Absent early in the month, in the first month, or with nothing to measure. */
     projection: z.ZodOptional<z.ZodObject<{
         value: z.ZodNumber;
@@ -5171,20 +5229,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;
@@ -5248,7 +5346,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;
@@ -5259,6 +5365,12 @@ declare const ScoreProgressSchema: z.ZodObject<{
         max: number;
         key: string;
     } | undefined;
+    nextBand?: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    } | undefined;
     projection?: {
         value: number;
         band?: {
@@ -5289,7 +5401,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;
@@ -5300,6 +5420,12 @@ declare const ScoreProgressSchema: z.ZodObject<{
         max: number;
         key: string;
     } | undefined;
+    nextBand?: {
+        label: string;
+        min: number;
+        max: number;
+        key: string;
+    } | undefined;
     projection?: {
         value: number;
         band?: {

package/dist/index.js

@@ -6376,12 +6376,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()
@@ -6398,6 +6393,8 @@ var ScoreProgressSchema = external_exports.object({
   value: external_exports.number(),
   hasData: external_exports.boolean(),
   band: ScoreBandSchema.optional(),
+  /** The band above `band`. Absent at the top band and without data. */
+  nextBand: ScoreBandSchema.optional(),
   /** Where the month closes at the pace so far. Absent early in the month, in the first month, or with nothing to measure. */
   projection: ScoreProjectionSchema.optional(),
   metrics: external_exports.array(ScoreProgressMetricSchema),