@nifrajs/cli 4.0.2 → 5.1.0

package/dist/migrate-layout.d.ts

@@ -1,16 +1,28 @@
 import type * as TS from "typescript";
+import { type OutputSchemaEntry } from "./output-schemas.js";
 export interface LayoutMigrationIssue {
     readonly file: string;
     readonly reason: string;
 }
+/** A step left for after the migration that a command takes: it needs no decision, so `ok` ignores it. */
+export interface LayoutMigrationFollowUp {
+    readonly file: string;
+    readonly reason: string;
+    readonly command: string;
+}
 export interface LayoutMigrationResult {
+    /** No issue needs a decision; follow-ups may remain. */
     readonly ok: boolean;
     readonly write: boolean;
+    /** `"api"` for an app that serves no pages: only its backend entry moves, nothing is split or zoned. */
+    readonly mode: "web" | "api";
     /** Route files whose backend exports moved, and where they went. */
     readonly splits: ReadonlyArray<{
         readonly file: string;
         readonly backend: string;
         readonly moved: readonly string[];
+        /** The module beside the route both halves import constant data from, when the split made one. */
+        readonly shared?: string;
     }>;
     /** Files that moved, app-relative. */
     readonly moves: ReadonlyArray<{
@@ -19,10 +31,28 @@ export interface LayoutMigrationResult {
     }>;
     /** Files whose imports were rewritten (and were not otherwise created). */
     readonly rewritten: readonly string[];
+    /** Tooling config the migration updated so it still covers what moved. */
+    readonly tooling: ReadonlyArray<{
+        readonly file: string;
+        readonly change: string;
+    }>;
+    /**
+     * Output schemas drafted for the backend halves the split wrote, from their return types:
+     * `missing` in a dry run, `generated` once written. Each is a draft the author reviews.
+     */
+    readonly schemas: readonly OutputSchemaEntry[];
     readonly issues: readonly LayoutMigrationIssue[];
+    /** Commands to run after the migration, each with what it settles. */
+    readonly followUps: readonly LayoutMigrationFollowUp[];
 }
 export interface LayoutMigrationOptions {
     readonly write?: boolean;
+    /**
+     * Leave the modules the layout would move into `frontend/`, `backend/` or `shared/` where they are,
+     * and list them in the app's `"nifra": { "zones": ... }` instead: the widest folder whose files all
+     * belong to one side, else the file itself. Route splits and the root entry moves still happen.
+     */
+    readonly zones?: boolean;
     /** Inject the TypeScript compiler (tests); defaults to the CLI's own. */
     readonly typescript?: typeof TS;
 }
@@ -30,15 +60,31 @@ export interface SplitResult {
     readonly frontend: string;
     /** `undefined` when the file exports nothing for the server. */
     readonly backend: string | undefined;
+    /** The module beside the route that holds constant data both halves import, when there is any. */
+    readonly shared?: string;
     readonly moved: readonly string[];
     readonly issues: readonly string[];
 }
+/** Options for {@link splitRouteSource}. */
+export interface SplitOptions {
+    /**
+     * The file name of a module beside the route (`index.shared.ts`) to hold constant data both halves
+     * read, which each half then imports. Without it, that data is copied into each half.
+     */
+    readonly sharedFile?: string;
+}
 /**
  * Split one route module's source into its frontend and backend halves. `backendSpecifier` is how the
  * frontend refers to the backend half in an `import type` (`./index.backend.ts`).
  */
-export declare function splitRouteSource(ts: typeof TS, source: string, fileName: string, backendSpecifier: string): SplitResult;
+export declare function splitRouteSource(ts: typeof TS, source: string, fileName: string, backendSpecifier: string, options?: SplitOptions): SplitResult;
 /** `_middleware.ts`'s default export, as the `middleware` export of a `_layout.backend.ts`. */
 export declare function middlewareSource(ts: typeof TS, source: string, fileName: string): string;
 export declare function migrateLayout(appRoot: string, options?: LayoutMigrationOptions): Promise<LayoutMigrationResult>;
+/**
+ * Split one route file in place: its server-only exports, and the code only they use, move into its
+ * `x.backend.ts`, created or merged into. Returns the files written, app-relative; nothing for a file
+ * that exports nothing for the server. Refuses, naming why, a split that would need a decision.
+ */
+export declare function splitRouteFile(appRoot: string, file: string, options?: Pick<LayoutMigrationOptions, "typescript">): Promise<readonly string[]>;
 //# sourceMappingURL=migrate-layout.d.ts.map

package/dist/migrate-layout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migrate-layout.d.ts","sourceRoot":"","sources":["../src/migrate-layout.ts"],"names":[],"mappings":"AA+BA,OAAO,KAAK,KAAK,EAAE,MAAM,YAAY,CAAA;AAkCrC,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;IACvB,oEAAoE;IACpE,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;QAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;QACxB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;KAClC,CAAC,CAAA;IACF,sCAAsC;IACtC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAC7E,2EAA2E;IAC3E,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAA;IACrC,QAAQ,CAAC,MAAM,EAAE,SAAS,oBAAoB,EAAE,CAAA;CACjD;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,yEAAyE;IACzE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAA;CAChC;AAqCD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;IACjC,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAA;CACnC;AAsKD;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,EAAE,EAAE,OAAO,EAAE,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,gBAAgB,EAAE,MAAM,GACvB,WAAW,CAyKb;AAeD,+FAA+F;AAC/F,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CA6BxF;AAkdD,wBAAsB,aAAa,CACjC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,qBAAqB,CAAC,CAyUhC"}
+{"version":3,"file":"migrate-layout.d.ts","sourceRoot":"","sources":["../src/migrate-layout.ts"],"names":[],"mappings":"AA2CA,OAAO,KAAK,KAAK,EAAE,MAAM,YAAY,CAAA;AAOrC,OAAO,EAAE,KAAK,iBAAiB,EAAqB,MAAM,qBAAqB,CAAA;AAgE/E,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AAED,0GAA0G;AAC1G,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,qBAAqB;IACpC,wDAAwD;IACxD,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAA;IACpB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;IACvB,wGAAwG;IACxG,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK,CAAA;IAC5B,oEAAoE;IACpE,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;QAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;QACxB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;QACjC,kGAAkG;QAClG,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KACzB,CAAC,CAAA;IACF,sCAAsC;IACtC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IAC7E,2EAA2E;IAC3E,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAA;IACrC,0EAA0E;IAC1E,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACnF;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,iBAAiB,EAAE,CAAA;IAC9C,QAAQ,CAAC,MAAM,EAAE,SAAS,oBAAoB,EAAE,CAAA;IAChD,sEAAsE;IACtE,QAAQ,CAAC,SAAS,EAAE,SAAS,uBAAuB,EAAE,CAAA;CACvD;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAA;IACxB,yEAAyE;IACzE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,CAAA;CAChC;AA6DD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,kGAAkG;IAClG,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAA;IACjC,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAA;CACnC;AA8OD,4CAA4C;AAC5C,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAC7B;AAiHD;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,EAAE,EAAE,OAAO,EAAE,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,gBAAgB,EAAE,MAAM,EACxB,OAAO,GAAE,YAAiB,GACzB,WAAW,CAmVb;AAsBD,+FAA+F;AAC/F,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CA8BxF;AA88BD,wBAAsB,aAAa,CACjC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,qBAAqB,CAAC,CAi3BhC;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAClC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,IAAI,CAAC,sBAAsB,EAAE,YAAY,CAAM,GACvD,OAAO,CAAC,SAAS,MAAM,EAAE,CAAC,CA0B5B"}