@paymanai/payman-typescript-ask-sdk 4.0.4 → 4.0.6

package/dist/index.d.mts

@@ -150,7 +150,8 @@ type MessageDisplay = {
     totalElapsedMs?: number;
 };
 type SessionParams = {
-    id?: string;
+    /** Session owner ID sent to the ask API as `sessionOwnerId`. */
+    id: string;
     name?: string;
     attributes?: Record<string, string>;
 };
@@ -171,14 +172,28 @@ type ChatConfig = {
     api: APIConfig;
     /** Agent ID to run against the k2 playground endpoint */
     agentId: string;
-    /** User ID for chatStore and activeStreamStore — required for context store messages management. Set to undefined on logout to clear stored messages. */
+    /** User ID for local chatStore and activeStreamStore only. This is not sent to the ask API. */
     userId?: string;
     /** Stage/Environment */
     stage?: AgentStage;
     /** Query param name for stage (default: "stage"). */
     stageQueryParam?: string;
-    /** Session params */
-    sessionParams?: SessionParams;
+    /** Session owner params sent with ask requests. */
+    sessionParams: SessionParams;
+    /**
+     * BCP-47 language tag forwarded to the server as `locale` (e.g. "en-US",
+     * "ja-JP"). Defaults to `navigator.language` in the browser and falls
+     * back to "en-US" if neither is available. The server uses this to
+     * localize agent responses; required field on the playground endpoint.
+     */
+    locale?: string;
+    /**
+     * IANA timezone id forwarded to the server as `timezone` (e.g.
+     * "America/Los_Angeles"). Defaults to the runtime's resolved zone via
+     * `Intl.DateTimeFormat().resolvedOptions().timeZone`; falls back to
+     * "UTC" if Intl is unavailable.
+     */
+    timezone?: string;
     /** Custom placeholder text */
     placeholder?: string;
     /** Empty state text */

package/dist/index.d.ts

@@ -150,7 +150,8 @@ type MessageDisplay = {
     totalElapsedMs?: number;
 };
 type SessionParams = {
-    id?: string;
+    /** Session owner ID sent to the ask API as `sessionOwnerId`. */
+    id: string;
     name?: string;
     attributes?: Record<string, string>;
 };
@@ -171,14 +172,28 @@ type ChatConfig = {
     api: APIConfig;
     /** Agent ID to run against the k2 playground endpoint */
     agentId: string;
-    /** User ID for chatStore and activeStreamStore — required for context store messages management. Set to undefined on logout to clear stored messages. */
+    /** User ID for local chatStore and activeStreamStore only. This is not sent to the ask API. */
     userId?: string;
     /** Stage/Environment */
     stage?: AgentStage;
     /** Query param name for stage (default: "stage"). */
     stageQueryParam?: string;
-    /** Session params */
-    sessionParams?: SessionParams;
+    /** Session owner params sent with ask requests. */
+    sessionParams: SessionParams;
+    /**
+     * BCP-47 language tag forwarded to the server as `locale` (e.g. "en-US",
+     * "ja-JP"). Defaults to `navigator.language` in the browser and falls
+     * back to "en-US" if neither is available. The server uses this to
+     * localize agent responses; required field on the playground endpoint.
+     */
+    locale?: string;
+    /**
+     * IANA timezone id forwarded to the server as `timezone` (e.g.
+     * "America/Los_Angeles"). Defaults to the runtime's resolved zone via
+     * `Intl.DateTimeFormat().resolvedOptions().timeZone`; falls back to
+     * "UTC" if Intl is unavailable.
+     */
+    timezone?: string;
     /** Custom placeholder text */
     placeholder?: string;
     /** Empty state text */

package/dist/index.js

@@ -954,16 +954,40 @@ function createCancelledMessageUpdate(steps, currentMessage) {
 var DEFAULT_STREAM_ENDPOINT = "/api/playground/ask/stream";
 function buildRequestBody(config, userMessage, sessionId, options) {
   const sessionOwner = config.sessionParams;
+  const sessionOwnerId = sessionOwner?.id?.trim();
+  if (!sessionOwnerId) {
+    throw new Error("ChatConfig.sessionParams.id is required to send ask requests.");
+  }
   const sessionAttributes = sessionOwner?.attributes && Object.keys(sessionOwner.attributes).length > 0 ? sessionOwner.attributes : void 0;
   return {
     agentId: config.agentId,
     userInput: userMessage,
     sessionId,
+    sessionOwnerId,
     sessionOwnerLabel: sessionOwner?.name || void 0,
     sessionAttributes,
-    analysisMode: options?.analysisMode
+    analysisMode: options?.analysisMode,
+    locale: resolveLocale(config.locale),
+    timezone: resolveTimezone(config.timezone)
   };
 }
+function resolveLocale(configured) {
+  if (configured && configured.trim().length > 0) return configured.trim();
+  if (typeof navigator !== "undefined") {
+    const navLocale = navigator.language;
+    if (navLocale && navLocale.length > 0) return navLocale;
+  }
+  return "en-US";
+}
+function resolveTimezone(configured) {
+  if (configured && configured.trim().length > 0) return configured.trim();
+  try {
+    const zone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+    if (zone && zone.length > 0) return zone;
+  } catch {
+  }
+  return "UTC";
+}
 function buildStreamingUrl(config) {
   const endpoint = config.api.streamEndpoint || DEFAULT_STREAM_ENDPOINT;
   const stage = config.stage || "DEV";
@@ -1176,16 +1200,16 @@ function useStreamManagerV2(config, callbacks, setMessages, setIsWaitingForRespo
           )
         );
       };
-      const currentConfig = configRef.current;
-      const requestBody = buildRequestBody(
-        currentConfig,
-        userMessage,
-        sessionId,
-        options
-      );
-      const url = buildStreamingUrl(currentConfig);
-      const headers = buildRequestHeaders(currentConfig);
       try {
+        const currentConfig = configRef.current;
+        const requestBody = buildRequestBody(
+          currentConfig,
+          userMessage,
+          sessionId,
+          options
+        );
+        const url = buildStreamingUrl(currentConfig);
+        const headers = buildRequestHeaders(currentConfig);
         await streamWorkflowEvents(url, requestBody, headers, {
           signal: abortController.signal,
           onEvent: (event) => {
@@ -1407,14 +1431,24 @@ function useStreamManagerV2(config, callbacks, setMessages, setIsWaitingForRespo
 }
 
 // src/hooks/useChatV2.ts
+function getStoredOrInitialMessages(config) {
+  if (!config.userId) return config.initialMessages ?? [];
+  const stored = chatStore.get(config.userId);
+  if (stored.length > 0) return stored;
+  if (config.initialMessages?.length) {
+    chatStore.set(config.userId, config.initialMessages);
+    return config.initialMessages;
+  }
+  return [];
+}
+function getSessionIdFromMessages(messages) {
+  return messages.find((message) => message.sessionId)?.sessionId;
+}
 function useChatV2(config, callbacks = {}) {
-  const [messages, setMessages] = react.useState(() => {
-    if (config.userId) return chatStore.get(config.userId);
-    return config.initialMessages ?? [];
-  });
+  const [messages, setMessages] = react.useState(() => getStoredOrInitialMessages(config));
   const [isWaitingForResponse, setIsWaitingForResponse] = react.useState(false);
   const sessionIdRef = react.useRef(
-    config.userId ? chatStore.get(config.userId).find((m) => m.sessionId)?.sessionId ?? config.initialSessionId ?? void 0 : config.initialSessionId ?? void 0
+    getSessionIdFromMessages(getStoredOrInitialMessages(config)) ?? config.initialSessionId ?? void 0
   );
   const prevUserIdRef = react.useRef(config.userId);
   const callbacksRef = react.useRef(callbacks);
@@ -1658,7 +1692,7 @@ function useChatV2(config, callbacks = {}) {
       setIsWaitingForResponse(active.isWaiting);
     }
     return unsubscribe;
-  }, []);
+  }, [config.userId]);
   react.useEffect(() => {
     if (!config.userId) return;
     const toSave = messages.filter((m) => !m.isStreaming);
@@ -1666,6 +1700,13 @@ function useChatV2(config, callbacks = {}) {
       chatStore.set(config.userId, toSave);
     }
   }, [messages, config.userId]);
+  react.useEffect(() => {
+    if (!config.userId || activeStreamStore.has(config.userId)) return;
+    if (!config.initialMessages?.length || messagesRef.current.length > 0) return;
+    chatStore.set(config.userId, config.initialMessages);
+    setMessages(config.initialMessages);
+    sessionIdRef.current = getSessionIdFromMessages(config.initialMessages) ?? config.initialSessionId;
+  }, [config.initialMessages, config.initialSessionId, config.userId]);
   react.useEffect(() => {
     const prevUserId = prevUserIdRef.current;
     prevUserIdRef.current = config.userId;
@@ -1677,11 +1718,19 @@ function useChatV2(config, callbacks = {}) {
       setIsWaitingForResponse(false);
       setUserActionState({ request: null, result: null, clearOtpTrigger: 0 });
     } else if (config.userId) {
-      const stored = chatStore.get(config.userId);
-      setMessages(stored);
-      sessionIdRef.current = stored.find((m) => m.sessionId)?.sessionId;
+      const active = activeStreamStore.get(config.userId);
+      if (active) {
+        setMessages(active.messages);
+        setIsWaitingForResponse(active.isWaiting);
+        sessionIdRef.current = getSessionIdFromMessages(active.messages) ?? config.initialSessionId;
+        return;
+      }
+      const nextMessages = getStoredOrInitialMessages(config);
+      setMessages(nextMessages);
+      sessionIdRef.current = getSessionIdFromMessages(nextMessages) ?? config.initialSessionId;
+      setIsWaitingForResponse(false);
     }
-  }, [config.userId]);
+  }, [config]);
   return {
     messages,
     sendMessage,