@intentius/sql-yodeler 0.7.0 → 0.9.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/README.md +10 -2
- package/dist/apply-steps/index.d.ts +73 -21
- package/dist/apply-steps/index.js +171 -49
- package/dist/apply-steps/index.js.map +1 -1
- package/dist/ci/render.d.ts +11 -2
- package/dist/ci/render.js +21 -6
- package/dist/ci/render.js.map +1 -1
- package/dist/cli.js +1 -1
- package/dist/cli.js.map +1 -1
- package/dist/commands/apply.js +173 -64
- package/dist/commands/apply.js.map +1 -1
- package/dist/commands/drift.js +8 -8
- package/dist/commands/drift.js.map +1 -1
- package/dist/commands/lint.js +10 -7
- package/dist/commands/lint.js.map +1 -1
- package/dist/commands/override.js +46 -22
- package/dist/commands/override.js.map +1 -1
- package/dist/commands/plan.js +19 -19
- package/dist/commands/plan.js.map +1 -1
- package/dist/commands/revert.js +3 -2
- package/dist/commands/revert.js.map +1 -1
- package/dist/config/define.d.ts +12 -7
- package/dist/config/define.js.map +1 -1
- package/dist/lint/check.d.ts +3 -0
- package/dist/lint/check.js +3 -2
- package/dist/lint/check.js.map +1 -1
- package/dist/lint/policies.d.ts +22 -0
- package/dist/lint/policies.js +47 -0
- package/dist/lint/policies.js.map +1 -0
- package/dist/lint/schema-checks.d.ts +14 -3
- package/dist/lint/schema-checks.js +11 -5
- package/dist/lint/schema-checks.js.map +1 -1
- package/dist/mcp/tools.d.ts +1 -1
- package/dist/mcp/tools.js +6 -4
- package/dist/mcp/tools.js.map +1 -1
- package/dist/notify/index.d.ts +30 -97
- package/dist/notify/index.js +50 -154
- package/dist/notify/index.js.map +1 -1
- package/dist/notify/verify.d.ts +17 -31
- package/dist/notify/verify.js +16 -47
- package/dist/notify/verify.js.map +1 -1
- package/dist/pr/forge.d.ts +33 -38
- package/dist/pr/forge.js +74 -97
- package/dist/pr/forge.js.map +1 -1
- package/dist/pr/issue.d.ts +16 -33
- package/dist/pr/issue.js +17 -88
- package/dist/pr/issue.js.map +1 -1
- package/dist/pr/model.js +7 -2
- package/dist/pr/model.js.map +1 -1
- package/dist/pr/render.js +2 -2
- package/dist/pr/render.js.map +1 -1
- package/dist/release/index.d.ts +63 -0
- package/dist/release/index.js +122 -0
- package/dist/release/index.js.map +1 -0
- package/dist/report/audit.d.ts +18 -19
- package/dist/report/audit.js +57 -27
- package/dist/report/audit.js.map +1 -1
- package/dist/report/model.js +18 -5
- package/dist/report/model.js.map +1 -1
- package/dist/tenants/wave.d.ts +6 -2
- package/dist/tenants/wave.js +1 -3
- package/dist/tenants/wave.js.map +1 -1
- package/dist/versioned/policy.d.ts +44 -24
- package/dist/versioned/policy.js +70 -37
- package/dist/versioned/policy.js.map +1 -1
- package/dist/waves/index.d.ts +4 -10
- package/dist/waves/index.js +8 -33
- package/dist/waves/index.js.map +1 -1
- package/package.json +19 -8
- package/schemas/event.schema.json +218 -26
- package/dist/pr/comment.d.ts +0 -32
- package/dist/pr/comment.js +0 -99
- package/dist/pr/comment.js.map +0 -1
package/dist/mcp/tools.js
CHANGED
|
@@ -14,6 +14,7 @@ import { drift } from "../commands/drift.js";
|
|
|
14
14
|
import { lint } from "../commands/lint.js";
|
|
15
15
|
import { plan } from "../commands/plan.js";
|
|
16
16
|
import { status } from "../commands/status.js";
|
|
17
|
+
import { overrideCommand } from "../versioned/policy.js";
|
|
17
18
|
/** The only verbs a tool may run, and only with the flags {@link runVerb} allows. */
|
|
18
19
|
export const READ_VERBS = { status, plan, lint, drift };
|
|
19
20
|
/** Never a tool, and never run by one: each writes to a database, a history, the migrations directory or the gate ledger. */
|
|
@@ -88,11 +89,12 @@ const envInput = (required, what) => ({
|
|
|
88
89
|
...(required ? { required: ["env"] } : {}),
|
|
89
90
|
additionalProperties: false,
|
|
90
91
|
});
|
|
91
|
-
/** A plan's steps that are a person's: overriding
|
|
92
|
+
/** A plan's steps that are a person's: overriding the policy rules that deny it (when the denial should not stand), and approving it. */
|
|
92
93
|
export function personSteps(env, plan) {
|
|
93
|
-
const
|
|
94
|
-
|
|
95
|
-
|
|
94
|
+
const denied = (plan?.policy ?? []).filter((r) => r.outcome === "denied").map((r) => r.id);
|
|
95
|
+
const steps = denied.length > 0
|
|
96
|
+
? [{ action: `override policy ${denied.length === 1 ? "rule" : "rules"} ${denied.join(", ")}, if a person on policy.overriders decides the denial should not stand`, command: overrideCommand(env, denied) }]
|
|
97
|
+
: [];
|
|
96
98
|
if (typeof plan?.approve === "string")
|
|
97
99
|
steps.push({ action: "approve this plan, after reading it", command: plan.approve });
|
|
98
100
|
return steps;
|
package/dist/mcp/tools.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../src/mcp/tools.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../src/mcp/tools.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,qFAAqF;AACrF,MAAM,CAAC,MAAM,UAAU,GAAsC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAE3F,6HAA6H;AAC7H,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAU,CAAC;AAE9J,8GAA8G;AAC9G,MAAM,WAAW,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,QAAQ,EAAE,mBAAmB,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;AA6BvH,6HAA6H;AAC7H,MAAM,UAAU,cAAc,CAAC,KAA2B;IACxD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9G,IAAI,KAAK;YAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,uBAAuB,KAAK,gBAAgB,CAAC,CAAC;QACrF,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK;YAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;gBAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,eAAe,CAAC,yCAAyC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxL,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,YAAY,IAAI,CAAC,CAAC,WAAW,CAAC,eAAe,KAAK,IAAI;YAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,6BAA6B,CAAC,CAAC;IACxI,CAAC;IACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,UAAU,CAAC,gEAAgE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACvI,CAAC;AAED,kFAAkF;AAClF,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,IAAY,EAAE,IAAuB;IACjE,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/E,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,UAAU,CAAC,uBAAuB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IAC7G,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACxF,IAAI,IAAI;QAAE,MAAM,IAAI,UAAU,CAAC,gCAAgC,IAAI,IAAI,IAAI,aAAa,CAAC,CAAC;IAC1F,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,MAAM,EAAE,GAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC;IAClE,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;IACxD,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAC5B,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,IAAY,EAAW,EAAE;IACtC,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAa,CAAC;IACnE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,mEAAmE;AACnE,MAAM,OAAO,GAAG,CAAC,GAAW,EAAY,EAAE,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AAE1D,MAAM,MAAM,GAAG,CAAC,IAA6B,EAAE,QAAiB,EAAsB,EAAE;IACtF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;IACrB,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,QAAQ;QAAE,OAAO,SAAS,CAAC;IACrD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,MAAM,IAAI,UAAU,CAAC,6DAA6D,CAAC,CAAC;IAC3I,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,KAAK,UAAU,QAAQ,CAAC,IAAY,EAAE,IAAY,EAAE,IAAc,EAAE,MAAc,EAAE,QAAuC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACjI,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACvD,OAAO;QACL,MAAM,EAAE,cAAc;QACtB,IAAI;QACJ,OAAO,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,OAAO,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QAChH,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,OAAO;QACP,aAAa,EAAE,MAAM;QACrB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC5D,CAAC;AACJ,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,QAAiB,EAAE,IAAY,EAAE,EAAE,CAAC,CAAC;IACrD,IAAI,EAAE,QAAiB;IACvB,UAAU,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE;IAC1D,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1C,oBAAoB,EAAE,KAAK;CAC5B,CAAC,CAAC;AAOH,yIAAyI;AACzI,MAAM,UAAU,WAAW,CAAC,GAAW,EAAE,IAAwB;IAC/D,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3F,MAAM,KAAK,GACT,MAAM,CAAC,MAAM,GAAG,CAAC;QACf,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,mBAAmB,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,wEAAwE,EAAE,OAAO,EAAE,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;QAC7M,CAAC,CAAC,EAAE,CAAC;IACT,IAAI,OAAO,IAAI,EAAE,OAAO,KAAK,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,qCAAqC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5H,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,SAAS,GAAG,EAAE,YAAY,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;AAE7G,MAAM,GAAG,GAAG,+CAA+C,CAAC;AAE5D,2CAA2C;AAC3C,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO;QACL;YACE,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qOAAqO,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE;YACpR,WAAW,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC;YAChC,WAAW,EAAE,SAAS;YACtB,KAAK,EAAE,CAAC,QAAQ,CAAC;YACjB,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAW,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;SAC7H;QACD;YACE,IAAI,EAAE,MAAM;YACZ,WAAW,EAAE,gRAAgR,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;YAC7T,WAAW,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC;YAChC,WAAW,EAAE,SAAS;YACtB,KAAK,EAAE,CAAC,MAAM,CAAC;YACf,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;gBACnB,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,EAAE,IAAI,CAAW,CAAC;gBACtC,MAAM,CAAC,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;gBACjG,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC,OAA6B,CAAC,CAAC;gBACpE,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACxD,CAAC;SACF;QACD;YACE,IAAI,EAAE,MAAM;YACZ,WAAW,EAAE,sNAAsN,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;YACnQ,WAAW,EAAE,QAAQ,CAAC,KAAK,EAAE,GAAG,GAAG,qDAAqD,CAAC;YACzF,WAAW,EAAE,SAAS;YACtB,KAAK,EAAE,CAAC,MAAM,CAAC;YACf,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;gBACb,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBAC7B,OAAO,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YACrH,CAAC;SACF;QACD;YACE,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,yGAAyG,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE;YACvJ,WAAW,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC;YAChC,WAAW,EAAE,SAAS;YACtB,KAAK,EAAE,CAAC,OAAO,CAAC;YAChB,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAW,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;SAC1H;QACD;YACE,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,uKAAuK,QAAQ,CAAC,KAAK,CAAC,iBAAiB;YACpN,WAAW,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC;YAChC,WAAW,EAAE,SAAS;YACtB,KAAK,EAAE,CAAC,QAAQ,CAAC;YACjB,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CACb,QAAQ,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAW,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC,EAAE,EAAE;gBACrH,MAAM,CAAC,GAAG,CAA4B,CAAC;gBACvC,OAAO,EAAE,WAAW,EAAE,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;YAC3H,CAAC,CAAC;SACL;QACD;YACE,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,8JAA8J,QAAQ,CAAC,KAAK,CAAC,iBAAiB;YAC3M,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,mEAAmE,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,oBAAoB,EAAE,KAAK,EAAE;YAC9M,WAAW,EAAE,SAAS;YACtB,KAAK,EAAE,CAAC,MAAM,CAAC;YACf,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;gBACnB,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChE,MAAM,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC;gBACnD,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC;gBACjE,IAAI,IAAI,EAAE,CAAC;oBACT,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,QAAQ,iBAAiB,EAAE,EAAE,CAAC;gBAC1N,CAAC;gBACD,MAAM,CAAC,GAAG,MAAM,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE;oBACtF,MAAM,IAAI,GAAI,CAA2B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC;oBACtE,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,QAAQ,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;gBACpF,CAAC,CAAC,CAAC;gBACH,OAAO,CAAC,CAAC,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,6BAA6B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,sCAAsC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACrK,CAAC;SACF;KACF,CAAC;AACJ,CAAC"}
|
package/dist/notify/index.d.ts
CHANGED
|
@@ -1,81 +1,39 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Webhook events (#61). `notify` in
|
|
3
|
-
* variables that hold a webhook's URL
|
|
4
|
-
* themselves); `yodel apply`,
|
|
5
|
-
*
|
|
6
|
-
* failed, and when drift is
|
|
2
|
+
* Webhook events (#61), sent through chant's notify (#211). `notify` in
|
|
3
|
+
* yodel.config.ts names the environment variables that hold a webhook's URL
|
|
4
|
+
* and its signing key (never the values themselves); `yodel apply`,
|
|
5
|
+
* `yodel plan` and `yodel drift` post an event when an environment is
|
|
6
|
+
* waiting for approval, when a run was refused or failed, and when drift is
|
|
7
|
+
* found:
|
|
7
8
|
*
|
|
8
9
|
* ```ts
|
|
9
10
|
* notify: { webhook: "YODEL_WEBHOOK_URL", key: "YODEL_WEBHOOK_KEY", slack: "SLACK_WEBHOOK_URL" }
|
|
10
11
|
* ```
|
|
11
12
|
*
|
|
12
|
-
* The
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
13
|
+
* The event is chant's `chant.notify/v1`; yodel decides when to send one and
|
|
14
|
+
* what it says. The webhook gets it as JSON, signed under yodel's header
|
|
15
|
+
* names (`./verify.ts`); Slack and Teams incoming webhooks get chant's
|
|
16
|
+
* message. A delivery that fails is reported on stderr and never changes the
|
|
17
|
+
* command's exit code: the event is news about the run, not part of it.
|
|
16
18
|
*/
|
|
19
|
+
import { type NotifyConfig, type NotifyDelivery, type NotifyFetch, type NotifyFields } from "@intentius/chant/notify";
|
|
17
20
|
import type { Io } from "../command.js";
|
|
18
21
|
export * from "./verify.js";
|
|
19
|
-
export
|
|
20
|
-
export type NotifyEventKind
|
|
21
|
-
/**
|
|
22
|
-
export
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
/** The variable holding a Slack incoming webhook's URL. Its messages are text and unsigned (Slack does not check a signature). */
|
|
28
|
-
slack?: string;
|
|
29
|
-
/** The events to send. Default: all of them. */
|
|
30
|
-
events?: NotifyEventKind[];
|
|
31
|
-
}
|
|
32
|
-
/** What an event says. The JSON Schema is schemas/event.schema.json. */
|
|
33
|
-
export interface NotifyEvent {
|
|
34
|
-
version: 1;
|
|
35
|
-
/** Unique per event; the `x-yodel-delivery` header carries it too, so a receiver can drop a repeat. */
|
|
36
|
-
id: string;
|
|
37
|
-
event: NotifyEventKind;
|
|
38
|
-
/** When yodel sent it, ISO 8601 UTC. */
|
|
39
|
-
at: string;
|
|
40
|
-
environment: string;
|
|
41
|
-
/** The command that sent it. */
|
|
42
|
-
command: "apply" | "plan" | "drift";
|
|
43
|
-
/** The command's own word for the outcome (`gated`, `refused`, `denied`, `failed`, `drifted`). */
|
|
44
|
-
status: string;
|
|
45
|
-
/** One line a person can read. */
|
|
46
|
-
summary: string;
|
|
47
|
-
/** The migrations concerned: the pending ones for apply and plan. */
|
|
48
|
-
migrations: string[];
|
|
49
|
-
/** The plan digest the run computed, when it computed one. */
|
|
50
|
-
digest?: string;
|
|
51
|
-
/** The command that approves the plan, on `waiting`: `yodel approve <env> --plan <digest>`, for a person at a terminal. */
|
|
52
|
-
approve?: string;
|
|
53
|
-
/** chant's own command for the same approval, for scripts. */
|
|
54
|
-
chantApprove?: string;
|
|
55
|
-
/** Why it was refused or failed: the refusal's message, the failing exit code. */
|
|
56
|
-
reason?: string;
|
|
57
|
-
/** drift: the objects changed and missing, and the drift's fingerprint (the same drift, the same fingerprint, run after run). */
|
|
58
|
-
drift?: {
|
|
59
|
-
changed: string[];
|
|
60
|
-
missing: string[];
|
|
61
|
-
fingerprint?: string;
|
|
22
|
+
export { NOTIFY_EVENTS, makeNotifyEvent, notifyConfigProblem, slackMessage, webhookRequest } from "@intentius/chant/notify";
|
|
23
|
+
export type { NotifyConfig, NotifyDelivery, NotifyEvent, NotifyEventKind, NotifyFields } from "@intentius/chant/notify";
|
|
24
|
+
/** The product name events carry in `source`. */
|
|
25
|
+
export declare const SOURCE = "sql-yodeler";
|
|
26
|
+
/** What yodel says on top of chant's event: the command that sent it, in `detail`. */
|
|
27
|
+
export type YodelFields = NotifyFields & {
|
|
28
|
+
detail: {
|
|
29
|
+
command: "apply" | "plan" | "drift";
|
|
62
30
|
};
|
|
63
|
-
|
|
64
|
-
runUrl?: string;
|
|
65
|
-
/** The repository and commit, when CI says. */
|
|
66
|
-
repository?: string;
|
|
67
|
-
commit?: string;
|
|
68
|
-
}
|
|
69
|
-
/** Checks `notify` in yodel.config.ts; returns a message for the first problem, or undefined. */
|
|
70
|
-
export declare function notifyConfigProblem(value: unknown): string | undefined;
|
|
71
|
-
/** Where the CI run is, when yodel runs in one. */
|
|
72
|
-
export declare function ciContext(env: NodeJS.ProcessEnv): Pick<NotifyEvent, "runUrl" | "repository" | "commit">;
|
|
73
|
-
type Fields = Omit<NotifyEvent, "version" | "id" | "at" | "runUrl" | "repository" | "commit">;
|
|
31
|
+
};
|
|
74
32
|
/**
|
|
75
33
|
* The event for what `yodel apply --json` (or `yodel plan --json`) printed,
|
|
76
34
|
* or undefined when the outcome is not one an event is sent for.
|
|
77
35
|
*/
|
|
78
|
-
export declare function eventFromRun(command: "apply" | "plan", doc: Record<string, unknown>):
|
|
36
|
+
export declare function eventFromRun(command: "apply" | "plan", doc: Record<string, unknown>): YodelFields | undefined;
|
|
79
37
|
/** The event for what `yodel drift --json` printed, or undefined when nothing drifted. */
|
|
80
38
|
export declare function eventFromDrift(doc: {
|
|
81
39
|
environment?: string;
|
|
@@ -85,42 +43,17 @@ export declare function eventFromDrift(doc: {
|
|
|
85
43
|
}>;
|
|
86
44
|
missing?: string[];
|
|
87
45
|
fingerprint?: string;
|
|
88
|
-
}):
|
|
89
|
-
/** A whole event: the fields, with its id, time and the CI run. */
|
|
90
|
-
export declare function makeEvent(fields: Fields, env?: NodeJS.ProcessEnv, now?: Date): NotifyEvent;
|
|
91
|
-
/** The Slack message for an event: one line of text, with the approve command and the run on `waiting`. */
|
|
92
|
-
export declare function slackMessage(e: NotifyEvent): {
|
|
93
|
-
text: string;
|
|
94
|
-
};
|
|
95
|
-
export type Fetch = (url: string, init: {
|
|
96
|
-
method: string;
|
|
97
|
-
headers: Record<string, string>;
|
|
98
|
-
body: string;
|
|
99
|
-
signal?: AbortSignal;
|
|
100
|
-
}) => Promise<{
|
|
101
|
-
ok: boolean;
|
|
102
|
-
status: number;
|
|
103
|
-
}>;
|
|
104
|
-
export interface Delivery {
|
|
105
|
-
target: "webhook" | "slack";
|
|
106
|
-
ok: boolean;
|
|
107
|
-
/** The HTTP status, or why there was none. */
|
|
108
|
-
detail: string;
|
|
109
|
-
}
|
|
110
|
-
/** The request that delivers `event` to the webhook, signed with `key`. */
|
|
111
|
-
export declare function webhookRequest(event: NotifyEvent, key: string, now?: number): {
|
|
112
|
-
headers: Record<string, string>;
|
|
113
|
-
body: string;
|
|
114
|
-
};
|
|
46
|
+
}): YodelFields | undefined;
|
|
115
47
|
/**
|
|
116
|
-
* Sends the event to what `config` names
|
|
117
|
-
*
|
|
118
|
-
* a failed one is
|
|
48
|
+
* Sends the event to what `config` names, through chant's notify under
|
|
49
|
+
* yodel's header names. Reads the URLs and the key from `env` at send time.
|
|
50
|
+
* Never throws: each delivery's outcome is returned and a failed one is
|
|
51
|
+
* written to `io.err`.
|
|
119
52
|
*/
|
|
120
|
-
export declare function sendEvent(config: NotifyConfig | undefined, fields:
|
|
53
|
+
export declare function sendEvent(config: NotifyConfig | undefined, fields: YodelFields | undefined, options: {
|
|
121
54
|
io: Io;
|
|
122
55
|
verb: string;
|
|
123
56
|
env?: NodeJS.ProcessEnv;
|
|
124
|
-
fetch?:
|
|
57
|
+
fetch?: NotifyFetch;
|
|
125
58
|
attempts?: number;
|
|
126
|
-
}): Promise<
|
|
59
|
+
}): Promise<NotifyDelivery[]>;
|
package/dist/notify/index.js
CHANGED
|
@@ -1,68 +1,27 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Webhook events (#61). `notify` in
|
|
3
|
-
* variables that hold a webhook's URL
|
|
4
|
-
* themselves); `yodel apply`,
|
|
5
|
-
*
|
|
6
|
-
* failed, and when drift is
|
|
2
|
+
* Webhook events (#61), sent through chant's notify (#211). `notify` in
|
|
3
|
+
* yodel.config.ts names the environment variables that hold a webhook's URL
|
|
4
|
+
* and its signing key (never the values themselves); `yodel apply`,
|
|
5
|
+
* `yodel plan` and `yodel drift` post an event when an environment is
|
|
6
|
+
* waiting for approval, when a run was refused or failed, and when drift is
|
|
7
|
+
* found:
|
|
7
8
|
*
|
|
8
9
|
* ```ts
|
|
9
10
|
* notify: { webhook: "YODEL_WEBHOOK_URL", key: "YODEL_WEBHOOK_KEY", slack: "SLACK_WEBHOOK_URL" }
|
|
10
11
|
* ```
|
|
11
12
|
*
|
|
12
|
-
* The
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
13
|
+
* The event is chant's `chant.notify/v1`; yodel decides when to send one and
|
|
14
|
+
* what it says. The webhook gets it as JSON, signed under yodel's header
|
|
15
|
+
* names (`./verify.ts`); Slack and Teams incoming webhooks get chant's
|
|
16
|
+
* message. A delivery that fails is reported on stderr and never changes the
|
|
17
|
+
* command's exit code: the event is news about the run, not part of it.
|
|
16
18
|
*/
|
|
17
|
-
import {
|
|
18
|
-
import {
|
|
19
|
+
import { makeNotifyEvent, sendNotify } from "@intentius/chant/notify";
|
|
20
|
+
import { HEADER_PREFIX } from "./verify.js";
|
|
19
21
|
export * from "./verify.js";
|
|
20
|
-
export
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
export function notifyConfigProblem(value) {
|
|
24
|
-
if (typeof value !== "object" || value === null || Array.isArray(value))
|
|
25
|
-
return "notify: expected { webhook, key, slack?, events? }";
|
|
26
|
-
const v = value;
|
|
27
|
-
for (const k of Object.keys(v))
|
|
28
|
-
if (!["webhook", "key", "slack", "events"].includes(k))
|
|
29
|
-
return `notify.${k}: unknown setting (expected webhook, key, slack, events)`;
|
|
30
|
-
for (const k of ["webhook", "key", "slack"]) {
|
|
31
|
-
const n = v[k];
|
|
32
|
-
if (n === undefined)
|
|
33
|
-
continue;
|
|
34
|
-
if (typeof n !== "string" || n.includes("://") || !NAME.test(n)) {
|
|
35
|
-
return `notify.${k}: the name of the environment variable that holds the ${k === "key" ? "signing key" : "URL"} (such as ${k === "key" ? "YODEL_WEBHOOK_KEY" : k === "slack" ? "SLACK_WEBHOOK_URL" : "YODEL_WEBHOOK_URL"}), never the ${k === "key" ? "key" : "URL"} itself`;
|
|
36
|
-
}
|
|
37
|
-
}
|
|
38
|
-
if (v.webhook !== undefined && v.key === undefined)
|
|
39
|
-
return "notify.key: a webhook needs a signing key; name the variable that holds it";
|
|
40
|
-
if (v.key !== undefined && v.webhook === undefined)
|
|
41
|
-
return "notify.webhook: a key is for a webhook; name the variable that holds its URL";
|
|
42
|
-
if (v.webhook === undefined && v.slack === undefined)
|
|
43
|
-
return "notify: name a webhook (with its key) or a slack URL variable";
|
|
44
|
-
if (v.events !== undefined && !(Array.isArray(v.events) && v.events.every((e) => NOTIFY_EVENTS.includes(e)))) {
|
|
45
|
-
return `notify.events: a list of ${NOTIFY_EVENTS.join(", ")}`;
|
|
46
|
-
}
|
|
47
|
-
return undefined;
|
|
48
|
-
}
|
|
49
|
-
/** Where the CI run is, when yodel runs in one. */
|
|
50
|
-
export function ciContext(env) {
|
|
51
|
-
const out = {};
|
|
52
|
-
if (env.GITHUB_SERVER_URL && env.GITHUB_REPOSITORY && env.GITHUB_RUN_ID)
|
|
53
|
-
out.runUrl = `${env.GITHUB_SERVER_URL}/${env.GITHUB_REPOSITORY}/actions/runs/${env.GITHUB_RUN_ID}`;
|
|
54
|
-
else if (env.CI_JOB_URL)
|
|
55
|
-
out.runUrl = env.CI_JOB_URL;
|
|
56
|
-
else if (env.CI_PIPELINE_URL)
|
|
57
|
-
out.runUrl = env.CI_PIPELINE_URL;
|
|
58
|
-
const repository = env.GITHUB_REPOSITORY ?? env.CI_PROJECT_PATH;
|
|
59
|
-
if (repository)
|
|
60
|
-
out.repository = repository;
|
|
61
|
-
const commit = env.GITHUB_SHA ?? env.CI_COMMIT_SHA;
|
|
62
|
-
if (commit)
|
|
63
|
-
out.commit = commit;
|
|
64
|
-
return out;
|
|
65
|
-
}
|
|
22
|
+
export { NOTIFY_EVENTS, makeNotifyEvent, notifyConfigProblem, slackMessage, webhookRequest } from "@intentius/chant/notify";
|
|
23
|
+
/** The product name events carry in `source`. */
|
|
24
|
+
export const SOURCE = "sql-yodeler";
|
|
66
25
|
const ids = (list) => (Array.isArray(list) ? list.flatMap((p) => (typeof p === "object" && p !== null && typeof p.id === "string" ? [p.id] : [])) : []);
|
|
67
26
|
const str = (v) => (typeof v === "string" && v !== "" ? v : undefined);
|
|
68
27
|
const firstLine = (s) => s.split("\n")[0] ?? s;
|
|
@@ -73,15 +32,21 @@ const firstLine = (s) => s.split("\n")[0] ?? s;
|
|
|
73
32
|
export function eventFromRun(command, doc) {
|
|
74
33
|
const status = str(doc.status) ?? (doc.refusal ? "refused" : undefined);
|
|
75
34
|
const environment = str(doc.environment) ?? "";
|
|
76
|
-
const
|
|
35
|
+
const targets = ids(doc.pending);
|
|
77
36
|
const digest = str(doc.gatePlanDigest) ?? str(doc.planDigest);
|
|
78
|
-
const base = { environment,
|
|
37
|
+
const base = { source: SOURCE, environment, targets, detail: { command }, ...(digest ? { digest } : {}) };
|
|
79
38
|
const refusal = doc.refusal?.message;
|
|
80
39
|
const deniedRules = Array.isArray(doc.policy) ? doc.policy.filter((r) => r.outcome === "denied").map((r) => r.id ?? "") : [];
|
|
81
40
|
if (status === "gated") {
|
|
82
41
|
const approve = str(doc.approve);
|
|
83
|
-
const
|
|
84
|
-
return {
|
|
42
|
+
const chant = str(doc.chantApprove);
|
|
43
|
+
return {
|
|
44
|
+
...base,
|
|
45
|
+
event: "waiting",
|
|
46
|
+
status,
|
|
47
|
+
summary: `${environment} is waiting for approval of ${digest ?? "its plan"} (${String(targets.length)} migration${targets.length === 1 ? "" : "s"})`,
|
|
48
|
+
...(approve ? { approve: { command: approve, ...(chant ? { chant } : {}) } } : {}),
|
|
49
|
+
};
|
|
85
50
|
}
|
|
86
51
|
if (status === "refused" || status === "denied" || (command === "plan" && (refusal !== undefined || deniedRules.length > 0))) {
|
|
87
52
|
const reason = typeof refusal === "string" ? refusal : deniedRules.length > 0 ? `policy rule ${deniedRules.join(", ")} denies the plan` : status === "refused" ? "refused" : "denied by policy";
|
|
@@ -90,7 +55,14 @@ export function eventFromRun(command, doc) {
|
|
|
90
55
|
if (status === "failed" || status === "incomplete") {
|
|
91
56
|
const code = typeof doc.exitCode === "number" ? doc.exitCode : undefined;
|
|
92
57
|
const reason = `${command} ${status}${code !== undefined ? ` (exit ${String(code)})` : ""}`;
|
|
93
|
-
return {
|
|
58
|
+
return {
|
|
59
|
+
...base,
|
|
60
|
+
event: "failed",
|
|
61
|
+
status,
|
|
62
|
+
summary: `${command} in ${environment} ${status}${code !== undefined ? ` with exit ${String(code)}` : ""}`,
|
|
63
|
+
reason,
|
|
64
|
+
...(code !== undefined ? { exitCode: code } : {}),
|
|
65
|
+
};
|
|
94
66
|
}
|
|
95
67
|
return undefined;
|
|
96
68
|
}
|
|
@@ -102,110 +74,34 @@ export function eventFromDrift(doc) {
|
|
|
102
74
|
const missing = doc.missing ?? [];
|
|
103
75
|
const environment = doc.environment ?? "";
|
|
104
76
|
return {
|
|
77
|
+
source: SOURCE,
|
|
105
78
|
event: "drift",
|
|
106
79
|
environment,
|
|
107
|
-
command: "drift",
|
|
108
80
|
status: "drifted",
|
|
109
|
-
|
|
81
|
+
detail: { command: "drift" },
|
|
110
82
|
summary: `${environment} drifted: ${[changed.length > 0 ? `${changed.join(", ")} changed` : "", missing.length > 0 ? `${missing.join(", ")} missing` : ""].filter(Boolean).join("; ")}`,
|
|
111
83
|
drift: { changed, missing, ...(doc.fingerprint ? { fingerprint: doc.fingerprint } : {}) },
|
|
112
84
|
};
|
|
113
85
|
}
|
|
114
|
-
/** A whole event: the fields, with its id, time and the CI run. */
|
|
115
|
-
export function makeEvent(fields, env = process.env, now = new Date()) {
|
|
116
|
-
return { version: 1, id: randomUUID(), at: now.toISOString(), ...fields, ...ciContext(env) };
|
|
117
|
-
}
|
|
118
|
-
/** The Slack message for an event: one line of text, with the approve command and the run on `waiting`. */
|
|
119
|
-
export function slackMessage(e) {
|
|
120
|
-
const lines = [`yodel ${e.event}: ${e.summary}`];
|
|
121
|
-
if (e.approve)
|
|
122
|
-
lines.push(`Approve with: \`${e.approve}\``);
|
|
123
|
-
if (e.runUrl)
|
|
124
|
-
lines.push(`Run: ${e.runUrl}`);
|
|
125
|
-
return { text: lines.join("\n") };
|
|
126
|
-
}
|
|
127
|
-
/** The request that delivers `event` to the webhook, signed with `key`. */
|
|
128
|
-
export function webhookRequest(event, key, now = Math.floor(Date.now() / 1000)) {
|
|
129
|
-
const body = JSON.stringify(event);
|
|
130
|
-
return {
|
|
131
|
-
body,
|
|
132
|
-
headers: {
|
|
133
|
-
"content-type": "application/json",
|
|
134
|
-
"user-agent": "sql-yodeler",
|
|
135
|
-
[EVENT_HEADER]: event.event,
|
|
136
|
-
[DELIVERY_HEADER]: event.id,
|
|
137
|
-
[TIMESTAMP_HEADER]: String(now),
|
|
138
|
-
[SIGNATURE_HEADER]: signWebhook(key, now, body),
|
|
139
|
-
},
|
|
140
|
-
};
|
|
141
|
-
}
|
|
142
|
-
async function post(fetchFn, url, request, attempts) {
|
|
143
|
-
let last = "";
|
|
144
|
-
for (let i = 0; i < attempts; i++) {
|
|
145
|
-
if (i > 0)
|
|
146
|
-
await new Promise((r) => setTimeout(r, 500 * i));
|
|
147
|
-
try {
|
|
148
|
-
const res = await fetchFn(url, { method: "POST", ...request, signal: AbortSignal.timeout(10_000) });
|
|
149
|
-
if (res.ok)
|
|
150
|
-
return undefined;
|
|
151
|
-
last = `HTTP ${String(res.status)}`;
|
|
152
|
-
// A 4xx will not change on a retry: the receiver refused the event (a signature it does not accept, say).
|
|
153
|
-
if (res.status < 500)
|
|
154
|
-
return last;
|
|
155
|
-
}
|
|
156
|
-
catch (e) {
|
|
157
|
-
last = e instanceof Error ? e.message : String(e);
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
return last;
|
|
161
|
-
}
|
|
162
86
|
/**
|
|
163
|
-
* Sends the event to what `config` names
|
|
164
|
-
*
|
|
165
|
-
* a failed one is
|
|
87
|
+
* Sends the event to what `config` names, through chant's notify under
|
|
88
|
+
* yodel's header names. Reads the URLs and the key from `env` at send time.
|
|
89
|
+
* Never throws: each delivery's outcome is returned and a failed one is
|
|
90
|
+
* written to `io.err`.
|
|
166
91
|
*/
|
|
167
92
|
export async function sendEvent(config, fields, options) {
|
|
168
93
|
if (!config || !fields)
|
|
169
94
|
return [];
|
|
170
|
-
if (config.events && !config.events.includes(fields.event))
|
|
171
|
-
return [];
|
|
172
95
|
const env = options.env ?? process.env;
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
let d;
|
|
184
|
-
if (!url)
|
|
185
|
-
d = { target: "webhook", ok: false, detail: `${config.webhook} is not set` };
|
|
186
|
-
else if (!key)
|
|
187
|
-
d = { target: "webhook", ok: false, detail: `${config.key ?? "the key variable"} is not set, and yodel does not send an unsigned event` };
|
|
188
|
-
else {
|
|
189
|
-
const failed = await post(fetchFn, url, webhookRequest(event, key), attempts);
|
|
190
|
-
d = { target: "webhook", ok: failed === undefined, detail: failed ?? "delivered" };
|
|
191
|
-
}
|
|
192
|
-
if (!d.ok)
|
|
193
|
-
warn(d);
|
|
194
|
-
out.push(d);
|
|
195
|
-
}
|
|
196
|
-
if (config.slack) {
|
|
197
|
-
const url = env[config.slack];
|
|
198
|
-
let d;
|
|
199
|
-
if (!url)
|
|
200
|
-
d = { target: "slack", ok: false, detail: `${config.slack} is not set` };
|
|
201
|
-
else {
|
|
202
|
-
const failed = await post(fetchFn, url, { headers: { "content-type": "application/json" }, body: JSON.stringify(slackMessage(event)) }, attempts);
|
|
203
|
-
d = { target: "slack", ok: failed === undefined, detail: failed ?? "delivered" };
|
|
204
|
-
}
|
|
205
|
-
if (!d.ok)
|
|
206
|
-
warn(d);
|
|
207
|
-
out.push(d);
|
|
208
|
-
}
|
|
209
|
-
return out;
|
|
96
|
+
return sendNotify(config, makeNotifyEvent(fields, { env }), {
|
|
97
|
+
env,
|
|
98
|
+
prefix: HEADER_PREFIX,
|
|
99
|
+
userAgent: SOURCE,
|
|
100
|
+
log: (line) => {
|
|
101
|
+
options.io.err(`yodel ${options.verb}: ${line}\n`);
|
|
102
|
+
},
|
|
103
|
+
...(options.fetch ? { fetch: options.fetch } : {}),
|
|
104
|
+
...(options.attempts !== undefined ? { attempts: options.attempts } : {}),
|
|
105
|
+
});
|
|
210
106
|
}
|
|
211
107
|
//# sourceMappingURL=index.js.map
|
package/dist/notify/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/notify/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE7G,cAAc,aAAa,CAAC;AAE5B,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAU,CAAC;AAiDhF,MAAM,IAAI,GAAG,0BAA0B,CAAC;AAExC,iGAAiG;AACjG,MAAM,UAAU,mBAAmB,CAAC,KAAc;IAChD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,oDAAoD,CAAC;IACrI,MAAM,CAAC,GAAG,KAAgC,CAAC;IAC3C,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAAE,IAAI,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YAAE,OAAO,UAAU,CAAC,0DAA0D,CAAC;IACrK,KAAK,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,CAAU,EAAE,CAAC;QACrD,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACf,IAAI,CAAC,KAAK,SAAS;YAAE,SAAS;QAC9B,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAChE,OAAO,UAAU,CAAC,yDAAyD,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,mBAAmB,gBAAgB,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;QAC/Q,CAAC;IACH,CAAC;IACD,IAAI,CAAC,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,KAAK,SAAS;QAAE,OAAO,4EAA4E,CAAC;IACxI,IAAI,CAAC,CAAC,GAAG,KAAK,SAAS,IAAI,CAAC,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,8EAA8E,CAAC;IAC1I,IAAI,CAAC,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS;QAAE,OAAO,+DAA+D,CAAC;IAC7H,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAE,aAAoC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACrI,OAAO,4BAA4B,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IAChE,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,SAAS,CAAC,GAAsB;IAC9C,MAAM,GAAG,GAA0D,EAAE,CAAC;IACtE,IAAI,GAAG,CAAC,iBAAiB,IAAI,GAAG,CAAC,iBAAiB,IAAI,GAAG,CAAC,aAAa;QAAE,GAAG,CAAC,MAAM,GAAG,GAAG,GAAG,CAAC,iBAAiB,IAAI,GAAG,CAAC,iBAAiB,iBAAiB,GAAG,CAAC,aAAa,EAAE,CAAC;SACvK,IAAI,GAAG,CAAC,UAAU;QAAE,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC;SAChD,IAAI,GAAG,CAAC,eAAe;QAAE,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,eAAe,CAAC;IAC/D,MAAM,UAAU,GAAG,GAAG,CAAC,iBAAiB,IAAI,GAAG,CAAC,eAAe,CAAC;IAChE,IAAI,UAAU;QAAE,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC;IAC5C,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,aAAa,CAAC;IACnD,IAAI,MAAM;QAAE,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;IAChC,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,GAAG,GAAG,CAAC,IAAa,EAAY,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,OAAQ,CAAsB,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAE,CAAoB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AACrN,MAAM,GAAG,GAAG,CAAC,CAAU,EAAsB,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACpG,MAAM,SAAS,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAI/D;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,OAAyB,EAAE,GAA4B;IAClF,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACxE,MAAM,WAAW,GAAG,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IAC/C,MAAM,UAAU,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IACjF,MAAM,OAAO,GAAI,GAAG,CAAC,OAA6C,EAAE,OAAO,CAAC;IAC5E,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,MAAmD,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3K,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACjC,MAAM,YAAY,GAAG,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC3C,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,+BAA+B,MAAM,IAAI,UAAU,KAAK,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IACvR,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,QAAQ,IAAI,CAAC,OAAO,KAAK,MAAM,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7H,MAAM,MAAM,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC;QAChM,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,OAAO,WAAW,iBAAiB,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC;IAC5L,CAAC;IACD,IAAI,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,YAAY,EAAE,CAAC;QACnD,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,MAAM,MAAM,GAAG,GAAG,OAAO,IAAI,MAAM,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC5F,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,OAAO,WAAW,IAAI,MAAM,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;IAClK,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,0FAA0F;AAC1F,MAAM,UAAU,cAAc,CAAC,GAA6H;IAC1J,IAAI,CAAC,GAAG,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IACnC,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;IAClC,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC;IAC1C,OAAO;QACL,KAAK,EAAE,OAAO;QACd,WAAW;QACX,OAAO,EAAE,OAAO;QAChB,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,EAAE;QACd,OAAO,EAAE,GAAG,WAAW,aAAa,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACvL,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;KAC1F,CAAC;AACJ,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,SAAS,CAAC,MAAc,EAAE,MAAyB,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,IAAI,EAAE;IAC9F,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;AAC/F,CAAC;AAED,2GAA2G;AAC3G,MAAM,UAAU,YAAY,CAAC,CAAc;IACzC,MAAM,KAAK,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACjD,IAAI,CAAC,CAAC,OAAO;QAAE,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC;IAC5D,IAAI,CAAC,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7C,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACpC,CAAC;AAWD,2EAA2E;AAC3E,MAAM,UAAU,cAAc,CAAC,KAAkB,EAAE,GAAW,EAAE,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;IACjG,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACnC,OAAO;QACL,IAAI;QACJ,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;YAClC,YAAY,EAAE,aAAa;YAC3B,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,KAAK;YAC3B,CAAC,eAAe,CAAC,EAAE,KAAK,CAAC,EAAE;YAC3B,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC;YAC/B,CAAC,gBAAgB,CAAC,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC;SAChD;KACF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,OAAc,EAAE,GAAW,EAAE,OAA0D,EAAE,QAAgB;IAC3H,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;QAClC,IAAI,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACpG,IAAI,GAAG,CAAC,EAAE;gBAAE,OAAO,SAAS,CAAC;YAC7B,IAAI,GAAG,QAAQ,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,0GAA0G;YAC1G,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG;gBAAE,OAAO,IAAI,CAAC;QACpC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAgC,EAChC,MAA0B,EAC1B,OAA4F;IAE5F,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAClC,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACtE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IACvC,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;IAClD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACrC,MAAM,GAAG,GAAe,EAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,CAAC,CAAW,EAAE,EAAE;QAC3B,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,OAAO,CAAC,IAAI,iBAAiB,MAAM,CAAC,KAAK,mCAAmC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;IACjI,CAAC,CAAC;IACF,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAChC,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrD,IAAI,CAAW,CAAC;QAChB,IAAI,CAAC,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,aAAa,EAAE,CAAC;aAClF,IAAI,CAAC,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,kBAAkB,wDAAwD,EAAE,CAAC;aACpJ,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC9E,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,KAAK,SAAS,EAAE,MAAM,EAAE,MAAM,IAAI,WAAW,EAAE,CAAC;QACrF,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,EAAE;YAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACd,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,CAAW,CAAC;QAChB,IAAI,CAAC,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,aAAa,EAAE,CAAC;aAC9E,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;YAClJ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,KAAK,SAAS,EAAE,MAAM,EAAE,MAAM,IAAI,WAAW,EAAE,CAAC;QACnF,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,EAAE;YAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACd,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/notify/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,eAAe,EAAE,UAAU,EAA+E,MAAM,yBAAyB,CAAC;AAEnJ,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,mBAAmB,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAG5H,iDAAiD;AACjD,MAAM,CAAC,MAAM,MAAM,GAAG,aAAa,CAAC;AAKpC,MAAM,GAAG,GAAG,CAAC,IAAa,EAAY,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,OAAQ,CAAsB,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAE,CAAoB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AACrN,MAAM,GAAG,GAAG,CAAC,CAAU,EAAsB,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACpG,MAAM,SAAS,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAE/D;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,OAAyB,EAAE,GAA4B;IAClF,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACxE,MAAM,WAAW,GAAG,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;IAC/C,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACjC,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC9D,MAAM,IAAI,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAC1G,MAAM,OAAO,GAAI,GAAG,CAAC,OAA6C,EAAE,OAAO,CAAC;IAC5E,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,MAAmD,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3K,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACjC,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACpC,OAAO;YACL,GAAG,IAAI;YACP,KAAK,EAAE,SAAS;YAChB,MAAM;YACN,OAAO,EAAE,GAAG,WAAW,+BAA+B,MAAM,IAAI,UAAU,KAAK,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG;YACpJ,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACnF,CAAC;IACJ,CAAC;IACD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,QAAQ,IAAI,CAAC,OAAO,KAAK,MAAM,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7H,MAAM,MAAM,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC;QAChM,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,OAAO,WAAW,iBAAiB,SAAS,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC;IAC5L,CAAC;IACD,IAAI,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,YAAY,EAAE,CAAC;QACnD,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;QACzE,MAAM,MAAM,GAAG,GAAG,OAAO,IAAI,MAAM,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAC5F,OAAO;YACL,GAAG,IAAI;YACP,KAAK,EAAE,QAAQ;YACf,MAAM;YACN,OAAO,EAAE,GAAG,OAAO,OAAO,WAAW,IAAI,MAAM,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;YAC1G,MAAM;YACN,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClD,CAAC;IACJ,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,0FAA0F;AAC1F,MAAM,UAAU,cAAc,CAAC,GAA6H;IAC1J,IAAI,CAAC,GAAG,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IACnC,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;IAClC,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC;IAC1C,OAAO;QACL,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO;QACd,WAAW;QACX,MAAM,EAAE,SAAS;QACjB,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;QAC5B,OAAO,EAAE,GAAG,WAAW,aAAa,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACvL,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;KAC1F,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAgC,EAChC,MAA+B,EAC/B,OAAkG;IAElG,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAClC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IACvC,OAAO,UAAU,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE;QAC1D,GAAG;QACH,MAAM,EAAE,aAAa;QACrB,SAAS,EAAE,MAAM;QACjB,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE;YACZ,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,OAAO,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC;QACrD,CAAC;QACD,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,GAAG,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1E,CAAC,CAAC;AACL,CAAC"}
|
package/dist/notify/verify.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
* node:crypto
|
|
2
|
+
* Checking a yodel webhook event (#61), over chant's notify-verify (#211).
|
|
3
|
+
* It needs only node:crypto and chant's compiled notify-verify, so a
|
|
4
|
+
* receiver can import it alone, in plain Node:
|
|
4
5
|
*
|
|
5
6
|
* ```ts
|
|
6
7
|
* import { verifyWebhook } from "@intentius/sql-yodeler/webhook";
|
|
@@ -15,36 +16,21 @@
|
|
|
15
16
|
* epoch), a dot, and the request body exactly as sent. It travels as
|
|
16
17
|
* `x-yodel-signature: sha256=<hex>`. Signing the timestamp with the body
|
|
17
18
|
* lets a receiver refuse a delivery replayed later; {@link verifyWebhook}
|
|
18
|
-
* refuses one
|
|
19
|
+
* refuses one more than five minutes from now by default. This is chant's
|
|
20
|
+
* scheme under yodel's header names, so a receiver written for an earlier
|
|
21
|
+
* release keeps verifying.
|
|
19
22
|
*/
|
|
20
|
-
|
|
21
|
-
export
|
|
22
|
-
export
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
export declare const
|
|
26
|
-
|
|
27
|
-
export declare
|
|
28
|
-
export
|
|
29
|
-
export
|
|
30
|
-
|
|
31
|
-
body: string | Uint8Array;
|
|
32
|
-
/** The request's headers; names are matched without regard to case. */
|
|
33
|
-
headers: WebhookHeaders;
|
|
34
|
-
/** The shared secret. An empty or missing key never verifies. */
|
|
35
|
-
key: string | undefined;
|
|
36
|
-
/** Now, in seconds since the epoch. Default: the clock. */
|
|
37
|
-
now?: number;
|
|
38
|
-
/** How old a delivery may be, in seconds. Default {@link DEFAULT_TOLERANCE_SECONDS}. */
|
|
39
|
-
toleranceSeconds?: number;
|
|
40
|
-
}
|
|
41
|
-
export type VerifyResult = {
|
|
42
|
-
ok: true;
|
|
43
|
-
event: unknown;
|
|
44
|
-
} | {
|
|
45
|
-
ok: false;
|
|
46
|
-
reason: string;
|
|
47
|
-
};
|
|
23
|
+
import { type VerifyWebhookInput, type VerifyWebhookResult } from "@intentius/chant/notify-verify";
|
|
24
|
+
export { DEFAULT_TOLERANCE_SECONDS, signWebhook } from "@intentius/chant/notify-verify";
|
|
25
|
+
export type { WebhookHeaders } from "@intentius/chant/notify-verify";
|
|
26
|
+
/** The prefix of yodel's webhook header names. */
|
|
27
|
+
export declare const HEADER_PREFIX = "x-yodel";
|
|
28
|
+
export declare const SIGNATURE_HEADER: string;
|
|
29
|
+
export declare const TIMESTAMP_HEADER: string;
|
|
30
|
+
export declare const EVENT_HEADER: string;
|
|
31
|
+
export declare const DELIVERY_HEADER: string;
|
|
32
|
+
export type VerifyInput = Omit<VerifyWebhookInput, "prefix">;
|
|
33
|
+
export type VerifyResult = VerifyWebhookResult;
|
|
48
34
|
/**
|
|
49
35
|
* Whether a delivery was signed with `key` and is recent: the signature
|
|
50
36
|
* header matches (compared in constant time) and the timestamp is within the
|