@exposify/next 0.0.0-stage → 0.0.2

package/dist/config.d.cts

@@ -0,0 +1,191 @@
+import { LoginField, ProposedField } from '@exposify/core';
+import { A as ActionField } from './fields-olvyFnxj.cjs';
+
+/** What the generator writes to the manifest. */
+type FoundLogin = {
+    kind: "action";
+    key: string;
+    export: string;
+    file: string;
+    fields: LoginField[];
+    host?: string;
+} | {
+    kind: "route";
+    path: string;
+    file: string;
+    fields: LoginField[];
+    body: "json" | "form";
+};
+
+interface FoundPage {
+    file: string;
+    /** `/product/:slug`, as routes are written. */
+    path: string;
+    params: string[];
+    /** Tool name: `view_` and the path, snake_cased (`view_product_slug`, `/` is `view_home`). */
+    name: string;
+    /** Search params the page (or a client component it renders) reads: optional tool arguments. */
+    search: string[];
+    /** From `export const metadata`, when it's static. */
+    title?: string;
+    description?: string;
+    /** It renders a form posting to a Server Action and reads no data of its own: hidden by default. */
+    formOnly?: boolean;
+    /** The app's checks it runs first (guards.ts). */
+    guards?: string[];
+}
+
+type MarkerKind = "exposed" | "hidden" | "described";
+interface StaticMarker {
+    kind: MarkerKind;
+    name?: string;
+    description?: string;
+    /** describe()'s `input`, as written (for Server Actions, which the CLI checks against the scan). */
+    input?: WrittenInput;
+}
+/** A hand-written zod input shape as the CLI reads it: field names, and z.enum()'s values; "opaque" when it isn't an object literal. */
+type WrittenInput = Record<string, {
+    enum?: string[];
+}> | "opaque";
+interface RouteModule {
+    /** HTTP methods the module exports (App Router), in HTTP_METHODS order. */
+    methods: string[];
+    /** `export const runtime = "edge"`. */
+    edge: boolean;
+    /** It imports aiReady from @exposify/next: the MCP route itself. */
+    mcpRoute: boolean;
+    /** Wrappers found on exported methods, e.g. `export const POST = exposed(...)`. */
+    markers: Record<string, StaticMarker>;
+    /** Each exported method's handler source, capped, for `describe`. */
+    sources: Record<string, string>;
+}
+interface PagesMethods {
+    methods: string[];
+    via: "if" | "switch" | "next-connect";
+}
+/**
+ * How each of a Server Action's parameters is filled when an agent calls it:
+ * `formData` gets the fields as FormData, `prev` (useActionState's previous
+ * state) gets undefined, `input` is a named argument of its own (bound with
+ * `.bind`, or passed directly by client code), and `object` (a destructured
+ * parameter) gets every field as a plain object.
+ */
+type ActionParamRole = "formData" | "prev" | "input" | "object";
+interface ActionParam {
+    name: string;
+    role: ActionParamRole;
+}
+interface ActionExport {
+    /** The export name; "default" for a default export. */
+    name: string;
+    line: number;
+    params: ActionParam[];
+    /** Calls `cookies().set` or `.delete` (itself or through a same-file helper). */
+    setsCookies: boolean;
+    /** False when the function couldn't be found in the file (e.g. re-exported from another module): its parameters are unknown. */
+    resolved: boolean;
+    marker?: StaticMarker;
+    /** The function's source, capped, for `describe`. */
+    source?: string;
+    /** Pass 2: its parameters and the form fields it reads (fields.ts). */
+    fields: ActionField[];
+    readsAll: boolean;
+    unresolved: string[];
+    /** Pass 3: the forms that submit to it (forms.ts `linkForms`). */
+    forms?: Array<{
+        file: string;
+        line: number;
+    }>;
+}
+interface InlineAction {
+    /** The function's name, or the variable it's assigned to, when it has one. */
+    name?: string;
+    line: number;
+}
+
+interface GenerateOptions {
+    /** Output file, relative to the project root. Default: exposify.generated.ts (.js without a tsconfig.json). */
+    out?: string;
+    /** Docs globs for search_docs. Default: README.md, docs/**\/*.md. */
+    docs?: string[];
+    /** From next.config. */
+    pageExtensions?: string[];
+    basePath?: string;
+    trailingSlash?: boolean;
+}
+interface FoundAppRoute {
+    router: "app";
+    file: string;
+    path: string;
+    params: string[];
+    module: RouteModule;
+}
+interface FoundPagesRoute {
+    router: "pages";
+    file: string;
+    path: string;
+    params: string[];
+    detected: PagesMethods | null;
+    source?: string;
+}
+interface FoundAction {
+    file: string;
+    /** Unique among the app's actions: the default tool name, and the URL segment under `/mcp/actions/`. */
+    key: string;
+    action: ActionExport;
+    /** An input `describe` proposed and a person accepted (exposify.descriptions.json); "stale" when the action changed since. */
+    proposed?: {
+        fields: ProposedField[];
+        status: "current" | "stale";
+    };
+    /** A page that uses it (`/checkout`, `/admin/orders/:id`), which tool calls are sent to; absent when no page does (hosts.ts). */
+    host?: string;
+    /** The app's checks it runs first (`lib/auth.ts#requireAdmin`), guards.ts. */
+    guards?: string[];
+}
+interface Discovery {
+    root: string;
+    /** `app` or `src/app`, when present. */
+    appDir?: string;
+    pagesDir?: string;
+    routes: Array<FoundAppRoute | FoundPagesRoute>;
+    /** The route file that imports aiReady, when there is one. */
+    mcpRoute?: {
+        file: string;
+        source: string;
+    };
+    /** The MCP route's URL without its catch-all segment (`/mcp`); absent when it isn't a catch-all, which Server Actions need. */
+    mcpPath?: string;
+    /** Exported functions of `"use server"` modules. */
+    actions: FoundAction[];
+    /** `"use server"` functions inside other code, which can't be exposed. */
+    inlineActions: Array<InlineAction & {
+        file: string;
+    }>;
+    /** App Router pages, as read tools (pages.ts). */
+    pages: FoundPage[];
+    /** The app's own login, for Connect with no code (login.ts); the other candidates, for `inspect`. */
+    login?: FoundLogin;
+    loginOthers?: FoundLogin[];
+}
+interface GenerateResult {
+    /** Absolute path written. */
+    file: string;
+    changed: boolean;
+    discovery: Discovery;
+}
+/** Discovers routes and (re)writes the manifest; only touches the file when its content changes, so dev reloads don't loop. */
+declare function generate(root: string, opts?: GenerateOptions, warn?: (message: string) => void): GenerateResult;
+
+interface WithExposifyOptions extends Pick<GenerateOptions, "out" | "docs"> {
+    /** Project root. Default: process.cwd(), where Next runs. */
+    root?: string;
+}
+type ConfigInput<C> = C | ((phase: string, ctx: {
+    defaultConfig: unknown;
+}) => C | Promise<C>);
+declare function withExposify<C extends object>(nextConfig?: ConfigInput<C>, options?: WithExposifyOptions): (phase: string, ctx: {
+    defaultConfig: unknown;
+}) => Promise<C>;
+
+export { type GenerateOptions, type WithExposifyOptions, generate, withExposify };

