@screeb/sdk-browser 0.1.6 → 0.1.8

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://screeb.app" alt="Intercom">
+  <a href="https://screeb.app" alt="Screeb">
     <img src="https://raw.githubusercontent.com/ScreebApp/sdk-js/master/packages/screeb-sdk-browser/readme/screeb-logo.svg?token=GHSAT0AAAAAAB2OOPMGT2QD5TL3IRJN3CKCZDEYHJA" alt="Logo" height="120px" style="margin-top: 20px;"/>
   </a>
 </p>
@@ -9,7 +9,7 @@
 
   <b>Continuous Product Discovery, Without the Time Sink.</b>
 
-  <a href="https://screeb.app" alt="Intercom">Screeb</a> is the only Continuous Product Discovery platform that lets you analyse users' behaviour, ask in-app questions, recruit people for interviews and analyse data in a blink with AI.
+  <a href="https://screeb.app" alt="Screeb">Screeb</a> is the only Continuous Product Discovery platform that lets you analyse users' behaviour, ask in-app questions, recruit people for interviews and analyse data in a blink with AI.
 </p>
 
 <p align="center">
@@ -50,6 +50,8 @@ Screeb.load();
 Screeb.init('<your-website-id>');
 ```
 
+For a working example, see our [Screeb Angular SDK example app](https://github.com/ScreebApp/sdk-js/tree/master/packages/screeb-sdk-browser-example).
+
 For a more advanced usage and a complete API documentation, see [documentation generated from source files](https://github.com/ScreebApp/sdk-js/tree/master/packages/screeb-sdk-browser/docs).
 
 For further information, see [our developper documentation](https://github.com/ScreebApp/developers).

package/dist/es/index.d.ts

@@ -12,9 +12,27 @@ export type ScreebOptions = {
     screebEndpoint?: string;
 };
 type ScreebFunction = (..._: unknown[]) => void | Promise<unknown>;
+/** This is the Screeb object publicly exposed in browser `window`. */
 export type ScreebObject = ScreebFunction & {
     q?: unknown[][];
 };
+/** This is the object returned by the function `identityGet()`. */
+export type ScreebIdentityGetReturn = {
+    /** Anonymous id given to each user */
+    anonymous_id: string;
+    /** The authenticated id assigned to the user. */
+    user_id: string;
+    /** The current user session id */
+    session_id: string;
+    /** The current user session start time */
+    session_start: string;
+    /** The current user session end time */
+    session_end: string;
+    /** The current channel id with which the tag was initialized */
+    channel_id: string;
+    /** `true` if the tag us loaded, initialized and ready to rock */
+    is_ready: boolean;
+};
 /**
  * Appends Screeb tag into your dom.
  *
@@ -173,15 +191,6 @@ export declare const eventTrack: (eventName: string, eventProperties?: PropertyR
  * ```
  */
 export declare const identity: (userId: string, userProperties?: PropertyRecord) => void | Promise<unknown>;
-type ScreebIdentityGetReturn = {
-    anonymous_id: string;
-    user_id: string;
-    session_id: string;
-    session_start: string;
-    session_end: string;
-    channel_id: string;
-    is_ready: boolean;
-};
 /**
  * Retrieves the current user identity.
  *

package/dist/es/index.js

@@ -1,5 +1,15 @@
 var SCREEB_TAG_ENDPOINT = "https://t.screeb.app/tag.js";
 var _window = window;
+var callScreebCommand = function () {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args[_i] = arguments[_i];
+    }
+    if (_window.$screeb) {
+        return _window.$screeb.apply(_window.$screeb, args);
+    }
+    return Promise.reject("[Screeb] Screeb.load() must be called before any other function.");
+};
 /**
  * Appends Screeb tag into your dom.
  *
@@ -77,7 +87,7 @@ var init = function (websiteId, userId, userProperties) {
             },
         };
     }
-    return $screeb("init", websiteId, identityObject);
+    return callScreebCommand("init", websiteId, identityObject);
 };
 /**
  * Checks if Screeb tag has been loaded.
@@ -91,7 +101,9 @@ var init = function (websiteId, userId, userProperties) {
  * console.log(Screeb.isLoaded()); // true
  * ```
  */
