Split out DTOs into separate files

Author: CarsonF

src/components/progress-report/media/dto/index.ts

@@ -0,0 +1,3 @@
+export * from './media.dto';
+export * from './media-list.dto';
+export * from './upload.dto';

src/components/progress-report/media/dto/media-list.dto.ts

@@ -0,0 +1,30 @@
+import { InputType, ObjectType } from '@nestjs/graphql';
+import {
+  PaginatedList,
+  SortablePaginationInput,
+  Variant,
+  VariantInputField,
+} from '~/common';
+import { ProgressReport } from '../../dto';
+import { MediaVariant, ProgressReportMedia } from './media.dto';
+
+@InputType()
+export class ProgressReportMediaListInput extends SortablePaginationInput<
+  'createdAt' | 'variant'
+>({
+  defaultSort: 'createdAt',
+}) {
+  @VariantInputField(ProgressReportMedia, {
+    nullable: true,
+    many: true,
+    description: 'Filter to these specific variants',
+  })
+  variants?: ReadonlyArray<Variant<MediaVariant>>;
+}
+
+@ObjectType()
+export class ProgressReportMediaList extends PaginatedList(
+  ProgressReportMedia,
+) {
+  readonly report: ProgressReport;
+}

src/components/progress-report/media/dto/media.dto.ts

@@ -0,0 +1,64 @@
+import { Field, InputType, ObjectType } from '@nestjs/graphql';
+import { setOf } from '@seedcompany/common';
+import { keys as keysOf } from 'ts-transformer-keys';
+import {
+  IdField,
+  IdOf,
+  Resource,
+  SecuredProps,
+  Variant,
+  VariantOf,
+} from '~/common';
+import { SetDbType } from '~/core';
+import { RegisterResource } from '~/core/resources';
+import { FileId, Media } from '../../../file';
+import { User } from '../../../user';
+import { ProgressReport } from '../../dto';
+import { ProgressReportHighlight } from '../../dto/highlights.dto';
+import { MediaCategory } from '../media-category.enum';
+
+export type VariantGroup = IdOf<'ProgressReportMediaVariantGroup'>;
+
+@RegisterResource()
+@InputType({ isAbstract: true })
+@ObjectType()
+export class ProgressReportMedia extends Resource {
+  static Props = keysOf<ProgressReportMedia>();
+  static SecuredProps = keysOf<SecuredProps<ProgressReportMedia>>();
+  static BaseNodeProps = [...Resource.Props, 'category', 'creator', 'variant'];
+  static readonly Parent = import('../../dto/progress-report.entity').then(
+    (m) => m.ProgressReport,
+  );
+  static readonly ConfirmThisClassPassesSensitivityToPolicies = true;
+
+  static Variants = ProgressReportHighlight.Variants;
+  // Only the last variant is publicly visible (accessible by anyone anonymously)
+  // Saved in DB, so adjust with caution
+  static PublicVariants = setOf(
+    ProgressReportHighlight.Variants.slice(-1).map((v) => v.key),
+  );
+
+  readonly report: IdOf<ProgressReport>;
+
+  @Field(() => Variant)
+  readonly variant: Variant<MediaVariant> & SetDbType<MediaVariant>;
+
+  @Field(() => MediaCategory, { nullable: true })
+  readonly category?: MediaCategory | null;
+
+  readonly media: IdOf<Media>;
+  readonly file: FileId;
+
+  @IdField()
+  readonly variantGroup: VariantGroup;
+
+  readonly creator: IdOf<User>;
+}
+
+export type MediaVariant = VariantOf<typeof ProgressReportMedia>;
+
+declare module '~/core/resources/map' {
+  interface ResourceMap {
+    ProgressReportMedia: typeof ProgressReportMedia;
+  }
+}

src/components/progress-report/media/dto/upload.dto.ts

