@tmlmobilidade/interfaces 20251218.110.37 → 20251222.1537.24

package/dist/common/mongo-collection.d.ts

@@ -131,9 +131,9 @@ export declare abstract class MongoCollectionClass<T extends Document, TCreate,
     }): Promise<InsertManyResult<T>>;
     /**
      * Inserts a single document into the collection.
-     * @param doc - The document to insert
-     * @param options - The options for the insert operation
-     * @returns A promise that resolves to the result of the insert operation
+     * @param doc The document to insert.
+     * @param options The options for the insert operation.
+     * @returns A promise that resolves to the result of the insert operation.
      */
     insertOne<TReturnDocument extends boolean = true>(doc: TCreate & {
         _id?: string;

package/dist/common/mongo-collection.js

@@ -231,47 +231,57 @@ export class MongoCollectionClass {
     }
     /**
      * Inserts a single document into the collection.
-     * @param doc - The document to insert
-     * @param options - The options for the insert operation
-     * @returns A promise that resolves to the result of the insert operation
+     * @param doc The document to insert.
+     * @param options The options for the insert operation.
+     * @returns A promise that resolves to the result of the insert operation.
      */
     async insertOne(doc, { options, unsafe = false } = {}) {
-        const newDocument = {
-            ...doc,
-            _id: doc._id || generateRandomString({ length: 5 }),
-            created_at: doc.created_at || Dates.now('utc').unix_timestamp,
-            created_by: doc.created_by || 'system',
-            updated_at: doc.updated_at || Dates.now('utc').unix_timestamp,
-            updated_by: doc.updated_by || 'system',
-        };
-        if (!doc._id) {
-            while (await this.findById(newDocument._id)) {
-                newDocument._id = generateRandomString({ length: 5 });
-            }
-        }
-        let parsedDocument = newDocument;
+        // Setup a copy of the document to be inserted
+        let parsedDocument = { ...doc };
+        // Validate the document against the create schema if unsafe is false
         if (!unsafe) {
             try {
-                if (!this.createSchema) {
+                // If no create schema is defined, throw an error.
+                // In safe mode, a schema is required to validate the document.
+                if (!this.createSchema)
                     throw new Error('No schema defined for insert operation. This is either an internal interface error or you should pass unsafe=true to the insert operation.');
-                }
-                parsedDocument = this.createSchema.parse(newDocument);
+                // Validate the document against the create schema
+                parsedDocument = this.createSchema.parse(parsedDocument);
             }
             catch (error) {
                 throw new HttpException(HttpStatus.BAD_REQUEST, error.message, { cause: error });
             }
         }
+        // Add default fields if they are missing from the original document
+        if (!doc.created_at)
+            parsedDocument.created_at = Dates.now('utc').unix_timestamp;
+        if (!doc.created_by)
+            parsedDocument.created_by = 'system';
+        if (!doc.updated_at)
+            parsedDocument.updated_at = Dates.now('utc').unix_timestamp;
+        if (!doc.updated_by)
+            parsedDocument.updated_by = 'system';
+        // Add the ID if it is missing from the original document
+        // If the document is missing any default fields, add them
+        if (!doc._id) {
+            parsedDocument._id = generateRandomString({ length: 5 });
+            while (await this.findById(parsedDocument._id)) {
+                parsedDocument._id = generateRandomString({ length: 5 });
+            }
+        }
+        // Attempt to insert the document into the collection
         const result = await this.mongoCollection.insertOne(parsedDocument, options);
-        if (!result.acknowledged) {
+        // Check if the insert operation was acknowledged
+        if (!result.acknowledged)
             throw new HttpException(HttpStatus.INTERNAL_SERVER_ERROR, 'Failed to insert document', result);
-        }
+        // If returnResult is false, return the insert result directly
         if (options && options.returnResult === false)
             return result;
-        const inserted_doc = await this.findOne({ _id: { $eq: result.insertedId } }, options);
-        if (!inserted_doc) {
+        // Otherwise, fetch and return the inserted document
+        const insertedDoc = await this.findOne({ _id: { $eq: result.insertedId } }, options);
+        if (!insertedDoc)
             throw new HttpException(HttpStatus.INTERNAL_SERVER_ERROR, 'Failed to find inserted document', result);
-        }
-        return inserted_doc;
+        return insertedDoc;
     }
     /**
      * Checks if a document with the given ID is locked or not.

package/dist/interfaces/auth/verification-tokens.d.ts

@@ -1,5 +1,5 @@
 import { MongoCollectionClass } from '../../common/mongo-collection.js';
-import { CreateVerificationTokenDto, UpdateVerificationTokenDto, VerificationToken } from '@tmlmobilidade/types';
+import { type CreateVerificationTokenDto, type UpdateVerificationTokenDto, type VerificationToken } from '@tmlmobilidade/types';
 import { IndexDescription } from 'mongodb';
 import { z } from 'zod';
 declare class VerificationTokensClass extends MongoCollectionClass<VerificationToken, CreateVerificationTokenDto, UpdateVerificationTokenDto> {
@@ -10,9 +10,8 @@ declare class VerificationTokensClass extends MongoCollectionClass<VerificationT
     static getInstance(): Promise<VerificationTokensClass>;
     /**
      * Finds a verification token by its token.
-     *
-     * @param token - The token to find
-     * @returns The verification token or null if not found
+     * @param token The token to find.
+     * @returns The verification token or null if not found.
      */
     findByToken(token: string): Promise<import("mongodb").WithId<{
         _id: string;

package/dist/interfaces/auth/verification-tokens.js

@@ -1,12 +1,12 @@
 /* * */
 import { MongoCollectionClass } from '../../common/mongo-collection.js';
-import { VerificationTokenSchema } from '@tmlmobilidade/types';
+import { CreateVerificationTokenSchema, UpdateVerificationTokenSchema } from '@tmlmobilidade/types';
 import { AsyncSingletonProxy } from '@tmlmobilidade/utils';
 /* * */
 class VerificationTokensClass extends MongoCollectionClass {
     static _instance;
-    createSchema = VerificationTokenSchema;
-    updateSchema = VerificationTokenSchema;
+    createSchema = CreateVerificationTokenSchema;
+    updateSchema = UpdateVerificationTokenSchema;
     constructor() {
         super();
     }
@@ -20,9 +20,8 @@ class VerificationTokensClass extends MongoCollectionClass {
     }
     /**
      * Finds a verification token by its token.
-     *
-     * @param token - The token to find
-     * @returns The verification token or null if not found
+     * @param token The token to find.
+     * @returns The verification token or null if not found.
      */
     async findByToken(token) {
         return this.findOne({ token });

package/dist/providers/auth/auth.js

@@ -150,15 +150,13 @@ class AuthProvider {
      */
     async register(createUserDto) {
         // Insert the new user into the database with the provided data
-        const insertNewUserResult = await users.insertOne({ ...createUserDto });
+        const insertNewUserResult = await users.insertOne(createUserDto);
         // Generate a random token that will be used to verify the user
         const verificationToken = generateRandomToken();
         // Insert the verification token into the database
         await verificationTokens.insertOne({
-            created_by: 'system',
             expires_at: Dates.now('utc').plus({ days: 7 }).unix_timestamp,
             token: verificationToken,
-            updated_by: 'system',
             user_id: insertNewUserResult._id,
         });
         // Send a welcome email to the user with the verification token

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/interfaces",
-	"version": "20251218.110.37",
+	"version": "20251222.1537.24",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"
@@ -46,8 +46,8 @@
 		"@tmlmobilidade/strings": "*",
 		"@tmlmobilidade/utils": "*",
 		"bcryptjs": "3.0.3",
-		"oci-common": "2.122.1",
-		"oci-objectstorage": "2.122.1",
+		"oci-common": "2.122.2",
+		"oci-objectstorage": "2.122.2",
 		"zod": "3.25.76"
 	},
 	"devDependencies": {