@flowerforce/flowerbase 1.6.2 → 1.6.3-beta.0

package/dist/utils/initializer/exposeRoutes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"exposeRoutes.d.ts","sourceRoot":"","sources":["../../../src/utils/initializer/exposeRoutes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAOzC;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAU,SAAS,eAAe,kBA2E1D,CAAA"}
+{"version":3,"file":"exposeRoutes.d.ts","sourceRoot":"","sources":["../../../src/utils/initializer/exposeRoutes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAOzC;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAU,SAAS,eAAe,kBAmF1D,CAAA"}

package/dist/utils/initializer/exposeRoutes.js

@@ -22,7 +22,11 @@ const crypto_1 = require("../crypto");
  */
 const exposeRoutes = (fastify) => __awaiter(void 0, void 0, void 0, function* () {
     try {
-        fastify.get(`${constants_1.API_VERSION}/app/:appId/location`, (req) => __awaiter(void 0, void 0, void 0, function* () {
+        fastify.get(`${constants_1.API_VERSION}/app/:appId/location`, {
+            schema: {
+                tags: ['System']
+            }
+        }, (req) => __awaiter(void 0, void 0, void 0, function* () {
             var _a, _b, _c;
             const schema = (_a = constants_1.DEFAULT_CONFIG === null || constants_1.DEFAULT_CONFIG === void 0 ? void 0 : constants_1.DEFAULT_CONFIG.HTTPS_SCHEMA) !== null && _a !== void 0 ? _a : 'http';
             const headerHost = (_b = req.headers.host) !== null && _b !== void 0 ? _b : 'localhost:3000';
@@ -37,7 +41,11 @@ const exposeRoutes = (fastify) => __awaiter(void 0, void 0, void 0, function* ()
                 ws_hostname: `${wsSchema}://${host}`
             };
         }));
-        fastify.get('/health', () => __awaiter(void 0, void 0, void 0, function* () {
+        fastify.get('/health', {
+            schema: {
+                tags: ['System']
+            }
+        }, () => __awaiter(void 0, void 0, void 0, function* () {
             return ({
                 status: 'ok',
                 uptime: (0, node_process_1.uptime)()

package/dist/utils/initializer/registerPlugins.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registerPlugins.d.ts","sourceRoot":"","sources":["../../../src/utils/initializer/registerPlugins.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAOnC,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAA;AAE9D,KAAK,gBAAgB,GAAG,eAAe,CAAC,UAAU,CAAC,CAAA;AAGnD,KAAK,qBAAqB,GAAG;IAC3B,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,SAAS,CAAA;IACxB,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB,CAAA;AAQD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAU,gEAMnC,qBAAqB,kBAsBvB,CAAA"}
+{"version":3,"file":"registerPlugins.d.ts","sourceRoot":"","sources":["../../../src/utils/initializer/registerPlugins.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAOnC,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAA;AAG9D,KAAK,gBAAgB,GAAG,eAAe,CAAC,UAAU,CAAC,CAAA;AAGnD,KAAK,qBAAqB,GAAG;IAC3B,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,SAAS,CAAA;IACxB,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB,CAAA;AAQD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAU,gEAMnC,qBAAqB,kBAsBvB,CAAA"}

package/dist/utils/initializer/registerPlugins.js

@@ -22,6 +22,7 @@ const controller_2 = require("../../auth/providers/anon-user/controller");
 const controller_3 = require("../../auth/providers/custom-function/controller");
 const controller_4 = require("../../auth/providers/local-userpass/controller");
 const constants_1 = require("../../constants");
+const plugin_1 = __importDefault(require("../../monitoring/plugin"));
 /**
  * > Used to register all plugins
  * @param register -> the fastify register method
@@ -65,7 +66,7 @@ const getRegisterConfig = (_a) => __awaiter(void 0, [_a], void 0, function* ({ m
         origin: '*',
         methods: ['POST', 'GET']
     };
-    return [
+    const baseConfig = [
         {
             pluginName: 'cors',
             plugin: cors_1.default,
@@ -125,4 +126,12 @@ const getRegisterConfig = (_a) => __awaiter(void 0, [_a], void 0, function* ({ m
             }
         }
     ];
+    if (constants_1.DEFAULT_CONFIG.MONIT_ENABLED) {
+        baseConfig.splice(2, 0, {
+            pluginName: 'monitoringPlugin',
+            plugin: plugin_1.default,
+            options: { basePath: '/monit' }
+        });
+    }
+    return baseConfig;
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowerforce/flowerbase",
-  "version": "1.6.2",
+  "version": "1.6.3-beta.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,13 +20,15 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
+    "@aws-sdk/client-lambda": "^3.974.0",
+    "@aws-sdk/client-s3": "^3.974.0",
+    "@aws-sdk/s3-request-presigner": "^3.975.0",
     "@fastify/cors": "^10.0.1",
     "@fastify/jwt": "^9.0.1",
     "@fastify/mongodb": "^9.0.1",
     "@fastify/swagger": "^9.5.1",
     "@fastify/swagger-ui": "^5.2.3",
-    "@aws-sdk/client-lambda": "^3.974.0",
-    "@aws-sdk/client-s3": "^3.974.0",
+    "@fastify/websocket": "^11.2.0",
     "bson": "^6.8.0",
     "dotenv": "^16.4.7",
     "fastify": "^5.0.0",

package/src/auth/controller.ts

@@ -47,7 +47,11 @@ export async function authController(app: FastifyInstance) {
    * @param {import('fastify').FastifyRequest} req - The request object.
    * @returns {Promise<Object>} A promise resolving with the user's profile data.
    */
-  app.get(AUTH_ENDPOINTS.PROFILE, async function (req) {
+  app.get(AUTH_ENDPOINTS.PROFILE, {
+    schema: {
+      tags: ['Auth']
+    }
+  }, async function (req) {
     if (req.user.typ !== 'access') {
       throw new Error('Access token required')
     }
@@ -76,6 +80,11 @@ export async function authController(app: FastifyInstance) {
    */
   app.post<{ Reply: SessionCreatedDto }>(
     AUTH_ENDPOINTS.SESSION,
+    {
+      schema: {
+        tags: ['Auth']
+      }
+    },
     async function (req, res) {
       if (req.user.typ !== 'refresh') {
         throw new Error(AUTH_ERRORS.INVALID_TOKEN)
@@ -125,6 +134,11 @@ export async function authController(app: FastifyInstance) {
      */
   app.delete(
     AUTH_ENDPOINTS.SESSION,
+    {
+      schema: {
+        tags: ['Auth']
+      }
+    },
     async function (req, res) {
       const authHeader = req.headers.authorization
       if (!authHeader?.startsWith('Bearer ')) {

package/src/auth/providers/anon-user/controller.ts

@@ -31,6 +31,11 @@ export async function anonUserController(app: FastifyInstance) {
 
   app.post<LoginDto>(
     AUTH_ENDPOINTS.LOGIN,
+    {
+      schema: {
+        tags: ['Auth']
+      }
+    },
     async function () {
       const anonProvider = AUTH_CONFIG.authProviders?.['anon-user']
       if (!anonProvider || anonProvider.disabled) {

package/src/auth/providers/custom-function/schema.ts

@@ -1,25 +1,24 @@
 export const LOGIN_SCHEMA = {
-    body: {
-        type: 'object',
-        properties:
-        {
-            apiKey: { type: 'string' },
-            options: {
-                type: "object",
-                properties: {
-                    device: {
-                        type: "object",
-                        properties: {
-                            sdkVersion: { type: 'string' },
-                            platform: { type: 'string' },
-                            platformVersion: { type: 'string' }
-                        }
-                    }
-
-                }
-            },
-
-        },
-        required: ['apiKey', 'options']
-    }
-}
+  tags: ['Auth'],
+  body: {
+    type: 'object',
+    properties:
+    {
+      apiKey: { type: 'string' },
+      options: {
+        type: "object",
+        properties: {
+          device: {
+            type: "object",
+            properties: {
+              sdkVersion: { type: 'string' },
+              platform: { type: 'string' },
+              platformVersion: { type: 'string' }
+            }
+          }
+        }
+      },
+    },
+    required: ['apiKey', 'options']
+  }
+}

package/src/auth/utils.ts

@@ -5,6 +5,7 @@ import path from 'path'
 const CHARSET =
   "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#$%^&*()-_=+[]{};:,.<>?";
 export const LOGIN_SCHEMA = {
+  tags: ['Auth'],
   body: {
     type: 'object',
     properties: {
@@ -21,6 +22,7 @@ export const LOGIN_SCHEMA = {
 }
 
 export const RESET_SEND_SCHEMA = {
+  tags: ['Auth'],
   body: {
     type: 'object',
     properties: {
@@ -36,6 +38,7 @@ export const RESET_SEND_SCHEMA = {
 }
 
 export const RESET_CALL_SCHEMA = {
+  tags: ['Auth'],
   body: {
     type: 'object',
     properties: {
@@ -53,6 +56,7 @@ export const RESET_CALL_SCHEMA = {
 }
 
 export const CONFIRM_RESET_SCHEMA = {
+  tags: ['Auth'],
   body: {
     type: 'object',
     properties: {
@@ -65,6 +69,7 @@ export const CONFIRM_RESET_SCHEMA = {
 }
 
 export const CONFIRM_USER_SCHEMA = {
+  tags: ['Auth'],
   body: {
     type: 'object',
     properties: {
@@ -78,6 +83,7 @@ export const CONFIRM_USER_SCHEMA = {
 export const RESET_SCHEMA = RESET_SEND_SCHEMA
 
 export const REGISTRATION_SCHEMA = {
+  tags: ['Auth'],
   body: {
     type: 'object',
     properties: {

package/src/constants.ts

@@ -6,6 +6,13 @@ const parseBoolean = (value?: string) => {
   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',
@@ -32,6 +39,21 @@ export const 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(process.env.MONIT_CAPTURE_CONSOLE ?? 'true'),
+  MONIT_REDACT_ERROR_DETAILS: parseBoolean(process.env.MONIT_REDACT_ERROR_DETAILS ?? 'true'),
+  MONIT_ALLOWED_IPS: (process.env.MONIT_ALLOWED_IPS ?? '')
+    .split(',')
+    .map((item) => item.trim())
+    .filter(Boolean),
+  MONIT_RATE_LIMIT_WINDOW_MS: Number(process.env.MONIT_RATE_LIMIT_WINDOW_MS) || 60_000,
+  MONIT_RATE_LIMIT_MAX: Number(process.env.MONIT_RATE_LIMIT_MAX) || 120,
+  MONIT_ALLOW_INVOKE: parseBoolean(process.env.MONIT_ALLOW_INVOKE ?? 'true'),
+  MONIT_ALLOW_EDIT: parseBoolean(process.env.MONIT_ALLOW_EDIT ?? 'true'),
   CORS_OPTIONS: {
     origin: "*",
     methods: ["GET", "POST", "PUT", "DELETE"] as ALLOWED_METHODS[]

package/src/features/endpoints/utils.ts

@@ -60,31 +60,49 @@ export const getMethodsConfig = (
     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)
 })
 

package/src/features/functions/controller.ts

@@ -62,7 +62,11 @@ export const functionsController: FunctionController = async (
 
   const streams = {} as Record<string, ChangeStream<Document, Document>>
 
-  app.post<{ Body: FunctionCallDto }>('/call', async (req, res) => {
+  app.post<{ Body: FunctionCallDto }>('/call', {
+    schema: {
+      tags: ['Functions']
+    }
+  }, async (req, res) => {
     const user = getRequestUser(req)
     if (!user || user.typ !== 'access') {
       throw new Error('Access token required')
@@ -148,7 +152,11 @@ export const functionsController: FunctionController = async (
   })
   app.get<{
     Querystring: FunctionCallBase64Dto
-  }>('/call', async (req, res) => {
+  }>('/call', {
+    schema: {
+      tags: ['Functions']
+    }
+  }, async (req, res) => {
     const { query } = req
     const user = getRequestUser(req)
     if (!user || user.typ !== 'access') {

package/src/index.ts

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