@lpdjs/firestore-repo-service 2.2.3 → 2.2.5

package/dist/{types-BbCdscqh.d.cts → types-CX5AbZWV.d.cts}

@@ -337,4 +337,4 @@ interface FirestoreSyncConfig<M = Record<string, any>> {
     repos?: TypedRepoSyncConfigs<M>;
 }
 
-export type { AdminHttpsOptions as A, FirestoreSyncConfig as F, GenerateDDLConfig as G, LogicalType as L, OrFactory as O, PubSubClientDep as P, RepoSyncConfig as R, SqlAdapter as S, SyncEvent as a, adminsyncConfig as b, SqlDialect as c, SqlColumn as d, SqlTableDef as e, SyncTriggersConfig as f, SyncWorkerConfig as g, FirestoreTriggersDep as h, PubSubHandlerDep as i, SyncDeps as j, SyncOperation as k, SyncWorkerOptions as l, adminsyncBasicAuth as m, adminsyncFeaturesFlag as n };
+export type { AdminHttpsOptions as A, FirestoreSyncConfig as F, GenerateDDLConfig as G, LogicalType as L, OrFactory as O, PubSubClientDep as P, RepoSyncConfig as R, SyncEvent as S, SqlAdapter as a, adminsyncConfig as b, SqlDialect as c, SqlColumn as d, SqlTableDef as e, SyncTriggersConfig as f, SyncWorkerConfig as g, FirestoreTriggersDep as h, PubSubHandlerDep as i, SyncDeps as j, SyncOperation as k, SyncWorkerOptions as l, adminsyncBasicAuth as m, adminsyncFeaturesFlag as n };

package/dist/{types-BbCdscqh.d.ts → types-CX5AbZWV.d.ts}

@@ -337,4 +337,4 @@ interface FirestoreSyncConfig<M = Record<string, any>> {
     repos?: TypedRepoSyncConfigs<M>;
 }
 
-export type { AdminHttpsOptions as A, FirestoreSyncConfig as F, GenerateDDLConfig as G, LogicalType as L, OrFactory as O, PubSubClientDep as P, RepoSyncConfig as R, SqlAdapter as S, SyncEvent as a, adminsyncConfig as b, SqlDialect as c, SqlColumn as d, SqlTableDef as e, SyncTriggersConfig as f, SyncWorkerConfig as g, FirestoreTriggersDep as h, PubSubHandlerDep as i, SyncDeps as j, SyncOperation as k, SyncWorkerOptions as l, adminsyncBasicAuth as m, adminsyncFeaturesFlag as n };
+export type { AdminHttpsOptions as A, FirestoreSyncConfig as F, GenerateDDLConfig as G, LogicalType as L, OrFactory as O, PubSubClientDep as P, RepoSyncConfig as R, SyncEvent as S, SqlAdapter as a, adminsyncConfig as b, SqlDialect as c, SqlColumn as d, SqlTableDef as e, SyncTriggersConfig as f, SyncWorkerConfig as g, FirestoreTriggersDep as h, PubSubHandlerDep as i, SyncDeps as j, SyncOperation as k, SyncWorkerOptions as l, adminsyncBasicAuth as m, adminsyncFeaturesFlag as n };

package/dist/{types-DKgWRTDf.d.cts → types-Z9Qy8Xmx.d.cts}

@@ -515,38 +515,14 @@ type ConfiguredRepository<T extends RepositoryConfig<any, any, any, any, any, an
 };
 
 /**
- * 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
+ * Type definitions for the CRUD API server.
  */
 
