@oliversalzburg/js-utils 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Oliver Salzburg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+# Project Template
+
+## Does
+
+-   [Yarn 3](https://yarnpkg.com/)
+-   Uses [TypeScript](https://www.typescriptlang.org/)
+-   Target application runs in [Node.js](https://nodejs.org/)
+-   [esbuild](https://esbuild.github.io/)
+-   [EditorConfig](https://editorconfig.org/) + [ESLint](https://eslint.org/) + [Prettier](https://prettier.io/) + [lint-staged](https://github.com/okonet/lint-staged)
+-   QA with [GitHub Actions](https://github.com/features/actions)
+-   [MkDocs](https://www.mkdocs.org/)-oriented Markdown in mind
+
+## Doesn't
+
+-   [Yarn PnP](https://yarnpkg.com/features/pnp)
+-   [Yarn telemetry](https://yarnpkg.com/advanced/telemetry)
+-   [Yarn Zero-Installs](https://yarnpkg.com/features/zero-installs)
+-   [Husky](https://github.com/typicode/husky)
+
+## Why
+
+1.  Why modern Yarn?
+
+    Among other things, Yarn is robust, performant and extremely versatile when it comes to repository management. The given configuration provides a very solid first-time experience. Some of the things that make modern Yarn great can be seen in this project template.
+
+1.  Why esbuild?
+
+    We want fast builds. The code is still checked for correctness in the editor and in CI.
+
+1.  Why the MkDocs Markdown?
+
+    If you're going to want to build any documentation site, you will appreciate having auto-formatted to this style from the start. Using mkdocs-material for documentation sites is highly recommended. The Python Markdown ecosystem is much more versatile and performant than the JS/TS space.
+
+1.  Why is PnP disabled?
+
+    While PnP is generally preferred for its strictness, using it still incurs a lot of friction. Because PnP is enabled by default in modern Yarn, this deters many users from adopting modern Yarn. Thus, this project uses Yarn's `node-modules` linker, the behavior of which should be very familiar to most adopters.
+
+1.  Why is telemetry disabled?
+
+    Whenever possible, the disclosure of _any_ data should be opt-in. Please refer to the document linked above, and enable telemetry after carefully reading it.
+
+1.  Why not Zero-Installs?
+
+    Zero-Installs are purely a `.gitignore`-controlled feature. Most new adopters do not expect the behavior of the default configuration and some adopters have raised concerns over long-term effects. Enable it after carefully reading the article linked above.
+
+1.  Why not use Husky for the hook?
+
+    Husky is more complex than what is required to install the hook in a modern Yarn repository. We also do not want to hand over control over repository behavior to a dependency.

package/output/array.d.ts

@@ -0,0 +1,5 @@
+import { ConstructorOf } from "./nil.js";
+export declare const shuffleArray: <T>(array: T[]) => T[];
+export declare const intersect: <T>(a: T[], b: T[]) => T[];
+export declare const difference: <T>(a: T[], b: T[]) => T[];
+export declare const filterType: <T>(array: Array<unknown>, InstanceType: ConstructorOf<T>) => T[];

package/output/array.js

@@ -0,0 +1,18 @@
+import { is } from "./nil.js";
+export const shuffleArray = (array) => {
+    for (let index = array.length - 1; index > 0; index--) {
+        const targetIndex = Math.floor(Math.random() * (index + 1));
+        const temp = array[index];
+        array[index] = array[targetIndex];
+        array[targetIndex] = temp;
+    }
+    return array;
+};
+export const intersect = (a, b) => {
+    return a.filter(x => b.includes(x));
+};
+export const difference = (a, b) => {
+    return a.filter(x => !b.includes(x));
+};
+export const filterType = (array, InstanceType) => array.filter(element => is(element, InstanceType));
+//# sourceMappingURL=array.js.map

package/output/array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../source/array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,EAAE,EAAE,MAAM,UAAU,CAAC;AAE7C,MAAM,CAAC,MAAM,YAAY,GAAG,CAAI,KAAe,EAAE,EAAE;IACjD,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE;QACrD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1B,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QAClC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;KAC3B;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAI,CAAW,EAAE,CAAW,EAAE,EAAE;IACvD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAI,CAAW,EAAE,CAAW,EAAE,EAAE;IACxD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAI,KAAqB,EAAE,YAA8B,EAAE,EAAE,CACrF,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAa,CAAC"}

package/output/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./array.js";
+export * from "./nil.js";
+export * from "./sleep.js";

package/output/index.js

@@ -0,0 +1,4 @@
+export * from "./array.js";
+export * from "./nil.js";
+export * from "./sleep.js";
+//# sourceMappingURL=index.js.map

package/output/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC"}

package/output/nil.d.ts

@@ -0,0 +1,30 @@
+export type Nil = null | undefined;
+export type Maybe<T> = T | Nil;
+/**
+ * Describes a function that is a constructor for T.
+ */
+export type ConstructorOf<T = Record<string, unknown>> = new (...args: any[]) => T;
+/**
+ * Check if something is a concrete value of the given type.
+ * Can be used as a typeguard.
+ *
+ * @param nilable The subject that could be nil.
+ * @param InstanceType The type to check against.
+ */
+export declare function is<T>(nilable: Maybe<T>, InstanceType: ConstructorOf<T>): nilable is T;
+/**
+ * Check if something is Nil.
+ * Can be used as a typeguard.
+ *
+ * @param subject The subject that could be nil.
+ */
+export declare function isNil<T>(subject: Maybe<T>): subject is Nil;
+export declare class UnexpectedNilError extends Error {
+    constructor(message?: string);
+}
+/**
+ * Ensure that the passed subject is not nil; throw otherwise.
+ *
+ * @param subject A subject that is possible nil.
+ */
+export declare function mustExist<T>(subject: Maybe<T>): T;

package/output/nil.js

@@ -0,0 +1,36 @@
+/**
+ * Check if something is a concrete value of the given type.
+ * Can be used as a typeguard.
+ *
+ * @param nilable The subject that could be nil.
+ * @param InstanceType The type to check against.
+ */
+export function is(nilable, InstanceType) {
+    return !isNil(nilable) && nilable instanceof InstanceType;
+}
+/**
+ * Check if something is Nil.
+ * Can be used as a typeguard.
+ *
+ * @param subject The subject that could be nil.
+ */
+export function isNil(subject) {
+    return subject === null || subject === undefined;
+}
+export class UnexpectedNilError extends Error {
+    constructor(message = "unexpected nil value") {
+        super(message);
+    }
+}
+/**
+ * Ensure that the passed subject is not nil; throw otherwise.
+ *
+ * @param subject A subject that is possible nil.
+ */
+export function mustExist(subject) {
+    if (isNil(subject)) {
+        throw new UnexpectedNilError();
+    }
+    return subject;
+}
+//# sourceMappingURL=nil.js.map

package/output/nil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nil.js","sourceRoot":"","sources":["../source/nil.ts"],"names":[],"mappings":"AAQA;;;;;;GAMG;AACH,MAAM,UAAU,EAAE,CAAI,OAAiB,EAAE,YAA8B;IACrE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,YAAY,YAAY,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAI,OAAiB;IACxC,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,CAAC;AACnD,CAAC;AAED,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAO,GAAG,sBAAsB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAI,OAAiB;IAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;QAClB,MAAM,IAAI,kBAAkB,EAAE,CAAC;KAChC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/output/sleep.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Wait a given period before continuing execution.
+ *
+ * @param duration How many milliseconds to wait.
+ */
+export declare function sleep(duration: number): Promise<void>;

package/output/sleep.js

@@ -0,0 +1,9 @@
+/**
+ * Wait a given period before continuing execution.
+ *
+ * @param duration How many milliseconds to wait.
+ */
+export function sleep(duration) {
+    return new Promise(resolve => setTimeout(resolve, duration));
+}
+//# sourceMappingURL=sleep.js.map

package/output/sleep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../source/sleep.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,KAAK,CAAC,QAAgB;IACpC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC/D,CAAC"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@oliversalzburg/js-utils",
+  "version": "0.0.1",
+  "license": "MIT",
+  "author": "Oliver Salzburg <oliver.salzburg@gmail.com>",
+  "type": "module",
+  "exports": "./output/index.js",
+  "scripts": {
+    "build": "yarn run build:tsc",
+    "build:esbuild": "node build.js",
+    "build:tsc": "tsc",
+    "lint:eslint": "eslint source",
+    "lint:tsc": "tsc --noEmit",
+    "prepack": "yarn run build"
+  },
+  "types": "./output/index.d.ts",
+  "devDependencies": {
+    "@types/eslint": "8.44.6",
+    "@types/node": "20.8.9",
+    "@typescript-eslint/eslint-plugin": "6.9.0",
+    "@typescript-eslint/parser": "6.9.0",
+    "esbuild": "0.19.5",
+    "eslint": "8.52.0",
+    "lint-staged": "15.0.2",
+    "prettier": "3.0.3",
+    "prettier-package-json": "2.8.0",
+    "prettier-plugin-organize-imports": "3.2.3",
+    "typescript": "5.2.2"
+  },
+  "packageManager": "yarn@4.0.0"
+}