jamespot-user-api 1.0.180 → 1.0.182

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 (130) hide show
  1. package/documentation/assets/search.js +1 -1
  2. package/documentation/classes/AdminLicenseApi.html +14 -14
  3. package/documentation/classes/AdminStoreApi.html +1 -1
  4. package/documentation/classes/AdminUtilsApi.html +2 -2
  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 -1
  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 +17 -17
  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 +10 -8
  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/BookmarkType.html +1 -1
  37. package/documentation/enums/Format.html +1 -1
  38. package/documentation/enums/StudioApplicationStatus.html +1 -1
  39. package/documentation/enums/WidgetsName.html +1 -1
  40. package/documentation/enums/_GroupModerateStatus.html +1 -0
  41. package/documentation/index.html +1 -1
  42. package/documentation/interfaces/AccessRightObject.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/FileBankProps.html +1 -1
  47. package/documentation/interfaces/FolderProps.html +1 -1
  48. package/documentation/interfaces/ListFilterSpec.html +1 -1
  49. package/documentation/interfaces/OF.html +1 -1
  50. package/documentation/interfaces/PagingResults.html +1 -1
  51. package/documentation/interfaces/RootFolderProps.html +1 -1
  52. package/documentation/interfaces/SpotProps.html +1 -1
  53. package/documentation/interfaces/TaxonomyCreate.html +1 -1
  54. package/documentation/interfaces/WidgetType.html +1 -1
  55. package/documentation/interfaces/WindowInterface.html +1 -1
  56. package/documentation/modules.html +11 -11
  57. package/jest.config.ts +1 -2
  58. package/lib/jamespot-user-api.js +1 -1
  59. package/lib/jamespot-user-api.js.map +1 -1
  60. package/lib/jest.config.d.ts +0 -1
  61. package/lib/jest.config.vm.d.ts +0 -1
  62. package/lib/src/apis/admin/utils.d.ts +1 -1
  63. package/lib/src/apis/article/article.d.ts +3 -1
  64. package/lib/src/apis/file/file.d.ts +2 -2
  65. package/lib/src/apis/filebank/filebank.d.ts +2 -2
  66. package/lib/src/apis/group/group.d.ts +218 -9
  67. package/lib/src/apis/group/group.mock.d.ts +6 -6
  68. package/lib/src/apis/jland/jland.d.ts +2 -31
  69. package/lib/src/apis/jland/jland.mock.d.ts +3 -2
  70. package/lib/src/apis/taxonomy/taxonomy.d.ts +2 -2
  71. package/lib/src/apis/tvDisplay/tvDisplay.d.ts +962 -3
  72. package/lib/src/apis/user/user.d.ts +11 -103
  73. package/lib/src/apis/user/user.mock.d.ts +5 -1
  74. package/lib/src/apis/widget/widget.d.ts +2 -2
  75. package/lib/src/apis/widget/widget.mock.d.ts +2 -2
  76. package/lib/src/types/adminUtils.d.ts +10 -10
  77. package/lib/src/types/article.d.ts +3065 -4796
  78. package/lib/src/types/asei.d.ts +231 -413
  79. package/lib/src/types/assetReservation.d.ts +1051 -1768
  80. package/lib/src/types/autocomplete.d.ts +14 -14
  81. package/lib/src/types/businessContact.d.ts +136 -502
  82. package/lib/src/types/comment.d.ts +231 -413
  83. package/lib/src/types/diapazone.d.ts +4 -4
  84. package/lib/src/types/faq.d.ts +1365 -2277
  85. package/lib/src/types/global.d.ts +2 -2
  86. package/lib/src/types/group.d.ts +1881 -127
  87. package/lib/src/types/hook.d.ts +1 -2
  88. package/lib/src/types/index.d.ts +1 -0
  89. package/lib/src/types/jLand.d.ts +1175 -0
  90. package/lib/src/types/mediaLibrary.d.ts +241 -423
  91. package/lib/src/types/meeting.d.ts +723 -1269
  92. package/lib/src/types/model.d.ts +653 -89
  93. package/lib/src/types/object.d.ts +2 -2
  94. package/lib/src/types/pollSurvey.d.ts +856 -1402
  95. package/lib/src/types/quizz.d.ts +723 -1269
  96. package/lib/src/types/search.d.ts +8 -8
  97. package/lib/src/types/share.d.ts +8 -8
  98. package/lib/src/types/socialEvent.d.ts +723 -1269
  99. package/lib/src/types/support.d.ts +723 -1269
  100. package/lib/src/types/surveyDate.d.ts +726 -1308
  101. package/lib/src/types/tvDisplay.d.ts +18544 -49
  102. package/lib/src/types/uri.d.ts +44 -8
  103. package/lib/src/types/wedoc.d.ts +633 -27
  104. package/lib/src/types/widgets/common.d.ts +1 -18
  105. package/lib/src/types/widgets/default.d.ts +538 -1719
  106. package/lib/src/types/widgets/widgetApi.d.ts +0 -1
  107. package/lib/src/types/widgets/widgetArticleAttachment.d.ts +0 -1
  108. package/lib/src/types/widgets/widgetArticleButton.d.ts +0 -1
  109. package/lib/src/types/widgets/widgetArticleGallery.d.ts +0 -1
  110. package/lib/src/types/widgets/widgetArticleImage.d.ts +0 -1
  111. package/lib/src/types/widgets/widgetArticleSlider.d.ts +0 -1
  112. package/lib/src/types/widgets/widgetArticleText.d.ts +0 -1
  113. package/lib/src/types/widgets/widgetArticleTitle.d.ts +0 -1
  114. package/lib/src/types/widgets/widgetCheckList.d.ts +7 -4
  115. package/lib/src/types/widgets/widgetDatasourceTable.d.ts +0 -1
  116. package/lib/src/types/widgets/widgetExcelDatasourceTable.d.ts +2 -26
  117. package/lib/src/types/widgets.d.ts +3573 -4860
  118. package/lib/src/util/Test.d.ts +5 -498
  119. package/lib/src/util/group.d.ts +2 -2
  120. package/lib/src/util/index.d.ts +1 -0
  121. package/lib/src/util/widget.d.ts +83 -0
  122. package/package.json +1 -1
  123. package/phpunitMock/articleCreate-businessContact.json +23 -0
  124. package/phpunitMock/articleCreate-jLandMap.json +49 -0
  125. package/phpunitMock/articleDelete-businessContact.json +12 -0
  126. package/phpunitMock/articleUpdate-businessContact.json +50 -0
  127. package/phpunitMock/objectListJLandJLandList-success.json +14 -0
  128. package/phpunitMock/userSignIn-success.json +31 -0
  129. package/documentation/enums/GroupModerateStatus.html +0 -1
  130. package/documentation/interfaces/Category.html +0 -1
