Add a dedicated GQL server for metadata available on /meta (#1820)

server/src/metadata/field-metadata/field-metadata.entity.ts

@@ -0,0 +1,51 @@
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  JoinColumn,
+  ManyToOne,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm';
+
+import { ObjectMetadata } from 'src/metadata/object-metadata/object-metadata.entity';
+
+@Entity('field_metadata')
+export class FieldMetadata {
+  @PrimaryGeneratedColumn('uuid')
+  id: string;
+
+  @Column({ nullable: false, name: 'object_id' })
+  objectId: string;
+
+  @Column({ nullable: false })
+  type: string;
+
+  @Column({ nullable: false, name: 'display_name' })
+  displayName: string;
+
+  @Column({ nullable: false, name: 'target_column_name' })
+  targetColumnName: string;
+
+  @Column('text', { nullable: true, array: true })
+  enums: string[];
+
+  @Column({ default: false, name: 'is_custom' })
+  isCustom: boolean;
+
+  @Column({ nullable: true, default: true, name: 'is_nullable' })
+  isNullable: boolean;
+
+  @Column({ nullable: false, name: 'workspace_id' })
+  workspaceId: string;
+
+  @ManyToOne(() => ObjectMetadata, (object) => object.fields)
+  @JoinColumn({ name: 'object_id' })
+  object: ObjectMetadata;
+
+  @CreateDateColumn({ name: 'created_at' })
+  createdAt: Date;
+
+  @UpdateDateColumn({ name: 'updated_at' })
+  updatedAt: Date;
+}

server/src/metadata/field-metadata/field-metadata.module.ts

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+
+import { FieldMetadataService } from './field-metadata.service';
+import { FieldMetadata } from './field-metadata.entity';
+
+@Module({
+  imports: [TypeOrmModule.forFeature([FieldMetadata], 'metadata')],
+  providers: [FieldMetadataService],
+  exports: [FieldMetadataService],
+})
+export class FieldMetadataModule {}

server/src/metadata/field-metadata/field-metadata.service.spec.ts

@@ -0,0 +1,27 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { getRepositoryToken } from '@nestjs/typeorm';
+
+import { FieldMetadataService } from './field-metadata.service';
+import { FieldMetadata } from './field-metadata.entity';
+
+describe('FieldMetadataService', () => {
+  let service: FieldMetadataService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        FieldMetadataService,
+        {
+          provide: getRepositoryToken(FieldMetadata, 'metadata'),
+          useValue: {},
+        },
+      ],
+    }).compile();
+
+    service = module.get<FieldMetadataService>(FieldMetadataService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});

server/src/metadata/field-metadata/field-metadata.service.ts

@@ -0,0 +1,40 @@
+import { Injectable } from '@nestjs/common';
+import { InjectRepository } from '@nestjs/typeorm';
+
+import { Repository } from 'typeorm';
+
+import { FieldMetadata } from './field-metadata.entity';
+import { generateColumnName } from './field-metadata.util';
+
+@Injectable()
+export class FieldMetadataService {
+  constructor(
+    @InjectRepository(FieldMetadata, 'metadata')
+    private readonly fieldMetadataRepository: Repository<FieldMetadata>,
+  ) {}
+
+  public async createFieldMetadata(
+    name: string,
+    type: string,
+    objectId: string,
+    workspaceId: string,
+  ): Promise<FieldMetadata> {
+    return await this.fieldMetadataRepository.save({
+      displayName: name,
+      type,
+      objectId,
+      isCustom: true,
+      targetColumnName: generateColumnName(name),
+      workspaceId,
+    });
+  }
+
+  public async getFieldMetadataByNameAndObjectId(
+    name: string,
+    objectId: string,
+  ): Promise<FieldMetadata | null> {
+    return await this.fieldMetadataRepository.findOne({
+      where: { displayName: name, objectId },
+    });
+  }
+}

server/src/metadata/field-metadata/field-metadata.util.ts

@@ -0,0 +1,9 @@
+/**
+ * Generate a column name from a field name removing unsupported characters.
+ *
+ * @param name string
+ * @returns string
+ */
+export function generateColumnName(name: string): string {
+  return name.toLowerCase().replace(/ /g, '_');
+}