@sprig-technologies/sprig-browser 2.14.8 → 2.15.1

package/shared/network.js

@@ -1,130 +0,0 @@
-/*global fetch */
-import 'whatwg-fetch';
-import { HEADERS, INSTALLATION_METHOD } from './constants';
-import Deferred from './deferred';
-import { delay, NETWORK_CONFIG } from './networkHelper';
-
-let killswitch = false;
-let killswitchReason = '';
-let isRateLimited = false;
-let pendingRequestQueue = [];
-
-function getInstallationMethodHeader(Sprig) {
-  if (Sprig._config && Sprig._config.installationMethod) return Sprig._config.installationMethod;
-  if (Sprig._gtm) return INSTALLATION_METHOD.GTM;
-  if (Sprig._segment) return INSTALLATION_METHOD.SEGMENT;
-  return INSTALLATION_METHOD.SNIPPET;
-}
-
-export function killNetworkRequests(reason) {
-  killswitch = true;
-  killswitchReason = reason;
-}
-
-export function getHttpHeaders(Sprig = {}) {
-  const headers = {
-    'Content-Type': 'application/json',
-    'userleap-platform': 'web',
-    'x-ul-sdk-version': '2.14.8', //version here doesn't matter. it is string-replaced when compiled
-  };
-  if (Sprig.envId) headers[HEADERS.ENVIRONMENT_ID] = Sprig.envId;
-  if (Sprig.token) headers['Authorization'] = 'Bearer ' + Sprig.token;
-  if (Sprig.userId) headers[HEADERS.USER_ID] = Sprig.userId;
-  if (Sprig.visitorId) headers[HEADERS.VISITOR_ID] = Sprig.visitorId;
-  if (Sprig.partnerAnonymousId) headers[HEADERS.PARTNER_ANONYMOUS_ID] = Sprig.partnerAnonymousId;
-  if (Sprig.mobileHeadersJSON) {
-    const mobileHeaders = JSON.parse(Sprig.mobileHeadersJSON);
-    Object.assign(headers, mobileHeaders);
-  }
-  headers[HEADERS.INSTALLATION_METHOD] = getInstallationMethodHeader(Sprig);
-  if (Sprig.locale) headers['accept-language'] = Sprig.locale; // custom set locale overrides original header locales
-
-  return headers;
-}
-
-async function dropOrQueueRequest(shouldDropOnRateLimit, isRateLimitRetry, requestInfo) {
-  if (shouldDropOnRateLimit) {
-    return { status: 429 };
-  } else {
-    const deferredRequest = new Deferred(requestInfo);
-    pendingRequestQueue.push(deferredRequest);
-    return deferredRequest.promise;
-  }
-}
-
-export async function ulFetch(url, options, attempt = 0, shouldDropOnRateLimit = false, shouldRetryRequest = false) {
-  // drop or queue request based on the current rate limit status
-  const requestInfo = { url, options, attempt, shouldDropOnRateLimit };
-  if (isRateLimited && !shouldRetryRequest) {
-    return dropOrQueueRequest(shouldDropOnRateLimit, shouldRetryRequest, requestInfo);
-  }
-  const killswitchResponse = { ok: false, reportError: false };
-  if (killswitch) {
-    console.log(`UserLeap - ${killswitchReason}`);
-    return killswitchResponse;
-  }
-
-  try {
-    options.headers = Object.assign(getHttpHeaders(), options.headers);
-    const result = await fetch(url, options);
-    if (result.status === 429) {
-      // retry if rate limit is not in effect yet and the request is not droppable
-      const shouldRetryCurrentRequest = (!isRateLimited && !shouldDropOnRateLimit) || shouldRetryRequest;
-      if (shouldRetryCurrentRequest) {
-        isRateLimited = true;
-        const rateLimitResetTime = result.headers.has('ratelimit-reset')
-          ? Number(result.headers.get('ratelimit-reset'))
-          : NETWORK_CONFIG.RATELIMIT_RESET_DEFAULT;
-        return delay(rateLimitResetTime * 1000).then(async () => {
-          return ulFetch(url, options, 0, shouldDropOnRateLimit, true);
-        });
-      } else {
-        return dropOrQueueRequest(shouldDropOnRateLimit, false, requestInfo);
-      }
-    }
-    isRateLimited = false;
-    if (pendingRequestQueue.length) {
-      pendingRequestQueue.map((deferredRequest) => {
-        const { url, options, attempt, shouldDropOnRateLimit } = deferredRequest.payload;
-        ulFetch(url, options, attempt, shouldDropOnRateLimit).then((result) => {
-          deferredRequest.resolveRequest(result);
-        });
-      });
-      pendingRequestQueue = [];
-    }
-    if (result.ok) {
-      if (result.status === 249) {
-        killNetworkRequests();
-        return killswitchResponse;
-      }
-
-      const responseText = await result.text();
-      try {
-        if (responseText && responseText !== 'OK') {
-          result.json = JSON.parse(responseText);
-        }
-        return result;
-      } catch (err) {
-        return {
-          ok: false,
-          reportError: true,
-          error: new Error(`failed parsing response json for ${url} - ${responseText}`),
-        };
-      }
-    }
-    return result;
-  } catch (err) {
-    //retry
-    const newAttempt = attempt + 1;
-    if (newAttempt > 2) {
-      return {
-        ok: false,
-        reportError: false,
-        error: err,
-      };
-    }
-    return delay(newAttempt * 1000).then(() => {
-      return ulFetch(url, options, newAttempt);
-    });
-  }
-}

