@casual-simulation/aux-records 3.8.1 → 3.10.2

package/TypeUtils.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=TypeUtils.js.map

package/TypeUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypeUtils.js","sourceRoot":"","sources":["TypeUtils.ts"],"names":[],"mappings":""}

package/Utils.d.ts

@@ -1,3 +1,4 @@
+import type { ArrayOfKASP, ISO4217_Map } from './TypeUtils';
 /**
  * Signs the given request and adds the related headers to it.
  * @param request The request to sign.
@@ -56,6 +57,21 @@ export declare function canonicalUriEncode(input: string, encodeSlash: boolean):
  * @param char The character to encode.
  */
 export declare function encodeHexUtf8(char: number): string;
+export declare const iSO4217_AlphaArray: (keyof ISO4217_Map)[];
+declare const ISO4217_Map: ArrayOfKASP<ISO4217_Map, ['n', 'mU']>;
+/**
+ * Gets the ISO 4217 currency meta for the given currency name
+ * or numeric code
+ * @important
+ * ! Be sure to validate that the implementing service supports
+ * ! the currency as well as the minor unit count (if applicable)
+ * @param query The currency name or numeric code
+ */
+export declare function getISO4217CurrencyCode(query: keyof ISO4217_Map | ISO4217_Map[keyof ISO4217_Map]['n']): [
+    keyof ISO4217_Map,
+    ISO4217_Map[keyof ISO4217_Map]['n'],
+    ISO4217_Map[keyof ISO4217_Map]['mU']
+];
 /**
  * Parses the given string of instance names into an array of instance names.
  * @param instances The names of the instances.
@@ -66,6 +82,48 @@ export declare function parseInstancesList(instances: string): string[] | undefi
  * @param obj The object to cleanup.
  */
 export declare function cleanupObject<T extends object>(obj: T): Partial<T>;
+/**
+ * A function which returns true if param val is found to be type / instance of any specified in param constructorArray
+ * @param val The value whose type / instance to check the presence of in constructorArray
+ * @param constructorArray The array which contains the allowed types / instances for parameter val
+ */
+export declare function isOfXType<T>(val: T, constructorArray: Array<Function | undefined | null>): boolean;
+/**
+ * Clones the given record or returns null if the record is undefined.
+ * @param record The record to clone.
+ */
+export declare function cloneDeepNull<T extends Record<keyof any, any>>(record: T | undefined): T;
+/**
+ * Tries to parse the given JSON string into a JavaScript Value.
+ * @param json The JSON to parse.
+ */
+export declare function tryParseJson(json: string): JsonParseResult;
+interface ScopedErrorConfig {
+    /** The scope of the function. E.g. [ClassName, FunctionName] */
+    scope: Array<string> | string;
+    /** The message to log if an error occurs. */
+    errMsg: string;
+}
+export declare function scopedError(errConfig: ScopedErrorConfig, err: string): void;
+interface ScopedTryConfig<E> extends ScopedErrorConfig {
+    /** The value to return if an error occurs. */
+    returnOnError?: E;
+}
+/**
+ * Attempts to run the given function and logs an error if it fails with a standard error format which includes the scope and message.
+ * @param fn The function to run.
+ * @param errConfig The configuration for proper logging and return value if an error occurs.
+ */
+export declare function tryScope<T, E>(fn: () => T, errConfig: ScopedTryConfig<E>): Promise<T | E>;
+export type JsonParseResult = JsonParseSuccess | JsonParseFailure;
+export interface JsonParseSuccess {
+    success: true;
+    value: any;
+}
+export interface JsonParseFailure {
+    success: false;
+    error: Error;
+}
 export interface RegexRule {
     type: 'allow' | 'deny';
     pattern: string;
@@ -128,4 +186,5 @@ export declare function handleAxiosErrors(err: any): void;
  * @param str The string.
  */
 export declare function byteLengthOfString(str: string): number;
+export {};
 //# sourceMappingURL=Utils.d.ts.map

package/Utils.js

@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
-import { omitBy, padStart, sortBy } from 'es-toolkit/compat';
+import { cloneDeep, omitBy, padStart, sortBy } from 'es-toolkit/compat';
 import { sha256, hmac } from 'hash.js';
 import { PUBLIC_READ_MARKER } from '@casual-simulation/aux-common';
 import axios from 'axios';
@@ -223,6 +223,381 @@ function getAmzDateString(date) {
         padStart(date.getUTCSeconds().toString(), 2, '0') +
         'Z');
 }
