@nextclaw/extension-sdk 0.2.1 → 0.2.3
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/dist/services/extension-client.service.d.ts +1 -1
- package/dist/services/extension-client.service.d.ts.map +1 -1
- package/dist/services/extension-client.service.js +7 -7
- package/dist/services/extension-client.service.js.map +1 -1
- package/dist/services/extension-transport.service.js +10 -5
- package/dist/services/extension-transport.service.js.map +1 -1
- package/dist/types/extension-sdk.types.d.ts +4 -1
- package/dist/types/extension-sdk.types.d.ts.map +1 -1
- package/package.json +5 -3
|
@@ -8,7 +8,7 @@ declare class NextClawExtension {
|
|
|
8
8
|
readonly capabilities: ExtensionCapabilities;
|
|
9
9
|
readonly extensionId: string;
|
|
10
10
|
private readonly transport;
|
|
11
|
-
private
|
|
11
|
+
private eventStreamSubscription;
|
|
12
12
|
constructor(options?: NextClawExtensionOptions);
|
|
13
13
|
readonly close: () => void;
|
|
14
14
|
readonly onRequest: (handler: ExtensionRequestHandler) => (() => void);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"extension-client.service.d.ts","names":[],"sources":["../../src/services/extension-client.service.ts"],"mappings":";;;;cA6Ia,iBAAA;EAAA,SACF,QAAA,EAAU,QAAA;EAAA,SACV,QAAA,EAAU,iBAAA;EAAA,SACV,YAAA,EAAc,qBAAA;EAAA,SACd,WAAA;EAAA,iBACQ,SAAA;EAAA,QACT,
|
|
1
|
+
{"version":3,"file":"extension-client.service.d.ts","names":[],"sources":["../../src/services/extension-client.service.ts"],"mappings":";;;;cA6Ia,iBAAA;EAAA,SACF,QAAA,EAAU,QAAA;EAAA,SACV,QAAA,EAAU,iBAAA;EAAA,SACV,YAAA,EAAc,qBAAA;EAAA,SACd,WAAA;EAAA,iBACQ,SAAA;EAAA,QACT,uBAAA;cAEI,OAAA,GAAS,wBAAA;EAAA,SAyBZ,KAAA;EAAA,SAKA,SAAA,GAAa,OAAA,EAAS,uBAAA;EAAA,iBAYd,kBAAA;AAAA"}
|
|
@@ -82,19 +82,19 @@ var NextClawExtension = class {
|
|
|
82
82
|
capabilities;
|
|
83
83
|
extensionId;
|
|
84
84
|
transport;
|
|
85
|
-
|
|
85
|
+
eventStreamSubscription = null;
|
|
86
86
|
constructor(options = {}) {
|
|
87
87
|
this.transport = new ExtensionTransportService(options);
|
|
88
88
|
this.extensionId = this.transport.extensionId;
|
|
89
89
|
this.eventBus = new EventBus({
|
|
90
90
|
onFirstSubscriber: () => {
|
|
91
|
-
this.
|
|
91
|
+
this.eventStreamSubscription ??= this.transport.subscribe((event) => {
|
|
92
92
|
this.eventBus.emitEnvelope(this.toEventBusEnvelope(event));
|
|
93
93
|
});
|
|
94
94
|
},
|
|
95
95
|
onNoSubscribers: () => {
|
|
96
|
-
this.
|
|
97
|
-
this.
|
|
96
|
+
this.eventStreamSubscription?.close();
|
|
97
|
+
this.eventStreamSubscription = null;
|
|
98
98
|
}
|
|
99
99
|
});
|
|
100
100
|
this.channels = new ExtensionChannelRegistry({
|
|
@@ -108,8 +108,8 @@ var NextClawExtension = class {
|
|
|
108
108
|
});
|
|
109
109
|
}
|
|
110
110
|
close = () => {
|
|
111
|
-
this.
|
|
112
|
-
this.
|
|
111
|
+
this.eventStreamSubscription?.close();
|
|
112
|
+
this.eventStreamSubscription = null;
|
|
113
113
|
};
|
|
114
114
|
onRequest = (handler) => this.eventBus.subscribeAll((event) => {
|
|
115
115
|
if (event.type !== "extension.request") return;
|
|
@@ -120,7 +120,7 @@ var NextClawExtension = class {
|
|
|
120
120
|
toEventBusEnvelope = (event) => ({
|
|
121
121
|
...event,
|
|
122
122
|
emittedAt: event.emittedAt ?? (/* @__PURE__ */ new Date()).toISOString(),
|
|
123
|
-
source: event.source ?? "
|
|
123
|
+
source: event.source ?? "event-stream"
|
|
124
124
|
});
|
|
125
125
|
};
|
|
126
126
|
//#endregion
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"extension-client.service.js","names":[],"sources":["../../src/services/extension-client.service.ts"],"sourcesContent":["import { EventBus } from \"@nextclaw/shared\";\nimport type {\n ExtensionCapabilities,\n ExtensionCapabilityHandler,\n ExtensionChannels,\n ExtensionRequest,\n ExtensionRequestHandler,\n ExtensionTransportEnvelope,\n NextClawExtensionOptions,\n} from \"../types/extension-sdk.types.js\";\nimport { ExtensionChannelService } from \"./extension-channel.service.js\";\nimport { ExtensionTransportService } from \"./extension-transport.service.js\";\n\nclass ExtensionChannelRegistry implements ExtensionChannels {\n private readonly channels = new Map<string, ExtensionChannelService>();\n\n constructor(\n private readonly params: {\n eventBus: EventBus;\n transport: ExtensionTransportService;\n },\n ) {}\n\n readonly use = (channelId: string): ExtensionChannelService => {\n const normalizedChannelId = channelId.trim();\n if (!normalizedChannelId) {\n throw new Error(\"channelId is required.\");\n }\n const existing = this.channels.get(normalizedChannelId);\n if (existing) {\n return existing;\n }\n const channel = new ExtensionChannelService({\n channelId: normalizedChannelId,\n eventBus: this.params.eventBus,\n transport: this.params.transport,\n });\n this.channels.set(normalizedChannelId, channel);\n return channel;\n };\n}\n\nfunction readRequest(payload: unknown): ExtensionRequest | null {\n if (!payload || typeof payload !== \"object\" || Array.isArray(payload)) {\n return null;\n }\n const record = payload as Record<string, unknown>;\n if (\n typeof record.requestId !== \"string\" ||\n typeof record.extensionId !== \"string\" ||\n typeof record.kind !== \"string\"\n ) {\n return null;\n }\n return {\n requestId: record.requestId,\n extensionId: record.extensionId,\n kind: record.kind,\n payload: record.payload && typeof record.payload === \"object\" && !Array.isArray(record.payload)\n ? record.payload as Record<string, unknown>\n : {},\n };\n}\n\nfunction normalizeName(value: string, name: string): string {\n const normalized = value.trim();\n if (!normalized) {\n throw new Error(`${name} is required.`);\n }\n return normalized;\n}\n\nasync function handleRequest(\n transport: ExtensionTransportService,\n request: ExtensionRequest,\n handler: ExtensionRequestHandler,\n): Promise<void> {\n try {\n const data = await handler(request);\n await transport.respondToRequest({\n requestId: request.requestId,\n ok: true,\n data,\n });\n } catch (error) {\n await transport.respondToRequest({\n requestId: request.requestId,\n ok: false,\n error: {\n message: error instanceof Error ? error.message : String(error),\n },\n });\n }\n}\n\nclass ExtensionCapabilityRegistry implements ExtensionCapabilities {\n constructor(\n private readonly params: {\n eventBus: EventBus;\n extensionId: string;\n transport: ExtensionTransportService;\n },\n ) {}\n\n readonly provide = (namespace: string, capability: object): (() => void) => {\n const normalizedNamespace = normalizeName(namespace, \"namespace\");\n const unsubscribeHandlers = this.readHandlers(capability).map(([name, handler]) =>\n this.provideHandler(`${normalizedNamespace}.${name}`, handler),\n );\n if (unsubscribeHandlers.length === 0) {\n throw new Error(`capability '${normalizedNamespace}' has no callable methods.`);\n }\n return () => {\n for (const unsubscribe of unsubscribeHandlers) {\n unsubscribe();\n }\n };\n };\n\n readonly provideHandler = (kind: string, handler: ExtensionCapabilityHandler): (() => void) => {\n const normalizedKind = normalizeName(kind, \"kind\");\n return this.params.eventBus.subscribeAll((event) => {\n if (event.type !== \"extension.request\") {\n return;\n }\n const request = readRequest(event.payload);\n if (!request || request.extensionId !== this.params.extensionId || request.kind !== normalizedKind) {\n return;\n }\n void handleRequest(this.params.transport, request, async (matchedRequest) =>\n await handler(matchedRequest.payload ?? {}, matchedRequest),\n );\n });\n };\n\n private readonly readHandlers = (capability: object): Array<[string, ExtensionCapabilityHandler]> =>\n Object.entries(capability).filter(\n (entry): entry is [string, ExtensionCapabilityHandler] => typeof entry[1] === \"function\",\n );\n}\n\nexport class NextClawExtension {\n readonly eventBus: EventBus;\n readonly channels: ExtensionChannels;\n readonly capabilities: ExtensionCapabilities;\n readonly extensionId: string;\n private readonly transport: ExtensionTransportService;\n private
|
|
1
|
+
{"version":3,"file":"extension-client.service.js","names":[],"sources":["../../src/services/extension-client.service.ts"],"sourcesContent":["import { EventBus } from \"@nextclaw/shared\";\nimport type {\n ExtensionCapabilities,\n ExtensionCapabilityHandler,\n ExtensionChannels,\n ExtensionRequest,\n ExtensionRequestHandler,\n ExtensionTransportEnvelope,\n NextClawExtensionOptions,\n} from \"../types/extension-sdk.types.js\";\nimport { ExtensionChannelService } from \"./extension-channel.service.js\";\nimport { ExtensionTransportService } from \"./extension-transport.service.js\";\n\nclass ExtensionChannelRegistry implements ExtensionChannels {\n private readonly channels = new Map<string, ExtensionChannelService>();\n\n constructor(\n private readonly params: {\n eventBus: EventBus;\n transport: ExtensionTransportService;\n },\n ) {}\n\n readonly use = (channelId: string): ExtensionChannelService => {\n const normalizedChannelId = channelId.trim();\n if (!normalizedChannelId) {\n throw new Error(\"channelId is required.\");\n }\n const existing = this.channels.get(normalizedChannelId);\n if (existing) {\n return existing;\n }\n const channel = new ExtensionChannelService({\n channelId: normalizedChannelId,\n eventBus: this.params.eventBus,\n transport: this.params.transport,\n });\n this.channels.set(normalizedChannelId, channel);\n return channel;\n };\n}\n\nfunction readRequest(payload: unknown): ExtensionRequest | null {\n if (!payload || typeof payload !== \"object\" || Array.isArray(payload)) {\n return null;\n }\n const record = payload as Record<string, unknown>;\n if (\n typeof record.requestId !== \"string\" ||\n typeof record.extensionId !== \"string\" ||\n typeof record.kind !== \"string\"\n ) {\n return null;\n }\n return {\n requestId: record.requestId,\n extensionId: record.extensionId,\n kind: record.kind,\n payload: record.payload && typeof record.payload === \"object\" && !Array.isArray(record.payload)\n ? record.payload as Record<string, unknown>\n : {},\n };\n}\n\nfunction normalizeName(value: string, name: string): string {\n const normalized = value.trim();\n if (!normalized) {\n throw new Error(`${name} is required.`);\n }\n return normalized;\n}\n\nasync function handleRequest(\n transport: ExtensionTransportService,\n request: ExtensionRequest,\n handler: ExtensionRequestHandler,\n): Promise<void> {\n try {\n const data = await handler(request);\n await transport.respondToRequest({\n requestId: request.requestId,\n ok: true,\n data,\n });\n } catch (error) {\n await transport.respondToRequest({\n requestId: request.requestId,\n ok: false,\n error: {\n message: error instanceof Error ? error.message : String(error),\n },\n });\n }\n}\n\nclass ExtensionCapabilityRegistry implements ExtensionCapabilities {\n constructor(\n private readonly params: {\n eventBus: EventBus;\n extensionId: string;\n transport: ExtensionTransportService;\n },\n ) {}\n\n readonly provide = (namespace: string, capability: object): (() => void) => {\n const normalizedNamespace = normalizeName(namespace, \"namespace\");\n const unsubscribeHandlers = this.readHandlers(capability).map(([name, handler]) =>\n this.provideHandler(`${normalizedNamespace}.${name}`, handler),\n );\n if (unsubscribeHandlers.length === 0) {\n throw new Error(`capability '${normalizedNamespace}' has no callable methods.`);\n }\n return () => {\n for (const unsubscribe of unsubscribeHandlers) {\n unsubscribe();\n }\n };\n };\n\n readonly provideHandler = (kind: string, handler: ExtensionCapabilityHandler): (() => void) => {\n const normalizedKind = normalizeName(kind, \"kind\");\n return this.params.eventBus.subscribeAll((event) => {\n if (event.type !== \"extension.request\") {\n return;\n }\n const request = readRequest(event.payload);\n if (!request || request.extensionId !== this.params.extensionId || request.kind !== normalizedKind) {\n return;\n }\n void handleRequest(this.params.transport, request, async (matchedRequest) =>\n await handler(matchedRequest.payload ?? {}, matchedRequest),\n );\n });\n };\n\n private readonly readHandlers = (capability: object): Array<[string, ExtensionCapabilityHandler]> =>\n Object.entries(capability).filter(\n (entry): entry is [string, ExtensionCapabilityHandler] => typeof entry[1] === \"function\",\n );\n}\n\nexport class NextClawExtension {\n readonly eventBus: EventBus;\n readonly channels: ExtensionChannels;\n readonly capabilities: ExtensionCapabilities;\n readonly extensionId: string;\n private readonly transport: ExtensionTransportService;\n private eventStreamSubscription: { close: () => void } | null = null;\n\n constructor(options: NextClawExtensionOptions = {}) {\n this.transport = new ExtensionTransportService(options);\n this.extensionId = this.transport.extensionId;\n this.eventBus = new EventBus({\n onFirstSubscriber: () => {\n this.eventStreamSubscription ??= this.transport.subscribe((event) => {\n this.eventBus.emitEnvelope(this.toEventBusEnvelope(event));\n });\n },\n onNoSubscribers: () => {\n this.eventStreamSubscription?.close();\n this.eventStreamSubscription = null;\n },\n });\n this.channels = new ExtensionChannelRegistry({\n eventBus: this.eventBus,\n transport: this.transport,\n });\n this.capabilities = new ExtensionCapabilityRegistry({\n eventBus: this.eventBus,\n extensionId: this.extensionId,\n transport: this.transport,\n });\n }\n\n readonly close = (): void => {\n this.eventStreamSubscription?.close();\n this.eventStreamSubscription = null;\n };\n\n readonly onRequest = (handler: ExtensionRequestHandler): (() => void) =>\n this.eventBus.subscribeAll((event) => {\n if (event.type !== \"extension.request\") {\n return;\n }\n const request = readRequest(event.payload);\n if (!request || request.extensionId !== this.extensionId) {\n return;\n }\n void handleRequest(this.transport, request, handler);\n });\n\n private readonly toEventBusEnvelope = (event: ExtensionTransportEnvelope): ExtensionTransportEnvelope => ({\n ...event,\n emittedAt: event.emittedAt ?? new Date().toISOString(),\n source: event.source ?? \"event-stream\",\n });\n\n}\n"],"mappings":";;;;AAaA,IAAM,2BAAN,MAA4D;CAC1D,2BAA4B,IAAI,KAAsC;CAEtE,YACE,QAIA;AAJiB,OAAA,SAAA;;CAMnB,OAAgB,cAA+C;EAC7D,MAAM,sBAAsB,UAAU,MAAM;AAC5C,MAAI,CAAC,oBACH,OAAM,IAAI,MAAM,yBAAyB;EAE3C,MAAM,WAAW,KAAK,SAAS,IAAI,oBAAoB;AACvD,MAAI,SACF,QAAO;EAET,MAAM,UAAU,IAAI,wBAAwB;GAC1C,WAAW;GACX,UAAU,KAAK,OAAO;GACtB,WAAW,KAAK,OAAO;GACxB,CAAC;AACF,OAAK,SAAS,IAAI,qBAAqB,QAAQ;AAC/C,SAAO;;;AAIX,SAAS,YAAY,SAA2C;AAC9D,KAAI,CAAC,WAAW,OAAO,YAAY,YAAY,MAAM,QAAQ,QAAQ,CACnE,QAAO;CAET,MAAM,SAAS;AACf,KACE,OAAO,OAAO,cAAc,YAC5B,OAAO,OAAO,gBAAgB,YAC9B,OAAO,OAAO,SAAS,SAEvB,QAAO;AAET,QAAO;EACL,WAAW,OAAO;EAClB,aAAa,OAAO;EACpB,MAAM,OAAO;EACb,SAAS,OAAO,WAAW,OAAO,OAAO,YAAY,YAAY,CAAC,MAAM,QAAQ,OAAO,QAAQ,GAC3F,OAAO,UACP,EAAE;EACP;;AAGH,SAAS,cAAc,OAAe,MAAsB;CAC1D,MAAM,aAAa,MAAM,MAAM;AAC/B,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,GAAG,KAAK,eAAe;AAEzC,QAAO;;AAGT,eAAe,cACb,WACA,SACA,SACe;AACf,KAAI;EACF,MAAM,OAAO,MAAM,QAAQ,QAAQ;AACnC,QAAM,UAAU,iBAAiB;GAC/B,WAAW,QAAQ;GACnB,IAAI;GACJ;GACD,CAAC;UACK,OAAO;AACd,QAAM,UAAU,iBAAiB;GAC/B,WAAW,QAAQ;GACnB,IAAI;GACJ,OAAO,EACL,SAAS,iBAAiB,QAAQ,MAAM,UAAU,OAAO,MAAM,EAChE;GACF,CAAC;;;AAIN,IAAM,8BAAN,MAAmE;CACjE,YACE,QAKA;AALiB,OAAA,SAAA;;CAOnB,WAAoB,WAAmB,eAAqC;EAC1E,MAAM,sBAAsB,cAAc,WAAW,YAAY;EACjE,MAAM,sBAAsB,KAAK,aAAa,WAAW,CAAC,KAAK,CAAC,MAAM,aACpE,KAAK,eAAe,GAAG,oBAAoB,GAAG,QAAQ,QAAQ,CAC/D;AACD,MAAI,oBAAoB,WAAW,EACjC,OAAM,IAAI,MAAM,eAAe,oBAAoB,4BAA4B;AAEjF,eAAa;AACX,QAAK,MAAM,eAAe,oBACxB,cAAa;;;CAKnB,kBAA2B,MAAc,YAAsD;EAC7F,MAAM,iBAAiB,cAAc,MAAM,OAAO;AAClD,SAAO,KAAK,OAAO,SAAS,cAAc,UAAU;AAClD,OAAI,MAAM,SAAS,oBACjB;GAEF,MAAM,UAAU,YAAY,MAAM,QAAQ;AAC1C,OAAI,CAAC,WAAW,QAAQ,gBAAgB,KAAK,OAAO,eAAe,QAAQ,SAAS,eAClF;AAEG,iBAAc,KAAK,OAAO,WAAW,SAAS,OAAO,mBACxD,MAAM,QAAQ,eAAe,WAAW,EAAE,EAAE,eAAe,CAC5D;IACD;;CAGJ,gBAAiC,eAC/B,OAAO,QAAQ,WAAW,CAAC,QACxB,UAAyD,OAAO,MAAM,OAAO,WAC/E;;AAGL,IAAa,oBAAb,MAA+B;CAC7B;CACA;CACA;CACA;CACA;CACA,0BAAgE;CAEhE,YAAY,UAAoC,EAAE,EAAE;AAClD,OAAK,YAAY,IAAI,0BAA0B,QAAQ;AACvD,OAAK,cAAc,KAAK,UAAU;AAClC,OAAK,WAAW,IAAI,SAAS;GAC3B,yBAAyB;AACvB,SAAK,4BAA4B,KAAK,UAAU,WAAW,UAAU;AACnE,UAAK,SAAS,aAAa,KAAK,mBAAmB,MAAM,CAAC;MAC1D;;GAEJ,uBAAuB;AACrB,SAAK,yBAAyB,OAAO;AACrC,SAAK,0BAA0B;;GAElC,CAAC;AACF,OAAK,WAAW,IAAI,yBAAyB;GAC3C,UAAU,KAAK;GACf,WAAW,KAAK;GACjB,CAAC;AACF,OAAK,eAAe,IAAI,4BAA4B;GAClD,UAAU,KAAK;GACf,aAAa,KAAK;GAClB,WAAW,KAAK;GACjB,CAAC;;CAGJ,cAA6B;AAC3B,OAAK,yBAAyB,OAAO;AACrC,OAAK,0BAA0B;;CAGjC,aAAsB,YACpB,KAAK,SAAS,cAAc,UAAU;AACpC,MAAI,MAAM,SAAS,oBACjB;EAEF,MAAM,UAAU,YAAY,MAAM,QAAQ;AAC1C,MAAI,CAAC,WAAW,QAAQ,gBAAgB,KAAK,YAC3C;AAEG,gBAAc,KAAK,WAAW,SAAS,QAAQ;GACpD;CAEJ,sBAAuC,WAAmE;EACxG,GAAG;EACH,WAAW,MAAM,8BAAa,IAAI,MAAM,EAAC,aAAa;EACtD,QAAQ,MAAM,UAAU;EACzB"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { normalizeEndpoint, resolveWebSocketUrl } from "../utils/extension-url.utils.js";
|
|
2
2
|
import { getKeyId, ingressKeys } from "@nextclaw/shared";
|
|
3
|
+
import WebSocket from "ws";
|
|
3
4
|
//#region src/services/extension-transport.service.ts
|
|
4
5
|
function readRuntimeEnv() {
|
|
5
6
|
return typeof process === "undefined" ? {} : process.env;
|
|
@@ -48,17 +49,21 @@ var ExtensionTransportService = class {
|
|
|
48
49
|
await this.postIngress(getKeyId(ingressKeys.extension.response), response);
|
|
49
50
|
};
|
|
50
51
|
subscribe = (handler) => {
|
|
51
|
-
const socket = this.createSocket(resolveWebSocketUrl(this.endpoint, "/ws")
|
|
52
|
+
const socket = this.createSocket(resolveWebSocketUrl(this.endpoint, "/ws"), { headers: {
|
|
53
|
+
authorization: `Bearer ${this.token}`,
|
|
54
|
+
"x-nextclaw-extension-id": this.extensionId
|
|
55
|
+
} });
|
|
52
56
|
socket.onmessage = (event) => {
|
|
53
57
|
const envelope = this.parseEnvelope(event.data);
|
|
54
58
|
if (envelope) handler(envelope);
|
|
55
59
|
};
|
|
56
60
|
return { close: () => socket.close() };
|
|
57
61
|
};
|
|
58
|
-
createSocket = (url) => {
|
|
59
|
-
if (this.webSocketFactory) return this.webSocketFactory(url);
|
|
60
|
-
|
|
61
|
-
|
|
62
|
+
createSocket = (url, options) => {
|
|
63
|
+
if (this.webSocketFactory) return this.webSocketFactory(url, options);
|
|
64
|
+
const socket = new WebSocket(url, { headers: options.headers });
|
|
65
|
+
socket.on("error", () => void 0);
|
|
66
|
+
return socket;
|
|
62
67
|
};
|
|
63
68
|
parseEnvelope = (value) => {
|
|
64
69
|
if (typeof value !== "string") return null;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"extension-transport.service.js","names":[],"sources":["../../src/services/extension-transport.service.ts"],"sourcesContent":["import type {\n ExtensionRequestResponse,\n ExtensionTransportEnvelope,\n NextClawExtensionOptions,\n NextClawExtensionWebSocketLike,\n} from \"../types/extension-sdk.types.js\";\nimport { getKeyId, ingressKeys } from \"@nextclaw/shared\";\nimport { normalizeEndpoint, resolveWebSocketUrl } from \"../utils/extension-url.utils.js\";\n\ntype
|
|
1
|
+
{"version":3,"file":"extension-transport.service.js","names":[],"sources":["../../src/services/extension-transport.service.ts"],"sourcesContent":["import type {\n ExtensionRequestResponse,\n ExtensionTransportEnvelope,\n NextClawExtensionOptions,\n NextClawExtensionWebSocketFactoryOptions,\n NextClawExtensionWebSocketLike,\n} from \"../types/extension-sdk.types.js\";\nimport { getKeyId, ingressKeys } from \"@nextclaw/shared\";\nimport { normalizeEndpoint, resolveWebSocketUrl } from \"../utils/extension-url.utils.js\";\nimport WebSocket from \"ws\";\n\ntype EventStreamHandler = (event: ExtensionTransportEnvelope) => void;\n\ntype RuntimeEnv = {\n NEXTCLAW_EXTENSION_ENDPOINT?: string;\n NEXTCLAW_EXTENSION_TOKEN?: string;\n NEXTCLAW_EXTENSION_ID?: string;\n};\n\ndeclare const process: { env: RuntimeEnv } | undefined;\n\nfunction readRuntimeEnv(): RuntimeEnv {\n return typeof process === \"undefined\" ? {} : process.env;\n}\n\nfunction requireRuntimeValue(value: string | undefined, name: string): string {\n const trimmed = value?.trim();\n if (!trimmed) {\n throw new Error(`${name} is required.`);\n }\n return trimmed;\n}\n\nexport class ExtensionTransportService {\n readonly token: string;\n readonly extensionId: string;\n private readonly endpoint: string;\n private readonly fetchImpl: typeof fetch;\n private readonly webSocketFactory?: (\n url: string,\n options?: NextClawExtensionWebSocketFactoryOptions,\n ) => NextClawExtensionWebSocketLike;\n\n constructor(options: NextClawExtensionOptions = {}) {\n const env = readRuntimeEnv();\n this.endpoint = normalizeEndpoint(\n options.endpoint ?? requireRuntimeValue(env.NEXTCLAW_EXTENSION_ENDPOINT, \"NEXTCLAW_EXTENSION_ENDPOINT\"),\n );\n this.token = options.token ?? requireRuntimeValue(env.NEXTCLAW_EXTENSION_TOKEN, \"NEXTCLAW_EXTENSION_TOKEN\");\n this.extensionId =\n options.extensionId ?? requireRuntimeValue(env.NEXTCLAW_EXTENSION_ID, \"NEXTCLAW_EXTENSION_ID\");\n this.fetchImpl = options.fetch ?? globalThis.fetch;\n this.webSocketFactory = options.webSocketFactory;\n if (typeof this.fetchImpl !== \"function\") {\n throw new Error(\"fetch is unavailable. Provide fetch when creating the extension.\");\n }\n }\n\n readonly postIngress = async <TResponse = unknown>(\n type: string,\n payload: unknown,\n ): Promise<TResponse> => {\n const envelope: ExtensionTransportEnvelope = {\n type,\n extensionId: this.extensionId,\n payload,\n emittedAt: new Date().toISOString(),\n source: \"extension-sdk\",\n };\n const response = await this.fetchImpl(`${this.endpoint}/webhook`, {\n method: \"POST\",\n headers: {\n \"content-type\": \"application/json\",\n authorization: `Bearer ${this.token}`,\n },\n body: JSON.stringify(envelope),\n });\n const body = (await response.json().catch(() => null)) as unknown;\n if (!response.ok) {\n throw new Error(this.readErrorMessage(body, `NextClaw ingress failed with ${response.status}`));\n }\n return this.readResponseData<TResponse>(body);\n };\n\n readonly respondToRequest = async (response: ExtensionRequestResponse): Promise<void> => {\n await this.postIngress(getKeyId(ingressKeys.extension.response), response);\n };\n\n readonly subscribe = (handler: EventStreamHandler): { close: () => void } => {\n const socket = this.createSocket(resolveWebSocketUrl(this.endpoint, \"/ws\"), {\n headers: {\n authorization: `Bearer ${this.token}`,\n \"x-nextclaw-extension-id\": this.extensionId,\n },\n });\n socket.onmessage = (event) => {\n const envelope = this.parseEnvelope(event.data);\n if (envelope) {\n handler(envelope);\n }\n };\n return {\n close: () => socket.close(),\n };\n };\n\n private readonly createSocket = (\n url: string,\n options: NextClawExtensionWebSocketFactoryOptions,\n ): NextClawExtensionWebSocketLike => {\n if (this.webSocketFactory) {\n return this.webSocketFactory(url, options);\n }\n const socket = new WebSocket(url, { headers: options.headers });\n socket.on(\"error\", () => undefined);\n return socket as unknown as NextClawExtensionWebSocketLike;\n };\n\n private readonly parseEnvelope = (value: unknown): ExtensionTransportEnvelope | null => {\n if (typeof value !== \"string\") {\n return null;\n }\n try {\n const parsed = JSON.parse(value) as ExtensionTransportEnvelope;\n return parsed && typeof parsed === \"object\" && typeof parsed.type === \"string\" ? parsed : null;\n } catch {\n return null;\n }\n };\n\n private readonly readErrorMessage = (body: unknown, fallback: string): string => {\n if (!body || typeof body !== \"object\") {\n return fallback;\n }\n const error = (body as { error?: { message?: unknown } }).error;\n return typeof error?.message === \"string\" && error.message.trim() ? error.message : fallback;\n };\n\n private readonly readResponseData = <TResponse>(body: unknown): TResponse => {\n if (body && typeof body === \"object\" && !Array.isArray(body)) {\n const record = body as { ok?: unknown; data?: unknown };\n if (record.ok === true && \"data\" in record) {\n return record.data as TResponse;\n }\n }\n return body as TResponse;\n };\n}\n"],"mappings":";;;;AAqBA,SAAS,iBAA6B;AACpC,QAAO,OAAO,YAAY,cAAc,EAAE,GAAG,QAAQ;;AAGvD,SAAS,oBAAoB,OAA2B,MAAsB;CAC5E,MAAM,UAAU,OAAO,MAAM;AAC7B,KAAI,CAAC,QACH,OAAM,IAAI,MAAM,GAAG,KAAK,eAAe;AAEzC,QAAO;;AAGT,IAAa,4BAAb,MAAuC;CACrC;CACA;CACA;CACA;CACA;CAKA,YAAY,UAAoC,EAAE,EAAE;EAClD,MAAM,MAAM,gBAAgB;AAC5B,OAAK,WAAW,kBACd,QAAQ,YAAY,oBAAoB,IAAI,6BAA6B,8BAA8B,CACxG;AACD,OAAK,QAAQ,QAAQ,SAAS,oBAAoB,IAAI,0BAA0B,2BAA2B;AAC3G,OAAK,cACH,QAAQ,eAAe,oBAAoB,IAAI,uBAAuB,wBAAwB;AAChG,OAAK,YAAY,QAAQ,SAAS,WAAW;AAC7C,OAAK,mBAAmB,QAAQ;AAChC,MAAI,OAAO,KAAK,cAAc,WAC5B,OAAM,IAAI,MAAM,mEAAmE;;CAIvF,cAAuB,OACrB,MACA,YACuB;EACvB,MAAM,WAAuC;GAC3C;GACA,aAAa,KAAK;GAClB;GACA,4BAAW,IAAI,MAAM,EAAC,aAAa;GACnC,QAAQ;GACT;EACD,MAAM,WAAW,MAAM,KAAK,UAAU,GAAG,KAAK,SAAS,WAAW;GAChE,QAAQ;GACR,SAAS;IACP,gBAAgB;IAChB,eAAe,UAAU,KAAK;IAC/B;GACD,MAAM,KAAK,UAAU,SAAS;GAC/B,CAAC;EACF,MAAM,OAAQ,MAAM,SAAS,MAAM,CAAC,YAAY,KAAK;AACrD,MAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MAAM,KAAK,iBAAiB,MAAM,gCAAgC,SAAS,SAAS,CAAC;AAEjG,SAAO,KAAK,iBAA4B,KAAK;;CAG/C,mBAA4B,OAAO,aAAsD;AACvF,QAAM,KAAK,YAAY,SAAS,YAAY,UAAU,SAAS,EAAE,SAAS;;CAG5E,aAAsB,YAAuD;EAC3E,MAAM,SAAS,KAAK,aAAa,oBAAoB,KAAK,UAAU,MAAM,EAAE,EAC1E,SAAS;GACP,eAAe,UAAU,KAAK;GAC9B,2BAA2B,KAAK;GACjC,EACF,CAAC;AACF,SAAO,aAAa,UAAU;GAC5B,MAAM,WAAW,KAAK,cAAc,MAAM,KAAK;AAC/C,OAAI,SACF,SAAQ,SAAS;;AAGrB,SAAO,EACL,aAAa,OAAO,OAAO,EAC5B;;CAGH,gBACE,KACA,YACmC;AACnC,MAAI,KAAK,iBACP,QAAO,KAAK,iBAAiB,KAAK,QAAQ;EAE5C,MAAM,SAAS,IAAI,UAAU,KAAK,EAAE,SAAS,QAAQ,SAAS,CAAC;AAC/D,SAAO,GAAG,eAAe,KAAA,EAAU;AACnC,SAAO;;CAGT,iBAAkC,UAAsD;AACtF,MAAI,OAAO,UAAU,SACnB,QAAO;AAET,MAAI;GACF,MAAM,SAAS,KAAK,MAAM,MAAM;AAChC,UAAO,UAAU,OAAO,WAAW,YAAY,OAAO,OAAO,SAAS,WAAW,SAAS;UACpF;AACN,UAAO;;;CAIX,oBAAqC,MAAe,aAA6B;AAC/E,MAAI,CAAC,QAAQ,OAAO,SAAS,SAC3B,QAAO;EAET,MAAM,QAAS,KAA2C;AAC1D,SAAO,OAAO,OAAO,YAAY,YAAY,MAAM,QAAQ,MAAM,GAAG,MAAM,UAAU;;CAGtF,oBAAgD,SAA6B;AAC3E,MAAI,QAAQ,OAAO,SAAS,YAAY,CAAC,MAAM,QAAQ,KAAK,EAAE;GAC5D,MAAM,SAAS;AACf,OAAI,OAAO,OAAO,QAAQ,UAAU,OAClC,QAAO,OAAO;;AAGlB,SAAO"}
|
|
@@ -7,7 +7,10 @@ type NextClawExtensionOptions = {
|
|
|
7
7
|
token?: string;
|
|
8
8
|
extensionId?: string;
|
|
9
9
|
fetch?: typeof fetch;
|
|
10
|
-
webSocketFactory?: (url: string) => NextClawExtensionWebSocketLike;
|
|
10
|
+
webSocketFactory?: (url: string, options?: NextClawExtensionWebSocketFactoryOptions) => NextClawExtensionWebSocketLike;
|
|
11
|
+
};
|
|
12
|
+
type NextClawExtensionWebSocketFactoryOptions = {
|
|
13
|
+
headers?: Record<string, string>;
|
|
11
14
|
};
|
|
12
15
|
type NextClawExtensionWebSocketLike = {
|
|
13
16
|
onopen: (() => void) | null;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"extension-sdk.types.d.ts","names":[],"sources":["../../src/types/extension-sdk.types.ts"],"mappings":";;;;KAyBY,wBAAA;EACV,QAAA;EACA,KAAA;EACA,WAAA;EACA,KAAA,UAAe,KAAA;EACf,gBAAA,
|
|
1
|
+
{"version":3,"file":"extension-sdk.types.d.ts","names":[],"sources":["../../src/types/extension-sdk.types.ts"],"mappings":";;;;KAyBY,wBAAA;EACV,QAAA;EACA,KAAA;EACA,WAAA;EACA,KAAA,UAAe,KAAA;EACf,gBAAA,IACE,GAAA,UACA,OAAA,GAAU,wCAAA,KACP,8BAAA;AAAA;AAAA,KAGK,wCAAA;EACV,OAAA,GAAU,MAAA;AAAA;AAAA,KAGA,8BAAA;EACV,MAAA;EACA,SAAA,IAAa,KAAA;IAAS,IAAA;EAAA;EACtB,OAAA,IAAW,KAAA;EACX,OAAA;EACA,KAAA;AAAA;AAAA,KAGU,0BAAA;EACV,IAAA;EACA,WAAA;EACA,OAAA,EAAS,QAAA;EACT,SAAA;EACA,MAAA;AAAA;AAAA,KAGU,gBAAA;EACV,SAAA;EACA,WAAA;EACA,IAAA;EACA,OAAA,GAAU,MAAA;AAAA;AAAA,KAGA,wBAAA;EACV,MAAA,EAAQ,OAAA;AAAA;AAAA,KAGE,sBAAA;EACV,GAAA,2BAA8B,OAAA,CAAQ,OAAA;EACtC,QAAA,sBACE,OAAA,GAAU,MAAA,EAAQ,OAAA,YAAmB,OAAA,WAClC,WAAA;AAAA;AAAA,KAGK,wBAAA;EACV,IAAA,QAAY,OAAA,CAAQ,2BAAA;EACpB,OAAA,GAAU,KAAA;IACR,WAAA;IACA,IAAA,GAAO,MAAA;IACP,cAAA;IACA,QAAA;IACA,QAAA,GAAW,MAAA;EAAA,MACP,OAAA,CAAQ,sCAAA;EACd,WAAA,GAAc,KAAA;IACZ,OAAA;IACA,cAAA;IACA,QAAA;IACA,QAAA,GAAW,MAAA;EAAA,MACP,OAAA,CAAQ,sCAAA;AAAA;AAAA,KAGJ,gBAAA;EACV,EAAA;EACA,aAAA,GAAgB,KAAA,EAAO,IAAA,CAAK,2CAAA,mBAA8D,OAAA;EAC1F,UAAA,GAAa,OAAA,GAAU,KAAA,EAAO,gBAAA,YAA4B,OAAA,WAAkB,WAAA;EAC5E,MAAA,EAAQ,sBAAA;EACR,QAAA,EAAU,wBAAA;AAAA;AAAA,KAGA,iBAAA;EACV,GAAA,GAAM,SAAA,aAAsB,gBAAA;AAAA;AAAA,KAGlB,uBAAA,IAA2B,OAAA,EAAS,gBAAA,eAA+B,OAAA;AAAA,KAEnE,0BAAA,GAA6B,MAAA;AAAA,KAE7B,0BAAA,kBAA4C,0BAAA,GAA6B,0BAAA,KACnF,OAAA,EAAS,QAAA,EACT,OAAA,EAAS,gBAAA,eACI,OAAA;AAAA,KAEH,qBAAA;EACV,OAAA,GAAU,SAAA,UAAmB,UAAA,aAAuB,WAAA;EACpD,cAAA,GAAiB,IAAA,UAAc,OAAA,EAAS,0BAAA,KAA+B,WAAA;AAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nextclaw/extension-sdk",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.3",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Backend SDK for NextClaw extension server processes.",
|
|
6
6
|
"type": "module",
|
|
@@ -35,11 +35,13 @@
|
|
|
35
35
|
"README.md"
|
|
36
36
|
],
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"
|
|
39
|
-
"@nextclaw/
|
|
38
|
+
"ws": "^8.18.0",
|
|
39
|
+
"@nextclaw/ncp": "0.5.22",
|
|
40
|
+
"@nextclaw/shared": "0.2.2"
|
|
40
41
|
},
|
|
41
42
|
"devDependencies": {
|
|
42
43
|
"@types/node": "^20.17.6",
|
|
44
|
+
"@types/ws": "^8.5.14",
|
|
43
45
|
"typescript": "^5.6.3",
|
|
44
46
|
"vitest": "^4.1.2"
|
|
45
47
|
},
|