sorokeep 1.0.0
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/CONTRIBUTING.md +296 -0
- package/LICENSE +21 -0
- package/README.md +677 -0
- package/dist/alerts/alerts.d.ts +21 -0
- package/dist/alerts/alerts.d.ts.map +1 -0
- package/dist/alerts/alerts.js +18 -0
- package/dist/alerts/alerts.js.map +1 -0
- package/dist/alerts/discord.d.ts +3 -0
- package/dist/alerts/discord.d.ts.map +1 -0
- package/dist/alerts/discord.js +199 -0
- package/dist/alerts/discord.js.map +1 -0
- package/dist/alerts/dispatcher.d.ts +13 -0
- package/dist/alerts/dispatcher.d.ts.map +1 -0
- package/dist/alerts/dispatcher.js +91 -0
- package/dist/alerts/dispatcher.js.map +1 -0
- package/dist/alerts/keys.d.ts +24 -0
- package/dist/alerts/keys.d.ts.map +1 -0
- package/dist/alerts/keys.js +44 -0
- package/dist/alerts/keys.js.map +1 -0
- package/dist/alerts/pagerduty.d.ts +8 -0
- package/dist/alerts/pagerduty.d.ts.map +1 -0
- package/dist/alerts/pagerduty.js +164 -0
- package/dist/alerts/pagerduty.js.map +1 -0
- package/dist/alerts/resource.d.ts +23 -0
- package/dist/alerts/resource.d.ts.map +1 -0
- package/dist/alerts/resource.js +167 -0
- package/dist/alerts/resource.js.map +1 -0
- package/dist/alerts/slack.d.ts +7 -0
- package/dist/alerts/slack.d.ts.map +1 -0
- package/dist/alerts/slack.js +184 -0
- package/dist/alerts/slack.js.map +1 -0
- package/dist/alerts/telegram.d.ts +9 -0
- package/dist/alerts/telegram.d.ts.map +1 -0
- package/dist/alerts/telegram.js +133 -0
- package/dist/alerts/telegram.js.map +1 -0
- package/dist/alerts/templates.d.ts +109 -0
- package/dist/alerts/templates.d.ts.map +1 -0
- package/dist/alerts/templates.js +139 -0
- package/dist/alerts/templates.js.map +1 -0
- package/dist/alerts/types.d.ts +113 -0
- package/dist/alerts/types.d.ts.map +1 -0
- package/dist/alerts/types.js +87 -0
- package/dist/alerts/types.js.map +1 -0
- package/dist/alerts/webhook.d.ts +13 -0
- package/dist/alerts/webhook.d.ts.map +1 -0
- package/dist/alerts/webhook.js +56 -0
- package/dist/alerts/webhook.js.map +1 -0
- package/dist/cli/schemaFormatter.d.ts +11 -0
- package/dist/cli/schemaFormatter.d.ts.map +1 -0
- package/dist/cli/schemaFormatter.js +74 -0
- package/dist/cli/schemaFormatter.js.map +1 -0
- package/dist/commands/alerts.d.ts +3 -0
- package/dist/commands/alerts.d.ts.map +1 -0
- package/dist/commands/alerts.js +256 -0
- package/dist/commands/alerts.js.map +1 -0
- package/dist/commands/budget.d.ts +3 -0
- package/dist/commands/budget.d.ts.map +1 -0
- package/dist/commands/budget.js +47 -0
- package/dist/commands/budget.js.map +1 -0
- package/dist/commands/channels.d.ts +3 -0
- package/dist/commands/channels.d.ts.map +1 -0
- package/dist/commands/channels.js +84 -0
- package/dist/commands/channels.js.map +1 -0
- package/dist/commands/check.d.ts +3 -0
- package/dist/commands/check.d.ts.map +1 -0
- package/dist/commands/check.js +58 -0
- package/dist/commands/check.js.map +1 -0
- package/dist/commands/completion.d.ts +3 -0
- package/dist/commands/completion.d.ts.map +1 -0
- package/dist/commands/completion.js +36 -0
- package/dist/commands/completion.js.map +1 -0
- package/dist/commands/costs.d.ts +15 -0
- package/dist/commands/costs.d.ts.map +1 -0
- package/dist/commands/costs.js +280 -0
- package/dist/commands/costs.js.map +1 -0
- package/dist/commands/daemon.d.ts +3 -0
- package/dist/commands/daemon.d.ts.map +1 -0
- package/dist/commands/daemon.js +93 -0
- package/dist/commands/daemon.js.map +1 -0
- package/dist/commands/db.d.ts +3 -0
- package/dist/commands/db.d.ts.map +1 -0
- package/dist/commands/db.js +140 -0
- package/dist/commands/db.js.map +1 -0
- package/dist/commands/guard.d.ts +3 -0
- package/dist/commands/guard.d.ts.map +1 -0
- package/dist/commands/guard.js +181 -0
- package/dist/commands/guard.js.map +1 -0
- package/dist/commands/history.d.ts +3 -0
- package/dist/commands/history.d.ts.map +1 -0
- package/dist/commands/history.js +57 -0
- package/dist/commands/history.js.map +1 -0
- package/dist/commands/inspect.d.ts +3 -0
- package/dist/commands/inspect.d.ts.map +1 -0
- package/dist/commands/inspect.js +82 -0
- package/dist/commands/inspect.js.map +1 -0
- package/dist/commands/mcp.d.ts +3 -0
- package/dist/commands/mcp.d.ts.map +1 -0
- package/dist/commands/mcp.js +20 -0
- package/dist/commands/mcp.js.map +1 -0
- package/dist/commands/pause.d.ts +3 -0
- package/dist/commands/pause.d.ts.map +1 -0
- package/dist/commands/pause.js +32 -0
- package/dist/commands/pause.js.map +1 -0
- package/dist/commands/resources.d.ts +3 -0
- package/dist/commands/resources.d.ts.map +1 -0
- package/dist/commands/resources.js +95 -0
- package/dist/commands/resources.js.map +1 -0
- package/dist/commands/restore.d.ts +3 -0
- package/dist/commands/restore.d.ts.map +1 -0
- package/dist/commands/restore.js +92 -0
- package/dist/commands/restore.js.map +1 -0
- package/dist/commands/resume.d.ts +3 -0
- package/dist/commands/resume.d.ts.map +1 -0
- package/dist/commands/resume.js +31 -0
- package/dist/commands/resume.js.map +1 -0
- package/dist/commands/status.d.ts +3 -0
- package/dist/commands/status.d.ts.map +1 -0
- package/dist/commands/status.js +63 -0
- package/dist/commands/status.js.map +1 -0
- package/dist/commands/watch.d.ts +3 -0
- package/dist/commands/watch.d.ts.map +1 -0
- package/dist/commands/watch.js +163 -0
- package/dist/commands/watch.js.map +1 -0
- package/dist/core/aws_secrets.d.ts +13 -0
- package/dist/core/aws_secrets.d.ts.map +1 -0
- package/dist/core/aws_secrets.js +34 -0
- package/dist/core/aws_secrets.js.map +1 -0
- package/dist/core/budget.d.ts +10 -0
- package/dist/core/budget.d.ts.map +1 -0
- package/dist/core/budget.js +31 -0
- package/dist/core/budget.js.map +1 -0
- package/dist/core/channels.d.ts +67 -0
- package/dist/core/channels.d.ts.map +1 -0
- package/dist/core/channels.js +136 -0
- package/dist/core/channels.js.map +1 -0
- package/dist/core/check.d.ts +25 -0
- package/dist/core/check.d.ts.map +1 -0
- package/dist/core/check.js +85 -0
- package/dist/core/check.js.map +1 -0
- package/dist/core/completion.d.ts +9 -0
- package/dist/core/completion.d.ts.map +1 -0
- package/dist/core/completion.js +68 -0
- package/dist/core/completion.js.map +1 -0
- package/dist/core/costs.d.ts +90 -0
- package/dist/core/costs.d.ts.map +1 -0
- package/dist/core/costs.js +147 -0
- package/dist/core/costs.js.map +1 -0
- package/dist/core/decoder.d.ts +7 -0
- package/dist/core/decoder.d.ts.map +1 -0
- package/dist/core/decoder.js +38 -0
- package/dist/core/decoder.js.map +1 -0
- package/dist/core/discovery.d.ts +38 -0
- package/dist/core/discovery.d.ts.map +1 -0
- package/dist/core/discovery.js +208 -0
- package/dist/core/discovery.js.map +1 -0
- package/dist/core/extension.d.ts +83 -0
- package/dist/core/extension.d.ts.map +1 -0
- package/dist/core/extension.js +429 -0
- package/dist/core/extension.js.map +1 -0
- package/dist/core/inspect.d.ts +62 -0
- package/dist/core/inspect.d.ts.map +1 -0
- package/dist/core/inspect.js +303 -0
- package/dist/core/inspect.js.map +1 -0
- package/dist/core/introspection.d.ts +8 -0
- package/dist/core/introspection.d.ts.map +1 -0
- package/dist/core/introspection.js +8 -0
- package/dist/core/introspection.js.map +1 -0
- package/dist/core/monitor.d.ts +42 -0
- package/dist/core/monitor.d.ts.map +1 -0
- package/dist/core/monitor.js +188 -0
- package/dist/core/monitor.js.map +1 -0
- package/dist/core/rent_projection.d.ts +153 -0
- package/dist/core/rent_projection.d.ts.map +1 -0
- package/dist/core/rent_projection.js +146 -0
- package/dist/core/rent_projection.js.map +1 -0
- package/dist/core/scvalTranslator.d.ts +11 -0
- package/dist/core/scvalTranslator.d.ts.map +1 -0
- package/dist/core/scvalTranslator.js +36 -0
- package/dist/core/scvalTranslator.js.map +1 -0
- package/dist/core/state_diff.d.ts +45 -0
- package/dist/core/state_diff.d.ts.map +1 -0
- package/dist/core/state_diff.js +112 -0
- package/dist/core/state_diff.js.map +1 -0
- package/dist/core/status.d.ts +24 -0
- package/dist/core/status.d.ts.map +1 -0
- package/dist/core/status.js +57 -0
- package/dist/core/status.js.map +1 -0
- package/dist/core/vault.d.ts +37 -0
- package/dist/core/vault.d.ts.map +1 -0
- package/dist/core/vault.js +179 -0
- package/dist/core/vault.js.map +1 -0
- package/dist/core/watch.d.ts +36 -0
- package/dist/core/watch.d.ts.map +1 -0
- package/dist/core/watch.js +176 -0
- package/dist/core/watch.js.map +1 -0
- package/dist/daemon/loop.d.ts +38 -0
- package/dist/daemon/loop.d.ts.map +1 -0
- package/dist/daemon/loop.js +169 -0
- package/dist/daemon/loop.js.map +1 -0
- package/dist/db/backup.d.ts +12 -0
- package/dist/db/backup.d.ts.map +1 -0
- package/dist/db/backup.js +132 -0
- package/dist/db/backup.js.map +1 -0
- package/dist/db/budget.d.ts +17 -0
- package/dist/db/budget.d.ts.map +1 -0
- package/dist/db/budget.js +31 -0
- package/dist/db/budget.js.map +1 -0
- package/dist/db/database.d.ts +6 -0
- package/dist/db/database.d.ts.map +1 -0
- package/dist/db/database.js +134 -0
- package/dist/db/database.js.map +1 -0
- package/dist/db/migrations/.gitkeep +1 -0
- package/dist/db/migrations/001_resource_usage_logs.sql +28 -0
- package/dist/db/migrator.d.ts +28 -0
- package/dist/db/migrator.d.ts.map +1 -0
- package/dist/db/migrator.js +75 -0
- package/dist/db/migrator.js.map +1 -0
- package/dist/db/repositories.d.ts +474 -0
- package/dist/db/repositories.d.ts.map +1 -0
- package/dist/db/repositories.js +809 -0
- package/dist/db/repositories.js.map +1 -0
- package/dist/db/schema.sql +207 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +47 -0
- package/dist/index.js.map +1 -0
- package/dist/lib.d.ts +20 -0
- package/dist/lib.d.ts.map +1 -0
- package/dist/lib.js +16 -0
- package/dist/lib.js.map +1 -0
- package/dist/logging/index.d.ts +22 -0
- package/dist/logging/index.d.ts.map +1 -0
- package/dist/logging/index.js +34 -0
- package/dist/logging/index.js.map +1 -0
- package/dist/logging/logger.d.ts +14 -0
- package/dist/logging/logger.d.ts.map +1 -0
- package/dist/logging/logger.js +135 -0
- package/dist/logging/logger.js.map +1 -0
- package/dist/logging/types.d.ts +10 -0
- package/dist/logging/types.d.ts.map +1 -0
- package/dist/logging/types.js +2 -0
- package/dist/logging/types.js.map +1 -0
- package/dist/mcp/index.d.ts +3 -0
- package/dist/mcp/index.d.ts.map +1 -0
- package/dist/mcp/index.js +14 -0
- package/dist/mcp/index.js.map +1 -0
- package/dist/mcp/server.d.ts +10 -0
- package/dist/mcp/server.d.ts.map +1 -0
- package/dist/mcp/server.js +51 -0
- package/dist/mcp/server.js.map +1 -0
- package/dist/mcp/tools/get-extension-costs.d.ts +4 -0
- package/dist/mcp/tools/get-extension-costs.d.ts.map +1 -0
- package/dist/mcp/tools/get-extension-costs.js +33 -0
- package/dist/mcp/tools/get-extension-costs.js.map +1 -0
- package/dist/mcp/tools/get_contract_status.d.ts +8 -0
- package/dist/mcp/tools/get_contract_status.d.ts.map +1 -0
- package/dist/mcp/tools/get_contract_status.js +33 -0
- package/dist/mcp/tools/get_contract_status.js.map +1 -0
- package/dist/rpc/client.d.ts +154 -0
- package/dist/rpc/client.d.ts.map +1 -0
- package/dist/rpc/client.js +766 -0
- package/dist/rpc/client.js.map +1 -0
- package/dist/utils/config.d.ts +51 -0
- package/dist/utils/config.d.ts.map +1 -0
- package/dist/utils/config.js +86 -0
- package/dist/utils/config.js.map +1 -0
- package/dist/utils/formatting.d.ts +10 -0
- package/dist/utils/formatting.d.ts.map +1 -0
- package/dist/utils/formatting.js +66 -0
- package/dist/utils/formatting.js.map +1 -0
- package/dist/utils/watch-config.d.ts +13 -0
- package/dist/utils/watch-config.d.ts.map +1 -0
- package/dist/utils/watch-config.js +32 -0
- package/dist/utils/watch-config.js.map +1 -0
- package/package.json +73 -0
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import type { AlertEvent } from "./types.js";
|
|
2
|
+
export declare function getTemplateContext(event: AlertEvent): {
|
|
3
|
+
contractDisplay: string;
|
|
4
|
+
resourceLabel: string;
|
|
5
|
+
resourceUnit: string;
|
|
6
|
+
severityLevel: string;
|
|
7
|
+
entryLabel: string;
|
|
8
|
+
severityEmoji: string;
|
|
9
|
+
isTTLAlert: boolean;
|
|
10
|
+
isResourceAlert: boolean;
|
|
11
|
+
isResolved: boolean;
|
|
12
|
+
isCritical: boolean;
|
|
13
|
+
isWarning: boolean;
|
|
14
|
+
isInfo: boolean;
|
|
15
|
+
currentUsageFormatted: string;
|
|
16
|
+
limitFormatted: string;
|
|
17
|
+
currentRemainingLedgersFormatted: string;
|
|
18
|
+
configuredLedgersFormatted: string;
|
|
19
|
+
dedupKey: string;
|
|
20
|
+
customDetails: Record<string, unknown>;
|
|
21
|
+
type: "threshold_crossed" | "alert_resolved";
|
|
22
|
+
severity: import("./types.js").AlertSeverity;
|
|
23
|
+
contractId: string;
|
|
24
|
+
contractName: string | null;
|
|
25
|
+
network: string;
|
|
26
|
+
entry: {
|
|
27
|
+
keyXdr: string;
|
|
28
|
+
type: string;
|
|
29
|
+
label: string | null;
|
|
30
|
+
};
|
|
31
|
+
threshold: {
|
|
32
|
+
configuredLedgers: number;
|
|
33
|
+
currentRemainingLedgers: number;
|
|
34
|
+
approximateTimeRemaining: string;
|
|
35
|
+
};
|
|
36
|
+
firedAtLedger: number;
|
|
37
|
+
timestamp: string;
|
|
38
|
+
} | {
|
|
39
|
+
contractDisplay: string;
|
|
40
|
+
resourceLabel: string;
|
|
41
|
+
resourceUnit: string;
|
|
42
|
+
severityLevel: string;
|
|
43
|
+
entryLabel: string;
|
|
44
|
+
severityEmoji: string;
|
|
45
|
+
isTTLAlert: boolean;
|
|
46
|
+
isResourceAlert: boolean;
|
|
47
|
+
isResolved: boolean;
|
|
48
|
+
isCritical: boolean;
|
|
49
|
+
isWarning: boolean;
|
|
50
|
+
isInfo: boolean;
|
|
51
|
+
currentUsageFormatted: string;
|
|
52
|
+
limitFormatted: string;
|
|
53
|
+
currentRemainingLedgersFormatted: string;
|
|
54
|
+
configuredLedgersFormatted: string;
|
|
55
|
+
dedupKey: string;
|
|
56
|
+
customDetails: Record<string, unknown>;
|
|
57
|
+
type: "resource_alert";
|
|
58
|
+
severity: import("./types.js").AlertSeverity;
|
|
59
|
+
contractId: string;
|
|
60
|
+
contractName: string | null;
|
|
61
|
+
network: string;
|
|
62
|
+
resource: {
|
|
63
|
+
type: "cpu" | "memory";
|
|
64
|
+
currentUsage: number;
|
|
65
|
+
limit: number;
|
|
66
|
+
usagePercent: number;
|
|
67
|
+
};
|
|
68
|
+
message: string;
|
|
69
|
+
firedAtLedger?: number;
|
|
70
|
+
timestamp: string;
|
|
71
|
+
} | {
|
|
72
|
+
contractDisplay: string;
|
|
73
|
+
resourceLabel: string;
|
|
74
|
+
resourceUnit: string;
|
|
75
|
+
severityLevel: string;
|
|
76
|
+
entryLabel: string;
|
|
77
|
+
severityEmoji: string;
|
|
78
|
+
isTTLAlert: boolean;
|
|
79
|
+
isResourceAlert: boolean;
|
|
80
|
+
isResolved: boolean;
|
|
81
|
+
isCritical: boolean;
|
|
82
|
+
isWarning: boolean;
|
|
83
|
+
isInfo: boolean;
|
|
84
|
+
currentUsageFormatted: string;
|
|
85
|
+
limitFormatted: string;
|
|
86
|
+
currentRemainingLedgersFormatted: string;
|
|
87
|
+
configuredLedgersFormatted: string;
|
|
88
|
+
dedupKey: string;
|
|
89
|
+
customDetails: Record<string, unknown>;
|
|
90
|
+
type: "state_changed";
|
|
91
|
+
severity: import("./types.js").AlertSeverity;
|
|
92
|
+
contractId: string;
|
|
93
|
+
contractName: string | null;
|
|
94
|
+
network: string;
|
|
95
|
+
entry: {
|
|
96
|
+
keyXdr: string;
|
|
97
|
+
type: string;
|
|
98
|
+
label: string | null;
|
|
99
|
+
};
|
|
100
|
+
diff: {
|
|
101
|
+
diffType: "created" | "updated" | "deleted";
|
|
102
|
+
oldValueXdr: string | null;
|
|
103
|
+
newValueXdr: string | null;
|
|
104
|
+
};
|
|
105
|
+
detectedAtLedger: number;
|
|
106
|
+
timestamp: string;
|
|
107
|
+
};
|
|
108
|
+
export declare function renderAlertTemplate(channel: string, event: AlertEvent, customTemplatesPath?: string): string | null;
|
|
109
|
+
//# sourceMappingURL=templates.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/alerts/templates.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAe7C,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2FnD;AAID,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,mBAAmB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAkCnH"}
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
import Handlebars from "handlebars";
|
|
2
|
+
import fs from "node:fs";
|
|
3
|
+
import path from "node:path";
|
|
4
|
+
import { loadConfig } from "../utils/config.js";
|
|
5
|
+
import { getLogger } from "../logging/index.js";
|
|
6
|
+
const logger = getLogger().child({ component: "AlertTemplates" });
|
|
7
|
+
// ─── Register Handlebars Helpers ─────────────────────────────────────────────
|
|
8
|
+
Handlebars.registerHelper("eq", (a, b) => a === b);
|
|
9
|
+
Handlebars.registerHelper("upperCase", (str) => typeof str === "string" ? str.toUpperCase() : str);
|
|
10
|
+
Handlebars.registerHelper("localeString", (num) => typeof num === "number" ? num.toLocaleString() : num);
|
|
11
|
+
Handlebars.registerHelper("json", (obj) => JSON.stringify(obj));
|
|
12
|
+
Handlebars.registerHelper("escapeJson", (str) => typeof str === "string" ? JSON.stringify(str).slice(1, -1) : str);
|
|
13
|
+
Handlebars.registerHelper("escapeMarkdown", (text) => typeof text === "string" ? text.replace(/[_*[\]()~`>#+=|{}.!\\-]/g, "\\$&") : text);
|
|
14
|
+
// ─── Context Preparation ─────────────────────────────────────────────────────
|
|
15
|
+
export function getTemplateContext(event) {
|
|
16
|
+
const isResourceAlert = event.type === "resource_alert";
|
|
17
|
+
const isResolved = event.type === "alert_resolved";
|
|
18
|
+
const contractDisplay = event.contractName ?? event.contractId;
|
|
19
|
+
let resourceLabel = "";
|
|
20
|
+
let resourceUnit = "";
|
|
21
|
+
let entryLabel = "";
|
|
22
|
+
if (isResourceAlert) {
|
|
23
|
+
resourceLabel = event.resource.type === "cpu" ? "CPU" : "Memory";
|
|
24
|
+
resourceUnit = event.resource.type === "cpu" ? "instructions" : "bytes";
|
|
25
|
+
}
|
|
26
|
+
else {
|
|
27
|
+
entryLabel = event.entry.label ?? event.entry.type;
|
|
28
|
+
}
|
|
29
|
+
const severityLevel = event.severity === "critical" ? "CRITICAL" : "Warning";
|
|
30
|
+
// Dedup keys and details for channels like PagerDuty
|
|
31
|
+
let dedupKey;
|
|
32
|
+
let customDetails;
|
|
33
|
+
if (isResourceAlert) {
|
|
34
|
+
dedupKey = `sorokeep:${event.network}:${event.contractId}:resource:${event.resource.type}`;
|
|
35
|
+
customDetails = {
|
|
36
|
+
contractId: event.contractId,
|
|
37
|
+
contractName: event.contractName,
|
|
38
|
+
network: event.network,
|
|
39
|
+
resourceType: event.resource.type,
|
|
40
|
+
usagePercent: event.resource.usagePercent,
|
|
41
|
+
currentUsage: event.resource.currentUsage,
|
|
42
|
+
limit: event.resource.limit,
|
|
43
|
+
firedAtLedger: event.firedAtLedger,
|
|
44
|
+
timestamp: event.timestamp,
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
else if (event.type === "threshold_crossed" || event.type === "alert_resolved") {
|
|
48
|
+
const entryKey = event.entry.keyXdr || event.entry.type;
|
|
49
|
+
dedupKey = `sorokeep:${event.network}:${event.contractId}:${entryKey}:${event.threshold.configuredLedgers}`;
|
|
50
|
+
customDetails = {
|
|
51
|
+
contractId: event.contractId,
|
|
52
|
+
contractName: event.contractName,
|
|
53
|
+
network: event.network,
|
|
54
|
+
entryKeyXdr: event.entry.keyXdr,
|
|
55
|
+
entryType: event.entry.type,
|
|
56
|
+
entryLabel: event.entry.label,
|
|
57
|
+
currentRemainingLedgers: event.threshold.currentRemainingLedgers,
|
|
58
|
+
configuredLedgers: event.threshold.configuredLedgers,
|
|
59
|
+
approximateTimeRemaining: event.threshold.approximateTimeRemaining,
|
|
60
|
+
firedAtLedger: event.firedAtLedger,
|
|
61
|
+
timestamp: event.timestamp,
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
else if (event.type === "state_changed") {
|
|
65
|
+
const entryKey = event.entry.keyXdr || event.entry.type;
|
|
66
|
+
dedupKey = `sorokeep:${event.network}:${event.contractId}:${entryKey}:state_changed`;
|
|
67
|
+
customDetails = {
|
|
68
|
+
contractId: event.contractId,
|
|
69
|
+
contractName: event.contractName,
|
|
70
|
+
network: event.network,
|
|
71
|
+
entryKeyXdr: event.entry.keyXdr,
|
|
72
|
+
entryType: event.entry.type,
|
|
73
|
+
entryLabel: event.entry.label,
|
|
74
|
+
diffType: event.diff.diffType,
|
|
75
|
+
detectedAtLedger: event.detectedAtLedger,
|
|
76
|
+
timestamp: event.timestamp,
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
else {
|
|
80
|
+
dedupKey = `sorokeep:${event.network}:${event.contractId}:unknown`;
|
|
81
|
+
customDetails = { contractId: event.contractId, timestamp: event.timestamp };
|
|
82
|
+
}
|
|
83
|
+
return {
|
|
84
|
+
...event,
|
|
85
|
+
contractDisplay,
|
|
86
|
+
resourceLabel,
|
|
87
|
+
resourceUnit,
|
|
88
|
+
severityLevel,
|
|
89
|
+
entryLabel,
|
|
90
|
+
severityEmoji: isResolved ? "✅" : (event.severity === "critical" ? "🔴" : "⚠️"),
|
|
91
|
+
isTTLAlert: event.type === "threshold_crossed" || event.type === "alert_resolved",
|
|
92
|
+
isResourceAlert,
|
|
93
|
+
isResolved,
|
|
94
|
+
isCritical: event.severity === "critical",
|
|
95
|
+
isWarning: event.severity === "warning",
|
|
96
|
+
isInfo: event.severity === "info",
|
|
97
|
+
currentUsageFormatted: isResourceAlert ? event.resource.currentUsage.toLocaleString() : "",
|
|
98
|
+
limitFormatted: isResourceAlert ? event.resource.limit.toLocaleString() : "",
|
|
99
|
+
currentRemainingLedgersFormatted: "threshold" in event ? event.threshold.currentRemainingLedgers.toLocaleString() : "",
|
|
100
|
+
configuredLedgersFormatted: "threshold" in event ? event.threshold.configuredLedgers.toLocaleString() : "",
|
|
101
|
+
dedupKey,
|
|
102
|
+
customDetails,
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
// ─── Main Render API ─────────────────────────────────────────────────────────
|
|
106
|
+
export function renderAlertTemplate(channel, event, customTemplatesPath) {
|
|
107
|
+
// Priority: custom path parameter > config.templatesPath
|
|
108
|
+
let templatesPath = customTemplatesPath;
|
|
109
|
+
if (!templatesPath) {
|
|
110
|
+
try {
|
|
111
|
+
const config = loadConfig();
|
|
112
|
+
if ("templatesPath" in config && typeof config.templatesPath === "string") {
|
|
113
|
+
templatesPath = config.templatesPath;
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
catch {
|
|
117
|
+
// Ignore config loading errors during startup/tests
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
if (!templatesPath) {
|
|
121
|
+
return null;
|
|
122
|
+
}
|
|
123
|
+
const templateFile = path.join(templatesPath, `${channel}.hbs`);
|
|
124
|
+
if (!fs.existsSync(templateFile)) {
|
|
125
|
+
return null;
|
|
126
|
+
}
|
|
127
|
+
try {
|
|
128
|
+
const raw = fs.readFileSync(templateFile, "utf8");
|
|
129
|
+
const template = Handlebars.compile(raw, { noEscape: true });
|
|
130
|
+
const context = getTemplateContext(event);
|
|
131
|
+
return template(context);
|
|
132
|
+
}
|
|
133
|
+
catch (err) {
|
|
134
|
+
const msg = err instanceof Error ? err.message : String(err);
|
|
135
|
+
logger.error(`Failed to render template ${templateFile}: ${msg}`);
|
|
136
|
+
return null;
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
//# sourceMappingURL=templates.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../src/alerts/templates.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAGhD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAElE,gFAAgF;AAEhF,UAAU,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACnD,UAAU,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACnG,UAAU,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACzG,UAAU,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AAChE,UAAU,CAAC,cAAc,CAAC,YAAY,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACnH,UAAU,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAE1I,gFAAgF;AAEhF,MAAM,UAAU,kBAAkB,CAAC,KAAiB;IAChD,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC;IACxD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC;IACnD,MAAM,eAAe,GAAG,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,UAAU,CAAC;IAE/D,IAAI,aAAa,GAAG,EAAE,CAAC;IACvB,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,IAAI,UAAU,GAAG,EAAE,CAAC;IAEpB,IAAI,eAAe,EAAE,CAAC;QAClB,aAAa,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;QACjE,YAAY,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC;IAC5E,CAAC;SAAM,CAAC;QACJ,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;IACvD,CAAC;IAED,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;IAE7E,qDAAqD;IACrD,IAAI,QAAgB,CAAC;IACrB,IAAI,aAAsC,CAAC;IAE3C,IAAI,eAAe,EAAE,CAAC;QAClB,QAAQ,GAAG,YAAY,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,UAAU,aAAa,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC3F,aAAa,GAAG;YACZ,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,YAAY,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI;YACjC,YAAY,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY;YACzC,YAAY,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY;YACzC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK;YAC3B,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,SAAS,EAAE,KAAK,CAAC,SAAS;SAC7B,CAAC;IACN,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QAC/E,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QACxD,QAAQ,GAAG,YAAY,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,UAAU,IAAI,QAAQ,IAAI,KAAK,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC;QAC5G,aAAa,GAAG;YACZ,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM;YAC/B,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI;YAC3B,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK;YAC7B,uBAAuB,EAAE,KAAK,CAAC,SAAS,CAAC,uBAAuB;YAChE,iBAAiB,EAAE,KAAK,CAAC,SAAS,CAAC,iBAAiB;YACpD,wBAAwB,EAAE,KAAK,CAAC,SAAS,CAAC,wBAAwB;YAClE,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,SAAS,EAAE,KAAK,CAAC,SAAS;SAC7B,CAAC;IACN,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;QACxD,QAAQ,GAAG,YAAY,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,UAAU,IAAI,QAAQ,gBAAgB,CAAC;QACrF,aAAa,GAAG;YACZ,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM;YAC/B,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI;YAC3B,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK;YAC7B,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ;YAC7B,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;YACxC,SAAS,EAAE,KAAK,CAAC,SAAS;SAC7B,CAAC;IACN,CAAC;SAAM,CAAC;QACJ,QAAQ,GAAG,YAAY,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,UAAU,UAAU,CAAC;QACnE,aAAa,GAAG,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC;IACjF,CAAC;IAED,OAAO;QACH,GAAG,KAAK;QACR,eAAe;QACf,aAAa;QACb,YAAY;QACZ,aAAa;QACb,UAAU;QACV,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/E,UAAU,EAAE,KAAK,CAAC,IAAI,KAAK,mBAAmB,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB;QACjF,eAAe;QACf,UAAU;QACV,UAAU,EAAE,KAAK,CAAC,QAAQ,KAAK,UAAU;QACzC,SAAS,EAAE,KAAK,CAAC,QAAQ,KAAK,SAAS;QACvC,MAAM,EAAE,KAAK,CAAC,QAAQ,KAAK,MAAM;QACjC,qBAAqB,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE;QAC1F,cAAc,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE;QAC5E,gCAAgC,EAAE,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,uBAAuB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE;QACtH,0BAA0B,EAAE,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE;QAC1G,QAAQ;QACR,aAAa;KAChB,CAAC;AACN,CAAC;AAED,gFAAgF;AAEhF,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,KAAiB,EAAE,mBAA4B;IAChG,yDAAyD;IACzD,IAAI,aAAa,GAAuB,mBAAmB,CAAC;IAE5D,IAAI,CAAC,aAAa,EAAE,CAAC;QACjB,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,UAAU,EAAE,CAAC;YAC5B,IAAI,eAAe,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACxE,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;YACzC,CAAC;QACL,CAAC;QAAC,MAAM,CAAC;YACL,oDAAoD;QACxD,CAAC;IACL,CAAC;IAED,IAAI,CAAC,aAAa,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,GAAG,OAAO,MAAM,CAAC,CAAC;IAChE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC1C,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACpB,MAAM,GAAG,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7D,MAAM,CAAC,KAAK,CAAC,6BAA6B,YAAY,KAAK,GAAG,EAAE,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IAChB,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
export type AlertSeverity = "critical" | "warning" | "info";
|
|
2
|
+
export type AlertEventType = "threshold_crossed" | "alert_resolved" | "resource_alert" | "state_changed";
|
|
3
|
+
export interface TTLAlertEvent {
|
|
4
|
+
type: "threshold_crossed" | "alert_resolved";
|
|
5
|
+
severity: AlertSeverity;
|
|
6
|
+
contractId: string;
|
|
7
|
+
contractName: string | null;
|
|
8
|
+
network: string;
|
|
9
|
+
entry: {
|
|
10
|
+
keyXdr: string;
|
|
11
|
+
type: string;
|
|
12
|
+
label: string | null;
|
|
13
|
+
};
|
|
14
|
+
threshold: {
|
|
15
|
+
/** The ledger count configured in the alert_config. */
|
|
16
|
+
configuredLedgers: number;
|
|
17
|
+
/** Remaining TTL at the moment the alert fired. */
|
|
18
|
+
currentRemainingLedgers: number;
|
|
19
|
+
/** Human-readable time estimate, e.g. "~6h 25m". */
|
|
20
|
+
approximateTimeRemaining: string;
|
|
21
|
+
};
|
|
22
|
+
/** Ledger sequence number at the time of detection. */
|
|
23
|
+
firedAtLedger: number;
|
|
24
|
+
/** ISO 8601 timestamp. */
|
|
25
|
+
timestamp: string;
|
|
26
|
+
}
|
|
27
|
+
export interface ResourceAlertEvent {
|
|
28
|
+
type: "resource_alert";
|
|
29
|
+
severity: AlertSeverity;
|
|
30
|
+
contractId: string;
|
|
31
|
+
contractName: string | null;
|
|
32
|
+
network: string;
|
|
33
|
+
resource: {
|
|
34
|
+
type: "cpu" | "memory";
|
|
35
|
+
/** Current usage (in instructions or bytes). */
|
|
36
|
+
currentUsage: number;
|
|
37
|
+
/** Configured limit (in instructions or bytes). */
|
|
38
|
+
limit: number;
|
|
39
|
+
/** Usage as a percentage of limit. */
|
|
40
|
+
usagePercent: number;
|
|
41
|
+
};
|
|
42
|
+
/** Human-readable message about the resource usage. */
|
|
43
|
+
message: string;
|
|
44
|
+
/** Ledger sequence number at the time of detection (if available). */
|
|
45
|
+
firedAtLedger?: number;
|
|
46
|
+
/** ISO 8601 timestamp. */
|
|
47
|
+
timestamp: string;
|
|
48
|
+
}
|
|
49
|
+
export interface StateChangeAlertEvent {
|
|
50
|
+
type: "state_changed";
|
|
51
|
+
severity: AlertSeverity;
|
|
52
|
+
contractId: string;
|
|
53
|
+
contractName: string | null;
|
|
54
|
+
network: string;
|
|
55
|
+
entry: {
|
|
56
|
+
keyXdr: string;
|
|
57
|
+
type: string;
|
|
58
|
+
label: string | null;
|
|
59
|
+
};
|
|
60
|
+
diff: {
|
|
61
|
+
diffType: "created" | "updated" | "deleted";
|
|
62
|
+
oldValueXdr: string | null;
|
|
63
|
+
newValueXdr: string | null;
|
|
64
|
+
};
|
|
65
|
+
/** Ledger sequence number at the time of detection. */
|
|
66
|
+
detectedAtLedger: number;
|
|
67
|
+
/** ISO 8601 timestamp. */
|
|
68
|
+
timestamp: string;
|
|
69
|
+
}
|
|
70
|
+
export type AlertEvent = TTLAlertEvent | ResourceAlertEvent | StateChangeAlertEvent;
|
|
71
|
+
export interface AlertChannel {
|
|
72
|
+
send(target: string, event: AlertEvent, secret?: string | null): Promise<void>;
|
|
73
|
+
}
|
|
74
|
+
export declare function computeSeverity(remainingTTL: number, thresholdLedgers: number, isResolution: boolean): AlertSeverity;
|
|
75
|
+
export declare function computeResourceSeverity(usagePercent: number): AlertSeverity;
|
|
76
|
+
export declare function buildAlertEvent(opts: {
|
|
77
|
+
type: "threshold_crossed" | "alert_resolved";
|
|
78
|
+
contractId: string;
|
|
79
|
+
contractName: string | null;
|
|
80
|
+
network: string;
|
|
81
|
+
entryKeyXdr: string;
|
|
82
|
+
entryType: string;
|
|
83
|
+
entryLabel: string | null;
|
|
84
|
+
configuredLedgers: number;
|
|
85
|
+
remainingTTL: number;
|
|
86
|
+
firedAtLedger: number;
|
|
87
|
+
}): TTLAlertEvent;
|
|
88
|
+
export declare function buildResourceAlertEvent(opts: {
|
|
89
|
+
contractId: string;
|
|
90
|
+
contractName: string | null;
|
|
91
|
+
network: string;
|
|
92
|
+
resourceType: "cpu" | "memory";
|
|
93
|
+
currentUsage: number;
|
|
94
|
+
limit: number;
|
|
95
|
+
usagePercent: number;
|
|
96
|
+
firedAtLedger?: number;
|
|
97
|
+
}): ResourceAlertEvent;
|
|
98
|
+
/**
|
|
99
|
+
* Build a state-change AlertEvent from raw data.
|
|
100
|
+
*/
|
|
101
|
+
export declare function buildStateChangeAlertEvent(opts: {
|
|
102
|
+
contractId: string;
|
|
103
|
+
contractName: string | null;
|
|
104
|
+
network: string;
|
|
105
|
+
entryKeyXdr: string;
|
|
106
|
+
entryType: string;
|
|
107
|
+
entryLabel: string | null;
|
|
108
|
+
diffType: "created" | "updated" | "deleted";
|
|
109
|
+
oldValueXdr: string | null;
|
|
110
|
+
newValueXdr: string | null;
|
|
111
|
+
detectedAtLedger: number;
|
|
112
|
+
}): StateChangeAlertEvent;
|
|
113
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/alerts/types.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,CAAC;AAC5D,MAAM,MAAM,cAAc,GAAG,mBAAmB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,eAAe,CAAC;AAEzG,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,mBAAmB,GAAG,gBAAgB,CAAC;IAC7C,QAAQ,EAAE,aAAa,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE;QACH,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB,CAAC;IACF,SAAS,EAAE;QACP,uDAAuD;QACvD,iBAAiB,EAAE,MAAM,CAAC;QAC1B,mDAAmD;QACnD,uBAAuB,EAAE,MAAM,CAAC;QAChC,oDAAoD;QACpD,wBAAwB,EAAE,MAAM,CAAC;KACpC,CAAC;IACF,uDAAuD;IACvD,aAAa,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,aAAa,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE;QACN,IAAI,EAAE,KAAK,GAAG,QAAQ,CAAC;QACvB,gDAAgD;QAChD,YAAY,EAAE,MAAM,CAAC;QACrB,mDAAmD;QACnD,KAAK,EAAE,MAAM,CAAC;QACd,sCAAsC;QACtC,YAAY,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,eAAe,CAAC;IACtB,QAAQ,EAAE,aAAa,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE;QACH,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACxB,CAAC;IACF,IAAI,EAAE;QACF,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;QAC5C,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B,CAAC;IACF,uDAAuD;IACvD,gBAAgB,EAAE,MAAM,CAAC;IACzB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,kBAAkB,GAAG,qBAAqB,CAAC;AAEpF,MAAM,WAAW,YAAY;IACzB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClF;AAED,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,GAAG,aAAa,CAKpH;AAED,wBAAgB,uBAAuB,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa,CAI3E;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE;IAClC,IAAI,EAAE,mBAAmB,GAAG,gBAAgB,CAAC;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACzB,GAAG,aAAa,CAoBhB;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE;IAC1C,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B,GAAG,kBAAkB,CAyBrB;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;IAC5C,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;CAC5B,GAAG,qBAAqB,CAoBxB"}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { formatTimeToCloseLedger } from "../utils/formatting.js";
|
|
2
|
+
export function computeSeverity(remainingTTL, thresholdLedgers, isResolution) {
|
|
3
|
+
if (isResolution)
|
|
4
|
+
return "info";
|
|
5
|
+
if (remainingTTL <= 0)
|
|
6
|
+
return "critical";
|
|
7
|
+
if (remainingTTL < thresholdLedgers * 0.25)
|
|
8
|
+
return "critical";
|
|
9
|
+
return "warning";
|
|
10
|
+
}
|
|
11
|
+
export function computeResourceSeverity(usagePercent) {
|
|
12
|
+
if (usagePercent >= 95)
|
|
13
|
+
return "critical";
|
|
14
|
+
if (usagePercent >= 80)
|
|
15
|
+
return "warning";
|
|
16
|
+
return "info";
|
|
17
|
+
}
|
|
18
|
+
export function buildAlertEvent(opts) {
|
|
19
|
+
return {
|
|
20
|
+
type: opts.type,
|
|
21
|
+
severity: computeSeverity(opts.remainingTTL, opts.configuredLedgers, opts.type === "alert_resolved"),
|
|
22
|
+
contractId: opts.contractId,
|
|
23
|
+
contractName: opts.contractName,
|
|
24
|
+
network: opts.network,
|
|
25
|
+
entry: {
|
|
26
|
+
keyXdr: opts.entryKeyXdr,
|
|
27
|
+
type: opts.entryType,
|
|
28
|
+
label: opts.entryLabel,
|
|
29
|
+
},
|
|
30
|
+
threshold: {
|
|
31
|
+
configuredLedgers: opts.configuredLedgers,
|
|
32
|
+
currentRemainingLedgers: opts.remainingTTL,
|
|
33
|
+
approximateTimeRemaining: formatTimeToCloseLedger(opts.remainingTTL),
|
|
34
|
+
},
|
|
35
|
+
firedAtLedger: opts.firedAtLedger,
|
|
36
|
+
timestamp: new Date().toISOString(),
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
export function buildResourceAlertEvent(opts) {
|
|
40
|
+
const resourceLabel = opts.resourceType === "cpu" ? "CPU" : "Memory";
|
|
41
|
+
const usageUnit = opts.resourceType === "cpu" ? "instructions" : "bytes";
|
|
42
|
+
let message = `${resourceLabel} usage is at ${opts.usagePercent}% of limit`;
|
|
43
|
+
if (opts.usagePercent > 100) {
|
|
44
|
+
message = `${resourceLabel} usage exceeds limit: ${opts.currentUsage} ${usageUnit} / ${opts.limit} ${usageUnit}`;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
type: "resource_alert",
|
|
48
|
+
severity: computeResourceSeverity(opts.usagePercent),
|
|
49
|
+
contractId: opts.contractId,
|
|
50
|
+
contractName: opts.contractName,
|
|
51
|
+
network: opts.network,
|
|
52
|
+
resource: {
|
|
53
|
+
type: opts.resourceType,
|
|
54
|
+
currentUsage: opts.currentUsage,
|
|
55
|
+
limit: opts.limit,
|
|
56
|
+
usagePercent: opts.usagePercent,
|
|
57
|
+
},
|
|
58
|
+
message,
|
|
59
|
+
firedAtLedger: opts.firedAtLedger,
|
|
60
|
+
timestamp: new Date().toISOString(),
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Build a state-change AlertEvent from raw data.
|
|
65
|
+
*/
|
|
66
|
+
export function buildStateChangeAlertEvent(opts) {
|
|
67
|
+
return {
|
|
68
|
+
type: "state_changed",
|
|
69
|
+
severity: "info",
|
|
70
|
+
contractId: opts.contractId,
|
|
71
|
+
contractName: opts.contractName,
|
|
72
|
+
network: opts.network,
|
|
73
|
+
entry: {
|
|
74
|
+
keyXdr: opts.entryKeyXdr,
|
|
75
|
+
type: opts.entryType,
|
|
76
|
+
label: opts.entryLabel,
|
|
77
|
+
},
|
|
78
|
+
diff: {
|
|
79
|
+
diffType: opts.diffType,
|
|
80
|
+
oldValueXdr: opts.oldValueXdr,
|
|
81
|
+
newValueXdr: opts.newValueXdr,
|
|
82
|
+
},
|
|
83
|
+
detectedAtLedger: opts.detectedAtLedger,
|
|
84
|
+
timestamp: new Date().toISOString(),
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/alerts/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAiFjE,MAAM,UAAU,eAAe,CAAC,YAAoB,EAAE,gBAAwB,EAAE,YAAqB;IACjG,IAAI,YAAY;QAAE,OAAO,MAAM,CAAC;IAChC,IAAI,YAAY,IAAI,CAAC;QAAE,OAAO,UAAU,CAAC;IACzC,IAAI,YAAY,GAAG,gBAAgB,GAAG,IAAI;QAAE,OAAO,UAAU,CAAC;IAC9D,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,YAAoB;IACxD,IAAI,YAAY,IAAI,EAAE;QAAE,OAAO,UAAU,CAAC;IAC1C,IAAI,YAAY,IAAI,EAAE;QAAE,OAAO,SAAS,CAAC;IACzC,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAW/B;IACG,OAAO;QACH,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,QAAQ,EAAE,eAAe,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC;QACpG,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,KAAK,EAAE;YACH,MAAM,EAAE,IAAI,CAAC,WAAW;YACxB,IAAI,EAAE,IAAI,CAAC,SAAS;YACpB,KAAK,EAAE,IAAI,CAAC,UAAU;SACzB;QACD,SAAS,EAAE;YACP,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;YACzC,uBAAuB,EAAE,IAAI,CAAC,YAAY;YAC1C,wBAAwB,EAAE,uBAAuB,CAAC,IAAI,CAAC,YAAY,CAAC;SACvE;QACD,aAAa,EAAE,IAAI,CAAC,aAAa;QACjC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACtC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,IASvC;IACG,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;IACrE,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC;IAEzE,IAAI,OAAO,GAAG,GAAG,aAAa,gBAAgB,IAAI,CAAC,YAAY,YAAY,CAAC;IAC5E,IAAI,IAAI,CAAC,YAAY,GAAG,GAAG,EAAE,CAAC;QAC1B,OAAO,GAAG,GAAG,aAAa,yBAAyB,IAAI,CAAC,YAAY,IAAI,SAAS,MAAM,IAAI,CAAC,KAAK,IAAI,SAAS,EAAE,CAAC;IACrH,CAAC;IAED,OAAO;QACH,IAAI,EAAE,gBAAgB;QACtB,QAAQ,EAAE,uBAAuB,CAAC,IAAI,CAAC,YAAY,CAAC;QACpD,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,QAAQ,EAAE;YACN,IAAI,EAAE,IAAI,CAAC,YAAY;YACvB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,IAAI,CAAC,YAAY;SAClC;QACD,OAAO;QACP,aAAa,EAAE,IAAI,CAAC,aAAa;QACjC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACtC,CAAC;AACN,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,0BAA0B,CAAC,IAW1C;IACG,OAAO;QACH,IAAI,EAAE,eAAe;QACrB,QAAQ,EAAE,MAAM;QAChB,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,KAAK,EAAE;YACH,MAAM,EAAE,IAAI,CAAC,WAAW;YACxB,IAAI,EAAE,IAAI,CAAC,SAAS;YACpB,KAAK,EAAE,IAAI,CAAC,UAAU;SACzB;QACD,IAAI,EAAE;YACF,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;SAChC;QACD,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;QACvC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACtC,CAAC;AACN,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { AlertEvent } from "./types.js";
|
|
2
|
+
/**
|
|
3
|
+
* Send an AlertEvent to a webhook URL via HTTP POST.
|
|
4
|
+
*
|
|
5
|
+
* If a `secret` is provided, the request includes an `X-Sorokeep-Signature`
|
|
6
|
+
* header with an HMAC-SHA256 hex digest of the body, allowing receivers to
|
|
7
|
+
* verify authenticity.
|
|
8
|
+
*
|
|
9
|
+
* Throws on any non-2xx response or network error.
|
|
10
|
+
* The caller (dispatcher) is responsible for retry logic via the `delivered` flag.
|
|
11
|
+
*/
|
|
12
|
+
export declare function sendWebhookAlert(url: string, event: AlertEvent, secret?: string | null): Promise<void>;
|
|
13
|
+
//# sourceMappingURL=webhook.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webhook.d.ts","sourceRoot":"","sources":["../../src/alerts/webhook.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAQ7C;;;;;;;;;GASG;AACH,wBAAsB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CA6C5G"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { createHmac } from "node:crypto";
|
|
2
|
+
import { getLogger } from "../logging/index.js";
|
|
3
|
+
import { renderAlertTemplate } from "./templates.js";
|
|
4
|
+
const logger = getLogger().child({ component: "WebhookHandler" });
|
|
5
|
+
const TIMEOUT_MS = 10_000;
|
|
6
|
+
/**
|
|
7
|
+
* Send an AlertEvent to a webhook URL via HTTP POST.
|
|
8
|
+
*
|
|
9
|
+
* If a `secret` is provided, the request includes an `X-Sorokeep-Signature`
|
|
10
|
+
* header with an HMAC-SHA256 hex digest of the body, allowing receivers to
|
|
11
|
+
* verify authenticity.
|
|
12
|
+
*
|
|
13
|
+
* Throws on any non-2xx response or network error.
|
|
14
|
+
* The caller (dispatcher) is responsible for retry logic via the `delivered` flag.
|
|
15
|
+
*/
|
|
16
|
+
export async function sendWebhookAlert(url, event, secret) {
|
|
17
|
+
logger.debug(`Sending webhook alert to ${url}`, { type: event.type, contractId: event.contractId });
|
|
18
|
+
const customMessage = renderAlertTemplate("webhook", event);
|
|
19
|
+
let body;
|
|
20
|
+
const headers = { "Content-Type": "application/json" };
|
|
21
|
+
if (customMessage !== null) {
|
|
22
|
+
body = customMessage;
|
|
23
|
+
try {
|
|
24
|
+
JSON.parse(customMessage);
|
|
25
|
+
}
|
|
26
|
+
catch {
|
|
27
|
+
headers["Content-Type"] = "text/plain";
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
else {
|
|
31
|
+
body = JSON.stringify(event);
|
|
32
|
+
}
|
|
33
|
+
if (secret) {
|
|
34
|
+
const signature = createHmac("sha256", secret).update(body).digest("hex");
|
|
35
|
+
headers["X-Sorokeep-Signature"] = `sha256=${signature}`;
|
|
36
|
+
}
|
|
37
|
+
const controller = new AbortController();
|
|
38
|
+
const timeout = setTimeout(() => controller.abort(), TIMEOUT_MS);
|
|
39
|
+
let response;
|
|
40
|
+
try {
|
|
41
|
+
response = await fetch(url, {
|
|
42
|
+
method: "POST",
|
|
43
|
+
headers,
|
|
44
|
+
body,
|
|
45
|
+
signal: controller.signal,
|
|
46
|
+
});
|
|
47
|
+
}
|
|
48
|
+
finally {
|
|
49
|
+
clearTimeout(timeout);
|
|
50
|
+
}
|
|
51
|
+
if (!response.ok) {
|
|
52
|
+
throw new Error(`Webhook delivery failed: HTTP ${response.status} from ${url}`);
|
|
53
|
+
}
|
|
54
|
+
logger.debug(`Webhook alert delivered successfully to ${url}`);
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=webhook.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"webhook.js","sourceRoot":"","sources":["../../src/alerts/webhook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAErD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAElE,MAAM,UAAU,GAAG,MAAM,CAAC;AAE1B;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,GAAW,EAAE,KAAiB,EAAE,MAAsB;IACzF,MAAM,CAAC,KAAK,CAAC,4BAA4B,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;IAEpG,MAAM,aAAa,GAAG,mBAAmB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC5D,IAAI,IAAY,CAAC;IACjB,MAAM,OAAO,GAA2B,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;IAE/E,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QACzB,IAAI,GAAG,aAAa,CAAC;QACrB,IAAI,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC9B,CAAC;QAAC,MAAM,CAAC;YACL,OAAO,CAAC,cAAc,CAAC,GAAG,YAAY,CAAC;QAC3C,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACT,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1E,OAAO,CAAC,sBAAsB,CAAC,GAAG,UAAU,SAAS,EAAE,CAAC;IAC5D,CAAC;IAED,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,UAAU,CAAC,CAAC;IAEjE,IAAI,QAAkB,CAAC;IACvB,IAAI,CAAC;QACD,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,MAAM,EAAE,UAAU,CAAC,MAAM;SAC5B,CAAC,CAAC;IACP,CAAC;YAAS,CAAC;QACP,YAAY,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CACX,iCAAiC,QAAQ,CAAC,MAAM,SAAS,GAAG,EAAE,CACjE,CAAC;IACN,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,2CAA2C,GAAG,EAAE,CAAC,CAAC;AACnE,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export type SchemaDictionary = Record<string, string>;
|
|
2
|
+
export declare function loadSchema(schemaPath: string): SchemaDictionary;
|
|
3
|
+
export declare function applySchema(data: any, schema: SchemaDictionary): any;
|
|
4
|
+
/**
|
|
5
|
+
* Wrapper used by CLI inspect formatting: loads schema when schemaPath is provided.
|
|
6
|
+
*
|
|
7
|
+
* - If schemaPath is undefined, returns schema map as undefined (caller should skip transformation)
|
|
8
|
+
* - If schemaPath is provided, loads+validates schema and applies translation to `data`.
|
|
9
|
+
*/
|
|
10
|
+
export declare function loadAndApplySchema(data: any, schemaPath?: string): any;
|
|
11
|
+
//# sourceMappingURL=schemaFormatter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schemaFormatter.d.ts","sourceRoot":"","sources":["../../src/cli/schemaFormatter.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAwBtD,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAwB/D;AAuBD,wBAAgB,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,gBAAgB,GAAG,GAAG,CAGpE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,GAAG,CAItE"}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import fs from "node:fs";
|
|
2
|
+
function normalizeSchemaCandidate(input) {
|
|
3
|
+
if (typeof input !== "object" || input === null || Array.isArray(input)) {
|
|
4
|
+
throw new Error("Schema configuration error: schema JSON must be a top-level object mapping raw keys to labels");
|
|
5
|
+
}
|
|
6
|
+
const candidate = input;
|
|
7
|
+
const out = {};
|
|
8
|
+
for (const [k, v] of Object.entries(candidate)) {
|
|
9
|
+
if (typeof v !== "string") {
|
|
10
|
+
throw new Error(`Schema configuration error: schema value for key '${k}' must be a string label`);
|
|
11
|
+
}
|
|
12
|
+
out[k] = v;
|
|
13
|
+
}
|
|
14
|
+
return out;
|
|
15
|
+
}
|
|
16
|
+
export function loadSchema(schemaPath) {
|
|
17
|
+
try {
|
|
18
|
+
const raw = fs.readFileSync(schemaPath, "utf8");
|
|
19
|
+
let parsed;
|
|
20
|
+
try {
|
|
21
|
+
parsed = JSON.parse(raw);
|
|
22
|
+
}
|
|
23
|
+
catch (err) {
|
|
24
|
+
const msg = err instanceof Error ? err.message : String(err);
|
|
25
|
+
throw new Error(`Schema configuration error: malformed JSON in schema file: ${msg}`, { cause: err });
|
|
26
|
+
}
|
|
27
|
+
return normalizeSchemaCandidate(parsed);
|
|
28
|
+
}
|
|
29
|
+
catch (err) {
|
|
30
|
+
const nodeErr = err;
|
|
31
|
+
if (nodeErr?.code === "ENOENT") {
|
|
32
|
+
throw new Error(`Schema configuration error: schema file not found at '${schemaPath}'`, { cause: err } // Pass the original caught variable directly
|
|
33
|
+
);
|
|
34
|
+
}
|
|
35
|
+
const msg = nodeErr?.message ?? String(err);
|
|
36
|
+
throw new Error(`Schema configuration error: failed to load schema file: ${msg}`, { cause: err }); // Pass the original caught variable directly
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
function applySchemaToValue(value, schema) {
|
|
40
|
+
if (typeof value === "string") {
|
|
41
|
+
return schema[value] ?? value;
|
|
42
|
+
}
|
|
43
|
+
if (Array.isArray(value)) {
|
|
44
|
+
return value.map((v) => applySchemaToValue(v, schema));
|
|
45
|
+
}
|
|
46
|
+
if (typeof value === "object" && value !== null) {
|
|
47
|
+
const obj = value;
|
|
48
|
+
const out = {};
|
|
49
|
+
for (const [key, v] of Object.entries(obj)) {
|
|
50
|
+
const nextKey = schema[key] ?? key;
|
|
51
|
+
out[nextKey] = applySchemaToValue(v, schema);
|
|
52
|
+
}
|
|
53
|
+
return out;
|
|
54
|
+
}
|
|
55
|
+
return value;
|
|
56
|
+
}
|
|
57
|
+
export function applySchema(data, schema) {
|
|
58
|
+
if (!schema || Object.keys(schema).length === 0)
|
|
59
|
+
return data;
|
|
60
|
+
return applySchemaToValue(data, schema);
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Wrapper used by CLI inspect formatting: loads schema when schemaPath is provided.
|
|
64
|
+
*
|
|
65
|
+
* - If schemaPath is undefined, returns schema map as undefined (caller should skip transformation)
|
|
66
|
+
* - If schemaPath is provided, loads+validates schema and applies translation to `data`.
|
|
67
|
+
*/
|
|
68
|
+
export function loadAndApplySchema(data, schemaPath) {
|
|
69
|
+
if (!schemaPath)
|
|
70
|
+
return data;
|
|
71
|
+
const schema = loadSchema(schemaPath);
|
|
72
|
+
return applySchema(data, schema);
|
|
73
|
+
}
|
|
74
|
+
//# sourceMappingURL=schemaFormatter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schemaFormatter.js","sourceRoot":"","sources":["../../src/cli/schemaFormatter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AAIzB,SAAS,wBAAwB,CAAC,KAAc;IAC9C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACxE,MAAM,IAAI,KAAK,CACb,+FAA+F,CAChG,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,KAAgC,CAAC;IACnD,MAAM,GAAG,GAAqB,EAAE,CAAC;IAEjC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/C,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CACb,qDAAqD,CAAC,0BAA0B,CACjF,CAAC;QACJ,CAAC;QACD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,UAAkB;IACzC,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAChD,IAAI,MAAe,CAAC;QACpB,IAAI,CAAC;YACD,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,GAAG,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC7D,MAAM,IAAI,KAAK,CAAC,8DAA8D,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QACzG,CAAC;QAED,OAAO,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,MAAM,OAAO,GAAG,GAA4B,CAAC;QAC7C,IAAI,OAAO,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACX,yDAAyD,UAAU,GAAG,EACtE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,6CAA6C;aAC/D,CAAC;QACN,CAAC;QAED,MAAM,GAAG,GAAG,OAAO,EAAE,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,2DAA2D,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,6CAA6C;IACpJ,CAAC;AACL,CAAC;AACD,SAAS,kBAAkB,CAAC,KAAc,EAAE,MAAwB;IAClE,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;IAChC,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,MAAM,GAAG,GAAG,KAAgC,CAAC;QAC7C,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC;YACnC,GAAG,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAS,EAAE,MAAwB;IAC7D,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7D,OAAO,kBAAkB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAS,EAAE,UAAmB;IAC/D,IAAI,CAAC,UAAU;QAAE,OAAO,IAAI,CAAC;IAC7B,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;IACtC,OAAO,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACnC,CAAC"}
|