@starci/hfs 4.11.21 → 4.12.0

package/runtime/engine/release-config.d.mts

@@ -0,0 +1,19 @@
+/** The validated config.yaml `release` block. */
+export interface ReleaseBlock {
+    suite?: string | null;
+}
+/** The keys of the release block. */
+export declare const RELEASE_KEYS: readonly string[];
+/** Where the full test suite of a release is judged: `local` (the release cut also runs the L4 rows before it tags, the shipped default) or `ci` (the GitHub workflows judge EVERY row on each push to main; the cut runs none). */
+export declare const SUITE_MODES: readonly string[];
+/**
+ * config.yaml `release` - {suite?: local | ci}: who judges the full suite of a release (docs/releasing.md "Where the suite runs"). `local` is the shipped default: `starci release cut` also runs the
+ * L4 rows on this host before it tags. `ci` is the owner's recorded choice (2026-10-09, widened 2026-10-26 by push-main-after-scoped-check): the full suite runs on GitHub only, on every push
+ * to main; the cut runs no row and the verdict is read with `starci release ci-status`. The push of main needs neither mode: it needs a green scoped check.
+ * `none` is refused: the suite does not vanish, it moves to CI, and the value says so.
+ */
+export declare function validateRelease(release: unknown): void;
+/** The suite mode a validated owner config names; an absent block or key is the shipped default. */
+export declare const releaseSuiteMode: (config?: {
+    release?: ReleaseBlock | null;
+} | null) => string;

package/runtime/engine/release-config.mjs

@@ -1,28 +1,32 @@
-import {isPlainObject as plain} from './plain-object.mjs';
-import {invalid} from './invalid-config.mjs';
-
+import { isPlainObject as plain } from './plain-object.mjs';
+import { invalid } from './invalid-config.mjs';
 /** The keys of the release block. */
-export const RELEASE_KEYS=Object.freeze(['suite']);
+export const RELEASE_KEYS = Object.freeze(['suite']);
 /** Where the full test suite of a release is judged: `local` (the release cut also runs the L4 rows before it tags, the shipped default) or `ci` (the GitHub workflows judge EVERY row on each push to main; the cut runs none). */
-export const SUITE_MODES=Object.freeze(['local','ci']);
-const RELEASE_DEFAULTS=Object.freeze({suite:'local'});
-
+export const SUITE_MODES = Object.freeze(['local', 'ci']);
+const RELEASE_DEFAULTS = Object.freeze({ suite: 'local' });
 /**
  * config.yaml `release` - {suite?: local | ci}: who judges the full suite of a release (docs/releasing.md "Where the suite runs"). `local` is the shipped default: `starci release cut` also runs the
  * L4 rows on this host before it tags. `ci` is the owner's recorded choice (2026-10-09, widened 2026-10-26 by push-main-after-scoped-check): the full suite runs on GitHub only, on every push
  * to main; the cut runs no row and the verdict is read with `starci release ci-status`. The push of main needs neither mode: it needs a green scoped check.
  * `none` is refused: the suite does not vanish, it moves to CI, and the value says so.
  */
