firebase-admin-edge 1.1.1 → 2.0.0

package/dist/db/firestore-endpoints.d.ts

@@ -0,0 +1,41 @@
+import type { FirestoreOpenTelemetryOptions } from './firestore-settings.js';
+import { FirebaseEdgeError } from '../auth/errors.js';
+import type { FirestoreDocument } from './firestore-document.js';
+import { type QueryOptions } from './query-request.js';
+import { type WriteOperation, WriteResult } from './write-request.js';
+import type { AggregateSpec, AggregateData } from './aggregate.js';
+import { Timestamp } from './timestamp.js';
+import { type ExplainOptions, type ExplainMetrics } from './explain.js';
+export declare function batchGetDocuments(projectId: string, databaseId: string, paths: string[], token: string, fetchFn?: typeof globalThis.fetch, fieldMask?: string[], transaction?: string): Promise<(FirestoreDocument | undefined)[]>;
+export declare function listCollectionIds(projectId: string, databaseId: string, parent: string, token: string, fetchFn?: typeof globalThis.fetch): Promise<string[]>;
+export declare function listDocumentPaths(projectId: string, databaseId: string, path: string, token: string, fetchFn?: typeof globalThis.fetch): Promise<string[]>;
+export declare function streamQuery(projectId: string, databaseId: string, collectionPath: string, options: QueryOptions, token: string, fetchFn?: typeof globalThis.fetch, signal?: AbortSignal): AsyncGenerator<FirestoreDocument>;
+export interface QueryRow {
+    document?: FirestoreDocument;
+    metrics?: ExplainMetrics;
+    readTime?: string;
+}
+/** @internal Streaming transport shared by ordinary queries and query explain. */
+export declare function streamQueryRows(projectId: string, databaseId: string, collectionPath: string, options: QueryOptions, token: string, fetchFn?: typeof globalThis.fetch, signal?: AbortSignal, explainOptions?: ExplainOptions): AsyncGenerator<QueryRow>;
+export declare function createDocumentName(projectId: string, databaseId: string, path: string): string;
+/** @internal Independent REST writes, with one result or error per operation. */
+export declare function batchWrite(projectId: string, databaseId: string, operations: WriteOperation[], token: string, fetchFn?: typeof globalThis.fetch): Promise<(WriteResult | FirebaseEdgeError)[]>;
+export declare function commitWrites(projectId: string, databaseId: string, operations: WriteOperation[], token: string, fetchFn?: typeof globalThis.fetch, transaction?: string): Promise<WriteResult[]>;
+export declare function beginTransaction(projectId: string, databaseId: string, token: string, fetchFn?: typeof globalThis.fetch, options?: {
+    readOnly: true;
+    readTime?: Timestamp;
+}): Promise<string>;
+export declare function rollbackTransaction(projectId: string, databaseId: string, transaction: string, token: string, fetchFn?: typeof globalThis.fetch): Promise<void>;
+export declare function runAggregate(projectId: string, databaseId: string, collectionPath: string, options: QueryOptions, spec: AggregateSpec, token: string, fetchFn?: typeof globalThis.fetch, transaction?: string, explainOptions?: ExplainOptions): Promise<AggregateData>;
+/** @internal Fetch and sort all split points; REST pages are not globally ordered. */
+export declare function partitionQuery(projectId: string, databaseId: string, collectionId: string, count: number, token: string, fetchFn?: typeof globalThis.fetch): Promise<string[]>;
+/** @internal Configure the REST destination. */
+export declare function configureFirestoreFetch(fetchFn: typeof globalThis.fetch, host: string, ssl?: boolean, port?: number, telemetry?: FirestoreOpenTelemetryOptions): typeof globalThis.fetch;
+export declare function runQuery(projectId: string, databaseId: string, collectionPath: string, options: QueryOptions, token: string, fetchFn?: typeof globalThis.fetch, transaction?: string): Promise<FirestoreDocument[]>;
+/** Read via batchGet so found and missing documents both retain server read times. */
+export declare function getDocument(projectId: string, databaseId: string, path: string, token: string, fetchFn?: typeof globalThis.fetch, transaction?: string): Promise<FirestoreDocument | undefined>;
+/** Execute REST pipeline stages, preserving errors from streamed response rows. */
+export declare function executePipeline(projectId: string, databaseId: string, structuredPipeline: object, token: string, fetchFn?: typeof globalThis.fetch, transaction?: string, readTime?: Timestamp): Promise<import('./pipeline.js').PipelineResponse>;
+/** @internal Stream pipeline document batches with fetch cancellation and bounded buffering. */
+export declare function streamPipeline(projectId: string, databaseId: string, structuredPipeline: object, token: string, fetchFn?: typeof globalThis.fetch, signal?: AbortSignal, readTime?: Timestamp): AsyncGenerator<Partial<FirestoreDocument>>;
+//# sourceMappingURL=firestore-endpoints.d.ts.map

