@koine/utils 2.0.0-beta.37 → 2.0.0-beta.39

package/Defer.d.ts

@@ -3,4 +3,3 @@ export type Deferred<T> = Promise<T> & {
     reject: PromiseConstructor["reject"];
 };
 export declare function Defer<T>(): Deferred<T>;
-export default Defer;

package/Emitter.d.ts

@@ -1,7 +1,6 @@
-export declare function Emitter<EventMap extends {
+export declare let Emitter: <EventMap extends {
     [key: string]: any;
-}>(namespace: string): {
+}>(namespace: string) => {
     on<EventName extends keyof EventMap>(name: EventName, handler: (data?: EventMap[EventName] | undefined) => any): void;
     emit<EventName_1 extends keyof EventMap>(name: EventName_1, data?: EventMap[EventName_1] | undefined): void;
 };
-export default Emitter;

package/README.md

@@ -0,0 +1,48 @@
+# @koine/utils
+
+Libraries to encapsulate and re-export from here, the selection is based on:
+
+- [x] full typescript support
+- [x] treeshake-ability
+- [x] docs in source comments
+
+- [dhmk-utils](https://github.com/dhmk083/dhmk-utils)
+- [mesqueeb/merge-anything](https://github.com/mesqueeb/merge-anything)
+- [mesqueeb/filter-anything](https://github.com/mesqueeb/filter-anything)
+- [mesqueeb/case-anything](https://github.com/mesqueeb/case-anything)
+- [mesqueeb/nestify-anything](https://github.com/mesqueeb/nestify-anything)
+- [mesqueeb/fast-sort (fork)](https://github.com/mesqueeb/fast-sort "fork")
+- [mesqueeb/compare-anything](https://github.com/mesqueeb/compare-anything)
+- [mesqueeb/copy-anything](https://github.com/mesqueeb/copy-anything)
+- [mesqueeb/flatten-anything](https://github.com/mesqueeb/flatten-anything)
+
+To consider:
+
+- [dlv](https://www.npmjs.com/package/dlv)
+- [lukeed/dset](https://github.com/lukeed/dset)
+- [angus-c/just](https://github.com/angus-c/just)
+
+About ts utilities types @see:
+
+- [sindresorhus/type-fest](https://github.com/sindresorhus/type-fest)
+- [millsp/ts-toolbelt](https://github.com/millsp/ts-toolbelt)
+- [ts-essentials](https://github.com/ts-essentials/ts-essentials)
+
+For inspiration look at [1loc.dev](https://1loc.dev).
+
+About utilities useful examples @see:
+
+- [chakra-ui](https://github.com/chakra-ui/chakra-ui/blob/main/packages/utils/src)
+
+TODO: We could also re-exports direct dependencies of packages that we often use
+anyway like [those of `yup`](https://github.com/jquense/yup/blob/master/package.json#L103):
+
+- [tiny-case](https://github.com/jquense/tiny-case)
+- [property-expr](https://github.com/jquense/expr/blob/master/index.js)
+- [toposort](https://github.com/marcelklehr/toposort)
+
+TODO: check typescript utilities in [TypeScript core](https://github.com/microsoft/TypeScript/blob/main/src/compiler/core.ts)
+
+## Code
+
+- Transformative functions like `truncate` or `titleCase` should allow for nullable inputs as much as possible, acceptin both `undefined` and `null`.

package/accentSets.d.ts

@@ -1,3 +1,2 @@
 export type AccentsSet = [string, string];
-export declare const accentsSets: AccentsSet[];
-export default accentsSets;
+export declare let accentsSets: AccentsSet[];

package/addOrReplaceAtIdx.d.ts

@@ -1,2 +1 @@
-export declare function addOrReplaceAtIdx<T>(list: T[], newItem: T, newIdx?: number): T[];
-export default addOrReplaceAtIdx;
+export declare let addOrReplaceAtIdx: <T>(list: T[], newItem: T, newIdx?: number) => T[];

package/areEqual.d.ts

@@ -1,4 +1,4 @@
 type ComparablePrimitive = string | number | boolean;
 type Comparable = ComparablePrimitive | object | Record<string, ComparablePrimitive> | Array<ComparablePrimitive>;
-export declare function areEqual(a: Comparable, b?: Comparable): boolean;
-export default areEqual;
+export declare let areEqual: (a: Comparable, b?: Comparable) => boolean;
+export {};

package/arrayFilterFalsy.d.ts

@@ -1,2 +1 @@
-export declare function arrayFilterFalsy<T extends unknown[]>(list?: null | T): Exclude<NonNullable<T>[number], false | "" | 0 | undefined>[];
-export default arrayFilterFalsy;
+export declare let arrayFilterFalsy: <T extends unknown[]>(list?: T | null | undefined) => Exclude<NonNullable<T>[number], false | "" | 0 | undefined>[];

package/arrayOfAll.d.ts

@@ -1,2 +1 @@
-export declare const arrayOfAll: <T>() => <U extends T[]>(array: U & ([T] extends [U[number]] ? unknown : "Invalid")) => U & ([T] extends [U[number]] ? unknown : "Invalid");
-export default arrayOfAll;
+export declare let arrayOfAll: <T>() => <U extends T[]>(array: U & ([T] extends [U[number]] ? unknown : "Invalid")) => U & ([T] extends [U[number]] ? unknown : "Invalid");

package/arraySum.d.ts

@@ -1,2 +1 @@
-export declare const arraySum: (numbers: number[]) => number;
-export default arraySum;
+export declare let arraySum: (numbers: number[]) => number;

package/arrayToLookup.d.ts

@@ -1,2 +1 @@
-export declare function arrayToLookup<T extends string | number | symbol>(array?: T[]): Record<T, 1>;
-export default arrayToLookup;
+export declare let arrayToLookup: <T extends string | number | symbol>(array?: T[]) => Record<T, 1>;

package/arrayUniqueByProperties.d.ts

@@ -1,2 +1 @@
-export declare const arrayUniqueByProperties: <T extends any[]>(array: T, keys: (keyof T[number])[]) => T;
-export default arrayUniqueByProperties;
+export declare let arrayUniqueByProperties: <T extends any[]>(array: T, keys: (keyof T[number])[]) => T;

package/buildUrlQueryString.d.ts

@@ -1,3 +1,2 @@
-import { type AnyQueryParams } from "./location.js";
-export declare function buildUrlQueryString<T extends AnyQueryParams>(params: T): string;
-export default buildUrlQueryString;
+import type { AnyQueryParams } from "./location";
+export declare let buildUrlQueryString: <T extends AnyQueryParams>(params: T) => string;

package/capitalize.d.ts

@@ -1,2 +1 @@
-export declare function capitalize<T extends string>(string?: null | T): Capitalize<T>;
-export default capitalize;
+export declare let capitalize: <T extends string>(string?: T | null | undefined) => Capitalize<T>;

package/changeCaseCamel.d.ts

@@ -0,0 +1,2 @@
+import { type PascalCaseOptions } from "./changeCaseHelpers";
+export declare let changeCaseCamel: (input: string, options?: PascalCaseOptions) => string;

package/changeCaseCapital.d.ts

@@ -0,0 +1,2 @@
+import { type Options } from "./changeCaseHelpers";
+export declare let changeCaseCapital: (input: string, options?: Options) => string;

package/changeCaseConstant.d.ts

@@ -0,0 +1,2 @@
+import { type Options } from "./changeCaseHelpers";
+export declare let changeCaseConstant: (input: string, options?: Options) => string;

package/changeCaseDot.d.ts

@@ -0,0 +1,2 @@
+import type { Options } from "./changeCaseHelpers";
+export declare let changeCaseDot: (input: string, options?: Options) => string;

package/changeCaseHelpers.d.ts

@@ -0,0 +1,19 @@
+export type Locale = string[] | string | false | undefined;
+export interface PascalCaseOptions extends Options {
+    mergeAmbiguousCharacters?: boolean;
+}
+export interface Options {
+    locale?: Locale;
+    split?: (value: string) => string[];
+    separateNumbers?: boolean;
+    delimiter?: string;
+    prefixCharacters?: string;
+    suffixCharacters?: string;
+}
+export declare let split: (value: string) => string[];
+export declare let splitSeparateNumbers: (value: string) => string[];
+export declare let lowerFactory: (locale: Locale) => (input: string) => string;
+export declare let upperFactory: (locale: Locale) => (input: string) => string;
+export declare let capitalCaseTransformFactory: (lower: (input: string) => string, upper: (input: string) => string) => (word: string) => string;
+export declare let pascalCaseTransformFactory: (lower: (input: string) => string, upper: (input: string) => string) => (word: string, index: number) => string;
+export declare let splitPrefixSuffix: (input: string, options?: Options) => [string, string[], string];

package/changeCaseKebab.d.ts

@@ -0,0 +1,2 @@
+import type { Options } from "./changeCaseHelpers";
+export declare let changeCaseKebab: (input: string, options?: Options) => string;

package/changeCaseNone.d.ts

@@ -0,0 +1,2 @@
+import { type Options } from "./changeCaseHelpers";
+export declare let changeCaseNone: (input: string, options?: Options) => string;

package/changeCasePascal.d.ts

@@ -0,0 +1,2 @@
+import { PascalCaseOptions } from "./changeCaseHelpers";
+export declare let changeCasePascal: (input: string, options?: PascalCaseOptions) => string;

package/changeCasePascalSnake.d.ts

@@ -0,0 +1,2 @@
+import type { Options } from "./changeCaseHelpers";
+export declare let changeCasePascalSnake: (input: string, options?: Options) => string;

package/changeCasePath.d.ts

@@ -0,0 +1,2 @@
+import type { Options } from "./changeCaseHelpers";
+export declare let changeCasePath: (input: string, options?: Options) => string;

package/changeCaseSentence.d.ts

@@ -0,0 +1,2 @@
+import { type Options } from "./changeCaseHelpers";
+export declare let changeCaseSentence: (input: string, options?: Options) => string;

package/changeCaseSnake.d.ts

@@ -0,0 +1,2 @@
+import type { Options } from "./changeCaseHelpers";
+export declare let changeCaseSnake: (input: string, options?: Options) => string;

package/changeCaseTrain.d.ts

@@ -0,0 +1,2 @@
+import type { Options } from "./changeCaseHelpers";
+export declare let changeCaseTrain: (input: string, options?: Options) => string;

package/chunkByChunks.d.ts

@@ -1,2 +1 @@
-export declare function chunkByChunks<T>(arr: T[], nrOfChunks: number, balanced?: boolean): T[][];
-export default chunkByChunks;
+export declare let chunkByChunks: <T>(arr: T[], nrOfChunks: number, balanced?: boolean) => T[][];

package/chunkBySize.d.ts

@@ -1,2 +1 @@
-export declare function chunkBySize<T>(arr: T[], size: number): T[][];
-export default chunkBySize;
+export declare let chunkBySize: <T>(arr: T[], size: number) => T[][];

package/clamp.d.ts

@@ -1,2 +1 @@
-export declare function clamp(num: number, min: number, max: number): number;
-export default clamp;
+export declare let clamp: (num: number, min: number, max: number) => number;

package/clsx.d.ts

@@ -2,5 +2,5 @@ type ClassValue = ClassArray | ClassDictionary | string | number | null | boolea
 type ClassDictionary = Record<string, any>;
 type ClassArray = ClassValue[];
 export type ClsxClassValue = ClassValue;
-export declare const clsx: (...args: ClassValue[]) => string;
-export default clsx;
+export declare let clsx: (...args: ClassValue[]) => string;
+export {};

package/convertRange.d.ts

@@ -1,2 +1 @@
-export declare function convertRange(num: number, r1: number[], r2: number[]): number;
-export default convertRange;
+export declare let convertRange: (num: number, r1: number[], r2: number[]) => number;

package/cookie.d.ts

@@ -12,7 +12,7 @@ export type CookieAttributesServer = CookieAttributes & {
     decode?: (input: string) => string;
 };
 export type CookieAttributesClient = CookieAttributes;
-export declare const defaultAttributesClient: {
+export declare let defaultAttributesClient: {
     path: string;
 };
 export {};

package/createPalette.d.ts

@@ -6,5 +6,5 @@ type PaletteMapPair<T extends PaletteShade> = {
 type PaletteMap<T extends PaletteShades> = {
     [PS in T[number] as keyof PaletteMapPair<PS>]: PaletteMapPair<PS>[keyof PaletteMapPair<PS>];
 };
-export declare const createPalette: <TName extends string, TShades extends PaletteShades, TColor = TShades[number][1], TMap = PaletteMap<TShades>>(name: TName, shades: TShades) => readonly [TMap, Record<`${TName}-${TShades[number][0]}`, string>, TColor[]];
-export default createPalette;
+export declare let createPalette: <TName extends string, TShades extends PaletteShades, TColor = TShades[number][1], TMap = PaletteMap<TShades>>(name: TName, shades: TShades) => readonly [TMap, Record<`${TName}-${TShades[number][0]}`, string>, TColor[]];
+export {};

package/debounce.d.ts

@@ -1,2 +1 @@
-export declare function debounce<T extends (...args: any[]) => any>(fn: T, wait?: number, immediate?: boolean): (this: unknown, ...args: Parameters<T>) => void;
-export default debounce;
+export declare let debounce: <T extends (...args: any[]) => any>(fn: T, wait?: number, immediate?: boolean) => (this: unknown, ...args: Parameters<T>) => void;

package/debouncePromise.d.ts

@@ -7,5 +7,4 @@ export interface DebouncedFunction<Args extends any[], F extends (...args: Args)
     (this: ThisParameterType<F>, ...args: Args & Parameters<F>): Promise<ReturnType<F>>;
     cancel: (reason?: any) => void;
 }
-export declare function debouncePromise<Args extends any[], F extends (...args: Args) => any>(func: F, waitMilliseconds?: number, options?: DebounceOptions<ReturnType<F>>): DebouncedFunction<Args, F>;
-export default debouncePromise;
+export declare let debouncePromise: <Args extends any[], F extends (...args: Args) => any>(func: F, waitMilliseconds?: number, options?: DebounceOptions<ReturnType<F>>) => DebouncedFunction<Args, F>;

package/debounceRaf.d.ts

@@ -1,2 +1 @@
 export declare function debounceRaf<T extends (...args: any[]) => any>(this: unknown, fn: T): (this: unknown, ...args: Parameters<T>) => void;
-export default debounceRaf;

package/decode.d.ts

@@ -1,2 +1 @@
-export declare function decode<TReturn extends string>(str: string): TReturn;
-export default decode;
+export declare let decode: <TReturn extends string>(str: string) => TReturn;

package/encode.d.ts

@@ -1,2 +1 @@
-export declare function encode<TReturn extends string>(str: string): TReturn;
-export default encode;
+export declare let encode: <TReturn extends string>(str: string) => TReturn;

package/ensureInt.d.ts

@@ -1,2 +1 @@
-export declare const ensureInt: (input: string | number) => number;
-export default ensureInt;
+export declare let ensureInt: (input: string | number) => number;

package/errorToString.d.ts

@@ -1,2 +1 @@
-export declare const errorToString: (e: unknown) => string;
-export default errorToString;
+export declare let errorToString: (e: unknown) => string;

package/findDuplicatedIndexes.d.ts

@@ -1,2 +1 @@
-export declare function findDuplicatedIndexes(arr: any[]): Record<number, true>;
-export default findDuplicatedIndexes;
+export declare let findDuplicatedIndexes: (arr: any[]) => Record<number, true>;

package/forin.d.ts

@@ -1,2 +1 @@
-export declare function forin<T>(object: T, cb: <K extends keyof T>(key: K, value: T[K]) => void): void;
-export default forin;
+export declare let forin: <T>(object: T, cb: <K extends keyof T>(key: K, value: T[K]) => void) => void;

package/gbToBytes.d.ts

@@ -1,2 +1 @@
-export declare const gbToBytes: (bytes: number) => number;
-export default gbToBytes;
+export declare let gbToBytes: (bytes: number) => number;

package/getEmptyArray.d.ts

@@ -1,2 +1 @@
-export declare function getEmptyArray(length: number | string): undefined[];
-export default getEmptyArray;
+export declare let getEmptyArray: (length: number | string) => undefined[];

package/getKeys.d.ts

@@ -1,2 +1 @@
-export declare const getKeys: <T extends object>(obj: T) => (keyof T)[];
-export default getKeys;
+export declare let getKeys: <T extends object>(obj: T) => (keyof T)[];

package/getMediaQueryWidthResolvers.d.ts

@@ -1,5 +1,5 @@
 export type GetMediaQueryWidthResolversBreakpoints = Record<string, number>;
-export declare function getMediaQueryWidthResolvers<TBreakpointsConfig extends GetMediaQueryWidthResolversBreakpoints>(customBreakpoints: TBreakpointsConfig): {
+export declare let getMediaQueryWidthResolvers: <TBreakpointsConfig extends GetMediaQueryWidthResolversBreakpoints>(customBreakpoints: TBreakpointsConfig) => {
     max: (br: Extract<keyof TBreakpointsConfig, string>) => string;
     min: (br: Extract<keyof TBreakpointsConfig, string>) => string;
     down: (br: Extract<keyof TBreakpointsConfig, string>) => string;
@@ -7,4 +7,3 @@ export declare function getMediaQueryWidthResolvers<TBreakpointsConfig extends G
     between: (br1: Extract<keyof TBreakpointsConfig, string>, br2?: Extract<keyof TBreakpointsConfig, string> | undefined) => string;
     only: (br: Extract<keyof TBreakpointsConfig, string>) => string;
 };
-export default getMediaQueryWidthResolvers;

package/getMediaQueryWidthTailwindScreens.d.ts

@@ -1,5 +1,4 @@
-import { type GetMediaQueryWidthResolversBreakpoints } from "./getMediaQueryWidthResolvers.js";
-export declare function getMediaQueryWidthTailwindScreens(breakpoints: GetMediaQueryWidthResolversBreakpoints): Record<string, {
+import { type GetMediaQueryWidthResolversBreakpoints } from "./getMediaQueryWidthResolvers";
+export declare let getMediaQueryWidthTailwindScreens: (breakpoints: GetMediaQueryWidthResolversBreakpoints) => Record<string, {
     raw: string;
 }>;
-export default getMediaQueryWidthTailwindScreens;

package/getNonce.d.ts

@@ -1,2 +1 @@
-export declare function getNonce(): string | null;
-export default getNonce;
+export declare let getNonce: () => string | null;

package/getParamAmong.d.ts

@@ -1,2 +1 @@
-export declare function getParamAmong<T extends string[]>(raw?: string | string[], allowedValues?: T): T[number] | null;
-export default getParamAmong;
+export declare let getParamAmong: <T extends string[]>(raw?: string | string[], allowedValues?: T) => T[number] | null;

package/getParamAsInt.d.ts

@@ -1,2 +1 @@
-export declare function getParamAsInt<TFallback extends number | null | undefined>(raw?: string | string[], fallback?: TFallback): number | TFallback;
-export default getParamAsInt;
+export declare let getParamAsInt: <TFallback extends number | null | undefined>(raw?: string | string[], fallback?: TFallback) => number | TFallback;

package/getParamAsString.d.ts

@@ -1,2 +1 @@
-export declare function getParamAsString(raw?: string | string[]): string;
-export default getParamAsString;
+export declare let getParamAsString: (raw?: string | string[]) => string;

package/getType.d.ts

@@ -3,5 +3,4 @@ export type AnyAsyncFunction = (...args: any[]) => Promise<any>;
 export type AnyClass = new (...args: any[]) => any;
 export type PlainObject = Record<string | number | symbol, any>;
 export type TypeGuard<A, B extends A> = (payload: A) => payload is B;
-export declare function getType(payload: any): string;
-export default getType;
+export declare let getType: (payload: any) => string;

package/getUrlHashParams.d.ts

@@ -1,3 +1 @@
-import { type AnyQueryParams } from "./location.js";
-export declare function getUrlHashParams<T extends NonNullable<AnyQueryParams>>(hash?: string): T;
-export default getUrlHashParams;
+export declare let getUrlHashParams: <T extends Record<string | number, unknown>>(hash?: string) => T;

package/getUrlHashPathname.d.ts

@@ -1,2 +1 @@
-export declare function getUrlHashPathname(hash?: string): string;
-export default getUrlHashPathname;
+export declare let getUrlHashPathname: (hash?: string) => string;

package/getUrlPathnameParts.d.ts

@@ -1,2 +1 @@
-export declare function getUrlPathnameParts(pathname?: string): string[];
-export default getUrlPathnameParts;
+export declare let getUrlPathnameParts: (pathname?: string) => string[];

package/getUrlQueryParams.d.ts

@@ -1,3 +1 @@
-import { type AnyQueryParams } from "./location.js";
-export declare function getUrlQueryParams<T extends NonNullable<AnyQueryParams>>(url?: string): T;
-export default getUrlQueryParams;
+export declare let getUrlQueryParams: <T extends Record<string | number, unknown>>(url?: string) => T;

package/imgEmptyPixel.d.ts

@@ -1,2 +1 @@
-export declare const imgEmptyPixel = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=";
-export default imgEmptyPixel;
+export declare let imgEmptyPixel: string;

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./index";

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;