@athoscommerce/snap-store-mobx 1.5.0 → 1.5.1-beta.110

package/dist/esm/Chat/Stores/ChatAttachmentStore.js

@@ -0,0 +1,222 @@
+// TODO: implement
+// how should localStorage be handled for attachments?
+import { v4 as uuidv4 } from 'uuid';
+import { makeObservable, observable, computed } from 'mobx';
+import { CHAT_COMPARISON_MAX } from './ChatCompareStore';
+export class ChatAttachmentStore {
+    constructor() {
+        this.items = [];
+        makeObservable(this, {
+            items: observable,
+            attached: computed,
+            compared: computed,
+        });
+    }
+    get attached() {
+        return this.items.filter((item) => item.state !== 'saved');
+    }
+    get compared() {
+        return this.items
+            .filter((item) => item.state !== 'saved')
+            .filter((item) => item.type === 'product')
+            .filter((item) => item.requestType === 'productComparison');
+    }
+    add(attachment) {
+        // TODO: check if attachment already exists
+        switch (attachment.type) {
+            case 'image': {
+                // if there are currently any other attachments remove them
+                this.items.forEach((item) => {
+                    this.remove(item.id);
+                });
+                const newAttachment = new ChatAttachmentImage(attachment);
+                this.items.push(newAttachment);
+                return newAttachment;
+            }
+            case 'product': {
+                // 'productSimilar' and 'productQuery' are single-product flows — replace any
+                // existing attachments so the conversation only targets the latest product
+                if (attachment.requestType === 'productSimilar' || attachment.requestType === 'productQuery') {
+                    this.items.forEach((item) => {
+                        this.remove(item.id);
+                    });
+                    const newAttachment = new ChatAttachmentProduct(attachment);
+                    this.items.unshift(newAttachment);
+                    return newAttachment;
+                }
+                // For 'productQuery' or 'productComparison', continue with existing logic
+                // if there are currently any other attachments remove them
+                this.items.forEach((item) => {
+                    if (item.type !== 'product') {
+                        this.remove(item.id);
+                    }
+                });
+                // check if product is already attached
+                const existingProductAttachment = this.items.find((item) => item.type === 'product' &&
+                    (item.state === 'active' || item.state === 'attached') &&
+                    item.productId === attachment.productId);
+                if (existingProductAttachment) {
+                    existingProductAttachment.requestType = attachment.requestType; // changes existing attachments to the incoming requestType
+                    return existingProductAttachment;
+                }
+                // productComparison supports up to CHAT_COMPARISON_MAX products (matches ChatCompareStore.maxItems);
+                // trim oldest active/attached product attachments to keep total below the cap.
+                const productAttachments = this.items.filter((item) => item.type === 'product' && (item.state === 'active' || item.state === 'attached'));
+                while (productAttachments.length >= CHAT_COMPARISON_MAX) {
+                    const toRemove = productAttachments.pop();
+                    if (toRemove) {
+                        this.remove(toRemove.id);
+                    }
+                }
+                this.items.forEach((item) => {
+                    item.requestType = attachment.requestType; // changes existing attachments to the incoming requestType
+                });
+                const newAttachment = new ChatAttachmentProduct(attachment);
+                this.items.unshift(newAttachment);
+                return newAttachment;
+            }
+            case 'facet': {
+                // if there are currently any non-facet attachments remove them
+                this.items.forEach((item) => {
+                    if (item.type !== 'facet') {
+                        this.remove(item.id);
+                    }
+                });
+                // check if this exact facet value is already attached
+                const existingFacet = this.items.find((item) => item.type === 'facet' &&
+                    item.key === attachment.key &&
+                    item.value === attachment.value &&
+                    (item.state === 'active' || item.state === 'attached'));
+                if (existingFacet) {
+                    return existingFacet;
+                }
+                const newAttachment = new ChatAttachmentFacet(attachment);
+                this.items.push(newAttachment);
+                return newAttachment;
+            }
+        }
+    }
+    remove(id) {
+        const index = this.items.findIndex((item) => item.id === id);
+        const attachment = this.items[index];
+        if (attachment.state === 'active' || attachment.state === 'saved') {
+            attachment.save();
+        }
+        else {
+            if (index !== -1) {
+                this.items.splice(index, 1);
+            }
+        }
+    }
+    get(id) {
+        return this.items.find((item) => item.id === id);
+    }
+    reset() {
+        this.items = [];
+    }
+    // Restore serialized attachments from storage without running the add() dedup logic,
+    // which would otherwise drop earlier images when multiple attachments are loaded.
+    hydrate(attachments) {
+        attachments.forEach((attachment) => {
+            switch (attachment.type) {
+                case 'image':
+                    this.items.push(new ChatAttachmentImage(attachment));
+                    break;
+                case 'product':
+                    this.items.push(new ChatAttachmentProduct(attachment));
+                    break;
+                case 'facet':
+                    this.items.push(new ChatAttachmentFacet(attachment));
+                    break;
+            }
+        });
+    }
+}
+class ChatAttachment {
+    constructor(params = {}) {
+        this.state = 'loading';
+        this.error = undefined;
+        this.id = params.data?.id ?? uuidv4();
+        this.state = params.data?.state ?? 'loading';
+        makeObservable(this, {
+            id: observable,
+            state: observable,
+            error: observable,
+        });
+    }
+    save() {
+        this.state = 'saved';
+    }
+    activate() {
+        this.state = 'active';
+    }
+}
+export class ChatAttachmentProduct extends ChatAttachment {
+    constructor({ id, productId, thumbnailUrl, name, requestType, state, error }) {
+        super({ data: { id, state, error } });
+        this.type = 'product';
+        this.state = state ?? 'attached';
+        this.productId = productId;
+        this.thumbnailUrl = thumbnailUrl;
+        this.name = name;
+        this.requestType = requestType;
+        makeObservable(this, {
+            type: observable,
+            productId: observable,
+            thumbnailUrl: observable,
+            name: observable,
+            requestType: observable,
+        });
+    }
+}
+export class ChatAttachmentFacet extends ChatAttachment {
+    constructor({ id, key, facetLabel, value, label, count, state, error }) {
+        super({ data: { id, state, error } });
+        this.type = 'facet';
+        this.state = state ?? 'attached';
+        this.key = key;
+        this.facetLabel = facetLabel;
+        this.value = value;
+        this.label = label;
+        this.count = count;
+        makeObservable(this, {
+            type: observable,
+            key: observable,
+            facetLabel: observable,
+            value: observable,
+            label: observable,
+        });
+    }
+}
+export class ChatAttachmentImage extends ChatAttachment {
+    constructor({ id, base64, fileName, imageId, imageUrl, thumbnailUrl, state, error }) {
+        super({ data: { id, state, error } });
+        this.type = 'image';
+        // used to update attachment after upload or from
+        this.update = async ({ imageId, imageUrl, thumbnailUrl, error, }) => {
+            if (imageId && imageUrl && thumbnailUrl) {
+                this.state = 'attached';
+                this.imageId = imageId;
+                this.imageUrl = imageUrl;
+                this.thumbnailUrl = thumbnailUrl;
+            }
+            else if (error) {
+                this.state = 'error';
+                this.error = error;
+            }
+        };
+        this.base64 = base64;
+        this.fileName = fileName;
+        this.imageId = imageId;
+        this.imageUrl = imageUrl;
+        this.thumbnailUrl = thumbnailUrl;
+        makeObservable(this, {
+            type: observable,
+            imageId: observable,
+            imageUrl: observable,
+            thumbnailUrl: observable,
+            base64: observable,
+            fileName: observable,
+        });
+    }
+}

