@lyxa.ai/types 1.1.59 → 1.1.61

package/README.md

@@ -22,7 +22,7 @@ Perfect for sharing types between frontend and backend applications.
 
 ## Version
 
-Version: 1.1.59
+Version: 1.1.61
 
 ## Dependencies
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lyxa.ai/types",
-  "version": "1.1.59",
+  "version": "1.1.61",
   "description": "Lyxa type definitions and validation schemas for both frontend and backend",
   "author": "elie <42282499+Internalizable@users.noreply.github.com>",
   "license": "MIT",

package/utilities/validation/filter-schema.factory.d.ts

@@ -8,25 +8,23 @@ export interface FilterSchemaConfig<TSelect extends ReadonlyNonEmptyArray<string
     maxSize?: number;
     defaultSize?: number;
 }
-export type PopulateObject<TPath extends string, TSelectFields extends ReadonlyNonEmptyArray<string>> = {
-    path: TPath;
-    select?: Partial<Record<TSelectFields[number], 0 | 1>>;
-    match?: Record<string, any>;
-    options?: {
-        sort?: Record<string, 1 | -1>;
-        limit?: number;
-        skip?: number;
+type PopulateMap<TPopulate extends Record<string, ReadonlyNonEmptyArray<string>>> = {
+    [K in keyof TPopulate]?: {
+        select?: Partial<Record<TPopulate[K][number], 0 | 1>>;
+        match?: Record<string, any>;
+        options?: {
+            sort?: Record<string, 1 | -1>;
+            limit?: number;
+            skip?: number;
+        };
     };
 };
-type PopulateUnion<TPopulate extends Record<string, ReadonlyNonEmptyArray<string>>> = {
-    [K in keyof TPopulate]: PopulateObject<K & string, TPopulate[K]>;
-}[keyof TPopulate];
 export type FilterDTO<TSelect extends ReadonlyNonEmptyArray<string> | [] = [], TPopulate extends Record<string, ReadonlyNonEmptyArray<string>> | {} = {}, TSearch extends ReadonlyNonEmptyArray<string> | [] = [], TQuery extends Record<string, ZodTypeAny> = {}> = {
     size?: number;
     page?: number;
     sort?: Record<string, 1 | -1>;
     select?: TSelect extends ReadonlyNonEmptyArray<string> ? Partial<Record<TSelect[number], 0 | 1>> : never;
-    populate?: keyof TPopulate extends never ? never : PopulateUnion<TPopulate> | PopulateUnion<TPopulate>[];
+    populate?: PopulateMap<TPopulate>;
     search?: TSearch extends ReadonlyNonEmptyArray<string> ? {
         searchKey: string;
         searchFields?: TSearch[number][];

package/utilities/validation/filter-schema.factory.js

@@ -5,7 +5,6 @@ const zod_1 = require("zod");
 const sortSchema = zod_1.z.record(zod_1.z.string(), zod_1.z.union([zod_1.z.literal(1), zod_1.z.literal(-1)]));
 function createFilterSchema(config) {
     const { selectableFields, populatableFields, searchableFields, queryableFields, maxSize = 100, defaultSize = 10, } = config;
-    const populateKeys = populatableFields ? Object.keys(populatableFields) : [];
     const schemaShape = {
         size: zod_1.z.number().min(1).max(maxSize).optional().default(defaultSize),
         page: zod_1.z.number().min(1).optional().default(1),
@@ -16,12 +15,12 @@ function createFilterSchema(config) {
             .record(zod_1.z.enum([...selectableFields]), zod_1.z.union([zod_1.z.literal(0), zod_1.z.literal(1)]))
             .optional();
     }
-    if (populateKeys.length) {
-        const populateSchemas = [];
-        for (const path of populateKeys) {
+    if (populatableFields && Object.keys(populatableFields).length) {
+        const populateShape = {};
+        for (const path in populatableFields) {
             const allowedSelects = populatableFields[path];
-            const populateSchema = zod_1.z.object({
-                path: zod_1.z.literal(path),
+            populateShape[path] = zod_1.z
+                .object({
                 select: zod_1.z
                     .record(zod_1.z.enum([...allowedSelects]), zod_1.z.union([zod_1.z.literal(0), zod_1.z.literal(1)]))
                     .optional(),
@@ -33,19 +32,10 @@ function createFilterSchema(config) {
                     skip: zod_1.z.number().optional(),
                 })
                     .optional(),
-            });
-            populateSchemas.push(populateSchema);
-        }
-        if (populateSchemas.length > 0) {
-            let unionSchema;
-            if (populateSchemas.length === 1) {
-                unionSchema = populateSchemas[0];
-            }
-            else {
-                unionSchema = zod_1.z.union(populateSchemas);
-            }
-            schemaShape.populate = zod_1.z.union([unionSchema, zod_1.z.array(unionSchema)]).optional();
+            })
+                .optional();
         }
+        schemaShape.populate = zod_1.z.object(populateShape).optional();
     }
     if (searchableFields?.length) {
         schemaShape.search = zod_1.z

package/utilities/validation/filter-schema.factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter-schema.factory.js","sourceRoot":"/","sources":["utilities/validation/filter-schema.factory.ts"],"names":[],"mappings":";;AAkDA,gDAsFC;AAxID,6BAAoC;AAgDpC,MAAM,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhF,SAAgB,kBAAkB,CAKhC,MAA+D;IAChE,MAAM,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,OAAO,GAAG,GAAG,EACb,WAAW,GAAG,EAAE,GAChB,GAAG,MAAM,CAAC;IAEX,MAAM,YAAY,GAAG,iBAAiB,CAAC,CAAC,CAAE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAyB,CAAC,CAAC,CAAC,EAAE,CAAC;IAEtG,MAAM,WAAW,GAAwB;QACxC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;QACpE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7C,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE;KAC3B,CAAC;IAGF,IAAI,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC9B,WAAW,CAAC,MAAM,GAAG,OAAC;aACpB,MAAM,CAAC,OAAC,CAAC,IAAI,CAAC,CAAC,GAAG,gBAAgB,CAA0B,CAAC,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACrG,QAAQ,EAAE,CAAC;IACd,CAAC;IAGD,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,eAAe,GAAiB,EAAE,CAAC;QAEzC,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;YACjC,MAAM,cAAc,GAAG,iBAAkB,CAAC,IAAI,CAAkC,CAAC;YAEjF,MAAM,cAAc,GAAG,OAAC,CAAC,MAAM,CAAC;gBAC/B,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,IAAc,CAAC;gBAC/B,MAAM,EAAE,OAAC;qBACP,MAAM,CAAC,OAAC,CAAC,IAAI,CAAC,CAAC,GAAG,cAAc,CAA0B,CAAC,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;qBACnG,QAAQ,EAAE;gBACZ,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;gBAC/C,OAAO,EAAE,OAAC;qBACR,MAAM,CAAC;oBACP,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE;oBAC3B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;oBAC5B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC3B,CAAC;qBACD,QAAQ,EAAE;aACZ,CAAC,CAAC;YAEH,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,IAAI,WAAuB,CAAC;YAC5B,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClC,WAAW,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACP,WAAW,GAAG,OAAC,CAAC,KAAK,CAAC,eAA4D,CAAC,CAAC;YACrF,CAAC;YACD,WAAW,CAAC,QAAQ,GAAG,OAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChF,CAAC;IACF,CAAC;IAGD,IAAI,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC9B,WAAW,CAAC,MAAM,GAAG,OAAC;aACpB,MAAM,CAAC;YACP,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,IAAI,CAAC,CAAC,GAAG,gBAAgB,CAA0B,CAAC,CAAC,CAAC,QAAQ,EAAE;SACxF,CAAC;aACD,QAAQ,EAAE,CAAC;IACd,CAAC;IAGD,IAAI,eAAe,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC;QAC5D,MAAM,UAAU,GAA+B,EAAE,CAAC;QAClD,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YACnC,UAAU,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;QACnD,CAAC;QACD,WAAW,CAAC,KAAK,GAAG,OAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;IACrD,CAAC;IAED,OAAO,OAAC,CAAC,MAAM,CAAC,WAAW,CAA8D,CAAC;AAC3F,CAAC","sourcesContent":["import { z, ZodTypeAny } from 'zod';\n\ntype ReadonlyNonEmptyArray<T> = readonly [T, ...T[]];\n\nexport interface FilterSchemaConfig<\n\tTSelect extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTPopulate extends Record<string, ReadonlyNonEmptyArray<string>> | {} = {},\n\tTSearch extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTQuery extends Record<string, ZodTypeAny> = {},\n> {\n\tselectableFields?: TSelect;\n\tpopulatableFields?: TPopulate;\n\tsearchableFields?: TSearch;\n\tqueryableFields?: TQuery;\n\tmaxSize?: number;\n\tdefaultSize?: number;\n}\n\n// Each populate path has its own select fields from populatableFields\nexport type PopulateObject<TPath extends string, TSelectFields extends ReadonlyNonEmptyArray<string>> = {\n\tpath: TPath;\n\tselect?: Partial<Record<TSelectFields[number], 0 | 1>>;\n\tmatch?: Record<string, any>;\n\toptions?: { sort?: Record<string, 1 | -1>; limit?: number; skip?: number };\n};\n\n// Create a union type of all possible populate objects based on populatableFields\ntype PopulateUnion<TPopulate extends Record<string, ReadonlyNonEmptyArray<string>>> = {\n\t[K in keyof TPopulate]: PopulateObject<K & string, TPopulate[K]>;\n}[keyof TPopulate];\n\nexport type FilterDTO<\n\tTSelect extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTPopulate extends Record<string, ReadonlyNonEmptyArray<string>> | {} = {},\n\tTSearch extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTQuery extends Record<string, ZodTypeAny> = {},\n> = {\n\tsize?: number;\n\tpage?: number;\n\tsort?: Record<string, 1 | -1>;\n\tselect?: TSelect extends ReadonlyNonEmptyArray<string> ? Partial<Record<TSelect[number], 0 | 1>> : never;\n\tpopulate?: keyof TPopulate extends never ? never : PopulateUnion<TPopulate> | PopulateUnion<TPopulate>[];\n\tsearch?: TSearch extends ReadonlyNonEmptyArray<string>\n\t\t? { searchKey: string; searchFields?: TSearch[number][] }\n\t\t: never;\n\tquery?: { [K in keyof TQuery]?: z.infer<TQuery[K]> };\n};\n\nconst sortSchema = z.record(z.string(), z.union([z.literal(1), z.literal(-1)]));\n\nexport function createFilterSchema<\n\tTSelect extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTPopulate extends Record<string, ReadonlyNonEmptyArray<string>> | {} = {},\n\tTSearch extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTQuery extends Record<string, ZodTypeAny> = {},\n>(config: FilterSchemaConfig<TSelect, TPopulate, TSearch, TQuery>) {\n\tconst {\n\t\tselectableFields,\n\t\tpopulatableFields,\n\t\tsearchableFields,\n\t\tqueryableFields,\n\t\tmaxSize = 100,\n\t\tdefaultSize = 10,\n\t} = config;\n\n\tconst populateKeys = populatableFields ? (Object.keys(populatableFields) as (keyof TPopulate)[]) : [];\n\n\tconst schemaShape: Record<string, any> = {\n\t\tsize: z.number().min(1).max(maxSize).optional().default(defaultSize),\n\t\tpage: z.number().min(1).optional().default(1),\n\t\tsort: sortSchema.optional(),\n\t};\n\n\t// Select - uses selectableFields for top-level document fields\n\tif (selectableFields?.length) {\n\t\tschemaShape.select = z\n\t\t\t.record(z.enum([...selectableFields] as [string, ...string[]]), z.union([z.literal(0), z.literal(1)]))\n\t\t\t.optional();\n\t}\n\n\t// Populate - each path uses its own select fields from populatableFields\n\tif (populateKeys.length) {\n\t\tconst populateSchemas: ZodTypeAny[] = [];\n\n\t\tfor (const path of populateKeys) {\n\t\t\tconst allowedSelects = populatableFields![path] as ReadonlyNonEmptyArray<string>;\n\n\t\t\tconst populateSchema = z.object({\n\t\t\t\tpath: z.literal(path as string),\n\t\t\t\tselect: z\n\t\t\t\t\t.record(z.enum([...allowedSelects] as [string, ...string[]]), z.union([z.literal(0), z.literal(1)]))\n\t\t\t\t\t.optional(),\n\t\t\t\tmatch: z.record(z.string(), z.any()).optional(),\n\t\t\t\toptions: z\n\t\t\t\t\t.object({\n\t\t\t\t\t\tsort: sortSchema.optional(),\n\t\t\t\t\t\tlimit: z.number().optional(),\n\t\t\t\t\t\tskip: z.number().optional(),\n\t\t\t\t\t})\n\t\t\t\t\t.optional(),\n\t\t\t});\n\n\t\t\tpopulateSchemas.push(populateSchema);\n\t\t}\n\n\t\tif (populateSchemas.length > 0) {\n\t\t\tlet unionSchema: ZodTypeAny;\n\t\t\tif (populateSchemas.length === 1) {\n\t\t\t\tunionSchema = populateSchemas[0];\n\t\t\t} else {\n\t\t\t\tunionSchema = z.union(populateSchemas as [ZodTypeAny, ZodTypeAny, ...ZodTypeAny[]]);\n\t\t\t}\n\t\t\tschemaShape.populate = z.union([unionSchema, z.array(unionSchema)]).optional();\n\t\t}\n\t}\n\n\t// Search\n\tif (searchableFields?.length) {\n\t\tschemaShape.search = z\n\t\t\t.object({\n\t\t\t\tsearchKey: z.string(),\n\t\t\t\tsearchFields: z.array(z.enum([...searchableFields] as [string, ...string[]])).optional(),\n\t\t\t})\n\t\t\t.optional();\n\t}\n\n\t// Query\n\tif (queryableFields && Object.keys(queryableFields).length) {\n\t\tconst queryShape: Record<string, ZodTypeAny> = {};\n\t\tfor (const key in queryableFields) {\n\t\t\tqueryShape[key] = queryableFields[key].optional();\n\t\t}\n\t\tschemaShape.query = z.object(queryShape).optional();\n\t}\n\n\treturn z.object(schemaShape) as z.ZodType<FilterDTO<TSelect, TPopulate, TSearch, TQuery>>;\n}\n\n/**\n * EXAMPLE USAGE\n *\n * const TicketFilterSchema = createFilterSchema({\n *   // Top-level document fields that can be selected\n *   selectableFields: [\n *     '_id',\n *     'ticketId',\n *     'type',\n *     'status',\n *     'createdAt',\n *     'updatedAt',\n *   ] as const,\n *\n *   // Each populate path has its own allowed select fields\n *   populatableFields: {\n *     chatroom: ['_id', 'lastMessage', 'participants', 'unreadCount'] as const,\n *     client: ['_id', 'name', 'profilePhoto', 'type'] as const,\n *     admin: ['_id', 'name', 'profilePhoto'] as const,\n *     order: ['_id', 'orderId', 'shop', 'total'] as const,\n *   } as const,\n *\n *   searchableFields: ['ticketId'] as const,\n *\n *   queryableFields: {\n *     status: z.enum(['OPEN', 'CLOSED', 'PENDING']),\n *     type: z.enum(['ORDER', 'GENERAL', 'COMPLAINT']),\n *     client: z.string(),\n *     clientType: z.enum(['USER', 'SHOP']),\n *   },\n * });\n *\n * type TicketFilterDTO = z.infer<typeof TicketFilterSchema>;\n *\n * // ✅ VALID EXAMPLES\n *\n * // Example 1: Select only top-level fields\n * const filter1: TicketFilterDTO = {\n *   select: { ticketId: 1, status: 1, createdAt: 1 },\n *   query: { status: 'OPEN' },\n *   page: 1,\n *   size: 20,\n * };\n *\n * // Example 2: Populate client with specific fields\n * const filter2: TicketFilterDTO = {\n *   populate: {\n *     path: 'client',\n *     select: { name: 1, profilePhoto: 1 }, // Uses client's allowed fields\n *   },\n *   page: 1,\n *   size: 20,\n * };\n *\n * // Example 3: Populate multiple relations\n * const filter3: TicketFilterDTO = {\n *   populate: [\n *     { path: 'client', select: { name: 1, profilePhoto: 1 } },\n *     { path: 'order', select: { orderId: 1, total: 1 } },\n *     { path: 'chatroom', select: { lastMessage: 1, unreadCount: 1 } },\n *   ],\n *   page: 1,\n *   size: 20,\n * };\n *\n * // Example 4: Complex query with search\n * const filter4: TicketFilterDTO = {\n *   query: { status: 'OPEN', type: 'ORDER' },\n *   search: { searchKey: 'TKT-123', searchFields: ['ticketId'] },\n *   populate: { path: 'client', select: { name: 1 } },\n *   sort: { createdAt: -1 },\n *   page: 1,\n *   size: 20,\n * };\n *\n * // Example 5: Populate with match and options\n * const filter5: TicketFilterDTO = {\n *   populate: {\n *     path: 'order',\n *     select: { orderId: 1, shop: 1 },\n *     match: { status: 'DELIVERED' },\n *     options: { sort: { createdAt: -1 }, limit: 10 },\n *   },\n *   page: 1,\n *   size: 20,\n * };\n *\n * // ❌ INVALID EXAMPLES (TypeScript will reject)\n *\n * const invalid1: TicketFilterDTO = {\n *   select: { invalidField: 1 }, // ❌ not in selectableFields\n * };\n *\n * const invalid2: TicketFilterDTO = {\n *   populate: {\n *     path: 'client',\n *     select: { email: 1 }, // ❌ email not in client's populatableFields\n *   },\n * };\n *\n * const invalid3: TicketFilterDTO = {\n *   populate: {\n *     path: 'invalidPath', // ❌ path doesn't exist\n *     select: { name: 1 },\n *   },\n * };\n *\n * const invalid4: TicketFilterDTO = {\n *   query: { status: 'INVALID_STATUS' }, // ❌ not in enum\n * }\n */"]}
+{"version":3,"file":"filter-schema.factory.js","sourceRoot":"/","sources":["utilities/validation/filter-schema.factory.ts"],"names":[],"mappings":";;AAgDA,gDA8EC;AA9HD,6BAAoC;AA6CpC,MAAM,UAAU,GAAG,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAGhF,SAAgB,kBAAkB,CAKhC,MAA+D;IAChE,MAAM,EACL,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,OAAO,GAAG,GAAG,EACb,WAAW,GAAG,EAAE,GAChB,GAAG,MAAM,CAAC;IAEX,MAAM,WAAW,GAAwB;QACxC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC;QACpE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7C,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE;KAC3B,CAAC;IAGF,IAAI,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC9B,WAAW,CAAC,MAAM,GAAG,OAAC;aACpB,MAAM,CAAC,OAAC,CAAC,IAAI,CAAC,CAAC,GAAG,gBAAgB,CAA0B,CAAC,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACrG,QAAQ,EAAE,CAAC;IACd,CAAC;IAGD,IAAI,iBAAiB,IAAI,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,MAAM,EAAE,CAAC;QAChE,MAAM,aAAa,GAAwB,EAAE,CAAC;QAE9C,KAAK,MAAM,IAAI,IAAI,iBAAiB,EAAE,CAAC;YACtC,MAAM,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAkC,CAAC;YAEhF,aAAa,CAAC,IAAI,CAAC,GAAG,OAAC;iBACrB,MAAM,CAAC;gBACP,MAAM,EAAE,OAAC;qBACP,MAAM,CACN,OAAC,CAAC,IAAI,CAAC,CAAC,GAAG,cAAc,CAA0B,CAAC,EACpD,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CACrC;qBACA,QAAQ,EAAE;gBACZ,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC,OAAC,CAAC,MAAM,EAAE,EAAE,OAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;gBAC/C,OAAO,EAAE,OAAC;qBACR,MAAM,CAAC;oBACP,IAAI,EAAE,UAAU,CAAC,QAAQ,EAAE;oBAC3B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;oBAC5B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC3B,CAAC;qBACD,QAAQ,EAAE;aACZ,CAAC;iBACD,QAAQ,EAAE,CAAC;QACd,CAAC;QAED,WAAW,CAAC,QAAQ,GAAG,OAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC3D,CAAC;IAGD,IAAI,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC9B,WAAW,CAAC,MAAM,GAAG,OAAC;aACpB,MAAM,CAAC;YACP,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,IAAI,CAAC,CAAC,GAAG,gBAAgB,CAA0B,CAAC,CAAC,CAAC,QAAQ,EAAE;SACxF,CAAC;aACD,QAAQ,EAAE,CAAC;IACd,CAAC;IAGD,IAAI,eAAe,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC;QAC5D,MAAM,UAAU,GAA+B,EAAE,CAAC;QAClD,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YACnC,UAAU,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;QACnD,CAAC;QACD,WAAW,CAAC,KAAK,GAAG,OAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;IACrD,CAAC;IAED,OAAO,OAAC,CAAC,MAAM,CAAC,WAAW,CAA8D,CAAC;AAC3F,CAAC","sourcesContent":["import { z, ZodTypeAny } from 'zod';\n\ntype ReadonlyNonEmptyArray<T> = readonly [T, ...T[]];\n\nexport interface FilterSchemaConfig<\n\tTSelect extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTPopulate extends Record<string, ReadonlyNonEmptyArray<string>> | {} = {},\n\tTSearch extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTQuery extends Record<string, ZodTypeAny> = {},\n> {\n\tselectableFields?: TSelect;\n\tpopulatableFields?: TPopulate;\n\tsearchableFields?: TSearch;\n\tqueryableFields?: TQuery;\n\tmaxSize?: number;\n\tdefaultSize?: number;\n}\n\n// Mapped type for keyed populate\ntype PopulateMap<TPopulate extends Record<string, ReadonlyNonEmptyArray<string>>> = {\n\t[K in keyof TPopulate]?: {\n\t\tselect?: Partial<Record<TPopulate[K][number], 0 | 1>>;\n\t\tmatch?: Record<string, any>;\n\t\toptions?: { sort?: Record<string, 1 | -1>; limit?: number; skip?: number };\n\t};\n};\n\n// Filter DTO\nexport type FilterDTO<\n\tTSelect extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTPopulate extends Record<string, ReadonlyNonEmptyArray<string>> | {} = {},\n\tTSearch extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTQuery extends Record<string, ZodTypeAny> = {},\n> = {\n\tsize?: number;\n\tpage?: number;\n\tsort?: Record<string, 1 | -1>;\n\tselect?: TSelect extends ReadonlyNonEmptyArray<string> ? Partial<Record<TSelect[number], 0 | 1>> : never;\n\tpopulate?: PopulateMap<TPopulate>;\n\tsearch?: TSearch extends ReadonlyNonEmptyArray<string>\n\t\t? { searchKey: string; searchFields?: TSearch[number][] }\n\t\t: never;\n\tquery?: { [K in keyof TQuery]?: z.infer<TQuery[K]> };\n};\n\nconst sortSchema = z.record(z.string(), z.union([z.literal(1), z.literal(-1)]));\n\n// Create the Zod schema\nexport function createFilterSchema<\n\tTSelect extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTPopulate extends Record<string, ReadonlyNonEmptyArray<string>> | {} = {},\n\tTSearch extends ReadonlyNonEmptyArray<string> | [] = [],\n\tTQuery extends Record<string, ZodTypeAny> = {},\n>(config: FilterSchemaConfig<TSelect, TPopulate, TSearch, TQuery>) {\n\tconst {\n\t\tselectableFields,\n\t\tpopulatableFields,\n\t\tsearchableFields,\n\t\tqueryableFields,\n\t\tmaxSize = 100,\n\t\tdefaultSize = 10,\n\t} = config;\n\n\tconst schemaShape: Record<string, any> = {\n\t\tsize: z.number().min(1).max(maxSize).optional().default(defaultSize),\n\t\tpage: z.number().min(1).optional().default(1),\n\t\tsort: sortSchema.optional(),\n\t};\n\n\t// Top-level select\n\tif (selectableFields?.length) {\n\t\tschemaShape.select = z\n\t\t\t.record(z.enum([...selectableFields] as [string, ...string[]]), z.union([z.literal(0), z.literal(1)]))\n\t\t\t.optional();\n\t}\n\n\t// Keyed populate\n\tif (populatableFields && Object.keys(populatableFields).length) {\n\t\tconst populateShape: Record<string, any> = {};\n\n\t\tfor (const path in populatableFields) {\n\t\t\tconst allowedSelects = populatableFields[path] as ReadonlyNonEmptyArray<string>;\n\n\t\t\tpopulateShape[path] = z\n\t\t\t\t.object({\n\t\t\t\t\tselect: z\n\t\t\t\t\t\t.record(\n\t\t\t\t\t\t\tz.enum([...allowedSelects] as [string, ...string[]]),\n\t\t\t\t\t\t\tz.union([z.literal(0), z.literal(1)])\n\t\t\t\t\t\t)\n\t\t\t\t\t\t.optional(),\n\t\t\t\t\tmatch: z.record(z.string(), z.any()).optional(),\n\t\t\t\t\toptions: z\n\t\t\t\t\t\t.object({\n\t\t\t\t\t\t\tsort: sortSchema.optional(),\n\t\t\t\t\t\t\tlimit: z.number().optional(),\n\t\t\t\t\t\t\tskip: z.number().optional(),\n\t\t\t\t\t\t})\n\t\t\t\t\t\t.optional(),\n\t\t\t\t})\n\t\t\t\t.optional();\n\t\t}\n\n\t\tschemaShape.populate = z.object(populateShape).optional();\n\t}\n\n\t// Search\n\tif (searchableFields?.length) {\n\t\tschemaShape.search = z\n\t\t\t.object({\n\t\t\t\tsearchKey: z.string(),\n\t\t\t\tsearchFields: z.array(z.enum([...searchableFields] as [string, ...string[]])).optional(),\n\t\t\t})\n\t\t\t.optional();\n\t}\n\n\t// Query\n\tif (queryableFields && Object.keys(queryableFields).length) {\n\t\tconst queryShape: Record<string, ZodTypeAny> = {};\n\t\tfor (const key in queryableFields) {\n\t\t\tqueryShape[key] = queryableFields[key].optional();\n\t\t}\n\t\tschemaShape.query = z.object(queryShape).optional();\n\t}\n\n\treturn z.object(schemaShape) as z.ZodType<FilterDTO<TSelect, TPopulate, TSearch, TQuery>>;\n}\n\n/**\n * EXAMPLE USAGE\n *\n * const TicketFilterSchema = createFilterSchema({\n *   // Top-level document fields that can be selected\n *   selectableFields: [\n *     '_id',\n *     'ticketId',\n *     'type',\n *     'status',\n *     'createdAt',\n *     'updatedAt',\n *   ] as const,\n *\n *   // Each populate path has its own allowed select fields\n *   populatableFields: {\n *     chatroom: ['_id', 'lastMessage', 'participants', 'unreadCount'] as const,\n *     client: ['_id', 'name', 'profilePhoto', 'type'] as const,\n *     admin: ['_id', 'name', 'profilePhoto'] as const,\n *     order: ['_id', 'orderId', 'shop', 'total'] as const,\n *   } as const,\n *\n *   searchableFields: ['ticketId'] as const,\n *\n *   queryableFields: {\n *     status: z.enum(['OPEN', 'CLOSED', 'PENDING']),\n *     type: z.enum(['ORDER', 'GENERAL', 'COMPLAINT']),\n *     client: z.string(),\n *     clientType: z.enum(['USER', 'SHOP']),\n *   },\n * });\n *\n * type TicketFilterDTO = z.infer<typeof TicketFilterSchema>;\n *\n * // ✅ VALID EXAMPLES\n *\n * // Example 1: Select only top-level fields\n * const filter1: TicketFilterDTO = {\n *   select: { ticketId: 1, status: 1, createdAt: 1 },\n *   query: { status: 'OPEN' },\n *   page: 1,\n *   size: 20,\n * };\n *\n * // Example 2: Populate client with specific fields\n * const filter2: TicketFilterDTO = {\n *   populate: {\n *     path: 'client',\n *     select: { name: 1, profilePhoto: 1 }, // Uses client's allowed fields\n *   },\n *   page: 1,\n *   size: 20,\n * };\n *\n * // Example 3: Populate multiple relations\n * const filter3: TicketFilterDTO = {\n *   populate: [\n *     { path: 'client', select: { name: 1, profilePhoto: 1 } },\n *     { path: 'order', select: { orderId: 1, total: 1 } },\n *     { path: 'chatroom', select: { lastMessage: 1, unreadCount: 1 } },\n *   ],\n *   page: 1,\n *   size: 20,\n * };\n *\n * // Example 4: Complex query with search\n * const filter4: TicketFilterDTO = {\n *   query: { status: 'OPEN', type: 'ORDER' },\n *   search: { searchKey: 'TKT-123', searchFields: ['ticketId'] },\n *   populate: { path: 'client', select: { name: 1 } },\n *   sort: { createdAt: -1 },\n *   page: 1,\n *   size: 20,\n * };\n *\n * // Example 5: Populate with match and options\n * const filter5: TicketFilterDTO = {\n *   populate: {\n *     path: 'order',\n *     select: { orderId: 1, shop: 1 },\n *     match: { status: 'DELIVERED' },\n *     options: { sort: { createdAt: -1 }, limit: 10 },\n *   },\n *   page: 1,\n *   size: 20,\n * };\n *\n * // ❌ INVALID EXAMPLES (TypeScript will reject)\n *\n * const invalid1: TicketFilterDTO = {\n *   select: { invalidField: 1 }, // ❌ not in selectableFields\n * };\n *\n * const invalid2: TicketFilterDTO = {\n *   populate: {\n *     path: 'client',\n *     select: { email: 1 }, // ❌ email not in client's populatableFields\n *   },\n * };\n *\n * const invalid3: TicketFilterDTO = {\n *   populate: {\n *     path: 'invalidPath', // ❌ path doesn't exist\n *     select: { name: 1 },\n *   },\n * };\n *\n * const invalid4: TicketFilterDTO = {\n *   query: { status: 'INVALID_STATUS' }, // ❌ not in enum\n * }\n */"]}

package/utilities/validation/index.d.ts

@@ -1,4 +1,4 @@
 export * from './common-validation';
 export * from './global-validation';
 export * from './validation-for-frontend';
-export { createFilterSchema, FilterSchemaConfig, PopulateObject } from './filter-schema.factory';
+export { createFilterSchema, FilterSchemaConfig } from './filter-schema.factory';

package/utilities/validation/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"/","sources":["utilities/validation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,sDAAoC;AACpC,4DAA0C;AAC1C,iEAAiG;AAAxF,2HAAA,kBAAkB,OAAA","sourcesContent":["export * from './common-validation';\nexport * from './global-validation';\nexport * from './validation-for-frontend';\nexport { createFilterSchema, FilterSchemaConfig, PopulateObject } from './filter-schema.factory';"]}
+{"version":3,"file":"index.js","sourceRoot":"/","sources":["utilities/validation/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,sDAAoC;AACpC,4DAA0C;AAC1C,iEAAiF;AAAxE,2HAAA,kBAAkB,OAAA","sourcesContent":["export * from './common-validation';\nexport * from './global-validation';\nexport * from './validation-for-frontend';\nexport { createFilterSchema, FilterSchemaConfig } from './filter-schema.factory';"]}