@screeb/sdk-react 0.1.1 → 0.1.3

package/dist/es/index.js

@@ -16,20 +16,9 @@ LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
-/* global Reflect, Promise */
+/* global Reflect, Promise, SuppressedError, Symbol */
 
 
-var __assign = function() {
-    __assign = Object.assign || function __assign(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-
 function __rest(s, e) {
     var t = {};
     for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
@@ -78,7 +67,12 @@ function __generator(thisArg, body) {
         } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
-}
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
 
 var ScreebContext = React.createContext(undefined);
 
@@ -113,7 +107,7 @@ var isSSR = typeof window === "undefined";
 
 var isInitialized = false;
 var ScreebProvider = function (_a) {
-    var websiteId = _a.websiteId, userId = _a.userId, userProperties = _a.userProperties, children = _a.children, _b = _a.shouldLoad, shouldLoad = _b === void 0 ? !isSSR : _b, _c = _a.autoInit, autoInit = _c === void 0 ? false : _c, options = _a.options, rest = __rest(_a, ["websiteId", "userId", "userProperties", "children", "shouldLoad", "autoInit", "options"]);
+    var websiteId = _a.websiteId, userId = _a.userId, userProperties = _a.userProperties, hooks = _a.hooks, children = _a.children, _b = _a.shouldLoad, shouldLoad = _b === void 0 ? !isSSR : _b, _c = _a.autoInit, autoInit = _c === void 0 ? false : _c, options = _a.options, rest = __rest(_a, ["websiteId", "userId", "userProperties", "hooks", "children", "shouldLoad", "autoInit", "options"]);
     var isLoaded = React.useRef(Screeb.isLoaded());
     // Allow data-x attributes, see https://github.com/devrnt/react-use-screeb/issues/478
     var invalidPropKeys = Object.keys(rest).filter(function (key) { return !key.startsWith("data-"); });
@@ -230,12 +224,12 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var init = React.useCallback(function (websiteId, userId, userProperties) { return __awaiter(void 0, void 0, void 0, function () {
+    var init = React.useCallback(function (websiteId, userId, userProperties, hooks) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("init", function () {
                         if (!isInitialized) {
-                            Screeb.init(websiteId, userId, userProperties);
+                            Screeb.init(websiteId, userId, userProperties, hooks);
                             isInitialized = true;
                         }
                     }, true)];
@@ -254,7 +248,7 @@ var ScreebProvider = function (_a) {
                     isLoaded.current = true;
                     if (!autoInit) return [3 /*break*/, 3];
                     if (!websiteId) return [3 /*break*/, 2];
-                    return [4 /*yield*/, init(websiteId, userId, userProperties)];
+                    return [4 /*yield*/, init(websiteId, userId, userProperties, hooks)];
                 case 1:
                     _a.sent();
                     return [3 /*break*/, 3];
@@ -271,11 +265,11 @@ var ScreebProvider = function (_a) {
             case 1: return [2 /*return*/, _a.sent()];
         }
     }); }); }, []);
-    var surveyStart = React.useCallback(function (surveyId, allowMultipleResponses, hiddenFields) { return __awaiter(void 0, void 0, void 0, function () {
+    var surveyStart = React.useCallback(function (surveyId, allowMultipleResponses, hiddenFields, hooks) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, ensureScreeb("surveyStart", function () {
-                        return Screeb.surveyStart(surveyId, allowMultipleResponses, hiddenFields);
+                        return Screeb.surveyStart(surveyId, allowMultipleResponses, hiddenFields, hooks);
                     })];
                 case 1: return [2 /*return*/, _a.sent()];
             }
@@ -329,7 +323,7 @@ var ScreebProvider = function (_a) {
     if (!isSSR && shouldLoad) {
         load(options);
     }
-    return (jsx(ScreebContext.Provider, __assign({ value: providerValue }, { children: children })));
+    return (jsx(ScreebContext.Provider, { value: providerValue, children: children }));
 };
 var useScreebContext = function () {
     var context = React.useContext(ScreebContext);

package/dist/es/types.d.ts

@@ -1,4 +1,4 @@
-import { PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "@screeb/sdk-browser";
+import { Hooks, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "@screeb/sdk-browser";
 /** Properties of Screeb provider */
 export type ScreebProps = {
     /** Your website/channel id. */
@@ -7,6 +7,8 @@ export type ScreebProps = {
     userId?: string;
     /** The properties of your user. */
     userProperties?: PropertyRecord;
+    /** Hooks to define callback for various event */
+    hooks?: Hooks;
 };
 /**
  * Shutdowns current Screeb session.

package/docs/README.md

@@ -42,6 +42,10 @@
 
 Shutdowns current Screeb session.
 
+##### Returns
+
+`Promise`<`void`\>
+
 **`Example`**
 
 ```ts
@@ -50,10 +54,6 @@ const { close } = useScreeb();
 close();
 ```
 
-##### Returns
-
-`Promise`<`void`\>
-
 ___
 
 ### DebugFunction
@@ -66,6 +66,10 @@ ___
 
 Prints the actual state information of Screeb tag.
 
+##### Returns
+
+`Promise`<`unknown`\>
+
 **`Example`**
 
 ```ts
@@ -91,10 +95,6 @@ debug();
 // **************************************************************
 ```
 
-##### Returns
-
-`Promise`<`unknown`\>
-
 ___
 
 ### EventTrackFunction
@@ -107,6 +107,17 @@ ___
 
 Tracks a user event.
 
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `eventName` | `string` | The event name. |
+| `eventProperties?` | `PropertyRecord` | The properties of your event. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
+
+##### Returns
+
+`Promise`<`unknown`\>
+
 **`Example`**
 
 ```ts
@@ -128,17 +139,6 @@ eventTrack(
 );
 ```
 
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `eventName` | `string` | The event name. |
-| `eventProperties?` | `PropertyRecord` | The properties of your event. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
-
-##### Returns
-
-`Promise`<`unknown`\>
-
 ___
 
 ### IdentityFunction
@@ -152,6 +152,17 @@ ___
 Change the current user identity.
 Warning: Running surveys will be closed.
 
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `userId` | `string` | The unique identifier of your user. |
+| `userProperties?` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
+
+##### Returns
+
+`Promise`<`unknown`\>
+
 **`Example`**
 
 ```ts
@@ -169,17 +180,6 @@ identity(
 );
 ```
 
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `userId` | `string` | The unique identifier of your user. |
-| `userProperties?` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
-
-##### Returns
-
-`Promise`<`unknown`\>
-
 ___
 
 ### IdentityGetFunction
@@ -192,6 +192,10 @@ ___
 
 Retrieves the current user identity.
 
+##### Returns
+
+`Promise`<`ScreebIdentityGetReturn`\>
+
 **`Example`**
 
 ```ts
@@ -209,10 +213,6 @@ console.log(await identityGet());
 // }
 ```
 
-##### Returns
-
-`Promise`<`ScreebIdentityGetReturn`\>
-
 ___
 
 ### IdentityGroupAssignFunction
@@ -225,6 +225,18 @@ ___
 
 Assigns the current user to a group.
 
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `groupName` | `string` |  |
+| `groupType?` | `string` |  |
+| `groupProperties?` | `PropertyRecord` | The properties of your user group. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
+
+##### Returns
+
+`Promise`<`unknown`\>
+
 **`Example`**
 
 ```ts
@@ -244,18 +256,6 @@ identityGroupAssign(
 );
 ```
 
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `groupName` | `string` |  |
-| `groupType?` | `string` |  |
-| `groupProperties?` | `PropertyRecord` | The properties of your user group. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
-
-##### Returns
-
-`Promise`<`unknown`\>
-
 ___
 
 ### IdentityGroupUnassignFunction
@@ -268,14 +268,6 @@ ___
 
 Unassigns the current user to a group.
 
-**`Example`**
-
-```ts
-const { identityGroupUnassign } = useScreeb();
-
-identityGroupUnassign('company', 'Apple');
-```
-
 ##### Parameters
 
 | Name | Type | Description |
@@ -287,6 +279,14 @@ identityGroupUnassign('company', 'Apple');
 
 `Promise`<`unknown`\>
 
+**`Example`**
+
+```ts
+const { identityGroupUnassign } = useScreeb();
+
+identityGroupUnassign('company', 'Apple');
+```
+
 ___
 
 ### IdentityPropertiesFunction
@@ -299,6 +299,16 @@ ___
 
 Adds properties to the current user identity.
 
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `userProperties` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
+
+##### Returns
+
+`Promise`<`unknown`\>
+
 **`Example`**
 
 ```ts
@@ -325,16 +335,6 @@ identityProperties(
 );
 ```
 
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `userProperties` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
-
-##### Returns
-
-`Promise`<`unknown`\>
-
 ___
 
 ### IdentityResetFunction
@@ -348,6 +348,10 @@ ___
 Resets the current user identity.
 Warning: This command must be called only once, since it creates a new identity on Screeb side.
 
+##### Returns
+
+`Promise`<`unknown`\>
+
 **`Example`**
 
 ```ts
@@ -356,10 +360,6 @@ const { identityReset } = useScreeb();
 identityReset();
 ```
 
-##### Returns
-
-`Promise`<`unknown`\>
-
 ___
 
 ### InitFunction
@@ -372,6 +372,18 @@ ___
 
 Initializes Screeb tag.
 
+##### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `websiteId` | `string` | Your website/channel id. |
+| `userId?` | `string` | The unique identifier of your user. |
+| `userProperties?` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date ``` |
+
+##### Returns
+
+`Promise`<`void`\>
+
 **`Example`**
 
 ```ts
@@ -390,18 +402,6 @@ init(
 );
 ```
 
-##### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `websiteId` | `string` | Your website/channel id. |
-| `userId?` | `string` | The unique identifier of your user. |
-| `userProperties?` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date ``` |
-
-##### Returns
-
-`Promise`<`void`\>
-
 ___
 
 ### LoadFunction
@@ -414,14 +414,6 @@ ___
 
 Appends Screeb tag into your dom.
 
-**`Example`**
-
-```ts
-const { load } = useScreeb();
-
-load();
-```
-
 ##### Parameters
 
 | Name | Type | Description |
@@ -432,6 +424,14 @@ load();
 
 `Promise`<`void`\>
 
+**`Example`**
+
+```ts
+const { load } = useScreeb();
+
+load();
+```
+
 ___
 
 ### ScreebContextValues
@@ -472,6 +472,7 @@ Properties of Screeb provider
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
+| `hooks?` | `Hooks` | Hooks to define callback for various event |
 | `userId?` | `string` | The unique identifier of your user. |
 | `userProperties?` | `PropertyRecord` | The properties of your user. |
 | `websiteId` | `string` | Your website/channel id. |
@@ -496,6 +497,10 @@ ___
 
 Interrupts a running survey.
 
+##### Returns
+
+`Promise`<`unknown`\>
+
 **`Example`**
 
 ```ts
@@ -504,10 +509,6 @@ const { surveyClose } = useScreeb();
 surveyClose();
 ```
 
-##### Returns
-
-`Promise`<`unknown`\>
-
 ___
 
 ### SurveyStartFunction
@@ -520,6 +521,18 @@ ___
 
 Starts a survey by its ID.
 
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `surveyId` | `string` |
+| `allowMultipleResponses` | `boolean` |
+| `hiddenFields` | `PropertyRecord` |
+
+##### Returns
+
+`Promise`<`unknown`\>
+
 **`Example`**
 
 ```ts
@@ -535,18 +548,6 @@ surveyStart(
 );
 ```
 
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `surveyId` | `string` |
-| `allowMultipleResponses` | `boolean` |
-| `hiddenFields` | `PropertyRecord` |
-
-##### Returns
-
-`Promise`<`unknown`\>
-
 ___
 
 ### TargetingCheckFunction
@@ -559,6 +560,10 @@ ___
 
 Forces a targeting check.
 
+##### Returns
+
+`Promise`<`unknown`\>
+
 **`Example`**
 
 ```ts
@@ -567,10 +572,6 @@ const { targetingCheck } = useScreeb();
 targetingCheck();
 ```
 
-##### Returns
-
-`Promise`<`unknown`\>
-
 ___
 
 ### TargetingDebugFunction
@@ -583,6 +584,10 @@ ___
 
 Prints the current state of the targeting engine.
 
+##### Returns
+
+`Promise`<`unknown`\>
+
 **`Example`**
 
 ```ts
@@ -605,15 +610,11 @@ console.log(await targetingDebug());
 //   - Rule of type "Capping per respondent display count": false 🔴
 ```
 
-##### Returns
-
-`Promise`<`unknown`\>
-
 ## Functions
 
 ### ScreebProvider
 
-▸ **ScreebProvider**(`props`, `context?`): ``null`` \| `ReactElement`<`any`, `any`\>
+▸ **ScreebProvider**(`props`, `context?`): `ReactNode`
 
 #### Parameters
 
@@ -624,7 +625,7 @@ console.log(await targetingDebug());
 
 #### Returns
 
-``null`` \| `ReactElement`<`any`, `any`\>
+`ReactNode`
 
 ___
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-react",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Screeb's browser sdk, optimized for React.",
   "keywords": [
     "product discovery",
@@ -39,36 +39,36 @@
     "README.md"
   ],
   "scripts": {
-    "build": "rollup -c ./node_modules/@screeb/typescript-config/src/rollup.config.js",
+    "build": "rollup -c ../../node_modules/@screeb/typescript-config/src/rollup.config.js",
     "build:doc": "typedoc src/index.ts",
     "clean": "rm -Rf dist",
     "lint": "eslint .",
     "test": "echo '@TODO'"
   },
   "dependencies": {
-    "@screeb/sdk-browser": "^0.1.8"
+    "@screeb/sdk-browser": "^0.1.10"
   },
   "devDependencies": {
-    "@screeb/eslint-config": "^0.1.5",
+    "@screeb/eslint-config": "^0.1.6",
     "@screeb/sdk-browser": "^0.1.6",
-    "@screeb/typescript-config": "^0.1.5",
-    "@types/jest": "^29.5.1",
-    "@types/node": "^18.11.19",
-    "@types/react": "^18.0.20",
-    "@types/react-dom": "^18.0.6",
-    "@typescript-eslint/eslint-plugin": "^5.59.6",
-    "eslint": "^8.41.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.1",
+    "@screeb/typescript-config": "^0.1.6",
+    "@types/jest": "^29.5.5",
+    "@types/node": "^20.8.4",
+    "@types/react": "^18.2.28",
+    "@types/react-dom": "^18.2.13",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "eslint": "^8.51.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jest": "^27.4.2",
     "eslint-plugin-jsx-a11y": "^6.7.1",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^29.5.0",
-    "prettier": "^2.8.8",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "rollup": "^3.23.0",
-    "typedoc": "^0.24.7",
-    "typedoc-plugin-markdown": "^3.15.3"
+    "eslint-plugin-prettier": "^5.0.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.0.3",
+    "react": ">=18.2.0",
+    "react-dom": ">=18.2.0",
+    "rollup": "^4.0.2",
+    "typedoc": "^0.25.2",
+    "typedoc-plugin-markdown": "^3.16.0"
   },
   "peerDependencies": {
     "react": ">=16.8.0",