@@ -1,5 +1,5 @@
1
1
  import { JBaseApi } from '../base';
2
- import { ApiWrapper, jObjectLittle, UserMapModel, ApiPagingResults, ApiDefaultWrapper, jUserLittle, Readable, jUserValues, UserFieldsConfigurationType, UserFieldsType, UserDirectoryConfiguration, ObjectListProps, BusinessContact, FormatExtension } from '../../types';
2
+ import { ApiWrapper, jObjectLittle, UserMapModel, ApiPagingResults, ApiDefaultWrapper, jUserLittle, Readable, jUserValues, UserFieldsConfigurationType, UserFieldsType, UserDirectoryConfiguration, ObjectListProps, BusinessContact, FormatExtension, jArticleLittle, FormatList, jBusinessContactList, jUserView } from '../../types';
3
3
  import { jBusinessContactLittle } from '../../types/businessContact';
4
4
  export declare class JUserApi extends JBaseApi {
5
5
  /**
@@ -14,11 +14,11 @@ export declare class JUserApi extends JBaseApi {
14
14
  title: string;
15
15
  name: string;
16
16
  Pseudo: string;
17
+ class: string;
17
18
  label: string;
18
19
  shortUri: string;
19
20
  cssClass: string;
20
21
  cssColor: string;
21
- class: string;
22
22
  }[]>;
23
23
  /**
24
24
  * Get a user
@@ -57,94 +57,14 @@ export declare class JUserApi extends JBaseApi {
57
57
  }): Promise<ApiPagingResults<T>>;
58
58
  userMap(payload: ObjectListProps): Promise<ApiPagingResults<UserMapModel>>;
59
59
  userBusinessContactQueryList<T extends jObjectLittle = jBusinessContactLittle>(query: ObjectListProps): Promise<ApiPagingResults<T>>;
60
- userCreateBusinessContact(user: BusinessContact): Promise<ApiWrapper<{
61
- type: string;
62
- id: number;
63
- mainType: string;
64
- uri: string;
65
- dateCreation: string;
66
- dateModified: string;
67
- title: string;
68
- _url: string;
69
- }[], import("../../types").BaseMessages>>;
70
- userUpdateBusinessContact(user: Readable<BusinessContact & {
71
- uri: string;
72
- }>): Promise<ApiWrapper<{
73
- type: string;
74
- id: number;
75
- mainType: string;
60
+ userCreateBusinessContact<T extends jArticleLittle = jArticleLittle>(user: BusinessContact, options?: {
61
+ format?: FormatList;
62
+ }): Promise<ApiWrapper<T[]>>;
63
+ userUpdateBusinessContact<T extends jBusinessContactLittle = jBusinessContactList>(user: Readable<BusinessContact & {
76
64
  uri: string;
77
- dateCreation: string;
78
- dateModified: string;
79
- title: string;
80
- _url: string;
81
- _user: import("../../types").jObjectBase & {
82
- title: string;
83
- _url: string;
84
- } & {
85
- [key: string]: string | number | null;
86
- level: 0 | 3 | 5 | 9;
87
- dateCreation: string;
88
- dateModified: string;
89
- };
90
- _right: import("../../types").Rights;
91
- _audience: (jUserLittle | {
92
- type: string;
93
- id: number;
94
- mainType: string;
95
- uri: string;
96
- dateCreation: string;
97
- dateModified: string;
98
- title: string;
99
- _url: string;
100
- category: number;
101
- privacy: number;
102
- } | {
103
- type: "folder" | "rootFolder";
104
- id: number;
105
- mainType: string;
106
- uri: string;
107
- title: string;
108
- _url: string;
109
- dateCreation?: string | undefined;
110
- dateModified?: string | null | undefined;
111
- folderColor?: string | undefined;
112
- })[];
113
- description?: string | null | undefined;
114
- image?: {
115
- width: number;
116
- height: number;
117
- } | undefined;
118
- articleWidgets?: {
119
- title: string;
120
- widget: {
121
- layers?: string[] | undefined;
122
- } & (import("../../types").WidgetArticleButtonType | import("../../types").WidgetArticleGalleryType | import("../../types").WidgetArticleTitleType | import("../../types").WidgetArticleTextType | import("../../types").WidgetArticleImageType | import("../../types").WidgetArticleAttachmentType | import("../../types").WidgetApiType | import("../../types").WidgetArticleSliderType | import("../../types").WidgetType<import("../../types").WidgetCheckListContent & import("../../types").LegacyAngularJSType> | import("../../types").WidgetDatasourceTableType | {
123
- name: import("../../types").WidgetsName.ExcelDatasourceTable;
124
- uniqid: string;
125
- content: {
126
- uri?: string | undefined;
127
- limit?: number | undefined;
128
- tableColumnsData?: {
129
- name?: string | undefined;
130
- label?: string | undefined;
131
- isVisible?: boolean | undefined;
132
- textEllipsis?: boolean | undefined;
133
- dateFormat?: "date" | "time" | "date-time" | "date-time-sec" | "time-sec" | undefined;
134
- numberFormat?: "fr-FR" | "en-EN" | "filesize" | undefined;
135
- }[] | undefined;
136
- tableHeadColor?: string | undefined;
137
- tableHeadTextColor?: string | undefined;
138
- tableHeadIconColor?: string | undefined;
139
- tableRowColor?: string | undefined;
140
- tableRowTextColor?: string | undefined;
141
- tableBorderRadius?: number | undefined;
142
- tableSizedColumns?: boolean | undefined;
143
- tableSizedColumnsWidth?: number | undefined;
144
- };
145
- });
146
- }[] | undefined;
147
- }, import("../../types").BaseMessages>>;
65
+ }>, options?: {
66
+ format?: FormatList;
67
+ }): Promise<ApiWrapper<T>>;
148
68
  userDeleteBusinessContact(idArticle: number): Promise<ApiWrapper<boolean, import("../../types").BaseMessages>>;
149
69
  userAddContact(idUser: number): Promise<ApiDefaultWrapper>;
150
70
  userRemoveContact(idUser: number): Promise<ApiDefaultWrapper>;
@@ -152,21 +72,9 @@ export declare class JUserApi extends JBaseApi {
152
72
  * signIn function returns a Promise of users.
153
73
  * @param mail Mail or username
154
74
  * @param pwd Password to be validated
75
+ * @param format Format of the response
155
76
  */
156
- signIn(mail: string, pwd: string): Promise<ApiWrapper<{
157
- type: string;
158
- id: string;
159
- mainType: string;
160
- uri: string;
161
- title: string;
162
- name: string;
163
- Pseudo: string;
164
- label: string;
165
- shortUri: string;
166
- cssClass: string;
167
- cssColor: string;
168
- class: string;
169
- }, import("../../types").BaseMessages>>;
77
+ signIn<T extends jUserLittle = jUserView>(mail: string, pwd: string, format?: FormatList): Promise<ApiWrapper<T>>;
170
78
  getFields(idUser: number, fieldsType: UserFieldsType): Promise<ApiWrapper<{
171
79
  value: string | Record<string, any>;
172
80
  name: string;
@@ -1,4 +1,4 @@
1
- import { ApiDefaultWrapper, ApiPagingResults, ApiWrapper, UserMapModel, jUserAutocomplete, jUserList, jUserView, jUserLittle, UserFieldsConfigurationType, UserField, UserDirectoryConfiguration, UserValues } from '../../types';
1
+ import { ApiDefaultWrapper, ApiPagingResults, ApiWrapper, UserMapModel, jUserAutocomplete, jUserList, jUserView, jUserLittle, UserFieldsConfigurationType, UserField, UserDirectoryConfiguration, UserValues, jArticleLittle } from '../../types';
2
2
  import { jBusinessContactList } from '../../types/businessContact';
3
3
  export declare const userAutocompleteA: ApiWrapper<jUserAutocomplete[]>;
4
4
  export declare const userGetUser1: ApiWrapper<jUserView>;
@@ -16,3 +16,7 @@ export declare const userMapDefault: ApiPagingResults<UserMapModel>;
16
16
  export declare const userAddContactDefault: ApiDefaultWrapper;
17
17
  export declare const userRemoveContactDefault: ApiDefaultWrapper;
18
18
  export declare const userGetFields: ApiWrapper<UserField[]>;
19
+ export declare const userCreateBusinessContact: ApiWrapper<jArticleLittle[]>;
20
+ export declare const userUpdateBusinessContact: ApiWrapper<jBusinessContactList>;
21
+ export declare const userDeleteBusinessContact: ApiWrapper<boolean>;
22
+ export declare const userSignIn: ApiWrapper<jUserView>;
@@ -1,4 +1,4 @@
1
- import { ApiWrapper, CombinedWidgetContent, CombinedWidgetType, WidgetWrapperProps, jUserLittle } from '../../types';
1
+ import { ApiWrapper, CombinedWidgetContent, CombinedWidgetType, WidgetWrapperGeneric, jUserLittle } from '../../types';
2
2
  import { JBaseApi } from '../base';
3
3
  export declare class JWidgetApi extends JBaseApi {
4
4
  responseUserList(uri: string, uniqid: string, page: number): Promise<ApiWrapper<jUserLittle[]>>;
@@ -20,5 +20,5 @@ export declare class JWidgetApi extends JBaseApi {
20
20
  content: Partial<CombinedWidgetContent>;
21
21
  title: string;
22
22
  type: string;
23
- }): Promise<ApiWrapper<Pick<WidgetWrapperProps<T>, 'widget'>[]>>;
23
+ }): Promise<ApiWrapper<Pick<WidgetWrapperGeneric<T>, 'widget'>[]>>;
24
24
  }
