@internetderdinge/api 1.229.27 → 1.229.28

package/dist/src/iotdevice/iotdevice.route.js

@@ -7,7 +7,7 @@ import { getEventsSchema, getDeviceSchema, getEntrySchema, updateEntrySchema, pi
 // add other input schemas as needed
  } from "./iotdevice.validation";
 import { iotDeviceResponseSchema, eventResponseSchema, deviceResponseSchema, shadowAlarmSchema, pingResponseSchema, deviceStatusSchema, apiStatusSchema, entryResponseSchema, } from "./iotdevice.schemas";
-import { getIotDevices, getEvents, getDevice, shadowAlarmGet, shadowAlarmUpdate, shadowAdmin, pingDevice, getDeviceStatus, getApiStatus, getEntry, updateEntry, } from "./iotdevice.controller";
+import { getIotDevices, getEvents, getDevice, shadowAlarmGet, shadowAlarmUpdate, shadowAdmin, pingDevice, getDeviceStatus, getApiStatus, getEntry, updateEntry, ledLightHint, } from "./iotdevice.controller";
 export const iotdeviceRouteSpecs = [
     {
         method: "get",
@@ -74,7 +74,7 @@ export const iotdeviceRouteSpecs = [
         path: "/ledlight/:deviceId",
         validate: [auth("getUsers"), validateAdmin],
         responseSchema: pingResponseSchema,
-        handler: pingDevice,
+        handler: ledLightHint,
         summary: "Ping device LED light",
         description: "Sends a ping to the device’s LED light to test its connectivity or response.",
     },

package/dist/src/utils/buildRouterAndDocs.js

@@ -10,22 +10,19 @@ function hasRoleValidation(validators = []) {
 }
 export default function buildAiRouterAndDocs(router, routeSpecs, basePath = "/", tags = []) {
     routeSpecs.forEach((spec) => {
-        // mount Express
-        if (!spec.validate) {
-            spec.validate = [];
+        const validate = spec.validate || [];
+        const routeMiddleware = spec.validateWithRequestSchema ||
+            (spec.requestSchema
+                ? [validateZod(spec.requestSchema), ...validate]
+                : validate);
+        router[spec.method](spec.path, ...routeMiddleware, spec.handler);
+        const { body, ...rest } = spec.requestSchema || {};
+        const request = { ...rest };
+        if (spec.requestBody) {
+            request.body = spec.requestBody;
         }
-        if (spec.requestSchema) {
-            spec.validateWithRequestSchema = [
-                validateZod(spec.requestSchema),
-                ...spec.validate,
-            ];
-        }
-        if (spec.validateWithRequestSchema) {
-            router[spec.method](spec.path, ...spec.validateWithRequestSchema, spec.handler);
-        }
-        var { body, ...rest } = spec.requestSchema || {};
-        if (body) {
-            rest.body = {
+        else if (body) {
+            request.body = {
                 content: {
                     "application/json": {
                         schema: body,
@@ -34,17 +31,17 @@ export default function buildAiRouterAndDocs(router, routeSpecs, basePath = "/",
             };
         }
         if (spec.responseSchema &&
-            !hasRoleValidation(spec.validate) &&
+            !hasRoleValidation(spec.validateWithRequestSchema || validate) &&
             spec.privateDocs !== true &&
             spec.memoOnly !== true) {
             // collect all middleware fn names (falls back to '<anonymous>' if unnamed)
-            const middlewareNames = (spec.validate || []).map((fn) => `\`${fn.name}\`` || "<anonymous>");
+            const middlewareNames = (spec.validateWithRequestSchema || validate).map((fn) => `\`${fn.name}\`` || "<anonymous>");
             const openApiPath = (basePath + spec.path).replace(/:([A-Za-z0-9_]+)/g, "{$1}");
             registry.registerPath({
                 method: spec.method,
                 path: openApiPath,
                 summary: spec.summary,
-                request: rest,
+                request,
                 // append middleware names to the description
                 description: [
                     spec.description,

package/dist/src/utils/registerOpenApi.js

@@ -3,6 +3,12 @@ import { extendZodWithOpenApi } from "@asteasolutions/zod-to-openapi";
 import { z } from "zod";
 extendZodWithOpenApi(z);
 export const registry = new OpenAPIRegistry();
+export const xApiKey = registry.registerComponent("securitySchemes", "x-api-key", {
+    type: "apiKey",
+    in: "header",
+    name: "x-api-key",
+    description: "API key for authentication",
+});
 // add Bearer JWT auth
 export const bearerAuth = registry.registerComponent("securitySchemes", "bearerAuth", {
     type: "http",
@@ -10,12 +16,6 @@ export const bearerAuth = registry.registerComponent("securitySchemes", "bearerA
     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" }),
@@ -23,45 +23,50 @@ const UserSchema = z
     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() }),
-    },
-    responses: {
-        200: {
-            description: "Object with user data.",
-            content: {
-                "application/json": {
-                    schema: UserSchema,
-                },
-            },
+  method: "get",
+  path: "/usersnnn/{id}",
+  summary: "Get a single user",
+  request: {
+    params: z.object({ id: z.string() }),
+  },
+
+  responses: {
+    200: {
+      description: "Object with user data.",
+      content: {
+        "application/json": {
+          schema: UserSchema,
         },
+      },
     },
+  },
 });
+
+
 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",
+  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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@internetderdinge/api",
-  "version": "1.229.27",
+  "version": "1.229.28",
   "description": "Shared OpenIoT API modules",
   "main": "dist/src/index.js",
   "type": "module",

package/src/iotdevice/iotdevice.route.ts

@@ -40,6 +40,7 @@ import {
   getApiStatus,
   getEntry,
   updateEntry,
+  ledLightHint,
 } from "./iotdevice.controller";
 import { request } from "https";
 
@@ -113,7 +114,7 @@ export const iotdeviceRouteSpecs: RouteSpec[] = [
     path: "/ledlight/:deviceId",
     validate: [auth("getUsers"), validateAdmin],
     responseSchema: pingResponseSchema,
-    handler: pingDevice,
+    handler: ledLightHint,
     summary: "Ping device LED light",
     description:
       "Sends a ping to the device’s LED light to test its connectivity or response.",

package/src/utils/buildRouterAndDocs.ts

@@ -21,6 +21,10 @@ export type RouteSpec = {
   validate?: RequestHandler<any, any, any, any, any>[];
   validateWithRequestSchema?: RequestHandler<any, any, any, any, any>[];
   requestSchema?: Partial<Record<string, ZodTypeAny>>;
+  requestBody?: {
+    required?: boolean;
+    content: Record<string, { schema: ZodTypeAny }>;
+  };
   responseSchema?: ZodTypeAny;
   handler: RequestHandler<any, any, any, any, any>;
   summary: string;
@@ -36,31 +40,22 @@ export default function buildAiRouterAndDocs(
   tags: string[] = [],
 ) {
   routeSpecs.forEach((spec) => {
-    // mount Express
-
-    if (!spec.validate) {
-      spec.validate = [];
-    }
-
-    if (spec.requestSchema) {
-      spec.validateWithRequestSchema = [
-        validateZod(spec.requestSchema),
-        ...spec.validate,
-      ];
-    }
-
-    if (spec.validateWithRequestSchema) {
-      router[spec.method](
-        spec.path,
-        ...spec.validateWithRequestSchema,
-        spec.handler,
-      );
-    }
-
-    var { body, ...rest } = spec.requestSchema || {};
-
-    if (body) {
-      rest.body = {
+    const validate = spec.validate || [];
+    const routeMiddleware =
+      spec.validateWithRequestSchema ||
+      (spec.requestSchema
+        ? [validateZod(spec.requestSchema), ...validate]
+        : validate);
+
+    router[spec.method](spec.path, ...routeMiddleware, spec.handler);
+
+    const { body, ...rest } = spec.requestSchema || {};
+    const request = { ...rest } as Record<string, unknown>;
+
+    if (spec.requestBody) {
+      request.body = spec.requestBody;
+    } else if (body) {
+      request.body = {
         content: {
           "application/json": {
             schema: body,
@@ -71,12 +66,12 @@ export default function buildAiRouterAndDocs(
 
     if (
       spec.responseSchema &&
-      !hasRoleValidation(spec.validate) &&
+      !hasRoleValidation(spec.validateWithRequestSchema || validate) &&
       spec.privateDocs !== true &&
       spec.memoOnly !== true
     ) {
       // collect all middleware fn names (falls back to '<anonymous>' if unnamed)
-      const middlewareNames = (spec.validate || []).map(
+      const middlewareNames = (spec.validateWithRequestSchema || validate).map(
         (fn) => `\`${fn.name}\`` || "<anonymous>",
       );
       const openApiPath = (basePath + spec.path).replace(
@@ -88,7 +83,7 @@ export default function buildAiRouterAndDocs(
         method: spec.method,
         path: openApiPath,
         summary: spec.summary,
-        request: rest,
+        request,
 
         // append middleware names to the description
         description: [

package/src/utils/registerOpenApi.ts

@@ -6,6 +6,17 @@ extendZodWithOpenApi(z);
 
 export const registry = new OpenAPIRegistry();
 
+export const xApiKey = registry.registerComponent(
+  "securitySchemes",
+  "x-api-key",
+  {
+    type: "apiKey",
+    in: "header",
+    name: "x-api-key",
+    description: "API key for authentication",
+  },
+);
+
 // add Bearer JWT auth
 export const bearerAuth = registry.registerComponent(
   "securitySchemes",
@@ -18,17 +29,6 @@ export const bearerAuth = registry.registerComponent(
   },
 );
 
-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" }),
@@ -37,6 +37,7 @@ const UserSchema = z
   })
   .openapi("User");
 
+/*
 registry.registerPath({
   method: "get",
   path: "/usersnnn/{id}",
@@ -57,6 +58,7 @@ registry.registerPath({
   },
 });
 
+
 registry.registerPath({
   method: "get",
   path: "/users/{id}",
@@ -81,3 +83,4 @@ registry.registerPath({
     },
   },
 });
+*/