@babelforce/babelconnect-sdk 0.1.0 → 0.6.1

package/README.md

@@ -22,7 +22,7 @@ messaging) on top of `babelconnect-server`. Two ways to use it:
 npm install @babelforce/babelconnect-sdk
 ```
 
-ESM-only, targets ES2022. Runs in modern browsers; Node 18+ for control-only (no-audio) use. Native WebRTC
+ESM-only, targets ES2022. Runs in modern browsers; Node 20+ for control-only (no-audio) use. Native WebRTC
 audio requires a browser (microphone permission).
 
 ## Quickstart — programmatic client (with audio)
@@ -90,8 +90,10 @@ bc.session.set({ number: "+49301234567" }); // correlate / prefill
 (`setPresence`, `setDisplayAs`, `setAgentNumber`, `setWebrtc`), and history/contacts fetches (`getHistory`,
 `getSmsThread`, `getPhonebook`).
 
-Full API reference and the embedding guide:
-**[babelconnect-sdk-docs](https://babelforce.github.io/babelconnect-sdk-docs/)**.
+Full docs — API reference, guides, and the embedding guide:
+**[babelconnect SDK docs](https://babelforce.github.io/babelconnect-sdk/)**. Good starting points:
+the **[tutorial](https://babelforce.github.io/babelconnect-sdk/docs/tutorial/first-softphone)** and,
+if you hit a snag, **[troubleshooting](https://babelforce.github.io/babelconnect-sdk/docs/guides/troubleshooting)**.
 
 ## How it works
 

package/dist/client.d.ts

@@ -8,7 +8,7 @@ export interface ConnectOptions {
     token: string;
     /** Per-call WebRTC leg. Defaults to {@link browserMediaFactory}; pass `null` for a control-only client. */
     mediaFactory?: MediaFactory | null;
-    /** Auto-answer the agent's own OUTBOUND ringing leg (default `true`). INBOUND waits for {@link answerCall}. */
+    /** Auto-answer the agent's own OUTBOUND ringing leg (default `true`). INBOUND waits for {@link BabelconnectClient.answerCall}. */
     autoAnswer?: boolean;
     /** Out-of-band server notices (command rejections) + local media failures. */
     onError?: (err: BcError) => void;
@@ -34,7 +34,18 @@ export declare class BabelconnectClient {
     private readonly pending;
     private closed;
     private constructor();
-    /** Open the session and start mirroring server state. */
+    /**
+     * Open the session and start mirroring server state. Returns synchronously and queues intents until the
+     * stream is live, so you can subscribe and register immediately.
+     *
+     * @example
+     * ```ts
+     * const bc = BabelconnectClient.connect({ serverUrl, token });
+     * bc.subscribe(render);          // render(AgentView) on every update
+     * bc.register();                 // announce reachability + load deployment data
+     * bc.placeCall("+15551234567");  // the result arrives as a callUpsert patch
+     * ```
+     */
     static connect(opts: ConnectOptions): BabelconnectClient;
     /** The current view (deep copy). */
     get view(): AgentView;
@@ -42,6 +53,12 @@ export declare class BabelconnectClient {
     subscribe(fn: (v: AgentView) => void): () => void;
     /** The first active call, or undefined. */
     activeCall(): CallState | undefined;
+    /**
+     * Announce the agent and load its deployment data (presence options, caller-ID numbers, phonebook, feature
+     * config) — call this once after {@link BabelconnectClient.subscribe}. It also marks the agent
+     * **WebRTC-reachable** on the backend, so a control-only client that takes calls should follow it with
+     * {@link BabelconnectClient.setWebrtc}(false) + {@link BabelconnectClient.setAgentNumber}.
+     */
     register(capabilities?: string[]): void;
     placeCall(to: string, opts?: {
         displayAsTo?: string;
@@ -51,10 +68,15 @@ export declare class BabelconnectClient {
     }): void;
     /** Manually answer a RINGING call by id (no-op under autoAnswer once already answered). */
     answerCall(callId: string): Promise<void>;
+    /** End (or reject) a call by id. */
     hangup(callId: string): void;
+    /** Mute or unmute the agent's own leg of a call. */
     mute(callId: string, on: boolean): void;
+    /** Put a call on hold or retrieve it. */
     hold(callId: string, on: boolean): void;
+    /** Send DTMF tones into the call (e.g. an IVR menu choice). Valid characters: `0`–`9`, `*`, `#`, `A`–`D`. */
     sendDigits(callId: string, digits: string): void;
