@endora-commerce/cli 0.100.0

package/dist/new-instance/index.d.ts

@@ -0,0 +1,118 @@
+import { type ResolvedInput } from '../inputs/resolve.js';
+import { type Topology } from './deploy.js';
+import { InstanceHostError, InstanceInputError, type InstanceHost } from './host.js';
+import { type ModuleSeedPolicy, type ModuleSetResolution } from './modules.js';
+import { type InstancePlan } from './template.js';
+export interface NewInstanceOptions {
+    /** Where to write. Required: this command has no default target (R5.1). */
+    readonly dir?: string | undefined;
+    /** Module ids, repeatable and comma-splittable — `new module`'s grammar (§3.1). */
+    readonly modules?: readonly string[] | undefined;
+    /** The deployment directory's name. Defaults to the workspace name (§2.2). */
+    readonly deployment?: string | undefined;
+    /** The endpoint the instance installs from. Absent writes no `.npmrc` (R5.7). */
+    readonly registry?: string | undefined;
+    /**
+     * Which machine layout the `deploy/` examples describe (D-230).
+     *
+     * A string rather than the union, because it arrives from argv: the refusal
+     * that turns it into one names the vocabulary, and a caller handing an
+     * already-narrowed value would be the type system asserting what only the
+     * operator's input can decide. Absent is `single-host`.
+     */
+    readonly topology?: string | undefined;
+    /**
+     * The members not to write — `--without <member>`, repeatable
+     * (`specs/118-instance-member-selection/contracts/instance-members.md` R3.5,
+     * ruled by D-215). Subtractive, so absent is *every member*; validated
+     * against the template's own vocabulary before anything is resolved.
+     */
+    readonly without?: readonly string[] | undefined;
+    /** Report every file it would write, and write nothing (R5.3). */
+    readonly dryRun?: boolean | undefined;
+    readonly cwd?: string | undefined;
+    /** Injected so a test drives the manifest lookup without a fixture install. */
+    readonly moduleUrl?: string | undefined;
+    /**
+     * What a default module set is seeded with when `modules` is empty.
+     *
+     * Absent is `required` — `instance-tree.md` R3.2's smallest set, which is this
+     * command's default and stays so. `endora install` passes `available`
+     * (D-270): a policy, never a list, so the verb names no module (125 FR-143).
+     */
+    readonly moduleSeed?: ModuleSeedPolicy | undefined;
+}
+export interface NewInstanceResult {
+    readonly targetDir: string;
+    readonly host: InstanceHost;
+    readonly plan: InstancePlan;
+    readonly modules: ModuleSetResolution;
+    readonly deployment: string;
+    readonly topology: Topology;
+    readonly dryRun: boolean;
+    /** R1.4's bound, measured on the plan this run built. */
+    readonly wiringLines: number;
+    /** R2.5a's one line. `defaulted=` is `0` by arithmetic, over the four tiers. */
+    readonly provenance: string;
+    /**
+     * The values this run resolved: what the target's own `.env` already supplied
+     * and what it generated. Exported so a proof reads the partition rather than
+     * the line's text.
+     */
+    readonly resolved: readonly ResolvedInput[];
+    /**
+     * What a **dry** run would have generated, by name. Empty on a real run,
+     * where {@link resolved} carries them with their provenance instead — a dry
+     * run generates nothing, so a name here is a prediction and never a value.
+     */
+    readonly wouldGenerate: readonly string[];
+    readonly nextSteps: readonly string[];
+}
+export declare function runNewInstance(options: NewInstanceOptions): Promise<NewInstanceResult>;
+/**
+ * What this run's own development environment adds to the block (feature 125).
+ *
+ * Both entries are **derived from the rendered `compose.dev.yml`** and from the
+ * member decisions this run took; neither is a value written down here. They
+ * are an options object rather than two more positional parameters because the
+ * block already takes four, and a fifth boolean beside a fourth array is how a
+ * call site gets them the wrong way round.
+ */
+export interface DevelopmentSteps {
+    /** The admin member was written, so there is a bundle to serve (FR-110). */
+    readonly admin?: boolean;
+    /**
+     * What a natively running process reaches the development stack at, read off
+     * the document this run rendered (`deploy.ts`' `developmentAddresses`).
+     *
+     * **Printed, not written** — writing it into `.env` is FR-105 and waits on
+     * proposed ruling PR-1(a), so until then the block carries the values and the
+     * client copies the ones they want.
+     */
+    readonly environment?: ReadonlyMap<string, string>;
+    /** Where the mail catcher's own interface is, if this stack runs one. */
+    readonly mailUrl?: string | undefined;
+}
+/**
+ * What a client is told to run, in order (R3.4).
+ *
+ * Exported so a proof can read the sequence rather than a process's stdout: it
+ * is the only statement anywhere of the order the steps go in, and the order is
+ * the part that was wrong — `start` before `build`, and no module install at
+ * all (`specs/110-instance-repository/` T141).
+ *
+ * `moduleIds` is the resolved set, and it is a parameter rather than a constant
+ * for the reason `cliAliasesFor` is derived: a step naming a command this
+ * instance cannot run is worse than no step, because it fails at the one moment
+ * a client cannot tell a missing module from a broken install.
+ */
+export declare function nextSteps(targetDir: string, deployment: string, topology?: Topology, moduleIds?: readonly string[], development?: DevelopmentSteps): readonly string[];
+export { InstanceHostError, InstanceInputError };
+/**
+ * The member vocabulary and its refusal, re-exported for `endora install`:
+ * that command validates `--without` with its other preconditions and renders
+ * the checklist from the vocabulary, and it reaches both through this runner
+ * rather than through the template, which it must not name (125 FR-143).
+ */
+export { MEMBER_VOCABULARY, memberRefusal, type MemberDeclaration } from './template.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/new-instance/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/new-instance/index.ts"],"names":[],"mappings":"AAoDA,OAAO,EAKL,KAAK,aAAa,EACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAML,KAAK,QAAQ,EACd,MAAM,aAAa,CAAC;AAErB,OAAO,EAGL,iBAAiB,EACjB,kBAAkB,EAElB,KAAK,YAAY,EAElB,MAAM,WAAW,CAAC;AACnB,OAAO,EAIL,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAML,KAAK,YAAY,EAClB,MAAM,eAAe,CAAC;AAEvB,MAAM,WAAW,kBAAkB;IACjC,2EAA2E;IAC3E,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,mFAAmF;IACnF,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IACjD,8EAA8E;IAC9E,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,iFAAiF;IACjF,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;IACjD,kEAAkE;IAClE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,+EAA+E;IAC/E,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;CACpD;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;IACtC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,yDAAyD;IACzD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,gFAAgF;IAChF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAC;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,aAAa,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;CACvC;AAgCD,wBAAsB,cAAc,CAClC,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,CAuO5B;AA+KD;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4EAA4E;IAC5E,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnD,yEAAyE;IACzE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CACvB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,QAAQ,GAAE,QAA2B,EACrC,SAAS,GAAE,SAAS,MAAM,EAAO,EACjC,WAAW,GAAE,gBAAqB,GACjC,SAAS,MAAM,EAAE,CAmFnB;AAED,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,CAAC;AAEjD;;;;;GAKG;AACH,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,KAAK,iBAAiB,EAAE,MAAM,eAAe,CAAC"}