@pezkuwi/util 14.0.10 → 14.0.12

package/packageDetect.d.ts

@@ -0,0 +1 @@
+export {};

package/packageDetect.js

@@ -0,0 +1,5 @@
+import { packageInfo as decoderInfo } from '@pezkuwi/x-textdecoder';
+import { packageInfo as encoderInfo } from '@pezkuwi/x-textencoder';
+import { detectPackage } from './detectPackage.js';
+import { packageInfo } from './packageInfo.js';
+detectPackage(packageInfo, null, [decoderInfo, encoderInfo]);

package/packageInfo.d.ts

@@ -0,0 +1,6 @@
+export declare const packageInfo: {
+    name: string;
+    path: string;
+    type: string;
+    version: string;
+};

package/packageInfo.js

@@ -0,0 +1 @@
+export const packageInfo = { name: '@pezkuwi/util', path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '14.0.10' };

package/promisify.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @name promisify
+ * @summary Wraps an async callback into a `Promise`
+ * @description
+ * Wraps the supplied async function `fn` that has a standard JS callback `(error: Error, result: any)` into a `Promise`, passing the supplied parameters. When `error` is set, the Promise is rejected, else the Promise resolves with the `result` value.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * const { promisify } from '@pezkuwi/util';
+ *
+ * await promisify(null, ((a, cb) => cb(null, a), true); // resolves with `true`
+ * await promisify(null, (cb) => cb(new Error('error!'))); // rejects with `error!`
+ * ```
+ */
+export declare function promisify<R = any>(self: unknown, fn: (...params: any[]) => any, ...params: any[]): Promise<R>;

package/promisify.js

@@ -0,0 +1,27 @@
+/**
+ * @name promisify
+ * @summary Wraps an async callback into a `Promise`
+ * @description
+ * Wraps the supplied async function `fn` that has a standard JS callback `(error: Error, result: any)` into a `Promise`, passing the supplied parameters. When `error` is set, the Promise is rejected, else the Promise resolves with the `result` value.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * const { promisify } from '@pezkuwi/util';
+ *
+ * await promisify(null, ((a, cb) => cb(null, a), true); // resolves with `true`
+ * await promisify(null, (cb) => cb(new Error('error!'))); // rejects with `error!`
+ * ```
+ */
+export function promisify(self, fn, ...params) {
+    return new Promise((resolve, reject) => {
+        fn.apply(self, params.concat((error, result) => {
+            if (error) {
+                reject(error);
+            }
+            else {
+                resolve(result);
+            }
+        }));
+    });
+}

package/src/packageInfo.ts

@@ -3,4 +3,4 @@
 
 // Do not edit, auto-generated by @pezkuwi/dev
 
-export const packageInfo = { name: '@pezkuwi/util', path: 'auto', type: 'auto', version: '14.0.10' };
+export const packageInfo = { name: '@pezkuwi/util', path: 'auto', type: 'auto', version: '14.0.12' };

package/src/u8a/toHex.spec.ts

@@ -60,7 +60,7 @@ describe('u8aToHex', (): void => {
   it('returns the hex value where allowed < max', (): void => {
     expect(
       u8aToHex(
-        new Uint8Array(Uint8Array.from([128, 0, 10, 11]), 64)
+        Uint8Array.from([128, 0, 10, 11])
       )
     ).toEqual('0x80000a0b');
   });

package/src/u8a/toHexBuffer.spec.ts

@@ -47,7 +47,7 @@ describe('u8aToHex', (): void => {
   it('returns the hex value where allowed < max', (): void => {
     expect(
       u8aToHex(
-        new Uint8Array(Uint8Array.from([128, 0, 10, 11]), 64)
+        Uint8Array.from([128, 0, 10, 11])
       )
     ).toEqual('0x80000a0b');
   });

package/string/camelCase.d.ts

@@ -0,0 +1,13 @@
+import type { AnyString } from '../types.js';
+export declare const CC_TO_UP: string[];
+export declare const CC_TO_LO: string[];
+/**
+ * @name stringCamelCase
+ * @summary Convert a dash/dot/underscore/space separated Ascii string/String to camelCase
+ */
+export declare const stringCamelCase: (value: AnyString) => string;
+/**
+ * @name stringPascalCase
+ * @summary Convert a dash/dot/underscore/space separated Ascii string/String to PascalCase
+ */
+export declare const stringPascalCase: (value: AnyString) => string;

package/string/camelCase.js

@@ -0,0 +1,59 @@
+export const CC_TO_UP = new Array(256);
+export const CC_TO_LO = new Array(256);
+for (let i = 0, count = CC_TO_UP.length; i < count; i++) {
+    CC_TO_LO[i] = String.fromCharCode(i).toLowerCase();
+    CC_TO_UP[i] = String.fromCharCode(i).toUpperCase();
+}
+/** @internal */
+function formatAllCaps(w) {
+    return w.slice(0, w.length - 1).toLowerCase() + CC_TO_UP[w.charCodeAt(w.length - 1)];
+}
+/**
+ * @internal
+ *
+ * Inspired by https://stackoverflow.com/a/2970667
+ *
+ * This is not as optimal as the original SO answer (we split into per-word),
+ * however it does pass the tests (which the SO version doesn't) and is still
+ * a major improvement over the original camelcase npm package -
+ *
+ *   camelcase: 20.88 μs/op
+ *        this:  1.00 μs/op
+ *
+ * Caveat of this: only Ascii, but acceptable for the intended usecase
+ */
+function converter(format) {
+    return (value) => {
+        const parts = value
+            // replace all separators (including consequtive) with spaces
+            .replace(/[-_., ]+/g, ' ')
+            // we don't want leading or trailing spaces
+            .trim()
+            // split into words
+            .split(' ');
+        let result = '';
+        for (let i = 0, count = parts.length; i < count; i++) {
+            const w = parts[i];
+            // apply the formatting
+            result += format(/^[\dA-Z]+$/.test(w)
+                // all full uppercase + letters are changed to lowercase
+                ? w.toLowerCase()
+                // all consecutive capitals + letters are changed to lowercase
+                // e.g. UUID64 -> uuid64, while preserving splits, eg. NFTOrder -> nftOrder
+                : w.replace(/^[\dA-Z]{2,}[^a-z]/, formatAllCaps), i);
+        }
+        return result;
+    };
+}
+/**
+ * @name stringCamelCase
+ * @summary Convert a dash/dot/underscore/space separated Ascii string/String to camelCase
+ */
+export const stringCamelCase = /*#__PURE__*/ converter((w, i) => 
+(i ? CC_TO_UP[w.charCodeAt(0)] : CC_TO_LO[w.charCodeAt(0)]) + w.slice(1));
+/**
+ * @name stringPascalCase
+ * @summary Convert a dash/dot/underscore/space separated Ascii string/String to PascalCase
+ */
+export const stringPascalCase = /*#__PURE__*/ converter((w) => 
+CC_TO_UP[w.charCodeAt(0)] + w.slice(1));

package/string/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @summary Utility methods to convert to work with `string` values
+ */
+export { stringCamelCase, stringPascalCase } from './camelCase.js';
+export { stringLowerFirst, stringUpperFirst } from './lowerFirst.js';
+export { stringShorten } from './shorten.js';
+export { stringToHex } from './toHex.js';
+export { stringToU8a } from './toU8a.js';

package/string/index.js

@@ -0,0 +1,8 @@
+/**
+ * @summary Utility methods to convert to work with `string` values
+ */
+export { stringCamelCase, stringPascalCase } from './camelCase.js';
+export { stringLowerFirst, stringUpperFirst } from './lowerFirst.js';
+export { stringShorten } from './shorten.js';
+export { stringToHex } from './toHex.js';
+export { stringToU8a } from './toU8a.js';

package/string/lowerFirst.d.ts

@@ -0,0 +1,31 @@
+import type { AnyString } from '../types.js';
+/**
+ * @name stringLowerFirst
+ * @summary Lowercase the first letter of a string
+ * @description
+ * Lowercase the first letter of a string
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringLowerFirst } from '@pezkuwi/util';
+ *
+ * stringLowerFirst('ABC'); // => 'aBC'
+ * ```
+ */
+export declare const stringLowerFirst: (value?: AnyString | null) => string;
+/**
+ * @name stringUpperFirst
+ * @summary Uppercase the first letter of a string
+ * @description
+ * Lowercase the first letter of a string
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringUpperFirst } from '@pezkuwi/util';
+ *
+ * stringUpperFirst('abc'); // => 'Abc'
+ * ```
+ */
+export declare const stringUpperFirst: (value?: AnyString | null) => string;

package/string/lowerFirst.js

@@ -0,0 +1,37 @@
+import { CC_TO_LO, CC_TO_UP } from './camelCase.js';
+/** @internal */
+function converter(map) {
+    return (value) => value
+        ? map[value.charCodeAt(0)] + value.slice(1)
+        : '';
+}
+/**
+ * @name stringLowerFirst
+ * @summary Lowercase the first letter of a string
+ * @description
+ * Lowercase the first letter of a string
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringLowerFirst } from '@pezkuwi/util';
+ *
+ * stringLowerFirst('ABC'); // => 'aBC'
+ * ```
+ */
+export const stringLowerFirst = /*#__PURE__*/ converter(CC_TO_LO);
+/**
+ * @name stringUpperFirst
+ * @summary Uppercase the first letter of a string
+ * @description
+ * Lowercase the first letter of a string
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringUpperFirst } from '@pezkuwi/util';
+ *
+ * stringUpperFirst('abc'); // => 'Abc'
+ * ```
+ */
+export const stringUpperFirst = /*#__PURE__*/ converter(CC_TO_UP);

package/string/shorten.d.ts

@@ -0,0 +1,16 @@
+import type { AnyString } from '../types.js';
+/**
+ * @name stringShorten
+ * @summary Returns a string with maximum length
+ * @description
+ * Checks the string against the `prefixLength`, if longer than double this, shortens it by placing `..` in the middle of it
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringShorten } from '@pezkuwi/util';
+ *
+ * stringShorten('1234567890', 2); // => 12..90
+ * ```
+ */
+export declare function stringShorten(value: AnyString, prefixLength?: number): string;

package/string/shorten.js

@@ -0,0 +1,19 @@
+/**
+ * @name stringShorten
+ * @summary Returns a string with maximum length
+ * @description
+ * Checks the string against the `prefixLength`, if longer than double this, shortens it by placing `..` in the middle of it
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringShorten } from '@pezkuwi/util';
+ *
+ * stringShorten('1234567890', 2); // => 12..90
+ * ```
+ */
+export function stringShorten(value, prefixLength = 6) {
+    return value.length <= 2 + 2 * prefixLength
+        ? value.toString()
+        : `${value.substring(0, prefixLength)}…${value.slice(-prefixLength)}`;
+}

package/string/toHex.d.ts

@@ -0,0 +1,16 @@
+import type { AnyString, HexString } from '../types.js';
+/**
+ * @name stringToHex
+ * @summary Creates a hex string from a utf-8 string
+ * @description
+ * String input values return the actual encoded hex value.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringToHex } from '@pezkuwi/util';
+ *
+ * stringToU8a('hello'); // 0x68656c6c6f
+ * ```
+ */
+export declare function stringToHex(value?: AnyString): HexString;

package/string/toHex.js

@@ -0,0 +1,19 @@
+import { u8aToHex } from '../u8a/toHex.js';
+import { stringToU8a } from './toU8a.js';
+/**
+ * @name stringToHex
+ * @summary Creates a hex string from a utf-8 string
+ * @description
+ * String input values return the actual encoded hex value.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringToHex } from '@pezkuwi/util';
+ *
+ * stringToU8a('hello'); // 0x68656c6c6f
+ * ```
+ */
+export function stringToHex(value) {
+    return u8aToHex(stringToU8a(value));
+}

package/string/toU8a.d.ts

@@ -0,0 +1,16 @@
+import type { AnyString } from '../types.js';
+/**
+ * @name stringToU8a
+ * @summary Creates a Uint8Array object from a utf-8 string.
+ * @description
+ * String input values return the actual encoded `UInt8Array`. `null` or `undefined` values returns an empty encoded array.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringToU8a } from '@pezkuwi/util';
+ *
+ * stringToU8a('hello'); // [0x68, 0x65, 0x6c, 0x6c, 0x6f]
+ * ```
+ */
+export declare function stringToU8a(value?: AnyString | null): Uint8Array;

package/string/toU8a.js

@@ -0,0 +1,21 @@
+import { TextEncoder } from '@pezkuwi/x-textencoder';
+const encoder = new TextEncoder();
+/**
+ * @name stringToU8a
+ * @summary Creates a Uint8Array object from a utf-8 string.
+ * @description
+ * String input values return the actual encoded `UInt8Array`. `null` or `undefined` values returns an empty encoded array.
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import { stringToU8a } from '@pezkuwi/util';
+ *
+ * stringToU8a('hello'); // [0x68, 0x65, 0x6c, 0x6c, 0x6f]
+ * ```
+ */
+export function stringToU8a(value) {
+    return value
+        ? encoder.encode(value.toString())
+        : new Uint8Array();
+}

package/stringify.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @name stringify
+ * @summary Performs a JSON.stringify, with BigInt handling
+ * @description A wrapper for JSON.stringify that handles BigInt values transparently, converting them to string. No differences from the native JSON.stringify function otherwise.
+ */
+export declare function stringify(value: unknown, space?: string | number): string;

package/stringify.js

@@ -0,0 +1,15 @@
+import { isBigInt } from './is/bigInt.js';
+/** @internal */
+function replacer(_, v) {
+    return isBigInt(v)
+        ? v.toString()
+        : v;
+}
+/**
+ * @name stringify
+ * @summary Performs a JSON.stringify, with BigInt handling
+ * @description A wrapper for JSON.stringify that handles BigInt values transparently, converting them to string. No differences from the native JSON.stringify function otherwise.
+ */
+export function stringify(value, space) {
+    return JSON.stringify(value, replacer, space);
+}