+    /** Set the outbound caller ID the consumer sees (choose from `agent.availableNumbers`). */
     setDisplayAs(number: string): void;
     /** Switch presence (the selector): "available" or a configured pause reason (see `AgentInfo.presenceOptions`). */
     setPresence(name: string): void;
@@ -64,24 +86,40 @@ export declare class BabelconnectClient {
         agentId?: string;
         applicationId?: string;
     }): void;
+    /** Open a conference around the current call. `hold` parks that call while you add members and consult. */
     startConference(hold?: boolean): void;
+    /** Invite a participant — pass exactly one of `agentId` or `number`. Starts a conference first if none is active. */
     addConferenceMember(opts: {
         agentId?: string;
         number?: string;
     }): void;
+    /** Remove a member from the conference (moderator only). */
     kickConferenceMember(memberId: string): void;
+    /** Hold or unhold an individual conference member (moderator only). */
     holdConferenceMember(memberId: string, on: boolean): void;
+    /** Mute or unmute an individual conference member (moderator only). */
     muteConferenceMember(memberId: string, on: boolean): void;
+    /** End the whole conference for everyone (moderator only). */
     endConference(): void;
+    /** Drop only the agent's own leg; the other members stay connected. */
     leaveConference(): void;
+    /** Add seconds to the after-call-work countdown (default 30). Show only when `wrapUp.canExtend`. */
     wrapUpExtend(seconds?: number): void;
+    /** End after-call work early. Show only when `wrapUp.canCancel`. */
     wrapUpCancel(): void;
+    /** Clear a blocked line (busy / unreachable / declined) so new calls reach the agent again. */
     resetLineStatus(): void;
+    /** Begin recording the current call. Gated on `agent.canRecord`. */
     startRecording(callId: string): void;
+    /** Stop the call's active recording. */
     stopRecording(callId: string): void;
+    /** Toggle the "flagged" mark on the call's active recording. */
     flagRecording(callId: string): void;
+    /** Replace the tags on the call's active recording (choose from `agent.availableTags`). */
     setRecordingTags(callId: string, tags: string[]): void;
+    /** Turn the in-browser WebRTC phone on or off. With it off, set an agent number so calls bridge there. */
     setWebrtc(on: boolean): void;
+    /** Set the agent's external phone number; the backend bridges calls there when WebRTC is off. */
     setAgentNumber(number: string): void;
     /** Send an SMS. `from` may be empty (server picks the default); `session` carries CTI/embedding correlation. */
     sendSms(to: string, text: string, opts?: {

package/dist/client.js

@@ -28,7 +28,18 @@ export class BabelconnectClient {
         });
         this.rpc = createClient(Agent, transport);
     }
