shred-api-client 2.13.2 → 2.13.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -5056,21 +5056,62 @@ declare const ScoreGoalSchema: z.ZodObject<{
5056
5056
  average?: number | undefined;
5057
5057
  recommended?: string | undefined;
5058
5058
  }>;
5059
+ /** Same shape as the recap's: `weight` is the share the metric carries this month. */
5059
5060
  declare const ScoreProgressMetricSchema: z.ZodObject<{
5061
+ /**
5062
+ * Deliberately not the enum: a metric added API-side must not break a client that
5063
+ * predates it. Render the array generically and switch on ScoreMetricKey only where
5064
+ * a known metric needs special treatment.
5065
+ */
5060
5066
  key: z.ZodString;
5067
+ /** The share this metric actually carried, after unavailable ones were left out. */
5068
+ weight: z.ZodNumber;
5061
5069
  value: z.ZodNumber;
5062
5070
  target: z.ZodNumber;
5071
+ ratio: z.ZodNumber;
5063
5072
  available: z.ZodBoolean;
5073
+ rating: z.ZodOptional<z.ZodObject<{
5074
+ key: z.ZodString;
5075
+ label: z.ZodString;
5076
+ min: z.ZodNumber;
5077
+ max: z.ZodNumber;
5078
+ }, "strip", z.ZodTypeAny, {
5079
+ label: string;
5080
+ min: number;
5081
+ max: number;
5082
+ key: string;
5083
+ }, {
5084
+ label: string;
5085
+ min: number;
5086
+ max: number;
5087
+ key: string;
5088
+ }>>;
5064
5089
  }, "strip", z.ZodTypeAny, {
5065
5090
  value: number;
5066
5091
  key: string;
5067
5092
  target: number;
5093
+ weight: number;
5094
+ ratio: number;
5068
5095
  available: boolean;
5096
+ rating?: {
5097
+ label: string;
5098
+ min: number;
5099
+ max: number;
5100
+ key: string;
5101
+ } | undefined;
5069
5102
  }, {
5070
5103
  value: number;
5071
5104
  key: string;
5072
5105
  target: number;
5106
+ weight: number;
5107
+ ratio: number;
5073
5108
  available: boolean;
5109
+ rating?: {
5110
+ label: string;
5111
+ min: number;
5112
+ max: number;
5113
+ key: string;
5114
+ } | undefined;
5074
5115
  }>;
5075
5116
  declare const ScoreProjectionSchema: z.ZodObject<{
5076
5117
  value: z.ZodNumber;
@@ -5188,20 +5229,60 @@ declare const ScoreProgressSchema: z.ZodObject<{
5188
5229
  } | undefined;
5189
5230
  }>>;
5190
5231
  metrics: z.ZodArray<z.ZodObject<{
5232
+ /**
5233
+ * Deliberately not the enum: a metric added API-side must not break a client that
5234
+ * predates it. Render the array generically and switch on ScoreMetricKey only where
5235
+ * a known metric needs special treatment.
5236
+ */
5191
5237
  key: z.ZodString;
5238
+ /** The share this metric actually carried, after unavailable ones were left out. */
5239
+ weight: z.ZodNumber;
5192
5240
  value: z.ZodNumber;
5193
5241
  target: z.ZodNumber;
5242
+ ratio: z.ZodNumber;
5194
5243
  available: z.ZodBoolean;
5244
+ rating: z.ZodOptional<z.ZodObject<{
5245
+ key: z.ZodString;
5246
+ label: z.ZodString;
5247
+ min: z.ZodNumber;
5248
+ max: z.ZodNumber;
5249
+ }, "strip", z.ZodTypeAny, {
5250
+ label: string;
5251
+ min: number;
5252
+ max: number;
5253
+ key: string;
5254
+ }, {
5255
+ label: string;
5256
+ min: number;
5257
+ max: number;
5258
+ key: string;
5259
+ }>>;
5195
5260
  }, "strip", z.ZodTypeAny, {
5196
5261
  value: number;
5197
5262
  key: string;
5198
5263
  target: number;
5264
+ weight: number;
5265
+ ratio: number;
5199
5266
  available: boolean;
5267
+ rating?: {
5268
+ label: string;
5269
+ min: number;
5270
+ max: number;
5271
+ key: string;
5272
+ } | undefined;
5200
5273
  }, {
5201
5274
  value: number;
5202
5275
  key: string;
5203
5276
  target: number;
5277
+ weight: number;
5278
+ ratio: number;
5204
5279
  available: boolean;
5280
+ rating?: {
5281
+ label: string;
5282
+ min: number;
5283
+ max: number;
5284
+ key: string;
5285
+ } | undefined;
5205
5286
  }>, "many">;
5206
5287
  history: z.ZodArray<z.ZodObject<{
5207
5288
  period: z.ZodString;
@@ -5265,7 +5346,15 @@ declare const ScoreProgressSchema: z.ZodObject<{
5265
5346
  value: number;
5266
5347
  key: string;
5267
5348
  target: number;
5349
+ weight: number;
5350
+ ratio: number;
5268
5351
  available: boolean;
5352
+ rating?: {
5353
+ label: string;
5354
+ min: number;
5355
+ max: number;
5356
+ key: string;
5357
+ } | undefined;
5269
5358
  }[];
5270
5359
  day: number;
5271
5360
  daysInMonth: number;
@@ -5312,7 +5401,15 @@ declare const ScoreProgressSchema: z.ZodObject<{
5312
5401
  value: number;
5313
5402
  key: string;
5314
5403
  target: number;
5404
+ weight: number;
5405
+ ratio: number;
5315
5406
  available: boolean;
5407
+ rating?: {
5408
+ label: string;
5409
+ min: number;
5410
+ max: number;
5411
+ key: string;
5412
+ } | undefined;
5316
5413
  }[];
5317
5414
  day: number;
5318
5415
  daysInMonth: number;
package/dist/index.js CHANGED
@@ -6376,12 +6376,7 @@ var ScoreGoalSchema = external_exports.object({
6376
6376
  /** The `key` of the option offered as recommended. */
6377
6377
  recommended: external_exports.string().optional()
6378
6378
  });
6379
- var ScoreProgressMetricSchema = external_exports.object({
6380
- key: external_exports.string(),
6381
- value: external_exports.number(),
6382
- target: external_exports.number(),
6383
- available: external_exports.boolean()
6384
- });
6379
+ var ScoreProgressMetricSchema = ScoreMetricSchema;
6385
6380
  var ScoreProjectionSchema = external_exports.object({
6386
6381
  value: external_exports.number(),
6387
6382
  band: ScoreBandSchema.optional()