jamespot-user-api 1.0.146 → 1.0.148

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 (115) 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/JBookmarkApi.html +1 -1
  11. package/documentation/classes/JBusinessNetworkingApi.html +1 -1
  12. package/documentation/classes/JCommunityApi.html +1 -1
  13. package/documentation/classes/JDiapazoneApi.html +1 -1
  14. package/documentation/classes/JFaqApi.html +1 -1
  15. package/documentation/classes/JFileApi.html +5 -5
  16. package/documentation/classes/JFilebankApi.html +1 -1
  17. package/documentation/classes/JGlobalApi.html +1 -1
  18. package/documentation/classes/JGroupApi.html +10 -10
  19. package/documentation/classes/JIAApi.html +1 -1
  20. package/documentation/classes/JLandApi.html +1 -1
  21. package/documentation/classes/JMessengerApi.html +1 -1
  22. package/documentation/classes/JObjectApi.html +1 -1
  23. package/documentation/classes/JSearchApi.html +6 -6
  24. package/documentation/classes/JShareApi.html +1 -1
  25. package/documentation/classes/JSocialActionApi.html +1 -1
  26. package/documentation/classes/JTaxonomyApi.html +2 -2
  27. package/documentation/classes/JUserApi.html +7 -7
  28. package/documentation/classes/JWedocApi.html +1 -1
  29. package/documentation/classes/JWidgetApi.html +1 -1
  30. package/documentation/classes/JamespotUserApi.html +1 -1
  31. package/documentation/classes/Network.html +1 -1
  32. package/documentation/classes/TVDisplayApi.html +1 -1
  33. package/documentation/classes/WindowBrowser.html +1 -1
  34. package/documentation/enums/StudioApplicationStatus.html +1 -1
  35. package/documentation/index.html +1 -1
  36. package/documentation/interfaces/AccessRightObject.html +1 -1
  37. package/documentation/interfaces/AdminLicenseUser.html +1 -1
  38. package/documentation/interfaces/ApiDefaultWrapper.html +1 -1
  39. package/documentation/interfaces/ApiWrapper.html +1 -1
  40. package/documentation/interfaces/BaseAutocomplete.html +1 -1
  41. package/documentation/interfaces/BaseMessage.html +1 -1
  42. package/documentation/interfaces/Category.html +1 -1
  43. package/documentation/interfaces/FileBankProps.html +1 -1
  44. package/documentation/interfaces/FolderProps.html +1 -1
  45. package/documentation/interfaces/ListFilterSpec.html +1 -1
  46. package/documentation/interfaces/OF.html +1 -1
  47. package/documentation/interfaces/ObjectListProps.html +1 -1
  48. package/documentation/interfaces/PagingResults.html +1 -1
  49. package/documentation/interfaces/RootFolderProps.html +1 -1
  50. package/documentation/interfaces/SearchCategoryModel.html +1 -1
  51. package/documentation/interfaces/SearchCategoryValue.html +1 -1
  52. package/documentation/interfaces/SearchConfig.html +1 -1
  53. package/documentation/interfaces/SearchFacetModel.html +1 -1
  54. package/documentation/interfaces/SearchFacetValueModel.html +1 -1
  55. package/documentation/interfaces/SearchQuery.html +1 -1
  56. package/documentation/interfaces/SearchQueryFilterModel.html +1 -1
  57. package/documentation/interfaces/SearchQueryOption.html +1 -1
  58. package/documentation/interfaces/SearchQueryResult.html +1 -1
  59. package/documentation/interfaces/SearchQuerySortModel.html +1 -1
  60. package/documentation/interfaces/SearchResultCatProps.html +1 -1
  61. package/documentation/interfaces/SearchResultPropsApp.html +1 -1
  62. package/documentation/interfaces/SearchResultPropsObject.html +1 -1
  63. package/documentation/interfaces/SpotProps.html +1 -1
  64. package/documentation/interfaces/Taxonomy.html +1 -1
  65. package/documentation/interfaces/TaxonomyCreate.html +1 -1
  66. package/documentation/interfaces/WindowInterface.html +1 -1
  67. package/documentation/modules.html +13 -11
  68. package/lib/jamespot-user-api.js +1 -1
  69. package/lib/jamespot-user-api.js.map +1 -1
  70. package/lib/src/apis/animations/animations.d.ts +7 -11
  71. package/lib/src/apis/animations/animations.mock.d.ts +8 -3
  72. package/lib/src/apis/article/article.mock.d.ts +20 -2
  73. package/lib/src/apis/bookmark/bookmark.d.ts +1 -1
  74. package/lib/src/apis/drive/drive.d.ts +1 -1
  75. package/lib/src/apis/group/group.d.ts +11 -10
  76. package/lib/src/apis/group/group.mock.d.ts +2 -1
  77. package/lib/src/types/animations.d.ts +8 -0
  78. package/lib/src/types/drive.d.ts +1 -0
  79. package/lib/src/types/group.d.ts +11 -1
  80. package/lib/src/types/index.d.ts +1 -0
  81. package/lib/src/types/meeting.d.ts +12 -0
  82. package/lib/src/types/model.d.ts +1 -1
  83. package/lib/src/types/pollSurvey.d.ts +27 -0
  84. package/lib/src/types/quizz.d.ts +15 -0
  85. package/lib/src/types/realtime.d.ts +10 -1
  86. package/lib/src/types/socialEvent.d.ts +17 -0
  87. package/lib/src/types/support.d.ts +8 -0
  88. package/lib/src/types/surveyDate.d.ts +9 -0
  89. package/lib/src/types/utils.d.ts +6 -0
  90. package/lib/src/types/widgets.d.ts +22 -2
  91. package/lib/src/util/Test.d.ts +1 -1
  92. package/lib/src/util/file.d.ts +1 -1
  93. package/package.json +1 -1
  94. package/phpunitMock/animationsDeleteAnimation-default.json +1 -0
  95. package/phpunitMock/animationsGetAnimationActive-default.json +1 -0
  96. package/phpunitMock/animationsGetConfiguration-default.json +2 -2
  97. package/phpunitMock/animationsGetConfiguration-get-animation-without-me-in.json +1 -0
  98. package/phpunitMock/animationsGetConfigurationApp-default.json +13 -0
  99. package/phpunitMock/animationsGetConfigurationApp-without-me-in.json +13 -0
  100. package/phpunitMock/animationsSaveConfiguration-default.json +13 -1
  101. package/phpunitMock/animationsToggleAnimationActive-default.json +7 -0
  102. package/phpunitMock/articleGet-meeting-list.json +55 -0
  103. package/phpunitMock/articleGet-meeting-view.json +64 -0
  104. package/phpunitMock/articleGet-pollSurvey-list.json +62 -0
  105. package/phpunitMock/articleGet-pollSurvey-view.json +71 -0
  106. package/phpunitMock/articleGet-quizz-list.json +42 -0
  107. package/phpunitMock/articleGet-quizz-view.json +49 -0
  108. package/phpunitMock/articleGet-socialEvent-list.json +57 -0
  109. package/phpunitMock/articleGet-socialEvent-view.json +66 -0
  110. package/phpunitMock/articleGet-support-list.json +42 -0
  111. package/phpunitMock/articleGet-support-view.json +55 -0
  112. package/phpunitMock/articleGet-surveyDate-list.json +54 -0
  113. package/phpunitMock/articleGet-surveyDate-view.json +56 -0
  114. package/phpunitMock/objectListJamespotSpotQueryList-raw-list.json +51 -0
  115. package/phpunitMock/tvDisplayGetConfigureChannel-dynamic.json +2 -0
