@rapidrest/service-core 1.0.0-rc.7 → 1.0.0

package/dist/types/http/Adapters.d.ts

@@ -1,68 +0,0 @@
-import type { HttpRequest, HttpResponse } from "./types.js";
-import type { HttpRequest as UWSHttpRequest, HttpResponse as UWSHttpResponse } from "uWebSockets.js";
-/**
- * Adapts a uWS `HttpRequest` to the framework-agnostic `HttpRequest` interface.
- *
- * IMPORTANT: uWS HttpRequest is stack-allocated and only valid during the synchronous portion of
- * the handler. All request data MUST be captured in the constructor before any `await`.
- */
-export declare class UWSRequest implements HttpRequest {
-    readonly method: string;
-    readonly url: string;
-    readonly path: string;
-    readonly headers: Record<string, string>;
-    params: Record<string, string>;
-    readonly query: Record<string, string | string[]>;
-    body: any;
-    rawBody?: Buffer;
-    readonly cookies: Record<string, string>;
-    readonly signedCookies: Record<string, string>;
-    readonly socket: {
-        remoteAddress?: string;
-    };
-    user?: any;
-    authPayload?: any;
-    authToken?: string;
-    /** Allow arbitrary per-request properties (websocket, wsHandled, etc.) */
-    [key: string]: any;
-    constructor(uwsReq: UWSHttpRequest, remoteAddress?: string);
-}
-/**
- * Adapts a uWS `HttpResponse` to the framework-agnostic `HttpResponse` interface.
- *
- * Buffers headers and status code until the first write. Tracks abort state to safely
- * skip writes on aborted connections. All uWS writes are wrapped in `res.cork()` for
- * optimal performance.
- */
-export declare class UWSResponse implements HttpResponse {
-    private readonly uwsRes;
-    private _statusCode;
-    private _headers;
-    private _headersSent;
-    private _writableEnded;
-    private _aborted;
-    /** Set to true for HEAD requests — body bytes must not be sent. */
-    isHead: boolean;
-    /** Intermediate result passed between middleware. */
-    result?: any;
-    /** Allow arbitrary per-response properties. */
-    [key: string]: any;
-    constructor(uwsRes: UWSHttpResponse);
-    get statusCode(): number;
-    get headersSent(): boolean;
-    get writableEnded(): boolean;
-    status(code: number): this;
-    setHeader(key: string, value: string | number): this;
-    getHeader(key: string): string | undefined;
-    json(data: any): void;
-    send(data?: any): void;
-    end(data?: any): void;
-    /** Converts a numeric status code to the "200 OK" string format uWS expects. */
-    private _statusToString;
-}
-/**
- * Reads the full request body from a uWS response object as a Buffer.
- * Body parsing (JSON / URL-encoded) is applied based on content-type and the result
- * is cached on `req.body` / `req.rawBody`.
- */
-export declare function readBody(uwsRes: UWSHttpResponse, req: UWSRequest): Promise<void>;

package/dist/types/routes/AdminRoute.d.ts

@@ -1,47 +0,0 @@
-import { Redis } from "ioredis";
-import Transport from "winston-transport";
-/**
- * Implements a Winston transport that pipes incoming log messages to a configured redis pubsub channel.
- */
-export declare class RedisTransport extends Transport {
-    private channel;
-    private redis;
-    constructor(opts: any);
-    close(): void;
-    log(info: any, next: Function): any;
-}
-/**
- * The `AdminRoute` provides a default `/admin` endpoint that gives trusted users the following abilities:
- *
- * * Clear cache via `GET /admin/clear-cache`
- * * Live tail the service logs via `GET /admin/logs`
- * * Retrieve service dependencies via `GET /admin/dependencies`
- * * Retrieve service release notes via `GET /admin/release-notes`
- * * Restart the service via `GET /admin/restart`
- *
- * @author Jean-Philippe Steinmetz
- */
-export declare class AdminRoute {
-    /** A map of user uid's to active sockets. */
-    private activeSockets;
-    protected cacheClient?: Redis;
-    private cacheConnConfig;
-    private logger;
-    private logsConnConfig;
-    private redisClient?;
-    /** The underlying ReleaseNotes specification. */
-    private releaseNotes;
-    private serviceName?;
-    private trustedRoles;
-    /**
-     * Constructs a new `ReleaseNotesRoute` object with the specified defaults.
-     *
-     * @param releaseNotes The ReleaseNotes specification object to serve.
-     */
-    constructor(releaseNotes: string);
-    private init;
-    private clearCache;
-    private logs;
-    private get;
-    private restart;
-}

