@rapidrest/core 1.3.1 → 1.3.2

package/dist/lib/StringUtils.js

@@ -67,11 +67,11 @@ export class StringUtils {
      * Replaces all instances of the match regex pattern with the contents of the inner regular expression pattern for
      * the given string.
      *
-     * e.g.
-     *
+     * @example
+     * ```ts
      * let result = replaceAll('/my/path/{id}', new RegExp('\\{([^\\}]+)\\}'), ':');
      * console.log(result); // -> /my/path/:id
-     *
+     * ```
      * @param {string} str The string to perform replacement on.
      * @param {RegExp} match The regular expression pattern to match containing an outer and inner pattern.
      * @param {string} prefix The prefix to prepend the replacement text with.

package/dist/types/StringUtils.d.ts

@@ -24,11 +24,11 @@ export declare class StringUtils {
      * Replaces all instances of the match regex pattern with the contents of the inner regular expression pattern for
      * the given string.
      *
-     * e.g.
-     *
+     * @example
+     * ```ts
      * let result = replaceAll('/my/path/{id}', new RegExp('\\{([^\\}]+)\\}'), ':');
      * console.log(result); // -> /my/path/:id
-     *
+     * ```
      * @param {string} str The string to perform replacement on.
      * @param {RegExp} match The regular expression pattern to match containing an outer and inner pattern.
      * @param {string} prefix The prefix to prepend the replacement text with.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rapidrest/core",
-    "version": "1.3.1",
+    "version": "1.3.2",
     "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>",
@@ -12,8 +12,6 @@
     ],
     "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 \"$@\"",
@@ -69,8 +67,6 @@
         "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",
@@ -90,7 +86,6 @@
     "type": "module",
     "typings": "dist/types/index.d.ts",
     "files": [
-        "dist",
-        "docs"
+        "dist"
     ]
 }

package/docs/Makefile

@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

package/docs/conf.py

@@ -1,58 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-import recommonmark
-from recommonmark.transform import AutoStructify
-
-source_suffix = ['.rst', '.md']
-
-# -- Project information -----------------------------------------------------
-
-project = 'RapidREST: Core Library'
-copyright = 'Jean-Philippe Steinmetz. All rights reserved.'
-author = 'RapidREST <rapidrests@gmail.com>'
-
-# -- General configuration ---------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'recommonmark',
-    'sphinx.ext.autodoc',
-]
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
-
-master_doc = 'index'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# app setup hook
-def setup(app):
-    app.add_config_value('recommonmark_config', {
-        'auto_toc_tree_section': 'Contents',
-        'enable_math': False,
-        'enable_inline_math': False,
-        'enable_eval_rst': True,
-        'enable_auto_doc_ref': True,
-    }, True)
-    app.add_transform(AutoStructify)

package/docs/index.rst

@@ -1,17 +0,0 @@
-===============================================================================
-RapidREST: Core Library
-===============================================================================
-
-Repository: ``git@github.com:rapidrest/core.git``
-
-A collection of common utilities and core functionality for rapidly building RESTful applications.
-
-.. toctree::
-   :caption: Project Info
-
-   ../README
-   
-.. toctree::
-   :caption: API Reference
-   
-   reference/globals

package/docs/make.bat

@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/README.md

@@ -1,21 +0,0 @@
-[**@rapidrest/core**](../../../README.md)
-
-***
-
-[@rapidrest/core](../../../globals.md) / ObjectDecorators
-
-# ObjectDecorators
-
-## Type Aliases
-
-- [ValidatorFunction](type-aliases/ValidatorFunction.md)
-
-## Functions
-
-- [Config](functions/Config.md)
-- [Destroy](functions/Destroy.md)
-- [Init](functions/Init.md)
-- [Inject](functions/Inject.md)
-- [Logger](functions/Logger.md)
-- [Nullable](functions/Nullable.md)
-- [Validator](functions/Validator.md)

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Config.md

