@dbx-tools/tunnel 0.9.95 → 0.9.105
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 +25 -6
- package/index.ts +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.js +2 -2
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -3,6 +3,25 @@
|
|
|
3
3
|
Front an app with a public Portr and/or FRP tunnel and the passwordless
|
|
4
4
|
[`@dbx-tools/auth-gate`](../auth-gate) gate, in-process.
|
|
5
5
|
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
Add an authenticated public FRP endpoint to an AppKit app:
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
import { server } from "@databricks/appkit";
|
|
12
|
+
import { appkit } from "@dbx-tools/appkit";
|
|
13
|
+
import { email } from "@dbx-tools/email";
|
|
14
|
+
import { interceptor, plugin } from "@dbx-tools/tunnel";
|
|
15
|
+
|
|
16
|
+
const { tunnelInterceptor } = interceptor;
|
|
17
|
+
const { authGate } = plugin;
|
|
18
|
+
|
|
19
|
+
await appkit.createApp({
|
|
20
|
+
plugins: [server(), email(), authGate({})],
|
|
21
|
+
interceptor: tunnelInterceptor({ transport: "frp" }),
|
|
22
|
+
});
|
|
23
|
+
```
|
|
24
|
+
|
|
6
25
|
Supports the [SSE-enabled Portr fork](https://github.com/reggie-db/portr/releases/tag/v1.0.15-sse.2),
|
|
7
26
|
based on [upstream Portr](https://github.com/amalshaji/portr), plus
|
|
8
27
|
[FRP](https://github.com/fatedier/frp). Use this library
|
|
@@ -21,7 +40,7 @@ through, either death tears the pair down). The app is the process; the tunnel
|
|
|
21
40
|
rides along inside it. Access is granted per email address against an allow-list,
|
|
22
41
|
authenticated by Better Auth email OTP or a passkey; the gate itself is the
|
|
23
42
|
`authGate` AppKit plugin, which registers the login routes and a gating
|
|
24
|
-
middleware on the app's
|
|
43
|
+
middleware on the app's Express server (no separate proxy process).
|
|
25
44
|
|
|
26
45
|
**Key features:**
|
|
27
46
|
|
|
@@ -43,7 +62,7 @@ middleware on the app's OWN Express server (no separate proxy process).
|
|
|
43
62
|
NOTIFICATION, and a notification contains the sender, the subject, and a short
|
|
44
63
|
snippet - nothing else - so a code that lives only in the body is unreachable
|
|
45
64
|
however cleanly the body is shaped. See
|
|
46
|
-
[Why the code is in the subject](#
|
|
65
|
+
[Why the code is in the subject](#email-code-subject).
|
|
47
66
|
- The two MIME parts are built separately, on purpose. The HTML card uses the
|
|
48
67
|
configured subject template as its neutral title and shows the code once as a
|
|
49
68
|
large styled body heading; the `text/plain` part
|
|
@@ -98,7 +117,7 @@ middleware on the app's OWN Express server (no separate proxy process).
|
|
|
98
117
|
cannot send codes locks everyone out. `@dbx-tools/email` is an OPTIONAL peer
|
|
99
118
|
dependency, imported lazily; the app that mounts the gate provides it.
|
|
100
119
|
|
|
101
|
-
##
|
|
120
|
+
## Tunnel And Gate Behavior
|
|
102
121
|
|
|
103
122
|
A bare tunnel (`ngrok`, `portr` on its own) makes the app reachable by anyone
|
|
104
123
|
with the URL. This package keeps the tunnel but puts a gate in front of it,
|
|
@@ -107,7 +126,7 @@ reusing what the app already has: AppKit's cache for code storage, the
|
|
|
107
126
|
Because it rides inside the app's own `createApp`, there is no second process to
|
|
108
127
|
supervise and no wrapper command to thread flags through.
|
|
109
128
|
|
|
110
|
-
##
|
|
129
|
+
## Full App Configuration
|
|
111
130
|
|
|
112
131
|
```ts
|
|
113
132
|
import { appkit } from "@dbx-tools/appkit";
|
|
@@ -200,7 +219,7 @@ Resolution order:
|
|
|
200
219
|
|
|
201
220
|
3. **An ephemeral per-process key**, when there is no secret and no reachable
|
|
202
221
|
cache. Sessions do not survive a restart, but the gate still serves: the key
|
|
203
|
-
only validates an
|
|
222
|
+
only validates an existing session, so losing it costs sessions, never
|
|
204
223
|
admission. A caller still needs a code delivered to an allow-listed address.
|
|
205
224
|
|
|
206
225
|
The cached key is read, generated-and-stored, then **re-read**. Two instances
|
|
@@ -212,7 +231,7 @@ the one it minted. Set `TUNNEL_AUTH_JWT_SECRET` to remove the race entirely.
|
|
|
212
231
|
purpose - a key that expired before the cookies it signed would sign everyone out
|
|
213
232
|
for no reason.
|
|
214
233
|
|
|
215
|
-
##
|
|
234
|
+
## Email Code Subject
|
|
216
235
|
|
|
217
236
|
The subject line the gate SENDS is `123456 is your verification code` -
|
|
218
237
|
`--subject` is the template the code is spliced into, not the literal line.
|
package/index.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// Hand edits are overwritten on the next watch; this file is read-only.
|
|
4
4
|
|
|
5
5
|
export const PACKAGE_IDENTIFIER = "@dbx-tools/tunnel";
|
|
6
|
-
export const PACKAGE_VERSION = "0.9.
|
|
6
|
+
export const PACKAGE_VERSION = "0.9.105";
|
|
7
7
|
export * as allowlist from "./src/allowlist.ts";
|
|
8
8
|
export * as codeEmail from "./src/code-email.ts";
|
|
9
9
|
export * as frp from "./src/frp.ts";
|
package/lib/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export declare const PACKAGE_IDENTIFIER = "@dbx-tools/tunnel";
|
|
2
|
-
export declare const PACKAGE_VERSION = "0.9.
|
|
2
|
+
export declare const PACKAGE_VERSION = "0.9.105";
|
|
3
3
|
export * as allowlist from "./src/allowlist.ts";
|
|
4
4
|
export * as codeEmail from "./src/code-email.ts";
|
|
5
5
|
export * as frp from "./src/frp.ts";
|
package/lib/index.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// Regenerated from the exporting modules in ./src.
|
|
3
3
|
// Hand edits are overwritten on the next watch; this file is read-only.
|
|
4
4
|
export const PACKAGE_IDENTIFIER = "@dbx-tools/tunnel";
|
|
5
|
-
export const PACKAGE_VERSION = "0.9.
|
|
5
|
+
export const PACKAGE_VERSION = "0.9.105";
|
|
6
6
|
export * as allowlist from "./src/allowlist.js";
|
|
7
7
|
export * as codeEmail from "./src/code-email.js";
|
|
8
8
|
export * as frp from "./src/frp.js";
|
|
@@ -26,4 +26,4 @@ export { PortrOptionsSchema } from "./src/portr.js";
|
|
|
26
26
|
export { TUNNEL_TRACE_TAG, TUNNEL_SUBDOMAIN_TRACE_TAG } from "./src/request-context.js";
|
|
27
27
|
export { KEY_TTL_SECONDS } from "./src/signing-key.js";
|
|
28
28
|
export * from "./exports.js";
|
|
29
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
29
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyxtQkFBbUIsQ0FBQztBQUN0RCxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsU0FBUyxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxTQUFTLE1BQU0sb0JBQW9CLENBQUM7QUFDaEQsT0FBTyxLQUFLLFNBQVMsTUFBTSxxQkFBcUIsQ0FBQztBQUNqRCxPQUFPLEtBQUssR0FBRyxNQUFNLGNBQWMsQ0FBQztBQUNwQyxPQUFPLEtBQUssSUFBSSxNQUFNLGVBQWUsQ0FBQztBQUN0QyxPQUFPLEtBQUssT0FBTyxNQUFNLGtCQUFrQixDQUFDO0FBQzVDLE9BQU8sS0FBSyxXQUFXLE1BQU0sc0JBQXNCLENBQUM7QUFDcEQsT0FBTyxLQUFLLFNBQVMsTUFBTSxxQkFBcUIsQ0FBQztBQUNqRCxPQUFPLEtBQUssU0FBUyxNQUFNLHFCQUFxQixDQUFDO0FBQ2pELE9BQU8sS0FBSyxNQUFNLE1BQU0saUJBQWlCLENBQUM7QUFDMUMsT0FBTyxLQUFLLEtBQUssTUFBTSxnQkFBZ0IsQ0FBQztBQUN4QyxPQUFPLEtBQUssY0FBYyxNQUFNLDBCQUEwQixDQUFDO0FBQzNELE9BQU8sS0FBSyxRQUFRLE1BQU0sb0JBQW9CLENBQUM7QUFDL0MsT0FBTyxLQUFLLFVBQVUsTUFBTSxzQkFBc0IsQ0FBQztBQUNuRCxPQUFPLEtBQUssVUFBVSxNQUFNLHFCQUFxQixDQUFDO0FBRWxELE9BQU8sRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUVoRCxPQUFPLEVBQUUsVUFBVSxFQUFFLGlCQUFpQixFQUFFLE1BQU0sZUFBZSxDQUFDO0FBRTlELE9BQU8sRUFBRSxpQkFBaUIsRUFBRSx1QkFBdUIsRUFBRSxNQUFNLGtCQUFrQixDQUFDO0FBRTlFLE9BQU8sRUFBRSxxQkFBcUIsRUFBRSw4QkFBOEIsRUFBRSxNQUFNLHNCQUFzQixDQUFDO0FBRzdGLE9BQU8sRUFBRSxvQkFBb0IsRUFBRSxjQUFjLEVBQUUsUUFBUSxFQUFFLE1BQU0saUJBQWlCLENBQUM7QUFFakYsT0FBTyxFQUFFLGtCQUFrQixFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFFcEQsT0FBTyxFQUFFLGdCQUFnQixFQUFFLDBCQUEwQixFQUFFLE1BQU0sMEJBQTBCLENBQUM7QUFDeEYsT0FBTyxFQUFFLGVBQWUsRUFBRSxNQUFNLHNCQUFzQixDQUFDO0FBR3ZELGNBQWMsY0FBYyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gR0VORVJBVEVEIGJ5IHByb2plbiB3YXRjaCAtIERPIE5PVCBFRElULlxuLy8gUmVnZW5lcmF0ZWQgZnJvbSB0aGUgZXhwb3J0aW5nIG1vZHVsZXMgaW4gLi9zcmMuXG4vLyBIYW5kIGVkaXRzIGFyZSBvdmVyd3JpdHRlbiBvbiB0aGUgbmV4dCB3YXRjaDsgdGhpcyBmaWxlIGlzIHJlYWQtb25seS5cblxuZXhwb3J0IGNvbnN0IFBBQ0tBR0VfSURFTlRJRklFUiA9IFwiQGRieC10b29scy90dW5uZWxcIjtcbmV4cG9ydCBjb25zdCBQQUNLQUdFX1ZFUlNJT04gPSBcIjAuOS4xMDVcIjtcbmV4cG9ydCAqIGFzIGFsbG93bGlzdCBmcm9tIFwiLi9zcmMvYWxsb3dsaXN0LnRzXCI7XG5leHBvcnQgKiBhcyBjb2RlRW1haWwgZnJvbSBcIi4vc3JjL2NvZGUtZW1haWwudHNcIjtcbmV4cG9ydCAqIGFzIGZycCBmcm9tIFwiLi9zcmMvZnJwLnRzXCI7XG5leHBvcnQgKiBhcyBnYXRlIGZyb20gXCIuL3NyYy9nYXRlLnRzXCI7XG5leHBvcnQgKiBhcyBoZWFkZXJzIGZyb20gXCIuL3NyYy9oZWFkZXJzLnRzXCI7XG5leHBvcnQgKiBhcyBpbnRlcmNlcHRvciBmcm9tIFwiLi9zcmMvaW50ZXJjZXB0b3IudHNcIjtcbmV4cG9ydCAqIGFzIGxvZ2luUGFnZSBmcm9tIFwiLi9zcmMvbG9naW4tcGFnZS50c1wiO1xuZXhwb3J0ICogYXMgcGF0aFByb3h5IGZyb20gXCIuL3NyYy9wYXRoLXByb3h5LnRzXCI7XG5leHBvcnQgKiBhcyBwbHVnaW4gZnJvbSBcIi4vc3JjL3BsdWdpbi50c1wiO1xuZXhwb3J0ICogYXMgcG9ydHIgZnJvbSBcIi4vc3JjL3BvcnRyLnRzXCI7XG5leHBvcnQgKiBhcyByZXF1ZXN0Q29udGV4dCBmcm9tIFwiLi9zcmMvcmVxdWVzdC1jb250ZXh0LnRzXCI7XG5leHBvcnQgKiBhcyBzZW5kQ29kZSBmcm9tIFwiLi9zcmMvc2VuZC1jb2RlLnRzXCI7XG5leHBvcnQgKiBhcyBzaWduaW5nS2V5IGZyb20gXCIuL3NyYy9zaWduaW5nLWtleS50c1wiO1xuZXhwb3J0ICogYXMgc3VwZXJ2aXNvciBmcm9tIFwiLi9zcmMvc3VwZXJ2aXNvci50c1wiO1xuZXhwb3J0IHR5cGUgeyBDb2RlQ29weSB9IGZyb20gXCIuL3NyYy9jb2RlLWVtYWlsLnRzXCI7XG5leHBvcnQgeyBGcnBPcHRpb25zU2NoZW1hIH0gZnJvbSBcIi4vc3JjL2ZycC50c1wiO1xuZXhwb3J0IHR5cGUgeyBGcnBJbnN0YWxsT3B0aW9ucywgRnJwQ29uZmlnLCBGcnBPcHRpb25zIH0gZnJvbSBcIi4vc3JjL2ZycC50c1wiO1xuZXhwb3J0IHsgaXNBdXRoUGF0aCwgVU5BVVRIT1JJWkVEX0JPRFkgfSBmcm9tIFwiLi9zcmMvZ2F0ZS50c1wiO1xuZXhwb3J0IHR5cGUgeyBHYXRlT3B0aW9ucywgR2F0ZUFjdGlvbiB9IGZyb20gXCIuL3NyYy9nYXRlLnRzXCI7XG5leHBvcnQgeyBQUk9URUNURURfSEVBREVSUywgREVGQVVMVF9GT1JXQVJEX0hFQURFUlMgfSBmcm9tIFwiLi9zcmMvaGVhZGVycy50c1wiO1xuZXhwb3J0IHR5cGUgeyBIZWFkZXJQb2xpY3kgfSBmcm9tIFwiLi9zcmMvaGVhZGVycy50c1wiO1xuZXhwb3J0IHsgVHVubmVsVHJhbnNwb3J0U2NoZW1hLCBUdW5uZWxJbnRlcmNlcHRvck9wdGlvbnNTY2hlbWEgfSBmcm9tIFwiLi9zcmMvaW50ZXJjZXB0b3IudHNcIjtcbmV4cG9ydCB0eXBlIHsgVHVubmVsVHJhbnNwb3J0LCBUdW5uZWxJbnRlcmNlcHRvck9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvaW50ZXJjZXB0b3IudHNcIjtcbmV4cG9ydCB0eXBlIHsgTG9naW5QYWdlT3B0aW9ucyB9IGZyb20gXCIuL3NyYy9sb2dpbi1wYWdlLnRzXCI7XG5leHBvcnQgeyBBdXRoR2F0ZUNvbmZpZ1NjaGVtYSwgQXV0aEdhdGVQbHVnaW4sIGF1dGhHYXRlIH0gZnJvbSBcIi4vc3JjL3BsdWdpbi50c1wiO1xuZXhwb3J0IHR5cGUgeyBBdXRoR2F0ZUNvbmZpZywgU2VuZENvZGVPcHRpb25zLCBSZXNvbHZlZEF1dGhHYXRlQ29uZmlnLCBBdXRoR2F0ZUFwaSB9IGZyb20gXCIuL3NyYy9wbHVnaW4udHNcIjtcbmV4cG9ydCB7IFBvcnRyT3B0aW9uc1NjaGVtYSB9IGZyb20gXCIuL3NyYy9wb3J0ci50c1wiO1xuZXhwb3J0IHR5cGUgeyBQb3J0ckluc3RhbGxPcHRpb25zLCBQb3J0ckNvbmZpZywgUG9ydHJPcHRpb25zIH0gZnJvbSBcIi4vc3JjL3BvcnRyLnRzXCI7XG5leHBvcnQgeyBUVU5ORUxfVFJBQ0VfVEFHLCBUVU5ORUxfU1VCRE9NQUlOX1RSQUNFX1RBRyB9IGZyb20gXCIuL3NyYy9yZXF1ZXN0LWNvbnRleHQudHNcIjtcbmV4cG9ydCB7IEtFWV9UVExfU0VDT05EUyB9IGZyb20gXCIuL3NyYy9zaWduaW5nLWtleS50c1wiO1xuZXhwb3J0IHR5cGUgeyBTaWduaW5nS2V5IH0gZnJvbSBcIi4vc3JjL3NpZ25pbmcta2V5LnRzXCI7XG5leHBvcnQgdHlwZSB7IFByb2Nlc3NTdXBlcnZpc29yLCBQcm9jZXNzU3VwZXJ2aXNvck9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvc3VwZXJ2aXNvci50c1wiO1xuZXhwb3J0ICogZnJvbSBcIi4vZXhwb3J0cy50c1wiO1xuIl19
|
package/package.json
CHANGED
|
@@ -19,21 +19,21 @@
|
|
|
19
19
|
"projen": "projen"
|
|
20
20
|
},
|
|
21
21
|
"devDependencies": {
|
|
22
|
-
"@dbx-tools/email": "^0.9.
|
|
22
|
+
"@dbx-tools/email": "^0.9.105",
|
|
23
23
|
"@types/bun": "1.3.14",
|
|
24
24
|
"@types/node": "^24.6.0",
|
|
25
25
|
"typescript": "^5.9.3"
|
|
26
26
|
},
|
|
27
27
|
"peerDependencies": {
|
|
28
|
-
"@dbx-tools/email": "^0.9.
|
|
28
|
+
"@dbx-tools/email": "^0.9.105"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
31
|
"@databricks/appkit": "0.81.0",
|
|
32
|
-
"@dbx-tools/appkit": "^0.9.
|
|
33
|
-
"@dbx-tools/auth-gate": "^0.9.
|
|
34
|
-
"@dbx-tools/core": "^0.9.
|
|
35
|
-
"@dbx-tools/shared-auth": "^0.9.
|
|
36
|
-
"@dbx-tools/shared-core": "^0.9.
|
|
32
|
+
"@dbx-tools/appkit": "^0.9.105",
|
|
33
|
+
"@dbx-tools/auth-gate": "^0.9.105",
|
|
34
|
+
"@dbx-tools/core": "^0.9.105",
|
|
35
|
+
"@dbx-tools/shared-auth": "^0.9.105",
|
|
36
|
+
"@dbx-tools/shared-core": "^0.9.105",
|
|
37
37
|
"@types/express": "^5.0.5",
|
|
38
38
|
"better-call": "1.4.0",
|
|
39
39
|
"http-proxy-3": "^1.23.1",
|
|
@@ -109,7 +109,7 @@
|
|
|
109
109
|
"./package.json": "./package.json"
|
|
110
110
|
}
|
|
111
111
|
},
|
|
112
|
-
"version": "0.9.
|
|
112
|
+
"version": "0.9.105",
|
|
113
113
|
"types": "./lib/index.d.ts",
|
|
114
114
|
"dbxToolsConfig": {
|
|
115
115
|
"tags": [
|