shred-api-client 2.11.4 → 2.12.0

package/dist/index.d.ts

@@ -4452,6 +4452,49 @@ declare const ScoreMetricSchema: z.ZodObject<{
         key: string;
     } | undefined;
 }>;
+/** The month's score as if it had ended on `day`. The last point equals the month's value. */
+declare const ScoreDaySchema: z.ZodObject<{
+    day: z.ZodNumber;
+    value: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    day: number;
+}, {
+    value: number;
+    day: number;
+}>;
+/** The month before, for the day-by-day chart. `value` is the score `trend` is measured from. */
+declare const ScoreComparisonSchema: z.ZodObject<{
+    period: z.ZodString;
+    periodLabel: z.ZodString;
+    value: z.ZodNumber;
+    daily: z.ZodArray<z.ZodObject<{
+        day: z.ZodNumber;
+        value: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        day: number;
+    }, {
+        value: number;
+        day: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    daily: {
+        value: number;
+        day: number;
+    }[];
+    value: number;
+    period: string;
+    periodLabel: string;
+}, {
+    daily: {
+        value: number;
+        day: number;
+    }[];
+    value: number;
+    period: string;
+    periodLabel: string;
+}>;
 declare const ScoreSchema: z.ZodObject<{
     value: z.ZodNumber;
     hasData: z.ZodBoolean;
@@ -4548,11 +4591,54 @@ declare const ScoreSchema: z.ZodObject<{
             key: string;
         } | undefined;
     }>, "many">;
+    /** Served on the recap's `current` only. */
+    daily: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        day: z.ZodNumber;
+        value: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        value: number;
+        day: number;
+    }, {
+        value: number;
+        day: number;
+    }>, "many">>;
+    /** Absent when the month before predates the customer's first project. */
+    comparison: z.ZodOptional<z.ZodObject<{
+        period: z.ZodString;
+        periodLabel: z.ZodString;
+        value: z.ZodNumber;
+        daily: z.ZodArray<z.ZodObject<{
+            day: z.ZodNumber;
+            value: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            value: number;
+            day: number;
+        }, {
+            value: number;
+            day: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        daily: {
+            value: number;
+            day: number;
+        }[];
+        value: number;
+        period: string;
+        periodLabel: string;
+    }, {
+        daily: {
+            value: number;
+            day: number;
+        }[];
+        value: number;
+        period: string;
+        periodLabel: string;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     value: number;
-    hasData: boolean;
     period: string;
     periodLabel: string;
+    hasData: boolean;
     computedAt: number;
     metrics: {
         value: number;
@@ -4568,6 +4654,10 @@ declare const ScoreSchema: z.ZodObject<{
             key: string;
         } | undefined;
     }[];
+    daily?: {
+        value: number;
+        day: number;
+    }[] | undefined;
     band?: {
         label: string;
         min: number;
@@ -4582,11 +4672,20 @@ declare const ScoreSchema: z.ZodObject<{
     } | undefined;
     pointsToNextBand?: number | undefined;
     trend?: number | undefined;
+    comparison?: {
+        daily: {
+            value: number;
+            day: number;
+        }[];
+        value: number;
+        period: string;
+        periodLabel: string;
+    } | undefined;
 }, {
     value: number;
-    hasData: boolean;
     period: string;
     periodLabel: string;
+    hasData: boolean;
     computedAt: number;
     metrics: {
         value: number;
@@ -4602,6 +4701,10 @@ declare const ScoreSchema: z.ZodObject<{
             key: string;
         } | undefined;
     }[];
+    daily?: {
+        value: number;
+        day: number;
+    }[] | undefined;
     band?: {
         label: string;
         min: number;
@@ -4616,6 +4719,15 @@ declare const ScoreSchema: z.ZodObject<{
     } | undefined;
     pointsToNextBand?: number | undefined;
     trend?: number | undefined;
+    comparison?: {
+        daily: {
+            value: number;
+            day: number;
+        }[];
+        value: number;
+        period: string;
+        periodLabel: string;
+    } | undefined;
 }>;
 declare const ScoreHistoryEntrySchema: z.ZodObject<{
     period: z.ZodString;
@@ -4755,11 +4867,54 @@ declare const ScoreRecapSchema: z.ZodObject<{
                 key: string;
             } | undefined;
         }>, "many">;
+        /** Served on the recap's `current` only. */
+        daily: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            day: z.ZodNumber;
+            value: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            value: number;
+            day: number;
+        }, {
+            value: number;
+            day: number;
+        }>, "many">>;
+        /** Absent when the month before predates the customer's first project. */
+        comparison: z.ZodOptional<z.ZodObject<{
+            period: z.ZodString;
+            periodLabel: z.ZodString;
+            value: z.ZodNumber;
+            daily: z.ZodArray<z.ZodObject<{
+                day: z.ZodNumber;
+                value: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                value: number;
+                day: number;
+            }, {
+                value: number;
+                day: number;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            daily: {
+                value: number;
+                day: number;
+            }[];
+            value: number;
+            period: string;
+            periodLabel: string;
+        }, {
+            daily: {
+                value: number;
+                day: number;
+            }[];
+            value: number;
+            period: string;
+            periodLabel: string;
+        }>>;
     }, "strip", z.ZodTypeAny, {
         value: number;
-        hasData: boolean;
         period: string;
         periodLabel: string;
+        hasData: boolean;
         computedAt: number;
         metrics: {
             value: number;
@@ -4775,6 +4930,10 @@ declare const ScoreRecapSchema: z.ZodObject<{
                 key: string;
             } | undefined;
         }[];
+        daily?: {
+            value: number;
+            day: number;
+        }[] | undefined;
         band?: {
             label: string;
             min: number;
@@ -4789,11 +4948,20 @@ declare const ScoreRecapSchema: z.ZodObject<{
         } | undefined;
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
+        comparison?: {
+            daily: {
+                value: number;
+                day: number;
+            }[];
+            value: number;
+            period: string;
+            periodLabel: string;
+        } | undefined;
     }, {
         value: number;
-        hasData: boolean;
         period: string;
         periodLabel: string;
+        hasData: boolean;
         computedAt: number;
         metrics: {
             value: number;
@@ -4809,6 +4977,10 @@ declare const ScoreRecapSchema: z.ZodObject<{
                 key: string;
             } | undefined;
         }[];
+        daily?: {
+            value: number;
+            day: number;
+        }[] | undefined;
         band?: {
             label: string;
             min: number;
@@ -4823,6 +4995,15 @@ declare const ScoreRecapSchema: z.ZodObject<{
         } | undefined;
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
+        comparison?: {
+            daily: {
+                value: number;
+                day: number;
+            }[];
+            value: number;
+            period: string;
+            periodLabel: string;
+        } | undefined;
     }>;
     /** Oldest first. Months before the customer's first project are absent, not zero. */
     history: z.ZodArray<z.ZodObject<{
@@ -4866,6 +5047,9 @@ declare const ScoreRecapSchema: z.ZodObject<{
             key: string;
         } | undefined;
     }>, "many">;
+    /** The neighbouring months that can be opened, taken from `history`. Absent at either edge. */
+    previousPeriod: z.ZodOptional<z.ZodString>;
+    nextPeriod: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     history: {
         value: number;
@@ -4880,9 +5064,9 @@ declare const ScoreRecapSchema: z.ZodObject<{
     }[];
     current: {
         value: number;
-        hasData: boolean;
         period: string;
         periodLabel: string;
+        hasData: boolean;
         computedAt: number;
         metrics: {
             value: number;
@@ -4898,6 +5082,10 @@ declare const ScoreRecapSchema: z.ZodObject<{
                 key: string;
             } | undefined;
         }[];
+        daily?: {
+            value: number;
+            day: number;
+        }[] | undefined;
         band?: {
             label: string;
             min: number;
@@ -4912,7 +5100,18 @@ declare const ScoreRecapSchema: z.ZodObject<{
         } | undefined;
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
+        comparison?: {
+            daily: {
+                value: number;
+                day: number;
+            }[];
+            value: number;
+            period: string;
+            periodLabel: string;
+        } | undefined;
     };
+    previousPeriod?: string | undefined;
+    nextPeriod?: string | undefined;
 }, {
     history: {
         value: number;
@@ -4927,9 +5126,9 @@ declare const ScoreRecapSchema: z.ZodObject<{
     }[];
     current: {
         value: number;
-        hasData: boolean;
         period: string;
         periodLabel: string;
+        hasData: boolean;
         computedAt: number;
         metrics: {
             value: number;
@@ -4945,6 +5144,10 @@ declare const ScoreRecapSchema: z.ZodObject<{
                 key: string;
             } | undefined;
         }[];
+        daily?: {
+            value: number;
+            day: number;
+        }[] | undefined;
         band?: {
             label: string;
             min: number;
@@ -4959,7 +5162,92 @@ declare const ScoreRecapSchema: z.ZodObject<{
         } | undefined;
         pointsToNextBand?: number | undefined;
         trend?: number | undefined;
+        comparison?: {
+            daily: {
+                value: number;
+                day: number;
+            }[];
+            value: number;
+            period: string;
+            periodLabel: string;
+        } | undefined;
     };
+    previousPeriod?: string | undefined;
+    nextPeriod?: string | undefined;
+}>;
+declare const ScoreGoalOptionSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    target: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    label: string;
+    key: string;
+    target: number;
+}, {
+    label: string;
+    key: string;
+    target: number;
+}>;
+declare const ScoreGoalSchema: z.ZodObject<{
+    /** The goal of the month being lived. */
+    current: z.ZodNumber;
+    /** A goal chosen this month, starting on `from` (`YYYY-MM`). */
+    next: z.ZodOptional<z.ZodObject<{
+        target: z.ZodNumber;
+        from: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        from: string;
+        target: number;
+    }, {
+        from: string;
+        target: number;
+    }>>;
+    /** Projects a month over the last `averageMonths` closed months; absent when there are none. */
+    average: z.ZodOptional<z.ZodNumber>;
+    averageMonths: z.ZodNumber;
+    options: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        target: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        key: string;
+        target: number;
+    }, {
+        label: string;
+        key: string;
+        target: number;
+    }>, "many">;
+    /** The `key` of the option offered as recommended. */
+    recommended: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    options: {
+        label: string;
+        key: string;
+        target: number;
+    }[];
+    current: number;
+    averageMonths: number;
+    next?: {
+        from: string;
+        target: number;
+    } | undefined;
+    average?: number | undefined;
+    recommended?: string | undefined;
+}, {
+    options: {
+        label: string;
+        key: string;
+        target: number;
+    }[];
+    current: number;
+    averageMonths: number;
+    next?: {
+        from: string;
+        target: number;
+    } | undefined;
+    average?: number | undefined;
+    recommended?: string | undefined;
 }>;
 type ScoreMetricKey = z.infer<typeof ScoreMetricKeySchema>;
 type ScoreBand = z.infer<typeof ScoreBandSchema>;
@@ -4967,6 +5255,10 @@ type ScoreMetric = z.infer<typeof ScoreMetricSchema>;
 type Score = z.infer<typeof ScoreSchema>;
 type ScoreHistoryEntry = z.infer<typeof ScoreHistoryEntrySchema>;
 type ScoreRecap = z.infer<typeof ScoreRecapSchema>;
+type ScoreDay = z.infer<typeof ScoreDaySchema>;
+type ScoreComparison = z.infer<typeof ScoreComparisonSchema>;
+type ScoreGoalOption = z.infer<typeof ScoreGoalOptionSchema>;
+type ScoreGoal = z.infer<typeof ScoreGoalSchema>;
 
 interface IAPI$1 {
     /**
@@ -4975,17 +5267,40 @@ interface IAPI$1 {
      * and a month still being lived is rejected.
      */
     getRecap: (context: Context, period?: string) => Promise<ScoreRecap>;
+    /** The caller's monthly project goal, the options and their recent average. */
+    getGoal: (context: Context) => Promise<ScoreGoal>;
+    /**
+     * Chooses a goal, which starts next month. `target` must be one of the options;
+     * choosing the goal in effect cancels a pending one. Answers with the updated goal.
+     */
+    setGoal: (context: Context, target: number) => Promise<ScoreGoal>;
 }
 declare const Endpoints$1: {
     GetRecap: {
         uri: string;
         method: string;
     };
+    GetGoal: {
+        uri: string;
+        method: string;
+    };
+    SetGoal: {
+        uri: string;
+        method: string;
+    };
 };
 
 type index$3_Score = Score;
 type index$3_ScoreBand = ScoreBand;
 declare const index$3_ScoreBandSchema: typeof ScoreBandSchema;
+type index$3_ScoreComparison = ScoreComparison;
+declare const index$3_ScoreComparisonSchema: typeof ScoreComparisonSchema;
+type index$3_ScoreDay = ScoreDay;
+declare const index$3_ScoreDaySchema: typeof ScoreDaySchema;
+type index$3_ScoreGoal = ScoreGoal;
+type index$3_ScoreGoalOption = ScoreGoalOption;
+declare const index$3_ScoreGoalOptionSchema: typeof ScoreGoalOptionSchema;
+declare const index$3_ScoreGoalSchema: typeof ScoreGoalSchema;
 type index$3_ScoreHistoryEntry = ScoreHistoryEntry;
 declare const index$3_ScoreHistoryEntrySchema: typeof ScoreHistoryEntrySchema;
 type index$3_ScoreMetric = ScoreMetric;
@@ -4995,7 +5310,7 @@ declare const index$3_ScoreMetricSchema: typeof ScoreMetricSchema;
 declare const index$3_ScoreRecapSchema: typeof ScoreRecapSchema;
 declare const index$3_ScoreSchema: typeof ScoreSchema;
 declare namespace index$3 {
-  export { Endpoints$1 as Endpoints, type ScoreRecap as Entity, type IAPI$1 as IAPI, type index$3_Score as Score, type index$3_ScoreBand as ScoreBand, index$3_ScoreBandSchema as ScoreBandSchema, type index$3_ScoreHistoryEntry as ScoreHistoryEntry, index$3_ScoreHistoryEntrySchema as ScoreHistoryEntrySchema, type index$3_ScoreMetric as ScoreMetric, type index$3_ScoreMetricKey as ScoreMetricKey, index$3_ScoreMetricKeySchema as ScoreMetricKeySchema, index$3_ScoreMetricSchema as ScoreMetricSchema, index$3_ScoreRecapSchema as ScoreRecapSchema, index$3_ScoreSchema as ScoreSchema };
+  export { Endpoints$1 as Endpoints, type ScoreRecap as Entity, type IAPI$1 as IAPI, type index$3_Score as Score, type index$3_ScoreBand as ScoreBand, index$3_ScoreBandSchema as ScoreBandSchema, type index$3_ScoreComparison as ScoreComparison, index$3_ScoreComparisonSchema as ScoreComparisonSchema, type index$3_ScoreDay as ScoreDay, index$3_ScoreDaySchema as ScoreDaySchema, type index$3_ScoreGoal as ScoreGoal, type index$3_ScoreGoalOption as ScoreGoalOption, index$3_ScoreGoalOptionSchema as ScoreGoalOptionSchema, index$3_ScoreGoalSchema as ScoreGoalSchema, type index$3_ScoreHistoryEntry as ScoreHistoryEntry, index$3_ScoreHistoryEntrySchema as ScoreHistoryEntrySchema, type index$3_ScoreMetric as ScoreMetric, type index$3_ScoreMetricKey as ScoreMetricKey, index$3_ScoreMetricKeySchema as ScoreMetricKeySchema, index$3_ScoreMetricSchema as ScoreMetricSchema, index$3_ScoreRecapSchema as ScoreRecapSchema, index$3_ScoreSchema as ScoreSchema };
 }
 
 /**

package/dist/index.js

@@ -6286,7 +6286,9 @@ var ShredU_api_default = ShredUAPI;
 
 // src/model/score/Score.api.ts
 var Endpoints10 = {
-  GetRecap: { uri: "/score/", method: "GET" }
+  GetRecap: { uri: "/score/", method: "GET" },
+  GetGoal: { uri: "/score/goal/", method: "GET" },
+  SetGoal: { uri: "/score/goal/", method: "PUT" }
 };
 
 // src/model/score/Score.schema.ts
@@ -6316,6 +6318,16 @@ var ScoreMetricSchema = external_exports.object({
   available: external_exports.boolean(),
   rating: ScoreBandSchema.optional()
 });
+var ScoreDaySchema = external_exports.object({
+  day: external_exports.number(),
+  value: external_exports.number()
+});
+var ScoreComparisonSchema = external_exports.object({
+  period: external_exports.string(),
+  periodLabel: external_exports.string(),
+  value: external_exports.number(),
+  daily: external_exports.array(ScoreDaySchema)
+});
 var ScoreSchema = external_exports.object({
   value: external_exports.number(),
   hasData: external_exports.boolean(),
@@ -6326,7 +6338,11 @@ var ScoreSchema = external_exports.object({
   pointsToNextBand: external_exports.number().optional(),
   trend: external_exports.number().optional(),
   computedAt: external_exports.number(),
-  metrics: external_exports.array(ScoreMetricSchema)
+  metrics: external_exports.array(ScoreMetricSchema),
+  /** Served on the recap's `current` only. */
+  daily: external_exports.array(ScoreDaySchema).optional(),
+  /** Absent when the month before predates the customer's first project. */
+  comparison: ScoreComparisonSchema.optional()
 });
 var ScoreHistoryEntrySchema = external_exports.object({
   period: external_exports.string(),
@@ -6337,7 +6353,27 @@ var ScoreHistoryEntrySchema = external_exports.object({
 var ScoreRecapSchema = external_exports.object({
   current: ScoreSchema,
   /** Oldest first. Months before the customer's first project are absent, not zero. */
-  history: external_exports.array(ScoreHistoryEntrySchema)
+  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()
+});
+var ScoreGoalOptionSchema = external_exports.object({
+  key: external_exports.string(),
+  label: external_exports.string(),
+  target: external_exports.number()
+});
+var ScoreGoalSchema = external_exports.object({
+  /** The goal of the month being lived. */
+  current: external_exports.number(),
+  /** A goal chosen this month, starting on `from` (`YYYY-MM`). */
+  next: external_exports.object({ target: external_exports.number(), from: external_exports.string() }).optional(),
+  /** Projects a month over the last `averageMonths` closed months; absent when there are none. */
+  average: external_exports.number().optional(),
+  averageMonths: external_exports.number(),
+  options: external_exports.array(ScoreGoalOptionSchema),
+  /** The `key` of the option offered as recommended. */
+  recommended: external_exports.string().optional()
 });
 
 // src/api/Score.api.ts
@@ -6358,6 +6394,14 @@ var ScoreAPI = class {
       ScoreRecapSchema
     );
   }
+  async getGoal(ctx) {
+    const { uri, method } = Endpoints10.GetGoal;
+    return this.clientHTTP.makeRequest(this.env, uri, method, null, ctx, ScoreGoalSchema);
+  }
+  async setGoal(ctx, target) {
+    const { uri, method } = Endpoints10.SetGoal;
+    return this.clientHTTP.makeRequest(this.env, uri, method, { target }, ctx, ScoreGoalSchema);
+  }
 };
 var Score_api_default = ScoreAPI;
 
@@ -7165,6 +7209,10 @@ var score_exports = {};
 __export(score_exports, {
   Endpoints: () => Endpoints10,
   ScoreBandSchema: () => ScoreBandSchema,
+  ScoreComparisonSchema: () => ScoreComparisonSchema,
+  ScoreDaySchema: () => ScoreDaySchema,
+  ScoreGoalOptionSchema: () => ScoreGoalOptionSchema,
+  ScoreGoalSchema: () => ScoreGoalSchema,
   ScoreHistoryEntrySchema: () => ScoreHistoryEntrySchema,
   ScoreMetricKeySchema: () => ScoreMetricKeySchema,
   ScoreMetricSchema: () => ScoreMetricSchema,