@churnsignal/churnsignal-sdk-web 0.1.1

package/README.md

@@ -0,0 +1,63 @@
+# RAVEN SDK WEB
+This SDK allows developers to seamlessly integrate Raven into their Web applications
+
+## Commands
+
+### Install dependencies
+
+To install the dependencies run:
+
+```bash
+npm i
+```
+
+To do a one-off build
+
+```bash
+npm run build
+```
+
+This builds the library to `/dist` folder
+
+To run in watch mode run
+
+```bash
+npm start
+```
+
+This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
+
+To run tests run
+
+```bash
+npm run test
+```
+
+## Checking if it's working
+
+To use this package in another app you will need to link it
+To do so, go into the SDK folder and run  
+`npm link`
+then inside of the folder of the app you want to check it in run  
+`npm link @churnsignal/churnsignal-sdk-web`
+
+### Bundle Analysis
+
+[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.
+
+
+## Module Formats
+
+CJS, ESModules, and UMD module formats are supported.
+
+The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. 
+
+## Named Exports
+
+Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
+
+## Including Styles
+
+There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
+
+For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.

package/dist/api-client.d.ts

@@ -0,0 +1,28 @@
+declare type ApiClientProps = {
+    apiKey: string;
+    baseUrl?: string;
+    config: {
+        workspaceId: string;
+        tenantId?: string;
+    };
+};
+export declare type EventProperties = Record<string, any>;
+declare type User = {
+    email: string;
+};
+declare class ApiClient {
+    private apiKey;
+    private baseUrl?;
+    private workspaceId;
+    private tenantId?;
+    private user?;
+    constructor({ apiKey, baseUrl, config }: ApiClientProps);
+    fetchWithConfig: (endpoint: string, options?: RequestInit) => Promise<Response>;
+    getApiKey(): string;
+    getBaseUrl(): string | undefined;
+    getWorkspaceId(): string;
+    getUser(): User | undefined;
+    identify(user: User): void;
+    track(eventName: string, eventProperties?: EventProperties): void;
+}
+export default ApiClient;

package/dist/churnsignal-sdk-web.cjs.development.js

@@ -0,0 +1,249 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var urlRegex = /^https?:\/\//;
+var isValidUrl = function isValidUrl(url) {
+  return urlRegex.test(url);
+};
+var sanitiseUrl = function sanitiseUrl(url) {
+  // Trim whitespace
+  var sanitisedUrl = url.trim();
+  // Validate scheme
+  if (!isValidUrl(url)) {
+    throw new Error("URL must start with 'http://' or 'https://'");
+  }
+  try {
+    var urlObject = new URL(sanitisedUrl);
+    urlObject.hostname = urlObject.hostname.toLowerCase();
+    // Remove trailing slash
+    if (urlObject.pathname !== '/') {
+      urlObject.pathname = urlObject.pathname.replace(/\/+$/, '') || '';
+    }
+    // Reconstruct the URL from its components
+    // Note: The URL interface automatically handles encoding of the pathname
+    return urlObject.toString().replace(/\/+$/, '');
+  } catch (e) {
+    throw new Error('Invalid URL provided');
+  }
+};
+
+function _extends() {
+  _extends = Object.assign ? Object.assign.bind() : function (target) {
+    for (var i = 1; i < arguments.length; i++) {
+      var source = arguments[i];
+      for (var key in source) {
+        if (Object.prototype.hasOwnProperty.call(source, key)) {
+          target[key] = source[key];
+        }
+      }
+    }
+    return target;
+  };
+  return _extends.apply(this, arguments);
+}
+
+var transformTrackRequestData = function transformTrackRequestData(_ref) {
+  var eventName = _ref.eventName,
+    eventProperties = _ref.eventProperties,
+    userProperties = _ref.userProperties,
+    configProperties = _ref.configProperties;
+  var transformedEvent = {
+    name: eventName,
+    timestamp: new Date().getTime().toString(),
+    userEmail: userProperties == null ? void 0 : userProperties.email,
+    tenantId: configProperties.tenantId,
+    workspaceId: configProperties.workspaceId,
+    type: 'event',
+    data: eventProperties
+  };
+  return JSON.stringify(transformedEvent);
+};
+
+var sdkConfig = {
+  defaultHeaders: {
+    'Content-Type': 'application/json'
+  }
+};
+var API_PREFIX = 'sdk-prod';
+var TRACK_ENDPOINT = API_PREFIX + "/track";
+// const IDENTIFY_USER_ENDPOINT = `${API_PREFIX}/identify`;
+var ApiClient = /*#__PURE__*/function () {
+  function ApiClient(_ref) {
+    var _this = this;
+    var apiKey = _ref.apiKey,
+      baseUrl = _ref.baseUrl,
+      config = _ref.config;
+    this.workspaceId = '';
+    // Wrapper function for fetch
+    this.fetchWithConfig = function (endpoint, options) {
+      if (options === void 0) {
+        options = {
+          method: 'GET'
+        };
+      }
+      // Construct the full URL
+      var url = _this.getBaseUrl() + "/" + endpoint;
+      // Merge the default headers with any headers provided in the options
+      var headers = _extends({}, sdkConfig.defaultHeaders, {
+        'x-api-key': _this.getApiKey()
+      }, options.headers || {});
+      // Merge the rest of the options with the headers
+      var config = _extends({}, options, {
+        headers: headers
+      });
+      // Execute the fetch call with the merged configuration
+      return fetch(url, config);
+    };
+    this.apiKey = apiKey;
+    this.baseUrl = baseUrl;
+    this.workspaceId = config.workspaceId;
+    this.tenantId = config.tenantId;
+  }
+  var _proto = ApiClient.prototype;
+  _proto.getApiKey = function getApiKey() {
+    return this.apiKey;
+  };
+  _proto.getBaseUrl = function getBaseUrl() {
+    return this.baseUrl;
+  };
+  _proto.getWorkspaceId = function getWorkspaceId() {
+    return this.workspaceId;
+  };
+  _proto.getUser = function getUser() {
+    return this.user;
+  };
+  _proto.identify = function identify(user) {
+    this.user = user;
+    // this.fetchWithConfig(IDENTIFY_USER_ENDPOINT, {
+    //   method: 'POST',
+    //   body: transformIdentifyRequestData({
+    //     ...user,
+    //   }),
+    // });
+  };
+  _proto.track = function track(eventName, eventProperties) {
+    if (!this.user) {
+      throw new Error('No identified users to track');
+    }
+    this.fetchWithConfig(TRACK_ENDPOINT, {
+      method: 'POST',
+      body: transformTrackRequestData({
+        eventName: eventName,
+        eventProperties: eventProperties,
+        configProperties: {
+          workspaceId: this.getWorkspaceId(),
+          tenantId: this.tenantId
+        },
+        userProperties: {
+          email: this.user.email
+        }
+      })
+    });
+  };
+  return ApiClient;
+}();
+
+var SDKInstanceManager = /*#__PURE__*/function () {
+  function SDKInstanceManager() {
+    this.isInitialised = false;
+    this.config = {
+      workspaceId: ''
+    };
+    if (!SDKInstanceManager.instance) {
+      this.config = {
+        workspaceId: ''
+      };
+      this.isInitialised = false;
+      SDKInstanceManager.instance = this;
+    }
+    return SDKInstanceManager.instance;
+  }
+  /**
+   * @throws Error in case validation of parameters fails
+   * @param apiKey - required string value representing the API key
+   * @param baseUrl - required string value representing the API endpoint
+   * @param config - required object value
+   * @returns void
+   */
+  var _proto = SDKInstanceManager.prototype;
+  _proto.initialise = function initialise(apiKey, baseUrl, config) {
+    if (this.getIsInitialised()) {
+      console.info('SDK is already initialised with API key');
+      return;
+    }
+    if (!apiKey || typeof apiKey !== 'string') {
+      throw new Error('SDK needs a valid API key to be inialised');
+    }
+    if (!baseUrl || typeof baseUrl !== 'string' || !isValidUrl(baseUrl)) {
+      throw new Error('SDK needs a valid base URL to be initialised');
+    }
+    if (!config.workspaceId) {
+      throw new Error('Workspace ID must be provided');
+    }
+    this.config = config;
+    var sanitisedUrl = sanitiseUrl(baseUrl);
+    this.apiClient = new ApiClient({
+      apiKey: apiKey,
+      baseUrl: sanitisedUrl,
+      config: config
+    });
+    this.isInitialised = true;
+  };
+  _proto.destroy = function destroy() {
+    this.config = {
+      workspaceId: ''
+    };
+    this.isInitialised = false;
+  };
+  _proto.getIsInitialised = function getIsInitialised() {
+    return this.isInitialised;
+  };
+  _proto.getApiClient = function getApiClient() {
+    return this.apiClient;
+  };
+  _proto.getConfig = function getConfig() {
+    return this.config;
+  };
+  return SDKInstanceManager;
+}();
+var instance = /*#__PURE__*/new SDKInstanceManager();
+
+/**
+ * @param apiKey - required string value representing the API key
+ * @param baseUrl - required string value representing the API endpoint
+ * @param options - optional object value
+ * @returns boolean indicating whether the initialisation of the sdk was successful or not
+ */
+var initialise = function initialise(apiKey, baseUrl, config) {
+  try {
+    instance.initialise(apiKey, baseUrl, config);
+    return true;
+  } catch (e) {
+    console.info(e == null ? void 0 : e.message);
+    return false;
+  }
+};
+
+var identify = function identify(user) {
+  var _sdkInstanceManager$g;
+  (_sdkInstanceManager$g = instance.getApiClient()) == null || _sdkInstanceManager$g.identify(user);
+};
+
+var track = function track(eventName, eventProperties) {
+  var _sdkInstanceManager$g;
+  if (!instance.getIsInitialised()) {
+    console.error('SDK must be initialised first');
+    return;
+  }
+  if (!eventName || typeof eventName !== 'string') {
+    console.error('Event name must be provided');
+    return;
+  }
+  (_sdkInstanceManager$g = instance.getApiClient()) == null || _sdkInstanceManager$g.track(eventName, eventProperties);
+};
+
+exports.identify = identify;
+exports.initialise = initialise;
+exports.track = track;
+//# sourceMappingURL=churnsignal-sdk-web.cjs.development.js.map

package/dist/churnsignal-sdk-web.cjs.development.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"churnsignal-sdk-web.cjs.development.js","sources":["../src/utils/url-validator.ts","../src/utils/request-transformations.ts","../src/api-client.ts","../src/managers/sdk-instance-manager.ts","../src/core/initialise.ts","../src/core/identify.ts","../src/core/track.ts"],"sourcesContent":["const urlRegex = /^https?:\\/\\//;\n\nexport const isValidUrl = (url: string) => urlRegex.test(url);\n\nexport const sanitiseUrl = (url: string) => {\n  // Trim whitespace\n  const sanitisedUrl = url.trim();\n\n  // Validate scheme\n  if (!isValidUrl(url)) {\n    throw new Error(\"URL must start with 'http://' or 'https://'\");\n  }\n\n  try {\n    let urlObject = new URL(sanitisedUrl);\n\n    urlObject.hostname = urlObject.hostname.toLowerCase();\n\n    // Remove trailing slash\n    if (urlObject.pathname !== '/') {\n      urlObject.pathname = urlObject.pathname.replace(/\\/+$/, '') || '';\n    }\n\n    // Reconstruct the URL from its components\n    // Note: The URL interface automatically handles encoding of the pathname\n    return urlObject.toString().replace(/\\/+$/, '');\n  } catch (e) {\n    throw new Error('Invalid URL provided');\n  }\n};\n","import { EventProperties } from '../api-client';\n\ntype TrackRequest = {\n  eventName: string;\n  eventProperties?: EventProperties;\n  userProperties?: {\n    email: string;\n  };\n  configProperties: {\n    workspaceId: string;\n    tenantId?: string\n  };\n};\n\nexport const transformTrackRequestData = ({\n  eventName,\n  eventProperties,\n  userProperties,\n  configProperties,\n}: TrackRequest) => {\n  const transformedEvent = {\n    name: eventName,\n    timestamp: new Date().getTime().toString(),\n    userEmail: userProperties?.email,\n    tenantId: configProperties.tenantId, // TODO this will be handled on the API side, for now pass it in SDK setup\n    workspaceId: configProperties.workspaceId,\n    type: 'event',\n    data: eventProperties,\n  };\n  return JSON.stringify(transformedEvent);\n};\n\ntype IdentifyRequest = {\n  email: string\n}\n\nexport const transformIdentifyRequestData = ({\n  email\n}: IdentifyRequest) => {\n  const transformedIdentify = {\n    userEmail: email\n  }\n  return JSON.stringify(transformedIdentify);\n}","import {\n  transformTrackRequestData,\n  // transformIdentifyRequestData,\n} from './utils/request-transformations';\n\ntype ApiClientProps = {\n  apiKey: string;\n  baseUrl?: string;\n  config: {\n    workspaceId: string;\n    tenantId?: string;\n  };\n};\n\nexport type EventProperties = Record<string, any>;\n\ntype User = {\n  email: string;\n};\n\nconst sdkConfig = {\n  defaultHeaders: {\n    'Content-Type': 'application/json',\n  },\n};\n\nconst API_PREFIX = 'sdk-prod';\n\nconst TRACK_ENDPOINT = `${API_PREFIX}/track`;\n// const IDENTIFY_USER_ENDPOINT = `${API_PREFIX}/identify`;\n\nclass ApiClient {\n  private apiKey: string;\n  private baseUrl?: string;\n  private workspaceId: string = '';\n  private tenantId?: string;\n  private user?: User;\n\n  constructor({ apiKey, baseUrl, config }: ApiClientProps) {\n    this.apiKey = apiKey;\n    this.baseUrl = baseUrl;\n    this.workspaceId = config.workspaceId;\n    this.tenantId = config.tenantId;\n  }\n\n  // Wrapper function for fetch\n  fetchWithConfig = (\n    endpoint: string,\n    options: RequestInit = { method: 'GET' }\n  ) => {\n    // Construct the full URL\n    const url = `${this.getBaseUrl()}/${endpoint}`;\n\n    // Merge the default headers with any headers provided in the options\n    const headers = {\n      ...sdkConfig.defaultHeaders,\n      'x-api-key': this.getApiKey(),\n      ...(options.headers || {}),\n    };\n\n    // Merge the rest of the options with the headers\n    const config = {\n      ...options,\n      headers,\n    };\n\n    // Execute the fetch call with the merged configuration\n    return fetch(url, config);\n  };\n\n  getApiKey() {\n    return this.apiKey;\n  }\n\n  getBaseUrl() {\n    return this.baseUrl;\n  }\n\n  getWorkspaceId() {\n    return this.workspaceId;\n  }\n\n  getUser() {\n    return this.user;\n  }\n\n  identify(user: User) {\n    this.user = user;\n    // this.fetchWithConfig(IDENTIFY_USER_ENDPOINT, {\n    //   method: 'POST',\n    //   body: transformIdentifyRequestData({\n    //     ...user,\n    //   }),\n    // });\n  }\n\n  track(eventName: string, eventProperties?: EventProperties) {\n    if (!this.user) {\n      throw new Error('No identified users to track');\n    }\n    this.fetchWithConfig(TRACK_ENDPOINT, {\n      method: 'POST',\n      body: transformTrackRequestData({\n        eventName,\n        eventProperties,\n        configProperties: {\n          workspaceId: this.getWorkspaceId(),\n          tenantId: this.tenantId,\n        },\n        userProperties: {\n          email: this.user.email,\n        },\n      }),\n    });\n  }\n}\n\nexport default ApiClient;\n","import { isValidUrl, sanitiseUrl } from '../utils/url-validator';\nimport ApiClient from './../api-client';\n\ntype Config = {\n  workspaceId: string;\n  tenantId?: string;\n};\n\nclass SDKInstanceManager {\n  private static instance: SDKInstanceManager;\n  private isInitialised: boolean = false;\n  private config: Config = { workspaceId: '' };\n  private apiClient?: ApiClient;\n\n  constructor() {\n    if (!SDKInstanceManager.instance) {\n      this.config = { workspaceId: '' };\n      this.isInitialised = false;\n      SDKInstanceManager.instance = this;\n    }\n\n    return SDKInstanceManager.instance;\n  }\n\n  /**\n   * @throws Error in case validation of parameters fails\n   * @param apiKey - required string value representing the API key\n   * @param baseUrl - required string value representing the API endpoint\n   * @param config - required object value\n   * @returns void\n   */\n  initialise(apiKey: string, baseUrl: string, config: Config) {\n    if (this.getIsInitialised()) {\n      console.info('SDK is already initialised with API key');\n      return;\n    }\n    if (!apiKey || typeof apiKey !== 'string') {\n      throw new Error('SDK needs a valid API key to be inialised');\n    }\n    if (!baseUrl || typeof baseUrl !== 'string' || !isValidUrl(baseUrl)) {\n      throw new Error('SDK needs a valid base URL to be initialised');\n    }\n    if (!config.workspaceId) {\n      throw new Error('Workspace ID must be provided');\n    }\n    this.config = config;\n    let sanitisedUrl = sanitiseUrl(baseUrl);\n    this.apiClient = new ApiClient({ apiKey, baseUrl: sanitisedUrl, config });\n    this.isInitialised = true;\n  }\n\n  destroy() {\n    this.config = { workspaceId: '' };\n    this.isInitialised = false;\n  }\n\n  getIsInitialised() {\n    return this.isInitialised;\n  }\n\n  getApiClient() {\n    return this.apiClient;\n  }\n\n  getConfig() {\n    return this.config;\n  }\n}\n\nconst instance = new SDKInstanceManager();\nexport { instance as default };\n","import sdkInstanceManager from './../managers/sdk-instance-manager';\n\nexport type InitConfig = {\n  workspaceId: string\n  tenantId: string; // TODO to be removed should be done on the API side\n};\n\n/**\n * @param apiKey - required string value representing the API key\n * @param baseUrl - required string value representing the API endpoint\n * @param options - optional object value\n * @returns boolean indicating whether the initialisation of the sdk was successful or not\n */\nexport const initialise = (\n  apiKey: string,\n  baseUrl: string,\n  config: InitConfig\n) => {\n  try {\n    sdkInstanceManager.initialise(apiKey, baseUrl, config);\n    return true;\n  } catch (e) {\n    console.info((e as any)?.message);\n    return false;\n  }\n};\n","import sdkInstanceManager from '../managers/sdk-instance-manager';\n\nexport const identify = (user: { email: string }) => {\n  sdkInstanceManager.getApiClient()?.identify(user);\n};\n","import sdkInstanceManager from '../managers/sdk-instance-manager';\n\ntype Properties = Record<string, any>;\n\nexport const track = (eventName: string, eventProperties?: Properties) => {\n  if (!sdkInstanceManager.getIsInitialised()) {\n    console.error('SDK must be initialised first');\n    return;\n  }\n  if (!eventName || typeof eventName !== 'string') {\n    console.error('Event name must be provided');\n    return;\n  }\n  sdkInstanceManager.getApiClient()?.track(eventName, eventProperties);\n};\n"],"names":["urlRegex","isValidUrl","url","test","sanitiseUrl","sanitisedUrl","trim","Error","urlObject","URL","hostname","toLowerCase","pathname","replace","toString","e","transformTrackRequestData","_ref","eventName","eventProperties","userProperties","configProperties","transformedEvent","name","timestamp","Date","getTime","userEmail","email","tenantId","workspaceId","type","data","JSON","stringify","sdkConfig","defaultHeaders","API_PREFIX","TRACK_ENDPOINT","ApiClient","apiKey","baseUrl","config","endpoint","options","method","_this","getBaseUrl","headers","_extends","getApiKey","fetch","_proto","prototype","getWorkspaceId","getUser","user","identify","track","fetchWithConfig","body","SDKInstanceManager","instance","isInitialised","initialise","getIsInitialised","console","info","apiClient","destroy","getApiClient","getConfig","sdkInstanceManager","message","_sdkInstanceManager$g","error"],"mappings":";;;;AAAA,IAAMA,QAAQ,GAAG,cAAc;AAExB,IAAMC,UAAU,GAAG,SAAbA,UAAUA,CAAIC,GAAW;EAAA,OAAKF,QAAQ,CAACG,IAAI,CAACD,GAAG,CAAC;AAAA;AAEtD,IAAME,WAAW,GAAG,SAAdA,WAAWA,CAAIF,GAAW;;EAErC,IAAMG,YAAY,GAAGH,GAAG,CAACI,IAAI,EAAE;;EAG/B,IAAI,CAACL,UAAU,CAACC,GAAG,CAAC,EAAE;IACpB,MAAM,IAAIK,KAAK,CAAC,6CAA6C,CAAC;;EAGhE,IAAI;IACF,IAAIC,SAAS,GAAG,IAAIC,GAAG,CAACJ,YAAY,CAAC;IAErCG,SAAS,CAACE,QAAQ,GAAGF,SAAS,CAACE,QAAQ,CAACC,WAAW,EAAE;;IAGrD,IAAIH,SAAS,CAACI,QAAQ,KAAK,GAAG,EAAE;MAC9BJ,SAAS,CAACI,QAAQ,GAAGJ,SAAS,CAACI,QAAQ,CAACC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,EAAE;;;;IAKnE,OAAOL,SAAS,CAACM,QAAQ,EAAE,CAACD,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;GAChD,CAAC,OAAOE,CAAC,EAAE;IACV,MAAM,IAAIR,KAAK,CAAC,sBAAsB,CAAC;;AAE3C,CAAC;;;;;;;;;;;;;;;;;ACfM,IAAMS,yBAAyB,GAAG,SAA5BA,yBAAyBA,CAAAC,IAAA;MACpCC,SAAS,GAAAD,IAAA,CAATC,SAAS;IACTC,eAAe,GAAAF,IAAA,CAAfE,eAAe;IACfC,cAAc,GAAAH,IAAA,CAAdG,cAAc;IACdC,gBAAgB,GAAAJ,IAAA,CAAhBI,gBAAgB;EAEhB,IAAMC,gBAAgB,GAAG;IACvBC,IAAI,EAAEL,SAAS;IACfM,SAAS,EAAE,IAAIC,IAAI,EAAE,CAACC,OAAO,EAAE,CAACZ,QAAQ,EAAE;IAC1Ca,SAAS,EAAEP,cAAc,oBAAdA,cAAc,CAAEQ,KAAK;IAChCC,QAAQ,EAAER,gBAAgB,CAACQ,QAAQ;IACnCC,WAAW,EAAET,gBAAgB,CAACS,WAAW;IACzCC,IAAI,EAAE,OAAO;IACbC,IAAI,EAAEb;GACP;EACD,OAAOc,IAAI,CAACC,SAAS,CAACZ,gBAAgB,CAAC;AACzC,CAAC;;ACVD,IAAMa,SAAS,GAAG;EAChBC,cAAc,EAAE;IACd,cAAc,EAAE;;CAEnB;AAED,IAAMC,UAAU,GAAG,UAAU;AAE7B,IAAMC,cAAc,GAAMD,UAAU,WAAQ;AAC5C;AAAA,IAEME,SAAS;EAOb,SAAAA,UAAAtB,IAAA;;QAAcuB,MAAM,GAAAvB,IAAA,CAANuB,MAAM;MAAEC,OAAO,GAAAxB,IAAA,CAAPwB,OAAO;MAAEC,MAAM,GAAAzB,IAAA,CAANyB,MAAM;IAJ7B,gBAAW,GAAW,EAAE;;IAYhC,oBAAe,GAAG,UAChBC,QAAgB,EAChBC;UAAAA;QAAAA,UAAuB;UAAEC,MAAM,EAAE;SAAO;;;MAGxC,IAAM3C,GAAG,GAAM4C,KAAI,CAACC,UAAU,EAAE,SAAIJ,QAAU;;MAG9C,IAAMK,OAAO,GAAAC,QAAA,KACRd,SAAS,CAACC,cAAc;QAC3B,WAAW,EAAEU,KAAI,CAACI,SAAS;SACvBN,OAAO,CAACI,OAAO,IAAI,EAAE,CAC1B;;MAGD,IAAMN,MAAM,GAAAO,QAAA,KACPL,OAAO;QACVI,OAAO,EAAPA;QACD;;MAGD,OAAOG,KAAK,CAACjD,GAAG,EAAEwC,MAAM,CAAC;KAC1B;IA7BC,IAAI,CAACF,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACX,WAAW,GAAGY,MAAM,CAACZ,WAAW;IACrC,IAAI,CAACD,QAAQ,GAAGa,MAAM,CAACb,QAAQ;;EAChC,IAAAuB,MAAA,GAAAb,SAAA,CAAAc,SAAA;EAAAD,MAAA,CA2BDF,SAAS,GAAT,SAAAA;IACE,OAAO,IAAI,CAACV,MAAM;GACnB;EAAAY,MAAA,CAEDL,UAAU,GAAV,SAAAA;IACE,OAAO,IAAI,CAACN,OAAO;GACpB;EAAAW,MAAA,CAEDE,cAAc,GAAd,SAAAA;IACE,OAAO,IAAI,CAACxB,WAAW;GACxB;EAAAsB,MAAA,CAEDG,OAAO,GAAP,SAAAA;IACE,OAAO,IAAI,CAACC,IAAI;GACjB;EAAAJ,MAAA,CAEDK,QAAQ,GAAR,SAAAA,SAASD,IAAU;IACjB,IAAI,CAACA,IAAI,GAAGA,IAAI;;;;;;;GAOjB;EAAAJ,MAAA,CAEDM,KAAK,GAAL,SAAAA,MAAMxC,SAAiB,EAAEC,eAAiC;IACxD,IAAI,CAAC,IAAI,CAACqC,IAAI,EAAE;MACd,MAAM,IAAIjD,KAAK,CAAC,8BAA8B,CAAC;;IAEjD,IAAI,CAACoD,eAAe,CAACrB,cAAc,EAAE;MACnCO,MAAM,EAAE,MAAM;MACde,IAAI,EAAE5C,yBAAyB,CAAC;QAC9BE,SAAS,EAATA,SAAS;QACTC,eAAe,EAAfA,eAAe;QACfE,gBAAgB,EAAE;UAChBS,WAAW,EAAE,IAAI,CAACwB,cAAc,EAAE;UAClCzB,QAAQ,EAAE,IAAI,CAACA;SAChB;QACDT,cAAc,EAAE;UACdQ,KAAK,EAAE,IAAI,CAAC4B,IAAI,CAAC5B;;OAEpB;KACF,CAAC;GACH;EAAA,OAAAW,SAAA;AAAA;;ACjHqC,IAOlCsB,kBAAkB;EAMtB,SAAAA;IAJQ,kBAAa,GAAY,KAAK;IAC9B,WAAM,GAAW;MAAE/B,WAAW,EAAE;KAAI;IAI1C,IAAI,CAAC+B,kBAAkB,CAACC,QAAQ,EAAE;MAChC,IAAI,CAACpB,MAAM,GAAG;QAAEZ,WAAW,EAAE;OAAI;MACjC,IAAI,CAACiC,aAAa,GAAG,KAAK;MAC1BF,kBAAkB,CAACC,QAAQ,GAAG,IAAI;;IAGpC,OAAOD,kBAAkB,CAACC,QAAQ;;;;;;;;;EAGpC,IAAAV,MAAA,GAAAS,kBAAA,CAAAR,SAAA;EAAAD,MAAA,CAOAY,UAAU,GAAV,SAAAA,WAAWxB,MAAc,EAAEC,OAAe,EAAEC,MAAc;IACxD,IAAI,IAAI,CAACuB,gBAAgB,EAAE,EAAE;MAC3BC,OAAO,CAACC,IAAI,CAAC,yCAAyC,CAAC;MACvD;;IAEF,IAAI,CAAC3B,MAAM,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;MACzC,MAAM,IAAIjC,KAAK,CAAC,2CAA2C,CAAC;;IAE9D,IAAI,CAACkC,OAAO,IAAI,OAAOA,OAAO,KAAK,QAAQ,IAAI,CAACxC,UAAU,CAACwC,OAAO,CAAC,EAAE;MACnE,MAAM,IAAIlC,KAAK,CAAC,8CAA8C,CAAC;;IAEjE,IAAI,CAACmC,MAAM,CAACZ,WAAW,EAAE;MACvB,MAAM,IAAIvB,KAAK,CAAC,+BAA+B,CAAC;;IAElD,IAAI,CAACmC,MAAM,GAAGA,MAAM;IACpB,IAAIrC,YAAY,GAAGD,WAAW,CAACqC,OAAO,CAAC;IACvC,IAAI,CAAC2B,SAAS,GAAG,IAAI7B,SAAS,CAAC;MAAEC,MAAM,EAANA,MAAM;MAAEC,OAAO,EAAEpC,YAAY;MAAEqC,MAAM,EAANA;KAAQ,CAAC;IACzE,IAAI,CAACqB,aAAa,GAAG,IAAI;GAC1B;EAAAX,MAAA,CAEDiB,OAAO,GAAP,SAAAA;IACE,IAAI,CAAC3B,MAAM,GAAG;MAAEZ,WAAW,EAAE;KAAI;IACjC,IAAI,CAACiC,aAAa,GAAG,KAAK;GAC3B;EAAAX,MAAA,CAEDa,gBAAgB,GAAhB,SAAAA;IACE,OAAO,IAAI,CAACF,aAAa;GAC1B;EAAAX,MAAA,CAEDkB,YAAY,GAAZ,SAAAA;IACE,OAAO,IAAI,CAACF,SAAS;GACtB;EAAAhB,MAAA,CAEDmB,SAAS,GAAT,SAAAA;IACE,OAAO,IAAI,CAAC7B,MAAM;GACnB;EAAA,OAAAmB,kBAAA;AAAA;AAGH,IAAMC,QAAQ,gBAAG,IAAID,kBAAkB,EAAE;;AC9DzC;;;;;;AAMA,IAAaG,UAAU,GAAG,SAAbA,UAAUA,CACrBxB,MAAc,EACdC,OAAe,EACfC,MAAkB;EAElB,IAAI;IACF8B,QAAkB,CAACR,UAAU,CAACxB,MAAM,EAAEC,OAAO,EAAEC,MAAM,CAAC;IACtD,OAAO,IAAI;GACZ,CAAC,OAAO3B,CAAC,EAAE;IACVmD,OAAO,CAACC,IAAI,CAAEpD,CAAS,oBAATA,CAAS,CAAE0D,OAAO,CAAC;IACjC,OAAO,KAAK;;AAEhB,CAAC;;ICvBYhB,QAAQ,GAAG,SAAXA,QAAQA,CAAID,IAAuB;;EAC9C,CAAAkB,qBAAA,GAAAF,QAAkB,CAACF,YAAY,EAAE,aAAjCI,qBAAA,CAAmCjB,QAAQ,CAACD,IAAI,CAAC;AACnD,CAAC;;ICAYE,KAAK,GAAG,SAARA,KAAKA,CAAIxC,SAAiB,EAAEC,eAA4B;;EACnE,IAAI,CAACqD,QAAkB,CAACP,gBAAgB,EAAE,EAAE;IAC1CC,OAAO,CAACS,KAAK,CAAC,+BAA+B,CAAC;IAC9C;;EAEF,IAAI,CAACzD,SAAS,IAAI,OAAOA,SAAS,KAAK,QAAQ,EAAE;IAC/CgD,OAAO,CAACS,KAAK,CAAC,6BAA6B,CAAC;IAC5C;;EAEF,CAAAD,qBAAA,GAAAF,QAAkB,CAACF,YAAY,EAAE,aAAjCI,qBAAA,CAAmChB,KAAK,CAACxC,SAAS,EAAEC,eAAe,CAAC;AACtE,CAAC;;;;;;"}

