@pallasoft/ps-utilities 2.7.0 → 2.8.0

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

@@ -0,0 +1,5 @@
+export declare class AmountService {
+    static normalise(raw: string): string;
+    static toNumber(raw: string): number;
+    static isAmount(raw: string): boolean;
+}

package/dist/common/amount-service.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AmountService = void 0;
+var amount_config_1 = require("./constants/amount-config");
+var AmountService = /** @class */ (function () {
+    function AmountService() {
+    }
+    AmountService.normalise = function (raw) {
+        var trimmed = raw.trim();
+        var isBracketed = trimmed.startsWith(amount_config_1.AmountConfig.openBracket) && trimmed.endsWith(amount_config_1.AmountConfig.closeBracket);
+        var isNegative = isBracketed || trimmed.startsWith(amount_config_1.AmountConfig.minus);
+        var kept = trimmed.replace(amount_config_1.AmountConfig.disallowed, '');
+        var pointIndex = kept.indexOf(amount_config_1.AmountConfig.point);
+        var digits = pointIndex === -1
+            ? kept
+            : "".concat(kept.slice(0, pointIndex + 1)).concat(kept
+                .slice(pointIndex + 1)
+                .split(amount_config_1.AmountConfig.point)
+                .join(''));
+        if (digits === '')
+            return isNegative && !isBracketed ? amount_config_1.AmountConfig.minus : '';
+        return isNegative ? "".concat(amount_config_1.AmountConfig.minus).concat(digits) : digits;
+    };
+    AmountService.toNumber = function (raw) {
+        var normalised = AmountService.normalise(raw);
+        var parsed = Number(normalised);
+        return normalised === '' || !Number.isFinite(parsed) ? 0 : parsed;
+    };
+    AmountService.isAmount = function (raw) {
+        var normalised = AmountService.normalise(raw);
+        return (normalised !== '' && normalised !== amount_config_1.AmountConfig.minus && Number.isFinite(Number(normalised)));
+    };
+    return AmountService;
+}());
+exports.AmountService = AmountService;

package/dist/common/constants/amount-config.d.ts

@@ -0,0 +1,7 @@
+export declare const AmountConfig: {
+    readonly closeBracket: ")";
+    readonly disallowed: RegExp;
+    readonly minus: "-";
+    readonly openBracket: "(";
+    readonly point: ".";
+};

package/dist/common/constants/amount-config.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AmountConfig = void 0;
+exports.AmountConfig = {
+    closeBracket: ')',
+    disallowed: /[^0-9.]/g,
+    minus: '-',
+    openBracket: '(',
+    point: '.',
+};

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

@@ -1,3 +1,7 @@
+export * from './amount-config';
 export * from './email-preview-config';
+export * from './phone-config';
+export * from './postal-code-formats';
 export * from './signed-token-config';
 export * from './user-token-config';
+export * from './validation-config';

package/dist/common/constants/index.js

@@ -14,6 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./amount-config"), exports);
 __exportStar(require("./email-preview-config"), exports);
+__exportStar(require("./phone-config"), exports);
+__exportStar(require("./postal-code-formats"), exports);
 __exportStar(require("./signed-token-config"), exports);
 __exportStar(require("./user-token-config"), exports);
+__exportStar(require("./validation-config"), exports);

package/dist/common/constants/phone-config.d.ts

@@ -0,0 +1,6 @@
+export declare const PhoneConfig: {
+    readonly defaultCountry: "CA";
+    readonly displayNamesType: "region";
+    readonly locale: "en";
+    readonly plus: "+";
+};

package/dist/common/constants/phone-config.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhoneConfig = void 0;
+exports.PhoneConfig = {
+    defaultCountry: 'CA',
+    displayNamesType: 'region',
+    locale: 'en',
+    plus: '+',
+};

package/dist/common/constants/postal-code-formats.d.ts

@@ -0,0 +1,5 @@
+import type { PostalCodeFormatData } from '../../models/postal-code-format-data';
+export declare const PostalCodeFormats: Record<string, PostalCodeFormatData>;
+export declare const PostalCodeConfig: {
+    readonly fallbackAllowed: RegExp;
+};

