@ht-sdks/events-sdk-js-browser 1.0.4

package/src/core/user/index.ts

@@ -0,0 +1,399 @@
+import { v4 as uuid } from '@lukeed/uuid'
+import autoBind from '../../lib/bind-all'
+import { Traits } from '../events'
+import {
+  CookieOptions,
+  UniversalStorage,
+  MemoryStorage,
+  StorageObject,
+  StorageSettings,
+  StoreType,
+  applyCookieOptions,
+  initializeStorages,
+  isArrayOfStoreType,
+} from '../storage'
+import { decryptRudderValue, decryptRudderHtValue } from './migrate'
+import {
+  SessionContext,
+  SessionInfo,
+  generateAutoTrackingSession,
+  generateManualTrackingSession,
+  hasSessionExpired,
+  updateSessionExpiration,
+} from '../session'
+
+export type ID = string | null | undefined
+
+export interface UserOptions {
+  /**
+   * Disables storing any data about the user.
+   */
+  disable?: boolean
+  localStorageFallbackDisabled?: boolean
+  persist?: boolean
+
+  cookie?: {
+    key?: string
+    oldKey?: string
+  }
+
+  localStorage?: {
+    key: string
+  }
+
+  sessions?: {
+    autoTrack?: boolean
+    timeout?: number // milliseconds
+  }
+
+  /**
+   * Store priority
+   * @example stores: [StoreType.Cookie, StoreType.Memory]
+   */
+  storage?: StorageSettings
+}
+
+const defaults = {
+  persist: true,
+  cookie: {
+    key: 'htjs_user_id',
+    oldKey: 'ajs_user',
+  },
+  localStorage: {
+    key: 'htjs_user_traits',
+  },
+  sessions: {
+    autoTrack: true,
+  },
+}
+
+const sessionKey = 'htjs_sesh'
+const anonymousIdKey = 'htjs_anonymous_id'
+const rudderHtAnonymousIdKey = 'htev_anonymous_id'
+const segmentAnonymousIdKey = 'ajs_anonymous_id'
+const rudderAnonymousIdKey = 'rl_anonymous_id'
+
+export class User {
+  static defaults = defaults
+
+  private idKey: string
+  private traitsKey: string
+  private anonKey: string
+  private seshKey: string
+  private cookieOptions?: CookieOptions
+
+  private legacyUserStore: UniversalStorage<{
+    [k: string]:
+      | {
+          id?: string
+          traits?: Traits
+        }
+      | string
+  }>
+  private traitsStore: UniversalStorage<{
+    [k: string]: Traits
+  }>
+
+  private identityStore: UniversalStorage<{
+    [k: string]: string
+  }>
+
+  private sessionStore: UniversalStorage<{ [k: string]: SessionInfo }>
+
+  options: UserOptions = {}
+
+  constructor(options: UserOptions = defaults, cookieOptions?: CookieOptions) {
+    this.options = { ...defaults, ...options }
+    this.cookieOptions = cookieOptions
+
+    this.idKey = options.cookie?.key ?? defaults.cookie.key
+    this.traitsKey = options.localStorage?.key ?? defaults.localStorage.key
+    this.anonKey = anonymousIdKey
+    this.seshKey = sessionKey
+
+    this.identityStore = this.createStorage(this.options, cookieOptions)
+
+    this.sessionStore = this.createStorage(this.options, cookieOptions)
+
+    // using only cookies for legacy user store
+    this.legacyUserStore = this.createStorage(
+      this.options,
+      cookieOptions,
+      (s) => s === StoreType.Cookie
+    )
+
+    // using only localStorage / memory for traits store
+    this.traitsStore = this.createStorage(
+      this.options,
+      cookieOptions,
+      (s) => s !== StoreType.Cookie
+    )
+
+    const legacyUser = this.legacyUserStore.get(defaults.cookie.oldKey)
+    if (legacyUser && typeof legacyUser === 'object') {
+      legacyUser.id && this.id(legacyUser.id)
+      legacyUser.traits && this.traits(legacyUser.traits)
+    }
+    autoBind(this)
+  }
+
+  id = (id?: ID): ID => {
+    if (this.options.disable) {
+      return null
+    }
+
+    const prevId = this.identityStore.getAndSync(this.idKey)
+
+    if (id !== undefined) {
+      this.identityStore.set(this.idKey, id)
+
+      const changingIdentity = id !== prevId && prevId !== null && id !== null
+      if (changingIdentity) {
+        this.anonymousId(null)
+      }
+    }
+
+    const retId = this.identityStore.getAndSync(this.idKey)
+    if (retId) return retId
+
+    const retLeg = this.legacyUserStore.get(defaults.cookie.oldKey)
+    return retLeg ? (typeof retLeg === 'object' ? retLeg.id : retLeg) : null
+  }
+
+  private legacySIO(): [string, string] | null {
+    const val = this.legacyUserStore.get('_sio') as string
+    if (!val) {
+      return null
+    }
+    const [anon, user] = val.split('----')
+    return [anon, user]
+  }
+
+  anonymousId = (id?: ID): ID => {
+    if (this.options.disable) {
+      return null
+    }
+
+    if (id === undefined) {
+      let val = this.identityStore.getAndSync(this.anonKey)
+
+      // support anonymousId migration from other analytics providers
+      if (!val) {
+        val = decryptRudderHtValue(
+          this.identityStore.getAndSync(rudderHtAnonymousIdKey) ?? ''
+        )
+        if (val) this.identityStore.set(this.anonKey, val)
+      }
+      if (!val) {
+        val = this.identityStore.getAndSync(segmentAnonymousIdKey)
+        if (val) this.identityStore.set(this.anonKey, val)
+      }
+      if (!val) {
+        val = decryptRudderValue(
+          this.identityStore.getAndSync(rudderAnonymousIdKey) ?? ''
+        )
+        if (val) this.identityStore.set(this.anonKey, val)
+      }
+      if (!val) {
+        val = this.legacySIO()?.[0] ?? null
+      }
+
+      if (val) {
+        return val
+      }
+    }
+
+    if (id === null) {
+      this.identityStore.set(this.anonKey, null)
+      return this.identityStore.getAndSync(this.anonKey)
+    }
+
+    this.identityStore.set(this.anonKey, id ?? uuid())
+    return this.identityStore.getAndSync(this.anonKey)
+  }
+
+  traits = (traits?: Traits | null): Traits | undefined => {
+    if (this.options.disable) {
+      return
+    }
+
+    if (traits === null) {
+      traits = {}
+    }
+
+    if (traits) {
+      this.traitsStore.set(this.traitsKey, traits ?? {})
+    }
+
+    return this.traitsStore.get(this.traitsKey) ?? {}
+  }
+
+  identify(id?: ID, traits?: Traits): void {
+    if (this.options.disable) {
+      return
+    }
+
+    traits = traits ?? {}
+    const currentId = this.id()
+
+    if (currentId === null || currentId === id) {
+      traits = {
+        ...this.traits(),
+        ...traits,
+      }
+    }
+
+    if (id) {
+      this.id(id)
+    }
+
+    this.traits(traits)
+  }
+
+  startManualSession(sessionId?: number) {
+    if (this.options.disable) {
+      return
+    }
+    this.sessionStore.clear(this.seshKey)
+    const session = generateManualTrackingSession(sessionId)
+    this.sessionStore.set(this.seshKey, session)
+  }
+
+  endManualSession() {
+    this.sessionStore.clear(this.seshKey)
+  }
+
+  private getAndUpdateSessionInfo(): SessionInfo | null {
+    if (this.options.disable) {
+      return null
+    }
+
+    let session = this.sessionStore.getAndSync(this.seshKey)
+
+    if (session == null) {
+      if (this.options?.sessions?.autoTrack) {
+        session = generateAutoTrackingSession(this.options?.sessions?.timeout)
+        this.sessionStore.set(this.seshKey, session)
+        return session
+      }
+      return null
+    }
+
+    if (session?.autoTrack && hasSessionExpired(session.expiresAt!)) {
+      session = generateAutoTrackingSession(this.options?.sessions?.timeout)
+      this.sessionStore.set(this.seshKey, session)
+      return session
+    }
+
+    session = updateSessionExpiration(session)
+    this.sessionStore.set(this.seshKey, session)
+    return session
+  }
+
+  getAndUpdateSession(): SessionContext | null {
+    const sessionInfo = this.getAndUpdateSessionInfo()
+    const session: SessionContext = {}
+    if (sessionInfo?.id) session.sessionId = sessionInfo.id
+    if (sessionInfo?.sessionStart)
+      session.sessionStart = sessionInfo.sessionStart
+    return session
+  }
+
+  sessionId(): number | null {
+    const session = this.sessionStore.getAndSync(this.seshKey)
+    return session?.id ?? null
+  }
+
+  logout(): void {
+    this.anonymousId(null)
+    this.id(null)
+    this.traits({})
+  }
+
+  reset(): void {
+    this.logout()
+    this.identityStore.clear(this.idKey)
+    this.identityStore.clear(this.anonKey)
+    this.sessionStore.clear(this.seshKey)
+    this.traitsStore.clear(this.traitsKey)
+  }
+
+  load(): User {
+    return new User(this.options, this.cookieOptions)
+  }
+
+  save(): boolean {
+    return true
+  }
+
+  /**
+   * Creates the right storage system applying all the user options, cookie options and particular filters
+   * @param options UserOptions
+   * @param cookieOpts CookieOptions
+   * @param filterStores filter function to apply to any StoreTypes (skipped if options specify using a custom storage)
+   * @returns a Storage object
+   */
+  private createStorage<T extends StorageObject = StorageObject>(
+    options: UserOptions,
+    cookieOpts?: CookieOptions,
+    filterStores?: (value: StoreType) => boolean
+  ): UniversalStorage<T> {
+    let stores: StoreType[] = [
+      StoreType.LocalStorage,
+      StoreType.Cookie,
+      StoreType.Memory,
+    ]
+
+    // If disabled we won't have any storage functionality
+    if (options.disable) {
+      return new UniversalStorage<T>([])
+    }
+
+    // If persistance is disabled we will always fallback to Memory Storage
+    if (!options.persist) {
+      return new UniversalStorage<T>([new MemoryStorage<T>()])
+    }
+
+    if (options.storage !== undefined && options.storage !== null) {
+      if (isArrayOfStoreType(options.storage)) {
+        // If the user only specified order of stores we will still apply filters and transformations e.g. not using localStorage if localStorageFallbackDisabled
+        stores = options.storage.stores
+      }
+    }
+
+    // Disable LocalStorage
+    if (options.localStorageFallbackDisabled) {
+      stores = stores.filter((s) => s !== StoreType.LocalStorage)
+    }
+
+    // Apply Additional filters
+    if (filterStores) {
+      stores = stores.filter(filterStores)
+    }
+
+    return new UniversalStorage(
+      initializeStorages(applyCookieOptions(stores, cookieOpts))
+    )
+  }
+}
+
+const groupDefaults: UserOptions = {
+  persist: true,
+  cookie: {
+    key: 'htjs_group_id',
+  },
+  localStorage: {
+    key: 'htjs_group_properties',
+  },
+}
+
+export class Group extends User {
+  constructor(options: UserOptions = groupDefaults, cookie?: CookieOptions) {
+    super({ ...groupDefaults, ...options }, cookie)
+    autoBind(this)
+  }
+
+  anonymousId = (_id?: ID): ID => {
+    return undefined
+  }
+}

