@andrew_l/toolkit 0.3.3 → 0.3.4

package/dist/index.d.ts

@@ -781,6 +781,251 @@ declare function bigIntBytes(value: bigint): Uint8Array;
  */
 declare function bigIntFromBytes(bytes: Uint8Array): bigint;
 
+type Arrayable<T> = T[] | T;
+
+type Awaitable<T> = Promise<T> | T;
+
+type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
+
+type FunctionArgs<Args extends any[] = any[], Return = void> = (
+  ...args: Args
+) => Return;
+
+type DeepPartial<T> = T extends Date
+  ? T
+  : T extends object
+    ? { [P in keyof T]?: DeepPartial<T[P]> }
+    : T;
+
+type DeepReadonly<T> = T extends unknown[]
+  ? Readonly<T>
+  : T extends object
+    ? Readonly<{ [P in keyof T]: DeepReadonly<T[P]> }>
+    : Readonly<T>;
+
+type AnyFunction = (...args: any[]) => any;
+
+type Data = Record<string, unknown>;
+
+type GenericObject = Record<string, any>;
+
+type SelectOptions<T = any> = SelectOptionItem<T>[];
+
+type OverwriteWith<T1, T2> =
+  IsAny<T2> extends true ? T1 : Omit<T1, keyof T2> & T2;
+
+type IsAny<T> = boolean extends (T extends never ? true : false)
+  ? true
+  : false;
+
+type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
+
+/**
+ * @example
+ * LiteralUnion<'foo' | 'bar', string>
+ *
+ * @see {@link https://github.com/microsoft/TypeScript/issues/29729}
+ */
+type LiteralUnion<Union, Type> = Union | (Type & Nothing);
+
+interface Nothing {}
+
+type ValuesOfObject<T> = T[keyof T];
+
+type Fn = () => void;
+
+type PromisifyFn<T extends AnyFunction> = (
+  ...args: ArgumentsType<T>
+) => Promise<ReturnType<T>>;
+
+/**
+ * A time value, which can be a string (e.g., "HH:MM"),
+ * an object with `h` (hours) and `m` (minutes) properties, or a similar format
+ * that `createTimeObject` can parse.
+ */
+type TimeValue = TimeString | TimeObject;
+
+/**
+ * Represent time string in 24h format
+ */
+type TimeString = string;
+
+/**
+ * Represent time object in 24h format ("HH:MM")
+ */
+type TimeObject = {
+  /**
+   * Hour (0 - 23).
+   */
+  h: number;
+
+  /**
+   * Minutes (0 - 59).
+   */
+  m: number;
+};
+
+/**
+ * Represent date object
+ */
+type DateObject = {
+  /**
+   * The year of the date (e.g., 2024).
+   */
+  year: number;
+
+  /**
+   * The month of the date (1 = January, 12 = December).
+   */
+  month: number;
+
+  /**
+   * The day of the month (1-31).
+   */
+  date: number;
+};
+
+interface ThemeConfig {
+  colors: {
+    [x: string]: Record<string, string>;
+  };
+  variables: {
+    [x: string]: Record<string, string | number>;
+  };
+}
+
+type Prettify<T> = {
+  [K in keyof T]: T[K];
+} & {};
+
+interface SelectOptionItem<T = any> {
+  text: string;
+  value: T;
+  props?: any;
+}
+
+interface SelectOptionItem<T = any> {
+  text: string;
+  value: T;
+  props?: any;
+}
+
+type Primitive =
+  | null
+  | undefined
+  | string
+  | number
+  | bigint
+  | boolean
+  | symbol;
+
+type ExecResult<T extends Data = Data, K extends Data = Data> =
+  | ExecSuccess<T>
+  | ExecSkip<K>;
+
+type ExecSuccess<T extends Data = Data> = {
+  success: true;
+  code: string;
+  reason?: string;
+} & T;
+
+type ExecSkip<T extends Data = Data> = {
+  skip: true;
+  code: string;
+  reason?: string;
+} & T;
+
+type ExecResultToSuccess<T> =
+  T extends ExecSuccess<infer X> ? ExecSuccess<X> : ExecSuccess;
+
+type ExecResultToSkip<T> =
+  T extends ExecSkip<infer X> ? ExecSkip<X> : ExecSkip;
+
+interface Logger {
+  info: (...args: unknown[]) => void;
+  warn: (...args: unknown[]) => void;
+  error: (...args: unknown[]) => void;
+  debug: (...args: unknown[]) => void;
+  log: (...args: unknown[]) => void;
+  extend: (...args: unknown[]) => void;
+}
+
+declare namespace BitPack {
+    type Field = {
+        name: string;
+        bits: number;
+        take: Take;
+    };
+    type Options<TFields extends Field[]> = {
+        totalBits: number;
+        fields: TFields;
+        debug?: boolean;
+        optimize?: boolean;
+    };
+    type Take = 'low' | 'high';
+    type API<TFields extends string = string> = {
+        buffer: Fn.Buffer<TFields>;
+        number: Fn.Number<TFields>;
+        bigint: Fn.BigInt<TFields>;
+        bits: Fn.Bits<TFields>;
+        plan?: Plan[];
+    };
+    namespace Fn {
+        type Buffer<TFields extends string = string> = WithDebug<(data: FieldOptions<TFields>) => Uint8Array>;
+        type Number<TFields extends string = string> = WithDebug<(data: FieldOptions<TFields>) => number>;
+        type BigInt<TFields extends string = string> = WithDebug<(data: FieldOptions<TFields>) => bigint>;
+        type Bits<TFields extends string = string> = WithDebug<(data: FieldOptions<TFields>) => string>;
+    }
+    type WithDebug<T extends AnyFunction> = T & {
+        code?: string;
+    };
+    type ExtractFieldNames<T extends Field[]> = T[number]['name'];
+    type FieldOptions<T extends string> = {
+        [P in T]: number;
+    };
+}
+type Plan = {
+    object: 'set' | 'value';
+    container?: number;
+    bits?: number;
+    offset?: number;
+    value?: unknown;
+    child?: Plan;
+};
+declare function bitPack<const TFields extends BitPack.Field[], TFieldNames extends string = BitPack.ExtractFieldNames<TFields>>(options: BitPack.Options<TFields>): BitPack.API<TFieldNames>;
+
+declare namespace BitUnpack {
+    type Field = {
+        name: string;
+        bits: number;
+    };
+    type Options<TFields extends Field[]> = {
+        totalBits: number;
+        fields: TFields;
+        debug?: boolean;
+    };
+    type API<TFields extends string = string> = {
+        buffer: Fn.Buffer<TFields>;
+        number: Fn.Number<TFields>;
+        bigint: Fn.BigInt<TFields>;
+        bits: Fn.Bits<TFields>;
+    };
+    namespace Fn {
+        type Buffer<TFields extends string = string> = WithDebug<(data: Uint8Array) => FieldResult<TFields>>;
+        type Number<TFields extends string = string> = WithDebug<(data: number) => FieldResult<TFields>>;
+        type BigInt<TFields extends string = string> = WithDebug<(data: bigint) => FieldResult<TFields>>;
+        type Bits<TFields extends string = string> = WithDebug<(data: string) => FieldResult<TFields>>;
+    }
+    type WithDebug<T extends AnyFunction> = T & {
+        code?: string;
+    };
+    type ExtractFieldNames<T extends Field[]> = T[number]['name'];
+    type FieldResult<T extends string> = {
+        [P in T]: number;
+    };
+}
+declare function bitUnpack<const TFields extends BitUnpack.Field[], TFieldNames extends string = BitUnpack.ExtractFieldNames<TFields>>(options: BitUnpack.Options<TFields>): BitUnpack.API<TFieldNames>;
+
 type BytesToBase64Options = {
     /**
      * Specifies the encoding type.
@@ -1000,175 +1245,6 @@ declare function uint8ToUint16(value: Uint8Array): Uint16Array;
  */
 declare function uint8ToUint32(value: Uint8Array): Uint32Array;
 
-type Arrayable<T> = T[] | T;
-
-type Awaitable<T> = Promise<T> | T;
-
-type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
-
-type FunctionArgs<Args extends any[] = any[], Return = void> = (
-  ...args: Args
-) => Return;
-
-type DeepPartial<T> = T extends Date
-  ? T
-  : T extends object
-    ? { [P in keyof T]?: DeepPartial<T[P]> }
-    : T;
-
-type DeepReadonly<T> = T extends unknown[]
-  ? Readonly<T>
-  : T extends object
-    ? Readonly<{ [P in keyof T]: DeepReadonly<T[P]> }>
-    : Readonly<T>;
-
-type AnyFunction = (...args: any[]) => any;
-
-type Data = Record<string, unknown>;
-
-type GenericObject = Record<string, any>;
-
-type SelectOptions<T = any> = SelectOptionItem<T>[];
-
-type OverwriteWith<T1, T2> =
-  IsAny<T2> extends true ? T1 : Omit<T1, keyof T2> & T2;
-
-type IsAny<T> = boolean extends (T extends never ? true : false)
-  ? true
-  : false;
-
-type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
-
-/**
- * @example
- * LiteralUnion<'foo' | 'bar', string>
- *
- * @see {@link https://github.com/microsoft/TypeScript/issues/29729}
- */
-type LiteralUnion<Union, Type> = Union | (Type & Nothing);
-
-interface Nothing {}
-
-type ValuesOfObject<T> = T[keyof T];
-
-type Fn = () => void;
-
-type PromisifyFn<T extends AnyFunction> = (
-  ...args: ArgumentsType<T>
-) => Promise<ReturnType<T>>;
-
-/**
- * A time value, which can be a string (e.g., "HH:MM"),
- * an object with `h` (hours) and `m` (minutes) properties, or a similar format
- * that `createTimeObject` can parse.
- */
-type TimeValue = TimeString | TimeObject;
-
-/**
- * Represent time string in 24h format
- */
-type TimeString = string;
-
-/**
- * Represent time object in 24h format ("HH:MM")
- */
-type TimeObject = {
-  /**
-   * Hour (0 - 23).
-   */
-  h: number;
-
-  /**
-   * Minutes (0 - 59).
-   */
-  m: number;
-};
-
-/**
- * Represent date object
- */
-type DateObject = {
-  /**
-   * The year of the date (e.g., 2024).
-   */
-  year: number;
-
-  /**
-   * The month of the date (1 = January, 12 = December).
-   */
-  month: number;
-
-  /**
-   * The day of the month (1-31).
-   */
-  date: number;
-};
-
-interface ThemeConfig {
-  colors: {
-    [x: string]: Record<string, string>;
-  };
-  variables: {
-    [x: string]: Record<string, string | number>;
-  };
-}
-
-type Prettify<T> = {
-  [K in keyof T]: T[K];
-} & {};
-
-interface SelectOptionItem<T = any> {
-  text: string;
-  value: T;
-  props?: any;
-}
-
-interface SelectOptionItem<T = any> {
-  text: string;
-  value: T;
-  props?: any;
-}
-
-type Primitive =
-  | null
-  | undefined
-  | string
-  | number
-  | bigint
-  | boolean
-  | symbol;
-
-type ExecResult<T extends Data = Data, K extends Data = Data> =
-  | ExecSuccess<T>
-  | ExecSkip<K>;
-
-type ExecSuccess<T extends Data = Data> = {
-  success: true;
-  code: string;
-  reason?: string;
-} & T;
-
-type ExecSkip<T extends Data = Data> = {
-  skip: true;
-  code: string;
-  reason?: string;
-} & T;
-
-type ExecResultToSuccess<T> =
-  T extends ExecSuccess<infer X> ? ExecSuccess<X> : ExecSuccess;
-
-type ExecResultToSkip<T> =
-  T extends ExecSkip<infer X> ? ExecSkip<X> : ExecSkip;
-
-interface Logger {
-  info: (...args: unknown[]) => void;
-  warn: (...args: unknown[]) => void;
-  error: (...args: unknown[]) => void;
-  debug: (...args: unknown[]) => void;
-  log: (...args: unknown[]) => void;
-  extend: (...args: unknown[]) => void;
-}
-
 interface ArgToKeyOptions {
     /**
      * Object key generation strategy.
@@ -2918,6 +2994,11 @@ declare function getMostSpecificPaths(keys: string[]): string[];
  */
 declare function humanFileSize(bytes: number, digits?: number, withSpace?: boolean): string;
 
+type WithCode<T extends AnyFunction> = T & {
+    code: string;
+};
+declare function createFunction<T extends AnyFunction>(fnName: string, code: string, ...args: any[]): WithCode<T>;
+
 interface DebounceOptions {
     /**
      * An optional AbortSignal to cancel the debounced function.
@@ -5742,4 +5823,4 @@ declare function wrapText(value: string, maxLength?: number): string;
  */
 declare function toError<T>(value: T, unknownMessage?: string): T extends Error ? T : Error;
 
-export { type AnyFunction, AppError, type AppErrorOptions, type ArgumentsType, type Arrayable, AsyncIterableQueue, type Awaitable, type Base64ToBytesOptions, type BaseX, BrowserAssertionError, type BytesToBase64Options, CancellablePromise, type CatchErrorResult, Color, type ColorChannels, ColorParser, type Data, type DateObject, type DateObjectInput, type DebouncedFunction, type DeepPartial, type DeepReadonly, type Defer, instance as EJSON, EJSON as EJSONInstance, EJSONStream, type EJSONStreamOptions, type EJSONStreamOptionsWithPayload, type EJSONType, type EnvParser, type ExecResult, type ExecResultToSkip, type ExecResultToSuccess, type ExecSkip, type ExecSuccess, FindMean, FixedMap, FixedWeakMap, type Fn, type FormatMoney, type FormatNumber, type FunctionArgs, type GenericObject, type IfAny, type IsAny, type LiteralUnion, type Logger, LruCache, type Nothing, type OverwriteWith, type Prettify, type Primitive, type PromisifyFn, Queue, type RandomizerOptions, ResourcePool, type ResourcePoolEventMap, type ResourcePoolOptions, type RetryOnErrorConfig, type SecureCustomizerOptions, type SelectOptionItem, type SelectOptions, type SimpleDefaultEventMap, SimpleEventEmitter, type SimpleEventMap, SortedArray, type SortedArrayCompareFn, _default as TWEMOJI_REGEX, type ThemeConfig, type ThrottledFunction, TimeBucket, type TimeBucketOptions, type TimeObject, type TimeObjectInput, TimeSpan, type TimeSpanUnit, type TimeString, type TimeValue, type TimestampMsInput, type TypeOf, type TypeOfMap, type ValuesOfObject, type WithCache, type WithCacheBucketBatchOptions, type WithCacheBucketOptions, type WithCacheFixedOptions, type WithCacheLruOptions, type WithCacheOptions, type WithCachePointer, type WithCacheResult, type WithCacheStorage, type WithCustomizer, type WithCustomizerFactory, type WithCustomizerValue, type WrrItem, alpha, arrayable, assert, asyncFilter, asyncFind, asyncForEach, asyncMap, avg, avgCircular, base62, base62Fast, base64, base64ToBytes, base64url, basex, bigIntBytes, bigIntFromBytes, blendColors, buildCssColor, bytesToBase64, cache, cacheBucket, cacheFixed, cacheLRU, camelCase, capitalize, captureStackTrace, catchError, channelsToHSL, channelsToHex, channelsToRGB, checkBitmask, chunk, chunkSeries, clamp, cleanEmpty, cleanObject, colorToChannels, compareBytes, concatenateBytes, contrastRatio, convertToUnit, crc32, createCustomizer, createCustomizerFactory, createDateObject, createDeepCloneWith, createEJSON, createEJSONStream, createEnvParser, createRandomizer, createSecureCustomizer, createTimeObject, createTimeSpan, createWithCache, cssVariable, dateInDays, dateInSeconds, debounce, deepAssign, deepClone, deepCloneWith, deepDefaults, deepFreeze, def, defer, delay, difference, dropCache, env, escapeHtml, escapeNumeric, escapeRegExp, fastIdle, fastIdlePromise, fastRaf, findMean, flagsToMap, flatten, formatMoney, formatNumber, get, getFileExtension, getFileName, getInitials, getMostSpecificPaths, getRandomInt, getRandomTime, getWords, groupBy, has, hasOwn, hasProtocol, hex, hexToChannels, hmToSeconds, hslToChannels, humanFileSize, humanize, interpolateColor, intersection, intersectionBy, isBigInt, isBoolean, isCached, isClient, isColorChannels, isCustomizerFactory, isDate, isDateObject, isDef, isEmpty, isEqual, isError, isFunction, isInfinity, isMap, isNode, isNullOrUndefined, isNumber, isObject, isOneEmoji, isPlainObject, isPrimitive, isPromise, isRegExp, isSet, isSkip, isString, isSuccess, isSymbol, isTimeObject, isTimeString, isTimeValue, isValidWeekDay, isWeakMap, isWeakSet, isWithCache, isoToFlagEmoji, kebabCase, keyBy, logger, loggerSetLevel, lowerCase, luminance, maskingEmail, maskingPhone, maskingWords, nextTickIteration, noop, objectId, omit, omitPrefixed, orderBy, parseAllNumbers, parseAlpha, parsePercentage, percentOf, pick, pickPrefixed, qs, rafPromise, randomString, removeVS16s, retryOnError, rgbToChannels, round2digits, secondsToHm, set, shuffle, snakeCase, sprintf, startCase, strAssign, sum, textDecoder, textEncoder, throttle, timeFromMinutes, timeStringify, timeToMinutes, timeout, timestamp, timestampMs, timestampToDate, tintedTextColor, toError, toMap, truncate, typeOf, uint16ToUint8, uint32ToUint8, uint8ToUint16, uint8ToUint32, unflatten, union, uniq, uniqBy, unset, weeksInYear, weightedRoundRobin, withCache, withCacheBucket, withCacheBucketBatch, withCacheFixed, withCacheLRU, withDeepClone, withPointerCache, withResolve, wrapText };
+export { type AnyFunction, AppError, type AppErrorOptions, type ArgumentsType, type Arrayable, AsyncIterableQueue, type Awaitable, type Base64ToBytesOptions, type BaseX, BitPack, BitUnpack, BrowserAssertionError, type BytesToBase64Options, CancellablePromise, type CatchErrorResult, Color, type ColorChannels, ColorParser, type Data, type DateObject, type DateObjectInput, type DebouncedFunction, type DeepPartial, type DeepReadonly, type Defer, instance as EJSON, EJSON as EJSONInstance, EJSONStream, type EJSONStreamOptions, type EJSONStreamOptionsWithPayload, type EJSONType, type EnvParser, type ExecResult, type ExecResultToSkip, type ExecResultToSuccess, type ExecSkip, type ExecSuccess, FindMean, FixedMap, FixedWeakMap, Fn, type FormatMoney, type FormatNumber, type FunctionArgs, type GenericObject, type IfAny, type IsAny, type LiteralUnion, type Logger, LruCache, type Nothing, type OverwriteWith, type Prettify, type Primitive, type PromisifyFn, Queue, type RandomizerOptions, ResourcePool, type ResourcePoolEventMap, type ResourcePoolOptions, type RetryOnErrorConfig, type SecureCustomizerOptions, type SelectOptionItem, type SelectOptions, type SimpleDefaultEventMap, SimpleEventEmitter, type SimpleEventMap, SortedArray, type SortedArrayCompareFn, _default as TWEMOJI_REGEX, type ThemeConfig, type ThrottledFunction, TimeBucket, type TimeBucketOptions, type TimeObject, type TimeObjectInput, TimeSpan, type TimeSpanUnit, type TimeString, type TimeValue, type TimestampMsInput, type TypeOf, type TypeOfMap, type ValuesOfObject, type WithCache, type WithCacheBucketBatchOptions, type WithCacheBucketOptions, type WithCacheFixedOptions, type WithCacheLruOptions, type WithCacheOptions, type WithCachePointer, type WithCacheResult, type WithCacheStorage, type WithCode, type WithCustomizer, type WithCustomizerFactory, type WithCustomizerValue, type WrrItem, alpha, arrayable, assert, asyncFilter, asyncFind, asyncForEach, asyncMap, avg, avgCircular, base62, base62Fast, base64, base64ToBytes, base64url, basex, bigIntBytes, bigIntFromBytes, bitPack, bitUnpack, blendColors, buildCssColor, bytesToBase64, cache, cacheBucket, cacheFixed, cacheLRU, camelCase, capitalize, captureStackTrace, catchError, channelsToHSL, channelsToHex, channelsToRGB, checkBitmask, chunk, chunkSeries, clamp, cleanEmpty, cleanObject, colorToChannels, compareBytes, concatenateBytes, contrastRatio, convertToUnit, crc32, createCustomizer, createCustomizerFactory, createDateObject, createDeepCloneWith, createEJSON, createEJSONStream, createEnvParser, createFunction, createRandomizer, createSecureCustomizer, createTimeObject, createTimeSpan, createWithCache, cssVariable, dateInDays, dateInSeconds, debounce, deepAssign, deepClone, deepCloneWith, deepDefaults, deepFreeze, def, defer, delay, difference, dropCache, env, escapeHtml, escapeNumeric, escapeRegExp, fastIdle, fastIdlePromise, fastRaf, findMean, flagsToMap, flatten, formatMoney, formatNumber, get, getFileExtension, getFileName, getInitials, getMostSpecificPaths, getRandomInt, getRandomTime, getWords, groupBy, has, hasOwn, hasProtocol, hex, hexToChannels, hmToSeconds, hslToChannels, humanFileSize, humanize, interpolateColor, intersection, intersectionBy, isBigInt, isBoolean, isCached, isClient, isColorChannels, isCustomizerFactory, isDate, isDateObject, isDef, isEmpty, isEqual, isError, isFunction, isInfinity, isMap, isNode, isNullOrUndefined, isNumber, isObject, isOneEmoji, isPlainObject, isPrimitive, isPromise, isRegExp, isSet, isSkip, isString, isSuccess, isSymbol, isTimeObject, isTimeString, isTimeValue, isValidWeekDay, isWeakMap, isWeakSet, isWithCache, isoToFlagEmoji, kebabCase, keyBy, logger, loggerSetLevel, lowerCase, luminance, maskingEmail, maskingPhone, maskingWords, nextTickIteration, noop, objectId, omit, omitPrefixed, orderBy, parseAllNumbers, parseAlpha, parsePercentage, percentOf, pick, pickPrefixed, qs, rafPromise, randomString, removeVS16s, retryOnError, rgbToChannels, round2digits, secondsToHm, set, shuffle, snakeCase, sprintf, startCase, strAssign, sum, textDecoder, textEncoder, throttle, timeFromMinutes, timeStringify, timeToMinutes, timeout, timestamp, timestampMs, timestampToDate, tintedTextColor, toError, toMap, truncate, typeOf, uint16ToUint8, uint32ToUint8, uint8ToUint16, uint8ToUint32, unflatten, union, uniq, uniqBy, unset, weeksInYear, weightedRoundRobin, withCache, withCacheBucket, withCacheBucketBatch, withCacheFixed, withCacheLRU, withDeepClone, withPointerCache, withResolve, wrapText };