@infra-blocks/types 0.2.0 → 0.3.0-alpha.0

package/README.md

@@ -1,6 +1,10 @@
 # ts-types
+[![Build](https://github.com/infrastructure-blocks/ts-types/actions/workflows/build.yml/badge.svg)](https://github.com/infrastructure-blocks/ts-types/actions/workflows/build.yml)
+[![NPM Publish Release From Label](https://github.com/infrastructure-blocks/ts-types/actions/workflows/npm-publish-release-from-label.yml/badge.svg)](https://github.com/infrastructure-blocks/ts-types/actions/workflows/npm-publish-release-from-label.yml)
+[![Update From Template](https://github.com/infrastructure-blocks/ts-types/actions/workflows/update-from-template.yml/badge.svg)](https://github.com/infrastructure-blocks/ts-types/actions/workflows/update-from-template.yml)
+[![codecov](https://codecov.io/gh/infrastructure-blocks/ts-types/graph/badge.svg?token=EHQLSLTN3K)](https://codecov.io/gh/infrastructure-blocks/ts-types)
 
-Small types utility library for Typescript.
+Types utility library for Typescript.
 
 ## Development
 
@@ -21,7 +25,6 @@ npm run test
 
 ### Package publication
 
-This package leverages the [npm-publish-from-label](https://github.com/infrastructure-blocks/npm-publish-from-label-action) action
-as a turnkey, automated mechanism for publishing packages. Refer to its documentation to understand its capabilities.
-
-Packages should therefore not be published manually, as these tasks are automated by the CI.
+Package publication is fully automated at the CI level. This repository leverages the
+[npm-publish-from-label-workflow](https://github.com/infrastructure-blocks/npm-publish-from-label-workflow)
+workflow as a turnkey, automated mechanism for publishing packages. Refer to its documentation for usage information.

package/lib/cjs/index.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFunction = exports.isNumber = exports.isSymbol = exports.isString = void 0;
+/**
+ * A convenient Typescript type guard function to assess that a value is a string.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a string.
+ */
+function isString(value) {
+    return typeof value === "string";
+}
+exports.isString = isString;
+/**
+ * A convenient Typescript type guard function to assess that a value is a symbol.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a symbol.
+ */
+function isSymbol(value) {
+    return typeof value === "symbol";
+}
+exports.isSymbol = isSymbol;
+/**
+ * A convenient Typescript type guard function to assess that a value is a number.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a number.
+ */
+function isNumber(value) {
+    return typeof value === "number";
+}
+exports.isNumber = isNumber;
+/**
+ * A convenient Typescript type guard function to assess that a value is a function.
+ *
+ * @remark
+ * * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a function.
+ */
+// eslint-disable-next-line @typescript-eslint/ban-types
+function isFunction(value) {
+    return typeof value === "function";
+}
+exports.isFunction = isFunction;
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AA2DA;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAFD,4BAEC;AAED;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAFD,4BAEC;AAED;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAFD,4BAEC;AAED;;;;;;;;;GASG;AACH,wDAAwD;AACxD,SAAgB,UAAU,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACrC,CAAC;AAFD,gCAEC"}

package/lib/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/lib/esm/index.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Convenient type alias to regroup a type that can be T, null or undefined.
+ *
+ * Semantically the opposite of {@link NonNullable}.
+ */
+export type Nullable<T> = T | null | undefined;
+/**
+ * A type alias for single element predicate functions.
+ */
+export type Predicate<T> = (item: T) => boolean;
+/**
+ * A type alias for functions that return a value of a given type without arguments.
+ */
+export type Provider<T> = () => T;
+/**
+ * A convenient type declaration for handlers used to resolve "error" type events.
+ */
+export type ErrorHandler<T extends Error = Error> = (err: T) => void;
+/**
+ * A convenience type extractor to get the inner type of an array.
+ *
+ * It will cause compilation errors if T isn't an array.
+ *
+ * See here: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html
+ */
+export type UnpackedArray<T> = T extends (infer U)[] ? U : never;
+/**
+ * A convenience type extractor to get the inner type of a promise.
+ *
+ * It will cause compilation errors if T isn't a promise.
+ *
+ * See here: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html
+ */
+export type UnpackedPromise<T> = T extends Promise<infer U> ? U : never;
+/**
+ * A convenience type mapping that transitively make partial fields optional.
+ *
+ * The built-in Partial type doesn't cover nested objects, this one does.
+ */
+export type TransitivePartial<T> = {
+    [K in keyof T]?: T[K] extends object ? TransitivePartial<T[K]> : T[K];
+};
+/**
+ * A convenience type mapping to extract keys of a type that are of a given type.
+ *
+ * For example, if you would like all the types of an object that are numbers, you could do
+ * KeyOfType<TheType, number>
+ */
+export type KeyOfType<T, U> = {
+    [P in keyof T]: T[P] extends U ? P : never;
+}[keyof T];
+/**
+ * A convenient Typescript type guard function to assess that a value is a string.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a string.
+ */
+export declare function isString(value: unknown): value is string;
+/**
+ * A convenient Typescript type guard function to assess that a value is a symbol.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a symbol.
+ */
+export declare function isSymbol(value: unknown): value is symbol;
+/**
+ * A convenient Typescript type guard function to assess that a value is a number.
+ *
+ * @remark
+ * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a number.
+ */
+export declare function isNumber(value: unknown): value is number;
+/**
+ * A convenient Typescript type guard function to assess that a value is a function.
+ *
+ * @remark
+ * * This function is mostly meant as a Typescript type guard. See:
+ * https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards
+ *
+ * @param value - The value to test.
+ * @returns Whether or not the value is a function.
+ */
+export declare function isFunction(value: unknown): value is Function;

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AA2DA;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,wDAAwD;AACxD,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACrC,CAAC"}

package/package.json

@@ -1,26 +1,31 @@
 {
   "name": "@infra-blocks/types",
-  "version": "0.2.0",
+  "version": "0.3.0-alpha.0",
   "description": "Typescript types utility package.",
-  "exports": "./lib/index.js",
-  "engines": {
-    "node": ">=18.0.0"
+  "license": "ISC",
+  "author": "",
+  "type": "module",
+  "exports": {
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
   },
   "files": [
-    "lib/**/*.{js,d.ts,map}"
+    "lib/**/*.{js,cjs,mjs,json,d.ts,map}"
   ],
-  "type": "module",
   "scripts": {
-    "prepack": "npm run build",
-    "build": "npm run clean && tsc --project tsconfig.build.json",
-    "compile": "tsc",
+    "prebuild": "npm run clean",
+    "build": "tsc -b tsconfig.build.json tsconfig.build.cjs.json",
+    "postbuild": "scripts/post-build.sh",
     "clean": "rm -rf lib && rm -f infra-blocks-*.tgz",
-    "lint": "eslint --ext .js,.cjs,.mjs,.ts --max-warnings 0 .",
+    "compile": "tsc",
+    "lint": "eslint --ext .js,.cjs,.mjs,.json,.ts --max-warnings 0 .",
+    "prepack": "npm run build",
     "test": "npm run test:unit",
     "test:coverage": "c8 npm run test",
     "test:coverage:lcov": "c8 --reporter=lcov npm run test",
-    "test:unit": "mocha --config test/unit/.mocharc.cjs 'test/unit/**/*.spec.ts'",
-    "test:integration": "mocha --config test/integration/.mocharc.js 'test/integration/**/*.spec.ts'"
+    "test:integration": "mocha --config test/integration/.mocharc.js 'test/integration/**/*.spec.ts'",
+    "test:unit": "mocha --config test/unit/.mocharc.cjs 'test/unit/**/*.spec.ts'"
   },
   "devDependencies": {
     "@infra-blocks/test": "^0.1.1",
@@ -31,12 +36,14 @@
     "c8": "^8.0.0",
     "eslint": "^8.41.0",
     "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-json-format": "^2.0.1",
     "eslint-plugin-prettier": "^4.2.1",
     "mocha": "^10.2.0",
     "prettier": "^2.8.8",
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   },
-  "author": "",
-  "license": "ISC"
+  "engines": {
+    "node": ">=18.0.0"
+  }
 }

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA2DA;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED;;;;;;;;;GASG;AACH,wDAAwD;AACxD,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,OAAO,OAAO,KAAK,KAAK,UAAU,CAAC;AACrC,CAAC"}