@xema/omni-protocol 0.1.33 → 0.1.34

package/dist/index.d.ts

@@ -76,11 +76,12 @@ export interface DialCapability {
 }
 /**
  * How a dial ended, as the switch distinguishes it. `answered` is the one success; the rest are
- * the ways a destination was not reached. A manifest declares which of these its platform can
- * tell apart (`dialOutcomes`), and a `dial-outcome` carries only a declared one.
+ * the ways a destination was not reached -- `cancelled` because the dialler called it off before
+ * anyone answered, not because the destination failed to. A manifest declares which of these its
+ * platform can tell apart (`dialOutcomes`), and a `dial-outcome` carries only a declared one.
  */
-export type DialOutcome = "answered" | "busy" | "no-answer" | "unreachable" | "rejected";
-export declare const DIAL_OUTCOMES: readonly ["answered", "busy", "no-answer", "unreachable", "rejected"];
+export type DialOutcome = "answered" | "busy" | "no-answer" | "unreachable" | "rejected" | "cancelled";
+export declare const DIAL_OUTCOMES: readonly ["answered", "busy", "no-answer", "unreachable", "rejected", "cancelled"];
 /** Every idle capability a provider may declare. Only voice may `dial`; the channel arm says so. */
 export declare const IDLE_CAPABILITIES: readonly ["dial", "personalBrowser", "calendar", "contacts"];
 export type IdleCapability = (typeof IDLE_CAPABILITIES)[number];
@@ -1212,9 +1213,10 @@ export type ProviderEvent<C extends Channel = Channel> = {
 }
 /**
  * How a dial the host placed ended, once, either way -- `answered` is stated, never read off
- * somebody appearing on the call. `taskId` where the dial was on a task, and that task may
- * already have ended: a dial placed late routinely outlives its call. `reason` is the switch's
- * own words, shown to the agent as such.
+ * somebody appearing on the call, and says what happened to the dial; who is on the call is
+ * `Task.onCall`. `taskId` is the task the dial was placed on, resolved from the dial and never
+ * from what the agent is looking at, and that task may already have ended: a dial placed late
+ * routinely outlives its call. `reason` is the switch's own words, shown to the agent as such.
  */
  | {
     type: "dial-outcome";

package/dist/index.js

@@ -15,7 +15,7 @@ export function negotiateProtocolVersion(adapterVersions, hostVersions = OMNI_SU
     const shared = adapterVersions.filter(version => host.has(version));
     return shared.length === 0 ? undefined : Math.max(...shared);
 }
-export const DIAL_OUTCOMES = ["answered", "busy", "no-answer", "unreachable", "rejected"];
+export const DIAL_OUTCOMES = ["answered", "busy", "no-answer", "unreachable", "rejected", "cancelled"];
 /** Every idle capability a provider may declare. Only voice may `dial`; the channel arm says so. */
 export const IDLE_CAPABILITIES = ["dial", "personalBrowser", "calendar", "contacts"];
 /** What Omni calls each idle capability. */

package/dist/validation.js

@@ -67,7 +67,7 @@ const ACCESS_APPLIES_TO = membersOf({
     "initial-url": true, "all-navigation": true,
 });
 const DIAL_DESTINATION_POLICIES = membersOf({ "contacts-only": true, "any-number": true });
-const DIAL_OUTCOMES = membersOf({ answered: true, busy: true, "no-answer": true, unreachable: true, rejected: true });
+const DIAL_OUTCOMES = membersOf({ answered: true, busy: true, "no-answer": true, unreachable: true, rejected: true, cancelled: true });
 const ON_CALL_ROLES = membersOf({ party: true, agent: true, consulted: true, conferenced: true });
 /** The task capabilities under which a command dials, and so need the manifest to say how a dial ends. */
 const DIALLING_CAPABILITIES = ["callback", "blindTransfer", "consultTransfer", "conference"];

package/guide.md

@@ -165,7 +165,7 @@ type DialDestinations = "contacts-only" | "any-number";
 
 type DialCapability = { destinations: DialDestinations };
 
-type DialOutcome = "answered" | "busy" | "no-answer" | "unreachable" | "rejected";
+type DialOutcome = "answered" | "busy" | "no-answer" | "unreachable" | "rejected" | "cancelled";
 
 type IdleCapabilities<C extends Channel = Channel> = {
   personalBrowser?: PersonalBrowserCapability;
@@ -2779,12 +2779,23 @@ nothing, is refused (`result.status`). `validateResult(result, method, path, dia
 
 **The outcome is stated, once, either way.** A `dial-outcome` names the `dialId`, the task where
 there was one, the destination where the provider knows it, and how the dial ended -- from a closed
-set: `answered`, `busy`, `no-answer`, `unreachable`, `rejected`. `answered` is stated rather than
-read off somebody appearing on the call, because a host that infers success cannot tell "reached"
-from "still ringing". `reason` is the switch's own words, optional, and shown to the agent
-attributed to the switch rather than to Omni. The task named may already have ended, and the
-harness places the outcome all the same (`TaskStream`, `stream.dialOutcome.unknown`,
-`stream.dialOutcome.duplicate`); an agent who moved on still learns nobody was reached.
+set: `answered`, `busy`, `no-answer`, `unreachable`, `rejected`, `cancelled`. `answered` is stated
+rather than read off somebody appearing on the call, because a host that infers success cannot tell
+"reached" from "still ringing". `cancelled` is the dialler calling the dial off before anyone
+answered -- the agent hanging up while a consult still rings -- which is not a `no-answer` the
+destination never gave. `reason` is the switch's own words, optional, and shown to the agent
+attributed to the switch rather than to Omni.
+
+**`taskId` is the task the dial was placed on**, resolved from the dial's own identity and never from
+whatever task the agent is looking at when the outcome arrives. That task may already have ended,
+and the harness places the outcome all the same (`TaskStream`, `stream.dialOutcome.unknown`,
+`stream.dialOutcome.duplicate`); an agent who moved on still learns nobody was reached, against the
+call it belonged to and never against the next one.
+
+**`answered` says what happened to the dial; `onCall` says who is in the room.** They are two
+claims, and both are true at once when a leg answers and never joins. A desk shows `answered` as the
+dial's conclusion and says "on the call" only when the person appears on `Task.onCall`; the obvious
+reading of `answered` -- that they are on the line -- is the one it does not make.
 
 **A provider says which outcomes it can tell apart.** No switch distinguishes all five, and a
 provider that cannot tell busy from unreachable must not pick one. The manifest declares

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xema/omni-protocol",
-  "version": "0.1.33",
+  "version": "0.1.34",
   "description": "The Omni protocol: the contract every provider adapter implements",
   "type": "module",
   "license": "MIT",