package/dist/churnsignal-sdk-web.cjs.production.min.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var t=/^https?:\/\//,e=function(e){return t.test(e)};function i(){return(i=Object.assign?Object.assign.bind():function(t){for(var e=1;e<arguments.length;e++){var i=arguments[e];for(var n in i)Object.prototype.hasOwnProperty.call(i,n)&&(t[n]=i[n])}return t}).apply(this,arguments)}var n=function(t){var e=t.eventProperties,i=t.userProperties,n=t.configProperties,r={name:t.eventName,timestamp:(new Date).getTime().toString(),userEmail:null==i?void 0:i.email,tenantId:n.tenantId,workspaceId:n.workspaceId,type:"event",data:e};return JSON.stringify(r)},r={"Content-Type":"application/json"},s=function(){function t(t){var e=this,n=t.apiKey,s=t.baseUrl,o=t.config;this.workspaceId="",this.fetchWithConfig=function(t,n){void 0===n&&(n={method:"GET"});var s=e.getBaseUrl()+"/"+t,o=i({},r,{"x-api-key":e.getApiKey()},n.headers||{}),a=i({},n,{headers:o});return fetch(s,a)},this.apiKey=n,this.baseUrl=s,this.workspaceId=o.workspaceId,this.tenantId=o.tenantId}var e=t.prototype;return e.getApiKey=function(){return this.apiKey},e.getBaseUrl=function(){return this.baseUrl},e.getWorkspaceId=function(){return this.workspaceId},e.getUser=function(){return this.user},e.identify=function(t){this.user=t},e.track=function(t,e){if(!this.user)throw new Error("No identified users to track");this.fetchWithConfig("sdk-prod/track",{method:"POST",body:n({eventName:t,eventProperties:e,configProperties:{workspaceId:this.getWorkspaceId(),tenantId:this.tenantId},userProperties:{email:this.user.email}})})},t}(),o=new(function(){function t(){return this.isInitialised=!1,this.config={workspaceId:""},t.instance||(this.config={workspaceId:""},this.isInitialised=!1,t.instance=this),t.instance}var i=t.prototype;return i.initialise=function(t,i,n){if(this.getIsInitialised())console.info("SDK is already initialised with API key");else{if(!t||"string"!=typeof t)throw new Error("SDK needs a valid API key to be inialised");if(!i||"string"!=typeof i||!e(i))throw new Error("SDK needs a valid base URL to be initialised");if(!n.workspaceId)throw new Error("Workspace ID must be provided");this.config=n;var r=function(t){var i=t.trim();if(!e(t))throw new Error("URL must start with 'http://' or 'https://'");try{var n=new URL(i);return n.hostname=n.hostname.toLowerCase(),"/"!==n.pathname&&(n.pathname=n.pathname.replace(/\/+$/,"")||""),n.toString().replace(/\/+$/,"")}catch(t){throw new Error("Invalid URL provided")}}(i);this.apiClient=new s({apiKey:t,baseUrl:r,config:n}),this.isInitialised=!0}},i.destroy=function(){this.config={workspaceId:""},this.isInitialised=!1},i.getIsInitialised=function(){return this.isInitialised},i.getApiClient=function(){return this.apiClient},i.getConfig=function(){return this.config},t}());exports.identify=function(t){var e;null==(e=o.getApiClient())||e.identify(t)},exports.initialise=function(t,e,i){try{return o.initialise(t,e,i),!0}catch(t){return console.info(null==t?void 0:t.message),!1}},exports.track=function(t,e){var i;o.getIsInitialised()?t&&"string"==typeof t?null==(i=o.getApiClient())||i.track(t,e):console.error("Event name must be provided"):console.error("SDK must be initialised first")};
+//# sourceMappingURL=churnsignal-sdk-web.cjs.production.min.js.map