@@ -1,33 +0,0 @@
-[**@rapidrest/core**](../../../../README.md)
-
-***
-
-[@rapidrest/core](../../../../globals.md) / [ObjectDecorators](../README.md) / Config
-
-# Function: Config()
-
-> **Config**(`path?`, `defaultValue?`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/ObjectDecorators.ts:61](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/decorators/ObjectDecorators.ts#L61)
-
-Apply this to a property to have a configuration variable be injected at instantiation. If no path is given, the
-global configuration object is injected.
-
-## Parameters
-
-### path?
-
-`string`
-
-The path to the configuration variable to inject.
-
-### defaultValue?
-
-`any` = `undefined`
-
-Set to the desired default value. If `undefined` is specified then an error is thrown if
-no config variable is found at the given path.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Destroy.md

@@ -1,27 +0,0 @@
-[**@rapidrest/core**](../../../../README.md)
-
-***
-
-[@rapidrest/core](../../../../globals.md) / [ObjectDecorators](../README.md) / Destroy
-
-# Function: Destroy()
-
-> **Destroy**(`target`, `propertyKey`): `void`
-
-Defined in: [src/decorators/ObjectDecorators.ts:10](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/decorators/ObjectDecorators.ts#L10)
-
-Apply this to a class function to mark it as a destructor to be called by the `ObjectFactory` during cleanup.
-
-## Parameters
-
-### target
-
-`any`
-
-### propertyKey
-
-`string`
-
-## Returns
-
-`void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Init.md

@@ -1,33 +0,0 @@
-[**@rapidrest/core**](../../../../README.md)
-
-***
-
-[@rapidrest/core](../../../../globals.md) / [ObjectDecorators](../README.md) / Init
-
-# Function: Init()
-
-> **Init**(`target`, `propertyKey`, `descriptor`): `void`
-
-Defined in: [src/decorators/ObjectDecorators.ts:49](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/decorators/ObjectDecorators.ts#L49)
-
-Apply this to a function to be executed once a new object instance has been created and all dependencies injected.
-Note: If the decorated function returns a Promise it is not gauranteed to finish execution before the object is
-returned during the instantiation process.
-
-## Parameters
-
-### target
-
-`any`
-
-### propertyKey
-
-`string`
-
-### descriptor
-
-`PropertyDescriptor`
-
-## Returns
-
-`void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Inject.md

@@ -1,33 +0,0 @@
-[**@rapidrest/core**](../../../../README.md)
-
-***
-
-[@rapidrest/core](../../../../globals.md) / [ObjectDecorators](../README.md) / Inject
-
-# Function: Inject()
-
-> **Inject**(`type`, `options?`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/ObjectDecorators.ts:21](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/decorators/ObjectDecorators.ts#L21)
-
-Injects an object instance to the decorated property of the given name and type using the provided arguments
-if no object has been created yet.
-
-## Parameters
-
-### type
-
-`any`
-
-The fully qualified name or type of the class to instantiate. If a type is given it's class name will be inferred
-via the constructor name.
-
-### options?
-
-[`InstanceOptions`](../../../../interfaces/InstanceOptions.md)
-
-The set of options to use when creating new instances of the injected class type.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Logger.md

@@ -1,27 +0,0 @@
-[**@rapidrest/core**](../../../../README.md)
-
-***
-
-[@rapidrest/core](../../../../globals.md) / [ObjectDecorators](../README.md) / Logger
-
-# Function: Logger()
-
-> **Logger**(`target`, `propertyKey`): `void`
-
-Defined in: [src/decorators/ObjectDecorators.ts:77](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/decorators/ObjectDecorators.ts#L77)
-
-Apply this to a property to have the logger utility injected at instantiation.
-
-## Parameters
-
-### target
-
-`any`
-
-### propertyKey
-
-`string` \| `symbol`
-
-## Returns
-
-`void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Nullable.md

@@ -1,27 +0,0 @@
-[**@rapidrest/core**](../../../../README.md)
-
-***
-
-[@rapidrest/core](../../../../globals.md) / [ObjectDecorators](../README.md) / Nullable
-
-# Function: Nullable()
-
-> **Nullable**(`target`, `propertyKey`): `void`
-
-Defined in: [src/decorators/ObjectDecorators.ts:90](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/decorators/ObjectDecorators.ts#L90)
-
-Apply this to a property to indicate that the value can be `null` or `undefined.`
-
-## Parameters
-
-### target
-
-`any`
-
-### propertyKey
-
-`string` \| `symbol`
-
-## Returns
-
-`void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/functions/Validator.md

@@ -1,25 +0,0 @@
-[**@rapidrest/core**](../../../../README.md)
-
-***
-
-[@rapidrest/core](../../../../globals.md) / [ObjectDecorators](../README.md) / Validator
-
-# Function: Validator()
-
-> **Validator**(`func`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/ObjectDecorators.ts:108](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/decorators/ObjectDecorators.ts#L108)
-
-Apply this to a property to specify the function that will be used to perform validation of the value.
-
-## Parameters
-
-### func
-
-[`ValidatorFunction`](../type-aliases/ValidatorFunction.md)
-
-The validation function to use for the given property.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/ObjectDecorators/type-aliases/ValidatorFunction.md

@@ -1,31 +0,0 @@
-[**@rapidrest/core**](../../../../README.md)
-
-***
-
-[@rapidrest/core](../../../../globals.md) / [ObjectDecorators](../README.md) / ValidatorFunction
-
-# Type Alias: ValidatorFunction
-
-> **ValidatorFunction** = (`value`) => `any`
-
-Defined in: [src/decorators/ObjectDecorators.ts:101](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/decorators/ObjectDecorators.ts#L101)
-
-A function used to validate a property value.
-
-## Parameters
-
-### value
-
-`any`
-
-The value to validate.
-
-## Returns
-
-`any`
-
-The validated value to assign to the property.
-
-## Throws
-
-An exception if the value cannot be validated.

package/docs/reference/README.md

@@ -1,35 +0,0 @@
-**@rapidrest/core**
-
-***
-
-# RapidREST: Core Library
-
-A set of common utilities shared amongst all RapidREST based applications and servers.
-
-## Features
-
-* Alert & Notification System
-* Class Loader
-* File management utilities
-* JSON Web Token utilities
-* Object Factory
-* OpenAPI utilities
-* String utilities
-* Telemetry utilities
-* Thread-pool Manager
-* User authentication utilities
-* Validation utilities
-
-## Getting Started
-
-### Yarn
-
-```
-yarn add @rapidrest/core
-```
-
-### NPM
-
-```
-npm i @rapidrest/core
-```

package/docs/reference/classes/AlertUtils.md

@@ -1,158 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / AlertUtils
-
-# Class: AlertUtils
-
-Defined in: [src/AlertUtils.ts:116](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L116)
-
-The `AlertUtils` class is used to send alerts about important system events that have occurred
-and require further monitoring or intervention.
-
-## Constructors
-
-### Constructor
-
-> **new AlertUtils**(`options`): `AlertUtils`
-
-Defined in: [src/AlertUtils.ts:128](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L128)
-
-Creates a new instance of `AuthUtils` with the provided defaults.
-
-#### Parameters
-
-##### options
-
-[`AlertUtilsOptions`](../interfaces/AlertUtilsOptions.md)
-
-The configuration options to use.
-
-#### Returns
-
-`AlertUtils`
-
-## Methods
-
-### addAttachment()
-
-> **addAttachment**(`id`, `attachment`, `indexFile?`): `Promise`\<`boolean`\>
-
-Defined in: [src/AlertUtils.ts:298](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L298)
-
-Uploads a single attachment to the alert with the given unique identifier.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the alert to add an attachment for.
-
-##### attachment
-
-[`AlertAttachment`](../interfaces/AlertAttachment.md)
-
-The file to upload as an attachment.
-
-##### indexFile?
-
-`string`
-
-Sets the indexFile parameter of the request.
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-True if the operation was successful, otherwise false.
-
-***
-
-### close()
-
-> **close**(`id`, `data?`): `Promise`\<`boolean`\>
-
-Defined in: [src/AlertUtils.ts:139](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L139)
-
-Attempts to close the existing alert with the given identifier.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the alert to close.
-
-##### data?
-
-[`AlertClose`](../interfaces/AlertClose.md) = `{}`
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-True if the operation was successful, otherwise false.
-
-***
-
-### get()
-
-> **get**(`id`): `Promise`\<[`Alert`](../interfaces/Alert.md) \| `null`\>
-
-Defined in: [src/AlertUtils.ts:167](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L167)
-
-Attempts to retrieve the existing alert with the given identifier.
-
-#### Parameters
-
-##### id
-
-`string`
-
-The unique identifier of the alert to retrieve.
-
-#### Returns
-
-`Promise`\<[`Alert`](../interfaces/Alert.md) \| `null`\>
-
-The retrieved alert if successful, otherwise `null`.
-
-***
-
-### send()
-
-> **send**(`alert`, `vars?`, `attachments?`): `Promise`\<`string` \| `null`\>
-
-Defined in: [src/AlertUtils.ts:191](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/AlertUtils.ts#L191)
-
-Sends the provided alert to the configured monitoring service.
-
-#### Parameters
-
-##### alert
-
-[`Alert`](../interfaces/Alert.md)
-
-The alert to send.
-
-##### vars?
-
-`any` = `{}`
-
-A map of vars to perform replacement on for the alert's various properties.
-
-##### attachments?
-
-[`AlertUtilsAttachmentOptions`](../interfaces/AlertUtilsAttachmentOptions.md)
-
-The attachments to upload along with the alert.
-
-#### Returns
-
-`Promise`\<`string` \| `null`\>
-
-The unique identifier of the created alert if the operation was successful, otherwise `null`.