@lilaquadrat/chat 0.1.17 → 0.1.18

package/dist/types/src/config/chatConfig.d.ts

@@ -1,83 +0,0 @@
-import type { Pinia } from 'pinia';
-import { type Feature } from '@/stores/main.store';
-import { type GetUsersFn } from '@/config/users';
-import { type GetTokenFn } from '@/config/auth';
-import type { ParticipantUser } from '@/helpers/participants';
-/**
- * The host-facing configuration and how it is applied to the stores.
- *
- * This lives apart from bootstrap.ts on purpose. bootstrap.ts statically imports every
- * customer-only component, and rollup tree-shakes by module, not by branch — so a support-agent
- * entry that pulled `applyConfig` out of bootstrap.ts would drag the whole customer widget into
- * its bundle and undo the point of shipping a second element. Both bootstrap paths import from
- * here instead; bootstrap.ts re-exports for existing consumers.
- */
-export interface ChatModuleConfig {
-    /** how the host resolves users. Required for default mode; unused in support mode. */
-    getUsers?: GetUsersFn;
-    /**
-     * enabled features. Defaults to ['chat']. The two are orthogonal:
-     *   ['chat']            = normal user↔user chats only
-     *   ['support']         = support-only widget
-     *   ['chat','support']  = normal chats + an on-demand support chat alongside them
-     */
-    features?: Feature[];
-    /**
-     * @deprecated legacy single-axis mode; use `features` instead.
-     * 'chat'|'default' → ['chat'], 'support' → ['support'], 'both' → ['chat','support'].
-     */
-    mode?: 'chat' | 'support' | 'both' | 'default';
-    /** the current user id. Falls back to the ?user= query param (dev) when omitted. */
-    userId?: string;
-    /**
-     * the current user's own profile (prename/lastname/...). The backend enriches *other*
-     * participants but not the requesting user, so the host passes its own data here to
-     * resolve the current user's name. `id` defaults to `userId` when omitted.
-     */
-    user?: ParticipantUser;
-    /**
-     * @deprecated ignored. The backend owns the support team (everyone holding the
-     * `support:member` scope) and attaches it itself, so a client-side recipient list could
-     * only ever drift from reality. Still accepted so existing embeds keep working.
-     */
-    support?: {
-        participants: string[];
-    };
-    /** websocket endpoint. Defaults to ws://localhost:3001 (dev). */
-    wsUrl?: string;
-    /** API endpoint. Defaults to http://localhost:3000 (dev). */
-    apiUrl?: string;
-    /** media endpoint. Defaults to http://localhost:3000 (dev). */
-    mediaUrl?: string;
-    /** called whenever the unread message/conversation count changes */
-    unread?: (_stats: {
-        unreadMessages: number;
-        unreadConversations: number;
-    }) => void;
-    /** called when the close button in the header is clicked */
-    close?: () => void;
-    /**
-     * notification sounds. On at full volume by default; `false` silences them.
-     * A sound is only played for remote events the user cannot currently see.
-     */
-    sound?: boolean | {
-        enabled?: boolean;
-        volume?: number;
-    };
-    /** the host's OIDC access token. Identity is derived from its `sub`; sent as Bearer + WS auth. */
-    token?: string;
-    /**
-     * host-provided token resolver. Called on every (re)connect; may be async and must always
-     * return a currently-valid token. Receives `true` after AUTH_FAILED to force rotation.
-     * Preferred over the static `token` — identity comes from its `sub`.
-     */
-    getToken?: GetTokenFn;
-}
-/** resolve the enabled features from config: explicit `features` wins, else map legacy `mode`. */
-export declare function resolveFeatures(config: ChatModuleConfig): Feature[];
-/**
- * Apply host configuration to the stores / providers. Shared by every bootstrap path
- * (createChatModule, the <lilaquadrat-studio-chat> element and the support-agent element).
- * Pass the pinia instance when calling outside an active-pinia context.
- */
-export declare function applyConfig(config: ChatModuleConfig, pinia?: Pinia): void;

package/dist/types/src/config/components.shared.d.ts

