denotify-client 1.1.11 → 1.1.12

package/dist/denotify-client.d.ts

@@ -0,0 +1,355 @@
+// Generated by dts-bundle-generator v7.2.0
+
+import * as yup from 'yup';
+
+export type DiscordWebhook = {
+	url: string;
+	username?: string;
+	avatar_url?: string;
+	message: string;
+};
+export type NotifyDiscordWebhookRawId = "notify_discord_webhook";
+export type NotifyDiscordWebhookRawResponse = {
+	id: number;
+	created_at: string;
+	url: string;
+	username: string;
+	avatar_url: string;
+	message: string;
+};
+export type NotificationTypeId = "Discord";
+export type NotificationConfig = DiscordWebhook;
+export type NotifyRawId = NotifyDiscordWebhookRawId;
+export type NotifyRawResponse = NotifyDiscordWebhookRawResponse;
+export type NotificationRawResponse = {
+	notify_type: NotifyRawId;
+	notify: NotifyRawResponse;
+	error: boolean;
+	error_message: string | null;
+	error_timestamp: number | null;
+};
+export type PollFunctionV1 = {
+	nBlocks: number;
+	address: string;
+	abi: any;
+	fixedArgs?: (string | number)[];
+	function: string;
+	condition: Condition;
+	responseArgIndex?: number;
+	responseArgDecimals?: number;
+	constant?: number;
+};
+export type HandlerFunctionCallRawConfig = {
+	nBlocks: number;
+	address: string;
+	abi: any;
+	fixedArgs?: (string | number)[];
+	function: string;
+	condition: Condition;
+	responseArgIndex?: number;
+	responseArgDecimals?: number;
+	constant?: number;
+};
+export type HandlerFunctionCallUpdate = Partial<HandlerFunctionCallRawConfig>;
+export type HandlerFunctionCallRawResponse = {
+	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 OnchainEventV1 = {
+	address: string;
+	event: string;
+	abi: any;
+	condition: Condition;
+	paramsIndex?: number;
+	paramsDecimals?: number;
+	constant?: number;
+};
+export type HandlerOnchainEventRawConfig = {
+	address: string;
+	event: string;
+	abi: any;
+	condition: Condition;
+	paramsIndex?: number;
+	paramsDecimals?: number;
+	constant?: number;
+};
+export type HandlerOnchainEventUpdate = Partial<HandlerOnchainEventRawConfig>;
+export type HandlerOnchainEventRawResponse = {
+	id: number;
+	created_at: string;
+	address: string;
+	event: string;
+	abi: any;
+	paramsIndex: number;
+	paramsDecimals: number;
+	condition: Condition;
+	constant: number;
+};
+export type FunctionCallerConfig = {
+	address: string;
+	bytecode: string;
+	abiHash: string;
+	function: string;
+}[];
+export declare class FunctionBuilder {
+	private api?;
+	private data;
+	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>;
+	get(): FunctionCallerConfig;
+	static schema(): yup.ArraySchema<{
+		function: string;
+		address: string;
+		bytecode: string;
+		abiHash: string;
+	}[] | undefined, yup.AnyObject, "", "">;
+}
+export type Logic = "AND" | "OR" | "XOR" | "NAND" | "NOR" | "WHERE";
+export type NumericOperation = "eq" | "!eq" | "gt" | "gte" | "lt" | "lte";
+export type StringOperation = "contains" | "!contains" | "is" | "!is" | "isEmpty" | "!isEmpty";
+export type AddressOperation = "is" | "!is" | "isEmpty" | "!isEmpty";
+export type FilterDataTypes = "String" | "Address" | "Number";
+export type FilterOpertationType = NumericOperation | StringOperation | AddressOperation;
+export type FilterCondition = {
+	logic?: Logic;
+	key: string;
+	type: FilterDataTypes;
+	operation: FilterOpertationType;
+	constant: string | number;
+};
+export type ConditionGroup = {
+	logic: Logic;
+	conditions: FilterCondition[];
+};
+export type FilterConfig = ConditionGroup[];
+export declare class FilterBuilder {
+	private groups;
+	constructor();
+	static version(): string;
+	static new(): FilterBuilder;
+	newGroup(logic: Logic): 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;
+			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, yup.AnyObject, "", "">;
+}
+export type TimeBase = "blocks" | "time";
+/**
+ * @typedef PollFunction
+ * @param {TimeBase} timeBase - Supports two poll period types. 'block' will test the trigger ever nBlocks blocks, 'time' will test the trigger as specified by timePeriod
+ * @param {number} nBlocks -
+ *
+ */
+export type PollFunctionV2 = {
+	timeBase: TimeBase;
+	nBlocks?: number;
+	timePeriod?: string | null;
+	startTime?: number;
+	debounceCount?: number;
+	functions: FunctionCallerConfig;
+	triggerOn: "always" | "filter";
+	latch?: boolean;
+	filterVersion?: string;
+	filter?: FilterConfig;
+};
+export type HandlerFunctionCallV2RawConfig = {
+	timeBase: TimeBase;
+	nBlocks?: number;
+	timePeriod?: string | null;
+	startTime?: number;
+	debounceCount?: number;
+	functions: FunctionCallerConfig;
+	triggerOn: "always" | "filter";
+	latch?: boolean;
+	filterVersion?: string;
+	filter?: FilterConfig;
+};
+export type HandlerFunctionCallV2Update = Partial<HandlerFunctionCallV2RawConfig>;
+export type HandlerFunctionCallV2RawResponse = {
+	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 = "avalanche" | "ethereum";
+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 TriggerRawResponse = {
+	id: number;
+	type: TriggerTypeRawId;
+	triggered: boolean;
+	lastBlock: number;
+	alertType: "event" | "latch";
+	enabled: boolean;
+	nickname: string;
+	error: boolean;
+	error_message: string | null;
+	error_timestamp: number | null;
+	network: Network;
+	handler: HandlerRawResponse;
+};
+export type Condition = ">" | ">=" | "<" | "<=" | "=" | "true";
+export type DeNotifyOptions = {
+	email?: string;
+	password?: string;
+	projectId?: string;
+	key?: string;
+	url?: string;
+	anonKey?: string;
+};
+export type AlertConfig = {
+	name: string;
+	network: Network;
+	triggerId: TriggerTypeId;
+	trigger: TriggerConfig;
+	notificationId: NotificationTypeId;
+	notification: NotificationConfig;
+};
+export type Pagination = {
+	page?: number;
+	size?: number;
+};
+export type HistoryParams = {
+	id?: number;
+	page?: number;
+	size?: number;
+};
+export type AlertHistory = {
+	type: "trigger" | "notification";
+	set: boolean;
+	alert_id: number;
+	block: number;
+	metadata: any;
+	subtype: TriggerTypeRawId | NotifyRawId;
+};
+export type AlertRawResponse = {
+	alertId: number;
+	trigger: TriggerRawResponse;
+	notification: NotificationRawResponse;
+};
+export declare class DeNotifyClient {
+	private url;
+	private headers;
+	private constructor();
+	static create(options: DeNotifyOptions): Promise<DeNotifyClient>;
+	alertHistory(id?: number | null, pagination?: Pagination): Promise<{
+		params: HistoryParams;
+		history: AlertHistory[];
+	}>;
+	getAlert(id: number): Promise<AlertRawResponse>;
+	getAlerts(): Promise<AlertRawResponse[]>;
+	createAlert(config: AlertConfig): Promise<any>;
+	deleteAlert(id: number): Promise<any>;
+	private request;
+	getAbi(network: string, address: string): Promise<{
+		abi: any[];
+		proxy?: string;
+	}>;
+	getAbiHash(abi: any): Promise<any>;
+	setAlertName(_triggerId: number, _name: string): Promise<void>;
+	enableAlert(_triggerId: number): Promise<void>;
+	disableAlert(_triggerId: number): Promise<void>;
+	updateNotification(_triggerId: number): Promise<void>;
+	updateTrigger(triggerId: number, update: TriggerUpdate): Promise<any>;
+}
+export declare class AlertBuilder {
+	private name;
+	private network?;
+	private triggerId?;
+	private trigger?;
+	private notificationId?;
+	private notification?;
+	private constructor();
+	static create(name: string): AlertBuilder;
+	onNetwork(network: Network): AlertBuilder;
+	/**
+	 * Call withTrigger with one of the TriggerConfig types:
+	 * PollFunctionV2 | PollFunctionV1 | OnchainEventV1
+	 * @param id Simple ID
+	 * @param options Desired trigger configuration
+	 * @returns self for piping
+	 */
+	withTrigger<T>(id: TriggerTypeId, options: T): AlertBuilder;
+	withNotification<T = NotificationConfig>(id: NotificationTypeId, options: T): 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";
+	}>;
+	config(): Promise<AlertConfig>;
+}
+
+export {};