Add metadata query resolvers (#1929)

* Add metadata queries resolvers

* remove hello field

* fix linter

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

@@ -1,3 +1,5 @@
+import { Field, ID, ObjectType } from '@nestjs/graphql';
+
 import {
   Column,
   CreateDateColumn,
@@ -7,6 +9,11 @@ import {
   PrimaryGeneratedColumn,
   UpdateDateColumn,
 } from 'typeorm';
+import {
+  Authorize,
+  IDField,
+  QueryOptions,
+} from '@ptc-org/nestjs-query-graphql';
 
 import { ObjectMetadata } from 'src/metadata/object-metadata/object-metadata.entity';
 
@@ -14,29 +21,47 @@ export type FieldMetadataTargetColumnMap = {
   [key: string]: string;
 };
 
+@ObjectType('field')
+@QueryOptions({
+  defaultResultSize: 10,
+  maxResultsSize: 100,
+  disableFilter: true,
+  disableSort: true,
+})
+@Authorize({
+  authorize: (context: any) => ({
+    workspaceId: { eq: context?.req?.user?.workspace?.id },
+  }),
+})
 @Entity('field_metadata')
 export class FieldMetadata {
+  @IDField(() => ID)
   @PrimaryGeneratedColumn('uuid')
   id: string;
 
   @Column({ nullable: false, name: 'object_id' })
   objectId: string;
 
+  @Field()
   @Column({ nullable: false })
   type: string;
 
+  @Field()
   @Column({ nullable: false, name: 'display_name' })
   displayName: string;
 
   @Column({ nullable: false, name: 'target_column_name' })
   targetColumnName: string;
 
+  @Field({ nullable: true })
   @Column({ nullable: true, name: 'description', type: 'text' })
   description: string;
 
+  @Field({ nullable: true })
   @Column({ nullable: true, name: 'icon' })
   icon: string;
 
+  @Field({ nullable: true })
   @Column({ nullable: true, name: 'placeholder' })
   placeholder: string;
 
@@ -46,12 +71,15 @@ export class FieldMetadata {
   @Column('text', { nullable: true, array: true })
   enums: string[];
 
+  @Field()
   @Column({ default: false, name: 'is_custom' })
   isCustom: boolean;
 
+  @Field()
   @Column({ default: false, name: 'is_active' })
   isActive: boolean;
 
+  @Field()
   @Column({ nullable: true, default: true, name: 'is_nullable' })
   isNullable: boolean;
 

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

@@ -1,11 +1,36 @@
 import { Module } from '@nestjs/common';
-import { TypeOrmModule } from '@nestjs/typeorm';
+
+import {
+  NestjsQueryGraphQLModule,
+  PagingStrategies,
+} from '@ptc-org/nestjs-query-graphql';
+import { NestjsQueryTypeOrmModule } from '@ptc-org/nestjs-query-typeorm';
+
+import { JwtAuthGuard } from 'src/guards/jwt.auth.guard';
 
 import { FieldMetadataService } from './field-metadata.service';
 import { FieldMetadata } from './field-metadata.entity';
 
 @Module({
-  imports: [TypeOrmModule.forFeature([FieldMetadata], 'metadata')],
+  imports: [
+    NestjsQueryGraphQLModule.forFeature({
+      imports: [
+        NestjsQueryTypeOrmModule.forFeature([FieldMetadata], 'metadata'),
+      ],
+      resolvers: [
+        {
+          EntityClass: FieldMetadata,
+          DTOClass: FieldMetadata,
+          enableTotalCount: true,
+          pagingStrategy: PagingStrategies.CURSOR,
+          create: { disabled: true },
+          update: { disabled: true },
+          delete: { disabled: true },
+          guards: [JwtAuthGuard],
+        },
+      ],
+    }),
+  ],
   providers: [FieldMetadataService],
   exports: [FieldMetadataService],
 })

server/src/metadata/metadata.resolver.ts

@@ -1,5 +1,5 @@
 import { UseGuards } from '@nestjs/common';
-import { Args, Mutation, Query, Resolver } from '@nestjs/graphql';
+import { Args, Mutation, Resolver } from '@nestjs/graphql';
 
 import { Workspace } from '@prisma/client';
 
@@ -15,11 +15,6 @@ import { CreateCustomFieldInput } from './args/create-custom-field.input';
 export class MetadataResolver {
   constructor(private readonly metadataService: MetadataService) {}
 
-  @Query(() => String)
-  async hello(): Promise<string> {
-    return 'Hello World!';
-  }
-
   @Mutation(() => String)
   async createCustomField(
     @Args() createCustomFieldInput: CreateCustomFieldInput,

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

@@ -1,3 +1,5 @@
+import { ObjectType, ID, Field } from '@nestjs/graphql';
+
 import {
   Column,
   CreateDateColumn,
@@ -6,11 +8,31 @@ import {
   PrimaryGeneratedColumn,
   UpdateDateColumn,
 } from 'typeorm';
+import {
+  Authorize,
+  CursorConnection,
+  IDField,
+  QueryOptions,
+} from '@ptc-org/nestjs-query-graphql';
 
 import { FieldMetadata } from 'src/metadata/field-metadata/field-metadata.entity';
 
+@ObjectType('object')
+@QueryOptions({
+  defaultResultSize: 10,
+  maxResultsSize: 100,
+  disableFilter: true,
+  disableSort: true,
+})
+@Authorize({
+  authorize: (context: any) => ({
+    workspaceId: { eq: context?.req?.user?.workspace?.id },
+  }),
+})
+@CursorConnection('fields', () => FieldMetadata)
 @Entity('object_metadata')
 export class ObjectMetadata {
+  @IDField(() => ID)
   @PrimaryGeneratedColumn('uuid')
   id: string;
 
@@ -18,27 +40,34 @@ export class ObjectMetadata {
   dataSourceId: string;
 
   // Deprecated
+  @Field()
   @Column({ nullable: false, name: 'display_name' })
   displayName: string;
 
+  @Field()
   @Column({ nullable: true, name: 'display_name_singular' })
   displayNameSingular: string;
 
+  @Field()
   @Column({ nullable: true, name: 'display_name_plural' })
   displayNamePlural: string;
 
+  @Field()
   @Column({ nullable: true, name: 'description', type: 'text' })
   description: string;
 
+  @Field()
   @Column({ nullable: true, name: 'icon' })
   icon: string;
 
   @Column({ nullable: false, name: 'target_table_name' })
   targetTableName: string;
 
+  @Field()
   @Column({ default: false, name: 'is_custom' })
   isCustom: boolean;
 
+  @Field()
   @Column({ default: false, name: 'is_active' })
   isActive: boolean;
 
@@ -48,9 +77,11 @@ export class ObjectMetadata {
   @OneToMany(() => FieldMetadata, (field) => field.object)
   fields: FieldMetadata[];
 
+  @Field()
   @CreateDateColumn({ name: 'created_at' })
   createdAt: Date;
 
+  @Field()
   @UpdateDateColumn({ name: 'updated_at' })
   updatedAt: Date;
 }

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

@@ -1,11 +1,36 @@
 import { Module } from '@nestjs/common';
-import { TypeOrmModule } from '@nestjs/typeorm';
+
+import {
+  NestjsQueryGraphQLModule,
+  PagingStrategies,
+} from '@ptc-org/nestjs-query-graphql';
+import { NestjsQueryTypeOrmModule } from '@ptc-org/nestjs-query-typeorm';
+
+import { JwtAuthGuard } from 'src/guards/jwt.auth.guard';
 
 import { ObjectMetadataService } from './object-metadata.service';
 import { ObjectMetadata } from './object-metadata.entity';
 
 @Module({
-  imports: [TypeOrmModule.forFeature([ObjectMetadata], 'metadata')],
+  imports: [
+    NestjsQueryGraphQLModule.forFeature({
+      imports: [
+        NestjsQueryTypeOrmModule.forFeature([ObjectMetadata], 'metadata'),
+      ],
+      resolvers: [
+        {
+          EntityClass: ObjectMetadata,
+          DTOClass: ObjectMetadata,
+          enableTotalCount: true,
+          pagingStrategy: PagingStrategies.CURSOR,
+          create: { disabled: true },
+          update: { disabled: true },
+          delete: { disabled: true },
+          guards: [JwtAuthGuard],
+        },
+      ],
+    }),
+  ],
   providers: [ObjectMetadataService],
   exports: [ObjectMetadataService],
 })

server/src/tenant/schema-generation/graphql-types/page-info.graphql-type.ts

@@ -1,9 +1,5 @@
-import {
-  GraphQLBoolean,
-  GraphQLNonNull,
-  GraphQLObjectType,
-  GraphQLString,
-} from 'graphql';
+import { ConnectionCursorScalar } from '@ptc-org/nestjs-query-graphql';
+import { GraphQLBoolean, GraphQLNonNull, GraphQLObjectType } from 'graphql';
 
 /**
  * GraphQL PageInfo type.
@@ -11,8 +7,8 @@ import {
 export const PageInfoType = new GraphQLObjectType({
   name: 'PageInfo',
   fields: {
-    startCursor: { type: GraphQLString },
-    endCursor: { type: GraphQLString },
+    startCursor: { type: ConnectionCursorScalar },
+    endCursor: { type: ConnectionCursorScalar },
     hasNextPage: { type: new GraphQLNonNull(GraphQLBoolean) },
     hasPreviousPage: { type: new GraphQLNonNull(GraphQLBoolean) },
   },