@coventia/softphone 0.3.0 → 0.4.0

package/dist/{call-CaPDWVk3.d.cts → call-C6YpT6uR.d.cts}

@@ -240,6 +240,11 @@ interface CallHistoryEntry {
     readonly outcome?: CallOutcome;
     /** The org's own number that was dialled — present only (and only meaningful) for an inbound call. */
     readonly did?: string;
+    /**
+     * The org's own number an outbound call was made from (what the callee saw) — present only for outbound calls the
+     * backend recorded it for (outbound-number-per-agent.md §5.7). Digits, no `+`.
+     */
+    readonly from?: string;
     /** True when Coventia has at least one recording for this call. */
     readonly recorded: boolean;
     /**
@@ -415,6 +420,64 @@ interface RingtoneSource {
      */
     cached?(): Promise<RingtoneSettings | null>;
 }
+/**
+ * What kind of number this is, for the tags next to it in "Llamar desde" (outbound-number-per-agent.md §5.5).
+ * Display only — it never blocks a choice. `mobile` must not be used for customer care or unsolicited commercial
+ * calls; `commercial` (the 400 range) is for outbound commercial calls only and receives no calls.
+ */
+type OutboundNumberKind = 'landline' | 'mobile' | 'commercial' | 'other';
+/** One of the organization's numbers an agent can call from. */
+interface OutboundNumber {
+    /** Stable id — what is stored as the agent's choice. */
+    readonly id: string;
+    /** International format, digits only, no `+` — e.g. `34960000001`. */
+    readonly number: string;
+    /** The name the organization gave the number, or `null`. */
+    readonly label: string | null;
+    readonly kind: OutboundNumberKind;
+}
+/**
+ * Where the agent's extension stands. `pending`/`failed`: an assignment change could not update it yet, so the
+ * extension may still present an earlier number. `unassigned`: the agent has no extension in this organization.
+ */
+type OutboundNumberState = 'applied' | 'pending' | 'failed' | 'unassigned';
+/** The organization's numbers and the caller's choice, as the backend resolves them. */
+interface OutboundNumberSettings {
+    /** The organization's active numbers, ordered by number. */
+    readonly numbers: readonly OutboundNumber[];
+    /** The organization default (an `OutboundNumber.id`), or `null`. */
+    readonly orgDefault: string | null;
+    /** This agent's own choice, or `null` = "use the organization default". */
+    readonly mine: string | null;
+    /** The number this agent's calls show: `mine`, else `orgDefault`. */
+    readonly effective: string | null;
+    /** The agent's extension ("100"), or `null` when they have none. */
+    readonly extension: string | null;
+    readonly state: OutboundNumberState;
+    /** 0 when a change could go out now; otherwise the seconds until it can. */
+    readonly changeAvailableInSeconds: number;
+}
+/**
+ * Why a change was refused before anything was sent. `platform`: the shared limit on number changes (nothing the
+ * agent did). `user`: the agent changed it moments ago. Either way the previous number stays in use.
+ */
+interface OutboundNumberRefusal {
+    readonly reason: 'platform' | 'user';
+    /** Seconds until a change can go out — always at least 1. */
+    readonly retryAfterSeconds: number;
+}
+/** The outbound number of the agent the softphone is signed in as, in its organization. */
+interface OutboundNumbersSource {
+    get(signal?: AbortSignal): Promise<OutboundNumberSettings>;
+    /**
+     * Changes this agent's number; `null` = back to the organization default. Resolves to the new settings once the
+     * change is in effect. When the request limits refuse it, rejects with an `Error` carrying
+     * `refusal: OutboundNumberRefusal` (check with `isOutboundNumberRefused`) — nothing was stored or sent.
+     */
+    setMine(id: string | null): Promise<OutboundNumberSettings>;
+    /** The settings this agent last had on this device, if remembered — instant, no network. Optional. */
+    cached?(): Promise<OutboundNumberSettings | null>;
+}
 
 /**
  * The error taxonomy.
@@ -873,4 +936,4 @@ interface Call extends TypedEmitter<CallEventMap> {
     cancelConsult(): Promise<void>;
 }
 
-export { type AgentsDirectory as A, type PresenceSource as B, CALL_TRANSITIONS as C, type CallHistoryEntry as D, ERROR_CATALOGUE as E, type FatalErrorCode as F, type ContactsPage as G, type HangupReason as H, INITIAL_STATES as I, type LogLevel as L, type NonFatalErrorCode as N, type PresenceEntry as P, type RemoteParty as R, type SoftphoneConfig as S, type TokenEndpointOptions as T, type VoiceToken as V, type Call as a, type CallDirection as b, CallEvent as c, type CallEventMap as d, type CallOptions as e, type CallState as f, type Contact as g, type FatalSoftphoneError as h, type HoldOriginator as i, type NonFatalSoftphoneError as j, type RingtoneOption as k, type RingtoneSettings as l, type RingtoneSource as m, type SoftphoneError as n, type SoftphoneErrorCode as o, SoftphoneEvent as p, type SoftphoneEventMap as q, type SoftphoneState as r, type TokenSource as s, type TypedEmitter as t, canTransition as u, isFatal as v, isTerminal as w, type ContactsSource as x, type HistorySource as y, type TransferOutcomesPage as z };
+export { isFatal as A, isTerminal as B, CALL_TRANSITIONS as C, type ContactsSource as D, ERROR_CATALOGUE as E, type FatalErrorCode as F, type HistorySource as G, type HangupReason as H, INITIAL_STATES as I, type AgentsDirectory as J, type TransferOutcomesPage as K, type LogLevel as L, type PresenceSource as M, type NonFatalErrorCode as N, type OutboundNumberRefusal as O, type PresenceEntry as P, type CallHistoryEntry as Q, type RemoteParty as R, type SoftphoneConfig as S, type TokenEndpointOptions as T, type ContactsPage as U, type VoiceToken as V, type Call as a, type CallDirection as b, CallEvent as c, type CallEventMap as d, type CallOptions as e, type CallState as f, type Contact as g, type FatalSoftphoneError as h, type HoldOriginator as i, type NonFatalSoftphoneError as j, type OutboundNumber as k, type OutboundNumberKind as l, type OutboundNumberSettings as m, type OutboundNumberState as n, type OutboundNumbersSource as o, type RingtoneOption as p, type RingtoneSettings as q, type RingtoneSource as r, type SoftphoneError as s, type SoftphoneErrorCode as t, SoftphoneEvent as u, type SoftphoneEventMap as v, type SoftphoneState as w, type TokenSource as x, type TypedEmitter as y, canTransition as z };

package/dist/{call-CaPDWVk3.d.ts → call-C6YpT6uR.d.ts}

@@ -240,6 +240,11 @@ interface CallHistoryEntry {
     readonly outcome?: CallOutcome;
     /** The org's own number that was dialled — present only (and only meaningful) for an inbound call. */
     readonly did?: string;
