oneentry 1.0.62 → 1.0.63

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.
package/README.md CHANGED
@@ -33,7 +33,6 @@ const {
33
33
  FileUploading,
34
34
  GeneralTypes,
35
35
  Locales,
36
- Markers,
37
36
  Menus,
38
37
  Pages,
39
38
  Products,
@@ -82,7 +81,6 @@ Now you can use the following links to jump to specific entries:
82
81
  - [FileUploading](#fileuploading)
83
82
  - [GeneralTypes](#generaltypes)
84
83
  - [Locales](#locales)
85
- - [Markers](#markers)
86
84
  - [Menus](#menus)
87
85
  - [Orders](#orders)
88
86
  - [Pages](#pages)
@@ -331,6 +329,421 @@ example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extende
331
329
  ---
332
330
 
333
331
 
332
+ ## <h2 id="blocks"> User Auth Provider </h2>
333
+
334
+ ```js
335
+ const { AuthProvider } = defineOneEntry('your-url');
336
+ ```
337
+
338
+ ### AuthProvider.signUp(marker, data, langCode)
339
+
340
+
341
+ ```js
342
+
343
+ const data = {
344
+ "formIdentifier": "reg",
345
+ "authData": [
346
+ {
347
+ "marker": "login",
348
+ "value": "test"
349
+ },
350
+ {
351
+ "marker": "password",
352
+ "value": "12345"
353
+ }
354
+ ],
355
+ "formData": [
356
+ {
357
+ "marker": "last_name",
358
+ "type": "string",
359
+ "value": "Username"
360
+ }
361
+ ],
362
+ "notificationData": {
363
+ "email": "test@test.com",
364
+ "phonePush": "",
365
+ "phoneSMS": "+99999999999"
366
+ }
367
+ }
368
+
369
+ const value = await AuthProvider.getBlocks('en_US', 0, 30)
370
+ ```
371
+
372
+ > This method will register a new user. Returns the registered user's object.
373
+
374
+ Example return:
375
+
376
+ ```json
377
+ {
378
+ "id": 1764,
379
+ "updatedDate": "2024-05-23T12:43:00.169Z",
380
+ "version": 10,
381
+ "identifier": "catalog",
382
+ "isActive": false,
383
+ "authProviderId": 1,
384
+ "formData": {
385
+ "en_US": [
386
+ {
387
+ "marker": "login",
388
+ "value": "test"
389
+ },
390
+ {
391
+ "marker": "f-name",
392
+ "value": "Second name"
393
+ }
394
+ ]
395
+ },
396
+ "notificationData": {
397
+ "email": "test@test.com",
398
+ "phonePush": "",
399
+ "phoneSMS": "+9999999999"
400
+ },
401
+ "systemCode": {
402
+ "value": "90ВDCX",
403
+ "expiredDate": "2024-05-07T21:02:00.000Z"
404
+ }
405
+ }
406
+ ```
407
+
408
+ <details>
409
+ <summary>Schema</summary>
410
+
411
+ **id:** number <br>
412
+ *object identifier*
413
+ example: 1764 <br>
414
+
415
+ **updatedDate:** string <br>
416
+ *object modification date* <br>
417
+
418
+ **version:** number <br>
419
+ *object version number* <br>
420
+ example: 10 <br>
421
+
422
+ **identifier:** string <br>
423
+ *textual identifier for the field record* <br>
424
+ example: catalog <br>
425
+ default: marker <br>
426
+
427
+ **attributeSetId:** number <br>
428
+ *identifier for the used attribute set* <br>
429
+ example: 7 <br>
430
+
431
+ **formData:** FormDataLangType <br>
432
+ *Data submitted by the form* <br>
433
+ example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] } <br>
434
+
435
+ **notificationData:** UserNotificationDataType <br>
436
+ *data for notifying the user* <br>
437
+ example: OrderedMap { "email": "test@test.ru", "phonePush": "", "phoneSMS": "+79991234567" } <br>
438
+
439
+ **systemCode:** string <br>
440
+ *system code for performing official actions (password reset, activation)* <br>
441
+ example: OrderedMap { "value": "90ВDCX", "expiredDate": "2024-05-07T21:02:00.000Z" } <br>
442
+
443
+ **formIdentifier:** string <br>
444
+ *the text identifier of the authorization provider's form* <br>
445
+ example: reg_form <br>
446
+
447
+ **authData:** FormAuthDataType <br>
448
+ *authorization data taken from the form linked to the authorization provider* <br>
449
+ example: List [ OrderedMap { "marker": "login", "value": "test" }, OrderedMap { "marker": "password", "value": "12345" } ] <br>
450
+
451
+ **authProviderId:** number <br>
452
+ *ID of the authorization provider* <br>
453
+ example: 1 <br>
454
+
455
+ </details>
456
+
457
+
458
+ ### AuthProvider.generateCode(marker, userIdentifier)
459
+
460
+
461
+ ```js
462
+ const value = await AuthProvider.generateCode('email', 'test@trer.com')
463
+ ```
464
+
465
+ > This method receives a code to activate the user. Returns the object with the code.
466
+
467
+ Example return:
468
+
469
+ ```json
470
+ {
471
+ "code": "90ВDCX",
472
+ "expiredDate": "2024-05-07T21:02:00.000Z"
473
+ }
474
+ ```
475
+
476
+ <details>
477
+ <summary>Schema</summary>
478
+
479
+ **code:** string <br>
480
+ *code for performing official actions (password reset, activation)*
481
+ example: 90ВDCX <br>
482
+
483
+ **expiredDate:** string <br>
484
+ *object modification date* <br>
485
+
486
+ **expiredDate:** string <br>
487
+ *the time and date until which the code is valid* <br>
488
+ example: 2024-05-07T21:02:00.000Z <br>
489
+ </details>
490
+
491
+
492
+ ### AuthProvider.activateUser(marker, userIdentifier, code)
493
+
494
+ ```js
495
+ const value = await AuthProvider.activateUser('email', 'test@trer.com', 'WTGC9E')
496
+ ```
497
+
498
+ > This method activates the user by code. If successful, it will return true.
499
+
500
+ Example return:
501
+
502
+ ```json
503
+ true
504
+ ```
505
+
506
+ ### AuthProvider.auth(marker, login, password)
507
+
508
+ ```js
509
+ const value = await AuthProvider.auth('email', 'test@trer.com', '123456')
510
+ ```
511
+
512
+ > This method performs user authorization. Returns an object with a set of tokens.
513
+
514
+ Example return:
515
+
516
+ ```json
517
+ {
518
+ "userIdentifier": "test@test.ru",
519
+ "authProviderIdentifier": "email",
520
+ "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MywiYXV0aFByb3ZpZGVySWRlbnRpZmllciI6ImVtYWlsIiwidXNlcklkZW50aWZpZXIiOiJ0ZXN0QHRlc3QucnUiLCJ1c2VyQWdlbnQiOiJQb3N0bWFuUnVudGltZS83LjM3LjMiLCJpYXQiOjE3MTQ1NTc2NzAsImV4cCI6MTcxNDU2MTI3MH0.vm74Ha-S37462CAF3QiDpO9b0OhlJFNDMKq4eEyoaB8",
521
+ "refreshToken": "1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9"
522
+ }
523
+ ```
524
+ <details>
525
+ <summary>Schema</summary>
526
+
527
+ **userIdentifier:** string <br>
528
+ *user identifier*
529
+ example: test@test.ru <br>
530
+
531
+ **authProviderIdentifier:** string <br>
532
+ *auth provider identifier* <br>
533
+ example: email <br>
534
+
535
+ **accessToken:** string <br>
536
+ *access token* <br>
537
+ example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MywiYXV0aFByb3ZpZGVySWRlbnRpZmllciI6ImVtYWlsIiwidXNlcklkZW50aWZpZXIiOiJ0ZXN0QHRlc3QucnUiLCJ1c2VyQWdlbnQiOiJQb3N0bWFuUnVudGltZS83LjM3LjMiLCJpYXQiOjE3MTQ1NTc2NzAsImV4cCI6MTcxNDU2MTI3MH0.vm74Ha-S37462CAF3QiDpO9b0OhlJFNDMKq4eEyoaB8 <br>
538
+
539
+ **refreshToken:** string <br>
540
+ *refresh token* <br>
541
+ example: 1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9 <br>
542
+
543
+ </details>
544
+
545
+
546
+ ### AuthProvider.refresh(marker, token)
547
+
548
+ ```js
549
+ const value = await AuthProvider.refresh('email', '1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9')
550
+ ```
551
+
552
+ > This method updates the user's token. Returns an object with a set of tokens.
553
+
554
+ Example return:
555
+
556
+ ```json
557
+ {
558
+ "userIdentifier": "test@test.ru",
559
+ "authProviderIdentifier": "email",
560
+ "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MywiYXV0aFByb3ZpZGVySWRlbnRpZmllciI6ImVtYWlsIiwidXNlcklkZW50aWZpZXIiOiJ0ZXN0QHRlc3QucnUiLCJ1c2VyQWdlbnQiOiJQb3N0bWFuUnVudGltZS83LjM3LjMiLCJpYXQiOjE3MTQ1NTc2NzAsImV4cCI6MTcxNDU2MTI3MH0.vm74Ha-S37462CAF3QiDpO9b0OhlJFNDMKq4eEyoaB8",
561
+ "refreshToken": "1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9"
562
+ }
563
+ ```
564
+ <details>
565
+ <summary>Schema</summary>
566
+
567
+ **userIdentifier:** string <br>
568
+ *user identifier*
569
+ example: test@test.ru <br>
570
+
571
+ **authProviderIdentifier:** string <br>
572
+ *auth provider identifier* <br>
573
+ example: email <br>
574
+
575
+ **accessToken:** string <br>
576
+ *access token* <br>
577
+ example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MywiYXV0aFByb3ZpZGVySWRlbnRpZmllciI6ImVtYWlsIiwidXNlcklkZW50aWZpZXIiOiJ0ZXN0QHRlc3QucnUiLCJ1c2VyQWdlbnQiOiJQb3N0bWFuUnVudGltZS83LjM3LjMiLCJpYXQiOjE3MTQ1NTc2NzAsImV4cCI6MTcxNDU2MTI3MH0.vm74Ha-S37462CAF3QiDpO9b0OhlJFNDMKq4eEyoaB8 <br>
578
+
579
+ **refreshToken:** string <br>
580
+ *refresh token* <br>
581
+ example: 1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9 <br>
582
+
583
+ </details>
584
+
585
+
586
+ ### AuthProvider.logout(marker, token)
587
+
588
+ ```js
589
+ const value = await AuthProvider.logout('email', '1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9')
590
+ ```
591
+
592
+ > This method performs a user logout. If successful, it will return true.
593
+
594
+ Example return:
595
+
596
+ ```json
597
+ true
598
+ ```
599
+
600
+ ### AuthProvider.changePassword(marker, userIdentifier, code, newPassword, repeatPassword)
601
+
602
+ ```js
603
+ const value = await AuthProvider.changePassword('email', 'test@test.com', 'EW32RF', 654321, 654321)
604
+ ```
605
+
606
+ > This method changes the password of an authorized user. If successful, it will return true.
607
+
608
+ Example return:
609
+
610
+ ```json
611
+ true
612
+ ```
613
+
614
+
615
+ ### AuthProvider.getAuthProviders(langCode, offset, limit)
616
+
617
+ ```js
618
+ const value = await AuthProvider.getAuthProviders()
619
+ ```
620
+
621
+ > This method gets all the objects of the authorization providers.
622
+
623
+ Example return:
624
+
625
+ ```json
626
+ [
627
+ {
628
+ "id": 1764,
629
+ "localizeInfos": {
630
+ "title": "My block"
631
+ },
632
+ "version": 10,
633
+ "identifier": "catalog",
634
+ "isActive": false,
635
+ "isCheckCode": false,
636
+ "type": "email",
637
+ "formIdentifier": null
638
+ }
639
+ ]
640
+ ```
641
+ <details>
642
+ <summary>Schema</summary>
643
+
644
+ **id:** number <br>
645
+ *object identifier*
646
+ example: 1764 <br>
647
+
648
+ **localizeInfos:** CommonLocalizeInfos <br>
649
+ *block name with localization* <br>
650
+ example: OrderedMap { "en_US": OrderedMap { "title": "My block" } } <br>
651
+
652
+ **version:** number <br>
653
+ *object version number* <br>
654
+ example: 10 <br>
655
+
656
+ **identifier:** string <br>
657
+ *textual identifier for the field record* <br>
658
+ example: catalog <br>
659
+ default: marker <br>
660
+
661
+ **isActive:** boolean <br>
662
+ *Flag of usage* <br>
663
+ example: false <br>
664
+
665
+ **isCheckCode:** boolean <br>
666
+ *a sign of user activation via a code* <br>
667
+ example: false <br>
668
+
669
+ **type:** string <br>
670
+ *type of providere* <br>
671
+ example: email <br>
672
+
673
+ **formIdentifier:** string <br>
674
+ *the marker of the form used by the provider (may be null)* <br>
675
+ example: email <br>
676
+
677
+ </details>
678
+
679
+
680
+ ### AuthProvider.getMarker(marker, langCode)
681
+
682
+ ```js
683
+ const value = await AuthProvider.getMarker('email')
684
+ ```
685
+
686
+ > Getting a single token authorization provider object.
687
+
688
+ Example return:
689
+
690
+ ```json
691
+ {
692
+ "id": 1764,
693
+ "localizeInfos": {
694
+ "en_US": {
695
+ "title": "My block"
696
+ }
697
+ },
698
+ "version": 10,
699
+ "identifier": "catalog",
700
+ "isActive": false,
701
+ "isCheckCode": false,
702
+ "type": "email",
703
+ "formIdentifier": null
704
+ }
705
+ ```
706
+ <details>
707
+ <summary>Schema</summary>
708
+
709
+ **id:** number <br>
710
+ *object identifier*
711
+ example: 1764 <br>
712
+
713
+ **localizeInfos:** CommonLocalizeInfos <br>
714
+ *block name with localization* <br>
715
+ example: OrderedMap { "en_US": OrderedMap { "title": "My block" } } <br>
716
+
717
+ **version:** number <br>
718
+ *object version number* <br>
719
+ example: 10 <br>
720
+
721
+ **identifier:** string <br>
722
+ *textual identifier for the field record* <br>
723
+ example: catalog <br>
724
+ default: marker <br>
725
+
726
+ **isActive:** boolean <br>
727
+ *Flag of usage* <br>
728
+ example: false <br>
729
+
730
+ **isCheckCode:** boolean <br>
731
+ *a sign of user activation via a code* <br>
732
+ example: false <br>
733
+
734
+ **type:** string <br>
735
+ *type of providere* <br>
736
+ example: email <br>
737
+
738
+ **formIdentifier:** string <br>
739
+ *the marker of the form used by the provider (may be null)* <br>
740
+ example: email <br>
741
+
742
+ </details>
743
+
744
+ ---
745
+
746
+
334
747
  ## <h2 id="blocks"> Blocks </h2>
335
748
 
336
749
  ```js
@@ -622,6 +1035,31 @@ Example return:
622
1035
  ]
623
1036
  ```
624
1037
 
1038
+ ## <h2 id="fileuploading"> Events </h2>
1039
+
1040
+ ```js
1041
+ const { Events } = defineOneEntry('your-url');
1042
+ ```
1043
+
1044
+ ### Events.subscribeByMarker(marker, userId, productId)
1045
+
1046
+ ```js
1047
+ const value = await Events.subscribeByMarker('test_event', 1, 1)
1048
+ ```
1049
+
1050
+ > This method unsubscribes to the product event. Returns nothing if the unsubscription was successful.
1051
+
1052
+
1053
+ ### Events.unsubscribeByMarker(marker, userId, productId)
1054
+
1055
+ ```js
1056
+ const value = await Events.subscribeByMarker('test_event', 1, 1)
1057
+ ```
1058
+
1059
+ > This method subscribes to the product event. Returns nothing if the subscription was successful.
1060
+
1061
+ ---
1062
+
625
1063
 
626
1064
  ## <h2 id="fileuploading"> FileUploading </h2>
627
1065
 
@@ -874,56 +1312,192 @@ Example return:
874
1312
  ]
875
1313
  }
876
1314
  ```
877
- <details>
878
- <summary>Schema</summary>
879
-
880
- **id:** number <br>
881
- *object identifier* <br>
882
- example: 1764 <br>
883
-
884
- **attributeSetId:** number <br>
885
- *identifier of the attribute set used* <br>
886
-
887
- **processingType:** string <br>
888
- *form processing type* <br>
889
- example: email <br>
890
-
891
- **localizeInfos:** FormLocalizeInfos <br>
892
- *form name with localization* <br>
893
- Enum:
894
- [ db, email, script ]
895
- example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } } <br>
896
-
897
- **processingData:** ProcessingData <br>
898
- *form data* <br>
899
-
900
- **version:** number <br>
901
- *object version number* <br>
902
- example: 10 <br>
903
-
904
- **identifier:** string <br>
905
- *textual identifier for the record field* <br>
906
- example: catalog <br>
907
- default: marker <br>
908
-
909
- **position:** number <br>
910
- *position number (for sorting)* <br>
911
- example: 192 <br>
912
-
913
- **attributes:** <br>
914
- *array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
915
- example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ], "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ] <br>
916
-
917
- </details>
1315
+ <details>
1316
+ <summary>Schema</summary>
1317
+
1318
+ **id:** number <br>
1319
+ *object identifier* <br>
1320
+ example: 1764 <br>
1321
+
1322
+ **attributeSetId:** number <br>
1323
+ *identifier of the attribute set used* <br>
1324
+
1325
+ **processingType:** string <br>
1326
+ *form processing type* <br>
1327
+ example: email <br>
1328
+
1329
+ **localizeInfos:** FormLocalizeInfos <br>
1330
+ *form name with localization* <br>
1331
+ Enum:
1332
+ [ db, email, script ]
1333
+ example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } } <br>
1334
+
1335
+ **processingData:** ProcessingData <br>
1336
+ *form data* <br>
1337
+
1338
+ **version:** number <br>
1339
+ *object version number* <br>
1340
+ example: 10 <br>
1341
+
1342
+ **identifier:** string <br>
1343
+ *textual identifier for the record field* <br>
1344
+ example: catalog <br>
1345
+ default: marker <br>
1346
+
1347
+ **position:** number <br>
1348
+ *position number (for sorting)* <br>
1349
+ example: 192 <br>
1350
+
1351
+ **attributes:** <br>
1352
+ *array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
1353
+ example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ], "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ] <br>
1354
+
1355
+ </details>
1356
+
1357
+ ---
1358
+
1359
+
1360
+ ## <h2 id="formdata"> FormData </h2>
1361
+
1362
+ ```js
1363
+ const { FormData } = defineOneEntry('your-url');
1364
+ ```
1365
+
1366
+ Methods with a post request accept as the request body an object with the form data field, which corresponds to the type of information being sent.
1367
+ The following are examples of form data objects for different data types.
1368
+
1369
+ ---
1370
+ Example with a simple type attribute "string", "number", "float"
1371
+ ```json
1372
+ {
1373
+ "marker": "last_name",
1374
+ "type": "string",
1375
+ "value": "Username"
1376
+ }
1377
+ ```
1378
+
1379
+ ---
1380
+ Example with a simple type attribute "date", "dateTime", "time"
1381
+ ```json
1382
+ {
1383
+ "marker": "birthday",
1384
+ "type": "date",
1385
+ "value": {
1386
+ "fullDate": "2024-05-07T21:02:00.000Z",
1387
+ "formattedValue": "08-05-2024 00:02",
1388
+ "formatString": "DD-MM-YYYY HH:mm"
1389
+ }
1390
+ }
1391
+ ```
1392
+
1393
+ ---
1394
+ Example with a simple type attribute "text"
1395
+ ```json
1396
+ {
1397
+ "marker": "about",
1398
+ "type": "text",
1399
+ "value": {
1400
+ "htmlValue": "<p>Hello world</p>",
1401
+ "plainValue": "",
1402
+ "params": {
1403
+ "isEditorDisabled": false,
1404
+ "isImageCompressed": true
1405
+ }
1406
+ }
1407
+ }
1408
+ ```
1409
+
1410
+ ---
1411
+ Example with a simple type attribute "text"
1412
+ ```json
1413
+ {
1414
+ "marker": "about",
1415
+ "type": "text",
1416
+ "value": {
1417
+ "htmlValue": "<p>Hello world</p>",
1418
+ "plainValue": "",
1419
+ "params": {
1420
+ "isEditorDisabled": false,
1421
+ "isImageCompressed": true
1422
+ }
1423
+ }
1424
+ }
1425
+ ```
1426
+
1427
+ ---
1428
+ Example with a simple type attribute "textWithHeader"
1429
+ ```json
1430
+ {
1431
+ "marker": "about",
1432
+ "type": "textWithHeader",
1433
+ "value": {
1434
+ "header": "Headline",
1435
+ "htmlValue": "<p>Hello World</p>",
1436
+ "plainValue": "",
1437
+ "params": {
1438
+ "isEditorDisabled": false,
1439
+ "isImageCompressed": true
1440
+ }
1441
+ }
1442
+ }
1443
+ ```
1444
+
1445
+ ---
1446
+ Example with a simple type attribute "image" or "groupOfImages"
1447
+ ```json
1448
+ {
1449
+ "marker": "avatar",
1450
+ "type": "image",
1451
+ "value": [
1452
+ {
1453
+ "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
1454
+ "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
1455
+ "size": 392585,
1456
+ "previewLink": "",
1457
+ "params": {
1458
+ "isImageCompressed": true
1459
+ }
1460
+ }
1461
+ ]
1462
+ }
1463
+ ```
918
1464
 
919
1465
  ---
1466
+ Example with a simple type attribute "files"
1467
+ ```json
1468
+ {
1469
+ "marker": "picture",
1470
+ "type": "file",
1471
+ "value": [
1472
+ {
1473
+ "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
1474
+ "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
1475
+ "size": 392585
1476
+ }
1477
+ ]
1478
+ }
1479
+ ```
920
1480
 
1481
+ ---
1482
+ Example with a simple type attribute "radioButton" or "list"
1483
+ ```json
1484
+ {
1485
+ "marker": "selector",
1486
+ "type": "list",
1487
+ "value": [
1488
+ {
1489
+ "title": "red",
1490
+ "value": "1",
1491
+ "extended": {
1492
+ "value": "красный",
1493
+ "type": "string"
1494
+ }
1495
+ }
1496
+ ]
1497
+ }
1498
+ ```
921
1499
 
922
- ## <h2 id="formdata"> FormData </h2>
923
1500
 
924
- ```js
925
- const { FormData } = defineOneEntry('your-url');
926
- ```
927
1501
 
928
1502
  ### FormData.postFormsData(data, langCode)
929
1503
 
@@ -999,6 +1573,7 @@ Example return:
999
1573
  "attributeSetIdentifier": "test-form"
1000
1574
  }
1001
1575
  ```
1576
+ ---
1002
1577
 
1003
1578
  <details>
1004
1579
  <summary>Schema</summary>
@@ -1188,177 +1763,6 @@ description:position number
1188
1763
 
1189
1764
 
1190
1765
 
1191
- ## <h2 id="markers"> Markers </h2>
1192
-
1193
-
1194
- ```js
1195
- const { Markers } = defineOneEntry('your-url');
1196
- ```
1197
-
1198
- ### Markers.getMarkers(offset, limit)
1199
-
1200
- ```js
1201
- const value = await Markers.getMarkers(0, 30)
1202
- ```
1203
-
1204
- >This method return an array of all objects MarkerEntity.
1205
-
1206
- Example return:
1207
-
1208
- ```json
1209
- [
1210
- {
1211
- "id": 17,
1212
- "updatedDate": "2023-12-18T08:53:37.422Z",
1213
- "version": 10,
1214
- "identifier": "catalog",
1215
- "name": "string",
1216
- "marker": "string",
1217
- "localizeInfos": {
1218
- "title": "My marker"
1219
- }
1220
- }
1221
- ]
1222
- ```
1223
-
1224
- <details>
1225
- <summary>Schema</summary>
1226
-
1227
- **id:** number <br>
1228
- *object identifier* <br>
1229
- example: 1764 <br>
1230
-
1231
- **updatedDate:** string($date-time) <br>
1232
- *object modification date* <br>
1233
-
1234
- **version:** number <br>
1235
- *version number of the object change* <br>
1236
- example: 10 <br>
1237
-
1238
- **identifier?:** string <br>
1239
- *textual identifier for a record field* <br>
1240
- example: catalog <br>
1241
-
1242
- **name?:** string <br>
1243
- *name* <br>
1244
-
1245
- **marker?:** string <br>
1246
- *textual identifier* <br>
1247
-
1248
- **localizeInfos:** CommonLocalizeInfos <br>
1249
- *localized marker name* <br>
1250
- example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } } <br>
1251
- </details>
1252
-
1253
-
1254
- ### Markers.getMarkerById(id)
1255
-
1256
- ```js
1257
- const value = await Markers.getMarkerById(1)
1258
- ```
1259
-
1260
- >This method return one object of MarkerEntity by id.
1261
-
1262
- Example return:
1263
-
1264
- ```json
1265
- {
1266
- "id": 17,
1267
- "updatedDate": "2023-12-18T08:55:22.581Z",
1268
- "version": 10,
1269
- "identifier": "catalog",
1270
- "name": "string",
1271
- "marker": "string",
1272
- "localizeInfos": {
1273
- "title": "My marker"
1274
- }
1275
- }
1276
- ```
1277
-
1278
- <details>
1279
- <summary>Schema</summary>
1280
-
1281
- **id:** number <br>
1282
- *object identifier* <br>
1283
- example: 1764 <br>
1284
-
1285
- **updatedDate:** string($date-time) <br>
1286
- *object modification date* <br>
1287
-
1288
- **version:** number <br>
1289
- *version number of the object change* <br>
1290
- example: 10 <br>
1291
-
1292
- **identifier?:** string <br>
1293
- *textual identifier for a record field* <br>
1294
- example: catalog <br>
1295
-
1296
- **name?:** string <br>
1297
- *name* <br>
1298
-
1299
- **marker?:** string <br>
1300
- *textual identifier* <br>
1301
-
1302
- **localizeInfos:** CommonLocalizeInfos <br>
1303
- *localized marker name* <br>
1304
- example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } } <br>
1305
- </details>
1306
-
1307
- ### Markers.getMarkerByMarker(marker)
1308
-
1309
- ```js
1310
- const value = await Markers.getMarkerByMarker('my-marker')
1311
- ```
1312
-
1313
- >This method return one object of MarkerEntity by marker.
1314
-
1315
- Example return:
1316
-
1317
- ```json
1318
- {
1319
- "id": 17,
1320
- "updatedDate": "2023-12-18T08:59:42.006Z",
1321
- "version": 10,
1322
- "identifier": "catalog",
1323
- "name": "string",
1324
- "marker": "string",
1325
- "localizeInfos": {
1326
- "title": "My marker"
1327
- }
1328
- }
1329
- ```
1330
-
1331
- <details>
1332
- <summary>Schema</summary>
1333
-
1334
- **id:** number <br>
1335
- *object identifier* <br>
1336
- example: 1764 <br>
1337
-
1338
- **updatedDate:** string($date-time) <br>
1339
- *object modification date* <br>
1340
-
1341
- **version:** number <br>
1342
- *version number of the object change* <br>
1343
- example: 10 <br>
1344
-
1345
- **identifier?:** string <br>
1346
- *textual identifier for a record field* <br>
1347
- example: catalog <br>
1348
-
1349
- **name?:** string <br>
1350
- *name* <br>
1351
-
1352
- **marker?:** string <br>
1353
- *textual identifier* <br>
1354
-
1355
- **localizeInfos:** CommonLocalizeInfos <br>
1356
- *localized marker name* <br>
1357
- example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } } <br>
1358
- </details>
1359
-
1360
- ---
1361
-
1362
1766
  ## <h2 id="menus"> Menus </h2>