package/dist/config.d.ts

@@ -0,0 +1,191 @@
+import { LoginField, ProposedField } from '@exposify/core';
+import { A as ActionField } from './fields-olvyFnxj.js';
+
+/** What the generator writes to the manifest. */
+type FoundLogin = {
+    kind: "action";
+    key: string;
+    export: string;
+    file: string;
+    fields: LoginField[];
+    host?: string;
+} | {
+    kind: "route";
+    path: string;
+    file: string;
+    fields: LoginField[];
+    body: "json" | "form";
+};
+
+interface FoundPage {
+    file: string;
+    /** `/product/:slug`, as routes are written. */
+    path: string;
+    params: string[];
+    /** Tool name: `view_` and the path, snake_cased (`view_product_slug`, `/` is `view_home`). */
+    name: string;
+    /** Search params the page (or a client component it renders) reads: optional tool arguments. */
+    search: string[];
+    /** From `export const metadata`, when it's static. */
+    title?: string;
+    description?: string;
+    /** It renders a form posting to a Server Action and reads no data of its own: hidden by default. */
+    formOnly?: boolean;
+    /** The app's checks it runs first (guards.ts). */
+    guards?: string[];
+}
+
+type MarkerKind = "exposed" | "hidden" | "described";
+interface StaticMarker {
+    kind: MarkerKind;
+    name?: string;
+    description?: string;
+    /** describe()'s `input`, as written (for Server Actions, which the CLI checks against the scan). */
+    input?: WrittenInput;
+}
+/** A hand-written zod input shape as the CLI reads it: field names, and z.enum()'s values; "opaque" when it isn't an object literal. */
+type WrittenInput = Record<string, {
+    enum?: string[];
+}> | "opaque";
+interface RouteModule {
+    /** HTTP methods the module exports (App Router), in HTTP_METHODS order. */
+    methods: string[];
+    /** `export const runtime = "edge"`. */
+    edge: boolean;
+    /** It imports aiReady from @exposify/next: the MCP route itself. */
+    mcpRoute: boolean;
+    /** Wrappers found on exported methods, e.g. `export const POST = exposed(...)`. */
+    markers: Record<string, StaticMarker>;
+    /** Each exported method's handler source, capped, for `describe`. */
+    sources: Record<string, string>;
+}
+interface PagesMethods {
+    methods: string[];
+    via: "if" | "switch" | "next-connect";
+}
+/**
+ * How each of a Server Action's parameters is filled when an agent calls it:
+ * `formData` gets the fields as FormData, `prev` (useActionState's previous
+ * state) gets undefined, `input` is a named argument of its own (bound with
+ * `.bind`, or passed directly by client code), and `object` (a destructured
+ * parameter) gets every field as a plain object.
+ */
+type ActionParamRole = "formData" | "prev" | "input" | "object";
+interface ActionParam {
+    name: string;
+    role: ActionParamRole;
+}
+interface ActionExport {
+    /** The export name; "default" for a default export. */
+    name: string;
+    line: number;
+    params: ActionParam[];
+    /** Calls `cookies().set` or `.delete` (itself or through a same-file helper). */
+    setsCookies: boolean;
+    /** False when the function couldn't be found in the file (e.g. re-exported from another module): its parameters are unknown. */
+    resolved: boolean;
+    marker?: StaticMarker;
+    /** The function's source, capped, for `describe`. */
+    source?: string;
+    /** Pass 2: its parameters and the form fields it reads (fields.ts). */
+    fields: ActionField[];
+    readsAll: boolean;
+    unresolved: string[];
+    /** Pass 3: the forms that submit to it (forms.ts `linkForms`). */
+    forms?: Array<{
+        file: string;
+        line: number;
+    }>;
+}
+interface InlineAction {
+    /** The function's name, or the variable it's assigned to, when it has one. */
+    name?: string;
+    line: number;
+}
+
+interface GenerateOptions {
+    /** Output file, relative to the project root. Default: exposify.generated.ts (.js without a tsconfig.json). */
+    out?: string;
+    /** Docs globs for search_docs. Default: README.md, docs/**\/*.md. */
+    docs?: string[];
+    /** From next.config. */
+    pageExtensions?: string[];
+    basePath?: string;
+    trailingSlash?: boolean;
+}
+interface FoundAppRoute {
+    router: "app";
+    file: string;
+    path: string;
+    params: string[];
+    module: RouteModule;
+}
+interface FoundPagesRoute {
+    router: "pages";
+    file: string;
+    path: string;
+    params: string[];
+    detected: PagesMethods | null;
+    source?: string;
+}
+interface FoundAction {
+    file: string;
+    /** Unique among the app's actions: the default tool name, and the URL segment under `/mcp/actions/`. */
+    key: string;
+    action: ActionExport;
+    /** An input `describe` proposed and a person accepted (exposify.descriptions.json); "stale" when the action changed since. */
+    proposed?: {
+        fields: ProposedField[];
+        status: "current" | "stale";
+    };
+    /** A page that uses it (`/checkout`, `/admin/orders/:id`), which tool calls are sent to; absent when no page does (hosts.ts). */
+    host?: string;
+    /** The app's checks it runs first (`lib/auth.ts#requireAdmin`), guards.ts. */
+    guards?: string[];
+}
+interface Discovery {
+    root: string;
+    /** `app` or `src/app`, when present. */
+    appDir?: string;
+    pagesDir?: string;
+    routes: Array<FoundAppRoute | FoundPagesRoute>;
+    /** The route file that imports aiReady, when there is one. */
+    mcpRoute?: {
+        file: string;
+        source: string;
+    };
+    /** The MCP route's URL without its catch-all segment (`/mcp`); absent when it isn't a catch-all, which Server Actions need. */
+    mcpPath?: string;
+    /** Exported functions of `"use server"` modules. */
+    actions: FoundAction[];
+    /** `"use server"` functions inside other code, which can't be exposed. */
+    inlineActions: Array<InlineAction & {
+        file: string;
+    }>;
+    /** App Router pages, as read tools (pages.ts). */
+    pages: FoundPage[];
+    /** The app's own login, for Connect with no code (login.ts); the other candidates, for `inspect`. */
+    login?: FoundLogin;
+    loginOthers?: FoundLogin[];
+}
+interface GenerateResult {
+    /** Absolute path written. */
+    file: string;
+    changed: boolean;
+    discovery: Discovery;
+}
+/** Discovers routes and (re)writes the manifest; only touches the file when its content changes, so dev reloads don't loop. */
+declare function generate(root: string, opts?: GenerateOptions, warn?: (message: string) => void): GenerateResult;
+
+interface WithExposifyOptions extends Pick<GenerateOptions, "out" | "docs"> {
+    /** Project root. Default: process.cwd(), where Next runs. */
+    root?: string;
+}
+type ConfigInput<C> = C | ((phase: string, ctx: {
+    defaultConfig: unknown;
+}) => C | Promise<C>);
+declare function withExposify<C extends object>(nextConfig?: ConfigInput<C>, options?: WithExposifyOptions): (phase: string, ctx: {
+    defaultConfig: unknown;
+}) => Promise<C>;
+
+export { type GenerateOptions, type WithExposifyOptions, generate, withExposify };