@lpdjs/firestore-repo-service 2.2.2 → 2.2.4

package/dist/servers/crud/index.d.cts

@@ -1,9 +1,75 @@
 import { HttpsOptions } from 'firebase-functions/v2/https';
-import { C as ConfiguredRepository, m as CrudServerOptions, O as OpenAPIDocument } from '../../types-B5NdBY1Z.cjs';
-export { A as ApiResponse, B as BasicAuthConfig, l as CrudRepoConfig, r as CrudRepoEntry, s as CrudRepoRegistry, n as FieldRole, L as ListResponseData, M as Middleware, u as OpenAPISpecOptions, o as QueryRequestBody, p as RepoFieldPath, q as RepoRelationKeys, U as UserFieldPath, t as generateOpenAPISpec } from '../../types-B5NdBY1Z.cjs';
+import { s as CrudRepoRegistry, O as OpenAPISpecOptions, C as ConfiguredRepository, m as CrudServerOptions } from '../../types-Z9Qy8Xmx.cjs';
+export { A as ApiResponse, B as BasicAuthConfig, l as CrudRepoConfig, r as CrudRepoEntry, n as FieldRole, L as ListResponseData, M as Middleware, o as QueryRequestBody, p as RepoFieldPath, q as RepoRelationKeys, U as UserFieldPath } from '../../types-Z9Qy8Xmx.cjs';
 import 'zod';
 import 'firebase-admin/firestore';
 
