@upscopeio/sdk 2025.10.9 → 2025.11.2

package/index.d.ts

@@ -1,201 +1,205 @@
-type SubmitRating = {
-  userSessionRating?: number;
-  userAgentRating?: number;
-  userAgentFeedback?: string;
-};
-
-type UpscopeStorageImplementation = {
-  clear(): void | Promise<void>;
-  getItem(key: string): string | null | Promise<string | null>;
-  key(index: number): string | null | Promise<string | null>;
-  removeItem(key: string): void | Promise<void>;
-  setItem(key: string, value: string): void | Promise<void>;
-};
-
 type CobrowsingSdkConfiguration = {
+  // User provided
+  agentPrompt?: string;
+  callName?: string;
   jsConfiguration?: boolean;
-  uniqueId?: null | string;
+  secretKey?: string;
+
+  // User provided nulls clear, undefined maintain existing info
   identities?: null | string | string[];
-  tags?: null | string | string[];
   integrationIds?: null | string | string[];
   metadata?: null | Record<string, string>;
-  agentPrompt?: string;
-  callName?: string;
-  secretKey?: string;
+  tags?: null | string | string[];
+  uniqueId?: null | string;
 
   // Automatic
-  product: "helloscreen" | "userview" | "cobrowsingapi";
-  version: string;
-  apiKey: string;
-  beta: boolean;
-  region: string | null;
-  readonly regionWhitelist: string[] | null;
-  dataEndpoint: string;
-  pageviewsEndpoint: string;
-  phoneEndpoint: string;
-  javascriptEndpoint: string;
-  storageImplementation: null | UpscopeStorageImplementation;
-  storageKey: string | null;
-  requireAuthorizationForSession: boolean;
-  integrateWithLivechat: boolean;
-  liveChatRewrite: boolean;
-  grabIdentityFromLivechat: boolean;
-  showUpscopeLink: boolean;
-  cursorColor: string;
-  enlargeCursor: boolean;
-  showTerminateButton: boolean;
-  screenWakeLock: boolean;
-  useFingerprinting: boolean;
-  autoconnect: boolean;
-  trackConsole: boolean;
-  allowRemoteConsole: boolean;
+  agentRequestAcceptedText: string;
+  agentRequestButtonPages: string[];
+  agentRequestButtonRequestingSubtitle: string;
+  agentRequestButtonRequestingTitle: string;
+  agentRequestButtonStyle: string;
+  agentRequestButtonSubtitle: string;
+  agentRequestButtonTitle: string;
+  agentRequestNotAvailableText: string;
+  agentRequestResultTitle: string;
+  allowAgentRedirect: boolean;
+  allowFullScreen: boolean;
   allowRemoteClick: boolean;
+  allowRemoteConsole: boolean;
+  allowRemoteMiddleware: (element: HTMLElement) => boolean;
   allowRemoteScroll: boolean;
   allowRemoteType: boolean;
-  allowAgentRedirect: boolean;
-  allowFullScreen: boolean;
-  enableSessionRating: boolean;
-  requireControlRequest: boolean;
-  rewriteExternalLinks: boolean;
+  apiKey: string;
+  authorizationPromptMessage: string;
+  authorizationPromptTitle: string;
+  autoconnect: boolean;
+  beta: boolean;
+  callAudioAuthorizationFailedMessage: string;
+  callAudioAuthorizationFailedTitle: string;
+  callPopupFailedMessage: string;
+  callPopupFailedTitle: string;
+  callPopupNoInputMessage: string;
+  callPopupNoInputTitle: string;
+  callPopupNoOutputMessage: string;
+  callPopupNoOutputTitle: string;
+  callPromptText: string;
+  callRingtone: string;
+  callWaitMessage: string;
   collectHistory: boolean;
+  computedStyleSelectors: "angular" | "react" | string[];
   consoleAllowed: boolean;
+  controlRequestMessage: string;
+  controlRequestTitle: string;
+  cssFile: string;
+  cursorColor: string;
+  customCallController: ((callback: (accepted: boolean) => void) => (() => void) | void) | null;
+  customControlRequestController: ((callback: (accepted: boolean) => void) => (() => void) | void) | null;
+  customFullScreenRequestController: ((callback: (accepted: boolean) => void) => (() => void) | void) | null;
+  dataEndpoint: string;
+  disconnectAfterSeconds: number;
+  domChangesDelay: number;
   drawingsTtlMs: number;
+  enableCanvases: boolean;
   enableLookupCodeOnKey: boolean;
-  lookupCodeKey: number;
-  lookupCodeKeyRepetitions: number;
-  lookupCodeKeyTitle: string;
-  lookupCodeKeyMessage: string;
-  lookupCodeElement: null | HTMLElement | string;
+  enableSessionRating: boolean;
+  enableSessionRating: boolean;
+  endOfScreenshareMessage: null | string;
+  enlargeCursor: boolean;
+  fullScreenRequestMessage: string;
+  fullScreenRequestTitle: string;
+  grabIdentityFromLivechat: boolean;
+  ignoreBrowserSupport: boolean;
   injectLookupCodeButton: boolean;
+  integrateWithLivechat: boolean;
+  javascriptEndpoint: string;
+  liveChatRewrite: boolean;
   lookupCodeButtonPages: string[];
   lookupCodeButtonStyle: string;
-  disconnectAfterSeconds: number;
-  proxyAssets: string[];
+  lookupCodeElement: HTMLElement | null | string;
+  lookupCodeKey: number;
+  lookupCodeKeyMessage: string;
+  lookupCodeKeyRepetitions: number;
+  lookupCodeKeyTitle: string;
   maskedElements: string[];
-  domChangesDelay: number;
-  ignoreBrowserSupport: boolean;
-  enableCanvases: boolean;
-  customCallController: null | ((callback: (accepted: boolean) => void) => void | (() => void));
-  customControlRequestController: null | ((callback: (accepted: boolean) => void) => void | (() => void));
-  customFullScreenRequestController: null | ((callback: (accepted: boolean) => void) => void | (() => void));
-  controlRequestTitle: string;
-  controlRequestMessage: string;
-  enableSessionRating: boolean;
-  sessionRatingModalTitle: string;
-  sessionRatingModalMessage: string;
-  sessionRatingSessionLabel: string;
+  maskElementMiddleware: (element: HTMLElement) => boolean;
+  noRemoteElements: string[];
+  onConnection: (() => void) | null;
+  onSessionContinue: () => void;
+  onSessionEnd: () => void;
+  onSessionRequest: (cb: (accepted: boolean) => void, requestingAgent: null | string) => (() => void) | void;
+  onSessionStart: () => void;
+  onWaitingForCall: () => void;
+  pageviewsEndpoint: string;
+  phoneEndpoint: string;
+  // Automatic
+  product: "cobrowsingapi" | "helloscreen" | "userview";
+  proxyAssets: string[];
+  publicLinkOrigin: null | string;
+  region: null | string;
+  readonly regionWhitelist: null | string[];
+  requireAuthorizationForSession: boolean;
+  requireControlRequest: boolean;
+  rewriteExternalLinks: boolean;
+  screenWakeLock: boolean;
   sessionRatingAgentLabel: string;
   sessionRatingFeedbackLabel: string;
+  sessionRatingModalMessage: string;
+  sessionRatingModalTitle: string;
+  sessionRatingSessionLabel: string;
   sessionRatingSubmitLabel: string;
-  fullScreenRequestTitle: string;
-  fullScreenRequestMessage: string;
-  callPromptText: string;
-  callRingtone: string;
-  cssFile: string;
-  useInlineCss: boolean;
-  authorizationPromptTitle: string;
-  authorizationPromptMessage: string;
-  endOfScreenshareMessage: null | string;
-  callWaitMessage: string;
-  translationsYes: string;
+  sfdcFieldId: string;
+  sfdcFieldLabel: string;
+  shouldComputeStyleMiddleware: (element: HTMLElement) => boolean;
+  showAgentRequestButton: "always" | "never" | "when_available"; // One of: always / when_available / never
+  showTerminateButton: boolean;
+  showUpscopeLink: boolean;
+  storageImplementation: null | UpscopeStorageImplementation;
+  storageKey: null | string;
+  styleSheetContentFromRules: (stylesheet: HTMLLinkElement | HTMLStyleElement) => boolean;
+  trackConsole: boolean;
   translationsNo: string;
   translationsOk: string;
   translationsStopSession: string;
-  agentRequestButtonStyle: string;
-  agentRequestButtonTitle: string;
-  agentRequestButtonSubtitle: string;
-  agentRequestButtonRequestingTitle: string;
-  agentRequestButtonRequestingSubtitle: string;
-  agentRequestResultTitle: string;
-  agentRequestNotAvailableText: string;
-  agentRequestAcceptedText: string;
-  showAgentRequestButton: "always" | "when_available" | "never"; // One of: always / when_available / never
-  agentRequestButtonPages: string[];
-  callPopupFailedTitle: string;
-  callPopupFailedMessage: string;
-  callPopupNoInputTitle: string;
-  callPopupNoInputMessage: string;
-  callPopupNoOutputTitle: string;
-  callPopupNoOutputMessage: string;
-  callAudioAuthorizationFailedTitle: string;
-  callAudioAuthorizationFailedMessage: string;
+  translationsYes: string;
   unavailableAgentRequestRedirectImmediately: boolean;
   unavailableAgentRequestRedirectTo: null | string;
-  sfdcFieldLabel: string;
-  sfdcFieldId: string;
-  onSessionRequest: (cb: (accepted: boolean) => void, requestingAgent: string | null) => void | (() => void);
-  onSessionStart: () => void;
-  onSessionEnd: () => void;
-  onWaitingForCall: () => void;
-  onSessionContinue: () => void;
-  onConnection: null | (() => void);
-  maskElementMiddleware: (element: HTMLElement) => boolean;
-  noRemoteElements: string[];
-  allowRemoteMiddleware: (element: HTMLElement) => boolean;
-  computedStyleSelectors: string[] | "react" | "angular";
-  shouldComputeStyleMiddleware: (element: HTMLElement) => boolean;
-  styleSheetContentFromRules: (stylesheet: HTMLLinkElement | HTMLStyleElement) => boolean;
-  publicLinkOrigin: string | null;
-};
-
-type SDKEvents = {
-  connection: undefined;
-  waitingForCall: undefined;
-  sessionStart: undefined;
-  callStart: undefined;
-  callAccepted: undefined;
-  agentRequestUpdate: ["pending" | "unavailable" | "canceled" | "accepted"];
-  newObserver: [string, Observer];
-  observerUpdate: [string, Partial<Observer>];
-  observerGone: [string];
-  observerContentVisible: [string];
-  observersCount: [number];
-  agentsAvailable: undefined;
-  sessionContinue: undefined;
-  sessionEnd: undefined;
-  callEnd: undefined;
-  connectionReset: undefined;
-  sessionRequest: undefined;
-  customMessage: [{ observer: string } | { visitor: string }, Record<string, any>];
-};
-
-type Observer = {
-  name: string | null;
-  id: string;
-  screenWidth: number;
-  screenHeight: number;
+  useFingerprinting: boolean;
+  useInlineCss: boolean;
+  version: string;
 };
 
 type Instruction =
