oneentry 1.0.93 → 1.0.95

package/README.md

@@ -6138,7 +6138,7 @@ You can subscribe to events via the WebSocket to receive notifications
 const { WS } = defineOneEntry('your-url');
 ```
 
-## WS.connect()
+### WS.connect()
 
 This method creates and return an instance of an object Socket.io with a connection.
 This method requires mandatory user authorization.
@@ -6148,3 +6148,107 @@ const socket = await WS.connect()
 
 socket.on('my_event', callback)
 ```
+
+When the attributes change (if the user is subscribed to the corresponding event and the Websocket option is active in the event)
+The "attributes" field always contains event attributes (the "events" field), and depending on the selected type of event for the catalog or form, the fields with the attributes "product" contain product attributes, and "user" contains fields from the user form, respectively. For a product, there is an additional field "title" (product name as a string), and for registration and code submission forms, there are additional fields "code" and "email."
+
+The attribute value is stored in the format *key - marker*, *value - {type, identifier, value}*.
+
+Example: 
+
+```json
+{
+    "message": "Message",
+    "attributes": {
+      "company": {
+        "identifier": "company",
+        "type": "string",
+        "value": "OneEntry"
+      }
+    }
+}
+```
+
+
+
+><details>
+><summary >Schema</summary>
+>
+>**message**	string <br>
+>*Text message* <br>
+>example: Message <br>
+>
+>**attributes:**	Record<string, any> <br>
+>*Сontains event attributes* <br>
+>example: { { "company": { "identifier": "company", "type": "string", "value": "OneEntry" } }<br>
+>
+></details>
+
+
+Product Example:
+
+```json
+{
+  "product": {
+    "id": 10,
+    "info": {
+      "title": "Pink Planet",
+    },
+    "status": {
+      "identifier": "available",
+      "info": {
+        "title": "ADD TO CART"
+      }
+    },
+    "attributes": {
+      "currency": {
+        "identifier": "currency",
+        "type": "string",
+        "value": "USD"
+      }
+    }
+  }
+}
+```
+
+
+User Example:
+
+```json
+{
+  "user": {
+    "notificationData": {...},
+    "attributes": {...}
+  },
+  "order": {
+    "id": 1,
+    "attributes": {...}
+  }
+}
+```
+
+
+Order Example:
+
+```json
+{
+  "user": {
+    "notificationData": {...},
+    "attributes": {...}
+  },
+  "order": {
+    "id": 1,
+    "attributes": {...}
+  }
+}
+```
+
+
+Form  Example:
+
+```json
+{
+  "email": "string",
+  "formData": {...}
+}
+```

package/dist/events/eventsApi.d.ts

@@ -13,18 +13,18 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * Subscribing to an event on a product.
      *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @param marker - Event marker.
-     * @param langCode - Language code.
-     * @param productId - Product id.
+     * @param {string} marker - Event marker.
+     * @param {number} langCode - Language code.
+     * @param {string} productId - Product id.
      */
     subscribeByMarker(marker: string, productId: number, langCode?: string): Promise<any | IError>;
     /**
      * Unsubscribing to an event on a product.
      *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @param marker - Event marker.
-     * @param langCode - Language code.
-     * @param productId - Product id.
+     * @param {string} marker - Event marker.
+     * @param {number} langCode - Language code.
+     * @param {string} productId - Product id.
      */
     unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<any | IError>;
 }

package/dist/events/eventsApi.js

@@ -13,9 +13,9 @@ class EventsApi extends asyncModules_1.default {
      * Subscribing to an event on a product.
      *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @param marker - Event marker.
-     * @param langCode - Language code.
-     * @param productId - Product id.
+     * @param {string} marker - Event marker.
+     * @param {number} langCode - Language code.
+     * @param {string} productId - Product id.
      */
     async subscribeByMarker(marker, productId, langCode = this.state.lang) {
         const result = await this._fetchPost(`/subscribe/marker/${marker}`, {
@@ -28,9 +28,9 @@ class EventsApi extends asyncModules_1.default {
      * Unsubscribing to an event on a product.
      *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @param marker - Event marker.
-     * @param langCode - Language code.
-     * @param productId - Product id.
+     * @param {string} marker - Event marker.
+     * @param {number} langCode - Language code.
+     * @param {string} productId - Product id.
      */
     async unsubscribeByMarker(marker, productId, langCode = this.state.lang) {
         const result = await this._fetchDelete(`/unsubscribe/marker/${marker}`, {

package/dist/users/usersInterfaces.d.ts

@@ -32,7 +32,7 @@ interface IUserBody {
         marker: string;
         value: string;
     }>;
-    formData: IAuthFormData | Array<IAuthFormData>;
+    formData?: IAuthFormData | Array<IAuthFormData>;
     notificationData: {
         email: string;
         phonePush: Array<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.93",
+  "version": "1.0.95",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",