package/dist/churnsignal-sdk-web.cjs.production.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"churnsignal-sdk-web.cjs.production.min.js","sources":["../src/utils/url-validator.ts","../src/utils/request-transformations.ts","../src/api-client.ts","../src/managers/sdk-instance-manager.ts","../src/core/identify.ts","../src/core/initialise.ts","../src/core/track.ts"],"sourcesContent":["const urlRegex = /^https?:\\/\\//;\n\nexport const isValidUrl = (url: string) => urlRegex.test(url);\n\nexport const sanitiseUrl = (url: string) => {\n  // Trim whitespace\n  const sanitisedUrl = url.trim();\n\n  // Validate scheme\n  if (!isValidUrl(url)) {\n    throw new Error(\"URL must start with 'http://' or 'https://'\");\n  }\n\n  try {\n    let urlObject = new URL(sanitisedUrl);\n\n    urlObject.hostname = urlObject.hostname.toLowerCase();\n\n    // Remove trailing slash\n    if (urlObject.pathname !== '/') {\n      urlObject.pathname = urlObject.pathname.replace(/\\/+$/, '') || '';\n    }\n\n    // Reconstruct the URL from its components\n    // Note: The URL interface automatically handles encoding of the pathname\n    return urlObject.toString().replace(/\\/+$/, '');\n  } catch (e) {\n    throw new Error('Invalid URL provided');\n  }\n};\n","import { EventProperties } from '../api-client';\n\ntype TrackRequest = {\n  eventName: string;\n  eventProperties?: EventProperties;\n  userProperties?: {\n    email: string;\n  };\n  configProperties: {\n    workspaceId: string;\n    tenantId?: string\n  };\n};\n\nexport const transformTrackRequestData = ({\n  eventName,\n  eventProperties,\n  userProperties,\n  configProperties,\n}: TrackRequest) => {\n  const transformedEvent = {\n    name: eventName,\n    timestamp: new Date().getTime().toString(),\n    userEmail: userProperties?.email,\n    tenantId: configProperties.tenantId, // TODO this will be handled on the API side, for now pass it in SDK setup\n    workspaceId: configProperties.workspaceId,\n    type: 'event',\n    data: eventProperties,\n  };\n  return JSON.stringify(transformedEvent);\n};\n\ntype IdentifyRequest = {\n  email: string\n}\n\nexport const transformIdentifyRequestData = ({\n  email\n}: IdentifyRequest) => {\n  const transformedIdentify = {\n    userEmail: email\n  }\n  return JSON.stringify(transformedIdentify);\n}","import {\n  transformTrackRequestData,\n  // transformIdentifyRequestData,\n} from './utils/request-transformations';\n\ntype ApiClientProps = {\n  apiKey: string;\n  baseUrl?: string;\n  config: {\n    workspaceId: string;\n    tenantId?: string;\n  };\n};\n\nexport type EventProperties = Record<string, any>;\n\ntype User = {\n  email: string;\n};\n\nconst sdkConfig = {\n  defaultHeaders: {\n    'Content-Type': 'application/json',\n  },\n};\n\nconst API_PREFIX = 'sdk-prod';\n\nconst TRACK_ENDPOINT = `${API_PREFIX}/track`;\n// const IDENTIFY_USER_ENDPOINT = `${API_PREFIX}/identify`;\n\nclass ApiClient {\n  private apiKey: string;\n  private baseUrl?: string;\n  private workspaceId: string = '';\n  private tenantId?: string;\n  private user?: User;\n\n  constructor({ apiKey, baseUrl, config }: ApiClientProps) {\n    this.apiKey = apiKey;\n    this.baseUrl = baseUrl;\n    this.workspaceId = config.workspaceId;\n    this.tenantId = config.tenantId;\n  }\n\n  // Wrapper function for fetch\n  fetchWithConfig = (\n    endpoint: string,\n    options: RequestInit = { method: 'GET' }\n  ) => {\n    // Construct the full URL\n    const url = `${this.getBaseUrl()}/${endpoint}`;\n\n    // Merge the default headers with any headers provided in the options\n    const headers = {\n      ...sdkConfig.defaultHeaders,\n      'x-api-key': this.getApiKey(),\n      ...(options.headers || {}),\n    };\n\n    // Merge the rest of the options with the headers\n    const config = {\n      ...options,\n      headers,\n    };\n\n    // Execute the fetch call with the merged configuration\n    return fetch(url, config);\n  };\n\n  getApiKey() {\n    return this.apiKey;\n  }\n\n  getBaseUrl() {\n    return this.baseUrl;\n  }\n\n  getWorkspaceId() {\n    return this.workspaceId;\n  }\n\n  getUser() {\n    return this.user;\n  }\n\n  identify(user: User) {\n    this.user = user;\n    // this.fetchWithConfig(IDENTIFY_USER_ENDPOINT, {\n    //   method: 'POST',\n    //   body: transformIdentifyRequestData({\n    //     ...user,\n    //   }),\n    // });\n  }\n\n  track(eventName: string, eventProperties?: EventProperties) {\n    if (!this.user) {\n      throw new Error('No identified users to track');\n    }\n    this.fetchWithConfig(TRACK_ENDPOINT, {\n      method: 'POST',\n      body: transformTrackRequestData({\n        eventName,\n        eventProperties,\n        configProperties: {\n          workspaceId: this.getWorkspaceId(),\n          tenantId: this.tenantId,\n        },\n        userProperties: {\n          email: this.user.email,\n        },\n      }),\n    });\n  }\n}\n\nexport default ApiClient;\n","import { isValidUrl, sanitiseUrl } from '../utils/url-validator';\nimport ApiClient from './../api-client';\n\ntype Config = {\n  workspaceId: string;\n  tenantId?: string;\n};\n\nclass SDKInstanceManager {\n  private static instance: SDKInstanceManager;\n  private isInitialised: boolean = false;\n  private config: Config = { workspaceId: '' };\n  private apiClient?: ApiClient;\n\n  constructor() {\n    if (!SDKInstanceManager.instance) {\n      this.config = { workspaceId: '' };\n      this.isInitialised = false;\n      SDKInstanceManager.instance = this;\n    }\n\n    return SDKInstanceManager.instance;\n  }\n\n  /**\n   * @throws Error in case validation of parameters fails\n   * @param apiKey - required string value representing the API key\n   * @param baseUrl - required string value representing the API endpoint\n   * @param config - required object value\n   * @returns void\n   */\n  initialise(apiKey: string, baseUrl: string, config: Config) {\n    if (this.getIsInitialised()) {\n      console.info('SDK is already initialised with API key');\n      return;\n    }\n    if (!apiKey || typeof apiKey !== 'string') {\n      throw new Error('SDK needs a valid API key to be inialised');\n    }\n    if (!baseUrl || typeof baseUrl !== 'string' || !isValidUrl(baseUrl)) {\n      throw new Error('SDK needs a valid base URL to be initialised');\n    }\n    if (!config.workspaceId) {\n      throw new Error('Workspace ID must be provided');\n    }\n    this.config = config;\n    let sanitisedUrl = sanitiseUrl(baseUrl);\n    this.apiClient = new ApiClient({ apiKey, baseUrl: sanitisedUrl, config });\n    this.isInitialised = true;\n  }\n\n  destroy() {\n    this.config = { workspaceId: '' };\n    this.isInitialised = false;\n  }\n\n  getIsInitialised() {\n    return this.isInitialised;\n  }\n\n  getApiClient() {\n    return this.apiClient;\n  }\n\n  getConfig() {\n    return this.config;\n  }\n}\n\nconst instance = new SDKInstanceManager();\nexport { instance as default };\n","import sdkInstanceManager from '../managers/sdk-instance-manager';\n\nexport const identify = (user: { email: string }) => {\n  sdkInstanceManager.getApiClient()?.identify(user);\n};\n","import sdkInstanceManager from './../managers/sdk-instance-manager';\n\nexport type InitConfig = {\n  workspaceId: string\n  tenantId: string; // TODO to be removed should be done on the API side\n};\n\n/**\n * @param apiKey - required string value representing the API key\n * @param baseUrl - required string value representing the API endpoint\n * @param options - optional object value\n * @returns boolean indicating whether the initialisation of the sdk was successful or not\n */\nexport const initialise = (\n  apiKey: string,\n  baseUrl: string,\n  config: InitConfig\n) => {\n  try {\n    sdkInstanceManager.initialise(apiKey, baseUrl, config);\n    return true;\n  } catch (e) {\n    console.info((e as any)?.message);\n    return false;\n  }\n};\n","import sdkInstanceManager from '../managers/sdk-instance-manager';\n\ntype Properties = Record<string, any>;\n\nexport const track = (eventName: string, eventProperties?: Properties) => {\n  if (!sdkInstanceManager.getIsInitialised()) {\n    console.error('SDK must be initialised first');\n    return;\n  }\n  if (!eventName || typeof eventName !== 'string') {\n    console.error('Event name must be provided');\n    return;\n  }\n  sdkInstanceManager.getApiClient()?.track(eventName, eventProperties);\n};\n"],"names":["urlRegex","isValidUrl","url","test","transformTrackRequestData","_ref","eventProperties","userProperties","configProperties","transformedEvent","name","eventName","timestamp","Date","getTime","toString","userEmail","email","tenantId","workspaceId","type","data","JSON","stringify","sdkConfig","Content-Type","ApiClient","apiKey","baseUrl","config","this","endpoint","options","method","_this","getBaseUrl","headers","_extends","x-api-key","getApiKey","fetch","_proto","prototype","getWorkspaceId","getUser","user","identify","track","Error","fetchWithConfig","API_PREFIX","body","instance","SDKInstanceManager","isInitialised","initialise","getIsInitialised","console","info","sanitisedUrl","trim","urlObject","URL","hostname","toLowerCase","pathname","replace","e","sanitiseUrl","apiClient","destroy","getApiClient","getConfig","_sdkInstanceManager$g","sdkInstanceManager","message","error"],"mappings":"oEAAA,IAAMA,EAAW,eAEJC,EAAa,SAACC,GAAW,OAAKF,EAASG,KAAKD,uOCYlD,IAAME,EAA4B,SAAHC,OAEpCC,EAAeD,EAAfC,gBACAC,EAAcF,EAAdE,eACAC,EAAgBH,EAAhBG,iBAEMC,EAAmB,CACvBC,KANOL,EAATM,UAOEC,WAAW,IAAIC,MAAOC,UAAUC,WAChCC,gBAAWT,SAAAA,EAAgBU,MAC3BC,SAAUV,EAAiBU,SAC3BC,YAAaX,EAAiBW,YAC9BC,KAAM,QACNC,KAAMf,GAER,OAAOgB,KAAKC,UAAUd,ICTlBe,EACY,CACdC,eAAgB,oBASdC,aAOJ,SAAAA,EAAArB,cAAcsB,EAAMtB,EAANsB,OAAQC,EAAOvB,EAAPuB,QAASC,EAAMxB,EAANwB,OAJvBC,iBAAsB,GAY9BA,qBAAkB,SAChBC,EACAC,YAAAA,IAAAA,EAAuB,CAAEC,OAAQ,QAGjC,IAAM/B,EAASgC,EAAKC,iBAAgBJ,EAG9BK,EAAOC,KACRb,GACHc,YAAaJ,EAAKK,aACdP,EAAQI,SAAW,IAInBP,EAAMQ,KACPL,GACHI,QAAAA,IAIF,OAAOI,MAAMtC,EAAK2B,IA5BlBC,KAAKH,OAASA,EACdG,KAAKF,QAAUA,EACfE,KAAKX,YAAcU,EAAOV,YAC1BW,KAAKZ,SAAWW,EAAOX,SACxB,IAAAuB,EAAAf,EAAAgB,UAuEA,OAvEAD,EA2BDF,UAAA,WACE,OAAOT,KAAKH,QACbc,EAEDN,WAAA,WACE,OAAOL,KAAKF,SACba,EAEDE,eAAA,WACE,OAAOb,KAAKX,aACbsB,EAEDG,QAAA,WACE,OAAOd,KAAKe,MACbJ,EAEDK,SAAA,SAASD,GACPf,KAAKe,KAAOA,GAObJ,EAEDM,MAAA,SAAMpC,EAAmBL,GACvB,IAAKwB,KAAKe,KACR,MAAM,IAAIG,MAAM,gCAElBlB,KAAKmB,gBAxEiBC,iBAwEe,CACnCjB,OAAQ,OACRkB,KAAM/C,EAA0B,CAC9BO,UAAAA,EACAL,gBAAAA,EACAE,iBAAkB,CAChBW,YAAaW,KAAKa,iBAClBzB,SAAUY,KAAKZ,UAEjBX,eAAgB,CACdU,MAAOa,KAAKe,KAAK5B,YAIxBS,KC7CG0B,EAAW,eAvDf,SAAAC,IAOE,OAXMvB,oBAAyB,EACzBA,YAAiB,CAAEX,YAAa,IAIjCkC,EAAmBD,WACtBtB,KAAKD,OAAS,CAAEV,YAAa,IAC7BW,KAAKwB,eAAgB,EACrBD,EAAmBD,SAAWtB,MAGzBuB,EAAmBD,SAG5B,IAAAX,EAAAY,EAAAX,UA0CC,OA1CDD,EAOAc,WAAA,SAAW5B,EAAgBC,EAAiBC,GAC1C,GAAIC,KAAK0B,mBACPC,QAAQC,KAAK,+CADf,CAIA,IAAK/B,GAA4B,iBAAXA,EACpB,MAAM,IAAIqB,MAAM,6CAElB,IAAKpB,GAA8B,iBAAZA,IAAyB3B,EAAW2B,GACzD,MAAM,IAAIoB,MAAM,gDAElB,IAAKnB,EAAOV,YACV,MAAM,IAAI6B,MAAM,iCAElBlB,KAAKD,OAASA,EACd,IAAI8B,EH1CmB,SAACzD,GAE1B,IAAMyD,EAAezD,EAAI0D,OAGzB,IAAK3D,EAAWC,GACd,MAAM,IAAI8C,MAAM,+CAGlB,IACE,IAAIa,EAAY,IAAIC,IAAIH,GAWxB,OATAE,EAAUE,SAAWF,EAAUE,SAASC,cAGb,MAAvBH,EAAUI,WACZJ,EAAUI,SAAWJ,EAAUI,SAASC,QAAQ,OAAQ,KAAO,IAK1DL,EAAU9C,WAAWmD,QAAQ,OAAQ,IAC5C,MAAOC,GACP,MAAM,IAAInB,MAAM,yBGmBGoB,CAAYxC,GAC/BE,KAAKuC,UAAY,IAAI3C,EAAU,CAAEC,OAAAA,EAAQC,QAAS+B,EAAc9B,OAAAA,IAChEC,KAAKwB,eAAgB,IACtBb,EAED6B,QAAA,WACExC,KAAKD,OAAS,CAAEV,YAAa,IAC7BW,KAAKwB,eAAgB,GACtBb,EAEDe,iBAAA,WACE,OAAO1B,KAAKwB,eACbb,EAED8B,aAAA,WACE,OAAOzC,KAAKuC,WACb5B,EAED+B,UAAA,WACE,OAAO1C,KAAKD,QACbwB,uBChEqB,SAACR,gBACvB4B,EAAAC,EAAmBH,iBAAnBE,EAAmC3B,SAASD,uBCUpB,SACxBlB,EACAC,EACAC,GAEA,IAEE,OADA6C,EAAmBnB,WAAW5B,EAAQC,EAASC,IACxC,EACP,MAAOsC,GAEP,OADAV,QAAQC,WAAMS,SAAAA,EAAWQ,UAClB,kBCnBU,SAAChE,EAAmBL,SAClCoE,EAAmBlB,mBAInB7C,GAAkC,iBAAdA,SAIzB8D,EAAAC,EAAmBH,iBAAnBE,EAAmC1B,MAAMpC,EAAWL,GAHlDmD,QAAQmB,MAAM,+BAJdnB,QAAQmB,MAAM"}

