twenty/packages/twenty-server/src/engine/metadata-modules/object-metadata/dtos/object-metadata.dto.ts

import { Field, HideField, ObjectType } from '@nestjs/graphql';

import {
  Authorize,
  CursorConnection,
  FilterableField,
  IDField,
  QueryOptions,
} from '@ptc-org/nestjs-query-graphql';

import { type WorkspaceEntityDuplicateCriteria } from 'src/engine/api/graphql/workspace-query-builder/types/workspace-entity-duplicate-criteria.type';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
import { FieldMetadataDTO } from 'src/engine/metadata-modules/field-metadata/dtos/field-metadata.dto';
import { IndexMetadataDTO } from 'src/engine/metadata-modules/index-metadata/dtos/index-metadata.dto';
import { type ObjectMetadataOverrides } from 'src/engine/metadata-modules/object-metadata/types/object-metadata-overrides.type';

@ObjectType('Object')
@Authorize({
  // oxlint-disable-next-line typescript/no-explicit-any
  authorize: (context: any) => ({
    workspaceId: { eq: context?.req?.workspace?.id },
  }),
})
@QueryOptions({
  defaultResultSize: 10,
  disableSort: true,
  maxResultsSize: 1000,
})
@CursorConnection('fields', () => FieldMetadataDTO)
@CursorConnection('indexMetadatas', () => IndexMetadataDTO)
export class ObjectMetadataDTO {
  @IDField(() => UUIDScalarType)
  id: string;

  @Field()
  universalIdentifier: string;

  @Field()
  nameSingular: string;

  @Field()
  namePlural: string;

  @Field()
  labelSingular: string;

  @Field()
  labelPlural: string;

  @Field({ nullable: true })
  description?: string;

  @Field({ nullable: true })
  icon?: string;

  @HideField()
  overrides?: ObjectMetadataOverrides | null;

  @Field({ nullable: true })
  shortcut?: string;

  @Field({ nullable: true })
  color?: string;

  @FilterableField()
  isRemote: boolean;

  @FilterableField()
  isActive: boolean;

  @FilterableField()
  isSystem: boolean;

  @FilterableField()
  isUIEditable: boolean;

  @FilterableField()
  isUICreatable: boolean;

  // Deprecated alias kept for one release: stays filterable so ObjectFilter
  // keeps its isUIReadOnly member and external API consumers are not broken.
  @FilterableField({
    deprecationReason: 'Use isUIEditable',
  })
  isUIReadOnly: boolean;

  @FilterableField()
  isSearchable: boolean;

  @HideField()
  workspaceId: string;

  @Field(() => UUIDScalarType)
  applicationId: string;

  @Field()
  createdAt: Date;

  @Field()
  updatedAt: Date;

  @Field(() => UUIDScalarType, { nullable: true })
  labelIdentifierFieldMetadataId?: string | null;

  @Field(() => UUIDScalarType, { nullable: true })
  imageIdentifierFieldMetadataId?: string | null;

  @Field()
  isLabelSyncedWithName: boolean;

  @Field(() => [[String]], { nullable: true })
  duplicateCriteria?: WorkspaceEntityDuplicateCriteria[];
}