+    /**
+     * The org's own number an outbound call was made from (what the callee saw) — present only for outbound calls the
+     * backend recorded it for (outbound-number-per-agent.md §5.7). Digits, no `+`.
+     */
+    readonly from?: string;
     /** True when Coventia has at least one recording for this call. */
     readonly recorded: boolean;
     /**
@@ -415,6 +420,64 @@ interface RingtoneSource {
      */
     cached?(): Promise<RingtoneSettings | null>;
 }
+/**
+ * What kind of number this is, for the tags next to it in "Llamar desde" (outbound-number-per-agent.md §5.5).
+ * Display only — it never blocks a choice. `mobile` must not be used for customer care or unsolicited commercial
+ * calls; `commercial` (the 400 range) is for outbound commercial calls only and receives no calls.
+ */
+type OutboundNumberKind = 'landline' | 'mobile' | 'commercial' | 'other';
+/** One of the organization's numbers an agent can call from. */
+interface OutboundNumber {
+    /** Stable id — what is stored as the agent's choice. */
+    readonly id: string;
+    /** International format, digits only, no `+` — e.g. `34960000001`. */
+    readonly number: string;
+    /** The name the organization gave the number, or `null`. */
+    readonly label: string | null;
+    readonly kind: OutboundNumberKind;
+}
+/**
+ * Where the agent's extension stands. `pending`/`failed`: an assignment change could not update it yet, so the
+ * extension may still present an earlier number. `unassigned`: the agent has no extension in this organization.
+ */
+type OutboundNumberState = 'applied' | 'pending' | 'failed' | 'unassigned';
+/** The organization's numbers and the caller's choice, as the backend resolves them. */
+interface OutboundNumberSettings {
+    /** The organization's active numbers, ordered by number. */
+    readonly numbers: readonly OutboundNumber[];
+    /** The organization default (an `OutboundNumber.id`), or `null`. */
+    readonly orgDefault: string | null;
+    /** This agent's own choice, or `null` = "use the organization default". */
+    readonly mine: string | null;
+    /** The number this agent's calls show: `mine`, else `orgDefault`. */
+    readonly effective: string | null;
+    /** The agent's extension ("100"), or `null` when they have none. */
+    readonly extension: string | null;
+    readonly state: OutboundNumberState;
+    /** 0 when a change could go out now; otherwise the seconds until it can. */
+    readonly changeAvailableInSeconds: number;
+}
+/**
+ * Why a change was refused before anything was sent. `platform`: the shared limit on number changes (nothing the
+ * agent did). `user`: the agent changed it moments ago. Either way the previous number stays in use.
+ */
+interface OutboundNumberRefusal {
+    readonly reason: 'platform' | 'user';
+    /** Seconds until a change can go out — always at least 1. */
+    readonly retryAfterSeconds: number;
+}
+/** The outbound number of the agent the softphone is signed in as, in its organization. */
+interface OutboundNumbersSource {
+    get(signal?: AbortSignal): Promise<OutboundNumberSettings>;
+    /**
+     * Changes this agent's number; `null` = back to the organization default. Resolves to the new settings once the
+     * change is in effect. When the request limits refuse it, rejects with an `Error` carrying
+     * `refusal: OutboundNumberRefusal` (check with `isOutboundNumberRefused`) — nothing was stored or sent.
+     */
+    setMine(id: string | null): Promise<OutboundNumberSettings>;
+    /** The settings this agent last had on this device, if remembered — instant, no network. Optional. */
+    cached?(): Promise<OutboundNumberSettings | null>;
+}
 
 /**
  * The error taxonomy.
@@ -873,4 +936,4 @@ interface Call extends TypedEmitter<CallEventMap> {
     cancelConsult(): Promise<void>;
 }
 
-export { type AgentsDirectory as A, type PresenceSource as B, CALL_TRANSITIONS as C, type CallHistoryEntry as D, ERROR_CATALOGUE as E, type FatalErrorCode as F, type ContactsPage as G, type HangupReason as H, INITIAL_STATES as I, type LogLevel as L, type NonFatalErrorCode as N, type PresenceEntry as P, type RemoteParty as R, type SoftphoneConfig as S, type TokenEndpointOptions as T, type VoiceToken as V, type Call as a, type CallDirection as b, CallEvent as c, type CallEventMap as d, type CallOptions as e, type CallState as f, type Contact as g, type FatalSoftphoneError as h, type HoldOriginator as i, type NonFatalSoftphoneError as j, type RingtoneOption as k, type RingtoneSettings as l, type RingtoneSource as m, type SoftphoneError as n, type SoftphoneErrorCode as o, SoftphoneEvent as p, type SoftphoneEventMap as q, type SoftphoneState as r, type TokenSource as s, type TypedEmitter as t, canTransition as u, isFatal as v, isTerminal as w, type ContactsSource as x, type HistorySource as y, type TransferOutcomesPage as z };
+export { isFatal as A, isTerminal as B, CALL_TRANSITIONS as C, type ContactsSource as D, ERROR_CATALOGUE as E, type FatalErrorCode as F, type HistorySource as G, type HangupReason as H, INITIAL_STATES as I, type AgentsDirectory as J, type TransferOutcomesPage as K, type LogLevel as L, type PresenceSource as M, type NonFatalErrorCode as N, type OutboundNumberRefusal as O, type PresenceEntry as P, type CallHistoryEntry as Q, type RemoteParty as R, type SoftphoneConfig as S, type TokenEndpointOptions as T, type ContactsPage as U, type VoiceToken as V, type Call as a, type CallDirection as b, CallEvent as c, type CallEventMap as d, type CallOptions as e, type CallState as f, type Contact as g, type FatalSoftphoneError as h, type HoldOriginator as i, type NonFatalSoftphoneError as j, type OutboundNumber as k, type OutboundNumberKind as l, type OutboundNumberSettings as m, type OutboundNumberState as n, type OutboundNumbersSource as o, type RingtoneOption as p, type RingtoneSettings as q, type RingtoneSource as r, type SoftphoneError as s, type SoftphoneErrorCode as t, SoftphoneEvent as u, type SoftphoneEventMap as v, type SoftphoneState as w, type TokenSource as x, type TypedEmitter as y, canTransition as z };

package/dist/chunk-5E5OEXS2.js

@@ -0,0 +1,14 @@
+// src/core/outbound-numbers.ts
+function isOutboundNumberRefused(value) {
+  const refusal = value?.refusal;
+  return value instanceof Error && !!refusal && (refusal.reason === "platform" || refusal.reason === "user") && typeof refusal.retryAfterSeconds === "number";
+}
+function outboundNumberRefused(refusal) {
+  const error = new Error(`Outbound number change refused (${refusal.reason}); retry in ${refusal.retryAfterSeconds}s`);
+  error.name = "OutboundNumberRefused";
+  return Object.assign(error, { refusal });
+}
+
+export { isOutboundNumberRefused, outboundNumberRefused };
+//# sourceMappingURL=chunk-5E5OEXS2.js.map
+//# sourceMappingURL=chunk-5E5OEXS2.js.map

package/dist/chunk-5E5OEXS2.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/core/outbound-numbers.ts"],"names":[],"mappings":";AAWO,SAAS,wBAAwB,KAAA,EAAqD;AAC3F,EAAA,MAAM,UAAW,KAAA,EAA+D,OAAA;AAChF,EAAA,OACE,KAAA,YAAiB,KAAA,IACjB,CAAC,CAAC,OAAA,KACD,OAAA,CAAQ,MAAA,KAAW,UAAA,IAAc,OAAA,CAAQ,MAAA,KAAW,MAAA,CAAA,IACrD,OAAO,QAAQ,iBAAA,KAAsB,QAAA;AAEzC;AAGO,SAAS,sBAAsB,OAAA,EAA4D;AAChG,EAAA,MAAM,KAAA,GAAQ,IAAI,KAAA,CAAM,CAAA,gCAAA,EAAmC,QAAQ,MAAM,CAAA,YAAA,EAAe,OAAA,CAAQ,iBAAiB,CAAA,CAAA,CAAG,CAAA;AACpH,EAAA,KAAA,CAAM,IAAA,GAAO,uBAAA;AACb,EAAA,OAAO,MAAA,CAAO,MAAA,CAAO,KAAA,EAAO,EAAE,SAAS,CAAA;AACzC","file":"chunk-5E5OEXS2.js","sourcesContent":["import type { OutboundNumberRefusal } from './types.js';\r\n\r\n/**\r\n * A change of outbound number the request limits refused (outbound-number-per-agent.md §5.3–§5.5). Structural,\r\n * like `isSoftphoneError`: the concrete error is a plain `Error` with a `refusal`, so a host — or a second copy\r\n * of the SDK on the page — can recognise it without sharing a class.\r\n */\r\nexport interface OutboundNumberRefusedError extends Error {\r\n  readonly refusal: OutboundNumberRefusal;\r\n}\r\n\r\nexport function isOutboundNumberRefused(value: unknown): value is OutboundNumberRefusedError {\r\n  const refusal = (value as { refusal?: Partial<OutboundNumberRefusal> } | null)?.refusal;\r\n  return (\r\n    value instanceof Error &&\r\n    !!refusal &&\r\n    (refusal.reason === 'platform' || refusal.reason === 'user') &&\r\n    typeof refusal.retryAfterSeconds === 'number'\r\n  );\r\n}\r\n\r\n/** @internal — raised by the Coventia source; hosts only read these. */\r\nexport function outboundNumberRefused(refusal: OutboundNumberRefusal): OutboundNumberRefusedError {\r\n  const error = new Error(`Outbound number change refused (${refusal.reason}); retry in ${refusal.retryAfterSeconds}s`);\r\n  error.name = 'OutboundNumberRefused';\r\n  return Object.assign(error, { refusal });\r\n}\r\n"]}

