Create Tool module

Co-authored-by: Rob Donigian <[email protected]>

Author: CarsonF

dbschema/tool.gel

@@ -0,0 +1,11 @@
+module default {
+  type Tool extending Resource, Mixin::Named {
+    overloaded name {
+      constraint exclusive;
+    }
+
+    required aiBased: bool {
+      default := false;
+    };
+  }
+}

src/app.module.ts

@@ -38,6 +38,7 @@ import { ScriptureModule } from './components/scripture';
 import { SearchModule } from './components/search/search.module';
 import { StoryModule } from './components/story/story.module';
 import { TimeZoneModule } from './components/timezone';
+import { ToolModule } from './components/tools/tool.module';
 import { UserModule } from './components/user/user.module';
 import { CoreModule, LoggerModule } from './core';
 
@@ -90,6 +91,7 @@ if (process.env.NODE_ENV !== 'production') {
     SystemNotificationModule,
     FinanceDepartmentModule,
     DBLUploadNotificationModule,
+    ToolModule,
   ],
 })
 export class AppModule {}

src/components/authorization/policies/by-feature/read-util-objects.policy.ts

@@ -8,5 +8,7 @@ import { Policy } from '../util';
   // If anyone is able to read the post, then they can read its properties as well.
   // These are declared via `XPostable.children(c => c.posts.read)`
   r.Post.specifically((p) => p.many('body', 'creator').read),
+
+  r.Tool.read,
 ])
 export class ReadUtilObjectsPolicy {}

src/components/search/dto/search-results.dto.ts

@@ -32,6 +32,7 @@ import {
   TranslationProject,
 } from '../../project/dto';
 import { Story } from '../../story/dto';
+import { Tool } from '../../tools/tool/dto';
 import { User } from '../../user/dto';
 
 // A mapping of searchable types to their results. Expand as needed.
@@ -58,6 +59,7 @@ const publicSearchable = {
   ProgressReport,
   FinancialReport,
   NarrativeReport,
+  Tool,
 } as const;
 
 // Same as above, but the keys are ignored from the SearchType enum,

src/components/tools/tool.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { ToolCoreModule } from './tool/tool.module';
+
+const submodules = [ToolCoreModule];
+
+@Module({
+  imports: submodules,
+  exports: submodules,
+})
+export class ToolModule {}

src/components/tools/tool/dto/create-tool.dto.ts

@@ -0,0 +1,18 @@
+import { Field, InputType, ObjectType } from '@nestjs/graphql';
+import { NameField } from '~/common';
+import { Tool } from './tool.dto';
+
+@InputType()
+export abstract class CreateTool {
+  @NameField()
+  readonly name: string;
+
+  @Field()
+  readonly aiBased: boolean = false;
+}
+
+@ObjectType()
+export abstract class CreateToolOutput {
+  @Field()
+  readonly tool: Tool;
+}

src/components/tools/tool/dto/delete-tool.dto.ts

@@ -0,0 +1,5 @@
+import { ObjectType } from '@nestjs/graphql';
+import { MutationPlaceholderOutput } from '~/common';
+
+@ObjectType()
+export abstract class DeleteToolOutput extends MutationPlaceholderOutput {}

src/components/tools/tool/dto/index.ts

@@ -0,0 +1,5 @@
+export * from './tool.dto';
+export * from './create-tool.dto';
+export * from './update-tool.dto';
+export * from './delete-tool.dto';
+export * from './list-tool.dto';

src/components/tools/tool/dto/list-tool.dto.ts

@@ -0,0 +1,25 @@
+import { InputType, ObjectType } from '@nestjs/graphql';
+import {
+  FilterField,
+  OptionalField,
+  PaginatedList,
+  SortablePaginationInput,
+} from '~/common';
+import { Tool } from './tool.dto';
+
+@InputType()
+export abstract class ToolFilters {
+  @OptionalField()
+  readonly name?: string;
+}
+
+@InputType()
+export class ToolListInput extends SortablePaginationInput<keyof Tool>({
+  defaultSort: 'name',
+}) {
+  @FilterField(() => ToolFilters)
+  readonly filter?: ToolFilters;
+}
+
+@ObjectType()
+export class ToolListOutput extends PaginatedList(Tool) {}

src/components/tools/tool/dto/tool.dto.ts

@@ -0,0 +1,32 @@
+import { Field, ObjectType } from '@nestjs/graphql';
+import {
+  DbUnique,
+  NameField,
+  Resource,
+  SecuredBoolean,
+  SecuredString,
+} from '~/common';
+import { e } from '~/core/gel';
+import { RegisterResource } from '~/core/resources';
+
+@RegisterResource({ db: e.Tool })
+@ObjectType({
+  implements: [Resource],
+})
+export class Tool extends Resource {
+  @NameField()
+  @DbUnique()
+  readonly name: SecuredString;
+
+  @Field()
+  readonly aiBased: SecuredBoolean;
+}
+
+declare module '~/core/resources/map' {
+  interface ResourceMap {
+    Tool: typeof Tool;
+  }
+  interface ResourceDBMap {
+    Tool: typeof e.default.Tool;
+  }
+}