package/dist/churnsignal-sdk-web.esm.js

@@ -0,0 +1,243 @@
+var urlRegex = /^https?:\/\//;
+var isValidUrl = function isValidUrl(url) {
+  return urlRegex.test(url);
+};
+var sanitiseUrl = function sanitiseUrl(url) {
+  // Trim whitespace
+  var sanitisedUrl = url.trim();
+  // Validate scheme
+  if (!isValidUrl(url)) {
+    throw new Error("URL must start with 'http://' or 'https://'");
+  }
+  try {
+    var urlObject = new URL(sanitisedUrl);
+    urlObject.hostname = urlObject.hostname.toLowerCase();
+    // Remove trailing slash
+    if (urlObject.pathname !== '/') {
+      urlObject.pathname = urlObject.pathname.replace(/\/+$/, '') || '';
+    }
+    // Reconstruct the URL from its components
+    // Note: The URL interface automatically handles encoding of the pathname
+    return urlObject.toString().replace(/\/+$/, '');
+  } catch (e) {
+    throw new Error('Invalid URL provided');
+  }
+};
+
+function _extends() {
+  _extends = Object.assign ? Object.assign.bind() : function (target) {
+    for (var i = 1; i < arguments.length; i++) {
+      var source = arguments[i];
+      for (var key in source) {
+        if (Object.prototype.hasOwnProperty.call(source, key)) {
+          target[key] = source[key];
+        }
+      }
+    }
+    return target;
+  };
+  return _extends.apply(this, arguments);
+}
+
+var transformTrackRequestData = function transformTrackRequestData(_ref) {
+  var eventName = _ref.eventName,
+    eventProperties = _ref.eventProperties,
+    userProperties = _ref.userProperties,
+    configProperties = _ref.configProperties;
+  var transformedEvent = {
+    name: eventName,
+    timestamp: new Date().getTime().toString(),
+    userEmail: userProperties == null ? void 0 : userProperties.email,
+    tenantId: configProperties.tenantId,
+    workspaceId: configProperties.workspaceId,
+    type: 'event',
+    data: eventProperties
+  };
+  return JSON.stringify(transformedEvent);
+};
+
+var sdkConfig = {
+  defaultHeaders: {
+    'Content-Type': 'application/json'
+  }
+};
+var API_PREFIX = 'sdk-prod';
+var TRACK_ENDPOINT = API_PREFIX + "/track";
+// const IDENTIFY_USER_ENDPOINT = `${API_PREFIX}/identify`;
+var ApiClient = /*#__PURE__*/function () {
+  function ApiClient(_ref) {
+    var _this = this;
+    var apiKey = _ref.apiKey,
+      baseUrl = _ref.baseUrl,
+      config = _ref.config;
+    this.workspaceId = '';
+    // Wrapper function for fetch
+    this.fetchWithConfig = function (endpoint, options) {
+      if (options === void 0) {
+        options = {
+          method: 'GET'
+        };
+      }
+      // Construct the full URL
+      var url = _this.getBaseUrl() + "/" + endpoint;
+      // Merge the default headers with any headers provided in the options
+      var headers = _extends({}, sdkConfig.defaultHeaders, {
+        'x-api-key': _this.getApiKey()
+      }, options.headers || {});
+      // Merge the rest of the options with the headers
+      var config = _extends({}, options, {
+        headers: headers
+      });
+      // Execute the fetch call with the merged configuration
+      return fetch(url, config);
+    };
+    this.apiKey = apiKey;
+    this.baseUrl = baseUrl;
+    this.workspaceId = config.workspaceId;
+    this.tenantId = config.tenantId;
+  }
+  var _proto = ApiClient.prototype;
+  _proto.getApiKey = function getApiKey() {
+    return this.apiKey;
+  };
+  _proto.getBaseUrl = function getBaseUrl() {
+    return this.baseUrl;
+  };
+  _proto.getWorkspaceId = function getWorkspaceId() {
+    return this.workspaceId;
+  };
+  _proto.getUser = function getUser() {
+    return this.user;
+  };
+  _proto.identify = function identify(user) {
+    this.user = user;
+    // this.fetchWithConfig(IDENTIFY_USER_ENDPOINT, {
+    //   method: 'POST',
+    //   body: transformIdentifyRequestData({
+    //     ...user,
+    //   }),
+    // });
+  };
+  _proto.track = function track(eventName, eventProperties) {
+    if (!this.user) {
+      throw new Error('No identified users to track');
+    }
+    this.fetchWithConfig(TRACK_ENDPOINT, {
+      method: 'POST',
+      body: transformTrackRequestData({
+        eventName: eventName,
+        eventProperties: eventProperties,
+        configProperties: {
+          workspaceId: this.getWorkspaceId(),
+          tenantId: this.tenantId
+        },
+        userProperties: {
+          email: this.user.email
+        }
+      })
+    });
+  };
+  return ApiClient;
+}();
+
+var SDKInstanceManager = /*#__PURE__*/function () {
+  function SDKInstanceManager() {
+    this.isInitialised = false;
+    this.config = {
+      workspaceId: ''
+    };
+    if (!SDKInstanceManager.instance) {
+      this.config = {
+        workspaceId: ''
+      };
+      this.isInitialised = false;
+      SDKInstanceManager.instance = this;
+    }
+    return SDKInstanceManager.instance;
+  }
+  /**
+   * @throws Error in case validation of parameters fails
+   * @param apiKey - required string value representing the API key
+   * @param baseUrl - required string value representing the API endpoint
+   * @param config - required object value
+   * @returns void
+   */
+  var _proto = SDKInstanceManager.prototype;
+  _proto.initialise = function initialise(apiKey, baseUrl, config) {
+    if (this.getIsInitialised()) {
+      console.info('SDK is already initialised with API key');
+      return;
+    }
+    if (!apiKey || typeof apiKey !== 'string') {
+      throw new Error('SDK needs a valid API key to be inialised');
+    }
+    if (!baseUrl || typeof baseUrl !== 'string' || !isValidUrl(baseUrl)) {
+      throw new Error('SDK needs a valid base URL to be initialised');
+    }
+    if (!config.workspaceId) {
+      throw new Error('Workspace ID must be provided');
+    }
+    this.config = config;
+    var sanitisedUrl = sanitiseUrl(baseUrl);
+    this.apiClient = new ApiClient({
+      apiKey: apiKey,
+      baseUrl: sanitisedUrl,
+      config: config
+    });
+    this.isInitialised = true;
+  };
+  _proto.destroy = function destroy() {
+    this.config = {
+      workspaceId: ''
+    };
+    this.isInitialised = false;
+  };
+  _proto.getIsInitialised = function getIsInitialised() {
+    return this.isInitialised;
+  };
+  _proto.getApiClient = function getApiClient() {
+    return this.apiClient;
+  };
+  _proto.getConfig = function getConfig() {
+    return this.config;
+  };
+  return SDKInstanceManager;
+}();
+var instance = /*#__PURE__*/new SDKInstanceManager();
+
+/**
+ * @param apiKey - required string value representing the API key
+ * @param baseUrl - required string value representing the API endpoint
+ * @param options - optional object value
+ * @returns boolean indicating whether the initialisation of the sdk was successful or not
+ */
+var initialise = function initialise(apiKey, baseUrl, config) {
+  try {
+    instance.initialise(apiKey, baseUrl, config);
+    return true;
+  } catch (e) {
+    console.info(e == null ? void 0 : e.message);
+    return false;
+  }
+};
+
+var identify = function identify(user) {
+  var _sdkInstanceManager$g;
+  (_sdkInstanceManager$g = instance.getApiClient()) == null || _sdkInstanceManager$g.identify(user);
+};
+
+var track = function track(eventName, eventProperties) {
+  var _sdkInstanceManager$g;
+  if (!instance.getIsInitialised()) {
+    console.error('SDK must be initialised first');
+    return;
+  }
+  if (!eventName || typeof eventName !== 'string') {
+    console.error('Event name must be provided');
+    return;
+  }
+  (_sdkInstanceManager$g = instance.getApiClient()) == null || _sdkInstanceManager$g.track(eventName, eventProperties);
+};
+
+export { identify, initialise, track };
+//# sourceMappingURL=churnsignal-sdk-web.esm.js.map

