feat(companion): support default canvas session in platform clients

src/companion/index.ts

@@ -44,6 +44,9 @@ export type {
   SharedStatusInput,
   HeartbeatStatusInput,
   PlatformBootstrapResult,
+  PlatformPutCanvasArtifactInput,
+  PlatformGetCanvasArtifactInput,
+  PlatformDeleteCanvasArtifactInput,
 } from './platformClients.js';
 export type {
   HeartbeatPublisher,

src/companion/platformClients.integration.test.ts

@@ -196,15 +196,17 @@ describe('platform clients integration', () => {
     }
 
     const runtime = createRuntime();
-    const client = new MacOSCompanionClient({ runtime, nodeId: 'macos-canvas-e2e' });
+    const client = new MacOSCompanionClient({
+      runtime,
+      nodeId: 'macos-canvas-e2e',
+      defaultSessionId: 'ws:platform-canvas-e2e',
+    });
     await client.connect();
 
     try {
       await client.register();
 
-      const sessionId = 'ws:platform-canvas-e2e';
       const put = await client.putCanvasArtifact({
-        sessionId,
         artifactId: 'mac-art-1',
         type: 'note',
         content: { text: 'hello from platform wrapper' },
@@ -212,16 +214,16 @@ describe('platform clients integration', () => {
       expect(put.upserted).toBe(true);
       expect(put.artifact.id).toBe('mac-art-1');
 
-      const list = await client.listCanvasArtifacts(sessionId);
+      const list = await client.listCanvasArtifacts();
       expect(list.artifacts.some((artifact) => artifact.id === 'mac-art-1')).toBe(true);
 
-      const get = await client.getCanvasArtifact({ sessionId, artifactId: 'mac-art-1' });
+      const get = await client.getCanvasArtifact({ artifactId: 'mac-art-1' });
       expect(get.artifact.id).toBe('mac-art-1');
 
-      const del = await client.deleteCanvasArtifact({ sessionId, artifactId: 'mac-art-1' });
+      const del = await client.deleteCanvasArtifact({ artifactId: 'mac-art-1' });
       expect(del.deleted).toBe(true);
 
-      const clear = await client.clearCanvasArtifacts(sessionId);
+      const clear = await client.clearCanvasArtifacts();
       expect(clear.cleared).toBe(0);
     } finally {
       client.disconnect();

src/companion/platformClients.test.ts

@@ -183,4 +183,44 @@ describe('platform companion clients', () => {
       }),
     );
   });
+
+  it('uses defaultSessionId for canvas operations when sessionId is omitted', async () => {
+    const mock = createRuntimeMock();
+    const client = new IOSCompanionClient({
+      runtime: mock.runtime,
+      nodeId: 'ios-node',
+      defaultSessionId: 'ws:default-canvas',
+    });
+
+    await client.putCanvasArtifact({
+      type: 'markdown',
+      content: { body: 'default session' },
+    });
+    await client.listCanvasArtifacts();
+    await client.getCanvasArtifact({ artifactId: 'a1' });
+    await client.deleteCanvasArtifact({ artifactId: 'a1' });
+    await client.clearCanvasArtifacts();
+
+    expect(mock.putCanvasArtifact).toHaveBeenCalledWith({
+      sessionId: 'ws:default-canvas',
+      type: 'markdown',
+      content: { body: 'default session' },
+      artifactId: undefined,
+      title: undefined,
+      metadata: undefined,
+    });
+    expect(mock.listCanvasArtifacts).toHaveBeenCalledWith('ws:default-canvas');
+    expect(mock.getCanvasArtifact).toHaveBeenCalledWith({ sessionId: 'ws:default-canvas', artifactId: 'a1' });
+    expect(mock.deleteCanvasArtifact).toHaveBeenCalledWith({ sessionId: 'ws:default-canvas', artifactId: 'a1' });
+    expect(mock.clearCanvasArtifacts).toHaveBeenCalledWith('ws:default-canvas');
+  });
+
+  it('throws when canvas sessionId is missing and no defaultSessionId is configured', async () => {
+    const mock = createRuntimeMock();
+    const client = new MacOSCompanionClient({ runtime: mock.runtime, nodeId: 'mac-node' });
+
+    expect(() => client.listCanvasArtifacts()).toThrow(
+      'sessionId is required (provide one or configure defaultSessionId)',
+    );
+  });
 });

src/companion/platformClients.ts

@@ -25,6 +25,7 @@ export interface PlatformClientOptions {
   role?: string;
   capabilities?: string[];
   protocolVersion?: number;
+  defaultSessionId?: string;
 }
 
 export interface RegisterPushTokenInput {
@@ -51,12 +52,25 @@ export interface PlatformBootstrapResult {
   capabilities: NodeCapabilitiesResult;
 }
 
+export interface PlatformPutCanvasArtifactInput extends Omit<PutCanvasArtifactInput, 'sessionId'> {
+  sessionId?: string;
+}
+
+export interface PlatformGetCanvasArtifactInput extends Omit<GetCanvasArtifactInput, 'sessionId'> {
+  sessionId?: string;
+}
+
+export interface PlatformDeleteCanvasArtifactInput extends Omit<DeleteCanvasArtifactInput, 'sessionId'> {
+  sessionId?: string;
+}
+
 export class MacOSCompanionClient {
   private readonly runtime: CompanionRuntimeClient;
   private readonly nodeId: string;
   private readonly role: string;
   private readonly capabilities: string[];
   private readonly protocolVersion?: number;
+  private readonly defaultSessionId?: string;
 
   constructor(options: PlatformClientOptions) {
     this.runtime = options.runtime;
@@ -64,6 +78,7 @@ export class MacOSCompanionClient {
     this.role = options.role ?? 'companion';
     this.capabilities = options.capabilities ?? ['ui.canvas', 'node.location.write', 'node.push.register'];
     this.protocolVersion = options.protocolVersion;
+    this.defaultSessionId = options.defaultSessionId;
   }
 
   connect(): Promise<void> {
@@ -139,24 +154,45 @@ export class MacOSCompanionClient {
     return this.runtime.listSystemNodes({ platform: 'macos', role: this.role });
   }
 
-  putCanvasArtifact(input: PutCanvasArtifactInput): Promise<CanvasPutResult> {
-    return this.runtime.putCanvasArtifact(input);
+  putCanvasArtifact(input: PlatformPutCanvasArtifactInput): Promise<CanvasPutResult> {
+    return this.runtime.putCanvasArtifact({
+      sessionId: this.resolveSessionId(input.sessionId),
+      artifactId: input.artifactId,
+      type: input.type,
+      title: input.title,
+      content: input.content,
+      metadata: input.metadata,
+    });
   }
 
-  getCanvasArtifact(input: GetCanvasArtifactInput): Promise<CanvasGetResult> {
-    return this.runtime.getCanvasArtifact(input);
+  getCanvasArtifact(input: PlatformGetCanvasArtifactInput): Promise<CanvasGetResult> {
+    return this.runtime.getCanvasArtifact({
+      sessionId: this.resolveSessionId(input.sessionId),
+      artifactId: input.artifactId,
+    });
   }
 
-  listCanvasArtifacts(sessionId: string): Promise<CanvasListResult> {
-    return this.runtime.listCanvasArtifacts(sessionId);
+  listCanvasArtifacts(sessionId?: string): Promise<CanvasListResult> {
+    return this.runtime.listCanvasArtifacts(this.resolveSessionId(sessionId));
   }
 
-  deleteCanvasArtifact(input: DeleteCanvasArtifactInput): Promise<CanvasDeleteResult> {
-    return this.runtime.deleteCanvasArtifact(input);
+  deleteCanvasArtifact(input: PlatformDeleteCanvasArtifactInput): Promise<CanvasDeleteResult> {
+    return this.runtime.deleteCanvasArtifact({
+      sessionId: this.resolveSessionId(input.sessionId),
+      artifactId: input.artifactId,
+    });
   }
 
-  clearCanvasArtifacts(sessionId: string): Promise<CanvasClearResult> {
-    return this.runtime.clearCanvasArtifacts(sessionId);
+  clearCanvasArtifacts(sessionId?: string): Promise<CanvasClearResult> {
+    return this.runtime.clearCanvasArtifacts(this.resolveSessionId(sessionId));
+  }
+
+  private resolveSessionId(sessionId?: string): string {
+    const resolved = sessionId ?? this.defaultSessionId;
+    if (!resolved) {
+      throw new Error('sessionId is required (provide one or configure defaultSessionId)');
+    }
+    return resolved;
   }
 }
 
@@ -166,6 +202,7 @@ export class IOSCompanionClient {
   private readonly role: string;
   private readonly capabilities: string[];
   private readonly protocolVersion?: number;
+  private readonly defaultSessionId?: string;
 
   constructor(options: PlatformClientOptions) {
     this.runtime = options.runtime;
@@ -173,6 +210,7 @@ export class IOSCompanionClient {
     this.role = options.role ?? 'companion';
     this.capabilities = options.capabilities ?? ['node.location.write', 'node.push.register'];
     this.protocolVersion = options.protocolVersion;
+    this.defaultSessionId = options.defaultSessionId;
   }
 
   connect(): Promise<void> {
@@ -248,24 +286,45 @@ export class IOSCompanionClient {
     return this.runtime.listSystemNodes({ platform: 'ios', role: this.role });
   }
 
-  putCanvasArtifact(input: PutCanvasArtifactInput): Promise<CanvasPutResult> {
-    return this.runtime.putCanvasArtifact(input);
+  putCanvasArtifact(input: PlatformPutCanvasArtifactInput): Promise<CanvasPutResult> {
+    return this.runtime.putCanvasArtifact({
+      sessionId: this.resolveSessionId(input.sessionId),
+      artifactId: input.artifactId,
+      type: input.type,
+      title: input.title,
+      content: input.content,
+      metadata: input.metadata,
+    });
   }
 
-  getCanvasArtifact(input: GetCanvasArtifactInput): Promise<CanvasGetResult> {
-    return this.runtime.getCanvasArtifact(input);
+  getCanvasArtifact(input: PlatformGetCanvasArtifactInput): Promise<CanvasGetResult> {
+    return this.runtime.getCanvasArtifact({
+      sessionId: this.resolveSessionId(input.sessionId),
+      artifactId: input.artifactId,
+    });
   }
 
-  listCanvasArtifacts(sessionId: string): Promise<CanvasListResult> {
-    return this.runtime.listCanvasArtifacts(sessionId);
+  listCanvasArtifacts(sessionId?: string): Promise<CanvasListResult> {
+    return this.runtime.listCanvasArtifacts(this.resolveSessionId(sessionId));
   }
 
-  deleteCanvasArtifact(input: DeleteCanvasArtifactInput): Promise<CanvasDeleteResult> {
-    return this.runtime.deleteCanvasArtifact(input);
+  deleteCanvasArtifact(input: PlatformDeleteCanvasArtifactInput): Promise<CanvasDeleteResult> {
+    return this.runtime.deleteCanvasArtifact({
+      sessionId: this.resolveSessionId(input.sessionId),
+      artifactId: input.artifactId,
+    });
   }
 
-  clearCanvasArtifacts(sessionId: string): Promise<CanvasClearResult> {
-    return this.runtime.clearCanvasArtifacts(sessionId);
+  clearCanvasArtifacts(sessionId?: string): Promise<CanvasClearResult> {
+    return this.runtime.clearCanvasArtifacts(this.resolveSessionId(sessionId));
+  }
+
+  private resolveSessionId(sessionId?: string): string {
+    const resolved = sessionId ?? this.defaultSessionId;
+    if (!resolved) {
+      throw new Error('sessionId is required (provide one or configure defaultSessionId)');
+    }
+    return resolved;
   }
 }
 
@@ -275,6 +334,7 @@ export class AndroidCompanionClient {
   private readonly role: string;
   private readonly capabilities: string[];
   private readonly protocolVersion?: number;
+  private readonly defaultSessionId?: string;
 
   constructor(options: PlatformClientOptions) {
     this.runtime = options.runtime;
@@ -282,6 +342,7 @@ export class AndroidCompanionClient {
     this.role = options.role ?? 'companion';
     this.capabilities = options.capabilities ?? ['node.location.write', 'node.push.register'];
     this.protocolVersion = options.protocolVersion;
+    this.defaultSessionId = options.defaultSessionId;
   }
 
   connect(): Promise<void> {
@@ -355,23 +416,44 @@ export class AndroidCompanionClient {
     return this.runtime.listSystemNodes({ platform: 'android', role: this.role });
   }
 
-  putCanvasArtifact(input: PutCanvasArtifactInput): Promise<CanvasPutResult> {
-    return this.runtime.putCanvasArtifact(input);
+  putCanvasArtifact(input: PlatformPutCanvasArtifactInput): Promise<CanvasPutResult> {
+    return this.runtime.putCanvasArtifact({
+      sessionId: this.resolveSessionId(input.sessionId),
+      artifactId: input.artifactId,
+      type: input.type,
+      title: input.title,
+      content: input.content,
+      metadata: input.metadata,
+    });
   }
 
-  getCanvasArtifact(input: GetCanvasArtifactInput): Promise<CanvasGetResult> {
-    return this.runtime.getCanvasArtifact(input);
+  getCanvasArtifact(input: PlatformGetCanvasArtifactInput): Promise<CanvasGetResult> {
+    return this.runtime.getCanvasArtifact({
+      sessionId: this.resolveSessionId(input.sessionId),
+      artifactId: input.artifactId,
+    });
   }
 
-  listCanvasArtifacts(sessionId: string): Promise<CanvasListResult> {
-    return this.runtime.listCanvasArtifacts(sessionId);
+  listCanvasArtifacts(sessionId?: string): Promise<CanvasListResult> {
+    return this.runtime.listCanvasArtifacts(this.resolveSessionId(sessionId));
   }
 
-  deleteCanvasArtifact(input: DeleteCanvasArtifactInput): Promise<CanvasDeleteResult> {
-    return this.runtime.deleteCanvasArtifact(input);
+  deleteCanvasArtifact(input: PlatformDeleteCanvasArtifactInput): Promise<CanvasDeleteResult> {
+    return this.runtime.deleteCanvasArtifact({
+      sessionId: this.resolveSessionId(input.sessionId),
+      artifactId: input.artifactId,
+    });
   }
 
-  clearCanvasArtifacts(sessionId: string): Promise<CanvasClearResult> {
-    return this.runtime.clearCanvasArtifacts(sessionId);
+  clearCanvasArtifacts(sessionId?: string): Promise<CanvasClearResult> {
+    return this.runtime.clearCanvasArtifacts(this.resolveSessionId(sessionId));
+  }
+
+  private resolveSessionId(sessionId?: string): string {
+    const resolved = sessionId ?? this.defaultSessionId;
+    if (!resolved) {
+      throw new Error('sessionId is required (provide one or configure defaultSessionId)');
+    }
+    return resolved;
   }
 }