@aventara/cli 0.1.0-pilot.1 → 0.1.0-pilot.2

package/dist/templates/template.registry.d.ts

@@ -3,14 +3,11 @@ import type { CatalogEntry, EntryId, ProviderOf } from "../catalog/catalog-entry
 import type { ClientShape, ExportReference } from "../project/service.detector.js";
 import type { PackageManager } from "../wizard/wizard.questions.js";
 /**
- * D7 — what the CLI writes for an ORM lives here as text, keyed by catalog id;
- * the adapter itself runs only through its bin.
- *
  * The registry is **total** in both directions, and both are checked before a
  * project is ever scaffolded:
- * - at compile time, over the generated catalog's literal type: an entry with
- *   no template set, or a template set missing a provider its adapter declares,
- *   does not type-check;
+ * - at compile time, over the generated catalog's literal type: an entry with no
+ *   template set, or a template set missing a provider its adapter declares, does
+ *   not type-check;
  * - at build time, by the catalog generator: a templates directory with no
  *   adapter, or an adapter with no templates directory, fails the build.
  */
@@ -20,11 +17,11 @@ export type ProviderTemplate = {
     readonly driverClass: string;
     /** The driver class's constructor argument, given the connection string as `url`. */
     readonly driverOptions: string;
-    /** The `DATABASE_URL` line's value; a placeholder where it cannot be known (Q16-8). */
+    /** The `DATABASE_URL` line's value; a placeholder where it cannot be known. */
     readonly databaseUrl: string;
     /** `.gitignore` lines this provider's files need (a SQLite database file). */
     readonly gitignore: readonly string[];
-    /** Packages whose install scripts pnpm must be allowed to run (B9). */
+    /** Packages whose install scripts pnpm must be allowed to run. */
     readonly nativeBuilds: readonly string[];
 };
 export type ModuleKind = "esm" | "cjs";
