@webority/mobile-chat 0.122.0 → 0.124.0

package/lib/module/labels.js

@@ -1 +0,0 @@
-"use strict";export const DEFAULT_CHAT_LABELS=Object.freeze({launcher:"Ask the assistant",panelTitle:"Assistant",newChat:"New chat",close:"Close",thread:"Conversation",you:"You",assistant:"Assistant",thinking:"Thinking",emptyTitle:"How can I help?",emptyText:"Ask a question about what you see on this page.",composer:"Your question",placeholder:"Ask a question",send:"Send",composerHint:"Press Enter to send, Shift and Enter for a new line.",allowance:e=>0===e?"You have no questions left today.":1===e?"You have 1 question left today.":`You have ${e} questions left today.`,disclaimer:"Answers are written by AI and can be wrong. Check anything important.",loadingConversation:"Loading the conversation",rateUp:"Helpful",rateDown:"Not helpful",rated:"Thanks for the feedback.",ratingNote:"What was wrong with this answer?",ratingNoteHint:"Optional.",ratingNoteSend:"Send",ratingNoteSkip:"Skip",ratingFailed:"Your rating did not save. Please try again.",actionRaiseTicket:"New support ticket",actionReply:e=>`Reply on ${e}`,actionReopen:e=>`Reopen ${e}`,actionNote:"Nothing is sent until you confirm.",actionConfirm:"Confirm",actionDismiss:"Not now",actionDismissed:"Not sent.",actionExpired:"This request expired and was not sent. Ask again if you still need it.",actionFailed:"We could not send this. Please try again.",actionDoneRaiseTicket:e=>`Ticket ${e} raised.`,actionDoneReply:e=>`Your reply was added to ${e}.`,actionDoneReopen:e=>`${e} is open again.`,viewTicket:"View ticket",conversations:"Past chats",conversationsEmptyTitle:"No past chats",conversationsEmptyText:"Your conversations with the assistant show here.",untitled:"Untitled chat",deleteConversation:"Delete chat",deleteConfirmTitle:"Delete this chat?",deleteConfirmMessage:"The conversation is removed for good.",deleteConfirm:"Delete",deleteFailed:"We could not delete this chat. Please try again.",cancel:"Cancel",loadMore:"Show more",loadFailed:"We could not load your chats. Please try again.",retry:"Try again"});export const mergeLabels=e=>e?{...DEFAULT_CHAT_LABELS,...e}:DEFAULT_CHAT_LABELS;

package/lib/module/sse.js

@@ -1 +0,0 @@
-"use strict";export const createSseParser=e=>{let t="";const dispatch=t=>{let n="message";const r=[];for(const e of t.split("\n")){if(""===e||e.startsWith(":"))continue;const t=e.indexOf(":"),s=-1===t?e:e.slice(0,t);let a=-1===t?"":e.slice(t+1);a.startsWith(" ")&&(a=a.slice(1)),"event"===s?n=a:"data"===s&&r.push(a)}if(0===r.length)return;let s;try{s=JSON.parse(r.join("\n"))}catch{return void e({name:"error",data:{code:"invalid-response",message:null}})}e({name:n,data:s})};return{push(e){if(!e)return;t=(t+e).replace(/\r\n/g,"\n").replace(/\r(?!$)/g,"\n");const n=t.split("\n\n");t=n.pop()??"";for(const e of n)dispatch(e)},end(){const e=t.replace(/\r$/,"");t="",e.trim()&&dispatch(e)}}};

package/lib/module/types.js

@@ -1 +0,0 @@
-"use strict";

package/lib/typescript/commonjs/client.d.ts

