@semaphore-protocol/utils 4.0.0-beta.1 → 4.0.0-beta.3

package/dist/lib.esm/types.js

@@ -1,119 +0,0 @@
-/**
- * @module @semaphore-protocol/utils
- * @version 4.0.0-beta.1
- * @file A library to provide utility functions to the other Semaphore packages.
- * @copyright Ethereum Foundation 2024
- * @license MIT
- * @see [Github]{@link https://github.com/semaphore-protocol/semaphore/tree/main/packages/utils}
-*/
-/**
- * @module Types
- * This module provides utility functions to check data types.
- * It defines a set of supported types and includes functions to check if
- * a value is defined and if it matches a supported type. These functions
- * are useful for type checking and validation in the other libraries,
- * enhancing code robustness and reliability.
- */
-// The list of types supported by this utility functions.
-var supportedTypes = ["number", "string", "function", "array", "uint8array", "object", "bigint"];
-/**
- * It returns true if the value is defined, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isDefined(value) {
-    return typeof value !== "undefined";
-}
-/**
- * It returns true if the value is a number, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isNumber(value) {
-    return typeof value === "number";
-}
-/**
- * It returns true if the value is a string, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isString(value) {
-    return typeof value === "string";
-}
-/**
- * It returns true if the value is a function, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isFunction(value) {
-    return typeof value === "function";
-}
-/**
- * It returns true if the value is an array, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isArray(value) {
-    return typeof value === "object" && Array.isArray(value);
-}
-/**
- * It returns true if the value is a uint8array, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isUint8Array(value) {
-    return value instanceof Uint8Array;
-}
-/**
- * It returns true if the value is an object, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isObject(value) {
-    return typeof value === "object";
-}
-/**
- * It returns true if the value is a bigint, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-function isBigInt(value) {
-    return typeof value === "bigint";
-}
-/**
- * It returns true if the value type is the same as the type passed
- * as the second parameter, false otherwise.
- * @param type The expected type.
- * @returns True or false.
- */
-function isType(value, type) {
-    switch (type) {
-        case "number":
-            return isNumber(value);
-        case "string":
-            return isString(value);
-        case "function":
-            return isFunction(value);
-        case "array":
-            return isArray(value);
-        case "uint8array":
-            return isUint8Array(value);
-        case "object":
-            return isObject(value);
-        case "bigint":
-            return isBigInt(value);
-        default:
-            return false;
-    }
-}
-/**
- * Return true if the type is being supported by this utility
- * functions, false otherwise.
- * @param type The type to be checked.
- * @returns True or false
- */
-function isSupportedType(type) {
-    return supportedTypes.includes(type);
-}
-
-export { isArray, isBigInt, isDefined, isFunction, isNumber, isObject, isString, isSupportedType, isType, isUint8Array };

package/dist/types/errors.d.ts