package/dist/types/routes/MetricsRoute.d.ts

@@ -1,15 +0,0 @@
-/**
- * Handles all REST API requests for the endpoint `/metrics'. This route handler produces Prometheus compatible metrics
- * for use with a Prometheus based server.
- *
- * Services that wish to provide metrics to be exposed via this route can register them using the global registry
- * from the provided `prom-client` dependency. See the `prom-client` documentation for more details.
- */
-export declare class MetricsRoute {
-    private metricsConfig;
-    private registry;
-    private trustedRoles;
-    constructor();
-    private getMetrics;
-    private getSingleMetric;
-}

package/dist/types/routes/OpenAPIRoute.d.ts

@@ -1,17 +0,0 @@
-/**
- * The `OpenAPIRoute` provides default routes to expose the service's OpenAPI specification.
- *
- * - `GET /` — Swagger UI HTML (loads swagger-ui-dist from CDN)
- * - `GET /openapi.json` — raw OpenAPI specification as JSON
- * - `GET /openapi.yaml` — raw OpenAPI specification as YAML
- *
- * @author Jean-Philippe Steinmetz
- */
-export declare class OpenAPIRoute {
-    /** The underlying OpenAPI specification. */
-    private apiSpec;
-    getHTML(): string;
-    getAPIDocs(): string;
-    getJSON(): any;
-    getYAML(): string;
-}

package/dist/types/routes/StatusRoute.d.ts

@@ -1,11 +0,0 @@
-/**
- * The `StatusRoute` provides a default `/status` endpoint the returns metadata information about the service such as
- * name, version.
- *
- * @author Jean-Philippe Steinmetz
- */
-export declare class StatusRoute {
-    private config;
-    private statusExtraData;
-    private get;
-}

package/dist/types/security/ACLRouteMongo.d.ts

@@ -1,19 +0,0 @@
-import { AccessControlListMongo } from "./AccessControlListMongo.js";
-import { MongoRepository as Repo } from "../database/MongoRepository.js";
-import { ModelRoute } from "../routes/ModelRoute.js";
-export declare class ACLRouteMongo extends ModelRoute<AccessControlListMongo> {
-    protected repo?: Repo<AccessControlListMongo>;
-    protected readonly repoUtilsClass: any;
-    constructor();
-    /**
-     * The base key used to get or set data in the cache.
-     */
-    protected get baseCacheKey(): string;
-    private create;
-    private updateBulk;
-    private count;
-    private findAll;
-    private delete;
-    private findById;
-    private update;
-}

package/dist/types/security/ACLRouteSQL.d.ts

@@ -1,19 +0,0 @@
-import { AccessControlListSQL } from "./AccessControlListSQL.js";
-import type { Repository as Repo } from "typeorm";
-import { ModelRoute } from "../routes/ModelRoute.js";
-export declare class ACLRouteSQL extends ModelRoute<AccessControlListSQL> {
-    protected repo?: Repo<AccessControlListSQL>;
-    protected readonly repoUtilsClass: any;
-    constructor();
-    /**
-     * The base key used to get or set data in the cache.
-     */
-    protected get baseCacheKey(): string;
-    private create;
-    private updateBulk;
-    private count;
-    private findAll;
-    private delete;
-    private findById;
-    private update;
-}

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 = 'Core Library'
-copyright = 'RapidREST All rights reserved.'
-author = 'RapidREST'
-
-# -- 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 @@
-===============================================================================
-Services Core Library
-===============================================================================
-
-Repository: ``git clone https://github.com/rapidrest/service-core.git``
-
-Provides all core functionality for RapidREST based backend services.
-
-.. toctree::
-   :caption: Project Info
-
-   reference/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/DatabaseDecorators/README.md

@@ -1,13 +0,0 @@
-[**@rapidrest/service-core**](../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../globals.md) / DatabaseDecorators
-
-# DatabaseDecorators
-
-## Functions
-
-- [MongoRepository](functions/MongoRepository.md)
-- [RedisConnection](functions/RedisConnection.md)
-- [Repository](functions/Repository.md)