package/dist/churnsignal-sdk-web.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"churnsignal-sdk-web.esm.js","sources":["../src/utils/url-validator.ts","../src/utils/request-transformations.ts","../src/api-client.ts","../src/managers/sdk-instance-manager.ts","../src/core/initialise.ts","../src/core/identify.ts","../src/core/track.ts"],"sourcesContent":["const urlRegex = /^https?:\\/\\//;\n\nexport const isValidUrl = (url: string) => urlRegex.test(url);\n\nexport const sanitiseUrl = (url: string) => {\n  // Trim whitespace\n  const sanitisedUrl = url.trim();\n\n  // Validate scheme\n  if (!isValidUrl(url)) {\n    throw new Error(\"URL must start with 'http://' or 'https://'\");\n  }\n\n  try {\n    let urlObject = new URL(sanitisedUrl);\n\n    urlObject.hostname = urlObject.hostname.toLowerCase();\n\n    // Remove trailing slash\n    if (urlObject.pathname !== '/') {\n      urlObject.pathname = urlObject.pathname.replace(/\\/+$/, '') || '';\n    }\n\n    // Reconstruct the URL from its components\n    // Note: The URL interface automatically handles encoding of the pathname\n    return urlObject.toString().replace(/\\/+$/, '');\n  } catch (e) {\n    throw new Error('Invalid URL provided');\n  }\n};\n","import { EventProperties } from '../api-client';\n\ntype TrackRequest = {\n  eventName: string;\n  eventProperties?: EventProperties;\n  userProperties?: {\n    email: string;\n  };\n  configProperties: {\n    workspaceId: string;\n    tenantId?: string\n  };\n};\n\nexport const transformTrackRequestData = ({\n  eventName,\n  eventProperties,\n  userProperties,\n  configProperties,\n}: TrackRequest) => {\n  const transformedEvent = {\n    name: eventName,\n    timestamp: new Date().getTime().toString(),\n    userEmail: userProperties?.email,\n    tenantId: configProperties.tenantId, // TODO this will be handled on the API side, for now pass it in SDK setup\n    workspaceId: configProperties.workspaceId,\n    type: 'event',\n    data: eventProperties,\n  };\n  return JSON.stringify(transformedEvent);\n};\n\ntype IdentifyRequest = {\n  email: string\n}\n\nexport const transformIdentifyRequestData = ({\n  email\n}: IdentifyRequest) => {\n  const transformedIdentify = {\n    userEmail: email\n  }\n  return JSON.stringify(transformedIdentify);\n}","import {\n  transformTrackRequestData,\n  // transformIdentifyRequestData,\n} from './utils/request-transformations';\n\ntype ApiClientProps = {\n  apiKey: string;\n  baseUrl?: string;\n  config: {\n    workspaceId: string;\n    tenantId?: string;\n  };\n};\n\nexport type EventProperties = Record<string, any>;\n\ntype User = {\n  email: string;\n};\n\nconst sdkConfig = {\n  defaultHeaders: {\n    'Content-Type': 'application/json',\n  },\n};\n\nconst API_PREFIX = 'sdk-prod';\n\nconst TRACK_ENDPOINT = `${API_PREFIX}/track`;\n// const IDENTIFY_USER_ENDPOINT = `${API_PREFIX}/identify`;\n\nclass ApiClient {\n  private apiKey: string;\n  private baseUrl?: string;\n  private workspaceId: string = '';\n  private tenantId?: string;\n  private user?: User;\n\n  constructor({ apiKey, baseUrl, config }: ApiClientProps) {\n    this.apiKey = apiKey;\n    this.baseUrl = baseUrl;\n    this.workspaceId = config.workspaceId;\n    this.tenantId = config.tenantId;\n  }\n\n  // Wrapper function for fetch\n  fetchWithConfig = (\n    endpoint: string,\n    options: RequestInit = { method: 'GET' }\n  ) => {\n    // Construct the full URL\n    const url = `${this.getBaseUrl()}/${endpoint}`;\n\n    // Merge the default headers with any headers provided in the options\n    const headers = {\n      ...sdkConfig.defaultHeaders,\n      'x-api-key': this.getApiKey(),\n      ...(options.headers || {}),\n    };\n\n    // Merge the rest of the options with the headers\n    const config = {\n      ...options,\n      headers,\n    };\n\n    // Execute the fetch call with the merged configuration\n    return fetch(url, config);\n  };\n\n  getApiKey() {\n    return this.apiKey;\n  }\n\n  getBaseUrl() {\n    return this.baseUrl;\n  }\n\n  getWorkspaceId() {\n    return this.workspaceId;\n  }\n\n  getUser() {\n    return this.user;\n  }\n\n  identify(user: User) {\n    this.user = user;\n    // this.fetchWithConfig(IDENTIFY_USER_ENDPOINT, {\n    //   method: 'POST',\n    //   body: transformIdentifyRequestData({\n    //     ...user,\n    //   }),\n    // });\n  }\n\n  track(eventName: string, eventProperties?: EventProperties) {\n    if (!this.user) {\n      throw new Error('No identified users to track');\n    }\n    this.fetchWithConfig(TRACK_ENDPOINT, {\n      method: 'POST',\n      body: transformTrackRequestData({\n        eventName,\n        eventProperties,\n        configProperties: {\n          workspaceId: this.getWorkspaceId(),\n          tenantId: this.tenantId,\n        },\n        userProperties: {\n          email: this.user.email,\n        },\n      }),\n    });\n  }\n}\n\nexport default ApiClient;\n","import { isValidUrl, sanitiseUrl } from '../utils/url-validator';\nimport ApiClient from './../api-client';\n\ntype Config = {\n  workspaceId: string;\n  tenantId?: string;\n};\n\nclass SDKInstanceManager {\n  private static instance: SDKInstanceManager;\n  private isInitialised: boolean = false;\n  private config: Config = { workspaceId: '' };\n  private apiClient?: ApiClient;\n\n  constructor() {\n    if (!SDKInstanceManager.instance) {\n      this.config = { workspaceId: '' };\n      this.isInitialised = false;\n      SDKInstanceManager.instance = this;\n    }\n\n    return SDKInstanceManager.instance;\n  }\n\n  /**\n   * @throws Error in case validation of parameters fails\n   * @param apiKey - required string value representing the API key\n   * @param baseUrl - required string value representing the API endpoint\n   * @param config - required object value\n   * @returns void\n   */\n  initialise(apiKey: string, baseUrl: string, config: Config) {\n    if (this.getIsInitialised()) {\n      console.info('SDK is already initialised with API key');\n      return;\n    }\n    if (!apiKey || typeof apiKey !== 'string') {\n      throw new Error('SDK needs a valid API key to be inialised');\n    }\n    if (!baseUrl || typeof baseUrl !== 'string' || !isValidUrl(baseUrl)) {\n      throw new Error('SDK needs a valid base URL to be initialised');\n    }\n    if (!config.workspaceId) {\n      throw new Error('Workspace ID must be provided');\n    }\n    this.config = config;\n    let sanitisedUrl = sanitiseUrl(baseUrl);\n    this.apiClient = new ApiClient({ apiKey, baseUrl: sanitisedUrl, config });\n    this.isInitialised = true;\n  }\n\n  destroy() {\n    this.config = { workspaceId: '' };\n    this.isInitialised = false;\n  }\n\n  getIsInitialised() {\n    return this.isInitialised;\n  }\n\n  getApiClient() {\n    return this.apiClient;\n  }\n\n  getConfig() {\n    return this.config;\n  }\n}\n\nconst instance = new SDKInstanceManager();\nexport { instance as default };\n","import sdkInstanceManager from './../managers/sdk-instance-manager';\n\nexport type InitConfig = {\n  workspaceId: string\n  tenantId: string; // TODO to be removed should be done on the API side\n};\n\n/**\n * @param apiKey - required string value representing the API key\n * @param baseUrl - required string value representing the API endpoint\n * @param options - optional object value\n * @returns boolean indicating whether the initialisation of the sdk was successful or not\n */\nexport const initialise = (\n  apiKey: string,\n  baseUrl: string,\n  config: InitConfig\n) => {\n  try {\n    sdkInstanceManager.initialise(apiKey, baseUrl, config);\n    return true;\n  } catch (e) {\n    console.info((e as any)?.message);\n    return false;\n  }\n};\n","import sdkInstanceManager from '../managers/sdk-instance-manager';\n\nexport const identify = (user: { email: string }) => {\n  sdkInstanceManager.getApiClient()?.identify(user);\n};\n","import sdkInstanceManager from '../managers/sdk-instance-manager';\n\ntype Properties = Record<string, any>;\n\nexport const track = (eventName: string, eventProperties?: Properties) => {\n  if (!sdkInstanceManager.getIsInitialised()) {\n    console.error('SDK must be initialised first');\n    return;\n  }\n  if (!eventName || typeof eventName !== 'string') {\n    console.error('Event name must be provided');\n    return;\n  }\n  sdkInstanceManager.getApiClient()?.track(eventName, eventProperties);\n};\n"],"names":["urlRegex","isValidUrl","url","test","sanitiseUrl","sanitisedUrl","trim","Error","urlObject","URL","hostname","toLowerCase","pathname","replace","toString","e","transformTrackRequestData","_ref","eventName","eventProperties","userProperties","configProperties","transformedEvent","name","timestamp","Date","getTime","userEmail","email","tenantId","workspaceId","type","data","JSON","stringify","sdkConfig","defaultHeaders","API_PREFIX","TRACK_ENDPOINT","ApiClient","apiKey","baseUrl","config","endpoint","options","method","_this","getBaseUrl","headers","_extends","getApiKey","fetch","_proto","prototype","getWorkspaceId","getUser","user","identify","track","fetchWithConfig","body","SDKInstanceManager","instance","isInitialised","initialise","getIsInitialised","console","info","apiClient","destroy","getApiClient","getConfig","sdkInstanceManager","message","_sdkInstanceManager$g","error"],"mappings":"AAAA,IAAMA,QAAQ,GAAG,cAAc;AAExB,IAAMC,UAAU,GAAG,SAAbA,UAAUA,CAAIC,GAAW;EAAA,OAAKF,QAAQ,CAACG,IAAI,CAACD,GAAG,CAAC;AAAA;AAEtD,IAAME,WAAW,GAAG,SAAdA,WAAWA,CAAIF,GAAW;;EAErC,IAAMG,YAAY,GAAGH,GAAG,CAACI,IAAI,EAAE;;EAG/B,IAAI,CAACL,UAAU,CAACC,GAAG,CAAC,EAAE;IACpB,MAAM,IAAIK,KAAK,CAAC,6CAA6C,CAAC;;EAGhE,IAAI;IACF,IAAIC,SAAS,GAAG,IAAIC,GAAG,CAACJ,YAAY,CAAC;IAErCG,SAAS,CAACE,QAAQ,GAAGF,SAAS,CAACE,QAAQ,CAACC,WAAW,EAAE;;IAGrD,IAAIH,SAAS,CAACI,QAAQ,KAAK,GAAG,EAAE;MAC9BJ,SAAS,CAACI,QAAQ,GAAGJ,SAAS,CAACI,QAAQ,CAACC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,EAAE;;;;IAKnE,OAAOL,SAAS,CAACM,QAAQ,EAAE,CAACD,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;GAChD,CAAC,OAAOE,CAAC,EAAE;IACV,MAAM,IAAIR,KAAK,CAAC,sBAAsB,CAAC;;AAE3C,CAAC;;;;;;;;;;;;;;;;;ACfM,IAAMS,yBAAyB,GAAG,SAA5BA,yBAAyBA,CAAAC,IAAA;MACpCC,SAAS,GAAAD,IAAA,CAATC,SAAS;IACTC,eAAe,GAAAF,IAAA,CAAfE,eAAe;IACfC,cAAc,GAAAH,IAAA,CAAdG,cAAc;IACdC,gBAAgB,GAAAJ,IAAA,CAAhBI,gBAAgB;EAEhB,IAAMC,gBAAgB,GAAG;IACvBC,IAAI,EAAEL,SAAS;IACfM,SAAS,EAAE,IAAIC,IAAI,EAAE,CAACC,OAAO,EAAE,CAACZ,QAAQ,EAAE;IAC1Ca,SAAS,EAAEP,cAAc,oBAAdA,cAAc,CAAEQ,KAAK;IAChCC,QAAQ,EAAER,gBAAgB,CAACQ,QAAQ;IACnCC,WAAW,EAAET,gBAAgB,CAACS,WAAW;IACzCC,IAAI,EAAE,OAAO;IACbC,IAAI,EAAEb;GACP;EACD,OAAOc,IAAI,CAACC,SAAS,CAACZ,gBAAgB,CAAC;AACzC,CAAC;;ACVD,IAAMa,SAAS,GAAG;EAChBC,cAAc,EAAE;IACd,cAAc,EAAE;;CAEnB;AAED,IAAMC,UAAU,GAAG,UAAU;AAE7B,IAAMC,cAAc,GAAMD,UAAU,WAAQ;AAC5C;AAAA,IAEME,SAAS;EAOb,SAAAA,UAAAtB,IAAA;;QAAcuB,MAAM,GAAAvB,IAAA,CAANuB,MAAM;MAAEC,OAAO,GAAAxB,IAAA,CAAPwB,OAAO;MAAEC,MAAM,GAAAzB,IAAA,CAANyB,MAAM;IAJ7B,gBAAW,GAAW,EAAE;;IAYhC,oBAAe,GAAG,UAChBC,QAAgB,EAChBC;UAAAA;QAAAA,UAAuB;UAAEC,MAAM,EAAE;SAAO;;;MAGxC,IAAM3C,GAAG,GAAM4C,KAAI,CAACC,UAAU,EAAE,SAAIJ,QAAU;;MAG9C,IAAMK,OAAO,GAAAC,QAAA,KACRd,SAAS,CAACC,cAAc;QAC3B,WAAW,EAAEU,KAAI,CAACI,SAAS;SACvBN,OAAO,CAACI,OAAO,IAAI,EAAE,CAC1B;;MAGD,IAAMN,MAAM,GAAAO,QAAA,KACPL,OAAO;QACVI,OAAO,EAAPA;QACD;;MAGD,OAAOG,KAAK,CAACjD,GAAG,EAAEwC,MAAM,CAAC;KAC1B;IA7BC,IAAI,CAACF,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACC,OAAO,GAAGA,OAAO;IACtB,IAAI,CAACX,WAAW,GAAGY,MAAM,CAACZ,WAAW;IACrC,IAAI,CAACD,QAAQ,GAAGa,MAAM,CAACb,QAAQ;;EAChC,IAAAuB,MAAA,GAAAb,SAAA,CAAAc,SAAA;EAAAD,MAAA,CA2BDF,SAAS,GAAT,SAAAA;IACE,OAAO,IAAI,CAACV,MAAM;GACnB;EAAAY,MAAA,CAEDL,UAAU,GAAV,SAAAA;IACE,OAAO,IAAI,CAACN,OAAO;GACpB;EAAAW,MAAA,CAEDE,cAAc,GAAd,SAAAA;IACE,OAAO,IAAI,CAACxB,WAAW;GACxB;EAAAsB,MAAA,CAEDG,OAAO,GAAP,SAAAA;IACE,OAAO,IAAI,CAACC,IAAI;GACjB;EAAAJ,MAAA,CAEDK,QAAQ,GAAR,SAAAA,SAASD,IAAU;IACjB,IAAI,CAACA,IAAI,GAAGA,IAAI;;;;;;;GAOjB;EAAAJ,MAAA,CAEDM,KAAK,GAAL,SAAAA,MAAMxC,SAAiB,EAAEC,eAAiC;IACxD,IAAI,CAAC,IAAI,CAACqC,IAAI,EAAE;MACd,MAAM,IAAIjD,KAAK,CAAC,8BAA8B,CAAC;;IAEjD,IAAI,CAACoD,eAAe,CAACrB,cAAc,EAAE;MACnCO,MAAM,EAAE,MAAM;MACde,IAAI,EAAE5C,yBAAyB,CAAC;QAC9BE,SAAS,EAATA,SAAS;QACTC,eAAe,EAAfA,eAAe;QACfE,gBAAgB,EAAE;UAChBS,WAAW,EAAE,IAAI,CAACwB,cAAc,EAAE;UAClCzB,QAAQ,EAAE,IAAI,CAACA;SAChB;QACDT,cAAc,EAAE;UACdQ,KAAK,EAAE,IAAI,CAAC4B,IAAI,CAAC5B;;OAEpB;KACF,CAAC;GACH;EAAA,OAAAW,SAAA;AAAA;;ACjHqC,IAOlCsB,kBAAkB;EAMtB,SAAAA;IAJQ,kBAAa,GAAY,KAAK;IAC9B,WAAM,GAAW;MAAE/B,WAAW,EAAE;KAAI;IAI1C,IAAI,CAAC+B,kBAAkB,CAACC,QAAQ,EAAE;MAChC,IAAI,CAACpB,MAAM,GAAG;QAAEZ,WAAW,EAAE;OAAI;MACjC,IAAI,CAACiC,aAAa,GAAG,KAAK;MAC1BF,kBAAkB,CAACC,QAAQ,GAAG,IAAI;;IAGpC,OAAOD,kBAAkB,CAACC,QAAQ;;;;;;;;;EAGpC,IAAAV,MAAA,GAAAS,kBAAA,CAAAR,SAAA;EAAAD,MAAA,CAOAY,UAAU,GAAV,SAAAA,WAAWxB,MAAc,EAAEC,OAAe,EAAEC,MAAc;IACxD,IAAI,IAAI,CAACuB,gBAAgB,EAAE,EAAE;MAC3BC,OAAO,CAACC,IAAI,CAAC,yCAAyC,CAAC;MACvD;;IAEF,IAAI,CAAC3B,MAAM,IAAI,OAAOA,MAAM,KAAK,QAAQ,EAAE;MACzC,MAAM,IAAIjC,KAAK,CAAC,2CAA2C,CAAC;;IAE9D,IAAI,CAACkC,OAAO,IAAI,OAAOA,OAAO,KAAK,QAAQ,IAAI,CAACxC,UAAU,CAACwC,OAAO,CAAC,EAAE;MACnE,MAAM,IAAIlC,KAAK,CAAC,8CAA8C,CAAC;;IAEjE,IAAI,CAACmC,MAAM,CAACZ,WAAW,EAAE;MACvB,MAAM,IAAIvB,KAAK,CAAC,+BAA+B,CAAC;;IAElD,IAAI,CAACmC,MAAM,GAAGA,MAAM;IACpB,IAAIrC,YAAY,GAAGD,WAAW,CAACqC,OAAO,CAAC;IACvC,IAAI,CAAC2B,SAAS,GAAG,IAAI7B,SAAS,CAAC;MAAEC,MAAM,EAANA,MAAM;MAAEC,OAAO,EAAEpC,YAAY;MAAEqC,MAAM,EAANA;KAAQ,CAAC;IACzE,IAAI,CAACqB,aAAa,GAAG,IAAI;GAC1B;EAAAX,MAAA,CAEDiB,OAAO,GAAP,SAAAA;IACE,IAAI,CAAC3B,MAAM,GAAG;MAAEZ,WAAW,EAAE;KAAI;IACjC,IAAI,CAACiC,aAAa,GAAG,KAAK;GAC3B;EAAAX,MAAA,CAEDa,gBAAgB,GAAhB,SAAAA;IACE,OAAO,IAAI,CAACF,aAAa;GAC1B;EAAAX,MAAA,CAEDkB,YAAY,GAAZ,SAAAA;IACE,OAAO,IAAI,CAACF,SAAS;GACtB;EAAAhB,MAAA,CAEDmB,SAAS,GAAT,SAAAA;IACE,OAAO,IAAI,CAAC7B,MAAM;GACnB;EAAA,OAAAmB,kBAAA;AAAA;AAGH,IAAMC,QAAQ,gBAAG,IAAID,kBAAkB,EAAE;;AC9DzC;;;;;;AAMA,IAAaG,UAAU,GAAG,SAAbA,UAAUA,CACrBxB,MAAc,EACdC,OAAe,EACfC,MAAkB;EAElB,IAAI;IACF8B,QAAkB,CAACR,UAAU,CAACxB,MAAM,EAAEC,OAAO,EAAEC,MAAM,CAAC;IACtD,OAAO,IAAI;GACZ,CAAC,OAAO3B,CAAC,EAAE;IACVmD,OAAO,CAACC,IAAI,CAAEpD,CAAS,oBAATA,CAAS,CAAE0D,OAAO,CAAC;IACjC,OAAO,KAAK;;AAEhB,CAAC;;ICvBYhB,QAAQ,GAAG,SAAXA,QAAQA,CAAID,IAAuB;;EAC9C,CAAAkB,qBAAA,GAAAF,QAAkB,CAACF,YAAY,EAAE,aAAjCI,qBAAA,CAAmCjB,QAAQ,CAACD,IAAI,CAAC;AACnD,CAAC;;ICAYE,KAAK,GAAG,SAARA,KAAKA,CAAIxC,SAAiB,EAAEC,eAA4B;;EACnE,IAAI,CAACqD,QAAkB,CAACP,gBAAgB,EAAE,EAAE;IAC1CC,OAAO,CAACS,KAAK,CAAC,+BAA+B,CAAC;IAC9C;;EAEF,IAAI,CAACzD,SAAS,IAAI,OAAOA,SAAS,KAAK,QAAQ,EAAE;IAC/CgD,OAAO,CAACS,KAAK,CAAC,6BAA6B,CAAC;IAC5C;;EAEF,CAAAD,qBAAA,GAAAF,QAAkB,CAACF,YAAY,EAAE,aAAjCI,qBAAA,CAAmChB,KAAK,CAACxC,SAAS,EAAEC,eAAe,CAAC;AACtE,CAAC;;;;"}

