forked from robsontenorio/vue-api-query
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathModel.js
406 lines (317 loc) · 8.08 KB
/
Model.js
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
import Builder from './Builder';
import StaticModel from './StaticModel';
export default class Model extends StaticModel {
constructor(...attributes) {
super()
if (attributes.length === 0) {
this._builder = new Builder(this)
} else {
Object.assign(this, ...attributes)
this._applyRelations(this)
}
if (this.baseURL === undefined) {
throw new Error('You must declare baseURL() method.')
}
if (this.request === undefined) {
throw new Error('You must declare request() method.')
}
if (this.$http === undefined) {
throw new Error('You must set $http property')
}
}
/**
* Setup
*/
get $http() {
return Model.$http
}
resource() {
return `${this.constructor.name.toLowerCase()}s`
}
primaryKey() {
return 'id'
}
getPrimaryKey() {
return this[this.primaryKey()]
}
custom(...args) {
if (args.length === 0) {
throw new Error('The custom() method takes a minimum of one argument.')
}
// It would be unintuitive for users to manage where the '/' has to be for
// multiple arguments. We don't need it for the first argument if it's
// a string, but subsequent string arguments need the '/' at the beginning.
// We handle this implementation detail here to simplify the readme.
let slash = '';
let resource = '';
args.forEach(value => {
switch (true) {
case (typeof value === 'string'):
resource += slash + value.replace(/^\/+/, '');
break;
case (value instanceof Model):
resource += slash + value.resource();
if (value.isValidId(value.getPrimaryKey())) {
resource += '/' + value.getPrimaryKey();
}
break;
default:
throw new Error('Arguments to custom() must be strings or instances of Model.')
}
if (!slash.length) {
slash = '/';
}
});
this._customResource = resource
return this
}
hasMany(model) {
let instance = new model
let url = `${this.baseURL()}/${this.resource()}/${this.getPrimaryKey()}/${instance.resource()}`
instance._from(url)
return instance
}
_from(url) {
Object.defineProperty(this, '_fromResource', { get: () => url })
}
for(...args) {
if (args.length === 0) {
throw new Error('The for() method takes a minimum of one argument.')
}
let url = `${this.baseURL()}`;
args.forEach(object => {
if (object instanceof Model === false) {
throw new Error('The object referenced on for() method is not a valid Model.')
}
if (!this.isValidId(object.getPrimaryKey())) {
throw new Error('The object referenced on for() method has a invalid id.')
}
url += `/${object.resource()}/${object.getPrimaryKey()}`
})
url += `/${this.resource()}`
this._from(url)
return this
}
relations () {
return {}
}
/**
* Helpers
*/
hasId() {
const id = this.getPrimaryKey()
return this.isValidId(id)
}
isValidId(id) {
return id !== undefined && id !== 0 && id !== '' && id !== null
}
endpoint() {
if (this._fromResource) {
if (this.hasId()) {
return `${this._fromResource}/${this.getPrimaryKey()}`
} else {
return this._fromResource
}
}
if (this.hasId()) {
return `${this.baseURL()}/${this.resource()}/${this.getPrimaryKey()}`
} else {
return `${this.baseURL()}/${this.resource()}`
}
}
parameterNames() {
return {
include: 'include',
filter: 'filter',
sort: 'sort',
fields: 'fields',
append: 'append',
page: 'page',
limit: 'limit'
}
}
/**
* Query
*/
include(...args) {
this._builder.include(...args)
return this
}
append(...args) {
this._builder.append(...args)
return this
}
select(...fields) {
this._builder.select(...fields)
return this
}
where(field, value) {
this._builder.where(field, value)
return this
}
whereIn(field, array) {
this._builder.whereIn(field, array)
return this
}
orderBy(...args) {
this._builder.orderBy(...args)
return this
}
page(value) {
this._builder.page(value)
return this
}
limit(value) {
this._builder.limit(value)
return this
}
params(payload) {
this._builder.params(payload)
return this
}
/**
* Result
*/
_applyInstance(data, model = this.constructor) {
const item = new model(data)
if(this._fromResource) {
item._from(this._fromResource)
}
return item
}
_applyInstanceCollection(data, model = this.constructor) {
let collection = data.data || data
collection = Array.isArray(collection) ? collection : [collection]
collection = collection.map(c => {
return this._applyInstance(c, model)
})
return collection
}
_applyRelations(model) {
const relations = model.relations()
for(const relation of Object.keys(relations)) {
if (!model[relation]) {
return;
}
if (Array.isArray(model[relation].data) || Array.isArray(model[relation])) {
const collection = this._applyInstanceCollection(model[relation], relations[relation])
if (model[relation].data !== undefined) {
model[relation].data = collection
} else {
model[relation] = collection
}
} else {
model[relation] = this._applyInstance(model[relation], relations[relation])
}
}
}
first() {
return this.get().then(response => {
let item
if (response.data) {
item = response.data[0]
} else {
item = response[0]
}
return item || {}
})
}
$first() {
return this
.first()
.then(response => response.data || response)
}
find(identifier) {
if (identifier === undefined) {
throw new Error('You must specify the param on find() method.')
}
let base = this._fromResource || `${this.baseURL()}/${this.resource()}`
let url = `${base}/${identifier}${this._builder.query()}`
return this.request({
url,
method: 'GET'
}).then(response => {
return this._applyInstance(response.data)
})
}
$find(identifier) {
if (identifier === undefined) {
throw new Error('You must specify the param on $find() method.')
}
return this
.find(identifier)
.then(response => this._applyInstance(response.data || response))
}
get() {
let base = this._fromResource || `${this.baseURL()}/${this.resource()}`
base = this._customResource ? `${this.baseURL()}/${this._customResource}` : base
let url = `${base}${this._builder.query()}`
return this.request({
url,
method: 'GET'
}).then(response => {
let collection = this._applyInstanceCollection(response.data)
if (response.data.data !== undefined) {
response.data.data = collection
} else {
response.data = collection
}
return response.data
})
}
$get() {
return this
.get()
.then(response => response.data || response)
}
/**
* Common CRUD operations
*/
delete() {
if (!this.hasId()) {
throw new Error('This model has a empty ID.')
}
return this.request({
url: this.endpoint(),
method: 'DELETE'
}).then(response => response)
}
save() {
return this.hasId() ? this._update() : this._create()
}
_create() {
return this.request({
method: 'POST',
url: this.endpoint(),
data: this
}).then(response => {
return this._applyInstance(response.data)
})
}
_update() {
return this.request({
method: 'PUT',
url: this.endpoint(),
data: this
}).then(response => {
return this._applyInstance(response.data)
})
}
/**
* Relationship operations
*/
attach(params) {
return this.request({
method: 'POST',
url: this.endpoint(),
data: params
}).then(response => response)
}
sync(params) {
return this.request({
method: 'PUT',
url: this.endpoint(),
data: params
}).then(response => response)
}
}