@screeb/sdk-react 0.1.12 → 0.1.14

package/dist/cjs/index.cjs

@@ -309,6 +309,22 @@ var ScreebProvider = function (_a) {
             }
         });
     }); }, []);
+    var messageClose = React__namespace.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, ensureScreeb("messageClose", function () { return Screeb__namespace.messageClose(); })];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    }); }); }, []);
+    var messageStart = React__namespace.useCallback(function (messageId, hiddenFields, hooks, language) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, ensureScreeb("messageStart", function () {
+                        return Screeb__namespace.messageStart(messageId, hiddenFields, hooks, language);
+                    })];
+                case 1: return [2 /*return*/, _a.sent()];
+            }
+        });
+    }); }, []);
     var targetingCheck = React__namespace.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
         switch (_a.label) {
             case 0: return [4 /*yield*/, ensureScreeb("targetingCheck", function () { return Screeb__namespace.targetingCheck(); })];
@@ -335,6 +351,8 @@ var ScreebProvider = function (_a) {
         load: load,
         surveyClose: surveyClose,
         surveyStart: surveyStart,
+        messageClose: messageClose,
+        messageStart: messageStart,
         targetingCheck: targetingCheck,
         targetingDebug: targetingDebug,
     }); }, [
@@ -351,6 +369,8 @@ var ScreebProvider = function (_a) {
         load,
         surveyClose,
         surveyStart,
+        messageClose,
+        messageStart,
         targetingCheck,
         targetingDebug,
     ]);