1363
1767
 
1364
1768
 
@@ -4628,3 +5032,112 @@ example: 12 <br>
4628
5032
  ---
4629
5033
 
4630
5034
 
5035
+ ## <h2 id="templatepreviews"> Users </h2>
5036
+
5037
+
5038
+ ```js
5039
+ const { Users } = defineOneEntry('your-url');
5040
+ ```
5041
+
5042
+ ### Users.getUser(langCode)
5043
+
5044
+ ```js
5045
+ const value = await Users.getUser()
5046
+ ```
5047
+
5048
+ > This method sends a request to get the data of an authorized user. Returns the authorized user's data object.
5049
+
5050
+ Example return:
5051
+
5052
+ ```json
5053
+ {
5054
+ "id": 1764,
5055
+ "identifier": "admin1",
5056
+ "formIdentifier": "regForm",
5057
+ "authProviderIdentifier": "email",
5058
+ "groups": [
5059
+ "group_1"
5060
+ ]
5061
+ }
5062
+ ```
5063
+ <details>
5064
+ <summary>Schema</summary>
5065
+
5066
+ **id:** number <br>
5067
+ *object identifier* <br>
5068
+ example: 1764 <br>
5069
+
5070
+ **identifier:** string <br>
5071
+ *textual identifier for a field in the record* <br>
5072
+ example: catalog <br>
5073
+
5074
+ **formIdentifier** string <br>
5075
+ *the text identifier of the form linked to the authorization provider* <br>
5076
+ example: , regForm <br>
5077
+
5078
+ **authProviderIdentifier:** string <br>
5079
+ *the text ID of the authorization provider* <br>
5080
+ example: email <br>
5081
+
5082
+ **groups** string[] <br>
5083
+ *An array of values for the text identifiers of the groups that the user belongs to* <br>
5084
+ example: List [ "group_1" ] <br>
5085
+
5086
+ </details>
5087
+
5088
+
5089
+ ### Users.getUser(langCode)
5090
+
5091
+ ```js
5092
+ const data = {
5093
+ "formIdentifier": "reg",
5094
+ "authData": [
5095
+ {
5096
+ "marker": "password",
5097
+ "value": "12345"
5098
+ }
5099
+ ],
5100
+ "formData": [
5101
+ {
5102
+ "marker": "last_name",
5103
+ "type": "string",
5104
+ "value": "Username"
5105
+ }
5106
+ ],
5107
+ "notificationData": {
5108
+ "email": "test@test.com",
5109
+ "phonePush": "",
5110
+ "phoneSMS": "+99999999999"
5111
+ }
5112
+ }
5113
+
5114
+ const value = await Users.updateUser(data, langCode)
5115
+ ```
5116
+
5117
+ > This method updates the authorized user's data object. Returns true (in case of successful update) or false (in case of unsuccessful update).
5118
+
5119
+ Example return:
5120
+
5121
+ ```json
5122
+ true
5123
+ ```
5124
+ <details>
5125
+ <summary>Schema</summary>
5126
+
5127
+ **formIdentifier** string <br>
5128
+ *the text identifier of the form linked to the authorization provider* <br>
5129
+ example: , regForm <br>
5130
+
5131
+ **formData:** FormDataLangType <br>
5132
+ *the data of the form linked to the authorization provider* <br>
5133
+ example: OrderedMap { "en_US": List [ OrderedMap { "marker": "first-name", "value": "First name" }, OrderedMap { "marker": "last-name", "value": "Second name" } ] } <br>
5134
+
5135
+ **authData** FormDataType <br>
5136
+ *Authorization data taken from the form linked to the authorization provider (used only to change the password)* <br>
5137
+ example: List [ OrderedMap { "marker": "password", "value": "12345" } ] <br>
5138
+
5139
+ **notificationData** UserNotificationDataType <br>
5140
+ *Data for notifying the user* <br>
5141
+ example: OrderedMap { "email": "test@test.com", "phonePush": "", "phoneSMS": "+9999999999" } <br>
5142
+
5143
+ </details>