package/dist/core/destroy.d.ts

@@ -0,0 +1 @@
+export declare const destroy: () => void;

package/dist/core/identify.d.ts

@@ -0,0 +1,3 @@
+export declare const identify: (user: {
+    email: string;
+}) => void;

package/dist/core/index.d.ts

@@ -0,0 +1,3 @@
+export * from './initialise';
+export * from './identify';
+export * from './track';

package/dist/core/initialise.d.ts

@@ -0,0 +1,11 @@
+export declare type InitConfig = {
+    workspaceId: string;
+    tenantId: string;
+};
+/**
+ * @param apiKey - required string value representing the API key
+ * @param baseUrl - required string value representing the API endpoint
+ * @param options - optional object value
+ * @returns boolean indicating whether the initialisation of the sdk was successful or not
+ */
+export declare const initialise: (apiKey: string, baseUrl: string, config: InitConfig) => boolean;

package/dist/core/track.d.ts

@@ -0,0 +1 @@
+export declare const track: (eventName: string, eventProperties?: Record<string, any> | undefined) => void;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './core/index';

package/dist/index.js

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./churnsignal-sdk-web.cjs.production.min.js')
+} else {
+  module.exports = require('./churnsignal-sdk-web.cjs.development.js')
+}

package/dist/managers/index.d.ts

