ts-japi 1.6.1 → 1.6.2

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.
Files changed (75) hide show
  1. package/CHANGELOG.md +7 -1
  2. package/Makefile +1 -27
  3. package/README.md +145 -75
  4. package/api-extractor.json +14 -0
  5. package/lib/classes/cache.d.ts +2 -2
  6. package/lib/classes/cache.js +26 -48
  7. package/lib/classes/cache.js.map +1 -1
  8. package/lib/classes/error-serializer.d.ts +6 -6
  9. package/lib/classes/error-serializer.js +58 -125
  10. package/lib/classes/error-serializer.js.map +1 -1
  11. package/lib/classes/linker.d.ts +5 -5
  12. package/lib/classes/linker.d.ts.map +1 -1
  13. package/lib/classes/linker.js +15 -41
  14. package/lib/classes/linker.js.map +1 -1
  15. package/lib/classes/metaizer.d.ts +4 -4
  16. package/lib/classes/metaizer.d.ts.map +1 -1
  17. package/lib/classes/metaizer.js +12 -38
  18. package/lib/classes/metaizer.js.map +1 -1
  19. package/lib/classes/paginator.d.ts +3 -3
  20. package/lib/classes/paginator.js +17 -16
  21. package/lib/classes/paginator.js.map +1 -1
  22. package/lib/classes/relator.d.ts +6 -6
  23. package/lib/classes/relator.d.ts.map +1 -1
  24. package/lib/classes/relator.js +70 -134
  25. package/lib/classes/relator.js.map +1 -1
  26. package/lib/classes/serializer.d.ts +9 -9
  27. package/lib/classes/serializer.js +213 -316
  28. package/lib/classes/serializer.js.map +1 -1
  29. package/lib/index.js +17 -10
  30. package/lib/index.js.map +1 -1
  31. package/lib/interfaces/cache.interface.d.ts +2 -2
  32. package/lib/interfaces/cache.interface.js +1 -1
  33. package/lib/interfaces/error-serializer.interface.d.ts +11 -11
  34. package/lib/interfaces/error-serializer.interface.js +1 -1
  35. package/lib/interfaces/error.interface.js +1 -1
  36. package/lib/interfaces/json-api.interface.js +1 -1
  37. package/lib/interfaces/linker.interface.d.ts +1 -1
  38. package/lib/interfaces/linker.interface.js +1 -1
  39. package/lib/interfaces/paginator.interface.js +1 -1
  40. package/lib/interfaces/relator.interface.d.ts +4 -4
  41. package/lib/interfaces/relator.interface.js +1 -1
  42. package/lib/interfaces/serializer.interface.d.ts +24 -24
  43. package/lib/interfaces/serializer.interface.js +1 -1
  44. package/lib/models/error.model.d.ts +1 -1
  45. package/lib/models/error.model.js +59 -22
  46. package/lib/models/error.model.js.map +1 -1
  47. package/lib/models/link.model.js +11 -10
  48. package/lib/models/link.model.js.map +1 -1
  49. package/lib/models/meta.model.js +5 -6
  50. package/lib/models/meta.model.js.map +1 -1
  51. package/lib/models/relationship.model.js +8 -6
  52. package/lib/models/relationship.model.js.map +1 -1
  53. package/lib/models/resource-identifier.model.js +11 -9
  54. package/lib/models/resource-identifier.model.js.map +1 -1
  55. package/lib/models/resource.model.js +13 -28
  56. package/lib/models/resource.model.js.map +1 -1
  57. package/lib/tsdoc-metadata.json +11 -0
  58. package/lib/types/global.types.js +1 -1
  59. package/lib/utils/is-error-document.d.ts +1 -1
  60. package/lib/utils/is-error-document.js +6 -8
  61. package/lib/utils/is-error-document.js.map +1 -1
  62. package/lib/utils/is-object.js +1 -1
  63. package/lib/utils/is-plain-object.js +4 -4
  64. package/lib/utils/is-plain-object.js.map +1 -1
  65. package/lib/utils/merge.d.ts +2 -2
  66. package/lib/utils/merge.js +16 -63
  67. package/lib/utils/merge.js.map +1 -1
  68. package/lib/utils/serializer.utils.js +56 -202
  69. package/lib/utils/serializer.utils.js.map +1 -1
  70. package/package.json +36 -30
  71. package/tools/generate_docs.ts +33 -0
  72. package/tools/internal/custom_markdown_action.ts +32 -0
  73. package/tools/internal/custom_markdown_documenter.ts +1337 -0
  74. package/tsconfig.json +60 -79
  75. package/CONTRIBUTING.md +0 -127
@@ -1,93 +1,76 @@
1
1
  "use strict";
2
- var __assign = (this && this.__assign) || function () {
3
- __assign = Object.assign || function(t) {
4
- for (var s, i = 1, n = arguments.length; i < n; i++) {
5
- s = arguments[i];
6
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
- t[p] = s[p];
8
- }
9
- return t;
10
- };
11
- return __assign.apply(this, arguments);
12
- };
13
- var __values = (this && this.__values) || function(o) {
14
- var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
15
- if (m) return m.call(o);
16
- if (o && typeof o.length === "number") return {
17
- next: function () {
18
- if (o && i >= o.length) o = void 0;
19
- return { value: o && o[i++], done: !o };
20
- }
21
- };
22
- throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
23
- };
24
- var __read = (this && this.__read) || function (o, n) {
25
- var m = typeof Symbol === "function" && o[Symbol.iterator];
26
- if (!m) return o;
27
- var i = m.call(o), r, ar = [], e;
28
- try {
29
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
30
- }
31
- catch (error) { e = { error: error }; }
32
- finally {
33
- try {
34
- if (r && !r.done && (m = i["return"])) m.call(i);
35
- }
36
- finally { if (e) throw e.error; }
37
- }
38
- return ar;
39
- };
40
2
  var __importDefault = (this && this.__importDefault) || function (mod) {
41
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
42
4
  };
