@mountainpass/waycharter 2.0.26 → 2.0.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/waycharter-convenience.js +104 -13
- package/dist/waycharter-convenience.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ This library is compatible with Node.js 10.x, 12.x and 14.x
|
|
|
13
13
|
|
|
14
14
|
<!-- [](https://www.codacy.com/gh/mountain-pass/waycharter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mountain-pass/waycharter&utm_campaign=Badge_Grade) [](https://www.codacy.com/gh/mountain-pass/waycharter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=mountain-pass/waycharter&utm_campaign=Badge_Coverage) -->
|
|
15
15
|
|
|
16
|
-
[](https://snyk.io/test/github/mountain-pass/waycharter) [](https://snyk.io/test/github/mountain-pass/waycharter) [](https://snyk.io/test/npm/@mountainpass/waycharter/2.0.28)
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
[](https://conventionalcommits.org) [](https://github.com/prettier/prettier)
|
|
@@ -57,6 +57,42 @@ var __rest = (this && this.__rest) || function (s, e) {
|
|
|
57
57
|
}
|
|
58
58
|
return t;
|
|
59
59
|
};
|
|
60
|
+
var __values = (this && this.__values) || function(o) {
|
|
61
|
+
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
|
|
62
|
+
if (m) return m.call(o);
|
|
63
|
+
if (o && typeof o.length === "number") return {
|
|
64
|
+
next: function () {
|
|
65
|
+
if (o && i >= o.length) o = void 0;
|
|
66
|
+
return { value: o && o[i++], done: !o };
|
|
67
|
+
}
|
|
68
|
+
};
|
|
69
|
+
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
|
|
70
|
+
};
|
|
71
|
+
var __read = (this && this.__read) || function (o, n) {
|
|
72
|
+
var m = typeof Symbol === "function" && o[Symbol.iterator];
|
|
73
|
+
if (!m) return o;
|
|
74
|
+
var i = m.call(o), r, ar = [], e;
|
|
75
|
+
try {
|
|
76
|
+
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
|
|
77
|
+
}
|
|
78
|
+
catch (error) { e = { error: error }; }
|
|
79
|
+
finally {
|
|
80
|
+
try {
|
|
81
|
+
if (r && !r.done && (m = i["return"])) m.call(i);
|
|
82
|
+
}
|
|
83
|
+
finally { if (e) throw e.error; }
|
|
84
|
+
}
|
|
85
|
+
return ar;
|
|
86
|
+
};
|
|
87
|
+
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
88
|
+
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
|
|
89
|
+
if (ar || !(i in from)) {
|
|
90
|
+
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
|
|
91
|
+
ar[i] = from[i];
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
return to.concat(ar || Array.prototype.slice.call(from));
|
|
95
|
+
};
|
|
60
96
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
61
97
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
62
98
|
};
|
|
@@ -96,9 +132,10 @@ var WayCharter = /** @class */ (function () {
|
|
|
96
132
|
WayCharter.prototype.registerCollection = function (_a) {
|
|
97
133
|
var _this = this;
|
|
98
134
|
var itemPath = _a.itemPath, itemLoader = _a.itemLoader, collectionPath = _a.collectionPath, collectionLoader = _a.collectionLoader, _b = _a.filters, filters = _b === void 0 ? [] : _b;
|
|
99
|
-
|
|
135
|
+
// Register item endpoint if provided
|
|
136
|
+
var itemPathTemplate;
|
|
100
137
|
if (itemPath !== undefined && itemLoader !== undefined) {
|
|
101
|
-
itemEndpoint = waycharter_1.EndPoint.create({
|
|
138
|
+
var itemEndpoint = waycharter_1.EndPoint.create({
|
|
102
139
|
router: this.router,
|
|
103
140
|
path: "".concat(collectionPath).concat(itemPath),
|
|
104
141
|
handler: function (_a) { return __awaiter(_this, [_a], void 0, function (_b) {
|
|
@@ -115,28 +152,82 @@ var WayCharter = /** @class */ (function () {
|
|
|
115
152
|
});
|
|
116
153
|
}); }
|
|
117
154
|
});
|
|
155
|
+
itemPathTemplate = itemEndpoint.pathTemplate;
|
|
118
156
|
}
|
|
119
157
|
var additionalPaths = filters.map(function (f) { return ({
|
|
120
158
|
rel: f.rel,
|
|
121
159
|
uri: "".concat(collectionPath, "{?").concat(f.parameters.join(','), "}")
|
|
122
160
|
}); });
|
|
123
|
-
|
|
161
|
+
// Use EndPoint.create (not createCollection) so we can generate
|
|
162
|
+
// per-item links like v1 did, instead of v2's template links
|
|
163
|
+
var collectionEndpoint = waycharter_1.EndPoint.create({
|
|
124
164
|
router: this.router,
|
|
125
165
|
path: collectionPath,
|
|
126
|
-
filters: filters,
|
|
127
|
-
itemEndpoint: itemEndpoint,
|
|
128
166
|
handler: function (_a) { return __awaiter(_this, [_a], void 0, function (_b) {
|
|
129
|
-
var pageInt, result, hasMore, rest;
|
|
130
|
-
var
|
|
131
|
-
|
|
132
|
-
|
|
167
|
+
var page, pageInt, filteredQuery, allowedParameters, _c, _d, _e, key, value, result, hasMore, loaderLinks, rest, body, itemLinks, canonicalLinks, index, queryString, paginationLinks, nextParameters, previousParameters;
|
|
168
|
+
var e_1, _f;
|
|
169
|
+
var queryParameters = _b.queryParameters, response = _b.response;
|
|
170
|
+
return __generator(this, function (_g) {
|
|
171
|
+
switch (_g.label) {
|
|
133
172
|
case 0:
|
|
173
|
+
page = typeof queryParameters.page === 'string' ? queryParameters.page : undefined;
|
|
134
174
|
pageInt = Number.parseInt(page || '0');
|
|
135
|
-
|
|
175
|
+
filteredQuery = {};
|
|
176
|
+
allowedParameters = new Set(filters.flatMap(function (f) { return f.parameters; }));
|
|
177
|
+
try {
|
|
178
|
+
for (_c = __values(Object.entries(queryParameters)), _d = _c.next(); !_d.done; _d = _c.next()) {
|
|
179
|
+
_e = __read(_d.value, 2), key = _e[0], value = _e[1];
|
|
180
|
+
if (allowedParameters.has(key) && typeof value === 'string') {
|
|
181
|
+
filteredQuery[key] = value;
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
186
|
+
finally {
|
|
187
|
+
try {
|
|
188
|
+
if (_d && !_d.done && (_f = _c.return)) _f.call(_c);
|
|
189
|
+
}
|
|
190
|
+
finally { if (e_1) throw e_1.error; }
|
|
191
|
+
}
|
|
192
|
+
return [4 /*yield*/, collectionLoader(__assign({ page: pageInt }, filteredQuery))];
|
|
136
193
|
case 1:
|
|
137
|
-
result =
|
|
138
|
-
hasMore = result.hasMore, rest = __rest(result, ["hasMore"]);
|
|
139
|
-
|
|
194
|
+
result = _g.sent();
|
|
195
|
+
hasMore = result.hasMore, loaderLinks = result.links, rest = __rest(result, ["hasMore", "links"]);
|
|
196
|
+
body = rest.body;
|
|
197
|
+
itemLinks = [];
|
|
198
|
+
canonicalLinks = [];
|
|
199
|
+
if (Array.isArray(body)) {
|
|
200
|
+
for (index = 0; index < body.length; index++) {
|
|
201
|
+
itemLinks.push({ rel: 'item', uri: "#/".concat(index) });
|
|
202
|
+
if (itemPathTemplate) {
|
|
203
|
+
canonicalLinks.push({
|
|
204
|
+
rel: 'canonical',
|
|
205
|
+
uri: itemPathTemplate,
|
|
206
|
+
anchor: "#/".concat(index)
|
|
207
|
+
});
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
queryString = new URLSearchParams(filteredQuery).toString();
|
|
212
|
+
paginationLinks = [{
|
|
213
|
+
rel: 'first',
|
|
214
|
+
uri: queryString ? "".concat(collectionPath, "?").concat(queryString) : collectionPath
|
|
215
|
+
}];
|
|
216
|
+
if (hasMore) {
|
|
217
|
+
nextParameters = new URLSearchParams(__assign({ page: String(pageInt + 1) }, filteredQuery)).toString();
|
|
218
|
+
paginationLinks.push({ rel: 'next', uri: "".concat(collectionPath, "?").concat(nextParameters) });
|
|
219
|
+
}
|
|
220
|
+
if (pageInt === 1) {
|
|
221
|
+
paginationLinks.push({
|
|
222
|
+
rel: 'prev',
|
|
223
|
+
uri: queryString ? "".concat(collectionPath, "?").concat(queryString) : collectionPath
|
|
224
|
+
});
|
|
225
|
+
}
|
|
226
|
+
else if (pageInt > 1) {
|
|
227
|
+
previousParameters = new URLSearchParams(__assign({ page: String(pageInt - 1) }, filteredQuery)).toString();
|
|
228
|
+
paginationLinks.push({ rel: 'prev', uri: "".concat(collectionPath, "?").concat(previousParameters) });
|
|
229
|
+
}
|
|
230
|
+
response.chart(__assign(__assign({}, rest), { links: __spreadArray(__spreadArray(__spreadArray(__spreadArray([], __read(itemLinks), false), __read(canonicalLinks), false), __read(paginationLinks), false), __read((loaderLinks || [])), false) }));
|
|
140
231
|
return [2 /*return*/];
|
|
141
232
|
}
|
|
142
233
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"waycharter-convenience.js","sourceRoot":"","sources":["../src/waycharter-convenience.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"waycharter-convenience.js","sourceRoot":"","sources":["../src/waycharter-convenience.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAA6B;AAC7B,2CAAwD;AAsCxD;IAGE;QACE,IAAI,CAAC,MAAM,GAAG,iBAAO,CAAC,MAAM,EAAE,CAAA;IAChC,CAAC;IAED,yCAAoB,GAApB,UAAwB,EAA+C;QAAvE,iBAaC;YAbyB,IAAI,UAAA,EAAE,MAAM,YAAA;QACpC,IAAM,QAAQ,GAAG,qBAAQ,CAAC,MAAM,CAAI;YAClC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,MAAA;YACJ,OAAO,EAAE,gEAAO,EAA6C;;oBAA3C,cAAc,oBAAA,EAAE,eAAe,qBAAA,EAAE,QAAQ,cAAA;;;gCAC1C,qBAAM,MAAM,uBAAM,cAAc,GAAK,eAAe,EAAG,EAAA;;4BAAhE,MAAM,GAAG,SAAuD;4BACtE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;;;;iBACvB;SACF,CAAC,CAAA;QACF,OAAO;YACL,YAAY,EAAE,QAAQ,CAAC,YAAY;YACnC,IAAI,EAAE,UAAC,UAAU,IAAK,OAAA,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAzB,CAAyB;SAChD,CAAA;IACH,CAAC;IAED,uCAAkB,GAAlB,UAA6C,EAMQ;QANrD,iBAmGC;YAlGC,QAAQ,cAAA,EACR,UAAU,gBAAA,EACV,cAAc,oBAAA,EACd,gBAAgB,sBAAA,EAChB,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA;QAEZ,qCAAqC;QACrC,IAAI,gBAAoC,CAAA;QACxC,IAAI,QAAQ,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YACvD,IAAM,YAAY,GAAG,qBAAQ,CAAC,MAAM,CAAW;gBAC7C,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,IAAI,EAAE,UAAG,cAAc,SAAG,QAAQ,CAAE;gBACpC,OAAO,EAAE,gEAAO,EAA4B;;wBAA1B,cAAc,oBAAA,EAAE,QAAQ,cAAA;;;oCACzB,qBAAM,UAAU,CAAC,cAAc,CAAC,EAAA;;gCAAzC,MAAM,GAAG,SAAgC;gCAC/C,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;;;;qBACvB;aACF,CAAC,CAAA;YACF,gBAAgB,GAAG,YAAY,CAAC,YAAY,CAAA;QAC9C,CAAC;QAED,IAAM,eAAe,GAAW,OAAO,CAAC,GAAG,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC;YAChD,GAAG,EAAE,CAAC,CAAC,GAAG;YACV,GAAG,EAAE,UAAG,cAAc,eAAK,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,MAAG;SACrD,CAAC,EAH+C,CAG/C,CAAC,CAAA;QAEH,gEAAgE;QAChE,6DAA6D;QAC7D,IAAM,kBAAkB,GAAG,qBAAQ,CAAC,MAAM,CAAiB;YACzD,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,cAAc;YACpB,OAAO,EAAE,gEAAO,EAA6B;;;oBAA3B,eAAe,qBAAA,EAAE,QAAQ,cAAA;;;;4BACnC,IAAI,GAAG,OAAO,eAAe,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAA;4BAClF,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,GAAG,CAAC,CAAA;4BAEtC,aAAa,GAA2B,EAAE,CAAA;4BAC1C,iBAAiB,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,UAAU,EAAZ,CAAY,CAAC,CAAC,CAAA;;gCACrE,KAA2B,KAAA,SAAA,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAA,4CAAE,CAAC;oCAAlD,KAAA,mBAAY,EAAX,GAAG,QAAA,EAAE,KAAK,QAAA;oCACpB,IAAI,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;wCAC5D,aAAa,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;oCAC5B,CAAC;gCACH,CAAC;;;;;;;;;4BACc,qBAAM,gBAAgB,YAAG,IAAI,EAAE,OAAO,IAAK,aAAa,EAAG,EAAA;;4BAApE,MAAM,GAAG,SAA2D;4BAClE,OAAO,GAAkC,MAAM,QAAxC,EAAS,WAAW,GAAc,MAAM,MAApB,EAAK,IAAI,UAAK,MAAM,EAAjD,oBAAwC,CAAF,CAAW;4BACjD,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;4BAGhB,SAAS,GAAW,EAAE,CAAA;4BACtB,cAAc,GAAW,EAAE,CAAA;4BACjC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gCACxB,KAAS,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;oCACjD,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,YAAK,KAAK,CAAE,EAAE,CAAC,CAAA;oCAClD,IAAI,gBAAgB,EAAE,CAAC;wCACrB,cAAc,CAAC,IAAI,CAAC;4CAClB,GAAG,EAAE,WAAW;4CAChB,GAAG,EAAE,gBAAgB;4CACrB,MAAM,EAAE,YAAK,KAAK,CAAE;yCACrB,CAAC,CAAA;oCACJ,CAAC;gCACH,CAAC;4BACH,CAAC;4BAGK,WAAW,GAAG,IAAI,eAAe,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAA;4BAC3D,eAAe,GAAW,CAAE;oCAChC,GAAG,EAAE,OAAO;oCACZ,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,UAAG,cAAc,cAAI,WAAW,CAAE,CAAC,CAAC,CAAC,cAAc;iCACvE,CAAC,CAAA;4BACF,IAAI,OAAO,EAAE,CAAC;gCACN,cAAc,GAAG,IAAI,eAAe,YAAG,IAAI,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,IAAK,aAAa,EAAG,CAAC,QAAQ,EAAE,CAAA;gCACtG,eAAe,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,UAAG,cAAc,cAAI,cAAc,CAAE,EAAE,CAAC,CAAA;4BACnF,CAAC;4BACD,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;gCAClB,eAAe,CAAC,IAAI,CAAC;oCACnB,GAAG,EAAE,MAAM;oCACX,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,UAAG,cAAc,cAAI,WAAW,CAAE,CAAC,CAAC,CAAC,cAAc;iCACvE,CAAC,CAAA;4BACJ,CAAC;iCAAM,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;gCACjB,kBAAkB,GAAG,IAAI,eAAe,YAAG,IAAI,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,IAAK,aAAa,EAAG,CAAC,QAAQ,EAAE,CAAA;gCAC1G,eAAe,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,UAAG,cAAc,cAAI,kBAAkB,CAAE,EAAE,CAAC,CAAA;4BACvF,CAAC;4BAED,QAAQ,CAAC,KAAK,uBACT,IAAI,KACP,KAAK,qEACA,SAAS,kBACT,cAAc,kBACd,eAAe,kBACf,CAAC,WAAW,IAAI,EAAE,CAAC,aAExB,CAAA;;;;iBACH;SACF,CAAC,CAAA;QAEF,OAAO;YACL,eAAe,iBAAA;YACf,YAAY,EAAE,kBAAkB,CAAC,YAAY;YAC7C,IAAI,EAAE,UAAC,UAAU,IAAK,OAAA,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAnC,CAAmC;SAC1D,CAAA;IACH,CAAC;IAED,2CAAsB,GAAtB,UAA0B,EAA+D;YAA7D,IAAI,UAAA,EAAE,IAAI,UAAA,EAAE,KAAK,WAAA,EAAE,OAAO,aAAA;QACpD,IAAM,QAAQ,GAAG,qBAAQ,CAAC,YAAY,CAAI;YACxC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,MAAA;YACJ,IAAI,MAAA;YACJ,KAAK,OAAA;YACL,OAAO,SAAA;SACR,CAAC,CAAA;QACF,OAAO;YACL,YAAY,EAAE,QAAQ,CAAC,YAAY;YACnC,IAAI,EAAE,UAAC,UAAU,IAAK,OAAA,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAzB,CAAyB;SAChD,CAAA;IACH,CAAC;IACH,iBAAC;AAAD,CAAC,AAxID,IAwIC;AAxIY,gCAAU"}
|