jamespot-user-api 1.0.167 → 1.0.168

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 (91) hide show
  1. package/documentation/assets/search.js +1 -1
  2. package/documentation/classes/AdminLicenseApi.html +11 -11
  3. package/documentation/classes/AdminStoreApi.html +1 -1
  4. package/documentation/classes/AdminUtilsApi.html +1 -1
  5. package/documentation/classes/JApplicationApi.html +8 -8
  6. package/documentation/classes/JArticleApi.html +1 -1
  7. package/documentation/classes/JAssetReservation.html +1 -1
  8. package/documentation/classes/JAudienceApi.html +1 -1
  9. package/documentation/classes/JBaseApi.html +1 -1
  10. package/documentation/classes/JBbbApi.html +1 -1
  11. package/documentation/classes/JBookmarkApi.html +1 -1
  12. package/documentation/classes/JBusinessNetworkingApi.html +1 -1
  13. package/documentation/classes/JCommunityApi.html +1 -1
  14. package/documentation/classes/JDatasourceApi.html +1 -0
  15. package/documentation/classes/JDiapazoneApi.html +1 -1
  16. package/documentation/classes/JFaqApi.html +1 -1
  17. package/documentation/classes/JFileApi.html +5 -5
  18. package/documentation/classes/JFilebankApi.html +1 -1
  19. package/documentation/classes/JGlobalApi.html +1 -1
  20. package/documentation/classes/JGroupApi.html +12 -12
  21. package/documentation/classes/JIAApi.html +1 -1
  22. package/documentation/classes/JLandApi.html +1 -1
  23. package/documentation/classes/JMessengerApi.html +1 -1
  24. package/documentation/classes/JObjectApi.html +1 -1
  25. package/documentation/classes/JSearchApi.html +6 -6
  26. package/documentation/classes/JShareApi.html +1 -1
  27. package/documentation/classes/JSocialActionApi.html +1 -1
  28. package/documentation/classes/JTaxonomyApi.html +2 -2
  29. package/documentation/classes/JUserApi.html +7 -7
  30. package/documentation/classes/JWedocApi.html +1 -1
  31. package/documentation/classes/JWidgetApi.html +1 -1
  32. package/documentation/classes/JamespotUserApi.html +1 -1
  33. package/documentation/classes/Network.html +1 -1
  34. package/documentation/classes/TVDisplayApi.html +1 -1
  35. package/documentation/classes/WindowBrowser.html +1 -1
  36. package/documentation/enums/Format.html +1 -1
  37. package/documentation/enums/GroupModerateStatus.html +1 -1
  38. package/documentation/enums/StudioApplicationStatus.html +1 -1
  39. package/documentation/enums/WidgetsName.html +1 -1
  40. package/documentation/index.html +1 -1
  41. package/documentation/interfaces/AccessRightObject.html +1 -1
  42. package/documentation/interfaces/AdminLicenseUser.html +1 -1
  43. package/documentation/interfaces/ApiDefaultWrapper.html +1 -1
  44. package/documentation/interfaces/ApiWrapper.html +1 -1
  45. package/documentation/interfaces/BaseMessage.html +1 -1
  46. package/documentation/interfaces/Category.html +1 -1
  47. package/documentation/interfaces/FileBankProps.html +1 -1
  48. package/documentation/interfaces/FolderProps.html +1 -1
  49. package/documentation/interfaces/ListFilterSpec.html +1 -1
  50. package/documentation/interfaces/OF.html +1 -1
  51. package/documentation/interfaces/ObjectListProps.html +1 -1
  52. package/documentation/interfaces/PagingResults.html +1 -1
  53. package/documentation/interfaces/RootFolderProps.html +1 -1
  54. package/documentation/interfaces/SearchCategoryModel.html +1 -1
  55. package/documentation/interfaces/SearchCategoryValue.html +1 -1
  56. package/documentation/interfaces/SearchConfig.html +1 -1
  57. package/documentation/interfaces/SearchFacetModel.html +1 -1
  58. package/documentation/interfaces/SearchFacetValueModel.html +1 -1
  59. package/documentation/interfaces/SearchQuery.html +1 -1
  60. package/documentation/interfaces/SearchQueryFilterModel.html +1 -1
  61. package/documentation/interfaces/SearchQueryOption.html +1 -1
  62. package/documentation/interfaces/SearchQueryResult.html +1 -1
  63. package/documentation/interfaces/SearchQuerySortModel.html +1 -1
  64. package/documentation/interfaces/SearchResultCatProps.html +1 -1
  65. package/documentation/interfaces/SearchResultPropsApp.html +1 -1
  66. package/documentation/interfaces/SearchResultPropsObject.html +1 -1
  67. package/documentation/interfaces/SpotProps.html +1 -1
  68. package/documentation/interfaces/TaxonomyCreate.html +1 -1
  69. package/documentation/interfaces/WidgetType.html +1 -1
  70. package/documentation/interfaces/WindowInterface.html +1 -1
  71. package/documentation/modules.html +14 -8
  72. package/lib/jamespot-user-api.js +1 -1
  73. package/lib/jamespot-user-api.js.map +1 -1
  74. package/lib/src/apis/datasource/datasource.d.ts +44 -0
  75. package/lib/src/apis/datasource/datasource.mock.d.ts +15 -0
  76. package/lib/src/apis/datasource/datasource.test.d.ts +1 -0
  77. package/lib/src/apis/index.d.ts +1 -0
  78. package/lib/src/apis/jamespotUserApi.d.ts +2 -0
  79. package/lib/src/apis/user/user.d.ts +137 -60
  80. package/lib/src/types/article.d.ts +27846 -12466
  81. package/lib/src/types/widgets.d.ts +15932 -4979
  82. package/lib/src/util/Test.d.ts +548 -240
  83. package/package.json +1 -1
  84. package/phpunitMock/accessibilityGetStatus-default.json +1 -1
  85. package/phpunitMock/widgetDatasourceCreate-doc.json +42 -0
  86. package/phpunitMock/widgetDatasourceCreate-studio.json +42 -0
  87. package/phpunitMock/widgetDatasourceGet-get-doc.json +17 -0
  88. package/phpunitMock/widgetDatasourceGet-get-studio.json +16 -0
  89. package/phpunitMock/widgetDatasourceGetModel-getModel-doc.json +14 -0
  90. package/phpunitMock/widgetDatasourceGetModel-getModel-studio.json +13 -0
  91. package/phpunitMock/widgetDatasourceGetObject-default.json +16 -0
