@lpdjs/firestore-repo-service 2.2.3 → 2.2.5

package/dist/openapi-B3P2F8op.d.ts

@@ -0,0 +1,69 @@
+import { s as CrudRepoRegistry, O as OpenAPISpecOptions } from './types-Z9Qy8Xmx.js';
+
+/**
+ * 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;
+
+export { type OpenAPIDocument as O, generateOpenAPISpec as g };

package/dist/openapi-UJJ1aCFk.d.cts

@@ -0,0 +1,69 @@
+import { s as CrudRepoRegistry, O as OpenAPISpecOptions } from './types-Z9Qy8Xmx.cjs';
+
+/**
+ * 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;
+
+export { type OpenAPIDocument as O, generateOpenAPISpec as g };

package/dist/queue-D_-aMf4H.d.ts

@@ -0,0 +1,52 @@
+import { a as SqlAdapter, S as SyncEvent } from './types-CX5AbZWV.js';
+
+/**
+ * Per-repo in-memory batch buffer.
+ *
+ * Accumulates {@link SyncEvent}s and flushes them in batches to a
+ * {@link SqlAdapter}. On flush failure the events are re-published
+ * to PubSub for retry (if a PubSub re-publisher is provided).
+ */
+
+interface SyncQueueOptions {
+    /** SQL adapter to flush data to */
+    adapter: SqlAdapter;
+    /** SQL table name */
+    tableName: string;
+    /** Primary key column name */
+    primaryKey: string;
+    /** Max rows per flush (default: 100) */
+    batchSize?: number;
+    /** Auto-flush interval in ms (default: 5_000). 0 = manual only. */
+    flushIntervalMs?: number;
+    /** Called on flush failure with the failed events. Typically re-publishes to PubSub. */
+    onFlushError?: (events: SyncEvent[], error: unknown) => Promise<void>;
+}
+/**
+ * In-memory buffer that batches sync events per-repo and flushes them
+ * to a SQL adapter.
+ */
+declare class SyncQueue {
+    private buffer;
+    private flushing;
+    private timer;
+    private readonly adapter;
+    private readonly tableName;
+    private readonly primaryKey;
+    private readonly batchSize;
+    private readonly onFlushError?;
+    constructor(opts: SyncQueueOptions);
+    /** Number of events waiting in the buffer. */
+    get size(): number;
+    /** Push one or more events into the buffer. Triggers auto-flush if batchSize reached. */
+    enqueue(...events: SyncEvent[]): void;
+    /**
+     * Flush all buffered events to the SQL adapter.
+     * Upserts and deletes are batched separately.
+     */
+    flush(): Promise<void>;
+    /** Stop the auto-flush timer and flush remaining events. */
+    shutdown(): Promise<void>;
+}
+
+export { SyncQueue as S, type SyncQueueOptions as a };

package/dist/queue-Dk1Ezhkf.d.cts

@@ -0,0 +1,52 @@
+import { a as SqlAdapter, S as SyncEvent } from './types-CX5AbZWV.cjs';
+
+/**
+ * Per-repo in-memory batch buffer.
+ *
+ * Accumulates {@link SyncEvent}s and flushes them in batches to a
+ * {@link SqlAdapter}. On flush failure the events are re-published
+ * to PubSub for retry (if a PubSub re-publisher is provided).
+ */
+
+interface SyncQueueOptions {
+    /** SQL adapter to flush data to */
+    adapter: SqlAdapter;
+    /** SQL table name */
+    tableName: string;
+    /** Primary key column name */
+    primaryKey: string;
+    /** Max rows per flush (default: 100) */
+    batchSize?: number;
+    /** Auto-flush interval in ms (default: 5_000). 0 = manual only. */
+    flushIntervalMs?: number;
+    /** Called on flush failure with the failed events. Typically re-publishes to PubSub. */
+    onFlushError?: (events: SyncEvent[], error: unknown) => Promise<void>;
+}
+/**
+ * In-memory buffer that batches sync events per-repo and flushes them
+ * to a SQL adapter.
+ */
+declare class SyncQueue {
+    private buffer;
+    private flushing;
+    private timer;
+    private readonly adapter;
+    private readonly tableName;
+    private readonly primaryKey;
+    private readonly batchSize;
+    private readonly onFlushError?;
+    constructor(opts: SyncQueueOptions);
+    /** Number of events waiting in the buffer. */
+    get size(): number;
+    /** Push one or more events into the buffer. Triggers auto-flush if batchSize reached. */
+    enqueue(...events: SyncEvent[]): void;
+    /**
+     * Flush all buffered events to the SQL adapter.
+     * Upserts and deletes are batched separately.
+     */
+    flush(): Promise<void>;
+    /** Stop the auto-flush timer and flush remaining events. */
+    shutdown(): Promise<void>;
+}
+
+export { SyncQueue as S, type SyncQueueOptions as a };

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

@@ -1,5 +1,5 @@
 import 'zod';
 import 'firebase-functions/v2/https';
-import '../../types-DKgWRTDf.cjs';
-export { A as AdminRepoConfig, a as AdminRepoEntry, b as AdminServerOptions, B as BasicAuthConfig, d as Middleware, M as MiniRouter, e as RepoRegistry, f as RouteHandler, c as createAdminServer } from '../../index-bqqrGjxe.cjs';
+import '../../types-Z9Qy8Xmx.cjs';
+export { A as AdminRepoConfig, a as AdminRepoEntry, b as AdminServerOptions, B as BasicAuthConfig, c as Middleware, M as MiniRouter, d as RepoRegistry, e as RouteHandler, f as createAdminServer } from '../../index-DpD4DEqH.cjs';
 import 'firebase-admin/firestore';

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

@@ -1,5 +1,5 @@
 import 'zod';
 import 'firebase-functions/v2/https';
-import '../../types-DKgWRTDf.js';
-export { A as AdminRepoConfig, a as AdminRepoEntry, b as AdminServerOptions, B as BasicAuthConfig, d as Middleware, M as MiniRouter, e as RepoRegistry, f as RouteHandler, c as createAdminServer } from '../../index-Bw1fvzu5.js';
+import '../../types-Z9Qy8Xmx.js';
+export { A as AdminRepoConfig, a as AdminRepoEntry, b as AdminServerOptions, B as BasicAuthConfig, c as Middleware, M as MiniRouter, d as RepoRegistry, e as RouteHandler, f as createAdminServer } from '../../index-Cvip2Sgt.js';
 import 'firebase-admin/firestore';