@web-ts-toolkit/access-router 0.3.0 → 0.5.0

package/advanced.mjs

@@ -1,7 +1,6 @@
 // src/symbols.ts
 var MIDDLEWARE = /* @__PURE__ */ Symbol.for("@web-ts-toolkit/access-router/middleware");
 var DATA_MIDDLEWARE = /* @__PURE__ */ Symbol.for("@web-ts-toolkit/access-router/data-middleware");
-var CORE = /* @__PURE__ */ Symbol.for("@web-ts-toolkit/access-router/core");
 var PERMISSIONS = /* @__PURE__ */ Symbol.for("@web-ts-toolkit/access-router/permissions");
 var PERMISSION_KEYS = /* @__PURE__ */ Symbol.for("@web-ts-toolkit/access-router/permission-keys");
 
@@ -139,7 +138,7 @@ var clientErrors = JsonRouter.clientErrors;
 function parsePathParam(value, parameter) {
   const result = stringOrStringArray.safeParse(value);
   if (!result.success) {
-    throwValidationError(result.error.issues, parameter, "parameter");
+    throwValidationError(normalizeIssues(result.error.issues), parameter, "parameter");
   }
   const param = Array.isArray(result.data) ? result.data[0] : result.data;
   if (!param) {
@@ -152,49 +151,336 @@ function parsePathParam(value, parameter) {
 function parseQuery(schema, value) {
   const result = schema.safeParse(value);
   if (!result.success) {
-    throwValidationError(result.error.issues, void 0, "parameter");
+    throwValidationError(normalizeIssues(result.error.issues), void 0, "parameter");
   }
   return result.data;
 }
 function parseBody(schema, value) {
   const result = schema.safeParse(value ?? {});
   if (!result.success) {
-    throwValidationError(result.error.issues, void 0, "pointer");
+    throwValidationError(normalizeIssues(result.error.issues), void 0, "pointer");
   }
   return result.data;
 }
 function parseBodyWithSchema(schema, value, userSchema) {
   const body = parseBody(schema, value);
-  return isZodSchema(userSchema) ? parseUserSchema(userSchema, body) : body;
+  return isRequestSchema(userSchema) ? parseUserSchema(userSchema, body) : Promise.resolve(body);
 }
-function parseNestedBodyWithSchema(schema, value, nestedKey, userSchema) {
+async function parseNestedBodyWithSchema(schema, value, nestedKey, userSchema) {
   const body = parseBody(schema, value);
-  if (!isZodSchema(userSchema)) return body;
+  if (!isRequestSchema(userSchema)) return body;
   return {
     ...body,
-    [nestedKey]: parseUserSchema(userSchema, body?.[nestedKey], [nestedKey])
+    [nestedKey]: await parseUserSchema(userSchema, body?.[nestedKey], [nestedKey])
   };
 }
 function throwValidationError(issues, key, location = "pointer") {
   const errors = issues.map((issue) => formatIssue(issue, key, location));
   throw new clientErrors.BadRequestError("Bad Request", { errors });
 }
-function parseUserSchema(schema, value, prefix = []) {
-  const result = schema.safeParse(value);
-  if (!result.success) {
-    const issues = result.error.issues.map((issue) => ({
-      ...issue,
-      path: prefix.concat(issue.path.map(String))
-    }));
-    throwValidationError(issues, void 0, "pointer");
+async function parseUserSchema(schema, value, prefix = []) {
+  const validator = toRequestSchemaValidator(schema);
+  const result = await validator(value);
+  if (!isRequestSchemaFailure(result)) {
+    return result.data;
   }
-  return result.data;
+  const issues = result.issues.map((issue) => ({
+    ...issue,
+    path: prefix.concat((issue.path ?? []).map(String))
+  }));
+  throwValidationError(issues, void 0, "pointer");
 }
 function isZodSchema(schema) {
   return typeof schema === "object" && schema !== null && "safeParse" in schema && typeof schema.safeParse === "function";
 }
+function isRequestSchema(schema) {
+  return isZodSchema(schema) || isStandardSchema(schema) || isRequestSchemaValidator(schema) || isRequestSchemaAdapter(schema);
+}
+function isRequestSchemaValidator(schema) {
+  return typeof schema === "function";
+}
+function isRequestSchemaAdapter(schema) {
+  return typeof schema === "object" && schema !== null && "validate" in schema && typeof schema.validate === "function";
+}
+function isStandardSchema(schema) {
+  return typeof schema === "object" && schema !== null && "~standard" in schema && typeof schema["~standard"] === "object" && schema["~standard"] !== null && "validate" in schema["~standard"] && typeof schema["~standard"].validate === "function";
+}
+function isRequestSchemaFailure(result) {
+  return result.success === false;
+}
+function toRequestSchemaValidator(schema) {
+  if (isZodSchema(schema)) return fromZod(schema);
+  if (isStandardSchema(schema)) return fromStandardSchema(schema);
+  if (isRequestSchemaValidator(schema)) return schema;
+  return schema.validate;
+}
+function defineRequestSchema(validator, options = {}) {
+  return {
+    validate: validator,
+    openapi: options.openapi
+  };
+}
+function fromZod(schema) {
+  return (value) => {
+    const result = schema.safeParse(value);
+    if (result.success) {
+      return {
+        success: true,
+        data: result.data
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeIssues(result.error.issues)
+    };
+  };
+}
+function fromStandardSchema(schema) {
+  return async (value) => {
+    const result = await schema["~standard"].validate(value);
+    if (!isStandardSchemaFailure(result)) {
+      return {
+        success: true,
+        data: result.value
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeIssues(result.issues)
+    };
+  };
+}
+function fromYup(schema) {
+  return async (value) => {
+    try {
+      const data = await schema.validate(value, { abortEarly: false });
+      return {
+        success: true,
+        data
+      };
+    } catch (error) {
+      return {
+        success: false,
+        issues: normalizeYupIssues(error)
+      };
+    }
+  };
+}
+function fromJoi(schema) {
+  return async (value) => {
+    const result = await schema.validate(value, { abortEarly: false });
+    if (!result.error?.details?.length) {
+      return {
+        success: true,
+        data: result.value
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeJoiIssues(result.error.details)
+    };
+  };
+}
+function fromAjv(validator) {
+  return async (value) => {
+    const valid = await validator(value);
+    if (valid) {
+      return {
+        success: true,
+        data: value
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeAjvIssues(validator.errors ?? [])
+    };
+  };
+}
+function fromValibot(schema, safeParse) {
+  return async (value) => {
+    const result = await safeParse(schema, value, { abortEarly: false });
+    if (result.success) {
+      return {
+        success: true,
+        data: result.output
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeValibotIssues(result.issues)
+    };
+  };
+}
+function fromArkType(type) {
+  return async (value) => {
+    const result = await type(value);
+    if (!isArkTypeErrors(result)) {
+      return {
+        success: true,
+        data: result
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeArkTypeIssues(result)
+    };
+  };
+}
+function fromIoTs(decoder) {
+  return async (value) => {
+    const result = decoder.decode(value);
+    if (result._tag === "Right") {
+      return {
+        success: true,
+        data: result.right
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeIoTsIssues(result.left)
+    };
+  };
+}
+function fromSuperstruct(struct, validate) {
+  return async (value) => {
+    const [failure, output] = await validate(value, struct);
+    if (!failure) {
+      return {
+        success: true,
+        data: output
+      };
+    }
+    return {
+      success: false,
+      issues: normalizeSuperstructFailure(failure)
+    };
+  };
+}
+function fromVine(validator) {
+  return async (value) => {
+    try {
+      const output = await validator.validate(value);
+      return {
+        success: true,
+        data: output
+      };
+    } catch (error) {
+      return {
+        success: false,
+        issues: normalizeVineError(error)
+      };
+    }
+  };
+}
+function isStandardSchemaFailure(result) {
+  return Array.isArray(result.issues);
+}
+function normalizeIssues(issues) {
+  return issues.map((issue) => ({
+    message: issue.message,
+    path: issue.path?.flatMap((segment) => normalizePathSegment(segment))
+  }));
+}
+function normalizePathSegment(segment) {
+  const key = isStandardSchemaPathSegment(segment) ? segment.key : segment;
+  return typeof key === "string" || typeof key === "number" ? [key] : [];
+}
+function isStandardSchemaPathSegment(segment) {
+  return typeof segment === "object" && segment !== null && "key" in segment;
+}
+function normalizeYupIssues(error) {
+  if (!isYupValidationError(error)) {
+    return [{ message: "Validation failed" }];
+  }
+  const issues = error.inner?.length ? error.inner : [error];
+  return issues.map((issue) => ({
+    message: issue.message,
+    path: parsePathString(issue.path)
+  }));
+}
+function normalizeJoiIssues(issues) {
+  return issues.map((issue) => ({
+    message: issue.message,
+    path: issue.path ? [...issue.path] : void 0
+  }));
+}
+function normalizeAjvIssues(issues) {
+  return issues.map((issue) => ({
+    message: issue.message ?? "Validation failed",
+    path: parseAjvPath(issue)
+  }));
+}
+function normalizeValibotIssues(issues) {
+  return issues.map((issue) => ({
+    message: issue.message,
+    path: issue.path?.flatMap(
+      (item) => typeof item.key === "string" || typeof item.key === "number" ? [item.key] : []
+    )
+  }));
+}
+function normalizeArkTypeIssues(issues) {
+  const normalized = issues.map((issue) => ({
+    message: issue.message ?? issue.problem ?? issues.summary ?? "Validation failed",
+    path: issue.path ? [...issue.path] : void 0
+  }));
+  return normalized.length ? normalized : [{ message: issues.summary ?? "Validation failed" }];
+}
+function normalizeIoTsIssues(issues) {
+  return issues.map((issue) => ({
+    message: issue.message ?? "Validation failed",
+    path: issue.context.map((entry) => entry.key).filter(Boolean)
+  }));
+}
+function normalizeSuperstructFailure(failure) {
+  const failures = failure.failures?.() ?? [failure];
+  return failures.map((entry) => ({
+    message: entry.message ?? "Validation failed",
+    path: normalizeSuperstructPath(entry)
+  }));
+}
+function normalizeSuperstructPath(failure) {
+  if (failure.path?.length) return [...failure.path];
+  if (typeof failure.key === "string" || typeof failure.key === "number") return [failure.key];
+  return void 0;
+}
+function normalizeVineError(error) {
+  if (!isVineValidationError(error)) {
+    return [{ message: "Validation failed" }];
+  }
+  return error.messages.map((message) => ({
+    message: message.message,
+    path: normalizeVineField(message)
+  }));
+}
+function normalizeVineField(message) {
+  const path = message.field.replace(/\[(\d+)\]/g, ".$1").split(".").filter(Boolean).map((segment) => /^\d+$/.test(segment) ? Number(segment) : segment);
+  if (typeof message.index === "number" && path.length === 0) {
+    return [message.index];
+  }
+  return path.length ? path : void 0;
+}
+function parseAjvPath(issue) {
+  const path = issue.instancePath?.split("/").filter(Boolean).map((segment) => /^\d+$/.test(segment) ? Number(segment) : segment);
+  if (issue.params?.missingProperty) {
+    return (path ?? []).concat(issue.params.missingProperty);
+  }
+  return path;
+}
+function parsePathString(path) {
+  if (!path) return void 0;
+  return path.replace(/\[(\d+)\]/g, ".$1").split(".").filter(Boolean).map((segment) => /^\d+$/.test(segment) ? Number(segment) : segment);
+}
+function isYupValidationError(error) {
+  return typeof error === "object" && error !== null && "message" in error;
+}
+function isArkTypeErrors(value) {
+  return Array.isArray(value);
+}
+function isVineValidationError(error) {
+  return typeof error === "object" && error !== null && "messages" in error && Array.isArray(error.messages);
+}
 function formatIssue(issue, key, location = "pointer") {
-  const path = issue.path.map(String);
+  const path = (issue.path ?? []).map(String);
   const joinedPath = path.join(".");
   if (location === "parameter") {
     return {
@@ -605,7 +891,6 @@ var rootDataQueryEntrySchema = z4.union([
 ]);
 var rootQuerySchema = z4.array(z4.union([rootModelQueryEntrySchema, rootDataQueryEntrySchema]));
 export {
-  CORE,
   Codes,
   CustomHeaders,
   DATA_MIDDLEWARE,
@@ -623,7 +908,18 @@ export {
   dataListBodySchema,
   dataReadByIdBodySchema,
   dataReadFilterBodySchema,
+  defineRequestSchema,
   distinctBodySchema,
+  fromAjv,
+  fromArkType,
+  fromIoTs,
+  fromJoi,
+  fromStandardSchema,
+  fromSuperstruct,
+  fromValibot,
+  fromVine,
+  fromYup,
+  fromZod,
   listBodySchema,
   listQuerySchema,
   parseBody,

package/index.d.mts

@@ -1,11 +1,58 @@
 import mongoose from 'mongoose';
 import { Response, NextFunction, Router } from 'express';
-import { _ as GlobalOptions, E as DefaultModelRouterOptions, N as ExtendedDefaultModelRouterOptions, ah as ModelRouterOptions, O as ExtendedModelRouterOptions, w as DataRouterOptions, M as ExtendedDataRouterOptions, A as AccessRouterBaseRequest, a0 as GuardHook, ag as ModelRequest, u as DataRequest, bi as DataService, bj as Model, bk as Service, bl as PublicService, bh as Validation, aX as RootRouterOptions } from './service-DLKAswCS.mjs';
-export { bm as AccessRouterPermissionMap, bn as AccessRouterPermissions, e as AccessRouterRequest, f as AccessRouterRequestExtensions, bo as Permissions } from './service-DLKAswCS.mjs';
+import { a6 as GlobalOptions, P as DefaultModelRouterOptions, X as ExtendedDefaultModelRouterOptions, aw as ModelRouterOptions, Y as ExtendedModelRouterOptions, L as DataRouterOptions, W as ExtendedDataRouterOptions, A as AccessRouterBaseRequest, a8 as GuardHook, av as ModelRequest, J as DataRequest, cm as DataService, cn as Model, co as Service, cp as PublicService, b$ as Validation, bl as RootRouterOptions } from './parsers-Ce1grlLx.mjs';
+export { cq as AccessRouterPermissionMap, cr as AccessRouterPermissions, c as AccessRouterRequest, d as AccessRouterRequestExtensions, l as AjvErrorObjectLike, m as AjvValidatorLike, n as ArkTypeErrorsLike, o as ArkTypeLike, ab as IoTsContextEntryLike, ac as IoTsDecodeErrorLike, ad as IoTsDecoderLike, ae as JoiSchemaLike, af as JoiValidationErrorDetailLike, cs as Permissions, aR as RequestSchemaAdapter, aS as RequestSchemaFailure, aT as RequestSchemaIssue, aU as RequestSchemaLike, aV as RequestSchemaOptions, aW as RequestSchemaResult, aX as RequestSchemaSuccess, aY as RequestSchemaValidator, bw as StandardSchemaFailure, bx as StandardSchemaInferOutput, by as StandardSchemaIssue, bz as StandardSchemaPathSegment, bA as StandardSchemaResult, bB as StandardSchemaSuccess, bC as StandardSchemaV1, bI as SuperstructFailureLike, bJ as SuperstructValidateLike, bV as ValibotIssueLike, bW as ValibotPathItemLike, bX as ValibotSafeParseLike, bY as ValibotSafeParseResult, c1 as VineValidationErrorLike, c2 as VineValidationMessageLike, c3 as VineValidatorLike, c4 as YupSchemaLike, c5 as YupValidationErrorLike, c6 as defineRequestSchema, c7 as fromAjv, c8 as fromArkType, c9 as fromIoTs, ca as fromJoi, cb as fromStandardSchema, cc as fromSuperstruct, cd as fromValibot, ce as fromVine, cf as fromYup, cg as fromZod } from './parsers-Ce1grlLx.mjs';
 import JsonRouter from '@web-ts-toolkit/express-json-router';
 import 'zod';
 import 'deep-diff';
 
+type OpenApiMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
+type OpenApiSchema = Record<string, unknown>;
+type OpenApiSchemaSource = unknown;
+type OpenApiParameter = {
+    name: string;
+    in: 'path' | 'query';
+    required?: boolean;
+    description?: string;
+    schema?: OpenApiSchema;
+};
+type OpenApiResponse = {
+    description: string;
+    content?: Record<string, {
+        schema: OpenApiSchema;
+    }>;
+};
+type OpenApiResponses = Record<string, OpenApiResponse>;
+type OpenApiRouteDescriptor = {
+    method: OpenApiMethod;
+    path: string;
+    operationId?: string;
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    acl?: string;
+    deprecated?: boolean;
+    query?: OpenApiSchemaSource;
+    body?: OpenApiSchemaSource;
+    pathParams?: Record<string, OpenApiSchemaSource>;
+    responses?: OpenApiResponses;
+};
+type OpenApiDocumentOptions = {
+    title: string;
+    version: string;
+    description?: string;
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+};
+type OpenApiRouterOptions = Partial<OpenApiDocumentOptions> & {
+    jsonPath?: string;
+    docsPath?: string | false;
+    swaggerUiCssUrl?: string;
+    swaggerUiBundleUrl?: string;
+};
+
 declare class AccessRuntime {
     private readonly globalOptions;
     private readonly defaultModelOptions;
@@ -15,6 +62,30 @@ declare class AccessRuntime {
     private readonly modelRefs;
     private readonly modelSubs;
     private readonly modelAtts;
+    private readonly openApiRegistry;
+    registerOpenApiRoute(route: OpenApiRouteDescriptor): void;
+    getOpenApiRoutes(): OpenApiRouteDescriptor[];
+    getOpenApiSpec(info: OpenApiDocumentOptions): {
+        openapi: string;
+        info: Omit<OpenApiDocumentOptions, "servers">;
+        servers?: OpenApiDocumentOptions["servers"];
+        paths: Record<string, Record<string, {
+            [key: `x-${string}`]: unknown;
+            operationId?: string;
+            summary?: string;
+            description?: string;
+            tags?: string[];
+            deprecated?: boolean;
+            parameters?: OpenApiParameter[];
+            requestBody?: {
+                required?: boolean;
+                content: Record<string, {
+                    schema: OpenApiSchema;
+                }>;
+            };
+            responses: OpenApiResponses;
+        }>>;
+    };
     setGlobalOptions(options: GlobalOptions): void;
     setGlobalOption<K extends keyof GlobalOptions>(key: K, value: GlobalOptions[K]): void;
     getGlobalOptions(): GlobalOptions;
@@ -76,6 +147,7 @@ declare class DataRouter<TData = unknown> {
     private getRequestSchema;
     getService(req: DataRequest): DataService<TData>;
     private assertAllowed;
+    private registerOpenApiRoute;
     private setCollectionRoutes;
     private setDocumentRoutes;
     set<K extends keyof DataRouterOptions<TData>>(key: K, value: DataRouterOptions<TData>[K]): this;
@@ -112,6 +184,7 @@ declare class ModelRouter<TModel = unknown> {
     getService(req: ModelRequest): Service<TModel>;
     getPublicService(req: ModelRequest): PublicService<TModel>;
     private assertAllowed;
+    private registerOpenApiRoute;
     private setCollectionRoutes;
     private setDocumentRoutes;
     private setSubDocumentRoutes;
@@ -251,6 +324,7 @@ declare class RootRouter {
     private readonly modelOperations;
     private readonly dataOperations;
     constructor(options?: RootRouterOptions, runtime?: AccessRuntime);
+    private registerOpenApiRoute;
     private wrapResult;
     private hasTarget;
     private isAllowed;
@@ -261,6 +335,8 @@ declare class RootRouter {
     get routes(): Router;
 }
 
+declare function createOpenApiRouter(runtime: AccessRuntime, options?: OpenApiRouterOptions): Router;
+
 type AccessRouterInstance = ModelRouter<any> | DataRouter<any> | RootRouter;
 type CombinedRouteInput = Router | AccessRouterInstance;
 declare function combineRoutes(...inputs: CombinedRouteInput[]): Router;
@@ -296,6 +372,7 @@ type CreateRouter = {
 type CreateDataRouter = {
     <TData>(dataName: string, options: DataRouterOptions<TData>): DataRouter<TData>;
 };
+type CreateRuntimeOpenApiRouter = (options?: OpenApiRouterOptions) => Router;
 type WttSet = {
     <K extends keyof GlobalOptions>(key: K, value: GlobalOptions[K]): void;
     (options: {
@@ -306,6 +383,7 @@ interface Wtt {
     runtime: AccessRuntime;
     createRouter: CreateRouter;
     createDataRouter: CreateDataRouter;
+    createOpenApiRouter: CreateRuntimeOpenApiRouter;
     combineRoutes: typeof combineRoutes;
     set: WttSet;
     setGlobalOptions: typeof setGlobalOptions;
@@ -330,4 +408,4 @@ type AccessRuntimeApi = typeof macl & Wtt;
 declare function createAccessRuntime(): AccessRuntimeApi;
 declare const acl: AccessRuntimeApi;
 
-export { AccessRuntime, type AccessRuntimeApi, type CombinedRouteInput, DataRouter, DataRouterOptions, GlobalOptions, ModelRouter, ModelRouterOptions, RootRouter, RootRouterOptions, acl, combineRoutes, createAccessRuntime, acl as default, getDefaultModelOption, getDefaultModelOptions, getGlobalOption, getGlobalOptions, getModelJsonSchema, getModelNames, getModelOption, getModelOptions, guard, permissionsPlugin, setDefaultModelOption, setDefaultModelOptions, setGlobalOption, setGlobalOptions, setModelOption, setModelOptions };
+export { AccessRuntime, type AccessRuntimeApi, type CombinedRouteInput, DataRouter, DataRouterOptions, GlobalOptions, ModelRouter, ModelRouterOptions, type OpenApiDocumentOptions, type OpenApiMethod, type OpenApiRouteDescriptor, type OpenApiRouterOptions, RootRouter, RootRouterOptions, acl, combineRoutes, createAccessRuntime, createOpenApiRouter, acl as default, getDefaultModelOption, getDefaultModelOptions, getGlobalOption, getGlobalOptions, getModelJsonSchema, getModelNames, getModelOption, getModelOptions, guard, permissionsPlugin, setDefaultModelOption, setDefaultModelOptions, setGlobalOption, setGlobalOptions, setModelOption, setModelOptions };

package/index.d.ts

@@ -1,11 +1,58 @@
 import mongoose from 'mongoose';
 import { Response, NextFunction, Router } from 'express';
-import { _ as GlobalOptions, E as DefaultModelRouterOptions, N as ExtendedDefaultModelRouterOptions, ah as ModelRouterOptions, O as ExtendedModelRouterOptions, w as DataRouterOptions, M as ExtendedDataRouterOptions, A as AccessRouterBaseRequest, a0 as GuardHook, ag as ModelRequest, u as DataRequest, bi as DataService, bj as Model, bk as Service, bl as PublicService, bh as Validation, aX as RootRouterOptions } from './service-DLKAswCS.js';
-export { bm as AccessRouterPermissionMap, bn as AccessRouterPermissions, e as AccessRouterRequest, f as AccessRouterRequestExtensions, bo as Permissions } from './service-DLKAswCS.js';
+import { a6 as GlobalOptions, P as DefaultModelRouterOptions, X as ExtendedDefaultModelRouterOptions, aw as ModelRouterOptions, Y as ExtendedModelRouterOptions, L as DataRouterOptions, W as ExtendedDataRouterOptions, A as AccessRouterBaseRequest, a8 as GuardHook, av as ModelRequest, J as DataRequest, cm as DataService, cn as Model, co as Service, cp as PublicService, b$ as Validation, bl as RootRouterOptions } from './parsers-Ce1grlLx.js';
+export { cq as AccessRouterPermissionMap, cr as AccessRouterPermissions, c as AccessRouterRequest, d as AccessRouterRequestExtensions, l as AjvErrorObjectLike, m as AjvValidatorLike, n as ArkTypeErrorsLike, o as ArkTypeLike, ab as IoTsContextEntryLike, ac as IoTsDecodeErrorLike, ad as IoTsDecoderLike, ae as JoiSchemaLike, af as JoiValidationErrorDetailLike, cs as Permissions, aR as RequestSchemaAdapter, aS as RequestSchemaFailure, aT as RequestSchemaIssue, aU as RequestSchemaLike, aV as RequestSchemaOptions, aW as RequestSchemaResult, aX as RequestSchemaSuccess, aY as RequestSchemaValidator, bw as StandardSchemaFailure, bx as StandardSchemaInferOutput, by as StandardSchemaIssue, bz as StandardSchemaPathSegment, bA as StandardSchemaResult, bB as StandardSchemaSuccess, bC as StandardSchemaV1, bI as SuperstructFailureLike, bJ as SuperstructValidateLike, bV as ValibotIssueLike, bW as ValibotPathItemLike, bX as ValibotSafeParseLike, bY as ValibotSafeParseResult, c1 as VineValidationErrorLike, c2 as VineValidationMessageLike, c3 as VineValidatorLike, c4 as YupSchemaLike, c5 as YupValidationErrorLike, c6 as defineRequestSchema, c7 as fromAjv, c8 as fromArkType, c9 as fromIoTs, ca as fromJoi, cb as fromStandardSchema, cc as fromSuperstruct, cd as fromValibot, ce as fromVine, cf as fromYup, cg as fromZod } from './parsers-Ce1grlLx.js';
 import JsonRouter from '@web-ts-toolkit/express-json-router';
 import 'zod';
 import 'deep-diff';
 
+type OpenApiMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
+type OpenApiSchema = Record<string, unknown>;
+type OpenApiSchemaSource = unknown;
+type OpenApiParameter = {
+    name: string;
+    in: 'path' | 'query';
+    required?: boolean;
+    description?: string;
+    schema?: OpenApiSchema;
+};
+type OpenApiResponse = {
+    description: string;
+    content?: Record<string, {
+        schema: OpenApiSchema;
+    }>;
+};
+type OpenApiResponses = Record<string, OpenApiResponse>;
+type OpenApiRouteDescriptor = {
+    method: OpenApiMethod;
+    path: string;
+    operationId?: string;
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    acl?: string;
+    deprecated?: boolean;
+    query?: OpenApiSchemaSource;
+    body?: OpenApiSchemaSource;
+    pathParams?: Record<string, OpenApiSchemaSource>;
+    responses?: OpenApiResponses;
+};
+type OpenApiDocumentOptions = {
+    title: string;
+    version: string;
+    description?: string;
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+};
+type OpenApiRouterOptions = Partial<OpenApiDocumentOptions> & {
+    jsonPath?: string;
+    docsPath?: string | false;
+    swaggerUiCssUrl?: string;
+    swaggerUiBundleUrl?: string;
+};
+
 declare class AccessRuntime {
     private readonly globalOptions;
     private readonly defaultModelOptions;
@@ -15,6 +62,30 @@ declare class AccessRuntime {
     private readonly modelRefs;
     private readonly modelSubs;
     private readonly modelAtts;
+    private readonly openApiRegistry;
+    registerOpenApiRoute(route: OpenApiRouteDescriptor): void;
+    getOpenApiRoutes(): OpenApiRouteDescriptor[];
+    getOpenApiSpec(info: OpenApiDocumentOptions): {
+        openapi: string;
+        info: Omit<OpenApiDocumentOptions, "servers">;
+        servers?: OpenApiDocumentOptions["servers"];
+        paths: Record<string, Record<string, {
+            [key: `x-${string}`]: unknown;
+            operationId?: string;
+            summary?: string;
+            description?: string;
+            tags?: string[];
+            deprecated?: boolean;
+            parameters?: OpenApiParameter[];
+            requestBody?: {
+                required?: boolean;
+                content: Record<string, {
+                    schema: OpenApiSchema;
+                }>;
+            };
+            responses: OpenApiResponses;
+        }>>;
+    };
     setGlobalOptions(options: GlobalOptions): void;
     setGlobalOption<K extends keyof GlobalOptions>(key: K, value: GlobalOptions[K]): void;
     getGlobalOptions(): GlobalOptions;
@@ -76,6 +147,7 @@ declare class DataRouter<TData = unknown> {
     private getRequestSchema;
     getService(req: DataRequest): DataService<TData>;
     private assertAllowed;
+    private registerOpenApiRoute;
     private setCollectionRoutes;
     private setDocumentRoutes;
     set<K extends keyof DataRouterOptions<TData>>(key: K, value: DataRouterOptions<TData>[K]): this;
@@ -112,6 +184,7 @@ declare class ModelRouter<TModel = unknown> {
     getService(req: ModelRequest): Service<TModel>;
     getPublicService(req: ModelRequest): PublicService<TModel>;
     private assertAllowed;
+    private registerOpenApiRoute;
     private setCollectionRoutes;
     private setDocumentRoutes;
     private setSubDocumentRoutes;
@@ -251,6 +324,7 @@ declare class RootRouter {
     private readonly modelOperations;
     private readonly dataOperations;
     constructor(options?: RootRouterOptions, runtime?: AccessRuntime);
+    private registerOpenApiRoute;
     private wrapResult;
     private hasTarget;
     private isAllowed;
@@ -261,6 +335,8 @@ declare class RootRouter {
     get routes(): Router;
 }
 
+declare function createOpenApiRouter(runtime: AccessRuntime, options?: OpenApiRouterOptions): Router;
+
 type AccessRouterInstance = ModelRouter<any> | DataRouter<any> | RootRouter;
 type CombinedRouteInput = Router | AccessRouterInstance;
 declare function combineRoutes(...inputs: CombinedRouteInput[]): Router;
@@ -296,6 +372,7 @@ type CreateRouter = {
 type CreateDataRouter = {
     <TData>(dataName: string, options: DataRouterOptions<TData>): DataRouter<TData>;
 };
+type CreateRuntimeOpenApiRouter = (options?: OpenApiRouterOptions) => Router;
 type WttSet = {
     <K extends keyof GlobalOptions>(key: K, value: GlobalOptions[K]): void;
     (options: {
@@ -306,6 +383,7 @@ interface Wtt {
     runtime: AccessRuntime;
     createRouter: CreateRouter;
     createDataRouter: CreateDataRouter;
+    createOpenApiRouter: CreateRuntimeOpenApiRouter;
     combineRoutes: typeof combineRoutes;
     set: WttSet;
     setGlobalOptions: typeof setGlobalOptions;
@@ -330,4 +408,4 @@ type AccessRuntimeApi = typeof macl & Wtt;
 declare function createAccessRuntime(): AccessRuntimeApi;
 declare const acl: AccessRuntimeApi;
 
-export { AccessRuntime, type AccessRuntimeApi, type CombinedRouteInput, DataRouter, DataRouterOptions, GlobalOptions, ModelRouter, ModelRouterOptions, RootRouter, RootRouterOptions, acl, combineRoutes, createAccessRuntime, acl as default, getDefaultModelOption, getDefaultModelOptions, getGlobalOption, getGlobalOptions, getModelJsonSchema, getModelNames, getModelOption, getModelOptions, guard, permissionsPlugin, setDefaultModelOption, setDefaultModelOptions, setGlobalOption, setGlobalOptions, setModelOption, setModelOptions };
+export { AccessRuntime, type AccessRuntimeApi, type CombinedRouteInput, DataRouter, DataRouterOptions, GlobalOptions, ModelRouter, ModelRouterOptions, type OpenApiDocumentOptions, type OpenApiMethod, type OpenApiRouteDescriptor, type OpenApiRouterOptions, RootRouter, RootRouterOptions, acl, combineRoutes, createAccessRuntime, createOpenApiRouter, acl as default, getDefaultModelOption, getDefaultModelOptions, getGlobalOption, getGlobalOptions, getModelJsonSchema, getModelNames, getModelOption, getModelOptions, guard, permissionsPlugin, setDefaultModelOption, setDefaultModelOptions, setGlobalOption, setGlobalOptions, setModelOption, setModelOptions };