@@ -1,18 +0,0 @@
-/**
- * Components every bundle needs: the shell App.vue renders plus everything reachable from the
- * chat view (chats → chat → chat-header/chat-input, main-right-target → chat/user details).
- *
- * This lives in its own file on purpose. Rollup only tree-shakes across module boundaries, so a
- * runtime flag inside bootstrap.ts could not drop a single byte — the `import` statements at the
- * top of that file are what pull the components into the bundle. The support-agent entry imports
- * only these two lists and therefore never references the customer-only components at all.
- */
-declare const SHARED_MODULES: {
-    name: string;
-    component: import("vue").DefineComponent<Record<string, unknown>, Record<string, unknown>, unknown>;
-}[];
-declare const SHARED_PARTIALS: {
-    name: string;
-    component: import("vue").DefineComponent<Record<string, unknown>, Record<string, unknown>, unknown>;
-}[];
-export { SHARED_MODULES, SHARED_PARTIALS, };

package/dist/types/src/config/users.d.ts

@@ -1,27 +0,0 @@
-/**
- * Pluggable user source.
- *
- * The chat module never hardcodes its users. The host application provides the
- * implementation once, via `createChatModule({ getUsers })` (see main.ts) or by
- * calling `setGetUsers()` directly before the contacts UI is used. This lets every
- * host plug in its own backend (REST, OIDC, in-memory, ...).
- */
-export interface ChatUser {
-    id: string;
-    prename?: string;
-    lastname?: string;
-    name?: string;
-    status?: string;
-}
-export interface GetUsersOptions {
-    /** restrict to specific user ids (e.g. to resolve participant names) */
-    ids?: string[];
-    /** free-text search/filter */
-    query?: string;
-}
-export type GetUsersFn = (_options?: GetUsersOptions) => Promise<ChatUser[]> | ChatUser[];
-/** register the host implementation. last call wins. */
-export declare function setGetUsers(fn: GetUsersFn): void;
-export declare function hasGetUsers(): boolean;
-/** resolve users through the registered implementation. returns [] (with a warning) if none was set. */
-export declare function getUsers(options?: GetUsersOptions): Promise<ChatUser[]>;

package/dist/types/src/helpers/date.d.ts

@@ -1,7 +0,0 @@
-import dayjs from 'dayjs';
-import 'dayjs/locale/de';
-import 'dayjs/locale/en';
-declare function date(date: string | Date | dayjs.Dayjs, format?: string): string;
-declare function time(date: string | Date | dayjs.Dayjs, format?: string): string;
-declare function dateRelative(date: string | Date | dayjs.Dayjs): string;
-export { date, time, dateRelative, dayjs };

package/dist/types/src/helpers/handleMessages.d.ts

@@ -1,2 +0,0 @@
-import type { IncomingFrame } from '@/interfaces/IncomingFrame';
-export default function handleMessages(message: IncomingFrame): void;

package/dist/types/src/helpers/loadComponents.d.ts

@@ -1,10 +0,0 @@
-import { type App, type Component, type AsyncComponentLoader } from 'vue';
-declare function loadViaDeclaration(components: {
-    name: string;
-    component: AsyncComponentLoader<Component>;
-}[], namespace: string | undefined, type: 'module' | 'partial', app: App<Element>): void;
-declare function loadViaDeclarationSync(components: {
-    name: string;
-    component: Component;
-}[], namespace: string | undefined, type: 'module' | 'partial', app: App<Element>): void;
-export { loadViaDeclaration, loadViaDeclarationSync, };

package/dist/types/src/helpers/participants.d.ts