@@ -1,14 +1,10 @@
1
1
  import { JBaseApi } from '../base';
2
- import { ApiWrapper } from '../../types';
3
- export type AnimationVariant = 'Olympics' | 'Maythefourth' | 'Spring' | 'MusicFestival' | 'EasterEggs' | 'CustomAnimation';
4
- export type AnimationConfigurationType = {
5
- name: AnimationVariant;
6
- activeClickEffect: number;
7
- activeDecor: number;
8
- auto: number;
9
- audience: string[];
10
- };
2
+ import { AnimationConfigurationType, ApiWrapper } from '../../types';
11
3
  export declare class JAnimationsApi extends JBaseApi {
12
- SaveAnimationConfiguration(animation: Object | null): Promise<ApiWrapper<boolean>>;
13
- GetCurrentAnimation(checkAudience?: boolean): Promise<ApiWrapper<AnimationConfigurationType>>;
4
+ SaveAnimationConfiguration(animation: Object): Promise<ApiWrapper<AnimationConfigurationType>>;
5
+ DeleteAnimation(): Promise<ApiWrapper<boolean>>;
6
+ GetCurrentAnimation(): Promise<ApiWrapper<AnimationConfigurationType | null>>;
7
+ GetCurrentAnimationApp(): Promise<ApiWrapper<AnimationConfigurationType | null>>;
8
+ ToggleAnimationActive(): Promise<ApiWrapper<boolean>>;
9
+ GetAnimationActive(): Promise<ApiWrapper<boolean>>;
14
10
  }
@@ -1,4 +1,9 @@
1
- import { ApiWrapper } from '../../types';
2
- import { AnimationConfigurationType } from './animations';
3
- export declare const animationsSaveConfiguration: ApiWrapper<boolean>;
1
+ import { AnimationConfigurationType, ApiWrapper } from '../../types';
2
+ export declare const animationsSaveConfiguration: ApiWrapper<AnimationConfigurationType>;
4
3
  export declare const animationsGetConfiguration: ApiWrapper<AnimationConfigurationType>;
4
+ export declare const animationsGetConfigurationWithoutMe: ApiWrapper<null>;
5
+ export declare const animationsDeleteCurrentAnimations: ApiWrapper<boolean>;
6
+ export declare const animationsGetConfigurationApp: ApiWrapper<AnimationConfigurationType>;
7
+ export declare const animationsGetConfigurationAppWithoutMeIn: ApiWrapper<AnimationConfigurationType>;
8
+ export declare const animationsGetAnimationActive: ApiWrapper<boolean>;
9
+ export declare const animationsToggleAnimationActive: ApiWrapper<boolean>;
@@ -1,8 +1,26 @@
1
- import { ApiWrapper, BaseMessages, PagingResults, jArticleList, jArticleLittle, jArticleView, jArticleWidgetLittle, jFileLittle, ApiDefaultWrapper } from '../../types';
1
+ import { ApiWrapper, BaseMessages, PagingResults, jArticleExtendView, jArticleList, jArticleLittle, jArticleView, jArticleWidgetLittle, jFileLittle, ApiDefaultWrapper } from '../../types';
2
2
  import { jCommentList } from '../../types/comment';