@@ -0,0 +1,44 @@
1
+ import { ApiWrapper, Format, WidgetTableColumn, jArticleList, jArticleLittle } from '../../types';
2
+ import { JBaseApi } from '../base';
3
+ export type DatasourceResult<T extends {} = {}> = {
4
+ type: string;
5
+ count_result: number;
6
+ result_in_cache: boolean;
7
+ model: WidgetTableColumn[];
8
+ data: T[];
9
+ };
10
+ export type DatasourceModel = WidgetTableColumn[];
11
+ export type DatasourceDataTypeUrl = {
12
+ title: string;
13
+ url: string;
14
+ };
15
+ export type DatasourceStudioLittle = {
16
+ mainType: 'typeApplication';
17
+ title: string;
18
+ img: string;
19
+ icon: string;
20
+ color: string;
21
+ description: string;
22
+ };
23
+ export type DatasourceArticleLittle = jArticleLittle & {
24
+ mainType: 'article';
25
+ };
26
+ export type jDatasourceArticleList = jArticleList & {
27
+ datasourceType: string;
28
+ datasourceIdentifier: string;
29
+ datasourceParameters: string | null;
30
+ datasourceModel: string | null;
31
+ };
32
+ export declare class JDatasourceApi extends JBaseApi {
33
+ get<T extends {}>(uri: string, format: Format): Promise<ApiWrapper<DatasourceResult<T>>>;
34
+ getModel(uri: string): Promise<ApiWrapper<{
35
+ type: string;
36
+ model: DatasourceModel;
37
+ }>>;
38
+ getObject(uri: string): Promise<ApiWrapper<DatasourceArticleLittle | DatasourceStudioLittle>>;
39
+ create({ title, datasourceType, datasourceIdentifier, }: {
40
+ title: string;
41
+ datasourceType: string;
42
+ datasourceIdentifier: string;
43
+ }): Promise<ApiWrapper<jDatasourceArticleList>>;
44
+ }
@@ -0,0 +1,15 @@
1
+ import { ApiWrapper, BaseMessages } from '../../types';
2
+ import { DatasourceArticleLittle, DatasourceModel, DatasourceResult, DatasourceStudioLittle, jDatasourceArticleList } from './datasource';
3
+ export declare const datasourceGetObject: ApiWrapper<DatasourceArticleLittle | DatasourceStudioLittle, BaseMessages>;
4
+ export declare const datasourceGetStudio: ApiWrapper<DatasourceResult, BaseMessages>;
5
+ export declare const datasourceGetDoc: ApiWrapper<DatasourceResult, BaseMessages>;
6
+ export declare const datasourceGetModelDoc: ApiWrapper<{
7
+ type: string;
8
+ model: any[];
9
+ }, BaseMessages>;
10
+ export declare const datasourceGetModelStudio: ApiWrapper<{
11
+ type: string;
12
+ model: DatasourceModel;
13
+ }, BaseMessages>;
14
+ export declare const datasourceCreateStudio: ApiWrapper<jDatasourceArticleList, BaseMessages>;
15
+ export declare const datasourceCreateDoc: ApiWrapper<jDatasourceArticleList, BaseMessages>;
@@ -0,0 +1 @@
1
+ export {};
@@ -8,6 +8,7 @@ export * from './bbb/bbb';
8
8
  export * from './bookmark/bookmark';
