@frontmcp/sdk 0.1.0

package/src/metadata/app.metadata.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.frontMcpRemoteAppMetadataSchema = exports.frontMcpLocalAppMetadataSchema = void 0;
+const zod_1 = require("zod");
+const types_1 = require("../types");
+const schemas_1 = require("../schemas");
+exports.frontMcpLocalAppMetadataSchema = zod_1.z.object({
+    id: zod_1.z.string().optional(),
+    name: zod_1.z.string().min(1),
+    description: zod_1.z.string().optional(),
+    providers: zod_1.z.array(schemas_1.annotatedFrontMcpProvidersSchema).optional().default([]),
+    authProviders: zod_1.z.array(schemas_1.annotatedFrontMcpAuthProvidersSchema).optional().default([]),
+    plugins: zod_1.z.array(schemas_1.annotatedFrontMcpPluginsSchema).optional(),
+    adapters: zod_1.z.array(schemas_1.annotatedFrontMcpAdaptersSchema).optional(),
+    tools: zod_1.z.array(schemas_1.annotatedFrontMcpToolsSchema).optional(),
+    resources: zod_1.z.array(schemas_1.annotatedFrontMcpResourcesSchema).optional(),
+    prompts: zod_1.z.array(schemas_1.annotatedFrontMcpPromptsSchema).optional(),
+    auth: types_1.authOptionsSchema.optional(),
+    standalone: zod_1.z.union([zod_1.z.literal('includeInParent'), zod_1.z.boolean()]).optional().default(false),
+}).passthrough();
+exports.frontMcpRemoteAppMetadataSchema = zod_1.z.object({
+    id: zod_1.z.string().optional(),
+    name: zod_1.z.string().min(1),
+    description: zod_1.z.string().optional(),
+    urlType: zod_1.z.enum(['worker', 'url']),
+    url: zod_1.z.string().url(),
+    auth: types_1.authOptionsSchema.optional(),
+    standalone: zod_1.z.union([zod_1.z.literal('includeInParent'), zod_1.z.boolean()]).optional().default(false),
+}).passthrough();
+//# sourceMappingURL=app.metadata.js.map

