@intentius/chant-lexicon-k3d 0.46.0 → 0.50.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export { k3dUp, k3dDown } from "./op/builders.js";
 export { k3dPlugin } from "./plugin.js";
 export { k3dSerializer } from "./serializer.js";
 export * from "./generated/index.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAGrC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG7C,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAG/C,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAGrC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG7C,cAAc,mBAAmB,CAAC"}

package/dist/op/builders.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Typed step-builder wrappers for this lexicon's activities (chant #1288
+ * Stage 2). See `lexicons/k8s/src/op/builders.ts`'s module doc for why these
+ * live beside their `*Args` interfaces rather than in core or the temporal
+ * barrel. `opts`'s type in each wrapper below IS the activity's own `*Args`
+ * interface (via `Omit`/`WithStepRefs`) — never restated. `core`'s own
+ * `k3dUp`/`k3dDown` are unchanged and produce byte-identical `ActivityStep`
+ * output; these are purely additive.
+ */
+import { type ActivityStep, type NamedActivityStep, type WithStepRefs } from "@intentius/chant/op";
+import type { K3dUpArgs, K3dDownArgs } from "./activities/k3d.js";
+/** Extra opts every wrapper below accepts alongside its activity's own fields. */
+type StepOpts = {
+    profile?: ActivityStep["profile"];
+    id?: string;
+};
+/**
+ * Create a local k3d cluster — the fully typed twin of core's `k3dUp`.
+ * `opts` is {@link K3dUpArgs} itself, minus the positional `name`. Defaults
+ * to the `longInfra` profile.
+ */
+export declare const k3dUp: (name: string, opts?: WithStepRefs<Omit<K3dUpArgs, "name">> & StepOpts) => NamedActivityStep;
+/**
+ * Delete a local k3d cluster — the fully typed twin of core's `k3dDown`.
+ * `opts` is {@link K3dDownArgs} itself, minus the positional `name`.
+ * Defaults to the `fastIdempotent` profile.
+ */
+export declare const k3dDown: (name: string, opts?: WithStepRefs<Omit<K3dDownArgs, "name">> & StepOpts) => NamedActivityStep;
+export {};
+//# sourceMappingURL=builders.d.ts.map

package/dist/op/builders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builders.d.ts","sourceRoot":"","sources":["../../src/op/builders.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAGL,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,YAAY,EAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/D,kFAAkF;AAClF,KAAK,QAAQ,GAAG;IAAE,OAAO,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnE;;;;GAIG;AACH,eAAO,MAAM,KAAK,GAChB,MAAM,MAAM,EACZ,OAAO,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,GAAG,QAAQ,KACtD,iBAGF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,OAAO,GAClB,MAAM,MAAM,EACZ,OAAO,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,GAAG,QAAQ,KACxD,iBAGF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intentius/chant-lexicon-k3d",
-  "version": "0.46.0",
+  "version": "0.50.0",
   "type": "module",
   "files": [
     "src/",
@@ -46,13 +46,13 @@
     "@types/js-yaml": "^4.0.9"
   },
   "dependencies": {
-    "js-yaml": "^4.1.0"
+    "js-yaml": "^4.3.1"
   },
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
-    "@intentius/chant": "^0.46.0",
+    "@intentius/chant": "^0.50.0",
     "typescript": "^5.9.3"
   },
   "description": "k3d lexicon for chant — a local Kubernetes cluster as declarable data",

package/src/index.ts

@@ -1,3 +1,9 @@
+// Typed Op step-builder wrappers (chant #1288 Stage 2) — k3dUp/k3dDown with
+// authoring-time types derived from this lexicon's own *Args interfaces (see
+// ./op/builders.ts's module doc). Opt-in: `@intentius/chant-lexicon-temporal`'s
+// same-named exports are core's original untyped builders, unchanged.
+export { k3dUp, k3dDown } from "./op/builders";
+
 // Plugin
 export { k3dPlugin } from "./plugin";
 

package/src/op/builders.test.ts