9
9
  export * from './businessNetworking/businessNetworking';
10
10
  export * from './community';
11
+ export * from './datasource/datasource';
11
12
  export * from './diapazone/diapazone';
12
13
  export * from './file/file';
13
14
  export * from './faq/faq';
@@ -5,6 +5,7 @@ import { JAseiApi } from './asei/asei';
5
5
  import { JAssetReservation } from './assetReservation/assetReservation';
6
6
  import { JAudienceApi } from './audience/audience';
7
7
  import { JCommunityApi } from './community';
8
+ import { JDatasourceApi } from './datasource/datasource';
8
9
  import { JDiapazoneApi } from './diapazone/diapazone';
9
10
  import { JDriveApi } from './drive/drive';
10
11
  import { JFileApi } from './file/file';
@@ -57,6 +58,7 @@ export declare class JamespotUserApi {
57
58
  bookmark: JBookmarkApi;
58
59
  businessNetworking: JBusinessNetworkingApi;
59
60
  community: JCommunityApi;
61
+ datasource: JDatasourceApi;
60
62
  diapazone: JDiapazoneApi;
61
63
  drive: JDriveApi;
62
64
  faq: JFaqApi;
@@ -313,9 +313,32 @@ export declare class JUserApi extends JBaseApi {
313
313
  }[] | undefined;
314
314
  } & {
315
315
  css?: Record<string, string> | undefined;
316
- widgets: any[];
317
- }> & {
318
- title: string;
316
+ widgets?: any[] | undefined;
317
+ }>) | ({
318
+ layers?: string[] | undefined;
319
+ } & {
320
+ name: import("../../types").WidgetsName.DatasourceTable;
321
+ uniqid: string;
322
+ content: {
323
+ limit?: number | undefined;
324
+ tableColumnsData?: {
325
+ name?: string | undefined;
326
+ isVisible?: boolean | undefined;
327
+ textEllipsis?: boolean | undefined;
328
+ label?: string | undefined;
329
+ dateFormat?: "date" | "date-time" | "date-time-sec" | "time" | "time-sec" | undefined;
330
+ numberFormat?: "fr-FR" | "en-EN" | "filesize" | undefined;
331
+ }[] | undefined;
332
+ tableHeadColor?: string | undefined;
333
+ tableHeadTextColor?: string | undefined;
334
+ tableHeadIconColor?: string | undefined;
335
+ tableRowColor?: string | undefined;
336
+ tableRowTextColor?: string | undefined;
337
+ tableBorderRadius?: number | undefined;
338
+ tableSizedColumns?: boolean | undefined;
339
+ tableSizedColumnsWidth?: number | undefined;
340
+ uri?: string | undefined;
341
+ };
319
342
  }) | ({
320
343
  layers?: string[] | undefined;
321
344
  } & {
@@ -361,10 +384,8 @@ export declare class JUserApi extends JBaseApi {
361
384
  }[] | undefined;
362
385
  } & {
363
386
  css?: Record<string, string> | undefined;
364
- widgets: any[];
365
- }> & {
366
- title: string;
367
- }) | ({
387
+ widgets?: any[] | undefined;
388
+ }>) | ({
368
389
  layers?: string[] | undefined;
369
390
  } & {
370
391
  name: import("../../types").WidgetsName.ArticleGallery;
@@ -403,10 +424,8 @@ export declare class JUserApi extends JBaseApi {
403
424
  }[] | undefined;
404
425
  } & {
405
426
  css?: Record<string, string> | undefined;
406
- widgets: any[];
407
- }> & {
408
- title: string;
409
- }) | ({
427
+ widgets?: any[] | undefined;
428
+ }>) | ({
410
429
  layers?: string[] | undefined;
411
430
  } & {
412
431
  name: import("../../types").WidgetsName.ArticleTitle;
@@ -435,10 +454,8 @@ export declare class JUserApi extends JBaseApi {
435
454
  }[] | undefined;
436
455
  } & {
437
456
  css?: Record<string, string> | undefined;
438
- widgets: any[];
439
- }> & {
440
- title: string;
441
- }) | ({
457
+ widgets?: any[] | undefined;
458
+ }>) | ({
442
459
  layers?: string[] | undefined;
443
460
  } & {
444
461
  name: import("../../types").WidgetsName.ArticleText;
@@ -467,10 +484,8 @@ export declare class JUserApi extends JBaseApi {
467
484
  }[] | undefined;
468
485
  } & {
469
486
  css?: Record<string, string> | undefined;
470
- widgets: any[];
471
- }> & {
472
- title: string;
473
- }) | ({
487
+ widgets?: any[] | undefined;
488
+ }>) | ({
474
489
  layers?: string[] | undefined;
475
490
  } & {
476
491
  name: import("../../types").WidgetsName.ArticleImage;
@@ -508,10 +523,8 @@ export declare class JUserApi extends JBaseApi {
508
523
  }[] | undefined;
509
524
  } & {
510
525
  css?: Record<string, string> | undefined;
511
- widgets: any[];
512
- }> & {
513
- title: string;
514
- }) | ({
526
+ widgets?: any[] | undefined;
527
+ }>) | ({
515
528
  layers?: string[] | undefined;
516
529
  } & {
517
530
  name: import("../../types").WidgetsName.ArticleAttachment;
@@ -549,10 +562,8 @@ export declare class JUserApi extends JBaseApi {
549
562
  }[] | undefined;
550
563
  } & {
551
564
  css?: Record<string, string> | undefined;
552
- widgets: any[];
553
- }> & {
554
- title: string;
555
- }) | ({
565
+ widgets?: any[] | undefined;
566
+ }>) | ({
556
567
  layers?: string[] | undefined;
557
568
  } & {
558
569
  name: import("../../types").WidgetsName.Api;
@@ -580,10 +591,8 @@ export declare class JUserApi extends JBaseApi {
580
591
  }[] | undefined;
581
592
  } & {
582
593
  css?: Record<string, string> | undefined;
583
- widgets: any[];
584
- }> & {
585
- title: string;
586
- }) | ({
594
+ widgets?: any[] | undefined;
595
+ }>) | ({
587
596
  layers?: string[] | undefined;
588
597
  } & {
589
598
  name: import("../../types").WidgetsName.ArticleSlider;
@@ -632,10 +641,8 @@ export declare class JUserApi extends JBaseApi {
632
641
  }[] | undefined;
633
642
  } & {
634
643
  css?: Record<string, string> | undefined;
635
- widgets: any[];
636
- }> & {
637
- title: string;
638
- }) | ({
644
+ widgets?: any[] | undefined;
645
+ }>) | ({
639
646
  layers?: string[] | undefined;
640
647
  } & import("../../types").WidgetType<{
641
648
  arr?: {
@@ -654,10 +661,8 @@ export declare class JUserApi extends JBaseApi {
654
661
  }[] | undefined;
655
662
  } & {
656
663
  css?: Record<string, string> | undefined;
657
- widgets: any[];
664
+ widgets?: any[] | undefined;
658
665
  }> & {
659
- title: string;
660
- } & {
661
666
  name: import("../../types").WidgetsName.ArticleButton;
662
667
  uniqid: string;
663
668
  content: {
@@ -702,10 +707,8 @@ export declare class JUserApi extends JBaseApi {
702
707
  }[] | undefined;
703
708
  } & {
704
709
  css?: Record<string, string> | undefined;
705
- widgets: any[];
710
+ widgets?: any[] | undefined;
706
711
  }> & {
707
- title: string;
708
- } & {
709
712
  name: import("../../types").WidgetsName.ArticleGallery;
710
713
  uniqid: string;
711
714
  content: {
@@ -744,10 +747,8 @@ export declare class JUserApi extends JBaseApi {
744
747
  }[] | undefined;
745
748
  } & {
746
749
  css?: Record<string, string> | undefined;
747
- widgets: any[];
750
+ widgets?: any[] | undefined;
748
751
  }> & {
749
- title: string;
750
- } & {
751
752
  name: import("../../types").WidgetsName.ArticleTitle;
752
753
  uniqid: string;
753
754
  content: {
@@ -776,10 +777,8 @@ export declare class JUserApi extends JBaseApi {
776
777
  }[] | undefined;
777
778
  } & {
778
779
  css?: Record<string, string> | undefined;
779
- widgets: any[];
780
+ widgets?: any[] | undefined;
780
781
  }> & {
781
- title: string;
782
- } & {
783
782
  name: import("../../types").WidgetsName.ArticleText;
784
783
  uniqid: string;
785
784
  content: {
@@ -808,10 +807,8 @@ export declare class JUserApi extends JBaseApi {
808
807
  }[] | undefined;
809
808
  } & {
810
809
  css?: Record<string, string> | undefined;
811
- widgets: any[];
810
+ widgets?: any[] | undefined;
812
811
  }> & {
813
- title: string;
814
- } & {
815
812
  name: import("../../types").WidgetsName.ArticleImage;
816
813
  uniqid: string;
817
814
  content: {
@@ -849,10 +846,8 @@ export declare class JUserApi extends JBaseApi {
849
846
  }[] | undefined;
850
847
  } & {
851
848
  css?: Record<string, string> | undefined;
852
- widgets: any[];
849
+ widgets?: any[] | undefined;
853
850
  }> & {
854
- title: string;
855
- } & {
856
851
  name: import("../../types").WidgetsName.ArticleAttachment;
857
852
  uniqid: string;
858
853
  content: {
@@ -890,10 +885,8 @@ export declare class JUserApi extends JBaseApi {
890
885
  }[] | undefined;
891
886
  } & {
892
887
  css?: Record<string, string> | undefined;
893
- widgets: any[];
888
+ widgets?: any[] | undefined;
894
889
  }> & {
895
- title: string;
896
- } & {
897
890
  name: import("../../types").WidgetsName.Api;
898
891
  uniqid: string;
899
892
  content: {
@@ -921,10 +914,8 @@ export declare class JUserApi extends JBaseApi {
921
914
  }[] | undefined;
922
915
  } & {
923
916
  css?: Record<string, string> | undefined;
924
- widgets: any[];
917
+ widgets?: any[] | undefined;
925
918
  }> & {
926
- title: string;
927
- } & {
928
919
  name: import("../../types").WidgetsName.ArticleSlider;
929
920
  uniqid: string;
930
921
  content: {
@@ -954,7 +945,93 @@ export declare class JUserApi extends JBaseApi {
954
945
  useDots?: boolean | undefined;
955
946
  startAt?: number | undefined;
956
947
  };
957
- });
948
+ }) | ({
949
+ layers?: string[] | undefined;
950
+ } & import("../../types").WidgetType<{
951
+ arr?: {
952
+ title: string;
953
+ value?: boolean | undefined;
954
+ links?: {
955
+ href: string;
956
+ target: string;
957
+ }[] | undefined;
958
+ id?: number | undefined;
959
+ user?: {
960
+ type: "user";
961
+ id: number;
962
+ mainType: "user";
963
+ } | undefined;
964
+ }[] | undefined;
965
+ } & {
966
+ css?: Record<string, string> | undefined;
967
+ widgets?: any[] | undefined;
968
+ }> & {
969
+ name: import("../../types").WidgetsName.DatasourceTable;
970
+ uniqid: string;
971
+ content: {
972
+ limit?: number | undefined;
973
+ tableColumnsData?: {
974
+ name?: string | undefined;
975
+ isVisible?: boolean | undefined;
976
+ textEllipsis?: boolean | undefined;
977
+ label?: string | undefined;
978
+ dateFormat?: "date" | "date-time" | "date-time-sec" | "time" | "time-sec" | undefined;
979
+ numberFormat?: "fr-FR" | "en-EN" | "filesize" | undefined;
980
+ }[] | undefined;
981
+ tableHeadColor?: string | undefined;
982
+ tableHeadTextColor?: string | undefined;
983
+ tableHeadIconColor?: string | undefined;
984
+ tableRowColor?: string | undefined;
985
+ tableRowTextColor?: string | undefined;
986
+ tableBorderRadius?: number | undefined;
987
+ tableSizedColumns?: boolean | undefined;
988
+ tableSizedColumnsWidth?: number | undefined;
989
+ uri?: string | undefined;
990
+ };
991
+ }) | ({
992
+ layers?: string[] | undefined;
993
+ } & {
994
+ name: import("../../types").WidgetsName.DatasourceTable;
995
+ uniqid: string;
996
+ content: {
997
+ limit?: number | undefined;
998
+ tableColumnsData?: {
999
+ name?: string | undefined;
1000
+ isVisible?: boolean | undefined;
1001
+ textEllipsis?: boolean | undefined;
1002
+ label?: string | undefined;
1003
+ dateFormat?: "date" | "date-time" | "date-time-sec" | "time" | "time-sec" | undefined;
1004
+ numberFormat?: "fr-FR" | "en-EN" | "filesize" | undefined;
1005
+ }[] | undefined;
1006
+ tableHeadColor?: string | undefined;
1007
+ tableHeadTextColor?: string | undefined;
1008
+ tableHeadIconColor?: string | undefined;
1009
+ tableRowColor?: string | undefined;
1010
+ tableRowTextColor?: string | undefined;
1011
+ tableBorderRadius?: number | undefined;
1012
+ tableSizedColumns?: boolean | undefined;
1013
+ tableSizedColumnsWidth?: number | undefined;
1014
+ uri?: string | undefined;
1015
+ };
1016
+ } & import("../../types").WidgetType<{
1017
+ arr?: {
1018
+ title: string;
1019
+ value?: boolean | undefined;
1020
+ links?: {
1021
+ href: string;
1022
+ target: string;
1023
+ }[] | undefined;
1024
+ id?: number | undefined;
1025
+ user?: {
1026
+ type: "user";
1027
+ id: number;
1028
+ mainType: "user";
1029
+ } | undefined;
1030
+ }[] | undefined;
1031
+ } & {
1032
+ css?: Record<string, string> | undefined;
1033
+ widgets?: any[] | undefined;
1034
+ }>);
958
1035
  }[] | undefined;
959
1036
  }, import("../../types").BaseMessages>>;
960
1037
  userDeleteBusinessContact(idArticle: number): Promise<ApiWrapper<boolean, import("../../types").BaseMessages>>;