@pallasoft/ps-utilities 2.14.0 → 2.15.0

package/dist/client/http-service.js

@@ -37,6 +37,9 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpService = void 0;
+var http_content_type_1 = require("../common/constants/http-content-type");
+var http_header_1 = require("../common/constants/http-header");
+var http_method_1 = require("../common/constants/http-method");
 var isBinaryBody = function (data) {
     return data instanceof FormData ||
         data instanceof Blob ||
@@ -49,17 +52,18 @@ var HttpService = /** @class */ (function () {
     HttpService.createApiClient = function (options) {
         var _this = this;
         if (options === void 0) { options = {}; }
-        var apiKey = options.apiKey, _a = options.apiKeyHeader, apiKeyHeader = _a === void 0 ? 'X-API-Key' : _a, baseURL = options.baseURL, defaultHeaders = options.headers;
+        var apiKey = options.apiKey, _a = options.apiKeyHeader, apiKeyHeader = _a === void 0 ? http_header_1.HttpHeader.apiKey : _a, baseURL = options.baseURL, defaultHeaders = options.headers;
         var request = function (method, url, data, config) { return __awaiter(_this, void 0, void 0, function () {
             var fullUrl, sendsBinaryBody, headers, body, response, responseData, error;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         fullUrl = baseURL ? "".concat(baseURL).concat(url) : url;
                         sendsBinaryBody = isBinaryBody(data);
                         headers = sendsBinaryBody
                             ? {}
-                            : { 'Content-Type': 'application/json' };
+                            : (_a = {}, _a[http_header_1.HttpHeader.contentType] = http_content_type_1.HttpContentType.json, _a);
                         if (defaultHeaders)
                             Object.assign(headers, defaultHeaders);
                         if (apiKey)
@@ -69,18 +73,18 @@ var HttpService = /** @class */ (function () {
                         body = data === undefined ? undefined : sendsBinaryBody ? data : JSON.stringify(data);
                         return [4 /*yield*/, fetch(fullUrl, { method: method, headers: headers, body: body })];
                     case 1:
-                        response = _a.sent();
+                        response = _b.sent();
                         return [4 /*yield*/, ((config === null || config === void 0 ? void 0 : config.responseType) === 'arraybuffer'
                                 ? response.arrayBuffer()
                                 : (config === null || config === void 0 ? void 0 : config.responseType) === 'text'
                                     ? response.text()
                                     : (config === null || config === void 0 ? void 0 : config.responseType) === 'json'
                                         ? response.json()
-                                        : String(response.headers.get('content-type')).includes('application/json')
+                                        : String(response.headers.get(http_header_1.HttpHeader.contentType)).includes(http_content_type_1.HttpContentType.json)
                                             ? response.json()
                                             : response.text())];
                     case 2:
-                        responseData = _a.sent();
+                        responseData = _b.sent();
                         if (!response.ok) {
                             error = new Error("Request failed with status ".concat(response.status));
                             error.response = { data: responseData, status: response.status };
@@ -92,19 +96,19 @@ var HttpService = /** @class */ (function () {
         }); };
         return {
             get: function (url, config) {
-                return request('GET', url, undefined, config);
+                return request(http_method_1.HttpMethod.Get, url, undefined, config);
             },
             post: function (url, data, config) {
-                return request('POST', url, data, config);
+                return request(http_method_1.HttpMethod.Post, url, data, config);
             },
             put: function (url, data, config) {
-                return request('PUT', url, data, config);
+                return request(http_method_1.HttpMethod.Put, url, data, config);
             },
             patch: function (url, data, config) {
-                return request('PATCH', url, data, config);
+                return request(http_method_1.HttpMethod.Patch, url, data, config);
             },
             delete: function (url, config) {
-                return request('DELETE', url, undefined, config);
+                return request(http_method_1.HttpMethod.Delete, url, undefined, config);
             },
         };
     };

package/dist/common/constants/http-content-type.d.ts

@@ -0,0 +1,8 @@
+export declare const HttpContentType: {
+    readonly formUrlEncoded: "application/x-www-form-urlencoded";
+    readonly html: "text/html";
+    readonly json: "application/json";
+    readonly multipartFormData: "multipart/form-data";
+    readonly octetStream: "application/octet-stream";
+    readonly plainText: "text/plain";
+};

package/dist/common/constants/http-content-type.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpContentType = void 0;
+exports.HttpContentType = {
+    formUrlEncoded: 'application/x-www-form-urlencoded',
+    html: 'text/html',
+    json: 'application/json',
+    multipartFormData: 'multipart/form-data',
+    octetStream: 'application/octet-stream',
+    plainText: 'text/plain',
+};

package/dist/common/constants/http-header.d.ts

@@ -0,0 +1,20 @@
+export declare const HttpHeader: {
+    readonly accept: "Accept";
+    readonly apiKey: "X-API-Key";
+    readonly authorization: "Authorization";
+    readonly cacheControl: "Cache-Control";
+    readonly cfConnectingIp: "CF-Connecting-IP";
+    readonly contentDisposition: "Content-Disposition";
+    readonly contentSecurityPolicy: "Content-Security-Policy";
+    readonly contentType: "Content-Type";
+    readonly contentTypeOptions: "X-Content-Type-Options";
+    readonly cookie: "Cookie";
+    readonly forwardedFor: "X-Forwarded-For";
+    readonly frameOptions: "X-Frame-Options";
+    readonly location: "Location";
+    readonly realIp: "X-Real-IP";
+    readonly robotsTag: "X-Robots-Tag";
+    readonly setCookie: "Set-Cookie";
+    readonly strictTransportSecurity: "Strict-Transport-Security";
+    readonly userAgent: "User-Agent";
+};

package/dist/common/constants/http-header.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpHeader = void 0;
+exports.HttpHeader = {
+    accept: 'Accept',
+    apiKey: 'X-API-Key',
+    authorization: 'Authorization',
+    cacheControl: 'Cache-Control',
+    cfConnectingIp: 'CF-Connecting-IP',
+    contentDisposition: 'Content-Disposition',
+    contentSecurityPolicy: 'Content-Security-Policy',
+    contentType: 'Content-Type',
+    contentTypeOptions: 'X-Content-Type-Options',
+    cookie: 'Cookie',
+    forwardedFor: 'X-Forwarded-For',
+    frameOptions: 'X-Frame-Options',
+    location: 'Location',
+    realIp: 'X-Real-IP',
+    robotsTag: 'X-Robots-Tag',
+    setCookie: 'Set-Cookie',
+    strictTransportSecurity: 'Strict-Transport-Security',
+    userAgent: 'User-Agent',
+};

package/dist/common/constants/http-method.d.ts

@@ -0,0 +1,9 @@
+export declare enum HttpMethod {
+    Delete = "DELETE",
+    Get = "GET",
+    Head = "HEAD",
+    Options = "OPTIONS",
+    Patch = "PATCH",
+    Post = "POST",
+    Put = "PUT"
+}

package/dist/common/constants/http-method.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpMethod = void 0;
+var HttpMethod;
+(function (HttpMethod) {
+    HttpMethod["Delete"] = "DELETE";
+    HttpMethod["Get"] = "GET";
+    HttpMethod["Head"] = "HEAD";
+    HttpMethod["Options"] = "OPTIONS";
+    HttpMethod["Patch"] = "PATCH";
+    HttpMethod["Post"] = "POST";
+    HttpMethod["Put"] = "PUT";
+})(HttpMethod || (exports.HttpMethod = HttpMethod = {}));

package/dist/common/constants/index.d.ts

@@ -10,3 +10,8 @@ export * from './socket-token-config';
 export * from './user-agent-config';
 export * from './amount-direction';
 export * from './error-response-config';
+export * from './http-content-type';
+export * from './http-header';
+export * from './http-method';
+export * from './relative-time-config';
+export * from './request-client-config';

package/dist/common/constants/index.js

@@ -26,3 +26,8 @@ __exportStar(require("./socket-token-config"), exports);
 __exportStar(require("./user-agent-config"), exports);
 __exportStar(require("./amount-direction"), exports);
 __exportStar(require("./error-response-config"), exports);
+__exportStar(require("./http-content-type"), exports);
+__exportStar(require("./http-header"), exports);
+__exportStar(require("./http-method"), exports);
+__exportStar(require("./relative-time-config"), exports);
+__exportStar(require("./request-client-config"), exports);

package/dist/common/constants/relative-time-config.d.ts

@@ -0,0 +1,21 @@
+export declare const RelativeTimeConfig: {
+    readonly futureToleranceSeconds: 300;
+    readonly justNowSeconds: 45;
+    readonly millisecondsPerSecond: 1000;
+    readonly format: {
+        readonly numeric: "auto";
+    };
+    readonly units: readonly [{
+        readonly limitSeconds: 3600;
+        readonly seconds: 60;
+        readonly unit: "minute";
+    }, {
+        readonly limitSeconds: 86400;
+        readonly seconds: 3600;
+        readonly unit: "hour";
+    }, {
+        readonly limitSeconds: 604800;
+        readonly seconds: 86400;
+        readonly unit: "day";
+    }];
+};

package/dist/common/constants/relative-time-config.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelativeTimeConfig = void 0;
+exports.RelativeTimeConfig = {
+    futureToleranceSeconds: 300,
+    justNowSeconds: 45,
+    millisecondsPerSecond: 1000,
+    format: { numeric: 'auto' },
+    units: [
+        { limitSeconds: 3600, seconds: 60, unit: 'minute' },
+        { limitSeconds: 86400, seconds: 3600, unit: 'hour' },
+        { limitSeconds: 604800, seconds: 86400, unit: 'day' },
+    ],
+};

package/dist/common/constants/request-client-config.d.ts

@@ -0,0 +1,5 @@
+export declare const RequestClientConfig: {
+    readonly addressHeaders: readonly ["CF-Connecting-IP", "X-Real-IP", "X-Forwarded-For"];
+    readonly agentHeader: "User-Agent";
+    readonly listSeparator: ",";
+};

package/dist/common/constants/request-client-config.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestClientConfig = void 0;
+var http_header_1 = require("./http-header");
+exports.RequestClientConfig = {
+    addressHeaders: [http_header_1.HttpHeader.cfConnectingIp, http_header_1.HttpHeader.realIp, http_header_1.HttpHeader.forwardedFor],
+    agentHeader: http_header_1.HttpHeader.userAgent,
+    listSeparator: ',',
+};

package/dist/common/date-service.d.ts

@@ -19,4 +19,7 @@ export declare class DateService {
     static nowUnixSeconds(): number;
     static fromParts(year: number, monthIndex: number, day: number): Dayjs;
     static isValid(date: string | number): boolean;
+    static addDays(date: string, days: number): string;
+    static addDaysToInstant(instant: Date, days: number): Date;
+    static startOfUtcDay(instant: Date): Date;
 }

package/dist/common/date-service.js

@@ -97,6 +97,15 @@ var DateService = /** @class */ (function () {
     DateService.isValid = function (date) {
         return (0, dayjs_1.default)(date).isValid();
     };
+    DateService.addDays = function (date, days) {
+        return dayjs_1.default.utc(date).add(days, 'day').format('YYYY-MM-DD');
+    };
+    DateService.addDaysToInstant = function (instant, days) {
+        return dayjs_1.default.utc(instant).add(days, 'day').toDate();
+    };
+    DateService.startOfUtcDay = function (instant) {
+        return dayjs_1.default.utc(instant).startOf('day').toDate();
+    };
     return DateService;
 }());
 exports.DateService = DateService;

package/dist/common/error-response-service.d.ts

@@ -1,4 +1,6 @@
+import type { CodedErrorData } from '../models/coded-error-data';
 export declare class ErrorResponseService {
+    static create(message: string, code: number): CodedErrorData;
     static code(error: unknown): number | null;
     static isClientError(status: number): boolean;
     static pageContent<Content extends {

package/dist/common/error-response-service.js

@@ -16,6 +16,9 @@ var error_response_config_1 = require("./constants/error-response-config");
 var ErrorResponseService = /** @class */ (function () {
     function ErrorResponseService() {
     }
+    ErrorResponseService.create = function (message, code) {
+        return Object.assign(new Error(message), { code: code });
+    };
     ErrorResponseService.code = function (error) {
         if (typeof error !== 'object' || error === null || !('code' in error))
             return null;

package/dist/common/index.d.ts

@@ -20,3 +20,6 @@ export * from './user-agent-service';
 export * from './user-token-service';
 export * from './validation-service';
 export * from './error-response-service';
+export * from './relative-time-service';
+export * from './request-client-service';
+export * from './json-service';

package/dist/common/index.js

@@ -36,3 +36,6 @@ __exportStar(require("./user-agent-service"), exports);
 __exportStar(require("./user-token-service"), exports);
 __exportStar(require("./validation-service"), exports);
 __exportStar(require("./error-response-service"), exports);
+__exportStar(require("./relative-time-service"), exports);
+__exportStar(require("./request-client-service"), exports);
+__exportStar(require("./json-service"), exports);

package/dist/common/json-service.d.ts

@@ -0,0 +1,5 @@
+import type { JsonValueGuard } from '../models/json-value-guard';
+export declare class JsonService {
+    static read(text: string | null | undefined): unknown;
+    static parse<Value>(text: string | null | undefined, guard: JsonValueGuard<Value>): Value | null;
+}

package/dist/common/json-service.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonService = void 0;
+var JsonService = /** @class */ (function () {
+    function JsonService() {
+    }
+    JsonService.read = function (text) {
+        if (typeof text !== 'string')
+            return undefined;
+        try {
+            return JSON.parse(text);
+        }
+        catch (_a) {
+            return undefined;
+        }
+    };
+    JsonService.parse = function (text, guard) {
+        var value = this.read(text);
+        return value !== undefined && guard(value) ? value : null;
+    };
+    return JsonService;
+}());
+exports.JsonService = JsonService;

package/dist/common/relative-time-service.d.ts

@@ -0,0 +1,4 @@
+import type { RelativeTimeOptions } from '../models/relative-time-options';
+export declare class RelativeTimeService {
+    static format(value: string, now: Date, options: RelativeTimeOptions): string;
+}

package/dist/common/relative-time-service.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelativeTimeService = void 0;
+var relative_time_config_1 = require("./constants/relative-time-config");
+var date_service_1 = require("./date-service");
+var RelativeTimeService = /** @class */ (function () {
+    function RelativeTimeService() {
+    }
+    RelativeTimeService.format = function (value, now, options) {
+        if (!date_service_1.DateService.isValid(value))
+            return value;
+        var seconds = (now.getTime() - date_service_1.DateService.getDate(value).valueOf()) /
+            relative_time_config_1.RelativeTimeConfig.millisecondsPerSecond;
+        if (seconds < -relative_time_config_1.RelativeTimeConfig.futureToleranceSeconds)
+            return options.formatDate(value);
+        if (seconds < relative_time_config_1.RelativeTimeConfig.justNowSeconds)
+            return options.justNow;
+        var step = relative_time_config_1.RelativeTimeConfig.units.find(function (unit) { return seconds < unit.limitSeconds; });
+        return step === undefined
+            ? options.formatDate(value)
+            : new Intl.RelativeTimeFormat(options.locale, relative_time_config_1.RelativeTimeConfig.format).format(-Math.max(1, Math.round(seconds / step.seconds)), step.unit);
+    };
+    return RelativeTimeService;
+}());
+exports.RelativeTimeService = RelativeTimeService;

package/dist/common/request-client-service.d.ts

@@ -0,0 +1,6 @@
+import type { RequestClientData } from '../models/request-client-data';
+import type { RequestClientOptions } from '../models/request-client-options';
+export declare class RequestClientService {
+    static from(headers: Headers, options?: RequestClientOptions): RequestClientData;
+    private static _limit;
+}

package/dist/common/request-client-service.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestClientService = void 0;
+var request_client_config_1 = require("./constants/request-client-config");
+var RequestClientService = /** @class */ (function () {
+    function RequestClientService() {
+    }
+    RequestClientService.from = function (headers, options) {
+        if (options === void 0) { options = {}; }
+        var address = request_client_config_1.RequestClientConfig.addressHeaders
+            .map(function (name) { return headers.get(name); })
+            .find(function (value) { return value !== null && value.trim() !== ''; });
+        var agent = headers.get(request_client_config_1.RequestClientConfig.agentHeader);
+        return {
+            ipAddress: address === undefined
+                ? null
+                : this._limit(address.split(request_client_config_1.RequestClientConfig.listSeparator)[0].trim(), options.ipAddressMaxLength),
+            userAgent: agent === null || agent.trim() === ''
+                ? null
+                : this._limit(agent.trim(), options.userAgentMaxLength),
+        };
+    };
+    RequestClientService._limit = function (value, maxLength) {
+        return typeof maxLength === 'number' ? value.slice(0, maxLength) : value;
+    };
+    return RequestClientService;
+}());
+exports.RequestClientService = RequestClientService;

package/dist/index.d.ts

@@ -3,8 +3,11 @@ import * as CommonNamespace from './common';
 export declare const Common: typeof CommonNamespace;
 export declare const Client: typeof ClientNamespace;
 export { AmountDirection } from './common/constants/amount-direction';
+export { HttpMethod } from './common/constants/http-method';
+export type { CodedErrorData } from './models/coded-error-data';
 export type { DeviceData } from './models/device-data';
 export type { EmailPreviewInput } from './models/email-preview-input';
+export type { JsonValueGuard } from './models/json-value-guard';
 export type { SignedTokenHeader } from './models/signed-token-header';
 export type { SignedTokenKeyPair } from './models/signed-token-key-pair';
 export type { SocketTokenClaims } from './models/socket-token-claims';
@@ -18,3 +21,6 @@ export type { DataKeyPair } from './common/envelope-crypto-service';
 export type { PhoneCountryData } from './models/phone-country-data';
 export type { PhoneDisplayData } from './models/phone-display-data';
 export type { PostalCodeFormatData } from './models/postal-code-format-data';
+export type { RelativeTimeOptions } from './models/relative-time-options';
+export type { RequestClientData } from './models/request-client-data';
+export type { RequestClientOptions } from './models/request-client-options';

package/dist/index.js

@@ -33,10 +33,12 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AmountDirection = exports.Client = exports.Common = void 0;
+exports.HttpMethod = exports.AmountDirection = exports.Client = exports.Common = void 0;
 var ClientNamespace = __importStar(require("./client"));
 var CommonNamespace = __importStar(require("./common"));
 exports.Common = CommonNamespace;
 exports.Client = ClientNamespace;
 var amount_direction_1 = require("./common/constants/amount-direction");
 Object.defineProperty(exports, "AmountDirection", { enumerable: true, get: function () { return amount_direction_1.AmountDirection; } });
+var http_method_1 = require("./common/constants/http-method");
+Object.defineProperty(exports, "HttpMethod", { enumerable: true, get: function () { return http_method_1.HttpMethod; } });

package/dist/models/coded-error-data.d.ts

@@ -0,0 +1,3 @@
+export interface CodedErrorData extends Error {
+    code: number;
+}

package/dist/models/coded-error-data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/json-value-guard.d.ts

@@ -0,0 +1 @@
+export type JsonValueGuard<Value> = (value: unknown) => value is Value;

package/dist/models/json-value-guard.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/relative-time-options.d.ts

@@ -0,0 +1,5 @@
+export interface RelativeTimeOptions {
+    locale: string;
+    justNow: string;
+    formatDate: (value: string) => string;
+}

package/dist/models/relative-time-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/request-client-data.d.ts

@@ -0,0 +1,4 @@
+export interface RequestClientData {
+    ipAddress: string | null;
+    userAgent: string | null;
+}

package/dist/models/request-client-data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/request-client-options.d.ts

@@ -0,0 +1,4 @@
+export interface RequestClientOptions {
+    ipAddressMaxLength?: number;
+    userAgentMaxLength?: number;
+}

package/dist/models/request-client-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/server/index.d.ts

@@ -1 +1,2 @@
 export * from './file-service';
+export * from './timing-safe-service';

package/dist/server/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./file-service"), exports);
+__exportStar(require("./timing-safe-service"), exports);

package/dist/server/timing-safe-service.d.ts

@@ -0,0 +1,3 @@
+export declare class TimingSafeService {
+    static equals(candidate: string, secret: string): boolean;
+}

package/dist/server/timing-safe-service.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimingSafeService = void 0;
+var node_crypto_1 = require("node:crypto");
+var TimingSafeService = /** @class */ (function () {
+    function TimingSafeService() {
+    }
+    TimingSafeService.equals = function (candidate, secret) {
+        var candidateBytes = Buffer.from(candidate);
+        var secretBytes = Buffer.from(secret);
+        return (candidateBytes.length === secretBytes.length && (0, node_crypto_1.timingSafeEqual)(candidateBytes, secretBytes));
+    };
+    return TimingSafeService;
+}());
+exports.TimingSafeService = TimingSafeService;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pallasoft/ps-utilities",
-	"version": "2.14.0",
+	"version": "2.15.0",
 	"private": false,
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -39,7 +39,8 @@
 		"format:prettier": "npx prettier --write \"**/*.{js,ts,json,md}\"",
 		"lint:eslint": "npx eslint \"**/*.{js,ts}\"",
 		"lint:eslint:fix": "npx eslint --fix \"**/*.{js,ts}\"",
-		"release": "semantic-release"
+		"release": "semantic-release",
+		"test": "vitest run"
 	},
 	"devDependencies": {
 		"@commitlint/cli": "^20.1.0",
@@ -65,9 +66,10 @@
 		"lint-staged": "^16.2.7",
 		"prettier": "^3.6.2",
 		"semantic-release": "^24.2.0",
+		"socket.io-client": "^4.8.3",
 		"ts-node": "^10.9.2",
 		"typescript": "^5.9.3",
-		"socket.io-client": "^4.8.3"
+		"vitest": "^3.2.7"
 	},
 	"peerDependencies": {
 		"hono": "^4.0.0",