-  | ["init", Partial<Omit<CobrowsingSdkConfiguration, "apiKey">> & { apiKey: string }]
-  | ["reset"]
-  | ["connect"]
   | ["cancelRequestAgent"]
+  | ["connect"]
+  | ["customMessage", Record<string, unknown>]
+  | ["expectDisconnect", Partial<{ message: null | string; returnTimeSeconds: null | number; title: null | string }>]
+  | ["getLookupCode", (code: string) => void]
+  | ["getPublicLink", { agentId: string; agentName: string }, (publicLink: string) => void]
   | ["getShortId", (shortId: string) => void]
   | ["getUserId", (shortId: string) => void] // Legacy version of getShortId
-  | ["getLookupCode", (code: string) => void]
   | ["getWatchLink", (link: string) => void]
-  | ["logEvent", "success" | "error" | "info" | "warn" | "contact", string]
+  | ["init", Partial<Omit<CobrowsingSdkConfiguration, "apiKey">> & { apiKey: string }]
+  | ["logEvent", "contact" | "error" | "info" | "success" | "warn", string]
   | ["newPageview"]
-  | ["on", ...(keyof SDKEvents)[], (event: any) => void]
+  | ["on", ...(keyof SDKEvents)[], (event: any) => void] // eslint-disable-line @typescript-eslint/no-explicit-any
+  | ["prefetchAssets"]
   | ["requestAgent"]
   | ["reset", boolean]