@@ -374,4 +394,4 @@ var useScreeb = function () {
 
 exports.ScreebProvider = ScreebProvider;
 exports.useScreeb = useScreeb;
-CONSTANTS.version = '0.1.12'
+CONSTANTS.version = '0.1.14'

package/dist/cjs/types.d.ts

@@ -301,6 +301,35 @@ export type SurveyCloseFunction = () => Promise<unknown>;
  * ```
  */
 export type SurveyStartFunction = (surveyId: string, allowMultipleResponses: boolean, hiddenFields: PropertyRecord, hooks?: Hooks, language?: string) => Promise<unknown>;
+/**
+ * Interrupts a running message.
+ *
+ * @example
+ * ```ts
+ * const { messageClose } = useScreeb();
+ *
+ * messageClose();
+ * ```
+ */
+export type MessageCloseFunction = () => Promise<unknown>;
+/**
+ * Starts a message by its ID.
+ *
+ * @example
+ * ```ts
+ * const { messageStart } = useScreeb();
+ *
+ * messageStart(
+ *   '<UUID>',
+ *   false,
+ *   {
+ *     color: "green",
+ *     article_id: 42
+ *   }
+ * );
+ * ```
+ */
+export type MessageStartFunction = (messageId: string, hiddenFields: PropertyRecord, hooks?: Hooks, language?: string) => Promise<unknown>;
 /**
  * Forces a targeting check.
  *
@@ -352,6 +381,8 @@ export type ScreebContextValues = {
     load: LoadFunction;
     surveyClose: SurveyCloseFunction;
     surveyStart: SurveyStartFunction;
+    messageClose: MessageCloseFunction;
+    messageStart: MessageStartFunction;
     targetingCheck: TargetingCheckFunction;
     targetingDebug: TargetingDebugFunction;
 };

package/dist/es/index.mjs

@@ -287,6 +287,22 @@ var ScreebProvider = function (_a) {
             }
         });
     }); }, []);
+    var messageClose = React.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, ensureScreeb("messageClose", function () { return Screeb.messageClose(); })];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    }); }); }, []);
+    var messageStart = React.useCallback(function (messageId, hiddenFields, hooks, language) { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, ensureScreeb("messageStart", function () {
+                        return Screeb.messageStart(messageId, hiddenFields, hooks, language);
+                    })];
+                case 1: return [2 /*return*/, _a.sent()];
+            }
+        });
+    }); }, []);
     var targetingCheck = React.useCallback(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
         switch (_a.label) {
             case 0: return [4 /*yield*/, ensureScreeb("targetingCheck", function () { return Screeb.targetingCheck(); })];
@@ -313,6 +329,8 @@ var ScreebProvider = function (_a) {
         load: load,
         surveyClose: surveyClose,
         surveyStart: surveyStart,
+        messageClose: messageClose,
+        messageStart: messageStart,
         targetingCheck: targetingCheck,
         targetingDebug: targetingDebug,
     }); }, [
@@ -329,6 +347,8 @@ var ScreebProvider = function (_a) {
         load,
         surveyClose,
         surveyStart,
+        messageClose,
+        messageStart,
         targetingCheck,
         targetingDebug,
     ]);
@@ -351,4 +371,4 @@ var useScreeb = function () {
 };
 
 export { ScreebProvider, useScreeb };
-CONSTANTS.version = '0.1.12'
+CONSTANTS.version = '0.1.14'

package/dist/es/types.d.ts

@@ -301,6 +301,35 @@ export type SurveyCloseFunction = () => Promise<unknown>;
  * ```
  */
 export type SurveyStartFunction = (surveyId: string, allowMultipleResponses: boolean, hiddenFields: PropertyRecord, hooks?: Hooks, language?: string) => Promise<unknown>;
+/**
+ * Interrupts a running message.
+ *
+ * @example
+ * ```ts
+ * const { messageClose } = useScreeb();
+ *
+ * messageClose();
+ * ```
+ */
+export type MessageCloseFunction = () => Promise<unknown>;
+/**
+ * Starts a message by its ID.
+ *
+ * @example
+ * ```ts
+ * const { messageStart } = useScreeb();
+ *
+ * messageStart(
+ *   '<UUID>',
+ *   false,
+ *   {
+ *     color: "green",
+ *     article_id: 42
+ *   }
+ * );
+ * ```
+ */
+export type MessageStartFunction = (messageId: string, hiddenFields: PropertyRecord, hooks?: Hooks, language?: string) => Promise<unknown>;
 /**
  * Forces a targeting check.
  *
@@ -352,6 +381,8 @@ export type ScreebContextValues = {
     load: LoadFunction;
     surveyClose: SurveyCloseFunction;
     surveyStart: SurveyStartFunction;
+    messageClose: MessageCloseFunction;
+    messageStart: MessageStartFunction;
     targetingCheck: TargetingCheckFunction;
     targetingDebug: TargetingDebugFunction;
 };

package/docs/README.md

@@ -17,6 +17,8 @@
 - [IdentityResetFunction](README.md#identityresetfunction)
 - [InitFunction](README.md#initfunction)
 - [LoadFunction](README.md#loadfunction)
+- [MessageCloseFunction](README.md#messageclosefunction)
+- [MessageStartFunction](README.md#messagestartfunction)
 - [ScreebContextValues](README.md#screebcontextvalues)
 - [ScreebProps](README.md#screebprops)
 - [ScreebProviderProps](README.md#screebproviderprops)
@@ -437,6 +439,70 @@ load();
 
 ___
 
+### MessageCloseFunction
+
+Ƭ **MessageCloseFunction**: () => `Promise`\<`unknown`\>
+
+Interrupts a running message.
+
+**`Example`**
+
+```ts
+const { messageClose } = useScreeb();
+
+messageClose();
+```
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### MessageStartFunction
+
+Ƭ **MessageStartFunction**: (`messageId`: `string`, `hiddenFields`: `PropertyRecord`, `hooks?`: `Hooks`, `language?`: `string`) => `Promise`\<`unknown`\>
+
+Starts a message by its ID.
+
+**`Example`**
+
+```ts
+const { messageStart } = useScreeb();
+
+messageStart(
+  '<UUID>',
+  false,
+  {
+    color: "green",
+    article_id: 42
+  }
+);
+```
+
+#### Type declaration
+
+▸ (`messageId`, `hiddenFields`, `hooks?`, `language?`): `Promise`\<`unknown`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageId` | `string` |
+| `hiddenFields` | `PropertyRecord` |
+| `hooks?` | `Hooks` |
+| `language?` | `string` |
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
 ### ScreebContextValues
 
 Ƭ **ScreebContextValues**: `Object`
@@ -458,6 +524,8 @@ Screeb context API
 | `identityReset` | [`IdentityResetFunction`](README.md#identityresetfunction) |
 | `init` | [`InitFunction`](README.md#initfunction) |
 | `load` | [`LoadFunction`](README.md#loadfunction) |
+| `messageClose` | [`MessageCloseFunction`](README.md#messageclosefunction) |
+| `messageStart` | [`MessageStartFunction`](README.md#messagestartfunction) |
 | `surveyClose` | [`SurveyCloseFunction`](README.md#surveyclosefunction) |
 | `surveyStart` | [`SurveyStartFunction`](README.md#surveystartfunction) |
 | `targetingCheck` | [`TargetingCheckFunction`](README.md#targetingcheckfunction) |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/sdk-react",
-  "version": "0.1.12",
+  "version": "0.1.14",
   "description": "Screeb's browser sdk, optimized for React.",
   "keywords": [
     "product discovery",
@@ -41,7 +41,7 @@
     "test": "echo '@TODO'"
   },
   "dependencies": {
-    "@screeb/sdk-browser": "^0.1.17"
+    "@screeb/sdk-browser": "^0.1.18"
   },
   "devDependencies": {
     "@screeb/eslint-config": "^0.1.6",