package/src/metadata/app.metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.metadata.js","sourceRoot":"","sources":["../../../src/metadata/app.metadata.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,oCAAuE;AAUvE,wCAIoB;AA0FP,QAAA,8BAA8B,GAAG,OAAC,CAAC,MAAM,CAAC;IACrD,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,0CAAgC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC3E,aAAa,EAAE,OAAC,CAAC,KAAK,CAAC,8CAAoC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnF,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,wCAA8B,CAAC,CAAC,QAAQ,EAAE;IAC3D,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,yCAA+B,CAAC,CAAC,QAAQ,EAAE;IAC7D,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,sCAA4B,CAAC,CAAC,QAAQ,EAAE;IACvD,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,0CAAgC,CAAC,CAAC,QAAQ,EAAE;IAC/D,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,wCAA8B,CAAC,CAAC,QAAQ,EAAE;IAC3D,IAAI,EAAE,yBAAiB,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CACnD,CAAC,CAAC,WAAW,EAAE,CAAC;AAmD5C,QAAA,+BAA+B,GAAG,OAAC,CAAC,MAAM,CAAC;IACtD,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,OAAO,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAClC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrB,IAAI,EAAE,yBAAiB,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CAClD,CAAC,CAAC,WAAW,EAAE,CAAC","sourcesContent":["import { z } from 'zod';\nimport { RawZodShape, AuthOptions, authOptionsSchema } from '../types';\nimport {\n  ProviderType,\n  PromptType,\n  ResourceType,\n  ToolType,\n  AuthProviderType,\n  PluginType,\n  AdapterType,\n} from '../interfaces';\nimport {\n  annotatedFrontMcpAdaptersSchema, annotatedFrontMcpAuthProvidersSchema,\n  annotatedFrontMcpPluginsSchema, annotatedFrontMcpPromptsSchema,\n  annotatedFrontMcpProvidersSchema, annotatedFrontMcpResourcesSchema, annotatedFrontMcpToolsSchema,\n} from '../schemas';\n\n\n/**\n * Declarative metadata describing what a local mcp app contributes at app scope.\n *\n * Includes dependency providers, app-scoped plugins, adapters (that can\n * generate tools/resources/prompts from external definitions), and any\n * inline tools authored in the app. Adapter-generated items inherit the\n * app’s plugins and policies and are tagged with provenance.\n */\nexport interface LocalAppMetadata {\n  /**\n   * Human-friendly name for this app as shown in UIs, logs, and describe reports.\n   * Keep it short, stable, and unique within a gateway (consider prefixes).\n   */\n  id?: string;\n  /**\n   * Human-friendly name for this app as shown in UIs, logs, and describe reports.\n   * Keep it short, stable, and unique within a gateway (consider prefixes).\n   */\n  name: string;\n\n  /**\n   * Optional longer explanation of what the app does and what it exposes.\n   * Used for documentation, describe reports, and UIs. Avoid secrets/PII.\n   */\n  description?: string;\n\n  /**\n   * Named singleton (or scoped-singleton) dependencies used by tools/plugins at runtime\n   * — e.g., config, database pools, Redis clients, queues, KMS.\n   *\n   * Resolution is hierarchical (tool → app → gateway). Providers may depend on\n   * other providers and are usually initialized lazily on first use.\n   */\n  providers?: ProviderType[];\n\n  /**\n   * Named singleton / session auth provider to be used by tools/plugins at runtime\n   * — e.g., GithubAuthProvider, GoogleAuthProvider, etc.\n   *\n   * Note: this is different from providers, which are used for calling fetch request\n   *     with specific auth context headers.\n   *\n   * Resolution is hierarchical (tool → app → gateway). Providers may depend on\n   * other providers and are usually initialized lazily on first use.\n   */\n  authProviders?: AuthProviderType[];\n\n  /**\n   * App-scoped plugins that participate in lifecycle events and can contribute\n   * additional capabilities (tools, resources, prompts, providers, adapters).\n   * Use plugins to enforce policy, auth, PII reduction, tracing, etc.\n   */\n  plugins?: PluginType[];\n\n  /**\n   * Adapters attached to this app that convert external definitions or sources\n   * (e.g., OpenAPI, Lambda, Custom) into generated tools/resources/prompts.\n   * Common options include include/exclude filters, name prefixes, base URLs,\n   * and authentication (often provided by plugins).\n   */\n  adapters?: AdapterType[];\n\n  /**\n   * Inline tools authored by this app (via builder or class). These are active\n   * actions with input/output schemas that the model can call. Tools generated\n   * by adapters do not need to be listed here.\n   */\n  tools?: ToolType[];\n  resources?: ResourceType[];\n  prompts?: PromptType[];\n\n\n  /**\n   * Configures the app's default authentication provider.\n   * If not provided, the app will use the gateway's default auth provider.\n   */\n  auth?: AuthOptions;\n\n  /**\n   * If true, the app will NOT be included and will act as a separated scope.\n   * If false, the app will be included in MultiApp frontmcp server.\n   * If 'includeInParent', the app will be included in the gateway's\n   *    standalone app list and will act as a separated scope under the appName prefix\n   */\n  standalone?: 'includeInParent' | boolean;\n}\n\nexport const frontMcpLocalAppMetadataSchema = z.object({\n  id: z.string().optional(),\n  name: z.string().min(1),\n  description: z.string().optional(),\n  providers: z.array(annotatedFrontMcpProvidersSchema).optional().default([]),\n  authProviders: z.array(annotatedFrontMcpAuthProvidersSchema).optional().default([]),\n  plugins: z.array(annotatedFrontMcpPluginsSchema).optional(),\n  adapters: z.array(annotatedFrontMcpAdaptersSchema).optional(),\n  tools: z.array(annotatedFrontMcpToolsSchema).optional(),\n  resources: z.array(annotatedFrontMcpResourcesSchema).optional(),\n  prompts: z.array(annotatedFrontMcpPromptsSchema).optional(),\n  auth: authOptionsSchema.optional(),\n  standalone: z.union([z.literal('includeInParent'), z.boolean()]).optional().default(false),\n} satisfies RawZodShape<LocalAppMetadata>).passthrough();\n\n\n/**\n * Declarative metadata describing what a remote encapsulated mcp app.\n */\nexport interface RemoteAppMetadata {\n  /**\n   * Human-friendly name for this app as shown in UIs, logs, and describe reports.\n   * Keep it short, stable, and unique within a gateway (consider prefixes).\n   */\n  id?: string;\n  /**\n   * Human-friendly name for this app as shown in UIs, logs, and describe reports.\n   * Keep it short, stable, and unique within a gateway (consider prefixes).\n   */\n  name: string;\n\n  /**\n   * Optional longer explanation of what the app does and what it exposes.\n   * Used for documentation, describe reports, and UIs. Avoid secrets/PII.\n   */\n  description?: string;\n\n  /**\n   * The type of the remote app.\n   * - 'worker': The remote app is a worker file.\n   * - 'url': The remote app is a remote URL.\n   */\n  urlType: 'worker' | 'url';\n  /**\n   * The URL of the remote app. This can be a local worker file or a remote URL.\n   */\n  url: string;\n\n  /**\n   * Configures the app's default authentication provider.\n   * If not provided, the app will use the gateway's default auth provider.\n   */\n  auth?: AuthOptions;\n\n  /**\n   * If true, the app will NOT be included and will act as a separated scope.\n   * If false, the app will be included in MultiApp frontmcp server.\n   * If 'includeInParent', the app will be included in the gateway's\n   *    standalone app list and will act as a separated scope under the appName prefix\n   */\n  standalone: 'includeInParent' | boolean;\n\n}\n\nexport const frontMcpRemoteAppMetadataSchema = z.object({\n  id: z.string().optional(),\n  name: z.string().min(1),\n  description: z.string().optional(),\n  urlType: z.enum(['worker', 'url']),\n  url: z.string().url(),\n  auth: authOptionsSchema.optional(),\n  standalone: z.union([z.literal('includeInParent'), z.boolean()]).optional().default(false),\n} satisfies RawZodShape<RemoteAppMetadata>).passthrough();\n\n\nexport type AppMetadata = LocalAppMetadata | RemoteAppMetadata;\n"]}