package/dist/common/constants/postal-code-formats.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostalCodeConfig = exports.PostalCodeFormats = void 0;
+exports.PostalCodeFormats = {
+    CA: { allowed: /[^A-Z0-9]/g, groups: [3, 3], separator: ' ' },
+    GB: { allowed: /[^A-Z0-9]/g, groups: [], separator: ' ' },
+    IN: { allowed: /[^0-9]/g, groups: [6], separator: '' },
+    NL: { allowed: /[^A-Z0-9]/g, groups: [4, 2], separator: ' ' },
+    US: { allowed: /[^0-9]/g, groups: [5, 4], separator: '-' },
+};
+exports.PostalCodeConfig = {
+    fallbackAllowed: /[^A-Z0-9 -]/g,
+};

package/dist/common/constants/validation-config.d.ts

@@ -0,0 +1,8 @@
+export declare const ValidationConfig: {
+    readonly email: RegExp;
+    readonly webProtocols: readonly ["http:", "https:"];
+    readonly hostSeparator: ".";
+    readonly urlProtocol: "https://";
+    readonly urlProtocolPattern: RegExp;
+    readonly uuid: RegExp;
+};

package/dist/common/constants/validation-config.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationConfig = void 0;
+exports.ValidationConfig = {
+    email: /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/,
+    webProtocols: ['http:', 'https:'],
+    hostSeparator: '.',
+    urlProtocol: 'https://',
+    urlProtocolPattern: /^[a-z][a-z0-9+.-]*:\/\//i,
+    uuid: /^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i,
+};

package/dist/common/index.d.ts

@@ -1,14 +1,18 @@
+export * from './amount-service';
 export * from './color-service';
 export * from './constants';
 export * from './crypto-service';
+export * from './date-service';
 export * from './email-preview-service';
 export * from './encrypted-fields-service';
 export * from './envelope-crypto-service';
-export * from './date-service';
 export * from './number-format-service';
+export * from './phone-service';
+export * from './postal-code-service';
 export * from './recaptcha-service';
 export * from './signed-token-service';
-export * from './url-service';
 export * from './string-service';
 export * from './transform-service';
+export * from './url-service';
 export * from './user-token-service';
+export * from './validation-service';

package/dist/common/index.js

@@ -14,17 +14,21 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./amount-service"), exports);
 __exportStar(require("./color-service"), exports);
 __exportStar(require("./constants"), exports);
 __exportStar(require("./crypto-service"), exports);
+__exportStar(require("./date-service"), exports);
 __exportStar(require("./email-preview-service"), exports);
 __exportStar(require("./encrypted-fields-service"), exports);
 __exportStar(require("./envelope-crypto-service"), exports);
-__exportStar(require("./date-service"), exports);
 __exportStar(require("./number-format-service"), exports);
+__exportStar(require("./phone-service"), exports);
+__exportStar(require("./postal-code-service"), exports);
 __exportStar(require("./recaptcha-service"), exports);
 __exportStar(require("./signed-token-service"), exports);
-__exportStar(require("./url-service"), exports);
 __exportStar(require("./string-service"), exports);
 __exportStar(require("./transform-service"), exports);
+__exportStar(require("./url-service"), exports);
 __exportStar(require("./user-token-service"), exports);
+__exportStar(require("./validation-service"), exports);

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

@@ -0,0 +1,14 @@
+import { type CountryCode } from 'libphonenumber-js';
+import type { PhoneCountryData } from '../models/phone-country-data';
+import type { PhoneDisplayData } from '../models/phone-display-data';
+export declare class PhoneService {
+    static isCountry(code: string): code is CountryCode;
+    static countries(preferred: string, locale?: string): PhoneCountryData[];
+    static display(value: string, fallbackCountry: string): PhoneDisplayData;
+    static format(national: string, country: string): string;
+    static formatForDisplay(value: string, country: string): string;
+    static toStored(national: string, country: string): string;
+    static isValid(national: string, country: string): boolean;
+    static callingCode(country: string): string;
+    private static parse;
+}

