lonnymq 0.0.0

package/dist/index.d.ts

@@ -0,0 +1,304 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type DeferredGetResult<T> = {
+	resultType: "RESULT_NOT_SET";
+} | {
+	resultType: "RESULT_SET";
+	value: T;
+};
+export declare class Deferred<T> {
+	private value;
+	private isSet;
+	constructor();
+	get(): DeferredGetResult<T>;
+	set(value: T): void;
+}
+export type DatabaseClientQueryResult = {
+	rows: Array<Record<string, unknown>>;
+};
+export interface DatabaseClient {
+	query(query: string): Promise<DatabaseClientQueryResult>;
+}
+export declare class ChannelPolicyClearCommand {
+	readonly schema: string;
+	readonly channelName: string;
+	readonly createdAt: Date;
+	constructor(params: {
+		schema: string;
+		channelName: string;
+	});
+	sortKeyGet(): string;
+	execute(databaseClient: DatabaseClient): Promise<void>;
+}
+export declare class ChannelPolicySetCommand {
+	readonly schema: string;
+	readonly channelName: string;
+	readonly maxSize: number | null;
+	readonly maxConcurrency: number | null;
+	readonly createdAt: Date;
+	constructor(params: {
+		schema: string;
+		channelName: string;
+		maxSize: number | null;
+		maxConcurrency: number | null;
+	});
+	sortKeyGet(): string;
+	execute(databaseClient: DatabaseClient): Promise<void>;
+}
+export type MessageCreateCommandResultMessageCreated = {
+	resultType: "MESSAGE_CREATED";
+	id: string;
+};
+export type MessageCreateCommandResultMessageDeduplicated = {
+	resultType: "MESSAGE_DEDUPLICATED";
+	id: string;
+};
+export type MessageCreateCommandResultMessageDropped = {
+	resultType: "MESSAGE_DROPPED";
+};
+export type MessageCreateCommandResult = MessageCreateCommandResultMessageCreated | MessageCreateCommandResultMessageDeduplicated | MessageCreateCommandResultMessageDropped;
+export declare class MessageCreateCommand {
+	readonly schema: string;
+	readonly channelName: string;
+	readonly name: string | null;
+	readonly content: string;
+	readonly lockMs: number;
+	readonly delayMs: number;
+	readonly createdAt: Date;
+	constructor(params: {
+		schema: string;
+		channelName: string;
+		name?: string;
+		content: string;
+		lockMs?: number;
+		delayMs?: number;
+		priority?: boolean;
+	});
+	execute(databaseClient: DatabaseClient): Promise<MessageCreateCommandResult>;
+}
+export type MessageDequeueCommandResultMessageDequeued = {
+	resultType: "MESSAGE_DEQUEUED";
+	message: {
+		id: string;
+		channelName: string;
+		name: string | null;
+		content: string;
+		dequeueId: string;
+		state: string | null;
+		numAttempts: number;
+		lockMs: number;
+	};
+};
+export type MessageDequeueCommandResultMessageNotAvailable = {
+	resultType: "MESSAGE_NOT_AVAILABLE";
+	retryMs: number | null;
+};
+export type MessageDequeueCommandResult = MessageDequeueCommandResultMessageDequeued | MessageDequeueCommandResultMessageNotAvailable;
+export declare class MessageDequeueCommand {
+	readonly schema: string;
+	constructor(params: {
+		schema: string;
+	});
+	execute(databaseClient: DatabaseClient): Promise<MessageDequeueCommandResult>;
+}
+export type MessageDeleteCommandResultMessageNotFound = {
+	resultType: "MESSAGE_NOT_FOUND";
+};
+export type MessageDeleteCommandResultStateInvalid = {
+	resultType: "STATE_INVALID";
+};
+export type MessageDeleteCommandResultMessageDeleted = {
+	resultType: "MESSAGE_DELETED";
+};
+export type MessageDeleteCommandResult = MessageDeleteCommandResultMessageNotFound | MessageDeleteCommandResultStateInvalid | MessageDeleteCommandResultMessageDeleted;
+export declare class MessageDeleteCommand {
+	readonly schema: string;
+	readonly id: string;
+	readonly dequeueId: string;
+	constructor(params: {
+		schema: string;
+		id: string;
+		dequeueId: string;
+	});
+	execute(databaseClient: DatabaseClient): Promise<MessageDeleteCommandResult>;
+}
+export type MessageDeferCommandResultMessageNotFound = {
+	resultType: "MESSAGE_NOT_FOUND";
+};
+export type MessageDeferCommandResultStateInvalid = {
+	resultType: "STATE_INVALID";
+};
+export type MessageDeferCommandResultMessageDeferred = {
+	resultType: "MESSAGE_DEFERRED";
+};
+export type MessageDeferCommandResult = MessageDeferCommandResultMessageNotFound | MessageDeferCommandResultStateInvalid | MessageDeferCommandResultMessageDeferred;
+export declare class MessageDeferCommand {
+	readonly schema: string;
+	readonly id: string;
+	readonly dequeueId: string;
+	readonly delayMs: number;
+	readonly state: string | null;
+	constructor(params: {
+		schema: string;
+		id: string;
+		dequeueId: string;
+		delayMs?: number;
+		state?: string | null;
+		priority?: boolean;
+	});
+	execute(databaseClient: DatabaseClient): Promise<MessageDeferCommandResult>;
+}
+export declare class QueueBatchChannelMessage {
+	private readonly schema;
+	private readonly channelName;
+	private readonly registerFn;
+	constructor(params: {
+		schema: string;
+		channelName: string;
+		registerFn: BatchedCommandRegisterFn;
+	});
+	create(params: {
+		name?: string;
+		lockMs?: number;
+		content: string;
+		delayMs?: number;
+		priority?: boolean;
+	}): Deferred<MessageCreateCommandResult>;
+}
+export declare class QueueBatchChannelPolicy {
+	private readonly schema;
+	private readonly channelName;
+	private readonly registerFn;
+	constructor(params: {
+		schema: string;
+		channelName: string;
+		registerFn: BatchedCommandRegisterFn;
+	});
+	set(params: {
+		maxConcurrency: number | null;
+		maxSize: number | null;
+	}): Deferred<void>;
+	clear(): Deferred<void>;
+}
+export declare class QueueBatchChannel {
+	readonly policy: QueueBatchChannelPolicy;
+	readonly message: QueueBatchChannelMessage;
+	constructor(params: {
+		schema: string;
+		registerFn: BatchedCommandRegisterFn;
+		channelName: string;
+	});
+}
+export type BatchedCommand = {
+	sortKey: string;
+	execute: (databaseClient: DatabaseClient) => Promise<void>;
+};
+export type BatchedCommandRegisterFn = (command: BatchedCommand) => void;
+export declare class QueueBatch {
+	private readonly commands;
+	private readonly schema;
+	constructor(params: {
+		schema: string;
+	});
+	channel(channelName: string): QueueBatchChannel;
+	execute(params: {
+		databaseClient: DatabaseClient;
+	}): Promise<void>;
+}
+export declare class QueueChannelMessage {
+	private readonly schema;
+	private readonly channelName;
+	constructor(params: {
+		schema: string;
+		channelName: string;
+	});
+	create(params: {
+		databaseClient: DatabaseClient;
+		name?: string;
+		lockMs?: number;
+		content: string;
+		delayMs?: number;
+		priority?: boolean;
+	}): Promise<MessageCreateCommandResult>;
+}
+export declare class QueueChannelPolicy {
+	private readonly schema;
+	private readonly channelName;
+	constructor(params: {
+		schema: string;
+		channelName: string;
+	});
+	set(params: {
+		databaseClient: DatabaseClient;
+		maxConcurrency: number | null;
+		maxSize: number | null;
+	}): Promise<void>;
+	clear(params: {
+		databaseClient: DatabaseClient;
+	}): Promise<void>;
+}
+export declare class QueueChannel {
+	readonly policy: QueueChannelPolicy;
+	readonly message: QueueChannelMessage;
+	constructor(params: {
+		schema: string;
+		channelName: string;
+	});
+}
+export declare class QueueMessage {
+	private readonly schema;
+	readonly id: string;
+	readonly channelName: string;
+	readonly name: string | null;
+	readonly content: string;
+	readonly dequeueId: string;
+	readonly state: string | null;
+	readonly numAttempts: number;
+	readonly lockMs: number;
+	constructor(params: {
+		schema: string;
+		id: string;
+		dequeueId: string;
+		channelName: string;
+		name: string | null;
+		content: string;
+		state: string | null;
+		numAttempts: number;
+		lockMs: number;
+	});
+	defer(params: {
+		databaseClient: DatabaseClient;
+		delayMs?: number;
+		priority?: boolean;
+		state?: string;
+	}): Promise<MessageDeferCommandResult>;
+	delete(params: {
+		databaseClient: DatabaseClient;
+	}): Promise<MessageDeleteCommandResult>;
+}
+export type QueueMigration = {
+	name: string;
+	sql: string[];
+};
+export type MessageDequeueResult = {
+	resultType: "MESSAGE_NOT_AVAILABLE";
+	retryMs: number | null;
+} | {
+	resultType: "MESSAGE_DEQUEUED";
+	message: QueueMessage;
+};
+export declare class Queue {
+	private readonly schema;
+	constructor(schema: string);
+	dequeue(params: {
+		databaseClient: DatabaseClient;
+	}): Promise<MessageDequeueResult>;
+	channel(channelName: string): QueueChannel;
+	batch(): QueueBatch;
+	migrations(params: {
+		useWake?: boolean;
+	}): QueueMigration[];
+	wakeChannel(): string;
+}
+
+export {};