-    /** Open the session and start mirroring server state. */
+    /**
+     * Open the session and start mirroring server state. Returns synchronously and queues intents until the
+     * stream is live, so you can subscribe and register immediately.
+     *
+     * @example
+     * ```ts
+     * const bc = BabelconnectClient.connect({ serverUrl, token });
+     * bc.subscribe(render);          // render(AgentView) on every update
+     * bc.register();                 // announce reachability + load deployment data
+     * bc.placeCall("+15551234567");  // the result arrives as a callUpsert patch
+     * ```
+     */
     static connect(opts) {
         const c = new BabelconnectClient(opts);
         void c.runSubscribe();
@@ -47,6 +58,12 @@ export class BabelconnectClient {
         return this.cache.current.activeCalls[0];
     }
     // --- intents ---
+    /**
+     * Announce the agent and load its deployment data (presence options, caller-ID numbers, phonebook, feature
+     * config) — call this once after {@link BabelconnectClient.subscribe}. It also marks the agent
+     * **WebRTC-reachable** on the backend, so a control-only client that takes calls should follow it with
+     * {@link BabelconnectClient.setWebrtc}(false) + {@link BabelconnectClient.setAgentNumber}.
+     */
     register(capabilities = ["webrtc"]) {
         this.send(new Command({ command: { case: "register", value: new Register({ capabilities }) } }));
     }
@@ -70,18 +87,23 @@ export class BabelconnectClient {
         if (call)
             await this.doAnswer(call);
     }
+    /** End (or reject) a call by id. */
     hangup(callId) {
         this.send(new Command({ command: { case: "hangup", value: new Hangup({ callId }) } }));
     }
+    /** Mute or unmute the agent's own leg of a call. */
     mute(callId, on) {
         this.send(new Command({ command: { case: "mute", value: new Mute({ callId, on }) } }));
     }
+    /** Put a call on hold or retrieve it. */
     hold(callId, on) {
         this.send(new Command({ command: { case: "hold", value: new Hold({ callId, on }) } }));
     }
+    /** Send DTMF tones into the call (e.g. an IVR menu choice). Valid characters: `0`–`9`, `*`, `#`, `A`–`D`. */
     sendDigits(callId, digits) {
         this.send(new Command({ command: { case: "dtmf", value: new SendDigits({ callId, digits }) } }));
     }
+    /** Set the outbound caller ID the consumer sees (choose from `agent.availableNumbers`). */
     setDisplayAs(number) {
         this.send(new Command({ command: { case: "setDisplayAs", value: new SetDisplayAs({ number }) } }));
     }
@@ -105,9 +127,11 @@ export class BabelconnectClient {
         }));
     }
     // --- Conferences ---
+    /** Open a conference around the current call. `hold` parks that call while you add members and consult. */
     startConference(hold = false) {
         this.send(new Command({ command: { case: "startConference", value: new StartConference({ hold }) } }));
     }