@@ -1,50 +0,0 @@
-/**
- * Participants arrive in two shapes: backend-enriched objects ({ id, prename, ... })
- * on real conversations, and bare id strings on local drafts (and on the write path
- * we send back to the server). These helpers normalize both so comparisons, keys and
- * display work regardless of shape.
- */
-export interface ParticipantUser {
-    id: string;
-    prename?: string;
-    lastname?: string;
-    email?: string;
-    /** host-provided contact name (see @/config/users ChatUser) */
-    name?: string;
-    /** presence: last proof of life as an ISO string; absent for a user who never connected */
-    lastSeen?: string;
-    /** presence: derived server-side from lastSeen freshness, pushed live via user:presence */
-    online?: boolean;
-    /**
-     * the participant's role in the conversation. `'agent'` for a member of the support team.
-     *
-     * `null`, not absent, for everyone else: the backend collapses two different absences with an
-     * `$ifNull` (no participant doc at all vs. a doc carrying no role) so that both the REST row
-     * and the `conversation:new` frame carry the key on every participant. Never test for
-     * `undefined` or `'role' in participant` — that would hold on one path and not the other.
-     * Optional here only because a local draft's participants are built client-side.
-     */
-    role?: 'agent' | null;
-}
-export type Participant = string | ParticipantUser;
-/** the user id of a participant, whether it's a bare id or an object */
-export declare function participantId(participant: Participant): string;
-/** map a participant list to its ids (e.g. before sending to the backend) */
-export declare function participantIds(participants?: Participant[]): string[];
-/**
- * the person being helped in a support conversation: the participant NOT marked
- * `role: 'agent'`. There is no separate customer entity — a support conversation is a
- * conversation whose participants carry roles, and this reads the counterpart back out.
- *
- * Matched by inequality against `'agent'`, deliberately: the counterpart's role arrives as
- * `null` from the server and is absent on a client-built draft, so anything testing for
- * `undefined` specifically would hold on one path and not the other.
- *
- * undefined when nothing in the list distinguishes anyone. That is the legacy case
- * (conversations from before roles were stamped mark nobody): with no agent marked, every
- * participant looks alike, and guessing would name an agent as the person being helped.
- * Callers show an unknown counterpart instead.
- */
-export declare function customerParticipant(participants?: Participant[]): ParticipantUser | undefined;
-/** human-readable name: "lastname, prename", else host name, else the raw id */
-export declare function participantName(participant: Participant): string;

package/dist/types/src/helpers/rights.d.ts

@@ -1,19 +0,0 @@
-export interface ConversationRightsSource {
-    isNew?: boolean;
-    participant?: {
-        state?: string;
-        rights?: string[];
-    };
-}
-type Conversation = ConversationRightsSource | null | undefined;
-/**
- * still a member? drafts count, every non-active backend state does not — the server
- * knows 'active' | 'left' | 'removed' | 'blocked' | 'deleted' and keeps only 'active'
- * participants in `conversation.participants` (see participants.service).
- * A missing state means the payload does not track it — treated as a member, the
- * rights check below still applies.
- */
-export declare function isActiveParticipant(conversation: Conversation): boolean;
-/** membership plus the named right ('read' | 'write' | 'rename' | 'participants' | 'block') */
-export declare function can(conversation: Conversation, right: string): boolean;
-export default can;

package/dist/types/src/helpers/sdkOptions.d.ts

@@ -1,17 +0,0 @@
-/**
- * Options for a StudioSDK instance: a currently-valid token plus the configured endpoints.
- *
- * The token is re-resolved through the host's `getToken` on every call rather than read once at
- * boot. The WS session already re-authenticates with a fresh token on every (re)connect (see
- * libs/chatSession.ts); without this, HTTP kept sending the boot-time token and started to 401
- * once it expired — harmless in a host app that reloads often, fatal for a standalone tab left
- * open. Hosts that pass only a static `token` are unaffected: resolveToken() returns undefined
- * and the stored token is used.
- */
-export default function sdkOptions(): Promise<{
-    authToken: string;
-    customEndpoints: {
-        api: string;
-        media: string;
-    };
-}>;

package/dist/types/src/helpers/sounds.d.ts

@@ -1,8 +0,0 @@
-export type SoundName = 'new-message' | 'new-conversation';
-/**
- * Play a notification sound. Never throws and never rejects: browsers refuse audio until
- * the page has seen a user gesture, and a machine without an output device rejects too —
- * neither is worth surfacing for something purely decorative.
- */
-export declare function playSound(name: SoundName, volume?: number): void;
-export default playSound;

package/dist/types/src/helpers/supportStatus.d.ts