43
- exports.__esModule = true;
44
- var error_model_1 = __importDefault(require("../models/error.model"));
45
- var merge_1 = __importDefault(require("../utils/merge"));
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const error_model_1 = __importDefault(require("../models/error.model"));
7
+ const merge_1 = __importDefault(require("../utils/merge"));
46
8
  /**
47
- * The {@linkcode ErrorSerializer} class is used to serialize errors.
9
+ * The {@link ErrorSerializer} class is used to serialize errors.
48
10
  *
49
11
  * Example:
50
12
  * ```typescript
51
13
  * [[include:error-serializer.example.ts]]
52
14
  * ```
53
15
  */
54
- var ErrorSerializer = /** @class */ (function () {
16
+ class ErrorSerializer {
17
+ /**
18
+ * Default options. Can be edited to change default options globally.
19
+ */
20
+ static defaultOptions = {
21
+ version: '1.0',
22
+ attributes: {
23
+ id: 'id',
24
+ status: 'code',
25
+ code: 'name',
26
+ title: 'reason',
27
+ detail: 'message',
28
+ source: {
29
+ pointer: 'location',
30
+ parameter: undefined,
31
+ },
32
+ },
33
+ metaizers: {},
34
+ linkers: {},
35
+ };
55
36
  /**
56
- * Creates a {@linkcode Serializer}.
37
+ * The set of options for the serializer.
38
+ */
39
+ options;
40
+ /**
41
+ * Creates a {@link Serializer}.
57
42
  *
58
- * @param collectionName The name of the collection of objects.
59
- * @param options Options for the serializer.
43
+ * @param collectionName - The name of the collection of objects.
44
+ * @param options - Options for the serializer.
60
45
  */
61
- function ErrorSerializer(options) {
62
- if (options === void 0) { options = {}; }
46
+ constructor(options = {}) {
63
47
  // Setting default options.
64
- this.options = merge_1["default"]({}, ErrorSerializer.defaultOptions, options);
48
+ this.options = (0, merge_1.default)({}, ErrorSerializer.defaultOptions, options);
65
49
  }
66
50
  /**
67
51
  * The actual serialization function.
68
52
  *
69
- * @param errors Errors to serialize.
70
- * @param options Options to use at runtime.
53
+ * @param errors - Errors to serialize.
54
+ * @param options - Options to use at runtime.
71
55
  */
72
- ErrorSerializer.prototype.serialize = function (errors, options) {
73
- var e_1, _a, e_2, _b, e_3, _c, _d;
56
+ serialize(errors, options) {
74
57
  // Get options.
75
- var o = this.options;
58
+ let o = this.options;
76
59
  if (options)
77
- o = merge_1["default"]({}, this.options, options);
78
- var attributes = o.attributes;
79
- var linkers = o.linkers;
80
- var metaizers = o.metaizers;
81
- var version = o.version;
82
- var document = { errors: [] };
60
+ o = (0, merge_1.default)({}, this.options, options);
61
+ const attributes = o.attributes;
62
+ const linkers = o.linkers;
63
+ const metaizers = o.metaizers;
64
+ const version = o.version;
65
+ const document = { errors: [] };
83
66
  // Normalize error input
84
67
  if (!Array.isArray(errors)) {
85
68
  errors = [errors];
86
69
  }
87
- document.errors = errors.map(function (e) {
88
- if (e instanceof error_model_1["default"])
70
+ document.errors = errors.map((e) => {
71
+ if (e instanceof error_model_1.default)
89
72
  return e;
90
- var eo = {};
73
+ const eo = {};
91
74
  if (attributes.id && e[attributes.id]) {
92
75
  eo.id = String(e[attributes.id]);
93
76
  }
@@ -115,86 +98,36 @@ var ErrorSerializer = /** @class */ (function () {
115
98
  delete eo.source;
116
99
  }
117
100
  }
118
- return new error_model_1["default"](eo);
101
+ return new error_model_1.default(eo);
119
102
  });
120
103
  // Constructing base document.
121
104
  if (version) {
122
- document.jsonapi = { version: version };
105
+ document.jsonapi = { version };
123
106
  }
124
107
  // Handling document metadata.
125
108
  if (metaizers.jsonapi) {
126
- document.jsonapi = __assign(__assign({}, document.jsonapi), { meta: metaizers.jsonapi.metaize() });
109
+ document.jsonapi = { ...document.jsonapi, meta: metaizers.jsonapi.metaize() };
127
110
  }
128
111
  if (metaizers.document) {
129
112
  document.meta = metaizers.document.metaize(document.errors);
130
113
  }
131
114
  if (metaizers.error) {
132
- try {
133
- for (var _e = __values(document.errors), _f = _e.next(); !_f.done; _f = _e.next()) {
134
- var error = _f.value;
135
- error.meta = metaizers.error.metaize(error);
136
- }
137
- }
138
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
139
- finally {
140
- try {
141
- if (_f && !_f.done && (_a = _e["return"])) _a.call(_e);
142
- }
143
- finally { if (e_1) throw e_1.error; }
115
+ for (const error of document.errors) {
116
+ error.meta = metaizers.error.metaize(error);
144
117
  }
145
118
  }
146
119
  // Handling links.
147
120
  if (Object.keys(linkers).length > 0) {
148
- try {
149
- for (var _g = __values(Object.entries(linkers)), _h = _g.next(); !_h.done; _h = _g.next()) {
150
- var _j = __read(_h.value, 2), key = _j[0], linker = _j[1];
151
- if (linker) {
152
- try {
153
- for (var _k = (e_3 = void 0, __values(document.errors)), _l = _k.next(); !_l.done; _l = _k.next()) {
154
- var error = _l.value;
155
- error.links = __assign(__assign({}, error.links), (_d = {}, _d[key] = linker.link(error), _d));
156
- }
157
- }
158
- catch (e_3_1) { e_3 = { error: e_3_1 }; }
159
- finally {
160
- try {
161
- if (_l && !_l.done && (_c = _k["return"])) _c.call(_k);
162
- }
163
- finally { if (e_3) throw e_3.error; }
164
- }
121
+ for (const [key, linker] of Object.entries(linkers)) {
122
+ if (linker) {
123
+ for (const error of document.errors) {
124
+ error.links = { ...error.links, [key]: linker.link(error) };
165
125
  }
166
126
  }
167
127
  }
168
- catch (e_2_1) { e_2 = { error: e_2_1 }; }
169
- finally {
170
- try {
171
- if (_h && !_h.done && (_b = _g["return"])) _b.call(_g);
172
- }
173
- finally { if (e_2) throw e_2.error; }
174
- }
175
128
  }
176
129
  return document;
177
- };
178
- /**
179
- * Default options. Can be edited to change default options globally.
180
- */
181
- ErrorSerializer.defaultOptions = {
182
- version: '1.0',
183
- attributes: {
184
- id: 'id',
185
- status: 'code',
186
- code: 'name',
187
- title: 'reason',
188
- detail: 'message',
189
- source: {
190
- pointer: 'location',
191
- parameter: undefined
192
- }
193
- },
194
- metaizers: {},
195
- linkers: {}
196
- };
197
- return ErrorSerializer;
198
- }());
199
- exports["default"] = ErrorSerializer;
130
+ }
131
+ }
132
+ exports.default = ErrorSerializer;
200
133
  //# sourceMappingURL=error-serializer.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"error-serializer.js","sourceRoot":"","sources":["../../src/classes/error-serializer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,sEAA8C;AAE9C,yDAAmC;AAEnC;;;;;;;GAOG;AACH;IA0BE;;;;;OAKG;IACH,yBAAmB,OAAwD;QAAxD,wBAAA,EAAA,YAAwD;QACzE,2BAA2B;QAC3B,IAAI,CAAC,OAAO,GAAG,kBAAK,CAAC,EAAE,EAAE,eAAe,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACI,mCAAS,GAAhB,UACE,MAAgC,EAChC,OAAoD;;QAEpD,eAAe;QACf,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QACrB,IAAI,OAAO;YAAE,CAAC,GAAG,kBAAK,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAElD,IAAM,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;QAChC,IAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;QAC1B,IAAM,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC;QAC9B,IAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;QAE1B,IAAM,QAAQ,GAAkB,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QAE/C,wBAAwB;QACxB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC1B,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;SACnB;QACD,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,UAAC,CAAC;YAC7B,IAAI,CAAC,YAAY,wBAAS;gBAAE,OAAO,CAAC,CAAC;YACrC,IAAM,EAAE,GAAiB,EAAE,CAAC;YAC5B,IAAI,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;gBACrC,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;aAClC;YACD,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;gBAC7C,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;aAC1C;YACD,IAAI,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;gBACzC,EAAE,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;aACtC;YACD,IAAI,UAAU,CAAC,KAAK,IAAI,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;gBAC3C,EAAE,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;aACxC;YACD,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;gBAC7C,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;aAC1C;YACD,IAAI,UAAU,CAAC,MAAM,EAAE;gBACrB,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC;gBACf,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;oBAC7D,EAAE,CAAC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;iBAC1D;gBACD,IAAI,UAAU,CAAC,MAAM,CAAC,SAAS,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;oBACjE,EAAE,CAAC,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC9D;gBACD,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;oBACvC,OAAO,EAAE,CAAC,MAAM,CAAC;iBAClB;aACF;YACD,OAAO,IAAI,wBAAS,CAAC,EAAE,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,8BAA8B;QAC9B,IAAI,OAAO,EAAE;YACX,QAAQ,CAAC,OAAO,GAAG,EAAE,OAAO,SAAA,EAAE,CAAC;SAChC;QAED,8BAA8B;QAC9B,IAAI,SAAS,CAAC,OAAO,EAAE;YACrB,QAAQ,CAAC,OAAO,yBAAQ,QAAQ,CAAC,OAAO,KAAE,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,GAAE,CAAC;SAC/E;QACD,IAAI,SAAS,CAAC,QAAQ,EAAE;YACtB,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC7D;QACD,IAAI,SAAS,CAAC,KAAK,EAAE;;gBACnB,KAAoB,IAAA,KAAA,SAAA,QAAQ,CAAC,MAAM,CAAA,gBAAA,4BAAE;oBAAhC,IAAM,KAAK,WAAA;oBACd,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;iBAC7C;;;;;;;;;SACF;QAED,kBAAkB;QAClB,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;;gBACnC,KAA4B,IAAA,KAAA,SAAA,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA,gBAAA,4BAAE;oBAA1C,IAAA,KAAA,mBAAa,EAAZ,GAAG,QAAA,EAAE,MAAM,QAAA;oBACrB,IAAI,MAAM,EAAE;;4BACV,KAAoB,IAAA,oBAAA,SAAA,QAAQ,CAAC,MAAM,CAAA,CAAA,gBAAA,4BAAE;gCAAhC,IAAM,KAAK,WAAA;gCACd,KAAK,CAAC,KAAK,yBAAQ,KAAK,CAAC,KAAK,gBAAG,GAAG,IAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAE,CAAC;6BAC7D;;;;;;;;;qBACF;iBACF;;;;;;;;;SACF;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IA5HD;;OAEG;IACW,8BAAc,GAAG;QAC7B,OAAO,EAAE,KAAK;QACd,UAAU,EAAE;YACV,EAAE,EAAE,IAAI;YACR,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE;gBACN,OAAO,EAAE,UAAU;gBACnB,SAAS,EAAE,SAAS;aACrB;SACF;QACD,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,EAAE;KACZ,CAAC;IA2GJ,sBAAC;CAAA,AA9HD,IA8HC;qBA9HoB,eAAe"}
1
+ {"version":3,"file":"error-serializer.js","sourceRoot":"","sources":["../../src/classes/error-serializer.ts"],"names":[],"mappings":";;;;;AAGA,wEAA8C;AAE9C,2DAAmC;AAEnC;;;;;;;GAOG;AACH,MAAqB,eAAe;IAClC;;OAEG;IACI,MAAM,CAAC,cAAc,GAAG;QAC7B,OAAO,EAAE,KAAK;QACd,UAAU,EAAE;YACV,EAAE,EAAE,IAAI;YACR,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE;gBACN,OAAO,EAAE,UAAU;gBACnB,SAAS,EAAE,SAAS;aACrB;SACF;QACD,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,EAAE;KACZ,CAAC;IAEF;;OAEG;IACK,OAAO,CAA8C;IAE7D;;;;;OAKG;IACH,YAAmB,UAAsD,EAAE;QACzE,2BAA2B;QAC3B,IAAI,CAAC,OAAO,GAAG,IAAA,eAAK,EAAC,EAAE,EAAE,eAAe,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACI,SAAS,CACd,MAAgC,EAChC,OAAoD;QAEpD,eAAe;QACf,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QACrB,IAAI,OAAO;YAAE,CAAC,GAAG,IAAA,eAAK,EAAC,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAElD,MAAM,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;QAChC,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;QAC1B,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC;QAC9B,MAAM,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;QAE1B,MAAM,QAAQ,GAAkB,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QAE/C,wBAAwB;QACxB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC1B,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;SACnB;QACD,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACjC,IAAI,CAAC,YAAY,qBAAS;gBAAE,OAAO,CAAC,CAAC;YACrC,MAAM,EAAE,GAAiB,EAAE,CAAC;YAC5B,IAAI,UAAU,CAAC,EAAE,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;gBACrC,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;aAClC;YACD,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;gBAC7C,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;aAC1C;YACD,IAAI,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;gBACzC,EAAE,CAAC,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;aACtC;YACD,IAAI,UAAU,CAAC,KAAK,IAAI,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;gBAC3C,EAAE,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;aACxC;YACD,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;gBAC7C,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;aAC1C;YACD,IAAI,UAAU,CAAC,MAAM,EAAE;gBACrB,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC;gBACf,IAAI,UAAU,CAAC,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;oBAC7D,EAAE,CAAC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;iBAC1D;gBACD,IAAI,UAAU,CAAC,MAAM,CAAC,SAAS,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;oBACjE,EAAE,CAAC,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;iBAC9D;gBACD,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;oBACvC,OAAO,EAAE,CAAC,MAAM,CAAC;iBAClB;aACF;YACD,OAAO,IAAI,qBAAS,CAAC,EAAE,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,8BAA8B;QAC9B,IAAI,OAAO,EAAE;YACX,QAAQ,CAAC,OAAO,GAAG,EAAE,OAAO,EAAE,CAAC;SAChC;QAED,8BAA8B;QAC9B,IAAI,SAAS,CAAC,OAAO,EAAE;YACrB,QAAQ,CAAC,OAAO,GAAG,EAAE,GAAG,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;SAC/E;QACD,IAAI,SAAS,CAAC,QAAQ,EAAE;YACtB,QAAQ,CAAC,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC7D;QACD,IAAI,SAAS,CAAC,KAAK,EAAE;YACnB,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE;gBACnC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;aAC7C;SACF;QAED,kBAAkB;QAClB,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YACnC,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;gBACnD,IAAI,MAAM,EAAE;oBACV,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE;wBACnC,KAAK,CAAC,KAAK,GAAG,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;qBAC7D;iBACF;aACF;SACF;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;;AA7HH,kCA8HC"}
@@ -2,7 +2,7 @@ import { LinkerOptions } from '../interfaces/linker.interface';
2
2
  import Link from '../models/link.model';
3
3
  import { VariadicFunction } from '../types/global.types';
4
4
  /**
5
- * The {@linkcode Linker} class is used to construct a [link](https://jsonapi.org/format/#document-links).
5
+ * The {@link Linker} class is used to construct a [link](https://jsonapi.org/format/#document-links).
6
6
  *
7
7
  * Example:
8
8
  * ```typescript
@@ -10,13 +10,13 @@ import { VariadicFunction } from '../types/global.types';
10
10
  * ```
11
11
  */
12
12
  export default class Linker<Dependencies extends any[]> {
13
- /** @internal Generates a {@linkcode Link}. */
13
+ /** @internal Generates a {@link Link}. */
14
14
  link: VariadicFunction<Dependencies, Link>;
15
15
  /**
16
- * Creates a {@linkcode Linker}.
16
+ * Creates a {@link Linker}.
17
17
  *
18
- * @param link A {@linkcode LinkFunction} used to generate a string URI from its arguments.
19
- * @param options Options for the linker.
18
+ * @param link - A {@link LinkFunction} used to generate a string URI from its arguments.
19
+ * @param options - Options for the linker.
20
20
  */
21
21
  constructor(link: VariadicFunction<Dependencies, string>, options?: LinkerOptions<Dependencies>);
22
22
  }
@@ -1 +1 @@
1
- {"version":3,"file":"linker.d.ts","sourceRoot":"","sources":["../../src/classes/linker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,IAAI,MAAM,sBAAsB,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM,CAAC,YAAY,SAAS,GAAG,EAAE;IACpD,8CAA8C;IACvC,IAAI,EAAE,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAElD;;;;;OAKG;gBAED,IAAI,EAAE,gBAAgB,CAAC,YAAY,EAAE,MAAM,CAAC,EAC5C,OAAO,GAAE,aAAa,CAAC,YAAY,CAAM;CAQ5C"}
1
+ {"version":3,"file":"linker.d.ts","sourceRoot":"","sources":["../../src/classes/linker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,IAAI,MAAM,sBAAsB,CAAC;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM,CAAC,YAAY,SAAS,GAAG,EAAE;IACpD,0CAA0C;IACnC,IAAI,EAAE,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAElD;;;;;OAKG;gBAED,IAAI,EAAE,gBAAgB,CAAC,YAAY,EAAE,MAAM,CAAC,EAC5C,OAAO,GAAE,aAAa,CAAC,YAAY,CAAM;CAQ5C"}
@@ -1,59 +1,33 @@
1
1
  "use strict";
2
- var __read = (this && this.__read) || function (o, n) {
3
- var m = typeof Symbol === "function" && o[Symbol.iterator];
4
- if (!m) return o;
5
- var i = m.call(o), r, ar = [], e;
6
- try {
7
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
8
- }
9
- catch (error) { e = { error: error }; }
10
- finally {
11
- try {
12
- if (r && !r.done && (m = i["return"])) m.call(i);
13
- }
14
- finally { if (e) throw e.error; }
15
- }
16
- return ar;
17
- };
18
- var __spreadArray = (this && this.__spreadArray) || function (to, from) {
19
- for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
20
- to[j] = from[i];
21
- return to;
22
- };
23
2
  var __importDefault = (this && this.__importDefault) || function (mod) {
24
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
25
4
  };
26
- exports.__esModule = true;
27
- var link_model_1 = __importDefault(require("../models/link.model"));
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const link_model_1 = __importDefault(require("../models/link.model"));
28
7
  /**
29
- * The {@linkcode Linker} class is used to construct a [link](https://jsonapi.org/format/#document-links).
8
+ * The {@link Linker} class is used to construct a [link](https://jsonapi.org/format/#document-links).
30
9
  *
31
10
  * Example:
32
11
  * ```typescript
33
12
  * [[include:linker.example.ts]]
34
13
  * ```
35
14
  */
36
- var Linker = /** @class */ (function () {
15
+ class Linker {
16
+ /** @internal Generates a {@link Link}. */
17
+ link;
37
18
  /**
38
- * Creates a {@linkcode Linker}.
19
+ * Creates a {@link Linker}.
39
20
  *
40
- * @param link A {@linkcode LinkFunction} used to generate a string URI from its arguments.
41
- * @param options Options for the linker.
21
+ * @param link - A {@link LinkFunction} used to generate a string URI from its arguments.
22
+ * @param options - Options for the linker.
42
23
  */
43
- function Linker(link, options) {
44
- if (options === void 0) { options = {}; }
45
- this.link = function () {
46
- var _a;
47
- var datas = [];
48
- for (var _i = 0; _i < arguments.length; _i++) {
49
- datas[_i] = arguments[_i];
50
- }
24
+ constructor(link, options = {}) {
25
+ this.link = (...datas) => {
51
26
  return options.metaizer
52
- ? new link_model_1["default"](link.apply(void 0, __spreadArray([], __read(datas))), (_a = options.metaizer).metaize.apply(_a, __spreadArray([], __read(datas))))
53
- : new link_model_1["default"](link.apply(void 0, __spreadArray([], __read(datas))));
27
+ ? new link_model_1.default(link(...datas), options.metaizer.metaize(...datas))
28
+ : new link_model_1.default(link(...datas));
54
29
  };
55
30
  }
56
- return Linker;
57
- }());
58
- exports["default"] = Linker;
31
+ }
32
+ exports.default = Linker;
59
33
  //# sourceMappingURL=linker.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"linker.js","sourceRoot":"","sources":["../../src/classes/linker.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,oEAAwC;AAGxC;;;;;;;GAOG;AACH;IAIE;;;;;OAKG;IACH,gBACE,IAA4C,EAC5C,OAAyC;QAAzC,wBAAA,EAAA,YAAyC;QAEzC,IAAI,CAAC,IAAI,GAAG;;YAAC,eAAsB;iBAAtB,UAAsB,EAAtB,qBAAsB,EAAtB,IAAsB;gBAAtB,0BAAsB;;YACjC,OAAO,OAAO,CAAC,QAAQ;gBACrB,CAAC,CAAC,IAAI,uBAAI,CAAC,IAAI,wCAAI,KAAK,KAAG,CAAA,KAAA,OAAO,CAAC,QAAQ,CAAA,CAAC,OAAO,oCAAI,KAAK,IAAE;gBAC9D,CAAC,CAAC,IAAI,uBAAI,CAAC,IAAI,wCAAI,KAAK,IAAE,CAAC;QAC/B,CAAC,CAAC;IACJ,CAAC;IACH,aAAC;AAAD,CAAC,AApBD,IAoBC"}
1
+ {"version":3,"file":"linker.js","sourceRoot":"","sources":["../../src/classes/linker.ts"],"names":[],"mappings":";;;;;AACA,sEAAwC;AAGxC;;;;;;;GAOG;AACH,MAAqB,MAAM;IACzB,0CAA0C;IACnC,IAAI,CAAuC;IAElD;;;;;OAKG;IACH,YACE,IAA4C,EAC5C,UAAuC,EAAE;QAEzC,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,KAAmB,EAAE,EAAE;YACrC,OAAO,OAAO,CAAC,QAAQ;gBACrB,CAAC,CAAC,IAAI,oBAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;gBAC9D,CAAC,CAAC,IAAI,oBAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC;IACJ,CAAC;CACF;AApBD,yBAoBC"}
@@ -1,7 +1,7 @@
1
1
  import Meta from '../models/meta.model';
2
2
  import { Dictionary, VariadicFunction } from '../types/global.types';
3
3
  /**
4
- * The {@linkcode Metaizer} class is used to construct [meta information](https://jsonapi.org/format/#document-meta).
4
+ * The {@link Metaizer} class is used to construct [meta information](https://jsonapi.org/format/#document-meta).
5
5
  *
6
6
  * Example:
7
7
  * ```typescript
@@ -9,12 +9,12 @@ import { Dictionary, VariadicFunction } from '../types/global.types';
9
9
  * ```
10
10
  */
11
11
  export default class Metaizer<Dependencies extends any[]> {
12
- /** @internal Generates a {@linkcode Meta}. */
12
+ /** @internal Generates a {@link Meta}. */
13
13
  metaize: VariadicFunction<Dependencies, Meta>;
14
14
  /**
15
- * Creates a {@linkcode Metaizer}.
15
+ * Creates a {@link Metaizer}.
16
16
  *
17
- * @param metaize A function to generate [meta information](https://jsonapi.org/format/#document-meta)
17
+ * @param metaize - A function to generate [meta information](https://jsonapi.org/format/#document-meta)
18
18
  * from its arguments.
19
19
  */
20
20
  constructor(metaize: VariadicFunction<Dependencies, Dictionary<any>>);
@@ -1 +1 @@
1
- {"version":3,"file":"metaizer.d.ts","sourceRoot":"","sources":["../../src/classes/metaizer.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,sBAAsB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ,CAAC,YAAY,SAAS,GAAG,EAAE;IACtD,8CAA8C;IACvC,OAAO,EAAE,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAErD;;;;;OAKG;gBACgB,OAAO,EAAE,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;CAG5E"}
1
+ {"version":3,"file":"metaizer.d.ts","sourceRoot":"","sources":["../../src/classes/metaizer.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,sBAAsB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAErE;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ,CAAC,YAAY,SAAS,GAAG,EAAE;IACtD,0CAA0C;IACnC,OAAO,EAAE,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IAErD;;;;;OAKG;gBACgB,OAAO,EAAE,gBAAgB,CAAC,YAAY,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;CAG5E"}
@@ -1,55 +1,29 @@
1
1
  "use strict";
2
- var __read = (this && this.__read) || function (o, n) {
3
- var m = typeof Symbol === "function" && o[Symbol.iterator];
4
- if (!m) return o;
5
- var i = m.call(o), r, ar = [], e;
6
- try {
7
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
8
- }
9
- catch (error) { e = { error: error }; }
10
- finally {
11
- try {
12
- if (r && !r.done && (m = i["return"])) m.call(i);
13
- }
14
- finally { if (e) throw e.error; }
15
- }
16
- return ar;
17
- };
18
- var __spreadArray = (this && this.__spreadArray) || function (to, from) {
19
- for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
20
- to[j] = from[i];
21
- return to;
22
- };
23
2
  var __importDefault = (this && this.__importDefault) || function (mod) {
24
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
25
4
  };
26
- exports.__esModule = true;
27
- var meta_model_1 = __importDefault(require("../models/meta.model"));
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const meta_model_1 = __importDefault(require("../models/meta.model"));
28
7
  /**
29
- * The {@linkcode Metaizer} class is used to construct [meta information](https://jsonapi.org/format/#document-meta).
8
+ * The {@link Metaizer} class is used to construct [meta information](https://jsonapi.org/format/#document-meta).
30
9
  *
31
10
  * Example:
32
11
  * ```typescript
33
12
  * [[include:metaizer.example.ts]]
34
13
  * ```
35
14
  */
36
- var Metaizer = /** @class */ (function () {
15
+ class Metaizer {
16
+ /** @internal Generates a {@link Meta}. */
17
+ metaize;
37
18
  /**
38
- * Creates a {@linkcode Metaizer}.
19
+ * Creates a {@link Metaizer}.
39
20
  *
40
- * @param metaize A function to generate [meta information](https://jsonapi.org/format/#document-meta)
21
+ * @param metaize - A function to generate [meta information](https://jsonapi.org/format/#document-meta)
41
22
  * from its arguments.
42
23
  */
43
- function Metaizer(metaize) {
44
- this.metaize = function () {
45
- var datas = [];
46
- for (var _i = 0; _i < arguments.length; _i++) {
47
- datas[_i] = arguments[_i];
48
- }
49
- return new meta_model_1["default"](metaize.apply(void 0, __spreadArray([], __read(datas))));
50
- };
24
+ constructor(metaize) {
25
+ this.metaize = (...datas) => new meta_model_1.default(metaize(...datas));
51
26
  }
52
- return Metaizer;
53
- }());
54
- exports["default"] = Metaizer;
27
+ }
28
+ exports.default = Metaizer;
55
29
  //# sourceMappingURL=metaizer.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"metaizer.js","sourceRoot":"","sources":["../../src/classes/metaizer.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oEAAwC;AAGxC;;;;;;;GAOG;AACH;IAIE;;;;;OAKG;IACH,kBAAmB,OAAwD;QACzE,IAAI,CAAC,OAAO,GAAG;YAAC,eAAsB;iBAAtB,UAAsB,EAAtB,qBAAsB,EAAtB,IAAsB;gBAAtB,0BAAsB;;YAAK,OAAA,IAAI,uBAAI,CAAC,OAAO,wCAAI,KAAK,IAAE;QAA3B,CAA2B,CAAC;IACzE,CAAC;IACH,eAAC;AAAD,CAAC,AAbD,IAaC"}
1
+ {"version":3,"file":"metaizer.js","sourceRoot":"","sources":["../../src/classes/metaizer.ts"],"names":[],"mappings":";;;;;AAAA,sEAAwC;AAGxC;;;;;;;GAOG;AACH,MAAqB,QAAQ;IAC3B,0CAA0C;IACnC,OAAO,CAAuC;IAErD;;;;;OAKG;IACH,YAAmB,OAAwD;QACzE,IAAI,CAAC,OAAO,GAAG,CAAC,GAAG,KAAmB,EAAE,EAAE,CAAC,IAAI,oBAAI,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IACzE,CAAC;CACF;AAbD,2BAaC"}
@@ -2,7 +2,7 @@ import { PaginationOf } from '../interfaces/paginator.interface';
2
2
  import Link from '../models/link.model';
3
3
  import { SingleOrArray } from '../types/global.types';
4
4
  /**
5
- * The {@linkcode Paginator} class is used to construct [pagination links](https://jsonapi.org/format/#fetching-pagination).
5
+ * The {@link Paginator} class is used to construct [pagination links](https://jsonapi.org/format/#fetching-pagination).
6
6
  *
7
7
  * Example:
8
8
  * ```typescript
@@ -13,9 +13,9 @@ export default class Paginator<DataType> {
13
13
  /** @internal Generates pagination links. */
14
14
  paginate: (data: SingleOrArray<DataType>) => PaginationOf<Link> | void;
15
15
  /**
16
- * Creates a {@linkcode Paginator}.
16
+ * Creates a {@link Paginator}.
17
17
  *
18
- * @param paginate A function to generate pagination links from data.
18
+ * @param paginate - A function to generate pagination links from data.
19
19
  */
20
20
  constructor(paginate: (data: SingleOrArray<DataType>) => PaginationOf<string> | void);
21
21
  }
@@ -2,36 +2,37 @@
2
2
  var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
- exports.__esModule = true;
6
- var link_model_1 = __importDefault(require("../models/link.model"));
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const link_model_1 = __importDefault(require("../models/link.model"));
7
7
  /**
8
- * The {@linkcode Paginator} class is used to construct [pagination links](https://jsonapi.org/format/#fetching-pagination).
8
+ * The {@link Paginator} class is used to construct [pagination links](https://jsonapi.org/format/#fetching-pagination).
9
9
  *
10
10
  * Example:
11
11
  * ```typescript
12
12
  * [[include:paginator.example.ts]]
13
13
  * ```
14
14
  */
15
- var Paginator = /** @class */ (function () {
15
+ class Paginator {
16
+ /** @internal Generates pagination links. */
17
+ paginate;
16
18
  /**
17
- * Creates a {@linkcode Paginator}.
19
+ * Creates a {@link Paginator}.
18
20
  *
19
- * @param paginate A function to generate pagination links from data.
21
+ * @param paginate - A function to generate pagination links from data.
20
22
  */
21
- function Paginator(paginate) {
22
- this.paginate = function (data) {
23
- var links = paginate(data);
23
+ constructor(paginate) {
24
+ this.paginate = (data) => {
25
+ const links = paginate(data);
24
26
  if (!links)
25
27
  return;
26
28
  return {
27
- first: typeof links.first === 'string' ? new link_model_1["default"](links.first) : links.first,
28
- last: typeof links.last === 'string' ? new link_model_1["default"](links.last) : links.last,
29
- prev: typeof links.prev === 'string' ? new link_model_1["default"](links.prev) : links.prev,
30
- next: typeof links.next === 'string' ? new link_model_1["default"](links.next) : links.next
29
+ first: typeof links.first === 'string' ? new link_model_1.default(links.first) : links.first,
30
+ last: typeof links.last === 'string' ? new link_model_1.default(links.last) : links.last,
31
+ prev: typeof links.prev === 'string' ? new link_model_1.default(links.prev) : links.prev,
32
+ next: typeof links.next === 'string' ? new link_model_1.default(links.next) : links.next,
31
33
  };
32
34
  };
33
35
  }
34
- return Paginator;
35
- }());
36
- exports["default"] = Paginator;
36
+ }
37
+ exports.default = Paginator;
37
38
  //# sourceMappingURL=paginator.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"paginator.js","sourceRoot":"","sources":["../../src/classes/paginator.ts"],"names":[],"mappings":";;;;;AACA,oEAAwC;AAGxC;;;;;;;GAOG;AACH;IAIE;;;;OAIG;IACH,mBAAmB,QAAwE;QACzF,IAAI,CAAC,QAAQ,GAAG,UAAC,IAA6B;YAC5C,IAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,CAAC,KAAK;gBAAE,OAAO;YACnB,OAAO;gBACL,KAAK,EAAE,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,uBAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK;gBAC5E,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,uBAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;gBACxE,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,uBAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;gBACxE,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,uBAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;aACzE,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;IACH,gBAAC;AAAD,CAAC,AArBD,IAqBC"}
1
+ {"version":3,"file":"paginator.js","sourceRoot":"","sources":["../../src/classes/paginator.ts"],"names":[],"mappings":";;;;;AACA,sEAAwC;AAGxC;;;;;;;GAOG;AACH,MAAqB,SAAS;IAC5B,4CAA4C;IACrC,QAAQ,CAA+D;IAE9E;;;;OAIG;IACH,YAAmB,QAAwE;QACzF,IAAI,CAAC,QAAQ,GAAG,CAAC,IAA6B,EAAE,EAAE;YAChD,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC7B,IAAI,CAAC,KAAK;gBAAE,OAAO;YACnB,OAAO;gBACL,KAAK,EAAE,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,oBAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK;gBAC5E,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,oBAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;gBACxE,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,oBAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;gBACxE,IAAI,EAAE,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,oBAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;aACzE,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC;CACF;AArBD,4BAqBC"}
@@ -9,7 +9,7 @@ import { Dictionary, nullish } from '../types/global.types';
9
9
  import { Helpers } from '../utils/serializer.utils';
10
10
  import Serializer from './serializer';
11
11
  /**
12
- * The {@linkcode Relator} class is used to generate top-level [included data](https://jsonapi.org/format/#document-top-level)
12
+ * The {@link Relator} class is used to generate top-level [included data](https://jsonapi.org/format/#document-top-level)
13
13
  * as well as resource-level [relationships](https://jsonapi.org/format/#document-resource-object-relationships).
14
14
  *
15
15
  * Example:
@@ -30,11 +30,11 @@ export default class Relator<PrimaryType, RelatedType extends Dictionary<any> =
30
30
  private options;
31
31
  relatedName: string;
32
32
  /**
33
- * Creates a {@linkcode Relator}.
33
+ * Creates a {@link Relator}.
34
34
  *
35
- * @param fetch Fetches related data from primary data.
36
- * @param serializer The `Serializer` to use for related data.
37
- * @param options Options for the relator.
35
+ * @param fetch - Fetches related data from primary data.
36
+ * @param serializer - The `Serializer` to use for related data.
37
+ * @param options - Options for the relator.
38
38
  */
39
39
  constructor(fetch: (data: PrimaryType) => Promise<RelatedType | RelatedType[] | nullish>, serializer: Serializer<RelatedType>, options?: Partial<RelatorOptions<PrimaryType, RelatedType>>);
40
40
  /** @internal Gets related data from primary data. */
@@ -49,7 +49,7 @@ export default class Relator<PrimaryType, RelatedType extends Dictionary<any> =
49
49
  getRelatedLinks(data: PrimaryType, relatedData: RelatedType | RelatedType[] | nullish): Dictionary<nullish | Link> | undefined;
50
50
  /** @internal Gets related meta from primary data and related data */
51
51
  getRelatedMeta(data: PrimaryType, relatedData: RelatedType | RelatedType[] | nullish): Meta | undefined;
52
- /** @internal Creates a {@linkcode Relationship}. */
52
+ /** @internal Creates a {@link Relationship}. */
53
53
  getRelationship(data: PrimaryType, relatedDataCache?: Dictionary<any>[]): Promise<Relationship>;
54
54
  }
55
55
  //# sourceMappingURL=relator.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"relator.d.ts","sourceRoot":"","sources":["../../src/classes/relator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,IAAI,MAAM,sBAAsB,CAAC;AACxC,OAAO,IAAI,MAAM,sBAAsB,CAAC;AACxC,OAAO,YAAqC,MAAM,8BAA8B,CAAC;AACjF,OAAO,kBAAkB,MAAM,qCAAqC,CAAC;AACrE,OAAO,QAAQ,MAAM,0BAA0B,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,OAAO,CAAC,WAAW,EAAE,WAAW,SAAS,UAAU,CAAC,GAAG,CAAC,GAAG,GAAG;IACjF;;OAEG;IACH,OAAc,cAAc;;MAE1B;IAEF;;OAEG;IACH,OAAO,CAAC,OAAO,CAA2C;IAEnD,WAAW,EAAE,MAAM,CAAC;IAC3B;;;;;;OAMG;gBAED,KAAK,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC,EAC5E,UAAU,EAAE,UAAU,CAAC,WAAW,CAAC,EACnC,OAAO,GAAE,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,CAAM;IAWjE,qDAAqD;IAC9C,cAAc,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC,CAAC;IAE7F,sCAAsC;IAC/B,kBAAkB,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC;IAEvF,4CAA4C;IACrC,oBAAoB,EAAE,CAC3B,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,GAAG,SAAS,KACjD,kBAAkB,CAAC;IAExB,0CAA0C;IACnC,kBAAkB,EAAE,CACzB,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,EACxC,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,EAC9B,gBAAgB,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,KACpD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpC,sEAAsE;IAC/D,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,GAAG,WAAW,EAAE,GAAG,OAAO;IAW5F,qEAAqE;IAC9D,cAAc,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,GAAG,WAAW,EAAE,GAAG,OAAO;IAQ3F,oDAAoD;IACvC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,gBAAgB,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE;CA+BrF"}
1
+ {"version":3,"file":"relator.d.ts","sourceRoot":"","sources":["../../src/classes/relator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,IAAI,MAAM,sBAAsB,CAAC;AACxC,OAAO,IAAI,MAAM,sBAAsB,CAAC;AACxC,OAAO,YAAqC,MAAM,8BAA8B,CAAC;AACjF,OAAO,kBAAkB,MAAM,qCAAqC,CAAC;AACrE,OAAO,QAAQ,MAAM,0BAA0B,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,UAAU,MAAM,cAAc,CAAC;AAEtC;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,OAAO,CAAC,WAAW,EAAE,WAAW,SAAS,UAAU,CAAC,GAAG,CAAC,GAAG,GAAG;IACjF;;OAEG;IACH,OAAc,cAAc;;MAE1B;IAEF;;OAEG;IACH,OAAO,CAAC,OAAO,CAA2C;IAEnD,WAAW,EAAE,MAAM,CAAC;IAC3B;;;;;;OAMG;gBAED,KAAK,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC,EAC5E,UAAU,EAAE,UAAU,CAAC,WAAW,CAAC,EACnC,OAAO,GAAE,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,CAAM;IAWjE,qDAAqD;IAC9C,cAAc,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC,CAAC;IAE7F,sCAAsC;IAC/B,kBAAkB,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC;IAEvF,4CAA4C;IACrC,oBAAoB,EAAE,CAC3B,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,GAAG,SAAS,KACjD,kBAAkB,CAAC;IAExB,0CAA0C;IACnC,kBAAkB,EAAE,CACzB,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,EACxC,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,EAC9B,gBAAgB,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,KACpD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpC,sEAAsE;IAC/D,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,GAAG,WAAW,EAAE,GAAG,OAAO;IAW5F,qEAAqE;IAC9D,cAAc,CAAC,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,GAAG,WAAW,EAAE,GAAG,OAAO;IAQ3F,gDAAgD;IACnC,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,gBAAgB,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE;CA+BrF"}