Skip to content

Commit db00e40

Browse files
committed
Fix issue with external exports
1 parent 8006776 commit db00e40

File tree

2 files changed

+15
-126
lines changed

2 files changed

+15
-126
lines changed

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

Lines changed: 14 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -277,13 +277,17 @@ export class Constant {
277277
static of(value: boolean): Constant;
278278
static of(value: null): Constant;
279279
static of(value: undefined): Constant;
280+
// Warning: (ae-forgotten-export) The symbol "GeoPoint" needs to be exported by the entry point pipelines.d.ts
280281
static of(value: GeoPoint): Constant;
282+
// Warning: (ae-forgotten-export) The symbol "Timestamp" needs to be exported by the entry point pipelines.d.ts
281283
static of(value: Timestamp): Constant;
282284
static of(value: Date): Constant;
283285
static of(value: Uint8Array): Constant;
286+
// Warning: (ae-forgotten-export) The symbol "DocumentReference" needs to be exported by the entry point pipelines.d.ts
284287
static of(value: DocumentReference): Constant;
285288
static of(value: any[]): Constant;
286289
static of(value: Map<string, any>): Constant;
290+
// Warning: (ae-forgotten-export) The symbol "VectorValue" needs to be exported by the entry point pipelines.d.ts
287291
static of(value: VectorValue): Constant;
288292
regexContains(pattern: string): RegexContains;
289293
regexContains(pattern: Constant): RegexContains;
@@ -385,23 +389,6 @@ export function divide(left: string, right: Constant): Divide;
385389
// @beta
386390
export function divide(left: string, right: any): Divide;
387391

388-
// @public
389-
export interface DocumentData {
390-
[field: string]: any;
391-
}
392-
393-
// @public
394-
export class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> {
395-
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
396-
readonly firestore: Firestore;
397-
get id(): string;
398-
get parent(): Query<AppModelType, DbModelType>;
399-
get path(): string;
400-
readonly type = "document";
401-
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;
402-
withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;
403-
}
404-
405392
// @beta (undocumented)
406393
export class DocumentsSource implements Stage {
407394
constructor(docPaths: string[]);
@@ -718,6 +705,8 @@ export class Field implements Selectable {
718705
// (undocumented)
719706
notEqAny(...others: any[]): FirestoreFunction;
720707
static of(name: string): Field;
708+
// Warning: (ae-forgotten-export) The symbol "FieldPath" needs to be exported by the entry point pipelines.d.ts
709+
//
721710
// (undocumented)
722711
static of(path: FieldPath): Field;
723712
// (undocumented)
@@ -757,12 +746,6 @@ export class Field implements Selectable {
757746
vectorLength(): VectorLength;
758747
}
759748

760-
// @public
761-
export class FieldPath {
762-
constructor(...fieldNames: string[]);
763-
isEqual(other: FieldPath): boolean;
764-
}
765-
766749
// @beta (undocumented)
767750
export class Fields implements Selectable {
768751
add(other: Constant): Add;
@@ -875,11 +858,6 @@ export class Fields implements Selectable {
875858
vectorLength(): VectorLength;
876859
}
877860

878-
// @public
879-
export abstract class FieldValue {
880-
abstract isEqual(other: FieldValue): boolean;
881-
}
882-
883861
// @beta
884862
export interface FilterCondition {
885863
// (undocumented)
@@ -909,20 +887,6 @@ export interface FindNearestOptions {
909887
vectorValue: VectorValue | number[];
910888
}
911889

912-
// @public
913-
export class Firestore {
914-
get app(): FirebaseApp;
915-
toJSON(): object;
916-
type: 'firestore-lite' | 'firestore';
917-
}
918-
919-
// @public
920-
export interface FirestoreDataConverter<AppModelType, DbModelType extends DocumentData = DocumentData> {
921-
fromFirestore(snapshot: QueryDocumentSnapshot<DocumentData, DocumentData>): AppModelType;
922-
toFirestore(modelObject: WithFieldValue<AppModelType>): WithFieldValue<DbModelType>;
923-
toFirestore(modelObject: PartialWithFieldValue<AppModelType>, options: SetOptions): PartialWithFieldValue<DbModelType>;
924-
}
925-
926890
// @beta
927891
export class FirestoreFunction {
928892
constructor(name: string, params: Constant[]);
@@ -1038,18 +1002,6 @@ export class GenericStage implements Stage {
10381002
name: string;
10391003
}
10401004

1041-
// @public
1042-
export class GeoPoint {
1043-
constructor(latitude: number, longitude: number);
1044-
isEqual(other: GeoPoint): boolean;
1045-
get latitude(): number;
1046-
get longitude(): number;
1047-
toJSON(): {
1048-
latitude: number;
1049-
longitude: number;
1050-
};
1051-
}
1052-
10531005
// @beta (undocumented)
10541006
export class Gt extends FirestoreFunction implements FilterCondition {
10551007
constructor(left: Constant, right: Constant);
@@ -1333,11 +1285,8 @@ export class Ordering {
13331285
constructor(expr: Constant, direction: 'ascending' | 'descending');
13341286
}
13351287

1336-
// @public
1337-
export type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
1338-
[K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
1339-
} : never);
1340-
1288+
// Warning: (ae-forgotten-export) The symbol "DocumentData" needs to be exported by the entry point pipelines.d.ts
1289+
//
13411290
// @public
13421291
export class Pipeline<AppModelType = DocumentData> {
13431292
/* Excluded from this release type: _db */
@@ -1397,11 +1346,14 @@ export class Pipeline<AppModelType = DocumentData> {
13971346
where(condition: FilterCondition & Constant): Pipeline<AppModelType>;
13981347
}
13991348

1349+
// Warning: (ae-forgotten-export) The symbol "Firestore" needs to be exported by the entry point pipelines.d.ts
14001350
// Warning: (ae-incompatible-release-tags) The symbol "pipeline" is marked as @public, but its signature references "PipelineSource" which is marked as @beta
14011351
//
14021352
// @public
14031353
export function pipeline(firestore: Firestore): PipelineSource;
14041354

1355+
// Warning: (ae-forgotten-export) The symbol "Query" needs to be exported by the entry point pipelines.d.ts
1356+
//
14051357
// @public
14061358
export function pipeline(query: Query): Pipeline;
14071359

@@ -1436,29 +1388,6 @@ export class PipelineSource {
14361388
documents(docs: DocumentReference[]): Pipeline;
14371389
}
14381390

1439-
// @public
1440-
export type Primitive = string | number | boolean | undefined | null;
1441-
1442-
// @public
1443-
export class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> {
1444-
protected constructor();
1445-
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
1446-
readonly firestore: Firestore;
1447-
readonly type: 'query' | 'collection';
1448-
withConverter(converter: null): Query<DocumentData, DocumentData>;
1449-
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
1450-
}
1451-
1452-
// @public
1453-
export class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> {
1454-
// @override
1455-
data(): AppModelType;
1456-
exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
1457-
get(fieldPath: string | FieldPath);
1458-
get id(): string;
1459-
get ref(): DocumentReference<AppModelType, DbModelType>;
1460-
}
1461-
14621391
// @beta (undocumented)
14631392
export class RegexContains extends FirestoreFunction implements FilterCondition {
14641393
constructor(expr: Constant, pattern: Constant);
@@ -1552,13 +1481,6 @@ export interface Selectable {
15521481
// @beta
15531482
export type SelectableExpr = Constant & Selectable;
15541483

1555-
// @public
1556-
export type SetOptions = {
1557-
readonly merge?: boolean;
1558-
} | {
1559-
readonly mergeFields?: Array<string | FieldPath>;
1560-
};
1561-
15621484
// @beta (undocumented)
15631485
export class Sort implements Stage {
15641486
constructor(orders: Ordering[]);
@@ -1645,27 +1567,6 @@ export class Sum extends FirestoreFunction implements Accumulator {
16451567
accumulator: true;
16461568
}
16471569

1648-
// @public
1649-
export class Timestamp {
1650-
constructor(
1651-
seconds: number,
1652-
nanoseconds: number);
1653-
static fromDate(date: Date): Timestamp;
1654-
static fromMillis(milliseconds: number): Timestamp;
1655-
isEqual(other: Timestamp): boolean;
1656-
readonly nanoseconds: number;
1657-
static now(): Timestamp;
1658-
readonly seconds: number;
1659-
toDate(): Date;
1660-
toJSON(): {
1661-
seconds: number;
1662-
nanoseconds: number;
1663-
};
1664-
toMillis(): number;
1665-
toString(): string;
1666-
valueOf(): string;
1667-
}
1668-
16691570
// @beta (undocumented)
16701571
export class TimestampAdd extends FirestoreFunction {
16711572
constructor(timestamp: Constant, unit: Constant, amount: Constant);
@@ -1807,25 +1708,13 @@ export function vectorLength(expr: Constant): VectorLength;
18071708
// @beta
18081709
export function vectorLength(field: string): VectorLength;
18091710

1810-
// @public
1811-
export class VectorValue {
1812-
/* Excluded from this release type: __constructor */
1813-
isEqual(other: VectorValue): boolean;
1814-
toArray(): number[];
1815-
}
1816-
18171711
// @beta (undocumented)
18181712
export class Where implements Stage {
18191713
constructor(condition: FilterCondition & Constant);
18201714
// (undocumented)
18211715
name: string;
18221716
}
18231717

1824-
// @public
1825-
export type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
1826-
[K in keyof T]: WithFieldValue<T[K]> | FieldValue;
1827-
} : never);
1828-
18291718
// @beta (undocumented)
18301719
export class Xor extends FirestoreFunction implements FilterCondition {
18311720
constructor(conditions: FilterExpr[]);
@@ -1839,8 +1728,8 @@ export function xor(left: FilterExpr, ...right: FilterExpr[]): Xor;
18391728

18401729
// Warnings were encountered during analysis:
18411730
//
1842-
// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/pipelines.d.ts:8518:9 - (ae-incompatible-release-tags) The symbol "accumulators" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
1843-
// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/pipelines.d.ts:8519:9 - (ae-incompatible-release-tags) The symbol "groups" is marked as @public, but its signature references "Selectable" which is marked as @beta
1844-
// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/pipelines.d.ts:8548:9 - (ae-incompatible-release-tags) The symbol "orderings" is marked as @public, but its signature references "Ordering" which is marked as @beta
1731+
// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/pipelines.d.ts:8118:9 - (ae-incompatible-release-tags) The symbol "accumulators" is marked as @public, but its signature references "AccumulatorTarget" which is marked as @beta
1732+
// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/pipelines.d.ts:8119:9 - (ae-incompatible-release-tags) The symbol "groups" is marked as @public, but its signature references "Selectable" which is marked as @beta
1733+
// /Users/markduckworth/projects/firebase-js-sdk/packages/firestore/dist/lite/pipelines.d.ts:8148:9 - (ae-incompatible-release-tags) The symbol "orderings" is marked as @public, but its signature references "Ordering" which is marked as @beta
18451734

18461735
```

packages/firestore/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
"api-report:all-packages": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package firestore --packageRoot . --typescriptDts ./dist/firestore/src/all_packages.d.ts --rollupDts ./dist/private.all_packages.d.ts --untrimmedRollupDts ./dist/internal.all_packages.d.ts --publicDts ./dist/all_packages.d.ts",
5252
"api-report:pipelines": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package firestore-pipelines --packageRoot . --typescriptDts ./dist/firestore/src/pipelines.d.ts --rollupDts ./dist/private.pipelines.d.ts --untrimmedRollupDts ./dist/internal.pipelines.d.ts --publicDts ./dist/pipelines.d.ts --otherExportsPublicDtsFiles ./dist/index.d.ts",
5353
"api-report:lite": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package firestore-lite --packageRoot . --typescriptDts ./dist/firestore/lite/index.d.ts --rollupDts ./dist/lite/private.d.ts --untrimmedRollupDts ./dist/lite/internal.d.ts --publicDts ./dist/lite/index.d.ts",
54-
"api-report:lite:pipelines": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package firestore-lite-pipelines --packageRoot . --typescriptDts ./dist/firestore/lite/pipelines.d.ts --rollupDts ./dist/lite/private.pipelines.d.ts --untrimmedRollupDts ./dist/lite/internal.pipelines.d.ts --publicDts ./dist/lite/pipelines.d.ts",
54+
"api-report:lite:pipelines": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package firestore-lite-pipelines --packageRoot . --typescriptDts ./dist/firestore/lite/pipelines.d.ts --rollupDts ./dist/lite/private.pipelines.d.ts --untrimmedRollupDts ./dist/lite/internal.pipelines.d.ts --publicDts ./dist/lite/pipelines.d.ts --otherExportsPublicDtsFiles ./dist/index.d.ts",
5555
"api-report:api-json": "rm -rf temp && api-extractor run --local --verbose",
5656
"api-report": "run-s --npm-path npm api-report:main api-report:pipelines api-report:lite api-report:lite:pipelines && yarn api-report:api-json",
5757
"doc": "api-documenter markdown --input temp --output docs",

0 commit comments

Comments
 (0)