Merge pull request #39 from DouglasNeuroInformatics/dev

feat: add ValidObjectIdPipe

Author: joshunrau

src/index.ts

@@ -40,6 +40,7 @@ export type { VirtualizationModuleOptions } from './modules/virtualization/virtu
 export { VirtualizationModule } from './modules/virtualization/virtualization.module.js';
 export { VirtualizationService } from './modules/virtualization/virtualization.service.js';
 export { ParseSchemaPipe } from './pipes/parse-schema.pipe.js';
+export { ValidObjectIdPipe } from './pipes/valid-object-id.pipe.js';
 export { $BaseEnv } from './schemas/env.schema.js';
 export type { BaseEnv } from './schemas/env.schema.js';
 export type { BaseEnvSchema } from './utils/env.utils.js';

src/pipes/__tests__/valid-object-id.pipe.test.ts

@@ -0,0 +1,18 @@
+import { BadRequestException } from '@nestjs/common';
+import { ObjectId } from 'mongodb';
+import { describe, expect, it } from 'vitest';
+
+import { ValidObjectIdPipe } from '../valid-object-id.pipe.js';
+
+describe('ValidObjectIdPipe', () => {
+  it('should return the input value if it is a valid object id', () => {
+    const pipe = new ValidObjectIdPipe();
+    const value = new ObjectId().toString();
+    expect(pipe.transform(value)).toEqual(value);
+  });
+  it('should throw BadRequestException if validation fails', () => {
+    const pipe = new ValidObjectIdPipe();
+    const value = crypto.randomUUID();
+    expect(() => pipe.transform(value)).toThrow(BadRequestException);
+  });
+});

src/pipes/valid-object-id.pipe.ts

@@ -0,0 +1,13 @@
+import { BadRequestException, Injectable } from '@nestjs/common';
+import type { PipeTransform } from '@nestjs/common';
+import { ObjectId } from 'mongodb';
+
+@Injectable()
+export class ValidObjectIdPipe implements PipeTransform<string> {
+  transform(value: unknown): string {
+    if (!(typeof value === 'string' && ObjectId.isValid(value))) {
+      throw new BadRequestException(`Invalid ObjectID: ${String(value)}`);
+    }
+    return value;
+  }
+}