@screeb/sdk-browser - npm Package Compare versions

Comparing version 0.1.17 to 0.1.18

dist/cjs/index.d.ts

@@ -319,2 +319,36 @@ import { Hooks, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "./types";
 /**
+ * Interrupts a running message.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageClose();
+ * ```
+ */
+export declare const messageClose: () => void | Promise<unknown>;
+/**
+ * Starts a message by its ID.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageStart(
+ *   '<UUID>',
+ *   false,
+ *   {
+ *     color: "green",
+ *     article_id: 42
+ *   },
+ *   {
+ *     version: "1.0.0",
+ *     onMessageShowed: (payload) => console.log("Message showed", payload),
+ *   },
+ *   "en"
+ * );
+ * ```
+ */
+export declare const messageStart: (messageId: string, hiddenFields?: PropertyRecord, hooks?: Hooks, language?: string) => void | Promise<unknown>;
+/**
  * Forces a targeting check.
@@ -321,0 +355,0 @@ *

dist/es/index.d.ts

@@ -319,2 +319,36 @@ import { Hooks, PropertyRecord, ScreebIdentityGetReturn, ScreebOptions } from "./types";
 /**
+ * Interrupts a running message.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageClose();
+ * ```
+ */
+export declare const messageClose: () => void | Promise<unknown>;
+/**
+ * Starts a message by its ID.
+ *
+ * @example
+ * ```ts
+ * import * as Screeb from "@screeb/sdk-browser";
+ *
+ * Screeb.messageStart(
+ *   '<UUID>',
+ *   false,
+ *   {
+ *     color: "green",
+ *     article_id: 42
+ *   },
+ *   {
+ *     version: "1.0.0",
+ *     onMessageShowed: (payload) => console.log("Message showed", payload),
+ *   },
+ *   "en"
+ * );
+ * ```
+ */
+export declare const messageStart: (messageId: string, hiddenFields?: PropertyRecord, hooks?: Hooks, language?: string) => void | Promise<unknown>;
+/**
  * Forces a targeting check.
@@ -321,0 +355,0 @@ *

docs/README.md

@@ -49,2 +49,4 @@ @screeb/sdk-browser
 - [load](README.md#load)
+- [messageClose](README.md#messageclose)
+- [messageStart](README.md#messagestart)
 - [surveyClose](README.md#surveyclose)
@@ -797,2 +799,63 @@ - [surveyStart](README.md#surveystart)
 
+### messageClose
+
+▸ **messageClose**(): `void` \| `Promise`\<`unknown`\>
+
+Interrupts a running message.
+
+#### Returns
+
+`void` \| `Promise`\<`unknown`\>
+
+**`Example`**
+
+```ts
+import * as Screeb from "@screeb/sdk-browser";
+
+Screeb.messageClose();
+```
+
+___
+
+### messageStart
+
+▸ **messageStart**(`messageId`, `hiddenFields?`, `hooks?`, `language?`): `void` \| `Promise`\<`unknown`\>
+
+Starts a message by its ID.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageId` | `string` |
+| `hiddenFields` | [`PropertyRecord`](README.md#propertyrecord) |
+| `hooks?` | [`Hooks`](README.md#hooks) |
+| `language?` | `string` |
+
+#### Returns
+
+`void` \| `Promise`\<`unknown`\>
+
+**`Example`**
+
+```ts
+import * as Screeb from "@screeb/sdk-browser";
+
+Screeb.messageStart(
+  '<UUID>',
+  false,
+  {
+    color: "green",
+    article_id: 42
+  },
+  {
+    version: "1.0.0",
+    onMessageShowed: (payload) => console.log("Message showed", payload),
+  },
+  "en"
+);
+```
+
+___
+
 ### surveyClose
@@ -799,0 +862,0 @@

package.json

 {
   "name": "@screeb/sdk-browser",
-  "version": "0.1.17",
+  "version": "0.1.18",
   "description": "Screeb's browser sdk.",
@@ -5,0 +5,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

89226

increased by0.26%

Lines of code

2098

increased by7.81%

Worsened metrics

Number of package files

12

decreased by-7.69%

No dependency changes