@@ -0,0 +1 @@
+export * from './sdk-instance-manager';

package/dist/managers/sdk-instance-manager.d.ts

@@ -0,0 +1,26 @@
+import ApiClient from './../api-client';
+declare type Config = {
+    workspaceId: string;
+    tenantId?: string;
+};
+declare class SDKInstanceManager {
+    private static instance;
+    private isInitialised;
+    private config;
+    private apiClient?;
+    constructor();
+    /**
+     * @throws Error in case validation of parameters fails
+     * @param apiKey - required string value representing the API key
+     * @param baseUrl - required string value representing the API endpoint
+     * @param config - required object value
+     * @returns void
+     */
+    initialise(apiKey: string, baseUrl: string, config: Config): void;
+    destroy(): void;
+    getIsInitialised(): boolean;
+    getApiClient(): ApiClient | undefined;
+    getConfig(): Config;
+}
+declare const instance: SDKInstanceManager;
+export { instance as default };

package/dist/utils/request-transformations.d.ts

@@ -0,0 +1,18 @@
+import { EventProperties } from '../api-client';
+declare type TrackRequest = {
+    eventName: string;
+    eventProperties?: EventProperties;
+    userProperties?: {
+        email: string;
+    };
+    configProperties: {
+        workspaceId: string;
+        tenantId?: string;
+    };
+};
+export declare const transformTrackRequestData: ({ eventName, eventProperties, userProperties, configProperties, }: TrackRequest) => string;
+declare type IdentifyRequest = {
+    email: string;
+};
+export declare const transformIdentifyRequestData: ({ email }: IdentifyRequest) => string;
+export {};

package/dist/utils/url-validator.d.ts

@@ -0,0 +1,2 @@
+export declare const isValidUrl: (url: string) => boolean;
+export declare const sanitiseUrl: (url: string) => string;

package/package.json

@@ -0,0 +1,55 @@
+{
+  "version": "0.1.1",
+  "license": "ISC",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=10"
+  },
+  "scripts": {
+    "start": "tsdx watch",
+    "build": "tsdx build",
+    "test": "tsdx test",
+    "lint": "tsdx lint",
+    "prepare": "tsdx build",
+    "size": "size-limit",
+    "analyze": "size-limit --why"
+  },
+  "peerDependencies": {},
+  "husky": {
+    "hooks": {
+      "pre-commit": "tsdx lint"
+    }
+  },
+  "prettier": {
+    "printWidth": 80,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "es5"
+  },
+  "name": "@churnsignal/churnsignal-sdk-web",
+  "author": "cyberraven",
+  "module": "dist/churnsignal-sdk-web.esm.js",
+  "size-limit": [
+    {
+      "path": "dist/churnsignal-sdk-web.cjs.production.min.js",
+      "limit": "10 KB"
+    },
+    {
+      "path": "dist/churnsignal-sdk-web.esm.js",
+      "limit": "10 KB"
+    }
+  ],
+  "devDependencies": {
+    "@size-limit/preset-small-lib": "^11.0.1",
+    "husky": "^8.0.3",
+    "size-limit": "^11.0.1",
+    "tsdx": "^0.14.1",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3"
+  }
+}

