@rapidrest/core 1.0.1

package/docs/reference/interfaces/JWTUtilsPayloadPasswordOptions.md

@@ -0,0 +1,78 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / JWTUtilsPayloadPasswordOptions
+
+# Interface: JWTUtilsPayloadPasswordOptions
+
+Defined in: src/JWTUtils.ts:83
+
+Describes the configuration options to be used with the `JWTUtilsConfig.payload` property when performing password
+based encryption.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Extends
+
+- [`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md)
+
+## Properties
+
+### algorithm
+
+> **algorithm**: `string`
+
+Defined in: src/JWTUtils.ts:87
+
+The cryptographic cipher algorithm to use during encryption/decryption of a JWT token payload.
+
+***
+
+### compress?
+
+> `optional` **compress**: [`ZLIB`](../enumerations/JWTUtilsCompressionMethods.md#zlib)
+
+Defined in: src/JWTUtils.ts:69
+
+Set the method to use for compressing the payload profile, otherwise set to `null` for no compression.
+
+#### Inherited from
+
+[`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md).[`compress`](JWTUtilsPayloadOptions.md#compress)
+
+***
+
+### encrypt?
+
+> `optional` **encrypt**: `boolean`
+
+Defined in: src/JWTUtils.ts:74
+
+Set to `true` to indicate that the JWT token payload is encrypted, otherwise set to `false`.
+
+#### Inherited from
+
+[`JWTUtilsPayloadOptions`](JWTUtilsPayloadOptions.md).[`encrypt`](JWTUtilsPayloadOptions.md#encrypt)
+
+***
+
+### iv
+
+> **iv**: `Buffer`
+
+Defined in: src/JWTUtils.ts:92
+
+The initialization vector to use during encryption and decryption.
+
+***
+
+### password
+
+> **password**: `string`
+
+Defined in: src/JWTUtils.ts:97
+
+The password to use when encrypting or decrypting JWT token payloads.

package/docs/reference/interfaces/NewEvent.md

@@ -0,0 +1,25 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / NewEvent
+
+# Interface: NewEvent
+
+Defined in: src/TelemetryUtils.ts:13
+
+Describes the required fields when creating a new telemetry event.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Properties
+
+### type
+
+> **type**: `string`
+
+Defined in: src/TelemetryUtils.ts:15
+
+The type of event begin recorded.

package/docs/reference/interfaces/OriginSettings.md

@@ -0,0 +1,25 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / OriginSettings
+
+# Interface: OriginSettings
+
+Defined in: src/MessagingUtils.ts:7
+
+## Properties
+
+### email
+
+> **email**: `string`
+
+Defined in: src/MessagingUtils.ts:8
+
+***
+
+### sms
+
+> **sms**: `string`
+
+Defined in: src/MessagingUtils.ts:9

package/docs/reference/interfaces/SlackConfig.md

@@ -0,0 +1,33 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / SlackConfig
+
+# Interface: SlackConfig
+
+Defined in: src/MessagingUtils.ts:41
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+Defined in: src/MessagingUtils.ts:42
+
+***
+
+### signingSecret
+
+> **signingSecret**: `string`
+
+Defined in: src/MessagingUtils.ts:44
+
+***
+
+### token
+
+> **token**: `string`
+
+Defined in: src/MessagingUtils.ts:43

package/docs/reference/interfaces/SmtpAuth.md

@@ -0,0 +1,25 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / SmtpAuth
+
+# Interface: SmtpAuth
+
+Defined in: src/MessagingUtils.ts:47
+
+## Properties
+
+### pass
+
+> **pass**: `string`
+
+Defined in: src/MessagingUtils.ts:49
+
+***
+
+### user
+
+> **user**: `string`
+
+Defined in: src/MessagingUtils.ts:48

package/docs/reference/interfaces/SmtpConfig.md

@@ -0,0 +1,41 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / SmtpConfig
+
+# Interface: SmtpConfig
+
+Defined in: src/MessagingUtils.ts:52
+
+## Properties
+
+### auth?
+
+> `optional` **auth**: [`SmtpAuth`](SmtpAuth.md)
+
+Defined in: src/MessagingUtils.ts:56
+
+***
+
+### host
+
+> **host**: `string`
+
+Defined in: src/MessagingUtils.ts:53
+
+***
+
+### port
+
+> **port**: `number`
+
+Defined in: src/MessagingUtils.ts:54
+
+***
+
+### secure
+
+> **secure**: `boolean`
+
+Defined in: src/MessagingUtils.ts:55

package/docs/reference/interfaces/Template.md

@@ -0,0 +1,81 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / Template
+
+# Interface: Template
+
+Defined in: src/MessagingUtils.ts:20
+
+## Properties
+
+### email\_options?
+
+> `optional` **email\_options**: `any`
+
+Defined in: src/MessagingUtils.ts:24
+
+***
+
+### enabled
+
+> **enabled**: `boolean`
+
+Defined in: src/MessagingUtils.ts:22
+
+***
+
+### html?
+
+> `optional` **html**: `string`
+
+Defined in: src/MessagingUtils.ts:28
+
+***
+
+### slack\_channel?
+
+> `optional` **slack\_channel**: `string`
+
+Defined in: src/MessagingUtils.ts:30
+
+***
+
+### slack\_text?
+
+> `optional` **slack\_text**: `string`
+
+Defined in: src/MessagingUtils.ts:32
+
+***
+
+### sms?
+
+> `optional` **sms**: `string`
+
+Defined in: src/MessagingUtils.ts:34
+
+***
+
+### sms\_options?
+
+> `optional` **sms\_options**: `any`
+
+Defined in: src/MessagingUtils.ts:36
+
+***
+
+### subject?
+
+> `optional` **subject**: `string`
+
+Defined in: src/MessagingUtils.ts:26
+
+***
+
+### text?
+
+> `optional` **text**: `string`
+
+Defined in: src/MessagingUtils.ts:38

package/docs/reference/interfaces/TemplateMapBase.md

@@ -0,0 +1,13 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / TemplateMapBase
+
+# Interface: TemplateMapBase
+
+Defined in: src/MessagingUtils.ts:12
+
+## Indexable
+
+\[`name`: `string`\]: [`Template`](Template.md)

package/docs/reference/interfaces/TwilioConfig.md

@@ -0,0 +1,33 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / TwilioConfig
+
+# Interface: TwilioConfig
+
+Defined in: src/MessagingUtils.ts:59
+
+## Properties
+
+### accountSid
+
+> **accountSid**: `string`
+
+Defined in: src/MessagingUtils.ts:60
+
+***
+
+### options?
+
+> `optional` **options**: `any`
+
+Defined in: src/MessagingUtils.ts:62
+
+***
+
+### token
+
+> **token**: `string`
+
+Defined in: src/MessagingUtils.ts:61

package/docs/reference/interfaces/WorkerMessage.md

@@ -0,0 +1,31 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / WorkerMessage
+
+# Interface: WorkerMessage
+
+Defined in: src/threads/ThreadWorker.ts:17
+
+Describes a single message sent from the thread pool managger to a worker thread.
+
+## Properties
+
+### data?
+
+> `optional` **data**: `any`
+
+Defined in: src/threads/ThreadWorker.ts:19
+
+The data associated with the message.
+
+***
+
+### type
+
+> **type**: [`WorkerMessageType`](../enumerations/WorkerMessageType.md)
+
+Defined in: src/threads/ThreadWorker.ts:21
+
+The type of message sent.

package/docs/reference/interfaces/WorkerOptions.md

@@ -0,0 +1,61 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / WorkerOptions
+
+# Interface: WorkerOptions
+
+Defined in: src/threads/ThreadPool.ts:22
+
+Describes the various options that can be used when creating worker threads.
+
+## Properties
+
+### allowTs?
+
+> `optional` **allowTs**: `boolean`
+
+Defined in: src/threads/ThreadPool.ts:30
+
+Set to `true` to enable support for importing TypeScript modules in the worker. Default is `true`.
+
+***
+
+### args?
+
+> `optional` **args**: `any`
+
+Defined in: src/threads/ThreadPool.ts:24
+
+The list of initialization arguments to pass into the worker thread.
+
+***
+
+### entry?
+
+> `optional` **entry**: `string`
+
+Defined in: src/threads/ThreadPool.ts:26
+
+The path to the entry file create a worker thread from. Default is `ThreadWorkerEntry.js`.
+
+***
+
+### restartOnExit?
+
+> `optional` **restartOnExit**: `boolean`
+
+Defined in: src/threads/ThreadPool.ts:28
+
+Indicates if a worker thread should automatically be restarted on exit.
+
+***
+
+### worker?
+
+> `optional` **worker**: `string`
+
+Defined in: src/threads/ThreadPool.ts:32
+
+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

@@ -0,0 +1,23 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / BooleanFunc
+
+# Type Alias: BooleanFunc()
+
+> **BooleanFunc** = (`val`) => `boolean`
+
+Defined in: src/ValidationUtils.ts:9
+
+A simple validation function that returns a boolean success or fail.
+
+## Parameters
+
+### val
+
+`any`
+
+## Returns
+
+`boolean`

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

@@ -0,0 +1,17 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / TemplateMap
+
+# Type Alias: TemplateMap
+
+> **TemplateMap** = `Omit`\<[`TemplateMapBase`](../interfaces/TemplateMapBase.md), `"from"`\> & `object`
+
+Defined in: src/MessagingUtils.ts:16
+
+## Type Declaration
+
+### from
+
+> **from**: [`OriginSettings`](../interfaces/OriginSettings.md)

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

@@ -0,0 +1,31 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / WorkerCallback
+
+# Type Alias: WorkerCallback()
+
+> **WorkerCallback** = (`threadId`, `msg?`) => `void`
+
+Defined in: src/threads/ThreadPool.ts:17
+
+Callback function for `ThreadPool` events.
+
+## Parameters
+
+### threadId
+
+`number`
+
+The id of the thread that originated the event.
+
+### msg?
+
+`any`
+
+The optional message data associated with the event.
+
+## Returns
+
+`void`

package/docs/reference/variables/Logger.md

@@ -0,0 +1,21 @@
+[**@rapidrest/core**](../README.md)
+
+***
+
+[@rapidrest/core](../README.md) / Logger
+
+# Variable: Logger
+
+> `const` **Logger**: `any`
+
+Defined in: src/Logger.ts:17
+
+Creates a new logger with the specified level and file name to output logs to.
+
+## Param
+
+The logging level to create the logger with.
+
+## Param
+
+The name (without an extension) of the file to output logs to.

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@rapidrest/core",
+  "version": "1.0.1",
+  "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.8",
+    "js-yaml": "^4.1.1",
+    "jsonwebtoken": "^9.0.3",
+    "jszip": "^3.10.1",
+    "mkdirp": "^3.0.1",
+    "readline": "^1.3.0",
+    "triple-beam": "^1.4.1",
+    "uuid": "^13.0.0",
+    "validator": "^13.15.26"
+  },
+  "peerDependencies": {
+    "axios": "1.x",
+    "reflect-metadata": "0.2.x",
+    "winston": "3.x",
+    "winston-transport": "4.x"
+  },
+  "devDependencies": {
+    "@slack/bolt": "^4.6.0",
+    "@slack/web-api": "^7.13.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.2.0",
+    "@types/nodemailer": "^7.0.9",
+    "@types/triple-beam": "^1.3.5",
+    "@types/validator": "^13.15.10",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/parser": "^8.54.0",
+    "axios": "^1.13.4",
+    "coveralls": "^3.1.1",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jsdoc": "^62.5.0",
+    "mkdirp": "^3.0.1",
+    "nconf": "^0.13.0",
+    "nock": "^14.0.10",
+    "nodemailer": "^7.0.13",
+    "prettier": "^3.8.1",
+    "reflect-metadata": "^0.2.2",
+    "rimraf": "^6.1.2",
+    "ts-node": "^10.9.2",
+    "twilio": "^5.12.0",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18",
+    "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"
+  ]
+}