@xema/omni-protocol 0.1.95 → 0.1.96

package/dist/index.d.ts

@@ -1687,7 +1687,7 @@ export interface Connection<C extends Channel = Channel> {
     execute(request: TaskCommandRequest<C>): Promise<TaskCommandResult>;
     disconnect(): Promise<void>;
     /** Required of any adapter publishing a `UserId` -- on a forced break, a team member list, or history. */
-    describeUsers?(ids: UserId[]): Promise<User[]>;
+    getUserDetails?(ids: UserId[]): Promise<User[]>;
     /** Required when the manifest declares `idleCapabilities.dial`. */
     dial?(request: DialRequest): Promise<DialResult>;
     /**

package/dist/testing.js

@@ -1,5 +1,5 @@
 import { browserSessionKey, effectiveLevels, sameCapabilities, } from "./index.js";
-import { assertNoViolations, validateAuthenticationState, validateBreakTransition, validateEventEnvelope, validateHostGuarantees, validateHostReport, validateDescribedUsers, observeRules, ruleEvaluated, validateHostMute, validateHostRecording, validateLoginStore, validateInteractionReport, validateManifest, validateResult, validateSnapshot, validateTask, validateTimeZone, validatePhone, validateTaskCommand, isTimeZone, sameTimeZone, } from "./validation.js";
+import { assertNoViolations, validateAuthenticationState, validateBreakTransition, validateEventEnvelope, validateHostGuarantees, validateHostReport, validateUserDetails, observeRules, ruleEvaluated, validateHostMute, validateHostRecording, validateLoginStore, validateInteractionReport, validateManifest, validateResult, validateSnapshot, validateTask, validateTimeZone, validatePhone, validateTaskCommand, isTimeZone, sameTimeZone, } from "./validation.js";
 export { ProtocolConformanceError, assertNoViolations } from "./validation.js";
 /**
  * A part of the contract a run may never reach: state nothing obliges an adapter to publish, so
@@ -356,7 +356,7 @@ export async function exerciseAdapter(adapter, context, options = {}) {
             violations.push(...undeterminedTasks(eventTasks(envelope), "event"));
             lockedPartySeen ||= eventTasks(envelope).some(locksParty);
             if (eventNamesUsers(envelope))
-                requireMethod(live, "describeUsers", "an event publishes a UserId");
+                requireMethod(live, "getUserDetails", "an event publishes a UserId");
             // Work is pulled, never pushed: an offer before the host stated capacity is an allocation
             // against nothing, and an offer beyond the count is one too many -- unless the task is the
             // host's own dial arriving, which counts against nothing.
@@ -458,22 +458,22 @@ export async function exerciseAdapter(adapter, context, options = {}) {
             violations.push(...undeterminedTasks(tasks, `${path}.tasks`));
             lockedPartySeen ||= tasks.some(locksParty);
             if (publishesUserIds(read)) {
-                requireMethod(source, "describeUsers", "the snapshot publishes a UserId");
+                requireMethod(source, "getUserDetails", "the snapshot publishes a UserId");
                 // Required by presence is not enough: the names the snapshot published are looked up, and what
                 // comes back is held to the shape -- an empty answer to a team member list of colleagues is named.
                 const named = userIdsIn(read);
-                if (typeof source.describeUsers === "function" && named.length > 0) {
+                if (typeof source.getUserDetails === "function" && named.length > 0) {
                     let described;
                     try {
-                        described = await source.describeUsers(named);
-                        violations.push(...validateDescribedUsers(described, named, "connection.describeUsers"));
+                        described = await source.getUserDetails(named);
+                        violations.push(...validateUserDetails(described, named, "connection.getUserDetails"));
                         if (Array.isArray(described) && described.length === 0) {
-                            violations.push({ rule: "connection.describeUsers.empty", path: "connection.describeUsers",
+                            violations.push({ rule: "connection.getUserDetails.empty", path: "connection.getUserDetails",
                                 message: `asked about ${named.join(", ")}, whom the snapshot itself named, the provider described nobody` });
                         }
                     }
                     catch (error) {
-                        violations.push({ rule: "connection.describeUsers.rejected", path: "connection.describeUsers", message: `describeUsers rejected rather than answered: ${String(error)}` });
+                        violations.push({ rule: "connection.getUserDetails.rejected", path: "connection.getUserDetails", message: `getUserDetails rejected rather than answered: ${String(error)}` });
                     }
                 }
             }
@@ -532,7 +532,7 @@ export async function exerciseAdapter(adapter, context, options = {}) {
         violations.push(...malformed);
         // The provider republishes the agent's day: once connected, the identity carries the zone the
         // host sent. That proves the round trip, not the store -- an echo passes it -- and the name
-        // says only what it tests; storage is proved by a colleague's zone arriving from describeUsers().
+        // says only what it tests; storage is proved by a colleague's zone arriving from getUserDetails().
         // A zone is judged by what it denotes: Asia/Kolkata and Asia/Calcutta are one zone, and a
         // provider that keeps the canonical name has kept the zone.
         if (isTimeZone(context.timeZone) && !sameTimeZone(current().identity.timeZone, context.timeZone)) {

package/dist/validation.d.ts

@@ -150,11 +150,11 @@ export declare function sameTimeZone(a: unknown, b: unknown): boolean;
 /** The zone a host sends at connect: required, and an IANA name. */
 export declare function validateTimeZone(value: unknown, path?: string): ProtocolViolation[];
 /**
- * What `describeUsers(ids)` answered: an array of users, each one asked for, each a valid identity.
+ * What `getUserDetails(ids)` answered: an array of users, each one asked for, each a valid identity.
  * The provider may answer fewer than asked, which is what "unknown to it" looks like; it never
  * answers somebody nobody asked about.
  */
-export declare function validateDescribedUsers(users: unknown, asked: readonly string[], path?: string): ProtocolViolation[];
+export declare function validateUserDetails(users: unknown, asked: readonly string[], path?: string): ProtocolViolation[];
 /** What a login is validated against beyond its own shape. */
 export interface LoginValidationContext {
     /** The level ids in force, from the manifest. The defaults when absent. */

package/dist/validation.js

@@ -2649,21 +2649,21 @@ export function validateTimeZone(value, path = "context.timeZone") {
     return into.violations;
 }
 /**
- * What `describeUsers(ids)` answered: an array of users, each one asked for, each a valid identity.
+ * What `getUserDetails(ids)` answered: an array of users, each one asked for, each a valid identity.
  * The provider may answer fewer than asked, which is what "unknown to it" looks like; it never
  * answers somebody nobody asked about.
  */
-export function validateDescribedUsers(users, asked, path = "describeUsers") {
+export function validateUserDetails(users, asked, path = "getUserDetails") {
     const into = new Collector();
     if (!Array.isArray(users)) {
-        into.add("describeUsers.shape", path, "describeUsers answers an array of users, empty when it knows none of them");
+        into.add("getUserDetails.shape", path, "getUserDetails answers an array of users, empty when it knows none of them");
         return into.violations;
     }
     users.forEach((user, index) => {
         const at = `${path}[${index}]`;
-        validateUser(user, "describeUsers.user", at, into);
+        validateUser(user, "getUserDetails.user", at, into);
         if (isPlainObject(user) && typeof user.id === "string") {
-            into.require(asked.includes(user.id), "describeUsers.unasked", `${at}.id`, `${user.id} was not among the ids asked for`);
+            into.require(asked.includes(user.id), "getUserDetails.unasked", `${at}.id`, `${user.id} was not among the ids asked for`);
         }
     });
     return into.violations;