@koine/utils 2.0.0-beta.4 → 2.0.0-beta.42

package/removeTrailingSlash.d.ts

@@ -1,7 +1 @@
-/**
- * Strips out the trailing slash
- *
- * @category location
- */
-export declare function removeTralingSlash(urlLike?: string): string;
-export default removeTralingSlash;
+export declare let removeTralingSlash: (urlLike?: string | null) => string;

package/removeUrlQueryParams.d.ts

@@ -1,8 +1 @@
-/**
- * Remove the given keys from the given URL query parameters
- *
- * @category location
- * @pure
- */
-export declare function removeUrlQueryParams(url: string, paramsToRemove?: string[]): string;
-export default removeUrlQueryParams;
+export declare let removeUrlQueryParams: (url: string, paramsToRemove?: string[]) => string;

package/render.d.ts

@@ -8,45 +8,6 @@ type DefinitionExtended = {
 type Definitions = {
     [key: string]: DefinitionExtended;
 } & DefinitionExtended;
-/**
- * Returned render function
- */
 type RenderFunction = (data: object) => string;
-/**
- * Render template (adapted from doT.js)
- *
- * The data made available to the template is always on the `data` key, e.g.:
- * `renderer({ myVal: "xx" })`
- * ... will be accessible on
- * `<%= data.myVal %>`
- *
- * The default delimiters are customised to work without conflicts with Blade and Twig:
- * ```
- * <% %>	for evaluation
- * <%= %>	for interpolation
- * <%? %>	for conditionals
- * <%~ %>	for array iteration
- * <%# %>	for compile-time evaluation/includes and partials
- * <%## #%>	for compile-time defines
- *
- * Unsupported:
- * <%! %>	for interpolation with encoding
- * ```
- *
- * @example
- *
- * ```js
- * import { render } from "...";
- *
- * const data = { name: "XYZ" };
- * const tpl = `Hello <%= data.name %>`;
- * const renderer = render(tpl);
- *
- * console.log(renderer(data)); // outputs 'Hello XYZ'
- * ```
- *
- * @borrows [olado/doT by Laura Doktorova](https://github.com/olado/doT)
- * @see https://olado.github.io/doT/index.html
- */
-export declare const render: (tmpl: string, def?: Definitions) => RenderFunction;
-export default render;
+export declare let render: (tmpl: string, def?: Definitions) => RenderFunction;
+export {};

package/round.d.ts

@@ -0,0 +1,2 @@
+import type { AnythingFalsy } from "./types";
+export declare let round: (number: number, decimals?: AnythingFalsy | number, trailingZeroes?: 1 | boolean | AnythingFalsy) => number;

package/roundTo.d.ts

@@ -1,8 +1 @@
-/**
- * Round to given number of the given number of decimals
- *
- * @category math
- * @see https://stackoverflow.com/a/15762794/1938970
- */
-export declare function roundTo(num: number, decimals?: number): string;
-export default roundTo;
+export declare let roundTo: (num: number, decimals?: number) => string;

package/serializeCookie.d.ts

@@ -1,27 +1,2 @@
-/**
- * @file
- *
- * @category cookie
- *
- * All cookie related code is inspired and adapted from:
- * - [js-cookie](https://github.com/js-cookie/js-cookie)
- * - [cookie](https://github.com/jshttp/cookie)
- */
-import { type CookieAttributesServer } from "./cookie";
-/**
- * Serialize data into a cookie header.
- *
- * Serialize the a name value pair into a cookie string suitable for
- * http headers. An optional attributes object specified cookie parameters.
- *
- * serialize('foo', 'bar', { httpOnly: true })
- *   => "foo=bar; httpOnly"
- *
- * @category cookie
- *
- * All cookie related code is inspired and adapted from:
- * - [js-cookie](https://github.com/js-cookie/js-cookie)
- * - [cookie](https://github.com/jshttp/cookie)
- */
-export declare function serializeCookie(name: string, val: string, attributes?: CookieAttributesServer): string;
-export default serializeCookie;
+import type { CookieAttributesServer } from "./cookie";
+export declare let serializeCookie: (name: string, val: string, attributes?: CookieAttributesServer) => string;

package/setCookie.d.ts

@@ -1,10 +1,2 @@
 import { type CookieAttributesClient } from "./cookie";
-/**
- * @category cookie
- *
- * All cookie related code is inspired and adapted from:
- * - [js-cookie](https://github.com/js-cookie/js-cookie)
- * - [cookie](https://github.com/jshttp/cookie)
- */
-export declare function setCookie<T extends string = string>(name: string, value: string | T, attributes?: CookieAttributesClient): string | undefined;
-export default setCookie;
+export declare let setCookie: <T extends string = string>(name: string, value: string | T, attributes?: CookieAttributesClient) => string | undefined;

package/shuffle.d.ts

@@ -1,16 +1 @@
-/**
- * Creates an array of shuffled values, using a version of the
- * [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher-Yates_shuffle).
- *
- * @see lodash.shuffle
- * @since 0.1.0
- * @category arrays
- * @param {Array} array The array to shuffle.
- * @returns {Array} Returns the new shuffled array.
- * @example
- *
- * shuffle([1, 2, 3, 4])
- * // => [4, 1, 3, 2]
- */
-export declare function shuffle<T>(array: T[]): T[];
-export default shuffle;
+export declare let shuffle: <T>(array: T[]) => T[];

package/slugify.d.ts

@@ -1,11 +1 @@
-/**
- * Slugify a text
- *
- * - replaces the accented letters
- * - replaces the punctuation with dashes
- *
- * @category text
- * @see https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021
- */
-export declare function slugify(text: string, separator?: string): string;
-export default slugify;
+export declare let slugify: (text: string, separator?: string) => string;

package/split.d.ts

@@ -1,3 +1,2 @@
 export type Split<S extends string, D extends string> = string extends S ? string[] : S extends "" ? [] : S extends `${infer T}${D}${infer U}` ? [T, ...Split<U, D>] : [S];
-export declare function split<T extends string, D extends string>(str: T, delimiter: D): Split<T, D>;
-export default split;
+export declare let split: <T extends string, D extends string>(string: T, delimiter: D) => Split<T, D>;

package/splitReverse.d.ts

@@ -0,0 +1,4 @@
+import type { Split } from "./split";
+import type { Reverse } from "./types";
+export type SplitReverse<S extends string, D extends string> = Reverse<Split<S, D>>;
+export declare let splitReverse: <T extends string, D extends string>(string: T, delimiter: D) => Reverse<Split<T, D>>;

package/swapMap.d.ts

@@ -1,7 +1 @@
-/**
- * Swap object map key/value
- *
- * @category objects
- */
-export declare function swapMap<T extends Record<string, string | number | symbol> = Record<string, string | number | symbol>>(map?: T): Record<T[keyof T], keyof T>;
-export default swapMap;
+export declare let swapMap: <T extends Record<string, string | number | symbol> = Record<string, string | number | symbol>>(map?: T) => Record<T[keyof T], keyof T>;

package/throttle.d.ts

@@ -1,9 +1,2 @@
 /// <reference types="node" />
-/**
- * Throttle function (e.g. for resize / scroll handlers)
- *
- * @category function
- * @see https://github.com/Mobius1/Rangeable/
- */
-export declare function throttle<TFn extends Function, TContext>(fn: TFn, limit: number, context?: TContext): (this: TContext, ...args: any[]) => NodeJS.Timeout | undefined;
-export default throttle;
+export declare let throttle: <TFn extends Function, TContext>(fn: TFn, limit: number, context?: TContext | undefined) => (this: TContext, ...args: any[]) => NodeJS.Timeout | undefined;

package/titleCase.d.ts

@@ -1,7 +1 @@
-/**
- * @category typography
- * @see https://github.com/blakeembrey/change-case/blob/master/packages/title-case/src/index.ts
- * @author Blake Embrey (hello@blakeembrey.com)
- */
-export declare const titleCase: (input?: null | string) => string;
-export default titleCase;
+export declare let titleCase: (input?: null | string) => string;

package/toNumber.d.ts

@@ -1,5 +1 @@
-/**
- * @category cast
- */
-export declare function toNumber(input?: string | number, fallback?: number): number;
-export default toNumber;
+export declare let toNumber: (input?: string | number, fallback?: number) => number;

package/toRgba.d.ts

@@ -1,5 +1 @@
-/**
- * @category colors
- */
-export declare function toRgba(hex: string, alpha?: number): string;
-export default toRgba;
+export declare let toRgba: (hex: string, alpha?: number) => string;

package/transformToUrlPathname.d.ts

@@ -1,11 +1 @@
-/**
- * Transform string in a URL pathname (relative URL)
- *
- * - adds an initial slash
- * - encode the string
- * - replaces whitespaces with dashes
- *
- * @category location
- */
-export declare function transformToUrlPathname(toPathname?: string): string;
-export default transformToUrlPathname;
+export declare let transformToUrlPathname: (toPathname?: string) => string;

package/truncate.d.ts

@@ -1,7 +1 @@
-/**
- * Truncate string
- *
- * @category typography
- */
-export declare const truncate: (input: undefined | null | string, length: number) => string;
-export default truncate;
+export declare let truncate: (input: undefined | null | string, length: number) => string;

package/tryUntil.d.ts

@@ -1,8 +1 @@
-/**
- * @borrows [https://levelup.gitconnected.com/javascript-wait-until-something-happens-or-timeout-82636839ea93]
- *
- * @param timeout in `ms`
- * @param interval in `ms`
- */
-export declare const tryUntil: (test: () => boolean, timeout: number, interval: number, resolve: () => void, reject?: () => void) => void;
-export default tryUntil;
+export declare let tryUntil: (test: () => boolean, timeout: number, interval: number, resolve: () => void, reject?: () => void) => void;

package/types.d.ts

@@ -1,28 +1,11 @@
 import type { Replace } from "type-fest";
-/**
- * Whatever that in javascript returns `false` when checked in an `if` condition
- */
 export type AnythingFalsy = null | undefined | 0 | "";
-/**
- * Pick the keys of an object `T` that starts with `S`. It produces a mapped type
- * with a subset of `T` whose keys start with `S`.
- */
 export type PickStartsWith<T extends object, S extends string> = {
     [K in keyof T as K extends `${S}${string}` ? K : never]: T[K];
 };
-/**
- * Returns a union of all the keys of an object `T` which starts with `S`.
- */
 export type KeysStartsWith<T extends object, S extends string> = keyof PickStartsWith<T, S>;
-/**
- * Pick the keys of an object `T` that starts with `S`. It produces a mapped type
- * with a subset of `T` whose keys start with `S` *and have `S`* removed.
- */
 export type PickStartsWithTails<T extends object, S extends string> = {
     [K in keyof T as K extends `${S}${string}` ? Replace<K, S, ""> : never]: T[K];
 };
-/**
- * Returns a union of all the keys of an object `T` which starts with `S`.
- * The strings in the produced union *have `S` removed*.
- */
 export type KeysTailsStartsWith<T extends object, S extends string> = keyof PickStartsWithTails<T, S>;
+export type Reverse<Tuple> = Tuple extends [infer Head, ...infer Rest] ? [...Reverse<Rest>, Head] : [];

package/typings.d.ts

@@ -1,9 +1,35 @@
 /**
  * List here the global variables used by third party scripts supported within
- * the `koine` ecosystem. For instance Google Analytics globally available
- * variables.
+ * the `koine` ecosystem.
  */
 
-// declare type NullableRecord<T> = {
-//   [K in keyof T]: T[K] | null;
-// };
+// as in type-fest start
+declare type Simplify<T> = { [KeyType in keyof T]: T[KeyType] };
+// as in type-fest end
+
+/**
+ * Tweak a model by making some properties required (not `optional` and not `nullable`)
+ *
+ * This is useful to tweak/correct the types generated from Swagger.
+ */
+declare type Tweak<
+  TModel extends object,
+  TRequiredKeys extends keyof TModel | never,
+  TReplacements extends Partial<Record<keyof TModel, unknown>> | false = false,
+> = TReplacements extends false
+  ? Simplify<
+      Omit<TModel, TRequiredKeys> &
+        Required<{
+          [K in TRequiredKeys]: NonNullable<TModel[K]>;
+        }>
+    >
+  : Simplify<
+      Omit<
+        Omit<TModel, TRequiredKeys> &
+          Required<{
+            [K in TRequiredKeys]: NonNullable<TModel[K]>;
+          }>,
+        keyof TReplacements
+      > &
+        TReplacements
+    >;

package/uid.d.ts

@@ -1,7 +1 @@
-/**
- * Super basic UID increment-based generator
- *
- * @category uid
- */
-export declare const uid: (prefix?: string) => string;
-export default uid;
+export declare let uid: (prefix?: string) => string;

package/updateLinkParams.d.ts

@@ -1,10 +1,2 @@
-import { type AnyQueryParams } from "./location";
-/**
- * Update link `<a href="">` merging the given new query parameters.
- * it returns the newly created `href` URL value
- *
- * @category location
- * @pure
- */
-export declare function updateLinkParams($anchor: HTMLAnchorElement, newParams: NonNullable<AnyQueryParams>): string;
-export default updateLinkParams;
+import type { AnyQueryParams } from "./location";
+export declare let updateLinkParams: ($anchor: HTMLAnchorElement, newParams: NonNullable<AnyQueryParams>) => string;

package/updateUrlQueryParams.d.ts

@@ -1,9 +1,2 @@
-import { type AnyQueryParams } from "./location";
-/**
- * Update a URL string query parameters merging the given new query parameters
- *
- * @category location
- * @pure
- */
-export declare function updateUrlQueryParams(url: string, newParams?: NonNullable<AnyQueryParams>): string;
-export default updateUrlQueryParams;
+import type { AnyQueryParams } from "./location";
+export declare let updateUrlQueryParams: (url: string, newParams?: NonNullable<AnyQueryParams>) => string;

package/uppercase.d.ts

@@ -1,7 +1 @@
-/**
- * Replacement for native `toUpperCase` tyescript ready (type narrowing ready)
- *
- * @category native
- */
-export declare const uppercase: <T extends string>(str?: T | null | undefined) => Uppercase<T>;
-export default uppercase;
+export declare let uppercase: <T extends string>(str?: T | null | undefined) => Uppercase<T>;

package/uuid.d.ts

@@ -1,8 +1 @@
-/**
- * Uuid, tiny custom helper instead of node's uuid/v4
- *
- * @category uid
- * @see https://stackoverflow.com/a/2117523/1938970
- */
-export declare const uuid: () => string;
-export default uuid;
+export declare let uuid: () => string;

package/uuidNumeric.d.ts

@@ -1,6 +1 @@
-/**
- * @category uid
- * @see https://stackoverflow.com/a/18048162/1938970
- */
-export declare const uuidNumeric: () => number;
-export default uuidNumeric;
+export declare let uuidNumeric: () => number;

package/wait.d.ts

@@ -1,7 +1 @@
-/**
- * A promisified `setTimeout`
- *
- * @category async
- */
-export declare const wait: (milliseconds: number) => Promise<unknown>;
-export default wait;
+export declare let wait: (milliseconds: number) => Promise<unknown>;

package/Defer.js

@@ -1,35 +0,0 @@
-/**
- * @category async
- */ "use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    Defer: function() {
-        return Defer;
-    },
-    default: function() {
-        return _default;
-    }
-});
-function Defer() /* : PromiseConstructor */ {
-    // @ts-expect-error nevermind
-    const self = this || {};
-    const p = self.promise = new Promise((resolve, reject)=>{
-        self.resolve = resolve;
-        self.reject = reject;
-    });
-    self.then = p.then.bind(p);
-    self.catch = p.catch.bind(p);
-    // if (p.finally) {
-    //   self.finally = p.finally.bind(p);
-    // }
-    return self;
-}
-const _default = Defer;

