poc full modular

Author: MarkDuckworth

common/api-review/firestore-lite.api.md

@@ -45,6 +45,11 @@ export class AddFields implements Stage {
     name: string;
 }
 
+// Warning: (ae-incompatible-release-tags) The symbol "addFields" is marked as @public, but its signature references "Selectable" which is marked as @beta
+//
+// @public
+export function addFields<AppModelType>(pipeline: Pipeline<AppModelType>, ...fields: Selectable[]): Pipeline<AppModelType>;
+
 // @public
 export type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
     [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
@@ -57,6 +62,17 @@ export class Aggregate implements Stage {
     name: string;
 }
 
+// Warning: (ae-incompatible-release-tags) The symbol "aggregate" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
+//
+// @public
+export function aggregate<AppModelType>(pipeline: Pipeline<AppModelType>, ...accumulators: AccumulatorTarget[]): Pipeline<AppModelType>;
+
+// @public
+export function aggregate<AppModelType>(pipeline: Pipeline<AppModelType>, options: {
+    accumulators: AccumulatorTarget[];
+    groups?: Array<string | Selectable>;
+}): Pipeline<AppModelType>;
+
 // @public
 export class AggregateField<T> {
     readonly aggregateType: AggregateType;
@@ -270,13 +286,23 @@ export function collection<AppModelType, DbModelType extends DocumentData>(refer
 // @public
 export function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;
 
+// Warning: (ae-incompatible-release-tags) The symbol "collectionGroupP" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
+//
+// @public (undocumented)
+export function collectionGroupP(pipelineSource: PipelineSource, collectionId: string): Pipeline;
+
 // @beta (undocumented)
 export class CollectionGroupSource implements Stage {
     constructor(collectionId: string);
     // (undocumented)
     name: string;
 }
 
+// Warning: (ae-incompatible-release-tags) The symbol "collectionP" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
+//
+// @public (undocumented)
+export function collectionP(pipelineSource: PipelineSource, collectionPath: string): Pipeline;
+
 // @public
 export class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType> {
     get id(): string;
@@ -458,6 +484,11 @@ export function countExpression(value: Constant): Count;
 // @public
 export function countExpression(value: string): Count;
 
+// Warning: (ae-incompatible-release-tags) The symbol "database" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
+//
+// @public (undocumented)
+export function database(pipelineSource: PipelineSource): Pipeline;
+
 // @beta (undocumented)
 export class DatabaseSource implements Stage {
     // (undocumented)
@@ -480,6 +511,11 @@ export class Distinct implements Stage {
     name: string;
 }
 
+// Warning: (ae-incompatible-release-tags) The symbol "distinct" is marked as @public, but its signature references "Selectable" which is marked as @beta
+//
+// @public
+export function distinct<AppModelType>(pipeline: Pipeline<AppModelType>, ...groups: Array<string | Selectable>): Pipeline<AppModelType>;
+
 // @beta (undocumented)
 export class Divide extends FirestoreFunction {
     constructor(left: Constant, right: Constant);
@@ -526,6 +562,11 @@ export class DocumentReference<AppModelType = DocumentData, DbModelType extends
     withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
 }
 
+// Warning: (ae-incompatible-release-tags) The symbol "documents" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
+//
+// @public (undocumented)
+export function documents(pipelineSource: PipelineSource, docs: DocumentReference[]): Pipeline;
+
 // @public
 export class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> {
     protected constructor();
@@ -643,6 +684,11 @@ export function euclideanDistance(expr: Constant, other: VectorValue): Euclidean
 // @beta
 export function euclideanDistance(expr: Constant, other: Constant): EuclideanDistance;
 
+// Warning: (ae-incompatible-release-tags) The symbol "execute" is marked as @public, but its signature references "PipelineResult" which is marked as @beta
+//
+// @public
+export function execute<AppModelType>(pipeline: Pipeline<AppModelType>): Promise<Array<PipelineResult<AppModelType>>>;
+
 // @beta (undocumented)
 export class Exists extends FirestoreFunction implements FilterCondition {
     constructor(expr: Constant);
@@ -1012,6 +1058,11 @@ export class FindNearest implements Stage {
     name: string;
 }
 
+// Warning: (ae-incompatible-release-tags) The symbol "findNearest" is marked as @public, but its signature references "FindNearestOptions" which is marked as @beta
+//
+// @public (undocumented)
+export function findNearest<AppModelType>(pipeline: Pipeline<AppModelType>, options: FindNearestOptions): Pipeline<AppModelType>;
+
 // @beta (undocumented)
 export interface FindNearestOptions {
     // (undocumented)
@@ -1029,10 +1080,6 @@ export interface FindNearestOptions {
 // @public
 export class Firestore {
     get app(): FirebaseApp;
-    // Warning: (ae-incompatible-release-tags) The symbol "pipeline" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
-    //
-    // (undocumented)
-    pipeline(): PipelineSource;
     toJSON(): object;
     type: 'firestore-lite' | 'firestore';
 }
@@ -1166,6 +1213,9 @@ export class GenericStage implements Stage {
     name: string;
 }
 
+// @public
+export function genericStage<AppModelType>(pipeline: Pipeline<AppModelType>, name: string, params: any[]): Pipeline<AppModelType>;
+
 // @public
 export class GeoPoint {
     constructor(latitude: number, longitude: number);
@@ -1322,6 +1372,9 @@ export class Limit implements Stage {
 // @public
 export function limit(limit: number): QueryLimitConstraint;
 
+// @public
+export function limitP<AppModelType>(pipeline: Pipeline<AppModelType>, limit: number): Pipeline<AppModelType>;
+
 // @public
 export function limitToLast(limit: number): QueryLimitConstraint;
 
@@ -1526,6 +1579,9 @@ export class Offset implements Stage {
     name: string;
     }
 
+// @public
+export function offset<AppModelType>(pipeline: Pipeline<AppModelType>, offset: number): Pipeline<AppModelType>;
+
 // @beta (undocumented)
 export class Or extends FirestoreFunction implements FilterCondition {
     constructor(conditions: FilterExpr[]);
@@ -1557,36 +1613,6 @@ export type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T
 
 // @public
 export class Pipeline<AppModelType = DocumentData> {
-    // Warning: (ae-incompatible-release-tags) The symbol "addFields" is marked as @public, but its signature references "Selectable" which is marked as @beta
-    addFields(...fields: Selectable[]): Pipeline<AppModelType>;
-    // Warning: (ae-incompatible-release-tags) The symbol "aggregate" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
-    aggregate(...accumulators: AccumulatorTarget[]): Pipeline<AppModelType>;
-    aggregate(options: {
-        accumulators: AccumulatorTarget[];
-        groups?: Array<string | Selectable>;
-    }): Pipeline<AppModelType>;
-    // Warning: (ae-incompatible-release-tags) The symbol "distinct" is marked as @public, but its signature references "Selectable" which is marked as @beta
-    distinct(...groups: Array<string | Selectable>): Pipeline<AppModelType>;
-    // Warning: (ae-incompatible-release-tags) The symbol "execute" is marked as @public, but its signature references "PipelineResult" which is marked as @beta
-    execute(): Promise<Array<PipelineResult<AppModelType>>>;
-    // Warning: (ae-incompatible-release-tags) The symbol "findNearest" is marked as @public, but its signature references "FindNearestOptions" which is marked as @beta
-    //
-    // (undocumented)
-    findNearest(options: FindNearestOptions): Pipeline<AppModelType>;
-    genericStage(name: string, params: any[]): Pipeline<AppModelType>;
-    limit(limit: number): Pipeline<AppModelType>;
-    offset(offset: number): Pipeline<AppModelType>;
-    // Warning: (ae-incompatible-release-tags) The symbol "select" is marked as @public, but its signature references "Selectable" which is marked as @beta
-    select(...selections: Array<Selectable | string>): Pipeline<AppModelType>;
-    // Warning: (ae-incompatible-release-tags) The symbol "sort" is marked as @public, but its signature references "Ordering" which is marked as @beta
-    sort(...orderings: Ordering[]): Pipeline<AppModelType>;
-    // (undocumented)
-    sort(options: {
-        orderings: Ordering[];
-    }): Pipeline<AppModelType>;
-    // Warning: (ae-incompatible-release-tags) The symbol "where" is marked as @public, but its signature references "FilterCondition" which is marked as @beta
-    // Warning: (ae-incompatible-release-tags) The symbol "where" is marked as @public, but its signature references "Constant" which is marked as @beta
-    where(condition: FilterCondition & Constant): Pipeline<AppModelType>;
 }
 
 // @public (undocumented)
@@ -1613,15 +1639,7 @@ export class PipelineResult<AppModelType = DocumentData> {
 
 // @beta
 export class PipelineSource {
-    // (undocumented)
-    collection(collectionPath: string): Pipeline;
-    // (undocumented)
-    collectionGroup(collectionId: string): Pipeline;
-    // (undocumented)
-    database(): Pipeline;
-    // (undocumented)
-    documents(docs: DocumentReference[]): Pipeline;
-    }
+}
 
 // @public
 export type Primitive = string | number | boolean | undefined | null;
@@ -1794,6 +1812,11 @@ export class Select implements Stage {
     name: string;
     }
 
+// Warning: (ae-incompatible-release-tags) The symbol "select" is marked as @public, but its signature references "Selectable" which is marked as @beta
+//
+// @public
+export function select<AppModelType>(pipeline: Pipeline<AppModelType>, ...selections: Array<Selectable | string>): Pipeline<AppModelType>;
+
 // @beta
 export interface Selectable {
     // (undocumented)
@@ -1839,6 +1862,16 @@ export class Sort implements Stage {
     name: string;
     }
 
+// Warning: (ae-incompatible-release-tags) The symbol "sort" is marked as @public, but its signature references "Ordering" which is marked as @beta
+//
+// @public
+export function sort<AppModelType>(pipeline: Pipeline<AppModelType>, ...orderings: Ordering[]): Pipeline<AppModelType>;
+
+// @public (undocumented)
+export function sort<AppModelType>(pipeline: Pipeline<AppModelType>, options: {
+    orderings: Ordering[];
+}): Pipeline<AppModelType>;
+
 // @beta (undocumented)
 export interface Stage {
     // (undocumented)
@@ -2153,6 +2186,12 @@ export function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value
 // @public
 export type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';
 
+// Warning: (ae-incompatible-release-tags) The symbol "whereP" is marked as @public, but its signature references "FilterCondition" which is marked as @beta
+// Warning: (ae-incompatible-release-tags) The symbol "whereP" is marked as @public, but its signature references "Constant" which is marked as @beta
+//
+// @public
+export function whereP<AppModelType>(pipeline: Pipeline<AppModelType>, condition: FilterCondition & Constant): Pipeline<AppModelType>;
+
 // @public
 export type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
     [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
@@ -2184,8 +2223,8 @@ export function xor(left: FilterExpr, ...right: FilterExpr[]): Xor;
 
 // Warnings were encountered during analysis:
 //
-// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:9257:9 - (ae-incompatible-release-tags) The symbol "accumulators" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
-// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:9258:9 - (ae-incompatible-release-tags) The symbol "groups" is marked as @public, but its signature references "Selectable" which is marked as @beta
-// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:9287:9 - (ae-incompatible-release-tags) The symbol "orderings" is marked as @public, but its signature references "Ordering" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:220:5 - (ae-incompatible-release-tags) The symbol "accumulators" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:221:5 - (ae-incompatible-release-tags) The symbol "groups" is marked as @public, but its signature references "Selectable" which is marked as @beta
+// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/index.d.ts:10070:5 - (ae-incompatible-release-tags) The symbol "orderings" is marked as @public, but its signature references "Ordering" which is marked as @beta
 
 ```