package/src/core/user/migrate.ts

@@ -0,0 +1,126 @@
+import { AES } from './vendor/crypto-es/lib/aes'
+import { Utf8 } from './vendor/crypto-es/lib/core'
+
+// https://github.com/rudderlabs/rudder-sdk-js/blob/5494b0acbc6da3df088884b2d10a2d22c0811ffb/LICENSE
+// MIT License
+
+// Copyright (c) 2021 RudderStack
+
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+/**
+ * Converts a base64 encoded string to bytes array
+ * @param base64Str base64 encoded string
+ * @returns bytes array
+ */
+const base64ToBytes = (base64Str: string): Uint8Array => {
+  const binString = (window as any)?.atob(base64Str) ?? ''
+  const bytes = binString.split('').map((char: string) => char.charCodeAt(0))
+  return new Uint8Array(bytes)
+}
+
+/**
+ * Decodes a base64 encoded string
+ * @param value base64 encoded string
+ * @returns decoded string
+ */
+const fromBase64 = (value: string): string =>
+  new TextDecoder().decode(base64ToBytes(value))
+
+/**
+ * JSON parse the value
+ * @param {*} value
+ */
+function parse(value: any) {
+  // if not parsable, return as is without json parse
+  try {
+    return value ? JSON.parse(value) : null
+  } catch (e) {
+    return value || null
+  }
+}
+
+const rudderHtEncryptKey = 'HTEV'
+export const rudderHtPrefix = 'HtEvEncrypt:'
+
+/**
+ * DEPRECATED
+ * decrypt value originally made by Ht fork of rudder v1 encryption
+ */
+export function decryptRudderHtValue(value: string): string | null {
+  try {
+    if (!value || typeof value !== 'string' || value.trim() === '') {
+      return null
+    }
+
+    // Try if its hightouch-fork-of-rudder v1 encrypted
+    // We should be able to delete this shortly
+    // We do not intend to encrypt future anonymousIds
+    if (value.substring(0, rudderHtPrefix.length) === rudderHtPrefix) {
+      return parse(
+        // @ts-ignore 2554
+        AES.decrypt(
+          value.substring(rudderHtPrefix.length),
+          rudderHtEncryptKey
+        ).toString(Utf8)
+      )
+    }
+  } catch (error) {
+    console.error(error)
+  }
+  return value
+}
+
+const rudderEncryptKey = 'Rudder'
+const rudderPrefixV1 = 'RudderEncrypt:'
+const rudderPrefixV3 = 'RS_ENC_v3_'
+
+/**
+ * decrypt value originally made by rudder v1 or v3 encryption
+ */
+export function decryptRudderValue(value: string): string | null {
+  try {
+    if (!value || typeof value !== 'string' || value.trim() === '') {
+      return null
+    }
+
+    // Try if its rudder v1 encrypted
+    if (value.substring(0, rudderPrefixV1.length) === rudderPrefixV1) {
+      return parse(
+        // @ts-ignore 2554
+        AES.decrypt(
+          value.substring(rudderPrefixV1.length),
+          rudderEncryptKey
+        ).toString(Utf8)
+      )
+    }
+
+    // Try if its rudder v3 encrypted
+    if (value.substring(0, rudderPrefixV3.length) === rudderPrefixV3) {
+      const parsed = parse(fromBase64(value.substring(rudderPrefixV3.length)))
+      if (!parsed || typeof parsed !== 'string' || parsed.trim() === '') {
+        return null
+      }
+      return parsed
+    }
+  } catch (error) {
+    console.error(error)
+  }
+  return value
+}

