@keeex/utils 7.0.1

package/lib/types/predicateerror.js

@@ -0,0 +1,107 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ */
+const getErrorPath = ({ keyName, error, cause }) => {
+    const res = { key: keyName };
+    if (Array.isArray(cause)) {
+        res.cause = cause.map((singleCause) => getErrorPath({ cause: singleCause }));
+        // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    }
+    else if (cause instanceof PredicateError) {
+        res.cause = getErrorPath({
+            cause: cause.cause,
+            error: cause.error,
+            keyName: cause.keyName,
+        });
+    }
+    else if (error) {
+        res.cause = error;
+    }
+    else if (cause) {
+        res.cause = cause.message;
+    }
+    else {
+        res.cause = "<unknown error>";
+    }
+    return res;
+};
+const createMessage = ({ keyName, error, cause }) => {
+    const errorPath = getErrorPath({
+        cause,
+        error,
+        keyName,
+    });
+    return JSON.stringify(errorPath);
+};
+/**
+ * Construct an error whose message indicate what property failed to validate and why
+ *
+ * The static function provided will raise the appropriate error if the `raise` parameter is true,
+ * and do nothing otherwise.
+ *
+ * @internal
+ */
+export class PredicateError extends Error {
+    #keyName;
+    #error;
+    constructor(params) {
+        super(createMessage(params), { cause: params.cause });
+        this.#keyName = params.keyName;
+        this.#error = params.error;
+    }
+    get keyName() {
+        return this.#keyName;
+    }
+    get error() {
+        return this.#error;
+    }
+    static mandatory = (raise, keyName) => {
+        if (raise)
+            throw new PredicateError({ keyName, error: "mandatory property missing" });
+    };
+    static expected = (raise, keyName, expectedMessage, value) => {
+        if (raise) {
+            // eslint-disable-next-line @typescript-eslint/init-declarations
+            let valueStr;
+            if (value !== undefined) {
+                try {
+                    valueStr = JSON.stringify(value);
+                }
+                catch {
+                    try {
+                        valueStr = value.toString();
+                    }
+                    catch {
+                        valueStr = "<value>";
+                    }
+                }
+            }
+            const msg = valueStr === undefined ? expectedMessage : `${expectedMessage} (${valueStr})`;
+            throw new PredicateError({ keyName, error: `expected ${msg}` });
+        }
+    };
+    static predicateFailed = (raise, keyName) => {
+        if (raise)
+            throw new PredicateError({ keyName, error: "predicate failed" });
+    };
+    static allTryFailed = (raise, keyName, cause) => {
+        if (raise)
+            throw new PredicateError({ cause, error: "all possibilities failed", keyName });
+    };
+    static keyError = (raise, keyName, cause) => {
+        if (raise)
+            throw new PredicateError({ cause, error: cause.message, keyName });
+    };
+}

package/lib/types/primitive.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ */
+import * as types from "./types.js";
+export declare const isPrimitive: <T>(obj: unknown, primitiveType: string, options?: types.PredicateOptions) => obj is T;
+export declare const makePrimitivePredicate: <T>(primitiveType: string) => types.TypePredicate<T>;
+export declare const isBoolean: types.TypePredicate<boolean>;
+export declare const isNumber: types.TypePredicate<number>;
+export declare const isString: types.TypePredicate<string>;
+export declare const isSymbol: types.TypePredicate<symbol>;
+export declare const isBigInt: types.TypePredicate<bigint>;

package/lib/types/primitive.js

@@ -0,0 +1,34 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ */
+// #region Imports
+import { PredicateError } from "./predicateerror.js";
+import * as types from "./types.js";
+// #endregion
+// #region Predicates
+export const isPrimitive = (obj, primitiveType, options = false) => {
+    if (typeof obj === primitiveType)
+        return true;
+    const opt = types.getPredicateOptions(options);
+    PredicateError.predicateFailed(opt.raise, undefined);
+    return false;
+};
+export const makePrimitivePredicate = (primitiveType) => (obj, options = false) => isPrimitive(obj, primitiveType, options);
+export const isBoolean = makePrimitivePredicate("boolean");
+export const isNumber = makePrimitivePredicate("number");
+export const isString = makePrimitivePredicate("string");
+export const isSymbol = makePrimitivePredicate("symbol");
+export const isBigInt = makePrimitivePredicate("bigint");
+// #endregion

package/lib/types/record.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ */
+import { PredicateOptions, TypePredicate } from "./types.js";
+interface ProfileValue<T = unknown> {
+    value: T;
+    optional?: boolean;
+    shortcut?: boolean;
+}
+interface InstanceOfValue {
+    clazz: any;
+    optional?: boolean;
+    shortcut?: boolean;
+}
+interface PredicateValue<T = unknown> {
+    predicate: TypePredicate<T>;
+    optional?: boolean;
+    shortcut?: boolean;
+}
+type AdvancedProfileValue = ProfileValue | InstanceOfValue | PredicateValue;
+type ProfileEntryType = string | TypePredicate | AdvancedProfileValue;
+/**
+ * Simple profile to check.
+ *
+ * Keys are property names, values are typeof values.
+ * A value prefixed or suffixed with '?' is optional.
+ */
+export type Profile<T> = Record<keyof T, ProfileEntryType | Array<ProfileEntryType>>;
+/**
+ * Check if an object's properties fit the basic types profile.
+ *
+ * Only fit to check primitive types, equality and using other predicates.
+ * If `shortcut: true` is used in the options, only properties marked as "shortcut" are checked.
+ * For structured properties like instanceof and predicate this is indicated by the `shortcut`
+ * property; for primary type predicate this is indicated by the "!" character either before or
+ * after the type name.
+ *
+ * @public
+ */
+export declare const isObjectProfile: <T>(obj: unknown, profile: Profile<T>, options?: PredicateOptions) => obj is T;
+/**
+ * Create a predicate function based on the given profile.
+ *
+ * @public
+ */
+export declare const makeProfilePredicate: <TargetType>(profile: Profile<TargetType>) => TypePredicate<TargetType>;
+/**
+ * Check if all of an object properties match a given type.
+ *
+ * @public
+ */
+export declare const isKeyValueOfType: <ValueType>(obj: unknown, typePredicate: TypePredicate<ValueType>, options?: PredicateOptions) => obj is Record<string, ValueType>;
+/** @public */
+export declare const makeKeyValueOfTypePredicate: <ValueType>(typePredicate: TypePredicate<ValueType>) => TypePredicate<Record<string, ValueType>>;
+export {};

package/lib/types/record.js

@@ -0,0 +1,235 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ */
+import { asError } from "../error.js";
+import { PredicateError } from "./predicateerror.js";
+import { getPredicateOptions, } from "./types.js";
+/**
+ * Extract modifiers from primitive type name
+ *
+ * A type prefixed/suffixed with "?" is optional.
+ * A type prefixed/suffixed with "!" is a shortcut (only shortcut are tested in shortcut mode)
+ *
+ * @internal
+ */
+const trimTypeValue = (typeName) => {
+    let expectedValueType = typeName;
+    let optional = false;
+    let shortcut = false;
+    const specialChars = ["?", "!"];
+    while (specialChars.includes(expectedValueType[0])) {
+        const chr = expectedValueType[0];
+        expectedValueType = expectedValueType.slice(1);
+        if (chr === "?")
+            optional = true;
+        if (chr === "!")
+            shortcut = true;
+    }
+    while (specialChars.includes(expectedValueType[expectedValueType.length - 1])) {
+        const chr = expectedValueType[expectedValueType.length - 1];
+        expectedValueType = expectedValueType.slice(0, -1);
+        if (chr === "?")
+            optional = true;
+        if (chr === "!")
+            shortcut = true;
+    }
+    return { expectedValueType, optional, shortcut };
+};
+const isValueMatchPrimitive = (rec, key, typeValue, options) => {
+    if (typeValue === "skip")
+        return true;
+    const { optional, shortcut, expectedValueType } = trimTypeValue(typeValue);
+    if (options.shortcut && !shortcut)
+        return true;
+    if (key in rec && rec[key] !== undefined) {
+        const actualValueType = typeof rec[key];
+        if (actualValueType !== expectedValueType) {
+            PredicateError.expected(options.raise, key, `primitive type ${expectedValueType}`);
+            return false;
+        }
+    }
+    else if (!optional) {
+        PredicateError.mandatory(options.raise, key);
+        return false;
+    }
+    return true;
+};
+const isValueMatchClazz = (value, typeValue, key, options) => {
+    if (!(value instanceof typeValue.clazz)) {
+        const name = typeof typeValue.clazz === "function"
+            ? typeValue.clazz.name
+            : "<something>";
+        PredicateError.expected(options.raise, key, `instance of ${name}`);
+        return false;
+    }
+    return true;
+};
+const isValueMatchPredicate = (value, typeValue, key, options) => {
+    try {
+        if (!typeValue.predicate(value, options)) {
+            PredicateError.predicateFailed(options.raise, key);
+            return false;
+        }
+    }
+    catch (e) {
+        if (e instanceof PredicateError)
+            PredicateError.keyError(options.raise, key, e);
+        throw e;
+    }
+    return true;
+};
+const isValueMatchValue = (value, typeValue, key, options) => {
+    if (value !== typeValue.value) {
+        PredicateError.expected(options.raise, key, "value");
+        return false;
+    }
+    return true;
+};
+// Helper
+const isValueMatchPresent = (value, typeValue, key, options) => {
+    if (options.shortcut && !typeValue.shortcut)
+        return true;
+    if ("clazz" in typeValue) {
+        if (!isValueMatchClazz(value, typeValue, key, options))
+            return false;
+    }
+    else if ("predicate" in typeValue) {
+        if (!isValueMatchPredicate(value, typeValue, key, options))
+            return false;
+    }
+    else if ("value" in typeValue) {
+        if (!isValueMatchValue(value, typeValue, key, options))
+            return false;
+    }
+    return true;
+};
+const isValueMatchAdvanced = (rec, key, typeValue, options) => {
+    if (options.shortcut && !typeValue.shortcut)
+        return true;
+    if (key in rec && rec[key] !== undefined) {
+        return isValueMatchPresent(rec[key], typeValue, key, options);
+    }
+    const result = Boolean(typeValue.optional);
+    if (!result)
+        PredicateError.mandatory(options.raise, key);
+    return result;
+};
+/** Check a single match between a profile and an actual object value */
+const isValueMatch = (rec, key, typeValue, options) => {
+    if (typeof typeValue === "string")
+        return isValueMatchPrimitive(rec, key, typeValue, options);
+    if (typeof typeValue === "function") {
+        if (options.shortcut)
+            return true;
+        try {
+            const res = typeValue(rec[key], options);
+            if (!res)
+                PredicateError.predicateFailed(options.raise, key);
+            return res;
+        }
+        catch (e) {
+            if (e instanceof PredicateError)
+                PredicateError.keyError(options.raise, key, e);
+            throw e;
+        }
+    }
+    return isValueMatchAdvanced(rec, key, typeValue, options);
+};
+const checkArrayTypeDef = (valueType, rec, keyName, options) => {
+    let anyAccept = false;
+    const errors = [];
+    for (const typeInfo of valueType) {
+        try {
+            const res = isValueMatch(rec, keyName, typeInfo, options);
+            if (res) {
+                anyAccept = true;
+                break;
+            }
+        }
+        catch (e) {
+            errors.push(asError(e));
+        }
+    }
+    if (!anyAccept) {
+        PredicateError.allTryFailed(options.raise, keyName, errors);
+        return false;
+    }
+    return true;
+};
+/**
+ * Check if an object's properties fit the basic types profile.
+ *
+ * Only fit to check primitive types, equality and using other predicates.
+ * If `shortcut: true` is used in the options, only properties marked as "shortcut" are checked.
+ * For structured properties like instanceof and predicate this is indicated by the `shortcut`
+ * property; for primary type predicate this is indicated by the "!" character either before or
+ * after the type name.
+ *
+ * @public
+ */
+export const isObjectProfile = (obj, profile, options = false) => {
+    const opt = getPredicateOptions(options);
+    if (typeof obj !== "object" || obj === null) {
+        PredicateError.predicateFailed(opt.raise, "root");
+        return false;
+    }
+    const rec = obj;
+    for (const keyName of Object.keys(profile)) {
+        const valueType = profile[keyName];
+        if (Array.isArray(valueType)) {
+            const res = checkArrayTypeDef(valueType, rec, keyName, opt);
+            if (!res)
+                return false;
+        }
+        else if (!isValueMatch(rec, keyName, valueType, opt))
+            return false;
+    }
+    return true;
+};
+/**
+ * Create a predicate function based on the given profile.
+ *
+ * @public
+ */
+export const makeProfilePredicate = (profile) => (obj, options = false) => isObjectProfile(obj, profile, options);
+/**
+ * Check if all of an object properties match a given type.
+ *
+ * @public
+ */
+export const isKeyValueOfType = (obj, typePredicate, options = false) => {
+    const opt = getPredicateOptions(options);
+    if (typeof obj !== "object") {
+        PredicateError.predicateFailed(opt.raise, undefined);
+        return false;
+    }
+    const rec = obj;
+    for (const key of Object.keys(rec)) {
+        try {
+            if (!typePredicate(rec[key], opt)) {
+                PredicateError.predicateFailed(opt.raise, key);
+                return false;
+            }
+        }
+        catch (e) {
+            if (e instanceof PredicateError)
+                PredicateError.keyError(opt.raise, key, e);
+            throw e;
+        }
+    }
+    return true;
+};
+/** @public */
+export const makeKeyValueOfTypePredicate = (typePredicate) => (obj, options = false) => isKeyValueOfType(obj, typePredicate, options);

package/lib/types/types.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ */
+export interface PredicateOptionsFull {
+    raise?: boolean;
+    shortcut?: boolean;
+}
+export type PredicateOptions = boolean | PredicateOptionsFull;
+export type TypePredicate<T = unknown> = (obj: unknown, optionsOrRaise?: PredicateOptions) => obj is T;
+/**
+ * Wrap the optional second argument of predicates into the full predicate options
+ *
+ * @internal
+ */
+export declare const getPredicateOptions: (optionsOrRaise?: PredicateOptions) => Required<PredicateOptionsFull>;
+/**
+ * Create a predicate that check in sequence multiple predicates and return true if one succeed.
+ *
+ * Used for construction similar to `type T = T1 | T2`
+ */
+export declare const makeOrPredicate: <T>(predicates: Array<TypePredicate>) => TypePredicate<T>;
+/** Type used for something that can be either a promise or not */
+export type Awaitable<T> = Promise<T> | T;
+/** Ensure that the string match a given regex */
+export declare const isMatchRegexPredicate: <T>(obj: unknown, regex: RegExp, options?: PredicateOptions) => obj is T;
+/**
+ * Convert a type template string to a regex.
+ *
+ * The template string name can be any of:
+ *
+ * - string
+ * - number
+ * - bigint
+ * - boolean
+ * - null
+ * - undefined
+ *
+ * Unknown names will be picked from the `substitutions` parameter.
+ * Missing names will throw an error.
+ *
+ * @param template - The type template string.
+ * @param substitutions - An object for direct string substitutions of unknown keys from template
+ */
+export declare const makeTemplateRegex: (template: string, substitutions?: Record<string, Array<string>>) => RegExp;
+/**
+ * Match a template type value.
+ *
+ * It is advisable to use `makeTemplatePredicate()` instead, as it will cache the computed regex.
+ */
+export declare const isTemplatePredicate: <T>(obj: unknown, template: string, substitutions: Record<string, Array<string>>, options?: PredicateOptions) => obj is T;
+/** Create a predicate function that matches the given template type string. */
+export declare const makeTemplatePredicate: <T>(template: string, substitutions?: Record<string, Array<string>>) => TypePredicate<T>;

package/lib/types/types.js

@@ -0,0 +1,115 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ */
+import { asError } from "../error.js";
+import { PredicateError } from "./predicateerror.js";
+/**
+ * Wrap the optional second argument of predicates into the full predicate options
+ *
+ * @internal
+ */
+export const getPredicateOptions = (optionsOrRaise) => {
+    if (!optionsOrRaise)
+        return { raise: false, shortcut: false };
+    if (typeof optionsOrRaise === "boolean")
+        return { raise: optionsOrRaise, shortcut: false };
+    return { raise: false, shortcut: false, ...optionsOrRaise };
+};
+/**
+ * Create a predicate that check in sequence multiple predicates and return true if one succeed.
+ *
+ * Used for construction similar to `type T = T1 | T2`
+ */
+export const makeOrPredicate = (predicates) => (obj, options = false) => {
+    const opt = getPredicateOptions(options);
+    const errors = [];
+    for (const predicate of predicates) {
+        try {
+            if (predicate(obj, { raise: true, shortcut: opt.shortcut }))
+                return true;
+        }
+        catch (e) {
+            errors.push(asError(e));
+        }
+    }
+    if (opt.raise)
+        throw new PredicateError({ cause: errors });
+    return false;
+};
+/** Ensure that the string match a given regex */
+export const isMatchRegexPredicate = (obj, regex, options = false) => {
+    const opt = getPredicateOptions(options);
+    if (typeof obj !== "string" || !regex.exec(obj)) {
+        PredicateError.predicateFailed(opt.raise, undefined);
+        return false;
+    }
+    return true;
+};
+/** Return a regex portion for a choice of strings */
+const regexForStringChoice = (choices) => `(${choices.map((c) => c.replaceAll("|", "\\|").replaceAll(")", "\\)")).join("|")})`;
+/** Substitutions for template types */
+const defaultSubstitutions = {
+    bigint: "-?\\d+",
+    boolean: regexForStringChoice(["true", "false"]),
+    null: "null",
+    number: "[+-]?(?:\\d+\\.?\\d*|\\d*\\.?\\d+)",
+    string: ".*",
+    undefined: "undefined",
+};
+/**
+ * Convert a type template string to a regex.
+ *
+ * The template string name can be any of:
+ *
+ * - string
+ * - number
+ * - bigint
+ * - boolean
+ * - null
+ * - undefined
+ *
+ * Unknown names will be picked from the `substitutions` parameter.
+ * Missing names will throw an error.
+ *
+ * @param template - The type template string.
+ * @param substitutions - An object for direct string substitutions of unknown keys from template
+ */
+export const makeTemplateRegex = (template, substitutions) => {
+    const regexStr = template.replace(/\$\{(?<inputText>.+?)\}/gu, (_, inputText) => {
+        if (inputText in defaultSubstitutions)
+            return defaultSubstitutions[inputText];
+        if (substitutions && inputText in substitutions) {
+            return regexForStringChoice(substitutions[inputText]);
+        }
+        throw new Error(`Unknown substitution "${inputText}" in template`);
+    });
+    return new RegExp(`^${regexStr}$`, "u");
+};
+/**
+ * Match a template type value.
+ *
+ * It is advisable to use `makeTemplatePredicate()` instead, as it will cache the computed regex.
+ */
+export const isTemplatePredicate = (obj, template, substitutions, options = false) => {
+    if (typeof obj !== "string")
+        return false;
+    const regex = makeTemplateRegex(template, substitutions);
+    return isMatchRegexPredicate(obj, regex, options);
+};
+/** Create a predicate function that matches the given template type string. */
+export const makeTemplatePredicate = (template, substitutions) => {
+    const regex = makeTemplateRegex(template, substitutions);
+    return (obj, options = false) => isMatchRegexPredicate(obj, regex, options);
+};

package/lib/types/utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ */
+import ms from "ms";
+/** Check that a value is suitable for input for `ms()` */
+export declare const isMsInput: import("./types.js").TypePredicate<number | ms.StringValue>;