@nascentdigital/funnel-core 4.4.4

package/dist/utils/StringUtils.d.ts

@@ -0,0 +1,10 @@
+export declare namespace StringUtils {
+    const vowels: ReadonlyArray<string>;
+    function firstChar(value: string): string | undefined;
+    function lastChar(value: string): string | undefined;
+    function filter(value: string, regex: RegExp): string;
+    function articleFor(value: string): "a" | "an";
+    function capitalize(value: string): string;
+    function toKebabCase(value: string): string;
+    function toSnakeCase(value: string): string;
+}

package/dist/utils/StringUtils.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringUtils = void 0;
+const to_space_case_1 = __importDefault(require("to-space-case"));
+// namespace
+var StringUtils;
+(function (StringUtils) {
+    // vowels
+    StringUtils.vowels = ['a', 'e', 'i', 'o', 'u'];
+    // helpers
+    function firstChar(value) {
+        return value.length > 0
+            ? value[0]
+            : undefined;
+    }
+    StringUtils.firstChar = firstChar;
+    function lastChar(value) {
+        return value.length > 0
+            ? value[value.length - 1]
+            : undefined;
+    }
+    StringUtils.lastChar = lastChar;
+    function filter(value, regex) {
+        return value
+            .matchAll(regex)
+            .reduce((newValue, [match]) => newValue + match, '');
+    }
+    StringUtils.filter = filter;
+    function articleFor(value) {
+        const [firstCharacter = ''] = value;
+        return StringUtils.vowels.includes(firstCharacter.toLowerCase()) ? 'an' : 'a';
+    }
+    StringUtils.articleFor = articleFor;
+    function capitalize(value) {
+        return value.length > 0
+            ? value[0].toUpperCase() + value.substring(1)
+            : value;
+    }
+    StringUtils.capitalize = capitalize;
+    function toKebabCase(value) {
+        return (0, to_space_case_1.default)(value).replace(/\s/g, '-');
+    }
+    StringUtils.toKebabCase = toKebabCase;
+    function toSnakeCase(value) {
+        return (0, to_space_case_1.default)(value).replace(/\s/g, '_');
+    }
+    StringUtils.toSnakeCase = toSnakeCase;
+})(StringUtils || (exports.StringUtils = StringUtils = {}));

package/dist/utils/UrlUtils.d.ts

@@ -0,0 +1,22 @@
+export declare namespace UrlUtils {
+    /**
+     * Create a URL object if provided url is parsable. This is replacement function for URL.parse() which is not
+     * supported in Safari 17 or lower.
+     *
+     * @param url A string or any other object with a stringifier that represents an absolute URL or a relative reference to a URL.
+     * @param base A string representing the base URL to use in cases where url is a relative URL. If not specified, it defaults to undefined.
+     */
+    function parse(url: string, base?: URL): URL | null;
+    function coerce(valueRaw: string, fallback?: string): string;
+    function parseMailto(mailto: string): {
+        email: string;
+        cc: string | undefined;
+        subject: string | undefined;
+        body: string | undefined;
+    };
+    function parseTel(tel: string): string;
+    function isRelativeUrl(url: string): boolean;
+    function normalizeBase(base: URL | string): string;
+    function normalizePath(path: string): string;
+    function concat(base: URL | string, path: string): string;
+}

