akeyless-server-commons 1.0.203 → 1.0.205
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/helpers/index.d.ts +1 -1
- package/dist/cjs/helpers/index.js +1 -1
- package/dist/cjs/helpers/index.js.map +1 -1
- package/dist/cjs/helpers/postponed_actions.d.ts +113 -0
- package/dist/cjs/helpers/postponed_actions.js +363 -0
- package/dist/cjs/helpers/postponed_actions.js.map +1 -0
- package/dist/cjs/helpers/start.js +16 -18
- package/dist/cjs/helpers/start.js.map +1 -1
- package/dist/cjs/managers/index.d.ts +1 -0
- package/dist/cjs/managers/index.js +1 -0
- package/dist/cjs/managers/index.js.map +1 -1
- package/dist/cjs/managers/rabbitmq_manager.d.ts +60 -0
- package/dist/cjs/managers/rabbitmq_manager.js +190 -0
- package/dist/cjs/managers/rabbitmq_manager.js.map +1 -0
- package/dist/esm/helpers/index.d.ts +1 -1
- package/dist/esm/helpers/index.js +1 -1
- package/dist/esm/helpers/index.js.map +1 -1
- package/dist/esm/helpers/postponed_actions.d.ts +113 -0
- package/dist/esm/helpers/postponed_actions.js +359 -0
- package/dist/esm/helpers/postponed_actions.js.map +1 -0
- package/dist/esm/helpers/start.js +16 -18
- package/dist/esm/helpers/start.js.map +1 -1
- package/dist/esm/managers/index.d.ts +1 -0
- package/dist/esm/managers/index.js +1 -0
- package/dist/esm/managers/index.js.map +1 -1
- package/dist/esm/managers/rabbitmq_manager.d.ts +60 -0
- package/dist/esm/managers/rabbitmq_manager.js +183 -0
- package/dist/esm/managers/rabbitmq_manager.js.map +1 -0
- package/dist/helpers/boards_helpers.js +62 -0
- package/dist/helpers/email_helpers.js +153 -0
- package/dist/helpers/firebase_helpers.js +601 -0
- package/dist/helpers/global_helpers.js +147 -0
- package/dist/helpers/index.js +13 -0
- package/dist/helpers/location_helpers.js +15 -0
- package/dist/helpers/login_helpers.js +18 -0
- package/dist/helpers/notification_helpers.js +248 -0
- package/dist/helpers/phone_number_helpers.js +96 -0
- package/dist/helpers/postponed_actions.js +358 -0
- package/dist/helpers/redis/helpers.js +215 -0
- package/dist/helpers/redis/index.js +4 -0
- package/dist/helpers/redis/initialize.js +139 -0
- package/dist/helpers/redis/keys.js +23 -0
- package/dist/helpers/redis/snapshot.js +166 -0
- package/dist/helpers/start.js +83 -0
- package/dist/helpers/tasks_helpers.js +139 -0
- package/dist/helpers/time_helpers.js +167 -0
- package/dist/index.js +5 -0
- package/dist/managers/cache_manager.js +37 -0
- package/dist/managers/index.js +4 -0
- package/dist/managers/logger_manager.js +68 -0
- package/dist/managers/rabbitmq_manager.js +182 -0
- package/dist/managers/translation_manager.js +38 -0
- package/dist/middlewares/auth_mw.js +50 -0
- package/dist/middlewares/error_handling.js +20 -0
- package/dist/middlewares/global_mw.js +119 -0
- package/dist/middlewares/index.js +4 -0
- package/dist/middlewares/trim_mw.js +7 -0
- package/dist/test.js +1 -0
- package/dist/types/enums/global.js +8 -0
- package/dist/types/enums/index.js +1 -0
- package/dist/types/helpers/boards_helpers.d.ts +10 -0
- package/dist/types/helpers/email_helpers.d.ts +12 -0
- package/dist/types/helpers/firebase_helpers.d.ts +56 -0
- package/dist/types/helpers/global_helpers.d.ts +16 -0
- package/dist/types/helpers/index.d.ts +13 -0
- package/dist/types/helpers/location_helpers.d.ts +3 -0
- package/dist/types/helpers/login_helpers.d.ts +4 -0
- package/dist/types/helpers/notification_helpers.d.ts +11 -0
- package/dist/types/helpers/phone_number_helpers.d.ts +19 -0
- package/dist/types/helpers/postponed_actions.d.ts +113 -0
- package/dist/types/helpers/redis/helpers.d.ts +11 -0
- package/dist/types/helpers/redis/index.d.ts +4 -0
- package/dist/types/helpers/redis/initialize.d.ts +6 -0
- package/dist/types/helpers/redis/keys.d.ts +5 -0
- package/dist/types/helpers/redis/snapshot.d.ts +2 -0
- package/dist/types/helpers/start.d.ts +4 -0
- package/dist/types/helpers/tasks_helpers.d.ts +25 -0
- package/dist/types/helpers/time_helpers.d.ts +40 -0
- package/dist/types/index.d.ts +5 -0
- package/dist/types/index.js +3 -0
- package/dist/types/interfaces/email.js +1 -0
- package/dist/types/interfaces/global.js +1 -0
- package/dist/types/interfaces/index.js +2 -0
- package/dist/types/managers/cache_manager.d.ts +12 -0
- package/dist/types/managers/index.d.ts +4 -0
- package/dist/types/managers/logger_manager.d.ts +14 -0
- package/dist/types/managers/rabbitmq_manager.d.ts +60 -0
- package/dist/types/managers/translation_manager.d.ts +14 -0
- package/dist/types/middlewares/auth_mw.d.ts +4 -0
- package/dist/types/middlewares/error_handling.d.ts +11 -0
- package/dist/types/middlewares/global_mw.d.ts +5 -0
- package/dist/types/middlewares/index.d.ts +4 -0
- package/dist/types/middlewares/trim_mw.d.ts +2 -0
- package/dist/types/test.d.ts +0 -0
- package/dist/types/types/enums/global.d.ts +9 -0
- package/dist/types/types/enums/index.d.ts +1 -0
- package/dist/types/types/firebase_types.js +1 -0
- package/dist/types/types/global.js +1 -0
- package/dist/types/types/index.d.ts +3 -0
- package/dist/types/types/index.js +2 -0
- package/dist/types/types/interfaces/email.d.ts +33 -0
- package/dist/types/types/interfaces/global.d.ts +27 -0
- package/dist/types/types/interfaces/index.d.ts +2 -0
- package/dist/types/types/types/firebase_types.d.ts +50 -0
- package/dist/types/types/types/global.d.ts +17 -0
- package/dist/types/types/types/index.d.ts +2 -0
- package/package.json +1 -1
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
export type JsonValue = null | boolean | number | string | JsonValue[] | {
|
|
2
|
+
[key: string]: JsonValue;
|
|
3
|
+
};
|
|
4
|
+
export type EventHeaderValue = string | number | boolean;
|
|
5
|
+
export interface RabbitEvent<T extends JsonValue = JsonValue> {
|
|
6
|
+
body: T;
|
|
7
|
+
event_id?: string;
|
|
8
|
+
created_at?: string;
|
|
9
|
+
redelivered: boolean;
|
|
10
|
+
headers: Record<string, unknown>;
|
|
11
|
+
}
|
|
12
|
+
export interface PushEventOptions {
|
|
13
|
+
/** RabbitMQ message time-to-live, in seconds. */
|
|
14
|
+
ttl_seconds?: number;
|
|
15
|
+
headers?: Record<string, EventHeaderValue>;
|
|
16
|
+
}
|
|
17
|
+
export interface SubscribeOptions {
|
|
18
|
+
/** Requeue messages when the handler throws or rejects. Defaults to true. */
|
|
19
|
+
requeue_on_error?: boolean;
|
|
20
|
+
}
|
|
21
|
+
export interface Subscription {
|
|
22
|
+
queue_name: string;
|
|
23
|
+
consumer_tag: string;
|
|
24
|
+
cancel(): Promise<void>;
|
|
25
|
+
}
|
|
26
|
+
export type EventHandler<T extends JsonValue = JsonValue> = (event: RabbitEvent<T>) => void | Promise<void>;
|
|
27
|
+
/**
|
|
28
|
+
* JSON event transport backed by durable fanout exchanges and durable queues.
|
|
29
|
+
*
|
|
30
|
+
* Each channel name maps to an exchange. Each distinct subscriber name gets a
|
|
31
|
+
* queue and therefore its own copy of every event. Instances sharing the same
|
|
32
|
+
* subscriber name compete for work, which supports horizontal scaling.
|
|
33
|
+
*/
|
|
34
|
+
export declare class RabbitManager {
|
|
35
|
+
readonly prefetch_count: number;
|
|
36
|
+
private connection;
|
|
37
|
+
private channel;
|
|
38
|
+
private connecting;
|
|
39
|
+
constructor();
|
|
40
|
+
connect(): Promise<void>;
|
|
41
|
+
close(): Promise<void>;
|
|
42
|
+
push_event<T extends JsonValue>(channel_name: string, payload: T, options?: PushEventOptions): Promise<string>;
|
|
43
|
+
private subscriptions;
|
|
44
|
+
subscribe_for_channel<T extends JsonValue>(channel_name: string, subscriber_name: string, handler: EventHandler<T>, options?: SubscribeOptions): Promise<Subscription>;
|
|
45
|
+
cancel_subscriptions(): Promise<void>;
|
|
46
|
+
pull_and_delete<T extends JsonValue>(channel_name: string, subscriber_name: string): Promise<RabbitEvent<T> | undefined>;
|
|
47
|
+
/**
|
|
48
|
+
* Diagnostic peek implemented as get + nack + requeue.
|
|
49
|
+
* It is not a reliable queue browser: the same event can repeat or move.
|
|
50
|
+
*/
|
|
51
|
+
pull_and_leave<T extends JsonValue>(channel_name: string, subscriber_name: string): Promise<RabbitEvent<T> | undefined>;
|
|
52
|
+
private open_connection;
|
|
53
|
+
private get_channel;
|
|
54
|
+
private declare_exchange;
|
|
55
|
+
private declare_subscription;
|
|
56
|
+
private handle_message;
|
|
57
|
+
private to_event;
|
|
58
|
+
private validate_name;
|
|
59
|
+
}
|
|
60
|
+
export declare const rabbitmq: RabbitManager;
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.rabbitmq = exports.RabbitManager = void 0;
|
|
7
|
+
const amqplib_1 = __importDefault(require("amqplib"));
|
|
8
|
+
const node_crypto_1 = require("node:crypto");
|
|
9
|
+
const logger_manager_1 = require("./logger_manager");
|
|
10
|
+
const SAFE_NAME = /^[A-Za-z0-9_.:-]{1,120}$/;
|
|
11
|
+
/**
|
|
12
|
+
* JSON event transport backed by durable fanout exchanges and durable queues.
|
|
13
|
+
*
|
|
14
|
+
* Each channel name maps to an exchange. Each distinct subscriber name gets a
|
|
15
|
+
* queue and therefore its own copy of every event. Instances sharing the same
|
|
16
|
+
* subscriber name compete for work, which supports horizontal scaling.
|
|
17
|
+
*/
|
|
18
|
+
class RabbitManager {
|
|
19
|
+
prefetch_count = 10;
|
|
20
|
+
connection;
|
|
21
|
+
channel;
|
|
22
|
+
connecting;
|
|
23
|
+
constructor() {
|
|
24
|
+
if (!(process.env.RABBITMQ_URL ?? "")) {
|
|
25
|
+
logger_manager_1.logger.warn("Missing ENV parameter RABBITMQ_URL");
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
async connect() {
|
|
29
|
+
if (this.connection && this.channel)
|
|
30
|
+
return;
|
|
31
|
+
this.connecting ??= this.open_connection().finally(() => {
|
|
32
|
+
this.connecting = undefined;
|
|
33
|
+
});
|
|
34
|
+
await this.connecting;
|
|
35
|
+
}
|
|
36
|
+
async close() {
|
|
37
|
+
const channel = this.channel;
|
|
38
|
+
const connection = this.connection;
|
|
39
|
+
this.channel = undefined;
|
|
40
|
+
this.connection = undefined;
|
|
41
|
+
if (channel)
|
|
42
|
+
await channel.close().catch(() => undefined);
|
|
43
|
+
if (connection)
|
|
44
|
+
await connection.close().catch(() => undefined);
|
|
45
|
+
}
|
|
46
|
+
async push_event(channel_name, payload, options = {}) {
|
|
47
|
+
const channel = await this.declare_exchange(channel_name);
|
|
48
|
+
const { ttl_seconds, headers = {} } = options;
|
|
49
|
+
if (ttl_seconds !== undefined && (!Number.isFinite(ttl_seconds) || ttl_seconds <= 0)) {
|
|
50
|
+
throw new Error("ttl_seconds must be a finite number greater than zero");
|
|
51
|
+
}
|
|
52
|
+
let encoded;
|
|
53
|
+
try {
|
|
54
|
+
encoded = JSON.stringify(payload);
|
|
55
|
+
}
|
|
56
|
+
catch (error) {
|
|
57
|
+
throw new Error("payload must be JSON serializable", { cause: error });
|
|
58
|
+
}
|
|
59
|
+
if (encoded === undefined)
|
|
60
|
+
throw new Error("payload must be JSON serializable");
|
|
61
|
+
const event_id = (0, node_crypto_1.randomUUID)();
|
|
62
|
+
const created_at = new Date().toISOString();
|
|
63
|
+
channel.publish(channel_name, "", Buffer.from(encoded, "utf8"), {
|
|
64
|
+
contentType: "application/json",
|
|
65
|
+
contentEncoding: "utf-8",
|
|
66
|
+
persistent: true,
|
|
67
|
+
messageId: event_id,
|
|
68
|
+
timestamp: Math.floor(Date.now() / 1_000),
|
|
69
|
+
...(ttl_seconds === undefined ? {} : { expiration: String(Math.round(ttl_seconds * 1_000)) }),
|
|
70
|
+
headers: { created_at, ...headers },
|
|
71
|
+
});
|
|
72
|
+
await channel.waitForConfirms();
|
|
73
|
+
return event_id;
|
|
74
|
+
}
|
|
75
|
+
subscriptions = [];
|
|
76
|
+
async subscribe_for_channel(channel_name, subscriber_name, handler, options = {}) {
|
|
77
|
+
const { channel, queue_name } = await this.declare_subscription(channel_name, subscriber_name);
|
|
78
|
+
const requeue_on_error = options.requeue_on_error ?? true;
|
|
79
|
+
const reply = await channel.consume(queue_name, (message) => {
|
|
80
|
+
if (!message)
|
|
81
|
+
return;
|
|
82
|
+
void this.handle_message(channel, message, handler, requeue_on_error);
|
|
83
|
+
}, { noAck: false });
|
|
84
|
+
const subscription = {
|
|
85
|
+
queue_name,
|
|
86
|
+
consumer_tag: reply.consumerTag,
|
|
87
|
+
cancel: async () => {
|
|
88
|
+
await channel.cancel(reply.consumerTag);
|
|
89
|
+
},
|
|
90
|
+
};
|
|
91
|
+
this.subscriptions.push(subscription);
|
|
92
|
+
return subscription;
|
|
93
|
+
}
|
|
94
|
+
async cancel_subscriptions() {
|
|
95
|
+
await Promise.all(this.subscriptions.map((subscription) => subscription.cancel()));
|
|
96
|
+
}
|
|
97
|
+
async pull_and_delete(channel_name, subscriber_name) {
|
|
98
|
+
const { channel, queue_name } = await this.declare_subscription(channel_name, subscriber_name);
|
|
99
|
+
const message = await channel.get(queue_name, { noAck: false });
|
|
100
|
+
if (!message)
|
|
101
|
+
return undefined;
|
|
102
|
+
const event = this.to_event(message);
|
|
103
|
+
channel.ack(message);
|
|
104
|
+
return event;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Diagnostic peek implemented as get + nack + requeue.
|
|
108
|
+
* It is not a reliable queue browser: the same event can repeat or move.
|
|
109
|
+
*/
|
|
110
|
+
async pull_and_leave(channel_name, subscriber_name) {
|
|
111
|
+
const { channel, queue_name } = await this.declare_subscription(channel_name, subscriber_name);
|
|
112
|
+
const message = await channel.get(queue_name, { noAck: false });
|
|
113
|
+
if (!message)
|
|
114
|
+
return undefined;
|
|
115
|
+
const event = this.to_event(message);
|
|
116
|
+
channel.nack(message, false, true);
|
|
117
|
+
return event;
|
|
118
|
+
}
|
|
119
|
+
async open_connection() {
|
|
120
|
+
if (!(process.env.RABBITMQ_URL ?? "")) {
|
|
121
|
+
return;
|
|
122
|
+
}
|
|
123
|
+
const connection_url = new URL(process.env.RABBITMQ_URL);
|
|
124
|
+
if (!connection_url.searchParams.has("heartbeat")) {
|
|
125
|
+
connection_url.searchParams.set("heartbeat", "30");
|
|
126
|
+
}
|
|
127
|
+
const connection = await amqplib_1.default.connect(connection_url.toString(), { timeout: 30_000 });
|
|
128
|
+
const channel = await connection.createConfirmChannel();
|
|
129
|
+
await channel.prefetch(this.prefetch_count);
|
|
130
|
+
this.connection = connection;
|
|
131
|
+
this.channel = channel;
|
|
132
|
+
}
|
|
133
|
+
async get_channel() {
|
|
134
|
+
await this.connect();
|
|
135
|
+
if (!this.channel)
|
|
136
|
+
throw new Error("RabbitMQ channel is not available");
|
|
137
|
+
return this.channel;
|
|
138
|
+
}
|
|
139
|
+
async declare_exchange(channel_name) {
|
|
140
|
+
this.validate_name(channel_name, "channel_name");
|
|
141
|
+
const channel = await this.get_channel();
|
|
142
|
+
await channel.assertExchange(channel_name, "fanout", { durable: true });
|
|
143
|
+
return channel;
|
|
144
|
+
}
|
|
145
|
+
async declare_subscription(channel_name, subscriber_name) {
|
|
146
|
+
this.validate_name(channel_name, "channel_name");
|
|
147
|
+
this.validate_name(subscriber_name, "subscriber_name");
|
|
148
|
+
const channel = await this.declare_exchange(channel_name);
|
|
149
|
+
const queue_name = `${channel_name}.${subscriber_name}`;
|
|
150
|
+
await channel.assertQueue(queue_name, { durable: true });
|
|
151
|
+
await channel.bindQueue(queue_name, channel_name, "");
|
|
152
|
+
return { channel, queue_name };
|
|
153
|
+
}
|
|
154
|
+
async handle_message(channel, message, handler, requeue_on_error) {
|
|
155
|
+
try {
|
|
156
|
+
await handler(this.to_event(message));
|
|
157
|
+
channel.ack(message);
|
|
158
|
+
}
|
|
159
|
+
catch (error) {
|
|
160
|
+
console.error(`RabbitMQ handler failed for ${message.properties.messageId ?? "unknown"}`, error);
|
|
161
|
+
channel.nack(message, false, requeue_on_error);
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
to_event(message) {
|
|
165
|
+
let body;
|
|
166
|
+
try {
|
|
167
|
+
body = JSON.parse(message.content.toString("utf8"));
|
|
168
|
+
}
|
|
169
|
+
catch (error) {
|
|
170
|
+
throw new Error("received a message that is not valid JSON", { cause: error });
|
|
171
|
+
}
|
|
172
|
+
const headers = { ...message.properties.headers };
|
|
173
|
+
const created_at = headers.created_at;
|
|
174
|
+
return {
|
|
175
|
+
body,
|
|
176
|
+
redelivered: message.fields.redelivered,
|
|
177
|
+
headers,
|
|
178
|
+
...(message.properties.messageId ? { event_id: message.properties.messageId } : {}),
|
|
179
|
+
...(typeof created_at === "string" ? { created_at } : {}),
|
|
180
|
+
};
|
|
181
|
+
}
|
|
182
|
+
validate_name(value, parameter) {
|
|
183
|
+
if (!SAFE_NAME.test(value)) {
|
|
184
|
+
throw new Error(`${parameter} must be 1-120 characters using letters, digits, _, ., :, or -`);
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
}
|
|
188
|
+
exports.RabbitManager = RabbitManager;
|
|
189
|
+
exports.rabbitmq = new RabbitManager();
|
|
190
|
+
//# sourceMappingURL=rabbitmq_manager.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rabbitmq_manager.js","sourceRoot":"","sources":["../../../src/managers/rabbitmq_manager.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA2H;AAC3H,6CAAwD;AACxD,qDAA0C;AAE1C,MAAM,SAAS,GAAG,0BAA0B,CAAC;AAiC7C;;;;;;GAMG;AACH,MAAa,aAAa;IACb,cAAc,GAAW,EAAE,CAAC;IAC7B,UAAU,CAA2B;IACrC,OAAO,CAA6B;IACpC,UAAU,CAA4B;IAE9C;QACI,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,EAAE,CAAC,EAAE,CAAC;YACpC,uBAAM,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;QACtD,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAAO;QACT,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QAE5C,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,eAAe,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;YACpD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,UAAU,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,KAAK;QACP,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC7B,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,IAAI,OAAO;YAAE,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,UAAU;YAAE,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,UAAU,CAAsB,YAAoB,EAAE,OAAU,EAAE,UAA4B,EAAE;QAClG,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC1D,MAAM,EAAE,WAAW,EAAE,OAAO,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC;QAE9C,IAAI,WAAW,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,WAAW,IAAI,CAAC,CAAC,EAAE,CAAC;YACnF,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;QAC7E,CAAC;QAED,IAAI,OAAe,CAAC;QACpB,IAAI,CAAC;YACD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3E,CAAC;QACD,IAAI,OAAO,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAEhF,MAAM,QAAQ,GAAG,IAAA,wBAAW,GAAE,CAAC;QAC/B,MAAM,UAAU,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC5C,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;YAC5D,WAAW,EAAE,kBAAkB;YAC/B,eAAe,EAAE,OAAO;YACxB,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YACzC,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC;YAC7F,OAAO,EAAE,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE;SACtC,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,eAAe,EAAE,CAAC;QAChC,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEO,aAAa,GAAmB,EAAE,CAAC;IAE3C,KAAK,CAAC,qBAAqB,CACvB,YAAoB,EACpB,eAAuB,EACvB,OAAwB,EACxB,UAA4B,EAAE;QAE9B,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QAC/F,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,IAAI,IAAI,CAAC;QAE1D,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,OAAO,CAC/B,UAAU,EACV,CAAC,OAAO,EAAE,EAAE;YACR,IAAI,CAAC,OAAO;gBAAE,OAAO;YACrB,KAAK,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAC1E,CAAC,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACnB,CAAC;QAEF,MAAM,YAAY,GAAG;YACjB,UAAU;YACV,YAAY,EAAE,KAAK,CAAC,WAAW;YAC/B,MAAM,EAAE,KAAK,IAAI,EAAE;gBACf,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YAC5C,CAAC;SACJ,CAAC;QACF,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEtC,OAAO,YAAY,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,oBAAoB;QACtB,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACvF,CAAC;IAED,KAAK,CAAC,eAAe,CAAsB,YAAoB,EAAE,eAAuB;QACpF,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO;YAAE,OAAO,SAAS,CAAC;QAE/B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAI,OAAO,CAAC,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAsB,YAAoB,EAAE,eAAuB;QACnF,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO;YAAE,OAAO,SAAS,CAAC;QAE/B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAI,OAAO,CAAC,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QACnC,OAAO,KAAK,CAAC;IACjB,CAAC;IAEO,KAAK,CAAC,eAAe;QACzB,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,EAAE,CAAC,EAAE,CAAC;YACpC,OAAO;QACX,CAAC;QACD,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,YAAa,CAAC,CAAC;QAC1D,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAChD,cAAc,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,UAAU,GAAG,MAAM,iBAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QACtF,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,oBAAoB,EAAE,CAAC;QACxD,MAAM,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAEO,KAAK,CAAC,WAAW;QACrB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,YAAoB;QAC/C,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACjD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QACzC,MAAM,OAAO,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,OAAO,OAAO,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,YAAoB,EAAE,eAAuB;QAC5E,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;QACvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC1D,MAAM,UAAU,GAAG,GAAG,YAAY,IAAI,eAAe,EAAE,CAAC;QACxD,MAAM,OAAO,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,MAAM,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;QACtD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;IACnC,CAAC;IAEO,KAAK,CAAC,cAAc,CACxB,OAAuB,EACvB,OAAuB,EACvB,OAAwB,EACxB,gBAAyB;QAEzB,IAAI,CAAC;YACD,MAAM,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAI,OAAO,CAAC,CAAC,CAAC;YACzC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,OAAO,CAAC,KAAK,CAAC,+BAA+B,OAAO,CAAC,UAAU,CAAC,SAAS,IAAI,SAAS,EAAE,EAAE,KAAK,CAAC,CAAC;YACjG,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,gBAAgB,CAAC,CAAC;QACnD,CAAC;IACL,CAAC;IAEO,QAAQ,CAAsB,OAAoC;QACtE,IAAI,IAAO,CAAC;QACZ,IAAI,CAAC;YACD,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAM,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,2CAA2C,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;QACnF,CAAC;QAED,MAAM,OAAO,GAA4B,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAC3E,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACtC,OAAO;YACH,IAAI;YACJ,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW;YACvC,OAAO;YACP,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnF,GAAG,CAAC,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC5D,CAAC;IACN,CAAC;IAEO,aAAa,CAAC,KAAa,EAAE,SAAiB;QAClD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,gEAAgE,CAAC,CAAC;QAClG,CAAC;IACL,CAAC;CACJ;AAvMD,sCAuMC;AAEY,QAAA,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC"}
|
|
@@ -7,7 +7,7 @@ export * from "./notification_helpers";
|
|
|
7
7
|
export * from "./email_helpers";
|
|
8
8
|
export * from "./phone_number_helpers";
|
|
9
9
|
export * from "./tasks_helpers";
|
|
10
|
+
export * from "./postponed_actions";
|
|
10
11
|
export * from "./boards_helpers";
|
|
11
12
|
export * from "./redis";
|
|
12
13
|
export * from "./location_helpers";
|
|
13
|
-
export * from "./rabbitmq_helpers";
|
|
@@ -7,8 +7,8 @@ export * from "./notification_helpers";
|
|
|
7
7
|
export * from "./email_helpers";
|
|
8
8
|
export * from "./phone_number_helpers";
|
|
9
9
|
export * from "./tasks_helpers";
|
|
10
|
+
export * from "./postponed_actions";
|
|
10
11
|
export * from "./boards_helpers";
|
|
11
12
|
export * from "./redis";
|
|
12
13
|
export * from "./location_helpers";
|
|
13
|
-
export * from "./rabbitmq_helpers";
|
|
14
14
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC;AACxB,cAAc,oBAAoB,CAAC"}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { TObject } from "akeyless-types-commons";
|
|
2
|
+
export declare enum PostponedActionStatus {
|
|
3
|
+
pending = "pending",
|
|
4
|
+
processing = "processing",
|
|
5
|
+
completed = "completed",
|
|
6
|
+
cancelled = "cancelled",
|
|
7
|
+
failed = "failed"
|
|
8
|
+
}
|
|
9
|
+
export type PostponedActionTime = Date | string | {
|
|
10
|
+
minutes?: number;
|
|
11
|
+
hours?: number;
|
|
12
|
+
};
|
|
13
|
+
export type JsonPayload = TObject<any>;
|
|
14
|
+
export interface PostponedAction {
|
|
15
|
+
key: string;
|
|
16
|
+
details: JsonPayload;
|
|
17
|
+
action_type: string;
|
|
18
|
+
description: string;
|
|
19
|
+
execute_at: Date;
|
|
20
|
+
status: PostponedActionStatus;
|
|
21
|
+
attempt_count: number;
|
|
22
|
+
created_at: Date;
|
|
23
|
+
updated_at: Date;
|
|
24
|
+
started_at?: Date;
|
|
25
|
+
completed_at?: Date;
|
|
26
|
+
cancelled_at?: Date;
|
|
27
|
+
failed_at?: Date;
|
|
28
|
+
error?: string;
|
|
29
|
+
}
|
|
30
|
+
export interface AddPostponedAction {
|
|
31
|
+
key: string;
|
|
32
|
+
details: JsonPayload;
|
|
33
|
+
action_type: string;
|
|
34
|
+
description: string;
|
|
35
|
+
execute_at: PostponedActionTime;
|
|
36
|
+
}
|
|
37
|
+
export interface UpdatePostponedAction {
|
|
38
|
+
details?: JsonPayload;
|
|
39
|
+
action_type?: string;
|
|
40
|
+
description?: string;
|
|
41
|
+
execute_at?: PostponedActionTime;
|
|
42
|
+
}
|
|
43
|
+
export declare const resolve_postponed_action_time: (value: PostponedActionTime, now?: Date) => Date;
|
|
44
|
+
export declare const get_postponed_action: (key: string) => Promise<PostponedAction | null>;
|
|
45
|
+
export declare const add_postponed_action: (input: AddPostponedAction) => Promise<PostponedAction>;
|
|
46
|
+
export declare const update_postponed_action: (key: string, input: UpdatePostponedAction) => Promise<void>;
|
|
47
|
+
export declare const repostpone_postponed_action: (key: string, execute_at: PostponedActionTime) => Promise<void>;
|
|
48
|
+
export declare const cancel_postponed_action: (key: string) => Promise<void>;
|
|
49
|
+
export declare const complete_postponed_action: (key: string) => Promise<void>;
|
|
50
|
+
export declare const fail_postponed_action: (key: string, error: unknown) => Promise<void>;
|
|
51
|
+
export declare const delete_postponed_action: (key: string) => Promise<void>;
|
|
52
|
+
export declare const claim_postponed_action: (key: string, action_type: string, now?: Date | undefined) => Promise<PostponedAction | null>;
|
|
53
|
+
export declare const claim_due_postponed_actions: (action_type: string, limit?: number | undefined, now?: Date | undefined) => Promise<PostponedAction[]>;
|
|
54
|
+
/**
|
|
55
|
+
* @example Add an action for a specific date and time.
|
|
56
|
+
* ```ts
|
|
57
|
+
* await postponed_actions.add({
|
|
58
|
+
* key: "subscription:123:expire",
|
|
59
|
+
* action_type: "subscription_expiration",
|
|
60
|
+
* description: "Expire subscription 123",
|
|
61
|
+
* details: { subscription_id: "123", notify_customer: true },
|
|
62
|
+
* execute_at: new Date("2026-08-01T12:00:00Z"),
|
|
63
|
+
* });
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @example Add an action relative to the current time. Adding the same key
|
|
67
|
+
* updates the pending action.
|
|
68
|
+
* ```ts
|
|
69
|
+
* await postponed_actions.add({
|
|
70
|
+
* key: "invoice:456:reminder",
|
|
71
|
+
* action_type: "invoice_reminder",
|
|
72
|
+
* description: "Send invoice 456 reminder",
|
|
73
|
+
* details: { invoice_id: "456" },
|
|
74
|
+
* execute_at: { hours: 2, minutes: 30 },
|
|
75
|
+
* });
|
|
76
|
+
* ```
|
|
77
|
+
*
|
|
78
|
+
* @example Update, repostpone, or cancel a pending action.
|
|
79
|
+
* ```ts
|
|
80
|
+
* await postponed_actions.update("invoice:456:reminder", {
|
|
81
|
+
* description: "Send the final invoice reminder",
|
|
82
|
+
* execute_at: { minutes: 15 },
|
|
83
|
+
* });
|
|
84
|
+
* await postponed_actions.repostpone("invoice:456:reminder", { hours: 1 });
|
|
85
|
+
* await postponed_actions.cancel("invoice:456:reminder");
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
88
|
+
* @example Claim and execute due actions. Claiming is atomic, so concurrent
|
|
89
|
+
* workers cannot claim the same action.
|
|
90
|
+
* ```ts
|
|
91
|
+
* const actions = await postponed_actions.claim_due("invoice_reminder", 25);
|
|
92
|
+
* for (const action of actions) {
|
|
93
|
+
* try {
|
|
94
|
+
* await execute_action(action.details);
|
|
95
|
+
* await postponed_actions.complete(action.key);
|
|
96
|
+
* } catch (error) {
|
|
97
|
+
* await postponed_actions.fail(action.key, error);
|
|
98
|
+
* }
|
|
99
|
+
* }
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
export declare const postponed_actions: {
|
|
103
|
+
get: (key: string) => Promise<PostponedAction | null>;
|
|
104
|
+
add: (input: AddPostponedAction) => Promise<PostponedAction>;
|
|
105
|
+
update: (key: string, input: UpdatePostponedAction) => Promise<void>;
|
|
106
|
+
repostpone: (key: string, execute_at: PostponedActionTime) => Promise<void>;
|
|
107
|
+
cancel: (key: string) => Promise<void>;
|
|
108
|
+
complete: (key: string) => Promise<void>;
|
|
109
|
+
fail: (key: string, error: unknown) => Promise<void>;
|
|
110
|
+
delete: (key: string) => Promise<void>;
|
|
111
|
+
claim: (key: string, action_type: string, now?: Date | undefined) => Promise<PostponedAction | null>;
|
|
112
|
+
claim_due: (action_type: string, limit?: number | undefined, now?: Date | undefined) => Promise<PostponedAction[]>;
|
|
113
|
+
};
|