@tmlmobilidade/interfaces 20251006.1055.51 → 20251006.1126.43

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './src/aggregation-pipeline.js';
+export * from './src/enrich-user-refs.js';
 export * from './src/interfaces/index.js';
 export * from './src/mongo-collection.js';
 export * from './src/mongo-transaction.js';

package/dist/index.js

@@ -1,5 +1,6 @@
 /* * */
 export * from './src/aggregation-pipeline.js';
+export * from './src/enrich-user-refs.js';
 export * from './src/interfaces/index.js';
 export * from './src/mongo-collection.js';
 export * from './src/mongo-transaction.js';

package/dist/src/enrich-user-refs.d.ts

@@ -0,0 +1,4 @@
+type AnyDoc = Record<string, any>;
+export declare function enrichUserRefs<T extends AnyDoc>(doc: T): Promise<T>;
+export declare function enrichUserRefsMany<T extends AnyDoc>(docs: T[]): Promise<T[]>;
+export {};

package/dist/src/enrich-user-refs.js

@@ -0,0 +1,75 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { users } from './interfaces/auth/users.js';
+import { UserDisplayFields } from '@tmlmobilidade/types';
+const isUserRefKey = (k) => k === 'created_by' || k === 'updated_by';
+const isEligibleId = (v) => typeof v === 'string' && v && v !== 'system';
+function collectUserIds(input, out) {
+    if (Array.isArray(input)) {
+        for (const item of input)
+            collectUserIds(item, out);
+        return;
+    }
+    if (input && typeof input === 'object') {
+        for (const [k, v] of Object.entries(input)) {
+            if (isUserRefKey(k) && isEligibleId(v))
+                out.add(v);
+            collectUserIds(v, out);
+        }
+    }
+}
+function replaceRefs(input, map) {
+    if (Array.isArray(input)) {
+        return input.map(item => replaceRefs(item, map));
+    }
+    if (input && typeof input === 'object') {
+        const obj = input;
+        const out = Array.isArray(obj) ? [] : {};
+        for (const [k, v] of Object.entries(obj)) {
+            if (isUserRefKey(k) && typeof v === 'string' && v !== 'system') {
+                const found = map.get(v);
+                out[k] = found ?? v; // fallback to original id if user not found
+            }
+            else {
+                out[k] = replaceRefs(v, map);
+            }
+        }
+        return out;
+    }
+    return input;
+}
+async function fetchUsersMap(ids) {
+    if (ids.size === 0)
+        return new Map();
+    const coll = await users.getCollection();
+    // Only fetch UserDisplay fields
+    const projection = Object.keys(UserDisplayFields).reduce((acc, field) => {
+        acc[field] = 1;
+        return acc;
+    }, {});
+    const result = await coll.find({ _id: { $in: Array.from(ids) } }, { projection }).toArray();
+    const map = new Map();
+    for (const u of result) {
+        map.set(u._id, {
+            _id: u._id,
+            avatar: u.avatar ?? undefined,
+            email: u.email,
+            first_name: u.first_name,
+            last_name: u.last_name,
+            phone: u.phone ?? undefined,
+        });
+    }
+    return map;
+}
+export async function enrichUserRefs(doc) {
+    const ids = new Set();
+    collectUserIds(doc, ids);
+    const map = await fetchUsersMap(ids);
+    return replaceRefs(doc, map);
+}
+export async function enrichUserRefsMany(docs) {
+    const ids = new Set();
+    for (const d of docs)
+        collectUserIds(d, ids);
+    const map = await fetchUsersMap(ids);
+    return docs.map(d => replaceRefs(d, map));
+}

package/dist/src/interfaces/auth/users.d.ts

@@ -2,7 +2,6 @@ import { MongoCollectionClass } from '../../mongo-collection.js';
 import { CreateUserDto, UpdateUserDto, User } from '@tmlmobilidade/types';
 import { Filter, FindOptions, IndexDescription, WithId } from 'mongodb';
 import { z } from 'zod';
-type NewType = string;
 declare class UsersClass extends MongoCollectionClass<User, CreateUserDto, UpdateUserDto> {
     private static _instance;
     protected createSchema: z.ZodSchema;
@@ -32,7 +31,7 @@ declare class UsersClass extends MongoCollectionClass<User, CreateUserDto, Updat
      * @param includePasswordHash - Whether to include the password hash in the result
      * @returns A promise that resolves to the matching user documents or null if not found
      */
-    findByOrganization(id: NewType, includePasswordHash?: boolean): Promise<{
+    findByOrganization(id: string, includePasswordHash?: boolean): Promise<{
         created_at: number & {
             __brand: "UnixTimestamp";
         };
@@ -41,16 +40,16 @@ declare class UsersClass extends MongoCollectionClass<User, CreateUserDto, Updat
         };
         created_by?: string | undefined | undefined;
         updated_by?: string | undefined | undefined;
-        phone?: string | null | undefined | undefined;
-        email: string;
-        permissions: import("@tmlmobilidade/types").Permission<unknown>[];
         active_notifications: string[];
         avatar?: string | null | undefined | undefined;
         bio?: string | null | undefined | undefined;
+        email: string;
         email_verified?: import("@tmlmobilidade/types").UnixTimestamp | null | undefined;
         first_name: string;
         last_name: string;
         organization_id?: string | null | undefined | undefined;
+        permissions: import("@tmlmobilidade/types").Permission<unknown>[];
+        phone?: string | null | undefined | undefined;
         preferences?: Record<string, Record<string, string | number | boolean | string[] | number[]>> | null | undefined;
         role_ids: string[];
         session_ids: string[];
@@ -74,16 +73,16 @@ declare class UsersClass extends MongoCollectionClass<User, CreateUserDto, Updat
         };
         created_by?: string | undefined | undefined;
         updated_by?: string | undefined | undefined;
-        phone?: string | null | undefined | undefined;
-        email: string;
-        permissions: import("@tmlmobilidade/types").Permission<unknown>[];
         active_notifications: string[];
         avatar?: string | null | undefined | undefined;
         bio?: string | null | undefined | undefined;
+        email: string;
         email_verified?: import("@tmlmobilidade/types").UnixTimestamp | null | undefined;
         first_name: string;
         last_name: string;
         organization_id?: string | null | undefined | undefined;
+        permissions: import("@tmlmobilidade/types").Permission<unknown>[];
+        phone?: string | null | undefined | undefined;
         preferences?: Record<string, Record<string, string | number | boolean | string[] | number[]>> | null | undefined;
         role_ids: string[];
         session_ids: string[];

package/dist/src/interfaces/auth/users.js

@@ -2,6 +2,7 @@
 import { MongoCollectionClass } from '../../mongo-collection.js';
 import { UpdateUserSchema, UserSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
+/* * */
 class UsersClass extends MongoCollectionClass {
     static _instance;
     createSchema = UserSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/interfaces",
-	"version": "20251006.1055.51",
+	"version": "20251006.1126.43",
 	"author": "João de Vasconcelos & Jusi Monteiro",
 	"license": "AGPL-3.0-or-later",
 	"homepage": "https://github.com/tmlmobilidade/services#readme",