@hexabot-ai/api 3.0.0-alpha.3 → 3.1.0-alpha.0

package/src/cms/controllers/menu.controller.ts

@@ -9,35 +9,24 @@ import {
   Controller,
   Delete,
   Get,
-  InternalServerErrorException,
-  NotFoundException,
-  Param,
+  HttpCode,
   Patch,
   Post,
   Query,
 } from '@nestjs/common';
 import { FindManyOptions } from 'typeorm';
 
+import { UuidParam } from '@/utils';
 import { BaseOrmController } from '@/utils/generics/base-orm.controller';
 import { FindAllOptions } from '@/utils/generics/base-orm.repository';
 import { TypeOrmSearchFilterPipe } from '@/utils/pipes/typeorm-search-filter.pipe';
 
-import {
-  Menu,
-  MenuCreateDto,
-  MenuDtoConfig,
-  MenuTransformerDto,
-  MenuUpdateDto,
-} from '../dto/menu.dto';
+import { Menu, MenuCreateDto, MenuUpdateDto } from '../dto/menu.dto';
 import { MenuOrmEntity } from '../entities/menu.entity';
 import { MenuService } from '../services/menu.service';
 
 @Controller('menu')
-export class MenuController extends BaseOrmController<
-  MenuOrmEntity,
-  MenuTransformerDto,
-  MenuDtoConfig
-> {
+export class MenuController extends BaseOrmController<MenuOrmEntity> {
   constructor(protected readonly menuService: MenuService) {
     super(menuService);
   }
@@ -56,9 +45,9 @@ export class MenuController extends BaseOrmController<
         allowedFields: ['parent.id', 'type', 'title', 'payload', 'url'],
       }),
     )
-    options?: FindManyOptions<MenuOrmEntity>,
+    options: FindManyOptions<MenuOrmEntity> = {},
   ) {
-    return super.count(options);
+    return this.count(options);
   }
 
   /**
@@ -68,7 +57,7 @@ export class MenuController extends BaseOrmController<
    * Otherwise, applies filters when present or returns the whole collection.
    */
   @Get()
