jamespot-user-api 1.0.156 → 1.0.158

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 (76) 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 +9 -9
  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/TaxonomyCreate.html +1 -1
  65. package/documentation/interfaces/WindowInterface.html +1 -1
  66. package/documentation/modules.html +11 -11
  67. package/lib/jamespot-user-api.js +1 -1
  68. package/lib/jamespot-user-api.js.map +1 -1
  69. package/lib/src/apis/widget/widget.d.ts +12 -0
  70. package/lib/src/apis/widget/widget.mock.d.ts +1 -0
  71. package/lib/src/types/article.d.ts +5 -2
  72. package/lib/src/types/comment.d.ts +5 -3
  73. package/lib/src/types/hook.d.ts +66 -0
  74. package/lib/src/types/utils.d.ts +4 -0
  75. package/lib/src/types/widgets.d.ts +43 -2
  76. package/package.json +1 -1
@@ -2,4 +2,16 @@ import { ApiWrapper, 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[]>>;
5
+ removeWidget({ id, type, uniqid }: {
6
+ id: number;
7
+ type: string;
8
+ uniqid: string;
9
+ }): Promise<ApiWrapper<[]>>;
10
+ checkListRespond({ id, type, idUser, uniqid, index, }: {
11
+ id: number;
12
+ type: string;
13
+ idUser: number;
14
+ uniqid: string;
15
+ index: number;
16
+ }): Promise<ApiWrapper<[]>>;
5
17
  }
@@ -1,2 +1,3 @@
1
1
  import { ApiWrapper, jUserLittle } from '../../types';
2
2
  export declare const widgetResponseUserList: ApiWrapper<jUserLittle[]>;
3
+ export declare const widgetResponseRemoveWidget: ApiWrapper<[]>;
@@ -1,4 +1,5 @@
1
1
  import { Filters, Orders } from './utils';