package/dist/utils/UrlUtils.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UrlUtils = void 0;
+// namespace
+const errors_1 = require("../errors");
+const Value_1 = require("./Value");
+var UrlUtils;
+(function (UrlUtils) {
+    /**
+     * Create a URL object if provided url is parsable. This is replacement function for URL.parse() which is not
+     * supported in Safari 17 or lower.
+     *
+     * @param url A string or any other object with a stringifier that represents an absolute URL or a relative reference to a URL.
+     * @param base A string representing the base URL to use in cases where url is a relative URL. If not specified, it defaults to undefined.
+     */
+    function parse(url, base) {
+        // if the provided url can be parsed, then create a new URL object
+        if (URL.canParse(url, base)) {
+            return new URL(url, base);
+        }
+        // otherwise return null
+        return null;
+    }
+    UrlUtils.parse = parse;
+    function coerce(valueRaw, fallback) {
+        // keep it simple if the format's valid
+        const value = valueRaw.trim().toLocaleLowerCase();
+        const [valuePrefix] = value.split('?', 1);
+        let uri;
+        if (URL.canParse(value)) {
+            uri = new URL(value).href;
+        }
+        // or accept relative paths
+        else if (isRelativeUrl(value)) {
+            uri = value;
+        }
+        // or handle qualified mailto/tel links
+        else if (Value_1.Value.isEmailLink(value) || Value_1.Value.isPhoneNumberLink(value)) {
+            uri = value;
+        }
+        // or handle mailto links
+        else if (Value_1.Value.isEmail(valuePrefix)) {
+            uri = `mailto:${value}`;
+        }
+        // or handle tel links
+        else if (Value_1.Value.isPhoneNumber(value)) {
+            uri = `tel:${value}`;
+        }
+        // or formalize urls without prefix
+        else if (Value_1.Value.isUri(value)) {
+            uri = `https://${value}`;
+        }
+        // otherwise, return original
+        else {
+            uri = fallback !== null && fallback !== void 0 ? fallback : value;
+        }
+        // strip any trailing slash
+        if (uri.endsWith('/')) {
+            uri = uri.substring(0, uri.length - 1);
+        }
+        // return uri
+        return uri;
+    }
+    UrlUtils.coerce = coerce;
+    function parseMailto(mailto) {
+        var _a, _b, _c;
+        // throw if it's not a mailto link
+        const prefix = 'mailto:';
+        if (!mailto.startsWith(prefix)) {
+            throw new errors_1.ArgumentError(`Invalid "mailto:" link "${mailto}"`);
+        }
+        // split email/args
+        const [email, paramsRaw] = mailto.substring(prefix.length).split('?');
+        const params = new URLSearchParams(paramsRaw);
+        return {
+            email,
+            cc: (_a = params.get('cc')) !== null && _a !== void 0 ? _a : undefined,
+            subject: (_b = params.get('subject')) !== null && _b !== void 0 ? _b : undefined,
+            body: (_c = params.get('body')) !== null && _c !== void 0 ? _c : undefined
+        };
+    }
+    UrlUtils.parseMailto = parseMailto;
+    function parseTel(tel) {
+        // throw if it's not a tel link
+        const prefix = 'tel:';
+        if (!tel.startsWith(prefix)) {
+            throw new errors_1.ArgumentError(`Invalid "tel:" link "${tel}"`);
+        }
+        // return number
+        return tel.substring(prefix.length);
+    }
+    UrlUtils.parseTel = parseTel;
+    const relativeUrlRegex = /^(\/[\w\-._~:?#[\]@!$&'()*+,;=%]*)+$/;
+    function isRelativeUrl(url) {
+        return relativeUrlRegex.test(url);
+    }
+    UrlUtils.isRelativeUrl = isRelativeUrl;
+    function normalizeBase(base) {
+        const href = typeof base === 'string' ? base : base.href;
+        return href.endsWith('/')
+            ? href.substring(0, href.length - 1)
+            : href;
+    }
+    UrlUtils.normalizeBase = normalizeBase;
+    function normalizePath(path) {
+        return path.startsWith('/')
+            ? path.substring(1)
+            : path;
+    }
+    UrlUtils.normalizePath = normalizePath;
+    function concat(base, path) {
+        const prefix = normalizeBase(base);
+        const suffix = normalizePath(path);
+        return suffix.length > 0
+            ? prefix + '/' + suffix
+            : prefix;
+    }
+    UrlUtils.concat = concat;
+})(UrlUtils || (exports.UrlUtils = UrlUtils = {}));

package/dist/utils/Value.d.ts

@@ -0,0 +1,23 @@
+export declare namespace Value {
+    type TypeOf = 'undefined' | 'null' | 'boolean' | 'string' | 'number' | 'bigint' | 'symbol' | 'object' | 'array' | 'function';
+    function typeOf(value: any): TypeOf;
+    function parseString(value: any): string | undefined;
+    /**
+     * A deep comparison that support arrays, objects, or basic value types.
+     * @param lhs any value
+     * @param rhs another value
+     */
+    function equals(lhs: any, rhs: any): boolean;
+    function isDefined<T>(value: T | undefined | null): value is T;
+    function isObject(value: any): value is object;
+    function isDate(value: any): value is Date;
+    function isFormData(value: any): value is FormData;
+    function isPhoneNumberLink(value: string): boolean;
+    function isPhoneNumber(value: string): boolean;
+    function isEmailLink(value: string): boolean;
+    function isEmail(value: string): boolean;
+    function isUri(value: string): boolean;
+    const foreverPromise: Promise<unknown>;
+    function isPromise<T = any>(value: any): value is Promise<T>;
+    function uuid(): string;
+}

package/dist/utils/Value.js

@@ -0,0 +1,122 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Value = void 0;
+const fast_deep_equal_1 = __importDefault(require("fast-deep-equal"));
+const UUID = __importStar(require("uuid"));
+// namespace
+var Value;
+(function (Value) {
+    function typeOf(value) {
+        const rawType = typeof value;
+        switch (rawType) {
+            case 'object':
+                return value === null
+                    ? 'null'
+                    : Array.isArray(value)
+                        ? 'array'
+                        : 'object';
+            default:
+                return rawType;
+        }
+    }
+    Value.typeOf = typeOf;
+    function parseString(value) {
+        return typeOf(value) === 'string'
+            ? value
+            : undefined;
+    }
+    Value.parseString = parseString;
+    /**
+     * A deep comparison that support arrays, objects, or basic value types.
+     * @param lhs any value
+     * @param rhs another value
+     */
+    function equals(lhs, rhs) {
+        return (0, fast_deep_equal_1.default)(lhs, rhs);
+    }
+    Value.equals = equals;
+    // type guards
+    function isDefined(value) {
+        return value !== undefined && value !== null;
+    }
+    Value.isDefined = isDefined;
+    function isObject(value) {
+        return typeOf(value) === 'object';
+    }
+    Value.isObject = isObject;
+    function isDate(value) {
+        return value && Object.prototype.toString.call(value) === '[object Date]';
+    }
+    Value.isDate = isDate;
+    function isFormData(value) {
+        return value && Object.prototype.toString.call(value) === '[object FormData]';
+    }
+    Value.isFormData = isFormData;
+    function isPhoneNumberLink(value) {
+        return /^tel:(?=(?:\D*\d){7,15}\D*$)[\d\s+\-\\]+$/.test(value);
+    }
+    Value.isPhoneNumberLink = isPhoneNumberLink;
+    function isPhoneNumber(value) {
+        return /^(?=(?:\D*\d){7,15}\D*$)[\d\s+\-\\]+$/.test(value);
+    }
+    Value.isPhoneNumber = isPhoneNumber;
+    function isEmailLink(value) {
+        return /^mailto:[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}(\?subject=[\w\d%]+)?$/.test(value);
+    }
+    Value.isEmailLink = isEmailLink;
+    function isEmail(value) {
+        return /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/.test(value);
+    }
+    Value.isEmail = isEmail;
+    function isUri(value) {
+        return /^((https?:\/\/)?([\w-]+\.)+[\w-]+(\/[\w\-._~:/?#[\]@!$&'()*+,;=%]*)?)|(\/[\w\-._~:/?#[\]@!$&'()*+,;=%]*)$/.test(value);
+    }
+    Value.isUri = isUri;
+    Value.foreverPromise = new Promise(() => { });
+    function isPromise(value) {
+        return value
+            && 'then' in value
+            && typeof value.then === 'function';
+    }
+    Value.isPromise = isPromise;
+    function uuid() {
+        return UUID.v7();
+    }
+    Value.uuid = uuid;
+})(Value || (exports.Value = Value = {}));

package/dist/utils/index.d.ts

@@ -0,0 +1,12 @@
+export * from './ArrayUtils';
+export * from './ByteSize';
+export * from './DateUtils';
+export * from './Deferral';
+export * from './Duration';
+export * from './Fn';
+export * from './isDefined';
+export * from './ObjectUtils';
+export * from './Random';
+export * from './StringUtils';
+export * from './UrlUtils';
+export * from './Value';

package/dist/utils/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./ArrayUtils"), exports);
+__exportStar(require("./ByteSize"), exports);
+__exportStar(require("./DateUtils"), exports);
+__exportStar(require("./Deferral"), exports);
+__exportStar(require("./Duration"), exports);
+__exportStar(require("./Fn"), exports);
+__exportStar(require("./isDefined"), exports);
+__exportStar(require("./ObjectUtils"), exports);
+__exportStar(require("./Random"), exports);
+__exportStar(require("./StringUtils"), exports);
+__exportStar(require("./UrlUtils"), exports);
+__exportStar(require("./Value"), exports);

package/dist/utils/isDefined.d.ts

@@ -0,0 +1 @@
+export declare function isDefinedStrict<T>(value: T | null | undefined): value is T;

package/dist/utils/isDefined.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDefinedStrict = isDefinedStrict;
+function isDefinedStrict(value) {
+    return value !== undefined && value !== null;
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@nascentdigital/funnel-core",
+  "version": "4.4.4",
+  "repository": {
+    "url": "https://github.com/nascentdigital/funnel.git",
+    "directory": "libs/core"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "scripts": {
+    "build": "tsc -P tsconfig.build.json",
+    "clean": "rimraf -I dist",
+    "test": "jest"
+  },
+  "peerDependencies": {
+    "@lexical/extension": "0.37.0",
+    "@lexical/link": "0.37.0",
+    "@lexical/list": "0.37.0",
+    "@lexical/react": "0.37.0",
+    "@lexical/rich-text": "0.37.0",
+    "@lexical/selection": "0.37.0",
+    "lexical": "0.37.0"
+  },
+  "dependencies": {
+    "@nodable/flexible-xml-parser": "^1",
+    "blurhash": "^2",
+    "byte-size": "^9",
+    "clone-deep": "^4",
+    "css.escape": "^1",
+    "date-fns": "^4",
+    "date-fns-tz": "^3",
+    "fast-deep-equal": "^3",
+    "fast-xml-parser": "^5",
+    "lexorank": "^1.0.5",
+    "ms": "^3.0.0-canary.1",
+    "rxjs": "^7",
+    "seedrandom": "^3",
+    "to-space-case": "^1",
+    "uuid": "^11",
+    "zod": "^3"
+  },
+  "devDependencies": {
+    "@tsd/typescript": "^5.8.3",
+    "@types/byte-size": "^8",
+    "@types/clone-deep": "^4",
+    "@types/css.escape": "^1",
+    "@types/jest": "^29.5.14",
+    "@types/seedrandom": "^3",
+    "@types/to-space-case": "^1",
+    "jest": "^29.7.0",
+    "jest-tsd": "^0.2.2",
+    "ts-jest": "^29.3.2"
+  },
+  "gitHead": "debc0f359106c88e8444638236f7ed7a4f77ec5a"
+}