-var isLoaded = function () { return $screeb && typeof $screeb === "function"; };
+var isLoaded = function () {
+    return Boolean(_window.$screeb) && typeof _window.$screeb === "function";
+};
 /**
  * Shutdowns current Screeb session.
  *
@@ -102,7 +114,7 @@ var isLoaded = function () { return $screeb && typeof $screeb === "function"; };
  * Screeb.close();
  * ```
  */
-var close = function () { return $screeb("close"); };
+var close = function () { return callScreebCommand("close"); };
 /**
  * Prints the actual state information of Screeb tag.
  *
@@ -130,7 +142,7 @@ var close = function () { return $screeb("close"); };
  * // **************************************************************
  * ```
  */
-var debug = function () { return $screeb("debug"); };
+var debug = function () { return callScreebCommand("debug"); };
 /**
  * Tracks a user event.
  *
@@ -162,7 +174,7 @@ var debug = function () { return $screeb("debug"); };
  * );
  * ```
  */
-var eventTrack = function (eventName, eventProperties) { return $screeb("event.track", eventName, eventProperties); };
+var eventTrack = function (eventName, eventProperties) { return callScreebCommand("event.track", eventName, eventProperties); };
 /**
  * Change the current user identity.
  * Warning: Running surveys will be closed.
@@ -192,7 +204,7 @@ var eventTrack = function (eventName, eventProperties) { return $screeb("event.t
  * ```
  */
 var identity = function (userId, userProperties) {
-    return $screeb("identity", userId, userProperties);
+    return callScreebCommand("identity", userId, userProperties);
 };
 /**
  * Retrieves the current user identity.
@@ -214,7 +226,7 @@ var identity = function (userId, userProperties) {
  * ```
  */
 var identityGet = function () {
-    return $screeb("identity.get");
+    return callScreebCommand("identity.get");
 };
 /**
  * Assigns the current user to a group.
@@ -246,7 +258,9 @@ var identityGet = function () {
  * );
  * ```
  */
-var identityGroupAssign = function (groupName, groupType, groupProperties) { return $screeb("identity.group.assign", groupType, groupName, groupProperties); };
+var identityGroupAssign = function (groupName, groupType, groupProperties) {
+    return callScreebCommand("identity.group.assign", groupType, groupName, groupProperties);
+};
 /**
  * Unassigns the current user to a group.
  *
@@ -261,7 +275,7 @@ var identityGroupAssign = function (groupName, groupType, groupProperties) { ret
  * ```
  */
 var identityGroupUnassign = function (groupName, groupType) {
-    return $screeb("identity.group.unassign", groupType, groupName);
+    return callScreebCommand("identity.group.unassign", groupType, groupName);
 };
 /**
  * Adds properties to the current user identity.
@@ -299,7 +313,7 @@ var identityGroupUnassign = function (groupName, groupType) {
  * ```
  */
 var identityProperties = function (userProperties) {
-    return $screeb("identity.properties", userProperties);
+    return callScreebCommand("identity.properties", userProperties);
 };
 /**
  * Resets the current user identity.
@@ -312,7 +326,7 @@ var identityProperties = function (userProperties) {
  * Screeb.identityReset();
  * ```
  */
-var identityReset = function () { return $screeb("identity.reset"); };
+var identityReset = function () { return callScreebCommand("identity.reset"); };
 /**
  * Interrupts a running survey.
  *
@@ -323,7 +337,7 @@ var identityReset = function () { return $screeb("identity.reset"); };
  * Screeb.surveyClose();
  * ```
  */
-var surveyClose = function () { return $screeb("survey.close"); };
+var surveyClose = function () { return callScreebCommand("survey.close"); };
 /**
  * Starts a survey by its ID.
  *
@@ -344,7 +358,7 @@ var surveyClose = function () { return $screeb("survey.close"); };
 var surveyStart = function (surveyId, allowMultipleResponses, hiddenFields) {
     if (allowMultipleResponses === void 0) { allowMultipleResponses = true; }
     if (hiddenFields === void 0) { hiddenFields = {}; }
-    return $screeb("survey.start", surveyId, {
+    return callScreebCommand("survey.start", surveyId, {
         allow_multiple_responses: allowMultipleResponses,
         hidden_fields: hiddenFields,
     });
@@ -359,7 +373,7 @@ var surveyStart = function (surveyId, allowMultipleResponses, hiddenFields) {
  * Screeb.targetingCheck();
  * ```
  */
