This repository was archived by the owner on May 27, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathSimpleResourceProxy.js
More file actions
194 lines (175 loc) · 7.14 KB
/
Copy pathSimpleResourceProxy.js
File metadata and controls
194 lines (175 loc) · 7.14 KB
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
/*
* BSD 3-Clause License
*
* Copyright (c) 2017, MapCreator
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
import ResourceBase from './crud/base/ResourceBase';
import PaginatedResourceListing from './PaginatedResourceListing';
import {isParentOf} from './utils/reflection';
/**
* Proxy for accessing resource. This will make sure that they
* are properly wrapped before the promise resolves.
* @protected
* @todo remove ::search* in favor of an object containing function parameters
*/
export default class SimpleResourceProxy {
/**
* @param {Maps4News} api - Instance of the api
* @param {ResourceBase} Target - Target to wrap
* @param {?string} [altUrl=null] - Internal use, Optional alternative url for more complex routing
* @param {object} seedData - Internal use, used for seeding ::new
*/
constructor(api, Target, altUrl = null, seedData = {}) {
if (!isParentOf(ResourceBase, Target)) {
throw new TypeError('Target is not a child of ResourceBase');
}
if (typeof Target !== 'function') {
throw new TypeError('Target must to be a class not an instance');
}
this._api = api;
this._Target = Target;
this._seedData = seedData;
if (altUrl) {
this.__baseUrl = altUrl;
}
}
get _baseUrl() {
if (!this.__baseUrl) {
this.__baseUrl = this.new().baseUrl;
}
return this.__baseUrl;
}
/**
* Get api instance
* @returns {Maps4News} - Api instance
*/
get api() {
return this._api;
}
/**
* Target to wrap results in
* @returns {ResourceBase} - Target constructor
* @constructor
*/
get Target() {
return this._Target;
}
/**
* The name of the target
* @returns {String} - Target name
* @example
* api.colors.accessorName === 'Color'
* api.fontFamilies.accessorName = 'Font Families'
*/
get accessorName() {
return this.Target.name.replace(/([A-Z])/g, x => ' ' + x).trim();
}
/**
* Lists target resource
* @param {Object<String, String|Array<String>>} query - Query
* @param {Number} page - The page to be requested
* @param {Number} perPage - Amount of items per page. This is silently capped by the API
* @returns {Promise} - Resolves with {@link PaginatedResourceListing} instance and rejects with {@link ApiError}
*
* @example
* // Find layers with a name that starts with "test" and a scale_min between 1 and 10
* // See Api documentation for search query syntax
* var query = {
* name: '^:test',
* scale_min: ['>:1', '<:10'],
* }
*
* api.layers.search(query).then(console.dir);
* @todo move page, perPage, etc. to an object and add other options
*/
search(query, page = 1, perPage = this.api.defaults.perPage) {
const url = this._baseUrl;
const resolver = new PaginatedResourceListing(this._api, url, this.Target, query);
return resolver.getPage(page, perPage);
}
/**
* Lists target resource
* @param {Number} page - The page to be requested
* @param {Number|undefined} perPage - Amount of items per page. This is silently capped by the API
* @returns {Promise} - Resolves with {@link PaginatedResourceListing} instance and rejects with {@link ApiError}
*/
list(page = 1, perPage = this.api.defaults.perPage) {
return this.search({}, page, perPage);
}
/**
* Lists target resource
* @param {Number} page - The page to be requested
* @param {Number} perPage - Amount of items per page. This is silently capped by the API
* @param {Boolean} cacheEnabled - If the pagination cache should be used
* @param {Number} cacheTime - Amount of seconds to store a value in cache
* @param {Boolean} shareCache - Share cache across instances
* @returns {PaginatedResourceWrapper} - Resolves with {@link PaginatedResourceListing} instance and rejects with {@link ApiError}
*
*/
listAndWrap(page = 1, perPage = this.api.defaults.perPage, cacheEnabled = this.api.defaults.cacheEnabled, cacheTime = this.api.defaults.cacheSeconds, shareCache = this.api.defaults._shareCache) {
return this.searchAndWrap({}, page, perPage, cacheEnabled, cacheTime, shareCache);
}
/**
* Lists target resource
* @param {Object<String, String|Array<String>>} query - Query
* @param {Number} page - The page to be requested
* @param {Number} perPage - Amount of items per page. This is silently capped by the API
* @param {Boolean} cacheEnabled - If the pagination cache should be used
* @param {Number} cacheTime - Amount of seconds to store a value in cache
* @param {Boolean} shareCache - Share cache across instances
* @returns {PaginatedResourceWrapper} - Wrapped {@link PaginatedResourceListing} instance
*
* @example
* // Find layers with a name that starts with "test" and a scale_min between 1 and 10
* // See Api documentation for search query syntax
* var query = {
* name: '^:test',
* scale_min: ['>:1', '<:10'],
* }
*
* api.layers.searchAndWrap(query)
*/
searchAndWrap(query, page = 1, perPage = this.api.defaults.perPage, cacheEnabled = this.api.defaults.cacheEnabled, cacheTime = this.api.defaults.cacheSeconds, shareCache = this.api.defaults._shareCache) {
const url = this._baseUrl;
const resolver = new PaginatedResourceListing(this._api, url, this.Target, query, page, perPage);
const wrapped = resolver.wrap(cacheEnabled, cacheTime, shareCache);
wrapped.get(page);
return wrapped;
}
/**
* Build a new isntance of the target
* @param {Object<String, *>} data - Data for the object to be populated with
* @returns {ResourceBase} - Resource with target data
*/
new(data = {}) {
// Merge but don't overwrite using seed data
data = Object.assign(this._seedData, data);
return new this.Target(this._api, data);
}
}