@crewhaus/tool-notify 0.7.0 → 0.8.1
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/LICENSE +201 -0
- package/NOTICE +9 -0
- package/README.md +58 -5
- package/dist/index.js +371 -96
- package/dist/lib/instant.d.ts +57 -0
- package/dist/lib/instant.js +188 -0
- package/dist/lib/preflight.js +7 -9
- package/dist/lib/quiet.d.ts +3 -1
- package/dist/lib/quiet.js +48 -15
- package/dist/lib/ratelimit.js +6 -3
- package/dist/lib/template.js +8 -1
- package/dist/lib/webhook-path.d.ts +11 -0
- package/dist/lib/webhook-path.js +42 -0
- package/dist/net.d.ts +189 -17
- package/dist/net.js +388 -142
- package/dist/paths.d.ts +21 -2
- package/dist/paths.js +72 -13
- package/package.json +13 -6
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
CrewHaus Factory
|
|
2
|
+
Copyright 2026 Max Meier
|
|
3
|
+
|
|
4
|
+
This product includes software developed by Max Meier
|
|
5
|
+
(operating as StudioMax — https://studiomax.io) and contributors.
|
|
6
|
+
|
|
7
|
+
The CrewHaus name and logo are trademarks of Max Meier. See
|
|
8
|
+
https://github.com/crewhaus/factory/blob/main/TRADEMARK.md for the
|
|
9
|
+
use-of-marks policy.
|
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ is a different and more dangerous act.
|
|
|
14
14
|
```yaml
|
|
15
15
|
tools:
|
|
16
16
|
- all-notify # every tool below
|
|
17
|
-
- -
|
|
17
|
+
- -smsSend # ...except this one (a tools: list takes the camelCase key)
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
| Tool | What it does |
|
|
@@ -44,7 +44,13 @@ The tools worth reaching for first are the ones that send nothing.
|
|
|
44
44
|
about the same broken host. `QuietHours` is the reason an overnight alert waits
|
|
45
45
|
until 09:00 when it will read identically. `RateLimitGate` is the reason a loop
|
|
46
46
|
does not re-report the same thing on every iteration. All three are pure, take
|
|
47
|
-
`now` as an argument, and compose
|
|
47
|
+
`now` as an argument, and compose. `now` (and an email's `date`) must name
|
|
48
|
+
its zone. Write it as ISO-8601 (`2026-09-17T03:14:00Z` or `…+09:00`) or
|
|
49
|
+
as an email Date header (`Thu, 17 Sep 2026 03:14:00 +0000`). JavaScript's
|
|
50
|
+
`Date#toString()` form and the US zones an email header may use (`EST`,
|
|
51
|
+
`PDT`, …) are read too. A time without a zone is refused, because it would
|
|
52
|
+
mean the host's local time and differ between machines. So is an abbreviation
|
|
53
|
+
such as `CET` or `IST`, which names different zones in different places:
|
|
48
54
|
|
|
49
55
|
```
|
|
50
56
|
NotifyDigest → QuietHours → RateLimitGate → MessageTemplate → ChatPost
|
|
@@ -74,7 +80,11 @@ re-deriving it — a second outbound surface with a weaker gate is the same hole
|
|
|
74
80
|
twice. In summary:
|
|
75
81
|
|
|
76
82
|
- **Empty allow-list denies everything.** Separately for origins, for SMTP
|
|
77
|
-
hosts,
|
|
83
|
+
hosts, for email recipients, for SMS numbers (`allowed_sms_recipients`, in
|
|
84
|
+
E.164 form or a prefix such as `+44*`) and for push targets
|
|
85
|
+
(`allowed_push_targets`, exact or a `prefix*`). There is no "allow all"
|
|
86
|
+
value. A provider that pins the number in `staticFields` and maps no `to`
|
|
87
|
+
never sends the call's value, so it needs no list.
|
|
78
88
|
- **SSRF refusal is numeric, not textual.** Loopback, link-local (including
|
|
79
89
|
the cloud metadata address), RFC1918, CGNAT, multicast and mDNS are refused
|
|
80
90
|
as an IP literal in any of its encodings — octal, hex, integer, every IPv6
|
|
@@ -83,6 +93,11 @@ twice. In summary:
|
|
|
83
93
|
- **The vetted IP is pinned** for the connection, so a rebinding resolver
|
|
84
94
|
cannot swap in a private address between the check and the socket. The SMTP
|
|
85
95
|
client pins the same way, and still presents and verifies the hostname.
|
|
96
|
+
- **An id names an item; it never moves the request.** A Discord channel,
|
|
97
|
+
message id or emoji, and `DeliveryCheck`'s message id, are written into a
|
|
98
|
+
URL path. `.` and `..` survive percent-encoding and the URL parser resolves
|
|
99
|
+
them, so they are refused, and the path actually requested must be the path
|
|
100
|
+
built with the value written in.
|
|
86
101
|
- **A send never follows a redirect.** Replaying a body at a new origin, or
|
|
87
102
|
downgrading to a GET that delivers nothing, are both worse than stopping.
|
|
88
103
|
Only `DeliveryCheck` follows, re-running the whole gate on every hop.
|
|
@@ -92,7 +107,7 @@ twice. In summary:
|
|
|
92
107
|
## Credentials
|
|
93
108
|
|
|
94
109
|
No tool accepts a secret. Every credential is the **NAME** of an environment
|
|
95
|
-
variable, read at call time:
|
|
110
|
+
variable, read at call time, and only a name you list:
|
|
96
111
|
|
|
97
112
|
```yaml
|
|
98
113
|
tool_config:
|
|
@@ -101,12 +116,28 @@ tool_config:
|
|
|
101
116
|
allowed_recipients: ["ops@example.com", "*@team.example.com"]
|
|
102
117
|
allowed_smtp_hosts: ["smtp.example.com"]
|
|
103
118
|
allowed_sender_domains: ["example.com"]
|
|
119
|
+
allowed_secret_envs: [SLACK_OPS_WEBHOOK, SLACK_BOT_TOKEN]
|
|
120
|
+
allowed_sms_recipients: ["+15550001111", "+4420*"]
|
|
121
|
+
allowed_push_targets: ["topic:ops-*"]
|
|
104
122
|
```
|
|
105
123
|
|
|
124
|
+
`allowed_secret_envs` covers every name a call supplies: `webhookUrlEnv` and
|
|
125
|
+
`tokenEnv` for the chat tools, `WebhookPost`'s `urlEnv`, `auth.envVar` and
|
|
126
|
+
`signing.secretEnv`, and `EmailSend`'s `usernameEnv` and `passwordEnv`. A call
|
|
127
|
+
may choose among the listed names and can never add one, so it cannot send
|
|
128
|
+
another process secret (your LLM provider key, say) to an allowed origin.
|
|
129
|
+
With no list, every such name is refused. A provider's own `auth.envVar`
|
|
130
|
+
(under `providers`) is yours already and needs no listing, but it is read
|
|
131
|
+
only for that provider's calls.
|
|
132
|
+
|
|
106
133
|
```jsonc
|
|
107
134
|
{ "platform": "slack", "webhookUrlEnv": "SLACK_OPS_WEBHOOK", "text": "…" }
|
|
108
135
|
```
|
|
109
136
|
|
|
137
|
+
In API mode (`apiBaseUrl` plus `tokenEnv`) the variable holds a bot token.
|
|
138
|
+
Discord receives it as `Authorization: Bot <token>` and Slack as
|
|
139
|
+
`Authorization: Bearer <token>`, which is what each platform expects of a bot.
|
|
140
|
+
|
|
110
141
|
A Slack incoming-webhook URL (`/services/T…/B…/…`) and a Discord one
|
|
111
142
|
(`/api/webhooks/<id>/<token>`) carry their whole authority in the **path**, so
|
|
112
143
|
the URL is itself a credential: it is named rather than passed, and no error
|
|
@@ -117,6 +148,25 @@ because a tool result is a transcript, a trace and usually an eval report. Every
|
|
|
117
148
|
result — success or failure — passes through a redactor built from the resolved
|
|
118
149
|
secret, in its literal, URL-encoded and base64 forms.
|
|
119
150
|
|
|
151
|
+
## What a permission rule reads
|
|
152
|
+
|
|
153
|
+
- **Chat.** `ChatPost` and `ChatUpdate` read the channel; `ChatDelete` and `ChatReact` read
|
|
154
|
+
`channel/messageId`. An API-mode call always names `apiBaseUrl`, so the value is matched with
|
|
155
|
+
that URL's origin in front: `alwaysAllow ChatPost(https://slack.com/C0123)`, or
|
|
156
|
+
`ChatPost(https://*/C0123)` for that channel on any API. A deny on an API fires on every
|
|
157
|
+
API-mode call to it: `alwaysDeny ChatPost(https://discord.com/**)`.
|
|
158
|
+
- **Incoming webhooks.** A webhook posts to the channel it was created for, and `ChatPost` ignores
|
|
159
|
+
a `channel` in that call. So the rule reads `webhookUrlEnv`, the variable that names the webhook:
|
|
160
|
+
`alwaysAllow ChatPost(SLACK_OPS_WEBHOOK)` covers a webhook post, with or without a `channel`. An
|
|
161
|
+
allow on a channel does not cover one, and a deny on a channel still fires on it. The webhook's
|
|
162
|
+
URL is a credential, so no rule reads it, its host included: a deny on an API does not stop a
|
|
163
|
+
webhook post to that host. Deny the variable instead: `alwaysDeny ChatPost(DISCORD_WEBHOOK)`.
|
|
164
|
+
- **`WebhookPost`** reads `url`, or `urlEnv` when the URL is kept in a variable:
|
|
165
|
+
`alwaysAllow WebhookPost(DEPLOY_HOOK_URL)`.
|
|
166
|
+
- **Not read:** the SMTP relay in `EmailSend`'s `host` (bounded by `allowed_smtp_hosts`), the
|
|
167
|
+
provider an SMS or push goes through (each one is yours, in `providers`), and the bot token a
|
|
168
|
+
Chat call names, which picks the workspace. A rule names who receives the message.
|
|
169
|
+
|
|
120
170
|
## Injection is the thing this package is most careful about
|
|
121
171
|
|
|
122
172
|
A notification is almost always assembled from data the harness did not write:
|
|
@@ -238,7 +288,10 @@ Stated rather than papered over:
|
|
|
238
288
|
- **Implicit TLS (port 465) is untested** for the same reason.
|
|
239
289
|
- **The idempotency ledger is per-process.** A retry after a restart will send
|
|
240
290
|
again. The ledger is the second line of defence; the key is also passed to
|
|
241
|
-
the provider, which is the first.
|
|
291
|
+
the provider, which is the first. A key names one message: the same key
|
|
292
|
+
with a different destination or content is refused and sends nothing,
|
|
293
|
+
while a retry that changes only its timeout, byte cap, retry pacing or
|
|
294
|
+
clock reading (`date`, a signature timestamp) returns the first result.
|
|
242
295
|
- **`ChatUpdate` does not return the previous text,** because the platform
|
|
243
296
|
does not give it back.
|
|
244
297
|
- **`EmailSendPreflight` does not fold provider-specific aliases.** Two
|