@@ -1,15 +0,0 @@
-import type { ConversationSla } from '@/interfaces/ConversationSla';
-export declare const SUPPORT_STATUSES: readonly ["awaiting_agent", "awaiting_customer", "resolved"];
-export type SupportStatus = typeof SUPPORT_STATUSES[number];
-export type SupportStatusFilter = SupportStatus | 'all';
-export interface SupportStatusResponse {
-    conversation: string;
-    status: SupportStatus;
-    updatedAt: string;
-    version: number;
-    sla: ConversationSla | null;
-    serverTime: string;
-}
-export declare const DEFAULT_SUPPORT_STATUS: SupportStatus;
-export declare function isSupportStatus(value: unknown): value is SupportStatus;
-export declare function normalizeSupportStatus(value: unknown): SupportStatus;

package/dist/types/src/interfaces/Conversation.d.ts

@@ -1,44 +0,0 @@
-import type { Participant } from '@/helpers/participants';
-import type { SupportStatus } from '@/helpers/supportStatus';
-import type { Message } from '@/interfaces/Message';
-import type { ParticipantDocument } from '@/interfaces/ParticipantDocument';
-import type { ConversationSla } from '@/interfaces/ConversationSla';
-export type ConversationOperationMode = 'chat' | 'support';
-export interface Conversation {
-    _id?: string;
-    id?: string;
-    name?: string;
-    participants: Participant[];
-    blocked?: string[];
-    messagesCount?: number;
-    messagesCountSystem?: number;
-    createdAt?: string;
-    lastActivity?: string;
-    operationMode: ConversationOperationMode;
-    supportStatus?: SupportStatus;
-    supportStatusUpdatedAt?: string;
-    supportStatusVersion?: number;
-    sla?: ConversationSla | null;
-    participant?: ParticipantDocument;
-    participantDocs?: ParticipantDocument[];
-    lastMessage?: Message;
-    oldestMessageId?: number | null;
-    messages?: Message[];
-    messagesLoaded?: boolean;
-    unreadCount?: number;
-    unread?: boolean;
-    isMember?: boolean;
-    isNew?: boolean;
-    isTemp?: boolean;
-    creator?: string;
-}
-export type ConversationPayload = Omit<Conversation, '_id' | 'operationMode' | 'participants'> & {
-    _id: string;
-    operationMode?: 'default' | ConversationOperationMode;
-    participants?: Participant[];
-};
-export type SupportConversationPage = {
-    data: ConversationPayload[];
-    hasMore: boolean;
-    serverTime?: string;
-};

package/dist/types/src/interfaces/ConversationSla.d.ts

@@ -1,9 +0,0 @@
-import type { SupportStatus } from '@/helpers/supportStatus';
-export interface ConversationSla {
-    conversation: string;
-    status: SupportStatus;
-    statusVersion: number;
-    startedAt: string;
-    endAt: string;
-    stoppedAt?: string;
-}

package/dist/types/src/interfaces/IncomingFrame.d.ts

