@openreplay/tracker 3.5.11 → 3.5.12

package/README.md

@@ -25,7 +25,11 @@ tracker.start({
     balance: "10M",
     role: "admin",
   }
-});
+}).then(startedSession => {
+  if (startedSession.success) {
+    console.log(startedSession) 
+  }
+})
 ```
 
 Then you can use OpenReplay JavaScript API anywhere in your code.

package/cjs/app/index.d.ts

@@ -13,11 +13,22 @@ export interface StartOptions {
     metadata?: Record<string, string>;
     forceNew?: boolean;
 }
-export interface OnStartInfo {
+interface OnStartInfo {
     sessionID: string;
     sessionToken: string;
     userUUID: string;
 }
+declare const CANCELED: "canceled";
+declare type SuccessfulStart = OnStartInfo & {
+    success: true;
+};
+declare type UnsuccessfulStart = {
+    reason: typeof CANCELED | string;
+    success: false;
+};
+declare const UnsuccessfulStart: (reason: string) => UnsuccessfulStart;
+declare const SuccessfulStart: (body: OnStartInfo) => SuccessfulStart;
+export declare type StartPromiseReturn = SuccessfulStart | UnsuccessfulStart;
 declare type StartCallback = (i: OnStartInfo) => void;
 declare type CommitCallback = (messages: Array<Message>) => void;
 declare type AppOptions = {
@@ -36,7 +47,6 @@ declare type AppOptions = {
     onStart?: StartCallback;
 } & WebworkerOptions;
 export declare type Options = AppOptions & ObserverOptions & SanitizerOptions;
-export declare const CANCELED = "canceled";
 export declare const DEFAULT_INGEST_POINT = "https://api.openreplay.com/ingest";
 export default class App {
     readonly nodes: Nodes;
@@ -88,7 +98,7 @@ export default class App {
     active(): boolean;
     resetNextPageSession(flag: boolean): void;
     private _start;
-    start(options?: StartOptions): Promise<OnStartInfo>;
+    start(options?: StartOptions): Promise<StartPromiseReturn>;
     stop(): void;
 }
 export {};

package/cjs/app/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_INGEST_POINT = exports.CANCELED = void 0;
+exports.DEFAULT_INGEST_POINT = void 0;
 const messages_js_1 = require("../common/messages.js");
 const utils_js_1 = require("../utils.js");
 const nodes_js_1 = require("./nodes.js");
@@ -10,13 +10,16 @@ const ticker_js_1 = require("./ticker.js");
 const logger_js_1 = require("./logger.js");
 const session_js_1 = require("./session.js");
 const performance_js_1 = require("../modules/performance.js");
+const CANCELED = "canceled";
+const START_ERROR = ":(";
+const UnsuccessfulStart = (reason) => ({ reason, success: false });
+const SuccessfulStart = (body) => (Object.assign(Object.assign({}, body), { success: true }));
 var ActivityState;
 (function (ActivityState) {
     ActivityState[ActivityState["NotActive"] = 0] = "NotActive";
     ActivityState[ActivityState["Starting"] = 1] = "Starting";
     ActivityState[ActivityState["Active"] = 2] = "Active";
 })(ActivityState || (ActivityState = {}));
-exports.CANCELED = "canceled";
 // TODO: use backendHost only
 exports.DEFAULT_INGEST_POINT = 'https://api.openreplay.com/ingest';
 class App {
@@ -29,7 +32,7 @@ class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '3.5.11'; // TODO: version compatability check inside each plugin.
+        this.version = '3.5.12'; // TODO: version compatability check inside each plugin.
         this.projectKey = projectKey;
         this.options = Object.assign({
             revID: '',
@@ -225,10 +228,10 @@ class App {
     }
     _start(startOpts) {
         if (!this.worker) {
-            return Promise.reject("No worker found: perhaps, CSP is not set.");
+            return Promise.resolve(UnsuccessfulStart("No worker found: perhaps, CSP is not set."));
         }
         if (this.activityState !== ActivityState.NotActive) {
-            return Promise.reject("OpenReplay: trying to call `start()` on the instance that has been started already.");
+            return Promise.resolve(UnsuccessfulStart("OpenReplay: trying to call `start()` on the instance that has been started already."));
         }
         this.activityState = ActivityState.Starting;
         let pageNo = 0;
@@ -263,8 +266,8 @@ class App {
                 return r.json();
             }
             else {
-                return r.text().then(text => text === exports.CANCELED
-                    ? Promise.reject(exports.CANCELED) // TODO: return {error: CANCELED} instead
+                return r.text().then(text => text === CANCELED
+                    ? Promise.reject(CANCELED) // TODO: return {error: CANCELED} instead
                     : Promise.reject(`Server error: ${r.status}. ${text}`));
             }
         })
@@ -297,17 +300,17 @@ class App {
             if (typeof this.options.onStart === 'function') {
                 this.options.onStart(onStartInfo);
             }
-            return onStartInfo;
+            return SuccessfulStart(onStartInfo);
         })
             .catch(reason => {
             sessionStorage.removeItem(this.options.session_token_key);
             this.stop();
-            //if (reason === CANCELED) { return Promise.resolve(CANCELED) } // TODO: what to return ????? Throwing is baad
-            if (reason !== exports.CANCELED) {
-                this.notify.log("OpenReplay was unable to start. ", reason);
-                this._debug("session_start", reason);
+            if (reason === CANCELED) {
+                return UnsuccessfulStart(CANCELED);
             }
-            return Promise.reject(reason);
+            this.notify.log("OpenReplay was unable to start. ", reason);
+            this._debug("session_start", reason);
+            return UnsuccessfulStart(START_ERROR);
         });
     }
     start(options = {}) {

package/cjs/index.d.ts

@@ -9,7 +9,7 @@ import type { Options as InputOptions } from "./modules/input.js";
 import type { Options as PerformanceOptions } from "./modules/performance.js";
 import type { Options as TimingOptions } from "./modules/timing.js";
 import type { StartOptions } from './app/index.js';
-import type { OnStartInfo } from './app/index.js';
+import type { StartPromiseReturn } from './app/index.js';
 export declare type Options = Partial<AppOptions & ConsoleOptions & ExceptionOptions & InputOptions & PerformanceOptions & TimingOptions> & {
     projectID?: number;
     projectKey: string;
@@ -24,7 +24,7 @@ export default class API {
     constructor(options: Options);
     use<T>(fn: (app: App | null, options?: Options) => T): T;
     isActive(): boolean;
-    start(startOpts?: Partial<StartOptions>): Promise<OnStartInfo>;
+    start(startOpts?: Partial<StartOptions>): Promise<StartPromiseReturn>;
     stop(): void;
     getSessionToken(): string | null | undefined;
     getSessionID(): string | null | undefined;

package/cjs/index.js

@@ -127,7 +127,7 @@ class API {
             // no-cors issue only with text/plain or not-set Content-Type
             // req.setRequestHeader("Content-Type", "application/json;charset=UTF-8");
             req.send(JSON.stringify({
-                trackerVersion: '3.5.11',
+                trackerVersion: '3.5.12',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)

package/lib/app/index.d.ts

@@ -13,11 +13,22 @@ export interface StartOptions {
     metadata?: Record<string, string>;
     forceNew?: boolean;
 }
-export interface OnStartInfo {
+interface OnStartInfo {
     sessionID: string;
     sessionToken: string;
     userUUID: string;
 }
+declare const CANCELED: "canceled";
+declare type SuccessfulStart = OnStartInfo & {
+    success: true;
+};
+declare type UnsuccessfulStart = {
+    reason: typeof CANCELED | string;
+    success: false;
+};
+declare const UnsuccessfulStart: (reason: string) => UnsuccessfulStart;
+declare const SuccessfulStart: (body: OnStartInfo) => SuccessfulStart;
+export declare type StartPromiseReturn = SuccessfulStart | UnsuccessfulStart;
 declare type StartCallback = (i: OnStartInfo) => void;
 declare type CommitCallback = (messages: Array<Message>) => void;
 declare type AppOptions = {
@@ -36,7 +47,6 @@ declare type AppOptions = {
     onStart?: StartCallback;
 } & WebworkerOptions;
 export declare type Options = AppOptions & ObserverOptions & SanitizerOptions;
-export declare const CANCELED = "canceled";
 export declare const DEFAULT_INGEST_POINT = "https://api.openreplay.com/ingest";
 export default class App {
     readonly nodes: Nodes;
@@ -88,7 +98,7 @@ export default class App {
     active(): boolean;
     resetNextPageSession(flag: boolean): void;
     private _start;
-    start(options?: StartOptions): Promise<OnStartInfo>;
+    start(options?: StartOptions): Promise<StartPromiseReturn>;
     stop(): void;
 }
 export {};

package/lib/app/index.js

@@ -7,13 +7,16 @@ import Ticker from "./ticker.js";
 import Logger, { LogLevel } from "./logger.js";
 import Session from "./session.js";
 import { deviceMemory, jsHeapSizeLimit } from "../modules/performance.js";
+const CANCELED = "canceled";
+const START_ERROR = ":(";
+const UnsuccessfulStart = (reason) => ({ reason, success: false });
+const SuccessfulStart = (body) => (Object.assign(Object.assign({}, body), { success: true }));
 var ActivityState;
 (function (ActivityState) {
     ActivityState[ActivityState["NotActive"] = 0] = "NotActive";
     ActivityState[ActivityState["Starting"] = 1] = "Starting";
     ActivityState[ActivityState["Active"] = 2] = "Active";
 })(ActivityState || (ActivityState = {}));
-export const CANCELED = "canceled";
 // TODO: use backendHost only
 export const DEFAULT_INGEST_POINT = 'https://api.openreplay.com/ingest';
 export default class App {
@@ -26,7 +29,7 @@ export default class App {
         this.stopCallbacks = [];
         this.commitCallbacks = [];
         this.activityState = ActivityState.NotActive;
-        this.version = '3.5.11'; // TODO: version compatability check inside each plugin.
+        this.version = '3.5.12'; // TODO: version compatability check inside each plugin.
         this.projectKey = projectKey;
         this.options = Object.assign({
             revID: '',
@@ -222,10 +225,10 @@ export default class App {
     }
     _start(startOpts) {
         if (!this.worker) {
-            return Promise.reject("No worker found: perhaps, CSP is not set.");
+            return Promise.resolve(UnsuccessfulStart("No worker found: perhaps, CSP is not set."));
         }
         if (this.activityState !== ActivityState.NotActive) {
-            return Promise.reject("OpenReplay: trying to call `start()` on the instance that has been started already.");
+            return Promise.resolve(UnsuccessfulStart("OpenReplay: trying to call `start()` on the instance that has been started already."));
         }
         this.activityState = ActivityState.Starting;
         let pageNo = 0;
@@ -294,17 +297,17 @@ export default class App {
             if (typeof this.options.onStart === 'function') {
                 this.options.onStart(onStartInfo);
             }
-            return onStartInfo;
+            return SuccessfulStart(onStartInfo);
         })
             .catch(reason => {
             sessionStorage.removeItem(this.options.session_token_key);
             this.stop();
-            //if (reason === CANCELED) { return Promise.resolve(CANCELED) } // TODO: what to return ????? Throwing is baad
-            if (reason !== CANCELED) {
-                this.notify.log("OpenReplay was unable to start. ", reason);
-                this._debug("session_start", reason);
+            if (reason === CANCELED) {
+                return UnsuccessfulStart(CANCELED);
             }
-            return Promise.reject(reason);
+            this.notify.log("OpenReplay was unable to start. ", reason);
+            this._debug("session_start", reason);
+            return UnsuccessfulStart(START_ERROR);
         });
     }
     start(options = {}) {

package/lib/index.d.ts

@@ -9,7 +9,7 @@ import type { Options as InputOptions } from "./modules/input.js";
 import type { Options as PerformanceOptions } from "./modules/performance.js";
 import type { Options as TimingOptions } from "./modules/timing.js";
 import type { StartOptions } from './app/index.js';
-import type { OnStartInfo } from './app/index.js';
+import type { StartPromiseReturn } from './app/index.js';
 export declare type Options = Partial<AppOptions & ConsoleOptions & ExceptionOptions & InputOptions & PerformanceOptions & TimingOptions> & {
     projectID?: number;
     projectKey: string;
@@ -24,7 +24,7 @@ export default class API {
     constructor(options: Options);
     use<T>(fn: (app: App | null, options?: Options) => T): T;
     isActive(): boolean;
-    start(startOpts?: Partial<StartOptions>): Promise<OnStartInfo>;
+    start(startOpts?: Partial<StartOptions>): Promise<StartPromiseReturn>;
     stop(): void;
     getSessionToken(): string | null | undefined;
     getSessionID(): string | null | undefined;

package/lib/index.js

@@ -123,7 +123,7 @@ export default class API {
             // no-cors issue only with text/plain or not-set Content-Type
             // req.setRequestHeader("Content-Type", "application/json;charset=UTF-8");
             req.send(JSON.stringify({
-                trackerVersion: '3.5.11',
+                trackerVersion: '3.5.12',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openreplay/tracker",
   "description": "The OpenReplay tracker main package",
-  "version": "3.5.11",
+  "version": "3.5.12",
   "keywords": [
     "logging",
     "replay"