package/src/metadata/auth-provider.metadata.d.ts

@@ -0,0 +1,33 @@
+import { z } from 'zod';
+/**
+ * Declarative metadata describing what a FrontMcpProvider contributes at app scope.
+ */
+export interface AuthProviderMetadata {
+    id?: string;
+    name: string;
+    description?: string;
+    scope?: AuthProviderScope;
+}
+/**
+ * Provider lifetime scope semantics.
+ */
+export declare enum AuthProviderScope {
+    GLOBAL = "global",
+    SESSION = "session"
+}
+export declare const frontMcpAuthProviderMetadataSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    scope: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof AuthProviderScope>>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    id: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    scope: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof AuthProviderScope>>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    id: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    scope: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof AuthProviderScope>>>;
+}, z.ZodTypeAny, "passthrough">>;

package/src/metadata/auth-provider.metadata.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.frontMcpAuthProviderMetadataSchema = exports.AuthProviderScope = void 0;
+const zod_1 = require("zod");
+/**
+ * Provider lifetime scope semantics.
+ */
+var AuthProviderScope;
+(function (AuthProviderScope) {
+    AuthProviderScope["GLOBAL"] = "global";
+    AuthProviderScope["SESSION"] = "session";
+})(AuthProviderScope || (exports.AuthProviderScope = AuthProviderScope = {}));
+exports.frontMcpAuthProviderMetadataSchema = zod_1.z.object({
+    id: zod_1.z.string().optional(),
+    name: zod_1.z.string().min(1),
+    description: zod_1.z.string().optional(),
+    scope: zod_1.z.nativeEnum(AuthProviderScope).optional().default(AuthProviderScope.GLOBAL),
+}).passthrough();
+//# sourceMappingURL=auth-provider.metadata.js.map

