@pd4castr/cli 1.10.0 → 1.12.0

package/README.md

@@ -11,7 +11,7 @@
 <p>
   <a href="#installation">Installation</a> •
   <a href="#quick-start">Quick Start</a> •
-  <a href="https://github.com/pipelabs/pd4castr-model-examples/" target="_blank">Full Documentation</a>
+  <a href="https://docs.v2.pd4castr.com.au/authoring/install-the-cli">Documentation</a>
 </p>
 </div>
 
@@ -48,8 +48,3 @@ Publish your model to the pd4castr platform:
 ```sh
 pd4castr publish
 ```
-
-## Contributing
-
-See [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup, testing, and
-contribution guidelines.

package/dist/index.js

@@ -90,6 +90,7 @@ var modelInputSchema = z.union([
 ]);
 var modelOutputSchema = z.object({
   name: z.string(),
+  key: z.string().regex(/^[a-z0-9][a-z0-9_-]*$/).optional(),
   type: z.enum([
     "float",
     "integer",
@@ -103,6 +104,7 @@ var modelOutputSchema = z.object({
 });
 var sensitivitySchema = z.object({
   name: z.string(),
+  key: z.string().regex(/^[a-z0-9][a-z0-9_-]*$/).optional(),
   query: z.string()
 });
 var inputAggregationSchema = z.object({
@@ -132,10 +134,45 @@ var projectConfigSchema = z.object({
   outputs: z.array(modelOutputSchema),
   sensitivities: z.array(sensitivitySchema).optional().default([]),
   [CONFIG_WARNING_KEY]: z.string().optional().default(""),
+  $$configVersion: z.number().int().min(0).optional().default(0),
   $$id: z.string().nullable().optional().default(null),
   $$modelGroupID: z.string().nullable().optional().default(null),
   $$revision: z.number().int().min(0).nullable().optional().default(null),
   $$dockerImage: z.string().nullable().optional().default(null)
+}).superRefine((data, ctx) => {
+  if (data.$$id) {
+    return;
+  }
+  for (const [i, output] of data.outputs.entries()) {
+    if (!output.key) {
+      ctx.addIssue({
+        code: "invalid_format",
+        format: "regex",
+        pattern: "^[a-z0-9][a-z0-9_-]*$",
+        path: [
+          "outputs",
+          i,
+          "key"
+        ],
+        message: "key is required (lowercase alphanumeric with hyphens/underscores)"
+      });
+    }
+  }
+  for (const [i, sensitivity] of data.sensitivities.entries()) {
+    if (!sensitivity.key) {
+      ctx.addIssue({
+        code: "invalid_format",
+        format: "regex",
+        pattern: "^[a-z0-9][a-z0-9_-]*$",
+        path: [
+          "sensitivities",
+          i,
+          "key"
+        ],
+        message: "key is required (lowercase alphanumeric with hyphens/underscores)"
+      });
+    }
+  }
 });
 
 // src/utils/is-existing-path.ts
@@ -164,6 +201,7 @@ async function loadProjectContext(configPath) {
     const config = projectConfigSchema.parse(rawConfig);
     return {
       config,
+      configPath: resolvedConfigPath,
       projectRoot
     };
   } catch (error) {
@@ -298,9 +336,83 @@ function getEnv() {
 }
 __name(getEnv, "getEnv");
 
+// package.json
+var package_default = {
+  name: "@pd4castr/cli",
+  version: "1.12.0",
+  description: "CLI tool for creating, testing, and publishing pd4castr models",
+  license: "MIT",
+  main: "dist/index.js",
+  private: false,
+  type: "module",
+  bin: {
+    pd4castr: "dist/index.js"
+  },
+  files: [
+    "dist/**/*",
+    "LICENSE.md",
+    "docs/assets/logo.png"
+  ],
+  engines: {
+    node: ">=20.0.0"
+  },
+  scripts: {
+    build: "tsup",
+    dev: "tsup --watch",
+    pd4castr: "node dist/index.js",
+    format: "prettier --write .",
+    lint: "eslint .",
+    typecheck: "tsc --noEmit",
+    prepublishOnly: "pnpm run build"
+  },
+  dependencies: {
+    "@inquirer/prompts": "7.7.1",
+    auth0: "4.28.0",
+    chalk: "5.6.0",
+    commander: "14.0.0",
+    execa: "9.6.0",
+    express: "4.21.2",
+    immer: "10.1.1",
+    ky: "1.14.2",
+    ora: "8.2.0",
+    "promise-retry": "2.0.1",
+    slugify: "1.6.6",
+    tiged: "2.12.7",
+    "tiny-invariant": "1.3.3",
+    zod: "4.0.14"
+  },
+  devDependencies: {
+    "@faker-js/faker": "10.0.0",
+    "@mswjs/data": "0.16.2",
+    "@types/express": "4.17.21",
+    "@types/node": "24.1.0",
+    "@types/supertest": "6.0.3",
+    "hook-std": "3.0.0",
+    "jest-extended": "7.0.0",
+    memfs: "4.49.0",
+    msw: "2.12.9",
+    "strip-ansi": "7.1.0",
+    supertest: "7.2.2",
+    tsup: "8.5.0",
+    "type-fest": "4.41.0",
+    typescript: "5.8.3",
+    vitest: "4.0.18"
+  },
+  publishConfig: {
+    access: "public"
+  },
+  keywords: [
+    "cli",
+    "pd4castr"
+  ]
+};
+
 // src/api/api.ts
 var api = ky.create({
-  prefixUrl: getEnv().apiURL
+  prefixUrl: getEnv().apiURL,
+  headers: {
+    "X-SDK-Version": `cli/${package_default.version}`
+  }
 });
 
 // src/api/query-data-fetcher.ts
@@ -840,7 +952,7 @@ async function getModelConfigFromProjectConfig(ctx) {
   const sensitivities = await getSensitivitiesWithInlinedSQL(ctx);
   const inputAggregations = await getInputAggregationsWithInlinedSQL(ctx);
   const runDatetimeQuery = await getrunDatetimeQuerySQL(ctx);
-  const { $$id, $$modelGroupID, $$revision, $$dockerImage, ...config } = ctx.config;
+  const { $$configVersion, $$id, $$modelGroupID, $$revision, $$dockerImage, ...config } = ctx.config;
   return {
     ...config,
     id: $$id,
@@ -1008,7 +1120,7 @@ function getModelSummaryLines(ctx) {
     ] : [],
     ...ctx.config.sensitivities.length > 0 ? [
       `	${chalk2.bold("Sensitivities:")}`,
-      ...ctx.config.sensitivities.map((s) => `	\u2022 ${s.name}`)
+      ...ctx.config.sensitivities.map((s) => `	\u2022 ${s.name}${s.key ? ` (${s.key})` : ""}`)
     ] : [],
     ""
   ];
@@ -1405,8 +1517,125 @@ import chalk6 from "chalk";
 import * as inquirer3 from "@inquirer/prompts";
 import chalk4 from "chalk";
 
-// src/commands/publish/utils/validate-local-model-state.ts
+// src/utils/migrate-config.ts
+import fs11 from "fs/promises";
+import invariant4 from "tiny-invariant";
+
+// src/migrations/01-backfill-output-variable-keys.ts
 import invariant2 from "tiny-invariant";
+var backfillOutputVariableKeys = {
+  version: 1,
+  description: "Backfill output variable keys from published model",
+  migrate(config, ctx) {
+    const outputsMissingKeys = config.outputs.filter((output) => !output.key);
+    if (outputsMissingKeys.length === 0) {
+      return config;
+    }
+    invariant2(ctx.publishedModel, "Published model is required to backfill output variable keys");
+    const publishedKeysByName = /* @__PURE__ */ new Map();
+    for (const published of ctx.publishedModel.outputVariables) {
+      publishedKeysByName.set(published.name, published.key);
+    }
+    const unmatchedOutputs = [];
+    const updatedOutputs = config.outputs.map((output) => {
+      if (output.key) {
+        return output;
+      }
+      const publishedKey = publishedKeysByName.get(output.name);
+      if (publishedKey) {
+        return {
+          ...output,
+          key: publishedKey
+        };
+      }
+      unmatchedOutputs.push(output.name);
+      return output;
+    });
+    if (unmatchedOutputs.length > 0) {
+      throw new Error(`The following outputs need a \`key\` defined in .pd4castrrc.json:
+${unmatchedOutputs.map((name) => `  - ${name}`).join("\n")}
+
+Set a unique key (lowercase alphanumeric with hyphens/underscores) for each output.`);
+    }
+    return {
+      ...config,
+      outputs: updatedOutputs
+    };
+  }
+};
+
+// src/migrations/02-backfill-sensitivity-keys.ts
+import invariant3 from "tiny-invariant";
+var backfillSensitivityKeys = {
+  version: 2,
+  description: "Backfill sensitivity keys from published model",
+  migrate(config, ctx) {
+    const sensitivitiesMissingKeys = (config.sensitivities ?? []).filter((sensitivity) => !sensitivity.key);
+    if (sensitivitiesMissingKeys.length === 0) {
+      return config;
+    }
+    invariant3(ctx.publishedModel, "Published model is required to backfill sensitivity keys");
+    const publishedKeysByName = /* @__PURE__ */ new Map();
+    for (const published of ctx.publishedModel.sensitivities) {
+      publishedKeysByName.set(published.name, published.key);
+    }
+    const unmatchedSensitivities = [];
+    const updatedSensitivities = config.sensitivities.map((sensitivity) => {
+      if (sensitivity.key) {
+        return sensitivity;
+      }
+      const publishedKey = publishedKeysByName.get(sensitivity.name);
+      if (publishedKey) {
+        return {
+          ...sensitivity,
+          key: publishedKey
+        };
+      }
+      unmatchedSensitivities.push(sensitivity.name);
+      return sensitivity;
+    });
+    if (unmatchedSensitivities.length > 0) {
+      throw new Error(`The following sensitivities need a \`key\` defined in .pd4castrrc.json:
+${unmatchedSensitivities.map((name) => `  - ${name}`).join("\n")}
+
+Set a unique key (lowercase alphanumeric with hyphens/underscores) for each sensitivity.`);
+    }
+    return {
+      ...config,
+      sensitivities: updatedSensitivities
+    };
+  }
+};
+
+// src/migrations/index.ts
+var migrations = [
+  backfillOutputVariableKeys,
+  backfillSensitivityKeys
+];
+
+// src/utils/migrate-config.ts
+async function migrateConfig(ctx, migrationCtx) {
+  const pendingMigrations = migrations.filter((migration) => migration.version > ctx.config.$$configVersion).sort((a, b) => a.version - b.version);
+  if (pendingMigrations.length === 0) {
+    return;
+  }
+  let config = ctx.config;
+  for (const migration of pendingMigrations) {
+    config = migration.migrate(config, migrationCtx);
+  }
+  const lastMigration = pendingMigrations.at(-1);
+  invariant4(lastMigration, "expected at least one pending migration");
+  config = {
+    ...config,
+    $$configVersion: lastMigration.version
+  };
+  ctx.config = config;
+  await fs11.writeFile(ctx.configPath, JSON.stringify(config, null, 2) + "\n", "utf8");
+}
+__name(migrateConfig, "migrateConfig");
+
+// src/commands/publish/utils/validate-local-model-state.ts
+import invariant5 from "tiny-invariant";
 
 // src/api/get-model.ts
 async function getModel(modelId, authCtx) {
@@ -1422,7 +1651,7 @@ __name(getModel, "getModel");
 
 // src/commands/publish/utils/validate-local-model-state.ts
 async function validateLocalModelState(ctx, authCtx) {
-  invariant2(ctx.config.$$id, "model ID is required to fetch published model");
+  invariant5(ctx.config.$$id, "model ID is required to fetch published model");
   const currentModel = await getModel(ctx.config.$$id, authCtx);
   if (currentModel.revision !== ctx.config.$$revision) {
     throw new Error(`OUT OF SYNC: Local revision (${ctx.config.$$revision}) does not match the current published revision (${currentModel.revision})`);
@@ -1430,6 +1659,7 @@ async function validateLocalModelState(ctx, authCtx) {
   if (currentModel.modelGroupId !== ctx.config.$$modelGroupID) {
     throw new Error(`OUT OF SYNC: Local model group ID (${ctx.config.$$modelGroupID}) does not match the current published model group ID (${currentModel.modelGroupId})`);
   }
+  return currentModel;
 }
 __name(validateLocalModelState, "validateLocalModelState");
 
@@ -1449,7 +1679,10 @@ async function handleModelRevisionCreateFlow(options, app, spinner, ctx, authCtx
     throw new Error("Model revision update cancelled");
   }
   spinner.start("Validating local model state...");
-  await validateLocalModelState(ctx, authCtx);
+  const publishedModel = await validateLocalModelState(ctx, authCtx);
+  await migrateConfig(ctx, {
+    publishedModel
+  });
   spinner.succeed("Local model is synced with published model");
   const dockerImage = getDockerImage(ctx);
   if (!options.skipChecks) {
@@ -1537,7 +1770,10 @@ async function handleModelRevisionUpdateFlow(options, app, spinner, ctx, authCtx
     throw new Error("Model revision update cancelled");
   }
   spinner.start("Validating local model state...");
-  await validateLocalModelState(ctx, authCtx);
+  const publishedModel = await validateLocalModelState(ctx, authCtx);
+  await migrateConfig(ctx, {
+    publishedModel
+  });
   spinner.succeed("Local model is synced with published model");
   const dockerImage = getDockerImage(ctx);
   if (!options.skipChecks) {
@@ -1903,79 +2139,6 @@ __name(registerTestCommand, "registerTestCommand");
 
 // src/program.ts
 import { Command } from "commander";
-
-// package.json
-var package_default = {
-  name: "@pd4castr/cli",
-  version: "1.10.0",
-  description: "CLI tool for creating, testing, and publishing pd4castr models",
-  license: "MIT",
-  main: "dist/index.js",
-  private: false,
-  type: "module",
-  bin: {
-    pd4castr: "dist/index.js"
-  },
-  files: [
-    "dist/**/*",
-    "LICENSE.md",
-    "docs/assets/logo.png"
-  ],
-  engines: {
-    node: ">=20.0.0"
-  },
-  scripts: {
-    build: "tsup",
-    dev: "tsup --watch",
-    pd4castr: "node dist/index.js",
-    format: "prettier --write .",
-    lint: "eslint .",
-    typecheck: "tsc --noEmit",
-    prepublishOnly: "yarn build"
-  },
-  dependencies: {
-    "@inquirer/prompts": "7.7.1",
-    auth0: "4.28.0",
-    chalk: "5.6.0",
-    commander: "14.0.0",
-    execa: "9.6.0",
-    express: "4.21.2",
-    immer: "10.1.1",
-    ky: "1.14.2",
-    ora: "8.2.0",
-    "promise-retry": "2.0.1",
-    slugify: "1.6.6",
-    tiged: "2.12.7",
-    "tiny-invariant": "1.3.3",
-    zod: "4.0.14"
-  },
-  devDependencies: {
-    "@faker-js/faker": "10.0.0",
-    "@mswjs/data": "0.16.2",
-    "@types/express": "4.17.21",
-    "@types/node": "24.1.0",
-    "@types/supertest": "6.0.3",
-    "hook-std": "3.0.0",
-    "jest-extended": "6.0.0",
-    memfs: "4.49.0",
-    msw: "2.10.5",
-    "strip-ansi": "7.1.0",
-    supertest: "7.1.4",
-    tsup: "8.5.0",
-    "type-fest": "4.41.0",
-    typescript: "5.8.3",
-    vitest: "3.2.4"
-  },
-  publishConfig: {
-    access: "public"
-  },
-  keywords: [
-    "cli",
-    "pd4castr"
-  ]
-};
-
-// src/program.ts
 var program = new Command();
 program.name("pd4castr").description("CLI tool for pd4castr").version(package_default.version);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pd4castr/cli",
-  "version": "1.10.0",
+  "version": "1.12.0",
   "description": "CLI tool for creating, testing, and publishing pd4castr models",
   "license": "MIT",
   "main": "dist/index.js",
@@ -24,7 +24,7 @@
     "format": "prettier --write .",
     "lint": "eslint .",
     "typecheck": "tsc --noEmit",
-    "prepublishOnly": "yarn build"
+    "prepublishOnly": "pnpm run build"
   },
   "dependencies": {
     "@inquirer/prompts": "7.7.1",
@@ -49,15 +49,15 @@
     "@types/node": "24.1.0",
     "@types/supertest": "6.0.3",
     "hook-std": "3.0.0",
-    "jest-extended": "6.0.0",
+    "jest-extended": "7.0.0",
     "memfs": "4.49.0",
-    "msw": "2.10.5",
+    "msw": "2.12.9",
     "strip-ansi": "7.1.0",
-    "supertest": "7.1.4",
+    "supertest": "7.2.2",
     "tsup": "8.5.0",
     "type-fest": "4.41.0",
     "typescript": "5.8.3",
-    "vitest": "3.2.4"
+    "vitest": "4.0.18"
   },
   "publishConfig": {
     "access": "public"