package/dist/esm/Chat/Stores/ChatCompareStore.d.ts

@@ -0,0 +1,16 @@
+/** Maximum number of products that can be added to a chat comparison. */
+export declare const CHAT_COMPARISON_MAX = 4;
+export declare class ChatCompareStore {
+    items: any[];
+    committedItems: any[];
+    maxItems: number;
+    constructor();
+    add(item: any): void;
+    remove(itemId: string): void;
+    reset(): void;
+    resetCommitted(): void;
+    commit(): void;
+    get compared(): any[];
+    get committed(): any[];
+}
+//# sourceMappingURL=ChatCompareStore.d.ts.map

package/dist/esm/Chat/Stores/ChatCompareStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatCompareStore.d.ts","sourceRoot":"","sources":["../../../../src/Chat/Stores/ChatCompareStore.ts"],"names":[],"mappings":"AAEA,yEAAyE;AACzE,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC,qBAAa,gBAAgB;IACrB,KAAK,EAAE,GAAG,EAAE,CAAM;IAClB,cAAc,EAAE,GAAG,EAAE,CAAM;IAC3B,QAAQ,EAAE,MAAM,CAAuB;;IAa9C,GAAG,CAAC,IAAI,EAAE,GAAG;IAYb,MAAM,CAAC,MAAM,EAAE,MAAM;IAIrB,KAAK;IAIL,cAAc;IAKd,MAAM;IAON,IAAI,QAAQ,UAEX;IAED,IAAI,SAAS,UAEZ;CACD"}

