-
Notifications
You must be signed in to change notification settings - Fork 145
/
aggregate.ts
165 lines (150 loc) · 5.03 KB
/
aggregate.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/**
* Copyright 2023 Google LLC. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as firestore from '@google-cloud/firestore';
import {FieldPath} from './path';
import {google} from '../protos/firestore_v1_proto_api';
import IAggregation = google.firestore.v1.StructuredAggregationQuery.IAggregation;
import * as assert from 'assert';
/**
* Concrete implementation of the Aggregate type.
*/
export class Aggregate {
constructor(
readonly alias: string,
readonly aggregateType: AggregateType,
readonly fieldPath?: string | FieldPath
) {}
/**
* Converts this object to the proto representation of an Aggregate.
* @internal
*/
toProto(): IAggregation {
const proto: IAggregation = {};
if (this.aggregateType === 'count') {
proto.count = {};
} else if (this.aggregateType === 'sum') {
assert(
this.fieldPath !== undefined,
'Missing field path for sum aggregation.'
);
proto.sum = {
field: {
fieldPath: FieldPath.fromArgument(this.fieldPath!).formattedName,
},
};
} else if (this.aggregateType === 'avg') {
assert(
this.fieldPath !== undefined,
'Missing field path for average aggregation.'
);
proto.avg = {
field: {
fieldPath: FieldPath.fromArgument(this.fieldPath!).formattedName,
},
};
} else {
throw new Error(`Aggregate type ${this.aggregateType} unimplemented.`);
}
proto.alias = this.alias;
return proto;
}
}
/**
* Represents an aggregation that can be performed by Firestore.
*/
export class AggregateField<T> implements firestore.AggregateField<T> {
/** A type string to uniquely identify instances of this class. */
readonly type = 'AggregateField';
/**
* The field on which the aggregation is performed.
* @internal
**/
public readonly _field?: string | FieldPath;
/**
* Create a new AggregateField<T>
* @param aggregateType Specifies the type of aggregation operation to perform.
* @param field Optionally specifies the field that is aggregated.
* @internal
*/
private constructor(
public readonly aggregateType: AggregateType,
field?: string | FieldPath
) {
this._field = field;
}
/**
* Compares this object with the given object for equality.
*
* This object is considered "equal" to the other object if and only if
* `other` performs the same kind of aggregation on the same field (if any).
*
* @param other The object to compare to this object for equality.
* @return `true` if this object is "equal" to the given object, as
* defined above, or `false` otherwise.
*/
isEqual(other: AggregateField<T>): boolean {
return (
other instanceof AggregateField &&
this.aggregateType === other.aggregateType &&
((this._field === undefined && other._field === undefined) ||
(this._field !== undefined &&
other._field !== undefined &&
FieldPath.fromArgument(this._field).isEqual(
FieldPath.fromArgument(other._field)
)))
);
}
/**
* Create an AggregateField object that can be used to compute the count of
* documents in the result set of a query.
*/
static count(): AggregateField<number> {
return new AggregateField<number>('count');
}
/**
* Create an AggregateField object that can be used to compute the average of
* a specified field over a range of documents in the result set of a query.
* @param field Specifies the field to average across the result set.
*/
static average(field: string | FieldPath): AggregateField<number | null> {
return new AggregateField<number | null>('avg', field);
}
/**
* Create an AggregateField object that can be used to compute the sum of
* a specified field over a range of documents in the result set of a query.
* @param field Specifies the field to sum across the result set.
*/
static sum(field: string | FieldPath): AggregateField<number> {
return new AggregateField<number>('sum', field);
}
}
/**
* A type whose property values are all `AggregateField` objects.
*/
export interface AggregateSpec {
[field: string]: AggregateFieldType;
}
/**
* The union of all `AggregateField` types that are supported by Firestore.
*/
export type AggregateFieldType =
| ReturnType<typeof AggregateField.count>
| ReturnType<typeof AggregateField.sum>
| ReturnType<typeof AggregateField.average>;
/**
* Union type representing the aggregate type to be performed.
*/
export type AggregateType = 'count' | 'avg' | 'sum';