-  async find(
+  async findPage(
     @Query(
       new TypeOrmSearchFilterPipe<MenuOrmEntity>({
         allowedFields: ['parent.id', 'type', 'title', 'payload', 'url'],
@@ -138,19 +127,8 @@ export class MenuController extends BaseOrmController<
    * @returns A promise that resolves to the menu item if found, or throws a `NotFoundException`.
    */
   @Get(':id')
-  async findOne(@Param('id') id: string): Promise<Menu> {
-    try {
-      const result = await this.menuService.findOne(id);
-      if (!result) {
-        this.logger.warn(`Unable to find menu with id: ${id}`);
-        throw new NotFoundException(`Menu with id: ${id} not found`);
-      }
-
-      return result;
-    } catch (e) {
-      this.logger.error(e);
-      throw new InternalServerErrorException();
-    }
+  async findMenuItem(@UuidParam('id') id: string): Promise<Menu> {
+    return this.findOne(id) as Promise<Menu>;
   }
 
   /**
@@ -166,7 +144,7 @@ export class MenuController extends BaseOrmController<
   @Patch(':id')
   async updateOne(
     @Body() body: MenuUpdateDto,
-    @Param('id') id: string,
+    @UuidParam('id') id: string,
   ): Promise<Menu> {
     if (!id) {
       return await this.create(body as MenuCreateDto);
@@ -185,18 +163,8 @@ export class MenuController extends BaseOrmController<
    * @returns A promise that resolves to an empty string upon successful deletion.
    */
   @Delete(':id')
-  async delete(@Param('id') id: string) {
-    try {
-      const result = await this.menuService.deleteOne(id);
-      if (!result.deletedCount) {
-        this.logger.warn(`Unable to delete menu with id: ${id}`);
-        throw new NotFoundException();
-      }
-
-      return '';
-    } catch (e) {
-      this.logger.error(e);
-      throw new InternalServerErrorException();
-    }
+  @HttpCode(204)
+  async deleteMenuItem(@UuidParam('id') id: string) {
+    return this.deleteOne(id);
   }
 }

package/src/cms/dto/content.dto.ts

@@ -9,11 +9,7 @@ import { Exclude, Expose, Type } from 'class-transformer';
 import { IsBoolean, IsNotEmpty, IsOptional, IsString } from 'class-validator';
 
 import { IsUUIDv4 } from '@/utils/decorators/is-uuid.decorator';
-import {
-  BaseStub,
-  DtoActionConfig,
-  DtoTransformerConfig,
-} from '@/utils/types/dto.types';
+import { BaseStub, TDto } from '@/utils/types/dto.types';
 
 import { ContentType } from './contentType.dto';
 
@@ -26,10 +22,10 @@ export class ContentStub extends BaseStub {
   status!: boolean;
 
   @Expose()
-  dynamicFields!: Record<string, any> | null;
+  properties!: Record<string, any> | null;
 
   @Expose()
-  rag?: string | null;
+  searchText: string;
 }
 
 @Exclude()
@@ -62,19 +58,20 @@ export class ContentCreateDto {
   @IsOptional()
   status?: boolean;
 
-  @ApiPropertyOptional({ description: 'Content dynamic fields', type: Object })
+  @ApiPropertyOptional({ description: 'Content properties', type: Object })
   @IsOptional()
-  dynamicFields?: Record<string, any>;
+  properties?: Record<string, any>;
 }
 
 export class ContentUpdateDto extends PartialType(ContentCreateDto) {}
 
-export type ContentTransformerDto = DtoTransformerConfig<{
-  PlainCls: typeof Content;
-  FullCls: typeof ContentFull;
-}>;
-
-export type ContentDtoConfig = DtoActionConfig<{
-  create: ContentCreateDto;
-  update: ContentUpdateDto;
-}>;
+export type ContentDto = TDto<
+  {
+    plain: typeof Content;
+    full: typeof ContentFull;
+  },
+  {
+    create: ContentCreateDto;
+    update: ContentUpdateDto;
+  }
+>;

package/src/cms/dto/contentType.dto.ts

@@ -4,27 +4,15 @@
  * Full terms: see LICENSE.md.
  */
 
-import { ApiProperty, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
-import { Exclude, Expose, Type } from 'class-transformer';
-import {
-  IsArray,
-  IsEnum,
-  IsNotEmpty,
-  IsOptional,
-  IsString,
-  Validate,
-  ValidateNested,
-} from 'class-validator';
+import { ApiProperty, PartialType } from '@nestjs/swagger';
+import { Exclude, Expose } from 'class-transformer';
+import { IsEnum, IsNotEmpty, IsString } from 'class-validator';
+import { JSONSchema7 as JsonSchema } from 'json-schema';
+import { z } from 'zod';
 
 import { FieldType } from '@/setting/types';
-import {
-  BaseStub,
-  DtoActionConfig,
-  DtoTransformerConfig,
-} from '@/utils/types/dto.types';
-
-import { UniqueFieldNames } from '../decorators/unique-field-names.decorator';
-import { ValidateRequiredFields } from '../validators/validate-required-fields.validator';
+import { Validate } from '@/utils/decorators/validate.decorator';
+import { BaseStub, TDto } from '@/utils/types/dto.types';
 
 @Exclude()
 export class ContentTypeStub extends BaseStub {
@@ -32,8 +20,7 @@ export class ContentTypeStub extends BaseStub {
   name!: string;
 
   @Expose()
-  @Type(() => ContentField)
-  fields!: ContentField[] | null;
+  schema!: JsonSchema;
 }
 
 @Exclude()
@@ -66,27 +53,23 @@ export class ContentTypeCreateDto {
   @IsNotEmpty()
   name: string;
 
-  @ApiPropertyOptional({
-    description: 'Content type fields',
-    type: ContentField,
+  @ApiProperty({
+    description: 'JSON Schema describing the content structure',
+    type: Object,
   })
-  @IsOptional()
-  @IsArray()
-  @ValidateNested({ each: true })
-  @Validate(ValidateRequiredFields)
-  @Type(() => ContentField)
-  @UniqueFieldNames()
-  fields?: ContentField[];
+  @Validate(z.looseObject({}))
+  schema!: JsonSchema;
 }
 
 export class ContentTypeUpdateDto extends PartialType(ContentTypeCreateDto) {}
 
-export type ContentTypeTransformerDto = DtoTransformerConfig<{
-  PlainCls: typeof ContentType;
-  FullCls: typeof ContentTypeFull;
-}>;
-
-export type ContentTypeDtoConfig = DtoActionConfig<{
-  create: ContentTypeCreateDto;
-  update: ContentTypeUpdateDto;
-}>;
+export type ContentTypeDto = TDto<
+  {
+    plain: typeof ContentType;
+    full: typeof ContentTypeFull;
+  },
+  {
+    create: ContentTypeCreateDto;
+    update: ContentTypeUpdateDto;
+  }
+>;

package/src/cms/dto/menu.dto.ts

@@ -16,13 +16,9 @@ import {
 } from 'class-validator';
 
 import { IsUUIDv4 } from '@/utils/decorators/is-uuid.decorator';
-import {
-  BaseStub,
-  DtoActionConfig,
-  DtoTransformerConfig,
-} from '@/utils/types/dto.types';
+import { BaseStub, TDto } from '@/utils/types/dto.types';
 
-import { MenuType } from '../entities/menu.entity';
+import { MenuType } from '../enums/menu-type.enum';
 
 @Exclude()
 export class MenuStub extends BaseStub {
@@ -97,12 +93,13 @@ export class MenuUpdateDto extends PartialType(MenuCreateDto) {}
 
 export class MenuQueryDto extends PartialType(MenuCreateDto) {}
 
-export type MenuTransformerDto = DtoTransformerConfig<{
-  PlainCls: typeof Menu;
-  FullCls: typeof MenuFull;
-}>;
-
-export type MenuDtoConfig = DtoActionConfig<{
-  create: MenuCreateDto;
-  update: MenuUpdateDto;
-}>;
+export type MenuDto = TDto<
+  {
+    plain: typeof Menu;
+    full: typeof MenuFull;
+  },
+  {
+    create: MenuCreateDto;
+    update: MenuUpdateDto;
+  }
+>;

package/src/cms/entities/content-type.entity.ts

@@ -4,63 +4,36 @@
  * Full terms: see LICENSE.md.
  */
 
-import { ForbiddenException } from '@nestjs/common';
-import { BeforeRemove, Column, Entity, Index, OneToMany } from 'typeorm';
+import { JSONSchema7 as JsonSchema } from 'json-schema';
+import { Column, Entity, Index, OneToMany } from 'typeorm';
 
 import { JsonColumn } from '@/database/decorators/json-column.decorator';
 import { BaseOrmEntity } from '@/database/entities/base.entity';
 
-import { ContentField } from '../dto/contentType.dto';
+import {
+  ContentType,
+  ContentTypeDto,
+  ContentTypeFull,
+} from '../dto/contentType.dto';
 
 import { ContentOrmEntity } from './content.entity';
 
 @Entity({ name: 'content_types' })
 @Index(['name'], { unique: true })
-export class ContentTypeOrmEntity extends BaseOrmEntity {
+export class ContentTypeOrmEntity extends BaseOrmEntity<ContentTypeDto> {
+  plainCls = ContentType;
+
+  fullCls = ContentTypeFull;
+
   @Column({ unique: true })
   name!: string;
 
+  /** JSON Schema describing the expected structure of stored values. */
   @JsonColumn({ nullable: true })
-  fields!: ContentField[] | null;
+  schema!: JsonSchema;
 
   @OneToMany(() => ContentOrmEntity, (content) => content.contentType, {
     cascade: ['remove'],
   })
   contents?: ContentOrmEntity[];
-
-  @BeforeRemove()
-  protected async ensureNoAssociatedBlocks(): Promise<void> {
-    if (!this.id) {
-      return;
-    }
-
-    const manager = ContentTypeOrmEntity.getEntityManager();
-    const databaseType = manager.connection.options.type;
-    const blockQuery = manager
-      .createQueryBuilder()
-      .select('1')
-      .from('blocks', 'block');
-
-    if (databaseType === 'sqlite' || databaseType === 'better-sqlite3') {
-      blockQuery.where(
-        `json_extract(block.options, '$.content.entity') = :contentTypeId`,
-        { contentTypeId: this.id },
-      );
-    } else if (databaseType === 'postgres') {
-      blockQuery.where(
-        `(block.options -> 'content' ->> 'entity') = :contentTypeId`,
-        { contentTypeId: this.id },
-      );
-    } else {
-      throw new Error(
-        `Unsupported database type for content type deletion safeguard: ${databaseType}`,
-      );
-    }
-
-    const associatedBlock = await blockQuery.limit(1).getRawOne();
-
-    if (associatedBlock) {
-      throw new ForbiddenException('Content type have blocks associated to it');
-    }
-  }
 }

package/src/cms/entities/content.entity.ts

@@ -5,8 +5,6 @@
  */
 
 import {
-  BeforeInsert,
-  BeforeUpdate,
   Column,
   Entity,
   Index,
@@ -18,17 +16,25 @@ import {
 import { ContentElement } from '@/chat/types/message';
 import { config } from '@/config';
 import { JsonColumn } from '@/database/decorators/json-column.decorator';
+import {
+  OnBeforeInsert,
+  OnBeforeUpdate,
+} from '@/database/decorators/orm-event-hooks.decorator';
 import { BaseOrmEntity } from '@/database/entities/base.entity';
 import { AsRelation } from '@/utils/decorators/relation-ref.decorator';
 
-import { Content } from '../dto/content.dto';
+import { Content, ContentDto, ContentFull } from '../dto/content.dto';
 
 import { ContentTypeOrmEntity } from './content-type.entity';
 
 @Entity({ name: 'contents' })
 @Index(['title'])
-@Index(['rag'])
-export class ContentOrmEntity extends BaseOrmEntity {
+@Index(['searchText'])
+export class ContentOrmEntity extends BaseOrmEntity<ContentDto> {
+  plainCls = Content;
+
+  fullCls = ContentFull;
+
   /**
    * The content type of this content.
    */
@@ -55,11 +61,11 @@ export class ContentOrmEntity extends BaseOrmEntity {
   @Column({ default: true })
   status!: boolean;
 
-  @JsonColumn({ name: 'dynamic_fields', nullable: true })
-  dynamicFields!: Record<string, any> | null;
+  @JsonColumn({ name: 'properties', nullable: true })
+  properties!: Record<string, any> | null;
 
-  @Column({ type: 'text', nullable: true })
-  rag?: string | null;
+  @Column({ name: 'searchText', type: 'text', nullable: false })
+  searchText: string;
 
   /**
    * Helper to return the internal url of this content.
@@ -79,27 +85,34 @@ export class ContentOrmEntity extends BaseOrmEntity {
    * Converts a content object to an element (A flat representation of a content)
    *
    * @param content
-   * @returns An object that has all dynamic fields accessible at top level
+   * @returns An object that has all content properties accessible at top level
    */
   static toElement(content: Content): ContentElement {
     return {
       id: content.id,
       title: content.title,
-      ...(content.dynamicFields ?? {}),
+      ...(content.properties ?? {}),
     };
   }
 
-  @BeforeInsert()
-  @BeforeUpdate()
-  applyDynamicFieldsTransformation(): void {
-    const dynamicFields = this.dynamicFields ?? {};
-    this.rag = this.stringifyDynamicFields(dynamicFields);
+  @OnBeforeInsert()
+  @OnBeforeUpdate()
+  async applySearchTextTransformation(): Promise<void> {
+    this.searchText = await this.buildSearchText();
   }
 
-  private stringifyDynamicFields(obj: Record<string, any>): string {
-    return Object.entries(obj).reduce(
-      (prev, cur) => `${prev}\n${cur[0]} : ${cur[1]}`,
-      '',
-    );
+  async buildSearchText(): Promise<string> {
+    const lines = [`title: ${this.title}`];
+    const properties = this.properties ?? {};
+
+    for (const [key, value] of Object.entries(properties)) {
+      if (typeof value !== 'string') {
+        continue;
+      }
+
+      lines.push(`${key}: ${value}`);
+    }
+
+    return lines.join('\n');
   }
 }

package/src/cms/entities/menu.entity.ts

@@ -5,27 +5,30 @@
  */
 
 import {
-  BeforeInsert,
-  BeforeUpdate,
   Check,
   Column,
   Entity,
   Index,
+  InsertEvent,
   JoinColumn,
   ManyToOne,
   OneToMany,
   RelationId,
+  UpdateEvent,
 } from 'typeorm';
 
 import { EnumColumn } from '@/database/decorators/enum-column.decorator';
+import {
+  OnBeforeInsert,
+  OnBeforeUpdate,
+} from '@/database/decorators/orm-event-hooks.decorator';
 import { BaseOrmEntity } from '@/database/entities/base.entity';
 import { AsRelation } from '@/utils/decorators/relation-ref.decorator';
 
-export enum MenuType {
-  web_url = 'web_url',
-  postback = 'postback',
-  nested = 'nested',
-}
+import { Menu, MenuDto, MenuFull } from '../dto/menu.dto';
+import { MenuType } from '../enums/menu-type.enum';
+
+export { MenuType };
 
 @Entity({ name: 'menus' })
 @Index(['parent'])
@@ -39,8 +42,11 @@ export enum MenuType {
   )
 `,
 )
-@Check(`"parent_id" IS NULL OR "id" <> "parent_id"`)
-export class MenuOrmEntity extends BaseOrmEntity {
+export class MenuOrmEntity extends BaseOrmEntity<MenuDto> {
+  plainCls = Menu;
+
+  fullCls = MenuFull;
+
   /**
    * The displayed title of the menu.
    */
@@ -82,22 +88,20 @@ export class MenuOrmEntity extends BaseOrmEntity {
   @OneToMany(() => MenuOrmEntity, (menu) => menu.parent)
   children?: MenuOrmEntity[];
 
-  @BeforeInsert()
-  async handleBeforeInsert(): Promise<void> {
-    await this.ensureValidParent();
-  }
-
-  @BeforeUpdate()
-  async handleBeforeUpdate(): Promise<void> {
-    await this.ensureValidParent();
-  }
-
-  private async ensureValidParent(): Promise<void> {
+  @OnBeforeInsert()
+  @OnBeforeUpdate()
+  protected async ensureValidParent(
+    event: InsertEvent<MenuOrmEntity> | UpdateEvent<MenuOrmEntity>,
+  ): Promise<void> {
     const parentId = this.parent?.id;
     if (parentId) {
-      // Ensure parent is nested
-      const manager = MenuOrmEntity.getEntityManager();
-      const parent = await manager.findOne(MenuOrmEntity, {
+      if (this.id && parentId === this.id) {
+        throw new Error(
+          'Menu Validation Error: parent should not reference itself',
+        );
+      }
+
+      const parent = await event.manager.findOne(MenuOrmEntity, {
         where: { id: parentId },
       });
 

package/src/cms/enums/menu-type.enum.ts

@@ -0,0 +1,11 @@
+/*
+ * Hexabot — Fair Core License (FCL-1.0-ALv2)
+ * Copyright (c) 2025 Hexastack.
+ * Full terms: see LICENSE.md.
+ */
+
+export enum MenuType {
+  web_url = 'web_url',
+  postback = 'postback',
+  nested = 'nested',
+}

package/src/cms/index.ts

@@ -34,12 +34,20 @@ export * from './repositories/menu.repository';
 
 export * from './services/content-type.service';
 
+export * from './services/rag-indexer.service';
+
+export * from './services/rag-retriever.service';
+
 export * from './services/content.service';
 
 export * from './services/menu.service';
 
+export * from './services/rag-backend.service';
+
 export * from './types/content';
 
+export * from './types/rag';
+
 export * from './types/menu-types';
 
 export * from './types/menu';

package/src/cms/repositories/content-type.repository.ts

@@ -6,34 +6,18 @@
 
 import { Injectable } from '@nestjs/common';
 import { InjectRepository } from '@nestjs/typeorm';
-import { EntitySubscriberInterface, Repository } from 'typeorm';
+import { Repository } from 'typeorm';
 
 import { BaseOrmRepository } from '@/utils/generics/base-orm.repository';
 
-import {
-  ContentType,
-  ContentTypeDtoConfig,
-  ContentTypeFull,
-  ContentTypeTransformerDto,
-} from '../dto/contentType.dto';
 import { ContentTypeOrmEntity } from '../entities/content-type.entity';
 
 @Injectable()
-export class ContentTypeRepository
-  extends BaseOrmRepository<
-    ContentTypeOrmEntity,
-    ContentTypeTransformerDto,
-    ContentTypeDtoConfig
-  >
-  implements EntitySubscriberInterface<ContentTypeOrmEntity>
-{
+export class ContentTypeRepository extends BaseOrmRepository<ContentTypeOrmEntity> {
   constructor(
     @InjectRepository(ContentTypeOrmEntity)
     repository: Repository<ContentTypeOrmEntity>,
   ) {
-    super(repository, [], {
-      PlainCls: ContentType,
-      FullCls: ContentTypeFull,
-    });
+    super(repository, []);
   }
 }