@minvws/mgo-utils 0.1.1-11

package/LICENSE.md

@@ -0,0 +1,7 @@
+The source code is released under the [EUPL license](./LICENSES/EUPL-1.2.txt).
+The documentation is released under the [CC0 license](./LICENSES/CC0-1.0.txt).
+The EUPL 1.2 and the CC0 do not apply to photos, videos, infographics, fonts or other forms of media.
+Specifically the rijkslogo and rijkshuisstijl have specific [terms of use](./LICENSES/LicenseRef-Rijkshuisstijl.txt).
+
+This repository follows the [REUSE Specfication v3.3](https://reuse.software/spec/).
+Please see [REUSE.toml](./REUSE.toml) and the individual `*.license` files for copyright and license information.

package/README.md

@@ -0,0 +1,36 @@
+# @minvws/mgo-utils
+
+This package contains commonly used utility functions within [MGO][repo].
+
+## Installation
+
+```shell
+npm i --save @minvws/mgo-utils
+
+# or
+
+pnpm add @minvws/mgo-utils
+```
+
+## Use
+
+```typescript
+
+import { isNullish } from '@minvws/mgo-utils'
+
+...
+
+if( isNullish(value) ) {
+    ...
+}
+
+```
+
+See the **[package source][source]** for more details
+
+<hr>
+
+_This package and its documentation are still under development._
+
+[repo]: https://github.com/minvws/nl-mgo-app-web
+[source]: https://github.com/minvws/nl-mgo-app-web/tree/main/packages/utils

package/dist/defer/defer.d.ts

@@ -0,0 +1,7 @@
+export interface Deferred<T> {
+    promise: Promise<T>;
+    resolve: (value: T) => void;
+    reject: (error: Error) => void;
+}
+export declare function defer<T = unknown>(): Deferred<T>;
+//# sourceMappingURL=defer.d.ts.map

package/dist/defer/defer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defer.d.ts","sourceRoot":"","sources":["../../src/defer/defer.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ,CAAC,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAC5B,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAED,wBAAgB,KAAK,CAAC,CAAC,GAAG,OAAO,iBAOhC"}

package/dist/defer/defer.js

@@ -0,0 +1,8 @@
+export function defer() {
+    const deferred = {};
+    deferred.promise = new Promise((resolve, reject) => {
+        deferred.resolve = resolve;
+        deferred.reject = reject;
+    });
+    return deferred;
+}

package/dist/flushCallStack/flushCallStack.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Flushes the Promise stack by awaiting a new immediate Promise.
+ * @returns {Promise<void>} The Promise to be awaited for flush
+ */
+export declare function flushCallStack(stackCount?: number): Promise<void>;
+//# sourceMappingURL=flushCallStack.d.ts.map

package/dist/flushCallStack/flushCallStack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flushCallStack.d.ts","sourceRoot":"","sources":["../../src/flushCallStack/flushCallStack.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,wBAAsB,cAAc,CAAC,UAAU,SAAI,iBAKlD"}

package/dist/flushCallStack/flushCallStack.js

@@ -0,0 +1,12 @@
+// save reference to the real setTimeout so we can still flush the callstack even when timers are faked.
+const realSetTimeout = setTimeout;
+/**
+ * Flushes the Promise stack by awaiting a new immediate Promise.
+ * @returns {Promise<void>} The Promise to be awaited for flush
+ */
+export async function flushCallStack(stackCount = 1) {
+    while (stackCount >= 1) {
+        await new Promise((resolve) => realSetTimeout(resolve));
+        stackCount--;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from './types/index.js';
+export * from './defer/defer.js';
+export * from './flushCallStack/flushCallStack.js';
+export * from './isNonNullish/isNonNullish.js';
+export * from './isNullish/isNullish.js';
+export * from './log/log.js';
+export * from './lossless/lossless.js';
+export * from './map/map.js';
+export * from './uniqueSlug/uniqueSlug.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AAEjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oCAAoC,CAAC;AACnD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC;AACvC,cAAc,cAAc,CAAC;AAC7B,cAAc,4BAA4B,CAAC"}

package/dist/index.js

@@ -0,0 +1,9 @@
+export * from './types/index.js';
+export * from './defer/defer.js';
+export * from './flushCallStack/flushCallStack.js';
+export * from './isNonNullish/isNonNullish.js';
+export * from './isNullish/isNullish.js';
+export * from './log/log.js';
+export * from './lossless/lossless.js';
+export * from './map/map.js';
+export * from './uniqueSlug/uniqueSlug.js';

package/dist/isNonNullish/isNonNullish.d.ts

@@ -0,0 +1,2 @@
+export declare function isNonNullish<T>(value?: T): value is NonNullable<typeof value>;
+//# sourceMappingURL=isNonNullish.d.ts.map

package/dist/isNonNullish/isNonNullish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isNonNullish.d.ts","sourceRoot":"","sources":["../../src/isNonNullish/isNonNullish.ts"],"names":[],"mappings":"AAEA,wBAAgB,YAAY,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,WAAW,CAAC,OAAO,KAAK,CAAC,CAE7E"}

package/dist/isNonNullish/isNonNullish.js

@@ -0,0 +1,4 @@
+import { isNullish } from '../isNullish/isNullish.js';
+export function isNonNullish(value) {
+    return !isNullish(value);
+}

package/dist/isNullish/isNullish.d.ts

@@ -0,0 +1,3 @@
+export type Nullish<T> = Extract<T, undefined | null>;
+export declare function isNullish<T>(value: T): value is Nullish<T>;
+//# sourceMappingURL=isNullish.d.ts.map

package/dist/isNullish/isNullish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isNullish.d.ts","sourceRoot":"","sources":["../../src/isNullish/isNullish.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC,CAAC;AAEtD,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,CAE1D"}

package/dist/isNullish/isNullish.js

@@ -0,0 +1,3 @@
+export function isNullish(value) {
+    return value === undefined || value === null;
+}

package/dist/log/log.d.ts

@@ -0,0 +1,11 @@
+declare function logWarning(message?: any, ...optionalParams: any[]): void;
+declare function logError(message?: any, ...optionalParams: any[]): void;
+/**
+ * A very simple utility to log warning or error messages during vite development mode
+ */
+export declare const log: {
+    warn: typeof logWarning;
+    error: typeof logError;
+};
+export {};
+//# sourceMappingURL=log.d.ts.map

package/dist/log/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../src/log/log.ts"],"names":[],"mappings":"AAEA,iBAAS,UAAU,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,QAI1D;AAED,iBAAS,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,QAIxD;AAED;;GAEG;AACH,eAAO,MAAM,GAAG;;;CAGf,CAAC"}

package/dist/log/log.js

@@ -0,0 +1,18 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+function logWarning(message, ...optionalParams) {
+    if (import.meta?.env?.DEV) {
+        console.warn(message, ...optionalParams);
+    }
+}
+function logError(message, ...optionalParams) {
+    if (import.meta?.env?.DEV) {
+        console.error(message, ...optionalParams);
+    }
+}
+/**
+ * A very simple utility to log warning or error messages during vite development mode
+ */
+export const log = {
+    warn: logWarning,
+    error: logError,
+};

package/dist/lossless/DeepReplaceType.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Perform a deep replacement of a type in another type definition.
+ *
+ * @example
+ * type Foo =  { foo: string; bar: number; baz: { qux: number } }
+ * DeepReplaceType<Foo, number, boolean> // { foo: string, bar: boolean, baz: { qux: boolean } }
+ * DeepReplaceType<number, number, boolean> // boolean
+ * DeepReplaceType<number | string, number, boolean> // boolean | string
+ * DeepReplaceType<(number | string)[], number, boolean> // (boolean | string)[]
+ */
+export type DeepReplaceType<T, ToReplace, Replacement> = T extends ToReplace ? Exclude<T, ToReplace> | Replacement : T extends object ? DeepReplaceTypeInObject<T, ToReplace, Replacement> : T;
+type DeepReplaceTypeInObject<T extends object, ToReplace, Replacement> = {
+    [key in keyof T]: T[key] extends object ? DeepReplaceTypeInObject<T[key], ToReplace, Replacement> : T[key] extends (infer U)[] ? DeepReplaceType<U, ToReplace, Replacement>[] : DeepReplaceType<T[key], ToReplace, Replacement>;
+};
+export {};
+//# sourceMappingURL=DeepReplaceType.d.ts.map

package/dist/lossless/DeepReplaceType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeepReplaceType.d.ts","sourceRoot":"","sources":["../../src/lossless/DeepReplaceType.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,IAAI,CAAC,SAAS,SAAS,GACtE,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG,WAAW,GACnC,CAAC,SAAS,MAAM,GACd,uBAAuB,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,GAClD,CAAC,CAAC;AAEV,KAAK,uBAAuB,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,WAAW,IAAI;KACpE,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,GACjC,uBAAuB,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,GACvD,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GACxB,eAAe,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,EAAE,GAC5C,eAAe,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC;CAC1D,CAAC"}

package/dist/lossless/DeepReplaceType.js

@@ -0,0 +1 @@
+export {};

package/dist/lossless/lossless.d.ts

@@ -0,0 +1,12 @@
+import { stringify, type LosslessNumber } from 'lossless-json';
+import { type DeepReplaceType } from './DeepReplaceType.js';
+export type { LosslessNumber };
+export type LosslessObject<T = unknown> = DeepReplaceType<T, number, LosslessNumber>;
+export type Lossless<T> = T extends number ? LosslessNumber : T extends object ? LosslessObject<T> : T;
+/**
+ * Prevent loss of precision when parsing JSON numbers.
+ * @see https://www.hl7.org/fhir/json.html#primitive
+ */
+export declare function losslessParse<T = any>(text: string): LosslessObject<T>;
+export declare const losslessStringify: typeof stringify;
+//# sourceMappingURL=lossless.d.ts.map

package/dist/lossless/lossless.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lossless.d.ts","sourceRoot":"","sources":["../../src/lossless/lossless.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,YAAY,EAAE,cAAc,EAAE,CAAC;AAE/B,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,OAAO,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;AAErF,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACpC,cAAc,GACd,CAAC,SAAS,MAAM,GACd,cAAc,CAAC,CAAC,CAAC,GACjB,CAAC,CAAC;AAEV;;;GAGG;AAGH,wBAAgB,aAAa,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,CAMtE;AAED,eAAO,MAAM,iBAAiB,kBAAY,CAAC"}

package/dist/lossless/lossless.js

@@ -0,0 +1,13 @@
+import { parse, stringify } from 'lossless-json';
+/**
+ * Prevent loss of precision when parsing JSON numbers.
+ * @see https://www.hl7.org/fhir/json.html#primitive
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function losslessParse(text) {
+    if (typeof text !== 'string') {
+        throw new Error('Input is not a (JSON) string');
+    }
+    return parse(text);
+}
+export const losslessStringify = stringify;

package/dist/map/map.d.ts

@@ -0,0 +1,23 @@
+import { type Nullable } from '../types/Nullable.js';
+/**
+ * Creates an array of values by running each element in collection thru iteratee.
+ * If the collection is empty or undefined it will return undefined, unless the `returnEmpty` parameter is set to true.
+ * The resulting array will NOT contain any undefined or null values.
+ *
+ * NOTE:
+ * The return type uses `& {}` which is the same as using `NonNullable<T>`.
+ * However having the return type wrapped inside another generic type doesn't
+ * translate well when exporting the types to the json schema as it loses the
+ * reference to the original type.
+ *
+ * @example
+ * const iteratee = (x: string | null | undefined) => x;
+ * map(undefined, iteratee); // => undefined
+ * map(undefined, iteratee, true); // => []
+ * map([], iteratee); // => undefined
+ * map(['foo', 'bar'], iteratee); // => ['foo', 'bar']
+ * map(['foo', undefined, 'bar', null, undefined], iteratee); // => ['foo', 'bar']
+ */
+export declare function map<Items extends unknown[], Iteratee extends (arg: Items[number], key: number) => unknown, T = ReturnType<Iteratee> & {}>(items: Nullable<Items>, iteratee: Iteratee, returnEmpty: true): T[];
+export declare function map<Items extends unknown[], Iteratee extends (arg: Items[number], key: number) => unknown, T = ReturnType<Iteratee> & {}>(items: Nullable<Items>, iteratee: Iteratee, returnEmpty?: false): T[] | undefined;
+//# sourceMappingURL=map.d.ts.map

package/dist/map/map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../../src/map/map.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAErD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,GAAG,CACf,KAAK,SAAS,OAAO,EAAE,EACvB,QAAQ,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,EAC7D,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE,EAC/B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,GAAG,CAAC,EAAE,CAAC;AACtE,wBAAgB,GAAG,CACf,KAAK,SAAS,OAAO,EAAE,EACvB,QAAQ,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,EAC7D,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE,EAC/B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,SAAS,CAAC"}

package/dist/map/map.js

@@ -0,0 +1,7 @@
+import { isNonNullish } from '../isNonNullish/isNonNullish.js';
+export function map(items, iteratee, returnEmpty = false) {
+    if (!items?.length) {
+        return returnEmpty ? [] : undefined;
+    }
+    return items.map(iteratee).filter(isNonNullish);
+}

package/dist/types/Nullable.d.ts

@@ -0,0 +1,2 @@
+export type Nullable<T> = T | null | undefined;
+//# sourceMappingURL=Nullable.d.ts.map

package/dist/types/Nullable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Nullable.d.ts","sourceRoot":"","sources":["../../src/types/Nullable.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC"}

package/dist/types/Nullable.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Nullable.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/types/index.js

@@ -0,0 +1 @@
+export * from './Nullable.js';

package/dist/uniqueSlug/uniqueSlug.d.ts

@@ -0,0 +1,2 @@
+export declare function createUniqueSlug(value: string, existingSlugs: string[]): string;
+//# sourceMappingURL=uniqueSlug.d.ts.map

package/dist/uniqueSlug/uniqueSlug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniqueSlug.d.ts","sourceRoot":"","sources":["../../src/uniqueSlug/uniqueSlug.ts"],"names":[],"mappings":"AAEA,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,UAStE"}

package/dist/uniqueSlug/uniqueSlug.js

@@ -0,0 +1,11 @@
+import { kebabCase } from 'lodash-es';
+export function createUniqueSlug(value, existingSlugs) {
+    const slug = kebabCase(value);
+    let uniqueSlug = slug;
+    let i = 2;
+    while (existingSlugs.includes(uniqueSlug)) {
+        uniqueSlug = `${slug}-${i}`;
+        i++;
+    }
+    return uniqueSlug;
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@minvws/mgo-utils",
+  "license": "EUPL-1.2",
+  "type": "module",
+  "version": "0.1.1-11",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/minvws/nl-mgo-app-web"
+  },
+  "files": [
+    "dist/"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "development": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./test/shared": {
+      "development": "./test/shared/index.ts"
+    }
+  },
+  "dependencies": {
+    "lodash-es": "^4.17.21",
+    "lossless-json": "^4.0.1"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "^8.4.1",
+    "@types/lodash-es": "^4.17.12",
+    "type-fest": "^4.23.0",
+    "typescript": "^5.4.5"
+  },
+  "scripts": {}
+}