package/dist/esm/Chat/Stores/ChatCompareStore.js

@@ -0,0 +1,51 @@
+import { computed, makeObservable, observable } from 'mobx';
+/** Maximum number of products that can be added to a chat comparison. */
+export const CHAT_COMPARISON_MAX = 4;
+export class ChatCompareStore {
+    constructor() {
+        this.items = [];
+        this.committedItems = [];
+        this.maxItems = CHAT_COMPARISON_MAX;
+        makeObservable(this, {
+            items: observable,
+            committedItems: observable,
+            maxItems: observable,
+            compared: computed,
+            committed: computed,
+        });
+    }
+    // add, remove, reset methods
+    add(item) {
+        // prevent adding the same product to the comparison twice
+        if (item.result?.id && this.items.some((existing) => existing.result?.id === item.result.id)) {
+            return;
+        }
+        if (this.items.length >= this.maxItems) {
+            // handle max items reached, e.g. remove the oldest item
+            this.items.shift();
+        }
+        this.items.push(item);
+    }
+    remove(itemId) {
+        this.items = this.items.filter((item) => item.result?.id !== itemId);
+    }
+    reset() {
+        this.items = [];
+    }
+    resetCommitted() {
+        this.committedItems = [];
+    }
+    // move the current items to the committed list and clear items
+    commit() {
+        if (this.items.length > 0) {
+            this.committedItems = this.items.slice();
+            this.items = [];
+        }
+    }
+    get compared() {
+        return this.items;
+    }
+    get committed() {
+        return this.committedItems;
+    }
+}

package/dist/esm/Chat/Stores/ChatSessionStore.d.ts

