/
record-cache.ts
236 lines (205 loc) · 6.35 KB
/
record-cache.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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
import { Orbit, evented, Evented } from '@orbit/core';
import {
DefaultRequestOptions,
RequestOptions,
requestOptionsForSource
} from '@orbit/data';
import {
RecordKeyMap,
RecordOperation,
RecordSchema,
RecordQueryBuilder,
RecordTransformBuilder,
RecordQueryExpression,
RecordQuery,
RecordTransform,
RecordNormalizer,
StandardRecordNormalizer,
StandardRecordValidator,
buildRecordValidatorFor
} from '@orbit/records';
import { Dict } from '@orbit/utils';
import { StandardValidator, ValidatorForFn } from '@orbit/validators';
const { assert } = Orbit;
export interface RecordCacheQueryOptions extends RequestOptions {
raiseNotFoundExceptions?: boolean;
}
export interface RecordCacheTransformOptions extends RequestOptions {
raiseNotFoundExceptions?: boolean;
useBuffer?: boolean;
}
export interface RecordCacheSettings<
QueryOptions extends RequestOptions = RecordCacheQueryOptions,
TransformOptions extends RequestOptions = RecordCacheTransformOptions,
QueryBuilder = RecordQueryBuilder,
TransformBuilder = RecordTransformBuilder
> {
name?: string;
schema: RecordSchema;
keyMap?: RecordKeyMap;
normalizer?: RecordNormalizer;
validatorFor?: ValidatorForFn<StandardValidator | StandardRecordValidator>;
validators?: Dict<StandardValidator | StandardRecordValidator>;
/**
* Automatically validate the contents of all requests.
*
* If true, builds a `validatorFor` function if one has not been provided.
* This will include standard validators as well as any custom `validators`
* that may be provided.
*
* @default true
*/
autoValidate?: boolean;
queryBuilder?: QueryBuilder;
transformBuilder?: TransformBuilder;
defaultQueryOptions?: DefaultRequestOptions<QueryOptions>;
defaultTransformOptions?: DefaultRequestOptions<TransformOptions>;
}
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface RecordCache extends Evented {}
@evented
export abstract class RecordCache<
QueryOptions extends RequestOptions = RecordCacheQueryOptions,
TransformOptions extends RequestOptions = RecordCacheTransformOptions,
QueryBuilder = RecordQueryBuilder,
TransformBuilder = RecordTransformBuilder
> {
protected _name?: string;
protected _keyMap?: RecordKeyMap;
protected _schema: RecordSchema;
protected _queryBuilder: QueryBuilder;
protected _transformBuilder: TransformBuilder;
protected _validatorFor?: ValidatorForFn<
StandardValidator | StandardRecordValidator
>;
protected _defaultQueryOptions?: DefaultRequestOptions<QueryOptions>;
protected _defaultTransformOptions?: DefaultRequestOptions<TransformOptions>;
constructor(
settings: RecordCacheSettings<
QueryOptions,
TransformOptions,
QueryBuilder,
TransformBuilder
>
) {
assert(
'RecordCache requires a `schema` setting to be constructed',
!!settings.schema
);
const { name, schema, keyMap } = settings;
this._name = name;
this._schema = schema;
this._keyMap = keyMap;
let { validatorFor, validators } = settings;
const autoValidate = settings.autoValidate !== false;
if (!autoValidate) {
assert(
'RecordCache should not be constructed with a `validatorFor` or `validators` if `autoValidate === false`',
validators === undefined && validatorFor === undefined
);
} else if (validatorFor !== undefined) {
assert(
'RecordCache can be constructed with either a `validatorFor` or `validators`, but not both',
validators === undefined
);
} else {
validatorFor = buildRecordValidatorFor({ validators });
}
this._validatorFor = validatorFor;
if (
settings.queryBuilder === undefined ||
settings.transformBuilder === undefined
) {
let normalizer = settings.normalizer;
if (normalizer === undefined) {
normalizer = new StandardRecordNormalizer({
schema,
keyMap,
validateInputs: autoValidate
});
}
if (settings.queryBuilder === undefined) {
(settings as any).queryBuilder = new RecordQueryBuilder({
schema,
normalizer,
validatorFor
});
}
if (settings.transformBuilder === undefined) {
(settings as any).transformBuilder = new RecordTransformBuilder({
schema,
normalizer,
validatorFor
});
}
}
this._queryBuilder = settings.queryBuilder as QueryBuilder;
this._transformBuilder = settings.transformBuilder as TransformBuilder;
this._defaultQueryOptions = settings.defaultQueryOptions;
this._defaultTransformOptions = settings.defaultTransformOptions;
}
get name(): string | undefined {
return this._name;
}
get schema(): RecordSchema {
return this._schema;
}
get keyMap(): RecordKeyMap | undefined {
return this._keyMap;
}
get validatorFor():
| ValidatorForFn<StandardValidator | StandardRecordValidator>
| undefined {
return this._validatorFor;
}
get queryBuilder(): QueryBuilder {
return this._queryBuilder;
}
get transformBuilder(): TransformBuilder {
return this._transformBuilder;
}
get defaultQueryOptions(): DefaultRequestOptions<QueryOptions> | undefined {
return this._defaultQueryOptions;
}
set defaultQueryOptions(
options: DefaultRequestOptions<QueryOptions> | undefined
) {
this._defaultQueryOptions = options;
}
get defaultTransformOptions():
| DefaultRequestOptions<TransformOptions>
| undefined {
return this._defaultTransformOptions;
}
set defaultTransformOptions(
options: DefaultRequestOptions<TransformOptions> | undefined
) {
this._defaultTransformOptions = options;
}
getQueryOptions(
query: RecordQuery,
expression?: RecordQueryExpression
): QueryOptions | undefined {
return requestOptionsForSource<QueryOptions>(
[
this._defaultQueryOptions,
query.options as QueryOptions | undefined,
expression?.options as QueryOptions | undefined
],
this._name
);
}
getTransformOptions(
transform: RecordTransform,
operation?: RecordOperation
): TransformOptions | undefined {
return requestOptionsForSource(
[
this._defaultTransformOptions,
transform.options as TransformOptions | undefined,
operation?.options as TransformOptions | undefined
],
this._name
);
}
}