package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DatabaseDecorators](../README.md) / MongoRepository
-
-# Function: MongoRepository()
-
-> **MongoRepository**(`type`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/DatabaseDecorators.ts:10](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DatabaseDecorators.ts#L10)
-
-Apply this to a property to have the TypeORM `MongoRepository` for the given entity type injected at instantiation.
-
-## Parameters
-
-### type
-
-`any`
-
-The entity type whose repository will be injected.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DatabaseDecorators](../README.md) / RedisConnection
-
-# Function: RedisConnection()
-
-> **RedisConnection**(`name`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/DatabaseDecorators.ts:44](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DatabaseDecorators.ts#L44)
-
-Apply this to a property to have the `Redis` connection injected at instantiation.
-
-## Parameters
-
-### name
-
-`string`
-
-The name of the database connection to inject.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DatabaseDecorators](../README.md) / Repository
-
-# Function: Repository()
-
-> **Repository**(`type`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/DatabaseDecorators.ts:27](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DatabaseDecorators.ts#L27)
-
-Apply this to a property to have the TypeORM `Repository` for the given entity type injected at instantiation.
-
-## Parameters
-
-### type
-
-`any`
-
-The entity type whose repository will be injected.
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

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

@@ -1,23 +0,0 @@
-[**@rapidrest/service-core**](../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../globals.md) / DocDecorators
-
-# DocDecorators
-
-## Interfaces
-
-- [DocumentsData](interfaces/DocumentsData.md)
-
-## Functions
-
-- [Default](functions/Default.md)
-- [Description](functions/Description.md)
-- [Document](functions/Document.md)
-- [Example](functions/Example.md)
-- [Format](functions/Format.md)
-- [Returns](functions/Returns.md)
-- [Summary](functions/Summary.md)
-- [Tags](functions/Tags.md)
-- [TypeInfo](functions/TypeInfo.md)

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Default
-
-# Function: Default()
-
-> **Default**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:40](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DocDecorators.ts#L40)
-
-Provides a default value for property of a class.
-
-## Parameters
-
-### value
-
-`string`
-
-The default value.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Description
-
-# Function: Description()
-
-> **Description**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:51](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DocDecorators.ts#L51)
-
-Provides a detailed describing the class, property or function.
-
-## Parameters
-
-### value
-
-`string`
-
-The description of the class, property or function.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Document
-
-# Function: Document()
-
-> **Document**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:20](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DocDecorators.ts#L20)
-
-Provides a set of documentation data for a given class, property or function.
-
-## Parameters
-
-### value
-
-[`DocumentsData`](../interfaces/DocumentsData.md)
-
-The default value.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Example
-
-# Function: Example()
-
-> **Example**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:62](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DocDecorators.ts#L62)
-
-Provides a example representation of the property or function return value.
-
-## Parameters
-
-### value
-
-`any`
-
-The example value.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Format
-
-# Function: Format()
-
-> **Format**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:73](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DocDecorators.ts#L73)
-
-Describes the underlying format of a class's property.
-
-## Parameters
-
-### value
-
-`string`
-
-The format of the property's property.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md

@@ -1,28 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Returns
-
-# Function: Returns()
-
-> **Returns**(`types?`): (`target`, `propertyKey`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:109](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DocDecorators.ts#L109)
-
-Stores runtime metadata about the typing information of a function's return value.
-
-## Parameters
-
-### types?
-
-`any`
-
-The optional return type(s) of the function. Can represent a single type (e.g. `MyClass`) or a union
-of types (e.g. `string | number | null`). When describing a generic type such as a collection this
-should be encoded as an array with the templated type as additional elements (e.g. `Array<MyClass>`
-becomes `[[Array, MyClass]]`).
-
-## Returns
-
-(`target`, `propertyKey`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Summary
-
-# Function: Summary()
-
-> **Summary**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:84](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DocDecorators.ts#L84)
-
-Provides a brief summary about the class, property or function.
-
-## Parameters
-
-### value
-
-`string`
-
-The summary of the class, property or function.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-
-***
-
-[@rapidrest/service-core](../../../../globals.md) / [DocDecorators](../README.md) / Tags
-
-# Function: Tags()
-
-> **Tags**(`value`): (`target`, `propertyKey?`) => `void`
-
-Defined in: [src/decorators/DocDecorators.ts:95](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/DocDecorators.ts#L95)
-
-Provides a list of searchable tags associated with the property or function.
-
-## Parameters
-
-### value
-
-`string`[]
-
-The list of searchable tags.
-
-## Returns
-
-(`target`, `propertyKey?`) => `void`