mirror of
https://github.com/hexastack/hexabot
synced 2025-06-26 18:27:28 +00:00
fix: event emitter + misc typings
This commit is contained in:
Mohamed Marrouchi
411
api/types/event-emitter.d.ts
vendored
Normal file
411
api/types/event-emitter.d.ts
vendored
Normal file
@@ -0,0 +1,411 @@
|
||||
/*
|
||||
* Copyright © 2024 Hexastack. All rights reserved.
|
||||
*
|
||||
* Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
|
||||
* 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
|
||||
* 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
|
||||
*/
|
||||
|
||||
import { type OnEventOptions } from '@nestjs/event-emitter/dist/interfaces';
|
||||
import type { Listener, OnOptions } from 'eventemitter2';
|
||||
import type {
|
||||
Document,
|
||||
Query,
|
||||
TFilterQuery,
|
||||
THydratedDocument,
|
||||
} from 'mongoose';
|
||||
import { type Socket } from 'socket.io';
|
||||
|
||||
import { type BotStats } from '@/analytics/schemas/bot-stats.schema';
|
||||
import { type Attachment } from '@/attachment/schemas/attachment.schema';
|
||||
import type EventWrapper from '@/channel/lib/EventWrapper';
|
||||
import { type SubscriberUpdateDto } from '@/chat/dto/subscriber.dto';
|
||||
import type { Block, BlockFull } from '@/chat/schemas/block.schema';
|
||||
import { type Category } from '@/chat/schemas/category.schema';
|
||||
import { type ContextVar } from '@/chat/schemas/context-var.schema';
|
||||
import { type Conversation } from '@/chat/schemas/conversation.schema';
|
||||
import type { Label, LabelDocument } from '@/chat/schemas/label.schema';
|
||||
import { type Message } from '@/chat/schemas/message.schema';
|
||||
import { type Subscriber } from '@/chat/schemas/subscriber.schema';
|
||||
import { type ContentType } from '@/cms/schemas/content-type.schema';
|
||||
import { type Content } from '@/cms/schemas/content.schema';
|
||||
import { type Menu } from '@/cms/schemas/menu.schema';
|
||||
import { type Language } from '@/i18n/schemas/language.schema';
|
||||
import { type Translation } from '@/i18n/schemas/translation.schema';
|
||||
import type {
|
||||
NlpEntity,
|
||||
NlpEntityDocument,
|
||||
} from '@/nlp/schemas/nlp-entity.schema';
|
||||
import { type NlpSampleEntity } from '@/nlp/schemas/nlp-sample-entity.schema';
|
||||
import { type NlpSample } from '@/nlp/schemas/nlp-sample.schema';
|
||||
import {
|
||||
NlpValueDocument,
|
||||
type NlpValue,
|
||||
} from '@/nlp/schemas/nlp-value.schema';
|
||||
import { type Setting } from '@/setting/schemas/setting.schema';
|
||||
import { type Invitation } from '@/user/schemas/invitation.schema';
|
||||
import { type Model } from '@/user/schemas/model.schema';
|
||||
import { type Permission } from '@/user/schemas/permission.schema';
|
||||
import { type Role } from '@/user/schemas/role.schema';
|
||||
import { type User } from '@/user/schemas/user.schema';
|
||||
import { EHook, type DeleteResult } from '@/utils/generics/base-repository';
|
||||
|
||||
import '@nestjs/event-emitter';
|
||||
/**
|
||||
* @description Module declaration that extends the NestJS EventEmitter with custom event types and methods.
|
||||
*/
|
||||
declare module '@nestjs/event-emitter' {
|
||||
export interface TDefinition<S, O = object> {
|
||||
schema: S;
|
||||
operations: O;
|
||||
}
|
||||
|
||||
export interface IHookExtensionsOperationMap {}
|
||||
|
||||
export interface IHookSettingsGroupLabelOperationMap {
|
||||
chatbot_settings: TDefinition<
|
||||
object,
|
||||
{
|
||||
global_fallback: Setting;
|
||||
fallback_block: Setting;
|
||||
fallback_message: Setting;
|
||||
}
|
||||
>;
|
||||
contact: TDefinition<
|
||||
object,
|
||||
{
|
||||
contact_email_recipient: Setting;
|
||||
company_name: Setting;
|
||||
company_phone: Setting;
|
||||
company_email: Setting;
|
||||
company_address1: Setting;
|
||||
company_address2: Setting;
|
||||
company_city: Setting;
|
||||
company_zipcode: Setting;
|
||||
company_state: Setting;
|
||||
company_country: Setting;
|
||||
}
|
||||
>;
|
||||
nlp_settings: TDefinition<
|
||||
object,
|
||||
{
|
||||
provider: Setting;
|
||||
endpoint: Setting;
|
||||
token: Setting;
|
||||
threshold: Setting;
|
||||
}
|
||||
>;
|
||||
}
|
||||
|
||||
/* custom hooks */
|
||||
export interface IHookOperationMap
|
||||
extends IHookSettingsGroupLabelOperationMap,
|
||||
IHookExtensionsOperationMap {
|
||||
analytics: TDefinition<
|
||||
object,
|
||||
{
|
||||
block: BlockFull;
|
||||
passation: Subscriber;
|
||||
'fallback-local': BlockFull;
|
||||
'fallback-global': EventWrapper<any, any>;
|
||||
}
|
||||
>;
|
||||
chatbot: TDefinition<
|
||||
object,
|
||||
{
|
||||
sent: unknown;
|
||||
received: unknown;
|
||||
message: unknown;
|
||||
delivery: unknown;
|
||||
read: unknown;
|
||||
typing: unknown;
|
||||
follow: unknown;
|
||||
echo: unknown;
|
||||
}
|
||||
>;
|
||||
websocket: TDefinition<
|
||||
object,
|
||||
{
|
||||
connection: Socket;
|
||||
}
|
||||
>;
|
||||
}
|
||||
|
||||
/* hooks */
|
||||
export interface IHookEntityOperationMap extends IHookOperationMap {
|
||||
stats: TDefinition<BotStats, { entry: string }>;
|
||||
attachment: TDefinition<Attachment>;
|
||||
block: TDefinition<Block>;
|
||||
category: TDefinition<Category>;
|
||||
contextVar: TDefinition<ContextVar>;
|
||||
conversation: TDefinition<Conversation, { end: unknown; close: unknown }>;
|
||||
label: TDefinition<
|
||||
Label,
|
||||
{ create: LabelDocument; delete: Label | Label[] }
|
||||
>;
|
||||
message: TDefinition<Message>;
|
||||
subscriber: TDefinition<Subscriber, { assign: SubscriberUpdateDto }>;
|
||||
contentType: TDefinition<ContentType>;
|
||||
content: TDefinition<Content>;
|
||||
menu: TDefinition<Menu>;
|
||||
language: TDefinition<Language, { delete: Language | Language[] }>;
|
||||
translation: TDefinition<Translation>;
|
||||
nlpEntity: TDefinition<
|
||||
NlpEntity,
|
||||
{
|
||||
create: NlpEntityDocument;
|
||||
update: NlpEntity;
|
||||
delete: NlpEntity | NlpEntity[];
|
||||
}
|
||||
>;
|
||||
nlpSampleEntity: TDefinition<NlpSampleEntity>;
|
||||
nlpSample: TDefinition<NlpSample>;
|
||||
nlpValue: TDefinition<
|
||||
NlpValue,
|
||||
{
|
||||
create: NlpValueDocument;
|
||||
update: NlpValue;
|
||||
delete: NlpValue | NlpValue[];
|
||||
}
|
||||
>;
|
||||
setting: TDefinition<Setting>;
|
||||
invitation: TDefinition<Invitation>;
|
||||
model: TDefinition<Model>;
|
||||
permission: TDefinition<Permission>;
|
||||
role: TDefinition<Role>;
|
||||
user: TDefinition<User, { lastvisit: Subscriber }>;
|
||||
}
|
||||
|
||||
/* entities hooks having schemas */
|
||||
export type IHookEntities = keyof Omit<
|
||||
IHookEntityOperationMap,
|
||||
keyof IHookOperationMap
|
||||
>;
|
||||
|
||||
/**
|
||||
* @description A constrained string type that allows specific string values while preserving type safety.
|
||||
*/
|
||||
export type ConstrainedString = string & Record<never, never>;
|
||||
|
||||
export type EventNamespaces = keyof IHookEntityOperationMap;
|
||||
|
||||
/* pre hooks */
|
||||
export type TPreValidate<T> = THydratedDocument<T>;
|
||||
|
||||
export type TPreCreate<T> = THydratedDocument<T>;
|
||||
|
||||
export type TPreUpdate<T> = TFilterQuery<T> & object;
|
||||
|
||||
export type TPreDelete<T> = Query<
|
||||
DeleteResult,
|
||||
Document<T>,
|
||||
unknown,
|
||||
T,
|
||||
'deleteOne',
|
||||
Record<string, never>
|
||||
>;
|
||||
|
||||
export type TPreUnion<T> =
|
||||
| TPreValidate<T>
|
||||
| TPreCreate<T>
|
||||
| TPreUpdate<T>
|
||||
| TPreDelete<T>;
|
||||
|
||||
/* post hooks */
|
||||
export type TPostValidate<T> = THydratedDocument<T>;
|
||||
|
||||
export type TPostCreate<T> = THydratedDocument<T>;
|
||||
|
||||
export type TPostUpdate<T> = THydratedDocument<T>;
|
||||
|
||||
export type TPostDelete = DeleteResult;
|
||||
|
||||
export type TPostUnion<T> =
|
||||
| TPostValidate<T>
|
||||
| TPostCreate<T>
|
||||
| TPostUpdate<T>
|
||||
| TPostDelete;
|
||||
|
||||
export type TCustomOperations<E extends keyof IHookEntityOperationMap> =
|
||||
IHookEntityOperationMap[E]['operations'][keyof IHookEntityOperationMap[E]['operations']];
|
||||
|
||||
/* union hooks */
|
||||
export type TUnion<G, E> = E extends keyof IHookEntityOperationMap
|
||||
? E extends keyof IHookOperationMap
|
||||
? TCustomOperations<E>
|
||||
: TPreUnion<G> | TPostUnion<G> | TCustomOperations<E>
|
||||
: never;
|
||||
|
||||
/* Normalized hook */
|
||||
export enum EHookPrefix {
|
||||
pre = 'pre',
|
||||
post = 'post',
|
||||
}
|
||||
|
||||
export type TCompatibleHook<
|
||||
P extends `${EHookPrefix}`,
|
||||
T = `${EHook}`,
|
||||
> = T extends `${P}${infer I}` ? `${P}${I}` : never;
|
||||
|
||||
export type TPreHook = TCompatibleHook<EHookPrefix.pre>;
|
||||
|
||||
export type TPostHook = TCompatibleHook<EHookPrefix.post>;
|
||||
|
||||
export type TNormalizedEvents = '*' | TPreHook | TPostHook;
|
||||
|
||||
export type TNormalizedHooks<
|
||||
E extends keyof IHookEntityOperationMap,
|
||||
T = IHookEntityOperationMap[E]['schema'],
|
||||
> =
|
||||
| {
|
||||
[EHook.preValidate]: TPreValidate<T>;
|
||||
}
|
||||
| {
|
||||
[EHook.preCreate]: TPreCreate<T>;
|
||||
}
|
||||
| {
|
||||
[EHook.preUpdate]: TPostUpdate<T>;
|
||||
}
|
||||
| {
|
||||
[EHook.preDelete]: TPreDelete<T>;
|
||||
}
|
||||
| {
|
||||
[EHook.postValidate]: TPostValidate<T>;
|
||||
}
|
||||
| {
|
||||
[EHook.postCreate]: TPostCreate<T>;
|
||||
}
|
||||
| {
|
||||
[EHook.postUpdate]: TPostUpdate<T>;
|
||||
}
|
||||
| {
|
||||
[EHook.postDelete]: TPostDelete;
|
||||
};
|
||||
|
||||
export type TNormalizedHook<
|
||||
E extends keyof IHookEntityOperationMap,
|
||||
O,
|
||||
> = Extract<TNormalizedHooks<E>, { [key in O]: unknown }>[O];
|
||||
|
||||
/* Extended hook */
|
||||
export type TExtendedHook<
|
||||
E extends keyof IHookEntityOperationMap,
|
||||
O extends keyof IHookEntityOperationMap[E]['operations'],
|
||||
> = IHookEntityOperationMap[E]['operations'][O];
|
||||
|
||||
export type EventValueOf<G> = G extends `hook:${infer E}:${infer O}`
|
||||
? O extends '*'
|
||||
? TUnion<G, E>
|
||||
: E extends keyof IHookEntityOperationMap
|
||||
? O extends keyof IHookEntityOperationMap[E]['operations']
|
||||
? TExtendedHook<E, O>
|
||||
: TNormalizedHook<E, O>
|
||||
: never
|
||||
: never;
|
||||
|
||||
export type IsHookEvent<G extends EventNamespaces | ConstrainedString> =
|
||||
G extends EventNamespaces
|
||||
? true
|
||||
: G extends `hook:${infer N}:${string}`
|
||||
? N extends keyof IHookEntityOperationMap
|
||||
? true
|
||||
: false
|
||||
: false;
|
||||
|
||||
export type TCustomEvents<G extends keyof IHookEntityOperationMap> =
|
||||
keyof IHookEntityOperationMap[G]['operations'] & string;
|
||||
|
||||
export type customEvent<G extends EventNamespaces | ConstrainedString> =
|
||||
G extends EventNamespaces
|
||||
? G extends `hook:${string}`
|
||||
? G
|
||||
: `hook:${G}:${TNormalizedEvents | TCustomEvents<G>}`
|
||||
: never;
|
||||
|
||||
export interface ListenerFn<G extends EventNamespaces | ConstrainedString> {
|
||||
(value: EventValueOf<G>, ...values: any[]): void;
|
||||
}
|
||||
|
||||
export class EventEmitter2 {
|
||||
emit<G extends EventNamespaces | ConstrainedString, H extends G>(
|
||||
customEvent: customEvent<G>,
|
||||
value: EventValueOf<H>,
|
||||
...values: any[]
|
||||
): boolean;
|
||||
|
||||
emitAsync<G extends EventNamespaces | ConstrainedString, H extends G>(
|
||||
customEvent: customEvent<G>,
|
||||
value: EventValueOf<H>,
|
||||
...values: any[]
|
||||
): Promise<any[]>;
|
||||
|
||||
addListener<G extends EventNamespaces | ConstrainedString, H extends G>(
|
||||
customEvent: customEvent<G>,
|
||||
listener: ListenerFn<H>,
|
||||
): this | Listener;
|
||||
|
||||
on<G extends EventNamespaces | ConstrainedString, H extends G>(
|
||||
customEvent: customEvent<G>,
|
||||
listener: ListenerFn<H>,
|
||||
options?: boolean | OnOptions,
|
||||
): this | Listener;
|
||||
|
||||
once<G extends EventNamespaces | ConstrainedString, H extends G>(
|
||||
customEvent: customEvent<G>,
|
||||
listener: ListenerFn<H>,
|
||||
options?: true | OnOptions,
|
||||
): this | Listener;
|
||||
|
||||
prependOnceListener<
|
||||
G extends EventNamespaces | ConstrainedString,
|
||||
H extends G,
|
||||
>(
|
||||
customEvent: customEvent<G>,
|
||||
listener: ListenerFn<H>,
|
||||
options?: boolean | OnOptions,
|
||||
): this | Listener;
|
||||
|
||||
many<G extends EventNamespaces | ConstrainedString, H extends G>(
|
||||
customEvent: customEvent<G>,
|
||||
timesToListen: number,
|
||||
listener: ListenerFn<H>,
|
||||
options?: boolean | OnOptions,
|
||||
): this | Listener;
|
||||
|
||||
prependMany<G extends EventNamespaces | ConstrainedString, H extends G>(
|
||||
customEvent: customEvent<G>,
|
||||
timesToListen: number,
|
||||
listener: ListenerFn<H>,
|
||||
options?: boolean | OnOptions,
|
||||
): this | Listener;
|
||||
|
||||
removeListener<G extends EventNamespaces | ConstrainedString, H extends G>(
|
||||
customEvent: customEvent<G>,
|
||||
listener: ListenerFn<H>,
|
||||
): this;
|
||||
|
||||
off<G extends EventNamespaces | ConstrainedString, H extends G>(
|
||||
customEvent: customEvent<G>,
|
||||
listener: ListenerFn<H>,
|
||||
): this;
|
||||
}
|
||||
|
||||
declare type OnEventMethodDecorator<
|
||||
G extends EventNamespaces | ConstrainedString,
|
||||
> = <T, K extends keyof T>(
|
||||
target: IsHookEvent<G> extends true
|
||||
? [T[K]] extends [(params: EventValueOf<G>, ...rest: any[]) => any]
|
||||
? T
|
||||
: never
|
||||
: T,
|
||||
propertyKey: K,
|
||||
) => void;
|
||||
|
||||
export declare function OnEvent<
|
||||
G extends EventNamespaces | ConstrainedString,
|
||||
H extends G,
|
||||
>(
|
||||
event: customEvent<G>,
|
||||
options?: OnEventOptions | undefined,
|
||||
): OnEventMethodDecorator<H>;
|
||||
}
|
||||
8
api/types/mongoose.d.ts
vendored
8
api/types/mongoose.d.ts
vendored
@@ -6,19 +6,19 @@
|
||||
* 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
|
||||
*/
|
||||
|
||||
import 'mongoose';
|
||||
import {
|
||||
ObjectWithNestedKeys,
|
||||
RecursivePartial,
|
||||
WithoutGenericAny,
|
||||
} from '../src/utils/types/filter.types';
|
||||
} from '@/utils/types/filter.types';
|
||||
import 'mongoose';
|
||||
|
||||
declare module 'mongoose' {
|
||||
type TOmitId<T> = Omit<T, 'id'>;
|
||||
type TReplaceId<T> = TOmitId<T> & { _id?: string };
|
||||
|
||||
// Enforce the typing with an alternative type to FilterQuery compatible with mongoose: version 8.0.0
|
||||
export type TFilterQuery<T, S = TReplaceId<T>> = (
|
||||
type TFilterQuery<T, S = TReplaceId<T>> = (
|
||||
| RecursivePartial<{
|
||||
[P in keyof S]?:
|
||||
| (S[P] extends string ? S[P] | RegExp : S[P])
|
||||
@@ -28,5 +28,5 @@ declare module 'mongoose' {
|
||||
) &
|
||||
WithoutGenericAny<RootQuerySelector<S>>;
|
||||
|
||||
export type THydratedDocument<T> = TOmitId<HydratedDocument<T>>;
|
||||
type THydratedDocument<T> = TOmitId<HydratedDocument<T>>;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user