@elizaos/plugin-tunnel 2.0.0-beta.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/README.md +39 -0
- package/dist/__tests__/TunnelTestSuite.d.ts +6 -0
- package/dist/__tests__/TunnelTestSuite.d.ts.map +1 -0
- package/dist/__tests__/TunnelTestSuite.js +47 -0
- package/dist/__tests__/TunnelTestSuite.js.map +1 -0
- package/dist/actions/get-tunnel-status.d.ts +3 -0
- package/dist/actions/get-tunnel-status.d.ts.map +1 -0
- package/dist/actions/get-tunnel-status.js +43 -0
- package/dist/actions/get-tunnel-status.js.map +1 -0
- package/dist/actions/start-tunnel.d.ts +3 -0
- package/dist/actions/start-tunnel.d.ts.map +1 -0
- package/dist/actions/start-tunnel.js +96 -0
- package/dist/actions/start-tunnel.js.map +1 -0
- package/dist/actions/stop-tunnel.d.ts +3 -0
- package/dist/actions/stop-tunnel.d.ts.map +1 -0
- package/dist/actions/stop-tunnel.js +41 -0
- package/dist/actions/stop-tunnel.js.map +1 -0
- package/dist/actions/tunnel.d.ts +20 -0
- package/dist/actions/tunnel.d.ts.map +1 -0
- package/dist/actions/tunnel.js +159 -0
- package/dist/actions/tunnel.js.map +1 -0
- package/dist/environment.d.ts +18 -0
- package/dist/environment.d.ts.map +1 -0
- package/dist/environment.js +66 -0
- package/dist/environment.js.map +1 -0
- package/dist/index.d.ts +21 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +46 -0
- package/dist/index.js.map +1 -0
- package/dist/providers/tunnel-state.d.ts +12 -0
- package/dist/providers/tunnel-state.d.ts.map +1 -0
- package/dist/providers/tunnel-state.js +43 -0
- package/dist/providers/tunnel-state.js.map +1 -0
- package/dist/services/LocalTunnelService.d.ts +37 -0
- package/dist/services/LocalTunnelService.d.ts.map +1 -0
- package/dist/services/LocalTunnelService.js +186 -0
- package/dist/services/LocalTunnelService.js.map +1 -0
- package/dist/types.d.ts +47 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +34 -0
- package/dist/types.js.map +1 -0
- package/package.json +59 -0
- package/src/__tests__/TunnelTestSuite.ts +46 -0
- package/src/__tests__/unit/local-tunnel-service.test.ts +23 -0
- package/src/actions/get-tunnel-status.ts +60 -0
- package/src/actions/start-tunnel.ts +117 -0
- package/src/actions/stop-tunnel.ts +58 -0
- package/src/actions/tunnel.ts +193 -0
- package/src/environment.ts +74 -0
- package/src/index.ts +59 -0
- package/src/providers/tunnel-state.ts +46 -0
- package/src/services/LocalTunnelService.ts +228 -0
- package/src/types.ts +62 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2C,KAAK,MAAM,EAAE,MAAM,eAAe,CAAC;AAOrF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,EAAE,MAwB1B,CAAC;AAEF,eAAe,YAAY,CAAC;AAE5B,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,KAAK,YAAY,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE/D,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAC5F,OAAO,EACL,gBAAgB,EAChB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,YAAY,EACjB,gBAAgB,GACjB,MAAM,SAAS,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { elizaLogger, promoteSubactionsToActions } from '@elizaos/core';
|
|
2
|
+
import { TunnelTestSuite } from './__tests__/TunnelTestSuite';
|
|
3
|
+
import { tunnelAction } from './actions/tunnel';
|
|
4
|
+
import { tunnelStateProvider } from './providers/tunnel-state';
|
|
5
|
+
import { checkTailscaleInstalled, LocalTunnelService } from './services/LocalTunnelService';
|
|
6
|
+
import { tunnelSlotIsFree } from './types';
|
|
7
|
+
/**
|
|
8
|
+
* Local Tailscale-CLI tunnel plugin.
|
|
9
|
+
*
|
|
10
|
+
* Registers `serviceType = "tunnel"` ONLY when:
|
|
11
|
+
* 1. No other tunnel service has already claimed the slot (first-active-wins
|
|
12
|
+
* across plugin-tunnel, plugin-elizacloud, plugin-ngrok), AND
|
|
13
|
+
* 2. The `tailscale` CLI is on PATH.
|
|
14
|
+
*
|
|
15
|
+
* The Eliza Cloud (headscale) tunnel lives in `@elizaos/plugin-elizacloud`.
|
|
16
|
+
* Ngrok lives in `@elizaos/plugin-ngrok`. Enable as many as you like — only
|
|
17
|
+
* one will bind.
|
|
18
|
+
*/
|
|
19
|
+
export const tunnelPlugin = {
|
|
20
|
+
name: 'tunnel',
|
|
21
|
+
description: 'Local Tailscale-CLI tunnel backend (serve / funnel). Coexists with plugin-elizacloud and plugin-ngrok via first-active-wins registration.',
|
|
22
|
+
actions: [...promoteSubactionsToActions(tunnelAction)],
|
|
23
|
+
providers: [tunnelStateProvider],
|
|
24
|
+
tests: [new TunnelTestSuite()],
|
|
25
|
+
init: async (_config, runtime) => {
|
|
26
|
+
if (!tunnelSlotIsFree(runtime)) {
|
|
27
|
+
elizaLogger.info('[plugin-tunnel] another tunnel service already registered — skipping LocalTunnelService');
|
|
28
|
+
return;
|
|
29
|
+
}
|
|
30
|
+
const installed = await checkTailscaleInstalled();
|
|
31
|
+
if (!installed) {
|
|
32
|
+
elizaLogger.info('[plugin-tunnel] tailscale CLI not found on PATH — skipping LocalTunnelService');
|
|
33
|
+
return;
|
|
34
|
+
}
|
|
35
|
+
elizaLogger.info('[plugin-tunnel] registering LocalTunnelService for serviceType="tunnel"');
|
|
36
|
+
await runtime.registerService(LocalTunnelService);
|
|
37
|
+
},
|
|
38
|
+
};
|
|
39
|
+
export default tunnelPlugin;
|
|
40
|
+
export { tunnelAction } from './actions/tunnel';
|
|
41
|
+
export { validateTunnelConfig } from './environment';
|
|
42
|
+
export { tunnelStateProvider } from './providers/tunnel-state';
|
|
43
|
+
// Public surface for consumers and sibling tunnel plugins.
|
|
44
|
+
export { checkTailscaleInstalled, LocalTunnelService } from './services/LocalTunnelService';
|
|
45
|
+
export { getTunnelService, tunnelSlotIsFree, } from './types';
|
|
46
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAe,MAAM,eAAe,CAAC;AACrF,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAC5F,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,YAAY,GAAW;IAClC,IAAI,EAAE,QAAQ;IACd,WAAW,EACT,2IAA2I;IAC7I,OAAO,EAAE,CAAC,GAAG,0BAA0B,CAAC,YAAY,CAAC,CAAC;IACtD,SAAS,EAAE,CAAC,mBAAmB,CAAC;IAChC,KAAK,EAAE,CAAC,IAAI,eAAe,EAAE,CAAC;IAC9B,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAC/B,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,WAAW,CAAC,IAAI,CACd,yFAAyF,CAC1F,CAAC;YACF,OAAO;QACT,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,uBAAuB,EAAE,CAAC;QAClD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,WAAW,CAAC,IAAI,CACd,+EAA+E,CAChF,CAAC;YACF,OAAO;QACT,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,yEAAyE,CAAC,CAAC;QAC5F,MAAM,OAAO,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;IACpD,CAAC;CACF,CAAC;AAEF,eAAe,YAAY,CAAC;AAE5B,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAqB,oBAAoB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,2DAA2D;AAC3D,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAC5F,OAAO,EACL,gBAAgB,EAIhB,gBAAgB,GACjB,MAAM,SAAS,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { Provider } from '@elizaos/core';
|
|
2
|
+
/**
|
|
3
|
+
* Surfaces the active tunnel's status into the model's state. Renders a
|
|
4
|
+
* one-line text summary and exposes the raw status object via `data`.
|
|
5
|
+
*
|
|
6
|
+
* Backend-agnostic — works with whichever tunnel implementation
|
|
7
|
+
* (`LocalTunnelService` here, `CloudTunnelService` in plugin-elizacloud,
|
|
8
|
+
* the ngrok service, etc.) won the `serviceType="tunnel"` slot.
|
|
9
|
+
*/
|
|
10
|
+
export declare const tunnelStateProvider: Provider;
|
|
11
|
+
export default tunnelStateProvider;
|
|
12
|
+
//# sourceMappingURL=tunnel-state.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tunnel-state.d.ts","sourceRoot":"","sources":["../../src/providers/tunnel-state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAG9C;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,EAAE,QAgCjC,CAAC;AAEF,eAAe,mBAAmB,CAAC"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { getTunnelService } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* Surfaces the active tunnel's status into the model's state. Renders a
|
|
4
|
+
* one-line text summary and exposes the raw status object via `data`.
|
|
5
|
+
*
|
|
6
|
+
* Backend-agnostic — works with whichever tunnel implementation
|
|
7
|
+
* (`LocalTunnelService` here, `CloudTunnelService` in plugin-elizacloud,
|
|
8
|
+
* the ngrok service, etc.) won the `serviceType="tunnel"` slot.
|
|
9
|
+
*/
|
|
10
|
+
export const tunnelStateProvider = {
|
|
11
|
+
name: 'TUNNEL_STATE',
|
|
12
|
+
description: 'Current tunnel status: active flag, public URL, local port, provider, backend.',
|
|
13
|
+
descriptionCompressed: 'Tunnel: active/url/port/provider/backend',
|
|
14
|
+
contexts: ['devtools', 'system'],
|
|
15
|
+
relevanceKeywords: ['tunnel', 'tailscale', 'headscale', 'ngrok', 'serve', 'funnel', 'expose'],
|
|
16
|
+
position: 200,
|
|
17
|
+
get: async (runtime, _message) => {
|
|
18
|
+
const svc = getTunnelService(runtime);
|
|
19
|
+
if (!svc) {
|
|
20
|
+
return {
|
|
21
|
+
text: 'No tunnel service is registered.',
|
|
22
|
+
data: {
|
|
23
|
+
active: false,
|
|
24
|
+
available: false,
|
|
25
|
+
},
|
|
26
|
+
};
|
|
27
|
+
}
|
|
28
|
+
const status = svc.getStatus();
|
|
29
|
+
const text = status.active
|
|
30
|
+
? `Tunnel ACTIVE — ${status.url ?? 'unknown URL'} (port ${status.port}, ${status.provider}${status.backend ? `/${status.backend}` : ''})`
|
|
31
|
+
: `Tunnel idle (${status.provider} ready).`;
|
|
32
|
+
return {
|
|
33
|
+
text,
|
|
34
|
+
data: {
|
|
35
|
+
available: true,
|
|
36
|
+
...status,
|
|
37
|
+
startedAt: status.startedAt ? status.startedAt.toISOString() : null,
|
|
38
|
+
},
|
|
39
|
+
};
|
|
40
|
+
},
|
|
41
|
+
};
|
|
42
|
+
export default tunnelStateProvider;
|
|
43
|
+
//# sourceMappingURL=tunnel-state.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tunnel-state.js","sourceRoot":"","sources":["../../src/providers/tunnel-state.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAa;IAC3C,IAAI,EAAE,cAAc;IACpB,WAAW,EAAE,gFAAgF;IAC7F,qBAAqB,EAAE,0CAA0C;IACjE,QAAQ,EAAE,CAAC,UAAU,EAAE,QAAQ,CAAC;IAChC,iBAAiB,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC;IAC7F,QAAQ,EAAE,GAAG;IAEb,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;QAC/B,MAAM,GAAG,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO;gBACL,IAAI,EAAE,kCAAkC;gBACxC,IAAI,EAAE;oBACJ,MAAM,EAAE,KAAK;oBACb,SAAS,EAAE,KAAK;iBACjB;aACF,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM;YACxB,CAAC,CAAC,mBAAmB,MAAM,CAAC,GAAG,IAAI,aAAa,UAAU,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG;YACzI,CAAC,CAAC,gBAAgB,MAAM,CAAC,QAAQ,UAAU,CAAC;QAC9C,OAAO;YACL,IAAI;YACJ,IAAI,EAAE;gBACJ,SAAS,EAAE,IAAI;gBACf,GAAG,MAAM;gBACT,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI;aACpE;SACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,eAAe,mBAAmB,CAAC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { type IAgentRuntime, Service } from '@elizaos/core';
|
|
2
|
+
import type { ITunnelService, TunnelStatus } from '../types';
|
|
3
|
+
export declare function checkTailscaleInstalled(): Promise<boolean>;
|
|
4
|
+
/**
|
|
5
|
+
* Tunnel service backed by the locally-installed `tailscale` CLI.
|
|
6
|
+
*
|
|
7
|
+
* The user is responsible for `tailscale up` (i.e. authenticating with
|
|
8
|
+
* Tailscale's coordination server, OR with a self-hosted headscale via
|
|
9
|
+
* `--login-server`). This service just calls `tailscale serve` / `tailscale
|
|
10
|
+
* funnel` to expose a port and reads `tailscale status --json` to learn the
|
|
11
|
+
* tailnet DNS name.
|
|
12
|
+
*
|
|
13
|
+
* Coexists with `@elizaos/plugin-elizacloud`'s cloud tunnel and
|
|
14
|
+
* `@elizaos/plugin-ngrok` — only the first one to register `serviceType="tunnel"`
|
|
15
|
+
* wins. This service registers itself only if the `tailscale` binary is on
|
|
16
|
+
* `PATH`, gating out machines that have no Tailscale install.
|
|
17
|
+
*/
|
|
18
|
+
export declare class LocalTunnelService extends Service implements ITunnelService {
|
|
19
|
+
static serviceType: string;
|
|
20
|
+
readonly capabilityDescription = "Tunnel via the locally-installed `tailscale` CLI (serve / funnel). User authenticates separately with `tailscale up`.";
|
|
21
|
+
private tunnelUrl;
|
|
22
|
+
private tunnelPort;
|
|
23
|
+
private startedAt;
|
|
24
|
+
private isShuttingDown;
|
|
25
|
+
private useFunnel;
|
|
26
|
+
static start(runtime: IAgentRuntime): Promise<Service>;
|
|
27
|
+
start(): Promise<void>;
|
|
28
|
+
stop(): Promise<void>;
|
|
29
|
+
startTunnel(port?: number): Promise<string | undefined>;
|
|
30
|
+
stopTunnel(): Promise<void>;
|
|
31
|
+
getUrl(): string | null;
|
|
32
|
+
isActive(): boolean;
|
|
33
|
+
getStatus(): TunnelStatus;
|
|
34
|
+
private fetchSelfDnsName;
|
|
35
|
+
private cleanup;
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=LocalTunnelService.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"LocalTunnelService.d.ts","sourceRoot":"","sources":["../../src/services/LocalTunnelService.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,KAAK,aAAa,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAGzE,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AA2C7D,wBAAgB,uBAAuB,IAAI,OAAO,CAAC,OAAO,CAAC,CAM1D;AAaD;;;;;;;;;;;;;GAaG;AACH,qBAAa,kBAAmB,SAAQ,OAAQ,YAAW,cAAc;IACvE,OAAgB,WAAW,SAAY;IACvC,QAAQ,CAAC,qBAAqB,2HAC4F;IAE1H,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,UAAU,CAAuB;IACzC,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,SAAS,CAAS;WAEJ,KAAK,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAM/D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAUtB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAwDvD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAmBjC,MAAM,IAAI,MAAM,GAAG,IAAI;IAIvB,QAAQ,IAAI,OAAO;IAInB,SAAS,IAAI,YAAY;YAWX,gBAAgB;IAgB9B,OAAO,CAAC,OAAO;CAMhB"}
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
import { spawn } from 'node:child_process';
|
|
2
|
+
import { elizaLogger, Service } from '@elizaos/core';
|
|
3
|
+
import { z } from 'zod';
|
|
4
|
+
import { validateTunnelConfig } from '../environment';
|
|
5
|
+
const tailscaleStatusPeerSchema = z.object({
|
|
6
|
+
DNSName: z.string().optional(),
|
|
7
|
+
Online: z.boolean().optional(),
|
|
8
|
+
});
|
|
9
|
+
const tailscaleStatusSchema = z.object({
|
|
10
|
+
Self: z
|
|
11
|
+
.object({
|
|
12
|
+
DNSName: z.string().optional(),
|
|
13
|
+
})
|
|
14
|
+
.optional(),
|
|
15
|
+
MagicDNSSuffix: z.string().optional(),
|
|
16
|
+
Peer: z.record(z.string(), tailscaleStatusPeerSchema).optional(),
|
|
17
|
+
});
|
|
18
|
+
function runCommand(cmd, args) {
|
|
19
|
+
return new Promise((resolve, reject) => {
|
|
20
|
+
const child = spawn(cmd, args, { stdio: ['ignore', 'pipe', 'pipe'] });
|
|
21
|
+
const out = [];
|
|
22
|
+
const err = [];
|
|
23
|
+
child.stdout?.on('data', (chunk) => out.push(chunk));
|
|
24
|
+
child.stderr?.on('data', (chunk) => err.push(chunk));
|
|
25
|
+
child.on('error', reject);
|
|
26
|
+
child.on('exit', (code) => resolve({
|
|
27
|
+
code,
|
|
28
|
+
stdout: Buffer.concat(out).toString('utf8'),
|
|
29
|
+
stderr: Buffer.concat(err).toString('utf8'),
|
|
30
|
+
}));
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
export function checkTailscaleInstalled() {
|
|
34
|
+
return new Promise((resolve) => {
|
|
35
|
+
const proc = spawn('which', ['tailscale']);
|
|
36
|
+
proc.on('exit', (code) => resolve(code === 0));
|
|
37
|
+
proc.on('error', () => resolve(false));
|
|
38
|
+
});
|
|
39
|
+
}
|
|
40
|
+
function parseTailscaleStatus(stdout) {
|
|
41
|
+
let raw;
|
|
42
|
+
try {
|
|
43
|
+
raw = JSON.parse(stdout);
|
|
44
|
+
}
|
|
45
|
+
catch {
|
|
46
|
+
return null;
|
|
47
|
+
}
|
|
48
|
+
const result = tailscaleStatusSchema.safeParse(raw);
|
|
49
|
+
return result.success ? result.data : null;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Tunnel service backed by the locally-installed `tailscale` CLI.
|
|
53
|
+
*
|
|
54
|
+
* The user is responsible for `tailscale up` (i.e. authenticating with
|
|
55
|
+
* Tailscale's coordination server, OR with a self-hosted headscale via
|
|
56
|
+
* `--login-server`). This service just calls `tailscale serve` / `tailscale
|
|
57
|
+
* funnel` to expose a port and reads `tailscale status --json` to learn the
|
|
58
|
+
* tailnet DNS name.
|
|
59
|
+
*
|
|
60
|
+
* Coexists with `@elizaos/plugin-elizacloud`'s cloud tunnel and
|
|
61
|
+
* `@elizaos/plugin-ngrok` — only the first one to register `serviceType="tunnel"`
|
|
62
|
+
* wins. This service registers itself only if the `tailscale` binary is on
|
|
63
|
+
* `PATH`, gating out machines that have no Tailscale install.
|
|
64
|
+
*/
|
|
65
|
+
export class LocalTunnelService extends Service {
|
|
66
|
+
static serviceType = 'tunnel';
|
|
67
|
+
capabilityDescription = 'Tunnel via the locally-installed `tailscale` CLI (serve / funnel). User authenticates separately with `tailscale up`.';
|
|
68
|
+
tunnelUrl = null;
|
|
69
|
+
tunnelPort = null;
|
|
70
|
+
startedAt = null;
|
|
71
|
+
isShuttingDown = false;
|
|
72
|
+
useFunnel = false;
|
|
73
|
+
static async start(runtime) {
|
|
74
|
+
const service = new LocalTunnelService(runtime);
|
|
75
|
+
await service.start();
|
|
76
|
+
return service;
|
|
77
|
+
}
|
|
78
|
+
async start() {
|
|
79
|
+
elizaLogger.info('[LocalTunnelService] starting');
|
|
80
|
+
const installed = await checkTailscaleInstalled();
|
|
81
|
+
if (!installed) {
|
|
82
|
+
throw new Error('tailscale is not installed. Install from https://tailscale.com/download or run: brew install tailscale');
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
async stop() {
|
|
86
|
+
await this.stopTunnel();
|
|
87
|
+
}
|
|
88
|
+
async startTunnel(port) {
|
|
89
|
+
if (this.isActive()) {
|
|
90
|
+
elizaLogger.warn('[LocalTunnelService] tunnel already running');
|
|
91
|
+
return this.tunnelUrl ?? undefined;
|
|
92
|
+
}
|
|
93
|
+
if (port === undefined || port === null) {
|
|
94
|
+
elizaLogger.warn('[LocalTunnelService] startTunnel called without a port — service active but no tunnel started');
|
|
95
|
+
return;
|
|
96
|
+
}
|
|
97
|
+
if (port < 1 || port > 65535) {
|
|
98
|
+
throw new Error('Invalid port number');
|
|
99
|
+
}
|
|
100
|
+
const config = await validateTunnelConfig(this.runtime);
|
|
101
|
+
this.useFunnel = config.TUNNEL_FUNNEL;
|
|
102
|
+
elizaLogger.info(`[LocalTunnelService] starting tunnel on port ${port} (funnel=${this.useFunnel})`);
|
|
103
|
+
if (this.useFunnel) {
|
|
104
|
+
const result = await runCommand('tailscale', ['funnel', String(port)]);
|
|
105
|
+
if (result.code !== 0) {
|
|
106
|
+
throw new Error(`tailscale funnel exited with code ${result.code}: ${result.stderr.trim()}`);
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
else {
|
|
110
|
+
const result = await runCommand('tailscale', [
|
|
111
|
+
'serve',
|
|
112
|
+
'--bg',
|
|
113
|
+
'--https=443',
|
|
114
|
+
`localhost:${port}`,
|
|
115
|
+
]);
|
|
116
|
+
if (result.code !== 0) {
|
|
117
|
+
throw new Error(`tailscale serve exited with code ${result.code}: ${result.stderr.trim()}`);
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
const dnsName = await this.fetchSelfDnsName();
|
|
121
|
+
if (!dnsName) {
|
|
122
|
+
throw new Error('tailscale serve started but no DNSName resolved from `tailscale status --json`');
|
|
123
|
+
}
|
|
124
|
+
this.tunnelUrl = `https://${dnsName}`;
|
|
125
|
+
this.tunnelPort = port;
|
|
126
|
+
this.startedAt = new Date();
|
|
127
|
+
elizaLogger.info(`[LocalTunnelService] tunnel started: ${this.tunnelUrl}`);
|
|
128
|
+
return this.tunnelUrl;
|
|
129
|
+
}
|
|
130
|
+
async stopTunnel() {
|
|
131
|
+
if (!this.isActive()) {
|
|
132
|
+
elizaLogger.warn('[LocalTunnelService] no active tunnel to stop');
|
|
133
|
+
return;
|
|
134
|
+
}
|
|
135
|
+
this.isShuttingDown = true;
|
|
136
|
+
elizaLogger.info('[LocalTunnelService] stopping tunnel');
|
|
137
|
+
if (this.useFunnel) {
|
|
138
|
+
await runCommand('tailscale', ['funnel', 'reset']);
|
|
139
|
+
}
|
|
140
|
+
else {
|
|
141
|
+
await runCommand('tailscale', ['serve', 'reset']);
|
|
142
|
+
}
|
|
143
|
+
this.cleanup();
|
|
144
|
+
this.isShuttingDown = false;
|
|
145
|
+
elizaLogger.info('[LocalTunnelService] tunnel stopped');
|
|
146
|
+
}
|
|
147
|
+
getUrl() {
|
|
148
|
+
return this.tunnelUrl;
|
|
149
|
+
}
|
|
150
|
+
isActive() {
|
|
151
|
+
return this.tunnelUrl !== null && !this.isShuttingDown;
|
|
152
|
+
}
|
|
153
|
+
getStatus() {
|
|
154
|
+
return {
|
|
155
|
+
active: this.isActive(),
|
|
156
|
+
url: this.tunnelUrl,
|
|
157
|
+
port: this.tunnelPort,
|
|
158
|
+
startedAt: this.startedAt,
|
|
159
|
+
provider: 'tailscale',
|
|
160
|
+
backend: 'local-cli',
|
|
161
|
+
};
|
|
162
|
+
}
|
|
163
|
+
async fetchSelfDnsName() {
|
|
164
|
+
const result = await runCommand('tailscale', ['status', '--json']);
|
|
165
|
+
if (result.code !== 0) {
|
|
166
|
+
elizaLogger.error(`[LocalTunnelService] tailscale status failed: ${result.stderr.trim()}`);
|
|
167
|
+
return null;
|
|
168
|
+
}
|
|
169
|
+
const status = parseTailscaleStatus(result.stdout);
|
|
170
|
+
if (!status) {
|
|
171
|
+
elizaLogger.error('[LocalTunnelService] tailscale status returned malformed JSON');
|
|
172
|
+
return null;
|
|
173
|
+
}
|
|
174
|
+
const raw = status.Self?.DNSName;
|
|
175
|
+
if (!raw)
|
|
176
|
+
return null;
|
|
177
|
+
return raw.replace(/\.$/, '');
|
|
178
|
+
}
|
|
179
|
+
cleanup() {
|
|
180
|
+
this.tunnelUrl = null;
|
|
181
|
+
this.tunnelPort = null;
|
|
182
|
+
this.startedAt = null;
|
|
183
|
+
this.useFunnel = false;
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
//# sourceMappingURL=LocalTunnelService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"LocalTunnelService.js","sourceRoot":"","sources":["../../src/services/LocalTunnelService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAsB,OAAO,EAAE,MAAM,eAAe,CAAC;AACzE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAGtD,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,CAAC;SACJ,MAAM,CAAC;QACN,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC/B,CAAC;SACD,QAAQ,EAAE;IACb,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,yBAAyB,CAAC,CAAC,QAAQ,EAAE;CACjE,CAAC,CAAC;AAUH,SAAS,UAAU,CAAC,GAAW,EAAE,IAAc;IAC7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACtE,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7D,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7D,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1B,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CACxB,OAAO,CAAC;YACN,IAAI;YACJ,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC3C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;SAC5C,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,uBAAuB;IACrC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;QAC3C,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAc;IAC1C,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACpD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,kBAAmB,SAAQ,OAAO;IAC7C,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC;IAC9B,qBAAqB,GAC5B,uHAAuH,CAAC;IAElH,SAAS,GAAkB,IAAI,CAAC;IAChC,UAAU,GAAkB,IAAI,CAAC;IACjC,SAAS,GAAgB,IAAI,CAAC;IAC9B,cAAc,GAAG,KAAK,CAAC;IACvB,SAAS,GAAG,KAAK,CAAC;IAE1B,MAAM,CAAU,KAAK,CAAC,KAAK,CAAC,OAAsB;QAChD,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QACtB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,WAAW,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;QAClD,MAAM,SAAS,GAAG,MAAM,uBAAuB,EAAE,CAAC;QAClD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAa;QAC7B,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpB,WAAW,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YAChE,OAAO,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;QACrC,CAAC;QAED,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YACxC,WAAW,CAAC,IAAI,CACd,+FAA+F,CAChG,CAAC;YACF,OAAO;QACT,CAAC;QAED,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,KAAK,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,aAAa,CAAC;QAEtC,WAAW,CAAC,IAAI,CACd,gDAAgD,IAAI,YAAY,IAAI,CAAC,SAAS,GAAG,CAClF,CAAC;QAEF,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACvE,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CACb,qCAAqC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAC5E,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,WAAW,EAAE;gBAC3C,OAAO;gBACP,MAAM;gBACN,aAAa;gBACb,aAAa,IAAI,EAAE;aACpB,CAAC,CAAC;YACH,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,oCAAoC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC9F,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC9C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,WAAW,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAC5B,WAAW,CAAC,IAAI,CAAC,wCAAwC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YACrB,WAAW,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;YAClE,OAAO;QACT,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,WAAW,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;QAEzD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,UAAU,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,MAAM,UAAU,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;QAC5B,WAAW,CAAC,IAAI,CAAC,qCAAqC,CAAC,CAAC;IAC1D,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;IACzD,CAAC;IAED,SAAS;QACP,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE;YACvB,GAAG,EAAE,IAAI,CAAC,SAAS;YACnB,IAAI,EAAE,IAAI,CAAC,UAAU;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,WAAW;YACrB,OAAO,EAAE,WAAW;SACrB,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,gBAAgB;QAC5B,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;QACnE,IAAI,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACtB,WAAW,CAAC,KAAK,CAAC,iDAAiD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3F,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,MAAM,GAAG,oBAAoB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,WAAW,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;YACnF,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC;QACjC,IAAI,CAAC,GAAG;YAAE,OAAO,IAAI,CAAC;QACtB,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC"}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Tunnel-service contract shared across all elizaOS tunnel plugins.
|
|
3
|
+
*
|
|
4
|
+
* All tunnel plugins (`@elizaos/plugin-tunnel`, `@elizaos/plugin-elizacloud`'s
|
|
5
|
+
* cloud tunnel, `@elizaos/plugin-ngrok`) register under
|
|
6
|
+
* `serviceType = "tunnel"` so consumers stay backend-agnostic via
|
|
7
|
+
* `runtime.getService("tunnel")`. The runtime returns the FIRST registered
|
|
8
|
+
* service for a given type, so plugins coordinate via conditional
|
|
9
|
+
* registration: each plugin's `init` only registers if its credentials are
|
|
10
|
+
* present and no other tunnel service has already claimed the slot.
|
|
11
|
+
*/
|
|
12
|
+
import type { IAgentRuntime } from '@elizaos/core';
|
|
13
|
+
declare module '@elizaos/core' {
|
|
14
|
+
interface ServiceTypeRegistry {
|
|
15
|
+
TUNNEL: 'tunnel';
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
export type TunnelProvider = 'tailscale' | 'headscale' | 'ngrok';
|
|
19
|
+
export interface TunnelStatus {
|
|
20
|
+
active: boolean;
|
|
21
|
+
url: string | null;
|
|
22
|
+
port: number | null;
|
|
23
|
+
startedAt: Date | null;
|
|
24
|
+
provider: TunnelProvider;
|
|
25
|
+
/** Optional human label distinguishing backend variants (e.g. "local-cli", "eliza-cloud-headscale"). */
|
|
26
|
+
backend?: string;
|
|
27
|
+
}
|
|
28
|
+
export interface ITunnelService {
|
|
29
|
+
startTunnel(port?: number): Promise<string | undefined>;
|
|
30
|
+
stopTunnel(): Promise<void>;
|
|
31
|
+
getUrl(): string | null;
|
|
32
|
+
isActive(): boolean;
|
|
33
|
+
getStatus(): TunnelStatus;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Backend-agnostic accessor. Returns the first registered service that
|
|
37
|
+
* implements the tunnel contract; returns null if nothing is registered or
|
|
38
|
+
* the registered service doesn't satisfy the shape (defensive guard against
|
|
39
|
+
* an unrelated service registering under "tunnel").
|
|
40
|
+
*/
|
|
41
|
+
export declare function getTunnelService(runtime: IAgentRuntime): ITunnelService | null;
|
|
42
|
+
/**
|
|
43
|
+
* True iff no tunnel service has claimed `serviceType="tunnel"` yet.
|
|
44
|
+
* Used by tunnel plugins' `init` hooks to coordinate "first active wins".
|
|
45
|
+
*/
|
|
46
|
+
export declare function tunnelSlotIsFree(runtime: IAgentRuntime): boolean;
|
|
47
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAW,MAAM,eAAe,CAAC;AAE5D,OAAO,QAAQ,eAAe,CAAC;IAC7B,UAAU,mBAAmB;QAC3B,MAAM,EAAE,QAAQ,CAAC;KAClB;CACF;AAED,MAAM,MAAM,cAAc,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC;AAEjE,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,cAAc,CAAC;IACzB,wGAAwG;IACxG,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACxD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,IAAI,MAAM,GAAG,IAAI,CAAC;IACxB,QAAQ,IAAI,OAAO,CAAC;IACpB,SAAS,IAAI,YAAY,CAAC;CAC3B;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,aAAa,GAAG,cAAc,GAAG,IAAI,CAO9E;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAEhE"}
|
package/dist/types.js
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Tunnel-service contract shared across all elizaOS tunnel plugins.
|
|
3
|
+
*
|
|
4
|
+
* All tunnel plugins (`@elizaos/plugin-tunnel`, `@elizaos/plugin-elizacloud`'s
|
|
5
|
+
* cloud tunnel, `@elizaos/plugin-ngrok`) register under
|
|
6
|
+
* `serviceType = "tunnel"` so consumers stay backend-agnostic via
|
|
7
|
+
* `runtime.getService("tunnel")`. The runtime returns the FIRST registered
|
|
8
|
+
* service for a given type, so plugins coordinate via conditional
|
|
9
|
+
* registration: each plugin's `init` only registers if its credentials are
|
|
10
|
+
* present and no other tunnel service has already claimed the slot.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Backend-agnostic accessor. Returns the first registered service that
|
|
14
|
+
* implements the tunnel contract; returns null if nothing is registered or
|
|
15
|
+
* the registered service doesn't satisfy the shape (defensive guard against
|
|
16
|
+
* an unrelated service registering under "tunnel").
|
|
17
|
+
*/
|
|
18
|
+
export function getTunnelService(runtime) {
|
|
19
|
+
const service = runtime.getService('tunnel');
|
|
20
|
+
if (!service)
|
|
21
|
+
return null;
|
|
22
|
+
if (typeof service.startTunnel !== 'function') {
|
|
23
|
+
return null;
|
|
24
|
+
}
|
|
25
|
+
return service;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* True iff no tunnel service has claimed `serviceType="tunnel"` yet.
|
|
29
|
+
* Used by tunnel plugins' `init` hooks to coordinate "first active wins".
|
|
30
|
+
*/
|
|
31
|
+
export function tunnelSlotIsFree(runtime) {
|
|
32
|
+
return runtime.getService('tunnel') === null;
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AA8BH;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAsB;IACrD,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC7C,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,IAAI,OAAQ,OAAmC,CAAC,WAAW,KAAK,UAAU,EAAE,CAAC;QAC3E,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,OAAmC,CAAC;AAC7C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAsB;IACrD,OAAO,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;AAC/C,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@elizaos/plugin-tunnel",
|
|
3
|
+
"version": "2.0.0-beta.1",
|
|
4
|
+
"description": "Tunnel plugin for elizaOS — local Tailscale CLI backend (serve/funnel). Pair with @elizaos/plugin-elizacloud for the hosted headscale backend.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"module": "dist/index.js",
|
|
8
|
+
"types": "dist/index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
"./package.json": "./package.json",
|
|
11
|
+
".": {
|
|
12
|
+
"types": "./dist/index.d.ts",
|
|
13
|
+
"import": "./dist/index.js",
|
|
14
|
+
"default": "./dist/index.js"
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"files": [
|
|
18
|
+
"dist",
|
|
19
|
+
"src"
|
|
20
|
+
],
|
|
21
|
+
"scripts": {
|
|
22
|
+
"build": "tsc --noCheck -p tsconfig.json",
|
|
23
|
+
"dev": "tsc --watch",
|
|
24
|
+
"typecheck": "tsc --noEmit",
|
|
25
|
+
"test": "bun test",
|
|
26
|
+
"test:unit": "bun test src/__tests__/",
|
|
27
|
+
"lint": "bunx @biomejs/biome check --write --unsafe .",
|
|
28
|
+
"lint:check": "bunx @biomejs/biome check .",
|
|
29
|
+
"format": "bunx @biomejs/biome format --write .",
|
|
30
|
+
"format:check": "bunx @biomejs/biome format ."
|
|
31
|
+
},
|
|
32
|
+
"keywords": [
|
|
33
|
+
"elizaos",
|
|
34
|
+
"plugin",
|
|
35
|
+
"tunnel",
|
|
36
|
+
"tailscale",
|
|
37
|
+
"networking"
|
|
38
|
+
],
|
|
39
|
+
"peerDependencies": {
|
|
40
|
+
"@elizaos/core": "2.0.0-beta.1"
|
|
41
|
+
},
|
|
42
|
+
"dependencies": {
|
|
43
|
+
"@elizaos/core": "2.0.0-beta.1",
|
|
44
|
+
"zod": "^4.4.2"
|
|
45
|
+
},
|
|
46
|
+
"devDependencies": {
|
|
47
|
+
"@biomejs/biome": "^2.4.14",
|
|
48
|
+
"@types/bun": "^1.3.8",
|
|
49
|
+
"@types/node": "^25.1.0",
|
|
50
|
+
"typescript": "^6.0.3"
|
|
51
|
+
},
|
|
52
|
+
"publishConfig": {
|
|
53
|
+
"access": "public"
|
|
54
|
+
},
|
|
55
|
+
"agentConfig": {
|
|
56
|
+
"pluginType": "elizaos:plugin:1.0.0",
|
|
57
|
+
"pluginParameters": {}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { IAgentRuntime, TestCase, TestSuite } from '@elizaos/core';
|
|
2
|
+
import { tunnelAction } from '../actions/tunnel';
|
|
3
|
+
import { tunnelStateProvider } from '../providers/tunnel-state';
|
|
4
|
+
import { LocalTunnelService } from '../services/LocalTunnelService';
|
|
5
|
+
|
|
6
|
+
export class TunnelTestSuite implements TestSuite {
|
|
7
|
+
name = 'tunnel';
|
|
8
|
+
tests: TestCase[] = [
|
|
9
|
+
{
|
|
10
|
+
name: 'LocalTunnelService — service-type contract',
|
|
11
|
+
fn: (_runtime: IAgentRuntime) => {
|
|
12
|
+
if (LocalTunnelService.serviceType !== 'tunnel') {
|
|
13
|
+
throw new Error('LocalTunnelService.serviceType must be "tunnel"');
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
name: 'tunnelAction — name and op enum',
|
|
19
|
+
fn: (_runtime: IAgentRuntime) => {
|
|
20
|
+
if (tunnelAction.name !== 'TUNNEL') {
|
|
21
|
+
throw new Error(`tunnelAction.name must be "TUNNEL", got ${tunnelAction.name}`);
|
|
22
|
+
}
|
|
23
|
+
const opParam = tunnelAction.parameters?.find((p) => p.name === 'op');
|
|
24
|
+
if (!opParam) throw new Error('tunnelAction must declare an `op` parameter');
|
|
25
|
+
const enumVals = (opParam.schema as { enum?: unknown[] } | undefined)?.enum;
|
|
26
|
+
if (!Array.isArray(enumVals)) throw new Error('op parameter must declare a string enum');
|
|
27
|
+
for (const expected of ['start', 'stop', 'status']) {
|
|
28
|
+
if (!enumVals.includes(expected)) {
|
|
29
|
+
throw new Error(`op enum missing "${expected}"`);
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
name: 'TUNNEL_STATE provider — name and shape',
|
|
36
|
+
fn: (_runtime: IAgentRuntime) => {
|
|
37
|
+
if (tunnelStateProvider.name !== 'TUNNEL_STATE') {
|
|
38
|
+
throw new Error(`tunnelStateProvider.name must be "TUNNEL_STATE"`);
|
|
39
|
+
}
|
|
40
|
+
if (typeof tunnelStateProvider.get !== 'function') {
|
|
41
|
+
throw new Error('tunnelStateProvider must define get()');
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
},
|
|
45
|
+
];
|
|
46
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
import { tunnelAction } from '../../actions/tunnel';
|
|
3
|
+
import { tunnelStateProvider } from '../../providers/tunnel-state';
|
|
4
|
+
import { LocalTunnelService } from '../../services/LocalTunnelService';
|
|
5
|
+
|
|
6
|
+
describe('plugin-tunnel exports', () => {
|
|
7
|
+
it('LocalTunnelService registers under serviceType="tunnel"', () => {
|
|
8
|
+
expect(LocalTunnelService.serviceType).toBe('tunnel');
|
|
9
|
+
});
|
|
10
|
+
|
|
11
|
+
it('TUNNEL action exposes start/stop/status enum and similes', () => {
|
|
12
|
+
expect(tunnelAction.name).toBe('TUNNEL');
|
|
13
|
+
const opParam = tunnelAction.parameters?.find((p) => p.name === 'action');
|
|
14
|
+
expect(opParam).toBeDefined();
|
|
15
|
+
expect((opParam?.schema as { enum?: string[] }).enum).toEqual(['start', 'stop', 'status']);
|
|
16
|
+
expect(tunnelAction.similes).toEqual(expect.arrayContaining(['TAILSCALE', 'START_TUNNEL']));
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
it('TUNNEL_STATE provider has get() and is named correctly', () => {
|
|
20
|
+
expect(tunnelStateProvider.name).toBe('TUNNEL_STATE');
|
|
21
|
+
expect(typeof tunnelStateProvider.get).toBe('function');
|
|
22
|
+
});
|
|
23
|
+
});
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import {
|
|
2
|
+
type ActionResult,
|
|
3
|
+
elizaLogger,
|
|
4
|
+
type HandlerCallback,
|
|
5
|
+
type IAgentRuntime,
|
|
6
|
+
type Memory,
|
|
7
|
+
type State,
|
|
8
|
+
} from '@elizaos/core';
|
|
9
|
+
import { getTunnelService } from '../types';
|
|
10
|
+
|
|
11
|
+
function formatUptime(startedAt: Date): string {
|
|
12
|
+
const ms = Date.now() - startedAt.getTime();
|
|
13
|
+
const minutes = Math.floor(ms / 60_000);
|
|
14
|
+
const hours = Math.floor(minutes / 60);
|
|
15
|
+
if (hours > 0) {
|
|
16
|
+
return `${hours} hour${hours === 1 ? '' : 's'}, ${minutes % 60} minute${minutes % 60 === 1 ? '' : 's'}`;
|
|
17
|
+
}
|
|
18
|
+
return `${minutes} minute${minutes === 1 ? '' : 's'}`;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export async function handleGetTunnelStatus(
|
|
22
|
+
runtime: IAgentRuntime,
|
|
23
|
+
_message?: Memory,
|
|
24
|
+
_state?: State,
|
|
25
|
+
_options?: Record<string, unknown>,
|
|
26
|
+
callback?: HandlerCallback
|
|
27
|
+
): Promise<ActionResult> {
|
|
28
|
+
const tunnelService = getTunnelService(runtime);
|
|
29
|
+
if (!tunnelService) {
|
|
30
|
+
if (callback) {
|
|
31
|
+
await callback({ text: 'Tunnel service is not available.' });
|
|
32
|
+
}
|
|
33
|
+
return { success: false, error: 'tunnel service unavailable' };
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
elizaLogger.info('[get-tunnel-status] reading status');
|
|
37
|
+
const status = tunnelService.getStatus();
|
|
38
|
+
const uptime = status.startedAt ? formatUptime(status.startedAt) : 'N/A';
|
|
39
|
+
|
|
40
|
+
const responseText = status.active
|
|
41
|
+
? `✅ tunnel active (${status.provider}).\n\nURL: ${status.url}\nLocal port: ${status.port}\nUptime: ${uptime}`
|
|
42
|
+
: '❌ No active tunnel. Say "start tunnel on port [PORT]" to start one.';
|
|
43
|
+
|
|
44
|
+
if (callback) {
|
|
45
|
+
await callback({ text: responseText });
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
success: true,
|
|
49
|
+
text: responseText,
|
|
50
|
+
data: {
|
|
51
|
+
action: 'tunnel_status',
|
|
52
|
+
active: status.active,
|
|
53
|
+
url: status.url ?? '',
|
|
54
|
+
port: status.port ?? 0,
|
|
55
|
+
provider: status.provider,
|
|
56
|
+
backend: status.backend ?? '',
|
|
57
|
+
uptime,
|
|
58
|
+
},
|
|
59
|
+
};
|
|
60
|
+
}
|