@wix/himalaya-cli 0.1037.0 → 0.1038.0

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/genie-chat/src/index.d.ts

@@ -55,6 +55,12 @@ export interface ConversationMessage {
     attachments?: Attachment[];
     /** Client tools this assistant turn asks the CALLER to run — see `FunctionCall`. */
     functionCalls?: FunctionCall[];
+    /** What the owner attached to this turn — a mentioned product, contact,
+     *  page — stored by the service BESIDE the text rather than inside it. The
+     *  transcript echoes them back under this key (the `wix.genie.v1` message
+     *  entity's `references`), which is the only way a reloaded conversation
+     *  can still say what a turn was about. */
+    references?: MessageReference[];
 }
 /** A file on a message — the service's `Attachment` entity.
  *
@@ -112,6 +118,40 @@ export interface FunctionCallResult {
     /** A JSON-ENCODED object carrying the tool's structured answer. */
     widgetResponse?: string;
 }
+/** One reference riding on a user turn (`messageReferences` on the persist
+ *  call, `references` on the stored message).
+ *
+ *  Field meanings are the chat-service's own, from the
+ *  `@wix/ambassador-genie-chat-service-v1-no-entity` `MessageReference` type the
+ *  native Aria app sends: `data` is the context handed to the model, `source`
+ *  a low-cardinality feature tag, and `type` how a client renders it
+ *  ("inline" | "global" | "hidden"). Build a mention's with `mentionReference`
+ *  rather than by hand, so the one shape the service is known to accept is
+ *  spelled in one place. */
+export interface MessageReference {
+    id?: string;
+    /** Shown to the owner (a chip label). */
+    label?: string;
+    /** The context the assistant receives — for a mention, a JSON string
+     *  `{"id":…,"type":…}` naming the item and its category. */
+    data?: string;
+    /** Feature tag, e.g. "mention". */
+    source?: string;
+    /** Render scope, e.g. "global" — a chip above the text, not a token in it. */
+    type?: string;
+}
+/** A mention of one item, in the exact shape the native Aria app sends: a
+ *  `global` reference (a chip, not a token in the text) whose `data` names the
+ *  item and the category it came from.
+ *
+ *  `category` is the category's ENGLISH label ("Products", "Contacts") — it is
+ *  what the model reads, so it is not localized. Newlines in the label are
+ *  folded to spaces; `JSON.stringify` does the escaping the native client does
+ *  by hand. */
+export declare function mentionReference(item: {
+    id: string;
+    title: string;
+}, category: string): MessageReference;
 /** Which assistant the conversation talks to. The real dashboard sends a
  *  `unifiedAssistantReference`; helper `ariaAssistantConfig()` builds it. */
 export interface AssistantConfig {
@@ -200,6 +240,10 @@ export interface SendMessageOptions {
     enforceAccountScopedConversations?: boolean;
     /** Tag the turn with the same origin the conversation was created under. */
     origin?: string;
+    /** References stored WITH the turn (step 1 only — the trigger names a turn
+     *  that already carries them). Omitted, the persist call sends `[]`, which is
+     *  what it always sent. */
+    messageReferences?: MessageReference[];
     /** Files already UPLOADED (see `createFileUpload`) to store with the turn.
      *  Rides step 1 only — the trigger names the stored turn, which carries them. */
     attachments?: Attachment[];
@@ -294,6 +338,81 @@ export declare function genieUploadRef(id: string | undefined): string;
 export declare function uploadTargetUrl(uploadUrl: string, fileName: string): string;
 /** Fetch the messages of a conversation (poll after sendMessage). */
 export declare function getConversationMessages(conversationId: string): Promise<GetConversationMessagesResponse>;
+/** How a provider pages its items. Any other value, or none, means unpaged:
+ *  `providersOf` reports it as "NONE" and such a provider is asked for one
+ *  page with no paging block. */
+export type ItemsPaginationMode = "CURSOR" | "OFFSET" | "UNKNOWN_PAGINATION_MODE";
+/** An installed item provider. Only the fields a picker needs are typed. */
+export interface ItemsSelectionProvider {
+    /** The handle `queryItems` is addressed by. */
+    key?: string;
+    appId?: string;
+    contentData?: {
+        providerName?: string;
+        iconKey?: string;
+        title?: string;
+    };
+    paginationMode?: ItemsPaginationMode | string;
+}
+export interface ListInstalledProvidersResponse {
+    providers?: ItemsSelectionProvider[];
+}
+/** One item a provider returned. */
+export interface ItemsSelectionItem {
+    id?: string;
+    name?: string;
+    description?: string;
+    image?: {
+        url?: string;
+    };
+    /** Additional information, e.g. a price. */
+    note?: string;
+}
+export interface QueryItemsResponse {
+    items?: ItemsSelectionItem[];
+    pagingMetadata?: {
+        hasNext?: boolean;
+        cursors?: {
+            next?: string;
+        };
+    };
+}
+/** The query `queryItems` sends. Set `cursorPaging` OR `paging` to match the
+ *  provider's `paginationMode`, or neither for an unpaged provider. */
+export interface ItemsQuery {
+    search?: string;
+    paging?: {
+        limit: number;
+        offset?: number;
+    };
+    cursorPaging?: {
+        limit: number;
+        cursor?: string;
+    };
+}
+/** The item providers installed on the CURRENT site — the categories a mention
+ *  picker offers. The site is the one whose signed instance authorizes the
+ *  call, so a caller that can switch business must re-list after a switch. */
+export declare function listInstalledProviders(): Promise<ListInstalledProvidersResponse>;
+/** Query one provider's items. `providerKey` is a provider's `key`, never its
+ *  display name. */
+export declare function queryItems(providerKey: string, query?: ItemsQuery): Promise<QueryItemsResponse>;
+/** The provider list from a `listInstalledProviders` response, with every
+ *  entry that has no key or no name dropped — neither can be offered or
+ *  queried. */
+export declare function providersOf(res: ListInstalledProvidersResponse | null | undefined): Array<{
+    key: string;
+    name: string;
+    paging: "CURSOR" | "OFFSET" | "NONE";
+}>;
+/** The items from a `queryItems` response, with every entry that has no id or
+ *  no name dropped — an item with neither cannot be referenced or shown. */
+export declare function itemsOf(res: QueryItemsResponse | null | undefined): Array<{
+    id: string;
+    title: string;
+    subtitle: string;
+    imageUrl: string;
+}>;
 /** The transcript from a getConversationMessages response, under either key. */
 export declare function messagesOf(res: GetConversationMessagesResponse | null | undefined): ConversationMessage[];
 /** The id of the user turn a send response stored, or "" when the service did

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-genie-chat.mjs

@@ -23,6 +23,15 @@ function wixCall(method, path, body) {
     }
   );
 }
+function mentionReference(item, category) {
+  return {
+    id: item.id,
+    label: item.title.split(/\r?\n/).join(" ").trim(),
+    data: JSON.stringify({ id: item.id, type: category }),
+    source: "mention",
+    type: "global"
+  };
+}
 function ariaAssistantConfig(unifiedAssistantId = ARIA_UNIFIED_ASSISTANT_ID) {
   return { unifiedAssistantReference: { type: "unified-assistant", unifiedAssistantId } };
 }
@@ -37,7 +46,7 @@ function conversationUserMessage(conversationId, content, opts = {}) {
   if (!conversationId) throw new Error("conversationUserMessage: conversationId is required");
   return wixCall("POST", `${BASE}/conversation-user-message`, {
     attachments: opts.attachments ?? [],
-    messageReferences: [],
+    messageReferences: opts.messageReferences ?? [],
     userMessageContent: content,
     origin: opts.origin ?? ARIA_ORIGIN,
     conversationId,
@@ -147,6 +156,42 @@ function getConversationMessages(conversationId) {
   if (!conversationId) throw new Error("getConversationMessages: conversationId is required");
   return wixCall("GET", `${BASE}/conversation-messages?conversationId=${encodeURIComponent(conversationId)}`);
 }
+var ITEMS_SELECTION_BASE = "https://manage.wix.com/_api/items-selection-service/v1/items-selection";
+function listInstalledProviders() {
+  return wixCall("GET", `${ITEMS_SELECTION_BASE}/installed-providers`);
+}
+function queryItems(providerKey, query = {}) {
+  if (!providerKey) throw new Error("queryItems: providerKey is required");
+  return wixCall(
+    "POST",
+    `${ITEMS_SELECTION_BASE}/${encodeURIComponent(providerKey)}/items`,
+    { providerKey, query }
+  );
+}
+function providersOf(res) {
+  const out = [];
+  for (const p of res?.providers ?? []) {
+    const key = typeof p?.key === "string" ? p.key.trim() : "";
+    const name = typeof p?.contentData?.providerName === "string" ? p.contentData.providerName.trim() : "";
+    if (!key || !name) continue;
+    const mode = p.paginationMode === "CURSOR" || p.paginationMode === "OFFSET" ? p.paginationMode : "NONE";
+    out.push({ key, name, paging: mode });
+  }
+  return out;
+}
+function itemsOf(res) {
+  const out = [];
+  for (const it of res?.items ?? []) {
+    const id = typeof it?.id === "string" ? it.id.trim() : "";
+    const title = typeof it?.name === "string" ? it.name.trim() : "";
+    if (!id || !title) continue;
+    const description = typeof it.description === "string" ? it.description.trim() : "";
+    const note = typeof it.note === "string" ? it.note.trim() : "";
+    const imageUrl = typeof it.image?.url === "string" ? it.image.url.trim() : "";
+    out.push({ id, title, subtitle: description || note, imageUrl });
+  }
+  return out;
+}
 function messagesOf(res) {
   return res?.messages ?? res?.conversationMessages ?? [];
 }
@@ -203,9 +248,14 @@ export {
   getConversationMessages,
   getConversations,
   isGenieChatError,
+  itemsOf,
   lastAssistantMessage,
+  listInstalledProviders,
+  mentionReference,
   messageText,
   messagesOf,
+  providersOf,
+  queryItems,
   sendFunctionCallResults,
   sendMessage,
   triggerAssistantMessage,