@@ -0,0 +1,51 @@
+import { Field, InputType } from '@nestjs/graphql';
+import { stripIndent } from 'common-tags';
+import {
+  IdField,
+  IdOf,
+  IntersectionType as Merge,
+  PickType,
+  Variant,
+  VariantInputField,
+} from '~/common';
+import {
+  CreateDefinedFileVersionInput,
+  MediaUserMetadata,
+} from '../../../file';
+import { ProgressReport } from '../../dto';
+import { MediaVariant, ProgressReportMedia, VariantGroup } from './media.dto';
+
+@InputType()
+export class UploadProgressReportMedia extends PickType(ProgressReportMedia, [
+  'category',
+]) {
+  @IdField()
+  readonly reportId: IdOf<ProgressReport>;
+
+  @Field()
+  readonly file: CreateDefinedFileVersionInput;
+
+  @VariantInputField(ProgressReportMedia)
+  readonly variant: Variant<MediaVariant>;
+
+  @IdField({
+    description: stripIndent`
+      Associate this media with an existing set of media.
+      Idea being the "same image" across multiple variants.
+      Group might not be the best name for this.
+
+      If none is given a new group will be created.
+    `,
+    nullable: true,
+  })
+  readonly variantGroup?: VariantGroup;
+}
+
+@InputType()
+export class UpdateProgressReportMedia extends Merge(
+  PickType(ProgressReportMedia, ['category']),
+  MediaUserMetadata,
+) {
+  @IdField()
+  readonly id: IdOf<ProgressReportMedia>;
+}

src/components/progress-report/media/handlers/update-media-metadata-check.handler.ts

@@ -1,7 +1,7 @@
 import { EventsHandler, GqlContextHost, ResourceLoader } from '~/core';
 import { Privileges } from '../../../authorization';
 import { CanUpdateMediaUserMetadataEvent } from '../../../file/media/events/can-update-event';
-import { ProgressReportMedia as ReportMedia } from '../media.dto';
+import { ProgressReportMedia as ReportMedia } from '../dto';
 
 @EventsHandler(CanUpdateMediaUserMetadataEvent)
 export class ProgressReportUpdateMediaMetadataCheckHandler {

src/components/progress-report/media/media.dto.ts

@@ -2,7 +2,7 @@ import { DataLoaderOptions } from '@seedcompany/data-loader';
 import { IdOf } from '~/common';
 import { LoaderFactory, SessionAwareLoaderStrategy } from '~/core';
 import { ProgressReport } from '../dto';
-import { ProgressReportMedia as ReportMedia } from './media.dto';
+import { ProgressReportMedia as ReportMedia } from './dto';
 import { ProgressReportMediaService } from './progress-report-media.service';
 
 @LoaderFactory()

src/components/progress-report/media/progress-report-featured-media.loader.ts

@@ -1,7 +1,7 @@
 import { forwardRef, Inject } from '@nestjs/common';
 import { IdOf } from '~/common';
 import { LoaderFactory, SessionAwareLoaderStrategy } from '~/core';
-import { ProgressReportMedia as ReportMedia } from './media.dto';
+import { ProgressReportMedia as ReportMedia } from './dto';
 import { ProgressReportMediaService } from './progress-report-media.service';
 
 @LoaderFactory(() => ReportMedia)

src/components/progress-report/media/progress-report-media.loader.ts

@@ -33,7 +33,7 @@ import {
   ProgressReportMedia as ReportMedia,
   UpdateProgressReportMedia as UpdateMedia,
   UploadProgressReportMedia as UploadMedia,
-} from './media.dto';
+} from './dto';
 
 @Injectable()
 export class ProgressReportMediaRepository extends DtoRepository<

src/components/progress-report/media/progress-report-media.repository.ts

@@ -17,7 +17,7 @@ import {
   ProgressReportMediaList as ReportMediaList,
   UpdateProgressReportMedia as UpdateMedia,
   UploadProgressReportMedia as UploadMedia,
-} from './media.dto';
+} from './dto';
 import { ProgressReportMediaLoader } from './progress-report-media.loader';
 import { ProgressReportMediaRepository } from './progress-report-media.repository';