3
+ import { jMeetingList, jMeetingView } from '../../types/meeting';
4
+ import { jPollSurveyList, jPollSurveyView } from '../../types/pollSurvey';
5
+ import { jQuizzList, jQuizzView } from '../../types/quizz';
6
+ import { jSocialEventList, jSocialEventView } from '../../types/socialEvent';
7
+ import { jSupportList, jSupportView } from '../../types/support';
8
+ import { jSurveyDateList, jSurveyDateView } from '../../types/surveyDate';
3
9
  export declare const articleGetMpArticleList: ApiWrapper<jArticleList, BaseMessages>;
4
10
  export declare const articleCreateMpArticleLittle: ApiWrapper<Array<jArticleLittle>, BaseMessages>;
5
- export declare const articleUpdateMpArticleView: ApiWrapper<jArticleView, BaseMessages>;
11
+ export declare const articleGetMeetingList: ApiWrapper<jMeetingList>;
12
+ export declare const articleGetMeetingView: ApiWrapper<jMeetingView & jArticleExtendView>;
13
+ export declare const articleGetPollSurveyList: ApiWrapper<jPollSurveyList>;
14
+ export declare const articleGetPollSurveyView: ApiWrapper<jPollSurveyView & jArticleExtendView>;
15
+ export declare const articleGetQuizzList: ApiWrapper<jQuizzList>;
16
+ export declare const articleGetQuizzView: ApiWrapper<jQuizzView & jArticleExtendView>;
17
+ export declare const articleGetSocialEventList: ApiWrapper<jSocialEventList>;
18
+ export declare const articleGetSocialEventView: ApiWrapper<jSocialEventView & jArticleExtendView>;
19
+ export declare const articleGetSupportList: ApiWrapper<jSupportList>;
20
+ export declare const articleGetSupportView: ApiWrapper<jSupportView & jArticleExtendView>;
21
+ export declare const articleGetSurveyDateList: ApiWrapper<jSurveyDateList>;
22
+ export declare const articleGetSurveyDateView: ApiWrapper<jSurveyDateView & jArticleExtendView>;
23
+ export declare const articleUpdateMpArticleView: ApiWrapper<jArticleView & jArticleExtendView, BaseMessages>;
6
24
  export declare const articleCountMpArticle: ApiWrapper<number>;
7
25
  export declare const articleWithWidget: ApiWrapper<jArticleWidgetLittle>;
8
26
  export declare const objectListJamespotArticleQueryList: ApiWrapper<PagingResults<jArticleLittle>>;
