Add targetColumnMap to FieldMetadata (#1863)

* Add targetColumnMap to FieldMetadata

* fix

* remove console.log

* fix test

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

@@ -10,6 +10,10 @@ import {
 
 import { ObjectMetadata } from 'src/metadata/object-metadata/object-metadata.entity';
 
+export type FieldMetadataTargetColumnMap = {
+  [key: string]: string;
+};
+
 @Entity('field_metadata')
 export class FieldMetadata {
   @PrimaryGeneratedColumn('uuid')
@@ -27,12 +31,27 @@ export class FieldMetadata {
   @Column({ nullable: false, name: 'target_column_name' })
   targetColumnName: string;
 
+  @Column({ nullable: true, name: 'description', type: 'text' })
+  description: string;
+
+  @Column({ nullable: true, name: 'icon' })
+  icon: string;
+
+  @Column({ nullable: true, name: 'placeholder' })
+  placeholder: string;
+
+  @Column({ nullable: true, name: 'target_column_map', type: 'jsonb' })
+  targetColumnMap: FieldMetadataTargetColumnMap;
+
   @Column('text', { nullable: true, array: true })
   enums: string[];
 
   @Column({ default: false, name: 'is_custom' })
   isCustom: boolean;
 
+  @Column({ default: false, name: 'is_active' })
+  isActive: boolean;
+
   @Column({ nullable: true, default: true, name: 'is_nullable' })
   isNullable: boolean;
 

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

@@ -4,7 +4,10 @@ import { InjectRepository } from '@nestjs/typeorm';
 import { Repository } from 'typeorm';
 
 import { FieldMetadata } from './field-metadata.entity';
-import { generateColumnName } from './field-metadata.util';
+import {
+  generateColumnName,
+  generateTargetColumnMap,
+} from './field-metadata.util';
 
 @Injectable()
 export class FieldMetadataService {
@@ -14,22 +17,23 @@ export class FieldMetadataService {
   ) {}
 
   public async createFieldMetadata(
-    name: string,
+    displayName: string,
     type: string,
     objectId: string,
     workspaceId: string,
   ): Promise<FieldMetadata> {
     return await this.fieldMetadataRepository.save({
-      displayName: name,
+      displayName: displayName,
       type,
       objectId,
       isCustom: true,
-      targetColumnName: generateColumnName(name),
+      targetColumnName: generateColumnName(displayName), // deprecated
       workspaceId,
+      targetColumnMap: generateTargetColumnMap(type),
     });
   }
 
-  public async getFieldMetadataByNameAndObjectId(
+  public async getFieldMetadataByDisplayNameAndObjectId(
     name: string,
     objectId: string,
   ): Promise<FieldMetadata | null> {

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

@@ -1,3 +1,9 @@
+import { v4 } from 'uuid';
+
+import { uuidToBase36 } from 'src/metadata/data-source/data-source.util';
+
+import { FieldMetadataTargetColumnMap } from './field-metadata.entity';
+
 /**
  * Generate a column name from a field name removing unsupported characters.
  *
@@ -7,3 +13,38 @@
 export function generateColumnName(name: string): string {
   return name.toLowerCase().replace(/ /g, '_');
 }
+
+/**
+ * Generate a target column map for a given type, this is used to map the field to the correct column(s) in the database.
+ * This is used to support fields that map to multiple columns in the database.
+ *
+ * @param type string
+ * @returns FieldMetadataTargetColumnMap
+ */
+export function generateTargetColumnMap(
+  type: string,
+): FieldMetadataTargetColumnMap {
+  switch (type) {
+    case 'text':
+    case 'phone':
+    case 'email':
+    case 'number':
+    case 'boolean':
+    case 'date':
+      return {
+        value: uuidToBase36(v4()),
+      };
+    case 'url':
+      return {
+        text: uuidToBase36(v4()),
+        link: uuidToBase36(v4()),
+      };
+    case 'money':
+      return {
+        amount: uuidToBase36(v4()),
+        currency: uuidToBase36(v4()),
+      };
+    default:
+      throw new Error(`Unknown type ${type}`);
+  }
+}