@sesamy/sesamy-js 1.3.1 → 1.3.3

package/src/services/analytics/index.ts

@@ -1,234 +0,0 @@
-import Analytics, { AnalyticsInstance } from 'analytics';
-import saturated from 'saturated';
-import { name, version } from '../../../package.json';
-import { TrackEvent } from './types/track-event';
-import { AnalyticsConfig } from '../../types/Config';
-import { routeChangeListener } from './listeners';
-import ElementTracker from './element-tracker';
-import { ANALYTICS_BASE_URL } from '../../constants';
-import { getSessionId } from './session-id';
-import { Events } from '../../types/Events';
-
-type Analytic = {
-  anonymousId: string;
-  userId?: string;
-  properties: { [key: string]: string | number };
-  event?: string;
-  type: string;
-};
-
-let flushing = false;
-
-let _clientId: string;
-let _enabled: boolean;
-let _endpoint: string;
-
-export interface AnalyticsEventWithType extends Analytic {
-  type: string;
-}
-
-export function initAnalytics({ clientId, enabled = true, endpoint = ANALYTICS_BASE_URL }: AnalyticsConfig) {
-  _clientId = clientId;
-  _enabled = enabled;
-  _endpoint = endpoint;
-
-  if (!_enabled) {
-    return;
-  }
-
-  // Register route change listener
-  routeChangeListener();
-
-  // Register body events
-  const bodyTracker = new ElementTracker({
-    element: document.body,
-    viewCallback: () => {
-      analytics.page();
-    },
-    activeDurationCallback: (duration: number, flushing?: boolean) => {
-      analytics.track('activeDuration', {
-        duration,
-        flushing,
-      });
-    },
-    idleDurationCallback: (duration: number, flushing?: boolean) => {
-      analytics.track('idleDuration', {
-        duration,
-        flushing,
-      });
-    },
-  });
-
-  addUnloadPageListener(document.body, () => {
-    bodyTracker.flush();
-  });
-
-  window.addEventListener(Events.AUTHENTICATED, async (event: Event) => {
-    const customEvent = event as CustomEvent;
-    await analytics.identify(customEvent.detail.sub);
-  });
-
-  window.addEventListener(Events.LOGOUT, async () => {
-    await analytics.track('logout', {});
-    queue.flush();
-    await analytics.reset();
-  });
-}
-
-function createMessage(payload: AnalyticsEventWithType[]): string {
-  return JSON.stringify(
-    payload.map(item => ({
-      ...item,
-      clientId: _clientId,
-      requestId: Math.random().toString(36).slice(2, 9),
-      sessionId: getSessionId(),
-      timestamp: new Date().toISOString(),
-      version,
-      event: item.event,
-      context: {
-        page: {
-          url: window.location.hostname,
-          path: window.location.pathname,
-          title: document.title,
-          search: window.location.search,
-          referrer: document.referrer,
-        },
-        locale: navigator.language,
-        library: name,
-        userAgent: navigator.userAgent,
-        clientId: _clientId,
-      },
-    })),
-  );
-}
-
-const queue = saturated(
-  async arr => {
-    if (arr.length > 0) {
-      const payload = createMessage(arr);
-
-      if (flushing) {
-        navigator.sendBeacon(_endpoint, payload);
-      } else {
-        const response = await fetch(_endpoint, {
-          method: 'POST',
-          body: payload,
-          headers: {
-            'Content-Type': 'text/plain',
-          },
-        });
-
-        if (!response.ok) {
-          // TODO: Retry, maybe store data in local storage
-        }
-      }
-    }
-  },
-  {
-    max: 10, // limit
-    interval: 3000, // 3s
-  },
-);
-
-function send(payload: AnalyticsEventWithType) {
-  if (!payload.anonymousId) {
-    // When resetting the analytics, the anonymousId is set to null. Skip sending these events
-  } else if (payload.properties?.flushing) {
-    const payloadWithoutFlushing = { ...payload };
-    delete payloadWithoutFlushing.properties.flushing;
-
-    navigator.sendBeacon(_endpoint, createMessage([payloadWithoutFlushing]));
-  } else {
-    queue.push(payload);
-  }
-}
-
-export const analytics: AnalyticsInstance = Analytics({
-  app: name,
-  version,
-  plugins: [
-    {
-      name: 'custom-analytics-plugin',
-      page: ({ payload }: { payload: Analytic }) => {
-        const { properties, anonymousId, userId, event } = payload;
-        const analyticsEvent = {
-          anonymousId,
-          userId,
-          properties,
-          event,
-          type: 'page',
-        };
-        // Send data to custom collection endpoint
-        send(analyticsEvent);
-      },
-      track: ({ payload }: { payload: Analytic }) => {
-        const { properties, anonymousId, userId, event } = payload;
-        const analyticsEvent: AnalyticsEventWithType = {
-          anonymousId,
-          userId,
-          properties,
-          event,
-          type: 'track',
-        };
-        send(analyticsEvent);
-      },
-      identify: ({ payload }: { payload: Analytic }) => {
-        const { properties, anonymousId, userId } = payload;
-        const analyticsEvent: AnalyticsEventWithType = {
-          anonymousId,
-          userId,
-          properties,
-          type: 'identify',
-        };
-        send(analyticsEvent);
-      },
-    },
-  ],
-});
-
-export function getAnonymousUserId() {
-  return analytics.user().anonymousId;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export function track(eventName: string, payload: any): void {
-  analytics.track(eventName, payload);
-}
-
-export function trackEvent(event: TrackEvent): void {
-  analytics.track(event.name, event);
-}
-
-export function flushQueue() {
-  flushing = true;
-  return queue.flush();
-}
-
-export function enableInteractions(callback?: () => void) {
-  analytics.plugins.enable('custom-analytics-plugin', callback);
-}
-
-export function disableInteractions(callback?: () => void) {
-  analytics.plugins.disable('custom-analytics-plugin', callback || (() => true));
-}
-
-export type Action = () => void;
-const unloadPageListeners = new Map<Element, Action>();
-
-export function addUnloadPageListener(element: Element, action: Action) {
-  unloadPageListeners.set(element, action);
-}
-
-export function removeUnloadPageListener(element: Element) {
-  unloadPageListeners.delete(element);
-}
-
-window.addEventListener('beforeunload', () => {
-  // Flush the queues for all the registered element trackers
-  unloadPageListeners.forEach((action, element) => {
-    action.bind(element)();
-  });
-
-  // Flush the outbound queue
-  flushQueue();
-});

package/src/services/analytics/listeners/index.ts

@@ -1,2 +0,0 @@
-export * from './scroll.js';
-export * from './route.js';

package/src/services/analytics/listeners/route.ts

@@ -1,9 +0,0 @@
-/// <reference path="../types/analytics-router-utils.d.ts" />
-import onRouteChange from '@analytics/router-utils';
-import { analytics } from '../index.js';
-
-export function routeChangeListener() {
-  onRouteChange(() => {
-    analytics.page();
-  });
-}

package/src/services/analytics/listeners/scroll.ts

@@ -1,62 +0,0 @@
-/// <reference path="../types/analytics-scroll-utils.d.ts" />
-import { onScrollChange } from '@analytics/scroll-utils';
-import { TrackEvents } from '../types/track-event';
-import { trackEvent } from '..';
-
-export type ScrollEvent = {
-  direction: string;
-  range: number[];
-  scrollMax: number;
-  scrollMin: number;
-  trigger: number;
-};
-
-export function addScrollListener(itemSrc: string, publisherContentId: string) {
-  onScrollChange({
-    25: (scrollData: ScrollEvent) => {
-      trackEvent({
-        name: TrackEvents.Scroll,
-        scrollData: scrollData.direction,
-        percentage: scrollData.trigger,
-        itemSrc,
-        publisherContentId,
-      });
-    },
-    50: (scrollData: ScrollEvent) => {
-      trackEvent({
-        name: TrackEvents.Scroll,
-        scrollData: scrollData.direction,
-        percentage: scrollData.trigger,
-        itemSrc,
-        publisherContentId,
-      });
-    },
-    75: (scrollData: ScrollEvent) => {
-      trackEvent({
-        name: TrackEvents.Scroll,
-        scrollData: scrollData.direction,
-        percentage: scrollData.trigger,
-        itemSrc,
-        publisherContentId,
-      });
-    },
-    90: (scrollData: ScrollEvent) => {
-      trackEvent({
-        name: TrackEvents.Scroll,
-        scrollData: scrollData.direction,
-        percentage: scrollData.trigger,
-        itemSrc,
-        publisherContentId,
-      });
-    },
-    100: (scrollData: ScrollEvent) => {
-      trackEvent({
-        name: TrackEvents.Scroll,
-        scrollData: scrollData.direction,
-        percentage: scrollData.trigger,
-        itemSrc,
-        publisherContentId,
-      });
-    },
-  });
-}

package/src/services/analytics/session-id.ts

@@ -1,11 +0,0 @@
-const SESSION_ID_KEY = 'sesamy_session_id';
-
-export function getSessionId() {
-  let sessionId = sessionStorage.getItem(SESSION_ID_KEY);
-
-  if (!sessionId) {
-    sessionId = Math.random().toString(36).slice(2, 9);
-    sessionStorage.setItem(SESSION_ID_KEY, sessionId);
-  }
-  return sessionId;
-}

package/src/services/analytics/types/analytics-activity-utils.d.ts

@@ -1,54 +0,0 @@
-interface OnDomActivityOptions {
-  throttle?: number;
-}
-
-interface AnalyticsEvent {}
-
-interface OnUserActivityOptions {
-  onIdle?: (elapsedTime: number, event?: AnalyticsEvent) => void;
-  onWakeUp?: (elapsedTime: number, event?: AnalyticsEvent) => void;
-  onHeartbeat?: (elapsedTime: number, event?: AnalyticsEvent) => void;
-  timeout?: number;
-  throttle?: number;
-}
-
-interface UserActivityStatus {
-  disable: () => () => void;
-  getStatus: () => {
-    isIdle: boolean;
-    isDisabled: boolean;
-    active: number;
-    idle: number;
-  };
-}
-
-declare module '@analytics/activity-utils' {
-  /**
-   * Function to handle user inactivity.
-   * @param onIdle Function to be called when the user is idle.
-   * @param opts Optional configuration object.
-   * @returns An object with methods to control and get the status of the listener.
-   */
-  function onIdle(
-    onIdle: (elapsedTime: number, event?: AnalyticsEvent) => void,
-    opts?: OnUserActivityOptions,
-  ): UserActivityStatus;
-
-  /**
-   * Function to handle user wake up from idle.
-   * @param onWakeUp Function to be called when the user wakes up from idle.
-   * @param opts Optional configuration object.
-   * @returns An object with methods to control and get the status of the listener.
-   */
-  function onWakeUp(
-    onWakeUp: (elapsedTime: number, event?: AnalyticsEvent) => void,
-    opts?: OnUserActivityOptions,
-  ): UserActivityStatus;
-
-  /**
-   * Function to handle user activity.
-   * @param options Configuration object for user activity.
-   * @returns An object with methods to control and get the status of the listener.
-   */
-  function onUserActivity(options: OnUserActivityOptions): UserActivityStatus;
-}

package/src/services/analytics/types/analytics-router-utils.d.ts

@@ -1,7 +0,0 @@
-declare module '@analytics/router-utils' {
-  interface definitionInterface {
-    (message: string): void;
-  }
-  function onRouteChange(callback: definitionInterface): void;
-  export default onRouteChange;
-}

package/src/services/analytics/types/analytics-scroll-utils.d.ts

@@ -1,4 +0,0 @@
-declare module '@analytics/scroll-utils' {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  function onScrollChange(t: any): any;
-}

package/src/services/analytics/types/track-event.ts

@@ -1,70 +0,0 @@
-export enum TrackEvents {
-  ViewArticle = 'viewArticle',
-  ActiveDuration = 'activeDuration',
-  IdleDuration = 'idleDuration',
-  Scroll = 'scroll',
-  ChangeView = 'changeView',
-  AddToCart = 'addToCart',
-  ViewArticleListing = 'viewArticleListing',
-}
-
-interface ViewArticleListingProps {
-  name: TrackEvents.ViewArticleListing;
-  publisherContentId?: string;
-  itemSrc: string;
-}
-
-interface AddToCartEventProps {
-  name: TrackEvents.AddToCart;
-  publisherContentId?: string;
-  itemSrc: string;
-}
-
-interface ChangeViewEventProps {
-  name: TrackEvents.ChangeView;
-  view: string;
-}
-
-interface ScrollEventProps {
-  name: TrackEvents.Scroll;
-  publisherContentId?: string;
-  itemSrc: string;
-  scrollData: string;
-  percentage: number;
-}
-
-interface IdleDurationEventProps {
-  name: TrackEvents.IdleDuration;
-  duration: number;
-  publisherContentId?: string;
-  itemSrc: string;
-}
-
-interface ActiveDurationEventProps {
-  name: TrackEvents.ActiveDuration;
-  duration: number;
-  publisherContentId?: string;
-  itemSrc: string;
-}
-
-interface ViewArticleEventProps {
-  name: TrackEvents.ViewArticle;
-  itemSrc: string;
-  publisherContentId?: string;
-  state: 'public' | 'locked' | 'unlocked' | 'logged-in';
-}
-
-interface Flushing {
-  flushing?: boolean;
-}
-
-export type TrackEvent = Flushing &
-  (
-    | ViewArticleEventProps
-    | ActiveDurationEventProps
-    | IdleDurationEventProps
-    | ScrollEventProps
-    | ChangeViewEventProps
-    | AddToCartEventProps
-    | ViewArticleListingProps
-  );

package/src/services/auth/index.ts

@@ -1,74 +0,0 @@
-import { Auth0Client, createAuth0Client } from '@auth0/auth0-spa-js';
-import { BASE_URL_DOMAIN } from '../../constants';
-import { triggerEvent } from '../../events/ready';
-import { Events } from '../../types/Events';
-
-let auth0Client: Auth0Client;
-
-export async function init({ clientId }: { clientId: string }) {
-  auth0Client = await createAuth0Client({
-    domain: `token.${BASE_URL_DOMAIN}`,
-    clientId,
-    cacheLocation: 'localstorage',
-  });
-
-  if (window.location.search.includes('code=')) {
-    try {
-      await auth0Client.handleRedirectCallback();
-      const user = await auth0Client.getUser();
-      triggerEvent(Events.AUTHENTICATED, user);
-      window.history.replaceState({}, document.title, '/');
-      const accessToken = await auth0Client.getTokenSilently();
-      localStorage.setItem('accessToken', accessToken);
-    } catch (err) {
-      // Fail silently
-    }
-  }
-}
-
-export async function isAuthenticated() {
-  if (!auth0Client) {
-    throw new Error('Auth0 client not initialized');
-  }
-  return auth0Client.isAuthenticated();
-}
-
-export async function getUser() {
-  if (!auth0Client) {
-    throw new Error('Auth0 client not initialized');
-  }
-  return auth0Client.getUser();
-}
-
-export function loginWithRedirect() {
-  if (!auth0Client) {
-    throw new Error('Auth0 client not initialized');
-  }
-
-  return auth0Client.loginWithRedirect({
-    authorizationParams: {
-      redirect_uri: window.location.href,
-    },
-  });
-}
-
-export async function getTokenSilently() {
-  if (!auth0Client) {
-    throw new Error('Auth0 client not initialized');
-  }
-  return auth0Client.getTokenSilently();
-}
-
-export async function logout() {
-  if (!auth0Client) {
-    throw new Error('Auth0 client not initialized');
-  }
-
-  triggerEvent(Events.LOGOUT, {});
-
-  return auth0Client.logout({
-    logoutParams: {
-      returnTo: window.location.href,
-    },
-  });
-}

package/src/services/sesamy/index.ts

@@ -1,160 +0,0 @@
-import { dedupe, retry } from "wretch/middlewares";
-import wretch, {
-  ConfiguredMiddleware,
-  WretchOptions,
-  WretchResponse,
-} from "wretch";
-import { BASE_URL_DOMAIN } from "../../constants";
-import { getTokenSilently } from "../auth";
-import { Entitlement } from "../../types/Entitlement";
-import { Contract } from "../../types/Contracts";
-import { Bill } from "../../types/Bills";
-import { Tag, TagValue } from "../../types/Tag";
-
-const auth0Middleware: ConfiguredMiddleware =
-  next =>
-  (url: string, options: WretchOptions): Promise<WretchResponse> => {
-    return new Promise(async (resolve, reject) => {
-      try {
-        const accessToken = await getTokenSilently();
-
-        const modifiedOptions = {
-          ...options,
-          headers: {
-            ...options.headers,
-            Authorization: `Bearer ${accessToken}`,
-          },
-        };
-
-        resolve(next(url, modifiedOptions));
-      } catch (error) {
-        console.error('Error fetching access token:', error);
-        reject(error);
-      }
-    });
-  };
-
-const basicAuthMiddleware: ConfiguredMiddleware =
-  next =>
-  (url: string, options: WretchOptions): Promise<WretchResponse> => {
-    const anonymousId = localStorage.getItem('__anon_id');
-    const accessToken = btoa(`${anonymousId}:`);
-
-    const modifiedOptions = {
-      ...options,
-      headers: {
-        ...options.headers,
-        Authorization: `Basic ${accessToken}`,
-      },
-    };
-
-    return next(url, modifiedOptions);
-  };
-
-const api = wretch(`https://api2.${BASE_URL_DOMAIN}`)
-  .headers({ 'Content-Type': 'application/json' })
-  .middlewares([
-    auth0Middleware,
-    dedupe(),
-    retry({
-      delayTimer: 1000,
-      delayRamp: (delay, nbOfAttempts) => delay * nbOfAttempts,
-      maxAttempts: 3,
-      until: response => response?.ok || false,
-      retryOnNetworkError: false,
-    }),
-  ]);
-
-const apiWithBasicAuth = wretch(`https://api2.${BASE_URL_DOMAIN}`)
-  .headers({ 'Content-Type': 'application/json' })
-  .middlewares([
-    basicAuthMiddleware,
-    dedupe(),
-    retry({
-      delayTimer: 1000,
-      delayRamp: (delay, nbOfAttempts) => delay * nbOfAttempts,
-      maxAttempts: 3,
-      until: response => response?.ok || false,
-      retryOnNetworkError: false,
-    }),
-  ]);
-
-export async function getEntitlements(): Promise<Entitlement[]> {
-  return api.get('/entitlements').json();
-}
-
-export async function getEntitlement(entitlementId: string) {
-  const entitlements: Entitlement[] = await api.get('/entitlements').json();
-
-  return entitlements?.find(entitlement => entitlement.id === entitlementId);
-}
-
-export async function getContracts(): Promise<Contract[]> {
-  return api.get('/contracts').json();
-}
-
-export async function getContract(contractId: string) {
-  const contracts: Contract[] = await api.get('/contracts').json();
-
-  return contracts?.find(contract => contract.id === contractId);
-}
-
-export async function getBills(): Promise<Bill[]> {
-  return api.get('/bills').json();
-}
-
-export async function getBill(billId: string) {
-  const bills: Bill[] = await api.get('/bills').json();
-
-  return bills?.find(bill => bill.id === billId);
-}
-
-export async function getTags() {
-  const tags: { [id: string]: TagValue }[] = await apiWithBasicAuth
-    .get("/tags")
-    .json();
-
-  return tags;
-}
-
-export async function setTag(id: string, value: string | number | (string | number)[]) {
-  const tags: { [id: string]: Tag }[] = await apiWithBasicAuth
-    .url(`/tags/${id}`)
-    .put({
-      value,
-    })
-    .json();
-
-  return tags;
-}
-
-export async function pushTag(id: string, value: string | number) {
-  const tags: { [id: string]: TagValue }[] = await apiWithBasicAuth
-    .url(`/tags/${id}/push`)
-    .put({
-      value,
-    })
-    .json();
-
-  return tags;
-}
-
-// Deprecated. Use tags instead
-export interface AccessArticleParams {
-  articleId: string;
-}
-
-export async function accessArticle(params: AccessArticleParams): Promise<{ status: string }> {
-  const userId = localStorage.getItem('__anon_id');
-  if (!userId) {
-    throw new Error('User id not found');
-  }
-
-  return apiWithBasicAuth
-    .url('/articles/access')
-    .post({
-      articleId: params.articleId,
-      userId,
-    })
-    .json();
-}

package/src/state.ts

@@ -1,3 +0,0 @@
-{
-  // Soon to come more stuff here..
-}