@@ -1,73 +0,0 @@
-import type { ChatRatingInput, ChatStreamOptions, ChatTurnInput, ChatTurnResult, Conversation, ConversationSummary } from "./types";
-/** A failed chat request. `message` is written for the person and is safe to show as is. */
-export declare class ChatApiError extends Error {
-    /**
-     * The server's code (`daily_limit`, `assistant_unavailable`, ...), `network` when no response
-     * arrived, `aborted` when the request was cancelled, `invalid-response`, or `unknown`.
-     */
-    readonly code: string;
-    /** The HTTP status, when a response arrived. */
-    readonly status: number | undefined;
-    /** For `daily_limit`: when the allowance comes back, in UTC. */
-    readonly resetsAtUtc: string | null;
-    constructor(code: string, message: string, status?: number, resetsAtUtc?: string | null);
-}
-/** The axios config fields the chat client sets. */
-export interface ChatHttpRequestConfig {
-    headers?: Record<string, string>;
-    responseType?: "text";
-    signal?: AbortSignal;
-    onDownloadProgress?: (progress: unknown) => void;
-}
-/**
- * The slice of an HTTP client the chat client needs. The app's signed-in axios instance
- * (mobile-core's `userClient`, or its own) satisfies it as is, so the bearer token, tenant header
- * and refresh on 401 apply to chat calls too. Declared structurally so no axios type leaks into
- * this package's declarations.
- */
-export interface ChatHttpClient {
-    get(url: string, config?: ChatHttpRequestConfig): Promise<{
-        data: unknown;
-    }>;
-    post(url: string, body?: unknown, config?: ChatHttpRequestConfig): Promise<{
-        data: unknown;
-        status?: number;
-    }>;
-    put(url: string, body?: unknown, config?: ChatHttpRequestConfig): Promise<{
-        data: unknown;
-    }>;
-    delete(url: string, config?: ChatHttpRequestConfig): Promise<{
-        data: unknown;
-    }>;
-}
-export interface ChatClient {
-    /** `POST {base}/chat`, streamed; resolves with the `done` event. */
-    sendMessage(input: ChatTurnInput, options?: ChatStreamOptions): Promise<ChatTurnResult>;
-    /** `GET {base}/allowance`. */
-    getAllowance(): Promise<{
-        messagesLeftToday: number | null;
-    }>;
-    /** `GET {base}/conversations?skip=&take=`, newest first. */
-    listConversations(query?: {
-        skip?: number;
-        take?: number;
-    }): Promise<ConversationSummary[]>;
-    /** `GET {base}/conversations/{id}`. */
-    getConversation(id: string): Promise<Conversation>;
-    /** `DELETE {base}/conversations/{id}`. */
-    deleteConversation(id: string): Promise<void>;
-    /** `PUT {base}/conversations/{conversationId}/messages/{messageId}/rating`. */
-    rateMessage(conversationId: string, messageId: string, input: ChatRatingInput): Promise<void>;
-}
-/**
- * Binds the chat HTTP contract to the app's own signed-in axios instance. The package never
- * handles auth: tokens, tenant headers and refresh stay in the instance.
- *
- * @param http The app's axios instance, e.g. mobile-core's `userClient`.
- * @param options `base` is the prefix the API maps the chat endpoints under, e.g.
- *   `/api/assistant` for `POST /api/assistant/chat`.
- */
-export declare const createChatClient: (http: ChatHttpClient, { base }: {
-    base: string;
-}) => ChatClient;
-//# sourceMappingURL=client.d.ts.map

package/lib/typescript/commonjs/labels.d.ts

@@ -1,63 +0,0 @@
-export interface ChatLabels {
-    launcher: string;
-    panelTitle: string;
-    newChat: string;
-    close: string;
-    thread: string;
-    you: string;
-    assistant: string;
-    thinking: string;
-    emptyTitle: string;
-    emptyText: string;
-    composer: string;
-    placeholder: string;
-    send: string;
-    composerHint: string;
-    allowance: (count: number) => string;
-    disclaimer: string;
-    loadingConversation: string;
-    rateUp: string;
-    rateDown: string;
-    rated: string;
-    ratingNote: string;
-    ratingNoteHint: string;
-    ratingNoteSend: string;
-    ratingNoteSkip: string;
-    ratingFailed: string;
-    actionRaiseTicket: string;
-    actionReply: (ticketNumber: string) => string;
-    actionReopen: (ticketNumber: string) => string;
-    actionNote: string;
-    actionConfirm: string;
-    actionDismiss: string;
-    actionDismissed: string;
-    actionExpired: string;
-    actionFailed: string;
-    actionDoneRaiseTicket: (ticketNumber: string) => string;
-    actionDoneReply: (ticketNumber: string) => string;
-    actionDoneReopen: (ticketNumber: string) => string;
-    viewTicket: string;
-    conversations: string;
-    conversationsEmptyTitle: string;
-    conversationsEmptyText: string;
-    untitled: string;
-    deleteConversation: string;
-    deleteConfirmTitle: string;
-    deleteConfirmMessage: string;
-    deleteConfirm: string;
-    deleteFailed: string;
-    cancel: string;
-    loadMore: string;
-    loadFailed: string;
-    retry: string;
-}
-/**
- * Every word the chat components show, in English, with the same keys as the web assistant's
- * labels, so a product passes one label set to both. Pass a `labels` object with any subset to a
- * component to change its wording; the rest keep these defaults. The few that take a value are
- * functions. `composerHint` describes a hardware keyboard's Enter key and is not shown on a phone.
- */
-export declare const DEFAULT_CHAT_LABELS: Readonly<ChatLabels>;
-/** The defaults with a component's `labels` laid over them. */
-export declare const mergeLabels: (labels?: Partial<ChatLabels>) => ChatLabels;
-//# sourceMappingURL=labels.d.ts.map

