@ouispec/cli 0.1.0

package/dist/inputs.d.ts

@@ -0,0 +1,134 @@
+/**
+ * The declarations the generator reads besides the page trees: each
+ * design-system package's control table, each room package's catalog, the
+ * API's operations (from its OpenAPI document), the navigation and the routes.
+ */
+import ts from 'typescript';
+import { type ControlDescriptor, type RoomCatalogData } from '@ouispec/bindings';
+import type { Finding } from './analyze.js';
+import { type GeneratorConfig } from './config.js';
+import { type Source } from './program.js';
+/**
+ * The components a package says only the person may use (`oui.personOnly`:
+ * export name → why), such as the approval card (ADR-0228): the assistant
+ * must never be offered a way to operate them, so the generator refuses an
+ * `agent` binding on one. Read on first use of each package the app imports;
+ * a package that declares none has none.
+ */
+export declare function personOnlyLookup(config: GeneratorConfig): (pkg: string) => ReadonlyMap<string, string>;
+/** `package#Export` → how the generator reads that control. */
+export type Controls = ReadonlyMap<string, ControlDescriptor>;
+/**
+ * Every listed design-system package's control table. A package the app
+ * cannot resolve, one with no table, or one whose table is missing is an
+ * error: skipping it would leave its controls unread and the build green.
+ */
+export declare function loadControls(config: GeneratorConfig): {
+    controls: Controls;
+    /** The packages whose tables were read: an error for any other names it, so its uses are not reported again. */
+    loaded: ReadonlySet<string>;
+    errors: Finding[];
+};
+export interface LoadedCatalog {
+    /** The package that declares it, or `app:<module>#<export>` for one the app declares. */
+    package: string;
+    /** For an app catalog: the module's absolute path and the export, to find where it is registered. */
+    appModule?: {
+        file: string;
+        export: string;
+    };
+    hosts: readonly string[];
+    catalog: RoomCatalogData;
+}
+/** Why an app room catalog cannot be loaded without Vite, and what to do. */
+export declare const VITE_REQUIRED: string;
+/**
+ * The room catalogs the app declares itself (`appCatalogs`), loaded through
+ * the app's Vite config and reduced to their declarations. A catalog is code
+ * (its entries may be made by functions), and its imports resolve only as
+ * the app's build resolves them, so the app's own Vite loads it.
+ */
+export declare function loadAppCatalogs(config: GeneratorConfig): Promise<LoadedCatalog[]>;
+/** Every room catalog among the app's dependencies (`oui.agentCatalog`, or `closure.agentCatalog`). */
+export declare function loadCatalogs(config: GeneratorConfig): {
+    catalogs: LoadedCatalog[];
+    errors: Finding[];
+};
+export interface ApiOperation {
+    /** The operation's `operationId`, which a `mutate` effect names. */
+    name: string;
+    method: string;
+    url: string;
+    summary: string;
+}
+/** The API as the app declares it: its document, whether it could be read, and its operations. */
+export interface ApiOperations {
+    /** `apiSpec` as written; `null` for an app with no API. */
+    spec: string | null;
+    /** Whether the document was read: when not, the error says why, and no operation is checked against it. */
+    readable: boolean;
+    operations: ReadonlyMap<string, ApiOperation>;
+    errors: Finding[];
+}
+/**
+ * The API's operations, from its OpenAPI 3 document (`apiSpec`), by
+ * `operationId`: method, path and summary line. The document is named by
+ * module path, so it is the one the installed API client ships; a path
+ * inside the app is also read. `apiSpec: null` is an app with no API.
+ */
+export declare function loadApiOperations(config: GeneratorConfig): ApiOperations;
+export interface NavEntry {
+    label: string;
+    route: string;
+    group: string;
+}
+/** The navigation entries: every `{ label, route }` object literal in the nav files. */
+export declare function loadNav(source: Source, files: readonly string[]): NavEntry[];
+/** The frame components the config names, each with the declaration that renders it. */
+export declare function loadShell(source: Source, config: GeneratorConfig): {
+    component: string;
+    routes: string[];
+    declaration: ts.Node | null;
+}[];
+export interface RouteEntry {
+    path: string;
+    /** The page component's name as the routes name it (a lazy route module's, its file's). */
+    component: string;
+    /** The declaration of the page component. */
+    declaration: ts.Node | null;
+}
+/** A layout route's element: rendered around the pages under it, as the app's frame is. */
+export interface LayoutEntry {
+    component: string;
+    declaration: ts.Node;
+    /** The routes it is rendered on: its pages', and its own when nothing renders in its place there. */
+    routes: string[];
+}
+export interface AppRoutes {
+    pages: RouteEntry[];
+    layouts: LayoutEntry[];
+    /** Routes the generator cannot read: each would otherwise be a page the assistant never knows. */
+    errors: Finding[];
+}
+/**
+ * The app's routes, from the routes file: `<Route>` elements (nested ones
+ * joined to their parent, `index` routes at their parent's path) and data
+ * routers (`createBrowserRouter([...])` and its kin, `useRoutes`), with
+ * `element`, `Component` and `lazy` route modules. Wrappers are resolved to
+ * the page, `lazy` and `React.lazy` to the component they load.
+ *
+ * Not pages: splats, and redirects — a `<Navigate>`, and a component that
+ * only ever renders one (a redirect that keeps the id). A redirect is not a
+ * page, and naming it as one teaches an address that is not the destination.
+ * A route's element that has child routes is a layout: it frames them.
+ */
+export declare function loadRoutes(source: Source, config: GeneratorConfig): AppRoutes;
+/** Whether a call is `lazy(...)` or `React.lazy(...)`. */
+export declare function isLazyCall(expr: ts.Expression): expr is ts.CallExpression;
+/**
+ * The function that renders a component a JSX tag names: through imports and
+ * re-exports, `lazy(() => import('./X'))` and `React.lazy(...)` (a default
+ * export, or `.then(m => ({ default: m.X }))`), `forwardRef` and `memo`.
+ */
+export declare function componentDeclaration(source: Source, tag: ts.JsxTagNameExpression): ts.Node | null;
+//# sourceMappingURL=inputs.d.ts.map

