@creator.co/wapi 1.2.4 → 1.2.6

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 (153) hide show
  1. package/.github/workflows/npmpublish.yml +1 -1
  2. package/README.md +216 -5
  3. package/dist/index.d.ts +15 -0
  4. package/dist/index.js.map +1 -1
  5. package/dist/jest.config.js +1 -1
  6. package/dist/jest.config.js.map +1 -1
  7. package/dist/package.json +13 -2
  8. package/dist/src/API/Request.d.ts +45 -82
  9. package/dist/src/API/Request.js +49 -77
  10. package/dist/src/API/Request.js.map +1 -1
  11. package/dist/src/API/Response.d.ts +94 -163
  12. package/dist/src/API/Response.js +101 -161
  13. package/dist/src/API/Response.js.map +1 -1
  14. package/dist/src/API/Utils.d.ts +21 -42
  15. package/dist/src/API/Utils.js +22 -43
  16. package/dist/src/API/Utils.js.map +1 -1
  17. package/dist/src/BaseEvent/EventProcessor.d.ts +32 -55
  18. package/dist/src/BaseEvent/EventProcessor.js +30 -38
  19. package/dist/src/BaseEvent/EventProcessor.js.map +1 -1
  20. package/dist/src/BaseEvent/Process.d.ts +20 -43
  21. package/dist/src/BaseEvent/Process.js +16 -27
  22. package/dist/src/BaseEvent/Process.js.map +1 -1
  23. package/dist/src/BaseEvent/Transaction.d.ts +104 -2
  24. package/dist/src/BaseEvent/Transaction.js +196 -41
  25. package/dist/src/BaseEvent/Transaction.js.map +1 -1
  26. package/dist/src/Config/Configuration.d.ts +48 -66
  27. package/dist/src/Config/Configuration.js +25 -42
  28. package/dist/src/Config/Configuration.js.map +1 -1
  29. package/dist/src/Config/EnvironmentVar.d.ts +30 -57
  30. package/dist/src/Config/EnvironmentVar.js +28 -41
  31. package/dist/src/Config/EnvironmentVar.js.map +1 -1
  32. package/dist/src/Crypto/Crypto.d.ts +17 -35
  33. package/dist/src/Crypto/Crypto.js +12 -21
  34. package/dist/src/Crypto/Crypto.js.map +1 -1
  35. package/dist/src/Crypto/JWT.d.ts +21 -32
  36. package/dist/src/Crypto/JWT.js +14 -22
  37. package/dist/src/Crypto/JWT.js.map +1 -1
  38. package/dist/src/Database/Database.d.ts +18 -0
  39. package/dist/src/Database/Database.js +18 -0
  40. package/dist/src/Database/Database.js.map +1 -0
  41. package/dist/src/Database/DatabaseManager.d.ts +32 -0
  42. package/dist/src/Database/DatabaseManager.js +50 -0
  43. package/dist/src/Database/DatabaseManager.js.map +1 -0
  44. package/dist/src/Database/DatabaseTransaction.d.ts +65 -0
  45. package/dist/src/Database/DatabaseTransaction.js +183 -0
  46. package/dist/src/Database/DatabaseTransaction.js.map +1 -0
  47. package/dist/src/Database/integrations/knex/KnexDatabase.d.ts +22 -0
  48. package/dist/src/Database/integrations/knex/KnexDatabase.js +108 -0
  49. package/dist/src/Database/integrations/knex/KnexDatabase.js.map +1 -0
  50. package/dist/src/Database/integrations/knex/KnexTransaction.d.ts +37 -0
  51. package/dist/src/Database/integrations/knex/KnexTransaction.js +60 -0
  52. package/dist/src/Database/integrations/knex/KnexTransaction.js.map +1 -0
  53. package/dist/src/Database/integrations/pgsql/PostgresDatabase.d.ts +30 -0
  54. package/dist/src/Database/integrations/pgsql/PostgresDatabase.js +108 -0
  55. package/dist/src/Database/integrations/pgsql/PostgresDatabase.js.map +1 -0
  56. package/dist/src/Database/integrations/pgsql/PostgresTransaction.d.ts +37 -0
  57. package/dist/src/Database/integrations/pgsql/PostgresTransaction.js +60 -0
  58. package/dist/src/Database/integrations/pgsql/PostgresTransaction.js.map +1 -0
  59. package/dist/src/Globals.d.ts +26 -94
  60. package/dist/src/Globals.js +26 -95
  61. package/dist/src/Globals.js.map +1 -1
  62. package/dist/src/Logger/Logger.d.ts +82 -105
  63. package/dist/src/Logger/Logger.js +111 -136
  64. package/dist/src/Logger/Logger.js.map +1 -1
  65. package/dist/src/Mailer/Mailer.d.ts +39 -75
  66. package/dist/src/Mailer/Mailer.js +36 -65
  67. package/dist/src/Mailer/Mailer.js.map +1 -1
  68. package/dist/src/Publisher/Publisher.d.ts +17 -25
  69. package/dist/src/Publisher/Publisher.js +21 -32
  70. package/dist/src/Publisher/Publisher.js.map +1 -1
  71. package/dist/src/Server/RouteResolver.d.ts +14 -22
  72. package/dist/src/Server/RouteResolver.js +21 -34
  73. package/dist/src/Server/RouteResolver.js.map +1 -1
  74. package/dist/src/Server/Router.d.ts +72 -51
  75. package/dist/src/Server/Router.js +8 -17
  76. package/dist/src/Server/Router.js.map +1 -1
  77. package/dist/src/Server/lib/ContainerServer.d.ts +15 -31
  78. package/dist/src/Server/lib/ContainerServer.js +13 -28
  79. package/dist/src/Server/lib/ContainerServer.js.map +1 -1
  80. package/dist/src/Server/lib/Server.d.ts +17 -32
  81. package/dist/src/Server/lib/Server.js +18 -28
  82. package/dist/src/Server/lib/Server.js.map +1 -1
  83. package/dist/src/Server/lib/container/GenericHandler.d.ts +5 -0
  84. package/dist/src/Server/lib/container/GenericHandler.js +16 -3
  85. package/dist/src/Server/lib/container/GenericHandler.js.map +1 -1
  86. package/dist/src/Server/lib/container/GenericHandlerEvent.d.ts +22 -37
  87. package/dist/src/Server/lib/container/GenericHandlerEvent.js +29 -41
  88. package/dist/src/Server/lib/container/GenericHandlerEvent.js.map +1 -1
  89. package/dist/src/Server/lib/container/HealthHandler.d.ts +6 -0
  90. package/dist/src/Server/lib/container/HealthHandler.js +6 -0
  91. package/dist/src/Server/lib/container/HealthHandler.js.map +1 -1
  92. package/dist/src/Server/lib/container/Proxy.d.ts +24 -52
  93. package/dist/src/Server/lib/container/Proxy.js +52 -52
  94. package/dist/src/Server/lib/container/Proxy.js.map +1 -1
  95. package/dist/src/Server/lib/container/Utils.d.ts +6 -10
  96. package/dist/src/Server/lib/container/Utils.js +6 -10
  97. package/dist/src/Server/lib/container/Utils.js.map +1 -1
  98. package/dist/src/Validation/Validator.d.ts +9 -13
  99. package/dist/src/Validation/Validator.js +8 -12
  100. package/dist/src/Validation/Validator.js.map +1 -1
  101. package/index.ts +15 -0
  102. package/jest.config.ts +1 -1
  103. package/package.json +13 -2
  104. package/src/API/Request.ts +66 -84
  105. package/src/API/Response.ts +144 -203
  106. package/src/API/Utils.ts +28 -44
  107. package/src/BaseEvent/EventProcessor.ts +52 -77
  108. package/src/BaseEvent/Process.ts +27 -52
  109. package/src/BaseEvent/Transaction.ts +147 -27
  110. package/src/Config/Configuration.ts +59 -76
  111. package/src/Config/EnvironmentVar.ts +39 -62
  112. package/src/Crypto/Crypto.ts +20 -36
  113. package/src/Crypto/JWT.ts +31 -35
  114. package/src/Database/Database.ts +19 -0
  115. package/src/Database/DatabaseManager.ts +51 -0
  116. package/src/Database/DatabaseTransaction.ts +118 -0
  117. package/src/Database/integrations/knex/KnexDatabase.ts +47 -0
  118. package/src/Database/integrations/knex/KnexTransaction.ts +51 -0
  119. package/src/Database/integrations/pgsql/PostgresDatabase.ts +49 -0
  120. package/src/Database/integrations/pgsql/PostgresTransaction.ts +54 -0
  121. package/src/Database/types.d.ts +49 -0
  122. package/src/Globals.ts +28 -96
  123. package/src/Logger/Logger.ts +141 -160
  124. package/src/Mailer/Mailer.ts +43 -76
  125. package/src/Publisher/Publisher.ts +31 -40
  126. package/src/Server/RouteResolver.ts +31 -52
  127. package/src/Server/Router.ts +75 -54
  128. package/src/Server/lib/ContainerServer.ts +20 -32
  129. package/src/Server/lib/Server.ts +19 -34
  130. package/src/Server/lib/container/GenericHandler.ts +17 -3
  131. package/src/Server/lib/container/GenericHandlerEvent.ts +44 -54
  132. package/src/Server/lib/container/HealthHandler.ts +6 -0
  133. package/src/Server/lib/container/Proxy.ts +39 -58
  134. package/src/Server/lib/container/Utils.ts +7 -10
  135. package/src/Validation/Validator.ts +11 -13
  136. package/tests/API/Response.test.ts +55 -56
  137. package/tests/BaseEvent/EventProcessor.test.ts +49 -50
  138. package/tests/BaseEvent/Process.test.ts +2 -2
  139. package/tests/BaseEvent/Transaction.test.ts +102 -44
  140. package/tests/Config/Config.test.ts +27 -27
  141. package/tests/Config/EnvironmentVar.test.ts +54 -18
  142. package/tests/Database/DatabaseManager.test.ts +55 -0
  143. package/tests/Database/integrations/knex/KnexDatabase.test.ts +53 -0
  144. package/tests/Database/integrations/knex/KnexTransaction.test.ts +133 -0
  145. package/tests/Database/integrations/pg/PostgresDatabase.test.ts +50 -0
  146. package/tests/Database/integrations/pg/PostgresTransaction.test.ts +51 -0
  147. package/tests/Publisher/Publisher.test.ts +3 -3
  148. package/tests/Server/lib/ContainerServer.test.ts +21 -22
  149. package/tests/Server/lib/container/GenericHandler.test.ts +31 -32
  150. package/tests/Server/lib/container/GenericHandlerEvent.test.ts +2 -2
  151. package/tests/Server/lib/container/HealthHandler.test.ts +6 -7
  152. package/tests/Server/lib/container/Proxy.test.ts +37 -35
  153. package/tsconfig.json +6 -1
