@ocap/util 1.17.0 → 1.17.3

package/lib/create-sorted-list.d.ts

@@ -1 +1 @@
-export declare const createSortedList: (list: $TSFixMe) => unknown[];
+export declare const createSortedList: (list: $TSFixMe) => any;

package/lib/index.d.ts

@@ -1,9 +1,11 @@
 /// <reference types="node" />
+/// <reference types="jest" />
+import { LiteralUnion } from 'type-fest';
 import rightPad from 'lodash/padEnd';
 import leftPad from 'lodash/padStart';
 import BN from 'bn.js';
 export declare type BytesType = string | Buffer | Uint8Array;
-export declare type EncodingType = 'hex' | 'base16' | 'base58' | 'base64' | 'Uint8Array' | 'buffer';
+export declare type EncodingType = LiteralUnion<'hex' | 'base16' | 'base58' | 'base64' | 'Uint8Array' | 'buffer', string>;
 export declare type KeyPairType = {
     publicKey: BytesType;
     secretKey: BytesType;
@@ -11,8 +13,8 @@ export declare type KeyPairType = {
 export { BN, leftPad, rightPad };
 /**
  * Returns a BN object, converts a number value to a BN
- * @param {String|Number|Object} `arg` input a string number, hex string number, number, BigNumber or BN object
- * @return {Object} `output` BN object of the number
+ * @param {string|number|BN} `arg` input a string number, hex string number, number, BigNumber or BN object
+ * @return {BN} `output` BN object of the number
  * @throws if the argument is not an array, object that isn't a bignumber, not a string number or number
  */
 export declare const numberToBN: (arg: string | number | BN) => BN;
@@ -31,10 +33,8 @@ export declare const isHexPrefixed: (str: string) => boolean;
  *
  * @public
  * @static
- * @param {String} str the string value
- * @return {String|Optional} a string by pass if necessary
  */
-export declare const stripHexPrefix: (str: $TSFixMe) => any;
+export declare const stripHexPrefix: (str: string | any) => any;
 /**
  * Returns true if object is BN, otherwise false
  *
@@ -114,7 +114,7 @@ export declare const hexToUtf8: (hex: string) => string;
  * @param {String|Number|BN} value
  * @returns {Number}
  */
-export declare const hexToNumber: (value: string | number | BN) => string | number | BN;
+export declare const hexToNumber: (value: string | number | BN) => number;
 /**
  * Converts value to hex representation
  *
@@ -146,7 +146,7 @@ export declare const bytesToHex: (bytes: $TSFixMe) => string;
  * @param {String} hex
  * @returns {Array} the byte array
  */
-export declare const hexToBytes: (hex: $TSFixMe) => number[];
+export declare const hexToBytes: (hex: $TSFixMe) => Array<any>;
 /**
  * Auto converts any given value into it's hex representation.
  * And even stringify objects before.
@@ -166,127 +166,54 @@ export declare const toHex: (value: string | number | boolean | BN | Uint8Array
 export declare const numberToString: (arg: $TSFixMe) => any;
 /**
  * Format a big number to human readable number, such as 1_0000_0000_0000_000 => 1 Token
- *
- * @public
- * @static
- * @method fromUnitToToken
- * @param {string|number} input
- * @param {number} [decimal=18]
- * @param {object} [optionsInput=undefined]
- * @returns {string}
  */
 export declare const fromUnitToToken: (input: string | number | BN, decimal?: number, optionsInput?: $TSFixMe) => string;
 /**
  * Convert human readable token number to big number instance
- *
- * @public
- * @static
- * @param {string} input
- * @param {number} [decimal=18]
- * @returns {BN}
  */
 export declare const fromTokenToUnit: (input: string | number, decimal?: number) => BN;
 /**
  * Validates if a value is an Uint8Array.
- *
- * @public
- * @static
- * @param {*} value - value to validate
- * @returns {Boolean} boolean indicating if a value is an Uint8Array
  */
 export declare function isUint8Array(value: $TSFixMe): boolean;
 /**
  * Generate a random UUID
- *
- * @public
- * @static
- * @returns {string} Generated uuid
  */
 export declare function UUID(): string;
 /**
  * Check if a string is valid UUID
- *
- * @public
- * @static
- * @param {string} str
- * @returns {boolean}
  */
 export declare function isUUID(str: string): boolean;
 /**
  * Convert input to Uint8Array on best effort, base64 node supported
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array|string} v
- * @returns {Uint8Array}
- * @throws {Error}
  */
-export declare function toUint8Array(v: $TSFixMe): Uint8Array;
+export declare function toUint8Array(v: any): Uint8Array;
 /**
  * Convert input to Buffer on best effort, base64 not supported
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array} v
- * @returns {buffer}
- * @throws {Error}
  */
-export declare function toBuffer(v: $TSFixMe): Buffer;
+export declare function toBuffer(v: any): Buffer;
 /**
  * Convert input to base58btc format on best effort
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array} v
- * @returns {string}
- * @throws {Error}
  */
-export declare function toBase58(v: $TSFixMe): string;
+export declare function toBase58(v: any): string;
 /**
  * Decode base58 string
- *
- * @public
- * @static
- * @param {string} v
- * @returns {buffer}
  */
 export declare function fromBase58(v: string): Buffer;
 /**
  * Convert input to base64 format
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array} v
- * @param {escape} [escape=true]
- * @returns {string}
- * @throws {Error}
  */
-export declare function toBase64(v: $TSFixMe, escape?: boolean): string;
+export declare function toBase64(v: any, escape?: boolean): string;
 /**
  * Decode base64(base64_url) string to buffer
- *
- * @public
- * @static
- * @param {string} v
- * @returns {buffer}
  */
 export declare function fromBase64(v: string): Buffer;
 /**
  * Convert did to address: remove `did:abt:` prefix
- *
- * @public
- * @static
- * @param {string} did - address string
- * @returns {string}
  */
 export declare function toAddress(did: string): string;
 /**
  * Convert address to did: prepend `did:abt:` prefix
- *
- * @public
- * @static
- * @param {string} did - address string
- * @returns {string}
  */
 export declare function toDid(address: string): string;
-export declare const formatTxType: (type: string) => string;
+export declare function formatTxType(type: string): any;

package/lib/index.js

@@ -27,9 +27,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatTxType = exports.toDid = exports.toAddress = exports.fromBase64 = exports.toBase64 = exports.fromBase58 = exports.toBase58 = exports.toBuffer = exports.toUint8Array = exports.isUUID = exports.UUID = exports.isUint8Array = exports.fromTokenToUnit = exports.fromUnitToToken = exports.numberToString = exports.toHex = exports.hexToBytes = exports.bytesToHex = exports.numberToHex = exports.hexToNumber = exports.hexToUtf8 = exports.utf8ToHex = exports.toBN = exports.isHex = exports.isHexStrict = exports.isBigNumber = exports.isBN = exports.stripHexPrefix = exports.isHexPrefixed = exports.numberToBN = exports.rightPad = exports.leftPad = exports.BN = void 0;
-/* eslint-disable @typescript-eslint/no-use-before-define */
-/* eslint-disable no-param-reassign */
-/* eslint-disable no-bitwise */
 const isBoolean_1 = __importDefault(require("lodash/isBoolean"));
 const isString_1 = __importDefault(require("lodash/isString"));
 const isNumber_1 = __importDefault(require("lodash/isNumber"));
@@ -62,8 +59,8 @@ const isBase58btc = (data) => {
 };
 /**
  * Returns a BN object, converts a number value to a BN
- * @param {String|Number|Object} `arg` input a string number, hex string number, number, BigNumber or BN object
- * @return {Object} `output` BN object of the number
+ * @param {string|number|BN} `arg` input a string number, hex string number, number, BigNumber or BN object
+ * @return {BN} `output` BN object of the number
  * @throws if the argument is not an array, object that isn't a bignumber, not a string number or number
  */
 const numberToBN = (arg) => {
@@ -113,14 +110,12 @@ exports.isHexPrefixed = isHexPrefixed;
  *
  * @public
  * @static
- * @param {String} str the string value
- * @return {String|Optional} a string by pass if necessary
  */
 const stripHexPrefix = (str) => {
-    if (typeof str !== 'string') {
-        return str;
+    if (typeof str === 'string') {
+        return (0, exports.isHexPrefixed)(str) ? str.slice(2) : str;
     }
-    return (0, exports.isHexPrefixed)(str) ? str.slice(2) : str;
+    return str;
 };
 exports.stripHexPrefix = stripHexPrefix;
 /**
@@ -257,7 +252,7 @@ exports.hexToUtf8 = hexToUtf8;
  */
 const hexToNumber = (value) => {
     if (!value) {
-        return value;
+        return 0;
     }
     return (0, exports.toBN)(value).toNumber();
 };
@@ -353,7 +348,7 @@ const toHex = (value, returnType = false) => {
         return returnType ? 'string' : (0, exports.utf8ToHex)(JSON.stringify(value));
     }
     // if its a negative number, pass it through numberToHex
-    if ((0, isString_1.default)(value)) {
+    if (typeof value === 'string') {
         if (value.indexOf('-0x') === 0 || value.indexOf('-0X') === 0) {
             return returnType ? 'int256' : (0, exports.numberToHex)(value);
         }
@@ -391,14 +386,6 @@ const numberToString = (arg) => {
 exports.numberToString = numberToString;
 /**
  * Format a big number to human readable number, such as 1_0000_0000_0000_000 => 1 Token
- *
- * @public
- * @static
- * @method fromUnitToToken
- * @param {string|number} input
- * @param {number} [decimal=18]
- * @param {object} [optionsInput=undefined]
- * @returns {string}
  */
 const fromUnitToToken = (input, decimal = 18, optionsInput = {}) => {
     let unit = (0, exports.toBN)(input);
@@ -430,12 +417,6 @@ const fromUnitToToken = (input, decimal = 18, optionsInput = {}) => {
 exports.fromUnitToToken = fromUnitToToken;
 /**
  * Convert human readable token number to big number instance
- *
- * @public
- * @static
- * @param {string} input
- * @param {number} [decimal=18]
- * @returns {BN}
  */
 const fromTokenToUnit = (input, decimal = 18) => {
     let token = (0, exports.numberToString)(input);
@@ -479,11 +460,6 @@ const fromTokenToUnit = (input, decimal = 18) => {
 exports.fromTokenToUnit = fromTokenToUnit;
 /**
  * Validates if a value is an Uint8Array.
- *
- * @public
- * @static
- * @param {*} value - value to validate
- * @returns {Boolean} boolean indicating if a value is an Uint8Array
  */
 function isUint8Array(value) {
     return Object.prototype.toString.call(value) === '[object Uint8Array]';
@@ -491,10 +467,6 @@ function isUint8Array(value) {
 exports.isUint8Array = isUint8Array;
 /**
  * Generate a random UUID
- *
- * @public
- * @static
- * @returns {string} Generated uuid
  */
 function UUID() {
     return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
@@ -506,11 +478,6 @@ function UUID() {
 exports.UUID = UUID;
 /**
  * Check if a string is valid UUID
- *
- * @public
- * @static
- * @param {string} str
- * @returns {boolean}
  */
 function isUUID(str) {
     return /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.test(str);
@@ -518,12 +485,6 @@ function isUUID(str) {
 exports.isUUID = isUUID;
 /**
  * Convert input to Uint8Array on best effort, base64 node supported
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array|string} v
- * @returns {Uint8Array}
- * @throws {Error}
  */
 function toUint8Array(v) {
     let vb = null;
@@ -553,12 +514,6 @@ function toUint8Array(v) {
 exports.toUint8Array = toUint8Array;
 /**
  * Convert input to Buffer on best effort, base64 not supported
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array} v
- * @returns {buffer}
- * @throws {Error}
  */
 function toBuffer(v) {
     return Buffer.from(toUint8Array(v));
@@ -566,12 +521,6 @@ function toBuffer(v) {
 exports.toBuffer = toBuffer;
 /**
  * Convert input to base58btc format on best effort
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array} v
- * @returns {string}
- * @throws {Error}
  */
 function toBase58(v) {
     const buf = base58btc.encode(toUint8Array(v));
@@ -580,11 +529,6 @@ function toBase58(v) {
 exports.toBase58 = toBase58;
 /**
  * Decode base58 string
- *
- * @public
- * @static
- * @param {string} v
- * @returns {buffer}
  */
 function fromBase58(v) {
     if (isBase58btc(v) === false) {
@@ -595,27 +539,14 @@ function fromBase58(v) {
 exports.fromBase58 = fromBase58;
 /**
  * Convert input to base64 format
- *
- * @public
- * @static
- * @param {buffer|base58|hex|Uint8Array} v
- * @param {escape} [escape=true]
- * @returns {string}
- * @throws {Error}
  */
 function toBase64(v, escape = true) {
-    // FIXME: 这个是正确的?
     const encoded = base64_url_1.default.encode(toBuffer(v));
     return escape ? base64_url_1.default.escape(encoded) : encoded;
 }
 exports.toBase64 = toBase64;
 /**
  * Decode base64(base64_url) string to buffer
- *
- * @public
- * @static
- * @param {string} v
- * @returns {buffer}
  */
 function fromBase64(v) {
     if (typeof v !== 'string') {
@@ -626,11 +557,6 @@ function fromBase64(v) {
 exports.fromBase64 = fromBase64;
 /**
  * Convert did to address: remove `did:abt:` prefix
- *
- * @public
- * @static
- * @param {string} did - address string
- * @returns {string}
  */
 function toAddress(did) {
     return did.replace(DID_PREFIX, '');
@@ -638,15 +564,12 @@ function toAddress(did) {
 exports.toAddress = toAddress;
 /**
  * Convert address to did: prepend `did:abt:` prefix
- *
- * @public
- * @static
- * @param {string} did - address string
- * @returns {string}
  */
 function toDid(address) {
     return `${DID_PREFIX}${toAddress(address)}`;
 }
 exports.toDid = toDid;
-const formatTxType = (type) => (0, upperFirst_1.default)((0, camelCase_1.default)(type));
+function formatTxType(type) {
+    return (0, upperFirst_1.default)((0, camelCase_1.default)(type));
+}
 exports.formatTxType = formatTxType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ocap/util",
-  "version": "1.17.0",
+  "version": "1.17.3",
   "description": "utils shared across multiple forge js libs, works in both node.js and browser",
   "keywords": [
     "arcblock",
@@ -15,6 +15,7 @@
     "bn.js": "5.2.1",
     "bs58": "^5.0.0",
     "lodash": "^4.17.21",
+    "type-fest": "^2.13.1",
     "utf8": "^3.0.0"
   },
   "resolutions": {
@@ -65,5 +66,5 @@
   "bugs": {
     "url": "https://github.com/ArcBlock/asset-chain/issues"
   },
-  "gitHead": "f0944b60a5fb4115e1a3727bb07f68174bc56c5c"
+  "gitHead": "7a74e4e2b362a6e6ea8d14617f0480966c3363d5"
 }