@douglasneuroinformatics/libjs 1.4.0 → 1.5.1

package/dist/exception.d.ts

@@ -0,0 +1,34 @@
+import type { IsNever, RequiredKeysOf, Simplify } from 'type-fest';
+type ExceptionOptions = Simplify<ErrorOptions & {
+    details?: {
+        [key: string]: unknown;
+    };
+}>;
+type ExceptionParams = {
+    message?: string;
+    name: string;
+};
+type ExceptionInstance<TParams extends ExceptionParams, TOptions extends ExceptionOptions> = Error & {
+    cause: TOptions['cause'];
+    details: TOptions['details'];
+    name: TParams['name'];
+};
+type ExceptionConstructorArgs<TParams extends ExceptionParams, TOptions extends ExceptionOptions> = IsNever<RequiredKeysOf<TOptions>> extends true ? [message?: string, options?: TOptions] : TParams extends {
+    message: string;
+} ? [TOptions] : [message: string, options: TOptions];
+type ExceptionConstructor<TParams extends ExceptionParams, TOptions extends ExceptionOptions> = new (...args: ExceptionConstructorArgs<TParams, TOptions>) => ExceptionInstance<TParams, TOptions>;
+declare abstract class BaseException<TParams extends ExceptionParams, TOptions extends ExceptionOptions> extends Error implements ExceptionInstance<TParams, TOptions> {
+    cause: TOptions['cause'];
+    details: TOptions['details'];
+    abstract name: TParams['name'];
+    constructor(message?: string, options?: TOptions);
+}
+declare class ExceptionBuilder<TParams extends ExceptionParams | undefined, TOptions extends ExceptionOptions> {
+    private params?;
+    build(): [TParams] extends [ExceptionParams] ? ExceptionConstructor<TParams, TOptions> : never;
+    setOptionsType<TUpdatedOptions extends ExceptionOptions>(): ExceptionBuilder<TParams, TUpdatedOptions>;
+    setParams<const TUpdatedParams extends NonNullable<TParams>>(params: TUpdatedParams): ExceptionBuilder<TUpdatedParams, TOptions>;
+}
+export type { ExceptionConstructor, ExceptionInstance };
+export { BaseException, ExceptionBuilder };
+//# sourceMappingURL=exception.d.ts.map

package/dist/exception.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exception.d.ts","sourceRoot":"","sources":["../src/exception.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAEnE,KAAK,gBAAgB,GAAG,QAAQ,CAC9B,YAAY,GAAG;IACb,OAAO,CAAC,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH,CACF,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,KAAK,iBAAiB,CAAC,OAAO,SAAS,eAAe,EAAE,QAAQ,SAAS,gBAAgB,IAAI,KAAK,GAAG;IACnG,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACzB,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC7B,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CACvB,CAAC;AAEF,KAAK,wBAAwB,CAAC,OAAO,SAAS,eAAe,EAAE,QAAQ,SAAS,gBAAgB,IAC9F,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,SAAS,IAAI,GAC1C,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,GACtC,OAAO,SAAS;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,GACjC,CAAC,QAAQ,CAAC,GACV,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;AAE7C,KAAK,oBAAoB,CAAC,OAAO,SAAS,eAAe,EAAE,QAAQ,SAAS,gBAAgB,IAAI,KAC9F,GAAG,IAAI,EAAE,wBAAwB,CAAC,OAAO,EAAE,QAAQ,CAAC,KACjD,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAE1C,uBAAe,aAAa,CAAC,OAAO,SAAS,eAAe,EAAE,QAAQ,SAAS,gBAAgB,CAC7F,SAAQ,KACR,YAAW,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC;IAE/B,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAClC,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IACpC,SAAyB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;gBAEnC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ;CAKjD;AAED,cAAM,gBAAgB,CAAC,OAAO,SAAS,eAAe,GAAG,SAAS,EAAE,QAAQ,SAAS,gBAAgB;IACnG,OAAO,CAAC,MAAM,CAAC,CAAU;IAEzB,KAAK,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,KAAK;IAe9F,cAAc,CAAC,eAAe,SAAS,gBAAgB,KAC3B,gBAAgB,CAAC,OAAO,EAAE,eAAe,CAAC;IAGtE,SAAS,CAAC,KAAK,CAAC,cAAc,SAAS,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,cAAc,GAEvD,gBAAgB,CAAC,cAAc,EAAE,QAAQ,CAAC;CAEvE;AAED,YAAY,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/exception.js