@@ -1,64 +0,0 @@
-/**
- * @module Errors
- * This module is designed to provide utility functions for validating
- * function parameters. It includes functions that throw type errors if
- * the parameters do not meet specified criteria, such as being defined,
- * a number, a string, a function, or an array. This module helps ensure
- * that functions receive the correct types of inputs, enhancing code
- * reliability and reducing runtime errors.
- */
-import { SupportedType } from "./types";
-/**
- * It throws a type error if the parameter value has not been defined.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export declare function requireDefined(parameterValue: any, parameterName: string): void;
-/**
- * It throws a type error if the parameter value is not a number.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export declare function requireNumber(parameterValue: number, parameterName: string): void;
-/**
- * It throws a type error if the parameter value is not a string.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export declare function requireString(parameterValue: string, parameterName: string): void;
-/**
- * It throws a type error if the parameter value is not a function.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export declare function requireFunction(parameterValue: Function, parameterName: string): void;
-/**
- * It throws a type error if the parameter value is not an array.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export declare function requireArray(parameterValue: any[], parameterName: string): void;
-/**
- * It throws a type error if the parameter value is not a uint8array.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export declare function requireUint8Array(parameterValue: Uint8Array, parameterName: string): void;
-/**
- * It throws a type error if the parameter value is not an object.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export declare function requireObject(parameterValue: object, parameterName: string): void;
-/**
- * It throws a type error if the parameter value is not a bigint.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export declare function requireBigInt(parameterValue: bigint, parameterName: string): void;
-/**
- * It throws a type error if the parameter value type is not part of the list of types.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export declare function requireTypes(parameterValue: any, parameterName: string, types: SupportedType[]): void;

package/dist/types/types.d.ts

@@ -1,73 +0,0 @@
-/**
- * @module Types
- * This module provides utility functions to check data types.
- * It defines a set of supported types and includes functions to check if
- * a value is defined and if it matches a supported type. These functions
- * are useful for type checking and validation in the other libraries,
- * enhancing code robustness and reliability.
- */
-declare const supportedTypes: readonly ["number", "string", "function", "array", "uint8array", "object", "bigint"];
-export type SupportedType = (typeof supportedTypes)[number];
-/**
- * It returns true if the value is defined, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export declare function isDefined(value: any): boolean;
-/**
- * It returns true if the value is a number, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export declare function isNumber(value: any): boolean;
-/**
- * It returns true if the value is a string, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export declare function isString(value: any): boolean;
-/**
- * It returns true if the value is a function, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export declare function isFunction(value: any): boolean;
-/**
- * It returns true if the value is an array, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export declare function isArray(value: any): boolean;
-/**
- * It returns true if the value is a uint8array, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export declare function isUint8Array(value: any): boolean;
-/**
- * It returns true if the value is an object, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export declare function isObject(value: any): boolean;
-/**
- * It returns true if the value is a bigint, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export declare function isBigInt(value: any): boolean;
-/**
- * It returns true if the value type is the same as the type passed
- * as the second parameter, false otherwise.
- * @param type The expected type.
- * @returns True or false.
- */
-export declare function isType(value: any, type: SupportedType): boolean;
-/**
- * Return true if the type is being supported by this utility
- * functions, false otherwise.
- * @param type The type to be checked.
- * @returns True or false
- */
-export declare function isSupportedType(type: string): type is SupportedType;
-export {};

package/src/errors.ts

@@ -1,132 +0,0 @@
-/**
- * @module Errors
- * This module is designed to provide utility functions for validating
- * function parameters. It includes functions that throw type errors if
- * the parameters do not meet specified criteria, such as being defined,
- * a number, a string, a function, or an array. This module helps ensure
- * that functions receive the correct types of inputs, enhancing code
- * reliability and reducing runtime errors.
- */
-
-import {
-    SupportedType,
-    isArray,
-    isBigInt,
-    isDefined,
-    isFunction,
-    isNumber,
-    isObject,
-    isString,
-    isSupportedType,
-    isType,
-    isUint8Array
-} from "./types"
-
-/**
- * It throws a type error if the parameter value has not been defined.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export function requireDefined(parameterValue: any, parameterName: string) {
-    if (!isDefined(parameterValue)) {
-        throw new TypeError(`Parameter '${parameterName}' is not defined`)
-    }
-}
-
-/**
- * It throws a type error if the parameter value is not a number.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export function requireNumber(parameterValue: number, parameterName: string) {
-    if (!isNumber(parameterValue)) {
-        throw new TypeError(`Parameter '${parameterName}' is not a number`)
-    }
-}
-
-/**
- * It throws a type error if the parameter value is not a string.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export function requireString(parameterValue: string, parameterName: string) {
-    if (!isString(parameterValue)) {
-        throw new TypeError(`Parameter '${parameterName}' is not a string`)
-    }
-}
-
-/**
- * It throws a type error if the parameter value is not a function.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export function requireFunction(parameterValue: Function, parameterName: string) {
-    if (!isFunction(parameterValue)) {
-        throw new TypeError(`Parameter '${parameterName}' is not a function`)
-    }
-}
-
-/**
- * It throws a type error if the parameter value is not an array.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export function requireArray(parameterValue: any[], parameterName: string) {
-    if (!isArray(parameterValue)) {
-        throw new TypeError(`Parameter '${parameterName}' is not an array`)
-    }
-}
-
-/**
- * It throws a type error if the parameter value is not a uint8array.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export function requireUint8Array(parameterValue: Uint8Array, parameterName: string) {
-    if (!isUint8Array(parameterValue)) {
-        throw new TypeError(`Parameter '${parameterName}' is not a Uint8Array`)
-    }
-}
-
-/**
- * It throws a type error if the parameter value is not an object.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export function requireObject(parameterValue: object, parameterName: string) {
-    if (!isObject(parameterValue)) {
-        throw new TypeError(`Parameter '${parameterName}' is not an object`)
-    }
-}
-
-/**
- * It throws a type error if the parameter value is not a bigint.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export function requireBigInt(parameterValue: bigint, parameterName: string) {
-    if (!isBigInt(parameterValue)) {
-        throw new TypeError(`Parameter '${parameterName}' is not a bigint`)
-    }
-}
-
-/**
- * It throws a type error if the parameter value type is not part of the list of types.
- * @param parameterValue The parameter value.
- * @param parameterName The parameter name.
- */
-export function requireTypes(parameterValue: any, parameterName: string, types: SupportedType[]) {
-    for (const type of types) {
-        if (!isSupportedType(type)) {
-            throw new Error(`Type '${type}' is not supported`)
-        }
-    }
-
-    for (const type of types) {
-        if (isType(parameterValue, type)) {
-            return
-        }
-    }
-
-    throw new TypeError(`Parameter '${parameterName}' is none of the following types: ${types.join(", ")}`)
-}

