@pd4castr/cli 1.5.0 → 1.7.0

package/dist/index.js

@@ -94,6 +94,62 @@ var inputAggregationSchema = z.object({
   description: z.string().optional().default(""),
   colours: z.array(z.string()).optional().default([])
 });
+var performanceMetricsOptionValueEntrySchema = z.object({
+  label: z.string(),
+  key: z.string()
+});
+var performanceMetricsSelectOptionSchema = z.object({
+  label: z.string(),
+  key: z.string(),
+  type: z.literal("select"),
+  values: z.array(performanceMetricsOptionValueEntrySchema).min(1),
+  defaultValue: z.string().optional()
+});
+var performanceMetricsNumberOptionSchema = z.object({
+  label: z.string(),
+  key: z.string(),
+  type: z.literal("number"),
+  defaultValue: z.number().optional()
+});
+var performanceMetricsDateOptionSchema = z.object({
+  label: z.string(),
+  key: z.string(),
+  type: z.literal("date"),
+  defaultValue: z.string().optional(),
+  maxDate: z.string().optional()
+});
+var performanceMetricsBooleanOptionSchema = z.object({
+  label: z.string(),
+  key: z.string(),
+  type: z.literal("boolean"),
+  defaultValue: z.boolean().optional()
+});
+var performanceMetricsRangeInputOptionSchema = z.discriminatedUnion("type", [
+  performanceMetricsSelectOptionSchema,
+  performanceMetricsNumberOptionSchema,
+  performanceMetricsDateOptionSchema
+]);
+var performanceMetricsRangeOptionSchema = z.object({
+  label: z.string(),
+  key: z.string(),
+  type: z.literal("range"),
+  inputs: z.tuple([
+    performanceMetricsRangeInputOptionSchema,
+    performanceMetricsRangeInputOptionSchema
+  ])
+});
+var performanceMetricsOptionSchema = z.discriminatedUnion("type", [
+  performanceMetricsSelectOptionSchema,
+  performanceMetricsNumberOptionSchema,
+  performanceMetricsDateOptionSchema,
+  performanceMetricsBooleanOptionSchema,
+  performanceMetricsRangeOptionSchema
+]);
+var performanceMetricsSchema = z.object({
+  options: z.array(performanceMetricsOptionSchema).optional().default([]),
+  comparisonModels: z.record(z.string(), z.string()).optional().default({}),
+  query: z.string().min(1)
+});
 var CONFIG_WARNING_KEY = "// WARNING: DO NOT MODIFY THESE SYSTEM MANAGED VALUES";
 var projectConfigSchema = z.object({
   name: z.string(),
@@ -103,7 +159,8 @@ var projectConfigSchema = z.object({
   timeHorizon: z.enum([
     "day_ahead",
     "week_ahead",
-    "quarterly"
+    "quarterly",
+    "historical"
   ]),
   displayTimezone: z.string().refine(isIanaTimeZone, "invalid IANA time zone").optional().default("Australia/Brisbane"),
   metadata: z.record(z.string(), z.any()).optional(),
@@ -113,6 +170,7 @@ var projectConfigSchema = z.object({
   inputAggregations: z.array(inputAggregationSchema).optional().default([]),
   outputs: z.array(modelOutputSchema),
   sensitivities: z.array(sensitivitySchema).optional().default([]),
+  performanceMetrics: performanceMetricsSchema.nullable().optional().default(null),
   [CONFIG_WARNING_KEY]: z.string().optional().default(""),
   $$id: z.string().nullable().optional().default(null),
   $$modelGroupID: z.string().nullable().optional().default(null),
@@ -810,6 +868,7 @@ async function getModelConfigFromProjectConfig(ctx) {
   const sensitivities = await getSensitivitiesWithInlinedSQL(ctx);
   const inputAggregations = await getInputAggregationsWithInlinedSQL(ctx);
   const runDatetimeQuery = await getrunDatetimeQuerySQL(ctx);
+  const performanceMetrics = await getPerformanceMetricsWithInlinedSQL(ctx);
   const { $$id, $$modelGroupID, $$revision, $$dockerImage, ...config } = ctx.config;
   return {
     ...config,
@@ -820,7 +879,8 @@ async function getModelConfigFromProjectConfig(ctx) {
     inputs,
     sensitivities,
     inputAggregations,
-    runDatetimeQuery
+    runDatetimeQuery,
+    performanceMetrics
   };
 }
 __name(getModelConfigFromProjectConfig, "getModelConfigFromProjectConfig");
@@ -904,6 +964,22 @@ async function getrunDatetimeQuerySQL(ctx) {
   }
 }
 __name(getrunDatetimeQuerySQL, "getrunDatetimeQuerySQL");
+async function getPerformanceMetricsWithInlinedSQL(ctx) {
+  if (ctx.config.performanceMetrics === null) {
+    return null;
+  }
+  try {
+    const queryPath = path9.resolve(ctx.projectRoot, ctx.config.performanceMetrics.query);
+    const sql = await fs8.readFile(queryPath, "utf8");
+    return {
+      ...ctx.config.performanceMetrics,
+      query: sql
+    };
+  } catch {
+    throw new Error(`Performance metrics query file not found (${ctx.config.performanceMetrics.query})`);
+  }
+}
+__name(getPerformanceMetricsWithInlinedSQL, "getPerformanceMetricsWithInlinedSQL");
 
 // src/utils/log-empty-line.ts
 function logEmptyLine() {
@@ -1691,7 +1767,7 @@ import { Command } from "commander";
 // package.json
 var package_default = {
   name: "@pd4castr/cli",
-  version: "1.5.0",
+  version: "1.7.0",
   description: "CLI tool for creating, testing, and publishing pd4castr models",
   license: "UNLICENSED",
   main: "dist/index.js",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pd4castr/cli",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "CLI tool for creating, testing, and publishing pd4castr models",
   "license": "UNLICENSED",
   "main": "dist/index.js",