@internetderdinge/api 1.229.1 → 1.229.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetderdinge/api",
-  "version": "1.229.1",
+  "version": "1.229.2",
   "description": "Shared OpenIoT API modules",
   "main": "dist/src/index.js",
   "type": "module",
@@ -9,113 +9,120 @@
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",
+    "dev:watch": "tsc -p tsconfig.json --watch --incremental --preserveWatchOutput",
+    "dev:yalc": "nodemon --watch src --watch package.json --ext ts,json --exec \"yarn build && yalc publish --push\"",
+    "yalc:publish": "yalc publish --push",
+    "deps:versions": "node --input-type=module -e \"import { createRequire } from 'node:module'; const require = createRequire(import.meta.url); const out = (name) => { const pkgPath = require.resolve(name + '/package.json'); const version = require(pkgPath).version; console.log(name + '@' + version + ' -> ' + pkgPath); }; out('zod'); out('@asteasolutions/zod-to-openapi');\"",
     "deploy:version": "node ./scripts/release-version.mjs",
     "release:paperless": "node ./scripts/release-and-sync-paperless.mjs",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"
   },
   "dependencies": {
-    "@asteasolutions/zod-to-openapi": "^7.3.2",
-    "@aws-sdk/client-cloudwatch-events": "^3.216.0",
-    "@aws-sdk/client-s3": "^3.216.0",
-    "@aws-sdk/client-sesv2": "^3.328.0",
-    "@aws-sdk/credential-provider-node": "^3.830.0",
-    "@aws-sdk/lib-storage": "^3.216.0",
-    "@aws-sdk/s3-request-presigner": "^3.216.0",
-    "@aws-sdk/util-endpoints": "^3.216.0",
-    "@sentry/node": "^10.25.0",
-    "@sentry/profiling-node": "^10.25.0",
-    "agenda": "^5.0.0",
-    "agendash": "^4.0.0",
-    "auth0": "^4.23.1",
-    "aws-crt": "^1.27.3",
-    "aws-iot-device-sdk-v2": "^1.22.0",
-    "aws-sdk": "^2.1261.0",
-    "aws4": "^1.11.0",
-    "axios": "^1.9.0",
-    "body-parser": "~1.15.0",
-    "body-parser-xml": "~1.1.0",
-    "canvas": "^3.1.0",
-    "compression": "^1.8.0",
-    "config": "^4.0.0",
-    "cors": "^2.8.5",
-    "cron": "^4.3.1",
-    "date-fns": "^2.28.0",
-    "date-fns-tz": "2.0.0",
-    "dotenv": "^10.0.0",
-    "elevenlabs": "^0.5.0",
-    "express": "^5.1.0",
+    "@aws-sdk/client-cloudwatch-events": "^3.990.0",
+    "@aws-sdk/client-s3": "^3.990.0",
+    "@aws-sdk/client-sesv2": "^3.990.0",
+    "@aws-sdk/credential-provider-node": "^3.972.9",
+    "@aws-sdk/lib-storage": "^3.990.0",
+    "@aws-sdk/s3-request-presigner": "^3.990.0",
+    "@aws-sdk/util-endpoints": "^3.990.0",
+    "@sentry/node": "^10.38.0",
+    "@sentry/profiling-node": "^10.38.0",
+    "agenda": "^6.2.2",
+    "agendash": "^8.1.1",
+    "auth0": "^5.3.1",
+    "aws-crt": "^1.29.0",
+    "aws-iot-device-sdk-v2": "^1.25.0",
+    "aws-sdk": "^2.1693.0",
+    "aws4": "^1.13.2",
+    "axios": "^1.13.5",
+    "body-parser": "~2.2.2",
+    "body-parser-xml": "~2.0.5",
+    "canvas": "^3.2.1",
+    "compression": "^1.8.1",
+    "config": "^4.3.0",
+    "cors": "^2.8.6",
+    "cron": "^4.4.0",
+    "date-fns": "^4.1.0",
+    "date-fns-tz": "3.2.0",
+    "dotenv": "^17.3.1",
+    "elevenlabs": "^1.59.0",
+    "express": "^5.2.1",
     "express-jwt": "^8.5.1",
     "express-mongo-sanitize": "^2.2.0",
-    "express-rate-limit": "^7.5.0",
+    "express-rate-limit": "^8.2.1",
     "express-ws": "^5.0.2",
-    "firebase-admin": "^11.0.0",
-    "googleapis": "^144.0.0",
+    "file-type": "^21.3.0",
+    "firebase-admin": "^13.6.1",
+    "googleapis": "^171.4.0",
     "he": "^1.2.0",
-    "helmet": "^4.1.0",
-    "http-status": "^1.4.0",
+    "helmet": "^8.1.0",
+    "http-status": "^2.1.0",
     "https": "^1.0.0",
-    "i18next": "^23.10.1",
-    "joi": "^17.3.0",
-    "js-yaml": "^3.8.4",
-    "jsonwebtoken": "^8.5.1",
-    "jwks-rsa": "^2.0.3",
-    "moment": "^2.24.0",
-    "moment-timezone": "^0.5.34",
-    "morgan": "^1.9.1",
-    "multer": "^1.4.5-lts.1",
+    "i18next": "^25.8.7",
+    "joi": "^18.0.2",
+    "js-yaml": "^4.1.1",
+    "jsonwebtoken": "^9.0.3",
+    "jwks-rsa": "^3.2.2",
+    "moment": "^2.30.1",
+    "moment-timezone": "^0.6.0",
+    "morgan": "^1.10.1",
+    "multer": "^2.0.2",
     "multer-s3": "^3.0.1",
-    "multiparty": "~4.1.2",
-    "node-uuid": "~1.4.7",
-    "nodemailer": "^6.3.1",
-    "openai": "^5.0.1",
-    "passport": "^0.4.0",
-    "passport-jwt": "^4.0.0",
+    "multiparty": "~4.2.3",
+    "node-uuid": "~1.4.8",
+    "nodemailer": "^8.0.1",
+    "openai": "^6.22.0",
+    "passport": "^0.7.0",
+    "passport-jwt": "^4.0.1",
     "path": "~0.12.7",
     "pixelmatch": "^7.1.0",
     "promise": "~8.3.0",
-    "puppeteer": "^24.9.0",
-    "qs": "^6.14.0",
-    "request": "^2.81.0",
-    "rrule": "^2.7.1",
-    "sharp": "^0.33.5",
-    "semver": "^7.7.1",
-    "stripe": "^12.6.0",
+    "puppeteer": "^24.37.3",
+    "qs": "^6.14.2",
+    "request": "^2.88.2",
+    "rrule": "^2.8.1",
+    "semver": "^7.7.4",
+    "sharp": "^0.34.5",
+    "stripe": "^20.3.1",
     "swagger-ui-express": "^5.0.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.3",
-    "uuid": "^9.0.1",
-    "validator": "^13.0.0",
-    "winston": "^3.2.1",
-    "xss-clean": "^0.1.4",
-    "zod": "^3.20.2"
+    "typescript": "^5.9.3",
+    "uuid": "^13.0.0",
+    "validator": "^13.15.26",
+    "winston": "^3.19.0",
+    "xss-clean": "^0.1.4"
   },
   "peerDependencies": {
-    "mongoose": "^8.15.1"
+    "@asteasolutions/zod-to-openapi": "^8.0.0",
+    "mongoose": "^8.15.1",
+    "zod": "^4.3.6"
   },
   "devDependencies": {
-    "@types/glob": "^8.1.0",
-    "@types/uuid": "^9.0.8",
-    "@types/validator": "^13.11.10",
-    "@types/passport": "^1.0.12",
-    "@types/file-type": "^16.5.1",
-    "@vitest/coverage-v8": "^2.1.9",
+    "@asteasolutions/zod-to-openapi": "^8.0.0",
+    "@types/file-type": "^10.9.3",
+    "@types/glob": "^9.0.0",
+    "@types/passport": "^1.0.17",
+    "@types/uuid": "^11.0.0",
+    "@types/validator": "^13.15.10",
+    "@vitest/coverage-v8": "^4.0.18",
     "coveralls": "^3.1.1",
-    "eslint": "^7.0.0",
-    "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-prettier": "^3.1.1",
-    "eslint-plugin-security": "^1.4.0",
-    "faker": "^5.1.0",
-    "husky": "^5.1.2",
-    "lint-staged": "^10.0.7",
-    "node-mocks-http": "^1.8.0",
-    "nodemon": "^3.1.10",
-    "prettier": "^3.5.3",
-    "mongoose": "^8.15.1",
-    "supertest": "^7.1.1",
-    "vitest": "^2.1.9"
+    "eslint": "^10.0.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-plugin-security": "^3.0.1",
+    "faker": "^6.6.6",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "mongoose": "^9.2.1",
+    "node-mocks-http": "^1.17.2",
+    "nodemon": "^3.1.11",
+    "prettier": "^3.8.1",
+    "supertest": "^7.2.2",
+    "vitest": "^4.0.18",
+    "zod": "^4.3.6"
   },
   "gitHead": "9556e8e376045c1e532aded7ec7132818190fa91"
 }