+    /** Invite a participant — pass exactly one of `agentId` or `number`. Starts a conference first if none is active. */
     addConferenceMember(opts) {
         this.send(new Command({
             command: {
@@ -116,45 +140,59 @@ export class BabelconnectClient {
             },
         }));
     }
+    /** Remove a member from the conference (moderator only). */
     kickConferenceMember(memberId) {
         this.send(new Command({ command: { case: "kickConferenceMember", value: new KickConferenceMember({ memberId }) } }));
     }
+    /** Hold or unhold an individual conference member (moderator only). */
     holdConferenceMember(memberId, on) {
         this.send(new Command({ command: { case: "holdConferenceMember", value: new HoldConferenceMember({ memberId, on }) } }));
     }
+    /** Mute or unmute an individual conference member (moderator only). */
     muteConferenceMember(memberId, on) {
         this.send(new Command({ command: { case: "muteConferenceMember", value: new MuteConferenceMember({ memberId, on }) } }));
     }
+    /** End the whole conference for everyone (moderator only). */
     endConference() {
         this.send(new Command({ command: { case: "endConference", value: new EndConference({}) } }));
     }
+    /** Drop only the agent's own leg; the other members stay connected. */
     leaveConference() {
         this.send(new Command({ command: { case: "leaveConference", value: new LeaveConference({}) } }));
     }
+    /** Add seconds to the after-call-work countdown (default 30). Show only when `wrapUp.canExtend`. */
     wrapUpExtend(seconds = 30) {
         this.send(new Command({ command: { case: "wrapUpExtend", value: new WrapUpExtend({ seconds }) } }));
     }
+    /** End after-call work early. Show only when `wrapUp.canCancel`. */
     wrapUpCancel() {
         this.send(new Command({ command: { case: "wrapUpCancel", value: new WrapUpCancel({}) } }));
     }
+    /** Clear a blocked line (busy / unreachable / declined) so new calls reach the agent again. */
     resetLineStatus() {
         this.send(new Command({ command: { case: "resetLineStatus", value: new ResetLineStatus({}) } }));
     }
+    /** Begin recording the current call. Gated on `agent.canRecord`. */
     startRecording(callId) {
         this.send(new Command({ command: { case: "startRecording", value: new StartRecording({ callId }) } }));
     }
+    /** Stop the call's active recording. */
     stopRecording(callId) {
         this.send(new Command({ command: { case: "stopRecording", value: new StopRecording({ callId }) } }));
     }
+    /** Toggle the "flagged" mark on the call's active recording. */
     flagRecording(callId) {
         this.send(new Command({ command: { case: "flagRecording", value: new FlagRecording({ callId }) } }));
     }
+    /** Replace the tags on the call's active recording (choose from `agent.availableTags`). */
     setRecordingTags(callId, tags) {
         this.send(new Command({ command: { case: "setRecordingTags", value: new SetRecordingTags({ callId, tags }) } }));
     }
+    /** Turn the in-browser WebRTC phone on or off. With it off, set an agent number so calls bridge there. */
     setWebrtc(on) {
         this.send(new Command({ command: { case: "setWebrtc", value: new SetWebrtc({ on }) } }));
     }
+    /** Set the agent's external phone number; the backend bridges calls there when WebRTC is off. */
     setAgentNumber(number) {
         this.send(new Command({ command: { case: "setAgentNumber", value: new SetAgentNumber({ number }) } }));
     }

package/dist/embed/index.d.ts

@@ -2,7 +2,7 @@
  * `@babelforce/babelconnect-sdk/embed` — embed the babelconnect agent app (the
  * server-served Flutter web app) into a host page via an `<iframe>` and a two-way
  * `postMessage` bridge. See the Embedding guide at
- * https://babelforce.github.io/babelconnect-sdk-docs/ for the full protocol.
+ * https://babelforce.github.io/babelconnect-sdk/ for the full protocol.
  * The embedded app talks only to babelconnect-server.
  *
  * @example

package/dist/embed/index.js

@@ -2,7 +2,7 @@
  * `@babelforce/babelconnect-sdk/embed` — embed the babelconnect agent app (the
  * server-served Flutter web app) into a host page via an `<iframe>` and a two-way
  * `postMessage` bridge. See the Embedding guide at
- * https://babelforce.github.io/babelconnect-sdk-docs/ for the full protocol.
+ * https://babelforce.github.io/babelconnect-sdk/ for the full protocol.
  * The embedded app talks only to babelconnect-server.
  *
  * @example

package/dist/state-cache.d.ts

@@ -1,6 +1,6 @@
 import { AgentView, type StateUpdate } from "./gen/babelconnect/v1/babelconnect_pb.js";
 /**
- * The client-side mirror of the server-authoritative {@link AgentView}.
+ * The client-side mirror of the server-authoritative `AgentView`.
  *
  * It applies `StateUpdate` snapshots and entity-level patches **mechanically** —
  * there is no domain logic here, by design: the server reduces, the client

package/dist/state-cache.js

@@ -1,6 +1,6 @@
 import { AgentView } from "./gen/babelconnect/v1/babelconnect_pb.js";
 /**
- * The client-side mirror of the server-authoritative {@link AgentView}.
+ * The client-side mirror of the server-authoritative `AgentView`.
  *
  * It applies `StateUpdate` snapshots and entity-level patches **mechanically** —
  * there is no domain logic here, by design: the server reduces, the client

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@babelforce/babelconnect-sdk",
-  "version": "0.1.0",
+  "version": "0.6.1",
   "description": "TypeScript SDK for babelconnect — server-authoritative agent state over gRPC-web, native WebRTC audio, and an embeddable widget (iframe + postMessage) for the Flutter web app.",
   "license": "Apache-2.0",
-  "homepage": "https://babelforce.github.io/babelconnect-sdk-docs/",
+  "homepage": "https://babelforce.github.io/babelconnect-sdk/",
   "type": "module",
   "sideEffects": false,
   "files": [
@@ -39,8 +39,8 @@
   "devDependencies": {
     "@bufbuild/protoc-gen-es": "^1.10.1",
     "@connectrpc/protoc-gen-connect-es": "^1.6.1",
-    "typedoc": "^0.27.0",
-    "typedoc-plugin-markdown": "^4.4.0",
+    "typedoc": "~0.27.0",
+    "typedoc-plugin-markdown": "4.4.0",
     "typescript": "^5.6.0"
   },
   "publishConfig": {