5622 add a syncemail onboarding step (#5689)

- add sync email onboarding step
- refactor calendar and email visibility enums
- add a new table `keyValuePair` in `core` schema
- add a new resolved boolean field `skipSyncEmail` in current user




https://github.com/twentyhq/twenty/assets/29927851/de791475-5bfe-47f9-8e90-76c349fba56f

packages/twenty-server/src/engine/core-modules/key-value-pair/key-value-pair.entity.ts

@@ -0,0 +1,62 @@
+import { Field, ObjectType } from '@nestjs/graphql';
+
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  JoinColumn,
+  ManyToOne,
+  PrimaryGeneratedColumn,
+  Relation,
+  Unique,
+  UpdateDateColumn,
+} from 'typeorm';
+import { IDField } from '@ptc-org/nestjs-query-graphql';
+
+import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
+import { User } from 'src/engine/core-modules/user/user.entity';
+import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
+
+@Entity({ name: 'keyValuePair', schema: 'core' })
+@ObjectType('KeyValuePair')
+@Unique('IndexOnKeyUserIdWorkspaceIdUnique', ['key', 'userId', 'workspaceId'])
+export class KeyValuePair {
+  @IDField(() => UUIDScalarType)
+  @PrimaryGeneratedColumn('uuid')
+  id: string;
+
+  @ManyToOne(() => User, (user) => user.keyValuePairs, {
+    onDelete: 'CASCADE',
+  })
+  @JoinColumn({ name: 'userId' })
+  user: Relation<User>;
+
+  @Column({ nullable: true })
+  userId: string;
+
+  @ManyToOne(() => Workspace, (workspace) => workspace.keyValuePairs, {
+    onDelete: 'CASCADE',
+  })
+  @JoinColumn({ name: 'workspaceId' })
+  workspace: Relation<Workspace>;
+
+  @Column({ nullable: true })
+  workspaceId: string;
+
+  @Field(() => String)
+  @Column({ nullable: false, type: 'text' })
+  key: string;
+
+  @Field(() => String, { nullable: true })
+  @Column({ nullable: true, type: 'text' })
+  value: string;
+
+  @CreateDateColumn({ type: 'timestamptz' })
+  createdAt: Date;
+
+  @UpdateDateColumn({ type: 'timestamptz' })
+  updatedAt: Date;
+
+  @Column({ nullable: true, type: 'timestamptz' })
+  deletedAt: Date | null;
+}

packages/twenty-server/src/engine/core-modules/key-value-pair/key-value-pair.module.ts

@@ -0,0 +1,22 @@
+import { Module } from '@nestjs/common';
+
+import { NestjsQueryGraphQLModule } from '@ptc-org/nestjs-query-graphql';
+import { NestjsQueryTypeOrmModule } from '@ptc-org/nestjs-query-typeorm';
+
+import { KeyValuePairService } from 'src/engine/core-modules/key-value-pair/key-value-pair.service';
+import { KeyValuePair } from 'src/engine/core-modules/key-value-pair/key-value-pair.entity';
+import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
+
+@Module({
+  imports: [
+    NestjsQueryGraphQLModule.forFeature({
+      imports: [
+        NestjsQueryTypeOrmModule.forFeature([KeyValuePair], 'core'),
+        TypeORMModule,
+      ],
+    }),
+  ],
+  exports: [KeyValuePairService],
+  providers: [KeyValuePairService],
+})
+export class KeyValuePairModule {}

packages/twenty-server/src/engine/core-modules/key-value-pair/key-value-pair.service.ts

@@ -0,0 +1,55 @@
+import { InjectRepository } from '@nestjs/typeorm';
+
+import { Repository } from 'typeorm';
+
+import { KeyValuePair } from 'src/engine/core-modules/key-value-pair/key-value-pair.entity';
+import { UserStates } from 'src/engine/core-modules/user-state/enums/user-states.enum';
+import { UserStateEmailSyncValues } from 'src/engine/core-modules/user-state/enums/user-state-email-sync-values.enum';
+
+export enum KeyValueTypes {
+  USER_STATE = 'USER_STATE',
+}
+
+type KeyValuePairs = {
+  [KeyValueTypes.USER_STATE]: {
+    [UserStates.SYNC_EMAIL_ONBOARDING_STEP]: UserStateEmailSyncValues;
+  };
+};
+
+export class KeyValuePairService<TYPE extends keyof KeyValuePairs> {
+  constructor(
+    @InjectRepository(KeyValuePair, 'core')
+    private readonly keyValuePairRepository: Repository<KeyValuePair>,
+  ) {}
+
+  async get<K extends keyof KeyValuePairs[TYPE]>(
+    userId: string,
+    workspaceId: string,
+    key: K,
+  ) {
+    return await this.keyValuePairRepository.findOne({
+      where: {
+        userId,
+        workspaceId,
+        key: key as string,
+      },
+    });
+  }
+
+  async set<K extends keyof KeyValuePairs[TYPE]>(
+    userId: string,
+    workspaceId: string,
+    key: K,
+    value: KeyValuePairs[TYPE][K],
+  ) {
+    await this.keyValuePairRepository.upsert(
+      {
+        userId,
+        workspaceId,
+        key: key as string,
+        value: value as string,
+      },
+      { conflictPaths: ['userId', 'workspaceId', 'key'] },
+    );
+  }
+}