@@ -0,0 +1,34 @@
+/* eslint-disable no-dupe-class-members */
+class BaseException extends Error {
+    cause;
+    details;
+    constructor(message, options) {
+        super(message);
+        this.cause = options?.cause;
+        this.details = options?.details;
+    }
+}
+class ExceptionBuilder {
+    params;
+    build() {
+        if (!this.params) {
+            throw new Error('Cannot build exception: params is undefined');
+        }
+        const params = this.params;
+        return class extends BaseException {
+            name = params.name;
+            constructor(...args) {
+                const [message, options] = (params.message ? [params.message, args[0]] : args);
+                super(message, options);
+            }
+        };
+    }
+    setOptionsType() {
+        return this;
+    }
+    setParams(params) {
+        this.params = params;
+        return this;
+    }
+}
+export { BaseException, ExceptionBuilder };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './array.js';
 export * from './datetime.js';
+export * from './exception.js';
 export * from './json.js';
 export * from './number.js';
 export * from './object.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC"}

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from './array.js';
 export * from './datetime.js';
+export * from './exception.js';
 export * from './json.js';
 export * from './number.js';
 export * from './object.js';

package/dist/tsconfig.build.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/array.ts","../src/datetime.ts","../src/index.ts","../src/json.ts","../src/number.ts","../src/object.ts","../src/random.ts","../src/range.ts","../src/string.ts","../src/types.ts","../src/zod.ts"],"version":"5.6.3"}
+{"root":["../src/array.ts","../src/datetime.ts","../src/exception.ts","../src/index.ts","../src/json.ts","../src/number.ts","../src/object.ts","../src/random.ts","../src/range.ts","../src/string.ts","../src/types.ts","../src/zod.ts"],"version":"5.6.3"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@douglasneuroinformatics/libjs",
   "type": "module",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "packageManager": "pnpm@10.3.0",
   "description": "A collection of utility functions and types for Node.js and the browser",
   "author": "Joshua Unrau",
@@ -21,7 +21,8 @@
   ],
   "scripts": {
     "build": "rm -rf dist && tsc -b tsconfig.build.json",
-    "build:docs": "typedoc",
+    "docs:build": "typedoc",
+    "docs:dev": "concurrently \"typedoc --watch\" \"http-server docs -c-1\"",
     "format": "prettier --write src",
     "lint": "tsc --noEmit && eslint --fix src",
     "prepare": "husky",
@@ -33,16 +34,20 @@
     "zod": "^3.22.6"
   },
   "devDependencies": {
-    "@douglasneuroinformatics/eslint-config": "^5.2.4",
+    "@douglasneuroinformatics/eslint-config": "^5.3.1",
     "@douglasneuroinformatics/prettier-config": "^0.0.1",
     "@douglasneuroinformatics/semantic-release": "^0.2.1",
     "@douglasneuroinformatics/tsconfig": "^1.0.2",
     "@types/node": "22.x",
     "@vitest/coverage-v8": "^3.0.5",
+    "concurrently": "^9.1.2",
     "eslint": "^9.20.1",
+    "http-server": "^14.1.1",
     "husky": "^9.1.7",
     "prettier": "^3.5.0",
-    "typedoc": "^0.27.7",
+    "typedoc": "^0.27.8",
+    "typedoc-material-theme": "^1.3.0",
+    "typedoc-plugin-zod": "^1.3.1",
     "typescript": "5.6.x",
     "vitest": "^3.0.5"
   },