@@ -1,71 +0,0 @@
-import type { Participant } from '@/helpers/participants';
-import type { SupportStatus } from '@/helpers/supportStatus';
-import type { ConversationPayload } from '@/interfaces/Conversation';
-import type { Message } from '@/interfaces/Message';
-import type { ConversationSla } from '@/interfaces/ConversationSla';
-export type ConversationNewFrame = ConversationPayload & {
-    type: 'conversation:new';
-};
-export type ConversationRenamedFrame = {
-    type: 'conversation:renamed';
-    conversation: string;
-    names: {
-        to: string;
-    };
-};
-export type ConversationParticipantsFrame = {
-    type: 'conversation:participants';
-    conversation: string;
-    participants: Participant[];
-};
-export type ConversationUserFrame = {
-    type: 'conversation:left';
-    conversation: string;
-    user: string;
-};
-export type ConversationRemovedFrame = {
-    type: 'conversation:removed';
-    conversation: string;
-};
-export type ConversationMutedFrame = {
-    type: 'conversation:muted';
-    conversation: string;
-    muted: boolean;
-};
-export type ConversationStatusFrame = {
-    type: 'conversation:status';
-    conversation: string;
-    status: SupportStatus;
-    version: number;
-    updatedAt: string;
-    sla: ConversationSla | null;
-    serverTime: string;
-};
-export type ConversationRightsFrame = {
-    type: 'conversation:rights';
-    conversation: string;
-    user: string;
-    rights: string[];
-};
-export type ConversationTypingFrame = {
-    type: 'conversation:typing';
-    conversation: string;
-    user: string;
-    typing: boolean;
-};
-export type UserPresenceFrame = {
-    type: 'user:presence';
-    user: string;
-    online: boolean;
-    lastSeen?: string;
-};
-export type ErrorFrame = {
-    type: 'error';
-    error?: unknown;
-    messageType?: string;
-};
-export type MessageFrame = Message & {
-    type: 'message';
-};
-export type IncomingFrame = ConversationNewFrame | ConversationRenamedFrame | ConversationParticipantsFrame | ConversationUserFrame | ConversationRemovedFrame | ConversationMutedFrame | ConversationStatusFrame | ConversationRightsFrame | ConversationTypingFrame | UserPresenceFrame | ErrorFrame | MessageFrame;
-export declare function isIncomingFrame(value: unknown): value is IncomingFrame;

package/dist/types/src/interfaces/Message.d.ts

@@ -1,18 +0,0 @@
-export type MessageHistory = {
-    created: string;
-    updated?: string;
-};
-export interface Message {
-    _id?: string;
-    id: number;
-    conversation: string;
-    user?: string;
-    message?: string;
-    origin: 'user' | 'system';
-    history: MessageHistory;
-    action?: string;
-    actionData?: Record<string, unknown>;
-    clientMessageId?: string;
-    duplicate?: boolean;
-    isUser?: boolean;
-}

package/dist/types/src/interfaces/ParticipantDocument.d.ts

@@ -1,13 +0,0 @@
-export type ParticipantState = 'active' | 'left' | 'removed' | 'blocked' | 'deleted';
-export interface ParticipantDocument {
-    _id?: string;
-    conversation: string;
-    user: string;
-    state: ParticipantState;
-    rights: string[];
-    lastReadId?: number;
-    latestMessageId?: number;
-    muted?: boolean;
-    role?: 'agent';
-    joinedAt?: string;
-}

package/dist/types/src/libs/StudioSDK.d.ts