package/lib/typescript/commonjs/sse.d.ts

@@ -1,23 +0,0 @@
-export interface SseEvent {
-    /** The `event:` field, or "message" when the block names none. */
-    name: string;
-    /** The `data:` lines joined by newlines and parsed as JSON. */
-    data: unknown;
-}
-export interface SseParser {
-    push: (text: string) => void;
-    end: () => void;
-}
-/**
- * An incremental reader for a `text/event-stream` body that arrives in pieces. Each `push` takes
- * the next piece of text; only complete events (ended by a blank line) are handed on, and the
- * incomplete tail waits for the next piece. `end` flushes a final event the stream closed
- * without a blank line after.
- *
- * Line endings may be `\n`, `\r\n` or `\r`, and a `\r\n` pair may be split across two pieces.
- * Comment lines (`:`), `id` and `retry` are ignored. A block whose data is not JSON is reported
- * as an `error` event with the code `invalid-response`, so a caller ends the turn instead of
- * hanging on it.
- */
-export declare const createSseParser: (onEvent: (event: SseEvent) => void) => SseParser;
-//# sourceMappingURL=sse.d.ts.map

package/lib/typescript/commonjs/types.d.ts

@@ -1,71 +0,0 @@
-/** An action the assistant prepared for the person to confirm. Nothing happens without the token. */
-export interface SupportAction {
-    token: string;
-    kind: "RaiseTicket" | "Reply" | "Reopen";
-    ticketId: string | null;
-    ticketNumber: string | null;
-    category: string | null;
-    subject: string | null;
-    body: string | null;
-    expiresDateTimeUtc: string;
-}
-/** The ticket a confirmed support action raised, replied on or reopened. */
-export interface SupportActionTicket {
-    id: string;
-    number: string;
-}
-export interface ChatTurnInput {
-    /** The person's question. */
-    message: string;
-    /** The conversation to continue; left out or null to start one. */
-    conversationId?: string | null;
-    /** Product-defined context about the screen, passed through as is. */
-    pageContext?: unknown;
-}
-export type ChatStreamEventName = "delta" | "reset" | "actions";
-export interface ChatStreamOptions {
-    /** Cancels the request. */
-    signal?: AbortSignal;
-    /**
-     * Called for each event before the end of the turn: `delta { text }` to append, `reset {}` to
-     * discard what was shown, `actions { actions }` for support cards.
-     */
-    onEvent?: (name: ChatStreamEventName, data: unknown) => void;
-}
-/** The `done` event: the turn's outcome of record. */
-export interface ChatTurnResult {
-    conversationId: string;
-    /** The stored reply's id, for rating; null when storing failed. */
-    messageId: string | null;
-    /** The reply of record. It replaces whatever was streamed. */
-    reply: string;
-    /** Null when the person has no daily limit. */
-    messagesLeftToday: number | null;
-}
-export interface ConversationSummary {
-    publicId: string;
-    title: string | null;
-    createdDateTimeUtc: string;
-    lastMessageDateTimeUtc: string;
-}
-export interface ConversationMessage {
-    publicId: string;
-    role: "User" | "Assistant";
-    content: string;
-    /** The support actions offered with an assistant reply, as a JSON array. */
-    actionsJson: string | null;
-    rating: ChatRating | null;
-    ratingNote: string | null;
-    createdDateTimeUtc: string;
-}
-export interface Conversation {
-    publicId: string;
-    title: string | null;
-    messages: ConversationMessage[];
-}
-export type ChatRating = "Up" | "Down";
-export interface ChatRatingInput {
-    rating: ChatRating;
-    note?: string | null;
-}
-//# sourceMappingURL=types.d.ts.map

package/lib/typescript/module/client.d.ts