package/dist/db/firestore-endpoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"firestore-endpoints.d.ts","sourceRoot":"","sources":["../../src/db/firestore-endpoints.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAC;AAI7E,OAAO,EAAE,iBAAiB,EAAe,MAAM,mBAAmB,CAAC;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAwB,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,KAAK,cAAc,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAGnE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAEH,KAAK,cAAc,EACnB,KAAK,cAAc,EACtB,MAAM,cAAc,CAAC;AAEtB,wBAAsB,iBAAiB,CACnC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EAAE,EACf,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,EACjC,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,CAAC,iBAAiB,GAAG,SAAS,CAAC,EAAE,CAAC,CAwD5C;AAED,wBAAsB,iBAAiB,CACnC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,GAClC,OAAO,CAAC,MAAM,EAAE,CAAC,CA4CnB;AAED,wBAAsB,iBAAiB,CACnC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,GAClC,OAAO,CAAC,MAAM,EAAE,CAAC,CAwDnB;AAED,wBAAuB,WAAW,CAC9B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,YAAY,EACrB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,EACjC,MAAM,CAAC,EAAE,WAAW,GACrB,cAAc,CAAC,iBAAiB,CAAC,CAWnC;AACD,MAAM,WAAW,QAAQ;IACrB,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IAC7B,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AACD,kFAAkF;AAClF,wBAAuB,eAAe,CAClC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,YAAY,EACrB,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,OAAO,UAAU,CAAC,KAAwB,EACnD,MAAM,CAAC,EAAE,WAAW,EACpB,cAAc,CAAC,EAAE,cAAc,GAChC,cAAc,CAAC,QAAQ,CAAC,CAkF1B;AAED,wBAAgB,kBAAkB,CAC9B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GACb,MAAM,CAER;AA4BD,iFAAiF;AACjF,wBAAsB,UAAU,CAC5B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,cAAc,EAAE,EAC5B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,GAClC,OAAO,CAAC,CAAC,WAAW,GAAG,iBAAiB,CAAC,EAAE,CAAC,CA2H9C;AAED,wBAAsB,YAAY,CAC9B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,cAAc,EAAE,EAC5B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,EACjC,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,WAAW,EAAE,CAAC,CAiCxB;AAED,wBAAsB,gBAAgB,CAClC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,EACjC,OAAO,CAAC,EAAE;IAAE,QAAQ,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,GACnD,OAAO,CAAC,MAAM,CAAC,CA0BjB;AAED,wBAAsB,mBAAmB,CACrC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,GAClC,OAAO,CAAC,IAAI,CAAC,CAUf;AAED,wBAAsB,YAAY,CAC9B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,YAAY,EACrB,IAAI,EAAE,aAAa,EACnB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,EACjC,WAAW,CAAC,EAAE,MAAM,EACpB,cAAc,CAAC,EAAE,cAAc,GAChC,OAAO,CAAC,aAAa,CAAC,CA8FxB;AAyBD,sFAAsF;AACtF,wBAAsB,cAAc,CAChC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,GAClC,OAAO,CAAC,MAAM,EAAE,CAAC,CAkFnB;AAED,gDAAgD;AAChD,wBAAgB,uBAAuB,CACnC,OAAO,EAAE,OAAO,UAAU,CAAC,KAAK,EAChC,IAAI,EAAE,MAAM,EACZ,GAAG,UAAO,EACV,IAAI,CAAC,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,6BAA6B,GAC1C,OAAO,UAAU,CAAC,KAAK,CA8BzB;AAqCD,wBAAsB,QAAQ,CAC1B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,cAAc,EAAE,MAAM,EACtB,OAAO,EAAE,YAAY,EACrB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,EACjC,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAwD9B;AAED,sFAAsF;AACtF,wBAAsB,WAAW,CAC7B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,EACjC,WAAW,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAkBxC;AAED,mFAAmF;AACnF,wBAAsB,eAAe,CACjC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,kBAAkB,EAAE,MAAM,EAC1B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,EACjC,WAAW,CAAC,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,SAAS,GACrB,OAAO,CAAC,OAAO,eAAe,EAAE,gBAAgB,CAAC,CAkEnD;AAED,gGAAgG;AAChG,wBAAuB,cAAc,CACjC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,kBAAkB,EAAE,MAAM,EAC1B,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,OAAO,UAAU,CAAC,KAAwB,EACnD,MAAM,CAAC,EAAE,WAAW,EACpB,QAAQ,CAAC,EAAE,SAAS,GACrB,cAAc,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CA8D5C"}