jamespot-user-api 1.0.139 → 1.0.141

package/lib/src/types/widgets.d.ts

@@ -1,8 +1,9 @@
 import { AudienceAutocomplete } from './autocomplete';
 import { jFileLittle } from './file';
-import { jArticleLittle } from './utils';
+import { jArticleList, jArticleLittle } from './utils';
 export type jArticleWidgetLittle = jArticleLittle & {
     articleWidgets: WidgetWrapperProps[];
+    articleWidgetDisplayMode: null | undefined | string;
 };
 export type WidgetLayer = {
     uniqid: string;
@@ -33,6 +34,7 @@ export type WidgetTypeKeys = {
     'widget-article-text': WidgetArticleTextType;
     'widget-article-image': WidgetArticleImageType;
     'widget-article-attachment': WidgetArticleAttachmentType;
+    'widget-article-slider': WidgetArticleSliderType;
 };
 export type WidgetContentKeys = {
     'widget-article-button': WidgetArticleButtonContent;
@@ -41,6 +43,7 @@ export type WidgetContentKeys = {
     'widget-article-text': WidgetArticleTextContent;
     'widget-article-image': WidgetArticleImageContent;
     'widget-article-attachment': WidgetArticleAttachmentContent;
+    'widget-article-slider': WidgetArticleSliderContent;
 };
 export type WidgetKeys = keyof WidgetTypeKeys;
 export type WidgetExtendedType = {
@@ -76,6 +79,11 @@ export type WidgetArticleAttachmentType = {
     uniqid: string;
     content: WidgetArticleAttachmentContent;
 };
+export type WidgetArticleSliderType = {
+    name: 'widget-article-slider';
+    uniqid: string;
+    content: WidgetArticleSliderContent;
+};
 export type CSSTextAlignType = 'left' | 'right' | 'center' | 'justify';
 export type CSSBackgroundPosition = 'top' | 'bottom' | 'center' | 'left' | 'right';
 export type CSSBackgroundSize = 'auto' | 'contain' | 'cover';
@@ -128,18 +136,29 @@ export type WidgetArticleButtonContent = {
 export type WidgetArticleImageContent = {
     file?: jFileLittle;
     useFilter?: boolean;
-    displayAs?: 'image' | 'background';
-    backgroundPosition?: CSSBackgroundPosition;
-    backgroundSize?: CSSBackgroundSize;
-    borderRadius?: string;
 };
 export type WidgetArticleAttachmentContent = {
     files?: jFileLittle[];
     fileDisplay?: 'list' | 'gallery';
 };
+export type WidgetArticleSliderContent = {
+    slides?: {
+        title: string;
+        text: string;
+        titleHeading?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span';
+        textColor?: string;
+        opacityFilter?: number;
+        opacityColor?: string;
+        file?: jFileLittle;
+    }[];
+    maxWidth?: number;
+    loop?: boolean;
+    useDots?: boolean;
+    startAt?: number;
+};
 export type CombinedWidgetContent = {
     widgets?: WidgetWrapperProps[];
-} & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent);
+} & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent | WidgetArticleSliderContent);
 export type WidgetStateProps = {
     busy?: boolean | undefined;
     loading?: boolean | undefined;
@@ -163,16 +182,6 @@ export type WidgetVector = {
     x: number;
     y: number;
 };
-export type WidgetFileType = {
-    id: number;
-    filename: string;
-    name?: string;
-    mimetype: string;
-    dimension: {
-        width: number;
-        height: number;
-    };
-};
 export type WidgetDisplayMode = 'edit' | 'view' | 'preview';
 export type WidgetModalProps = {
     title?: string;
@@ -194,8 +203,10 @@ export type WidgetsState = {
     currentEditableIndex: number;
     currentEditableWidgetId: string | undefined;
 };
-export type ArticleWidgetType = jArticleLittle & {
+export type ArticleDisplayMode = 'default' | 'vertical';
+export type ArticleWidgetType = jArticleList & {
     articleWidgets: WidgetWrapperProps[];
     articleWidgetsCover: number | undefined;
+    articleWidgetDisplayMode: ArticleDisplayMode;
     _audience: AudienceAutocomplete[];
 };

package/lib/src/util/Test.d.ts

@@ -1,21 +1,136 @@
 import { JamespotUserApi } from '../apis';
-import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectLittle, jObjectList, jUserList, Rights, jArticleView } from '../types';
+import { ApiDefaultWrapper, PagingResults, jArticleLittle, jArticleView, jObjectLittle, jObjectAutocomplete, Rights } from '../types';
 import { jCommentList } from '../types/comment';
 import { FetchResponseType, WindowBrowser } from '../window';
 import { Network } from './network';
 export declare const windowBrowser: WindowBrowser;
 export declare const network: Network;
 export declare const jApi: JamespotUserApi;
+export declare const fieldsObjFormatLittle: ({
+    n: "id";
+    t: string;
+} | {
+    n: "uri";
+    t: string;
+} | {
+    n: "dateCreation";
+    t: string;
+} | {
+    n: "dateModified";
+    t: string;
+} | {
+    n: "_url";
+    t: string;
+} | {
+    n: "type";
+    t: string;
+} | {
+    n: "mainType";
+    t: string;
+} | {
+    n: "title";
+    t: string;
+})[];
+export declare const fieldsObjFormatList: ({
+    n: "id";
+    t: string;
+} | {
+    n: "uri";
+    t: string;
+} | {
+    n: "dateCreation";
+    t: string;
+} | {
+    n: "dateModified";
+    t: string;
+} | {
+    n: "_url";
+    t: string;
+} | {
+    n: "type";
+    t: string;
+} | {
+    n: "mainType";
+    t: string;
+} | {
+    n: "title";
+    t: string;
+})[];
+export declare const fieldsObjFormatAutocomplete: ({
+    n: "id";
+    t: string;
+} | {
+    n: "uri";
+    t: string;
+} | {
+    n: "shortUri";
+    t: string;
+} | {
+    n: "name";
+    t: string;
+} | {
+    n: "mainType";
+    t: string;
+} | {
+    n: "type";
+    t: string;
+} | {
+    n: "label";
+    t: string;
+} | {
+    n: "cssClass";
+    t: string;
+} | {
+    n: "cssColor";
+    t: string;
+} | {
+    n: "class";
+    t: string;
+} | {
+    n: "title";
+    t: string;
+})[];
+export declare const arrayRights: ({
+    n: "create";
+    t: string;
+} | {
+    n: "read";
+    t: string;
+} | {
+    n: "publish";
+    t: string;
+} | {
+    n: "administrate";
+    t: string;
+} | {
+    n: "update";
+    t: string;
+} | {
+    n: "delete";
+    t: string;
+} | {
+    n: "comment";
+    t: string;
+} | {
+    n: "member";
+    t: string;
+})[];
 export declare const fetchMock: <T>(data: T) => jest.Mock<Promise<FetchResponseType<T>>, []>;
 export declare const validateJArticle: <T extends jArticleLittle>(received: T, expected: T) => void;
 export declare const validateApiWrapper: <T extends ApiDefaultWrapper<import("../types").BaseMessages>>(res: T, o: string, f: string, error?: null) => void;
 export declare const validatePagingResults: <T>(res: PagingResults<T>) => void;
+export declare const validateObject: <T extends {
+    [x: string]: any;
+}>(object: T, objectDefinition: Array<{
+    n: string;
+    t: string;
+}>) => void;
+export declare const validateObjectIsFormatList: <T extends jObjectLittle = jObjectLittle>(object: T) => void;
 export declare const validateObjectIsFormatLittle: <T extends jObjectLittle = jObjectLittle>(object: T) => void;
-export declare const validateObjectIsFormatList: <T extends jObjectList = jObjectList>(object: T) => void;
 export declare const validateArticleIsFormatView: <T extends jArticleView = jArticleView>(object: T) => void;
-export declare const validateUserIsFormatList: <T extends jUserList = jUserList>(object: T) => void;
-export declare const validateCommentIsFormatList: <T extends jCommentList = jCommentList>(object: T) => void;
 export declare const validateObjectIsFormatAutocomplete: <T extends jObjectAutocomplete = jObjectAutocomplete>(object: T) => void;
+export declare const validateRights: (object: Rights) => void;
+export declare const validateCommentIsFormatList: <T extends jCommentList = jCommentList>(object: T) => void;
 export declare const validateFileIsFormatLittle: <T extends {
     uri: string;
     id: number;
@@ -41,7 +156,6 @@ export declare const validateFileIsFormatLittle: <T extends {
 }>(object: T) => void;
 export declare const expectToHaveProperties: <T>(props: string[], payload: T[]) => void;
 export declare const expectToBeArray: <T>(arr: T[]) => void;
-export declare const validateRights: (object: Rights) => void;
 export declare const jDynamicProperties: string[];
 /**
  * Valorise toutes les propriétés Jamespot dynamiques avec leur typeof, sur toute la profondeur de l'objet.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jamespot-user-api",
-  "version": "1.0.139",
+  "version": "1.0.141",
   "main": "lib/jamespot-user-api.js",
   "types": "lib/src/index.d.ts",
   "directories": {

package/phpunitMock/activityLogLog-success.json

@@ -0,0 +1,7 @@
+{
+    "o": "activity",
+    "f": "logLog",
+    "error": 0,
+    "messages": [],
+    "result": 1
+}

package/phpunitMock/articleAddComment-success.json

@@ -0,0 +1,57 @@
+{
+    "o": "article",
+    "f": "addComment",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "id": 22,
+        "mainType": "comment",
+        "type": "comment",
+        "uri": "comment/22",
+        "dateCreation": "2024-03-04 14:31:49",
+        "dateModified": null,
+        "description": "<div class='content-html'>Comment for testArticleAddComment</div>",
+        "_user": {
+            "id": 4,
+            "mainType": "user",
+            "type": "user",
+            "uri": "user/4",
+            "dateCreation": "2019-07-09 15:48:26",
+            "dateModified": "2024-03-04 14:28:48",
+            "title": "Admin1",
+            "_url": "/user/4",
+            "level": 9
+        },
+        "_right": {
+            "create": true,
+            "read": true,
+            "publish": true,
+            "administrate": true,
+            "update": true,
+            "delete": true,
+            "comment": true,
+            "member": true
+        },
+        "_actions": {
+            "sociallike": {
+                "type": "custom",
+                "class": "fs-thumbs-up",
+                "cssClass": "comment",
+                "cssColor": "#76b9f2",
+                "isActive": false,
+                "label": "J'aime",
+                "struct": {
+                    "action": "custom-action",
+                    "do": "add",
+                    "type": "sociallike",
+                    "targetId": 22,
+                    "targetType": "comment"
+                },
+                "stats": {
+                    "total": 0
+                }
+            }
+        },
+        "_attachedFiles": []
+    }
+}

package/phpunitMock/articleGet-with-widgets.json

@@ -4,31 +4,31 @@
     "error": 0,
     "messages": [],
     "result": {
-        "id": 191,
+        "id": 248,
         "mainType": "article",
         "type": "articleWidget",
-        "uri": "articleWidget/191",
-        "dateCreation": "2023-09-21 11:40:50",
-        "dateModified": "2023-09-21 11:40:50",
+        "uri": "articleWidget/248",
+        "dateCreation": "2024-02-16 10:59:20",
+        "dateModified": "2024-02-16 10:59:20",
         "title": "Article with widgets",
-        "_url": "/article/191",
+        "_url": "/article/248",
         "articleWidgets": [
             {
                 "title": "",
                 "widget": {
                     "name": "widget-article-attachment",
-                    "uniqid": "650c0fa2c1c89",
+                    "uniqid": "65cf31f8a9ba4",
                     "content": {
                         "files": [
                             {
-                                "id": 93,
+                                "id": 39,
                                 "mainType": "file",
                                 "type": "fileTmp",
-                                "uri": "fileTmp/93",
-                                "dateCreation": "2023-09-21 11:40:50",
-                                "dateModified": "2023-09-21 11:40:50",
+                                "uri": "fileTmp/39",
+                                "dateCreation": "2024-02-16 10:59:20",
+                                "dateModified": "2024-02-16 10:59:20",
                                 "title": "txtTest.docx",
-                                "mimetype": "application/octet-stream",
+                                "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                                 "_url": "javascript:void(0);"
                             }
                         ],
@@ -40,7 +40,7 @@
                 "title": "",
                 "widget": {
                     "name": "widget-article-text",
-                    "uniqid": "650c0fa2c1c8d",
+                    "uniqid": "65cf31f8a9ba6",
                     "content": {
                         "text": "Hello world",
                         "color": "white",
@@ -54,7 +54,7 @@
                 "title": "",
                 "widget": {
                     "name": "widget-article-title",
-                    "uniqid": "650c0fa2c1c8e",
+                    "uniqid": "65cf31f8a9ba7",
                     "content": {
                         "text": "This is my title",
                         "textAlign": "center",
@@ -68,7 +68,7 @@
                 "title": "",
                 "widget": {
                     "name": "widget-article-button",
-                    "uniqid": "650c0fa2c1c8f",
+                    "uniqid": "65cf31f8a9ba8",
                     "content": {
                         "text": "This is a button",
                         "color": "white",
@@ -92,7 +92,7 @@
                                     "title": "",
                                     "widget": {
                                         "name": "widget-article-text",
-                                        "uniqid": "650c0fa2c1c8d",
+                                        "uniqid": "65cf31f8a9ba6",
                                         "content": {
                                             "text": "Hello world",
                                             "color": "white",
@@ -111,24 +111,20 @@
                 "title": "",
                 "widget": {
                     "name": "widget-article-image",
-                    "uniqid": "650c0fa2c1c92",
+                    "uniqid": "65cf31f8a9baa",
                     "content": {
                         "file": {
-                            "id": 93,
+                            "id": 39,
                             "mainType": "file",
                             "type": "fileTmp",
-                            "uri": "fileTmp/93",
-                            "dateCreation": "2023-09-21 11:40:50",
-                            "dateModified": "2023-09-21 11:40:50",
+                            "uri": "fileTmp/39",
+                            "dateCreation": "2024-02-16 10:59:20",
+                            "dateModified": "2024-02-16 10:59:20",
                             "title": "txtTest.docx",
-                            "mimetype": "application/octet-stream",
+                            "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                             "_url": "javascript:void(0);"
                         },
-                        "useFilter": true,
-                        "displayAs": "image",
-                        "backgroundPosition": "center",
-                        "backgroundSize": "cover",
-                        "borderRadius": "10"
+                        "useFilter": true
                     }
                 }
             },
@@ -136,18 +132,18 @@
                 "title": "",
                 "widget": {
                     "name": "widget-article-gallery",
-                    "uniqid": "650c0fa2c1c93",
+                    "uniqid": "65cf31f8a9bab",
                     "content": {
                         "files": [
                             {
-                                "id": 93,
+                                "id": 39,
                                 "mainType": "file",
                                 "type": "fileTmp",
-                                "uri": "fileTmp/93",
-                                "dateCreation": "2023-09-21 11:40:50",
-                                "dateModified": "2023-09-21 11:40:50",
+                                "uri": "fileTmp/39",
+                                "dateCreation": "2024-02-16 10:59:20",
+                                "dateModified": "2024-02-16 10:59:20",
                                 "title": "txtTest.docx",
-                                "mimetype": "application/octet-stream",
+                                "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                                 "_url": "javascript:void(0);"
                             }
                         ],
@@ -155,7 +151,34 @@
                         "column": "3"
                     }
                 }
+            },
+            {
+                "title": "",
+                "widget": {
+                    "name": "widget-article-slider",
+                    "uniqid": "65cf31f8a9bac",
+                    "content": {
+                        "slides": [
+                            {
+                                "title": "Slider",
+                                "text": "Description",
+                                "file": {
+                                    "id": 39,
+                                    "mainType": "file",
+                                    "type": "fileTmp",
+                                    "uri": "fileTmp/39",
+                                    "dateCreation": "2024-02-16 10:59:20",
+                                    "dateModified": "2024-02-16 10:59:20",
+                                    "title": "txtTest.docx",
+                                    "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+                                    "_url": "javascript:void(0);"
+                                }
+                            }
+                        ]
+                    }
+                }
             }
-        ]
+        ],
+        "articleWidgetDisplayMode": null
     }
 }

package/phpunitMock/articleGetComments-success.json

@@ -0,0 +1,59 @@
+{
+    "o": "article",
+    "f": "getComments",
+    "error": 0,
+    "messages": [],
+    "result": [
+        {
+            "id": 23,
+            "mainType": "comment",
+            "type": "comment",
+            "uri": "comment/23",
+            "dateCreation": "2024-03-04 14:31:49",
+            "dateModified": null,
+            "description": "<div class='content-html'>Comment for testArticleGetComments</div>",
+            "_user": {
+                "id": 4,
+                "mainType": "user",
+                "type": "user",
+                "uri": "user/4",
+                "dateCreation": "2019-07-09 15:48:26",
+                "dateModified": "2024-03-04 14:28:48",
+                "title": "Admin1",
+                "_url": "/user/4",
+                "level": 9
+            },
+            "_right": {
+                "create": true,
+                "read": true,
+                "publish": true,
+                "administrate": true,
+                "update": true,
+                "delete": true,
+                "comment": true,
+                "member": true
+            },
+            "_actions": {
+                "sociallike": {
+                    "type": "custom",
+                    "class": "fs-thumbs-up",
+                    "cssClass": "comment",
+                    "cssColor": "#76b9f2",
+                    "isActive": false,
+                    "label": "J'aime",
+                    "struct": {
+                        "action": "custom-action",
+                        "do": "add",
+                        "type": "sociallike",
+                        "targetId": 23,
+                        "targetType": "comment"
+                    },
+                    "stats": {
+                        "total": 0
+                    }
+                }
+            },
+            "_attachedFiles": []
+        }
+    ]
+}

package/phpunitMock/articleSaveAsDraft-default.json

@@ -0,0 +1,7 @@
+{
+    "o": "article",
+    "f": "saveAsDraft",
+    "error": 0,
+    "messages": [],
+    "result": { "idDraft": "48", "msg": "Brouillon cr\u00e9\u00e9" }
+}

package/phpunitMock/articleUpdateComment-success.json

@@ -0,0 +1,62 @@
+{
+    "o": "article",
+    "f": "updateComment",
+    "error": 0,
+    "messages": [
+        {
+            "code": 200,
+            "msg": "Enregistrement r\u00e9ussi"
+        }
+    ],
+    "result": {
+        "id": 24,
+        "mainType": "comment",
+        "type": "comment",
+        "uri": "comment/24",
+        "dateCreation": "2024-03-04 14:31:49",
+        "dateModified": null,
+        "description": "<div class='content-html'>New comment for UpdateComment</div>",
+        "_user": {
+            "id": 4,
+            "mainType": "user",
+            "type": "user",
+            "uri": "user/4",
+            "dateCreation": "2019-07-09 15:48:26",
+            "dateModified": "2024-03-04 14:28:48",
+            "title": "Admin1",
+            "_url": "/user/4",
+            "level": 9
+        },
+        "_right": {
+            "create": true,
+            "read": true,
+            "publish": true,
+            "administrate": true,
+            "update": true,
+            "delete": true,
+            "comment": true,
+            "member": true
+        },
+        "_actions": {
+            "sociallike": {
+                "type": "custom",
+                "class": "fs-thumbs-up",
+                "cssClass": "comment",
+                "cssColor": "#76b9f2",
+                "isActive": false,
+                "label": "J'aime",
+                "struct": {
+                    "action": "custom-action",
+                    "do": "add",
+                    "type": "sociallike",
+                    "targetId": 24,
+                    "targetType": "comment"
+                },
+                "stats": {
+                    "total": 0
+                }
+            }
+        },
+        "_attachedFiles": []
+    }
+}