package/Defer.mjs

@@ -1,27 +0,0 @@
-/**
- * @category async
- */ /**
- * @category async
- * @see https://stackoverflow.com/a/37673534/1938970
- * @example
- *
- * ```ts
- * const deferred = Defer();
- * deferred.resolve();
- * deferred.then(handleSuccess, handleError);
- * ```
- */ export function Defer() /* : PromiseConstructor */ {
-    // @ts-expect-error nevermind
-    const self = this || {};
-    const p = self.promise = new Promise((resolve, reject)=>{
-        self.resolve = resolve;
-        self.reject = reject;
-    });
-    self.then = p.then.bind(p);
-    self.catch = p.catch.bind(p);
-    // if (p.finally) {
-    //   self.finally = p.finally.bind(p);
-    // }
-    return self;
-}
-export default Defer;

package/Emitter.js

@@ -1,53 +0,0 @@
-/**
- * Emitter super simple class
- *
- * Events will be prefixed with the given `namespace` plus a `.` so:
- * `{namespace}.myevent`
- *
- * Adapted from https://github.com/developit/mitt
- *
- * Regarding typescript support @see:
- * - https://stackoverflow.com/q/53299743/1938970
- * - https://github.com/Microsoft/TypeScript/pull/26349
- */ "use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    Emitter: function() {
-        return Emitter;
-    },
-    default: function() {
-        return _default;
-    }
-});
-function Emitter(namespace) {
-    const all = new Map();
-    return {
-        /**
-     * Register an event handler for the given type.
-     */ on (name, handler) {
-            const handlers = all.get(`${namespace}.${String(name)}`);
-            const added = handlers && handlers.push(handler);
-            if (!added) {
-                all.set(`${namespace}.${String(name)}`, [
-                    handler
-                ]);
-            }
-        },
-        /**
-     * Invoke all handlers for the given type.
-     */ emit (name, data) {
-            (all.get(`${namespace}.${String(name)}`) || []).slice().map((handler)=>{
-                handler(data);
-            });
-        }
-    };
-}
-const _default = Emitter;

package/Emitter.mjs

@@ -1,35 +0,0 @@
-/**
- * Emitter super simple class
- *
- * Events will be prefixed with the given `namespace` plus a `.` so:
- * `{namespace}.myevent`
- *
- * Adapted from https://github.com/developit/mitt
- *
- * Regarding typescript support @see:
- * - https://stackoverflow.com/q/53299743/1938970
- * - https://github.com/Microsoft/TypeScript/pull/26349
- */ export function Emitter(namespace) {
-    const all = new Map();
-    return {
-        /**
-     * Register an event handler for the given type.
-     */ on (name, handler) {
-            const handlers = all.get(`${namespace}.${String(name)}`);
-            const added = handlers && handlers.push(handler);
-            if (!added) {
-                all.set(`${namespace}.${String(name)}`, [
-                    handler
-                ]);
-            }
-        },
-        /**
-     * Invoke all handlers for the given type.
-     */ emit (name, data) {
-            (all.get(`${namespace}.${String(name)}`) || []).slice().map((handler)=>{
-                handler(data);
-            });
-        }
-    };
-}
-export default Emitter;