handoff-relay 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 +21 -0
- package/README.md +434 -0
- package/dist/api/server.d.ts +16 -0
- package/dist/api/server.js +2578 -0
- package/dist/cli.d.ts +17 -0
- package/dist/cli.js +5502 -0
- package/dist/client-CjWEJ02H.d.ts +144 -0
- package/dist/index.d.ts +74 -0
- package/dist/index.js +2623 -0
- package/dist/mcp/server.d.ts +84 -0
- package/dist/mcp/server.js +2950 -0
- package/dist/relay-service-BjF5HNvN.d.ts +712 -0
- package/docs/advanced-manual-setup.md +196 -0
- package/docs/claude-code-setup.md +143 -0
- package/docs/codex-setup.md +135 -0
- package/docs/demo-video-script.md +49 -0
- package/docs/generic-mcp-setup.md +163 -0
- package/docs/launch-copy.md +70 -0
- package/docs/local-self-hosting.md +170 -0
- package/docs/packet-schema.md +116 -0
- package/docs/security-privacy.md +90 -0
- package/docs/troubleshooting.md +180 -0
- package/examples/hydration-receipts/reply-hydration.json +14 -0
- package/examples/packets/ask.json +73 -0
- package/examples/packets/reply.json +62 -0
- package/examples/packets/share.json +52 -0
- package/fixtures/clarification.json +7 -0
- package/fixtures/declined-packet.json +6 -0
- package/fixtures/normal-ask.json +72 -0
- package/fixtures/normal-share.json +51 -0
- package/fixtures/revoked-member.json +7 -0
- package/fixtures/secret-redaction.json +10 -0
- package/fixtures/stale-handoff.json +16 -0
- package/fixtures/superseded-packet.json +6 -0
- package/package.json +103 -0
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
2
|
+
import { z } from 'zod';
|
|
3
|
+
import { R as RelayApiClient } from '../client-CjWEJ02H.js';
|
|
4
|
+
import { R as RelayService } from '../relay-service-BjF5HNvN.js';
|
|
5
|
+
import 'better-sqlite3';
|
|
6
|
+
|
|
7
|
+
type HandoffServerMode = 'lan' | 'local' | 'remote';
|
|
8
|
+
type HandoffMemberRole = 'admin' | 'member';
|
|
9
|
+
interface HandoffProfile {
|
|
10
|
+
schemaVersion: 1;
|
|
11
|
+
profileName: string;
|
|
12
|
+
workspaceId: string;
|
|
13
|
+
workspaceName: string;
|
|
14
|
+
memberId: string;
|
|
15
|
+
handle: string;
|
|
16
|
+
displayName: string;
|
|
17
|
+
role: HandoffMemberRole;
|
|
18
|
+
serverUrl: string;
|
|
19
|
+
publicInviteBaseUrl?: string;
|
|
20
|
+
localDatabasePath?: string;
|
|
21
|
+
serverMode: HandoffServerMode;
|
|
22
|
+
createdAt: string;
|
|
23
|
+
lastVerifiedAt?: string;
|
|
24
|
+
}
|
|
25
|
+
interface HandoffCredentials {
|
|
26
|
+
memberToken: string;
|
|
27
|
+
approvalSecret: string;
|
|
28
|
+
createdAt: string;
|
|
29
|
+
lastRotationAt?: string;
|
|
30
|
+
}
|
|
31
|
+
interface HandoffEnv {
|
|
32
|
+
[key: string]: string | undefined;
|
|
33
|
+
}
|
|
34
|
+
interface ActiveProfileInput {
|
|
35
|
+
env?: HandoffEnv;
|
|
36
|
+
profileName?: string;
|
|
37
|
+
}
|
|
38
|
+
declare class ProfileStore {
|
|
39
|
+
readonly home: string;
|
|
40
|
+
constructor(home: string);
|
|
41
|
+
ensureHome(): void;
|
|
42
|
+
profilePath(profileName: string): string;
|
|
43
|
+
credentialPath(profileName: string): string;
|
|
44
|
+
localDatabasePath(profileName: string): string;
|
|
45
|
+
loadProfile(profileName: string): HandoffProfile | undefined;
|
|
46
|
+
loadActiveProfile(input?: ActiveProfileInput): HandoffProfile | undefined;
|
|
47
|
+
saveProfile(profile: HandoffProfile): void;
|
|
48
|
+
loadCredentials(profileName: string): HandoffCredentials;
|
|
49
|
+
saveCredentials(profileName: string, credentials: HandoffCredentials): void;
|
|
50
|
+
credentialsExist(profileName: string): boolean;
|
|
51
|
+
credentialPermissions(profileName: string): number | undefined;
|
|
52
|
+
credentialsAreRestrictive(profileName: string): boolean;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
interface McpToolDefinition {
|
|
56
|
+
name: string;
|
|
57
|
+
description: string;
|
|
58
|
+
inputSchema: Record<string, z.ZodTypeAny>;
|
|
59
|
+
handler: (args: any) => any | Promise<any>;
|
|
60
|
+
}
|
|
61
|
+
type RelayBackend = RelayService | RelayApiClient;
|
|
62
|
+
interface McpAuthContext {
|
|
63
|
+
approvalSecret?: string;
|
|
64
|
+
authToken: string;
|
|
65
|
+
workspaceId: string;
|
|
66
|
+
}
|
|
67
|
+
interface McpDefinitionOptions {
|
|
68
|
+
agentApprovals?: boolean;
|
|
69
|
+
authContext?: McpAuthContext;
|
|
70
|
+
explicitAuth?: boolean;
|
|
71
|
+
profileName?: string;
|
|
72
|
+
profileStore?: ProfileStore;
|
|
73
|
+
}
|
|
74
|
+
declare function getMcpToolDefinitions(service: RelayBackend, options?: McpDefinitionOptions): McpToolDefinition[];
|
|
75
|
+
declare function createMcpServer(service: RelayBackend, options?: McpDefinitionOptions): McpServer;
|
|
76
|
+
declare function startMcpServer(input: {
|
|
77
|
+
agentApprovals?: boolean;
|
|
78
|
+
dbPath: string;
|
|
79
|
+
explicitAuth?: boolean;
|
|
80
|
+
profileName?: string;
|
|
81
|
+
serverUrl?: string;
|
|
82
|
+
}): Promise<void>;
|
|
83
|
+
|
|
84
|
+
export { type McpAuthContext, type McpDefinitionOptions, type McpToolDefinition, createMcpServer, getMcpToolDefinitions, startMcpServer };
|