@kuroson/common-utils 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,32 @@
+# @kuroson/common-utils
+
+## 0.2.1
+
+### Patch Changes
+
+- 61adb1e: Updated dependency `@typescript-eslint/eslint-plugin` to `8.50.1`.
+  Updated dependency `@typescript-eslint/parser` to `8.50.1`.
+  Updated dependency `typescript-eslint` to `8.50.1`.
+  Updated dependency `next` to `16.1.1`.
+  Updated dependency `eslint-config-next` to `16.1.1`.
+  Updated dependency `@next/third-parties` to `16.1.1`.
+  Updated dependency `ldapts` to `8.0.31`.
+  Updated dependency `@next/eslint-plugin-next` to `16.1.1`.
+  Updated dependency `eslint-plugin-jest` to `29.10.1`.
+  Updated dependency `nodemailer` to `7.0.12`.
+
+## 0.2.0
+
+### Minor Changes
+
+- cdb0acc: Initial release
+
+## 0.1.0
+
+### Features
+
+- Initial release
+- Added `sleep` utility function
+- Added `parseError` utility function
+- Added `Prettify` type utility
+- Added error classes: `InputError`, `RuntimeError`, `SettingsError`, `HTTPError`

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Alvin Cherk
+
+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,21 @@
+# @kuroson/common-utils
+
+Common utility functions and types for my TypeScript/JavaScript projects.
+
+## Installation
+
+```bash
+npm install @kuroson/common-utils
+# or
+pnpm add @kuroson/common-utils
+# or
+yarn add @kuroson/common-utils
+```
+
+## Requirements
+
+- Node.js >= 22
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,61 @@
+'use strict';
+
+// src/index.ts
+var sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+var InputError = class extends Error {
+  constructor(message, options) {
+    super(message, options);
+    this.name = "InputError";
+  }
+};
+var RuntimeError = class extends Error {
+  constructor(message, options) {
+    super(message, options);
+    this.name = "RuntimeError";
+  }
+};
+var SettingsError = class extends Error {
+  constructor(message, options) {
+    super(message, options);
+    this.name = "SettingsError";
+  }
+};
+var HTTPError = class extends Error {
+  status;
+  message;
+  originalError;
+  constructor(status, message, originalError = void 0) {
+    super(message);
+    this.status = status;
+    this.message = message;
+    this.originalError = originalError;
+  }
+  getStatusCode() {
+    return this.status;
+  }
+  getMessage() {
+    return this.message;
+  }
+};
+var parseError = (err) => {
+  if (err instanceof Error) {
+    return err.message;
+  }
+  if (typeof err === "string") {
+    return err;
+  }
+  try {
+    return JSON.stringify(err);
+  } catch {
+    return String(err);
+  }
+};
+
+exports.HTTPError = HTTPError;
+exports.InputError = InputError;
+exports.RuntimeError = RuntimeError;
+exports.SettingsError = SettingsError;
+exports.parseError = parseError;
+exports.sleep = sleep;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;AAAO,IAAM,KAAA,GAAQ,CAAC,EAAA,KAA8B,IAAI,OAAA,CAAQ,CAAC,OAAA,KAAY,UAAA,CAAW,OAAA,EAAS,EAAE,CAAC;AAK7F,IAAM,UAAA,GAAN,cAAyB,KAAA,CAAM;AAAA,EACpC,WAAA,CAAY,SAAiB,OAAA,EAAwB;AACnD,IAAA,KAAA,CAAM,SAAS,OAAO,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,YAAA;AAAA,EACd;AACF;AAEO,IAAM,YAAA,GAAN,cAA2B,KAAA,CAAM;AAAA,EACtC,WAAA,CAAY,SAAiB,OAAA,EAAwB;AACnD,IAAA,KAAA,CAAM,SAAS,OAAO,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,cAAA;AAAA,EACd;AACF;AAEO,IAAM,aAAA,GAAN,cAA4B,KAAA,CAAM;AAAA,EACvC,WAAA,CAAY,SAAiB,OAAA,EAAwB;AACnD,IAAA,KAAA,CAAM,SAAS,OAAO,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,eAAA;AAAA,EACd;AACF;AAEO,IAAM,SAAA,GAAN,cAAwB,KAAA,CAAM;AAAA,EAC5B,MAAA;AAAA,EACS,OAAA;AAAA,EACT,aAAA;AAAA,EAEP,WAAA,CAAY,MAAA,EAAgB,OAAA,EAAiB,aAAA,GAAqB,MAAA,EAAW;AAC3E,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AAEf,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AAAA,EACvB;AAAA,EAEO,aAAA,GAAwB;AAC7B,IAAA,OAAO,IAAA,CAAK,MAAA;AAAA,EACd;AAAA,EAEO,UAAA,GAAqB;AAC1B,IAAA,OAAO,IAAA,CAAK,OAAA;AAAA,EACd;AACF;AAOO,IAAM,UAAA,GAAuC,CAAC,GAAA,KAAyB;AAC5E,EAAA,IAAI,eAAe,KAAA,EAAO;AACxB,IAAA,OAAO,GAAA,CAAI,OAAA;AAAA,EACb;AACA,EAAA,IAAI,OAAO,QAAQ,QAAA,EAAU;AAC3B,IAAA,OAAO,GAAA;AAAA,EACT;AACA,EAAA,IAAI;AACF,IAAA,OAAO,IAAA,CAAK,UAAU,GAAG,CAAA;AAAA,EAC3B,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,OAAO,GAAG,CAAA;AAAA,EACnB;AACF","file":"index.cjs","sourcesContent":["export const sleep = (ms: number): Promise<void> => new Promise((resolve) => setTimeout(resolve, ms));\nexport type Prettify<T> = {\n  [K in keyof T]: T[K];\n} & {};\n\nexport class InputError extends Error {\n  constructor(message: string, options?: ErrorOptions) {\n    super(message, options);\n    this.name = 'InputError';\n  }\n}\n\nexport class RuntimeError extends Error {\n  constructor(message: string, options?: ErrorOptions) {\n    super(message, options);\n    this.name = 'RuntimeError';\n  }\n}\n\nexport class SettingsError extends Error {\n  constructor(message: string, options?: ErrorOptions) {\n    super(message, options);\n    this.name = 'SettingsError';\n  }\n}\n\nexport class HTTPError extends Error {\n  public status: number;\n  public override message: string;\n  public originalError: any;\n\n  constructor(status: number, message: string, originalError: any = undefined) {\n    super(message);\n    this.status = status;\n    this.message = message;\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    this.originalError = originalError;\n  }\n\n  public getStatusCode(): number {\n    return this.status;\n  }\n\n  public getMessage(): string {\n    return this.message;\n  }\n}\n\n/**\n * Attempts to decode an error into a string to be logged\n * @param err error to be decoded\n * @returns A string representation of the error\n */\nexport const parseError: (err: unknown) => string = (err: unknown): string => {\n  if (err instanceof Error) {\n    return err.message;\n  }\n  if (typeof err === 'string') {\n    return err;\n  }\n  try {\n    return JSON.stringify(err);\n  } catch {\n    return String(err);\n  }\n};\n"]}