package/src/api-client.ts

@@ -0,0 +1,118 @@
+import {
+  transformTrackRequestData,
+  // transformIdentifyRequestData,
+} from './utils/request-transformations';
+
+type ApiClientProps = {
+  apiKey: string;
+  baseUrl?: string;
+  config: {
+    workspaceId: string;
+    tenantId?: string;
+  };
+};
+
+export type EventProperties = Record<string, any>;
+
+type User = {
+  email: string;
+};
+
+const sdkConfig = {
+  defaultHeaders: {
+    'Content-Type': 'application/json',
+  },
+};
+
+const API_PREFIX = 'sdk-prod';
+
+const TRACK_ENDPOINT = `${API_PREFIX}/track`;
+// const IDENTIFY_USER_ENDPOINT = `${API_PREFIX}/identify`;
+
+class ApiClient {
+  private apiKey: string;
+  private baseUrl?: string;
+  private workspaceId: string = '';
+  private tenantId?: string;
+  private user?: User;
+
+  constructor({ apiKey, baseUrl, config }: ApiClientProps) {
+    this.apiKey = apiKey;
+    this.baseUrl = baseUrl;
+    this.workspaceId = config.workspaceId;
+    this.tenantId = config.tenantId;
+  }
+
+  // Wrapper function for fetch
+  fetchWithConfig = (
+    endpoint: string,
+    options: RequestInit = { method: 'GET' }
+  ) => {
+    // Construct the full URL
+    const url = `${this.getBaseUrl()}/${endpoint}`;
+
+    // Merge the default headers with any headers provided in the options
+    const headers = {
+      ...sdkConfig.defaultHeaders,
+      'x-api-key': this.getApiKey(),
+      ...(options.headers || {}),
+    };
+
+    // Merge the rest of the options with the headers
+    const config = {
+      ...options,
+      headers,
+    };
+
+    // Execute the fetch call with the merged configuration
+    return fetch(url, config);
+  };
+
+  getApiKey() {
+    return this.apiKey;
+  }
+
+  getBaseUrl() {
+    return this.baseUrl;
+  }
+
+  getWorkspaceId() {
+    return this.workspaceId;
+  }
+
+  getUser() {
+    return this.user;
+  }
+
+  identify(user: User) {
+    this.user = user;
+    // this.fetchWithConfig(IDENTIFY_USER_ENDPOINT, {
+    //   method: 'POST',
+    //   body: transformIdentifyRequestData({
+    //     ...user,
+    //   }),
+    // });
+  }
+
+  track(eventName: string, eventProperties?: EventProperties) {
+    if (!this.user) {
+      throw new Error('No identified users to track');
+    }
+    this.fetchWithConfig(TRACK_ENDPOINT, {
+      method: 'POST',
+      body: transformTrackRequestData({
+        eventName,
+        eventProperties,
+        configProperties: {
+          workspaceId: this.getWorkspaceId(),
+          tenantId: this.tenantId,
+        },
+        userProperties: {
+          email: this.user.email,
+        },
+      }),
+    });
+  }
+}
+
+export default ApiClient;

package/src/core/destroy.ts

@@ -0,0 +1,5 @@
+import sdkInstanceManager from './../managers/sdk-instance-manager';
+
+export const destroy = () => {
+  sdkInstanceManager.destroy();
+};

package/src/core/identify.ts

@@ -0,0 +1,5 @@
+import sdkInstanceManager from '../managers/sdk-instance-manager';
+
+export const identify = (user: { email: string }) => {
+  sdkInstanceManager.getApiClient()?.identify(user);
+};

package/src/core/index.ts

@@ -0,0 +1,3 @@
+export * from './initialise';
+export * from './identify';
+export * from './track';

package/src/core/initialise.test.ts

@@ -0,0 +1,33 @@
+import { destroy } from './destroy';
+import { initialise } from './initialise';
+
+const config = {
+  workspaceId: 'test-workspace-id',
+  tenantId: ''
+};
+
+describe('Initialise', () => {
+  afterEach(() => {
+    destroy();
+  })
+  it('returns false if no API key is provided', () => {
+    const apiKey = '';
+    const url = 'http://example.url';
+    expect(initialise(apiKey, url, config)).toBe(false);
+  });
+  it('returns false if invalid base URL is provided', () => {
+    const apiKey = 'example-api-key';
+    const url = 'http//example.url';
+    expect(initialise(apiKey, url, config)).toBe(false);
+  });
+  it('returns true if valid params are provided', () => {
+    const apiKey = 'example-api-key';
+    const url = 'http://example.url';
+    expect(initialise(apiKey, url, config)).toBe(true);
+  });
+  it('returns false if workspace id is not provided', () => {
+    const apiKey = 'example-api-key';
+    const url = 'http://example.url';
+    expect(initialise(apiKey, url, {} as typeof config)).toBe(false);
+  });
+});

package/src/core/initialise.ts

@@ -0,0 +1,26 @@
+import sdkInstanceManager from './../managers/sdk-instance-manager';
+
+export type InitConfig = {
+  workspaceId: string
+  tenantId: string; // TODO to be removed should be done on the API side
+};
+
+/**
+ * @param apiKey - required string value representing the API key
+ * @param baseUrl - required string value representing the API endpoint
+ * @param options - optional object value
+ * @returns boolean indicating whether the initialisation of the sdk was successful or not
+ */
+export const initialise = (
+  apiKey: string,
+  baseUrl: string,
+  config: InitConfig
+) => {
+  try {
+    sdkInstanceManager.initialise(apiKey, baseUrl, config);
+    return true;
+  } catch (e) {
+    console.info((e as any)?.message);
+    return false;
+  }
+};

package/src/core/track.ts

@@ -0,0 +1,15 @@
+import sdkInstanceManager from '../managers/sdk-instance-manager';
+
+type Properties = Record<string, any>;
+
+export const track = (eventName: string, eventProperties?: Properties) => {
+  if (!sdkInstanceManager.getIsInitialised()) {
+    console.error('SDK must be initialised first');
+    return;
+  }
+  if (!eventName || typeof eventName !== 'string') {
+    console.error('Event name must be provided');
+    return;
+  }
+  sdkInstanceManager.getApiClient()?.track(eventName, eventProperties);
+};

package/src/index.ts

@@ -0,0 +1 @@
+export * from './core/index';

package/src/managers/index.ts

@@ -0,0 +1 @@
+export * from './sdk-instance-manager';

package/src/managers/sdk-instance-manager.ts

@@ -0,0 +1,71 @@
+import { isValidUrl, sanitiseUrl } from '../utils/url-validator';
+import ApiClient from './../api-client';
+
+type Config = {
+  workspaceId: string;
+  tenantId?: string;
+};
+
+class SDKInstanceManager {
+  private static instance: SDKInstanceManager;
+  private isInitialised: boolean = false;
+  private config: Config = { workspaceId: '' };
+  private apiClient?: ApiClient;
+
+  constructor() {
+    if (!SDKInstanceManager.instance) {
+      this.config = { workspaceId: '' };
+      this.isInitialised = false;
+      SDKInstanceManager.instance = this;
+    }
+
+    return SDKInstanceManager.instance;
+  }
+
+  /**
+   * @throws Error in case validation of parameters fails
+   * @param apiKey - required string value representing the API key
+   * @param baseUrl - required string value representing the API endpoint
+   * @param config - required object value
+   * @returns void
+   */
+  initialise(apiKey: string, baseUrl: string, config: Config) {
+    if (this.getIsInitialised()) {
+      console.info('SDK is already initialised with API key');
+      return;
+    }
+    if (!apiKey || typeof apiKey !== 'string') {
+      throw new Error('SDK needs a valid API key to be inialised');
+    }
+    if (!baseUrl || typeof baseUrl !== 'string' || !isValidUrl(baseUrl)) {
+      throw new Error('SDK needs a valid base URL to be initialised');
+    }
+    if (!config.workspaceId) {
+      throw new Error('Workspace ID must be provided');
+    }
+    this.config = config;
+    let sanitisedUrl = sanitiseUrl(baseUrl);
+    this.apiClient = new ApiClient({ apiKey, baseUrl: sanitisedUrl, config });
+    this.isInitialised = true;
+  }
+
+  destroy() {
+    this.config = { workspaceId: '' };
+    this.isInitialised = false;
+  }
+
+  getIsInitialised() {
+    return this.isInitialised;
+  }
+
+  getApiClient() {
+    return this.apiClient;
+  }
+
+  getConfig() {
+    return this.config;
+  }
+}
+
+const instance = new SDKInstanceManager();
+export { instance as default };

package/src/utils/request-transformations.ts

@@ -0,0 +1,44 @@
+import { EventProperties } from '../api-client';
+
+type TrackRequest = {
+  eventName: string;
+  eventProperties?: EventProperties;
+  userProperties?: {
+    email: string;
+  };
+  configProperties: {
+    workspaceId: string;
+    tenantId?: string
+  };
+};
+
+export const transformTrackRequestData = ({
+  eventName,
+  eventProperties,
+  userProperties,
+  configProperties,
+}: TrackRequest) => {
+  const transformedEvent = {
+    name: eventName,
+    timestamp: new Date().getTime().toString(),
+    userEmail: userProperties?.email,
+    tenantId: configProperties.tenantId, // TODO this will be handled on the API side, for now pass it in SDK setup
+    workspaceId: configProperties.workspaceId,
+    type: 'event',
+    data: eventProperties,
+  };
+  return JSON.stringify(transformedEvent);
+};
+
+type IdentifyRequest = {
+  email: string
+}
+
+export const transformIdentifyRequestData = ({
+  email
+}: IdentifyRequest) => {
+  const transformedIdentify = {
+    userEmail: email
+  }
+  return JSON.stringify(transformedIdentify);
+}

package/src/utils/url-validator.test.ts

@@ -0,0 +1,26 @@
+import { isValidUrl, sanitiseUrl } from './url-validator';
+
+describe('URL validator', () => {
+  it('returns true if the URL starts with http://', () => {
+    const url = 'http://example.url';
+    expect(isValidUrl(url)).toBe(true);
+  });
+  it('returns true if the URL starts with https://', () => {
+    const url = 'https://example.url';
+    expect(isValidUrl(url)).toBe(true);
+  });
+  it('returns false if the URL doesnt start with http:// or https://', () => {
+    const url = 'https//example.url';
+    expect(isValidUrl(url)).toBe(false);
+  });
+  it('Removes trailing slash from the pathname', () => {
+    const url = 'https://example.url/example/';
+    const sanitisedUrl = sanitiseUrl(url);
+    expect(sanitisedUrl).toBe('https://example.url/example');
+  });
+  it('Removes trailing slash from the root', () => {
+    const url = 'https://example.url/';
+    const sanitisedUrl = sanitiseUrl(url);
+    expect(sanitisedUrl).toBe('https://example.url');
+  });
+});

package/src/utils/url-validator.ts

@@ -0,0 +1,30 @@
+const urlRegex = /^https?:\/\//;
+
+export const isValidUrl = (url: string) => urlRegex.test(url);
+
+export const sanitiseUrl = (url: string) => {
+  // Trim whitespace
+  const sanitisedUrl = url.trim();
+
+  // Validate scheme
+  if (!isValidUrl(url)) {
+    throw new Error("URL must start with 'http://' or 'https://'");
+  }
+
+  try {
+    let urlObject = new URL(sanitisedUrl);
+
+    urlObject.hostname = urlObject.hostname.toLowerCase();
+
+    // Remove trailing slash
+    if (urlObject.pathname !== '/') {
+      urlObject.pathname = urlObject.pathname.replace(/\/+$/, '') || '';
+    }
+
+    // Reconstruct the URL from its components
+    // Note: The URL interface automatically handles encoding of the pathname
+    return urlObject.toString().replace(/\/+$/, '');
+  } catch (e) {
+    throw new Error('Invalid URL provided');
+  }
+};