@ayni.org/ayni-ui-core 0.3.5 → 0.3.7

package/dist/index.d.ts

@@ -4,8 +4,10 @@ export * from './conversationDesign.js';
 export * from './directory.js';
 export * from './flag.js';
 export * from './homeDesign.js';
+export * from './mediaMessages.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

@@ -4,8 +4,10 @@ export * from './conversationDesign.js';
 export * from './directory.js';
 export * from './flag.js';
 export * from './homeDesign.js';
+export * from './mediaMessages.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/mediaMessages.d.ts

@@ -0,0 +1,28 @@
+import type { ReplyQuote, TranscriptMessage } from './types.js';
+type Attachment = Extract<TranscriptMessage, {
+    role: 'activity';
+}>;
+/** Whether a transcript message is an attachment of a media message. */
+export declare function isAttachment(message: TranscriptMessage): message is Attachment;
+/** The id the agent knows a message under: a text by its own, a media message by its entry's. */
+export declare function targetIdOf(message: TranscriptMessage): string;
+/** What a media message is, for the quote of a reply and for its menu. */
+export type MediaKind = 'image' | 'voice' | 'video' | 'file';
+export declare function mediaKindOf(message: Attachment): MediaKind;
+/** The quote a reply to any message carries (PROF-RUN-009): a text by its words, a media message by what it is. */
+export declare function quoteOf(message: Exclude<TranscriptMessage, {
+    role: 'system';
+}>): ReplyQuote;
+/** The English names of a media message; a UI with its own languages translates the kind. */
+export declare const MEDIA_COPY: Record<MediaKind, string>;
+/**
+ * What a quote shows: the words of the quoted message, else what it is. A file is named by its file name; `name`
+ * gives the word for a kind in the UI's language.
+ */
+export declare function quoteLabel(quote: ReplyQuote, name?: (kind: MediaKind) => string): string;
+/**
+ * The last attachment of each media message: the one that shows the message's reactions when the message carries
+ * several (UI-CONV-024). Keyed by the message's entry.
+ */
+export declare function lastAttachments(messages: readonly TranscriptMessage[]): Map<string, string>;
+export {};

package/dist/mediaMessages.js

@@ -0,0 +1,71 @@
+/**
+ * Reactions and replies on a media message (UI-CONV-024, APP-MSG-005, PROF-RUN-009/010): a picture, a video, a
+ * file or a voice note is a message like a text. The agent knows it by the id of its entry, which each of its
+ * attachments carries, never by the id of an attachment: a reaction or a reply names that entry, and the
+ * reactions of the message are read under it. A reply quotes a media message by what it is.
+ */
+import { ACTIVITY } from '@ayni.org/ayni-agui-profile';
+import { plainText, REPLY_QUOTE_LENGTH } from './conversationDesign.js';
+/** Whether a transcript message is an attachment of a media message. */
+export function isAttachment(message) {
+    return message.role === 'activity' && message.activityType === ACTIVITY.attachment;
+}
+/** The id the agent knows a message under: a text by its own, a media message by its entry's. */
+export function targetIdOf(message) {
+    return isAttachment(message) ? (message.entryId ?? message.id) : message.id;
+}
+export function mediaKindOf(message) {
+    const type = message.content.type;
+    return type === 'image' || type === 'voice' || type === 'video' ? type : 'file';
+}
+/** The words a media message has of its own: a caption, a transcription; not the agent's placeholder for it. */
+function ownWords(textRepr) {
+    const text = typeof textRepr === 'string' ? textRepr.trim() : '';
+    return /^\[[^\]]*\]$/.test(text) ? '' : text;
+}
+/** The quote a reply to any message carries (PROF-RUN-009): a text by its words, a media message by what it is. */
+export function quoteOf(message) {
+    if (message.role !== 'activity')
+        return {
+            id: message.id,
+            text: plainText(message.content).slice(0, REPLY_QUOTE_LENGTH),
+            role: message.role === 'user' ? 'user' : 'assistant',
+        };
+    const content = message.content;
+    return {
+        id: targetIdOf(message),
+        text: ownWords(content.textRepr).slice(0, REPLY_QUOTE_LENGTH),
+        role: content.role === 'user' ? 'user' : 'assistant',
+        media: mediaKindOf(message),
+        ...(content.filename ? { filename: content.filename } : {}),
+    };
+}
+/** The English names of a media message; a UI with its own languages translates the kind. */
+export const MEDIA_COPY = {
+    image: 'Photo',
+    voice: 'Voice note',
+    video: 'Video',
+    file: 'File',
+};
+/**
+ * What a quote shows: the words of the quoted message, else what it is. A file is named by its file name; `name`
+ * gives the word for a kind in the UI's language.
+ */
+export function quoteLabel(quote, name = (kind) => MEDIA_COPY[kind]) {
+    if (quote.text)
+        return quote.text;
+    if (!quote.media)
+        return '';
+    return quote.media === 'file' && quote.filename ? quote.filename : name(quote.media);
+}
+/**
+ * The last attachment of each media message: the one that shows the message's reactions when the message carries
+ * several (UI-CONV-024). Keyed by the message's entry.
+ */
+export function lastAttachments(messages) {
+    const last = new Map();
+    for (const m of messages)
+        if (isAttachment(m))
+            last.set(targetIdOf(m), m.id);
+    return last;
+}

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/dist/reducer.js

@@ -287,8 +287,11 @@ export function reactionsOf(page) {
     const out = {};
     for (const m of page) {
         const meta = (m.metadata ?? {});
+        // the reactions of a media message are those of its entry, which each of its attachments carries: they are
+        // kept under the entry, where a live `ayni.reaction` names it too (UI-CONV-024)
+        const key = m.role === 'activity' && meta.entryId ? meta.entryId : String(m.id);
         if (meta.reactions?.length)
-            out[String(m.id)] = meta.reactions.map((r) => ({ emoji: r.emoji, by: r.by }));
+            out[key] = meta.reactions.map((r) => ({ emoji: r.emoji, by: r.by }));
     }
     return out;
 }

package/dist/types.d.ts

@@ -106,8 +106,12 @@ export interface SessionRecord {
 }
 export interface ReplyQuote {
     id: string;
+    /** the words of the quoted message; empty for a media message that has none of its own */
     text: string;
     role: 'user' | 'assistant';
+    /** what the quoted message is, when it is a media message (PROF-RUN-009) */
+    media?: 'image' | 'voice' | 'video' | 'file';
+    filename?: string;
 }
 export type TranscriptMessage = {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ayni.org/ayni-ui-core",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "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",