@upscopeio/sdk 0.0.0

package/index.d.ts

@@ -0,0 +1,145 @@
+export type SubmitRating = {
+  userSessionRating?: number;
+  userAgentRating?: number;
+  userAgentFeedback?: string;
+};
+
+export type CobrowsingSdkConfiguration = {
+  jsConfiguration?: boolean;
+  uniqueId?: null | string;
+  identities?: null | string | string[];
+  tags?: null | string | string[];
+  integrationIds?: null | string | string[];
+  agentPrompt?: string;
+  callName?: string;
+
+  // Automatic
+  version: string;
+  apiKey: string;
+  beta: boolean;
+  region: string | null;
+  readonly regionWhitelist: string[] | null;
+  dataEndpoint: string;
+  pageviewsEndpoint: string;
+  phoneEndpoint: string;
+  javascriptEndpoint: string;
+  storageImplementation: null | Storage;
+  proxyRedirectEndpoint: string;
+  requireAuthorizationForSession: boolean;
+  integrateWithLivechat: boolean;
+  liveChatRewrite: boolean;
+  grabIdentityFromLivechat: boolean;
+  showUpscopeLink: boolean;
+  cursorColor: string;
+  enlargeCursor: boolean;
+  showTerminateButton: boolean;
+  useFingerprinting: boolean;
+  autoconnect: boolean;
+  trackConsole: boolean;
+  allowRemoteConsole: boolean;
+  allowRemoteClick: boolean;
+  allowRemoteScroll: boolean;
+  allowRemoteType: boolean;
+  allowAgentRedirect: boolean;
+  rewriteExternalLinks: boolean;
+  collectHistory: boolean;
+  consoleAllowed: boolean;
+  drawingsTtlMs: number;
+  enableLookupCodeOnKey: boolean;
+  lookupCodeKey: number;
+  lookupCodeKeyRepetitions: number;
+  lookupCodeKeyTitle: string;
+  lookupCodeKeyMessage: string;
+  lookupCodeElement: null | HTMLElement | string;
+  injectLookupCodeButton: boolean;
+  lookupCodeButtonPages: string[];
+  lookupCodeButtonStyle: string;
+  disconnectAfterSeconds: number;
+  proxyAssets: string[];
+  maskedElements: string[];
+  domChangesDelay: number;
+  ignoreBrowserSupport: boolean;
+  enableCanvases: boolean;
+  customCallController: null | ((callback: (accepted: boolean) => void) => void);
+  callPromptText: string;
+  callRingtone: string;
+  authorizationPromptTitle: string;
+  authorizationPromptMessage: string;
+  endOfScreenshareMessage: null | string;
+  callWaitMessage: string;
+  translationsYes: string;
+  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;
+  unavailableAgentRequestRedirectImmediately: boolean;
+  unavailableAgentRequestRedirectTo: null | string;
+  fromProxy: boolean;
+  sfdcFieldLabel: string;
+  sfdcFieldId: string;
+  baseProxyUrl: string;
+  proxyDomain: string;
+  needsProxy: (url: string) => boolean;
+  onSessionRequest: (cb: (accepted: boolean) => void, requestingAgent: string | null) => void;
+  onSessionStart: () => void;
+  onSessionEnd: () => void;
+  onWaitingForCall: () => void;
+  onSessionContinue: () => void;
+  onConnection: null | (() => void);
+  maskElementMiddleware: (element: HTMLElement) => boolean;
+  noRemoteElements: string[];
+  allowRemoteMiddleware: (element: HTMLElement) => boolean;
+  styleSheetContentFromRules: (stylesheet: HTMLLinkElement | HTMLStyleElement) => boolean;
+};
+
+export type Instruction =
+  | ["init", Partial<CobrowsingSdkConfiguration>]
+  | ["reset"]
+  | ["connect"]
+  | ["cancelRequestAgent"]
+  | ["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]
+  | ["newPageview"]
+  | ["on", ...string[], (event: any) => void]
+  | ["requestAgent"]
+  | ["reset", boolean]
+  | ["redirect", string]
+  | ["saveHistory"]
+  | ["stopSession"]
+  | ["submitRating", SubmitRating]
+  | ["updateConnection", Partial<CobrowsingSdkConfiguration>];
+
+export type Upscope = {
+  _config?: CobrowsingSdkConfiguration;
+  __defaultConfiguration?: CobrowsingSdkConfiguration;
+  __defaultRegion?: string;
+  _version?: string;
+  _integrations?: string[];
+  q: Instruction[];
+};
+
+declare global {
+  interface Window {
+    Upscope: Upscope;
+  }
+}
+
+declare global {
+  function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): number;
+  function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): number;
+}
+export = Upscope;

package/index.js

@@ -0,0 +1,33 @@
+function loadSDK(apiKey) {
+    const i = function (...args) {
+        i.q.push(args);
+    };
+    i.q = [];
+    // The real Upscope implementation is loaded below
+    window.Upscope = i;
+    const s = document.createElement("script");
+    s.type = "text/javascript";
+    s.async = true;
+    s.src = `https://code.upscope.io/${apiKey}.js`;
+    const x = document.getElementsByTagName("script")[0];
+    x.parentNode?.insertBefore(s, x);
+}
+const _Upscope = function () {
+    const args = arguments;
+    if (window.Upscope === _Upscope) {
+        // The real Upscope implementation is not loaded yet, so load it
+        if (args[0] === "init") {
+            const config = args[1];
+            if (!config?.apiKey) {
+                throw new Error("API key not specified");
+            }
+            loadSDK(config.apiKey);
+        }
+        else {
+            throw new Error("Upscope is not loaded");
+        }
+    }
+    return window.Upscope(...args);
+};
+window.Upscope = _Upscope;
+export default _Upscope;

package/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@upscopeio/sdk",
+  "main": "index.js",
+  "type": "module",
+  "dependencies": {},
+  "version": "0.0.0"
+}