@@ -63,22 +63,16 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
63
63
  };
64
64
  Object.defineProperty(exports, "__esModule", { value: true });
65
65
  var Globals_1 = require("../Globals");
66
- //
67
66
  /**
68
- * ${1:Description placeholder}
69
- *
70
- * @class CustomError
71
- * @typedef {CustomError}
72
- * @extends {Error}
67
+ * CustomError class that extends the built-in Error class.
68
+ * @class
69
+ * @extends Error
70
+ * @param {any} body - The body of the error, which can be an object or a string.
71
+ * @constructor
72
+ * @property {string} name - The name of the error.
73
73
  */
74
74
  var CustomError = /** @class */ (function (_super) {
75
75
  __extends(CustomError, _super);
76
- /**
77
- * Creates an instance of CustomError.
78
- *
79
- * @constructor
80
- * @param {*} body
81
- */
82
76
  function CustomError(body) {
83
77
  var _this = _super.call(this, body.message || 'Unknown error!') || this;
84
78
  _this.name = body.error || 'UnknownError';
@@ -86,42 +80,32 @@ var CustomError = /** @class */ (function (_super) {
86
80
  }
87
81
  return CustomError;
88
82
  }(Error));
89
- //
90
83
  /**
91
- * ${1:Description placeholder}
92
- *
93
- * @export
94
- * @class Response
95
- * @typedef {Response}
96
- * @template [BodyType=null]
84
+ * Represents a response object with various methods for building and manipulating the response.
85
+ * @template BodyType - The type of the response body.
97
86
  */
98
87
  var Response = /** @class */ (function () {
99
- //
100
88
  /**
101
- * Creates an instance of Response.
102
- *
103
- * @constructor
104
- * @param {number} statusCode
105
- * @param {BodyType} body
106
- * @param {?(| {
107
- * shouldStream?: boolean
108
- * rawBody?: boolean
109
- * throwOnErrors?: boolean
110
- * disableTransactionID?: boolean
111
- * }
112
- * | undefined)\} [optBehaviour]
89
+ * Constructs a new Response object with the given status code, body, and optional behavior.
90
+ * @param {number} statusCode - The HTTP status code of the response.
91
+ * @param {BodyType} body - The body of the response.
92
+ * @param {Object} [optBehaviour] - Optional behavior configuration for the response.
93
+ * @param {boolean} [optBehaviour.shouldStream] - Indicates whether the response should be streamed.
94
+ * @param {boolean} [optBehaviour.rawBody] - Indicates whether the response body should be treated as raw data.
95
+ * @param {boolean} [optBehaviour.throwOnErrors] - Indicates whether errors should be thrown for non-successful status codes.
96
+ * @param {boolean} [optBehaviour
113
97
  */
114
98
  function Response(statusCode, body, optBehaviour) {
115
99
  // response
116
- this._statusCode = statusCode;
117
- this._body = body;
118
- this._headers = {
100
+ this.statusCode = statusCode;
101
+ this.body = body;
102
+ this.headers = {
119
103
  'Access-Control-Allow-Origin': '*',
120
104
  'Access-Control-Allow-Credentials': true,
121
105
  'Content-Type': 'application/json',
122
106
  };
123
107
  // behaviour
124
- this._isPipingOut = false; //internal -- flag to indicate streaming out has started and avoid double stream call
108
+ this.isPipingOut = false; //internal -- flag to indicate streaming out has started and avoid double stream call
125
109
  // options
126
110
  this.shouldStream = !!(optBehaviour === null || optBehaviour === void 0 ? void 0 : optBehaviour.shouldStream); //
127
111
  this.rawBody = !!(optBehaviour === null || optBehaviour === void 0 ? void 0 : optBehaviour.rawBody);
@@ -129,75 +113,66 @@ var Response = /** @class */ (function () {
129
113
  this.disableTransactionID = !!(optBehaviour === null || optBehaviour === void 0 ? void 0 : optBehaviour.disableTransactionID);
130
114
  }
131
115
  /**
132
- * ${1:Description placeholder}
133
- *
134
- * @public
135
- * @returns {number}
116
+ * Get the status code of the response.
117
+ * @returns {number} The status code.
136
118
  */
137
119
  Response.prototype.getCode = function () {
138
- return this._statusCode;
120
+ return this.statusCode;
139
121
  };
140
122
  /**
141
- * ${1:Description placeholder}
142
- *
143
- * @public
144
- * @returns {BodyType}
123
+ * Get the body of the object.
124
+ * @returns {BodyType} The body of the object.
145
125
  */
146
126
  Response.prototype.getBody = function () {
147
- return this._body;
127
+ return this.body;
148
128
  };
149
129
  /**
150
- * ${1:Description placeholder}
151
- *
152
- * @public
153
- * @param {string} key
154
- * @param {*} value
130
+ * Appends a key-value pair into the body object.
131
+ * @param {string} key - The key to append.
132
+ * @param {any} value - The value to append.
133
+ * @returns None
155
134
  */
156
135
  Response.prototype.appendIntoBody = function (key, value) {
157
- this._body[key] = value;
136
+ this.body[key] = value;
158
137
  };
159
138
  /**
160
- * ${1:Description placeholder}
161
- *
162
- * @public
163
- * @param {string} key
164
- * @param {*} value
139
+ * Appends a header to the existing headers object.
140
+ * @param {string} key - The key of the header.
141
+ * @param {any} value - The value of the header.
142
+ * @returns None
165
143
  */
166
144
  Response.prototype.appendHeader = function (key, value) {
167
- this._headers[key] = value;
145
+ this.headers[key] = value;
168
146
  };
169
147
  /**
170
- * ${1:Description placeholder}
171
- *
172
- * @public
173
- * @async
174
- * @param {Context} context
175
- * @param {Transaction<any, any, any>} transaction
176
- * @param {boolean} _optDoNotCallContext
177
- * @returns {Promise<void>}
148
+ * Builds the response for the given context and transaction.
149
+ * @param {Context} context - The context object.
150
+ * @param {Transaction<any, any, any>} transaction - The transaction object.
151
+ * @param {boolean} optDoNotCallContext - Optional flag to indicate whether to call the context or not.
152
+ * @returns {Promise<void>} - A promise that resolves when the response is built.
178
153
  */
179
- Response.prototype.build = function (context, transaction, _optDoNotCallContext) {
154
+ Response.prototype.build = function (context, transaction, optDoNotCallContext) {
180
155
  return __awaiter(this, void 0, void 0, function () {
181
156
  var b;
182
157
  return __generator(this, function (_a) {
183
158
  switch (_a.label) {
184
159
  case 0:
185
160
  //Stream support
186
- if (this._isPipingOut)
161
+ if (this.isPipingOut)
187
162
  return [2 /*return*/];
188
163
  if (this.shouldStream)
189
- return [2 /*return*/, this._pipe(context)
164
+ return [2 /*return*/, this.pipe(context)
190
165
  //append default fields
191
166
  ];
192
167
  //append default fields
193
- if (transaction.request.getRequestID() && this._body && !this.disableTransactionID)
168
+ if (transaction.request.getRequestID() && this.body && !this.disableTransactionID)
194
169
  this.appendIntoBody('transactionID', transaction.request.getRequestID()); //append transaction ID
195
170
  //Raw response support
196
171
  if (this.rawBody)
197
- return [2 /*return*/, this._rawContext(context, transaction)
172
+ return [2 /*return*/, this.rawContext(context, transaction)
198
173
  //build response
199
174
  ];
200
- b = __assign({ statusCode: this._statusCode, headers: this._headers }, (this._body ? { body: JSON.stringify(this._body) } : {}));
175
+ b = __assign({ statusCode: this.statusCode, headers: this.headers }, (this.body ? { body: JSON.stringify(this.body) } : {}));
201
176
  //log response and respond to context
202
177
  transaction.logger.debug(b);
203
178
  if (!transaction.responseProxy) return [3 /*break*/, 2];
@@ -209,7 +184,7 @@ var Response = /** @class */ (function () {
209
184
  _a.label = 2;
210
185
  case 2:
211
186
  //Batch does not succeed directly just on upper transaction (which will should be a batch)
212
- if (!_optDoNotCallContext)
187
+ if (!optDoNotCallContext)
213
188
  context.succeed(b);
214
189
  return [2 /*return*/];
215
190
  }
@@ -217,50 +192,44 @@ var Response = /** @class */ (function () {
217
192
  });
218
193
  };
219
194
  /**
220
- * ${1:Description placeholder}
221
- *
222
- * @private
223
- * @param {Context} context
195
+ * Private method that pipes the response to the given context.
196
+ * @param {Context} context - The context object provided by AWS Lambda.
197
+ * @returns None
224
198
  */
225
- Response.prototype._pipe = function (context) {
199
+ Response.prototype.pipe = function (context) {
226
200
  //Check if not streaming
227
- this._isPipingOut = true;
201
+ this.isPipingOut = true;
228
202
  //build response
229
203
  var b = {
230
- statusCode: this._statusCode,
231
- body: this._body,
232
- headers: this._headers,
204
+ statusCode: this.statusCode,
205
+ body: this.body,
206
+ headers: this.headers,
233
207
  };
234
208
  //log response and respond to context
235
209
  context.succeed(b);
236
210
  };
237
211
  /**
238
- * ${1:Description placeholder}
239
- *
240
- * @private
241
- * @param {Context} context
242
- * @param {Transaction<null, BodyType>} transaction
212
+ * Private method that handles the raw context of a transaction.
213
+ * @param {Context} context - The context object.
214
+ * @param {Transaction<null, BodyType>} transaction - The transaction object.
215
+ * @returns None
243
216
  */
244
- Response.prototype._rawContext = function (context, transaction) {
217
+ Response.prototype.rawContext = function (context, transaction) {
245
218
  //log response and respond to context
246
- transaction.logger.debug(this._body);
219
+ transaction.logger.debug(this.body);
247
220
  if (this.getCode() <= 200 && this.getCode() <= 299)
248
- context.succeed(this._body);
221
+ context.succeed(this.body);
249
222
  else {
250
223
  if (!this.throwOnErrors)
251
- context.fail(new CustomError(this._body));
224
+ context.fail(new CustomError(this.body));
252
225
  else
253
- throw new CustomError(this._body);
226
+ throw new CustomError(this.body);
254
227
  }
255
228
  };
256
- /* Shortcuts */
257
229
  /**
258
- * ${1:Description placeholder}
259
- *
260
- * @public
261
- * @static
262
- * @param {string} paramName
263
- * @returns {Response<ResponseErrorType>}
230
+ * Generates a response object for a missing path parameter error.
231
+ * @param {string} paramName - The name of the missing path parameter.
232
+ * @returns {Response<ResponseErrorType>} - The response object with error details.
264
233
  */
265
234
  Response.MissingParamResponse = function (paramName) {
266
235
  console.warn("Invalid request - Path parameter ".concat(paramName, " is missing."));
@@ -270,12 +239,9 @@ var Response = /** @class */ (function () {
270
239
  });
271
240
  };
272
241
  /**
273
- * ${1:Description placeholder}
274
- *
275
- * @public
276
- * @static
277
- * @param {string} paramName
278
- * @returns {Response<ResponseErrorType>}
242
+ * Creates a response object for a missing query parameter error.
243
+ * @param {string} paramName - The name of the missing query parameter.
244
+ * @returns {Response<ResponseErrorType>} - The response object with error details.
279
245
  */
280
246
  Response.MissingQueryResponse = function (paramName) {
281
247
  console.warn("Invalid request - Query parameter ".concat(paramName, " is missing."));
@@ -285,65 +251,49 @@ var Response = /** @class */ (function () {
285
251
  });
286
252
  };
287
253
  /**
288
- * ${1:Description placeholder}
289
- *
290
- * @public
291
- * @static
292
- * @param {?string} [msg]
293
- * @param {?string} [errCode]
294
- * @param {?*} [optBody]
295
- * @returns {Response<ResponseErrorType>}
254
+ * Creates a BadRequestResponse object with the given parameters.
255
+ * @param {string} [msg] - The error message.
256
+ * @param {string} [errCode] - The error code.
257
+ * @param {any} [optBody] - Optional additional body data.
258
+ * @returns {Response<ResponseErrorType>} - The BadRequestResponse object.
296
259
  */
297
260
  Response.BadRequestResponse = function (msg, errCode, optBody) {
298
261
  console.warn("Bad request - ".concat(msg));
299
262
  return new Response(400, __assign(__assign({ err: msg }, (errCode ? { errCode: errCode } : {})), (optBody || {})));
300
263
  };
301
264
  /**
302
- * ${1:Description placeholder}
303
- *
304
- * @public
305
- * @static
306
- * @param {string} msg
307
- * @param {?string} [errCode]
308
- * @param {?*} [optBody]
309
- * @returns {Response<ResponseErrorType>}
265
+ * Creates a BadRequestResponse object with rollback option.
266
+ * @param {string} msg - The error message.
267
+ * @param {string} [errCode] - The error code.
268
+ * @param {any} [optBody] - Optional body to include in the response.
269
+ * @returns {Response<ResponseErrorType>} - The BadRequestResponse object.
310
270
  */
311
271
  Response.BadRequestResponseWithRollback = function (msg, errCode, optBody) {
312
272
  console.warn("Bad request - ".concat(msg));
313
273
  return new Response(400, __assign(__assign({ err: msg, rollback: true }, (errCode ? { errCode: errCode } : {})), (optBody || {})));
314
274
  };
315
275
  /**
316
- * ${1:Description placeholder}
317
- *
318
- * @public
319
- * @static
320
- * @param {string} msg
321
- * @param {?string} [errCode]
322
- * @returns {Response<ResponseErrorType>}
276
+ * Creates an unauthorized response with the given error message and error code.
277
+ * @param {string} msg - The error message.
278
+ * @param {string} [errCode] - The error code (optional).
279
+ * @returns {Response<ResponseErrorType>} - The unauthorized response.
323
280
  */
324
281
  Response.UnauthorizedResponse = function (msg, errCode) {
325
282
  console.warn("Denying request - ".concat(msg));
326
283
  return new Response(401, __assign({ err: msg }, (errCode ? { errCode: errCode } : {})));
327
284
  };
328
285
  /**
329
- * ${1:Description placeholder}
330
- *
331
- * @public
332
- * @static
333
- * @template BodyType
334
- * @param {BodyType} body
335
- * @returns {Response<BodyType>}
286
+ * Creates a success response object with the given body.
287
+ * @param {BodyType} body - The body of the response.
288
+ * @returns {Response<BodyType>} - The success response object.
336
289
  */
337
290
  Response.SuccessResponse = function (body) {
338
291
  return new Response(200, (body ? body : {}));
339
292
  };
340
293
  /**
341
- * ${1:Description placeholder}
342
- *
343
- * @public
344
- * @static
345
- * @param {string} url
346
- * @returns {Response<null>}
294
+ * Creates a redirect response with the specified URL.
295
+ * @param {string} url - The URL to redirect to.
296
+ * @returns {Response<null>} - The redirect response.
347
297
  */
348
298
  Response.RedirectResponse = function (url) {
349
299
  var resp = new Response(302, null);
@@ -351,23 +301,17 @@ var Response = /** @class */ (function () {
351
301
  return resp;
352
302
  };
353
303
  /**
354
- * ${1:Description placeholder}
355
- *
356
- * @public
357
- * @static
358
- * @returns {Response<null>}
304
+ * Creates a success response with no content.
305
+ * @returns {Response<null>} A response object with a status code of 204 and no content.
359
306
  */
360
307
  Response.SuccessNoContentResponse = function () {
361
308
  return new Response(204, null);
362
309
  };
363
310
  /**
364
- * ${1:Description placeholder}
365
- *
366
- * @public
367
- * @static
368
- * @param {*} stream
369
- * @param {string} contentType
370
- * @returns {Response}
311
+ * Creates a success response object with a streaming body and specified content type.
312
+ * @param {any} stream - The stream object to be used as the response body.
313
+ * @param {string} contentType - The content type of the response.
314
+ * @returns {Response} - The success response object.
371
315
  */
372
316
  Response.SuccessStreamResponse = function (stream, contentType) {
373
317
  var resp = new Response(200, stream, {
@@ -379,14 +323,10 @@ var Response = /** @class */ (function () {
379
323
  return resp;
380
324
  };
381
325
  /**
382
- * ${1:Description placeholder}
383
- *
384
- * @public
385
- * @static
386
- * @template BodyType
387
- * @param {BodyType} body
388
- * @param {?number} [optionalCode]
389
- * @returns {Response<BodyType>}
326
+ * Creates a simple HTTP response with the given body and optional status code.
327
+ * @param {BodyType} body - The body of the response.
328
+ * @param {number} [optionalCode] - The optional status code of the response. Defaults to 200.
329
+ * @returns {Response<BodyType>} - The created response object.
390
330
  */
391
331
  Response.SimpleResponse = function (body, optionalCode) {
392
332
  var resp = new Response(optionalCode || 200, body);
@@ -1 +1 @@
1
- {"version":3,"file":"Response.js","sourceRoot":"","sources":["../../../src/API/Response.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,sCAAgC;AAChC,EAAE;AACF;;;;;;GAMG;AACH;IAA0B,+BAAK;IAC7B;;;;;OAKG;IACH,qBAAY,IAAS;QAArB,YACE,kBAAM,IAAI,CAAC,OAAO,IAAI,gBAAgB,CAAC,SAExC;QADC,KAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,IAAI,cAAc,CAAA;;IAC1C,CAAC;IACH,kBAAC;AAAD,CAAC,AAXD,CAA0B,KAAK,GAW9B;AAYD,EAAE;AACF;;;;;;;GAOG;AACH;IA6DE,EAAE;IACF;;;;;;;;;;;;;OAaG;IACH,kBACE,UAAkB,EAClB,IAAc,EACd,YAOa;QAEb,WAAW;QACX,IAAI,CAAC,WAAW,GAAG,UAAU,CAAA;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,QAAQ,GAAG;YACd,6BAA6B,EAAE,GAAG;YAClC,kCAAkC,EAAE,IAAI;YACxC,cAAc,EAAE,kBAAkB;SACnC,CAAA;QACD,YAAY;QACZ,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA,CAAC,qFAAqF;QAC/G,UAAU;QACV,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,YAAY,CAAA,CAAA,CAAC,EAAE;QACnD,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,CAAA,CAAA;QACtC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,aAAa,CAAA,CAAA;QAClD,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,oBAAoB,CAAA,CAAA;IAClE,CAAC;IACD;;;;;OAKG;IACI,0BAAO,GAAd;QACE,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IACD;;;;;OAKG;IACI,0BAAO,GAAd;QACE,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IACD;;;;;;OAMG;IACI,iCAAc,GAArB,UAAsB,GAAW,EAAE,KAAU;QAC3C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IACzB,CAAC;IACD;;;;;;OAMG;IACI,+BAAY,GAAnB,UAAoB,GAAW,EAAE,KAAU;QACzC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IAC5B,CAAC;IACD;;;;;;;;;OASG;IACU,wBAAK,GAAlB,UACE,OAAgB,EAChB,WAAuC,EACvC,oBAA6B;;;;;;wBAE7B,gBAAgB;wBAChB,IAAI,IAAI,CAAC,YAAY;4BAAE,sBAAM;wBAC7B,IAAI,IAAI,CAAC,YAAY;4BAAE,sBAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;gCAEjD,uBAAuB;8BAF0B;wBAEjD,uBAAuB;wBACvB,IAAI,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,oBAAoB;4BAChF,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA,CAAC,uBAAuB;wBAClG,sBAAsB;wBACtB,IAAI,IAAI,CAAC,OAAO;4BAAE,sBAAO,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC;gCAE/D,gBAAgB;8BAF+C;wBAGzD,CAAC,cACL,UAAU,EAAE,IAAI,CAAC,WAAW,EAC5B,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC5D,CAAA;wBACD,qCAAqC;wBACrC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;6BAEvB,WAAW,CAAC,aAAa,EAAzB,wBAAyB;wBAAE,qBAAM,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC;4BACpE,0FAA0F;0BADtB;;wBAArC,SAAqC,CAAA;;;wBACpE,0FAA0F;wBAC1F,IAAI,CAAC,oBAAoB;4BAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;;;;;KAC9C;IACD;;;;;OAKG;IACK,wBAAK,GAAb,UAAc,OAAgB;QAC5B,wBAAwB;QACxB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;QACxB,gBAAgB;QAChB,IAAM,CAAC,GAAG;YACR,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,OAAO,EAAE,IAAI,CAAC,QAAQ;SACvB,CAAA;QACD,qCAAqC;QACrC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IACD;;;;;;OAMG;IACK,8BAAW,GAAnB,UAAoB,OAAgB,EAAE,WAAwC;QAC5E,qCAAqC;QACrC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACpC,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG;YAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;aAC1E;YACH,IAAI,CAAC,IAAI,CAAC,aAAa;gBAAE,OAAO,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;;gBAC7D,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SACvC;IACH,CAAC;IAED,eAAe;IACf;;;;;;;OAOG;IACW,6BAAoB,GAAlC,UAAmC,SAAiB;QAClD,OAAO,CAAC,IAAI,CAAC,2CAAoC,SAAS,iBAAc,CAAC,CAAA;QACzE,OAAO,IAAI,QAAQ,CAAoB,GAAG,EAAE;YAC1C,GAAG,EAAE,0CAAmC,SAAS,iBAAc;YAC/D,OAAO,EAAE,iBAAO,CAAC,sBAAsB;SACxC,CAAC,CAAA;IACJ,CAAC;IACD;;;;;;;OAOG;IACW,6BAAoB,GAAlC,UAAmC,SAAiB;QAClD,OAAO,CAAC,IAAI,CAAC,4CAAqC,SAAS,iBAAc,CAAC,CAAA;QAC1E,OAAO,IAAI,QAAQ,CAAoB,GAAG,EAAE;YAC1C,GAAG,EAAE,2CAAoC,SAAS,iBAAc;YAChE,OAAO,EAAE,iBAAO,CAAC,sBAAsB;SACxC,CAAC,CAAA;IACJ,CAAC;IACD;;;;;;;;;OASG;IACW,2BAAkB,GAAhC,UACE,GAAY,EACZ,OAAgB,EAChB,OAAa;QAEb,OAAO,CAAC,IAAI,CAAC,wBAAiB,GAAG,CAAE,CAAC,CAAA;QACpC,OAAO,IAAI,QAAQ,CAAoB,GAAG,sBACxC,GAAG,EAAE,GAAG,IACL,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACrC,CAAC,OAAO,IAAI,EAAE,CAAC,EAClB,CAAA;IACJ,CAAC;IACD;;;;;;;;;OASG;IACW,uCAA8B,GAA5C,UACE,GAAW,EACX,OAAgB,EAChB,OAAa;QAEb,OAAO,CAAC,IAAI,CAAC,wBAAiB,GAAG,CAAE,CAAC,CAAA;QACpC,OAAO,IAAI,QAAQ,CAAoB,GAAG,sBACxC,GAAG,EAAE,GAAG,EACR,QAAQ,EAAE,IAAI,IACX,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACrC,CAAC,OAAO,IAAI,EAAE,CAAC,EAClB,CAAA;IACJ,CAAC;IACD;;;;;;;;OAQG;IACW,6BAAoB,GAAlC,UAAmC,GAAW,EAAE,OAAgB;QAC9D,OAAO,CAAC,IAAI,CAAC,4BAAqB,GAAG,CAAE,CAAC,CAAA;QACxC,OAAO,IAAI,QAAQ,CAAoB,GAAG,aACxC,GAAG,EAAE,GAAG,IACL,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EACxC,CAAA;IACJ,CAAC;IACD;;;;;;;;OAQG;IACW,wBAAe,GAA7B,UAAwC,IAAc;QACpD,OAAO,IAAI,QAAQ,CAAW,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAa,CAAC,CAAA;IACpE,CAAC;IACD;;;;;;;OAOG;IACW,yBAAgB,GAA9B,UAA+B,GAAW;QACxC,IAAM,IAAI,GAAG,IAAI,QAAQ,CAAO,GAAG,EAAE,IAAI,CAAC,CAAA;QAC1C,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IACD;;;;;;OAMG;IACW,iCAAwB,GAAtC;QACE,OAAO,IAAI,QAAQ,CAAO,GAAG,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;IACD;;;;;;;;OAQG;IACW,8BAAqB,GAAnC,UAAoC,MAAW,EAAE,WAAmB;QAClE,IAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE;YACrC,YAAY,EAAE,IAAI;SACnB,CAAC,CAAA;QACF,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;QAC7C,IAAI,WAAW;YAAE,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,WAAW,CAAC,CAAA;QAC/D,OAAO,IAAI,CAAA;IACb,CAAC;IACD;;;;;;;;;OASG;IACW,uBAAc,GAA5B,UACE,IAAc,EACd,YAAqB;QAErB,IAAM,IAAI,GAAG,IAAI,QAAQ,CAAW,YAAY,IAAI,GAAG,EAAE,IAAI,CAAC,CAAA;QAC9D,OAAO,IAAI,CAAA;IACb,CAAC;IACH,eAAC;AAAD,CAAC,AAxXD,IAwXC"}
1
+ {"version":3,"file":"Response.js","sourceRoot":"","sources":["../../../src/API/Response.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,sCAAgC;AAEhC;;;;;;;GAOG;AACH;IAA0B,+BAAK;IAC7B,qBAAY,IAAS;QAArB,YACE,kBAAM,IAAI,CAAC,OAAO,IAAI,gBAAgB,CAAC,SAExC;QADC,KAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,IAAI,cAAc,CAAA;;IAC1C,CAAC;IACH,kBAAC;AAAD,CAAC,AALD,CAA0B,KAAK,GAK9B;AAaD;;;GAGG;AACH;IA4CE;;;;;;;;;OASG;IACH,kBACE,UAAkB,EAClB,IAAc,EACd,YAOa;QAEb,WAAW;QACX,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,OAAO,GAAG;YACb,6BAA6B,EAAE,GAAG;YAClC,kCAAkC,EAAE,IAAI;YACxC,cAAc,EAAE,kBAAkB;SACnC,CAAA;QACD,YAAY;QACZ,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA,CAAC,qFAAqF;QAC9G,UAAU;QACV,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,YAAY,CAAA,CAAA,CAAC,EAAE;QACnD,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,CAAA,CAAA;QACtC,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,aAAa,CAAA,CAAA;QAClD,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,oBAAoB,CAAA,CAAA;IAClE,CAAC;IAED;;;OAGG;IACI,0BAAO,GAAd;QACE,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED;;;OAGG;IACI,0BAAO,GAAd;QACE,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED;;;;;OAKG;IACI,iCAAc,GAArB,UAAsB,GAAW,EAAE,KAAU;QAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IACxB,CAAC;IAED;;;;;OAKG;IACI,+BAAY,GAAnB,UAAoB,GAAW,EAAE,KAAU;QACzC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IAC3B,CAAC;IAED;;;;;;OAMG;IACU,wBAAK,GAAlB,UACE,OAAgB,EAChB,WAAuC,EACvC,mBAA4B;;;;;;wBAE5B,gBAAgB;wBAChB,IAAI,IAAI,CAAC,WAAW;4BAAE,sBAAM;wBAC5B,IAAI,IAAI,CAAC,YAAY;4BAAE,sBAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;gCAEhD,uBAAuB;8BAFyB;wBAEhD,uBAAuB;wBACvB,IAAI,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,oBAAoB;4BAC/E,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,WAAW,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA,CAAC,uBAAuB;wBAClG,sBAAsB;wBACtB,IAAI,IAAI,CAAC,OAAO;4BAAE,sBAAO,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC;gCAE9D,gBAAgB;8BAF8C;wBAGxD,CAAC,cACL,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,IAClB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC1D,CAAA;wBACD,qCAAqC;wBACrC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;6BAEvB,WAAW,CAAC,aAAa,EAAzB,wBAAyB;wBAAE,qBAAM,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC;4BACpE,0FAA0F;0BADtB;;wBAArC,SAAqC,CAAA;;;wBACpE,0FAA0F;wBAC1F,IAAI,CAAC,mBAAmB;4BAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;;;;;KAC7C;IAED;;;;OAIG;IACK,uBAAI,GAAZ,UAAa,OAAgB;QAC3B,wBAAwB;QACxB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACvB,gBAAgB;QAChB,IAAM,CAAC,GAAG;YACR,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAA;QACD,qCAAqC;QACrC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IACpB,CAAC;IAED;;;;;OAKG;IACK,6BAAU,GAAlB,UAAmB,OAAgB,EAAE,WAAwC;QAC3E,qCAAqC;QACrC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACnC,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG;YAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;aACzE;YACH,IAAI,CAAC,IAAI,CAAC,aAAa;gBAAE,OAAO,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;;gBAC5D,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;SACtC;IACH,CAAC;IAED;;;;OAIG;IACW,6BAAoB,GAAlC,UAAmC,SAAiB;QAClD,OAAO,CAAC,IAAI,CAAC,2CAAoC,SAAS,iBAAc,CAAC,CAAA;QACzE,OAAO,IAAI,QAAQ,CAAoB,GAAG,EAAE;YAC1C,GAAG,EAAE,0CAAmC,SAAS,iBAAc;YAC/D,OAAO,EAAE,iBAAO,CAAC,sBAAsB;SACxC,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACW,6BAAoB,GAAlC,UAAmC,SAAiB;QAClD,OAAO,CAAC,IAAI,CAAC,4CAAqC,SAAS,iBAAc,CAAC,CAAA;QAC1E,OAAO,IAAI,QAAQ,CAAoB,GAAG,EAAE;YAC1C,GAAG,EAAE,2CAAoC,SAAS,iBAAc;YAChE,OAAO,EAAE,iBAAO,CAAC,sBAAsB;SACxC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACW,2BAAkB,GAAhC,UACE,GAAY,EACZ,OAAgB,EAChB,OAAa;QAEb,OAAO,CAAC,IAAI,CAAC,wBAAiB,GAAG,CAAE,CAAC,CAAA;QACpC,OAAO,IAAI,QAAQ,CAAoB,GAAG,sBACxC,GAAG,EAAE,GAAG,IACL,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACrC,CAAC,OAAO,IAAI,EAAE,CAAC,EAClB,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACW,uCAA8B,GAA5C,UACE,GAAW,EACX,OAAgB,EAChB,OAAa;QAEb,OAAO,CAAC,IAAI,CAAC,wBAAiB,GAAG,CAAE,CAAC,CAAA;QACpC,OAAO,IAAI,QAAQ,CAAoB,GAAG,sBACxC,GAAG,EAAE,GAAG,EACR,QAAQ,EAAE,IAAI,IACX,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACrC,CAAC,OAAO,IAAI,EAAE,CAAC,EAClB,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACW,6BAAoB,GAAlC,UAAmC,GAAW,EAAE,OAAgB;QAC9D,OAAO,CAAC,IAAI,CAAC,4BAAqB,GAAG,CAAE,CAAC,CAAA;QACxC,OAAO,IAAI,QAAQ,CAAoB,GAAG,aACxC,GAAG,EAAE,GAAG,IACL,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EACxC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACW,wBAAe,GAA7B,UAAwC,IAAc;QACpD,OAAO,IAAI,QAAQ,CAAW,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAa,CAAC,CAAA;IACpE,CAAC;IAED;;;;OAIG;IACW,yBAAgB,GAA9B,UAA+B,GAAW;QACxC,IAAM,IAAI,GAAG,IAAI,QAAQ,CAAO,GAAG,EAAE,IAAI,CAAC,CAAA;QAC1C,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACW,iCAAwB,GAAtC;QACE,OAAO,IAAI,QAAQ,CAAO,GAAG,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;IAED;;;;;OAKG;IACW,8BAAqB,GAAnC,UAAoC,MAAW,EAAE,WAAmB;QAClE,IAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE;YACrC,YAAY,EAAE,IAAI;SACnB,CAAC,CAAA;QACF,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,CAAA;QAC7C,IAAI,WAAW;YAAE,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,WAAW,CAAC,CAAA;QAC/D,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACW,uBAAc,GAA5B,UACE,IAAc,EACd,YAAqB;QAErB,IAAM,IAAI,GAAG,IAAI,QAAQ,CAAW,YAAY,IAAI,GAAG,EAAE,IAAI,CAAC,CAAA;QAC9D,OAAO,IAAI,CAAA;IACb,CAAC;IACH,eAAC;AAAD,CAAC,AAtUD,IAsUC"}
@@ -1,63 +1,42 @@
1
1
  /**
2
- * ${1:Description placeholder}
3
- *
4
- * @export
5
- * @class Utils
6
- * @typedef {Utils}
2
+ * Utility class containing various static methods for common operations.
7
3
  */
8
4
  export default class Utils {
9
5
  /**
10
- * ${1:Description placeholder}
11
- *
12
- * @public
13
- * @static
14
- * @returns {boolean}
6
+ * Checks if the application is running in a hybridless container.
7
+ * @returns {boolean} - True if the application is running in a hybridless container, false otherwise.
15
8
  */
16
9
  static isHybridlessContainer(): boolean;
17
10
  /**
18
- * ${1:Description placeholder}
19
- *
20
- * @public
21
- * @static
22
- * @param {string} string
23
- * @returns {boolean}
11
+ * Checks if a given string is valid.
12
+ * @param {string} string - The string to check.
13
+ * @returns {boolean} - True if the string is valid, false otherwise.
24
14
  */
25
15
  static isValidString(string: string): boolean;
26
16
  /**
27
- * ${1:Description placeholder}
28
- *
29
- * @public
30
- * @static
31
- * @param {string} string
32
- * @returns {(number | null)}
17
+ * Parses a string into an integer and returns null if the string is not a valid number.
18
+ * @param {string} string - The string to parse into an integer.
19
+ * @returns {number | null} - The parsed integer or null if the string is not a valid number.
33
20
  */
34
21
  static parseIntNullIfNaN(string: string): number | null;
35
22
  /**
36
- * ${1:Description placeholder}
37
- *
38
- * @public
39
- * @static
40
- * @param {string} string
41
- * @returns {(any | null)}
23
+ * Parses a JSON string and returns the resulting object. If the string is empty or
24
+ * cannot be parsed, null is returned.
25
+ * @param {string} string - The JSON string to parse.
26
+ * @returns {any | null} - The parsed object or null if the string is empty or invalid.
42
27
  */
43
- static parseObjectNullIfEmpty(string: string): any | null;
28
+ static parseObjectNullIfEmpty(string: string | undefined): any | null;
44
29
  /**
45
- * ${1:Description placeholder}
46
- *
47
- * @public
48
- * @static
49
- * @param {string} number
50
- * @returns {boolean}
30
+ * Checks if a given value is a valid number.
31
+ * @param {string} number - The value to be checked.
32
+ * @returns {boolean} - True if the value is a valid number, false otherwise.
51
33
  */
52
34
  static isValidNumber(number: string): boolean;
53
35
  /**
54
- * ${1:Description placeholder}
55
- *
56
- * @public
57
- * @static
58
- * @param {*} obj
59
- * @param {string} key
60
- * @returns {(any | null)}
36
+ * Retrieves the value from an object using a case-insensitive key lookup.
37
+ * @param {any} obj - The object to search for the key.
38
+ * @param {string} key - The key to search for in the object.
39
+ * @returns {any | null} The value associated with the key, or null if the key is not found.
61
40
  */
62
41
  static caseInsensitiveObjectForKey(obj: any, key: string): any | null;
63
42
  }
@@ -1,61 +1,46 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  /**
4
- * ${1:Description placeholder}
5
- *
6
- * @export
7
- * @class Utils
8
- * @typedef {Utils}
4
+ * Utility class containing various static methods for common operations.
9
5
  */
10
6
  var Utils = /** @class */ (function () {
11
7
  function Utils() {
12
8
  }
13
9
  /**
14
- * ${1:Description placeholder}
15
- *
16
- * @public
17
- * @static
18
- * @returns {boolean}
10
+ * Checks if the application is running in a hybridless container.
11
+ * @returns {boolean} - True if the application is running in a hybridless container, false otherwise.
19
12
  */
20
13
  Utils.isHybridlessContainer = function () {
21
14
  return process.env.HYBRIDLESS_RUNTIME == 'true';
22
15
  };
23
16
  /**
24
- * ${1:Description placeholder}
25
- *
26
- * @public
27
- * @static
28
- * @param {string} string
29
- * @returns {boolean}
17
+ * Checks if a given string is valid.
18
+ * @param {string} string - The string to check.
19
+ * @returns {boolean} - True if the string is valid, false otherwise.
30
20
  */
31
21
  Utils.isValidString = function (string) {
32
22
  return (string === null || string === void 0 ? void 0 : string.length) > 0 && !Array.isArray(string);
33
23
  };
34
24
  /**
35
- * ${1:Description placeholder}
36
- *
37
- * @public
38
- * @static
39
- * @param {string} string
40
- * @returns {(number | null)}
25
+ * Parses a string into an integer and returns null if the string is not a valid number.
26
+ * @param {string} string - The string to parse into an integer.
27
+ * @returns {number | null} - The parsed integer or null if the string is not a valid number.
41
28
  */
42
29
  Utils.parseIntNullIfNaN = function (string) {
43
30
  var n = parseInt(string);
44
31
  return isNaN(n) ? null : n;
45
32
  };
46
33
  /**
47
- * ${1:Description placeholder}
48
- *
49
- * @public
50
- * @static
51
- * @param {string} string
52
- * @returns {(any | null)}
34
+ * Parses a JSON string and returns the resulting object. If the string is empty or
35
+ * cannot be parsed, null is returned.
36
+ * @param {string} string - The JSON string to parse.
37
+ * @returns {any | null} - The parsed object or null if the string is empty or invalid.
53
38
  */
54
39
  Utils.parseObjectNullIfEmpty = function (string) {
55
40
  var o = null;
56
41
  try {
57
- o = JSON.parse(string);
58
- if (Object.keys(o).length <= 0)
42
+ o = string ? JSON.parse(string) : null;
43
+ if (o && Object.keys(o).length <= 0)
59
44
  o = null;
60
45
  }
61
46
  catch (e) {
@@ -64,12 +49,9 @@ var Utils = /** @class */ (function () {
64
49
  return o;
65
50
  };
66
51
  /**
67
- * ${1:Description placeholder}
68
- *
69
- * @public
70
- * @static
71
- * @param {string} number
72
- * @returns {boolean}
52
+ * Checks if a given value is a valid number.
53
+ * @param {string} number - The value to be checked.
54
+ * @returns {boolean} - True if the value is a valid number, false otherwise.
73
55
  */
74
56
  Utils.isValidNumber = function (number) {
75
57
  var validNumb = NaN;
@@ -82,13 +64,10 @@ var Utils = /** @class */ (function () {
82
64
  return !isNaN(validNumb) && !Array.isArray(number);
83
65
  };
84
66
  /**
85
- * ${1:Description placeholder}
86
- *
87
- * @public
88
- * @static
89
- * @param {*} obj
90
- * @param {string} key
91
- * @returns {(any | null)}
67
+ * Retrieves the value from an object using a case-insensitive key lookup.
68
+ * @param {any} obj - The object to search for the key.
69
+ * @param {string} key - The key to search for in the object.
70
+ * @returns {any | null} The value associated with the key, or null if the key is not found.
92
71
  */
93
72
  Utils.caseInsensitiveObjectForKey = function (obj, key) {
94
73
  if (!obj)
@@ -1 +1 @@
1
- {"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/API/Utils.ts"],"names":[],"mappings":";;AAAA;;;;;;GAMG;AACH;IAAA;IAoFA,CAAC;IAnFC;;;;;;OAMG;IACW,2BAAqB,GAAnC;QACE,OAAO,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,MAAM,CAAA;IACjD,CAAC;IACD;;;;;;;OAOG;IACW,mBAAa,GAA3B,UAA4B,MAAc;QACxC,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,IAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACrD,CAAC;IACD;;;;;;;OAOG;IACW,uBAAiB,GAA/B,UAAgC,MAAc;QAC5C,IAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;QAC1B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAC5B,CAAC;IACD;;;;;;;OAOG;IACW,4BAAsB,GAApC,UAAqC,MAAc;QACjD,IAAI,CAAC,GAAG,IAAI,CAAA;QACZ,IAAI;YACF,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YACtB,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC;gBAAE,CAAC,GAAG,IAAI,CAAA;SACzC;QAAC,OAAO,CAAC,EAAE;YACV,WAAW;SACZ;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IACD;;;;;;;OAOG;IACW,mBAAa,GAA3B,UAA4B,MAAc;QACxC,IAAI,SAAS,GAAG,GAAG,CAAA;QACnB,IAAI;YACF,SAAS,GAAG,QAAQ,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;SAClC;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAA;SAClD;QACD,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACpD,CAAC;IACD;;;;;;;;OAQG;IACW,iCAA2B,GAAzC,UAA0C,GAAQ,EAAE,GAAW;QAC7D,IAAI,CAAC,GAAG;YAAE,OAAO,IAAI,CAAA;QACrB,IAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,EAArC,CAAqC,CAAC,CAAA;QACxF,IAAI,cAAc,IAAI,cAAc,IAAI,EAAE;YAAE,OAAO,GAAG,CAAC,cAAc,CAAC,CAAA;QACtE,OAAO,IAAI,CAAA;IACb,CAAC;IACH,YAAC;AAAD,CAAC,AApFD,IAoFC"}
1
+ {"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/API/Utils.ts"],"names":[],"mappings":";;AAAA;;GAEG;AACH;IAAA;IAwEA,CAAC;IAvEC;;;OAGG;IACW,2BAAqB,GAAnC;QACE,OAAO,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,MAAM,CAAA;IACjD,CAAC;IAED;;;;OAIG;IACW,mBAAa,GAA3B,UAA4B,MAAc;QACxC,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,IAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACrD,CAAC;IAED;;;;OAIG;IACW,uBAAiB,GAA/B,UAAgC,MAAc;QAC5C,IAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;QAC1B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;IAC5B,CAAC;IAED;;;;;OAKG;IACW,4BAAsB,GAApC,UAAqC,MAA0B;QAC7D,IAAI,CAAC,GAAG,IAAI,CAAA;QACZ,IAAI;YACF,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YACtC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC;gBAAE,CAAC,GAAG,IAAI,CAAA;SAC9C;QAAC,OAAO,CAAC,EAAE;YACV,WAAW;SACZ;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED;;;;OAIG;IACW,mBAAa,GAA3B,UAA4B,MAAc;QACxC,IAAI,SAAS,GAAG,GAAG,CAAA;QACnB,IAAI;YACF,SAAS,GAAG,QAAQ,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;SAClC;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAA;SAClD;QACD,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACpD,CAAC;IAED;;;;;OAKG;IACW,iCAA2B,GAAzC,UAA0C,GAAQ,EAAE,GAAW;QAC7D,IAAI,CAAC,GAAG;YAAE,OAAO,IAAI,CAAA;QACrB,IAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,EAArC,CAAqC,CAAC,CAAA;QACxF,IAAI,cAAc,IAAI,cAAc,IAAI,EAAE;YAAE,OAAO,GAAG,CAAC,cAAc,CAAC,CAAA;QACtE,OAAO,IAAI,CAAA;IACb,CAAC;IACH,YAAC;AAAD,CAAC,AAxED,IAwEC"}