@@ -0,0 +1,47 @@
+/**
+ * Typed step-builder wrappers (chant #1288 Stage 2) — see
+ * `lexicons/k8s/src/op/builders.test.ts`'s module doc for what's asserted
+ * and why.
+ */
+
+import { describe, test, expect } from "vitest";
+import { k3dUp as k3dUpOld, k3dDown as k3dDownOld, stepOutput, type StepOutputRef } from "@intentius/chant/op";
+import { k3dUp, k3dDown } from "./builders";
+
+describe("k3d typed step builders (#1288 Stage 2)", () => {
+  test("k3dUp: identical ActivityStep to core's original", () => {
+    expect(k3dUp("dev")).toEqual(k3dUpOld("dev"));
+    const opts = { servers: 1, agents: 2, ports: ["8080:80@loadbalancer"] };
+    expect(k3dUp("dev", opts)).toEqual(k3dUpOld("dev", opts));
+  });
+
+  test("k3dDown: identical ActivityStep to core's original", () => {
+    expect(k3dDown("dev")).toEqual(k3dDownOld("dev"));
+  });
+
+  test("k3dUp: accepts a StepOutputRef in a typed slot", () => {
+    const ref = stepOutput("resolve-config", "path");
+    const step = k3dUp("dev", { configFile: ref });
+    expect(step.args?.configFile).toBe(ref);
+  });
+
+  test("k3dUp: .out is reachable when an id is given", () => {
+    const step = k3dUp("dev", { id: "cluster" });
+    const ref: StepOutputRef = step.out.context;
+    expect(ref.step).toBe("cluster");
+    expect(ref.path).toBe("context");
+  });
+});
+
+// ── Compile-time-only: authoring-time type errors (never executed) ──────────
+function _typeChecksOnly(): void {
+  // @ts-expect-error — "server" (missing the s) is not a key of K3dUpArgs.
+  k3dUp("dev", { server: 1 });
+
+  // @ts-expect-error — servers must be a number.
+  k3dUp("dev", { servers: "1" });
+
+  // @ts-expect-error — ports must be string[], not a single string.
+  k3dUp("dev", { ports: "8080:80@loadbalancer" });
+}
+void _typeChecksOnly;

package/src/op/builders.ts

@@ -0,0 +1,47 @@
+/**
+ * Typed step-builder wrappers for this lexicon's activities (chant #1288
+ * Stage 2). See `lexicons/k8s/src/op/builders.ts`'s module doc for why these
+ * live beside their `*Args` interfaces rather than in core or the temporal
+ * barrel. `opts`'s type in each wrapper below IS the activity's own `*Args`
+ * interface (via `Omit`/`WithStepRefs`) — never restated. `core`'s own
+ * `k3dUp`/`k3dDown` are unchanged and produce byte-identical `ActivityStep`
+ * output; these are purely additive.
+ */
+
+import {
+  activity,
+  takeProfileAndId,
+  type ActivityStep,
+  type NamedActivityStep,
+  type WithStepRefs,
+} from "@intentius/chant/op";
+import type { K3dUpArgs, K3dDownArgs } from "./activities/k3d";
+
+/** Extra opts every wrapper below accepts alongside its activity's own fields. */
+type StepOpts = { profile?: ActivityStep["profile"]; id?: string };
+
+/**
+ * Create a local k3d cluster — the fully typed twin of core's `k3dUp`.
+ * `opts` is {@link K3dUpArgs} itself, minus the positional `name`. Defaults
+ * to the `longInfra` profile.
+ */
+export const k3dUp = (
+  name: string,
+  opts?: WithStepRefs<Omit<K3dUpArgs, "name">> & StepOpts,
+): NamedActivityStep => {
+  const { args, profile, id } = takeProfileAndId(opts as Record<string, unknown> | undefined);
+  return activity("k3dUp", { name, ...args }, { profile: profile ?? "longInfra", ...(id ? { id } : {}) });
+};
+
+/**
+ * Delete a local k3d cluster — the fully typed twin of core's `k3dDown`.
+ * `opts` is {@link K3dDownArgs} itself, minus the positional `name`.
+ * Defaults to the `fastIdempotent` profile.
+ */
+export const k3dDown = (
+  name: string,
+  opts?: WithStepRefs<Omit<K3dDownArgs, "name">> & StepOpts,
+): NamedActivityStep => {
+  const { args, profile, id } = takeProfileAndId(opts as Record<string, unknown> | undefined);
+  return activity("k3dDown", { name, ...args }, { profile: profile ?? "fastIdempotent", ...(id ? { id } : {}) });
+};