package/src/metadata/auth-provider.metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-provider.metadata.js","sourceRoot":"","sources":["../../../src/metadata/auth-provider.metadata.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAaxB;;GAEG;AACH,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,sCAAiB,CAAA;IACjB,wCAAmB,CAAA;AACrB,CAAC,EAHW,iBAAiB,iCAAjB,iBAAiB,QAG5B;AAEY,QAAA,kCAAkC,GAAG,OAAC,CAAC,MAAM,CAAC;IACzD,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,KAAK,EAAE,OAAC,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC;CACxC,CAAC,CAAC,WAAW,EAAE,CAAC","sourcesContent":["import { z } from 'zod';\nimport { RawZodShape } from '../types';\n\n/**\n * Declarative metadata describing what a FrontMcpProvider contributes at app scope.\n */\nexport interface AuthProviderMetadata {\n  id?: string;\n  name: string;\n  description?: string;\n  scope?: AuthProviderScope;\n}\n\n/**\n * Provider lifetime scope semantics.\n */\nexport enum AuthProviderScope {\n  GLOBAL = 'global',\n  SESSION = 'session',\n}\n\nexport const frontMcpAuthProviderMetadataSchema = z.object({\n  id: z.string().optional(),\n  name: z.string().min(1),\n  description: z.string().optional(),\n  scope: z.nativeEnum(AuthProviderScope).optional().default(AuthProviderScope.GLOBAL),\n} satisfies RawZodShape<AuthProviderMetadata>).passthrough();\n"]}

package/src/metadata/flow-hooks.metadata.d.ts

@@ -0,0 +1,20 @@
+export type FlowHookKind = 'stage' | 'will' | 'did' | 'around';
+export type FlowHookMetadata<Ctx = any> = {
+    type: 'flow';
+    hooks: FlowHookMeta<Ctx>[];
+};
+export type FlowHookMeta<Ctx = any> = {
+    kind: FlowHookKind;
+    stage: string;
+    method: string;
+    priority?: number;
+    filter?: (ctx: Ctx) => boolean | Promise<boolean>;
+    static?: boolean;
+};
+export type HookKind = 'stage' | 'will' | 'did' | 'around';
+export type Priority = number;
+export interface FlowHookOptions<Ctx> {
+    priority?: Priority;
+    filter?: (ctx: Ctx) => boolean | Promise<boolean>;
+    name?: string;
+}

package/src/metadata/flow-hooks.metadata.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=flow-hooks.metadata.js.map

package/src/metadata/flow-hooks.metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow-hooks.metadata.js","sourceRoot":"","sources":["../../../src/metadata/flow-hooks.metadata.ts"],"names":[],"mappings":"","sourcesContent":["export type FlowHookKind = 'stage' | 'will' | 'did' | 'around';\n\nexport type FlowHookMetadata<Ctx = any> = {\n  type: 'flow';\n  hooks: FlowHookMeta<Ctx>[];\n};\n\nexport type FlowHookMeta<Ctx = any> = {\n  kind: FlowHookKind;\n  stage: string;\n  method: string;\n  priority?: number;\n  filter?: (ctx: Ctx) => boolean | Promise<boolean>;\n  static?: boolean;\n};\n\n\nexport type HookKind = 'stage' | 'will' | 'did' | 'around';\nexport type Priority = number;\n\nexport interface FlowHookOptions<Ctx> {\n  priority?: Priority;\n  filter?: (ctx: Ctx) => boolean | Promise<boolean>;\n  name?: string;\n}"]}

package/src/metadata/flow.metadata.d.ts

