denotify-client 1.1.16 → 1.1.17

package/dist/denotify-client.d.ts

@@ -2,11 +2,28 @@
 
 import * as yup from 'yup';
 
+export type DiscordEmbedOptions = {
+	type?: string;
+	title?: string;
+	color?: number;
+	thumbnail?: {
+		url?: string;
+		height?: number;
+		width?: number;
+	};
+	image?: {
+		url?: string;
+		height?: number;
+		width?: number;
+	};
+	url?: string;
+};
 export type DiscordWebhook = {
 	url: string;
 	username?: string;
 	avatar_url?: string;
 	message: string;
+	embed?: DiscordEmbedOptions;
 };
 export type NotifyDiscordWebhookRawId = "notify_discord_webhook";
 export type NotifyDiscordWebhookRawResponse = {
@@ -16,11 +33,36 @@ export type NotifyDiscordWebhookRawResponse = {
 	username: string;
 	avatar_url: string;
 	message: string;
+	embed?: DiscordEmbedOptions;
+};
+export type Email = {
+	email: string;
+	subject?: string;
+	html: string;
+};
+export type NotifyEmailRawId = "notify_telegram";
+export type NotifyEmailRawResponse = {
+	id: number;
+	created_at: string;
+	email: string;
+	subject: string | null;
+	html: string;
 };
-export type NotificationTypeId = "Discord";
-export type NotificationConfig = DiscordWebhook;
-export type NotifyRawId = NotifyDiscordWebhookRawId;
-export type NotifyRawResponse = NotifyDiscordWebhookRawResponse;
+export type Telegram = {
+	clientId: number;
+	content: string;
+};
+export type NotifyTelegramRawId = "notify_telegram";
+export type NotifyTelegramRawResponse = {
+	id: number;
+	created_at: string;
+	clientId: number;
+	content: string;
+};
+export type NotificationTypeId = "Discord" | "Telegram" | "Email";
+export type NotificationConfig = DiscordWebhook | Telegram | Email;
+export type NotifyRawId = NotifyDiscordWebhookRawId | NotifyTelegramRawId | NotifyEmailRawId;
+export type NotifyRawResponse = NotifyDiscordWebhookRawResponse | NotifyTelegramRawResponse | NotifyEmailRawResponse;
 export type NotificationRawResponse = {
 	notify_type: NotifyRawId;
 	notify: NotifyRawResponse;
@@ -107,7 +149,7 @@ export declare class FunctionBuilder {
 	private constructor();
 	static create(api?: DeNotifyClient): FunctionBuilder;
 	getAbiHash(abi: any): Promise<string>;
-	addFunction<T = any>(address: string, func: string, args: T[], abi: any): Promise<this>;
+	addFunction<T = any>(address: string, func: string, args: T[], abi: any, abiHash?: string): Promise<this>;
 	get(): FunctionCallerConfig;
 	static schema(): yup.ArraySchema<{
 		function: string;
@@ -126,8 +168,8 @@ export type FilterCondition = {
 	logic?: Logic;
 	key: string;
 	type: FilterDataTypes;
-	operation: FilterOpertationType;
-	constant: string | number;
+	operation: FilterOpertationType | string;
+	constant: string | number | any;
 };
 export type ConditionGroup = {
 	logic: Logic;
@@ -143,14 +185,14 @@ export declare class FilterBuilder {
 	addCondition(logic: Logic, key: string, type: FilterDataTypes, operation: FilterOpertationType, constant: string | number): FilterBuilder;
 	finalise(): ConditionGroup[];
 	static schema(): yup.ArraySchema<{
-		conditions?: {
-			constant?: {} | undefined;
-			operation?: string | undefined;
+		logic: NonNullable<"AND" | "OR" | "XOR" | "NAND" | "NOR" | "WHERE" | undefined>;
+		conditions: {
 			type: NonNullable<"String" | "Address" | "Number" | undefined>;
 			key: string;
+			constant: {};
 			logic: NonNullable<"AND" | "OR" | "XOR" | "NAND" | "NOR" | "WHERE" | undefined>;
-		}[] | undefined;
-		logic: NonNullable<"AND" | "OR" | "XOR" | "NAND" | "NOR" | "WHERE" | undefined>;
+			operation: string;
+		}[];
 	}[] | undefined, yup.AnyObject, "", "">;
 }
 export type TimeBase = "blocks" | "time";
@@ -199,12 +241,49 @@ export type HandlerFunctionCallV2RawResponse = {
 	abi: string[];
 	version: number;
 };
+export type OnchainEventV2 = {
+	addresses: string[];
+	abiHash: string;
+	event: string;
+	debounceCount?: number;
+	functions?: FunctionCallerConfig;
+	triggerOn?: "always" | "filter";
+	latch?: boolean;
+	filterVersion?: string;
+	filter?: FilterConfig;
+};
+export type HandlerOnchainEventV2RawConfig = {
+	addresses: string[];
+	abiHash: string;
+	event: string;
+	debounceCount?: number;
+	functions: FunctionCallerConfig | null;
+	triggerOn: "always" | "filter";
+	latch: boolean;
+	filterVersion: string | null;
+	filter: FilterConfig | null;
+};
+export type HandlerOnchainEventV2Update = Partial<HandlerOnchainEventV2RawConfig>;
+export type HandlerOnchainEventV2RawResponse = {
+	id: number;
+	created_at: string;
+	nBlocks: number;
+	address: string;
+	fixedArgs: string[];
+	responseArgIndex: number;
+	responseArgDecimals: number;
+	function: string;
+	condition: Condition;
+	constant: number;
+	abi: string[];
+	version: number;
+};
 export type Network = "ethereum" | "avalanche" | "bsc" | "polygon" | "fantom" | "optimism" | "arbitrum" | "canto";
-export type TriggerConfig = PollFunctionV2 | PollFunctionV1 | OnchainEventV1;
-export type TriggerTypeId = "PollFunctionV2" | "OnchainEventV1" | "PollFunctionV1";
-export type TriggerUpdate = HandlerFunctionCallV2Update | HandlerFunctionCallUpdate | HandlerOnchainEventUpdate;
-export type TriggerTypeRawId = "handler_function_call" | "handler_onchain_event" | "handler_function_call_v2";
-export type HandlerRawResponse = HandlerFunctionCallV2RawResponse | HandlerFunctionCallRawResponse | HandlerOnchainEventRawResponse;
+export type TriggerConfig = PollFunctionV2 | PollFunctionV1 | OnchainEventV1 | OnchainEventV2;
+export type TriggerTypeId = "PollFunctionV2" | "OnchainEventV1" | "PollFunctionV1" | "OnchainEventV2";
+export type TriggerUpdate = HandlerFunctionCallV2Update | HandlerFunctionCallUpdate | HandlerOnchainEventUpdate | HandlerOnchainEventV2Update;
+export type TriggerTypeRawId = "handler_function_call" | "handler_onchain_event" | "handler_function_call_v2" | "handler_onchain_event_v2";
+export type HandlerRawResponse = HandlerFunctionCallV2RawResponse | HandlerFunctionCallRawResponse | HandlerOnchainEventRawResponse | HandlerOnchainEventV2RawResponse;
 export type TriggerRawResponse = {
 	id: number;
 	type: TriggerTypeRawId;
@@ -273,10 +352,11 @@ export declare class DeNotifyClient {
 	deleteAlert(id: number): Promise<any>;
 	private request;
 	getAbi(network: string, address: string): Promise<{
-		abi: any[];
+		abi: unknown[];
 		proxy?: string;
+		hash: string;
 	}>;
-	getAbiHash(abi: any): Promise<any>;
+	getAbiHash(abi: unknown): Promise<any>;
 	setAlertName(_triggerId: number, _name: string): Promise<void>;
 	enableAlert(_triggerId: number): Promise<void>;
 	disableAlert(_triggerId: number): Promise<void>;
@@ -300,55 +380,8 @@ export declare class AlertBuilder {
 	 * @param options Desired trigger configuration
 	 * @returns self for piping
 	 */
-	withTrigger<TTriggerTypeId extends TriggerTypeId>(id: TTriggerTypeId, options: TTriggerTypeId extends "PollFunctionV2" ? PollFunctionV2 : TTriggerTypeId extends "OnchainEventV1" ? OnchainEventV1 : TTriggerTypeId extends "PollFunctionV1" ? PollFunctionV1 : never): AlertBuilder;
-	withNotification<TNotificationTypeId extends NotificationTypeId>(id: TNotificationTypeId, options: TNotificationTypeId extends "Discord" ? DiscordWebhook : never): AlertBuilder;
-	validate(): Promise<{
-		username?: string | undefined;
-		avatar_url?: string | undefined;
-		message: string;
-		url: string;
-	} | {
-		condition?: string | undefined;
-		nBlocks?: number | undefined;
-		constant?: number | undefined;
-		responseArgIndex?: number | undefined;
-		responseArgDecimals?: number | undefined;
-		address: string;
-		abi: any[];
-	} | {
-		condition?: string | undefined;
-		constant?: number | undefined;
-		paramsIndex?: number | undefined;
-		paramsDecimals?: number | undefined;
-		address: string;
-		event: string;
-		abi: any[];
-	} | {
-		filter?: {
-			conditions?: {
-				constant?: {} | undefined;
-				operation?: string | undefined;
-				type: NonNullable<"String" | "Address" | "Number" | undefined>;
-				key: string;
-				logic: NonNullable<"AND" | "OR" | "XOR" | "NAND" | "NOR" | "WHERE" | undefined>;
-			}[] | undefined;
-			logic: NonNullable<"AND" | "OR" | "XOR" | "NAND" | "NOR" | "WHERE" | undefined>;
-		}[] | undefined;
-		nBlocks?: number | undefined;
-		timePeriod?: string | undefined;
-		debounceCount?: number | undefined;
-		functions?: {
-			function: string;
-			address: string;
-			bytecode: string;
-			abiHash: string;
-		}[] | undefined;
-		filterVersion?: string | undefined;
-		startTime: number;
-		latch: boolean;
-		timeBase: NonNullable<"time" | "blocks" | undefined>;
-		triggerOn: "filter" | "always";
-	}>;
+	withTrigger<TTriggerTypeId extends TriggerTypeId>(id: TTriggerTypeId, options: TTriggerTypeId extends "PollFunctionV2" ? PollFunctionV2 : TTriggerTypeId extends "OnchainEventV2" ? OnchainEventV2 : TTriggerTypeId extends "PollFunctionV1" ? PollFunctionV1 : TTriggerTypeId extends "OnchainEventV1" ? OnchainEventV1 : never): AlertBuilder;
+	withNotification<TNotificationTypeId extends NotificationTypeId>(id: TNotificationTypeId, options: TNotificationTypeId extends "Discord" ? DiscordWebhook : TNotificationTypeId extends "Telegram" ? Telegram : TNotificationTypeId extends "Email" ? Email : never): AlertBuilder;
 	config(): Promise<AlertConfig>;
 }