@oprt/cli 0.0.0-stage → 0.3.0

package/dist/read-C7rE5UlY.d.cts

@@ -0,0 +1,273 @@
+interface ContractProp {
+    type: string;
+    values?: string[];
+    types?: string[];
+    default?: string | number | boolean;
+    required?: boolean;
+    description?: string;
+}
+interface ContractComponent {
+    description: string;
+    props: Record<string, ContractProp>;
+    slots?: Record<string, {
+        type: string;
+        required?: boolean;
+    }>;
+    composable_with?: string[];
+    never_inside?: string[];
+    example: string;
+}
+interface CompositionRule {
+    allowed_children: string[];
+    children?: Record<string, CompositionRule>;
+}
+interface ContractRecipe {
+    description: string;
+    composed_of: string[];
+    layout: string;
+    install: string;
+    dependencies?: string[];
+    files?: Record<string, number>;
+}
+interface GuidanceRule {
+    id: string;
+    rule: string;
+    wrong?: string;
+    right?: string;
+}
+interface ComponentGuidance {
+    use_for?: string[];
+    part_of?: string;
+    not_for?: {
+        need: string;
+        use: string;
+    }[];
+    values?: Record<string, Record<string, string>>;
+}
+/** What a project needs besides the source it copies or the package it imports. */
+interface ContractSetup {
+    tailwind: string;
+    packages: {
+        name: string;
+        dev: boolean;
+        why: string;
+        range?: string;
+    }[];
+    stylesheet: {
+        line: string;
+        why: string;
+    }[];
+    package_source: {
+        when: string;
+        line: string;
+        why: string;
+    };
+    root_import: string;
+    root_import_note: string;
+    not_needed: {
+        name: string;
+        why: string;
+    }[];
+}
+interface Contract {
+    version: string;
+    components: Record<string, ContractComponent>;
+    composition_rules?: Record<string, CompositionRule>;
+    patterns?: Record<string, ContractRecipe>;
+    guidance: {
+        setup: ContractSetup;
+        rules: GuidanceRule[];
+        components: Record<string, ComponentGuidance>;
+    };
+    /** Every value @oprt/react exports: components, hooks, helpers and manifests. */
+    exports: string[];
+}
+
+interface RegistryEntry {
+    name: string;
+    slug: string;
+    kind: "component" | "recipe";
+    description: string;
+    /** Source paths relative to the selected output directory. */
+    files: string[];
+    /** External packages used by this entry's complete source closure, runtime and type-only alike. */
+    dependencies: string[];
+    /**
+     * The subset of `dependencies` that the closure imports only for types. They are needed to
+     * type-check the copied source, not to run it. Absent in registries from older builds.
+     */
+    devDependencies?: string[];
+}
+interface Registry {
+    version: string;
+    entries: RegistryEntry[];
+    files: Record<string, string>;
+    /** The version range each external package was verified against. Absent in older registries. */
+    ranges?: Record<string, string>;
+}
+interface AddOptions {
+    names: string[];
+    out?: string;
+    dryRun?: boolean;
+    overwrite?: boolean;
+}
+interface InstallFile {
+    path: string;
+    destination: string;
+    action: "create" | "overwrite" | "skip";
+}
+interface InstallResult {
+    outputDirectory: string;
+    entries: string[];
+    /** Every external package the selected sources import, runtime and type-only alike. */
+    dependencies: string[];
+    /** The subset of `dependencies` that no selected source imports a value from. */
+    devDependencies: string[];
+    /** The version range of each package in `dependencies`, where the registry records one. */
+    ranges: Record<string, string>;
+    files: InstallFile[];
+    dryRun: boolean;
+}
+type Command = {
+    command: "help";
+} | {
+    command: "version";
+} | {
+    command: "list";
+    json: boolean;
+} | ({
+    command: "add";
+    json: boolean;
+} & Required<AddOptions>) | {
+    command: "component";
+    names: string[];
+    list: boolean;
+    dense: boolean;
+    json: boolean;
+} | {
+    command: "search";
+    query: string;
+    limit: number;
+    json: boolean;
+} | {
+    command: "init";
+    agent?: string;
+    path?: string;
+    remove: boolean;
+    dryRun: boolean;
+    json: boolean;
+} | {
+    command: "doctor";
+    json: boolean;
+} | {
+    command: "check";
+    paths: string[];
+    strict: boolean;
+    json: boolean;
+} | {
+    command: "mcp";
+};
+/**
+ * A failure the program reports and exits on. `code` is stable and only ever added to: a caller
+ * that reads `--json` output branches on it, never on the wording of the message. `suggestions`
+ * are the nearest valid choices, when there are any.
+ */
+declare class CliError extends Error {
+    readonly exitCode: number;
+    readonly code: string;
+    readonly suggestions?: string[];
+    constructor(message: string, exitCode?: number, details?: {
+        code?: string;
+        suggestions?: string[];
+    });
+}
+
+interface IndexEntry {
+    name: string;
+    /** What it is for, in the words a person would ask with. */
+    purpose: string;
+    /** The parts that only live inside it. */
+    parts: string[];
+}
+interface DetailProp {
+    name: string;
+    type: string;
+    values?: string[];
+    types?: string[];
+    default?: string | number | boolean;
+    required?: boolean;
+    description?: string;
+    /** For an option prop: what each value is for. */
+    notes?: Record<string, string>;
+}
+interface ComponentDetail {
+    name: string;
+    description: string;
+    use_for: string[];
+    not_for: {
+        need: string;
+        use: string;
+    }[];
+    part_of?: string;
+    parts: string[];
+    props: DetailProp[];
+    slots?: Record<string, {
+        type: string;
+        required?: boolean;
+    }>;
+    composable_with: string[];
+    never_inside: string[];
+    /** What may go directly inside it, where the contract restricts that. */
+    allowed_children?: string[];
+    example: string;
+}
+interface SearchResult {
+    kind: "component" | "recipe";
+    name: string;
+    purpose: string;
+    score: number;
+    /** Why it matched, when that is not plain from the purpose. */
+    why?: string;
+    /** The command that reads on from here. */
+    next: string;
+}
+/** Every component a person would choose, by name, each with its parts. */
+declare function componentIndex(contract: Contract): IndexEntry[];
+/** One component: its contract, with the notes on when to choose it and each of its options. */
+declare function componentDetail(contract: Contract, wanted: string): ComponentDetail;
+/**
+ * A component as text. Dense is the short form for an agent: what it is for, what to use instead,
+ * every option with what each value is for, the nesting rules and the example. The full form adds
+ * the description and each prop's whole description.
+ */
+declare function renderComponent(detail: ComponentDetail, { dense }: {
+    dense: boolean;
+}): string;
+/**
+ * Components and recipes that answer a need, best first. A need that one component's guidance
+ * sends elsewhere ("go to another page" is not for Button: use Link) counts for the component it
+ * is sent to.
+ */
+declare function search(contract: Contract, registry: Registry, query: string, limit?: number): SearchResult[];
+
+declare const START = "<!-- OPERATOR:START -->";
+declare const END = "<!-- OPERATOR:END -->";
+/** The block for this contract, markers included, ending in a newline. */
+declare function renderAgentBlock(contract: Contract): string;
+/** The version of the installer that wrote the block in a text, if it holds one. */
+declare function blockVersion(text: string): string | undefined;
+/**
+ * Put the block into a file's text. A file without one gains it at the end; a file with one has
+ * only that part replaced, so whatever else the file says is kept.
+ */
+declare function applyBlock(existing: string | null, block: string): {
+    text: string;
+    action: "create" | "append" | "update" | "unchanged";
+};
+/** Take the block out of a file's text, with the blank line that set it apart. */
+declare function removeBlock(existing: string): {
+    text: string;
+    found: boolean;
+};
+
+export { type AddOptions as A, type Contract as C, type DetailProp as D, END as E, type InstallResult as I, type Registry as R, type SearchResult as S, type ComponentDetail as a, type Command as b, type RegistryEntry as c, CliError as d, type IndexEntry as e, type InstallFile as f, applyBlock as g, blockVersion as h, componentDetail as i, componentIndex as j, renderAgentBlock as k, renderComponent as l, START as m, removeBlock as r, search as s };

