@unieojs/unio-nextjs-adapter 0.1.0 → 0.2.0

package/README.md

@@ -9,8 +9,35 @@ npm i @unieojs/unio-nextjs-adapter --save
 ```
 
 After a Next.js build completes, the adapter writes `.unio/output` with
-`unio.json`, `routes.json`, `middleware.json`, `artifacts.json`, static assets,
-and server function descriptors.
+`unio.json`, `routes.json`, `middleware.json`, `artifacts.json`,
+`features.json`, `observability.json`, static assets, and server function
+descriptors.
+
+Zero-config platform usage can point Next.js at the package entry through
+`adapterPath` or `NEXT_ADAPTER_PATH`.
+
+Projects that need deployment-specific sidecars can create a local adapter
+module and pass extension hooks:
+
+```js
+import { createUnioNextjsAdapter } from "@unieojs/unio-nextjs-adapter";
+
+export default createUnioNextjsAdapter({
+  extendServerFunctionDescriptor({ descriptor, routeGroup }) {
+    return {
+      ...descriptor,
+      "x-example-platform": { routeGroup },
+    };
+  },
+  extendArtifacts({ artifacts }) {
+    return artifacts;
+  },
+  async afterEmit({ outputDir }) {
+    // Write files referenced by extra artifacts here.
+    void outputDir;
+  },
+});
+```
 
 Current support:
 
@@ -20,3 +47,20 @@ Current support:
 - Node.js middleware is represented in `middleware.json` and backed by a
   `serverFunction`.
 - Edge middleware and edge routes fail fast until Unio support lands.
+
+Example output:
+
+```text
+.unio/output/
+  unio.json
+  routes.json
+  middleware.json
+  artifacts.json
+  features.json
+  observability.json
+  static/
+  server-functions/
+    app-routes-api-hello/
+      serverFunction.json
+      .next/server/app/api/hello/route.js
+```

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { NextAdapter } from "./types.js";
+import type { NextAdapter, UnioNextjsAdapterOptions } from "./types.js";
 /**
  * Adapter name. Exported at top level so Next.js can read it when loading
  * via the CJS entry: its `interopDefault(mod) = mod.default` returns the
@@ -6,10 +6,10 @@ import type { NextAdapter } from "./types.js";
  * inside the default export.
  */
 export declare const name = "unio-nextjs-adapter";
+export declare function createUnioNextjsAdapter(options?: UnioNextjsAdapterOptions): NextAdapter;
 export declare const adapter: NextAdapter;
 export default adapter;
 export { modifyConfig } from "./modify-config.js";
 export { onBuildComplete } from "./on-build-complete.js";
 export { emitUboaOutput } from "./uboa.js";
-export { assertSsgOnly } from "./assert-ssg.js";
-export type { BuildContext, ModifyConfigContext, NextAdapter, NextConfigLike, NextPhase, Outputs, PrerenderOutput, RouteOutput, RoutingInfo, StaticFileOutput, } from "./types.js";
+export type { AfterEmitContext, BuildContext, CapabilityStatus, ExtendArtifactsContext, ExtendServerFunctionDescriptorContext, GeneratedUboa, ModifyConfigContext, NextAdapter, NextConfigLike, NextPhase, NextRouteOutputGroup, Outputs, PrerenderOutput, RouteOutput, RoutingInfo, StaticFileOutput, UboaApiSchemaArtifact, UboaApiSchemaFormat, UboaArtifact, UboaArtifactReference, UboaArtifactResourceKind, UboaAssetsRoute, UboaAssetsArtifact, UboaCapabilities, UboaEdgeBundleArtifact, UboaEdgeFunctionRoute, UboaEdgeMiddleware, UboaMiddleware, UboaNodejsMiddleware, UboaRoute, UboaServerFunctionDescriptor, UboaServerFunctionArtifact, UboaServerFunctionRoute, UnioNextjsAdapterOptions, } from "./types.js";

package/dist/index.js

@@ -7,14 +7,16 @@ import { onBuildComplete } from "./on-build-complete.js";
  * inside the default export.
  */
 export const name = "unio-nextjs-adapter";
-export const adapter = {
-    name,
-    modifyConfig,
-    onBuildComplete,
-};
+export function createUnioNextjsAdapter(options = {}) {
+    return {
+        name,
+        modifyConfig,
+        onBuildComplete: (ctx) => onBuildComplete(ctx, options),
+    };
+}
+export const adapter = createUnioNextjsAdapter();
 export default adapter;
 export { modifyConfig } from "./modify-config.js";
 export { onBuildComplete } from "./on-build-complete.js";
 export { emitUboaOutput } from "./uboa.js";
-export { assertSsgOnly } from "./assert-ssg.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAGzD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,qBAAqB,CAAC;AAE1C,MAAM,CAAC,MAAM,OAAO,GAAgB;IAClC,IAAI;IACJ,YAAY;IACZ,eAAe;CAChB,CAAC;AAEF,eAAe,OAAO,CAAC;AAEvB,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAGzD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,qBAAqB,CAAC;AAE1C,MAAM,UAAU,uBAAuB,CACrC,UAAoC,EAAE;IAEtC,OAAO;QACL,IAAI;QACJ,YAAY;QACZ,eAAe,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,EAAE,OAAO,CAAC;KACxD,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,OAAO,GAAgB,uBAAuB,EAAE,CAAC;AAE9D,eAAe,OAAO,CAAC;AAEvB,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC"}

package/dist/on-build-complete.d.ts

@@ -1,2 +1,2 @@
-import type { BuildContext } from "./types.js";
-export declare function onBuildComplete(ctx: BuildContext): Promise<void>;
+import type { BuildContext, UnioNextjsAdapterOptions } from "./types.js";
+export declare function onBuildComplete(ctx: BuildContext, options?: UnioNextjsAdapterOptions): Promise<void>;

package/dist/on-build-complete.js

@@ -23,6 +23,7 @@ async function cleanIntermediate(intermediateDir, protectedDirs) {
             return false;
     }
     try {
+        await fs.access(target);
         await fs.rm(target, { recursive: true, force: true });
         return true;
     }
@@ -30,9 +31,12 @@ async function cleanIntermediate(intermediateDir, protectedDirs) {
         return false;
     }
 }
-export async function onBuildComplete(ctx) {
+export async function onBuildComplete(ctx, options = {}) {
     const { projectDir, distDir } = ctx;
-    const uboa = await emitUboaOutput(ctx);
+    const uboa = await emitUboaOutput(ctx, options);
+    await logAndClean(uboa, projectDir, distDir);
+}
+async function logAndClean(uboa, projectDir, distDir) {
     const uboaOutputDir = path.resolve(projectDir, ".unio", "output");
     const intermediates = new Set();
     intermediates.add(path.resolve(projectDir, "out"));
@@ -41,7 +45,8 @@ export async function onBuildComplete(ctx) {
     for (const dir of intermediates) {
         const cleaned = await cleanIntermediate(dir, [projectDir, uboaOutputDir]);
         if (cleaned) {
-            console.log(`${LOG_PREFIX}   cleaned intermediate ${path.relative(projectDir, dir) || dir}/`);
+            const label = path.relative(projectDir, dir) || dir;
+            console.log(`${LOG_PREFIX}   cleaned intermediate ${label}/`);
         }
     }
     console.log(`${LOG_PREFIX} ✔ .unio/output ready: ` +

package/dist/on-build-complete.js.map

@@ -1 +1 @@
-{"version":3,"file":"on-build-complete.js","sourceRoot":"","sources":["../src/on-build-complete.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAG3C,MAAM,UAAU,GAAG,uBAAuB,CAAC;AAE3C;;;;;;;;GAQG;AACH,KAAK,UAAU,iBAAiB,CAC9B,eAAuB,EACvB,aAAuB;IAEvB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAE7C,KAAK,MAAM,CAAC,IAAI,aAAa,EAAE,CAAC;QAC9B,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,MAAM,KAAK,YAAY;YAAE,OAAO,KAAK,CAAC;QAC1C,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,GAAG,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC9E,IAAI,QAAQ;YAAE,OAAO,KAAK,CAAC;IAC7B,CAAC;IAED,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,GAAiB;IACrD,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC;IAEpC,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,CAAC;IACvC,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAElE,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;IACxC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;IACnD,IAAI,OAAO;QAAE,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAEtD,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC;QAC1E,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,GAAG,UAAU,2BAA2B,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CACT,GAAG,UAAU,yBAAyB;QACpC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,aAAa,IAAI,CAAC,UAAU,CAAC,MAAM,gBAAgB;QACxE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,YAAY,CACvC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"on-build-complete.js","sourceRoot":"","sources":["../src/on-build-complete.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAG3C,MAAM,UAAU,GAAG,uBAAuB,CAAC;AAE3C;;;;;;;;GAQG;AACH,KAAK,UAAU,iBAAiB,CAC9B,eAAuB,EACvB,aAAuB;IAEvB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAE7C,KAAK,MAAM,CAAC,IAAI,aAAa,EAAE,CAAC;QAC9B,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,MAAM,KAAK,YAAY;YAAE,OAAO,KAAK,CAAC;QAC1C,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,GAAG,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAC9E,IAAI,QAAQ;YAAE,OAAO,KAAK,CAAC;IAC7B,CAAC;IAED,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACxB,MAAM,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,GAAiB,EACjB,UAAoC,EAAE;IAEtC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC;IAEpC,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAChD,MAAM,WAAW,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AAC/C,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,IAAgD,EAChD,UAAkB,EAClB,OAAe;IAEf,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAElE,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;IACxC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC;IACnD,IAAI,OAAO;QAAE,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAEtD,KAAK,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC;QAC1E,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,GAAG,CAAC;YACpD,OAAO,CAAC,GAAG,CAAC,GAAG,UAAU,2BAA2B,KAAK,GAAG,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CACT,GAAG,UAAU,yBAAyB;QACpC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,aAAa,IAAI,CAAC,UAAU,CAAC,MAAM,gBAAgB;QACxE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,YAAY,CACvC,CAAC;AACJ,CAAC"}

package/dist/types.d.ts

@@ -56,7 +56,11 @@ export interface BuildContext {
     distDir: string;
     /** Absolute project root */
     projectDir: string;
+    /** Absolute repository root, when Next.js provides it */
+    repoRoot?: string;
     config: NextConfigLike;
+    nextVersion?: string;
+    buildId?: string;
 }
 /**
  * Second argument Next.js passes to `modifyConfig`. Verified against
@@ -73,3 +77,130 @@ export interface NextAdapter {
     modifyConfig?: (config: NextConfigLike, ctx: ModifyConfigContext) => NextConfigLike | Promise<NextConfigLike>;
     onBuildComplete?: (ctx: BuildContext) => void | Promise<void>;
 }
+export type CapabilityStatus = "supported" | "partial" | "degraded" | "unsupported";
+export interface UboaCapabilities {
+    static: CapabilityStatus;
+    routes: CapabilityStatus;
+    serverlessFunction: CapabilityStatus;
+    serverFunctionIntrospection: CapabilityStatus;
+    restRouteIntrospection: CapabilityStatus;
+    edgeMiddleware: CapabilityStatus;
+    isr: CapabilityStatus;
+    imageOptimization: CapabilityStatus;
+}
+interface UboaRouteBase {
+    id: string;
+    match: string;
+}
+export interface UboaAssetsRoute extends UboaRouteBase {
+    type: "assets";
+    entry: string;
+    serverFunction?: never;
+    edgeFunction?: never;
+    methods?: never;
+}
+export interface UboaServerFunctionRoute extends UboaRouteBase {
+    type: "serverFunction";
+    serverFunction: string;
+    methods?: string[];
+    entry?: never;
+    edgeFunction?: never;
+}
+export interface UboaEdgeFunctionRoute extends UboaRouteBase {
+    type: "edgeFunction";
+    edgeFunction: string;
+    entry?: never;
+    serverFunction?: never;
+    methods?: never;
+}
+export type UboaRoute = UboaAssetsRoute | UboaServerFunctionRoute | UboaEdgeFunctionRoute;
+interface UboaMiddlewareBase {
+    name: string;
+    match: string[];
+}
+export interface UboaEdgeMiddleware extends UboaMiddlewareBase {
+    runtime: "edge";
+    entry: string;
+    serverFunction?: never;
+}
+export interface UboaNodejsMiddleware extends UboaMiddlewareBase {
+    runtime: "nodejs";
+    serverFunction: string;
+    entry?: never;
+}
+export type UboaMiddleware = UboaEdgeMiddleware | UboaNodejsMiddleware;
+export type UboaArtifactResourceKind = "assets" | "serverFunction" | "edgeBundle" | "apiSchema";
+export interface UboaAssetsArtifact {
+    id: string;
+    resourceKind: "assets";
+    path: string;
+}
+export interface UboaServerFunctionArtifact {
+    id: string;
+    resourceKind: "serverFunction";
+    path: string;
+}
+export interface UboaEdgeBundleArtifact {
+    id: string;
+    resourceKind: "edgeBundle";
+    path: string;
+}
+export interface UboaArtifactReference {
+    id: string;
+    resourceKind: UboaArtifactResourceKind;
+}
+export type UboaApiSchemaFormat = "oneapi";
+export interface UboaApiSchemaArtifact {
+    id: string;
+    resourceKind: "apiSchema";
+    path: string;
+    schemaFormat: UboaApiSchemaFormat;
+    describes?: UboaArtifactReference;
+}
+export type UboaArtifact = UboaAssetsArtifact | UboaServerFunctionArtifact | UboaEdgeBundleArtifact | UboaApiSchemaArtifact;
+export interface UboaServerFunctionDescriptor {
+    name: string;
+    runtime: string;
+    entry: string;
+    handler: string;
+    memory: number;
+    maxDuration: number;
+    environment: Record<string, unknown>;
+    bindings: Record<string, unknown>;
+    framework: Record<string, unknown>;
+    source: Record<string, unknown>;
+    [key: string]: unknown;
+}
+export type NextRouteOutputGroup = "pages" | "pagesApi" | "appPages" | "appRoutes" | "middleware";
+export interface GeneratedUboa {
+    outputDir: string;
+    routes: UboaRoute[];
+    middleware: UboaMiddleware[];
+    artifacts: UboaArtifact[];
+    capabilities: UboaCapabilities;
+    warnings: string[];
+}
+export interface ExtendServerFunctionDescriptorContext {
+    descriptor: UboaServerFunctionDescriptor;
+    name: string;
+    route: RouteOutput;
+    routeGroup: NextRouteOutputGroup;
+    ctx: BuildContext;
+}
+export interface ExtendArtifactsContext {
+    artifacts: UboaArtifact[];
+    routes: UboaRoute[];
+    middleware: UboaMiddleware[];
+    ctx: BuildContext;
+}
+export interface AfterEmitContext {
+    outputDir: string;
+    generated: GeneratedUboa;
+    ctx: BuildContext;
+}
+export interface UnioNextjsAdapterOptions {
+    extendServerFunctionDescriptor?: (context: ExtendServerFunctionDescriptorContext) => Record<string, unknown> | Promise<Record<string, unknown>>;
+    extendArtifacts?: (context: ExtendArtifactsContext) => UboaArtifact[] | Promise<UboaArtifact[]>;
+    afterEmit?: (context: AfterEmitContext) => void | Promise<void>;
+}
+export {};

package/dist/uboa.d.ts

@@ -1,26 +1,2 @@
-import type { BuildContext } from "./types.js";
-interface UboaRoute {
-    id: string;
-    match: string;
-    type: "static" | "serverFunction";
-    entry?: string;
-    serverFunction?: string;
-}
-interface UboaMiddleware {
-    name: string;
-    match: string[];
-    runtime: "serverless";
-    serverFunction?: string;
-}
-interface UboaArtifact {
-    id: string;
-    resourceKind: "assets" | "serverFunction";
-    path: string;
-}
-interface GeneratedUboa {
-    routes: UboaRoute[];
-    middleware: UboaMiddleware[];
-    artifacts: UboaArtifact[];
-}
-export declare function emitUboaOutput(ctx: BuildContext): Promise<GeneratedUboa>;
-export {};
+import type { BuildContext, GeneratedUboa, UnioNextjsAdapterOptions } from "./types.js";
+export declare function emitUboaOutput(ctx: BuildContext, options?: UnioNextjsAdapterOptions): Promise<GeneratedUboa>;