package/shared/networkHelper.d.ts

@@ -1,5 +0,0 @@
-export function delay(t: any, v: any): Promise<any>;
-export namespace NETWORK_CONFIG {
-    const RATELIMIT_RESET_DEFAULT: number;
-}
-//# sourceMappingURL=networkHelper.d.ts.map

package/shared/networkHelper.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"networkHelper.d.ts","sourceRoot":"","sources":["../../../sprig-browser/shared/networkHelper.js"],"names":[],"mappings":"AAAA,oDAIC"}

package/shared/networkHelper.js

@@ -1,9 +0,0 @@
-export function delay(t, v) {
-  return new Promise(function(resolve) {
-    setTimeout(resolve.bind(null, v), t);
-  });
-}
-
-export const NETWORK_CONFIG = {
-  RATELIMIT_RESET_DEFAULT: 10, // 10s to restart rate limit retry
-};

package/shared/shouldDirectEmbed.d.ts

@@ -1,7 +0,0 @@
-/**
- * Get true or false for whether to direct embed from platform headers
- * @param {Object} [options = {}]
- * @return {Object} User meta information
- */
-export default function shouldDirectEmbed({ "userleap-platform": platform }?: any): any;
-//# sourceMappingURL=shouldDirectEmbed.d.ts.map

package/shared/shouldDirectEmbed.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"shouldDirectEmbed.d.ts","sourceRoot":"","sources":["../../../sprig-browser/shared/shouldDirectEmbed.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wFAEC"}

package/shared/shouldDirectEmbed.js

@@ -1,8 +0,0 @@
-/**
- * Get true or false for whether to direct embed from platform headers
- * @param {Object} [options = {}]
- * @return {Object} User meta information
- */
-export default function shouldDirectEmbed({ 'userleap-platform': platform }) {
-  return platform !== 'web';
-}

package/shared/tool.d.ts

@@ -1,3 +0,0 @@
-export function overrideStyles(document: any, styleString: any): void;
-export function calculateFrameHeight(document: any): any;
-//# sourceMappingURL=tool.d.ts.map

package/shared/tool.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tool.d.ts","sourceRoot":"","sources":["../../../sprig-browser/shared/tool.js"],"names":[],"mappings":"AAIO,sEAMN;AAEM,yDAMN"}

package/shared/tool.js