package/dist/index.d.cts

@@ -0,0 +1,29 @@
+declare const sleep: (ms: number) => Promise<void>;
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+declare class InputError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class RuntimeError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class SettingsError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class HTTPError extends Error {
+    status: number;
+    message: string;
+    originalError: any;
+    constructor(status: number, message: string, originalError?: any);
+    getStatusCode(): number;
+    getMessage(): string;
+}
+/**
+ * Attempts to decode an error into a string to be logged
+ * @param err error to be decoded
+ * @returns A string representation of the error
+ */
+declare const parseError: (err: unknown) => string;
+
+export { HTTPError, InputError, type Prettify, RuntimeError, SettingsError, parseError, sleep };

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+declare const sleep: (ms: number) => Promise<void>;
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+declare class InputError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class RuntimeError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class SettingsError extends Error {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class HTTPError extends Error {
+    status: number;
+    message: string;
+    originalError: any;
+    constructor(status: number, message: string, originalError?: any);
+    getStatusCode(): number;
+    getMessage(): string;
+}
+/**
+ * Attempts to decode an error into a string to be logged
+ * @param err error to be decoded
+ * @returns A string representation of the error
+ */
+declare const parseError: (err: unknown) => string;
+
+export { HTTPError, InputError, type Prettify, RuntimeError, SettingsError, parseError, sleep };

package/dist/index.js

@@ -0,0 +1,54 @@
+// src/index.ts
+var sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+var InputError = class extends Error {
+  constructor(message, options) {
+    super(message, options);
+    this.name = "InputError";
+  }
+};
+var RuntimeError = class extends Error {
+  constructor(message, options) {
+    super(message, options);
+    this.name = "RuntimeError";
+  }
+};
+var SettingsError = class extends Error {
+  constructor(message, options) {
+    super(message, options);
+    this.name = "SettingsError";
+  }
+};
+var HTTPError = class extends Error {
+  status;
+  message;
+  originalError;
+  constructor(status, message, originalError = void 0) {
+    super(message);
+    this.status = status;
+    this.message = message;
+    this.originalError = originalError;
+  }
+  getStatusCode() {
+    return this.status;
+  }
+  getMessage() {
+    return this.message;
+  }
+};
+var parseError = (err) => {
+  if (err instanceof Error) {
+    return err.message;
+  }
+  if (typeof err === "string") {
+    return err;
+  }
+  try {
+    return JSON.stringify(err);
+  } catch {
+    return String(err);
+  }
+};
+
+export { HTTPError, InputError, RuntimeError, SettingsError, parseError, sleep };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAAO,IAAM,KAAA,GAAQ,CAAC,EAAA,KAA8B,IAAI,OAAA,CAAQ,CAAC,OAAA,KAAY,UAAA,CAAW,OAAA,EAAS,EAAE,CAAC;AAK7F,IAAM,UAAA,GAAN,cAAyB,KAAA,CAAM;AAAA,EACpC,WAAA,CAAY,SAAiB,OAAA,EAAwB;AACnD,IAAA,KAAA,CAAM,SAAS,OAAO,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,YAAA;AAAA,EACd;AACF;AAEO,IAAM,YAAA,GAAN,cAA2B,KAAA,CAAM;AAAA,EACtC,WAAA,CAAY,SAAiB,OAAA,EAAwB;AACnD,IAAA,KAAA,CAAM,SAAS,OAAO,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,cAAA;AAAA,EACd;AACF;AAEO,IAAM,aAAA,GAAN,cAA4B,KAAA,CAAM;AAAA,EACvC,WAAA,CAAY,SAAiB,OAAA,EAAwB;AACnD,IAAA,KAAA,CAAM,SAAS,OAAO,CAAA;AACtB,IAAA,IAAA,CAAK,IAAA,GAAO,eAAA;AAAA,EACd;AACF;AAEO,IAAM,SAAA,GAAN,cAAwB,KAAA,CAAM;AAAA,EAC5B,MAAA;AAAA,EACS,OAAA;AAAA,EACT,aAAA;AAAA,EAEP,WAAA,CAAY,MAAA,EAAgB,OAAA,EAAiB,aAAA,GAAqB,MAAA,EAAW;AAC3E,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,MAAA,GAAS,MAAA;AACd,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AAEf,IAAA,IAAA,CAAK,aAAA,GAAgB,aAAA;AAAA,EACvB;AAAA,EAEO,aAAA,GAAwB;AAC7B,IAAA,OAAO,IAAA,CAAK,MAAA;AAAA,EACd;AAAA,EAEO,UAAA,GAAqB;AAC1B,IAAA,OAAO,IAAA,CAAK,OAAA;AAAA,EACd;AACF;AAOO,IAAM,UAAA,GAAuC,CAAC,GAAA,KAAyB;AAC5E,EAAA,IAAI,eAAe,KAAA,EAAO;AACxB,IAAA,OAAO,GAAA,CAAI,OAAA;AAAA,EACb;AACA,EAAA,IAAI,OAAO,QAAQ,QAAA,EAAU;AAC3B,IAAA,OAAO,GAAA;AAAA,EACT;AACA,EAAA,IAAI;AACF,IAAA,OAAO,IAAA,CAAK,UAAU,GAAG,CAAA;AAAA,EAC3B,CAAA,CAAA,MAAQ;AACN,IAAA,OAAO,OAAO,GAAG,CAAA;AAAA,EACnB;AACF","file":"index.js","sourcesContent":["export const sleep = (ms: number): Promise<void> => new Promise((resolve) => setTimeout(resolve, ms));\nexport type Prettify<T> = {\n  [K in keyof T]: T[K];\n} & {};\n\nexport class InputError extends Error {\n  constructor(message: string, options?: ErrorOptions) {\n    super(message, options);\n    this.name = 'InputError';\n  }\n}\n\nexport class RuntimeError extends Error {\n  constructor(message: string, options?: ErrorOptions) {\n    super(message, options);\n    this.name = 'RuntimeError';\n  }\n}\n\nexport class SettingsError extends Error {\n  constructor(message: string, options?: ErrorOptions) {\n    super(message, options);\n    this.name = 'SettingsError';\n  }\n}\n\nexport class HTTPError extends Error {\n  public status: number;\n  public override message: string;\n  public originalError: any;\n\n  constructor(status: number, message: string, originalError: any = undefined) {\n    super(message);\n    this.status = status;\n    this.message = message;\n    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n    this.originalError = originalError;\n  }\n\n  public getStatusCode(): number {\n    return this.status;\n  }\n\n  public getMessage(): string {\n    return this.message;\n  }\n}\n\n/**\n * Attempts to decode an error into a string to be logged\n * @param err error to be decoded\n * @returns A string representation of the error\n */\nexport const parseError: (err: unknown) => string = (err: unknown): string => {\n  if (err instanceof Error) {\n    return err.message;\n  }\n  if (typeof err === 'string') {\n    return err;\n  }\n  try {\n    return JSON.stringify(err);\n  } catch {\n    return String(err);\n  }\n};\n"]}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@kuroson/common-utils",
+  "version": "0.2.1",
+  "description": "Common utility functions and types",
+  "license": "MIT",
+  "author": "Alvin Cherk <a.cherk@unsw.edu.au>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "devDependencies": {
+    "@eslint/js": "9.39.2",
+    "@typescript-eslint/eslint-plugin": "8.50.1",
+    "depcheck": "1.4.7",
+    "eslint": "9.39.2",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-plugin-prettier": "5.5.4",
+    "eslint-plugin-unused-imports": "4.3.0",
+    "prettier": "3.7.4",
+    "tsup": "8.5.1",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.50.1"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.7.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "depcheck": {
+    "ignores": [],
+    "skip-missing": true
+  },
+  "scripts": {
+    "build:all": "tsup",
+    "depcheck": "depcheck",
+    "lint": "eslint './**/*.{ts,js}'",
+    "lint:fix": "eslint './**/*.{ts,js}' --fix",
+    "typecheck": "tsc --noEmit"
+  }
+}