package/src/core/user/tld.ts

@@ -0,0 +1,65 @@
+import cookie from 'js-cookie'
+
+/**
+ * Levels returns all levels of the given url.
+ *
+ * @param {string} url
+ * @return {Array}
+ * @api public
+ */
+function levels(url: URL): string[] {
+  const host = url.hostname
+  const parts = host.split('.')
+  const last = parts[parts.length - 1]
+  const levels: string[] = []
+
+  // Ip address.
+  if (parts.length === 4 && parseInt(last, 10) > 0) {
+    return levels
+  }
+
+  // Localhost.
+  if (parts.length <= 1) {
+    return levels
+  }
+
+  // Create levels.
+  for (let i = parts.length - 2; i >= 0; --i) {
+    levels.push(parts.slice(i).join('.'))
+  }
+
+  return levels
+}
+
+function parseUrl(url: string): URL | undefined {
+  try {
+    return new URL(url)
+  } catch {
+    return
+  }
+}
+
+export function tld(url: string): string | undefined {
+  const parsedUrl = parseUrl(url)
+  if (!parsedUrl) return
+
+  const lvls = levels(parsedUrl)
+
+  // Lookup the real top level one.
+  for (let i = 0; i < lvls.length; ++i) {
+    const cname = '__tld__'
+    const domain = lvls[i]
+    const opts = { domain: '.' + domain }
+
+    try {
+      // cookie access throw an error if the library is ran inside a sandboxed environment (e.g. sandboxed iframe)
+      cookie.set(cname, '1', opts)
+      if (cookie.get(cname)) {
+        cookie.remove(cname, opts)
+        return domain
+      }
+    } catch (_) {
+      return
+    }
+  }
+}

package/src/core/user/vendor/crypto-es/LICENSE

@@ -0,0 +1,53 @@
+MIT License
+
+Copyright (c) 2018-2020 LIN Chen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+[The MIT License (MIT)](http://opensource.org/licenses/MIT)
+
+Copyright (c) 2009-2013 Jeff Mott  
+Copyright (c) 2013-2016 Evan Vosberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+(c) 2009-2013 by Jeff Mott. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation or other materials provided with the distribution.
+Neither the name CryptoJS nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS," AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.