oneentry 1.0.118 → 1.0.119

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +45 -41
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2893,25 +2893,6 @@ Example with a simple type attribute "text"
2893
2893
 
2894
2894
  ---
2895
2895
 
2896
- Example with a simple type attribute "text"
2897
-
2898
- ```json
2899
- {
2900
- "marker": "about",
2901
- "type": "text",
2902
- "value": {
2903
- "htmlValue": "<p>Hello world</p>",
2904
- "plainValue": "",
2905
- "params": {
2906
- "isEditorDisabled": false,
2907
- "isImageCompressed": true
2908
- }
2909
- }
2910
- }
2911
- ```
2912
-
2913
- ---
2914
-
2915
2896
  Example with a simple type attribute "textWithHeader"
2916
2897
 
2917
2898
  ```json
@@ -3003,14 +2984,34 @@ Example with attribute type "entity" (nested list)
3003
2984
  {
3004
2985
  "marker": "entity-marker",
3005
2986
  "type": "entity",
2987
+ "value": [25, 32, 24]
2988
+ }
2989
+ ]
2990
+ }
2991
+ }
2992
+ ```
2993
+
2994
+ Value - numerical identifiers for pages and string identifiers for products.
2995
+ Identifiers for products should include the prefix 'p-', for example, 'p-1-', 'p-2-', etc.
2996
+ p-[parentId]-[productId]
2997
+
2998
+ ---
2999
+
3000
+ Example with attribute type "timeInterval"
3001
+
3002
+ ```json
3003
+ {
3004
+ "formIdentifier": "reg",
3005
+ "formData": {
3006
+ "en_US": [
3007
+ {
3008
+ "marker": "interval",
3009
+ "type": "timeInterval",
3006
3010
  "value": [
3007
- {
3008
- "id": 1,
3009
- "title": "red",
3010
- "value": "1",
3011
- "parentId": null,
3012
- "depth": 0,
3013
- }
3011
+ [
3012
+ "2025-02-11T16:00:00:000Z",
3013
+ "2025-02-13T16:00:00:000Z",
3014
+ ]
3014
3015
  ]
3015
3016
  }
3016
3017
  ]
@@ -3018,11 +3019,22 @@ Example with attribute type "entity" (nested list)
3018
3019
  }
3019
3020
  ```
3020
3021
 
3022
+ value — array of interval arrays in ISO 8601 format.
3023
+ for example 2025-02-11T16:00:00:000Z
3024
+
3025
+ 2025 — year;
3026
+ 02 — month;
3027
+ 11 — day of the month;
3028
+ T — separator between date and time;
3029
+ 16:00:00 — time in hours:minutes:seconds format;
3030
+ 000Z — milliseconds and time zone indication.
3031
+ Z means that the time is specified in UTC format.
3032
+
3021
3033
  ---
3022
3034
 
3023
3035
  ### FormData.getFormsData(langCode, offset, limit)
3024
3036
 
3025
- Creating an object of form data saving information
3037
+ Searching for all form data
3026
3038
 
3027
3039
  ```js
3028
3040
  const value = await FormData.getFormsData()
@@ -3099,7 +3111,7 @@ Example return:
3099
3111
 
3100
3112
  ### FormData.postFormsData(data, langCode)
3101
3113
 
3102
- Searching for all form data
3114
+ Creating an object of form data saving information
3103
3115
 
3104
3116
  ```js
3105
3117
  const body = {
@@ -3121,14 +3133,6 @@ const value = await FormData.postFormsData(body)
3121
3133
  ><details>
3122
3134
  ><summary>Schema (body)</summary>
3123
3135
  >
3124
- <!-- >**id:** number <br>
3125
- >*Data object identifier* <br>
3126
- >example: 1764 <br>
3127
- >
3128
- >**time:** Date <br>
3129
- >*Form modification date and time* <br>
3130
- >example: 2023-02-12 10:56 <br> -->
3131
- >
3132
3136
  >**formIdentifier:** string <br>
3133
3137
  >*Text identifier of the form object (marker)* <br>
3134
3138
  >example: my-form <br>
@@ -4792,7 +4796,7 @@ const value = await Pages.getRootPages()
4792
4796
  ><br>
4793
4797
  ></details>
4794
4798
 
4795
- This method retrieves all top-level page objects from the API. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data. Get required language parameter.
4799
+ This method retrieves all top-level page objects from the API. It returns a Promise that resolves to an array of top-level page objects or an empty array [] if there is no data.
4796
4800
 
4797
4801
  Example return:
4798
4802
 
@@ -4918,7 +4922,7 @@ const value = await Pages.getPages();
4918
4922
  ><br>
4919
4923
  ></details>
4920
4924
 
4921
- This method retrieves all created pages as an array from the API. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data. Get required language parameter.
4925
+ This method retrieves all created pages as an array from the API. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data.
4922
4926
 
4923
4927
  Example return:
4924
4928
 
@@ -5050,7 +5054,7 @@ const value = await Pages.getPageById(1);
5050
5054
  ><br>
5051
5055
  ></details>
5052
5056
 
5053
- This method retrieves a single page object based on its identifier (id) from the API. It returns a Promise that resolves to the page object, with the specific DTO depending on the type of page being returned. Get required language parameter.
5057
+ This method retrieves a single page object based on its identifier (id) from the API. It returns a Promise that resolves to the page object, with the specific DTO depending on the type of page being returned.
5054
5058
 
5055
5059
  Example return:
5056
5060
 
@@ -5166,7 +5170,7 @@ const value = await Pages.getPageByUrl('shop');
5166
5170
  ><br>
5167
5171
  ></details>
5168
5172
 
5169
- This method retrieves a single page object based on its URL (url) from the API. It returns a Promise that resolves to the page object, with the specific DTO depending on the type of page being returned. Get required language parameter.
5173
+ This method retrieves a single page object based on its URL (url) from the API. It returns a Promise that resolves to the page object, with the specific DTO depending on the type of page being returned.
5170
5174
 
5171
5175
  Example return:
5172
5176
 
@@ -5652,7 +5656,7 @@ const value = await Pages.searchPage('cup')
5652
5656
  ><br>
5653
5657
  ></details>
5654
5658
 
5655
- This method performs a quick search for page objects based on a text query (name). It returns a Promise that resolves to a ContentIndexedPageDto objects or an empty array []. Get required language parameter.
5659
+ This method performs a quick search for page objects based on a text query (name). It returns a Promise that resolves to a ContentIndexedPageDto objects or an empty array [].
5656
5660
 
5657
5661
  Example return:
5658
5662
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "oneentry",
3
- "version": "1.0.118",
3
+ "version": "1.0.119",
4
4
  "description": "OneEntry NPM package",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",