2
+ import { WidgetWrapperProps } from './widgets';
2
3
  export type ArticleListConfig = {
3
4
  type?: string;
4
5
  format?: string;
@@ -42,11 +43,13 @@ export type AddCommentParams = {
42
43
  idArticle: number;
43
44
  sendAlert: boolean;
44
45
  alertAuthor: boolean;
46
+ widgets?: WidgetWrapperProps[];
45
47
  };
46
48
  export type UpdateCommentParams = {
47
- token: string;
48
- description: string;
49
+ token?: string;
50
+ description?: string;
49
51
  idComment: number;
52
+ widgets?: WidgetWrapperProps[];
50
53
  };
51
54
  export type UserRead = {
52
55
  idUser: string;
@@ -1,9 +1,10 @@
1
- import { jUserLittle } from './user';
2
- import { Readable } from './utils';
1
+ import { Rights } from './common';
3
2
  import { jFileLittle } from './file';
4
3
  import { SocialAction } from './global';
5
4
  import { jObjectBase } from './object';
6
- import { Rights } from './common';
5
+ import { jUserLittle } from './user';
6
+ import { Readable } from './utils';
7
+ import { WidgetWrapperProps } from './widgets';
7
8
  export type jCommentLittle = Readable<Omit<jObjectBase, 'dateModified'> & {
8
9
  dateCreation: string;
9
10
  dateModified: string | null;
@@ -14,4 +15,5 @@ export type jCommentList = jCommentLittle & {
14
15
  _right: Rights;
15
16
  _attachedFiles?: jFileLittle[];
16
17
  _actions?: Record<string, SocialAction>;
18
+ _widgets?: WidgetWrapperProps[];
17
19
  };
@@ -57,6 +57,31 @@ declare const fileBankHookSchema: z.ZodIntersection<z.ZodObject<{
57
57
  order: "ASC" | "DESC";
58
58
  }>>;
59
59
  export type FileBankHook = z.infer<typeof fileBankHookSchema>;
60
+ declare const spotRssFeedSchema: z.ZodIntersection<z.ZodObject<{
61
+ isActive: z.ZodBoolean;
62
+ }, "strip", z.ZodTypeAny, {
63
+ isActive: boolean;
64
+ }, {
65
+ isActive: boolean;
66
+ }>, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
67
+ export type SpotRssFeed = z.infer<typeof spotRssFeedSchema>;
68
+ declare const widgetHookSchema: z.ZodIntersection<z.ZodObject<{
69
+ isActive: z.ZodBoolean;
70
+ }, "strip", z.ZodTypeAny, {
71
+ isActive: boolean;
72
+ }, {
73
+ isActive: boolean;
74
+ }>, z.ZodObject<{
75
+ create: z.ZodBoolean;
76
+ autorize: z.ZodArray<z.ZodOptional<z.ZodEnum<["message", "comment", "board", "article"]>>, "many">;
77
+ }, "strip", z.ZodTypeAny, {
78
+ create: boolean;
79
+ autorize: ("comment" | "message" | "board" | "article" | undefined)[];
80
+ }, {
81
+ create: boolean;
82
+ autorize: ("comment" | "message" | "board" | "article" | undefined)[];
83
+ }>>;
84
+ export type WidgetHook = z.infer<typeof widgetHookSchema>;
60
85
  /**
61
86
  * HookListType
62
87
  */
@@ -103,6 +128,29 @@ declare const hookListTypeSchema: z.ZodObject<{
103
128
  orderBy: string;
104
129
  order: "ASC" | "DESC";
105
130
  }>>>;
131
+ spotRssFeed: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
132
+ isActive: z.ZodBoolean;
133
+ }, "strip", z.ZodTypeAny, {
134
+ isActive: boolean;
135
+ }, {
136
+ isActive: boolean;
137
+ }>, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>>;
138
+ WidgetHook: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
139
+ isActive: z.ZodBoolean;
140
+ }, "strip", z.ZodTypeAny, {
141
+ isActive: boolean;
142
+ }, {
143
+ isActive: boolean;
144
+ }>, z.ZodObject<{
145
+ create: z.ZodBoolean;
146
+ autorize: z.ZodArray<z.ZodOptional<z.ZodEnum<["message", "comment", "board", "article"]>>, "many">;
147
+ }, "strip", z.ZodTypeAny, {
148
+ create: boolean;
149
+ autorize: ("comment" | "message" | "board" | "article" | undefined)[];
150
+ }, {
151
+ create: boolean;
152
+ autorize: ("comment" | "message" | "board" | "article" | undefined)[];
153
+ }>>>;
106
154
  }, "strip", z.ZodTypeAny, {
107
155
  DriveHook?: ({
108
156
  isActive: boolean;
@@ -120,6 +168,15 @@ declare const hookListTypeSchema: z.ZodObject<{
120
168
  orderBy: string;
121
169
  order: "ASC" | "DESC";
122
170
  }) | undefined;
171
+ spotRssFeed?: ({
172
+ isActive: boolean;
173
+ } & {}) | undefined;
174
+ WidgetHook?: ({
175
+ isActive: boolean;
176
+ } & {
177
+ create: boolean;
178
+ autorize: ("comment" | "message" | "board" | "article" | undefined)[];
179
+ }) | undefined;
123
180
  }, {
124
181
  DriveHook?: ({
125
182
  isActive: boolean;
@@ -137,6 +194,15 @@ declare const hookListTypeSchema: z.ZodObject<{
137
194
  orderBy: string;
138
195
  order: "ASC" | "DESC";
139
196
  }) | undefined;
197
+ spotRssFeed?: ({
198
+ isActive: boolean;
199
+ } & {}) | undefined;
200
+ WidgetHook?: ({
201
+ isActive: boolean;
202
+ } & {
203
+ create: boolean;
204
+ autorize: ("comment" | "message" | "board" | "article" | undefined)[];
205
+ }) | undefined;
140
206
  }>;
141
207
  export type HookListType = z.infer<typeof hookListTypeSchema>;
142
208
  export declare const validateIsFormatHookListType: (object: object) => HookListType;
@@ -71,6 +71,10 @@ export type jLinkList<T extends jObjectBase = jObjectLittle | jUserLittle> = jLi
71
71
  _src?: T;
72
72
  _target?: T | undefined;
73
73
  };
74
+ export type jHref = {
75
+ href: string;
76
+ target: string;
77
+ };
74
78
  export type jArticleLittle = jObjectLittle & {
75
79
  dateCreation: string;
76
80
  dateModified: string;
@@ -1,6 +1,7 @@
1
1
  import { AudienceAutocomplete } from './autocomplete';
2
2
  import { jFileLittle } from './file';
3
- import { jArticleList, jArticleLittle } from './utils';
3
+ import { jUserLittle } from './user';
4
+ import { jArticleList, jArticleLittle, jHref } from './utils';
4
5
  export type jArticleWidgetLittle = jArticleLittle & {
5
6
  articleWidgets: WidgetWrapperProps[];
6
7
  articleWidgetDisplayMode: null | undefined | string;
@@ -36,6 +37,7 @@ export type WidgetTypeKeys = {
36
37
  'widget-article-attachment': WidgetArticleAttachmentType;
37
38
  'widget-api': WidgetApiType;
38
39
  'widget-article-slider': WidgetArticleSliderType;
40
+ 'widget-check-list': WidgetCheckListType;
39
41
  };
40
42
  export type WidgetContentKeys = {
41
43
  'widget-article-button': WidgetArticleButtonContent;
@@ -46,6 +48,7 @@ export type WidgetContentKeys = {
46
48
  'widget-article-attachment': WidgetArticleAttachmentContent;
47
49
  'widget-api': WidgetApiContent;
48
50
  'widget-article-slider': WidgetArticleSliderContent;
51
+ 'widget-check-list': WidgetCheckListContent;
49
52
  };
50
53
  export type WidgetKeys = keyof WidgetTypeKeys;
51
54
  export type WidgetExtendedType = {
@@ -91,6 +94,18 @@ export type WidgetArticleSliderType = {
91
94
  uniqid: string;
92
95
  content: WidgetArticleSliderContent;
93
96
  };
97
+ export type WidgetCheckListType = {
98
+ title: string;
99
+ name: 'widget-check-list';
100
+ uniqid: string;
101
+ content: WidgetCheckListContent;
102
+ };
103
+ export type WidgetCheckListTypeForFront = {
104
+ title: string;
105
+ name: 'widget-check-list';
106
+ uniqid: string;
107
+ content: WidgetCheckListContentForFront;
108
+ };
94
109
  export type CSSTextAlignType = 'left' | 'right' | 'center' | 'justify';
95
110
  export type CSSBackgroundPosition = 'top' | 'bottom' | 'center' | 'left' | 'right';
96
111
  export type CSSBackgroundSize = 'auto' | 'contain' | 'cover';
@@ -176,9 +191,35 @@ export type WidgetArticleSliderContent = {
176
191
  useDots?: boolean;
177
192
  startAt?: number;
178
193
  };
194
+ export type WidgetCheckListContent = {
195
+ arr?: WidgetCheckListContentArr[];
196
+ };
197
+ export type WidgetCheckListContentForFront = {
198
+ arr?: WidgetCheckListContentArrForFront[];
199
+ };
200
+ export type WidgetCheckListContentArr = {
201
+ title: string;
202
+ value?: boolean;
203
+ links?: jHref[];
204
+ id?: number;
205
+ user?: {
206
+ id: number;
207
+ type: 'user';
208
+ mainType: 'user';
209
+ };
210
+ };
211
+ export type WidgetCheckListContentArrForFront = {
212
+ text: string;
213
+ value?: boolean;
214
+ links?: jHref[];
215
+ uri?: string;
216
+ mimetype?: string;
217
+ id?: number;
218
+ user?: jUserLittle;
219
+ };
179
220
  export type CombinedWidgetContent = {
180
221
  widgets?: WidgetWrapperProps[];
181
- } & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent | WidgetApiContent | WidgetArticleSliderContent);
222
+ } & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent | WidgetApiContent | WidgetArticleSliderContent | WidgetCheckListContent);
182
223
  export type WidgetStateProps = {
183
224
  busy?: boolean | undefined;
184
225
  loading?: boolean | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jamespot-user-api",
3
- "version": "1.0.156",
3
+ "version": "1.0.158",
4
4
  "main": "lib/jamespot-user-api.js",
5
5
  "types": "lib/src/index.d.ts",
6
6
  "directories": {