@@ -1,73 +0,0 @@
-import type { ChatRatingInput, ChatStreamOptions, ChatTurnInput, ChatTurnResult, Conversation, ConversationSummary } from "./types.js";
-/** A failed chat request. `message` is written for the person and is safe to show as is. */
-export declare class ChatApiError extends Error {
-    /**
-     * The server's code (`daily_limit`, `assistant_unavailable`, ...), `network` when no response
-     * arrived, `aborted` when the request was cancelled, `invalid-response`, or `unknown`.
-     */
-    readonly code: string;
-    /** The HTTP status, when a response arrived. */
-    readonly status: number | undefined;
-    /** For `daily_limit`: when the allowance comes back, in UTC. */
-    readonly resetsAtUtc: string | null;
-    constructor(code: string, message: string, status?: number, resetsAtUtc?: string | null);
-}
-/** The axios config fields the chat client sets. */
-export interface ChatHttpRequestConfig {
-    headers?: Record<string, string>;
-    responseType?: "text";
-    signal?: AbortSignal;
-    onDownloadProgress?: (progress: unknown) => void;
-}
-/**
- * The slice of an HTTP client the chat client needs. The app's signed-in axios instance
- * (mobile-core's `userClient`, or its own) satisfies it as is, so the bearer token, tenant header
- * and refresh on 401 apply to chat calls too. Declared structurally so no axios type leaks into
- * this package's declarations.
- */
-export interface ChatHttpClient {
-    get(url: string, config?: ChatHttpRequestConfig): Promise<{
-        data: unknown;
-    }>;
-    post(url: string, body?: unknown, config?: ChatHttpRequestConfig): Promise<{
-        data: unknown;
-        status?: number;
-    }>;
-    put(url: string, body?: unknown, config?: ChatHttpRequestConfig): Promise<{
-        data: unknown;
-    }>;
-    delete(url: string, config?: ChatHttpRequestConfig): Promise<{
-        data: unknown;
-    }>;
-}
-export interface ChatClient {
-    /** `POST {base}/chat`, streamed; resolves with the `done` event. */
-    sendMessage(input: ChatTurnInput, options?: ChatStreamOptions): Promise<ChatTurnResult>;
-    /** `GET {base}/allowance`. */
-    getAllowance(): Promise<{
-        messagesLeftToday: number | null;
-    }>;
-    /** `GET {base}/conversations?skip=&take=`, newest first. */
-    listConversations(query?: {
-        skip?: number;
-        take?: number;
-    }): Promise<ConversationSummary[]>;
-    /** `GET {base}/conversations/{id}`. */
-    getConversation(id: string): Promise<Conversation>;
-    /** `DELETE {base}/conversations/{id}`. */
-    deleteConversation(id: string): Promise<void>;
-    /** `PUT {base}/conversations/{conversationId}/messages/{messageId}/rating`. */
-    rateMessage(conversationId: string, messageId: string, input: ChatRatingInput): Promise<void>;
-}
-/**
- * Binds the chat HTTP contract to the app's own signed-in axios instance. The package never
- * handles auth: tokens, tenant headers and refresh stay in the instance.
- *
- * @param http The app's axios instance, e.g. mobile-core's `userClient`.
- * @param options `base` is the prefix the API maps the chat endpoints under, e.g.
- *   `/api/assistant` for `POST /api/assistant/chat`.
- */
-export declare const createChatClient: (http: ChatHttpClient, { base }: {
-    base: string;
-}) => ChatClient;
-//# sourceMappingURL=client.d.ts.map

package/lib/typescript/module/labels.d.ts

@@ -1,63 +0,0 @@
-export interface ChatLabels {
-    launcher: string;
-    panelTitle: string;
-    newChat: string;
-    close: string;
-    thread: string;
-    you: string;
-    assistant: string;
-    thinking: string;
-    emptyTitle: string;
-    emptyText: string;
-    composer: string;
-    placeholder: string;
-    send: string;
-    composerHint: string;
-    allowance: (count: number) => string;
-    disclaimer: string;
-    loadingConversation: string;
-    rateUp: string;
-    rateDown: string;
-    rated: string;
-    ratingNote: string;
-    ratingNoteHint: string;
-    ratingNoteSend: string;
-    ratingNoteSkip: string;
-    ratingFailed: string;
-    actionRaiseTicket: string;
-    actionReply: (ticketNumber: string) => string;
-    actionReopen: (ticketNumber: string) => string;
-    actionNote: string;
-    actionConfirm: string;
-    actionDismiss: string;
-    actionDismissed: string;
-    actionExpired: string;
-    actionFailed: string;
-    actionDoneRaiseTicket: (ticketNumber: string) => string;
-    actionDoneReply: (ticketNumber: string) => string;
-    actionDoneReopen: (ticketNumber: string) => string;
-    viewTicket: string;
-    conversations: string;
-    conversationsEmptyTitle: string;
-    conversationsEmptyText: string;
-    untitled: string;
-    deleteConversation: string;
-    deleteConfirmTitle: string;
-    deleteConfirmMessage: string;
-    deleteConfirm: string;
-    deleteFailed: string;
-    cancel: string;
-    loadMore: string;
-    loadFailed: string;
-    retry: string;
-}
-/**
- * Every word the chat components show, in English, with the same keys as the web assistant's
- * labels, so a product passes one label set to both. Pass a `labels` object with any subset to a
- * component to change its wording; the rest keep these defaults. The few that take a value are
- * functions. `composerHint` describes a hardware keyboard's Enter key and is not shown on a phone.
- */
-export declare const DEFAULT_CHAT_LABELS: Readonly<ChatLabels>;
-/** The defaults with a component's `labels` laid over them. */
-export declare const mergeLabels: (labels?: Partial<ChatLabels>) => ChatLabels;
-//# sourceMappingURL=labels.d.ts.map