@@ -10,7 +10,7 @@ export interface ListFilterSpec {
10
10
  export declare class JBookmarkApi extends JBaseApi {
11
11
  getFormattedList<T extends keyof BookmarkTypes>(filterSpecs: ListFilterSpec, format: T): Promise<ApiWrapper<PagingResults<BookmarkTypes[T]>, import("../../types").BaseMessages>>;
12
12
  addFormattedLink<T extends keyof BookmarkTypes>(targetId: number, targetType: string, format: T): Promise<ApiWrapper<BookmarkTypes[T], import("../../types").BaseMessages>>;
13
- addBookmark(bookmark: Pick<BookmarkTypes[keyof BookmarkTypes], 'bookmarkLabel' | 'bookmarkMeta' | 'bookmarkUrl'>, format?: keyof BookmarkTypes): Promise<ApiWrapper<import("../../types").BookmarkRawList<import("../../types").jObjectLittle | import("../../types").jUserLittle> | import("../../types").BookmarkList<import("../../types").jObjectLittle>, BaseMessagesOne>>;
13
+ addBookmark(bookmark: Pick<BookmarkTypes[keyof BookmarkTypes], 'bookmarkLabel' | 'bookmarkMeta' | 'bookmarkUrl'>, format?: keyof BookmarkTypes): Promise<ApiWrapper<import("../../types").BookmarkList<import("../../types").jObjectLittle> | import("../../types").BookmarkRawList<import("../../types").jObjectLittle | import("../../types").jUserLittle>, BaseMessagesOne>>;
14
14
  delete(bookmarkId: number): Promise<ApiWrapper<null, BaseMessagesOne>>;
15
15
  rename(bookmarkID: number, bookmarkLabel: string, bookmarkUrl?: string): Promise<ApiWrapper<null, BaseMessagesOne>>;
16
16
  move(bookmarkID: number, bookmarkReference: number, position: 'before' | 'after'): Promise<ApiWrapper<null, BaseMessagesOne>>;
@@ -10,7 +10,7 @@ export declare class JDriveApi extends JBaseApi {
10
10
  * Microsoft graph only
11
11
  * @returns
12
12
  */
13
- groups(): Promise<ApiWrapper<MSGroupEntity[]>>;
13
+ groups(query?: string, filter?: string): Promise<ApiWrapper<MSGroupEntity[]>>;
14
14
  /**
15
15
  * Microsoft graph only
16
16
  * @returns
@@ -1,6 +1,6 @@
1
- import { Category, CreateGroup, GroupList, GroupProperties, GroupUserLevel, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup } from '../../types/group';
1
+ import { Category, CreateGroup, GroupList, GroupListConfig, GroupProperties, GroupUserLevel, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup } from '../../types/group';
2
2
  import { JBaseApi } from '../base';
3
- import { ApiReturn, Format, PagingResults, jObjectLittle, jSpotAutocomplete, jUserLittle } from '../../types';
3
+ import { ApiReturn, ApiWrapper, Format, PagingResults, jObjectLittle, jSpotAutocomplete, jUserLittle } from '../../types';
4
4
  export declare class JGroupApi extends JBaseApi {
5
5
  /**
6
6
  * autocomplete return a list of groups
@@ -13,36 +13,36 @@ export declare class JGroupApi extends JBaseApi {
13
13
  * @param format return format
14
14
  * @returns
15
15
  */
16
- create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, jObjectLittle>, import("../../types").BaseMessages>>;
16
+ create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, jObjectLittle>, import("../../types").BaseMessages>>;
17
17
  /**
18
18
  * Update a group
19
19
  * @param group group to update. The uri is mandatory and identify the group to update
20
20
  * @param format return format
21
21
  * @returns
22
22
  */
23
- update<T extends Format = undefined>(group: UpdateGroup, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
23
+ update<T extends Format = undefined>(group: UpdateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
24
24
  /**
25
25
  * Get a spot
26
26
  * @param idSpot
27
27
  * @param format
28
28
  * @returns
29
29
  */
30
- getSpot<T extends Format = undefined>(idSpot: number | string, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
30
+ getSpot<T extends Format = undefined>(idSpot: number | string, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
31
31
  /**
32
32
  * Get the properties of a group that are not within the model
33
33
  * @param idSpot
34
34
  * @returns
35
35
  */
36
- getProperties(idSpot: number | string): Promise<import("../../types").ApiWrapper<GroupProperties, import("../../types").BaseMessages>>;
36
+ getProperties(idSpot: number | string): Promise<ApiWrapper<GroupProperties, import("../../types").BaseMessages>>;
37
37
  /**
38
38
  * Get the available applications that can be added to a group
39
39
  */
40
- getApplications(): Promise<import("../../types").ApiWrapper<Record<string, GroupWidget>, import("../../types").BaseMessages>>;
40
+ getApplications(): Promise<ApiWrapper<Record<string, GroupWidget>, import("../../types").BaseMessages>>;
41
41
  /**
42
42
  * Get the available group categories
43
43
  * @returns
44
44
  */
45
- getCategories(): Promise<import("../../types").ApiWrapper<Category[], import("../../types").BaseMessages>>;
45
+ getCategories(): Promise<ApiWrapper<Category[], import("../../types").BaseMessages>>;
46
46
  /**
47
47
  * Get the members of a group
48
48
  * @param idSpot spot id
@@ -51,16 +51,17 @@ export declare class JGroupApi extends JBaseApi {
51
51
  * @param page page number
52
52
  * @return array of User
53
53
  */
54
- getObjectListJamespotSpotMembers(idSpot: number | string, query?: string, limit?: number, page?: number): Promise<import("../../types").ApiWrapper<PagingResults<{
54
+ getObjectListJamespotSpotMembers(idSpot: number | string, query?: string, limit?: number, page?: number): Promise<ApiWrapper<PagingResults<{
55
55
  level: GroupUserLevel;
56
56
  user: jUserLittle;
57
57
  }>, import("../../types").BaseMessages>>;
58
+ list<T extends GroupList = GroupList>(config: GroupListConfig): Promise<ApiWrapper<PagingResults<T>>>;
58
59
  /**
59
60
  * Reset the notifications configuration for all users of the group
60
61
  * @param config configuration
61
62
  * @returns
62
63
  */
63
- resetNotifications(config: ResetNotificationConfiguration): Promise<import("../../types").ApiWrapper<{
64
+ resetNotifications(config: ResetNotificationConfiguration): Promise<ApiWrapper<{
64
65
  members: number;
65
66
  msg: string;
66
67
  }, import("../../types").BaseMessages>>;
@@ -1,5 +1,5 @@
1
1
  import { ApiPagingResults, ApiWrapper, jSpotAutocomplete } from '../../types';
2
- import { Category, GroupMemberLevel, GroupProperties, GroupView, GroupWidget } from '../../types/group';
2
+ import { Category, GroupMemberLevel, GroupProperties, GroupView, GroupWidget, jGroupList } from '../../types/group';
3
3
  export declare const spot: ApiWrapper<GroupView>;
4
4
  export declare const properties: ApiWrapper<GroupProperties>;
5
5
  export declare const groupAutocompleteA: ApiWrapper<jSpotAutocomplete[]>;
@@ -8,6 +8,7 @@ export declare const groupUpdate: ApiWrapper<GroupView>;
8
8
  export declare const groupGetAvailableWidget: ApiWrapper<Record<string, GroupWidget>>;
9
9
  export declare const groupGetCategories: ApiWrapper<Category[]>;
10
10
  export declare const groupObjectListJamespotSpotMembers: ApiPagingResults<GroupMemberLevel>;
11
+ export declare const groupList: ApiPagingResults<jGroupList>;
11
12
  export declare const groupResetNotification: ApiWrapper<{
12
13
  members: number;
13
14
  msg: string;
@@ -0,0 +1,8 @@
1
+ export type AnimationVariant = 'Olympics' | 'Maythefourth' | 'Spring' | 'MusicFestival' | 'EasterEggs' | 'CustomAnimation';
2
+ export type AnimationConfigurationType = {
3
+ name: AnimationVariant;
4
+ activeClickEffect: number;
5
+ activeDecor: number;
6
+ auto: boolean;
7
+ audience: string[];
8
+ };
@@ -35,4 +35,5 @@ export type DriveDocumentParams = {
35
35
  idFolder: string | undefined;
36
36
  page: number;
37
37
  limit: number;
38
+ query?: string | null;
38
39
  };
@@ -1,5 +1,5 @@
1
1
  import { jUserLittle } from './user';
2
- import { jObjectLittle } from './utils';
2
+ import { Filters, Orders, jObjectBase, jObjectLittle } from './utils';
3
3
  export type CreateGroup = {
4
4
  type: string;
5
5
  title: string;
@@ -117,6 +117,7 @@ export interface Category {
117
117
  idorder: number;
118
118
  label: string;
119
119
  }
120
+ export type jGroupList = jObjectBase & GroupLittle;
120
121
  export type GroupLittle = jObjectLittle & {
121
122
  dateCreation: string;
122
123
  dateModified: string;
@@ -141,3 +142,12 @@ export type ResetNotificationConfiguration = {
141
142
  mailComment: boolean;
142
143
  mailSubscriber: boolean;
143
144
  };
145
+ export type GroupListConfig = {
146
+ type?: string;
147
+ format?: string;
148
+ query?: string;
149
+ limit?: number;
150
+ page?: number;
151
+ orders?: Orders;
152
+ filters?: Filters | undefined;
153
+ };
@@ -1,6 +1,7 @@
1
1
  export * from './adminLicence';
2
2
  export * from './adminStore';
3
3
  export * from './adminUtils';
4
+ export * from './animations';
4
5
  export * from './article';
5
6
  export * from './asei';
6
7
  export * from './assetReservation';
@@ -0,0 +1,12 @@
1
+ import { jSocialEventList } from './socialEvent';
2
+ import { jArticleView } from './utils';
3
+ export type jMeetingList = jSocialEventList & {};
4
+ export type jMeetingView = jArticleView & jMeetingList & {
5
+ allDay: null;
6
+ agenda: string;
7
+ useQrcode: null;
8
+ textColor: string;
9
+ bgColor: string;
10
+ report: string;
11
+ reportFile: [];
12
+ };
@@ -108,7 +108,7 @@ export type WidgetUri = {
108
108
  type: string;
109
109
  };
110
110
  };
111
- export type Widget = WidgetText | WidgetTextarea | WidgetNumber | WidgetDate | WidgetDatetime | WidgetDatePicker | WidgetSelect | WidgetEmail | WidgetUrl | WidgetRefUser | WidgetRadio | WidgetCheckbox | WidgetOrientedlinks | WidgetTaxonomy | WidgetUri | WidgetTransient | WidgetMultiattribute | WidgetFile;
111
+ export type Widget = WidgetText | WidgetTextarea | WidgetNumber | WidgetDate | WidgetDatetime | WidgetDatePicker | WidgetSelect | WidgetEmail | WidgetUrl | WidgetRefUser | WidgetRadio | WidgetCheckbox | WidgetOrientedlinks | WidgetTaxonomy | WidgetUri | WidgetTransient | WidgetMultiattribute | WidgetTel | WidgetPlace | WidgetColor | WidgetLink | WidgetFile;
112
112
  export type WidgetsValue = WidgetActiveValue | WidgetDatePickerValue | WidgetDatetimeValue | WidgetDateValue | WidgetEmailValue | WidgetNumberValue | WidgetTextareaValue | WidgetTextValue | WidgetUrlValue;
113
113
  export type FieldConfiguration<T extends string = string> = {
114
114
  label: string;
@@ -0,0 +1,27 @@
1
+ import { jArticleList, jArticleView } from './utils';
2
+ export type jPollSurveyList = jArticleList & {
3
+ anonymousResponse: null;
4
+ multipleResponse: number;
5
+ publicResults: null;
6
+ pollProgression: {
7
+ colors: Record<string, string>;
8
+ maxRespondentsValue: number;
9
+ countRespondentsValue: number;
10
+ };
11
+ pollResponseShowProgression: number;
12
+ dateEnd: string;
13
+ status: {
14
+ name: string;
15
+ value: number;
16
+ };
17
+ };
18
+ export type jPollSurveyView = jArticleView & jPollSurveyList & {
19
+ pollContent: null;
20
+ pollLinks: null;
21
+ pollForceClose: null;
22
+ pollResponseUserVisibility: null;
23
+ pollResponseAuthorVisibility: null;
24
+ pollResponseShowRespondent: null;
25
+ pollBanner: [];
26
+ pollMessage: string;
27
+ };
@@ -0,0 +1,15 @@
1
+ import { jArticleList, jArticleView } from './utils';
2
+ export type jQuizzList = jArticleList & {
3
+ quizzDescription: string | null;
4
+ quizzClosingDate: string | null;
5
+ dateStart: string | null;
6
+ dateEnd: string | null;
7
+ };
8
+ export type jQuizzView = jArticleView & jQuizzList & {
9
+ quizzInvitation: null;
10
+ quizzFormSpec: string;
11
+ quizzRandom: null;
12
+ quizzHideResponses: null;
13
+ quizzStatus: null;
14
+ quizzPublicationDate: string | null;
15
+ };
@@ -1,10 +1,12 @@
1
1
  import { AllKeys, Readable, jObjectBase } from './utils';
2
2
  type BookmarksFunctions = 'update' | 'add' | 'delete';
3
+ type AnimationsFunctions = 'update' | 'add' | 'delete' | 'toggle' | 'getAnimationActive';
3
4
  type CustomActionFunctions = 'update' | 'add' | 'remove';
4
5
  type JamespotFunctions = 'comment-create' | 'comment-delete' | 'comment-update';
5
6
  type WSFunctions = 'presence' | 'connection' | 'disconnect';
6
7
  export type Namespaces = {
7
8
  BOOKMARKS: BookmarksFunctions;
9
+ ANIMATIONS: AnimationsFunctions;
8
10
  'CUSTOM-ACTION': CustomActionFunctions;
9
11
  JAMESPOT: JamespotFunctions;
10
12
  ws: WSFunctions;
@@ -15,6 +17,13 @@ export type AllMessages = {
15
17
  add: RTMessageObject<'BOOKMARKS', 'add'>;
16
18
  delete: RTMessageObject<'BOOKMARKS', 'delete'>;
17
19
  };
20
+ ANIMATIONS: {
21
+ update: RTMessage<'ANIMATIONS', 'update'>;
22
+ add: RTMessage<'ANIMATIONS', 'add'>;
23
+ delete: RTMessage<'ANIMATIONS', 'delete'>;
24
+ toggle: RTMessage<'ANIMATIONS', 'toggle'>;
25
+ getAnimationActive: RTMessage<'ANIMATIONS', 'getAnimationActive'>;
26
+ };
18
27
  'CUSTOM-ACTION': {
19
28
  update: RTMessageObject<'CUSTOM-ACTION', 'update'>;
20
29
  add: RTMessageObject<'CUSTOM-ACTION', 'add'>;
@@ -53,6 +62,6 @@ export type RTMessageObject<T extends keyof Namespaces, F extends Namespaces[T],
53
62
  export type RTMessageWsPresence = RTMessage<'ws', 'presence'> & {
54
63
  idUsers: number[];
55
64
  };
56
- export type AnyRTMessage<T = {}> = RTMessageObject<'BOOKMARKS', 'update', T> | RTMessageObject<'BOOKMARKS', 'add', T> | RTMessageObject<'BOOKMARKS', 'delete', T> | RTMessageObject<'CUSTOM-ACTION', 'update', T> | RTMessageObject<'CUSTOM-ACTION', 'add', T> | RTMessageObject<'CUSTOM-ACTION', 'remove', T> | RTMessageObject<'JAMESPOT', 'comment-create', T> | RTMessageObject<'JAMESPOT', 'comment-delete', T> | RTMessageObject<'JAMESPOT', 'comment-update', T> | RTMessageWsPresence | RTMessage<'ws', 'connection'> | RTMessage<'ws', 'disconnect'>;
65
+ export type AnyRTMessage<T = {}> = RTMessageObject<'BOOKMARKS', 'update', T> | RTMessageObject<'BOOKMARKS', 'add', T> | RTMessageObject<'BOOKMARKS', 'delete'> | RTMessage<'ANIMATIONS', 'update'> | RTMessage<'ANIMATIONS', 'add'> | RTMessage<'ANIMATIONS', 'delete'> | RTMessage<'ANIMATIONS', 'toggle'> | RTMessage<'ANIMATIONS', 'getAnimationActive'> | RTMessageObject<'CUSTOM-ACTION', 'update', T> | RTMessageObject<'CUSTOM-ACTION', 'add', T> | RTMessageObject<'CUSTOM-ACTION', 'remove', T> | RTMessageObject<'JAMESPOT', 'comment-create', T> | RTMessageObject<'JAMESPOT', 'comment-delete', T> | RTMessageObject<'JAMESPOT', 'comment-update', T> | RTMessageWsPresence | RTMessage<'ws', 'connection'> | RTMessage<'ws', 'disconnect'>;
57
66
  export type RTReceivedMessage<T extends keyof Namespaces, F extends Namespaces[T]> = ['message', RTMessage<T, F>];
58
67
  export {};
@@ -0,0 +1,17 @@
1
+ import { jArticleList, jArticleView } from './utils';
2
+ export type jSocialEventList = jArticleList & {
3
+ place: string;
4
+ address: string;
5
+ dateStart: string;
6
+ dateEnd: string;
7
+ noGestion: null;
8
+ };
9
+ export type jSocialEventView = jArticleView & jSocialEventList & {
10
+ allDay: null;
11
+ useQrcode: null;
12
+ textColor: string;
13
+ bgColor: string;
14
+ socialEventUseCeiling: null;
15
+ socialEventCeiling: null;
16
+ hideFromCalendar: null;
17
+ };
@@ -0,0 +1,8 @@
1
+ import { jUserLittle } from './user';
2
+ import { jArticleList, jArticleView } from './utils';
3
+ export type jSupportList = jArticleList & {
4
+ supportStatus: number | string | null;
5
+ supportType: number | string | null;
6
+ supportOwner: jUserLittle[];
7
+ };
8
+ export type jSupportView = jArticleView & jSupportList & {};
@@ -0,0 +1,9 @@
1
+ import { jArticleList, jArticleLittle, jArticleView } from './utils';
2
+ export type jSurveyDateList = jArticleList & {
3
+ dates: string[];
4
+ dateStart: string | null;
5
+ dateEnd: string;
6
+ };
7
+ export type jSurveyDateView = jArticleView & jSurveyDateList & {
8
+ surveyObjectLink: jArticleLittle[];
9
+ };
@@ -1,6 +1,7 @@
1
1
  import { ImageSize } from './file';
2
2
  import { GroupLittle } from './group';
3
3
  import { jUserLittle } from './user';
4
+ import { WidgetWrapperProps } from './widgets';
4
5
  /**
5
6
  * Ease usage in IDE by decomposing complex types
6
7
  * Decompose combined types into simple object types
@@ -103,8 +104,13 @@ export type jArticleList = jArticleLittle & {
103
104
  _right: Rights;
104
105
  _audience: Audience[];
105
106
  image?: ImageSize;
107
+ articleWidgets?: WidgetWrapperProps[];
106
108
  };
107
109
  export type jArticleView = jArticleList & {};
110
+ export type jArticleExtendView = {
111
+ processContext?: null;
112
+ uiObjectLink?: jObjectLittle[];
113
+ };
108
114
  export type Order = {
109
115
  name: string;
110
116
  sort: 'ASC' | 'DESC';
@@ -34,6 +34,7 @@ export type WidgetTypeKeys = {
34
34
  'widget-article-text': WidgetArticleTextType;
35
35
  'widget-article-image': WidgetArticleImageType;
36
36
  'widget-article-attachment': WidgetArticleAttachmentType;
37
+ 'widget-api': WidgetApiType;
37
38
  'widget-article-slider': WidgetArticleSliderType;
38
39
  };
39
40
  export type WidgetContentKeys = {
@@ -43,12 +44,18 @@ export type WidgetContentKeys = {
43
44
  'widget-article-text': WidgetArticleTextContent;
44
45
  'widget-article-image': WidgetArticleImageContent;
45
46
  'widget-article-attachment': WidgetArticleAttachmentContent;
47
+ 'widget-api': WidgetApiContent;
46
48
  'widget-article-slider': WidgetArticleSliderContent;
47
49
  };
48
50
  export type WidgetKeys = keyof WidgetTypeKeys;
49
51
  export type WidgetExtendedType = {
50
52
  layers?: string[];
51
53
  };
54
+ export type WidgetApiType = {
55
+ name: 'widget-api';
56
+ uniqid: string;
57
+ content: WidgetApiContent;
58
+ };
52
59
  export type WidgetArticleButtonType = {
53
60
  name: 'widget-article-button';
54
61
  uniqid: string;
@@ -109,6 +116,12 @@ export type WidgetArticleTextContent = {
109
116
  lineHeight?: string;
110
117
  linkColor?: string;
111
118
  };
119
+ export type WidgetApiContent = {
120
+ url?: string;
121
+ keys?: string[];
122
+ order?: string;
123
+ orderBy?: string;
124
+ };
112
125
  export type OpeningTypeLink = {
113
126
  url: string;
114
127
  target: string;
@@ -120,7 +133,10 @@ export type OpeningTypePopup = {
120
133
  title: string;
121
134
  widgets: WidgetWrapperProps[];
122
135
  };
123
- export type WidgetArticleButtonContent = {
136
+ /**
137
+ * Widget button base properties
138
+ */
139
+ export type WidgetButtonProps = {
124
140
  text?: string;
125
141
  color?: string;
126
142
  backgroundColor?: string;
@@ -128,6 +144,10 @@ export type WidgetArticleButtonContent = {
128
144
  fontSize?: string;
129
145
  buttonSize?: VariantSizeType;
130
146
  variant?: VariantType;
147
+ url?: string;
148
+ target?: string;
149
+ };
150
+ export type WidgetArticleButtonContent = WidgetButtonProps & {
131
151
  openingType?: OpeningType;
132
152
  openingTypeLink?: OpeningTypeLink;
133
153
  openingTypeAnchor?: OpeningTypeAnchor;
@@ -158,7 +178,7 @@ export type WidgetArticleSliderContent = {
158
178
  };
159
179
  export type CombinedWidgetContent = {
160
180
  widgets?: WidgetWrapperProps[];
161
- } & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent | WidgetArticleSliderContent);
181
+ } & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent | WidgetApiContent | WidgetArticleSliderContent);
162
182
  export type WidgetStateProps = {
163
183
  busy?: boolean | undefined;
164
184
  loading?: boolean | undefined;
@@ -116,7 +116,7 @@ export declare const arrayRights: ({
116
116
  t: string;
117
117
  })[];
118
118
  export declare const fetchMock: <T>(data: T) => jest.Mock<Promise<FetchResponseType<T>>, []>;
119
- export declare const validateJArticle: <T extends jArticleLittle>(received: T, expected: T) => void;
119
+ export declare const validateJArticle: <T extends jArticleLittle>(received: T, expected: T, excludeFields?: string[]) => void;
120
120
  export declare const validateApiWrapper: <T extends ApiDefaultWrapper<import("../types").BaseMessages>>(res: T, o: string, f: string, error?: null) => void;
121
121
  export declare const validatePagingResults: <T>(res: PagingResults<T>) => void;
122
122
  export declare const validateObject: <T extends {
@@ -21,5 +21,5 @@ export declare const resolveFilePath: (file: jFileLittle, size?: string) => stri
21
21
  export declare const getFileFamilyFromName: (name: string) => fileFamilyTypes;
22
22
  export declare function getFileFamily(mimetype: string | undefined): fileFamilyTypes;
23
23
  export declare const resolveFileUrl: (idFile: number, hash: string, mode?: 'ng' | 'rr') => string;
24
- export declare const resolveFileMimetype: (file: jFileLittle) => string;
24
+ export declare const resolveFileMimetype: (file: Pick<jFileLittle, 'mimetype' | 'title'>) => string;
25
25
  export declare const resolveFileFamily: (file: jFileLittle) => fileFamilyTypes;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jamespot-user-api",
3
- "version": "1.0.146",
3
+ "version": "1.0.148",
4
4
  "main": "lib/jamespot-user-api.js",
5
5
  "types": "lib/src/index.d.ts",
6
6
  "directories": {
@@ -0,0 +1 @@
1
+ { "o": "animations", "f": "deleteAnimation", "error": 0, "messages": [], "result": true }
@@ -0,0 +1 @@
1
+ { "o": "animations", "f": "getAnimationActive", "error": 0, "messages": [], "result": true }
@@ -7,7 +7,7 @@
7
7
  "name": "MusicFestival",
8
8
  "activeClickEffect": 1,
9
9
  "activeDecor": 0,
10
- "auto": 1,
11
- "audience": ["networkPublic\\/1"]
10
+ "auto": true,
11
+ "audience": ["networkPublic/1"]
12
12
  }
13
13
  }
@@ -0,0 +1 @@
1
+ { "o": "animations", "f": "getConfiguration", "error": 0, "messages": [], "result": null }
@@ -0,0 +1,13 @@
1
+ {
2
+ "o": "animations",
3
+ "f": "getConfigurationApp",
4
+ "error": 0,
5
+ "messages": [],
6
+ "result": {
7
+ "name": "MusicFestival",
8
+ "activeClickEffect": 1,
9
+ "activeDecor": 0,
10
+ "auto": true,
11
+ "audience": ["networkPublic/1"]
12
+ }
13
+ }
@@ -0,0 +1,13 @@
1
+ {
2
+ "o": "animations",
3
+ "f": "getConfigurationApp",
4
+ "error": 0,
5
+ "messages": [],
6
+ "result": {
7
+ "name": "Maythefourth",
8
+ "activeClickEffect": 1,
9
+ "activeDecor": 0,
10
+ "auto": false,
11
+ "audience": ["user/5"]
12
+ }
13
+ }
@@ -1 +1,13 @@
1
- { "o": "animations", "f": "saveConfiguration", "error": 0, "messages": [], "result": true }
1
+ {
2
+ "o": "animations",
3
+ "f": "saveConfiguration",
4
+ "error": 0,
5
+ "messages": [{ "code": 200, "msg": "Enregistrement r\u00e9ussi" }],
6
+ "result": {
7
+ "name": "MusicFestival",
8
+ "activeClickEffect": 1,
9
+ "activeDecor": 0,
10
+ "auto": true,
11
+ "audience": ["networkPublic/1"]
12
+ }
13
+ }
@@ -0,0 +1,7 @@
1
+ {
2
+ "o": "animations",
3
+ "f": "toggleAnimationActive",
4
+ "error": 0,
5
+ "messages": [{ "code": 200, "msg": "Enregistrement r\u00e9ussi" }],
6
+ "result": false
7
+ }
@@ -0,0 +1,55 @@
1
+ {
2
+ "o": "article",
3
+ "f": "get",
4
+ "error": 0,
5
+ "messages": [],
6
+ "result": {
7
+ "id": 432,
8
+ "mainType": "article",
9
+ "type": "meeting",
10
+ "uri": "meeting/432",
11
+ "dateCreation": "2024-01-26 11:03:59",
12
+ "dateModified": "2024-01-26 11:03:59",
13
+ "title": "Test meeting notifications (live - 1706263439)",
14
+ "_url": "/article/432",
15
+ "_right": {
16
+ "create": true,
17
+ "read": true,
18
+ "publish": false,
19
+ "administrate": true,
20
+ "update": true,
21
+ "delete": true,
22
+ "comment": true,
23
+ "member": true
24
+ },
25
+ "_user": {
26
+ "id": 1,
27
+ "mainType": "user",
28
+ "type": "user",
29
+ "uri": "user/1",
30
+ "dateCreation": "2019-03-26 16:29:33",
31
+ "dateModified": "2024-01-25 10:21:28",
32
+ "title": "AdminJenkins",
33
+ "_url": "/user/1",
34
+ "level": 9
35
+ },
36
+ "_audience": [
37
+ {
38
+ "id": 6,
39
+ "mainType": "user",
40
+ "type": "user",
41
+ "uri": "user/6",
42
+ "dateCreation": "2019-07-09 15:49:06",
43
+ "dateModified": "2024-01-25 10:23:18",
44
+ "title": "User1",
45
+ "_url": "/user/6",
46
+ "level": 5
47
+ }
48
+ ],
49
+ "place": "",
50
+ "address": "",
51
+ "dateStart": "2024-01-26 11:03:58",
52
+ "dateEnd": "2024-01-26 14:03:58",
53
+ "noGestion": null
54
+ }
55
+ }