@@ -48,7 +45,7 @@ export type ScaffoldInput = {
  * `aventara:prepare` and `postinstall` script names) is the planner's.
  */
 export type OrmScaffold = {
-    /** New, developer-owned files (§4.3). */
+    /** New, developer-owned files. */
     readonly files: readonly {
         readonly path: string;
         readonly content: string;
@@ -58,7 +55,7 @@ export type OrmScaffold = {
     readonly gitignore: readonly string[];
     readonly dependencies: Readonly<Record<string, string>>;
     readonly devDependencies: Readonly<Record<string, string>>;
-    /** The command `aventara:prepare` runs (D7: the adapter only through its bin). */
+    /** The command `aventara:prepare` runs. */
     readonly prepare: string;
     /** What the anchored `app.module.ts` edit adds: import lines, and `imports:` entries. */
     readonly appModule: {
@@ -66,13 +63,13 @@ export type OrmScaffold = {
         readonly entries: readonly string[];
     };
     readonly nativeBuilds: readonly string[];
-    /** The ORM's next steps, after the install and before the server starts (R11). */
+    /** The ORM's next steps, after the install and before the server starts. */
     readonly nextSteps: readonly string[];
 };
 /**
- * What a project's existing ORM setup states, read by the entry's templates
- * (R6) — the ORM's own file layout is template knowledge (D7); judging it
- * against the catalog is the matcher's (`catalog.matcher.ts`).
+ * What a project's existing ORM setup states, read by the entry's templates — the
+ * ORM's own file layout is template knowledge; judging it against the catalog is
+ * the matcher's (`catalog.matcher.ts`).
  */
 export type OrmProjectFacts = {
     /** The schema the generate step reads, relative to the project root. */
@@ -84,7 +81,7 @@ export type OrmProjectFacts = {
     /** The driver-adapter packages the project depends on. */
     readonly drivers: readonly string[];
 };
-/** Reusing a project's ORM setup (R6): its schema, its output, its service. */
+/** Reusing a project's ORM setup: its schema, its output, its service. */
 export type ReuseInput = {
     readonly entry: CatalogEntry;
     readonly facts: OrmProjectFacts & {
@@ -107,7 +104,6 @@ export type TemplateSet<I extends EntryId> = {
     readonly providers: {
         readonly [P in ProviderOf<I>]: ProviderTemplate;
     };
-    /** A project with no ORM: everything §4.3 lists. */
     readonly scaffold: (input: ScaffoldInput) => OrmScaffold;
     /** Reads an existing setup's facts; `undefined` when there is none to read. */
     readonly readProject: (directory: string, manifest: PackageManifest) => OrmProjectFacts;
@@ -118,7 +114,7 @@ export type TemplateSet<I extends EntryId> = {
         readonly service: ExportReference;
         readonly module: ExportReference;
     };
-    /** A project with the ORM already set up: no ORM file written or edited (R6). */
+    /** A project with the ORM already set up: no ORM file written or edited. */
     readonly reuse: (input: ReuseInput) => OrmScaffold;
 };
 export type TemplateRegistry = {

package/dist/templates/template.registry.js

@@ -1,13 +1,8 @@
 import { PRISMA7_TEMPLATES } from "./prisma7/prisma7.templates.js";
-/**
- * The entrypoint every scaffold mounts the protocol at: written into
- * `src/aventara.config.ts`, and tested by the e2e spec (pilot.1).
- */
 export const SCAFFOLD_ENTRYPOINT = "/api";
 export const TEMPLATE_REGISTRY = {
     prisma7: PRISMA7_TEMPLATES,
 };
-/** The template set for `entry` — every catalog entry has one (checked at build). */
 export function templatesFor(entry) {
     const set = TEMPLATE_REGISTRY[entry.id];
     if (set === undefined) {

package/dist/wizard/answer.resolver.d.ts

@@ -1,26 +1,24 @@
 import type { AnyWizardQuestion, QuestionId, WizardAnswers, WizardContext } from "./wizard.questions.js";
 /**
- * R5 — how each question gets its answer, in this order:
- *
  * 1. **its flag**, validated by the question (a bad value is refused, never
  *    re-asked);
- * 2. **the only choice there is** (N3): shown on a terminal with no keypress;
+ * 2. **the only choice there is**: shown on a terminal with no keypress;
  * 3. **`--yes`**: the question's default, when it has one;
  * 4. **the prompt**, when someone can answer (stdin is a terminal);
  * 5. otherwise the question is **unanswered**, and once every question has been
  *    tried the run refuses in one sentence naming exactly those flags.
  *
  * `--yes` comes before the prompt because it means "accept each unanswered
- * question's default" (R5 + R2), on a terminal as much as anywhere; a question
- * with no default (`new`'s `<name>`) is still asked on a terminal.
+ * question's default", on a terminal as much as anywhere; a question with no
+ * default (`new`'s `<name>`) is still asked on a terminal.
  */
-/** The seam to a person (B26): `node:readline/promises` on a terminal, a script in specs. */
+/** The seam to a person: `node:readline/promises` on a terminal, a script in specs. */
 export type Prompter = {
     /** Whether someone can answer: stdin is a terminal. */
     readonly interactive: boolean;
     /** Asks once; resolves with what was typed, `""` for Enter alone. */
     readonly ask: (request: PromptRequest) => Promise<string>;
-    /** Says one line without asking (N3, and why an answer was not accepted). */
+    /** Says one line without asking. */
     readonly say: (line: string) => void;
 };
 export type PromptRequest = {

package/dist/wizard/answer.resolver.js

@@ -1,9 +1,7 @@
 import { WizardAnswerError } from "./wizard.questions.js";
-/** Nobody can answer and some questions are unanswered. A refusal: one sentence. */
 export class UnansweredQuestionsError extends Error {
     name = "UnansweredQuestionsError";
 }
-/** `--db <sqlite|postgresql>`, or `<name>` for the positional. */
 function flagSpelling(question, context) {
     if (!question.flag.startsWith("--")) {
         return question.flag;
@@ -18,7 +16,6 @@ function listed(items) {
         ? items.join("")
         : `${items.slice(0, -1).join(", ")} and ${items[items.length - 1]}`;
 }
-/** The refusal sentence: the unanswered flags, exactly, and `--yes` for those with a default. */
 function unansweredSentence(missing, yes) {
     const defaulted = missing.filter((item) => item.defaulted);
     const yesClause = !yes && defaulted.length > 0
@@ -51,12 +48,6 @@ async function prompt(question, context, prompter) {
         }
     }
 }
-/**
- * Settles `questions` in order, each later question seeing the earlier answers.
- *
- * @throws WizardAnswerError when a flag's value is not an answer.
- * @throws UnansweredQuestionsError when nobody can answer and something is unanswered.
- */
 export async function resolveAnswers(questions, sources) {
     const answered = {};
     const missing = [];
@@ -65,7 +56,6 @@ export async function resolveAnswers(questions, sources) {
             ...sources.context,
             answered: answered,
         };
-        // A question that depends on one left unanswered cannot be asked yet.
         if (question.after !== undefined &&
             answered[question.after] === undefined) {
             missing.push({ spelling: question.flag, defaulted: false });

package/dist/wizard/readline.prompter.d.ts

@@ -1,13 +1,11 @@
 import type { Readable, Writable } from "node:stream";
 import type { Prompter } from "./answer.resolver.js";
 /**
- * P6, B26 — the {@link Prompter} over `node:readline`: no prompt dependency.
- *
- * Lines are **queued** as they arrive and handed to questions in order. A
- * terminal delivers whatever was typed ahead of a question — and a script piping
- * answers into a pseudo-terminal delivers them all at once — and readline drops
- * a line nobody is waiting for. Measured: with `readline/promises`' `question`,
- * three answers piped into `script(1)` reached the first question only.
+ * Lines are **queued** as they arrive and handed to questions in order. A terminal
+ * delivers whatever was typed ahead of a question — and a script piping answers
+ * into a pseudo-terminal delivers them all at once — and readline drops a line
+ * nobody is waiting for. Measured: with `readline/promises`' `question`, three
+ * answers piped into `script(1)` reached the first question only.
  */
 /** Input ended while a question was open: the person closed the wizard. A refusal. */
 export declare class WizardCancelledError extends Error {

package/dist/wizard/readline.prompter.js

@@ -1,14 +1,4 @@
 import { createInterface } from "node:readline";
-/**
- * P6, B26 — the {@link Prompter} over `node:readline`: no prompt dependency.
- *
- * Lines are **queued** as they arrive and handed to questions in order. A
- * terminal delivers whatever was typed ahead of a question — and a script piping
- * answers into a pseudo-terminal delivers them all at once — and readline drops
- * a line nobody is waiting for. Measured: with `readline/promises`' `question`,
- * three answers piped into `script(1)` reached the first question only.
- */
-/** Input ended while a question was open: the person closed the wizard. A refusal. */
 export class WizardCancelledError extends Error {
     name = "WizardCancelledError";
 }

package/dist/wizard/wizard.questions.d.ts

@@ -1,29 +1,27 @@
 import type { AdapterCatalog, CatalogEntry } from "../catalog/catalog-entry.interface.js";
 import { type ExportReference, type ServiceScan } from "../project/service.detector.js";
 /**
- * R5 — every question the two commands ask, in **one table**: its flag, its
- * label, its choices and its default. The command-line grammar, the TTY prompt,
- * the `--yes` defaults and the non-interactive refusal sentence are all derived
- * from it, so a question cannot have a flag the parser does not know or a
- * default the refusal does not mention.
+ * The command-line grammar, the TTY prompt, the `--yes` defaults and the
+ * non-interactive refusal sentence are all derived from it, so a question cannot
+ * have a flag the parser does not know or a default the refusal does not mention.
  *
  * Choices that are an adapter's facts — which ORMs and majors exist, which
- * databases one supports — come from the generated catalog (R14), never from a
- * literal here.
+ * databases one supports — come from the generated catalog, never from a literal
+ * here.
  */
-/** Q16-5 (a). Yarn is not supported (U1). */
+/** Yarn is not supported. */
 export declare const PACKAGE_MANAGERS: readonly ["npm", "pnpm"];
 export type PackageManager = (typeof PACKAGE_MANAGERS)[number];
 /** What the wizard settles. */
 export type WizardAnswers = {
-    /** `new`'s project directory (Q16-3). */
+    /** `new`'s project directory. */
     readonly name: string;
-    /** The ORM and major, as the catalog entry that serves it (R14). */
+    /** The ORM and major, as the catalog entry that serves it. */
     readonly orm: CatalogEntry;
-    /** One of `orm`'s providers (R10). */
+    /** One of `orm`'s providers. */
     readonly db: string;
     readonly packageManager: PackageManager;
-    /** `init` over an existing ORM setup: the developer's service (R6). */
+    /** `init` over an existing ORM setup: the developer's service. */
     readonly service: ServiceChoice;
     /** The Nest module that provides and exports it. */
     readonly module: ExportReference;
@@ -36,7 +34,7 @@ export type ServiceChoice = ExportReference & {
     readonly isNew: boolean;
 };
 export type QuestionId = keyof WizardAnswers;
-/** What the scan of the developer's source found, for the service questions (R6). */
+/** What the scan of the developer's source found, for the service questions. */
 export type ServiceContext = {
     readonly scan: ServiceScan;
     /** The ORM's client class, as the scan looked for it. */
@@ -52,7 +50,6 @@ export type ServiceContext = {
 /** What a question may consult: the catalog, what was detected, what is already answered. */
 export type WizardContext = {
     readonly catalog: AdapterCatalog;
-    /** Q16-5's default: the lockfile, else the launching package manager (B11), else npm. */
     readonly detectedPackageManager: PackageManager;
     readonly answered: Partial<WizardAnswers>;
     /** Present for `init` over an existing ORM setup. */
@@ -91,24 +88,20 @@ export type AnyWizardQuestion = {
     readonly [K in QuestionId]: WizardQuestion<K>;
 }[QuestionId];
 export declare const NAME_QUESTION: WizardQuestion<"name">;
-/**
- * R14 — the ORM, from the catalog: `--orm <family>@<major>`, or `--orm <family>`
- * for the family's highest major (Q16-31).
- */
 export declare const ORM_QUESTION: WizardQuestion<"orm">;
-/** R10 — the database, from the chosen entry's providers; the first is the default. */
 export declare const DB_QUESTION: WizardQuestion<"db">;
-/** Q16-5 — npm or pnpm; the default is detected. */
 export declare const PACKAGE_MANAGER_QUESTION: WizardQuestion<"packageManager">;
-/** R6, Q16-11 — the developer's service; a new one is written only when there is none. */
 export declare const SERVICE_QUESTION: WizardQuestion<"service">;
 /** The module that provides and exports the chosen service (or is @Global). */
 export declare const MODULE_QUESTION: WizardQuestion<"module">;
 /** `aventara new`'s questions, in the order they are asked. */
 export declare const NEW_QUESTIONS: readonly [WizardQuestion<"name">, WizardQuestion<"orm">, WizardQuestion<"db">, WizardQuestion<"packageManager">];
-/** `aventara init`'s questions when the project has no ORM (S6), in order. */
+/** `aventara init`'s questions when the project has no ORM, in order. */
 export declare const INIT_QUESTIONS: readonly [WizardQuestion<"orm">, WizardQuestion<"db">, WizardQuestion<"packageManager">];
-/** `aventara init`'s questions over an existing ORM setup (S7): the ORM and database are read, not asked. */
+/**
+ * `aventara init`'s questions over an existing ORM setup: the ORM and database are
+ * read, not asked.
+ */
 export declare const REUSE_QUESTIONS: readonly [WizardQuestion<"service">, WizardQuestion<"module">, WizardQuestion<"packageManager">];
 /** Every flag `aventara init` takes for a question, either way. */
 export declare const INIT_FLAG_QUESTIONS: readonly [WizardQuestion<"orm">, WizardQuestion<"db">, WizardQuestion<"service">, WizardQuestion<"module">, WizardQuestion<"packageManager">];

package/dist/wizard/wizard.questions.js

@@ -1,18 +1,5 @@
 import { modulesProviding, } from "../project/service.detector.js";
-/**
- * R5 — every question the two commands ask, in **one table**: its flag, its
- * label, its choices and its default. The command-line grammar, the TTY prompt,
- * the `--yes` defaults and the non-interactive refusal sentence are all derived
- * from it, so a question cannot have a flag the parser does not know or a
- * default the refusal does not mention.
- *
- * Choices that are an adapter's facts — which ORMs and majors exist, which
- * databases one supports — come from the generated catalog (R14), never from a
- * literal here.
- */
-/** Q16-5 (a). Yarn is not supported (U1). */
 export const PACKAGE_MANAGERS = ["npm", "pnpm"];
-/** An answer the question cannot accept. A refusal: one sentence. */
 export class WizardAnswerError extends Error {
     name = "WizardAnswerError";
 }
@@ -24,7 +11,6 @@ function available(catalog) {
         .map((entry) => `${ormLabel(entry)} (${entry.adapterPackage})`)
         .join(", ");
 }
-/** Ordered for the wizard: by family as the catalog lists them, majors newest first. */
 function ormChoices(catalog) {
     const families = [...new Set(catalog.map((entry) => entry.orm.family))];
     return families.flatMap((family) => catalog
@@ -47,10 +33,6 @@ export const NAME_QUESTION = {
     },
     describe: (name) => name,
 };
-/**
- * R14 — the ORM, from the catalog: `--orm <family>@<major>`, or `--orm <family>`
- * for the family's highest major (Q16-31).
- */
 export const ORM_QUESTION = {
     id: "orm",
     flag: "--orm",
@@ -86,7 +68,6 @@ function requireOrm(context) {
     }
     return orm;
 }
-/** R10 — the database, from the chosen entry's providers; the first is the default. */
 export const DB_QUESTION = {
     id: "db",
     flag: "--db",
@@ -107,7 +88,6 @@ export const DB_QUESTION = {
     },
     describe: (db) => db,
 };
-/** Q16-5 — npm or pnpm; the default is detected. */
 export const PACKAGE_MANAGER_QUESTION = {
     id: "packageManager",
     flag: "--package-manager",
@@ -139,7 +119,6 @@ function requireServices(context) {
     }
     return context.services;
 }
-/** The services on offer: what the scan found, or — when it found none — the template's new file. */
 function serviceOptions(services) {
     const found = [
         ...services.scan.candidates.map((candidate) => ({
@@ -156,14 +135,11 @@ function serviceOptions(services) {
         ? found
         : [{ ...services.newService, isNew: true }];
 }
-/** R6, Q16-11 — the developer's service; a new one is written only when there is none. */
 export const SERVICE_QUESTION = {
     id: "service",
     flag: "--prisma-service",
     placeholder: "<path#Export>",
     label: "Service to give Aventara (file#Export)",
-    // With no service found, the offer to write one is a question with a default
-    // (asked on a terminal, taken by --yes), not a single choice taken silently.
     choices: (context) => {
         const options = serviceOptions(requireServices(context));
         return options.every((option) => option.isNew)
@@ -198,7 +174,6 @@ export const SERVICE_QUESTION = {
     },
     describe: spelled,
 };
-/** The module that provides and exports the chosen service (or is @Global). */
 export const MODULE_QUESTION = {
     id: "module",
     flag: "--prisma-module",
@@ -232,26 +207,22 @@ export const MODULE_QUESTION = {
     },
     describe: spelled,
 };
-/** `aventara new`'s questions, in the order they are asked. */
 export const NEW_QUESTIONS = [
     NAME_QUESTION,
     ORM_QUESTION,
     DB_QUESTION,
     PACKAGE_MANAGER_QUESTION,
 ];
-/** `aventara init`'s questions when the project has no ORM (S6), in order. */
 export const INIT_QUESTIONS = [
     ORM_QUESTION,
     DB_QUESTION,
     PACKAGE_MANAGER_QUESTION,
 ];
-/** `aventara init`'s questions over an existing ORM setup (S7): the ORM and database are read, not asked. */
 export const REUSE_QUESTIONS = [
     SERVICE_QUESTION,
     MODULE_QUESTION,
     PACKAGE_MANAGER_QUESTION,
 ];
-/** Every flag `aventara init` takes for a question, either way. */
 export const INIT_FLAG_QUESTIONS = [
     ORM_QUESTION,
     DB_QUESTION,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aventara/cli",
-  "version": "0.1.0-pilot.1",
+  "version": "0.1.0-pilot.2",
   "license": "SEE LICENSE IN LICENSE",
   "description": "Scaffolds an Aventara server: `aventara new` for a new NestJS project, `aventara init` for an existing one.",
   "type": "module",
@@ -23,7 +23,7 @@
   },
   "scripts": {
     "prebuild": "node scripts/adapter-catalog.generator.ts",
-    "build": "tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.json --removeComments --declaration false && tsc -p tsconfig.json --emitDeclarationOnly && node ../../scripts/build/declaration-comments.sanitizer.ts dist",
     "typecheck": "tsc -p tsconfig.typecheck.json --noEmit",
     "test": "vitest run --typecheck --config ../../vitest.config.mts --root .",
     "lint": "biome lint src scripts"