@dxos/plugin-transcription 0.8.3 → 0.8.4-main.1c7ec43d41

package/src/transcriber/transcription-manager.ts

@@ -2,14 +2,14 @@
 // Copyright 2025 DXOS.org
 //
 
-import { signal } from '@preact/signals-core';
+import { Atom, type Registry } from '@effect-atom/atom-react';
 
 import { synchronized } from '@dxos/async';
 import { Resource } from '@dxos/context';
 import { Obj } from '@dxos/echo';
 import { type Queue } from '@dxos/echo-db';
 import { type EdgeHttpClient } from '@dxos/react-edge-client';
-import { DataType } from '@dxos/schema';
+import { type ContentBlock, Message } from '@dxos/types';
 
 import { MediaStreamRecorder } from './media-stream-recorder';
 import { Transcriber } from './transcriber';
@@ -30,10 +30,11 @@ const PREFIXED_CHUNKS_AMOUNT = 10;
  */
 const TRANSCRIBE_AFTER_CHUNKS_AMOUNT = 50;
 
-export type TranscriptMessageEnricher = (message: DataType.Message) => Promise<DataType.Message>;
+export type TranscriptMessageEnricher = (message: Message.Message) => Promise<Message.Message>;
 
 export type TranscriptionManagerOptions = {
   edgeClient: EdgeHttpClient;
+  registry: Registry.Registry;
 
   /**
    * Enrich the message before it is written to the transcription queue.
@@ -47,25 +48,30 @@ export type TranscriptionManagerOptions = {
 export class TranscriptionManager extends Resource {
   private readonly _edgeClient: EdgeHttpClient;
   private readonly _messageEnricher?: TranscriptMessageEnricher;
+  private readonly _registry: Registry.Registry;
   private _audioStreamTrack?: MediaStreamTrack = undefined;
   private _identityDid?: string = undefined;
   private _mediaRecorder?: MediaStreamRecorder = undefined;
   private _transcriber?: Transcriber = undefined;
-  private _queue?: Queue<DataType.Message> = undefined;
-  private _enabled = signal(false);
+  private _queue?: Queue<Message.Message> = undefined;
+  private _enabledAtom = Atom.make(false);
 
   constructor(options: TranscriptionManagerOptions) {
     super();
     this._edgeClient = options.edgeClient;
     this._messageEnricher = options.messageEnricher;
+    this._registry = options.registry;
   }
 
-  /** @reactive */
-  get enabled() {
-    return this._enabled.value;
+  get enabled(): Atom.Atom<boolean> {
+    return this._enabledAtom;
   }
 
-  setQueue(queue: Queue<DataType.Message>): this {
+  getEnabled(): boolean {
+    return this._registry.get(this._enabledAtom);
+  }
+
+  setQueue(queue: Queue<Message.Message>): this {
     this._queue = queue;
     return this;
   }
@@ -78,7 +84,7 @@ export class TranscriptionManager extends Resource {
   }
 
   setRecording(recording?: boolean): this {
-    if (!this.isOpen || !this._enabled.value) {
+    if (!this.isOpen || !this.getEnabled()) {
       return this;
     }
 
@@ -90,19 +96,17 @@ export class TranscriptionManager extends Resource {
     return this;
   }
 
-  /**
-   * Enable or disable transcription.
-   * @param enabled - Whether to enable transcription.
-   */
-  @synchronized
-  async setEnabled(enabled?: boolean): Promise<void> {
-    if (this._enabled.value === enabled) {
+  async setEnabled(enabled: boolean): Promise<void> {
+    if (this.getEnabled() === enabled) {
       return;
     }
 
-    this._enabled.value = enabled ?? false;
-    // TODO(burdon): Why is toggle called here?
-    this.isOpen && (await this._toggleTranscriber());
+    this._registry.set(this._enabledAtom, enabled ?? false);
+    if (enabled) {
+      await this._maybeRestartTranscriber();
+    } else {
+      await this._stopTranscriber();
+    }
   }
 
   @synchronized
@@ -112,44 +116,19 @@ export class TranscriptionManager extends Resource {
     }
 
     this._audioStreamTrack = track;
-    this.isOpen && (await this._toggleTranscriber());
+    await this._maybeRestartTranscriber();
   }
 
   protected override async _open(): Promise<void> {
-    await this._toggleTranscriber();
+    await this._maybeRestartTranscriber();
   }
 
   protected override async _close(): Promise<void> {
-    void this._transcriber?.close();
-  }
-
-  // TODO(burdon): Change this to setEnables (explicit), not toggle.
-  private async _toggleTranscriber(): Promise<void> {
-    await this._maybeReinitTranscriber();
-
-    // Open or close transcriber if transcription is enabled or disabled.
-    if (this._enabled.value) {
-      await this._transcriber?.open();
-      // TODO(burdon): Started and stopped blocks appear twice.
-      const block = Obj.make(DataType.Message, {
-        created: new Date().toISOString(),
-        blocks: [{ type: 'transcription', text: 'Started', started: new Date().toISOString() }],
-        sender: { role: 'assistant' },
-      });
-      await this._queue?.append([block]);
-    } else {
-      await this._transcriber?.close();
-      const block = Obj.make(DataType.Message, {
-        created: new Date().toISOString(),
-        blocks: [{ type: 'transcription', text: 'Stopped', started: new Date().toISOString() }],
-        sender: { role: 'assistant' },
-      });
-      await this._queue?.append([block]);
-    }
+    await this._stopTranscriber();
   }
 
-  private async _maybeReinitTranscriber(): Promise<void> {
-    if (!this._audioStreamTrack || !this._enabled.value) {
+  private async _maybeRestartTranscriber(): Promise<void> {
+    if (!this._audioStreamTrack || !this.getEnabled() || !this.isOpen) {
       return;
     }
 
@@ -172,15 +151,21 @@ export class TranscriptionManager extends Resource {
         recorder: this._mediaRecorder,
         onSegments: (segments) => this._onSegments(segments),
       });
+
+      await this._transcriber?.open();
     }
   }
 
-  private async _onSegments(segments: DataType.MessageBlock.Transcription[]): Promise<void> {
+  private async _stopTranscriber(): Promise<void> {
+    await this._transcriber?.close();
+  }
+
+  private async _onSegments(segments: ContentBlock.Transcript[]): Promise<void> {
     if (!this.isOpen || !this._queue) {
       return;
     }
 
-    let block = Obj.make(DataType.Message, {
+    let block = Obj.make(Message.Message, {
       created: new Date().toISOString(),
       blocks: segments,
       sender: { identityDid: this._identityDid },

package/src/translations.ts

@@ -2,21 +2,23 @@
 // Copyright 2023 DXOS.org
 //
 
-import { TRANSCRIPTION_PLUGIN } from './meta';
+import { type Resource } from '@dxos/react-ui';
 
-export default [
+import { meta } from '#meta';
+
+export const translations = [
   {
     'en-US': {
-      [TRANSCRIPTION_PLUGIN]: {
-        'plugin name': 'Transcription',
-        'transcript companion label': 'Transcript',
+      [meta.id]: {
+        'plugin.name': 'Transcription',
+        'transcript-companion.label': 'Transcript',
 
-        'delete button': 'Delete',
-        'bookmark button': 'Bookmark',
-        'scroll to end label': 'Scroll to latest',
+        'delete.button': 'Delete',
+        'bookmark.button': 'Bookmark',
+        'scroll-to-end.label': 'Scroll to latest',
 
-        'settings entity extraction label': 'Entity extraction',
+        'settings.entity-extraction.label': 'Entity extraction',
       },
     },
   },
-];
+] as const satisfies Resource[];

package/src/types/capabilities.ts

@@ -0,0 +1,39 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Capability } from '@dxos/app-framework';
+
+import { meta } from '#meta';
+
+import {
+  type MediaStreamRecorderProps,
+  type Transcriber,
+  type TranscriberProps,
+  type TranscriptMessageEnricher,
+  type TranscriptionManager,
+} from '../transcriber';
+
+export namespace TranscriptionCapabilities {
+  export type GetTranscriberProps = {
+    audioStreamTrack: MediaStreamTrack;
+    recorderConfig?: Partial<MediaStreamRecorderProps['config']>;
+    transcriberConfig?: Partial<TranscriberProps['config']>;
+    onSegments: TranscriberProps['onSegments'];
+    transcribe?: TranscriberProps['transcribe'];
+  };
+
+  export type GetTranscriber = (props: GetTranscriberProps) => Transcriber;
+
+  export type GetTranscriptionManagerProps = {
+    messageEnricher?: TranscriptMessageEnricher;
+  };
+
+  export type GetTranscriptionManager = (props: GetTranscriptionManagerProps) => TranscriptionManager;
+
+  export const Transcriber = Capability.make<GetTranscriber>(`${meta.id}.capability.transcriber`);
+
+  export const TranscriptionManager = Capability.make<GetTranscriptionManager>(
+    `${meta.id}.capability.transcription-manager`,
+  );
+}

package/src/types/defs.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+/**
+ * Endpoint to the calls service.
+ */
+// TODO(burdon): Reconfigure/move.
+export const TRANSCRIPTION_URL = 'https://calls-service.dxos.workers.dev';

package/src/types/index.ts

@@ -2,5 +2,5 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './schema';
-export * from './types';
+export * from './capabilities';
+export * from './defs';

package/src/util/index.ts

@@ -5,3 +5,4 @@
 export * from './array';
 export * from './get-time-str';
 export * from './monitor-audio-level';
+export * from './render-byline';

package/src/util/render-byline.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Identity } from '@dxos/react-client/halo';
+import { type Message } from '@dxos/types';
+
+// TODO(thure): Move this?
+export const renderByline =
+  (identities: Identity[]) =>
+  (message: Message.Message, index: number, debug = false): string[] => {
+    if (message.sender.role === 'assistant') {
+      // Start/stop block.
+      return [message.blocks.find((block) => block._tag === 'transcript')?.text ?? '', ''];
+    }
+
+    // TODO(burdon): Use link/reference markup for users (with popover).
+    // TODO(burdon): Color and avatar.
+    const identity = identities.find((identity) => identity.did === message.sender.identityDid);
+    const name =
+      identity?.profile?.displayName ??
+      message.sender.contact?.target?.fullName ??
+      message.sender.name ??
+      message.sender.email ??
+      message.sender.identityDid;
+    const blocks = message.blocks.filter((block) => block._tag === 'transcript');
+    return [
+      // TODO(thure): Use an XML tag with the bits needed here.
+      `###### ${name}` + (debug ? ` [${index}]:${message.id}` : ''),
+      blocks.map((block) => block.text.trim()).join(' '),
+      '',
+    ];
+  };

package/dist/lib/browser/TranscriptContainer-H3AZQ4CQ.mjs

@@ -1,11 +0,0 @@
-import {
-  TranscriptContainer_default,
-  TranscriptionContainer
-} from "./chunk-53AXUEIQ.mjs";
-import "./chunk-W2KNYJD6.mjs";
-import "./chunk-GOF7MJNV.mjs";
-export {
-  TranscriptionContainer,
-  TranscriptContainer_default as default
-};
-//# sourceMappingURL=TranscriptContainer-H3AZQ4CQ.mjs.map