package/lib/typescript/module/sse.d.ts

@@ -1,23 +0,0 @@
-export interface SseEvent {
-    /** The `event:` field, or "message" when the block names none. */
-    name: string;
-    /** The `data:` lines joined by newlines and parsed as JSON. */
-    data: unknown;
-}
-export interface SseParser {
-    push: (text: string) => void;
-    end: () => void;
-}
-/**
- * An incremental reader for a `text/event-stream` body that arrives in pieces. Each `push` takes
- * the next piece of text; only complete events (ended by a blank line) are handed on, and the
- * incomplete tail waits for the next piece. `end` flushes a final event the stream closed
- * without a blank line after.
- *
- * Line endings may be `\n`, `\r\n` or `\r`, and a `\r\n` pair may be split across two pieces.
- * Comment lines (`:`), `id` and `retry` are ignored. A block whose data is not JSON is reported
- * as an `error` event with the code `invalid-response`, so a caller ends the turn instead of
- * hanging on it.
- */
-export declare const createSseParser: (onEvent: (event: SseEvent) => void) => SseParser;
-//# sourceMappingURL=sse.d.ts.map

package/lib/typescript/module/types.d.ts

@@ -1,71 +0,0 @@
-/** An action the assistant prepared for the person to confirm. Nothing happens without the token. */
-export interface SupportAction {
-    token: string;
-    kind: "RaiseTicket" | "Reply" | "Reopen";
-    ticketId: string | null;
-    ticketNumber: string | null;
-    category: string | null;
-    subject: string | null;
-    body: string | null;
-    expiresDateTimeUtc: string;
-}
-/** The ticket a confirmed support action raised, replied on or reopened. */
-export interface SupportActionTicket {
-    id: string;
-    number: string;
-}
-export interface ChatTurnInput {
-    /** The person's question. */
-    message: string;
-    /** The conversation to continue; left out or null to start one. */
-    conversationId?: string | null;
-    /** Product-defined context about the screen, passed through as is. */
-    pageContext?: unknown;
-}
-export type ChatStreamEventName = "delta" | "reset" | "actions";
-export interface ChatStreamOptions {
-    /** Cancels the request. */
-    signal?: AbortSignal;
-    /**
-     * Called for each event before the end of the turn: `delta { text }` to append, `reset {}` to
-     * discard what was shown, `actions { actions }` for support cards.
-     */
-    onEvent?: (name: ChatStreamEventName, data: unknown) => void;
-}
-/** The `done` event: the turn's outcome of record. */
-export interface ChatTurnResult {
-    conversationId: string;
-    /** The stored reply's id, for rating; null when storing failed. */
-    messageId: string | null;
-    /** The reply of record. It replaces whatever was streamed. */
-    reply: string;
-    /** Null when the person has no daily limit. */
-    messagesLeftToday: number | null;
-}
-export interface ConversationSummary {
-    publicId: string;
-    title: string | null;
-    createdDateTimeUtc: string;
-    lastMessageDateTimeUtc: string;
-}
-export interface ConversationMessage {
-    publicId: string;
-    role: "User" | "Assistant";
-    content: string;
-    /** The support actions offered with an assistant reply, as a JSON array. */
-    actionsJson: string | null;
-    rating: ChatRating | null;
-    ratingNote: string | null;
-    createdDateTimeUtc: string;
-}
-export interface Conversation {
-    publicId: string;
-    title: string | null;
-    messages: ConversationMessage[];
-}
-export type ChatRating = "Up" | "Down";
-export interface ChatRatingInput {
-    rating: ChatRating;
-    note?: string | null;
-}
-//# sourceMappingURL=types.d.ts.map