-export function validateRelease(release){
-  if(release===null)return;
-  const bad=invalid('release');
-  if(!plain(release))bad(` must be {suite?: ${SUITE_MODES.join(' | ')}} or null.`);
-  for(const key of Object.keys(release))if(!RELEASE_KEYS.includes(key))bad(` has unknown key ${key} (allowed: ${RELEASE_KEYS.join(', ')}).`);
-  const value=release.suite;
-  if(value===undefined||value===null)return;
-  if(value==='none')bad('.suite: "none" is not a mode: write "ci" (no local full suite, CI judges) or "local".');
-  if(!SUITE_MODES.includes(value))bad(`.suite must be ${SUITE_MODES.join(' or ')}, or null.`);
+export function validateRelease(release) {
+    if (release === null)
+        return;
+    const bad = invalid('release');
+    if (!plain(release))
+        return bad(` must be {suite?: ${SUITE_MODES.join(' | ')}} or null.`);
+    for (const key of Object.keys(release))
+        if (!RELEASE_KEYS.includes(key))
+            bad(` has unknown key ${key} (allowed: ${RELEASE_KEYS.join(', ')}).`);
+    const value = release.suite;
+    if (value === undefined || value === null)
+        return;
+    if (value === 'none')
+        bad('.suite: "none" is not a mode: write "ci" (no local full suite, CI judges) or "local".');
+    if (typeof value !== 'string' || !SUITE_MODES.includes(value))
+        bad(`.suite must be ${SUITE_MODES.join(' or ')}, or null.`);
 }
-
 /** The suite mode a validated owner config names; an absent block or key is the shipped default. */
-export const releaseSuiteMode=config=>config?.release?.suite??RELEASE_DEFAULTS.suite;
+export const releaseSuiteMode = (config) => config?.release?.suite ?? RELEASE_DEFAULTS.suite;

package/runtime/engine/removed-vocabulary.d.mts

@@ -0,0 +1,12 @@
+/** One refused spelling of modules/kernel/removed-vocabulary.yaml. */
+export interface RemovedEntry {
+    kind: string;
+    name: string;
+    use: string;
+}
+/** modules/kernel/removed-vocabulary.yaml: the one list of spellings the runtime refuses, each with its replacement and the release that removed it. */
+export declare const removedVocabulary: () => RemovedEntry[];
+/** The removed spellings of one kind. */
+export declare const removedOfKind: (kind: string) => RemovedEntry[];
+/** `<name> is removed (<replacement>)` for a removed spelling of the kind, or undefined when the name is not one. */
+export declare function removedNotice(kind: string, name: string): string | undefined;

package/runtime/engine/removed-vocabulary.mjs

@@ -1,26 +1,27 @@
 import fs from 'node:fs';
-import {fileURLToPath} from 'node:url';
-import {parseYaml} from './yaml.mjs';
-
-const FILE=fileURLToPath(new URL('../modules/kernel/removed-vocabulary.yaml',import.meta.url));
-
-let cache=null;
-function loaded(){
-  let stat;try{stat=fs.statSync(FILE);}catch{throw new Error('Missing modules/kernel/removed-vocabulary.yaml');}
-  const version=`${stat.mtimeMs}:${stat.size}`;
-  if(cache?.version!==version)cache={version,doc:parseYaml(fs.readFileSync(FILE,'utf8'))};
-  return cache.doc;
+import { fileURLToPath } from 'node:url';
+import { parseYaml } from './yaml.mjs';
+const FILE = fileURLToPath(new URL('../modules/kernel/removed-vocabulary.yaml', import.meta.url));
+let cache = null;
+function loaded() {
+    let stat;
+    try {
+        stat = fs.statSync(FILE);
+    }
+    catch {
+        throw new Error('Missing modules/kernel/removed-vocabulary.yaml');
+    }
+    const version = `${stat.mtimeMs}:${stat.size}`;
+    if (cache?.version !== version)
+        cache = { version, doc: parseYaml(fs.readFileSync(FILE, 'utf8')) };
+    return cache.doc;
 }
-
-
 /** modules/kernel/removed-vocabulary.yaml: the one list of spellings the runtime refuses, each with its replacement and the release that removed it. */
-export const removedVocabulary=()=>loaded().removed;
-
+export const removedVocabulary = () => loaded().removed;
 /** The removed spellings of one kind. */
-export const removedOfKind=kind=>removedVocabulary().filter(entry=>entry.kind===kind);
-
+export const removedOfKind = (kind) => removedVocabulary().filter(entry => entry.kind === kind);
 /** `<name> is removed (<replacement>)` for a removed spelling of the kind, or undefined when the name is not one. */
-export function removedNotice(kind,name){
-  const entry=removedOfKind(kind).find(candidate=>candidate.name===name);
-  return entry?`${entry.name} is removed (${entry.use})`:undefined;
+export function removedNotice(kind, name) {
+    const entry = removedOfKind(kind).find(candidate => candidate.name === name);
+    return entry ? `${entry.name} is removed (${entry.use})` : undefined;
 }

package/runtime/engine/resources-config.d.mts

@@ -0,0 +1,34 @@
+/**
+ * config.yaml `resources` — the owner's host-capacity floors, which override the shipped numbers of
+ * modules/models/runtimes.yaml `allocation.resources`. minFreeDiskGb: the free space a drive holding the temp root or the
+ * repository must keep before `starci kernel dispatch --spawn` launches another worker. minFreeDiskPct: the same floor as a
+ * percentage of the drive's size; when both are set the larger requirement applies. minFreeRamPct: the free-RAM floor below
+ * which no new heavy op starts. A null or absent key leaves the shipped number.
+ */
+declare const FLOOR_LIMITS: Readonly<{
+    minFreeDiskGb: number;
+    minFreeDiskPct: 100;
+    minFreeRamPct: 100;
+}>;
+/** One of the resources block's floor keys. */
+type FloorKey = keyof typeof FLOOR_LIMITS;
+/** The validated config.yaml `resources` block (and the shipped `allocation.resources` it overrides). */
+export type ResourcesBlock = {
+    [key in FloorKey]?: number | null;
+};
+/** The floors in force. */
+export interface HostFloors {
+    minFreeDiskGb: number;
+    minFreeDiskPct: number | null;
+    minFreeRamPct: number;
+}
+/** The keys of the resources block. */
+export declare const RESOURCE_KEYS: readonly string[];
+export declare function validateResources(resources: unknown): void;
+/**
+ * The floors in force: the owner's `resources` (config.yaml) over the shipped `allocation.resources`.
+ * {minFreeDiskGb, minFreeDiskPct (null when unset), minFreeRamPct}. The shipped policy owns the default numbers: when it
+ * omits or misspells minFreeDiskGb or minFreeRamPct this refuses, there is no fallback constant.
+ */
+export declare function hostFloors(shipped: ResourcesBlock | null | undefined, owner?: ResourcesBlock | null | undefined): HostFloors;
+export {};

package/runtime/engine/resources-config.mjs

@@ -1,6 +1,5 @@
-import {isPlainObject as plain} from './plain-object.mjs';
-import {invalid} from './invalid-config.mjs';
-
+import { isPlainObject as plain } from './plain-object.mjs';
+import { invalid } from './invalid-config.mjs';
 /**
  * config.yaml `resources` — the owner's host-capacity floors, which override the shipped numbers of
  * modules/models/runtimes.yaml `allocation.resources`. minFreeDiskGb: the free space a drive holding the temp root or the
@@ -8,45 +7,53 @@ import {invalid} from './invalid-config.mjs';
  * percentage of the drive's size; when both are set the larger requirement applies. minFreeRamPct: the free-RAM floor below
  * which no new heavy op starts. A null or absent key leaves the shipped number.
  */
-const FLOOR_LIMITS=Object.freeze({minFreeDiskGb:Infinity,minFreeDiskPct:100,minFreeRamPct:100});
-const inRange=(value,limit)=>typeof value==='number'&&Number.isFinite(value)&&value>0&&value<=limit;
-
+const FLOOR_LIMITS = Object.freeze({ minFreeDiskGb: Infinity, minFreeDiskPct: 100, minFreeRamPct: 100 });
+const inRange = (value, limit) => typeof value === 'number' && Number.isFinite(value) && value > 0 && value <= limit;
 /** The keys of the resources block. */
-export const RESOURCE_KEYS=Object.freeze(Object.keys(FLOOR_LIMITS));
-
-export function validateResources(resources){
-  if(resources===null)return;
-  const bad=invalid('resources');
-  const keys=RESOURCE_KEYS;
-  const shape=keys.map(key=>`${key}?`).join(', ');
-  if(!plain(resources))bad(` must be {${shape}} or null.`);
-  for(const key of Object.keys(resources))if(!keys.includes(key))bad(` has unknown key ${key} (allowed: ${keys.join(', ')}).`);
-  for(const key of keys){
-    const value=resources[key];
-    if(value!==undefined&&value!==null&&!inRange(value,FLOOR_LIMITS[key])){
-      const cap=FLOOR_LIMITS[key]===Infinity?'':` and at most ${FLOOR_LIMITS[key]}`;
-      bad(`.${key} must be a number above 0${cap}, or null.`);
+export const RESOURCE_KEYS = Object.freeze(Object.keys(FLOOR_LIMITS));
+const isFloorKey = (key) => Object.hasOwn(FLOOR_LIMITS, key);
+export function validateResources(resources) {
+    if (resources === null)
+        return;
+    const bad = invalid('resources');
+    const keys = RESOURCE_KEYS;
+    const shape = keys.map(key => `${key}?`).join(', ');
+    if (!plain(resources))
+        return bad(` must be {${shape}} or null.`);
+    for (const key of Object.keys(resources))
+        if (!keys.includes(key))
+            bad(` has unknown key ${key} (allowed: ${keys.join(', ')}).`);
+    for (const key of keys) {
+        if (!isFloorKey(key))
+            continue;
+        const value = resources[key];
+        if (value !== undefined && value !== null && !inRange(value, FLOOR_LIMITS[key])) {
+            const cap = FLOOR_LIMITS[key] === Infinity ? '' : ` and at most ${FLOOR_LIMITS[key]}`;
+            bad(`.${key} must be a number above 0${cap}, or null.`);
+        }
     }
-  }
 }
-
-const declared=(block,key,source)=>{
-  const value=block?.[key];
-  if(value===undefined||value===null)return null;
-  if(!inRange(value,FLOOR_LIMITS[key]))throw new Error(`${source}.${key} must be a number above 0 (at most ${FLOOR_LIMITS[key]})`);
-  return value;
+const declared = (block, key, source) => {
+    const value = block?.[key];
+    if (value === undefined || value === null)
+        return null;
+    if (!inRange(value, FLOOR_LIMITS[key]))
+        throw new Error(`${source}.${key} must be a number above 0 (at most ${FLOOR_LIMITS[key]})`);
+    return value;
 };
-
 /**
  * The floors in force: the owner's `resources` (config.yaml) over the shipped `allocation.resources`.
  * {minFreeDiskGb, minFreeDiskPct (null when unset), minFreeRamPct}. The shipped policy owns the default numbers: when it
  * omits or misspells minFreeDiskGb or minFreeRamPct this refuses, there is no fallback constant.
  */
-export function hostFloors(shipped,owner=null){
-  const source='modules/models/runtimes.yaml allocation.resources';
-  const base={minFreeDiskGb:declared(shipped,'minFreeDiskGb',source),minFreeDiskPct:declared(shipped,'minFreeDiskPct',source),minFreeRamPct:declared(shipped,'minFreeRamPct',source)};
-  for(const key of ['minFreeDiskGb','minFreeRamPct'])if(base[key]===null)throw new Error(`${source}.${key} must declare a positive number`);
-  if(owner!==null&&owner!==undefined)validateResources(owner);
-  const pick=key=>declared(owner,key,'config.yaml resources')??base[key];
-  return {minFreeDiskGb:pick('minFreeDiskGb'),minFreeDiskPct:pick('minFreeDiskPct'),minFreeRamPct:pick('minFreeRamPct')};
+export function hostFloors(shipped, owner = null) {
+    const source = 'modules/models/runtimes.yaml allocation.resources';
+    const base = { minFreeDiskGb: declared(shipped, 'minFreeDiskGb', source), minFreeDiskPct: declared(shipped, 'minFreeDiskPct', source), minFreeRamPct: declared(shipped, 'minFreeRamPct', source) };
+    for (const key of ['minFreeDiskGb', 'minFreeRamPct'])
+        if (base[key] === null)
+            throw new Error(`${source}.${key} must declare a positive number`);
+    if (owner !== null && owner !== undefined)
+        validateResources(owner);
+    const pick = (key) => declared(owner, key, 'config.yaml resources') ?? base[key];
+    return { minFreeDiskGb: pick('minFreeDiskGb'), minFreeDiskPct: pick('minFreeDiskPct'), minFreeRamPct: pick('minFreeRamPct') };
 }

package/runtime/engine/runtime-root.d.mts

@@ -0,0 +1,28 @@
+/** The runtime root: this source tree (or an immutable sealed payload of it). */
+export declare const skillRoot: string;
+/**
+ * The StarCi Source root (the host containing .claude and .workspaces): STARCI_SOURCE_ROOT overrides it, else the directory
+ * holding this runtime checkout. Parameterized over `env`, so a spec can inject a fixture Source.
+ */
+export declare const starciSourceRoot: (env?: NodeJS.ProcessEnv) => string;
+/** Overrides the per-host state base wholesale (debug probes, spec trees); the one seam starciLocalRoot reads. */
+export declare const LOCAL_ROOT_ENV = "STARCI_LOCAL_ROOT";
+/** The host-data directory of a runtime root. Git-ignored and never packed; the example fixtures under examples/.runtimes are a separate, public exception. */
+export declare const RUNTIME_STATE_DIR = ".runtime";
+/**
+ * <root>/.runtime. The root is the `.claude` of the host Source: the checkout, or the copy `starci runtime install` places at
+ * <app>/.claude. ~/.starci/runtime/node_modules/starci is only the CLI's download cache (it supplies the installer and hosts no
+ * state), and `starci runtime link` merely points the launcher at a root, so the state follows the code's own location.
+ */
+export declare const runtimeStateDir: (root?: string) => string;
+/**
+ * The per-host state base, the one owner of every host-state location: machine.sqlite, projects/<ledger_id>/runtime.sqlite, archive/,
+ * artifacts/ (the blob store), guards/, host-lock/ and the other process state sit under it. Default <runtime root>/.runtime;
+ * LOCAL_ROOT_ENV replaces it wholesale. Nothing is read from or moved out of the earlier %LOCALAPPDATA%/StarCi and ~/.starci locations.
+ */
+export declare const starciLocalRoot: (env?: NodeJS.ProcessEnv, root?: string) => string;
+/**
+ * Read a runtime contract document. `parts` are path segments under `skillRoot`
+ * (e.g. readModuleJson('modules', 'models', 'kinds.yaml')).
+ */
+export declare function readModuleJson(...parts: string[]): any;

package/runtime/engine/runtime-root.mjs

@@ -1,8 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import {fileURLToPath} from 'node:url';
-import {parseYaml} from './yaml.mjs';
-
+import { fileURLToPath } from 'node:url';
+import { parseYaml } from './yaml.mjs';
 /**
  * Runtime root helper. The runtime reads this source tree directly. `skillRoot` is the
  * directory containing `package.json` (this module's parent) — the checkout, or the copy of it
@@ -13,7 +12,6 @@ import {parseYaml} from './yaml.mjs';
  * path under `skillRoot` and parses the file by its extension.
  */
 const moduleRoot = path.dirname(fileURLToPath(new URL('../package.json', import.meta.url)));
-
 /** The runtime root: this source tree (or an immutable sealed payload of it). */
 export const skillRoot = moduleRoot;
 /**
@@ -21,7 +19,6 @@ export const skillRoot = moduleRoot;
  * holding this runtime checkout. Parameterized over `env`, so a spec can inject a fixture Source.
  */
 export const starciSourceRoot = (env = process.env) => (env.STARCI_SOURCE_ROOT ? path.resolve(env.STARCI_SOURCE_ROOT) : path.dirname(skillRoot));
-
 /** Overrides the per-host state base wholesale (debug probes, spec trees); the one seam starciLocalRoot reads. */
 export const LOCAL_ROOT_ENV = 'STARCI_LOCAL_ROOT';
 /** The host-data directory of a runtime root. Git-ignored and never packed; the example fixtures under examples/.runtimes are a separate, public exception. */
@@ -38,17 +35,18 @@ export const runtimeStateDir = (root = skillRoot) => path.join(root, RUNTIME_STA
  * LOCAL_ROOT_ENV replaces it wholesale. Nothing is read from or moved out of the earlier %LOCALAPPDATA%/StarCi and ~/.starci locations.
  */
 export const starciLocalRoot = (env = process.env, root = skillRoot) => (env[LOCAL_ROOT_ENV] ? path.resolve(env[LOCAL_ROOT_ENV]) : runtimeStateDir(root));
-
 /**
  * Read a runtime contract document. `parts` are path segments under `skillRoot`
  * (e.g. readModuleJson('modules', 'models', 'kinds.yaml')).
  */
+// reason: a parsed YAML/JSON contract document read from disk (parsed-input boundary); callers index into it by contract shape.
 export function readModuleJson(...parts) {
-  const rel = parts.join('/');
-  const file = path.join(skillRoot, rel);
-  if (!(file.startsWith(skillRoot) && fs.existsSync(file) && fs.statSync(file).isFile()))
-    throw new Error(`Required contract not found for ${rel} under ${skillRoot}`);
-  const text = fs.readFileSync(file, 'utf8');
-  if (/\.ya?ml$/i.test(file)) return parseYaml(text);
-  return JSON.parse(text);
+    const rel = parts.join('/');
+    const file = path.join(skillRoot, rel);
+    if (!(file.startsWith(skillRoot) && fs.existsSync(file) && fs.statSync(file).isFile()))
+        throw new Error(`Required contract not found for ${rel} under ${skillRoot}`);
+    const text = fs.readFileSync(file, 'utf8');
+    if (/\.ya?ml$/i.test(file))
+        return parseYaml(text);
+    return JSON.parse(text);
 }

package/runtime/engine/secrets.d.mts

@@ -0,0 +1,41 @@
+/** The host-local credential filename, resolved only against a verified runtime main root. */
+export declare const SECRET_ENV_FILE = "secret.env";
+/** The configured credential variable grammar shared by validation and secret resolution. */
+export declare const ENV_NAME: RegExp;
+export declare const CREDENTIAL_FILE_MAX_BYTES: number;
+/** Filter credentials resolved by this process; the values never leave their resolution owner. */
+export declare function redactResolvedSecrets(text: string): string;
+/** Check lexical availability only; blank and conventional template markers never prove provider validity. */
+export declare function credentialPresent(value: unknown): value is string;
+/** Read one configured credential file with a finite byte budget; no effects beyond the read. */
+export declare function readSecretBytes(file: string): Buffer;
+/** Parse a dotenv file (KEY=VALUE lines, # comments, optional export/quotes). An absent file is {}. */
+export declare function readDotenv(file: string): Record<string, string>;
+/**
+ * Resolve a configured variable or its supported NAME_FILE custody pointer. An explicitly supplied
+ * blank variable disables the value; it must not resurrect a file value. Never print the result.
+ */
+export declare function connectorSecret(name: unknown, env?: NodeJS.ProcessEnv): string | null;
+/**
+ * Load the verified runtime main's local credentials below the actual environment without mutating
+ * either input. The caller owns repository identity; this base-tier reader never infers a root from cwd.
+ * Absence is allowed so the action-specific gate can name only the credentials that action requires.
+ */
+export declare function secretEnv(verifiedRuntimeRoot: unknown, env?: NodeJS.ProcessEnv): NodeJS.ProcessEnv;
+/** The outcome of selecting a SOPS age identity: refused, an identity file, or the public recipient only. */
+export interface SopsIdentity {
+    mode: 'refused' | 'file' | 'public-recipient';
+    env: NodeJS.ProcessEnv | null;
+    error: (Error & {
+        identityRefusal?: string;
+    }) | null;
+    inlineName?: string;
+}
+type Env = Record<string, string | undefined>;
+/** Select a supplied age identity without inventing custody or running a key tool. Inline execution awaits its owned isolation capability. */
+export declare function sopsIdentityEnv(env: Env | null | undefined, { identity, required, platform }?: {
+    identity?: string | null;
+    required?: boolean;
+    platform?: NodeJS.Platform | string;
+}): SopsIdentity;
+export {};