@lucern/contracts 0.1.2-alpha.5 → 0.3.0-alpha.0

package/dist/function-registry/helpers.d.ts

@@ -0,0 +1,86 @@
+import { FunctionContract, SurfaceClass, ContractProjectionContext, FunctionKind, FunctionIdempotency, FunctionSurfaceIntent, FunctionSurfaceMap, FunctionConvexTarget } from './types.js';
+import { z } from 'zod';
+import { F as FunctionEffect } from '../defineFunction-DO97DKs4.js';
+import { M as McpToolContract } from '../tool-contracts-WCnuE9DW.js';
+
+declare const jsonObjectSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+declare function argsSchemaFromMcpContract(contract: McpToolContract): z.ZodObject<z.ZodRawShape>;
+declare function inputSchemaFromMcpContract(contract: McpToolContract): z.ZodObject<z.ZodRawShape>;
+declare function defineFunctionContract<T extends FunctionContract>(contract: T): T;
+declare function classifyContract<T extends Omit<FunctionContract, "surfaceClass"> & {
+    surfaceClass?: SurfaceClass;
+}>(contract: T, surfaceClass: SurfaceClass): T & {
+    surfaceClass: SurfaceClass;
+};
+declare function authUserId(context: ContractProjectionContext): string;
+declare function withUserId(input: Record<string, unknown>, context: ContractProjectionContext): Record<string, unknown>;
+declare function withCreatedBy(input: Record<string, unknown>, context: ContractProjectionContext): Record<string, unknown>;
+declare function surfaceMcpContract(name: string): FunctionContract["mcp"];
+declare function surfaceContract(args: {
+    name: string;
+    kind: FunctionContract["kind"];
+    domain: string;
+    surfaceClass: SurfaceClass;
+    method?: FunctionContract["rest"]["method"];
+    path: string;
+    sdkNamespace: string;
+    sdkMethod: string;
+    summary: string;
+    tags?: string[];
+    scopes?: string[];
+    replacedBy?: string;
+    idempotent?: FunctionContract["idempotent"];
+    convex?: FunctionContract["convex"];
+    args?: z.ZodObject<z.ZodRawShape>;
+    returns?: z.ZodTypeAny;
+    input?: z.ZodTypeAny;
+    output?: z.ZodTypeAny;
+    effects?: readonly FunctionEffect[];
+    invariants?: readonly string[];
+}): {
+    name: string;
+    kind: FunctionKind;
+    idempotent: FunctionIdempotency;
+    effects: readonly FunctionEffect[];
+    invariants: readonly string[] | undefined;
+    surfaceIntent: FunctionSurfaceIntent;
+    domain: string;
+    surfaceClass: SurfaceClass;
+    surfaces: FunctionSurfaceMap;
+    replacedBy: string | undefined;
+    rest: {
+        method: "GET" | "POST" | "PATCH" | "DELETE";
+        path: string;
+    };
+    sdk: {
+        namespace: string;
+        method: string;
+    };
+    mcp: {
+        exposed: boolean;
+        toolName: string;
+    } & McpToolContract & {
+        exposed: boolean;
+        toolName: string;
+    };
+    auth: {
+        scopes: string[];
+        allowedPrincipalTypes: ("service" | "agent" | "user")[];
+    };
+    convex: FunctionConvexTarget | undefined;
+    args: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, {
+        [x: string]: any;
+    }, {
+        [x: string]: any;
+    }>;
+    returns: z.ZodTypeAny;
+    input: z.ZodTypeAny;
+    output: z.ZodTypeAny;
+    openapi: {
+        summary: string;
+        tags: string[];
+    };
+};
+declare function assertSurfaceCoverage(contracts: readonly FunctionContract[]): void;
+
+export { argsSchemaFromMcpContract, assertSurfaceCoverage, authUserId, classifyContract, defineFunctionContract, inputSchemaFromMcpContract, jsonObjectSchema, surfaceContract, surfaceMcpContract, withCreatedBy, withUserId };