@@ -0,0 +1,107 @@
+import type { ChatResponseModel, ChatRequestModel, ChatResponseTextData, ChatResponseProductSearchResultData, ChatResponseInspirationResultData, ChatResponseContentData, ChatResponseProductAnswerData, ChatResponseProductComparisonData, ChatResponseProductRecommendationData, ChatResponseErrorData, ChatResponseTopicDriftData } from '@athoscommerce/snap-client';
+import { ChatAttachmentAddAttachment, ChatAttachmentStore } from '../Stores/ChatAttachmentStore';
+import type { StorageStore } from '@athoscommerce/snap-toolbox';
+import { MetaResponseModel } from '@athoscommerce/snapi-types';
+import { ChatCompareStore } from './ChatCompareStore';
+export type ChatFeedbacks = {
+    messageId: string;
+    rating: 'UP' | 'DOWN';
+};
+export type ChatSessionFeedback = {
+    rating: 'UP' | 'DOWN';
+};
+export type ChatUserMessage = {
+    id: string;
+    messageType: 'user';
+    text: string;
+    attachments?: string[];
+    requestType?: string;
+    request?: Record<string, any>;
+};
+export type ChatProductQueryMessageData = {
+    id: string;
+    messageType: 'productQuery';
+    sourceProduct: any;
+    sourceMessageId?: string;
+};
+export type ChatSystemMessage = ChatResponseTextData | ChatResponseContentData | ChatResponseProductSearchResultData | ChatResponseInspirationResultData | ChatResponseProductAnswerData | ChatResponseProductComparisonData | ChatResponseProductRecommendationData | ChatResponseErrorData | ChatResponseTopicDriftData | ChatProductQueryMessageData;
+export type ChatMessage = ChatUserMessage | ChatSystemMessage;
+type ChatSessionStoreConfig = {
+    data?: {
+        id?: string;
+        sessionId?: string;
+        chat?: ChatMessage[];
+        attachments?: ChatAttachmentAddAttachment[];
+        actions?: ChatActions;
+        feedbacks?: ChatFeedbacks[];
+        sessionFeedback?: ChatSessionFeedback | null;
+        feedbackDismissed?: boolean;
+        createdAt?: Date;
+        sessionEndTime?: Date;
+        committedComparisons?: any[];
+    };
+    stores: {
+        storage: StorageStore;
+    };
+};
+export type ActionsData = {
+    type: 'actions';
+    data: any;
+};
+export type ChatActions = ActionsData[];
+/** Snapshot of facet labels keyed by field — used to render the user message text for a productSearch request. */
+export type FilterLabelMap = Record<string, {
+    facetLabel: string;
+    values: Record<string, string>;
+}>;
+export declare class ChatSessionStore {
+    chat: ChatMessage[];
+    actions: ChatActions;
+    id: string;
+    sessionId?: string;
+    attachments: ChatAttachmentStore;
+    comparisons: ChatCompareStore;
+    storage: StorageStore;
+    feedbacks: ChatFeedbacks[];
+    sessionFeedback: ChatSessionFeedback | null;
+    feedbackDismissed: boolean;
+    feedbackJustGiven: boolean;
+    createdAt: Date;
+    sessionEndTime?: Date;
+    requestType: string;
+    dismissedSideChatMessageId: string | null;
+    activeMessageId: string | null;
+    sessionLimitReached: boolean;
+    /** Whether raw stored results have been hydrated into Product/SearchResultStore instances. */
+    hydrated: boolean;
+    constructor(params: ChatSessionStoreConfig);
+    dismissSideChat(): void;
+    setActiveMessage(id: string): void;
+    pushProductQueryMessage(result: any): void;
+    popProductQueryMessage(restoreActiveMessageId?: string): void;
+    get isExpired(): boolean;
+    get topicDrift(): ChatResponseTopicDriftData | null;
+    get activeMessage(): ChatMessage | null;
+    dismissTopicDrift(): void;
+    handleTopicDrift(): string | undefined;
+    reset(): void;
+    private saveTimerId;
+    /** Persist the session to storage immediately (synchronous). */
+    saveImmediate(): void;
+    /**
+     * Schedule a save — multiple calls within the debounce window are coalesced
+     * into a single localStorage write.
+     */
+    save(): void;
+    /** Remove oldest stored sessions when exceeding the limit. */
+    static pruneStoredSessions(storage: StorageStore, maxSessions?: number): void;
+    /** Re-wrap raw stored results as Product / SearchResultStore instances. */
+    hydrateResults(meta: MetaResponseModel): void;
+    request(request: ChatRequestModel, filterLabels?: FilterLabelMap): void;
+    update(data: {
+        chat: ChatResponseModel;
+        meta: MetaResponseModel;
+    }): void;
+}
+export {};
+//# sourceMappingURL=ChatSessionStore.d.ts.map