+export const iSO4217_AlphaArray = [
+    'AED',
+    'AFN',
+    'ALL',
+    'AMD',
+    'ANG',
+    'AOA',
+    'ARS',
+    'AUD',
+    'AWG',
+    'AZN',
+    'BAM',
+    'BBD',
+    'BDT',
+    'BGN',
+    'BHD',
+    'BIF',
+    'BMD',
+    'BND',
+    'BOB',
+    'BOV',
+    'BRL',
+    'BSD',
+    'BTN',
+    'BWP',
+    'BYN',
+    'BZD',
+    'CAD',
+    'CDF',
+    'CHE',
+    'CHF',
+    'CHW',
+    'CLF',
+    'CLP',
+    'CNY',
+    'COP',
+    'COU',
+    'CRC',
+    'CUC',
+    'CUP',
+    'CVE',
+    'CZK',
+    'DJF',
+    'DKK',
+    'DOP',
+    'DZD',
+    'EGP',
+    'ERN',
+    'ETB',
+    'EUR',
+    'FJD',
+    'FKP',
+    'GBP',
+    'GEL',
+    'GHS',
+    'GIP',
+    'GMD',
+    'GNF',
+    'GTQ',
+    'GYD',
+    'HKD',
+    'HNL',
+    'HTG',
+    'HUF',
+    'IDR',
+    'ILS',
+    'INR',
+    'IQD',
+    'IRR',
+    'ISK',
+    'JMD',
+    'JOD',
+    'JPY',
+    'KES',
+    'KGS',
+    'KHR',
+    'KMF',
+    'KPW',
+    'KRW',
+    'KWD',
+    'KYD',
+    'KZT',
+    'LAK',
+    'LBP',
+    'LKR',
+    'LRD',
+    'LSL',
+    'LYD',
+    'MAD',
+    'MDL',
+    'MGA',
+    'MKD',
+    'MMK',
+    'MNT',
+    'MOP',
+    'MRU',
+    'MUR',
+    'MVR',
+    'MWK',
+    'MXN',
+    'MXV',
+    'MYR',
+    'MZN',
+    'NAD',
+    'NGN',
+    'NIO',
+    'NOK',
+    'NPR',
+    'NZD',
+    'OMR',
+    'PAB',
+    'PEN',
+    'PGK',
+    'PHP',
+    'PKR',
+    'PLN',
+    'PYG',
+    'QAR',
+    'RON',
+    'RSD',
+    'RUB',
+    'RWF',
+    'SAR',
+    'SBD',
+    'SCR',
+    'SDG',
+    'SEK',
+    'SGD',
+    'SHP',
+    'SLE',
+    'SOS',
+    'SRD',
+    'SSP',
+    'STN',
+    'SVC',
+    'SYP',
+    'SZL',
+    'THB',
+    'TJS',
+    'TMT',
+    'TND',
+    'TOP',
+    'TRY',
+    'TTD',
+    'TWD',
+    'TZS',
+    'UAH',
+    'UGX',
+    'USD',
+    'USN',
+    'UYI',
+    'UYU',
+    'UYW',
+    'UZS',
+    'VED',
+    'VES',
+    'VND',
+    'VUV',
+    'WST',
+    'XAF',
+    'XAG',
+    'XAU',
+    'XBA',
+    'XBB',
+    'XBC',
+    'XBD',
+    'XCD',
+    'XDR',
+    'XOF',
+    'XPD',
+    'XPF',
+    'XPT',
+    'XSU',
+    'XTS',
+    'XUA',
+    'XXX',
+    'YER',
+    'ZAR',
+    'ZMW',
+    'ZWG',
+    'ZWL',
+];
+const ISO4217_Map = [
+    ['AED', 784, 2],
+    ['AFN', 971, 2],
+    ['ALL', 8, 2],
+    ['AMD', 51, 2],
+    ['ANG', 532, 2],
+    ['AOA', 973, 2],
+    ['ARS', 32, 2],
+    ['AUD', 36, 2],
+    ['AWG', 533, 2],
+    ['AZN', 944, 2],
+    ['BAM', 977, 2],
+    ['BBD', 52, 2],
+    ['BDT', 50, 2],
+    ['BGN', 975, 2],
+    ['BHD', 48, 3],
+    ['BIF', 108, 0],
+    ['BMD', 60, 2],
+    ['BND', 96, 2],
+    ['BOB', 68, 2],
+    ['BOV', 984, 2],
+    ['BRL', 986, 2],
+    ['BSD', 44, 2],
+    ['BTN', 64, 2],
+    ['BWP', 72, 2],
+    ['BYN', 933, 2],
+    ['BZD', 84, 2],
+    ['CAD', 124, 2],
+    ['CDF', 976, 2],
+    ['CHE', 947, 2],
+    ['CHF', 756, 2],
+    ['CHW', 948, 2],
+    ['CLF', 990, 4],
+    ['CLP', 152, 0],
+    ['CNY', 156, 2],
+    ['COP', 170, 2],
+    ['COU', 970, 2],
+    ['CRC', 188, 2],
+    ['CUC', 931, 2],
+    ['CUP', 192, 2],
+    ['CVE', 132, 2],
+    ['CZK', 203, 2],
+    ['DJF', 262, 0],
+    ['DKK', 208, 2],
+    ['DOP', 214, 2],
+    ['DZD', 12, 2],
+    ['EGP', 818, 2],
+    ['ERN', 232, 2],
+    ['ETB', 230, 2],
+    ['EUR', 978, 2],
+    ['FJD', 242, 2],
+    ['FKP', 238, 2],
+    ['GBP', 826, 2],
+    ['GEL', 981, 2],
+    ['GHS', 936, 2],
+    ['GIP', 292, 2],
+    ['GMD', 270, 2],
+    ['GNF', 324, 0],
+    ['GTQ', 320, 2],
+    ['GYD', 328, 2],
+    ['HKD', 344, 2],
+    ['HNL', 340, 2],
+    ['HTG', 332, 2],
+    ['HUF', 348, 2],
+    ['IDR', 360, 2],
+    ['ILS', 376, 2],
+    ['INR', 356, 2],
+    ['IQD', 368, 3],
+    ['IRR', 364, 2],
+    ['ISK', 352, 0],
+    ['JMD', 388, 2],
+    ['JOD', 400, 3],
+    ['JPY', 392, 0],
+    ['KES', 404, 2],
+    ['KGS', 417, 2],
+    ['KHR', 116, 2],
+    ['KMF', 174, 0],
+    ['KPW', 408, 2],
+    ['KRW', 410, 0],
+    ['KWD', 414, 3],
+    ['KYD', 136, 2],
+    ['KZT', 398, 2],
+    ['LAK', 418, 2],
+    ['LBP', 422, 2],
+    ['LKR', 144, 2],
+    ['LRD', 430, 2],
+    ['LSL', 426, 2],
+    ['LYD', 434, 3],
+    ['MAD', 504, 2],
+    ['MDL', 498, 2],
+    ['MGA', 969, 2],
+    ['MKD', 807, 2],
+    ['MMK', 104, 2],
+    ['MNT', 496, 2],
+    ['MOP', 446, 2],
+    ['MRU', 929, 2],
+    ['MUR', 480, 2],
+    ['MVR', 462, 2],
+    ['MWK', 454, 2],
+    ['MXN', 484, 2],
+    ['MXV', 979, 2],
+    ['MYR', 458, 2],
+    ['MZN', 943, 2],
+    ['NAD', 516, 2],
+    ['NGN', 566, 2],
+    ['NIO', 558, 2],
+    ['NOK', 578, 2],
+    ['NPR', 524, 2],
+    ['NZD', 554, 2],
+    ['OMR', 512, 3],
+    ['PAB', 590, 2],
+    ['PEN', 604, 2],
+    ['PGK', 598, 2],
+    ['PHP', 608, 2],
+    ['PKR', 586, 2],
+    ['PLN', 985, 2],
+    ['PYG', 600, 0],
+    ['QAR', 634, 2],
+    ['RON', 946, 2],
+    ['RSD', 941, 2],
+    ['RUB', 643, 2],
+    ['RWF', 646, 0],
+    ['SAR', 682, 2],
+    ['SBD', 90, 2],
+    ['SCR', 690, 2],
+    ['SDG', 938, 2],
+    ['SEK', 752, 2],
+    ['SGD', 702, 2],
+    ['SHP', 654, 2],
+    ['SLE', 925, 2],
+    ['SOS', 706, 2],
+    ['SRD', 968, 2],
+    ['SSP', 728, 2],
+    ['STN', 930, 2],
+    ['SVC', 222, 2],
+    ['SYP', 760, 2],
+    ['SZL', 748, 2],
+    ['THB', 764, 2],
+    ['TJS', 972, 2],
+    ['TMT', 934, 2],
+    ['TND', 788, 3],
+    ['TOP', 776, 2],
+    ['TRY', 949, 2],
+    ['TTD', 780, 2],
+    ['TWD', 901, 2],
+    ['TZS', 834, 2],
+    ['UAH', 980, 2],
+    ['UGX', 800, 0],
+    ['USD', 840, 2],
+    ['USN', 997, 2],
+    ['UYI', 940, 0],
+    ['UYU', 858, 2],
+    ['UYW', 927, 4],
+    ['UZS', 860, 2],
+    ['VED', 926, 2],
+    ['VES', 928, 2],
+    ['VND', 704, 0],
+    ['VUV', 548, 0],
+    ['WST', 882, 2],
+    ['XAF', 950, 0],
+    ['XAG', 961, null],
+    ['XAU', 959, null],
+    ['XBA', 955, null],
+    ['XBB', 956, null],
+    ['XBC', 957, null],
+    ['XBD', 958, null],
+    ['XCD', 951, 2],
+    ['XDR', 960, null],
+    ['XOF', 952, 0],
+    ['XPD', 964, null],
+    ['XPF', 953, 0],
+    ['XPT', 962, null],
+    ['XSU', 994, null],
+    ['XTS', 963, null],
+    ['XUA', 965, null],
+    ['XXX', 999, null],
+    ['YER', 886, 2],
+    ['ZAR', 710, 2],
+    ['ZMW', 967, 2],
+    ['ZWG', 924, 2],
+    ['ZWL', 932, 2],
+];
+/**
+ * Gets the ISO 4217 currency meta for the given currency name
+ * or numeric code
+ * @important
+ * ! Be sure to validate that the implementing service supports
+ * ! the currency as well as the minor unit count (if applicable)
+ * @param query The currency name or numeric code
+ */
+export function getISO4217CurrencyCode(query) {
+    return ISO4217_Map.find((v) => v[typeof query == 'string' ? 0 : 1] === query);
+}
 /**
  * Parses the given string of instance names into an array of instance names.
  * @param instances The names of the instances.
@@ -243,6 +618,136 @@ export function parseInstancesList(instances) {
 export function cleanupObject(obj) {
     return omitBy(obj, (o) => typeof o === 'undefined' || o === null);
 }
+// /**
+//  * Deep clones and concurrently freezes within the same iteration the provided object (record/array).
+//  * @param obj The object to clone and freeze recursively.
+//  */
+// export function deepCloneFreeze<T extends Record<string, any> | Array<any>>(
+//     obj: T
+// ): Readonly<T> {
+//     const returnObj = (Array.isArray(obj) ? [] : {}) as T;
+//     for (const key in obj) {
+//         if (obj.hasOwnProperty(key)) {
+//             const value = obj[key];
+//             if (
+//                 typeof value === 'object' &&
+//                 value !== null &&
+//                 !(value instanceof Date)
+//             ) {
+//                 returnObj[key] = deepCloneFreeze(value) as T[Extract<
+//                     keyof T,
+//                     string
+//                 >];
+//             } else {
+//                 returnObj[key] = value;
+//             }
+//         }
+//     }
+//     return Object.freeze(returnObj);
+// }
+// /**
+//  * Provides a function that can be used to build a paginate/effect function for the given array.
+//  * @param arr The array to paginate.
+//  * @param effectEach A function used within map to effect each element.
+//  * @returns
+//  */
+// export function paginationProviderOf<T, E>(
+//     arr: T[],
+//     effectEach?: (item: T) => PromiseOrValue<E>
+// ) {
+//     return async (limit: number, offset: number) => {
+//         const content = arr.slice(offset, offset + limit);
+//         if (!effectEach || content.length < 1) return [];
+//         return await Promise.all(content.map((X) => effectEach(X)));
+//     };
+// }
+// ! Implementation is WIP
+// /**
+//  * Generates a custom asymmetric matcher used by jest.
+//  * * (Similar to expect.any)
+//  * @param asymmetricMatcher The function to run on the value to indicate whether or not its as expected
+//  * @param toString The string provider of the expected values state/type
+//  * @param getExpectedType The string provider of the expected values type(s)
+//  */
+// export function jestCustomAsymmetricMatcher(
+//     asymmetricMatcher: (value: any) => boolean,
+//     toAsymmetricMatcher: () => string,
+//     toString?: () => string,
+//     getExpectedType?: () => string
+// ) {
+//     return {
+//         $$typeof: Symbol.for('jest.asymmetricMatcher'),
+//         asymmetricMatcher,
+//         toAsymmetricMatcher,
+//         toString,
+//         getExpectedType,
+//     };
+// }
+/**
+ * A function which returns true if param val is found to be type / instance of any specified in param constructorArray
+ * @param val The value whose type / instance to check the presence of in constructorArray
+ * @param constructorArray The array which contains the allowed types / instances for parameter val
+ */
+export function isOfXType(val, 
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+constructorArray) {
+    return constructorArray.some((constructor) => {
+        return constructor === String ||
+            constructor === Number ||
+            constructor === Boolean ||
+            constructor === Symbol ||
+            constructor === BigInt ||
+            constructor === undefined
+            ? typeof val === (constructor?.name?.toLowerCase() ?? 'undefined')
+            : constructor === null
+                ? val === null
+                : val instanceof constructor;
+    });
+}
+/**
+ * Clones the given record or returns null if the record is undefined.
+ * @param record The record to clone.
+ */
+export function cloneDeepNull(record) {
+    return record ? cloneDeep(record) : null;
+}
+/**
+ * Tries to parse the given JSON string into a JavaScript Value.
+ * @param json The JSON to parse.
+ */
+export function tryParseJson(json) {
+    try {
+        return {
+            success: true,
+            value: JSON.parse(json),
+        };
+    }
+    catch (err) {
+        return {
+            success: false,
+            error: err,
+        };
+    }
+}
+export function scopedError(errConfig, err) {
+    console.error(Array.isArray(errConfig.scope)
+        ? errConfig.scope.map((s) => `[${s}]`).join(' ')
+        : `[${errConfig.scope}]`, errConfig.errMsg, err);
+}
+/**
+ * Attempts to run the given function and logs an error if it fails with a standard error format which includes the scope and message.
+ * @param fn The function to run.
+ * @param errConfig The configuration for proper logging and return value if an error occurs.
+ */
+export async function tryScope(fn, errConfig) {
+    try {
+        return await fn();
+    }
+    catch (err) {
+        scopedError(errConfig, err);
+        return errConfig.returnOnError;
+    }
+}
 /**
  * Determines if the given value matches the given list of rules.
  * @param value The value to test.
@@ -361,9 +866,8 @@ export function getPathMarker(marker) {
  * @param err The error.
  */
 export function handleAxiosErrors(err) {
-    var _a, _b, _c;
     if (axios.isAxiosError(err)) {
-        console.error('An axios error occcurred:', '\nStatus:', (_a = err.response) === null || _a === void 0 ? void 0 : _a.status, '\nHeaders:', (_b = err.response) === null || _b === void 0 ? void 0 : _b.headers, '\nData:', (_c = err.response) === null || _c === void 0 ? void 0 : _c.data, '\nRequest:', err.request);
+        console.error('An axios error occcurred:', '\nStatus:', err.response?.status, '\nHeaders:', err.response?.headers, '\nData:', err.response?.data, '\nRequest:', err.request);
         throw new Error('An axios error occurred: ' + err.message);
     }
     else {