@intentius/chant-lexicon-k3s 0.49.0 → 0.50.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export { k3sInstall, k3sUninstall } from "./op/builders.js";
 export { k3sPlugin } from "./plugin.js";
 export { k3sSerializer } 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;AAGlC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAGzD,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAGrC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG7C,cAAc,mBAAmB,CAAC;AAGlC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC"}

package/dist/op/builders.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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
+ * `k3sInstall`/`k3sUninstall` 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 { K3sInstallArgs, K3sUninstallArgs, K3sRole } from "./activities/k3s.js";
+/** Extra opts every wrapper below accepts alongside its activity's own fields. */
+type StepOpts = {
+    profile?: ActivityStep["profile"];
+    id?: string;
+};
+/**
+ * Run the pinned k3s installer against a reachable host — the fully typed
+ * twin of core's `k3sInstall`. `opts` is {@link K3sInstallArgs} itself,
+ * minus the positional `role` (`configFile` remains required). Defaults to
+ * the `longInfra` profile.
+ */
+export declare const k3sInstall: (role: K3sRole, opts: WithStepRefs<Omit<K3sInstallArgs, "role">> & StepOpts) => NamedActivityStep;
+/**
+ * Uninstall k3s from a reachable host — the fully typed twin of core's
+ * `k3sUninstall`. `opts` is {@link K3sUninstallArgs} itself, minus the
+ * positional `role`. Defaults to the `fastIdempotent` profile.
+ */
+export declare const k3sUninstall: (role: K3sRole, opts?: WithStepRefs<Omit<K3sUninstallArgs, "role">> & 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,cAAc,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAElF,kFAAkF;AAClF,KAAK,QAAQ,GAAG;IAAE,OAAO,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GACrB,MAAM,OAAO,EACb,MAAM,YAAY,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,GAAG,QAAQ,KAC1D,iBAGF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GACvB,MAAM,OAAO,EACb,OAAO,YAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,GAAG,QAAQ,KAC7D,iBAGF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intentius/chant-lexicon-k3s",
-  "version": "0.49.0",
+  "version": "0.50.0",
   "type": "module",
   "files": [
     "src/",
@@ -50,7 +50,7 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@intentius/chant": "^0.49.0",
+    "@intentius/chant": "^0.50.0",
     "typescript": "^5.9.3"
   },
   "description": "k3s lexicon for chant — the k3s distro's host configuration as declarable data",

package/src/index.ts

@@ -1,3 +1,10 @@
+// Typed Op step-builder wrappers (chant #1288 Stage 2) — k3sInstall/
+// k3sUninstall 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 { k3sInstall, k3sUninstall } from "./op/builders";
+
 // Plugin
 export { k3sPlugin } from "./plugin";
 

package/src/op/builders.test.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 { k3sInstall as k3sInstallOld, k3sUninstall as k3sUninstallOld, stepOutput, type StepOutputRef } from "@intentius/chant/op";
+import { k3sInstall, k3sUninstall } from "./builders";
+
+describe("k3s typed step builders (#1288 Stage 2)", () => {
+  test("k3sInstall: identical ActivityStep to core's original", () => {
+    const opts = { configFile: "dist/config.yaml" };
+    expect(k3sInstall("server", opts)).toEqual(k3sInstallOld("server", opts));
+    const optsWithVersion = { configFile: "dist/config.yaml", version: "v1.31.4+k3s1", tokenFile: "/etc/k3s-token" };
+    expect(k3sInstall("agent", optsWithVersion)).toEqual(k3sInstallOld("agent", optsWithVersion));
+  });
+
+  test("k3sUninstall: identical ActivityStep to core's original", () => {
+    expect(k3sUninstall("server")).toEqual(k3sUninstallOld("server"));
+  });
+
+  test("k3sInstall: accepts a StepOutputRef in a typed slot", () => {
+    const ref = stepOutput("write-config", "path");
+    const step = k3sInstall("server", { configFile: ref });
+    expect(step.args?.configFile).toBe(ref);
+  });
+
+  test("k3sInstall: .out is reachable when an id is given", () => {
+    const step = k3sInstall("server", { configFile: "dist/config.yaml", id: "install" });
+    const ref: StepOutputRef = step.out.version;
+    expect(ref.step).toBe("install");
+    expect(ref.path).toBe("version");
+  });
+});
+
+// ── Compile-time-only: authoring-time type errors (never executed) ──────────
+function _typeChecksOnly(): void {
+  // @ts-expect-error — configFile is required (the activity fails without
+  // it); omitting opts entirely is no longer a way around that.
+  k3sInstall("server");
+
+  // @ts-expect-error — "configfile" (wrong case) is not a key of K3sInstallArgs.
+  k3sInstall("server", { configfile: "dist/config.yaml" });
+
+  // @ts-expect-error — role must be "server" | "agent", not an arbitrary string.
+  k3sInstall("controller", { configFile: "dist/config.yaml" });
+}
+void _typeChecksOnly;

package/src/op/builders.ts

@@ -0,0 +1,48 @@
+/**
+ * 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
+ * `k3sInstall`/`k3sUninstall` 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 { K3sInstallArgs, K3sUninstallArgs, K3sRole } from "./activities/k3s";
+
+/** Extra opts every wrapper below accepts alongside its activity's own fields. */
+type StepOpts = { profile?: ActivityStep["profile"]; id?: string };
+
+/**
+ * Run the pinned k3s installer against a reachable host — the fully typed
+ * twin of core's `k3sInstall`. `opts` is {@link K3sInstallArgs} itself,
+ * minus the positional `role` (`configFile` remains required). Defaults to
+ * the `longInfra` profile.
+ */
+export const k3sInstall = (
+  role: K3sRole,
+  opts: WithStepRefs<Omit<K3sInstallArgs, "role">> & StepOpts,
+): NamedActivityStep => {
+  const { args, profile, id } = takeProfileAndId(opts as Record<string, unknown> | undefined);
+  return activity("k3sInstall", { role, ...args }, { profile: profile ?? "longInfra", ...(id ? { id } : {}) });
+};
+
+/**
+ * Uninstall k3s from a reachable host — the fully typed twin of core's
+ * `k3sUninstall`. `opts` is {@link K3sUninstallArgs} itself, minus the
+ * positional `role`. Defaults to the `fastIdempotent` profile.
+ */
+export const k3sUninstall = (
+  role: K3sRole,
+  opts?: WithStepRefs<Omit<K3sUninstallArgs, "role">> & StepOpts,
+): NamedActivityStep => {
+  const { args, profile, id } = takeProfileAndId(opts as Record<string, unknown> | undefined);
+  return activity("k3sUninstall", { role, ...args }, { profile: profile ?? "fastIdempotent", ...(id ? { id } : {}) });
+};