oneentry 1.0.104 → 1.0.105

package/README.md

@@ -476,11 +476,422 @@ Example return:
 const { AuthProvider } = defineOneEntry('your-url');
 ```
 
-### AuthProvider.signUp(marker, data, langCode)
+### AuthProvider.signUp(marker, body, langCode)
+
+>
+> Method accept the body as a parameter.
+>
+
+Examples for body parameter with different types data:
+
+Example with attributes of simple types formData "string", "integer", "float".
+
+```json
+{
+  "formIdentifier": "reg",
+  "langCode": "en_US",
+  "authData": [
+    {
+      "marker": "login",
+      "value": "test"
+    },
+    {
+      "marker": "password",
+      "value": "12345"
+    }
+  ],
+  "formData": {
+    "en_US": [
+      {
+        "marker": "last_name",
+        "type": "string",
+        "value": "Fyodor Ivanov"
+      }
+    ]
+  },
+  "notificationData": {
+    "email": "test@test.zone",
+    "phonePush": [],
+    "phoneSMS": "+79991234567"
+  }
+}
+```
+
+Example with attributes of types "date", "dateTime", "time"
+
+```json
+{
+  "formIdentifier": "reg",
+  "langCode": "en_US",
+  "authData": [
+    {
+      "marker": "login",
+      "value": "test"
+    },
+    {
+      "marker": "password",
+      "value": "12345"
+    }
+  ],
+  "formData": {
+    "en_US": [
+      {
+        "marker": "birthday",
+        "type": "date",
+        "value": {
+          "fullDate": "2024-05-07T21:02:00.000Z",
+          "formattedValue": "08-05-2024 00:02",
+          "formatString": "DD-MM-YYYY HH:mm"
+        }
+      }
+    ]
+  },
+  "notificationData": {
+    "email": "test@test.zone",
+    "phonePush": [],
+    "phoneSMS": "+79991234567"
+  }
+}
+```
+
+Example with attribute of type "text"
+
+```json
+{
+  "formIdentifier": "reg",
+  "langCode": "en_US",
+  "authData": [
+    {
+      "marker": "login",
+      "value": "test"
+    },
+    {
+      "marker": "password",
+      "value": "12345"
+    }
+  ],
+  "formData": {
+    "en_US": [
+      {
+        "marker": "about",
+        "type": "text",
+        "value": {
+          "htmlValue": "<p>This is me</p>",
+          "plainValue": "",
+          "params": {
+            "isEditorDisabled": false,
+            "isImageCompressed": true
+          }
+        }
+      }
+    ]
+  },
+  "notificationData": {
+    "email": "test@test.zone",
+    "phonePush": [],
+    "phoneSMS": "+79991234567"
+  }
+}
+```
+
+Example with attribute type "textWithHeader"
+
+```json
+{
+  "formIdentifier": "reg",
+  "langCode": "en_US",
+  "authData": [
+    {
+      "marker": "login",
+      "value": "test"
+    },
+    {
+      "marker": "password",
+      "value": "12345"
+    }
+  ],
+  "formData": {
+    "en_US": [
+      {
+        "marker": "about",
+        "type": "textWithHeader",
+        "value": {
+          "header": "Header",
+          "htmlValue": "<p>This is me</p>",
+          "plainValue": "",
+          "params": {
+            "isEditorDisabled": false,
+            "isImageCompressed": true
+          }
+        }
+      }
+    ]
+  },
+  "notificationData": {
+    "email": "test@test.zone",
+    "phonePush": [],
+    "phoneSMS": "+79991234567"
+  }
+}
+```
+
+Example with attributes type "image" and "groupOfImages"
+
+```json
+{
+  "formIdentifier": "reg",
+  "langCode": "en_US",
+  "authData": [
+    {
+      "marker": "login",
+      "value": "test"
+    },
+    {
+      "marker": "password",
+      "value": "12345"
+    }
+  ],
+  "formData": {
+    "en_US": [
+      {
+        "marker": "avatar",
+        "type": "image",
+        "value": [
+          {
+            "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+            "downloadLink": "http://my-site.zone/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+            "size": 392585,
+            "previewLink": "",
+            "params": {
+              "isImageCompressed": true
+            }
+          }
+        ]
+      }
+    ]
+  },
+  "notificationData": {
+    "email": "test@test.zone",
+    "phonePush": [],
+    "phoneSMS": "+79991234567"
+  }
+}
+```
+
+Example with attribute type "file"
+
+```json
+{
+  "formIdentifier": "reg",
+  "langCode": "en_US",
+  "authData": [
+    {
+      "marker": "login",
+      "value": "test"
+    },
+    {
+      "marker": "password",
+      "value": "12345"
+    }
+  ],
+  "formData": {
+    "en_US": [
+      {
+        "marker": "picture",
+        "type": "file",
+        "value": [
+          {
+            "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+            "downloadLink": "http://my-site.zone/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
+            "size": 392585
+          }
+        ]
+      }
+    ]
+  },
+  "notificationData": {
+    "email": "test@test.zone",
+    "phonePush": [],
+    "phoneSMS": "+79991234567"
+  }
+}
+```
+
+Example with attributes type "radioButton" and "list"
+
+```json
+{
+  "formIdentifier": "reg",
+  "langCode": "en_US",
+  "authData": [
+    {
+      "marker": "login",
+      "value": "test"
+    },
+    {
+      "marker": "password",
+      "value": "12345"
+    }
+  ],
+  "formData": {
+    "en_US": [
+      {
+        "marker": "selector",
+        "type": "list",
+        "value": [
+          {
+            "title": "red",
+            "value": "1",
+            "extended": {
+              "value": "red",
+              "type": "string"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  "notificationData": {
+    "email": "test@test.zone",
+    "phonePush": [],
+    "phoneSMS": "+79991234567"
+  }
+}
+```
+
+Example with attribute type "entity" (nested list)
+
+```json
+{
+  "formIdentifier": "reg",
+  "langCode": "en_US",
+  "authData": [
+    {
+      "marker": "login",
+      "value": "test"
+    },
+    {
+      "marker": "password",
+      "value": "12345"
+    }
+  ],
+  "formData": {
+    "en_US": [
+      {
+        "marker": "entity-selector",
+        "type": "entity",
+        "value": [
+          {
+            "id": "1",
+            "title": "red",
+            "value": "1",
+            "parentId": "null"
+          }
+        ]
+      }
+    ]
+  },
+  "notificationData": {
+    "email": "test@test.zone",
+    "phonePush": [],
+    "phoneSMS": "+79991234567"
+  }
+}
+```
+
+Example with one push identifier
+
+```json
+{
+  "formIdentifier": "reg",
+  "langCode": "en_US",
+  "authData": [
+    {
+      "marker": "login",
+      "value": "test"
+    },
+    {
+      "marker": "password",
+      "value": "12345"
+    }
+  ],
+  "formData": {
+    "en_US": [
+      {
+        "marker": "selector",
+        "type": "list",
+        "value": [
+          {
+            "title": "red",
+            "value": "1",
+            "extended": {
+              "value": "red",
+              "type": "string"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  "notificationData": {
+    "email": "test@test.zone",
+    "phonePush": [
+      "7DD987F846400079F4B03C058365A4869047B4A0."
+    ],
+    "phoneSMS": "+79991234567"
+  }
+}
+```
+
+Example with multiple push identifiers
+
+```json
+{
+  "formIdentifier": "reg",
+  "langCode": "en_US",
+  "authData": [
+    {
+      "marker": "login",
+      "value": "test"
+    },
+    {
+      "marker": "password",
+      "value": "12345"
+    }
+  ],
+  "formData": {
+    "en_US": [
+      {
+        "marker": "selector",
+        "type": "list",
+        "value": [
+          {
+            "title": "red",
+            "value": "1",
+            "extended": {
+              "value": "red",
+              "type": "string"
+            }
+          }
+        ]
+      }
+    ]
+  },
+  "notificationData": {
+    "email": "test@test.zone",
+    "phonePush": [
+      "7DD987F846400079F4B03C058365A4869047B4A0",
+      "7DD987F846400079F4B03C058365A4869047B4A0",
+      "7DD987F846400079F4B03C058365A4869047B4A0."
+    ],
+    "phoneSMS": "+79991234567"
+  }
+}
+```
 
 ```js
 
-const data = {
+const body = {
   "formIdentifier": "reg",
   "authData": [
     {
@@ -506,7 +917,7 @@ const data = {
   }
 }
 
-const value = await AuthProvider.signUp('email', data)
+const value = await AuthProvider.signUp('email', body)
 ```
 
 ><details>
@@ -678,16 +1089,16 @@ true
 
 ```js
 const data = {
-    authData: [
-        {
-            marker: "login",
-            value: "example@oneentry.cloud"
-        },
-        {
-            marker: "password",
-            value: "12345"
-        }
-    ]
+  authData: [
+    {
+      marker: "login",
+      value: "example@oneentry.cloud"
+    },
+    {
+      marker: "password",
+      value: "12345"
+    }
+  ]
 }
 
 const value = await AuthProvider.auth('email', data)
@@ -1593,6 +2004,7 @@ Example with a simple type attribute "date", "dateTime", "time"
 ```
 
 ---
+
 Example with a simple type attribute "text"
 
 ```json
@@ -1611,6 +2023,7 @@ Example with a simple type attribute "text"
 ```
 
 ---
+
 Example with a simple type attribute "text"
 
 ```json
@@ -1629,6 +2042,7 @@ Example with a simple type attribute "text"
 ```
 
 ---
+
 Example with a simple type attribute "textWithHeader"
 
 ```json
@@ -1648,6 +2062,7 @@ Example with a simple type attribute "textWithHeader"
 ```
 
 ---
+
 Example with a simple type attribute "image" or "groupOfImages"
 
 ```json
@@ -1669,6 +2084,7 @@ Example with a simple type attribute "image" or "groupOfImages"
 ```
 
 ---
+
 Example with a simple type attribute "files"
 
 ```json
@@ -1686,6 +2102,7 @@ Example with a simple type attribute "files"
 ```
 
 ---
+
 Example with a simple type attribute "radioButton" or "list"
 
 ```json
@@ -1705,6 +2122,33 @@ Example with a simple type attribute "radioButton" or "list"
 }
 ```
 
+---
+
+Example with attribute type "entity" (nested list)
+
+```json
+{
+  "formIdentifier": "reg",
+  "formData": {
+    "en_US": [
+      {
+        "marker": "entity-marker",
+        "type": "entity",
+        "value": [
+          {
+            "id": 1,
+            "title": "red",
+            "value": "1",
+            "parentId": null,
+            "depth": 0,
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
 ### FormData.postFormsData(data, langCode)
 
 ```js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.104",
+  "version": "1.0.105",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",