package/dist/inputs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inputs.d.ts","sourceRoot":"","sources":["../src/inputs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,EAUL,KAAK,iBAAiB,EAEtB,KAAK,eAAe,EACrB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAe,KAAK,eAAe,EAAE,MAAM,aAAa,CAAC;AAEhE,OAAO,EAQL,KAAK,MAAM,EACZ,MAAM,cAAc,CAAC;AAuCtB;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,eAAe,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAkBtG;AAED,+DAA+D;AAC/D,MAAM,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAE9D;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG;IACrD,QAAQ,EAAE,QAAQ,CAAC;IACnB,gHAAgH;IAChH,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB,CA+EA;AAED,MAAM,WAAW,aAAa;IAC5B,yFAAyF;IACzF,OAAO,EAAE,MAAM,CAAC;IAChB,qGAAqG;IACrG,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7C,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED,6EAA6E;AAC7E,eAAO,MAAM,aAAa,QAEoE,CAAC;AAE/F;;;;;GAKG;AACH,wBAAsB,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAyCvF;AAED,uGAAuG;AACvG,wBAAgB,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG;IAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;IAAC,MAAM,EAAE,OAAO,EAAE,CAAA;CAAE,CA0BtG;AAED,MAAM,WAAW,YAAY;IAC3B,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,kGAAkG;AAClG,MAAM,WAAW,aAAa;IAC5B,2DAA2D;IAC3D,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,2GAA2G;IAC3G,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC9C,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB;AAID;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,CAsDxE;AAcD,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wFAAwF;AACxF,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,QAAQ,EAAE,CAiB5E;AAED,wFAAwF;AACxF,wBAAgB,SAAS,CACvB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,eAAe,GACtB;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,WAAW,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAA;CAAE,EAAE,CAexE;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,2FAA2F;IAC3F,SAAS,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,WAAW,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC;CAC7B;AAED,2FAA2F;AAC3F,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC;IACrB,qGAAqG;IACrG,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,kGAAkG;IAClG,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB;AAqBD;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,GAAG,SAAS,CAsD7E;AAuBD,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC,cAAc,CAGzE;AA6MD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,oBAAoB,GAAG,EAAE,CAAC,IAAI,GAAG,IAAI,CAUjG"}