-
Notifications
You must be signed in to change notification settings - Fork 134
/
record-schema.ts
339 lines (297 loc) · 8.33 KB
/
record-schema.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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
/* eslint-disable valid-jsdoc */
import { evented, Evented, fulfillAll, Orbit } from '@orbit/core';
import { Dict } from '@orbit/utils';
import { ArrayValidationOptions } from '@orbit/validators';
import {
AttributeNotDefined,
KeyNotDefined,
ModelNotDefined,
RelationshipNotDefined
} from './record-exceptions';
const { uuid, deprecate } = Orbit;
export interface FieldValidationOptions {
required?: boolean;
[key: string]: unknown;
}
export interface AttributeDefinition {
type?: string;
serialization?: Dict<unknown>;
deserialization?: Dict<unknown>;
validation?: FieldValidationOptions & {
notNull?: boolean;
};
meta?: Dict<unknown>;
}
export interface HasOneRelationshipDefinition {
kind: 'hasOne';
type?: string | string[];
model?: string | string[];
inverse?: string;
dependent?: 'remove';
validation?: FieldValidationOptions & {
notNull?: boolean;
};
meta?: Dict<unknown>;
}
export interface HasManyRelationshipDefinition {
kind: 'hasMany';
type?: string | string[];
model?: string | string[];
inverse?: string;
dependent?: 'remove';
validation?: FieldValidationOptions & ArrayValidationOptions;
meta?: Dict<unknown>;
}
export type RelationshipDefinition =
| HasOneRelationshipDefinition
| HasManyRelationshipDefinition;
export interface KeyDefinition {
/**
* @deprecated since v0.17 - not used by any standard serializers
*/
primaryKey?: boolean;
validation?: FieldValidationOptions & {
notNull?: boolean;
};
meta?: Dict<unknown>;
}
export interface ModelDefinition {
keys?: Dict<KeyDefinition>;
attributes?: Dict<AttributeDefinition>;
relationships?: Dict<RelationshipDefinition>;
}
/**
* Settings used to initialze and/or upgrade schemas.
*/
export interface RecordSchemaSettings {
/**
* Schema version. Defaults to 1.
*/
version?: number;
/**
* Function used to generate record IDs.
*/
generateId?: (model?: string) => string;
/**
* Function used to pluralize names.
*
* @deprecated
*/
pluralize?: (word: string) => string;
/**
* Function used to singularize names.
*
* @deprecated
*/
singularize?: (word: string) => string;
/**
* Map of model definitions.
*/
models?: Dict<ModelDefinition>;
}
export type RecordSchemaEvent = 'upgrade';
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface RecordSchema extends Evented<RecordSchemaEvent> {}
/**
* A `Schema` defines the models allowed in a source, including their keys,
* attributes, and relationships. A single schema may be shared across multiple
* sources.
*/
@evented
export class RecordSchema {
private _models!: Dict<ModelDefinition>;
private _version!: number;
constructor(settings: RecordSchemaSettings = {}) {
if (settings.version === undefined) {
settings.version = 1;
}
if (settings.models === undefined) {
settings.models = {};
}
this._applySettings(settings);
}
/**
* Version
*/
get version(): number {
return this._version;
}
/**
* Upgrades Schema to a new version with new settings.
*
* Emits the `upgrade` event to cue sources to upgrade their data.
*/
async upgrade(settings: RecordSchemaSettings = {}): Promise<void> {
if (settings.version === undefined) {
settings.version = this._version + 1;
}
this._applySettings(settings);
await fulfillAll(this as Evented, 'upgrade', this._version);
}
/**
* Registers a complete set of settings
*/
protected _applySettings(settings: RecordSchemaSettings): void {
// Version
if (settings.version !== undefined) {
this._version = settings.version;
}
// Allow overrides
if (settings.generateId) {
this.generateId = settings.generateId;
}
if (settings.pluralize) {
deprecate(
'Schema#pluralize has been deprecated. Use inflectors from in @orbit/serializers instead.'
);
this.pluralize = settings.pluralize;
}
if (settings.singularize) {
deprecate(
'Schema#singularize has been deprecated. Use inflectors from @orbit/serializers instead.'
);
this.singularize = settings.singularize;
}
// Register model schemas
if (settings.models) {
this._deprecateRelationshipModel(settings.models);
this._models = settings.models;
}
}
/**
* Generate an id for a given model type.
*/
// eslint-disable-next-line @typescript-eslint/no-unused-vars
generateId(type?: string): string {
return uuid();
}
/**
* A naive pluralization method.
*
* Deprecated in favor of inflectors now in @orbit/serializers
*
* @deprecated since v0.17, remove in v0.18
*/
pluralize(word: string): string {
deprecate(
'Schema#pluralize has been deprecated. Use inflectors from @orbit/serializers instead.'
);
return word + 's';
}
/**
* A naive singularization method.
*
* Deprecated in favor of inflectors now in @orbit/serializers
*
* @deprecated since v0.17, remove in v0.18
*/
singularize(word: string): string {
deprecate(
'Schema#singularize has been deprecated. Use inflectors from @orbit/serializers instead.'
);
if (word.lastIndexOf('s') === word.length - 1) {
return word.substr(0, word.length - 1);
} else {
console.warn(
`Orbit's built-in naive singularization rules cannot singularize ${word}. Pass singularize & pluralize functions to Schema to customize.`
);
return word;
}
}
get models(): Dict<ModelDefinition> {
return this._models;
}
getModel(type: string): ModelDefinition {
const model = this.models[type];
if (model) {
return model;
} else {
throw new ModelNotDefined(type);
}
}
getAttribute(type: string, attribute: string): AttributeDefinition {
const model = this.getModel(type);
const attributeDef = model.attributes?.[attribute];
if (attributeDef) {
return attributeDef;
} else {
throw new AttributeNotDefined(type, attribute);
}
}
getKey(type: string, key: string): KeyDefinition {
const model = this.getModel(type);
const keyDef = model.keys?.[key];
if (keyDef) {
return keyDef;
} else {
throw new KeyNotDefined(type, key);
}
}
getRelationship(type: string, relationship: string): RelationshipDefinition {
const model = this.getModel(type);
const relationshipDef = model.relationships?.[relationship];
if (relationshipDef) {
return relationshipDef;
} else {
throw new RelationshipNotDefined(type, relationship);
}
}
hasModel(type: string): boolean {
return this.models[type] !== undefined;
}
hasAttribute(type: string, attribute: string): boolean {
return this.models[type]?.attributes?.[attribute] !== undefined;
}
hasKey(type: string, key: string): boolean {
return this.models[type]?.keys?.[key] !== undefined;
}
hasRelationship(type: string, relationship: string): boolean {
return this.models[type]?.relationships?.[relationship] !== undefined;
}
eachAttribute(
type: string,
callbackFn: (name: string, attribute: AttributeDefinition) => void
): void {
const model = this.getModel(type);
const attributes = model.attributes || {};
for (let name in attributes) {
callbackFn(name, attributes[name]);
}
}
eachKey(
type: string,
callbackFn: (name: string, key: KeyDefinition) => void
): void {
const model = this.getModel(type);
const keys = model.keys || {};
for (let name in keys) {
callbackFn(name, keys[name]);
}
}
eachRelationship(
type: string,
callbackFn: (name: string, relationship: RelationshipDefinition) => void
): void {
const model = this.getModel(type);
const relationships = model.relationships || {};
for (let name in relationships) {
callbackFn(name, relationships[name]);
}
}
_deprecateRelationshipModel(models: Dict<ModelDefinition>): void {
for (let type in models) {
if (models[type].relationships) {
let relationships = models[type]
.relationships as Dict<RelationshipDefinition>;
for (let name in relationships) {
let relationship = relationships[name];
if (relationship.model) {
deprecate(
'RelationshipDefinition.model is deprecated, use `type` and `kind` instead.'
);
}
}
}
}
}
}