@aventara/cli 0.1.0-pilot.4 → 1.0.0-rc.0

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

@@ -1,47 +0,0 @@
-import type { AnyWizardQuestion, QuestionId, WizardAnswers, WizardContext } from "./wizard.questions.js";
-/**
- * 1. **its flag**, validated by the question (a bad value is refused, never
- *    re-asked);
- * 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", 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: `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. */
-    readonly say: (line: string) => void;
-};
-export type PromptRequest = {
-    readonly label: string;
-    /** The accepted values, shown with the label; absent for free text. */
-    readonly choices?: readonly string[];
-    readonly defaultValue?: string;
-};
-/** Nobody can answer and some questions are unanswered. A refusal: one sentence. */
-export declare class UnansweredQuestionsError extends Error {
-    readonly name = "UnansweredQuestionsError";
-}
-export type AnswerSources = {
-    /** Raw answers from the command line, by question. */
-    readonly given: Readonly<Partial<Record<QuestionId, string>>>;
-    readonly yes: boolean;
-    readonly prompter: Prompter;
-    readonly context: Omit<WizardContext, "answered">;
-};
-/**
- * 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 declare function resolveAnswers(questions: readonly AnyWizardQuestion[], sources: AnswerSources): Promise<Partial<WizardAnswers>>;

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

@@ -1,22 +0,0 @@
-import type { Readable, Writable } from "node:stream";
-import type { Prompter } from "./answer.resolver.js";
-/**
- * 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 {
-    readonly name = "WizardCancelledError";
-}
-export type ReadlinePrompter = Prompter & {
-    readonly close: () => void;
-};
-export declare function createReadlinePrompter(streams: {
-    readonly input: Readable & {
-        readonly isTTY?: boolean;
-    };
-    readonly output: Writable;
-}): ReadlinePrompter;

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

@@ -1,120 +0,0 @@
-import type { AdapterCatalog, CatalogEntry } from "../catalog/catalog-entry.interface.js";
-import { type ExportReference, type ServiceScan } from "../project/service.detector.js";
-/**
- * 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, never from a literal
- * here.
- */
-/** 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. */
-    readonly name: string;
-    /** The ORM and major, as the catalog entry that serves it. */
-    readonly orm: CatalogEntry;
-    /** One of `orm`'s providers. */
-    readonly db: string;
-    readonly packageManager: PackageManager;
-    /** `init` over an existing ORM setup: the developer's service. */
-    readonly service: ServiceChoice;
-    /** The Nest module that provides and exports it. */
-    readonly module: ExportReference;
-};
-/** The service `AventaraModule` is given, or the template's new one to be written. */
-export type ServiceChoice = ExportReference & {
-    /** Set when the service holds its client in a member instead of extending it. */
-    readonly clientMember?: string;
-    /** The template's new service file, written because the project has none. */
-    readonly isNew: boolean;
-};
-export type QuestionId = keyof WizardAnswers;
-/** 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. */
-    readonly clientClass: string;
-    /** The service and module init writes when the project has none. */
-    readonly newService: ExportReference;
-    readonly newModule: ExportReference;
-    /** Whether a file already stands where the new service would be written. */
-    readonly newServiceFileExists: boolean;
-    /** How the ORM is named to the person, e.g. `Prisma`. */
-    readonly label: string;
-};
-/** What a question may consult: the catalog, what was detected, what is already answered. */
-export type WizardContext = {
-    readonly catalog: AdapterCatalog;
-    readonly detectedPackageManager: PackageManager;
-    readonly answered: Partial<WizardAnswers>;
-    /** Present for `init` over an existing ORM setup. */
-    readonly services?: ServiceContext;
-};
-export type Choice = {
-    /** What the flag takes and the prompt accepts, e.g. `prisma7`. */
-    readonly value: string;
-    /** How it is shown, e.g. `Prisma 7`. */
-    readonly label: string;
-};
-/** An answer the question cannot accept. A refusal: one sentence. */
-export declare class WizardAnswerError extends Error {
-    readonly name = "WizardAnswerError";
-}
-export type WizardQuestion<K extends QuestionId> = {
-    readonly id: K;
-    /** How the command line answers it: a `--flag <value>`, or the positional `<name>`. */
-    readonly flag: string;
-    /** The prompt's label. */
-    readonly label: string;
-    /** How the usage text shows its value; `<value>` when absent. */
-    readonly placeholder?: string;
-    /** A question whose choices depend on an earlier answer is not asked before it. */
-    readonly after?: QuestionId;
-    /** The answers on offer, or `undefined` for free text. */
-    readonly choices: (context: WizardContext) => readonly Choice[] | undefined;
-    /**
-     * Every value its flag takes before anything is answered — what `--help`
-     * lists (pilot.3); absent for free text. From the catalog, never a literal.
-     */
-    readonly accepts?: (catalog: AdapterCatalog) => readonly string[];
-    /** The answer `--yes` (or Enter at the prompt) takes; `undefined` when there is none. */
-    readonly defaultFor: (context: WizardContext) => string | undefined;
-    /** @throws WizardAnswerError when `raw` is not an answer to this question. */
-    readonly parse: (raw: string, context: WizardContext) => WizardAnswers[K];
-    /** How a settled answer is shown back. */
-    readonly describe: (answer: WizardAnswers[K]) => string;
-};
-export type AnyWizardQuestion = {
-    readonly [K in QuestionId]: WizardQuestion<K>;
-}[QuestionId];
-/**
- * What `--orm` takes: each adapter's alias, with what it is — the refusal's words,
- * and the usage's.
- */
-export declare function ormAliasesSentence(catalog: AdapterCatalog): string;
-export declare const NAME_QUESTION: WizardQuestion<"name">;
-/**
- * The prompt keeps the family-then-major order; every answer is an alias.
- */
-export declare const ORM_QUESTION: WizardQuestion<"orm">;
-export declare const DB_QUESTION: WizardQuestion<"db">;
-export declare const PACKAGE_MANAGER_QUESTION: WizardQuestion<"packageManager">;
-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, in order. */
-export declare const INIT_QUESTIONS: readonly [WizardQuestion<"orm">, WizardQuestion<"db">, WizardQuestion<"packageManager">];
-/**
- * `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">];