package/dist/common/phone-service.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhoneService = void 0;
+var libphonenumber_js_1 = require("libphonenumber-js");
+var phone_config_1 = require("./constants/phone-config");
+var PhoneService = /** @class */ (function () {
+    function PhoneService() {
+    }
+    PhoneService.isCountry = function (code) {
+        return (0, libphonenumber_js_1.getCountries)().includes(code);
+    };
+    PhoneService.countries = function (preferred, locale) {
+        if (locale === void 0) { locale = phone_config_1.PhoneConfig.locale; }
+        var names = new Intl.DisplayNames([locale], { type: phone_config_1.PhoneConfig.displayNamesType });
+        var options = (0, libphonenumber_js_1.getCountries)().map(function (code) {
+            var name = names.of(code);
+            return {
+                callingCode: (0, libphonenumber_js_1.getCountryCallingCode)(code),
+                code: code,
+                label: name !== undefined ? name : code,
+            };
+        });
+        return options.sort(function (left, right) {
+            if (left.code === preferred)
+                return -1;
+            if (right.code === preferred)
+                return 1;
+            return left.label.localeCompare(right.label);
+        });
+    };
+    PhoneService.display = function (value, fallbackCountry) {
+        var parsed = value.startsWith(phone_config_1.PhoneConfig.plus)
+            ? (0, libphonenumber_js_1.parsePhoneNumberFromString)(value)
+            : undefined;
+        if (parsed !== undefined && parsed.country !== undefined)
+            return { country: parsed.country, national: parsed.formatNational() };
+        return { country: fallbackCountry, national: value };
+    };
+    PhoneService.format = function (national, country) {
+        if (!PhoneService.isCountry(country))
+            return national;
+        return new libphonenumber_js_1.AsYouType(country).input(national);
+    };
+    PhoneService.formatForDisplay = function (value, country) {
+        var parsed = PhoneService.parse(value, country);
+        if (parsed === undefined || !parsed.isValid())
+            return value.trim();
+        return parsed.country === country ? parsed.formatNational() : parsed.formatInternational();
+    };
+    PhoneService.toStored = function (national, country) {
+        var trimmed = national.trim();
+        if (trimmed === '' || !PhoneService.isCountry(country))
+            return trimmed;
+        var parsed = (0, libphonenumber_js_1.parsePhoneNumberFromString)(trimmed, country);
+        return parsed !== undefined ? parsed.number : trimmed;
+    };
+    PhoneService.isValid = function (national, country) {
+        if (national.trim() === '')
+            return true;
+        var parsed = PhoneService.parse(national, country);
+        return parsed !== undefined && parsed.isValid();
+    };
+    PhoneService.callingCode = function (country) {
+        return PhoneService.isCountry(country) ? (0, libphonenumber_js_1.getCountryCallingCode)(country) : '';
+    };
+    PhoneService.parse = function (value, country) {
+        var trimmed = value.trim();
+        if (trimmed === '')
+            return undefined;
+        if (trimmed.startsWith(phone_config_1.PhoneConfig.plus))
+            return (0, libphonenumber_js_1.parsePhoneNumberFromString)(trimmed);
+        return PhoneService.isCountry(country)
+            ? (0, libphonenumber_js_1.parsePhoneNumberFromString)(trimmed, country)
+            : undefined;
+    };
+    return PhoneService;
+}());
+exports.PhoneService = PhoneService;

package/dist/common/postal-code-service.d.ts

@@ -0,0 +1,5 @@
+export declare class PostalCodeService {
+    static format(raw: string, country: string): string;
+    static maxLength(country: string): number | undefined;
+    static isValid(raw: string, country: string): boolean;
+}

