Create ToolUsage module

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

Author: CarsonF

dbschema/tool.gel

@@ -7,5 +7,19 @@ module default {
     required aiBased: bool {
       default := false;
     };
+
+    usages := .<tool[is Tool::Usage];
+  }
+}
+
+module Tool {
+  type Usage extending default::Resource, Mixin::Embedded {
+    required tool: default::Tool;
+    
+    overloaded required container: default::Resource {
+      on target delete delete source;
+    }
+
+    startDate: cal::local_date;
   }
 }

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

@@ -0,0 +1,25 @@
+import { Field, InputType, ObjectType } from '@nestjs/graphql';
+import { CalendarDate, DateField, type ID, IdField } from '~/common';
+import { ToolUsage } from './tool-usage.dto';
+
+@InputType()
+export abstract class CreateToolUsage {
+  @IdField({
+    description: 'A resource ID',
+  })
+  readonly container: ID<'Resource'>;
+
+  @IdField({
+    description: 'A tool ID',
+  })
+  readonly tool: ID<'Tool'>;
+
+  @DateField({ nullable: true })
+  readonly startDate?: CalendarDate;
+}
+
+@ObjectType()
+export abstract class CreateToolUsageOutput {
+  @Field()
+  readonly toolUsage: ToolUsage;
+}

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

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

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

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

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

@@ -0,0 +1,33 @@
+import { InputType, ObjectType } from '@nestjs/graphql';
+import {
+  FilterField,
+  PaginatedList,
+  SecuredList,
+  SortablePaginationInput,
+} from '~/common';
+import { ToolFilters } from '../../tool/dto';
+import { ToolUsage } from './tool-usage.dto';
+
+@InputType()
+export abstract class ToolUsageFilters {
+  @FilterField(() => ToolFilters)
+  readonly tool?: ToolFilters & {};
+}
+
+@InputType()
+export class ToolUsageListInput extends SortablePaginationInput<
+  keyof ToolUsage
+>({
+  defaultSort: 'createdAt',
+}) {
+  @FilterField(() => ToolUsageFilters)
+  readonly filter?: ToolUsageFilters;
+}
+
+@ObjectType()
+export class ToolUsageListOutput extends PaginatedList(ToolUsage) {}
+
+@ObjectType({
+  description: SecuredList.descriptionFor('tool usages'),
+})
+export abstract class SecuredToolUsageList extends SecuredList(ToolUsage) {}

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

@@ -0,0 +1,43 @@
+import { Field, ObjectType } from '@nestjs/graphql';
+import {
+  Resource,
+  type Secured,
+  SecuredDateNullable,
+  SecuredProperty,
+  type SetUnsecuredType,
+  type UnsecuredDto,
+} from '~/common';
+import { type BaseNode } from '~/core/database/results';
+import { e } from '~/core/gel';
+import { type LinkTo, RegisterResource } from '~/core/resources';
+import { Tool } from '../../tool/dto';
+
+@RegisterResource({ db: e.Tool.Usage })
+@ObjectType({
+  implements: [Resource],
+})
+export class ToolUsage extends Resource {
+  static readonly Parent = 'dynamic';
+
+  readonly container: Secured<BaseNode>;
+
+  @Field(() => Tool)
+  readonly tool: Tool & SetUnsecuredType<UnsecuredDto<Tool>>;
+
+  @Field()
+  readonly startDate: SecuredDateNullable;
+
+  readonly creator: LinkTo<'User'>;
+}
+
+@ObjectType()
+export class SecuredToolUsage extends SecuredProperty(ToolUsage) {}
+
+declare module '~/core/resources/map' {
+  interface ResourceMap {
+    ToolUsage: typeof ToolUsage;
+  }
+  interface ResourceDBMap {
+    ToolUsage: typeof e.Tool.Usage;
+  }
+}

src/components/tools/tool-usage/dto/update-tool-usage.dto.ts

@@ -0,0 +1,24 @@
+import { Field, InputType, ObjectType } from '@nestjs/graphql';
+import { type CalendarDate, DateField, type ID, IdField } from '~/common';
+import { ToolUsage } from './tool-usage.dto';
+
+@InputType()
+export abstract class UpdateToolUsage {
+  @IdField()
+  readonly id: ID;
+
+  @DateField({ nullable: true })
+  readonly startDate?: CalendarDate | null;
+}
+
+@InputType()
+export abstract class UpdateToolUsageInput {
+  @Field()
+  readonly usage: UpdateToolUsage;
+}
+
+@ObjectType()
+export abstract class UpdateToolUsageOutput {
+  @Field()
+  readonly toolUsage: ToolUsage;
+}

src/components/tools/tool-usage/resource-tools.resolver.ts

@@ -0,0 +1,19 @@
+import { Parent, ResolveField, Resolver } from '@nestjs/graphql';
+import { Resource } from '~/common';
+import { ToolUsage } from './dto';
+import { ToolUsageService } from './tool-usage.service';
+
+@Resolver(() => Resource, { isAbstract: true })
+export class ResourceToolsResolver {
+  constructor(private readonly toolUsageService: ToolUsageService) {}
+
+  @ResolveField(() => [ToolUsage], {
+    description: 'Tool usages for this resource',
+  })
+  async tools(@Parent() resource: Resource): Promise<ToolUsage[]> {
+    if (resource.__typename === 'ToolUsage' || resource.__typename === 'Tool') {
+      return [];
+    }
+    return await this.toolUsageService.findByContainerId(resource.id);
+  }
+}

src/components/tools/tool-usage/tool-usage.loader.ts

@@ -0,0 +1,15 @@
+import { type ID } from '~/common';
+import { type DataLoaderStrategy, LoaderFactory } from '~/core/data-loader';
+import { ToolUsage } from './dto';
+import { ToolUsageService } from './tool-usage.service';
+
+@LoaderFactory(() => ToolUsage)
+export class ToolUsageLoader
+  implements DataLoaderStrategy<ToolUsage, ID<ToolUsage>>
+{
+  constructor(private readonly usages: ToolUsageService) {}
+
+  async loadMany(ids: ReadonlyArray<ID<ToolUsage>>) {
+    return await this.usages.readMany(ids);
+  }
+}

src/components/tools/tool-usage/tool-usage.module.ts

@@ -0,0 +1,20 @@
+import { Module } from '@nestjs/common';
+import { ToolCoreModule } from '../tool/tool.module';
+import { ResourceToolsResolver } from './resource-tools.resolver';
+import { ToolUsageLoader } from './tool-usage.loader';
+import { ToolUsageRepository } from './tool-usage.repository';
+import { ToolUsageResolver } from './tool-usage.resolver';
+import { ToolUsageService } from './tool-usage.service';
+
+@Module({
+  imports: [ToolCoreModule],
+  providers: [
+    ToolUsageService,
+    ToolUsageRepository,
+    ToolUsageResolver,
+    ToolUsageLoader,
+    ResourceToolsResolver,
+  ],
+  exports: [ToolUsageService, ResourceToolsResolver],
+})
+export class ToolUsageModule {}