Provide hook for IDs to be transformed/resolved within the validation layer

Author: CarsonF

src/common/id.arg.ts

@@ -1,6 +1,6 @@
 import { PipeTransform, Type } from '@nestjs/common';
 import { Args, ArgsOptions, ID as IdType } from '@nestjs/graphql';
-import { ValidateIdPipe } from './validators';
+import { ValidateIdPipe } from './validators/short-id.validator';
 
 export const IdArg = (
   opts: Partial<ArgsOptions> = {},

src/common/validators/index.ts

@@ -1,4 +1,4 @@
 export * from './email.validator';
 export * from './iana-timezone.validator';
 export * from './iso-3166-1-alpha-3.validator';
-export * from './short-id.validator';
+export { IsId } from './short-id.validator';

src/common/validators/short-id.validator.ts

@@ -1,28 +1,54 @@
-import { ArgumentMetadata, PipeTransform } from '@nestjs/common';
-import { ValidationOptions } from 'class-validator';
+import { ArgumentMetadata, Injectable, PipeTransform } from '@nestjs/common';
+import {
+  ValidationArguments,
+  ValidationOptions,
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
+} from 'class-validator';
 import { ValidationException } from '~/core/validation';
 import { isValidId } from '../generate-id';
+import { ID } from '../id-field';
 import { ValidateBy } from './validateBy';
 
 export const IsId = (validationOptions?: ValidationOptions) =>
-  ValidateBy(
-    {
-      name: 'IsId',
-      validator: {
-        validate: isValidId,
-        defaultMessage: () =>
-          validationOptions?.each
-            ? 'Each value in $property must be a valid ID'
-            : 'Invalid ID',
-      },
-    },
-    validationOptions,
-  );
+  ValidateBy(ValidIdConstraint, {
+    message: validationOptions?.each
+      ? 'Each value in $property must be a valid ID'
+      : 'Invalid ID',
+    ...validationOptions,
+  });
+
+@Injectable()
+export class IdResolver {
+  async resolve(value: ID): Promise<ID> {
+    return value;
+  }
+}
+
+@Injectable()
+@ValidatorConstraint({ name: 'IsId', async: true })
+export class ValidIdConstraint implements ValidatorConstraintInterface {
+  constructor(private readonly resolver: IdResolver) {}
 
+  async validate(value: unknown, args: ValidationArguments) {
+    if (isValidId(value)) {
+      (args.object as any)[args.property] = await this.resolver.resolve(value);
+      return true;
+    }
+    return false;
+  }
+}
+
+@Injectable()
 export class ValidateIdPipe implements PipeTransform {
+  constructor(private readonly resolver: IdResolver) {}
+
   transform(id: unknown, metadata: ArgumentMetadata) {
-    if (id == null || isValidId(id)) {
-      return id;
+    if (id == null) {
+      return null;
+    }
+    if (isValidId(id)) {
+      return this.resolver.resolve(id);
     }
     throw new ValidationException([
       {

src/components/changeset/changeset.arg.ts

@@ -7,14 +7,10 @@ import {
 import { Args, ArgsOptions, ID as IDType } from '@nestjs/graphql';
 import { Resolver } from '@nestjs/graphql/dist/enums/resolver.enum.js';
 import { RESOLVER_TYPE_METADATA as TypeKey } from '@nestjs/graphql/dist/graphql.constants.js';
-import {
-  ID,
-  InputException,
-  ServerException,
-  ValidateIdPipe,
-} from '../../common';
-import { createAugmentedMetadataPipe } from '../../common/augmented-metadata.pipe';
-import { ResourceLoader } from '../../core';
+import { ID, InputException, ServerException } from '~/common';
+import { createAugmentedMetadataPipe } from '~/common/augmented-metadata.pipe';
+import { ValidateIdPipe } from '~/common/validators/short-id.validator';
+import { ResourceLoader } from '~/core/resources';
 
 const pipeMetadata = createAugmentedMetadataPipe<{
   mutation: boolean;

src/core/validation/validation.module.ts

@@ -1,14 +1,22 @@
 import { Module } from '@nestjs/common';
 import { APP_PIPE } from '@nestjs/core';
 import { Validator } from 'class-validator';
+import {
+  IdResolver,
+  ValidateIdPipe,
+  ValidIdConstraint,
+} from '~/common/validators/short-id.validator';
 import { ValidationPipe } from './validation.pipe';
 
 @Module({
   providers: [
     Validator,
     ValidationPipe,
     { provide: APP_PIPE, useExisting: ValidationPipe },
+    ValidIdConstraint,
+    ValidateIdPipe,
+    IdResolver,
   ],
-  exports: [ValidationPipe],
+  exports: [ValidationPipe, ValidateIdPipe, IdResolver],
 })
 export class ValidationModule {}