@flowerforce/flowerbase 1.6.2 → 1.6.3-beta.0

package/README.md

@@ -64,7 +64,7 @@ Add `tsconfig.json` file
 npx tsc --init
 ```
 
-In your `packages.json`, inside the script section add this: 
+In your `package.json`, inside the script section add this: 
 
 ```json
 {
@@ -85,46 +85,7 @@ touch src/index.ts
 ```
 
 ## 🌿 3. Environment Variables
-Ensure the following environment variables are set in your .env file or deployment environment:
-
-
-| Variable               | Description                                                                 | Example                                            |
-| ---------------------- | --------------------------------------------------------------------------- | -------------------------------------------------- |
-| `PROJECT_ID`           | A unique ID to identify your project. This value can be freely invented — it's preserved mainly for compatibility with the old Realm-style project structure.                     | `my-flowerbase-app`                                |
-| `PORT`                 | The port on which the server will run.                                      | `3000`                                             |
-| `MONGODB_URL`          | MongoDB connection URI, including username, password, and database name.    | `mongodb+srv://user:pass@cluster.mongodb.net/mydb` |
-| `JWT_SECRET`           | Secret used to sign and verify JWT tokens (choose a strong secret).         | `supersecretkey123!`                               |
-| `HOST`                 | The host address the server binds to (usually `0.0.0.0` for public access). | `0.0.0.0`                                          |
-| `HTTPS_SCHEMA`         | The schema for your server requests (usually `https` or `http`).            | `http`                                             |
-| `RESET_PASSWORD_TTL_SECONDS` | Time-to-live for password reset tokens (in seconds).                  | `3600`                                             |
-| `AUTH_RATE_LIMIT_WINDOW_MS`  | Rate limit window for auth endpoints (in ms).                          | `900000`                                           |
-| `AUTH_LOGIN_MAX_ATTEMPTS`    | Max login attempts per window.                                         | `10`                                               |
-| `AUTH_RESET_MAX_ATTEMPTS`    | Max reset requests per window.                                         | `5`                                                |
-| `REFRESH_TOKEN_TTL_DAYS`     | Refresh token time-to-live (in days).                                  | `60`                                               |
-| `SWAGGER_ENABLED`      | Enable Swagger UI and spec routes (disabled by default).                    | `true`                                             |
-| `SWAGGER_UI_USER`      | Basic Auth username for Swagger UI (optional).                            | `admin`                                            |
-| `SWAGGER_UI_PASSWORD`  | Basic Auth password for Swagger UI (optional).                            | `change-me`                                        |
-
-
-Example:
-```env
-PROJECT_ID=your-project-id
-PORT=3000
-MONGODB_URL=mongodb+srv://username:password@cluster.mongodb.net/dbname
-JWT_SECRET=your-jwt-secret
-HOST=0.0.0.0
-HTTPS_SCHEMA=http
-RESET_PASSWORD_TTL_SECONDS=3600
-AUTH_RATE_LIMIT_WINDOW_MS=900000
-AUTH_LOGIN_MAX_ATTEMPTS=10
-AUTH_RESET_MAX_ATTEMPTS=5
-REFRESH_TOKEN_TTL_DAYS=60
-SWAGGER_ENABLED=true
-SWAGGER_UI_USER=admin
-SWAGGER_UI_PASSWORD=change-me
-```
-
-🛡️ Note: Never commit .env files to source control. Use a .gitignore file to exclude it.
+Ensure the same environment variables described in the "Environment Variables" section above are set in your .env file or deployment environment.
 
 
 ## 🧩 4. Initialize Flowerbase
@@ -258,12 +219,13 @@ The authentication modes currently re-implemented in `@flowerforce/flowerbase` a
 }
 ```
 
-You can specify the MongoDB collection used to store authentication users by configuring the `auth_collection` field inside the `auth/providers.json` file.
+You can specify the MongoDB collection used to store authentication users by setting `auth_collection` at the root of `auth/providers.json`.
 
 #### 📁 auth/providers.json
 Example
 ```json
 {
+    "auth_collection": "my-users-collection",
     "api-key": {
         "name": "api-key",
         "type": "api-key",
@@ -273,12 +235,13 @@ Example
         "name": "local-userpass",
         "type": "local-userpass",
         "disabled": false,
-        "auth_collection": "my-users-collection", //custom collection name
         "config": {
             "autoConfirm": true,
-            "resetPasswordSubject": "reset",
+            "confirmationFunctionName": "",
+            "resetFunctionName": "",
             "resetPasswordUrl": "https://my.app.url/password-reset",
-            "runConfirmationFunction": false
+            "runConfirmationFunction": false,
+            "runResetFunction": false
         }
     },
     "anon-user": {
@@ -354,49 +317,9 @@ This will download a `.zip` file containing your Realm app's full structure and
 
 ✅ You are now ready to migrate or inspect your Realm app locally!
 
-1) In your existing project folder, initialize a new Node.js project, Run:
-
-```bash
-npm init -y
-```
-2) Install Flowerbase
+1) Reuse the same project setup steps from "Creating a New Project from Scratch" (init, install, tsconfig, scripts).
 
