castled-js-sdk 0.0.3 → 0.0.4

package/packages/npm/README.md

@@ -1,125 +0,0 @@
-# Castled Javascript Events SDK
-
-## Installation
-
-```bash
-npm install castled-js-sdk --save
-```
-
-**Note that this NPM module is only meant to be used for a browser installation**. If you want to integrate with your Node.js application, refer to the [**Node.js repository**](https://github.com/ht-sdks/events-sdk-node).
-<br><br>
-
-**IMPORTANT**: You should run the following code snippet only once and use the exported object throughout your project (e.g. Node module caching):
-
-```javascript
-import * as analytics from "castled-js-sdk";
-analytics.ready(() => {
-  console.log("we are all set!!!");
-});
-analytics.load(<WRITE_KEY>, <DATA_PLANE_URL>, {configUrl: <CONTROL_PLANE_URL> });
-export { analytics };
-```
-
-You can also do this with **ES5** using the `require` method, as shown:
-
-```javascript
-var analytics = require("castled-js-sdk");
-analytics.load(<WRITE_KEY>, <DATA_PLANE_URL>, {config:Url: <CONTROL_PLANE_URL>});
-exports.analytics = analytics;
-```
-
-### Exported APIs
-
-The APIs exported by the module are:
-
-- `load`
-- `ready`
-- `identify`
-- `alias`
-- `page`
-- `track`
-- `group`
-- `reset`
-- `getAnonymousId`
-- `setAnonymousId`
-
-### Supported browser versions
-
-| **Browser**     | **Supported Versions** |
-| :-------------- | :--------------------- |
-| Safari          | v7 or later            |
-| IE              | v10 or later           |
-| Edge            | v15 or later           |
-| Mozilla Firefox | v40 or later           |
-| Chrome          | v37 or later           |
-| Opera           | v23 or later           |
-| Yandex          | v14.12 or later        |
-
-> If the SDK does not work on the browser versions that you are targeting, verify if adding the browser polyfills to your application solves the issue.
-
-## Identifying users
-
-The `identify` call lets you identify a visiting user and associate them to their actions. It also lets you record the traits about them like their name, email address, etc.
-
-A sample `identify()` call is shown below:
-
-```javascript
-analytics.identify(
-  '12345',
-  {
-    email: 'name@domain.com',
-  },
-  {
-    page: {
-      path: '',
-      referrer: '',
-      search: '',
-      title: '',
-      url: '',
-    },
-  },
-  () => {
-    console.log('in identify call');
-  },
-);
-```
-
-In the above example, the user-related information like the `userId` and `email` (and other contextual info) is captured.
-
-> There is no need to call `identify()` for anonymous visitors to your website. Such visitors are automatically assigned an `anonymousId`.
-
-## Tracking user actions
-
-The `track` call lets you record the customer events, i.e. the actions that they perform, along with any associated properties.
-
-A sample `track` call is shown below:
-
-```javascript
-analytics.track(
-  'test track event GA3',
-  {
-    revenue: 30,
-    currency: 'USD',
-    user_actual_id: 12345,
-  },
-  () => {
-    console.log('in track call');
-  },
-);
-```
-
-In the above example, the `track` method tracks the user event ‘**test track event GA3**’ and information such as the `revenue`, `currency`, `anonymousId`.
-
-> You can use the `track` method to track various success metrics for your website like user signups, item purchases, article bookmarks, and more.
-
-## The `ready` API
-
-There are cases when you may want to tap into the features provided by the end-destination SDKs to enhance tracking and other functionalities. The JavaScript SDK exposes a `ready` API with a `callback` parameter that fires when the SDK is done initializing itself and the other third-party native SDK destinations.
-
-An example is shown in the following snippet:
-
-```javascript
-analytics.ready(() => {
-  console.log('we are all set!!!');
-});
-```

package/packages/npm/package.json

@@ -1,50 +0,0 @@
-{
-  "name": "castled-js-sdk",
-  "version": "0.0.3",
-  "description": "Castled Javascript Events SDK",
-  "main": "index.js",
-  "module": "index.es.js",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "import": "./index.es.js",
-      "require": "./index.js"
-    },
-    "./service-worker": {
-      "types": "./service-worker/index.d.ts",
-      "import": "./service-worker/index.es.js",
-      "require": "./service-worker/index.js"
-    },
-    "./service-worker/index.es": {
-      "types": "./service-worker/index.d.ts",
-      "import": "./service-worker/index.es.js"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      ".": [
-        "index.d.ts"
-      ],
-      "service-worker": [
-        "service-worker/index.d.ts"
-      ],
-      "service-worker/index.es": [
-        "service-worker/index.d.ts"
-      ]
-    }
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "Castled Data",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/castledio/castled-js-sdk.git"
-  },
-  "bugs": {
-    "url": "https://github.com/castledio/castled-js-sdk/issues"
-  },
-  "homepage": "https://github.com/castledio/castled-js-sdk/blob/master/README.md"
-}