package/src/types.ts

@@ -1,123 +0,0 @@
-/**
- * @module Types
- * This module provides utility functions to check data types.
- * It defines a set of supported types and includes functions to check if
- * a value is defined and if it matches a supported type. These functions
- * are useful for type checking and validation in the other libraries,
- * enhancing code robustness and reliability.
- */
-
-// The list of types supported by this utility functions.
-const supportedTypes = ["number", "string", "function", "array", "uint8array", "object", "bigint"] as const
-
-// Type extracted from the list above.
-export type SupportedType = (typeof supportedTypes)[number]
-
-/**
- * It returns true if the value is defined, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export function isDefined(value: any): boolean {
-    return typeof value !== "undefined"
-}
-
-/**
- * It returns true if the value is a number, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export function isNumber(value: any): boolean {
-    return typeof value === "number"
-}
-
-/**
- * It returns true if the value is a string, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export function isString(value: any): boolean {
-    return typeof value === "string"
-}
-
-/**
- * It returns true if the value is a function, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export function isFunction(value: any): boolean {
-    return typeof value === "function"
-}
-
-/**
- * It returns true if the value is an array, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export function isArray(value: any): boolean {
-    return typeof value === "object" && Array.isArray(value)
-}
-
-/**
- * It returns true if the value is a uint8array, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export function isUint8Array(value: any): boolean {
-    return value instanceof Uint8Array
-}
-
-/**
- * It returns true if the value is an object, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export function isObject(value: any): boolean {
-    return typeof value === "object"
-}
-
-/**
- * It returns true if the value is a bigint, false otherwise.
- * @param value The value to be checked.
- * @returns True or false.
- */
-export function isBigInt(value: any): boolean {
-    return typeof value === "bigint"
-}
-
-/**
- * It returns true if the value type is the same as the type passed
- * as the second parameter, false otherwise.
- * @param type The expected type.
- * @returns True or false.
- */
-export function isType(value: any, type: SupportedType): boolean {
-    switch (type) {
-        case "number":
-            return isNumber(value)
-        case "string":
-            return isString(value)
-        case "function":
-            return isFunction(value)
-        case "array":
-            return isArray(value)
-        case "uint8array":
-            return isUint8Array(value)
-        case "object":
-            return isObject(value)
-        case "bigint":
-            return isBigInt(value)
-        default:
-            return false
-    }
-}
-
-/**
- * Return true if the type is being supported by this utility
- * functions, false otherwise.
- * @param type The type to be checked.
- * @returns True or false
- */
-export function isSupportedType(type: string): type is SupportedType {
-    return (supportedTypes as readonly string[]).includes(type)
-}