@volter/twin-twilio 0.1.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/LICENSE +202 -0
- package/README.md +118 -0
- package/dist/src/cli.d.ts +2 -0
- package/dist/src/cli.js +26 -0
- package/dist/src/index.d.ts +12 -0
- package/dist/src/index.js +53 -0
- package/dist/src/twilio-budget.d.ts +83 -0
- package/dist/src/twilio-budget.js +411 -0
- package/dist/src/twilio-capabilities.d.ts +4 -0
- package/dist/src/twilio-capabilities.js +414 -0
- package/dist/src/twilio-conformance.d.ts +7 -0
- package/dist/src/twilio-conformance.js +41 -0
- package/dist/src/twilio-connector.d.ts +60 -0
- package/dist/src/twilio-connector.js +115 -0
- package/dist/src/twilio-credentials.d.ts +43 -0
- package/dist/src/twilio-credentials.js +161 -0
- package/dist/src/twilio-server.d.ts +14 -0
- package/dist/src/twilio-server.js +41 -0
- package/dist/src/twilio-signature.d.ts +51 -0
- package/dist/src/twilio-signature.js +78 -0
- package/dist/src/twilio-twin.d.ts +31 -0
- package/dist/src/twilio-twin.js +641 -0
- package/package.json +51 -0
- package/src/cli.ts +25 -0
- package/src/index.ts +107 -0
- package/src/twilio-budget.ts +457 -0
- package/src/twilio-capabilities.ts +436 -0
- package/src/twilio-conformance.ts +45 -0
- package/src/twilio-connector.ts +162 -0
- package/src/twilio-credentials.ts +171 -0
- package/src/twilio-server.ts +49 -0
- package/src/twilio-signature.ts +132 -0
- package/src/twilio-twin.ts +699 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# @volter/twin-twilio
|
|
2
|
+
|
|
3
|
+
> **Legacy connector helpers:** this package still has callable helpers using the retired v1
|
|
4
|
+
> `syncPull` API. Those paths require migration before use on the current kernel;
|
|
5
|
+
> older helper descriptions below do not establish current compatibility. Check the
|
|
6
|
+
> [generated index](../../../generated/INDEX.md) for protocol standing and use the
|
|
7
|
+
> [shared model](../../../docs/concepts/the-model.md) for current state semantics.
|
|
8
|
+
|
|
9
|
+
Local Twilio twin for the **messaging/telephony** surface: Messages send + async delivery-status
|
|
10
|
+
lifecycle (`queued`→`sending`→`sent`→`delivered`, kernel-folded poll-progression, no wall clock),
|
|
11
|
+
Verify (start/check with a twin-internal deterministic expected code — no real OTP is ever sent),
|
|
12
|
+
Lookup (pure deterministic derivation), IncomingPhoneNumbers list, and
|
|
13
|
+
`X-Twilio-Signature`-signed status-callback/inbound webhooks — built on the shared `@volter/world-core`
|
|
14
|
+
kernel. API-first vendor (no product UI to mirror — the real Twilio surface agents integrate with
|
|
15
|
+
is the REST API / `twilio` SDK; the Twilio Console is a config/analytics dashboard, not an agent
|
|
16
|
+
navigation target).
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
bun packages/twin/twilio/src/cli.ts
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Coverage
|
|
23
|
+
|
|
24
|
+
This is a v1 slice of the Twilio API. Three real hosts, disambiguated by host or path shape:
|
|
25
|
+
`api.twilio.com` (2010-04-01 REST — Messages, IncomingPhoneNumbers, Accounts), `verify.twilio.com`
|
|
26
|
+
(Verify v2), `lookups.twilio.com` (Lookup v2). Requests are `application/x-www-form-urlencoded`
|
|
27
|
+
(not JSON) on `api.twilio.com`/`verify.twilio.com`; `api.twilio.com` responses use a `.json` path
|
|
28
|
+
suffix (`verify`/`lookups` do not — grounded live against the installed SDK's own generated route
|
|
29
|
+
construction, refining the build spec's blanket ".json suffix" framing to be api-domain-specific).
|
|
30
|
+
Errors are Twilio's own `{code,message,more_info,status}` envelope (NOT fal's `{detail}`).
|
|
31
|
+
|
|
32
|
+
Modeled `done` (33): Messages send + the exact `queued→sending→sent→delivered` status lifecycle
|
|
33
|
+
(kernel-folded, deterministic poll-progression) + get/list + sid-format + isolation +
|
|
34
|
+
`direction:'outbound-api'` + `num_segments` + the 21604/21211 error-code pair, Accounts fetch
|
|
35
|
+
(serving the world's OWN `AuthToken` — see below), Verify start/check (a twin-internal
|
|
36
|
+
deterministic expected code — the RIGHT code approves, the WRONG code stays pending, a genuinely
|
|
37
|
+
UNKNOWN `to` 404s), Lookup (basic + `line_type_intelligence` + invalid-number 404), a
|
|
38
|
+
lazily-seeded IncomingPhoneNumbers list, `X-Twilio-Signature` sign/verify/tamper + an inbound-
|
|
39
|
+
message builder (fresh HMAC-SHA1, distinct from every sibling pack's signing scheme), the exact
|
|
40
|
+
Twilio error envelope shape, `readOnly`/unmodeled-route safety, kernel-persisted state, the
|
|
41
|
+
self-referential conformance snapshot, and a list-driven connector pull (idempotent — `client.
|
|
42
|
+
messages.list()` is a genuine Twilio REST list endpoint, unlike fal's handle-only queue).
|
|
43
|
+
|
|
44
|
+
Left as **`todo`** (honest gaps, not yet modeled — 37): MMS media, MessagingServiceSid routing,
|
|
45
|
+
scheduled sends, message delete/redact, real cursor pagination, status-callback delivery (an
|
|
46
|
+
injected deliverer actually POSTing to a registered URL), Messaging Services/Copilot/short
|
|
47
|
+
codes/senders, Voice (Calls/TwiML), Conversations, Verify's email/WhatsApp/call channels, max-
|
|
48
|
+
attempts (60202) handling, rate limiting, Fraud Guard, live carrier/CNAM/SIM-swap/reassigned-
|
|
49
|
+
number Lookup fields, IncomingPhoneNumbers provision/update, sub-accounts, Usage Records,
|
|
50
|
+
Regulatory Compliance Bundles, the full error-code catalog (this pack grounds 6 codes live — real
|
|
51
|
+
Twilio has thousands), status-callback retry/fallback-URL, Basic-auth 401 parity and API-Key auth,
|
|
52
|
+
connector push, connector pull of verifications (Verify v2 has **no** bulk list-verifications
|
|
53
|
+
endpoint per the live-fetched OpenAPI document — a genuine vendor gap, not an oversight; a
|
|
54
|
+
`mapVerification` pure mapper is written and ready for a future handle-driven pull), and a
|
|
55
|
+
fixtures-seed helper.
|
|
56
|
+
|
|
57
|
+
### The deterministic Verify code (D2 honesty)
|
|
58
|
+
|
|
59
|
+
Verify **never sends a real OTP** — no SMS/voice/email provider is ever contacted. The "expected
|
|
60
|
+
code" is a pure, deterministic function of `(serviceSid, to)`
|
|
61
|
+
(`String(parseInt(sha256(serviceSid+':'+to).slice(0,6),16) % 1e6).padStart(6,'0')`) that both this
|
|
62
|
+
twin and a caller can independently re-derive. The lifecycle **semantics** are faithful (the right
|
|
63
|
+
code approves, the wrong code stays pending), but no real one-time code is ever delivered to a
|
|
64
|
+
real phone/inbox.
|
|
65
|
+
|
|
66
|
+
### A kernel-reserved-field gotcha, found in THREE places (not just the one the build spec named)
|
|
67
|
+
|
|
68
|
+
The kernel's `type`/`id`/`updatedAt` fields are reserved row-meta (`packages/world-core/
|
|
69
|
+
src/actions.ts`) — a resource `fields` write that includes a literal `type` key is silently
|
|
70
|
+
DROPPED when re-serialized. The build spec called out Twilio Lookup's `line_type_intelligence.type`
|
|
71
|
+
as safe (it's nested, never top-level). Grounding this build against the real SDK/OpenAPI surfaced
|
|
72
|
+
**two more, real, top-level `type` collisions** the spec didn't name: the Twilio `Account` resource
|
|
73
|
+
(`account_enum_type`: `Trial`/`Full`) and the `IncomingPhoneNumber` resource (`payload.type`). This
|
|
74
|
+
pack avoids both: `accounts.fetch` never touches `applyTwinWrite` on the way out, so its `type`
|
|
75
|
+
field is a plain JSON-literal property that never enters the kernel merge/META-filter pipeline at
|
|
76
|
+
all (the credential it reports is read from the `signing_key` row, which carries no `type` field). The
|
|
77
|
+
`IncomingPhoneNumber` rows genuinely ARE kernel-persisted (lazily seeded on first list, per root),
|
|
78
|
+
so those take the build spec's own prescribed technique: stored as `number_type` internally,
|
|
79
|
+
renamed back to `type` only in the read path (`phoneNumberView()`).
|
|
80
|
+
|
|
81
|
+
### The account credential
|
|
82
|
+
|
|
83
|
+
The world's `AccountSid`/`AuthToken` pair is **state**, not a function of the world's directory: it
|
|
84
|
+
is the pack's `signing_key` resource, persisted through the kernel action log and established
|
|
85
|
+
exactly once per root, either way round.
|
|
86
|
+
|
|
87
|
+
- **Seeded via the wire** — the real Twilio SDK sends
|
|
88
|
+
`Authorization: Basic base64(AccountSid:AuthToken)` on every call, so an app already configured
|
|
89
|
+
with a SID/token seeds a virgin world just by talking to it. `GET Accounts/{Sid}.json` then hands
|
|
90
|
+
that app back its OWN `auth_token`, and every `X-Twilio-Signature` this world produces verifies
|
|
91
|
+
against the key the app already holds.
|
|
92
|
+
- **Minted with real entropy** — nothing presented, so the twin generates a vendor-shaped pair
|
|
93
|
+
(`AC` + 32 hex, and a 32-hex AuthToken) the first time it is asked.
|
|
94
|
+
|
|
95
|
+
Different roots therefore never share a secret — by construction, from entropy rather than from a
|
|
96
|
+
path hash — and a world COPIED to another directory keeps accepting exactly the credential it had.
|
|
97
|
+
A pair that is not vendor-shaped is never adopted, and a read-only world is never seeded at all.
|
|
98
|
+
This twin does not (and never did) REFUSE a request whose Basic pair does not match; adding that
|
|
99
|
+
401 is a separate capability with its own verify, not a side effect of moving the secret.
|
|
100
|
+
|
|
101
|
+
`src/twilio-signature.ts` holds no credential and reads no state: it is pure HMAC-SHA1 and takes
|
|
102
|
+
the AuthToken as an argument (`twilioAuthToken(root)` is where a caller gets the world's).
|
|
103
|
+
|
|
104
|
+
### `X-Twilio-Signature`
|
|
105
|
+
|
|
106
|
+
`base64(HMAC-SHA1(AuthToken, URL + sorted-concatenated POST-parameter key+value pairs))` — written
|
|
107
|
+
FRESH in `src/twilio-signature.ts` (never ports `fal`'s ed25519 scheme, `replicate`/`inngest`'s
|
|
108
|
+
HMAC-SHA256, or any sibling pack's signing module). VERBATIM-ported from the actually-installed
|
|
109
|
+
`twilio@6.0.2` npm package's own `lib/webhooks/webhooks.js` `getExpectedTwilioSignature` — not
|
|
110
|
+
just docs. `twilio-signature.ts` never imports the twin handler, so its 3 signing/builder
|
|
111
|
+
capabilities are legitimately mutation-test ALLOW-listed pure crypto.
|
|
112
|
+
|
|
113
|
+
**API-keys/admin surface**: sub-account and API-Key/Secret auth management are dashboard/API
|
|
114
|
+
surfaces this v1 slice does not model — filed as `todo` (`accounts.subaccounts`,
|
|
115
|
+
`auth.api_key_auth`), since a real REST surface exists for them.
|
|
116
|
+
|
|
117
|
+
See `src/twilio-capabilities.ts` for the full manifest (the real vendor surface is the
|
|
118
|
+
denominator — coverage is honest and partial until the twin reaches it).
|
package/dist/src/cli.js
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { keepProcessAlive } from '@volter/world-core/lifecycle';
|
|
3
|
+
// world-twilio CLI: serve the KERNEL-BACKED Twilio API twin, or run conformance. State
|
|
4
|
+
// lives in the @volter/world-core action log (no in-memory side-store). Conformance is dev-only +
|
|
5
|
+
// lazy-imported so the bin runs without @volter/world-tooling (E2).
|
|
6
|
+
import { hasFlag, optionValue } from '@volter/world-core/args';
|
|
7
|
+
import { createTwilioTwinServer } from "./twilio-server.js";
|
|
8
|
+
const [cmd, ...rest] = process.argv.slice(2);
|
|
9
|
+
const port = Number(optionValue(rest, '--port', String(process.env.PORT ?? '0'))) || undefined;
|
|
10
|
+
const root = optionValue(rest, '--root') || undefined;
|
|
11
|
+
const readOnly = hasFlag(rest, '--read-only'); // a twin accepts writes unless started read-only
|
|
12
|
+
if (cmd === 'serve' || cmd === undefined) {
|
|
13
|
+
const s = await createTwilioTwinServer({ readOnly, ...(root ? { root } : {}), ...(port ? { port } : {}) });
|
|
14
|
+
process.stdout.write(`twilio twin (Messages send/status-lifecycle, Verify start/check, Lookup, IncomingPhoneNumbers, X-Twilio-Signature webhooks)${readOnly ? ' [read-only]' : ''} at http://127.0.0.1:${s.port}\n`);
|
|
15
|
+
await keepProcessAlive();
|
|
16
|
+
}
|
|
17
|
+
else if (cmd === 'conformance') {
|
|
18
|
+
const { checkTwilioConformance } = await import("./twilio-conformance.js");
|
|
19
|
+
const report = checkTwilioConformance();
|
|
20
|
+
process.stdout.write(`${JSON.stringify(report, null, 2)}\n`);
|
|
21
|
+
if (!report.ok)
|
|
22
|
+
process.exitCode = 1;
|
|
23
|
+
}
|
|
24
|
+
else {
|
|
25
|
+
process.stdout.write('Usage: world-twilio serve|conformance [--port N] [--root DIR] [--read-only]\n');
|
|
26
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export { handleTwilioTwinRequest, routeTwilioSurface, twilioTwinSnapshot, TWILIO_RESOURCE_TYPES, } from './twilio-twin.js';
|
|
2
|
+
export type { TwilioRequest, TwilioResponse, TwilioResourceType, TwilioSurface, TwilioTwinSnapshot, } from './twilio-twin.js';
|
|
3
|
+
export { createTwilioTwinFetch, createTwilioTwinServer, type TwilioTwinFetchOptions } from './twilio-server.js';
|
|
4
|
+
export { mapMessage, mapVerification, pullTwilioMessages, syncTwilioFromReal, } from './twilio-connector.js';
|
|
5
|
+
export type { TwilioLikeClient, TwilioRealMessage, TwilioRealVerification, TwilioBudgetedOptions } from './twilio-connector.js';
|
|
6
|
+
export { TWILIO_BUDGETED_METHODS, TWILIO_BUDGET_CEILING, TWILIO_BUDGET_MAX_RETRY_AFTER_S, TWILIO_BUDGET_WINDOW_MS, TWILIO_CALL_WEIGHTS, TWILIO_RATE_BUDGET, TwilioBudget, TwilioBudgetError, twilioBudgetPath, twilioCallWeight, twilioClientBudget, guardTwilioClient, } from './twilio-budget.js';
|
|
7
|
+
export type { TwilioBudgetErrorKind, TwilioBudgetOptions, TwilioBudgetReservation, TwilioBudgetSnapshot } from './twilio-budget.js';
|
|
8
|
+
export { computeTwilioSignature, verifyTwilioSignature, buildSignedTwilioRequest, buildSignedStatusCallback, buildSignedInboundMessage, TwilioSignatureVerificationError, } from './twilio-signature.js';
|
|
9
|
+
export { twilioCredentials, twilioAuthToken, twilioAccountSid, storedTwilioCredentials, mintTwilioCredentials, presentedTwilioCredentials, isWellFormedTwilioAccountSid, isWellFormedTwilioAuthToken, TWILIO_SIGNING_KEY_TYPE, } from './twilio-credentials.js';
|
|
10
|
+
export type { TwilioCredentials, PresentedTwilioCredentials } from './twilio-credentials.js';
|
|
11
|
+
import type { TwinPack } from '@volter/world-core';
|
|
12
|
+
export declare const pack: TwinPack;
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
// @volter/twin-twilio — the Twilio messaging/telephony twin, built on the shared @volter/world-core
|
|
2
|
+
// kernel. REST transport over the api.twilio.com / verify.twilio.com / lookups.twilio.com
|
|
3
|
+
// three-host split; state lives entirely in the kernel action log (no side-store).
|
|
4
|
+
// Messages send + async delivery-status lifecycle (queued->sending->sent->delivered, kernel-
|
|
5
|
+
// folded poll-progression, no wall clock), Verify (start/check with a twin-internal deterministic
|
|
6
|
+
// expected code), Lookup (pure deterministic derivation), IncomingPhoneNumbers list, and
|
|
7
|
+
// X-Twilio-Signature-signed status-callback/inbound webhooks (fresh HMAC-SHA1, distinct from
|
|
8
|
+
// every other pack's signing scheme).
|
|
9
|
+
//
|
|
10
|
+
// Console = ABSENT (API-first vendor — the Twilio Console is a config/analytics dashboard, not
|
|
11
|
+
// an agent navigation target; see README ## Coverage and ui-scope.json needsUi:false).
|
|
12
|
+
// (Conformance/capability tooling lives in @volter/world-tooling, a dev dependency — NOT shipped.)
|
|
13
|
+
export { handleTwilioTwinRequest, routeTwilioSurface, twilioTwinSnapshot, TWILIO_RESOURCE_TYPES, } from "./twilio-twin.js";
|
|
14
|
+
export { createTwilioTwinFetch, createTwilioTwinServer } from "./twilio-server.js";
|
|
15
|
+
export { mapMessage, mapVerification, pullTwilioMessages, syncTwilioFromReal, } from "./twilio-connector.js";
|
|
16
|
+
// The client-side rate budget — the fail-closed backstop every live call goes through. The
|
|
17
|
+
// MECHANISM is the kernel's shared, vendor-agnostic `RateBudget`; what lives here is this vendor's
|
|
18
|
+
// DECLARATION (window/ceiling/per-method weights) plus `guardTwilioClient`, the choke point the
|
|
19
|
+
// connector entrypoints apply unconditionally. Exported so an operator can inspect spend
|
|
20
|
+
// (`snapshot`) and a caller can catch `TwilioBudgetError` by type; there is deliberately no export
|
|
21
|
+
// that disables the guard.
|
|
22
|
+
export { TWILIO_BUDGETED_METHODS, TWILIO_BUDGET_CEILING, TWILIO_BUDGET_MAX_RETRY_AFTER_S, TWILIO_BUDGET_WINDOW_MS, TWILIO_CALL_WEIGHTS, TWILIO_RATE_BUDGET, TwilioBudget, TwilioBudgetError, twilioBudgetPath, twilioCallWeight, twilioClientBudget, guardTwilioClient, } from "./twilio-budget.js";
|
|
23
|
+
export { computeTwilioSignature, verifyTwilioSignature, buildSignedTwilioRequest, buildSignedStatusCallback, buildSignedInboundMessage, TwilioSignatureVerificationError, } from "./twilio-signature.js";
|
|
24
|
+
// The world's OWN AccountSid/AuthToken pair as STATE — established once (seeded from the Basic
|
|
25
|
+
// pair the world first sees, or minted with real entropy) and persisted through the kernel action
|
|
26
|
+
// log as the declared `signing_key` resource, never derived from the world's filesystem path.
|
|
27
|
+
export { twilioCredentials, twilioAuthToken, twilioAccountSid, storedTwilioCredentials, mintTwilioCredentials, presentedTwilioCredentials, isWellFormedTwilioAccountSid, isWellFormedTwilioAuthToken, TWILIO_SIGNING_KEY_TYPE, } from "./twilio-credentials.js";
|
|
28
|
+
import { TWILIO_RATE_BUDGET as RATE_BUDGET } from "./twilio-budget.js";
|
|
29
|
+
export const pack = {
|
|
30
|
+
// The SAME object twilio-budget.ts declares at module load — one source of truth, so registering
|
|
31
|
+
// the pack and importing the connector can never arm two different ceilings.
|
|
32
|
+
rateBudget: RATE_BUDGET,
|
|
33
|
+
vendor: 'twilio',
|
|
34
|
+
transport: 'rest',
|
|
35
|
+
archetype: 'crud',
|
|
36
|
+
bin: 'world-twilio',
|
|
37
|
+
resources: ['message', 'verification', 'phone_number', 'signing_key'],
|
|
38
|
+
specSource: 'twilio-conformance.ts (self-referential endpoint/resource inventory) — grounded read-only against the published twilio-oai OpenAPI documents (github.com/twilio/twilio-oai: twilio_api_v2010, twilio_verify_v2, twilio_lookups_v2), the actually-installed twilio@6.0.2 npm SDK source, and the public Twilio error-code reference pages, all fetched during the build; see spec-sources.json.',
|
|
39
|
+
description: 'Twilio messaging/telephony twin — Messages send + delivery-status lifecycle (queued->sending->sent->delivered, kernel-folded poll-progression), Verify start/check (twin-internal deterministic expected code), Lookup (pure derivation), IncomingPhoneNumbers list, and X-Twilio-Signature-signed status-callback/inbound webhooks. Three-host split (api/verify/lookups.twilio.com), form-urlencoded requests, .json response suffix, Twilio {code,message,more_info,status} error envelope. Kernel-backed.',
|
|
40
|
+
browserRouting: { apiPathPrefix: '/', loaderHost: 'https://api.twilio.com' },
|
|
41
|
+
// INTERCEPTION RULING — hostsNone, the pack's own home for it: no injector entry grounded yet
|
|
42
|
+
// — worlds point the twilio SDK at the twin via explicit client config; zero-edit
|
|
43
|
+
// interception of the three real Twilio hosts (pack README §Coverage) is a visible gap until
|
|
44
|
+
// grounded here.
|
|
45
|
+
hostsNone: "no injector entry grounded yet — worlds point the twilio SDK at the twin via explicit client config; zero-edit interception of the three real Twilio hosts (pack README §Coverage) is a visible gap until grounded here",
|
|
46
|
+
// Adoption, moved off the central maps unchanged (descriptor-first back-migration, adding-a-twin.md §3,
|
|
47
|
+
// 2026-08-31).
|
|
48
|
+
adoption: {
|
|
49
|
+
// Twilio's official Python helper library.
|
|
50
|
+
pypi: ['twilio'],
|
|
51
|
+
sdks: ['twilio'], envStems: ['TWILIO'],
|
|
52
|
+
},
|
|
53
|
+
};
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { RateBudget, type RateBudgetDeclaration, type RateBudgetOptions, type RateBudgetReservation, type RateBudgetSnapshot } from '@volter/world-core';
|
|
2
|
+
import type { TwilioLikeClient } from './twilio-connector.js';
|
|
3
|
+
/** Rolling window, in ms. Spend older than this is pruned. */
|
|
4
|
+
export declare const TWILIO_BUDGET_WINDOW_MS = 60000;
|
|
5
|
+
/** Weighted units allowed inside one window. See the header for where this number comes from. */
|
|
6
|
+
export declare const TWILIO_BUDGET_CEILING = 60;
|
|
7
|
+
/** Seconds. A `Retry-After` above this means the credential is throttled hard — fail loudly. */
|
|
8
|
+
export declare const TWILIO_BUDGET_MAX_RETRY_AFTER_S = 300;
|
|
9
|
+
/** Per-call cost, keyed by the client method the guard is about to invoke. See the header. */
|
|
10
|
+
export declare const TWILIO_CALL_WEIGHTS: {
|
|
11
|
+
/** Every modeled call. Twilio publishes no per-second REST figure to differentiate. */
|
|
12
|
+
readonly other: 2;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* The client methods this pack PRICES BY NAME, as dotted paths into the injected client.
|
|
16
|
+
*
|
|
17
|
+
* Two kinds of entry: (a) every method this connector actually calls, and (b) an endpoint the
|
|
18
|
+
* VENDOR documents in a distinct tier which a consumer can reach through the guarded client even
|
|
19
|
+
* though this connector never calls it (see the weights section of the header). Used to build the
|
|
20
|
+
* guarded surface — and, in the pack's own suite, the counting fake.
|
|
21
|
+
*
|
|
22
|
+
* NOT a closed list, and not a claim about the injected client's shape. A path the real client does
|
|
23
|
+
* not have is SKIPPED (this connector's members are optional; inventing one would turn "observe
|
|
24
|
+
* nothing" into "call something that isn't there"), and a method absent from this list is still
|
|
25
|
+
* PRICED at `defaultWeight` when a caller reaches for it — an unmodeled endpoint must never be
|
|
26
|
+
* free, and dropping one would be worse than free because it would be invisible.
|
|
27
|
+
*/
|
|
28
|
+
export declare const TWILIO_BUDGETED_METHODS: readonly ["messages.list"];
|
|
29
|
+
/** THE PACK'S DECLARATION — pure data, the only Twilio-specific thing in the whole budget. */
|
|
30
|
+
export declare const TWILIO_RATE_BUDGET: RateBudgetDeclaration;
|
|
31
|
+
/** Price one Twilio call by its client method key (a dotted path, e.g. `messages.list`). */
|
|
32
|
+
export declare function twilioCallWeight(method: string): number;
|
|
33
|
+
/** Where Twilio's ledger lives. Token-keyed and cwd-independent by default (the vendor limits per
|
|
34
|
+
* credential, so a cwd-scoped ledger would hand the same credential a fresh allowance in every
|
|
35
|
+
* checkout, worktree and CI matrix leg); pass `root` to opt into world-scoped accounting. */
|
|
36
|
+
export declare function twilioBudgetPath(opts?: {
|
|
37
|
+
root?: string;
|
|
38
|
+
token?: string;
|
|
39
|
+
} | string): string;
|
|
40
|
+
/** Construction options for Twilio's budget. The vendor is fixed; everything else may only TIGHTEN. */
|
|
41
|
+
export type TwilioBudgetOptions = Omit<RateBudgetOptions, 'vendor'>;
|
|
42
|
+
/**
|
|
43
|
+
* Twilio's budget — the shared kernel guard bound to this vendor's declaration. A real subclass,
|
|
44
|
+
* not an alias, so `budget instanceof TwilioBudget` means "a budget that accounts against this
|
|
45
|
+
* vendor's ledger under this vendor's ceiling": another vendor's `RateBudget` (with its own,
|
|
46
|
+
* possibly larger, ceiling) is NOT assignable where one of these is required.
|
|
47
|
+
*/
|
|
48
|
+
export declare class TwilioBudget extends RateBudget {
|
|
49
|
+
constructor(opts?: TwilioBudgetOptions);
|
|
50
|
+
}
|
|
51
|
+
export type { RateBudgetErrorKind as TwilioBudgetErrorKind } from '@volter/world-core';
|
|
52
|
+
export { RateBudgetError as TwilioBudgetError } from '@volter/world-core';
|
|
53
|
+
export type TwilioBudgetReservation = RateBudgetReservation;
|
|
54
|
+
export type TwilioBudgetSnapshot = RateBudgetSnapshot;
|
|
55
|
+
/** What every budgeted connector entrypoint accepts. There is deliberately no option that turns the
|
|
56
|
+
* guard OFF — only ones that say WHICH ledger and clock to account against. */
|
|
57
|
+
export type TwilioBudgetedOptions = {
|
|
58
|
+
/** An existing budget to share across calls. Omit and one is constructed. Cannot be null. */
|
|
59
|
+
budget?: TwilioBudget;
|
|
60
|
+
/** Construction options for the default budget (ledger path, clock). Cannot loosen it. */
|
|
61
|
+
budgetOptions?: TwilioBudgetOptions;
|
|
62
|
+
};
|
|
63
|
+
/** Pull the budget wiring out of a caller's opts bag, so an entrypoint can forward it verbatim. */
|
|
64
|
+
export declare function twilioBudgetOf(opts: TwilioBudgetedOptions): TwilioBudgetedOptions;
|
|
65
|
+
/** Is this client already behind a budget? Returns the budget it is behind, if so. */
|
|
66
|
+
export declare function twilioClientBudget(client: unknown): RateBudget | undefined;
|
|
67
|
+
/**
|
|
68
|
+
* Wrap an INJECTED Twilio client so EVERY call it makes is charged against the shared budget
|
|
69
|
+
* BEFORE the request goes out. This pack's connector never constructs the transport itself (the
|
|
70
|
+
* consumer injects a client that satisfies `TwilioLikeClient` structurally), so the guard is a
|
|
71
|
+
* DECORATOR rather than a factory — which is exactly why every connector entrypoint applies it
|
|
72
|
+
* UNCONDITIONALLY instead of trusting the caller to have done it.
|
|
73
|
+
*
|
|
74
|
+
* IDEMPOTENT: wrapping an already-guarded client returns it unchanged, so a caller who forgot is
|
|
75
|
+
* protected and a caller who wrapped deliberately is not double-charged.
|
|
76
|
+
*
|
|
77
|
+
* A method that THROWS is still inspected: an SDK typically RAISES on a 429 rather than returning
|
|
78
|
+
* it, and that error's back-off is exactly the signal that must become a persisted cooldown. Losing
|
|
79
|
+
* it would leave the ledger cheerfully spending into a throttled credential. The original error is
|
|
80
|
+
* always re-raised afterwards — the budget never swallows a vendor failure — EXCEPT when the
|
|
81
|
+
* back-off is beyond the cap, where the budget's own louder "stop calling" error takes precedence.
|
|
82
|
+
*/
|
|
83
|
+
export declare function guardTwilioClient(client: TwilioLikeClient, opts?: TwilioBudgetedOptions): TwilioLikeClient;
|