+  | ["reset"]
   | ["saveHistory"]
   | ["stopSession"]
-  | ["prefetchAssets"]
-  | ["customMessage", Record<string, any>]
   | [
       "submitRating",
       {
-        userSessionRating?: number;
-        userAgentRating?: number;
         userAgentFeedback?: string;
+        userAgentRating?: number;
+        userSessionRating?: number;
       },
     ]
-  | ["expectDisconnect", Partial<SessionClientMessage["expectDisconnect"]>]
-  | ["getPublicLink", { agentId: string; agentName: string }, (publicLink: string) => void]
   | ["updateConnection", Partial<CobrowsingSdkConfiguration>];
 
+type Observer = {
+  id: string;
+  name: null | string;
+  screenHeight: number;
+  screenWidth: number;
+};
+
+type SDKEvents = {
+  agentRequestUpdate: ["accepted" | "canceled" | "pending" | "unavailable"];
+  agentsAvailable: undefined;
+  callAccepted: undefined;
+  callEnd: undefined;
+  callStart: undefined;
+  connection: undefined;
+  connectionReset: undefined;
+  customMessage: [{ observer: string } | { visitor: string }, Record<string, unknown>];
+  newObserver: [string, Observer];
+  observerContentVisible: [string];
+  observerGone: [string];
+  observersCount: [number];
+  observerUpdate: [string, Partial<Observer>];
+  sessionContinue: undefined;
+  sessionEnd: undefined;
+  sessionRequest: undefined;
+  sessionStart: undefined;
+  waitingForCall: undefined;
+};
+
+type SubmitRating = {
+  userAgentFeedback?: string;
+  userAgentRating?: number;
+  userSessionRating?: number;
+};
+
 type Upscope = (...instruction: Instruction) => void;
 
+type UpscopeStorageImplementation = {
+  clear: () => Promise<void> | void;
+  getItem: (key: string) => null | Promise<null | string> | string;
+  key: (index: number) => null | Promise<null | string> | string;
+  removeItem: (key: string) => Promise<void> | void;
+  setItem: (key: string, value: string) => Promise<void> | void;
+};
+
 export default function Upscope(...instruction: Instruction): void;

package/package.json

@@ -3,5 +3,5 @@
   "main": "index.js",
   "type": "module",
   "dependencies": {},
-  "version": "2025.10.9"
+  "version": "2025.11.2"
 }