-```bash
-npm install @flowerforce/flowerbase
-```
-
-3) Add Typescript
-
-```bash
-npm install --save-dev typescript @types/node ts-node
-```
-
-
-4) Add `tsconfig.json` file
-
-```bash
-npx tsc --init
-```
-
-5) Create an index.ts file
-
-Inside your project, create index.ts:
-
-```bash
-touch index.ts
-```
-
-6) In your `packages.json`, inside the script section add this: 
-
-```json
-{
-  "start": "ts-node index.ts"
-}
-```
-
-Initialize the Flowerbase App
-
-In index.ts, add:
+Initialize the Flowerbase App in `index.ts`:
 
 ```ts
 import { initialize } from '@flowerforce/flowerbase';
@@ -427,15 +350,31 @@ Ensure the following environment variables are set in your .env file or deployme
 | `MONGODB_URL`          | MongoDB connection URI, including username, password, and database name.    | `mongodb+srv://user:pass@cluster.mongodb.net/mydb` |
 | `JWT_SECRET`           | Secret used to sign and verify JWT tokens (choose a strong secret).         | `supersecretkey123!`                               |
 | `HOST`                 | The host address the server binds to (usually `0.0.0.0` for public access). | `0.0.0.0`                                          |
+| `API_VERSION`          | API version used in client base path.                                       | `v2.0`                                             |
 | `HTTPS_SCHEMA`         | The schema for your server requests (usually `https` or `http`).            | `http`                                             |
+| `ENABLE_LOGGER`        | Enable Fastify logger (any truthy value).                                   | `true`                                             |
 | `RESET_PASSWORD_TTL_SECONDS` | Time-to-live for password reset tokens (in seconds).                  | `3600`                                             |
 | `AUTH_RATE_LIMIT_WINDOW_MS`  | Rate limit window for auth endpoints (in ms).                          | `900000`                                           |
 | `AUTH_LOGIN_MAX_ATTEMPTS`    | Max login attempts per window.                                         | `10`                                               |
+| `AUTH_REGISTER_MAX_ATTEMPTS` | Max register attempts per window.                                      | `5`                                                |
 | `AUTH_RESET_MAX_ATTEMPTS`    | Max reset requests per window.                                         | `5`                                                |
 | `REFRESH_TOKEN_TTL_DAYS`     | Refresh token time-to-live (in days).                                  | `60`                                               |
+| `ANON_USER_TTL_SECONDS` | Anonymous user time-to-live (in seconds).                                  | `10800`                                            |
 | `SWAGGER_ENABLED`      | Enable Swagger UI and spec routes (disabled by default).                    | `true`                                             |
 | `SWAGGER_UI_USER`      | Basic Auth username for Swagger UI (optional).                            | `admin`                                            |
 | `SWAGGER_UI_PASSWORD`  | Basic Auth password for Swagger UI (optional).                            | `change-me`                                        |
+| `MONIT_ENABLED`        | Enable monitoring UI at `/monit`. Must be `true` for monit to run (credentials alone are not enough). | `true` |
+| `MONIT_USER`           | Basic Auth username for `/monit`.                                         | `monit`                                            |
+| `MONIT_PASSWORD`       | Basic Auth password for `/monit`.                                         | `change-me`                                        |
+| `MONIT_CACHE_HOURS`    | Cache duration for monitoring events (hours).                             | `24`                                               |
+| `MONIT_MAX_EVENTS`     | Maximum number of cached monitoring events.                               | `5000`                                             |
+| `MONIT_CAPTURE_CONSOLE`| Capture console log/warn/error into monitoring events.                     | `true`                                             |
+| `MONIT_REDACT_ERROR_DETAILS` | Redact error message/stack in monitoring output.                      | `true`                                             |
+| `MONIT_ALLOWED_IPS`    | Comma-separated allowlist for `/monit` (uses `req.ip`). Use `0.0.0.0` or `*` to allow all. | `127.0.0.1,10.0.0.10`                              |
+| `MONIT_RATE_LIMIT_WINDOW_MS` | Rate limit window for `/monit` (ms).                                 | `60000`                                            |
+| `MONIT_RATE_LIMIT_MAX` | Max requests per window for `/monit`.                                     | `120`                                              |
+| `MONIT_ALLOW_INVOKE`   | Allow function invoke from monit UI.                                      | `true`                                             |
+| `MONIT_ALLOW_EDIT`     | Allow function code access/override from monit UI.                         | `true`                                             |
 
 
 Example:
