@ayni.org/ayni-ui-core 0.3.4 → 0.3.6

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export * from './flag.js';
 export * from './homeDesign.js';
 export * from './profileClient.js';
 export * from './proofOfTrustDesign.js';
+export * from './readState.js';
 export * from './reducer.js';
 export * from './sse.js';
 export * from './store.js';

package/dist/index.js

@@ -6,6 +6,7 @@ export * from './flag.js';
 export * from './homeDesign.js';
 export * from './profileClient.js';
 export * from './proofOfTrustDesign.js';
+export * from './readState.js';
 export * from './reducer.js';
 export * from './sse.js';
 export * from './store.js';

package/dist/profileClient.d.ts

@@ -26,7 +26,9 @@ export declare class ProfileClient {
     constructor(sessionsUrl: string, fetchFn?: typeof fetch);
     private url;
     private headers;
-    create(client: ClientDescription, locale?: string, siblingOfToken?: string, deviceHandle?: string, resumeSessionId?: string, deviceProof?: string, conversationId?: string, newConversation?: boolean): Promise<CreateSessionResponse>;
+    create(client: ClientDescription, locale?: string, siblingOfToken?: string, deviceHandle?: string, resumeSessionId?: string, deviceProof?: string, conversationId?: string, newConversation?: boolean, 
+    /** a bound session or none (PROF-SESS-015): 409 when the device proof does not bind, nothing asked on the phone */
+    silent?: boolean): Promise<CreateSessionResponse>;
     /** The Principal's conversations with this agent (PROF-CONV-001). */
     conversations(token: string): Promise<ConversationsResponse>;
     /** Rename, archive or unarchive (PROF-CONV-002/003). */

package/dist/profileClient.js

@@ -37,7 +37,9 @@ export class ProfileClient {
     headers(token, extra = {}) {
         return { accept: 'application/json', ...(token ? { authorization: `Bearer ${token}` } : {}), ...extra };
     }
-    async create(client, locale, siblingOfToken, deviceHandle, resumeSessionId, deviceProof, conversationId, newConversation = false) {
+    async create(client, locale, siblingOfToken, deviceHandle, resumeSessionId, deviceProof, conversationId, newConversation = false, 
+    /** a bound session or none (PROF-SESS-015): 409 when the device proof does not bind, nothing asked on the phone */
+    silent = false) {
         const response = await this.fetchFn(this.url(), {
             method: 'POST',
             headers: this.headers(siblingOfToken, { 'content-type': 'application/json' }),
@@ -48,6 +50,7 @@ export class ProfileClient {
                 ...(deviceHandle && deviceProof && !siblingOfToken ? { deviceProof } : {}),
                 ...(conversationId ? { conversationId } : resumeSessionId ? { resumeSessionId } : {}),
                 ...(newConversation ? { newConversation: true } : {}),
+                ...(silent && !siblingOfToken ? { silent: true } : {}),
             }),
         });
         if (!response.ok)

package/dist/readState.d.ts

@@ -0,0 +1,29 @@
+import type { AgUiEvent } from './profileClient.js';
+import type { TranscriptMessage } from './types.js';
+/** Whether the agent keeps the shared read state. */
+export declare function hasReadState(descriptor: {
+    features?: unknown;
+} | undefined): boolean;
+/** Whether a device reports what it shows: for the audit trail (`receipts`), for the read marker (`readState`). */
+export declare function sendsViewed(descriptor: {
+    features?: unknown;
+} | undefined): boolean;
+/**
+ * The unread count a device shows for a conversation: the agent's when it gave one, the device's own otherwise,
+ * and none for the conversation in front of the person, which the device is reporting as viewed.
+ */
+export declare function unreadFrom(agentCount: unknown, own: number, onScreen: boolean): number;
+/**
+ * The messages of a transcript to report as viewed: what the agent said that is shown whole and was not reported
+ * yet, by the id the agent knows it under (a text by its own id, an attachment by its entry's).
+ */
+export declare function viewedIds(messages: readonly TranscriptMessage[], reported: ReadonlySet<string>): string[];
+/** What `ayni.conversation.changed` says of a conversation (PROF-CONV-007); null for any other event. */
+export interface ChangedConversation {
+    conversationId: string;
+    title?: string;
+    state?: 'active' | 'archived' | 'final';
+    unread?: number;
+    readUpTo?: string | null;
+}
+export declare function changedConversation(event: AgUiEvent): ChangedConversation | null;

package/dist/readState.js

@@ -0,0 +1,58 @@
+/**
+ * The shared read state, as a device uses it (D62, PROF-CONV-008, PROF-DESC-005): the agent keeps one read marker
+ * per conversation and counts what is unread after it; a device reports the messages it shows with a `viewed`
+ * receipt and shows the agent's count in place of its own. The rules are here so the web UI and the app apply
+ * the same ones.
+ */
+import { ACTIVITY } from '@ayni.org/ayni-agui-profile';
+import { CONVERSATION_CHANGED } from './reducer.js';
+/** Whether the agent keeps the shared read state. */
+export function hasReadState(descriptor) {
+    return descriptor?.features?.readState === true;
+}
+/** Whether a device reports what it shows: for the audit trail (`receipts`), for the read marker (`readState`). */
+export function sendsViewed(descriptor) {
+    return descriptor?.features?.receipts === true || hasReadState(descriptor);
+}
+/**
+ * The unread count a device shows for a conversation: the agent's when it gave one, the device's own otherwise,
+ * and none for the conversation in front of the person, which the device is reporting as viewed.
+ */
+export function unreadFrom(agentCount, own, onScreen) {
+    if (onScreen)
+        return 0;
+    return typeof agentCount === 'number' && agentCount >= 0 ? agentCount : own;
+}
+/**
+ * The messages of a transcript to report as viewed: what the agent said that is shown whole and was not reported
+ * yet, by the id the agent knows it under (a text by its own id, an attachment by its entry's).
+ */
+export function viewedIds(messages, reported) {
+    const ids = [];
+    for (const m of messages) {
+        let id;
+        if (m.role === 'assistant' && !m.streaming)
+            id = m.id;
+        else if (m.role === 'activity' &&
+            m.activityType === ACTIVITY.attachment &&
+            m.content.role === 'assistant')
+            id = m.entryId;
+        if (id && !reported.has(id) && !ids.includes(id))
+            ids.push(id);
+    }
+    return ids;
+}
+export function changedConversation(event) {
+    if (event.type !== 'CUSTOM' || event.name !== CONVERSATION_CHANGED)
+        return null;
+    const value = (event.value ?? {});
+    if (typeof value.conversationId !== 'string')
+        return null;
+    return {
+        conversationId: value.conversationId,
+        title: typeof value.title === 'string' ? value.title : undefined,
+        state: value.state === 'active' || value.state === 'archived' || value.state === 'final' ? value.state : undefined,
+        unread: typeof value.unread === 'number' ? value.unread : undefined,
+        readUpTo: typeof value.readUpTo === 'string' || value.readUpTo === null ? value.readUpTo : undefined,
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ayni.org/ayni-ui-core",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "Framework-independent core of the Ayni UI (UI-SHELL-004): agents and controllers, trust resolution, sessions and binding, the conversation reducer, the local store and sync; shared by the browser UI and the Ayni app",
   "type": "module",
   "main": "./dist/index.js",