@leancodepl/utils 8.3.6 → 8.5.0

package/package.json

@@ -1,24 +1,60 @@
 {
   "name": "@leancodepl/utils",
-  "version": "8.3.6",
+  "version": "8.5.0",
   "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "dependencies": {
-    "@leancodepl/api-date": "8.3.6",
+    "@leancodepl/api-date": "8.5.0",
     "tiny-invariant": ">=1.3.1"
   },
   "peerDependencies": {
-    "react": ">=17.0.0"
+    "react": "*"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leancodepl/js_corelibrary.git",
+    "directory": "packages/utils"
+  },
+  "homepage": "https://github.com/leancodepl/js_corelibrary",
+  "bugs": {
+    "url": "https://github.com/leancodepl/js_corelibrary/issues"
+  },
+  "description": "Common utility functions and React hooks for web applications",
+  "keywords": [
+    "utilities",
+    "react",
+    "hooks",
+    "helpers",
+    "typescript",
+    "javascript",
+    "leancode"
+  ],
+  "author": {
+    "name": "LeanCode",
+    "url": "https://leancode.co"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": false,
   "exports": {
     "./package.json": "./package.json",
     ".": {
       "module": "./index.esm.js",
-      "types": "./index.esm.d.ts",
+      "types": "./index.d.ts",
       "import": "./index.cjs.mjs",
       "default": "./index.cjs.js"
     }
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
-  "types": "./index.esm.d.ts"
+  "types": "./index.d.ts"
 }

package/index.cjs.d.ts

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

package/index.cjs.default.js

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

package/index.cjs.js

@@ -1,184 +0,0 @@
-'use strict';
-
-var invariant = require('tiny-invariant');
-var react = require('react');
-
-function addPrefix(object, prefix) {
-    return Object.fromEntries(Object.entries(object).map(([key, value])=>[
-            `${prefix}${key}`,
-            value
-        ]));
-}
-
-function transformFirst(value, transformFn) {
-    if (value.length === 0) {
-        return "";
-    }
-    return transformFn(value[0]) + value.slice(1);
-}
-function toLowerFirst(value) {
-    return transformFirst(value, (value)=>value.toLowerCase());
-}
-function toUpperFirst(value) {
-    return transformFirst(value, (value)=>value.toUpperCase());
-}
-
-function _extends() {
-    _extends = Object.assign || function assign(target) {
-        for(var i = 1; i < arguments.length; i++){
-            var source = arguments[i];
-            for(var key in source)if (Object.prototype.hasOwnProperty.call(source, key)) target[key] = source[key];
-        }
-        return target;
-    };
-    return _extends.apply(this, arguments);
-}
-
-function transformDeep(value, mode) {
-    if (value === null || value === undefined) {
-        return undefined;
-    }
-    if (Array.isArray(value)) {
-        return value.map((val)=>transformDeep(val, mode));
-    }
-    if (typeof value === "object") {
-        const transformKey = mode === "capitalize" ? toUpperFirst : toLowerFirst;
-        return Object.entries(value).reduce((accumulator, [key, value])=>_extends({}, accumulator, {
-                [transformKey(key)]: transformDeep(value, mode)
-            }), {});
-    }
-    return value;
-}
-function uncapitalizeDeep(value) {
-    return transformDeep(value, "uncapitalize");
-}
-function capitalizeDeep(value) {
-    return transformDeep(value, "capitalize");
-}
-
-function assertDefined(value, message) {
-    invariant(value !== undefined, message);
-}
-
-function assertNotNull(value, message) {
-    invariant(value !== null, message);
-}
-
-function assertNotEmpty(value, message) {
-    invariant(value !== null && value !== undefined, message);
-}
-
-function ensureDefined(value, message) {
-    assertDefined(value, message);
-    return value;
-}
-
-function ensureNotNull(value, message) {
-    assertNotNull(value, message);
-    return value;
-}
-
-function ensureNotEmpty(value, message) {
-    assertNotEmpty(value, message);
-    return value;
-}
-
-function downloadFile(dataOrUrl, options = {}) {
-    if (typeof dataOrUrl === "string") {
-        const { name } = options;
-        const a = document.createElement("a");
-        a.href = dataOrUrl;
-        a.target = "_blank";
-        if (name) a.download = name;
-        a.click();
-    } else {
-        const url = URL.createObjectURL(dataOrUrl);
-        downloadFile(url, options);
-        URL.revokeObjectURL(url);
-    }
-}
-
-function useRunInTask() {
-    const [runningTasks, setRunningTasks] = react.useState(0);
-    const runInTask = react.useCallback(async (task)=>{
-        setRunningTasks((runningTasks)=>runningTasks + 1);
-        try {
-            return await task();
-        } finally{
-            setRunningTasks((runningTasks)=>runningTasks - 1);
-        }
-    }, []);
-    return [
-        runningTasks > 0,
-        runInTask
-    ];
-}
-
-function useBoundRunInTask(block) {
-    const [isRunning, runInTask] = useRunInTask();
-    const runBlockInTask = react.useMemo(()=>block ? (...args)=>runInTask(()=>block(...args)) : undefined, [
-        block,
-        runInTask
-    ]);
-    return [
-        isRunning,
-        runBlockInTask
-    ];
-}
-
-function useKeyByRoute(routeMatches) {
-    const keys = [];
-    for(const key in routeMatches){
-        const matches = routeMatches[key];
-        if (Array.isArray(matches) ? matches.some((match)=>match !== null) : matches !== null) {
-            keys.push(key);
-        }
-    }
-    return keys;
-}
-
-function useSetUnset(set) {
-    return [
-        react.useCallback(()=>set(true), [
-            set
-        ]),
-        react.useCallback(()=>set(false), [
-            set
-        ])
-    ];
-}
-
-function useDialog(onAfterClose) {
-    const [isDialogOpen, setIsDialogOpen] = react.useState(false);
-    const [openDialog, closeDialog] = useSetUnset(setIsDialogOpen);
-    const close = react.useCallback(()=>{
-        closeDialog();
-        if (onAfterClose) setTimeout(onAfterClose);
-    }, [
-        closeDialog,
-        onAfterClose
-    ]);
-    return {
-        isDialogOpen,
-        openDialog,
-        closeDialog: close
-    };
-}
-
-exports.addPrefix = addPrefix;
-exports.assertDefined = assertDefined;
-exports.assertNotEmpty = assertNotEmpty;
-exports.assertNotNull = assertNotNull;
-exports.capitalizeDeep = capitalizeDeep;
-exports.downloadFile = downloadFile;
-exports.ensureDefined = ensureDefined;
-exports.ensureNotEmpty = ensureNotEmpty;
-exports.ensureNotNull = ensureNotNull;
-exports.toLowerFirst = toLowerFirst;
-exports.toUpperFirst = toUpperFirst;
-exports.uncapitalizeDeep = uncapitalizeDeep;
-exports.useBoundRunInTask = useBoundRunInTask;
-exports.useDialog = useDialog;
-exports.useKeyByRoute = useKeyByRoute;
-exports.useRunInTask = useRunInTask;
-exports.useSetUnset = useSetUnset;

package/index.cjs.mjs

@@ -1,2 +0,0 @@
-export * from './index.cjs.js';
-export { _default as default } from './index.cjs.default.js';

package/index.esm.d.ts

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

package/index.esm.js

@@ -1,166 +0,0 @@
-import invariant from 'tiny-invariant';
-import { useState, useCallback, useMemo } from 'react';
-
-function addPrefix(object, prefix) {
-    return Object.fromEntries(Object.entries(object).map(([key, value])=>[
-            `${prefix}${key}`,
-            value
-        ]));
-}
-
-function transformFirst(value, transformFn) {
-    if (value.length === 0) {
-        return "";
-    }
-    return transformFn(value[0]) + value.slice(1);
-}
-function toLowerFirst(value) {
-    return transformFirst(value, (value)=>value.toLowerCase());
-}
-function toUpperFirst(value) {
-    return transformFirst(value, (value)=>value.toUpperCase());
-}
-
-function _extends() {
-    _extends = Object.assign || function assign(target) {
-        for(var i = 1; i < arguments.length; i++){
-            var source = arguments[i];
-            for(var key in source)if (Object.prototype.hasOwnProperty.call(source, key)) target[key] = source[key];
-        }
-        return target;
-    };
-    return _extends.apply(this, arguments);
-}
-
-function transformDeep(value, mode) {
-    if (value === null || value === undefined) {
-        return undefined;
-    }
-    if (Array.isArray(value)) {
-        return value.map((val)=>transformDeep(val, mode));
-    }
-    if (typeof value === "object") {
-        const transformKey = mode === "capitalize" ? toUpperFirst : toLowerFirst;
-        return Object.entries(value).reduce((accumulator, [key, value])=>_extends({}, accumulator, {
-                [transformKey(key)]: transformDeep(value, mode)
-            }), {});
-    }
-    return value;
-}
-function uncapitalizeDeep(value) {
-    return transformDeep(value, "uncapitalize");
-}
-function capitalizeDeep(value) {
-    return transformDeep(value, "capitalize");
-}
-
-function assertDefined(value, message) {
-    invariant(value !== undefined, message);
-}
-
-function assertNotNull(value, message) {
-    invariant(value !== null, message);
-}
-
-function assertNotEmpty(value, message) {
-    invariant(value !== null && value !== undefined, message);
-}
-
-function ensureDefined(value, message) {
-    assertDefined(value, message);
-    return value;
-}
-
-function ensureNotNull(value, message) {
-    assertNotNull(value, message);
-    return value;
-}
-
-function ensureNotEmpty(value, message) {
-    assertNotEmpty(value, message);
-    return value;
-}
-
-function downloadFile(dataOrUrl, options = {}) {
-    if (typeof dataOrUrl === "string") {
-        const { name } = options;
-        const a = document.createElement("a");
-        a.href = dataOrUrl;
-        a.target = "_blank";
-        if (name) a.download = name;
-        a.click();
-    } else {
-        const url = URL.createObjectURL(dataOrUrl);
-        downloadFile(url, options);
-        URL.revokeObjectURL(url);
-    }
-}
-
-function useRunInTask() {
-    const [runningTasks, setRunningTasks] = useState(0);
-    const runInTask = useCallback(async (task)=>{
-        setRunningTasks((runningTasks)=>runningTasks + 1);
-        try {
-            return await task();
-        } finally{
-            setRunningTasks((runningTasks)=>runningTasks - 1);
-        }
-    }, []);
-    return [
-        runningTasks > 0,
-        runInTask
-    ];
-}
-
-function useBoundRunInTask(block) {
-    const [isRunning, runInTask] = useRunInTask();
-    const runBlockInTask = useMemo(()=>block ? (...args)=>runInTask(()=>block(...args)) : undefined, [
-        block,
-        runInTask
-    ]);
-    return [
-        isRunning,
-        runBlockInTask
-    ];
-}
-
-function useKeyByRoute(routeMatches) {
-    const keys = [];
-    for(const key in routeMatches){
-        const matches = routeMatches[key];
-        if (Array.isArray(matches) ? matches.some((match)=>match !== null) : matches !== null) {
-            keys.push(key);
-        }
-    }
-    return keys;
-}
-
-function useSetUnset(set) {
-    return [
-        useCallback(()=>set(true), [
-            set
-        ]),
-        useCallback(()=>set(false), [
-            set
-        ])
-    ];
-}
-
-function useDialog(onAfterClose) {
-    const [isDialogOpen, setIsDialogOpen] = useState(false);
-    const [openDialog, closeDialog] = useSetUnset(setIsDialogOpen);
-    const close = useCallback(()=>{
-        closeDialog();
-        if (onAfterClose) setTimeout(onAfterClose);
-    }, [
-        closeDialog,
-        onAfterClose
-    ]);
-    return {
-        isDialogOpen,
-        openDialog,
-        closeDialog: close
-    };
-}
-
-export { addPrefix, assertDefined, assertNotEmpty, assertNotNull, capitalizeDeep, downloadFile, ensureDefined, ensureNotEmpty, ensureNotNull, toLowerFirst, toUpperFirst, uncapitalizeDeep, useBoundRunInTask, useDialog, useKeyByRoute, useRunInTask, useSetUnset };

package/src/index.d.ts

@@ -1,16 +0,0 @@
-export * from "./lib/types";
-export * from "./lib/addPrefix";
-export * from "./lib/transformFirst";
-export * from "./lib/transformDeep";
-export * from "./lib/assertDefined";
-export * from "./lib/assertNotNull";
-export * from "./lib/assertNotEmpty";
-export * from "./lib/ensureDefined";
-export * from "./lib/ensureNotNull";
-export * from "./lib/ensureNotEmpty";
-export * from "./lib/downloadFile";
-export * from "./lib/hooks/useRunInTask";
-export * from "./lib/hooks/useBoundRunInTask";
-export * from "./lib/hooks/useKeyByRoute";
-export * from "./lib/hooks/useSetUnset";
-export * from "./lib/hooks/useDialog";

package/src/lib/addPrefix.d.ts

@@ -1,5 +0,0 @@
-type PrefixWith<T, TPrefix extends string> = {
-    [K in keyof T as K extends string ? `${TPrefix}${K}` : never]: T[K];
-};
-export declare function addPrefix<T extends object, TPrefix extends string>(object: T, prefix: TPrefix): PrefixWith<T, TPrefix>;
-export {};

package/src/lib/assertDefined.d.ts

@@ -1 +0,0 @@
-export declare function assertDefined<T>(value: T | undefined, message?: string): asserts value is T;

package/src/lib/assertNotEmpty.d.ts

@@ -1 +0,0 @@
-export declare function assertNotEmpty<T>(value: T | null | undefined, message?: string): asserts value is T;

package/src/lib/assertNotNull.d.ts

@@ -1 +0,0 @@
-export declare function assertNotNull<T>(value: T | null, message?: string): asserts value is T;

package/src/lib/downloadFile.d.ts

@@ -1,6 +0,0 @@
-type DownloadFileOptions = {
-    name?: string;
-};
-export declare function downloadFile(url: string, options?: DownloadFileOptions): void;
-export declare function downloadFile(obj: Blob | MediaSource, options?: DownloadFileOptions): void;
-export {};

package/src/lib/ensureDefined.d.ts

@@ -1 +0,0 @@
-export declare function ensureDefined<T>(value: T | undefined, message?: string): T;

package/src/lib/ensureNotEmpty.d.ts

@@ -1 +0,0 @@
-export declare function ensureNotEmpty<T>(value: T | null | undefined, message?: string): T;

package/src/lib/ensureNotNull.d.ts

@@ -1 +0,0 @@
-export declare function ensureNotNull<T>(value: T | null, message?: string): T;

package/src/lib/hooks/useBoundRunInTask.d.ts

@@ -1,4 +0,0 @@
-type AnyFunction = (...args: any[]) => any;
-export declare function useBoundRunInTask<T extends AnyFunction>(block: T): [boolean, T];
-export declare function useBoundRunInTask<T extends AnyFunction>(block: T | undefined): [boolean, T | undefined];
-export {};

package/src/lib/hooks/useDialog.d.ts

@@ -1,5 +0,0 @@
-export declare function useDialog(onAfterClose?: () => void): {
-    isDialogOpen: boolean;
-    openDialog: () => void;
-    closeDialog: () => void;
-};

package/src/lib/hooks/useKeyByRoute.d.ts

@@ -1 +0,0 @@
-export declare function useKeyByRoute<TKey extends string>(routeMatches: Record<TKey, (object | null)[] | never | object | null>): TKey[];

package/src/lib/hooks/useRunInTask.d.ts

@@ -1 +0,0 @@
-export declare function useRunInTask(): readonly [boolean, <T>(task: () => Promise<T> | T) => Promise<T>];

package/src/lib/hooks/useSetUnset.d.ts

@@ -1,2 +0,0 @@
-import { Dispatch, SetStateAction } from "react";
-export declare function useSetUnset(set: Dispatch<SetStateAction<boolean>>): readonly [() => void, () => void];

package/src/lib/transformDeep.d.ts

@@ -1,3 +0,0 @@
-import { CapitalizeDeep, UncapitalizeDeep } from "./types";
-export declare function uncapitalizeDeep<T>(value: T): UncapitalizeDeep<T>;
-export declare function capitalizeDeep<T>(value: T): CapitalizeDeep<T>;

package/src/lib/transformFirst.d.ts

@@ -1,2 +0,0 @@
-export declare function toLowerFirst(value: string): string;
-export declare function toUpperFirst(value: string): string;

package/src/lib/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./transformDeep";
-export * from "./unpromisify";

package/src/lib/types/transformDeep.d.ts

@@ -1,10 +0,0 @@
-import type { ApiDateOnly, ApiDateTimeOffset, ApiTimeOnly, ApiTimeSpan } from "@leancodepl/api-date";
-export type Mode = "capitalize" | "uncapitalize";
-export type TransformDeep<T, TMode extends Mode> = T extends Array<infer TArrayElement> ? Array<TransformDeep<TArrayElement, TMode>> : T extends object ? T extends ApiDateOnly | ApiDateTimeOffset | ApiTimeOnly | ApiTimeSpan ? T : {
-    [TKey in keyof T as TKey extends string ? TMode extends "uncapitalize" ? Uncapitalize<TKey> : Capitalize<TKey> : TKey]: TransformDeep<T[TKey], TMode>;
-} : T extends null ? undefined : T;
-export type UncapitalizeDeep<T> = TransformDeep<T, "uncapitalize">;
-export type CapitalizeDeep<T> = TransformDeep<T, "capitalize">;
-export type MutableDeep<T> = T extends bigint | boolean | Date | number | string | symbol | null | undefined ? T : T extends ReadonlyArray<infer ArrayType> ? Array<MutableDeep<ArrayType>> : {
-    -readonly [K in keyof T]: MutableDeep<T[K]>;
-};

package/src/lib/types/unpromisify.d.ts

@@ -1 +0,0 @@
-export type Unpromisify<T> = T extends Promise<infer TResult> ? TResult : T;