@screeb/sdk-react 0.2.0 → 0.2.2

package/dist/cjs/index.cjs

@@ -394,4 +394,4 @@ var useScreeb = function () {
 
 exports.ScreebProvider = ScreebProvider;
 exports.useScreeb = useScreeb;
-CONSTANTS.version = '0.2.0'
+CONSTANTS.version = '0.2.2'

package/dist/cjs/types.d.ts

@@ -1,4 +1,4 @@
-import { Hooks, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "@screeb/sdk-browser";
+import { HooksInit, HooksMessageStart, HooksSurveyStart, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "@screeb/sdk-browser";
 /** Properties of Screeb provider */
 export type ScreebProps = {
     /** Your website/channel id. */
@@ -8,7 +8,7 @@ export type ScreebProps = {
     /** The properties of your user. */
     userProperties?: PropertyRecord;
     /** Hooks to define callback for various event */
-    hooks?: Hooks;
+    hooks?: HooksInit;
     /** The language you want to force */
     language?: string;
 };
@@ -256,7 +256,7 @@ export type IdentityResetFunction = () => Promise<unknown>;
  * );
  * ```
  */
-export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: Hooks, language?: string) => Promise<void>;
+export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: HooksInit, language?: string) => Promise<void>;
 /**
  * Appends Screeb tag into your dom.
  *
@@ -301,7 +301,7 @@ export type SurveyCloseFunction = () => Promise<unknown>;
  * );
  * ```
  */
-export type SurveyStartFunction = (surveyId: string, distributionId: string, allowMultipleResponses: boolean, hiddenFields: PropertyRecord, hooks?: Hooks, language?: string) => Promise<unknown>;
+export type SurveyStartFunction = (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string) => Promise<unknown>;
 /**
  * Interrupts a running message.
  *
@@ -330,7 +330,7 @@ export type MessageCloseFunction = () => Promise<unknown>;
  * );
  * ```
  */
-export type MessageStartFunction = (messageId: string, hiddenFields: PropertyRecord, hooks?: Hooks, language?: string) => Promise<unknown>;
+export type MessageStartFunction = (messageId: string, hiddenFields: PropertyRecord, hooks?: HooksMessageStart, language?: string) => Promise<unknown>;
 /**
  * Forces a targeting check.
  *

package/dist/es/index.mjs

@@ -371,4 +371,4 @@ var useScreeb = function () {
 };
 
 export { ScreebProvider, useScreeb };
-CONSTANTS.version = '0.2.0'
+CONSTANTS.version = '0.2.2'

package/dist/es/types.d.ts

@@ -1,4 +1,4 @@
-import { Hooks, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "@screeb/sdk-browser";
+import { HooksInit, HooksMessageStart, HooksSurveyStart, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "@screeb/sdk-browser";
 /** Properties of Screeb provider */
 export type ScreebProps = {
     /** Your website/channel id. */
@@ -8,7 +8,7 @@ export type ScreebProps = {
     /** The properties of your user. */
     userProperties?: PropertyRecord;
     /** Hooks to define callback for various event */
-    hooks?: Hooks;
+    hooks?: HooksInit;
     /** The language you want to force */
     language?: string;
 };
@@ -256,7 +256,7 @@ export type IdentityResetFunction = () => Promise<unknown>;
  * );
  * ```
  */
-export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: Hooks, language?: string) => Promise<void>;
+export type InitFunction = (websiteId: string, userId?: string, userProperties?: PropertyRecord, hooks?: HooksInit, language?: string) => Promise<void>;
 /**
  * Appends Screeb tag into your dom.
  *
@@ -301,7 +301,7 @@ export type SurveyCloseFunction = () => Promise<unknown>;
  * );
  * ```
  */
-export type SurveyStartFunction = (surveyId: string, distributionId: string, allowMultipleResponses: boolean, hiddenFields: PropertyRecord, hooks?: Hooks, language?: string) => Promise<unknown>;
+export type SurveyStartFunction = (surveyId: string, distributionId?: string, allowMultipleResponses?: boolean, hiddenFields?: PropertyRecord, hooks?: HooksSurveyStart, language?: string) => Promise<unknown>;
 /**
  * Interrupts a running message.
  *
@@ -330,7 +330,7 @@ export type MessageCloseFunction = () => Promise<unknown>;
  * );
  * ```
  */
-export type MessageStartFunction = (messageId: string, hiddenFields: PropertyRecord, hooks?: Hooks, language?: string) => Promise<unknown>;
+export type MessageStartFunction = (messageId: string, hiddenFields: PropertyRecord, hooks?: HooksMessageStart, language?: string) => Promise<unknown>;
 /**
  * Forces a targeting check.
  *

package/docs/README.md

@@ -366,7 +366,7 @@ ___
 
 ### InitFunction
 
-Ƭ **InitFunction**: (`websiteId`: `string`, `userId?`: `string`, `userProperties?`: `PropertyRecord`, `hooks?`: `Hooks`, `language?`: `string`) => `Promise`\<`void`\>
+Ƭ **InitFunction**: (`websiteId`: `string`, `userId?`: `string`, `userProperties?`: `PropertyRecord`, `hooks?`: `HooksInit`, `language?`: `string`) => `Promise`\<`void`\>
 
 Initializes Screeb tag.
 
@@ -400,7 +400,7 @@ init(
 | `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 ``` |
-| `hooks?` | `Hooks` | - |
+| `hooks?` | `HooksInit` | - |
 | `language?` | `string` | Force a specific language for the tag. eg: 'en'. default: browser language. |
 
 ##### Returns
@@ -465,7 +465,7 @@ ___
 
 ### MessageStartFunction
 
-Ƭ **MessageStartFunction**: (`messageId`: `string`, `hiddenFields`: `PropertyRecord`, `hooks?`: `Hooks`, `language?`: `string`) => `Promise`\<`unknown`\>
+Ƭ **MessageStartFunction**: (`messageId`: `string`, `hiddenFields`: `PropertyRecord`, `hooks?`: `HooksMessageStart`, `language?`: `string`) => `Promise`\<`unknown`\>
 
 Starts a message by its ID.
 
@@ -494,7 +494,7 @@ messageStart(
 | :------ | :------ |
 | `messageId` | `string` |
 | `hiddenFields` | `PropertyRecord` |
-| `hooks?` | `Hooks` |
+| `hooks?` | `HooksMessageStart` |
 | `language?` | `string` |
 
 ##### Returns
@@ -543,7 +543,7 @@ Properties of Screeb provider
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `hooks?` | `Hooks` | Hooks to define callback for various event |
+| `hooks?` | `HooksInit` | Hooks to define callback for various event |
 | `language?` | `string` | The language you want to force |
 | `userId?` | `string` | The unique identifier of your user. |
 | `userProperties?` | `PropertyRecord` | The properties of your user. |
@@ -585,7 +585,7 @@ ___
 
 ### SurveyStartFunction
 
-Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `distributionId`: `string`, `allowMultipleResponses`: `boolean`, `hiddenFields`: `PropertyRecord`, `hooks?`: `Hooks`, `language?`: `string`) => `Promise`\<`unknown`\>
+Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `distributionId?`: `string`, `allowMultipleResponses?`: `boolean`, `hiddenFields?`: `PropertyRecord`, `hooks?`: `HooksSurveyStart`, `language?`: `string`) => `Promise`\<`unknown`\>
 
 Starts a survey by its ID.
 
@@ -607,17 +607,17 @@ surveyStart(
 
 #### Type declaration
 
-▸ (`surveyId`, `distributionId`, `allowMultipleResponses`, `hiddenFields`, `hooks?`, `language?`): `Promise`\<`unknown`\>
+▸ (`surveyId`, `distributionId?`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`): `Promise`\<`unknown`\>
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `surveyId` | `string` |
-| `distributionId` | `string` |
-| `allowMultipleResponses` | `boolean` |
-| `hiddenFields` | `PropertyRecord` |
-| `hooks?` | `Hooks` |
+| `distributionId?` | `string` |
+| `allowMultipleResponses?` | `boolean` |
+| `hiddenFields?` | `PropertyRecord` |
+| `hooks?` | `HooksSurveyStart` |
 | `language?` | `string` |
 
 ##### Returns

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-react",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Screeb's browser sdk, optimized for React.",
   "keywords": [
     "product discovery",
@@ -41,11 +41,10 @@
     "test": "echo '@TODO'"
   },
   "dependencies": {
-    "@screeb/sdk-browser": "^0.2.0"
+    "@screeb/sdk-browser": "^0.2.2"
   },
   "devDependencies": {
     "@screeb/eslint-config": "^0.1.6",
-    "@screeb/sdk-browser": "^0.1.6",
     "@screeb/typescript-config": "^0.1.10",
     "@types/jest": "^29.5.5",
     "@types/node": "^20.8.4",