@@ -1,148 +0,0 @@
-import { type AxiosResponse, type AxiosRequestConfig } from 'axios';
-import type { SupportStatus, SupportStatusResponse } from '@/helpers/supportStatus';
-import type { ConversationPayload, SupportConversationPage } from '@/interfaces/Conversation';
-import type { Message } from '@/interfaces/Message';
-import type { ParticipantDocument } from '@/interfaces/ParticipantDocument';
-import type { ChatUser } from '@/config/users';
-type HttpStatusCode = number;
-export type SDKResponse<T> = {
-    data: T;
-    status: HttpStatusCode;
-    cacheLifetime?: number;
-    cacheTime?: number;
-    isCache?: boolean;
-};
-export type SDKCache = {
-    group?: string;
-    action?: string;
-    id?: string;
-    cacheLifetime?: number;
-    cacheTime?: number;
-};
-export type SDKCallOptions = {
-    /**
-     * ignore the cache and always execute the call
-     */
-    bypassCache?: boolean;
-    group?: string;
-    action?: string;
-    /**
-     * if a id is given, use it as key for atomic cache flushing
-     *
-     * e.g. ``flushId(id)``
-     *
-     * instead of the whole action category
-     *
-     * e.g. ``flushCache(group, action)``
-     *
-     */
-    id?: string;
-    /**
-     * in milliseconds
-     */
-    cacheLifetime?: number;
-};
-export default class StudioSDK {
-    readonly endpoints: {
-        live: {
-            api: string;
-            media: string;
-        };
-        next: {
-            api: string;
-            media: string;
-        };
-    };
-    customEndpoints: {
-        api: string;
-        media: string;
-    };
-    authToken: string;
-    mode: 'live' | 'next' | 'custom';
-    company: string;
-    project: string;
-    app: string;
-    universalModel: string;
-    options: {
-        company?: string;
-        project?: string;
-        authToken?: string;
-        mode?: StudioSDK['mode'];
-        customEndpoints?: {
-            api: string;
-            media: string;
-        };
-        universalModel?: string;
-    };
-    constructor(app: string, options: StudioSDK['options']);
-    private getUrl;
-    private getHeaders;
-    static getCacheKeyMock(url: string): string;
-    static getCacheKey(url: string): string;
-    static getCache(): Record<string, SDKResponse<unknown> & SDKCache>;
-    static handleCall<T, D = unknown>(call: AxiosRequestConfig<D>, options?: SDKCallOptions): Promise<SDKResponse<T>>;
-    static cache<T>(url: string, response?: AxiosResponse<T>, options?: SDKCallOptions): SDKResponse<T> & SDKCache;
-    static flushCache(group?: string, action?: string): void;
-    /**
-    * one id can hold several entries (one per query string, e.g. every `beforeId` page of a
-    * conversation), so flushing has to drop all of them — otherwise a new message would only
-    * invalidate the page whose url happened to match.
-    */
-    static flushId(id: string): void;
-    conversations: {
-        list: () => Promise<SDKResponse<ConversationPayload[]>>;
-        activate: () => Promise<SDKResponse<unknown>>;
-        create: (data: {
-            participants: string[];
-        }) => Promise<SDKResponse<unknown>>;
-        rename: (conversationId: string, name: string) => Promise<SDKResponse<unknown>>;
-        participants: (conversationId: string, add: string[], remove: string[]) => Promise<SDKResponse<unknown>>;
-        leave: (conversationId: string) => Promise<SDKResponse<unknown>>;
-        /**
-        * POST, not DELETE: this removes the conversation for the CALLER only (their participant
-        * state goes to 'deleted' server-side), it does not delete the resource for everyone.
-        */
-        delete: (conversationId: string) => Promise<SDKResponse<unknown>>;
-        listParticipants: (conversationId: string) => Promise<SDKResponse<ParticipantDocument[]>>;
-        rights: (conversationId: string, user: string, rights: string[]) => Promise<SDKResponse<unknown>>;
-        /**
-        * silence the conversation for the CALLER only. Stored on their participant doc and never
-        * broadcast to the other members — muting is private.
-        */
-        mute: (conversationId: string, muted: boolean) => Promise<SDKResponse<unknown>>;
-        block: (conversationId: string, user: string, block: boolean) => Promise<SDKResponse<unknown>>;
-    };
-    contacts: {
-        list: (search?: string) => Promise<SDKResponse<ChatUser[]>>;
-        single: (contactId: string) => Promise<SDKResponse<ChatUser>>;
-        block: (contactId: string) => Promise<SDKResponse<unknown>>;
-        unblock: (contactId: string) => Promise<SDKResponse<unknown>>;
-    };
-    messages: {
-        list: (conversation: string, beforeId?: number) => Promise<SDKResponse<Message[]>>;
-    };
-    support: {
-        /**
-        * every support conversation the staff can see, newest activity first. Mirrors
-        * conversations.list() for the agent side. Keyset pagination — pass the last row's
-        * `lastActivity` as `before` and its `_id` as `beforeId`.
-        *
-        * Its own cache GROUP on purpose, even though the action is now also called 'list'.
-        * deleteConversation() and setMuted() flush ('conversations','list') to drop a stale
-        * customer list; if this shared that group a flush would take it with it — and, worse, this
-        * loader's own reload() flushing 'conversations' would throw away a list the agent console
-        * never even loads.
-        */
-        list: (options?: {
-            limit?: number;
-            before?: string;
-            beforeId?: string;
-            status?: SupportStatus;
-        }) => Promise<SDKResponse<SupportConversationPage>>;
-        setStatus: (conversationId: string, status: SupportStatus, version: number) => Promise<SDKResponse<SupportStatusResponse>>;
-    };
-    health: {
-        health: () => Promise<SDKResponse<void>>;
-    };
-}
-export {};