package/dist/read-C7rE5UlY.d.ts

@@ -0,0 +1,273 @@
+interface ContractProp {
+    type: string;
+    values?: string[];
+    types?: string[];
+    default?: string | number | boolean;
+    required?: boolean;
+    description?: string;
+}
+interface ContractComponent {
+    description: string;
+    props: Record<string, ContractProp>;
+    slots?: Record<string, {
+        type: string;
+        required?: boolean;
+    }>;
+    composable_with?: string[];
+    never_inside?: string[];
+    example: string;
+}
+interface CompositionRule {
+    allowed_children: string[];
+    children?: Record<string, CompositionRule>;
+}
+interface ContractRecipe {
+    description: string;
+    composed_of: string[];
+    layout: string;
+    install: string;
+    dependencies?: string[];
+    files?: Record<string, number>;
+}
+interface GuidanceRule {
+    id: string;
+    rule: string;
+    wrong?: string;
+    right?: string;
+}
+interface ComponentGuidance {
+    use_for?: string[];
+    part_of?: string;
+    not_for?: {
+        need: string;
+        use: string;
+    }[];
+    values?: Record<string, Record<string, string>>;
+}
+/** What a project needs besides the source it copies or the package it imports. */
+interface ContractSetup {
+    tailwind: string;
+    packages: {
+        name: string;
+        dev: boolean;
+        why: string;
+        range?: string;
+    }[];
+    stylesheet: {
+        line: string;
+        why: string;
+    }[];
+    package_source: {
+        when: string;
+        line: string;
+        why: string;
+    };
+    root_import: string;
+    root_import_note: string;
+    not_needed: {
+        name: string;
+        why: string;
+    }[];
+}
+interface Contract {
+    version: string;
+    components: Record<string, ContractComponent>;
+    composition_rules?: Record<string, CompositionRule>;
+    patterns?: Record<string, ContractRecipe>;
+    guidance: {
+        setup: ContractSetup;
+        rules: GuidanceRule[];
+        components: Record<string, ComponentGuidance>;
+    };
+    /** Every value @oprt/react exports: components, hooks, helpers and manifests. */
+    exports: string[];
+}
+
+interface RegistryEntry {
+    name: string;
+    slug: string;
+    kind: "component" | "recipe";
+    description: string;
+    /** Source paths relative to the selected output directory. */
+    files: string[];
+    /** External packages used by this entry's complete source closure, runtime and type-only alike. */
+    dependencies: string[];
+    /**
+     * The subset of `dependencies` that the closure imports only for types. They are needed to
+     * type-check the copied source, not to run it. Absent in registries from older builds.
+     */
+    devDependencies?: string[];
+}
+interface Registry {
+    version: string;
+    entries: RegistryEntry[];
+    files: Record<string, string>;
+    /** The version range each external package was verified against. Absent in older registries. */
+    ranges?: Record<string, string>;
+}
+interface AddOptions {
+    names: string[];
+    out?: string;
+    dryRun?: boolean;
+    overwrite?: boolean;
+}
+interface InstallFile {
+    path: string;
+    destination: string;
+    action: "create" | "overwrite" | "skip";
+}
+interface InstallResult {
+    outputDirectory: string;
+    entries: string[];
+    /** Every external package the selected sources import, runtime and type-only alike. */
+    dependencies: string[];
+    /** The subset of `dependencies` that no selected source imports a value from. */
+    devDependencies: string[];
+    /** The version range of each package in `dependencies`, where the registry records one. */
+    ranges: Record<string, string>;
+    files: InstallFile[];
+    dryRun: boolean;
+}
+type Command = {
+    command: "help";
+} | {
+    command: "version";
+} | {
+    command: "list";
+    json: boolean;
+} | ({
+    command: "add";
+    json: boolean;
+} & Required<AddOptions>) | {
+    command: "component";
+    names: string[];
+    list: boolean;
+    dense: boolean;
+    json: boolean;
+} | {
+    command: "search";
+    query: string;
+    limit: number;
+    json: boolean;
+} | {
+    command: "init";
+    agent?: string;
+    path?: string;
+    remove: boolean;
+    dryRun: boolean;
+    json: boolean;
+} | {
+    command: "doctor";
+    json: boolean;
+} | {
+    command: "check";
+    paths: string[];
+    strict: boolean;
+    json: boolean;
+} | {
+    command: "mcp";
+};
+/**
+ * A failure the program reports and exits on. `code` is stable and only ever added to: a caller
+ * that reads `--json` output branches on it, never on the wording of the message. `suggestions`
+ * are the nearest valid choices, when there are any.
+ */
+declare class CliError extends Error {
+    readonly exitCode: number;
+    readonly code: string;
+    readonly suggestions?: string[];
+    constructor(message: string, exitCode?: number, details?: {
+        code?: string;
+        suggestions?: string[];
+    });
+}
+
+interface IndexEntry {
+    name: string;
+    /** What it is for, in the words a person would ask with. */
+    purpose: string;
+    /** The parts that only live inside it. */
+    parts: string[];
+}
+interface DetailProp {
+    name: string;
+    type: string;
+    values?: string[];
+    types?: string[];
+    default?: string | number | boolean;
+    required?: boolean;
+    description?: string;
+    /** For an option prop: what each value is for. */
+    notes?: Record<string, string>;
+}
+interface ComponentDetail {
+    name: string;
+    description: string;
+    use_for: string[];
+    not_for: {
+        need: string;
+        use: string;
+    }[];
+    part_of?: string;
+    parts: string[];
+    props: DetailProp[];
+    slots?: Record<string, {
+        type: string;
+        required?: boolean;
+    }>;
+    composable_with: string[];
+    never_inside: string[];
+    /** What may go directly inside it, where the contract restricts that. */
+    allowed_children?: string[];
+    example: string;
+}
+interface SearchResult {
+    kind: "component" | "recipe";
+    name: string;
+    purpose: string;
+    score: number;
+    /** Why it matched, when that is not plain from the purpose. */
+    why?: string;
+    /** The command that reads on from here. */
+    next: string;
+}
+/** Every component a person would choose, by name, each with its parts. */
+declare function componentIndex(contract: Contract): IndexEntry[];
+/** One component: its contract, with the notes on when to choose it and each of its options. */
+declare function componentDetail(contract: Contract, wanted: string): ComponentDetail;
+/**
+ * A component as text. Dense is the short form for an agent: what it is for, what to use instead,
+ * every option with what each value is for, the nesting rules and the example. The full form adds
+ * the description and each prop's whole description.
+ */
+declare function renderComponent(detail: ComponentDetail, { dense }: {
+    dense: boolean;
+}): string;
+/**
+ * Components and recipes that answer a need, best first. A need that one component's guidance
+ * sends elsewhere ("go to another page" is not for Button: use Link) counts for the component it
+ * is sent to.
+ */
+declare function search(contract: Contract, registry: Registry, query: string, limit?: number): SearchResult[];
+
+declare const START = "<!-- OPERATOR:START -->";
+declare const END = "<!-- OPERATOR:END -->";
+/** The block for this contract, markers included, ending in a newline. */
+declare function renderAgentBlock(contract: Contract): string;
+/** The version of the installer that wrote the block in a text, if it holds one. */
+declare function blockVersion(text: string): string | undefined;
+/**
+ * Put the block into a file's text. A file without one gains it at the end; a file with one has
+ * only that part replaced, so whatever else the file says is kept.
+ */
+declare function applyBlock(existing: string | null, block: string): {
+    text: string;
+    action: "create" | "append" | "update" | "unchanged";
+};
+/** Take the block out of a file's text, with the blank line that set it apart. */
+declare function removeBlock(existing: string): {
+    text: string;
+    found: boolean;
+};
+
+export { type AddOptions as A, type Contract as C, type DetailProp as D, END as E, type InstallResult as I, type Registry as R, type SearchResult as S, type ComponentDetail as a, type Command as b, type RegistryEntry as c, CliError as d, type IndexEntry as e, type InstallFile as f, applyBlock as g, blockVersion as h, componentDetail as i, componentIndex as j, renderAgentBlock as k, renderComponent as l, START as m, removeBlock as r, search as s };