-var targetingCheck = function () { return $screeb("targeting.check"); };
+var targetingCheck = function () { return callScreebCommand("targeting.check"); };
 /**
  * Prints the current state of the targeting engine.
  *
@@ -384,6 +398,6 @@ var targetingCheck = function () { return $screeb("targeting.check"); };
  * //   - Rule of type "Capping per respondent display count": false 🔴
  * ```
  */
-var targetingDebug = function () { return $screeb("targeting.debug"); };
+var targetingDebug = function () { return callScreebCommand("targeting.debug"); };
 
 export { close, debug, eventTrack, identity, identityGet, identityGroupAssign, identityGroupUnassign, identityProperties, identityReset, init, isLoaded, load, surveyClose, surveyStart, targetingCheck, targetingDebug };

package/docs/README.md

@@ -8,6 +8,7 @@
 
 - [PropertyRecord](README.md#propertyrecord)
 - [PropertyType](README.md#propertytype)
+- [ScreebIdentityGetReturn](README.md#screebidentitygetreturn)
 - [ScreebObject](README.md#screebobject)
 - [ScreebOptions](README.md#screeboptions)
 
@@ -52,10 +53,32 @@ This is property types that are supported by Screeb.
 
 ___
 
+### ScreebIdentityGetReturn
+
+Ƭ **ScreebIdentityGetReturn**: `Object`
+
+This is the object returned by the function `identityGet()`.
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `anonymous_id` | `string` | Anonymous id given to each user |
+| `channel_id` | `string` | The current channel id with which the tag was initialized |
+| `is_ready` | `boolean` | `true` if the tag us loaded, initialized and ready to rock |
+| `session_end` | `string` | The current user session end time |
+| `session_id` | `string` | The current user session id |
+| `session_start` | `string` | The current user session start time |
+| `user_id` | `string` | The authenticated id assigned to the user. |
+
+___
+
 ### ScreebObject
 
 Ƭ **ScreebObject**: `ScreebFunction` & { `q?`: `unknown`[][]  }
 
+This is the Screeb object publicly exposed in browser `window`.
+
 ___
 
 ### ScreebOptions
@@ -209,7 +232,7 @@ ___
 
 ### identityGet
 
-▸ **identityGet**(): `Promise`<`ScreebIdentityGetReturn`\>
+▸ **identityGet**(): `Promise`<[`ScreebIdentityGetReturn`](README.md#screebidentitygetreturn)\>
 
 Retrieves the current user identity.
 
@@ -232,7 +255,7 @@ console.log(await Screeb.identityGet());
 
 #### Returns
 
-`Promise`<`ScreebIdentityGetReturn`\>
+`Promise`<[`ScreebIdentityGetReturn`](README.md#screebidentitygetreturn)\>
 
 ___
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-browser",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "Screeb's browser sdk.",
   "keywords": [
     "product discovery",
@@ -14,7 +14,7 @@
   "homepage": "https://screeb.app",
   "bugs": {
     "url": "https://github.com/ScreebApp/sdk-js/issues",
-    "email": "suuport@screeb.app"
+    "email": "support@screeb.app"
   },
   "repository": {
     "type": "git",
@@ -46,12 +46,12 @@
     "test": "jest"
   },
   "devDependencies": {
-    "@screeb/eslint-config": "^0.1.2",
-    "@screeb/typescript-config": "^0.1.2",
+    "@screeb/eslint-config": "^0.1.5",
+    "@screeb/typescript-config": "^0.1.5",
     "@types/jest": "^29.5.1",
     "@types/node": "^18.16.3",
-    "@typescript-eslint/eslint-plugin": "^5.59.2",
-    "eslint": "^8.39.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.6",
+    "eslint": "^8.41.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-jsx-a11y": "^6.7.1",
@@ -59,9 +59,9 @@
     "jest": "^29.5.0",
     "jest-environment-jsdom": "^29.5.0",
     "prettier": "^2.8.8",
-    "rollup": "^3.21.4",
+    "rollup": "^3.23.0",
     "ts-jest": "^29.1.0",
-    "typedoc": "^0.24.6",
+    "typedoc": "^0.24.7",
     "typedoc-plugin-markdown": "^3.15.3"
   },
   "publishConfig": {