@@ -1,19 +0,0 @@
-// for shared functions across the sdk
-
-import { CSS_CONSTANTS } from './constants';
-
-export const overrideStyles = (document, styleString) => {
-  const overrideStyles = document.createElement('style');
-  overrideStyles.type = 'text/css';
-  overrideStyles.textContent = styleString;
-  overrideStyles.id = CSS_CONSTANTS.CUSTOM_STYLE_TAG_ID;
-  document.head.appendChild(overrideStyles);
-};
-
-export const calculateFrameHeight = (document) => {
-  const container = document.querySelector(`.${CSS_CONSTANTS.CARD_CONTAINER_CLASS}`);
-  const containerHeight = container ? container.scrollHeight : 600;
-  const whiteSpace =
-    container && container.parentElement ? container.parentElement.clientHeight - container.clientHeight : 0;
-  return containerHeight + whiteSpace;
-};

package/shared/ulEvents.d.ts

@@ -1,33 +0,0 @@
-export namespace ulEvents {
-    const SURVEY_LIFE_CYCLE: string;
-    const SURVEY_DIMENSIONS: string;
-    const SURVEY_HEIGHT: string;
-    const SURVEY_PRESENTED: string;
-    const SURVEY_APPEARED: string;
-    const SURVEY_FADING_OUT: string;
-    const SURVEY_WILL_CLOSE: string;
-    const SURVEY_CLOSED: string;
-    const SDK_READY: string;
-    const CLOSE_SURVEY_ON_OVERLAY_CLICK: string;
-    const VISITOR_ID_UPDATED: string;
-}
-export namespace internalEvents {
-    namespace name {
-        const VERIFY_VIEW_VERSION: string;
-    }
-    namespace data {
-        const VIEW_VERSION: string;
-    }
-}
-export namespace DISMISS_REASONS {
-    const CLOSED: string;
-    const COMPLETE: string;
-    const PAGE_CHANGE: string;
-    const API: string;
-    const OVERRIDE: string;
-}
-export namespace SURVEY_STATE {
-    const READY: string;
-    const NO_SURVEY: string;
-}
-//# sourceMappingURL=ulEvents.d.ts.map

package/shared/ulEvents.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ulEvents.d.ts","sourceRoot":"","sources":["../../../sprig-browser/shared/ulEvents.js"],"names":[],"mappings":""}

package/shared/ulEvents.js

@@ -1,45 +0,0 @@
-// UserLeap event constants
-// event convention
-// event name: descriptive name of the event that happened
-//  payload: {
-//    name: 'event name',
-//    descriptiveDataName: data
-//  }
-export const ulEvents = {
-  // passing into controller
-  SURVEY_LIFE_CYCLE: 'survey.lifeCycle',
-  SURVEY_DIMENSIONS: 'survey.dimensions',
-  SURVEY_HEIGHT: 'survey.height',
-  SURVEY_PRESENTED: 'survey.presented',
-  SURVEY_APPEARED: 'survey.appeared',
-  SURVEY_FADING_OUT: 'survey.fadingOut',
-  SURVEY_WILL_CLOSE: 'survey.willClose',
-  SURVEY_CLOSED: 'survey.closed',
-  SDK_READY: 'sdk.ready',
-  // passing into view
-  CLOSE_SURVEY_ON_OVERLAY_CLICK: 'close.survey.overlayClick',
-  VISITOR_ID_UPDATED: 'visitor.id.updated',
-};
-
-// events not emitted externally and not in the documentation
-export const internalEvents = {
-  name: {
-    VERIFY_VIEW_VERSION: 'verify.view.version',
-  },
-  data: {
-    VIEW_VERSION: 'view.version',
-  },
-};
-
-export const DISMISS_REASONS = {
-  CLOSED: 'close.click', // user clicked the close button
-  COMPLETE: 'survey.completed', // user answered all questions
-  PAGE_CHANGE: 'page.change', // productConfig.dismissOnPageChange == true and we detected a page change (excludes hash/query param changes)
-  API: 'api', // JS called Sprig('dismissActiveSurvey')
-  OVERRIDE: 'override', // JS called Sprig('displaySurvey', SURVEY_ID)
-};
-
-export const SURVEY_STATE = {
-  READY: 'ready',
-  NO_SURVEY: 'no survey',
-};