-/** 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;
-}
+/**
+ * Options to control OpenAPI 3.1 spec generation for the CRUD server.
+ * Defined here (rather than in `./openapi`) to avoid a circular import:
+ * `openapi.ts` imports types from this module.
+ */
 interface OpenAPISpecOptions {
     /** Document title (default: "CRUD API") */
     title?: string;
@@ -562,43 +538,6 @@ interface OpenAPISpecOptions {
     /** Whether the API requires auth — adds securitySchemes */
     auth?: "basic" | "bearer" | false;
 }
-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;
-
-/**
- * Type definitions for the CRUD API server.
- */
-
 /**
  * Extracts the model type `T` from a `ConfiguredRepository`.
  * Uses a two-step inference so it survives intersection types
@@ -926,4 +865,4 @@ interface QueryRequestBody {
     })[];
 }
 
-export { type ApiResponse as A, type BasicAuthConfig as B, type ConfiguredRepository as C, type ExtractDocumentRefSignature as E, type FieldPath as F, type GetOptions as G, type IncludeConfigTyped as I, type ListResponseData as L, type Middleware as M, type OpenAPIDocument as O, type PaginationOptions as P, type QueryOptions as Q, type RepositoryConfig as R, type UserFieldPath as U, type WhereClause as W, type RelationConfig as a, type ExtractUpdateSignature as b, type GetResult as c, type RelationalKeys as d, createPaginationIterator as e, executePaginatedQuery as f, type PaginationResult as g, type GenerateGetMethods as h, type GenerateQueryMethods as i, type PaginationWithIncludeOptionsTyped as j, type PopulateOptionsTyped as k, type CrudRepoConfig as l, type CrudServerOptions as m, type FieldRole as n, type QueryRequestBody as o, type RepoFieldPath as p, type RepoRelationKeys as q, type CrudRepoEntry as r, type CrudRepoRegistry as s, generateOpenAPISpec as t, type OpenAPISpecOptions as u };
+export { type ApiResponse as A, type BasicAuthConfig as B, type ConfiguredRepository as C, type ExtractDocumentRefSignature as E, type FieldPath as F, type GetOptions as G, type IncludeConfigTyped as I, type ListResponseData as L, type Middleware as M, type OpenAPISpecOptions as O, type PaginationOptions as P, type QueryOptions as Q, type RepositoryConfig as R, type UserFieldPath as U, type WhereClause as W, type RelationConfig as a, type ExtractUpdateSignature as b, type GetResult as c, type RelationalKeys as d, createPaginationIterator as e, executePaginatedQuery as f, type PaginationResult as g, type GenerateGetMethods as h, type GenerateQueryMethods as i, type PaginationWithIncludeOptionsTyped as j, type PopulateOptionsTyped as k, type CrudRepoConfig as l, type CrudServerOptions as m, type FieldRole as n, type QueryRequestBody as o, type RepoFieldPath as p, type RepoRelationKeys as q, type CrudRepoEntry as r, type CrudRepoRegistry as s };

package/dist/{types-DKgWRTDf.d.ts → types-Z9Qy8Xmx.d.ts}

@@ -515,38 +515,14 @@ type ConfiguredRepository<T extends RepositoryConfig<any, any, any, any, any, an
 };
 
 /**
- * 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
+ * Type definitions for the CRUD API server.
  */
 
-/** 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;
-}
+/**
+ * Options to control OpenAPI 3.1 spec generation for the CRUD server.
+ * Defined here (rather than in `./openapi`) to avoid a circular import:
+ * `openapi.ts` imports types from this module.
+ */
 interface OpenAPISpecOptions {
     /** Document title (default: "CRUD API") */
     title?: string;
@@ -562,43 +538,6 @@ interface OpenAPISpecOptions {
     /** Whether the API requires auth — adds securitySchemes */
     auth?: "basic" | "bearer" | false;
 }
-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;
-
-/**
- * Type definitions for the CRUD API server.
- */
-
 /**
  * Extracts the model type `T` from a `ConfiguredRepository`.
  * Uses a two-step inference so it survives intersection types
@@ -926,4 +865,4 @@ interface QueryRequestBody {
     })[];
 }
 
-export { type ApiResponse as A, type BasicAuthConfig as B, type ConfiguredRepository as C, type ExtractDocumentRefSignature as E, type FieldPath as F, type GetOptions as G, type IncludeConfigTyped as I, type ListResponseData as L, type Middleware as M, type OpenAPIDocument as O, type PaginationOptions as P, type QueryOptions as Q, type RepositoryConfig as R, type UserFieldPath as U, type WhereClause as W, type RelationConfig as a, type ExtractUpdateSignature as b, type GetResult as c, type RelationalKeys as d, createPaginationIterator as e, executePaginatedQuery as f, type PaginationResult as g, type GenerateGetMethods as h, type GenerateQueryMethods as i, type PaginationWithIncludeOptionsTyped as j, type PopulateOptionsTyped as k, type CrudRepoConfig as l, type CrudServerOptions as m, type FieldRole as n, type QueryRequestBody as o, type RepoFieldPath as p, type RepoRelationKeys as q, type CrudRepoEntry as r, type CrudRepoRegistry as s, generateOpenAPISpec as t, type OpenAPISpecOptions as u };
+export { type ApiResponse as A, type BasicAuthConfig as B, type ConfiguredRepository as C, type ExtractDocumentRefSignature as E, type FieldPath as F, type GetOptions as G, type IncludeConfigTyped as I, type ListResponseData as L, type Middleware as M, type OpenAPISpecOptions as O, type PaginationOptions as P, type QueryOptions as Q, type RepositoryConfig as R, type UserFieldPath as U, type WhereClause as W, type RelationConfig as a, type ExtractUpdateSignature as b, type GetResult as c, type RelationalKeys as d, createPaginationIterator as e, executePaginatedQuery as f, type PaginationResult as g, type GenerateGetMethods as h, type GenerateQueryMethods as i, type PaginationWithIncludeOptionsTyped as j, type PopulateOptionsTyped as k, type CrudRepoConfig as l, type CrudServerOptions as m, type FieldRole as n, type QueryRequestBody as o, type RepoFieldPath as p, type RepoRelationKeys as q, type CrudRepoEntry as r, type CrudRepoRegistry as s };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lpdjs/firestore-repo-service",
-  "version": "2.2.3",
+  "version": "2.2.5",
   "description": "⚡ Type-safe Firestore ORM with auto-generated repositories, advanced queries, relations with typed select, pagination with include, batch/bulk operations, aggregations and transactions.",
   "type": "module",
   "main": "./dist/index.cjs",