@@ -1,5 +1,5 @@
1
- import { ApiWrapper, WidgetCheckListType, WidgetWrapperProps, jUserLittle } from '../../types';
1
+ import { ApiWrapper, WidgetCheckListType, jUserLittle, WidgetWrapperGeneric } from '../../types';
2
2
  export declare const widgetResponseUserList: ApiWrapper<jUserLittle[]>;
3
3
  export declare const widgetResponseRemoveWidget: ApiWrapper<boolean>;
4
4
  export declare const widgetResponseCheckListRespond: ApiWrapper<boolean>;
5
- export declare const widgetResponseUpdateWidget: ApiWrapper<Pick<WidgetWrapperProps<WidgetCheckListType>, 'widget'>[]>;
5
+ export declare const widgetResponseUpdateWidget: ApiWrapper<Pick<WidgetWrapperGeneric<WidgetCheckListType>, 'widget'>[]>;
@@ -8,17 +8,17 @@ export declare const adminAppTabSchema: z.ZodObject<{
8
8
  licenseMode: z.ZodOptional<z.ZodLiteral<"classic">>;
9
9
  hook: z.ZodOptional<z.ZodString>;
10
10
  }, "strip", z.ZodTypeAny, {
11
- idDiv: string;
12
11
  label: string;
13
12
  icon: string;
13
+ idDiv: string;
14
14
  href?: string | undefined;
15
15
  sref?: string | undefined;
16
16
  licenseMode?: "classic" | undefined;
17
17
  hook?: string | undefined;
18
18
  }, {
19
- idDiv: string;
20
19
  label: string;
21
20
  icon: string;
21
+ idDiv: string;
22
22
  href?: string | undefined;
23
23
  sref?: string | undefined;
24
24
  licenseMode?: "classic" | undefined;
@@ -42,17 +42,17 @@ export declare const adminAppSchema: z.ZodObject<{
42
42
  licenseMode: z.ZodOptional<z.ZodLiteral<"classic">>;
43
43
  hook: z.ZodOptional<z.ZodString>;
44
44
  }, "strip", z.ZodTypeAny, {
45
- idDiv: string;
46
45
  label: string;
47
46
  icon: string;
47
+ idDiv: string;
48
48
  href?: string | undefined;
49
49
  sref?: string | undefined;
50
50
  licenseMode?: "classic" | undefined;
51
51
  hook?: string | undefined;
52
52
  }, {
53
- idDiv: string;
54
53
  label: string;
55
54
  icon: string;
55
+ idDiv: string;
56
56
  href?: string | undefined;
57
57
  sref?: string | undefined;
58
58
  licenseMode?: "classic" | undefined;
@@ -67,9 +67,9 @@ export declare const adminAppSchema: z.ZodObject<{
67
67
  url?: string | undefined;
68
68
  state?: string | undefined;
69
69
  tabs?: {
70
- idDiv: string;
71
70
  label: string;
72
71
  icon: string;
72
+ idDiv: string;
73
73
  href?: string | undefined;
74
74
  sref?: string | undefined;
75
75
  licenseMode?: "classic" | undefined;
@@ -84,9 +84,9 @@ export declare const adminAppSchema: z.ZodObject<{
84
84
  url?: string | undefined;
85
85
  state?: string | undefined;
86
86
  tabs?: {
87
- idDiv: string;
88
87
  label: string;
89
88
  icon: string;
89
+ idDiv: string;
90
90
  href?: string | undefined;
91
91
  sref?: string | undefined;
92
92
  licenseMode?: "classic" | undefined;
@@ -111,17 +111,17 @@ export declare const adminAppsSchema: z.ZodArray<z.ZodObject<{
111
111
  licenseMode: z.ZodOptional<z.ZodLiteral<"classic">>;
112
112
  hook: z.ZodOptional<z.ZodString>;
113
113
  }, "strip", z.ZodTypeAny, {
114
- idDiv: string;
115
114
  label: string;
116
115
  icon: string;
116
+ idDiv: string;
117
117
  href?: string | undefined;
118
118
  sref?: string | undefined;
119
119
  licenseMode?: "classic" | undefined;
120
120
  hook?: string | undefined;
121
121
  }, {
122
- idDiv: string;
123
122
  label: string;
124
123
  icon: string;
124
+ idDiv: string;
125
125
  href?: string | undefined;
126
126
  sref?: string | undefined;
127
127
  licenseMode?: "classic" | undefined;
@@ -136,9 +136,9 @@ export declare const adminAppsSchema: z.ZodArray<z.ZodObject<{
136
136
  url?: string | undefined;
137
137
  state?: string | undefined;
138
138
  tabs?: {
139
- idDiv: string;
140
139
  label: string;
141
140
  icon: string;
141
+ idDiv: string;
142
142
  href?: string | undefined;
143
143
  sref?: string | undefined;
144
144
  licenseMode?: "classic" | undefined;
@@ -153,9 +153,9 @@ export declare const adminAppsSchema: z.ZodArray<z.ZodObject<{
153
153
  url?: string | undefined;
154
154
  state?: string | undefined;
155
155
  tabs?: {
156
- idDiv: string;
157
156
  label: string;
158
157
  icon: string;
158
+ idDiv: string;
159
159
  href?: string | undefined;
160
160
  sref?: string | undefined;
161
161
  licenseMode?: "classic" | undefined;