+/**
+ * OpenAPI 3.1 specification generator for the CRUD server.
+ *
+ * Introspects each `CrudRepoEntry` and uses Zod 4's native `z.toJSONSchema()`
+ * to produce a fully typed OpenAPI document ready for Scalar UI or codegen.
+ *
+ * @module servers/crud/openapi
+ */
+
+/** Minimal subset of an OpenAPI 3.1 document we produce. */
+interface OpenAPIDocument {
+    openapi: "3.1.0";
+    info: OpenAPIInfo;
+    servers?: {
+        url: string;
+        description?: string;
+    }[];
+    paths: Record<string, Record<string, OpenAPIOperation>>;
+    components: {
+        schemas: Record<string, Record<string, unknown>>;
+        securitySchemes?: Record<string, Record<string, unknown>>;
+    };
+    security?: Record<string, string[]>[];
+    tags?: {
+        name: string;
+        description?: string;
+    }[];
+}
+interface OpenAPIInfo {
+    title: string;
+    version: string;
+    description?: string;
+}
+interface OpenAPIOperation {
+    operationId: string;
+    summary: string;
+    tags: string[];
+    parameters?: Record<string, unknown>[];
+    requestBody?: Record<string, unknown>;
+    responses: Record<string, Record<string, unknown>>;
+    security?: Record<string, string[]>[];
+}
+/**
+ * Generate a full OpenAPI 3.1 specification from a `CrudRepoRegistry`.
+ *
+ * Uses Zod 4's native `z.toJSONSchema()` to convert each repo's schema
+ * into a JSON Schema component, then assembles paths for the standard
+ * CRUD endpoints.
+ *
+ * @example
+ * ```ts
+ * import { generateOpenAPISpec } from "@lpdjs/firestore-repo-service/servers/crud";
+ *
+ * const spec = generateOpenAPISpec(registry, "/api", {
+ *   title: "My API",
+ *   version: "1.0.0",
+ *   servers: [{ url: "https://my-api.example.com" }],
+ *   auth: "bearer",
+ * });
+ *
+ * // Write to file
+ * fs.writeFileSync("openapi.json", JSON.stringify(spec, null, 2));
+ * ```
+ */
+declare function generateOpenAPISpec(registry: CrudRepoRegistry, basePath: string, options?: OpenAPISpecOptions): OpenAPIDocument;
+
 /**
  * @module servers/crud
  *
@@ -181,4 +247,4 @@ declare function createCrudServer<TRepos extends Record<string, ConfiguredReposi
     httpsOptions?: HttpsOptions;
 };
 
-export { CrudServerOptions, OpenAPIDocument, createCrudServer };
+export { CrudRepoRegistry, CrudServerOptions, type OpenAPIDocument, OpenAPISpecOptions, createCrudServer, generateOpenAPISpec };

package/dist/servers/crud/index.d.ts

@@ -1,9 +1,75 @@
 import { HttpsOptions } from 'firebase-functions/v2/https';
-import { C as ConfiguredRepository, m as CrudServerOptions, O as OpenAPIDocument } from '../../types-B5NdBY1Z.js';
-export { A as ApiResponse, B as BasicAuthConfig, l as CrudRepoConfig, r as CrudRepoEntry, s as CrudRepoRegistry, n as FieldRole, L as ListResponseData, M as Middleware, u as OpenAPISpecOptions, o as QueryRequestBody, p as RepoFieldPath, q as RepoRelationKeys, U as UserFieldPath, t as generateOpenAPISpec } from '../../types-B5NdBY1Z.js';
+import { s as CrudRepoRegistry, O as OpenAPISpecOptions, C as ConfiguredRepository, m as CrudServerOptions } from '../../types-Z9Qy8Xmx.js';
+export { A as ApiResponse, B as BasicAuthConfig, l as CrudRepoConfig, r as CrudRepoEntry, n as FieldRole, L as ListResponseData, M as Middleware, o as QueryRequestBody, p as RepoFieldPath, q as RepoRelationKeys, U as UserFieldPath } from '../../types-Z9Qy8Xmx.js';
 import 'zod';
 import 'firebase-admin/firestore';
 
+/**
+ * OpenAPI 3.1 specification generator for the CRUD server.
+ *
+ * Introspects each `CrudRepoEntry` and uses Zod 4's native `z.toJSONSchema()`
+ * to produce a fully typed OpenAPI document ready for Scalar UI or codegen.
+ *
+ * @module servers/crud/openapi
+ */
+
+/** Minimal subset of an OpenAPI 3.1 document we produce. */
+interface OpenAPIDocument {
+    openapi: "3.1.0";
+    info: OpenAPIInfo;
+    servers?: {
+        url: string;
+        description?: string;
+    }[];
+    paths: Record<string, Record<string, OpenAPIOperation>>;
+    components: {
+        schemas: Record<string, Record<string, unknown>>;
+        securitySchemes?: Record<string, Record<string, unknown>>;
+    };
+    security?: Record<string, string[]>[];
+    tags?: {
+        name: string;
+        description?: string;
+    }[];
+}
+interface OpenAPIInfo {
+    title: string;
+    version: string;
+    description?: string;
+}
+interface OpenAPIOperation {
+    operationId: string;
+    summary: string;
+    tags: string[];
+    parameters?: Record<string, unknown>[];
+    requestBody?: Record<string, unknown>;
+    responses: Record<string, Record<string, unknown>>;
+    security?: Record<string, string[]>[];
+}
+/**
+ * Generate a full OpenAPI 3.1 specification from a `CrudRepoRegistry`.
+ *
+ * Uses Zod 4's native `z.toJSONSchema()` to convert each repo's schema
+ * into a JSON Schema component, then assembles paths for the standard
+ * CRUD endpoints.
+ *
+ * @example
+ * ```ts
+ * import { generateOpenAPISpec } from "@lpdjs/firestore-repo-service/servers/crud";
+ *
+ * const spec = generateOpenAPISpec(registry, "/api", {
+ *   title: "My API",
+ *   version: "1.0.0",
+ *   servers: [{ url: "https://my-api.example.com" }],
+ *   auth: "bearer",
+ * });
+ *
+ * // Write to file
+ * fs.writeFileSync("openapi.json", JSON.stringify(spec, null, 2));
+ * ```
+ */
+declare function generateOpenAPISpec(registry: CrudRepoRegistry, basePath: string, options?: OpenAPISpecOptions): OpenAPIDocument;
+
 /**
  * @module servers/crud
  *
@@ -181,4 +247,4 @@ declare function createCrudServer<TRepos extends Record<string, ConfiguredReposi
     httpsOptions?: HttpsOptions;
 };
 
-export { CrudServerOptions, OpenAPIDocument, createCrudServer };
+export { CrudRepoRegistry, CrudServerOptions, type OpenAPIDocument, OpenAPISpecOptions, createCrudServer, generateOpenAPISpec };