@@ -0,0 +1,75 @@
+import { z } from 'zod';
+import { HttpMethod, ServerRequest, Token } from '../interfaces';
+import { ScopeEntry } from '../entries';
+declare global {
+    export interface ExtendFlows {
+    }
+}
+export type FlowName = keyof ExtendFlows;
+export type CanActivateFlow = (request: ServerRequest, scope: ScopeEntry) => Promise<boolean>;
+export interface FlowMiddlewareOptions {
+    path?: RegExp | string;
+    method?: HttpMethod;
+    canActivate?: CanActivateFlow[];
+}
+export type FlowRunOptions<Ctx, Plan extends FlowPlan<string>, Input, Output extends (z.ZodObject<any> | z.ZodUnion<any> | z.ZodDiscriminatedUnion<any, any>), State extends z.ZodObject<any>> = {
+    ctx: Ctx;
+    plan: Plan;
+    input: Input;
+    output: Output;
+    state: State;
+    stage: StagesFromPlan<Plan>;
+};
+/**
+ * Declarative metadata describing what a FrontMcpFlow contributes at app scope.
+ */
+export interface FlowMetadata<Name extends FlowName> {
+    name: Name;
+    description?: string;
+    plan: FlowPlan<ExtendFlows[Name]['stage']>;
+    inputSchema: ExtendFlows[Name]['input'];
+    outputSchema: ExtendFlows[Name]['output'];
+    access: 'public' | 'authorized';
+    dependsOn?: Token[];
+    middleware?: FlowMiddlewareOptions;
+}
+export type StepInfo = string | {
+    title?: string;
+    description?: string;
+};
+export type FlowPhase = 'pre' | 'execute' | 'post' | 'finalize' | 'error';
+type Values<T> = T[keyof T];
+type ArrayElem<T> = T extends ReadonlyArray<infer U> ? U : never;
+export type StagesFromPlan<P extends FlowPlan<string>> = ArrayElem<Values<Required<P>>>;
+export type FlowPlan<Base extends string> = {
+    steps?: Record<Base, StepInfo>;
+} & Partial<Record<FlowPhase, Base[]>>;
+export declare const frontMcpFlowMetadataSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    access: z.ZodDefault<z.ZodOptional<z.ZodEnum<["public", "authorized"]>>>;
+    inputSchema: z.ZodType<Object, z.ZodTypeDef, Object>;
+    outputSchema: z.ZodOptional<z.ZodType<Object, z.ZodTypeDef, Object>>;
+    plan: z.ZodType<Object, z.ZodTypeDef, Object>;
+    dependsOn: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+    middleware: z.ZodOptional<z.ZodType<Object, z.ZodTypeDef, Object>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    access: z.ZodDefault<z.ZodOptional<z.ZodEnum<["public", "authorized"]>>>;
+    inputSchema: z.ZodType<Object, z.ZodTypeDef, Object>;
+    outputSchema: z.ZodOptional<z.ZodType<Object, z.ZodTypeDef, Object>>;
+    plan: z.ZodType<Object, z.ZodTypeDef, Object>;
+    dependsOn: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+    middleware: z.ZodOptional<z.ZodType<Object, z.ZodTypeDef, Object>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    access: z.ZodDefault<z.ZodOptional<z.ZodEnum<["public", "authorized"]>>>;
+    inputSchema: z.ZodType<Object, z.ZodTypeDef, Object>;
+    outputSchema: z.ZodOptional<z.ZodType<Object, z.ZodTypeDef, Object>>;
+    plan: z.ZodType<Object, z.ZodTypeDef, Object>;
+    dependsOn: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+    middleware: z.ZodOptional<z.ZodType<Object, z.ZodTypeDef, Object>>;
+}, z.ZodTypeAny, "passthrough">>;
+export {};

package/src/metadata/flow.metadata.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.frontMcpFlowMetadataSchema = void 0;
+const zod_1 = require("zod");
+exports.frontMcpFlowMetadataSchema = zod_1.z.object({
+    name: zod_1.z.string().min(1),
+    description: zod_1.z.string().optional(),
+    access: zod_1.z.enum(['public', 'authorized']).optional().default('public'),
+    inputSchema: zod_1.z.instanceof(Object),
+    outputSchema: zod_1.z.instanceof(Object).optional(),
+    plan: zod_1.z.instanceof(Object),
+    dependsOn: zod_1.z.array(zod_1.z.any()).optional(),
+    middleware: zod_1.z.instanceof(Object).optional(),
+}).passthrough();
+//# sourceMappingURL=flow.metadata.js.map