package/scripts/release-and-sync-paperless.mjs

@@ -132,4 +132,6 @@ const paperlessUpdate = updateDependencyVersion(
 );
 
 console.log(`Updated @internetderdinge/api to ${nextVersion}`);
-console.log(`paperlesspaper-api: ${paperlessUpdate.previous} -> ${paperlessUpdate.next}`);
+console.log(
+  `paperlesspaper-api: ${paperlessUpdate.previous} -> ${paperlessUpdate.next}`,
+);

package/src/accounts/accounts.validation.ts

@@ -22,7 +22,7 @@ export const createAccountSchema = {
     organization: zObjectId.openapi({ description: "Organization ObjectId" }),
     patient: zObjectId.openapi({ description: "Patient ObjectId" }),
     meta: z
-      .record(z.any())
+      .record(z.string(), z.any())
       .openapi({
         example: { key: "value" },
         description: "Additional metadata for the entry",
@@ -82,7 +82,7 @@ export const updateAccountSchema = {
     debug: z.boolean().optional(),
     demo: z.boolean().optional(),
     notification: z
-      .record(z.any())
+      .record(z.string(), z.any())
       .optional()
       .openapi({ description: "Notification settings object" }),
   }),

package/src/devices/devices.schemas.ts

@@ -17,13 +17,13 @@ export const eventResponseSchema = z.object({
   id: z.string(),
   deviceId: z.string(),
   type: z.string(),
-  payload: z.record(z.any()),
+  payload: z.record(z.string(), z.any()),
   timestamp: z.string(), // ISO timestamp
   // ...other event fields...
 });
 
 export const genericResponseSchema = z
-  .record(z.any())
+  .record(z.string(), z.any())
   .openapi({ description: "Generic response payload" });
 
 export const imageResponseSchema = z.object({

package/src/devices/devices.validation.ts

@@ -10,7 +10,6 @@ import {
   zDelete,
   zPagination,
 } from "../utils/zValidations.js";
-import { enable } from "agenda/dist/job/enable";
 
 extendZodWithOpenApi(z);
 
@@ -20,7 +19,7 @@ export const createEntrySchema = {
       name: z.string().optional(),
       deviceId: z.string().optional(),
       kind: z.string().optional(),
-      meta: z.record(z.any()).optional(),
+      meta: z.record(z.string(), z.any()).optional(),
       organization: zObjectId,
       patient: zObjectId.optional(),
       paper: zObjectId.optional().nullable(),
@@ -52,14 +51,14 @@ export const updateEntrySchema = {
     organization: zObjectId.optional(),
     patient: zObjectId.optional().nullable(),
     paper: zObjectId.optional().nullable(),
-    meta: z.record(z.any()).optional(),
-    iotDevice: z.record(z.any()).optional(),
+    meta: z.record(z.string(), z.any()).optional(),
+    iotDevice: z.record(z.string(), z.any()).optional(),
     shadow: z.union([z.string(), z.number()]).optional(),
     alarmEnable: z.number().int().optional(),
     takeOffsetTime: z.number().int().optional(),
     updatedAt: z.string().datetime().optional(),
     createdAt: z.string().datetime().optional(),
-    payment: z.record(z.any()).optional(),
+    payment: z.record(z.string(), z.any()).optional(),
     lut: z.string().optional(),
     sleepTime: z.string().optional(),
     clearScreen: z.boolean().optional(),
@@ -237,8 +236,8 @@ export const uploadSingleImageFromWebsiteSchema = {};
 export const updateDeviceSchema = {
   ...zUpdate("deviceId"),
   body: zPatchBody({
-    intake: z.record(z.any()).optional(),
-    meta: z.record(z.any()).optional(),
+    intake: z.record(z.string(), z.any()).optional(),
+    meta: z.record(z.string(), z.any()).optional(),
     organization: zObjectId.optional(),
     patient: zObjectId.optional().nullable(),
     paper: zObjectId.optional().nullable(),
@@ -246,8 +245,8 @@ export const updateDeviceSchema = {
     deviceId: z.string().optional(),
     alarmEnable: z.number().int().optional(),
     takeOffsetTime: z.number().int().optional(),
-    iotDevice: z.record(z.any()).optional(),
-    payment: z.record(z.any()).optional(),
+    iotDevice: z.record(z.string(), z.any()).optional(),
+    payment: z.record(z.string(), z.any()).optional(),
   }),
 };
 
@@ -259,7 +258,7 @@ export const updateSingleImageMetaSchema = {
   }),
   body: z
     .object({
-      meta: z.record(z.any()).optional(),
+      meta: z.record(z.string(), z.any()).optional(),
     })
     .openapi({ description: "Image metadata updates" }),
 };

package/src/middlewares/validateZod.ts

@@ -1,13 +1,13 @@
 import type { Request, Response, NextFunction } from 'express';
-import type { AnyZodObject } from 'zod';
+import type { ZodObject, ZodRawShape } from 'zod';
 import ApiError from '../utils/ApiError';
 import httpStatus from 'http-status';
-import z from 'zod';
+import { z } from 'zod';
 
 interface Schema {
-  body?: AnyZodObject;
-  query?: AnyZodObject;
-  params?: AnyZodObject;
+  body?: ZodObject<ZodRawShape>;
+  query?: ZodObject<ZodRawShape>;
+  params?: ZodObject<ZodRawShape>;
 }
 
 export const validateZod = (schema: Schema) => (req: Request, res: Response, next: NextFunction) => {

package/src/organizations/organizations.validation.ts

@@ -52,7 +52,7 @@ export const updateOrganizationSchema = {
       })
       .optional(),
     meta: z
-      .record(z.any())
+      .record(z.string(), z.any())
       .openapi({
         example: { key: "value" },
         description: "Additional metadata for the entry",

package/src/utils/buildRouterAndDocs.ts

@@ -69,7 +69,7 @@ export default function buildAiRouterAndDocs(
       };
     }
 
-    // console.log('spec.requestSchema', body);
+    console.log("spec.requestScbn");
 
     if (
       spec.responseSchema &&

package/src/utils/registerOpenApi.ts

@@ -1,32 +1,83 @@
-import { OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
+import { OpenAPIRegistry } from "@asteasolutions/zod-to-openapi";
+import { extendZodWithOpenApi } from "@asteasolutions/zod-to-openapi";
+import { z } from "zod";
+
+extendZodWithOpenApi(z);
 
 export const registry = new OpenAPIRegistry();
 
 // add Bearer JWT auth
-export const bearerAuth = registry.registerComponent('securitySchemes', 'bearerAuth', {
-  type: 'http',
-  scheme: 'bearer',
-  bearerFormat: 'JWT',
-  description: 'JWT Bearer authentication',
-});
+export const bearerAuth = registry.registerComponent(
+  "securitySchemes",
+  "bearerAuth",
+  {
+    type: "http",
+    scheme: "bearer",
+    bearerFormat: "JWT",
+    description: "JWT Bearer authentication",
+  },
+);
+
+export const xApiKey = registry.registerComponent(
+  "securitySchemes",
+  "x-api-key",
+  {
+    type: "apiKey",
+    in: "header",
+    name: "x-api-key",
+    description: "API key for authentication",
+  },
+);
+
+const UserSchema = z
+  .object({
+    id: z.string().openapi({ example: "1212121" }),
+    name: z.string().openapi({ example: "John Doe" }),
+    age: z.number().openapi({ example: 42 }),
+  })
+  .openapi("User");
+
+registry.registerPath({
+  method: "get",
+  path: "/usersnnn/{id}",
+  summary: "Get a single user",
+  request: {
+    params: z.object({ id: z.string() }),
+  },
 
-export const xApiKey = registry.registerComponent('securitySchemes', 'x-api-key', {
-  type: 'apiKey',
-  in: 'header',
-  name: 'x-api-key',
-  description: 'API key for authentication',
+  responses: {
+    200: {
+      description: "Object with user data.",
+      content: {
+        "application/json": {
+          schema: UserSchema,
+        },
+      },
+    },
+  },
 });
 
-/*
-registry.registerComponent('global', 'wwww', [
-  { name: 'ai', description: 'All AI-powered endpoints.' },
-  { name: 'auth', description: 'Authentication and authorization.' },
-  { name: 'Users', description: 'User management (create, read, update, delete).' },
-  // add more as needed
-]);
-
-registry.registerComponent('tag', 'users', {
-  name: 'users',
-  description: 'Operations about users',
+registry.registerPath({
+  method: "get",
+  path: "/users/{id}",
+  description: "Get user data by its id",
+  summary: "Get a single user",
+  request: {
+    params: z.object({
+      id: z.string().openapi({ example: "1212121" }),
+    }),
+  },
+  responses: {
+    200: {
+      description: "Object with user data.",
+      content: {
+        "application/json": {
+          schema: UserSchema,
+        },
+      },
+    },
+    204: {
+      description: "No content - successful operation",
+    },
+  },
 });
-*/

package/src/utils/zValidations.ts

@@ -5,20 +5,36 @@ import mongoose from "mongoose";
 
 export const zPagination = {
   query: z.object({
-    name: z.string().optional(),
+    name: z
+      .string()
+      .openapi({
+        example: "John",
+        description: "Name to filter by",
+        param: { name: "name", in: "query" },
+      })
+      .optional(),
     role: z
       .string()
-      .openapi({ example: "admin", description: "Role to filter by" })
+      .openapi({
+        example: "admin",
+        description: "Role to filter by",
+        param: { name: "role", in: "query" },
+      })
       .optional(),
     sortBy: z
       .string()
-      .openapi({ example: "createdAt", description: "Field to sort by" })
+      .openapi({
+        example: "createdAt",
+        description: "Field to sort by",
+        param: { name: "sortBy", in: "query" },
+      })
       .optional(),
     search: z
       .string()
       .openapi({
         example: process.env.SCHEMA_EXAMPLE_SEARCH || "",
         description: "Search term to filter results",
+        param: { name: "search", in: "query" },
       })
       .optional(),
     limit: z.coerce
@@ -26,6 +42,7 @@ export const zPagination = {
       .openapi({
         example: 10,
         description: "Number of items per page",
+        param: { name: "limit", in: "query" },
       })
       .int()
       .min(1)
@@ -36,6 +53,7 @@ export const zPagination = {
       .openapi({
         example: 0,
         description: "Offset for pagination, used to skip a number of items",
+        param: { name: "offset", in: "query" },
       })
       .int()
       .min(0)
@@ -47,6 +65,7 @@ export const zPagination = {
       .openapi({
         example: 1,
         description: "Page number for pagination",
+        param: { name: "page", in: "query" },
       })
       .min(1)
       .max(100000)