@@ -445,19 +384,42 @@ PORT=3000
 MONGODB_URL=mongodb+srv://username:password@cluster.mongodb.net/dbname
 JWT_SECRET=your-jwt-secret
 HOST=0.0.0.0
+API_VERSION=v2.0
 HTTPS_SCHEMA=http
+ENABLE_LOGGER=true
 RESET_PASSWORD_TTL_SECONDS=3600
 AUTH_RATE_LIMIT_WINDOW_MS=900000
 AUTH_LOGIN_MAX_ATTEMPTS=10
+AUTH_REGISTER_MAX_ATTEMPTS=5
 AUTH_RESET_MAX_ATTEMPTS=5
 REFRESH_TOKEN_TTL_DAYS=60
+ANON_USER_TTL_SECONDS=10800
 SWAGGER_ENABLED=true
 SWAGGER_UI_USER=admin
 SWAGGER_UI_PASSWORD=change-me
+MONIT_ENABLED=true
+MONIT_USER=monit
+MONIT_PASSWORD=change-me
+MONIT_CACHE_HOURS=24
+MONIT_MAX_EVENTS=5000
+MONIT_CAPTURE_CONSOLE=true
+MONIT_REDACT_ERROR_DETAILS=true
+MONIT_ALLOWED_IPS=127.0.0.1,10.0.0.10
+MONIT_RATE_LIMIT_WINDOW_MS=60000
+MONIT_RATE_LIMIT_MAX=120
+MONIT_ALLOW_INVOKE=true
+MONIT_ALLOW_EDIT=true
 ```
 
 🛡️ Note: Never commit .env files to source control. Use a .gitignore file to exclude it.
 
+### 🔎 Monitoring (Monit UI)
+
+- The monitoring UI lives at `/monit` and is protected by Basic Auth.
+- Monit routes are registered **only** when `MONIT_ENABLED=true` (credentials alone are not enough).
+- If `MONIT_ALLOWED_IPS` is set, only those IPs can reach `/monit` (ensure `req.ip` reflects your proxy setup / `trustProxy`).
+- You can disable **invoke** or **edit** with `MONIT_ALLOW_INVOKE=false` and/or `MONIT_ALLOW_EDIT=false`.
+
 
 <a id="build"></a>
 ## 🚀 Build & Deploy the Server

package/dist/auth/controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/auth/controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAQzC;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,GAAG,EAAE,eAAe,iBA0JxD"}
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/auth/controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAQzC;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,GAAG,EAAE,eAAe,iBAwKxD"}

package/dist/auth/controller.js

@@ -47,7 +47,11 @@ function authController(app) {
          * @param {import('fastify').FastifyRequest} req - The request object.
          * @returns {Promise<Object>} A promise resolving with the user's profile data.
          */
-        app.get(utils_1.AUTH_ENDPOINTS.PROFILE, function (req) {
+        app.get(utils_1.AUTH_ENDPOINTS.PROFILE, {
+            schema: {
+                tags: ['Auth']
+            }
+        }, function (req) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (req.user.typ !== 'access') {
                     throw new Error('Access token required');
@@ -75,7 +79,11 @@ function authController(app) {
          * @param {import('fastify').FastifyReply} res - The response object.
          * @returns {Promise<SessionCreatedDto>} A promise resolving with the newly created session data.
          */
-        app.post(utils_1.AUTH_ENDPOINTS.SESSION, function (req, res) {
+        app.post(utils_1.AUTH_ENDPOINTS.SESSION, {
+            schema: {
+                tags: ['Auth']
+            }
+        }, function (req, res) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (req.user.typ !== 'refresh') {
                     throw new Error(utils_1.AUTH_ERRORS.INVALID_TOKEN);
@@ -110,7 +118,11 @@ function authController(app) {
         /**
            * Endpoint to destroy the existing session.
            */
-        app.delete(utils_1.AUTH_ENDPOINTS.SESSION, function (req, res) {
+        app.delete(utils_1.AUTH_ENDPOINTS.SESSION, {
+            schema: {
+                tags: ['Auth']
+            }
+        }, function (req, res) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b;
                 const authHeader = req.headers.authorization;

package/dist/auth/providers/anon-user/controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../../../src/auth/providers/anon-user/controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAOzC;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,eAAe,iBAmE5D"}
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../../../src/auth/providers/anon-user/controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAOzC;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,eAAe,iBAwE5D"}

package/dist/auth/providers/anon-user/controller.js

@@ -35,7 +35,11 @@ function anonUserController(app) {
         catch (error) {
             console.error('Failed to ensure anonymous user TTL index', error);
         }
-        app.post(utils_1.AUTH_ENDPOINTS.LOGIN, function () {
+        app.post(utils_1.AUTH_ENDPOINTS.LOGIN, {
+            schema: {
+                tags: ['Auth']
+            }
+        }, function () {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a;
                 const anonProvider = (_a = constants_1.AUTH_CONFIG.authProviders) === null || _a === void 0 ? void 0 : _a['anon-user'];

package/dist/auth/providers/custom-function/schema.d.ts

@@ -1,4 +1,5 @@
 export declare const LOGIN_SCHEMA: {
+    tags: string[];
     body: {
         type: string;
         properties: {

package/dist/auth/providers/custom-function/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/auth/providers/custom-function/schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwBxB,CAAA"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/auth/providers/custom-function/schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuBxB,CAAA"}

package/dist/auth/providers/custom-function/schema.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LOGIN_SCHEMA = void 0;
 exports.LOGIN_SCHEMA = {
+    tags: ['Auth'],
     body: {
         type: 'object',
         properties: {

package/dist/auth/utils.d.ts

@@ -1,4 +1,5 @@
 export declare const LOGIN_SCHEMA: {
+    tags: string[];
     body: {
         type: string;
         properties: {
@@ -18,6 +19,7 @@ export declare const LOGIN_SCHEMA: {
     };
 };
 export declare const RESET_SEND_SCHEMA: {
+    tags: string[];
     body: {
         type: string;
         properties: {
@@ -32,6 +34,7 @@ export declare const RESET_SEND_SCHEMA: {
     };
 };
 export declare const RESET_CALL_SCHEMA: {
+    tags: string[];
     body: {
         type: string;
         properties: {
@@ -54,6 +57,7 @@ export declare const RESET_CALL_SCHEMA: {
     };
 };
 export declare const CONFIRM_RESET_SCHEMA: {
+    tags: string[];
     body: {
         type: string;
         properties: {
@@ -73,6 +77,7 @@ export declare const CONFIRM_RESET_SCHEMA: {
     };
 };
 export declare const CONFIRM_USER_SCHEMA: {
+    tags: string[];
     body: {
         type: string;
         properties: {
@@ -87,6 +92,7 @@ export declare const CONFIRM_USER_SCHEMA: {
     };
 };
 export declare const RESET_SCHEMA: {
+    tags: string[];
     body: {
         type: string;
         properties: {
@@ -101,6 +107,7 @@ export declare const RESET_SCHEMA: {
     };
 };
 export declare const REGISTRATION_SCHEMA: {
+    tags: string[];
     body: {
         type: string;
         properties: {

package/dist/auth/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/auth/utils.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;CAcxB,CAAA;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;CAa7B,CAAA;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;CAe7B,CAAA;AAED,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;CAUhC,CAAA;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;CAS/B,CAAA;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;CAAoB,CAAA;AAE7C,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;CAc/B,CAAA;AAED,oBAAY,cAAc;IACxB,KAAK,WAAW;IAChB,YAAY,cAAc;IAC1B,OAAO,aAAa;IACpB,OAAO,aAAa;IACpB,OAAO,aAAa;IACpB,KAAK,gBAAgB;IACrB,UAAU,gBAAgB;IAC1B,aAAa,WAAW;IACxB,UAAU,sBAAsB;CACjC;AAED,oBAAY,WAAW;IACrB,mBAAmB,wBAAwB;IAC3C,aAAa,mCAAmC;IAChD,oBAAoB,sCAAsC;IAC1D,sBAAsB,2BAA2B;IACjD,kBAAkB,uBAAuB;CAC1C;AAED,MAAM,WAAW,UAAU;IACzB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,gBAAgB,EAAE,aAAa,CAAA;IAC/B,iBAAiB,EAAE,cAAc,CAAA;IACjC,WAAW,CAAC,EAAE,QAAQ,CAAA;CACvB;AAED,UAAU,MAAM;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;CAClB;AACD,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,UAAU,cAAc;IACtB,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,iBAAiB,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE;QACN,kBAAkB,EAAE,MAAM,CAAA;KAC3B,CAAA;CACF;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,WAAW,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,WAAW,EAAE,OAAO,CAAA;IACpB,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;IACxB,uBAAuB,EAAE,OAAO,CAAA;IAChC,gBAAgB,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;IACvB,aAAa,EAAE,MAAM,CAAA;IACrB,8BAA8B,EAAE,MAAM,CAAA;CACvC;AAMD;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAO,UAuCjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAO,oBAarC,CAAA;AAED,eAAO,MAAM,gBAAgB,GAAI,eAAW,WAG3C,CAAA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/auth/utils.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;CAexB,CAAA;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;CAc7B,CAAA;AAED,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;CAgB7B,CAAA;AAED,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;CAWhC,CAAA;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;CAU/B,CAAA;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;;CAAoB,CAAA;AAE7C,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;CAe/B,CAAA;AAED,oBAAY,cAAc;IACxB,KAAK,WAAW;IAChB,YAAY,cAAc;IAC1B,OAAO,aAAa;IACpB,OAAO,aAAa;IACpB,OAAO,aAAa;IACpB,KAAK,gBAAgB;IACrB,UAAU,gBAAgB;IAC1B,aAAa,WAAW;IACxB,UAAU,sBAAsB;CACjC;AAED,oBAAY,WAAW;IACrB,mBAAmB,wBAAwB;IAC3C,aAAa,mCAAmC;IAChD,oBAAoB,sCAAsC;IAC1D,sBAAsB,2BAA2B;IACjD,kBAAkB,uBAAuB;CAC1C;AAED,MAAM,WAAW,UAAU;IACzB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,gBAAgB,EAAE,aAAa,CAAA;IAC/B,iBAAiB,EAAE,cAAc,CAAA;IACjC,WAAW,CAAC,EAAE,QAAQ,CAAA;CACvB;AAED,UAAU,MAAM;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;CAClB;AACD,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,UAAU,cAAc;IACtB,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,iBAAiB,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE;QACN,kBAAkB,EAAE,MAAM,CAAA;KAC3B,CAAA;CACF;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,WAAW,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,WAAW,EAAE,OAAO,CAAA;IACpB,wBAAwB,CAAC,EAAE,MAAM,CAAA;IACjC,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;IACxB,uBAAuB,EAAE,OAAO,CAAA;IAChC,gBAAgB,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;IACvB,aAAa,EAAE,MAAM,CAAA;IACrB,8BAA8B,EAAE,MAAM,CAAA;CACvC;AAMD;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAO,UAuCjC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,QAAO,oBAarC,CAAA;AAED,eAAO,MAAM,gBAAgB,GAAI,eAAW,WAG3C,CAAA"}

package/dist/auth/utils.js

@@ -9,6 +9,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const CHARSET = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%^&*()-_=+[]{};:,.<>?";
 exports.LOGIN_SCHEMA = {
+    tags: ['Auth'],
     body: {
         type: 'object',
         properties: {
@@ -24,6 +25,7 @@ exports.LOGIN_SCHEMA = {
     }
 };
 exports.RESET_SEND_SCHEMA = {
+    tags: ['Auth'],
     body: {
         type: 'object',
         properties: {
@@ -38,6 +40,7 @@ exports.RESET_SEND_SCHEMA = {
     }
 };
 exports.RESET_CALL_SCHEMA = {
+    tags: ['Auth'],
     body: {
         type: 'object',
         properties: {
@@ -54,6 +57,7 @@ exports.RESET_CALL_SCHEMA = {
     }
 };
 exports.CONFIRM_RESET_SCHEMA = {
+    tags: ['Auth'],
     body: {
         type: 'object',
         properties: {
@@ -65,6 +69,7 @@ exports.CONFIRM_RESET_SCHEMA = {
     }
 };
 exports.CONFIRM_USER_SCHEMA = {
+    tags: ['Auth'],
     body: {
         type: 'object',
         properties: {
@@ -76,6 +81,7 @@ exports.CONFIRM_USER_SCHEMA = {
 };
 exports.RESET_SCHEMA = exports.RESET_SEND_SCHEMA;
 exports.REGISTRATION_SCHEMA = {
+    tags: ['Auth'],
     body: {
         type: 'object',
         properties: {

package/dist/constants.d.ts

@@ -17,6 +17,18 @@ export declare const DEFAULT_CONFIG: {
     SWAGGER_ENABLED: boolean;
     SWAGGER_UI_USER: string;
     SWAGGER_UI_PASSWORD: string;
+    MONIT_ENABLED: boolean;
+    MONIT_USER: string;
+    MONIT_PASSWORD: string;
+    MONIT_CACHE_HOURS: number;
+    MONIT_MAX_EVENTS: number;
+    MONIT_CAPTURE_CONSOLE: boolean;
+    MONIT_REDACT_ERROR_DETAILS: boolean;
+    MONIT_ALLOWED_IPS: string[];
+    MONIT_RATE_LIMIT_WINDOW_MS: number;
+    MONIT_RATE_LIMIT_MAX: number;
+    MONIT_ALLOW_INVOKE: boolean;
+    MONIT_ALLOW_EDIT: boolean;
     CORS_OPTIONS: {
         origin: string;
         methods: ALLOWED_METHODS[];

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,IAAI,CAAA;AAepC,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;iBAoBsB,eAAe,EAAE;;CAEjE,CAAA;AACD,eAAO,MAAM,WAAW,QAA8C,CAAA;AACtE,eAAO,MAAM,YAAY,QAA8B,CAAA;AACvD,eAAO,MAAM,OAAO,QAAgB,CAAA;AAEpC,KAAK,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAA;AAE7E,eAAO,MAAM,WAAW;;;;;;;mBAOqB,aAAa;;;;;;;;;CAOzD,CAAA;AAID,eAAO,MAAM,SAAS;;;CAGrB,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,IAAI,CAAA;AAsBpC,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmCsB,eAAe,EAAE;;CAEjE,CAAA;AACD,eAAO,MAAM,WAAW,QAA8C,CAAA;AACtE,eAAO,MAAM,YAAY,QAA8B,CAAA;AACvD,eAAO,MAAM,OAAO,QAAgB,CAAA;AAEpC,KAAK,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAA;AAE7E,eAAO,MAAM,WAAW;;;;;;;mBAOqB,aAAa;;;;;;;;;CAOzD,CAAA;AAID,eAAO,MAAM,SAAS;;;CAGrB,CAAA"}

package/dist/constants.js

@@ -10,7 +10,7 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-var _a, _b, _c;
+var _a, _b, _c, _d, _e, _f, _g, _h;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.S3_CONFIG = exports.AUTH_CONFIG = exports.DB_NAME = exports.HTTPS_SCHEMA = exports.API_VERSION = exports.DEFAULT_CONFIG = void 0;
 const utils_1 = require("./auth/utils");
@@ -19,8 +19,14 @@ const parseBoolean = (value) => {
         return false;
     return ['1', 'true', 'yes', 'on'].includes(value.toLowerCase());
 };
+const monitUser = process.env.MONIT_USER || process.env.SWAGGER_UI_USER || '';
+const monitPassword = process.env.MONIT_PASSWORD || process.env.SWAGGER_UI_PASSWORD || '';
+const monitEnabledEnv = process.env.MONIT_ENABLED;
+const monitEnabled = typeof monitEnabledEnv === 'string'
+    ? parseBoolean(monitEnabledEnv)
+    : false;
 const { database_name, collection_name = 'users', user_id_field = 'id', on_user_creation_function_name } = (0, utils_1.loadCustomUserData)();
-const _d = (0, utils_1.loadAuthConfig)(), { auth_collection = 'auth_users' } = _d, configuration = __rest(_d, ["auth_collection"]);
+const _j = (0, utils_1.loadAuthConfig)(), { auth_collection = 'auth_users' } = _j, configuration = __rest(_j, ["auth_collection"]);
 exports.DEFAULT_CONFIG = {
     PORT: Number(process.env.PORT) || 3000,
     MONGODB_URL: process.env.MONGODB_URL || '',
@@ -39,6 +45,21 @@ exports.DEFAULT_CONFIG = {
     SWAGGER_ENABLED: parseBoolean(process.env.SWAGGER_ENABLED),
     SWAGGER_UI_USER: process.env.SWAGGER_UI_USER || '',
     SWAGGER_UI_PASSWORD: process.env.SWAGGER_UI_PASSWORD || '',
+    MONIT_ENABLED: monitEnabled,
+    MONIT_USER: monitUser,
+    MONIT_PASSWORD: monitPassword,
+    MONIT_CACHE_HOURS: Number(process.env.MONIT_CACHE_HOURS) || 24,
+    MONIT_MAX_EVENTS: Number(process.env.MONIT_MAX_EVENTS) || 5000,
+    MONIT_CAPTURE_CONSOLE: parseBoolean((_a = process.env.MONIT_CAPTURE_CONSOLE) !== null && _a !== void 0 ? _a : 'true'),
+    MONIT_REDACT_ERROR_DETAILS: parseBoolean((_b = process.env.MONIT_REDACT_ERROR_DETAILS) !== null && _b !== void 0 ? _b : 'true'),
+    MONIT_ALLOWED_IPS: ((_c = process.env.MONIT_ALLOWED_IPS) !== null && _c !== void 0 ? _c : '')
+        .split(',')
+        .map((item) => item.trim())
+        .filter(Boolean),
+    MONIT_RATE_LIMIT_WINDOW_MS: Number(process.env.MONIT_RATE_LIMIT_WINDOW_MS) || 60000,
+    MONIT_RATE_LIMIT_MAX: Number(process.env.MONIT_RATE_LIMIT_MAX) || 120,
+    MONIT_ALLOW_INVOKE: parseBoolean((_d = process.env.MONIT_ALLOW_INVOKE) !== null && _d !== void 0 ? _d : 'true'),
+    MONIT_ALLOW_EDIT: parseBoolean((_e = process.env.MONIT_ALLOW_EDIT) !== null && _e !== void 0 ? _e : 'true'),
     CORS_OPTIONS: {
         origin: "*",
         methods: ["GET", "POST", "PUT", "DELETE"]
@@ -53,13 +74,13 @@ exports.AUTH_CONFIG = {
     userCollection: collection_name,
     resetPasswordCollection: 'reset_password_requests',
     refreshTokensCollection: 'auth_refresh_tokens',
-    resetPasswordConfig: (_a = configuration['local-userpass']) === null || _a === void 0 ? void 0 : _a.config,
-    localUserpassConfig: (_b = configuration['local-userpass']) === null || _b === void 0 ? void 0 : _b.config,
+    resetPasswordConfig: (_f = configuration['local-userpass']) === null || _f === void 0 ? void 0 : _f.config,
+    localUserpassConfig: (_g = configuration['local-userpass']) === null || _g === void 0 ? void 0 : _g.config,
     authProviders: configuration,
     user_id_field,
     on_user_creation_function_name,
     providers: {
-        "custom-function": (_c = configuration['custom-function']) === null || _c === void 0 ? void 0 : _c.config,
+        "custom-function": (_h = configuration['custom-function']) === null || _h === void 0 ? void 0 : _h.config,
         "anon-user": configuration['anon-user']
     }
 };

package/dist/features/endpoints/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/features/endpoints/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAKvE,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAE9D;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAU,gBAAuB,KAAG,OAAO,CAAC,SAAS,CA+B9E,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC3B,KAAK,eAAe,EACpB,SAAS,UAAU,CAAC,OAAO,eAAe,CAAC,EAC3C,UAAU,MAAM;;;;;;;CAgChB,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,oDAK7B,qBAAqB,MACR,KAAK,cAAc,EAAE,KAAK,YAAY,gBA4CrD,CAAA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/features/endpoints/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAKvE,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAE9D;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAU,gBAAuB,KAAG,OAAO,CAAC,SAAS,CA+B9E,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC3B,KAAK,eAAe,EACpB,SAAS,UAAU,CAAC,OAAO,eAAe,CAAC,EAC3C,UAAU,MAAM;;;;;;;CAkDhB,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,oDAK7B,qBAAqB,MACR,KAAK,cAAc,EAAE,KAAK,YAAY,gBA4CrD,CAAA"}

package/dist/features/endpoints/utils.js

@@ -66,31 +66,49 @@ const getMethodsConfig = (app, handler, endpoint) => ({
         config: {
             rawBody: true
         },
+        schema: {
+            tags: ['Endpoints']
+        }
     }, handler),
     GET: () => app.get(endpoint, {
         config: {
             rawBody: true
         },
+        schema: {
+            tags: ['Endpoints']
+        }
     }, handler),
     POST: () => app.post(endpoint, {
         config: {
             rawBody: true
         },
+        schema: {
+            tags: ['Endpoints']
+        }
     }, handler),
     PUT: () => app.put(endpoint, {
         config: {
             rawBody: true
         },
+        schema: {
+            tags: ['Endpoints']
+        }
     }, handler),
     PATCH: () => app.patch(endpoint, {
         config: {
             rawBody: true
         },
+        schema: {
+            tags: ['Endpoints']
+        }
     }, handler),
     DELETE: () => app.delete(endpoint, {
         config: {
             rawBody: true
         },
+        schema: {
+            tags: ['Endpoints']
+        }
     }, handler)
 });
 exports.getMethodsConfig = getMethodsConfig;

package/dist/features/functions/controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../../src/features/functions/controller.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AA2ChD;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,EAAE,kBA0JjC,CAAA"}
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../../src/features/functions/controller.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AA2ChD;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,EAAE,kBAkKjC,CAAA"}

package/dist/features/functions/controller.js

@@ -55,7 +55,11 @@ const isReturnedError = (value) => {
 const functionsController = (app_1, _a) => __awaiter(void 0, [app_1, _a], void 0, function* (app, { functionsList, rules }) {
     app.addHook('preHandler', app.jwtAuthentication);
     const streams = {};
-    app.post('/call', (req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    app.post('/call', {
+        schema: {
+            tags: ['Functions']
+        }
+    }, (req, res) => __awaiter(void 0, void 0, void 0, function* () {
         const user = getRequestUser(req);
         if (!user || user.typ !== 'access') {
             throw new Error('Access token required');
@@ -121,7 +125,11 @@ const functionsController = (app_1, _a) => __awaiter(void 0, [app_1, _a], void 0
             });
         }
     }));
-    app.get('/call', (req, res) => __awaiter(void 0, void 0, void 0, function* () {
+    app.get('/call', {
+        schema: {
+            tags: ['Functions']
+        }
+    }, (req, res) => __awaiter(void 0, void 0, void 0, function* () {
         const { query } = req;
         const user = getRequestUser(req);
         if (!user || user.typ !== 'access') {

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAA;AActB,cAAc,SAAS,CAAA;AAGvB,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAA;AAE/D,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,eAAe,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAAC,EAC/B,SAAS,EACT,IAA0B,EAC1B,SAAqC,EACrC,IAA0B,EAC1B,UAAuC,EACvC,UAAwC,EACxC,QAAQ,EACT,EAAE,gBAAgB,iBA+GlB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAA;AActB,cAAc,SAAS,CAAA;AAGvB,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAA;AAE/D,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,eAAe,EAAE,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAAC,EAC/B,SAAS,EACT,IAA0B,EAC1B,SAAqC,EACrC,IAA0B,EAC1B,UAAuC,EACvC,UAAwC,EACxC,QAAQ,EACT,EAAE,gBAAgB,iBAwHlB"}

package/dist/index.js

@@ -148,7 +148,17 @@ function initialize(_a) {
                 },
                 staticCSP: true,
                 transformStaticCSP: (header) => header,
-                transformSpecification: (swaggerObject) => { return swaggerObject; },
+                transformSpecification: (swaggerObject) => {
+                    if (!swaggerObject || !swaggerObject.paths)
+                        return swaggerObject;
+                    const filteredPaths = Object.assign({}, swaggerObject.paths);
+                    Object.keys(filteredPaths).forEach((path) => {
+                        if (path === '/monit' || path.startsWith('/monit/')) {
+                            delete filteredPaths[path];
+                        }
+                    });
+                    return Object.assign(Object.assign({}, swaggerObject), { paths: filteredPaths });
+                },
                 transformSpecificationClone: true
             });
         }

package/dist/monitoring/plugin.d.ts

@@ -0,0 +1,7 @@
+import '@fastify/websocket';
+import type { FastifyInstance } from 'fastify';
+declare const createMonitoringPlugin: (app: FastifyInstance, opts?: {
+    basePath?: string;
+}) => Promise<void>;
+export default createMonitoringPlugin;
+//# sourceMappingURL=plugin.d.ts.map

package/dist/monitoring/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/monitoring/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,oBAAoB,CAAA;AAG3B,OAAO,KAAK,EAAE,eAAe,EAAgC,MAAM,SAAS,CAAA;AAslB5E,QAAA,MAAM,sBAAsB,QACrB,eAAe,SACd;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,kBAw5BH,CAAA;AAE1B,eAAe,sBAAsB,CAAA"}