package/src/metadata/flow.metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.metadata.js","sourceRoot":"","sources":["../../../src/metadata/flow.metadata.ts"],"names":[],"mappings":";;;AAAA,6BAAsB;AA0DT,QAAA,0BAA0B,GAAG,OAAC,CAAC,MAAM,CAAC;IACjD,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;IACrE,WAAW,EAAE,OAAC,CAAC,UAAU,CAAC,MAAM,CAAC;IACjC,YAAY,EAAE,OAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;IAC7C,IAAI,EAAE,OAAC,CAAC,UAAU,CAAC,MAAM,CAAC;IAC1B,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;IACtC,UAAU,EAAE,OAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;CACD,CAAC,CAAC,WAAW,EAAE,CAAC","sourcesContent":["import {z} from 'zod';\nimport {RawZodShape} from '../types';\nimport {HttpMethod, ServerRequest, Token} from '../interfaces';\nimport {ScopeEntry} from '../entries';\n\ndeclare global {\n  // eslint-disable-next-line\n  export interface ExtendFlows {\n\n  }\n}\n\nexport type FlowName = keyof ExtendFlows;\n\nexport type CanActivateFlow = (request: ServerRequest, scope: ScopeEntry) => Promise<boolean>;\n\nexport interface FlowMiddlewareOptions {\n  path?: RegExp | string; // string can be \"/test/**\" or \"/test/*/asds\", default to all paths\n  method?: HttpMethod; // default to all methods\n  canActivate?: CanActivateFlow[];\n}\n\nexport type FlowRunOptions<Ctx, Plan extends FlowPlan<string>, Input, Output extends (z.ZodObject<any> | z.ZodUnion<any> | z.ZodDiscriminatedUnion<any, any>), State extends z.ZodObject<any>> = {\n  ctx: Ctx;\n  plan: Plan;\n  input: Input;\n  output: Output;\n  state: State;\n  stage: StagesFromPlan<Plan>;\n}\n\n/**\n * Declarative metadata describing what a FrontMcpFlow contributes at app scope.\n */\nexport interface FlowMetadata<Name extends FlowName> {\n  name: Name;\n  description?: string;\n  plan: FlowPlan<ExtendFlows[Name]['stage']>;\n  inputSchema: ExtendFlows[Name]['input'];\n  outputSchema: ExtendFlows[Name]['output'];\n  access: 'public' | 'authorized';\n  dependsOn?: Token[];\n  middleware?: FlowMiddlewareOptions;\n}\n\n\nexport type StepInfo = string | { title?: string; description?: string; };\nexport type FlowPhase = 'pre' | 'execute' | 'post' | 'finalize' | 'error';\ntype Values<T> = T[keyof T];\ntype ArrayElem<T> = T extends ReadonlyArray<infer U> ? U : never;\n\nexport type StagesFromPlan<P extends FlowPlan<string>> = ArrayElem<Values<Required<P>>>;\n\nexport type FlowPlan<Base extends string> = {\n  steps?: Record<Base, StepInfo>;\n} & Partial<Record<FlowPhase, Base[]>>;\n\n\nexport const frontMcpFlowMetadataSchema = z.object({\n  name: z.string().min(1),\n  description: z.string().optional(),\n  access: z.enum(['public', 'authorized']).optional().default('public'),\n  inputSchema: z.instanceof(Object),\n  outputSchema: z.instanceof(Object).optional(),\n  plan: z.instanceof(Object),\n  dependsOn: z.array(z.any()).optional(),\n  middleware: z.instanceof(Object).optional(),\n} satisfies RawZodShape<FlowMetadata<never>>).passthrough();\n"]}