package/dist/common/postal-code-service.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostalCodeService = void 0;
+var postal_code_formats_1 = require("./constants/postal-code-formats");
+var PostalCodeService = /** @class */ (function () {
+    function PostalCodeService() {
+    }
+    PostalCodeService.format = function (raw, country) {
+        var upper = raw.toUpperCase();
+        var format = postal_code_formats_1.PostalCodeFormats[country];
+        if (format === undefined)
+            return upper.replace(postal_code_formats_1.PostalCodeConfig.fallbackAllowed, '');
+        var compact = upper.replace(format.allowed, '');
+        if (format.groups.length === 0)
+            return upper.replace(postal_code_formats_1.PostalCodeConfig.fallbackAllowed, '');
+        var parts = [];
+        var cursor = 0;
+        for (var _i = 0, _a = format.groups; _i < _a.length; _i++) {
+            var size = _a[_i];
+            if (cursor >= compact.length)
+                break;
+            parts.push(compact.slice(cursor, cursor + size));
+            cursor += size;
+        }
+        return parts.join(format.separator);
+    };
+    PostalCodeService.maxLength = function (country) {
+        var format = postal_code_formats_1.PostalCodeFormats[country];
+        if (format === undefined || format.groups.length === 0)
+            return undefined;
+        return (format.groups.reduce(function (sum, size) { return sum + size; }, 0) +
+            format.separator.length * (format.groups.length - 1));
+    };
+    PostalCodeService.isValid = function (raw, country) {
+        var format = postal_code_formats_1.PostalCodeFormats[country];
+        if (raw.trim() === '' || format === undefined || format.groups.length === 0)
+            return true;
+        return PostalCodeService.format(raw, country).length === PostalCodeService.maxLength(country);
+    };
+    return PostalCodeService;
+}());
+exports.PostalCodeService = PostalCodeService;

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

@@ -0,0 +1,7 @@
+export declare class ValidationService {
+    static isEmail(value: string): boolean;
+    static withProtocol(value: string): string;
+    static isWebUrl(value: string): boolean;
+    static isPhone(value: string, country: string): boolean;
+    static isUuid(value: string): boolean;
+}

package/dist/common/validation-service.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationService = void 0;
+var validation_config_1 = require("./constants/validation-config");
+var phone_service_1 = require("./phone-service");
+var ValidationService = /** @class */ (function () {
+    function ValidationService() {
+    }
+    ValidationService.isEmail = function (value) {
+        return validation_config_1.ValidationConfig.email.test(value.trim());
+    };
+    ValidationService.withProtocol = function (value) {
+        var trimmed = value.trim();
+        if (trimmed === '' || validation_config_1.ValidationConfig.urlProtocolPattern.test(trimmed))
+            return trimmed;
+        return "".concat(validation_config_1.ValidationConfig.urlProtocol).concat(trimmed);
+    };
+    ValidationService.isWebUrl = function (value) {
+        try {
+            var url_1 = new URL(ValidationService.withProtocol(value));
+            return (validation_config_1.ValidationConfig.webProtocols.some(function (protocol) { return protocol === url_1.protocol; }) &&
+                url_1.hostname.includes(validation_config_1.ValidationConfig.hostSeparator));
+        }
+        catch (_a) {
+            return false;
+        }
+    };
+    ValidationService.isPhone = function (value, country) {
+        return value.trim() !== '' && phone_service_1.PhoneService.isValid(value, country);
+    };
+    ValidationService.isUuid = function (value) {
+        return validation_config_1.ValidationConfig.uuid.test(value.trim());
+    };
+    return ValidationService;
+}());
+exports.ValidationService = ValidationService;

package/dist/index.d.ts

@@ -12,3 +12,6 @@ export type { UserTokenSubject } from './models/user-token-subject';
 export type { UserTokenVerifyOptions } from './models/user-token-verify-options';
 export type { EncryptedFieldsSpec } from './common/encrypted-fields-service';
 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';

package/dist/models/phone-country-data.d.ts

@@ -0,0 +1,5 @@
+export interface PhoneCountryData {
+    callingCode: string;
+    code: string;
+    label: string;
+}

package/dist/models/phone-country-data.js

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

package/dist/models/phone-display-data.d.ts

@@ -0,0 +1,4 @@
+export interface PhoneDisplayData {
+    country: string;
+    national: string;
+}

package/dist/models/phone-display-data.js

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

package/dist/models/postal-code-format-data.d.ts

@@ -0,0 +1,5 @@
+export interface PostalCodeFormatData {
+    allowed: RegExp;
+    groups: number[];
+    separator: string;
+}

package/dist/models/postal-code-format-data.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pallasoft/ps-utilities",
-	"version": "2.7.0",
+	"version": "2.8.0",
 	"private": false,
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -69,7 +69,8 @@
 	"dependencies": {
 		"@esbuild-plugins/tsconfig-paths": "^0.1.2",
 		"dayjs": "^1.11.19",
-		"esbuild": "^0.27.0"
+		"esbuild": "^0.27.0",
+		"libphonenumber-js": "^1.13.14"
 	},
 	"publishConfig": {
 		"access": "public",