Skip to content

Commit 8e52691

Browse files
MarkDuckworthMarkDuckworth
committed
Merge branch 'markduckworth/ppl-mod' of github.com:firebase/firebase-js-sdk into markduckworth/ppl-mod
2 parents 272f722 + 9a47899 commit 8e52691

File tree

2 files changed

+108
-170
lines changed

2 files changed

+108
-170
lines changed

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

Lines changed: 42 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,6 @@ export class AddFields implements Stage {
4545
name: string;
4646
}
4747

48-
// Warning: (ae-incompatible-release-tags) The symbol "addFields" is marked as @public, but its signature references "Selectable" which is marked as @beta
49-
//
50-
// @public
51-
export function addFields<AppModelType>(pipeline: Pipeline<AppModelType>, ...fields: Selectable[]): Pipeline<AppModelType>;
52-
5348
// @public
5449
export type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
5550
[K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
@@ -62,17 +57,6 @@ export class Aggregate implements Stage {
6257
name: string;
6358
}
6459

65-
// Warning: (ae-incompatible-release-tags) The symbol "aggregate" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
66-
//
67-
// @public
68-
export function aggregate<AppModelType>(pipeline: Pipeline<AppModelType>, ...accumulators: AccumulatorTarget[]): Pipeline<AppModelType>;
69-
70-
// @public
71-
export function aggregate<AppModelType>(pipeline: Pipeline<AppModelType>, options: {
72-
accumulators: AccumulatorTarget[];
73-
groups?: Array<string | Selectable>;
74-
}): Pipeline<AppModelType>;
75-
7660
// @public
7761
export class AggregateField<T> {
7862
readonly aggregateType: AggregateType;
@@ -286,23 +270,13 @@ export function collection<AppModelType, DbModelType extends DocumentData>(refer
286270
// @public
287271
export function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;
288272

289-
// Warning: (ae-incompatible-release-tags) The symbol "collectionGroupP" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
290-
//
291-
// @public (undocumented)
292-
export function collectionGroupP(pipelineSource: PipelineSource, collectionId: string): Pipeline;
293-
294273
// @beta (undocumented)
295274
export class CollectionGroupSource implements Stage {
296275
constructor(collectionId: string);
297276
// (undocumented)
298277
name: string;
299278
}
300279

301-
// Warning: (ae-incompatible-release-tags) The symbol "collectionP" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
302-
//
303-
// @public (undocumented)
304-
export function collectionP(pipelineSource: PipelineSource, collectionPath: string): Pipeline;
305-
306280
// @public
307281
export class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType> {
308282
get id(): string;
@@ -484,11 +458,6 @@ export function countExpression(value: Constant): Count;
484458
// @public
485459
export function countExpression(value: string): Count;
486460

487-
// Warning: (ae-incompatible-release-tags) The symbol "database" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
488-
//
489-
// @public (undocumented)
490-
export function database(pipelineSource: PipelineSource): Pipeline;
491-
492461
// @beta (undocumented)
493462
export class DatabaseSource implements Stage {
494463
// (undocumented)
@@ -511,11 +480,6 @@ export class Distinct implements Stage {
511480
name: string;
512481
}
513482

514-
// Warning: (ae-incompatible-release-tags) The symbol "distinct" is marked as @public, but its signature references "Selectable" which is marked as @beta
515-
//
516-
// @public
517-
export function distinct<AppModelType>(pipeline: Pipeline<AppModelType>, ...groups: Array<string | Selectable>): Pipeline<AppModelType>;
518-
519483
// @beta (undocumented)
520484
export class Divide extends FirestoreFunction {
521485
constructor(left: Constant, right: Constant);
@@ -562,11 +526,6 @@ export class DocumentReference<AppModelType = DocumentData, DbModelType extends
562526
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
563527
}
564528

565-
// Warning: (ae-incompatible-release-tags) The symbol "documents" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
566-
//
567-
// @public (undocumented)
568-
export function documents(pipelineSource: PipelineSource, docs: DocumentReference[]): Pipeline;
569-
570529
// @public
571530
export class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> {
572531
protected constructor();
@@ -684,11 +643,6 @@ export function euclideanDistance(expr: Constant, other: VectorValue): Euclidean
684643
// @beta
685644
export function euclideanDistance(expr: Constant, other: Constant): EuclideanDistance;
686645

687-
// Warning: (ae-incompatible-release-tags) The symbol "execute" is marked as @public, but its signature references "PipelineResult" which is marked as @beta
688-
//
689-
// @public
690-
export function execute<AppModelType>(pipeline: Pipeline<AppModelType>): Promise<Array<PipelineResult<AppModelType>>>;
691-
692646
// @beta (undocumented)
693647
export class Exists extends FirestoreFunction implements FilterCondition {
694648
constructor(expr: Constant);
@@ -1058,11 +1012,6 @@ export class FindNearest implements Stage {
10581012
name: string;
10591013
}
10601014

1061-
// Warning: (ae-incompatible-release-tags) The symbol "findNearest" is marked as @public, but its signature references "FindNearestOptions" which is marked as @beta
1062-
//
1063-
// @public (undocumented)
1064-
export function findNearest<AppModelType>(pipeline: Pipeline<AppModelType>, options: FindNearestOptions): Pipeline<AppModelType>;
1065-
10661015
// @beta (undocumented)
10671016
export interface FindNearestOptions {
10681017
// (undocumented)
@@ -1213,9 +1162,6 @@ export class GenericStage implements Stage {
12131162
name: string;
12141163
}
12151164

1216-
// @public
1217-
export function genericStage<AppModelType>(pipeline: Pipeline<AppModelType>, name: string, params: any[]): Pipeline<AppModelType>;
1218-
12191165
// @public
12201166
export class GeoPoint {
12211167
constructor(latitude: number, longitude: number);
@@ -1372,9 +1318,6 @@ export class Limit implements Stage {
13721318
// @public
13731319
export function limit(limit: number): QueryLimitConstraint;
13741320

1375-
// @public
1376-
export function limitP<AppModelType>(pipeline: Pipeline<AppModelType>, limit: number): Pipeline<AppModelType>;
1377-
13781321
// @public
13791322
export function limitToLast(limit: number): QueryLimitConstraint;
13801323

@@ -1579,9 +1522,6 @@ export class Offset implements Stage {
15791522
name: string;
15801523
}
15811524

1582-
// @public
1583-
export function offset<AppModelType>(pipeline: Pipeline<AppModelType>, offset: number): Pipeline<AppModelType>;
1584-
15851525
// @beta (undocumented)
15861526
export class Or extends FirestoreFunction implements FilterCondition {
15871527
constructor(conditions: FilterExpr[]);
@@ -1613,6 +1553,36 @@ export type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T
16131553

16141554
// @public
16151555
export class Pipeline<AppModelType = DocumentData> {
1556+
// Warning: (ae-incompatible-release-tags) The symbol "addFields" is marked as @public, but its signature references "Selectable" which is marked as @beta
1557+
addFields(...fields: Selectable[]): Pipeline<AppModelType>;
1558+
// Warning: (ae-incompatible-release-tags) The symbol "aggregate" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
1559+
aggregate(...accumulators: AccumulatorTarget[]): Pipeline<AppModelType>;
1560+
aggregate(options: {
1561+
accumulators: AccumulatorTarget[];
1562+
groups?: Array<string | Selectable>;
1563+
}): Pipeline<AppModelType>;
1564+
// Warning: (ae-incompatible-release-tags) The symbol "distinct" is marked as @public, but its signature references "Selectable" which is marked as @beta
1565+
distinct(...groups: Array<string | Selectable>): Pipeline<AppModelType>;
1566+
// Warning: (ae-incompatible-release-tags) The symbol "execute" is marked as @public, but its signature references "PipelineResult" which is marked as @beta
1567+
execute(): Promise<Array<PipelineResult<AppModelType>>>;
1568+
// Warning: (ae-incompatible-release-tags) The symbol "findNearest" is marked as @public, but its signature references "FindNearestOptions" which is marked as @beta
1569+
//
1570+
// (undocumented)
1571+
findNearest(options: FindNearestOptions): Pipeline<AppModelType>;
1572+
genericStage(name: string, params: any[]): Pipeline<AppModelType>;
1573+
limit(limit: number): Pipeline<AppModelType>;
1574+
offset(offset: number): Pipeline<AppModelType>;
1575+
// Warning: (ae-incompatible-release-tags) The symbol "select" is marked as @public, but its signature references "Selectable" which is marked as @beta
1576+
select(...selections: Array<Selectable | string>): Pipeline<AppModelType>;
1577+
// Warning: (ae-incompatible-release-tags) The symbol "sort" is marked as @public, but its signature references "Ordering" which is marked as @beta
1578+
sort(...orderings: Ordering[]): Pipeline<AppModelType>;
1579+
// (undocumented)
1580+
sort(options: {
1581+
orderings: Ordering[];
1582+
}): Pipeline<AppModelType>;
1583+
// Warning: (ae-incompatible-release-tags) The symbol "where" is marked as @public, but its signature references "FilterCondition" which is marked as @beta
1584+
// Warning: (ae-incompatible-release-tags) The symbol "where" is marked as @public, but its signature references "Constant" which is marked as @beta
1585+
where(condition: FilterCondition & Constant): Pipeline<AppModelType>;
16161586
}
16171587

16181588
// @public (undocumented)
@@ -1639,7 +1609,15 @@ export class PipelineResult<AppModelType = DocumentData> {
16391609

16401610
// @beta
16411611
export class PipelineSource {
1642-
}
1612+
// (undocumented)
1613+
collection(collectionPath: string): Pipeline;
1614+
// (undocumented)
1615+
collectionGroup(collectionId: string): Pipeline;
1616+
// (undocumented)
1617+
database(): Pipeline;
1618+
// (undocumented)
1619+
documents(docs: DocumentReference[]): Pipeline;
1620+
}
16431621

16441622
// @public
16451623
export type Primitive = string | number | boolean | undefined | null;
@@ -1812,11 +1790,6 @@ export class Select implements Stage {
18121790
name: string;
18131791
}
18141792

1815-
// Warning: (ae-incompatible-release-tags) The symbol "select" is marked as @public, but its signature references "Selectable" which is marked as @beta
1816-
//
1817-
// @public
1818-
export function select<AppModelType>(pipeline: Pipeline<AppModelType>, ...selections: Array<Selectable | string>): Pipeline<AppModelType>;
1819-
18201793
// @beta
18211794
export interface Selectable {
18221795
// (undocumented)
@@ -1862,16 +1835,6 @@ export class Sort implements Stage {
18621835
name: string;
18631836
}
18641837

1865-
// Warning: (ae-incompatible-release-tags) The symbol "sort" is marked as @public, but its signature references "Ordering" which is marked as @beta
1866-
//
1867-
// @public
1868-
export function sort<AppModelType>(pipeline: Pipeline<AppModelType>, ...orderings: Ordering[]): Pipeline<AppModelType>;
1869-
1870-
// @public (undocumented)
1871-
export function sort<AppModelType>(pipeline: Pipeline<AppModelType>, options: {
1872-
orderings: Ordering[];
1873-
}): Pipeline<AppModelType>;
1874-
18751838
// @beta (undocumented)
18761839
export interface Stage {
18771840
// (undocumented)
@@ -2186,12 +2149,6 @@ export function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value
21862149
// @public
21872150
export type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';
21882151

2189-
// Warning: (ae-incompatible-release-tags) The symbol "whereP" is marked as @public, but its signature references "FilterCondition" which is marked as @beta
2190-
// Warning: (ae-incompatible-release-tags) The symbol "whereP" is marked as @public, but its signature references "Constant" which is marked as @beta
2191-
//
2192-
// @public
2193-
export function whereP<AppModelType>(pipeline: Pipeline<AppModelType>, condition: FilterCondition & Constant): Pipeline<AppModelType>;
2194-
21952152
// @public
21962153
export type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
21972154
[K in keyof T]: WithFieldValue<T[K]> | FieldValue;
@@ -2223,8 +2180,8 @@ export function xor(left: FilterExpr, ...right: FilterExpr[]): Xor;
22232180

22242181
// Warnings were encountered during analysis:
22252182
//
2226-
// /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
2227-
// /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
2228-
// /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
2183+
// /home/runner/work/firebase-js-sdk/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
2184+
// /home/runner/work/firebase-js-sdk/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
2185+
// /home/runner/work/firebase-js-sdk/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
22292186

22302187
```

0 commit comments

Comments
 (0)