@hexabot-ai/api 3.1.4-alpha.0 → 3.2.1-alpha.0

package/src/setting/services/setting.service.ts

@@ -4,6 +4,7 @@
  * Full terms: see LICENSE.md.
  */
 
+import { Setting } from '@hexabot-ai/types';
 import { CACHE_MANAGER } from '@nestjs/cache-manager';
 import {
   BadRequestException,
@@ -29,11 +30,7 @@ import { UpdateOneOptions } from '@/utils/generics/base-orm.repository';
 import { BaseOrmService } from '@/utils/generics/base-orm.service';
 import { UpdateEntityEvent } from '@/utils/types/entity-event.types';
 
-import {
-  Setting,
-  SettingCreateDto,
-  SettingUpdateDto,
-} from '../dto/setting.dto';
+import { SettingCreateDto, SettingUpdateDto } from '../dto/setting.dto';
 import { SettingOrmEntity } from '../entities/setting.entity';
 import { SettingRepository } from '../repositories/setting.repository';
 import { buildSettingSeedsFromRegistry } from '../runtime-settings.seed';

package/src/setting/setting.module.ts

@@ -22,7 +22,8 @@ import { SettingService } from './services/setting.service';
 const runtimeSettingProviderPatterns = [
   // Built-in core settings groups
   'dist/setting/**/*.settings.js',
-  // Built-in core extension settings groups
+  // Built-in core extension settings groups. Channel source settings are
+  // owned by channel handlers and are intentionally not discovered here.
   'dist/extensions/**/*.settings.js',
   ...(process.env.NODE_ENV === 'test'
     ? []

package/src/setting/types/index.ts

@@ -4,16 +4,9 @@
  * Full terms: see LICENSE.md.
  */
 
-import { Setting } from '@/setting/dto/setting.dto';
+import { Setting } from '@hexabot-ai/types';
 
-export enum FieldType {
-  text = 'text',
-  url = 'url',
-  textarea = 'textarea',
-  checkbox = 'checkbox',
-  file = 'file',
-  html = 'html',
-}
+export { FieldType } from '@hexabot-ai/types';
 
 export type AnySetting = Setting;
 

package/src/user/controllers/auth.controller.ts

@@ -19,6 +19,7 @@ import { EventEmitter2 } from '@nestjs/event-emitter';
 import { Request, Response } from 'express';
 import { Session as ExpressSession } from 'express-session';
 
+import { AuditAuthLogin, AuditAuthLogout } from '@/audit';
 import { config } from '@/config';
 import { LicenseService } from '@/license/services/license.service';
 import { LoggerService } from '@/logger/logger.service';
@@ -59,6 +60,7 @@ export class BaseAuthController {
    * @returns A status object indicating successful logout.
    */
   @Post('logout')
+  @AuditAuthLogout()
   logout(
     @Session() session: ExpressSession,
     @Res({ passthrough: true }) res: Response,
@@ -93,6 +95,7 @@ export class LocalAuthController extends BaseAuthController {
   @UseGuards(LocalAuthGuard)
   @Roles('public')
   @Post('local')
+  @AuditAuthLogin()
   async login(@Req() req: Request) {
     return {
       ...req.user,

package/src/user/controllers/credential.controller.ts

@@ -4,6 +4,7 @@
  * Full terms: see LICENSE.md.
  */
 
+import { Credential, CredentialFull } from '@hexabot-ai/types';
 import {
   Body,
   Controller,
@@ -26,9 +27,7 @@ import { BaseOrmController } from '@/utils/generics/base-orm.controller';
 import { TypeOrmSearchFilterPipe } from '@/utils/pipes/typeorm-search-filter.pipe';
 
 import {
-  Credential,
   CredentialCreateDto,
-  CredentialFull,
   CredentialUpdateDto,
 } from '../dto/credential.dto';
 import { CredentialOrmEntity } from '../entities/credential.entity';

package/src/user/controllers/role.controller.ts

@@ -4,6 +4,7 @@
  * Full terms: see LICENSE.md.
  */
 
+import type { User } from '@hexabot-ai/types';
 import {
   Body,
   Controller,
@@ -26,7 +27,6 @@ import { PopulatePipe } from '@/utils/pipes/populate.pipe';
 import { TypeOrmSearchFilterPipe } from '@/utils/pipes/typeorm-search-filter.pipe';
 
 import { RoleCreateDto, RoleUpdateDto } from '../dto/role.dto';
-import { User } from '../dto/user.dto';
 import { RoleOrmEntity } from '../entities/role.entity';
 import { RoleService } from '../services/role.service';
 import { UserService } from '../services/user.service';

package/src/user/dto/credential.dto.ts

@@ -4,33 +4,12 @@
  * Full terms: see LICENSE.md.
  */
 
+import { credentialFullSchema, credentialSchema } from '@hexabot-ai/types';
 import { ApiProperty, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
-import { Exclude, Expose, Type } from 'class-transformer';
 import { IsNotEmpty, IsOptional, IsString } from 'class-validator';
 
 import { IsUUIDv4 } from '@/utils/decorators/is-uuid.decorator';
-import { BaseStub, TDto } from '@/utils/types/dto.types';
-
-import { User } from './user.dto';
-
-@Exclude()
-export class CredentialStub extends BaseStub {
-  @Expose()
-  name!: string;
-}
-
-@Exclude()
-export class Credential extends CredentialStub {
-  @Expose({ name: 'ownerId' })
-  owner!: string;
-}
-
-@Exclude()
-export class CredentialFull extends CredentialStub {
-  @Expose()
-  @Type(() => User)
-  owner!: User | null;
-}
+import { TDto } from '@/utils/types/dto.types';
 
 export class CredentialCreateDto {
   @ApiProperty({
@@ -63,8 +42,8 @@ export class CredentialUpdateDto extends PartialType(CredentialCreateDto) {}
 
 export type CredentialDto = TDto<
   {
-    plain: typeof Credential;
-    full: typeof CredentialFull;
+    plain: typeof credentialSchema;
+    full: typeof credentialFullSchema;
   },
   {
     create: CredentialCreateDto;

package/src/user/dto/model.dto.ts

@@ -4,42 +4,15 @@
  * Full terms: see LICENSE.md.
  */
 
+import { modelFullSchema, modelSchema } from '@hexabot-ai/types';
 import { ApiProperty } from '@nestjs/swagger';
-import { Exclude, Expose, Type } from 'class-transformer';
 import { IsNotEmpty, IsObject, IsOptional, IsString } from 'class-validator';
 
-import { BaseStub, TDto } from '@/utils/types/dto.types';
+import { TDto } from '@/utils/types/dto.types';
 
 import { TRelation } from '../types/index.type';
 import { TModel } from '../types/model.type';
 
-import { Permission } from './permission.dto';
-
-@Exclude()
-export class ModelStub extends BaseStub {
-  @Expose()
-  name: string;
-
-  @Expose()
-  identity: string;
-
-  @Expose()
-  attributes: object;
-
-  @Expose()
-  relation?: TRelation;
-}
-
-@Exclude()
-export class Model extends ModelStub {}
-
-@Exclude()
-export class ModelFull extends ModelStub {
-  @Expose()
-  @Type(() => Permission)
-  permissions?: Permission[];
-}
-
 export class ModelCreateDto {
   @ApiProperty({ description: 'Name of the model', type: String })
   @IsNotEmpty()
@@ -71,8 +44,8 @@ export class ModelCreateDto {
 
 export type ModelDto = TDto<
   {
-    plain: typeof Model;
-    full: typeof ModelFull;
+    plain: typeof modelSchema;
+    full: typeof modelFullSchema;
   },
   {
     create: ModelCreateDto;

package/src/user/dto/permission.dto.ts

@@ -4,48 +4,16 @@
  * Full terms: see LICENSE.md.
  */
 
+import { permissionFullSchema, permissionSchema } from '@hexabot-ai/types';
 import { ApiProperty } from '@nestjs/swagger';
-import { Exclude, Expose, Type } from 'class-transformer';
 import { IsEnum, IsNotEmpty, IsOptional, IsString } from 'class-validator';
 
 import { IsUUIDv4 } from '@/utils/decorators/is-uuid.decorator';
-import { BaseStub, TDto } from '@/utils/types/dto.types';
+import { TDto } from '@/utils/types/dto.types';
 
 import { Action } from '../types/action.type';
 import { TRelation } from '../types/index.type';
 
-import { Model } from './model.dto';
-import { Role } from './role.dto';
-
-@Exclude()
-export class PermissionStub extends BaseStub {
-  @Expose()
-  action: string;
-
-  @Expose()
-  relation: TRelation;
-}
-
-@Exclude()
-export class Permission extends PermissionStub {
-  @Expose({ name: 'modelId' })
-  model: string;
-
-  @Expose({ name: 'roleId' })
-  role: string;
-}
-
-@Exclude()
-export class PermissionFull extends PermissionStub {
-  @Expose()
-  @Type(() => Model)
-  model: Model;
-
-  @Expose()
-  @Type(() => Role)
-  role: Role;
-}
-
 export class PermissionCreateDto {
   @ApiProperty({ description: 'Id of the model', type: String })
   @IsNotEmpty()
@@ -75,8 +43,8 @@ export class PermissionCreateDto {
 
 export type PermissionDto = TDto<
   {
-    plain: typeof Permission;
-    full: typeof PermissionFull;
+    plain: typeof permissionSchema;
+    full: typeof permissionFullSchema;
   },
   {
     create: PermissionCreateDto;

package/src/user/dto/role.dto.ts

@@ -4,46 +4,11 @@
  * Full terms: see LICENSE.md.
  */
 
+import { roleFullSchema, roleSchema } from '@hexabot-ai/types';
 import { ApiProperty, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
-import { Exclude, Expose, Type } from 'class-transformer';
 import { IsBoolean, IsNotEmpty, IsOptional, IsString } from 'class-validator';
 
-import { BaseStub, TDto } from '@/utils/types/dto.types';
-
-import { Permission } from './permission.dto';
-import { User } from './user.dto';
-
-@Exclude()
-export class RoleStub extends BaseStub {
-  @Expose()
-  id!: string;
-
-  @Expose()
-  code!: string;
-
-  @Expose()
-  label!: string;
-
-  @Expose()
-  name!: string;
-
-  @Expose()
-  active!: boolean;
-}
-
-@Exclude()
-export class Role extends RoleStub {}
-
-@Exclude()
-export class RoleFull extends RoleStub {
-  @Expose()
-  @Type(() => Permission)
-  permissions?: Permission[];
-
-  @Expose()
-  @Type(() => User)
-  users: User[];
-}
+import { TDto } from '@/utils/types/dto.types';
 
 export class RoleCreateDto {
   @ApiProperty({ description: 'Name of the role', type: String })
@@ -65,8 +30,8 @@ export class RoleUpdateDto extends PartialType(RoleCreateDto) {}
 
 export type RoleDto = TDto<
   {
-    plain: typeof Role;
-    full: typeof RoleFull;
+    plain: typeof roleSchema;
+    full: typeof roleFullSchema;
   },
   {
     create: RoleCreateDto;

package/src/user/dto/user-profile.dto.ts

@@ -4,26 +4,11 @@
  * Full terms: see LICENSE.md.
  */
 
+import { userProfileFullSchema, userProfileSchema } from '@hexabot-ai/types';
 import { ApiProperty } from '@nestjs/swagger';
-import { Exclude, Expose } from 'class-transformer';
 import { IsNotEmpty, IsString } from 'class-validator';
 
-import { BaseStub, TDto } from '@/utils';
-
-@Exclude()
-export class UserProfileStub extends BaseStub {
-  @Expose()
-  firstName!: string;
-
-  @Expose()
-  lastName!: string;
-
-  @Expose()
-  language!: string | null;
-
-  @Expose()
-  timezone: number = 0;
-}
+import { TDto } from '@/utils';
 
 export class UserProfileCreateDto {
   @ApiProperty({ description: `User Profile firstName`, type: String })
@@ -38,6 +23,6 @@ export class UserProfileCreateDto {
 }
 
 export type UserProfileDto = TDto<{
-  plain: typeof UserProfileStub;
-  full: typeof UserProfileStub;
+  plain: typeof userProfileSchema;
+  full: typeof userProfileFullSchema;
 }>;

package/src/user/dto/user.dto.ts

@@ -4,6 +4,11 @@
  * Full terms: see LICENSE.md.
  */
 
+import {
+  userFullSchema,
+  userSchema,
+  type UserProvider,
+} from '@hexabot-ai/types';
 import { PickType } from '@nestjs/mapped-types';
 import {
   ApiProperty,
@@ -11,7 +16,6 @@ import {
   OmitType,
   PartialType,
 } from '@nestjs/swagger';
-import { Exclude, Expose, Type } from 'class-transformer';
 import {
   ArrayNotEmpty,
   IsArray,
@@ -23,107 +27,12 @@ import {
   IsString,
 } from 'class-validator';
 
-import { Attachment } from '@/attachment/dto/attachment.dto';
-import {
-  Subscriber,
-  SubscriberCreateDto,
-  SubscriberFull,
-  SubscriberStub,
-} from '@/chat/dto/subscriber.dto';
+import { SubscriberCreateDto } from '@/chat/dto/subscriber.dto';
 import { IsUUIDv4 } from '@/utils/decorators/is-uuid.decorator';
 import { TDto } from '@/utils/types/dto.types';
 
-import { UserProvider } from '../types/user-provider.type';
-
-import { Role } from './role.dto';
 import { UserProfileCreateDto } from './user-profile.dto';
 
-@Exclude()
-export class UserStub extends SubscriberStub {
-  @Expose()
-  username!: string;
-
-  @Expose()
-  email!: string;
-
-  @Expose()
-  sendEmail!: boolean;
-
-  @Expose()
-  state!: boolean;
-
-  @Expose()
-  resetCount!: number;
-
-  @Expose()
-  resetToken!: string | null;
-
-  @Expose()
-  provider?: UserProvider;
-}
-
-@Exclude()
-export class User extends Subscriber {
-  @Expose()
-  username!: string;
-
-  @Expose()
-  email!: string;
-
-  @Expose()
-  sendEmail!: boolean;
-
-  @Expose()
-  state!: boolean;
-
-  @Expose()
-  resetCount!: number;
-
-  @Expose()
-  resetToken!: string | null;
-
-  @Expose()
-  provider?: UserProvider;
-
-  @Expose({ name: 'roleIds' })
-  roles: string[];
-
-  @Expose({ name: 'avatarId' })
-  avatar: string;
-}
-
-@Exclude()
-export class UserFull extends SubscriberFull {
-  @Expose()
-  username!: string;
-
-  @Expose()
-  email!: string;
-
-  @Expose()
-  sendEmail!: boolean;
-
-  @Expose()
-  state!: boolean;
-
-  @Expose()
-  resetCount!: number;
-
-  @Expose()
-  resetToken!: string | null;
-
-  @Expose()
-  provider?: UserProvider;
-
-  @Expose()
-  @Type(() => Role)
-  roles: Role[];
-
-  @Expose()
-  @Type(() => Attachment)
-  avatar: Attachment | null;
-}
-
 export class UserCreateDto extends UserProfileCreateDto {
   @ApiProperty({ description: 'User username', type: String })
   @IsNotEmpty()
@@ -243,8 +152,8 @@ export class UserRequestResetDto extends PickType(UserCreateDto, ['email']) {}
 
 export type UserDto = TDto<
   {
-    plain: typeof User;
-    full: typeof UserFull;
+    plain: typeof userSchema;
+    full: typeof userFullSchema;
   },
   {
     create: UserCreateDto;

package/src/user/entities/credential.entity.ts

@@ -4,6 +4,7 @@
  * Full terms: see LICENSE.md.
  */
 
+import { credentialSchema, credentialFullSchema } from '@hexabot-ai/types';
 import {
   Column,
   Entity,
@@ -13,24 +14,22 @@ import {
   RelationId,
 } from 'typeorm';
 
+import { AuditLabel } from '@/audit/decorators/audit-label.decorator';
 import { BaseOrmEntity } from '@/database/entities/base.entity';
 import { AsRelation } from '@/utils/decorators/relation-ref.decorator';
 
-import {
-  Credential,
-  CredentialDto,
-  CredentialFull,
-} from '../dto/credential.dto';
+import { CredentialDto } from '../dto/credential.dto';
 
 import { UserOrmEntity } from './user.entity';
 
 @Entity({ name: 'credentials' })
 @Index(['name'], { unique: true })
 export class CredentialOrmEntity extends BaseOrmEntity<CredentialDto> {
-  plainCls = Credential;
+  plainCls = credentialSchema;
 
-  fullCls = CredentialFull;
+  fullCls = credentialFullSchema;
 
+  @AuditLabel()
   @Column()
   name!: string;
 

package/src/user/entities/model.entity.ts

@@ -4,12 +4,14 @@
  * Full terms: see LICENSE.md.
  */
 
+import { modelSchema, modelFullSchema } from '@hexabot-ai/types';
 import { Column, Entity, Index, OneToMany } from 'typeorm';
 
+import { AuditLabel } from '@/audit/decorators/audit-label.decorator';
 import { JsonColumn } from '@/database/decorators/json-column.decorator';
 import { BaseOrmEntity } from '@/database/entities/base.entity';
 
-import { Model, ModelDto, ModelFull } from '../dto/model.dto';
+import { ModelDto } from '../dto/model.dto';
 import { TRelation } from '../types/index.type';
 
 import { PermissionOrmEntity } from './permission.entity';
@@ -18,10 +20,11 @@ import { PermissionOrmEntity } from './permission.entity';
 @Index(['name'], { unique: true })
 @Index(['identity'], { unique: true })
 export class ModelOrmEntity extends BaseOrmEntity<ModelDto> {
-  plainCls = Model;
+  plainCls = modelSchema;
 
-  fullCls = ModelFull;
+  fullCls = modelFullSchema;
 
+  @AuditLabel()
   @Column()
   name!: string;
 

package/src/user/entities/permission.entity.ts

@@ -4,6 +4,7 @@
  * Full terms: see LICENSE.md.
  */
 
+import { permissionSchema, permissionFullSchema } from '@hexabot-ai/types';
 import {
   Column,
   Entity,
@@ -17,11 +18,7 @@ import { EnumColumn } from '@/database/decorators/enum-column.decorator';
 import { BaseOrmEntity } from '@/database/entities/base.entity';
 import { AsRelation } from '@/utils/decorators/relation-ref.decorator';
 
-import {
-  Permission,
-  PermissionDto,
-  PermissionFull,
-} from '../dto/permission.dto';
+import { PermissionDto } from '../dto/permission.dto';
 import { Action } from '../types/action.type';
 import { TRelation } from '../types/index.type';
 
@@ -31,9 +28,9 @@ import { RoleOrmEntity } from './role.entity';
 @Entity({ name: 'permissions' })
 @Index(['model', 'action', 'role', 'relation'], { unique: true })
 export class PermissionOrmEntity extends BaseOrmEntity<PermissionDto> {
-  plainCls = Permission;
+  plainCls = permissionSchema;
 
-  fullCls = PermissionFull;
+  fullCls = permissionFullSchema;
 
   @ManyToOne(() => ModelOrmEntity, (model) => model.permissions, {
     onDelete: 'CASCADE',

package/src/user/entities/role.entity.ts

@@ -4,11 +4,13 @@
  * Full terms: see LICENSE.md.
  */
 
+import { roleSchema, roleFullSchema } from '@hexabot-ai/types';
 import { Column, Entity, Index, ManyToMany, OneToMany } from 'typeorm';
 
+import { AuditLabel } from '@/audit/decorators/audit-label.decorator';
 import { BaseOrmEntity } from '@/database/entities/base.entity';
 
-import { Role, RoleDto, RoleFull } from '../dto/role.dto';
+import { RoleDto } from '../dto/role.dto';
 
 import { PermissionOrmEntity } from './permission.entity';
 import { UserOrmEntity } from './user.entity';
@@ -18,10 +20,11 @@ export type TRole = 'admin' | 'public';
 @Entity({ name: 'roles' })
 @Index(['name'], { unique: true })
 export class RoleOrmEntity extends BaseOrmEntity<RoleDto> {
-  plainCls = Role;
+  plainCls = roleSchema;
 
-  fullCls = RoleFull;
+  fullCls = roleFullSchema;
 
+  @AuditLabel()
   @Column()
   name!: string;
 

package/src/user/entities/user-profile.entity.ts

@@ -4,6 +4,7 @@
  * Full terms: see LICENSE.md.
  */
 
+import { userProfileStubSchema } from '@hexabot-ai/types';
 import {
   Column,
   Entity,
@@ -18,9 +19,9 @@ import {
 import { AttachmentOrmEntity } from '@/attachment/entities/attachment.entity';
 import { EnumColumn } from '@/database';
 import { BaseOrmEntity } from '@/database/entities/base.entity';
-import { AsRelation, TDto } from '@/utils';
+import { AsRelation, TZodDto } from '@/utils';
 
-import { UserProfileDto, UserProfileStub } from '../dto/user-profile.dto';
+import { UserProfileDto } from '../dto/user-profile.dto';
 
 export enum EUserProfileType {
   SubscriberOrmEntity = 'SubscriberOrmEntity',
@@ -34,11 +35,13 @@ export enum EUserProfileType {
 @Index(['firstName'])
 @Index(['lastName'])
 export class UserProfileOrmEntity<
-  Dto extends TDto = UserProfileDto,
+  Dto extends TZodDto = UserProfileDto,
 > extends BaseOrmEntity<Dto> {
-  plainCls = UserProfileStub;
+  plainCls: Dto['transformers']['plain'] =
+    userProfileStubSchema as Dto['transformers']['plain'];
 
-  fullCls = UserProfileStub;
+  fullCls: Dto['transformers']['full'] =
+    userProfileStubSchema as Dto['transformers']['full'];
 
   @Column()
   firstName: string;