npm - @rapidrest/core - Versions diffs - 1.1.4 → 1.2.0 - Mend

@rapidrest/core 1.1.4 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (69) hide show

package/docs/reference/interfaces/TwilioConfig.md CHANGED Viewed

@@ -6,7 +6,7 @@
 # Interface: TwilioConfig
-Defined in: [src/MessagingUtils.ts:66](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L66)
+Defined in: [src/MessagingUtils.ts:66](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L66)
 ## Properties
@@ -14,15 +14,15 @@ Defined in: [src/MessagingUtils.ts:66](https://github.com/rapidrest/core/blob/23
 > **accountSid**: `string`
-Defined in: [src/MessagingUtils.ts:67](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L67)
+Defined in: [src/MessagingUtils.ts:67](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L67)
 ***
 ### options?
-> `optional` **options**: `any`
+> `optional` **options?**: `any`
-Defined in: [src/MessagingUtils.ts:69](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L69)
+Defined in: [src/MessagingUtils.ts:69](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L69)
 ***
@@ -30,4 +30,4 @@ Defined in: [src/MessagingUtils.ts:69](https://github.com/rapidrest/core/blob/23
 > **token**: `string`
-Defined in: [src/MessagingUtils.ts:68](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L68)
+Defined in: [src/MessagingUtils.ts:68](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L68)

package/docs/reference/interfaces/WorkerMessage.md CHANGED Viewed

@@ -6,7 +6,7 @@
 # Interface: WorkerMessage
-Defined in: [src/threads/ThreadWorker.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L17)
+Defined in: [src/threads/ThreadWorker.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L17)
 Describes a single message sent from the thread pool managger to a worker thread.
@@ -14,9 +14,9 @@ Describes a single message sent from the thread pool managger to a worker thread
 ### data?
-> `optional` **data**: `any`
+> `optional` **data?**: `any`
-Defined in: [src/threads/ThreadWorker.ts:19](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L19)
+Defined in: [src/threads/ThreadWorker.ts:19](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L19)
 The data associated with the message.
@@ -26,6 +26,6 @@ The data associated with the message.
 > **type**: [`WorkerMessageType`](../enumerations/WorkerMessageType.md)
-Defined in: [src/threads/ThreadWorker.ts:21](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadWorker.ts#L21)
+Defined in: [src/threads/ThreadWorker.ts:21](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadWorker.ts#L21)
 The type of message sent.

package/docs/reference/interfaces/WorkerOptions.md CHANGED Viewed

@@ -6,7 +6,7 @@
 # Interface: WorkerOptions
-Defined in: [src/threads/ThreadPool.ts:22](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L22)
+Defined in: [src/threads/ThreadPool.ts:25](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L25)
 Describes the various options that can be used when creating worker threads.
@@ -14,9 +14,9 @@ Describes the various options that can be used when creating worker threads.
 ### allowTs?
-> `optional` **allowTs**: `boolean`
+> `optional` **allowTs?**: `boolean`
-Defined in: [src/threads/ThreadPool.ts:30](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L30)
+Defined in: [src/threads/ThreadPool.ts:33](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L33)
 Set to `true` to enable support for importing TypeScript modules in the worker. Default is `true`.
@@ -24,9 +24,9 @@ Set to `true` to enable support for importing TypeScript modules in the worker.
 ### args?
-> `optional` **args**: `any`
+> `optional` **args?**: `any`
-Defined in: [src/threads/ThreadPool.ts:24](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L24)
+Defined in: [src/threads/ThreadPool.ts:27](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L27)
 The list of initialization arguments to pass into the worker thread.
@@ -34,9 +34,9 @@ The list of initialization arguments to pass into the worker thread.
 ### entry?
-> `optional` **entry**: `string`
+> `optional` **entry?**: `string`
-Defined in: [src/threads/ThreadPool.ts:26](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L26)
+Defined in: [src/threads/ThreadPool.ts:29](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L29)
 The path to the entry file create a worker thread from. Default is `ThreadWorkerEntry.js`.
@@ -44,9 +44,9 @@ The path to the entry file create a worker thread from. Default is `ThreadWorker
 ### restartOnExit?
-> `optional` **restartOnExit**: `boolean`
+> `optional` **restartOnExit?**: `boolean`
-Defined in: [src/threads/ThreadPool.ts:28](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L28)
+Defined in: [src/threads/ThreadPool.ts:31](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L31)
 Indicates if a worker thread should automatically be restarted on exit.
@@ -54,8 +54,8 @@ Indicates if a worker thread should automatically be restarted on exit.
 ### worker?
-> `optional` **worker**: `string`
+> `optional` **worker?**: `string`
-Defined in: [src/threads/ThreadPool.ts:32](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L32)
+Defined in: [src/threads/ThreadPool.ts:35](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L35)
 The path to the worker file. This must be set when using `ThreadWorkerEntry` as the default entry file.

package/docs/reference/type-aliases/BooleanFunc.md CHANGED Viewed

@@ -4,11 +4,11 @@
 [@rapidrest/core](../globals.md) / BooleanFunc
-# Type Alias: BooleanFunc()
+# Type Alias: BooleanFunc
 > **BooleanFunc** = (`val`) => `boolean`
-Defined in: [src/ValidationUtils.ts:9](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/ValidationUtils.ts#L9)
+Defined in: [src/ValidationUtils.ts:9](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/ValidationUtils.ts#L9)
 A simple validation function that returns a boolean success or fail.

package/docs/reference/type-aliases/TemplateMap.md CHANGED Viewed

@@ -8,7 +8,7 @@
 > **TemplateMap** = `Omit`\<[`TemplateMapBase`](../interfaces/TemplateMapBase.md), `"from"`\> & `object`
-Defined in: [src/MessagingUtils.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/MessagingUtils.ts#L17)
+Defined in: [src/MessagingUtils.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/MessagingUtils.ts#L17)
 ## Type Declaration

package/docs/reference/type-aliases/WorkerCallback.md CHANGED Viewed

@@ -4,11 +4,11 @@
 [@rapidrest/core](../globals.md) / WorkerCallback
-# Type Alias: WorkerCallback()
+# Type Alias: WorkerCallback
 > **WorkerCallback** = (`threadId`, `msg?`) => `void`
-Defined in: [src/threads/ThreadPool.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/threads/ThreadPool.ts#L17)
+Defined in: [src/threads/ThreadPool.ts:20](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/threads/ThreadPool.ts#L20)
 Callback function for `ThreadPool` events.

package/docs/reference/variables/Logger.md CHANGED Viewed

@@ -8,14 +8,18 @@
 > `const` **Logger**: `any`
-Defined in: [src/Logger.ts:17](https://github.com/rapidrest/core/blob/23a4f312bccd7ea3a0598e320bd5d984466027e5/src/Logger.ts#L17)
+Defined in: [src/Logger.ts:17](https://github.com/rapidrest/core/blob/0eb0ed1163d4555240daccc189ac59a2ba35179a/src/Logger.ts#L17)
 Creates a new logger with the specified level and file name to output logs to.
 ## Param
+**level**
 The logging level to create the logger with.
 ## Param
+**file**
 The name (without an extension) of the file to output logs to.

package/package.json CHANGED Viewed

@@ -1,96 +1,96 @@
-{
-    "name": "@rapidrest/core",
-    "version": "1.1.4",
-    "description": "A collection of common utilities and core functionality for rapidly building RESTful applications.",
-    "repository": "https://github.com/rapidrest/core.git",
-    "author": "RapidREST <rapidrests@gmail.com>",
-    "license": "MIT",
-    "contributors": [
-        "Jean-Philippe Steinmetz",
-        "Arthur Thompson",
-        "Thomas Buscaglia"
-    ],
-    "scripts": {
-        "build": "rimraf dist && tsc",
-        "deploy-docs": "ts-node tools/gh-pages-publish",
-        "docs": "typedoc --plugin typedoc-plugin-markdown --out docs/reference src",
-        "lint": "eslint ./src ./test",
-        "local-audit": "yarn install && yarn npm audit -A -R \"$@\"",
-        "checkup": "yarn dlx @yarnpkg/doctor \"$@\"",
-        "dependency-check": "yarn dlx depcheck \"$@\"",
-        "report-coverage": "cat ./coverage/lcov.info | coveralls",
-        "test": "node --loader ts-node/esm ./node_modules/vitest/vitest.mjs run",
-        "test:prod": "npm run lint && node --loader ts-node/esm ./node_modules/vitest/vitest.mjs run",
-        "postversion": "git push && git push --tags"
-    },
-    "dependencies": {
-        "form-data": "^4.0.5",
-        "handlebars": "^4.7.9",
-        "js-yaml": "^4.2.0",
-        "jsonwebtoken": "^9.0.3",
-        "jszip": "^3.10.1",
-        "mkdirp": "^3.0.1",
-        "readline": "^1.3.0",
-        "triple-beam": "^1.4.1",
-        "uuid": "^14.0.0",
-        "validator": "^13.15.35"
-    },
-    "peerDependencies": {
-        "axios": "1.x",
-        "reflect-metadata": "0.2.x",
-        "winston": "3.x",
-        "winston-transport": "4.x"
-    },
-    "devDependencies": {
-        "@slack/bolt": "^4.7.3",
-        "@slack/web-api": "^7.16.0",
-        "@types/eslint": "^9.6.1",
-        "@types/express": "^5.0.6",
-        "@types/js-yaml": "^4.0.9",
-        "@types/jsonwebtoken": "^9.0.10",
-        "@types/node": "^25.9.2",
-        "@types/nodemailer": "^8.0.0",
-        "@types/triple-beam": "^1.3.5",
-        "@types/validator": "^13.15.10",
-        "@typescript-eslint/eslint-plugin": "^8.61.0",
-        "@typescript-eslint/parser": "^8.61.0",
-        "axios": "^1.17.0",
-        "coveralls": "^3.1.1",
-        "eslint": "^9.39.4",
-        "eslint-config-prettier": "^10.1.8",
-        "eslint-plugin-import": "^2.32.0",
-        "eslint-plugin-jsdoc": "^63.0.2",
-        "mkdirp": "^3.0.1",
-        "nconf": "^0.13.0",
-        "nock": "^14.0.15",
-        "nodemailer": "^8.0.10",
-        "prettier": "^3.8.4",
-        "reflect-metadata": "^0.2.2",
-        "rimraf": "^6.1.3",
-        "ts-node": "^10.9.2",
-        "twilio": "^6.0.2",
-        "typedoc": "^0.28.19",
-        "typedoc-plugin-markdown": "^4.12.0",
-        "typescript": "^6.0.3",
-        "vitest": "^4.1.8",
-        "winston": "^3.19.0",
-        "winston-transport": "^4.9.0"
-    },
-    "resolutions": {
-        "cross-spawn": "^7.0.5"
-    },
-    "packageManager": "yarn@4.5.0",
-    "engines": {
-        "node": ">=20.0.0"
-    },
-    "publishConfig": {
-        "registry": "https://registry.npmjs.org/"
-    },
-    "main": "dist/lib/index.js",
-    "type": "module",
-    "typings": "dist/types/index.d.ts",
-    "files": [
-        "dist",
-        "docs"
-    ]
-}
+{
+    "name": "@rapidrest/core",
+    "version": "1.2.0",
+    "description": "A collection of common utilities and core functionality for rapidly building RESTful applications.",
+    "repository": "https://github.com/rapidrest/core.git",
+    "author": "RapidREST <rapidrests@gmail.com>",
+    "license": "MIT",
+    "contributors": [
+        "Jean-Philippe Steinmetz",
+        "Arthur Thompson",
+        "Thomas Buscaglia"
+    ],
+    "scripts": {
+        "build": "yarn lint && rimraf dist && tsc",
+        "deploy-docs": "ts-node tools/gh-pages-publish",
+        "docs": "typedoc --plugin typedoc-plugin-markdown --out docs/reference src",
+        "lint": "eslint ./src ./test",
+        "local-audit": "yarn install && yarn npm audit -A -R \"$@\"",
+        "checkup": "yarn dlx @yarnpkg/doctor \"$@\"",
+        "dependency-check": "yarn dlx depcheck \"$@\"",
+        "report-coverage": "cat ./coverage/lcov.info | coveralls",
+        "test": "node --loader ts-node/esm ./node_modules/vitest/vitest.mjs run",
+        "test:prod": "npm run lint && node --loader ts-node/esm ./node_modules/vitest/vitest.mjs run",
+        "postversion": "git push && git push --tags"
+    },
+    "dependencies": {
+        "form-data": "^4.0.5",
+        "handlebars": "^4.7.9",
+        "js-yaml": "^4.2.0",
+        "jsonwebtoken": "^9.0.3",
+        "jszip": "^3.10.1",
+        "mkdirp": "^3.0.1",
+        "readline": "^1.3.0",
+        "triple-beam": "^1.4.1",
+        "uuid": "^14.0.0",
+        "validator": "^13.15.35"
+    },
+    "peerDependencies": {
+        "axios": "1.x",
+        "reflect-metadata": "0.2.x",
+        "winston": "3.x",
+        "winston-transport": "4.x"
+    },
+    "devDependencies": {
+        "@slack/bolt": "^4.7.3",
+        "@slack/web-api": "^7.16.0",
+        "@types/eslint": "^9.6.1",
+        "@types/express": "^5.0.6",
+        "@types/js-yaml": "^4.0.9",
+        "@types/jsonwebtoken": "^9.0.10",
+        "@types/node": "^25.9.2",
+        "@types/nodemailer": "^8.0.0",
+        "@types/triple-beam": "^1.3.5",
+        "@types/validator": "^13.15.10",
+        "@typescript-eslint/eslint-plugin": "^8.61.0",
+        "@typescript-eslint/parser": "^8.61.0",
+        "axios": "^1.17.0",
+        "coveralls": "^3.1.1",
+        "eslint": "^9.39.4",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-import": "^2.32.0",
+        "eslint-plugin-jsdoc": "^63.0.2",
+        "mkdirp": "^3.0.1",
+        "nconf": "^0.13.0",
+        "nock": "^14.0.15",
+        "nodemailer": "^8.0.10",
+        "prettier": "^3.8.4",
+        "reflect-metadata": "^0.2.2",
+        "rimraf": "^6.1.3",
+        "ts-node": "^10.9.2",
+        "twilio": "^6.0.2",
+        "typedoc": "^0.28.19",
+        "typedoc-plugin-markdown": "^4.12.0",
+        "typescript": "^6.0.3",
+        "vitest": "^4.1.8",
+        "winston": "^3.19.0",
+        "winston-transport": "^4.9.0"
+    },
+    "resolutions": {
+        "cross-spawn": "^7.0.5"
+    },
+    "packageManager": "yarn@4.5.0",
+    "engines": {
+        "node": ">=20.0.0"
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    },
+    "main": "dist/lib/index.js",
+    "type": "module",
+    "typings": "dist/types/index.d.ts",
+    "files": [
+        "dist",
+        "docs"
+    ]
+}