@internetderdinge/api 1.229.0 → 1.229.2

package/src/utils/zValidations.ts

@@ -1,45 +1,71 @@
-import { z } from 'zod';
-import { objectId } from '../validations/custom.validation';
-import mongoose from 'mongoose';
+// @ts-nocheck
+import { z } from "zod";
+import { objectId } from "../validations/custom.validation";
+import mongoose from "mongoose";
 
 export const zPagination = {
   query: z.object({
-    name: z.string().optional(),
-    role: z.string().openapi({ example: 'admin', description: 'Role to filter by' }).optional(),
-    sortBy: z.string().openapi({ example: 'createdAt', description: 'Field to sort by' }).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",
+        param: { name: "role", in: "query" },
+      })
+      .optional(),
+    sortBy: z
+      .string()
+      .openapi({
+        example: "createdAt",
+        description: "Field to sort by",
+        param: { name: "sortBy", in: "query" },
+      })
+      .optional(),
     search: z
       .string()
       .openapi({
-        example: 'search term',
-        description: 'Search term to filter results',
+        example: process.env.SCHEMA_EXAMPLE_SEARCH || "",
+        description: "Search term to filter results",
+        param: { name: "search", in: "query" },
       })
       .optional(),
     limit: z.coerce
       .number()
       .openapi({
         example: 10,
-        description: 'Number of items per page',
+        description: "Number of items per page",
+        param: { name: "limit", in: "query" },
       })
       .int()
       .min(1)
       .max(100000)
       .optional(),
-    offset: z
+    offset: z.coerce
       .number() // was z.int()
       .openapi({
         example: 0,
-        description: 'Offset for pagination, used to skip a number of items',
+        description: "Offset for pagination, used to skip a number of items",
+        param: { name: "offset", in: "query" },
       })
       .int()
       .min(0)
       .max(100000)
       .optional(),
-    page: z
+    page: z.coerce
       .number()
       .int()
       .openapi({
         example: 1,
-        description: 'Page number for pagination',
+        description: "Page number for pagination",
+        param: { name: "page", in: "query" },
       })
       .min(1)
       .max(100000)
@@ -50,40 +76,85 @@ export const zPagination = {
 export const zPaginationResponse = () =>
   z.object({
     results: z.array(z.unknown()), // Replace with your specific item schema
-    totalResults: z.number().openapi({ example: 100, description: 'Total number of items' }),
-    totalPages: z.number().openapi({ example: 10, description: 'Total number of pages' }),
-    page: z.number().openapi({ example: 1, description: 'Current page number' }),
-    limit: z.number().openapi({ example: 10, description: 'Number of items per page' }),
+    totalResults: z
+      .number()
+      .openapi({ example: 100, description: "Total number of items" }),
+    totalPages: z
+      .number()
+      .openapi({ example: 10, description: "Total number of pages" }),
+    page: z
+      .number()
+      .openapi({ example: 1, description: "Current page number" }),
+    limit: z
+      .number()
+      .openapi({ example: 10, description: "Number of items per page" }),
   });
 
+const defaultObjectIdExample = "682fd0d7d4a6325d9d45b86d";
+const exampleDefaults = {
+  organization: "682fd0d7d4a6325d9d45b86e",
+  user: defaultObjectIdExample,
+  device: "682fd0d7d4a6325d9d45b86f",
+  paper: "682fd0d7d4a6325d9d45b870",
+};
+const objectIdExampleOverrides: Record<string, string | undefined> = {
+  organizationId:
+    process.env.SCHEMA_EXAMPLE_ORGANIZATION_ID || exampleDefaults.organization,
+  organization:
+    process.env.SCHEMA_EXAMPLE_ORGANIZATION_ID || exampleDefaults.organization,
+  userId: process.env.SCHEMA_EXAMPLE_USER_ID || exampleDefaults.user,
+  deviceId: process.env.SCHEMA_EXAMPLE_DEVICE_ID || exampleDefaults.device,
+  device: process.env.SCHEMA_EXAMPLE_DEVICE_ID || exampleDefaults.device,
+  paperId: process.env.SCHEMA_EXAMPLE_PAPER_ID || exampleDefaults.paper,
+  paper: process.env.SCHEMA_EXAMPLE_PAPER_ID || exampleDefaults.paper,
+  patient: process.env.SCHEMA_EXAMPLE_USER_ID || exampleDefaults.user,
+  accountId: process.env.SCHEMA_EXAMPLE_ACCOUNT_ID,
+  tokenId: process.env.SCHEMA_EXAMPLE_TOKEN_ID,
+};
+
+export const zObjectIdFor = (paramName?: string) => {
+  const example = paramName ? objectIdExampleOverrides[paramName] : undefined;
+  const exampleValue = example || defaultObjectIdExample;
+  return z
+    .string()
+    .refine((val) => {
+      if (process.env.SCHEMA_STRICT_EXAMPLES === "true" && example) {
+        return val === example;
+      }
+      return mongoose.Types.ObjectId.isValid(val);
+    })
+    .openapi({
+      example: exampleValue,
+      description: "A valid MongoDB ObjectId",
+    });
+};
+
 export const zGet = (id: string) => ({
   params: z.object({
-    [id]: zObjectId /* .openapi({ example: '682fd0d7d4a6325d9d45b86d' }) */,
+    [id]: zObjectIdFor(id),
   }),
 });
 
-export function zPatchBody<T extends ZodRawShape>(shape: T, message = 'At least one field must be provided for update') {
+export function zPatchBody<T extends ZodRawShape>(
+  shape: T,
+  message = "At least one field must be provided for update",
+) {
   // assume user passed in already-optional vals
   return z.object(shape); // .refine((o) => Object.keys(o).length > 0, { message });
 }
 
 export const zUpdate = (id: string) => ({
   params: z.object({
-    [id]: zObjectId,
+    [id]: zObjectIdFor(id),
   }),
 });
 
 export const zDelete = (id: string) => ({
   params: z.object({
-    [id]: zObjectId,
+    [id]: zObjectIdFor(id),
   }),
 });
 
-export const zObjectId = z
-  .string()
-  .refine((val) => {
-    return mongoose.Types.ObjectId.isValid(val);
-  })
-  .openapi({ example: '682fd0d7d4a6325d9d45b86d', description: 'A valid MongoDB ObjectId' });
+export const zObjectId = zObjectIdFor();
 
 export const zDate = () => z.string().pipe(z.coerce.date());

package/tsconfig.json

@@ -1,13 +1,18 @@
 {
   "compilerOptions": {
     "target": "ES2020",
-    "module": "NodeNext",
+    "module": "ES2020",
     "baseUrl": ".",
     "rootDir": ".",
     "outDir": "./dist",
     "esModuleInterop": true,
-    "strict": true,
-    "moduleResolution": "NodeNext",
+    "strict": false,
+    "noImplicitAny": false,
+    "noImplicitThis": false,
+    "useUnknownInCatchVariables": false,
+    "noUncheckedIndexedAccess": false,
+    "exactOptionalPropertyTypes": false,
+    "moduleResolution": "Bundler",
     "resolveJsonModule": true,
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": true,
@@ -17,6 +22,10 @@
     "esm": true,
     "experimentalSpecifierResolution": "node"
   },
-  "include": ["src/**/*", "common.legac, "../memo-api/src/middlewares/validateMessage.ts"y/**/*"],
+  "include": [
+    "src/**/*",
+    "common.legacy/**/*",
+    "../memo-api/src/middlewares/validateMessage.ts"
+  ],
   "exclude": ["node_modules", "dist"]
 }