package/patches/@segment+localstorage-retry+1.3.0.patch

@@ -1,73 +0,0 @@
-diff --git a/node_modules/@segment/localstorage-retry/lib/engine.js b/node_modules/@segment/localstorage-retry/lib/engine.js
-index 5e3fffe..656a774 100644
---- a/node_modules/@segment/localstorage-retry/lib/engine.js
-+++ b/node_modules/@segment/localstorage-retry/lib/engine.js
-@@ -1,7 +1,7 @@
- 'use strict';
- 
- var keys = require('@ndhoule/keys');
--var uuid = require('uuid').v4;
-+var uuid = require('@lukeed/uuid').v4;
- 
- var inMemoryStore = {
-   _data: {},
-diff --git a/node_modules/@segment/localstorage-retry/lib/index.js b/node_modules/@segment/localstorage-retry/lib/index.js
-index 34220e8..f946ede 100644
---- a/node_modules/@segment/localstorage-retry/lib/index.js
-+++ b/node_modules/@segment/localstorage-retry/lib/index.js
-@@ -283,6 +283,7 @@ Queue.prototype._checkReclaim = function() {
-     var storage = self._store.getOriginalEngine();
-     for (var i = 0; i < storage.length; i++) {
-       var k = storage.key(i);
-+      if (k === null) continue;
-       var parts = k.split('.');
-       if (parts.length !== 3) continue;
-       if (parts[0] !== name) continue;
-@@ -345,15 +346,41 @@ Queue.prototype._reclaim = function(id) {
- 
-   this._store.set(this.keys.QUEUE, our.queue);
- 
--  // remove all keys
--  other.remove(this.keys.IN_PROGRESS);
--  other.remove(this.keys.QUEUE);
--  other.remove(this.keys.RECLAIM_START);
--  other.remove(this.keys.RECLAIM_END);
--  other.remove(this.keys.ACK);
-+  // remove all keys one by one, on next tick to avoid NS_ERROR_STORAGE_BUSY error
-+  try {
-+    this._clearOtherQueue(other, 1);
-+  } catch(e) {
-+    if(e.name === "NS_ERROR_STORAGE_BUSY" || e.code === "NS_ERROR_STORAGE_BUSY" || e.code === 0x80630001) {
-+      try {
-+        this._clearOtherQueue(other, 40);
-+      } catch(retryError) {
-+        console.error(retryError);
-+      }
-+    } else {
-+      console.error(e);
-+    }
-+  }
- 
-   // process the new items we claimed
-   this._processHead();
- };
- 
-+Queue.prototype._clearOtherQueue = function(other, localStorageBackoff) {
-+    setTimeout(() => {
-+      other.remove(this.keys.IN_PROGRESS);
-+      setTimeout(() => {
-+        other.remove(this.keys.QUEUE);
-+        setTimeout(() => {
-+          other.remove(this.keys.RECLAIM_START);
-+          setTimeout(() => {
-+            other.remove(this.keys.RECLAIM_END);
-+            setTimeout(() => {
-+              other.remove(this.keys.ACK);
-+            }, localStorageBackoff);
-+          }, localStorageBackoff);
-+        }, localStorageBackoff);
-+      }, localStorageBackoff);
-+    }, localStorageBackoff);
-+}
-+
- module.exports = Queue;

package/patches/@segment+top-domain+3.0.1.patch

@@ -1,34 +0,0 @@
-diff --git a/node_modules/@segment/top-domain/lib/index.js b/node_modules/@segment/top-domain/lib/index.js
-index ae67f2e..1913b53 100644
---- a/node_modules/@segment/top-domain/lib/index.js
-+++ b/node_modules/@segment/top-domain/lib/index.js
-@@ -4,7 +4,6 @@
-  * Module dependencies.
-  */
- 
--var parse = require('component-url').parse;
- var cookie = require('component-cookie');
- 
- /**
-@@ -55,6 +54,12 @@ function domain(url) {
-   return '';
- }
- 
-+function legacyGetHostname(href) {
-+  const l = document.createElement("a");
-+  l.href = href;
-+  return l.hostname;
-+};
-+
- /**
-  * Levels returns all levels of the given url.
-  *
-@@ -63,7 +68,7 @@ function domain(url) {
-  * @api public
-  */
- domain.levels = function(url) {
--  var host = parse(url).hostname;
-+  var host = typeof window.URL !== 'function' ? legacyGetHostname(url) : new URL(url).hostname;
-   var parts = host.split('.');
-   var last = parts[parts.length - 1];
-   var levels = [];

package/public/index.html

@@ -1,136 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Smoke test</title>
-
-    <script>
-      hightouchevents = window.hightouchevents = [];
-      var methods = [
-        'load',
-        'page',
-        'track',
-        'identify',
-        'alias',
-        'group',
-        'ready',
-        'reset',
-        'getAnonymousId',
-        'setAnonymousId',
-        'getUserId',
-        'getUserTraits',
-        'getGroupId',
-        'getGroupTraits',
-        'endSession',
-        'startSession',
-      ];
-
-      for (var i = 0; i < methods.length; i++) {
-        var method = methods[i];
-        hightouchevents[method] = (function (methodName) {
-          return function () {
-            hightouchevents.push([methodName].concat(Array.prototype.slice.call(arguments)));
-          };
-        })(method);
-      }
-
-      hightouchevents.load('__WRITE_KEY__', '__DATAPLANE_URL__', {
-        logLevel: 'DEBUG',
-        configUrl: '__CONFIG_SERVER_HOST__',
-        destSDKBaseURL: '__DEST_SDK_BASE_URL__',
-        // useBeacon: true,
-        // beaconQueueOptions: {
-        //   flushQueueInterval: 60 * 1000,
-        // }
-      });
-
-      hightouchevents.page();
-    </script>
-  </head>
-
-  <body>
-    <h1>Test HTML file</h1>
-    <br />
-
-    <button data-testid="page-btn" onclick="page()">Page</button>
-    <button data-testid="identify-btn" onclick="identify()">identify</button>
-    <button data-testid="track-btn" onclick="track()">Track</button>
-    <button data-testid="alias-btn" onclick="alias()">Alias</button>
-    <button data-testid="group-btn" onclick="group()">Group</button>
-
-    <p data-testid="action" id="action"></p>
-    <p data-testid="payload" id="htElement"></p>
-
-    <script>
-      function page() {
-        hightouchevents.page('Cart viewed', function (htElement) {
-          console.log('in page call');
-          document.getElementById('action').innerHTML = 'Page called';
-          document.getElementById('htElement').innerHTML = JSON.stringify(htElement);
-        });
-      }
-
-      function identify() {
-        hightouchevents.identify(
-          'Sample-User-id',
-          {
-            firstName: 'Tintin',
-            city: 'Brussels',
-            country: 'Belgium',
-            phone: '1234567890',
-            email: 'tintin@twentiethcentury.com',
-            custom_flavor: 'chocolate',
-            custom_date: Date.now(),
-          },
-          {},
-          function (htElement) {
-            console.log('in identify call');
-            document.getElementById('action').innerHTML = 'Identify called';
-            document.getElementById('htElement').innerHTML = JSON.stringify(htElement);
-          },
-        );
-      }
-
-      function track() {
-        hightouchevents.track(
-          'Sample Track event',
-          {
-            revenue: 30,
-            currency: 'USD',
-            user_actual_id: 12345,
-          },
-          function (htElement) {
-            console.log('in track call');
-            document.getElementById('action').innerHTML = 'Track called';
-            document.getElementById('htElement').innerHTML = JSON.stringify(htElement);
-          },
-        );
-      }
-
-      function alias() {
-        hightouchevents.alias('alias-user-id', function (htElement) {
-          console.log('alias call');
-          document.getElementById('action').innerHTML = 'Alias called';
-          document.getElementById('htElement').innerHTML = JSON.stringify(htElement);
-        });
-      }
-
-      function group() {
-        hightouchevents.group(
-          'sample_group_id',
-          {
-            name: 'Apple Inc.',
-            location: 'USA',
-          },
-          function (htElement) {
-            console.log('group call');
-            document.getElementById('action').innerHTML = 'Group called';
-            document.getElementById('htElement').innerHTML = JSON.stringify(htElement);
-          },
-        );
-      }
-    </script>
-  </body>
-</html>