package/dist/esm/Chat/Stores/ChatSessionStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatSessionStore.d.ts","sourceRoot":"","sources":["../../../../src/Chat/Stores/ChatSessionStore.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACX,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,mCAAmC,EACnC,iCAAiC,EACjC,uBAAuB,EACvB,6BAA6B,EAC7B,iCAAiC,EACjC,qCAAqC,EACrC,qBAAqB,EACrB,0BAA0B,EAC1B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACN,2BAA2B,EAI3B,mBAAmB,EACnB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAA6B,MAAM,4BAA4B,CAAC;AAC1F,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAsItD,MAAM,MAAM,aAAa,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;CAAE,CAAC;AAEzE,MAAM,MAAM,mBAAmB,GAAG;IAAE,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;CAAE,CAAC;AAE5D,MAAM,MAAM,eAAe,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,cAAc,CAAC;IAC5B,aAAa,EAAE,GAAG,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAC1B,oBAAoB,GACpB,uBAAuB,GACvB,mCAAmC,GACnC,iCAAiC,GACjC,6BAA6B,GAC7B,iCAAiC,GACjC,qCAAqC,GACrC,qBAAqB,GACrB,0BAA0B,GAC1B,2BAA2B,CAAC;AAE/B,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,iBAAiB,CAAC;AAE9D,KAAK,sBAAsB,GAAG;IAC7B,IAAI,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC;QACrB,WAAW,CAAC,EAAE,2BAA2B,EAAE,CAAC;QAC5C,OAAO,CAAC,EAAE,WAAW,CAAC;QACtB,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;QAC5B,eAAe,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;QAC7C,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAC5B,SAAS,CAAC,EAAE,IAAI,CAAC;QACjB,cAAc,CAAC,EAAE,IAAI,CAAC;QACtB,oBAAoB,CAAC,EAAE,GAAG,EAAE,CAAC;KAC7B,CAAC;IACF,MAAM,EAAE;QACP,OAAO,EAAE,YAAY,CAAC;KACtB,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACzB,IAAI,EAAE,SAAS,CAAC;IAEhB,IAAI,EAAE,GAAG,CAAC;CACV,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,WAAW,EAAE,CAAC;AAExC,kHAAkH;AAClH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC,CAAC;AAEpG,qBAAa,gBAAgB;IACrB,IAAI,EAAE,WAAW,EAAE,CAAM;IACzB,OAAO,EAAE,WAAW,CAAM;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,mBAAmB,CAA6B;IAC7D,WAAW,EAAE,gBAAgB,CAA0B;IACvD,OAAO,EAAE,YAAY,CAAC;IACtB,SAAS,EAAE,aAAa,EAAE,CAAM;IAChC,eAAe,EAAE,mBAAmB,GAAG,IAAI,CAAQ;IACnD,iBAAiB,EAAE,OAAO,CAAS;IACnC,iBAAiB,EAAE,OAAO,CAAS;IACnC,SAAS,EAAE,IAAI,CAAc;IAC7B,cAAc,CAAC,EAAE,IAAI,CAAC;IACtB,WAAW,EAAE,MAAM,CAAM;IACzB,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAQ;IACjD,eAAe,EAAE,MAAM,GAAG,IAAI,CAAQ;IACtC,mBAAmB,EAAE,OAAO,CAAS;IAC5C,8FAA8F;IACvF,QAAQ,EAAE,OAAO,CAAQ;gBAEpB,MAAM,EAAE,sBAAsB;IAiFnC,eAAe,IAAI,IAAI;IAWvB,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAKlC,uBAAuB,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI;IAqB1C,sBAAsB,CAAC,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI;IAQpE,IAAI,SAAS,IAAI,OAAO,CAQvB;IAED,IAAI,UAAU,IAAI,0BAA0B,GAAG,IAAI,CAGlD;IAED,IAAI,aAAa,IAAI,WAAW,GAAG,IAAI,CAoCtC;IAEM,iBAAiB,IAAI,IAAI;IAKzB,gBAAgB,IAAI,MAAM,GAAG,SAAS;IAsBtC,KAAK,IAAI,IAAI;IAQpB,OAAO,CAAC,WAAW,CAA8C;IAEjE,gEAAgE;IACzD,aAAa,IAAI,IAAI;IAoB5B;;;OAGG;IACI,IAAI,IAAI,IAAI;IAUnB,8DAA8D;WAChD,mBAAmB,CAAC,OAAO,EAAE,YAAY,EAAE,WAAW,GAAE,MAAW,GAAG,IAAI;IAmBxF,2EAA2E;IACpE,cAAc,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI;IAmC7C,OAAO,CAAC,OAAO,EAAE,gBAAgB,EAAE,YAAY,CAAC,EAAE,cAAc,GAAG,IAAI;IA6IvE,MAAM,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,iBAAiB,CAAC;QAAC,IAAI,EAAE,iBAAiB,CAAA;KAAE,GAAG,IAAI;CAyC/E"}