package/dist/element/index.d.ts

@@ -109,6 +109,11 @@ interface CallHistoryEntry {
     readonly outcome?: CallOutcome;
     /** The org's own number that was dialled — present only (and only meaningful) for an inbound call. */
     readonly did?: string;
+    /**
+     * The org's own number an outbound call was made from (what the callee saw) — present only for outbound calls the
+     * backend recorded it for (outbound-number-per-agent.md §5.7). Digits, no `+`.
+     */
+    readonly from?: string;
     /** True when Coventia has at least one recording for this call. */
     readonly recorded: boolean;
     /**
@@ -276,6 +281,55 @@ interface RingtoneSource {
      */
     cached?(): Promise<RingtoneSettings | null>;
 }
+/**
+ * What kind of number this is, for the tags next to it in "Llamar desde" (outbound-number-per-agent.md §5.5).
+ * Display only — it never blocks a choice. `mobile` must not be used for customer care or unsolicited commercial
+ * calls; `commercial` (the 400 range) is for outbound commercial calls only and receives no calls.
+ */
+type OutboundNumberKind = 'landline' | 'mobile' | 'commercial' | 'other';
+/** One of the organization's numbers an agent can call from. */
+interface OutboundNumber {
+    /** Stable id — what is stored as the agent's choice. */
+    readonly id: string;
+    /** International format, digits only, no `+` — e.g. `34960000001`. */
+    readonly number: string;
+    /** The name the organization gave the number, or `null`. */
+    readonly label: string | null;
+    readonly kind: OutboundNumberKind;
+}
+/**
+ * Where the agent's extension stands. `pending`/`failed`: an assignment change could not update it yet, so the
+ * extension may still present an earlier number. `unassigned`: the agent has no extension in this organization.
+ */
+type OutboundNumberState = 'applied' | 'pending' | 'failed' | 'unassigned';
+/** The organization's numbers and the caller's choice, as the backend resolves them. */
+interface OutboundNumberSettings {
+    /** The organization's active numbers, ordered by number. */
+    readonly numbers: readonly OutboundNumber[];
+    /** The organization default (an `OutboundNumber.id`), or `null`. */
+    readonly orgDefault: string | null;
+    /** This agent's own choice, or `null` = "use the organization default". */
+    readonly mine: string | null;
+    /** The number this agent's calls show: `mine`, else `orgDefault`. */
+    readonly effective: string | null;
+    /** The agent's extension ("100"), or `null` when they have none. */
+    readonly extension: string | null;
+    readonly state: OutboundNumberState;
+    /** 0 when a change could go out now; otherwise the seconds until it can. */
+    readonly changeAvailableInSeconds: number;
+}
+/** The outbound number of the agent the softphone is signed in as, in its organization. */
+interface OutboundNumbersSource {
+    get(signal?: AbortSignal): Promise<OutboundNumberSettings>;
+    /**
+     * Changes this agent's number; `null` = back to the organization default. Resolves to the new settings once the
+     * change is in effect. When the request limits refuse it, rejects with an `Error` carrying
+     * `refusal: OutboundNumberRefusal` (check with `isOutboundNumberRefused`) — nothing was stored or sent.
+     */
+    setMine(id: string | null): Promise<OutboundNumberSettings>;
+    /** The settings this agent last had on this device, if remembered — instant, no network. Optional. */
+    cached?(): Promise<OutboundNumberSettings | null>;
+}
 
 /** Contacts, history, caller ID, the agents directory, transfer outcomes, presence and ringtone
  *  settings, all from one config. */
@@ -293,6 +347,8 @@ interface BackendSources {
     readonly presence: PresenceSource;
     /** The caller's ringtone settings (custom-ringtone.md §4.4). Always Coventia's — no override. */
     readonly ringtones: RingtoneSource;
+    /** The caller's outbound number (outbound-number-per-agent.md §5.5). Always Coventia's — no override. */
+    readonly outboundNumbers: OutboundNumbersSource;
 }
 
 /**