jamespot-user-api 1.0.110 → 1.0.112

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

@@ -0,0 +1,68 @@
+/**
+ * @see JRCImgProps
+ */
+declare type WidthHeight = {
+    width?: number;
+    height?: number;
+};
+/**
+ * @see JRCImgProps
+ */
+declare type Size = {
+    size?: string;
+};
+/**
+ * @see JRCImgProps
+ */
+declare type Format = {
+    format?: string;
+};
+/**
+ * @see JRCImgProps
+ */
+declare type Timestamp = {
+    timestamp?: string | number;
+};
+declare type Args = Timestamp & {
+    iconColor?: 'white';
+};
+/**
+ * @see JRCImgProps
+ */
+export declare type ImgUrlProps = {
+    url?: string;
+    fallbackUrl?: string;
+    size?: string;
+    width?: number;
+    height?: number;
+    maxWidth?: string;
+    from?: string;
+    uri?: string;
+    recordId?: string | number;
+    type?: string;
+    format?: string;
+    iconColor?: 'white';
+    timestamp?: string | number;
+};
+export declare function getFrom(arg: Pick<ImgUrlProps, 'from'>): string;
+export declare function getTimestamp(arg: Timestamp): string;
+export declare function getArgs(arg: Args): string;
+export declare function getSize(arg: Size & WidthHeight, dpr?: number): string;
+export declare function getFormat(arg: Format): string;
+export declare function getUrl(url: string): URL | undefined;
+/**
+ * Format an img url
+ * If url arg is provided, it is used, in addition with an optional timestamp
+ * If not parsable or not passed, one should provide:
+ *   - optional from
+ *   - size in either size or width/height argument.
+ *     If width & height are provided, the downloaded image take car of the screen resolution
+ *   - uri or type/recordId
+ *   - optional format, default png
+ *   - optional timestamp
+ *   The final url is {from}/{size}/{uri}.{format}?_={timestamp}
+ * @param arg
+ * @param dpr device pixel ratio
+ */
+export declare function formatImgUrl(arg: ImgUrlProps, dpr?: number): string;
+export {};

package/lib/src/util/images.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,4 +1,8 @@
 export * from './ensure';
 export * from './file';
+export * from './images';
 export * from './network';
 export * from './object';
+export * from './string';
+export * from './taxonomy';
+export * from './uri';

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

@@ -30,7 +30,7 @@ export declare class Network {
     postFile(body: FormData): Promise<ApiWrapper<FileResponse, BaseMessages>>;
     postCSRF<T, U = BaseMessages>(body: OF): Promise<ApiWrapper<T, U>>;
     postToken<T, U = BaseMessages>(body: OF): Promise<ApiWrapper<T, U>>;
-    maybePostToken<T, U = BaseMessages>(body: MaybeWithToken<OF>): Promise<ApiWrapper<T, U>>;
+    maybePostToken<T, U = BaseMessages, P extends MaybeWithToken<OF> = MaybeWithToken<OF>>(body: P): Promise<ApiWrapper<T, U>>;
     token(): Promise<ApiWrapper<string>>;
     tokenCSRF(): Promise<ApiWrapper<string>>;
 }

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

@@ -0,0 +1,3 @@
+export declare function suffixIfDoesNotExist(str: string | undefined, suffix: string): string | undefined;
+export declare function removeIfStartsWith(str: string | undefined, prefix: string): string | undefined;
+export declare function padStartTwoDigits(val: string | number): string;

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

@@ -0,0 +1,2 @@
+export declare function extractTaxonomiesFromObject(objet: Record<string, unknown>): Record<string, unknown>;
+export declare function extractTaxonomiesFromObjectAndMapUri(objet: Record<string, unknown>): Record<string, unknown>;

package/lib/src/util/taxonomy.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+import { UriOrTypeId } from '../types/uri';
+export declare function getUri(arg: UriOrTypeId): string;

package/lib/src/util/uri.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jamespot-user-api",
-    "version": "1.0.110",
+    "version": "1.0.112",
     "scripts": {
         "build": "npx webpack --env NODE_ENV=production",
         "build-dev-vm": "npx webpack --env NODE_ENV=development --env NODE_BUILD=VM",

package/phpunitMock/autocompleteSpot-a.json

@@ -0,0 +1,50 @@
+{
+    "o": "autocomplete",
+    "f": "spot",
+    "error": 0,
+    "messages": [],
+    "result": [
+        {
+            "id": "spot/5",
+            "idspot": "5",
+            "uri": "spot/5",
+            "shortUri": "s5",
+            "title": "Spot 1 [updated]",
+            "name": "Spot 1 [updated]",
+            "mainType": "spot",
+            "type": "spot",
+            "label": "Groupe",
+            "cssClass": "group",
+            "cssColor": "#e34d55",
+            "class": "user-selector-spot"
+        },
+        {
+            "id": "spot/6",
+            "idspot": "6",
+            "uri": "spot/6",
+            "shortUri": "s6",
+            "title": "Spot 2 [updated]",
+            "name": "Spot 2 [updated]",
+            "mainType": "spot",
+            "type": "spot",
+            "label": "Groupe",
+            "cssClass": "group",
+            "cssColor": "#e34d55",
+            "class": "user-selector-spot"
+        },
+        {
+            "id": "spot/22",
+            "idspot": "22",
+            "uri": "spot/22",
+            "shortUri": "s22",
+            "title": "Groupe test A",
+            "name": "Groupe test A",
+            "mainType": "spot",
+            "type": "spot",
+            "label": "Groupe",
+            "cssClass": "group",
+            "cssColor": "#e34d55",
+            "class": "user-selector-spot"
+        }
+    ]
+}

package/phpunitMock/spotGet-default.json

@@ -4,16 +4,15 @@
     "error": 0,
     "messages": [],
     "result": {
-        "id": 2,
+        "id": 1,
         "mainType": "spot",
         "type": "spot",
-        "uri": "spot/2",
-        "dateCreation": "2019-07-19 18:36:24",
-        "dateModified": "2023-06-08 09:19:44",
+        "uri": "spot/1",
+        "dateCreation": "2019-07-18 18:36:24",
+        "dateModified": "2019-07-18 18:36:24",
         "title": "Groupe public",
-        "_url": "/group/2",
+        "_url": "/group/1",
         "privacy": 1,
-        "idCategory": 1,
         "category": "1",
         "description": "",
         "edito": null,

package/phpunitMock/spotGetProperties-default.json

@@ -58,7 +58,7 @@
         "edit_access": "",
         "commentLevel": "3",
         "user_level_signup": "2",
-        "nounsubscribe": "1",
+        "nounsubscribe": "0",
         "useTeaser": "",
         "displayType": "wall",
         "spot_right_user": "2",

package/phpunitMock/tvDisplayGetChannel-dynamic.json

@@ -0,0 +1,166 @@
+{
+    "o": "tvDisplay",
+    "f": "getChannel",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "interval": 60,
+        "channel": {
+            "id": 168,
+            "mainType": "article",
+            "type": "tvDisplayChannel",
+            "uri": "tvDisplayChannel/168",
+            "dateCreation": "2023-07-31 11:12:03",
+            "dateModified": "2023-07-31 11:12:03",
+            "title": "TV Channel dynamic",
+            "_url": "/ng/rr/tv-display",
+            "_right": {
+                "create": true,
+                "read": true,
+                "publish": true,
+                "administrate": true,
+                "update": true,
+                "delete": true,
+                "comment": false,
+                "member": true
+            },
+            "_user": {
+                "id": 4,
+                "mainType": "user",
+                "type": "user",
+                "uri": "user/4",
+                "dateCreation": "2019-07-09 15:48:26",
+                "dateModified": "2019-07-09 15:51:24",
+                "title": "Admin1",
+                "_url": "/user/4",
+                "level": 9
+            },
+            "tvChannelType": "DYNAMIC",
+            "tvChannelBackgroundColor": "#FF0000",
+            "tvChannelNumImages": 0,
+            "tvChannelGroupTarget": {
+                "id": 1,
+                "mainType": "spot",
+                "type": "spot",
+                "uri": "spot/1",
+                "dateCreation": "2019-07-18 18:36:24",
+                "dateModified": "2023-07-31 11:12:04",
+                "title": "Groupe public",
+                "_url": "/group/1",
+                "privacy": 1,
+                "category": "1"
+            },
+            "tvChannelConfig": { "contents": [], "key": "64c77ae3d247e" },
+            "_extend": {
+                "imageSecureUrl": "http://jenkins-preprod.jamespot.pro/imagesecure/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXRoIjoib3JpZ2luYWxcL3R2RGlzcGxheUNoYW5uZWxcLzE2OC5wbmcifQ.ZBwfoMazbEWGpKidSLYvIKHfgsRJUQ1QyOoOE5X_K-8",
+                "articles": [
+                    {
+                        "id": 169,
+                        "mainType": "article",
+                        "type": "mpArticle",
+                        "uri": "mpArticle/169",
+                        "dateCreation": "2023-07-31 11:12:04",
+                        "dateModified": "2023-07-31 11:12:04",
+                        "title": "a-2",
+                        "_url": "/article/169",
+                        "_right": {
+                            "create": true,
+                            "read": true,
+                            "publish": false,
+                            "administrate": true,
+                            "update": true,
+                            "delete": true,
+                            "comment": true,
+                            "member": true
+                        },
+                        "description": "<div class='content-html'>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</div>",
+                        "_user": {
+                            "id": 4,
+                            "mainType": "user",
+                            "type": "user",
+                            "uri": "user/4",
+                            "dateCreation": "2019-07-09 15:48:26",
+                            "dateModified": "2019-07-09 15:51:24",
+                            "title": "Admin1",
+                            "_url": "/user/4",
+                            "level": 9
+                        },
+                        "_extend": {
+                            "descriptionSecure": "<div class=\"content-html\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</div>\n",
+                            "imageSecureUrl": "http://jenkins-preprod.jamespot.pro/imagesecure/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXRoIjoib3JpZ2luYWxcL21wQXJ0aWNsZVwvMTY5LnBuZyJ9.QmhlsUg2s41MxGDSQFt49NNQYWCaMCepRaNElYFTEA8",
+                            "comments": [
+                                {
+                                    "id": 13,
+                                    "mainType": "comment",
+                                    "type": "comment",
+                                    "uri": "comment/13",
+                                    "dateCreation": "2023-07-31 11:12:04",
+                                    "dateModified": null,
+                                    "description": "<div class='content-html'>Phasellus sodales augue vitae sapien tempus tristique.</div>",
+                                    "_user": {
+                                        "id": 4,
+                                        "mainType": "user",
+                                        "type": "user",
+                                        "uri": "user/4",
+                                        "dateCreation": "2019-07-09 15:48:26",
+                                        "dateModified": "2019-07-09 15:51:24",
+                                        "title": "Admin1",
+                                        "_url": "/user/4",
+                                        "level": 9
+                                    },
+                                    "_right": {
+                                        "create": true,
+                                        "read": true,
+                                        "publish": true,
+                                        "administrate": true,
+                                        "update": true,
+                                        "delete": true,
+                                        "comment": true,
+                                        "member": true
+                                    },
+                                    "_extend": {
+                                        "userImageSecureUrl": "http://jenkins-preprod.jamespot.pro/imagesecure/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXRoIjoiNTAweDUwMFwvdXNlclwvNC5wbmcifQ.fpOAxsrCyDTyPQnIJaGcU6ty-HZOFl2M9ZfszPcHy-g",
+                                        "descriptionSecure": "<div class=\"content-html\">Phasellus sodales augue vitae sapien tempus tristique.</div>\n"
+                                    }
+                                }
+                            ]
+                        }
+                    },
+                    {
+                        "id": 2,
+                        "mainType": "article",
+                        "type": "mpArticle",
+                        "uri": "mpArticle/2",
+                        "dateCreation": "2019-07-19 09:36:25",
+                        "dateModified": "2019-07-19 09:36:25",
+                        "title": "Article groupe public",
+                        "_url": "/article/2",
+                        "_right": {
+                            "create": true,
+                            "read": true,
+                            "publish": false,
+                            "administrate": true,
+                            "update": true,
+                            "delete": true,
+                            "comment": false,
+                            "member": true
+                        },
+                        "description": "<div class='content-html'></div>",
+                        "_user": {
+                            "id": 1,
+                            "mainType": "user",
+                            "type": "user",
+                            "uri": "user/1",
+                            "dateCreation": "2019-03-26 16:29:33",
+                            "dateModified": "2019-07-19 09:39:23",
+                            "title": "AdminJenkins",
+                            "_url": "/user/1",
+                            "level": 9
+                        },
+                        "_extend": { "descriptionSecure": "<div class=\"content-html\"></div>\n", "comments": [] }
+                    }
+                ]
+            }
+        }
+    }
+}

package/phpunitMock/tvDisplayGetChannel-slideshow.json

@@ -0,0 +1,86 @@
+{
+    "o": "tvDisplay",
+    "f": "getChannel",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "interval": 60,
+        "channel": {
+            "id": 171,
+            "mainType": "article",
+            "type": "tvDisplayChannel",
+            "uri": "tvDisplayChannel/171",
+            "dateCreation": "2023-07-31 11:12:04",
+            "dateModified": "2023-07-31 11:12:04",
+            "title": "TV Channel slideshow",
+            "_url": "/ng/rr/tv-display",
+            "_right": {
+                "create": true,
+                "read": true,
+                "publish": true,
+                "administrate": true,
+                "update": true,
+                "delete": true,
+                "comment": false,
+                "member": true
+            },
+            "_user": {
+                "id": 4,
+                "mainType": "user",
+                "type": "user",
+                "uri": "user/4",
+                "dateCreation": "2019-07-09 15:48:26",
+                "dateModified": "2019-07-09 15:51:24",
+                "title": "Admin1",
+                "_url": "/user/4",
+                "level": 9
+            },
+            "tvChannelType": "SLIDESHOW",
+            "tvChannelBackgroundColor": "#9000DA",
+            "tvChannelNumImages": 2,
+            "tvChannelGroupTarget": {
+                "id": 1,
+                "mainType": "spot",
+                "type": "spot",
+                "uri": "spot/1",
+                "dateCreation": "2019-07-18 18:36:24",
+                "dateModified": "2023-07-31 11:12:04",
+                "title": "Groupe public",
+                "_url": "/group/1",
+                "privacy": 1,
+                "category": "1"
+            },
+            "tvChannelConfig": { "contents": [], "key": "64c77ae48a2d0" },
+            "_extend": {
+                "attachments": [
+                    {
+                        "id": 22,
+                        "mainType": "fileArticle",
+                        "type": "fileArticle",
+                        "uri": "fileArticle/22",
+                        "dateCreation": "2023-07-31 11:12:04",
+                        "dateModified": null,
+                        "title": "imgTest.jpg",
+                        "_url": "/ng/rr/tv-display",
+                        "_extend": {
+                            "imageSecureUrl": "http://jenkins-preprod.jamespot.pro/mediasecure/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZEZpbGUiOiIyMiIsIm1lZGlhS2V5IjoiOGNiMDYwYjRhOWMzNTBhOWQzNGI1ODg0NzlkMjBjOWYifQ.nhy6AHgSUJ25GW_zvg3Ng8efxxErEOaHZIbAhK8qqZ0"
+                        }
+                    },
+                    {
+                        "id": 23,
+                        "mainType": "fileArticle",
+                        "type": "fileArticle",
+                        "uri": "fileArticle/23",
+                        "dateCreation": "2023-07-31 11:12:04",
+                        "dateModified": null,
+                        "title": "imgTest.jpg",
+                        "_url": "/ng/rr/tv-display",
+                        "_extend": {
+                            "imageSecureUrl": "http://jenkins-preprod.jamespot.pro/mediasecure/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZEZpbGUiOiIyMyIsIm1lZGlhS2V5IjoiOGNiMDYwYjRhOWMzNTBhOWQzNGI1ODg0NzlkMjBjOWYifQ.5UNtRkFJvc2hTkiJ7i7UFt-8WD-tTw0JFOZMQI9ROpo"
+                        }
+                    }
+                ]
+            }
+        }
+    }
+}

package/phpunitMock/tvDisplayGetConfigureChannel-dynamic.json

@@ -0,0 +1,163 @@
+{
+    "o": "tvDisplay",
+    "f": "getConfigureChannel",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "id": 168,
+        "mainType": "article",
+        "type": "tvDisplayChannel",
+        "uri": "tvDisplayChannel/168",
+        "dateCreation": "2023-07-31 11:12:03",
+        "dateModified": "2023-07-31 11:12:03",
+        "title": "TV Channel dynamic",
+        "_url": "/ng/rr/tv-display",
+        "_right": {
+            "create": true,
+            "read": true,
+            "publish": true,
+            "administrate": true,
+            "update": true,
+            "delete": true,
+            "comment": false,
+            "member": true
+        },
+        "_user": {
+            "id": 4,
+            "mainType": "user",
+            "type": "user",
+            "uri": "user/4",
+            "dateCreation": "2019-07-09 15:48:26",
+            "dateModified": "2019-07-09 15:51:24",
+            "title": "Admin1",
+            "_url": "/user/4",
+            "level": 9
+        },
+        "tvChannelType": "DYNAMIC",
+        "tvChannelBackgroundColor": "#FF0000",
+        "tvChannelNumImages": 0,
+        "tvChannelGroupTarget": {
+            "id": 1,
+            "mainType": "spot",
+            "type": "spot",
+            "uri": "spot/1",
+            "dateCreation": "2019-07-18 18:36:24",
+            "dateModified": "2023-07-31 11:12:04",
+            "title": "Groupe public",
+            "_url": "/group/1",
+            "privacy": 1,
+            "category": "1"
+        },
+        "tvChannelConfig": { "contents": [], "key": "64c77ae3d247e" },
+        "_extend": {
+            "imageSecureUrl": "http://jenkins-preprod.jamespot.pro/imagesecure/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXRoIjoib3JpZ2luYWxcL3R2RGlzcGxheUNoYW5uZWxcLzE2OC5wbmcifQ.ZBwfoMazbEWGpKidSLYvIKHfgsRJUQ1QyOoOE5X_K-8",
+            "articles": [
+                {
+                    "id": 169,
+                    "mainType": "article",
+                    "type": "mpArticle",
+                    "uri": "mpArticle/169",
+                    "dateCreation": "2023-07-31 11:12:04",
+                    "dateModified": "2023-07-31 11:12:04",
+                    "title": "a-2",
+                    "_url": "/article/169",
+                    "_right": {
+                        "create": true,
+                        "read": true,
+                        "publish": false,
+                        "administrate": true,
+                        "update": true,
+                        "delete": true,
+                        "comment": true,
+                        "member": true
+                    },
+                    "description": "<div class='content-html'>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</div>",
+                    "_user": {
+                        "id": 4,
+                        "mainType": "user",
+                        "type": "user",
+                        "uri": "user/4",
+                        "dateCreation": "2019-07-09 15:48:26",
+                        "dateModified": "2019-07-09 15:51:24",
+                        "title": "Admin1",
+                        "_url": "/user/4",
+                        "level": 9
+                    },
+                    "_extend": {
+                        "descriptionSecure": "<div class=\"content-html\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</div>\n",
+                        "imageSecureUrl": "http://jenkins-preprod.jamespot.pro/imagesecure/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXRoIjoib3JpZ2luYWxcL21wQXJ0aWNsZVwvMTY5LnBuZyJ9.QmhlsUg2s41MxGDSQFt49NNQYWCaMCepRaNElYFTEA8",
+                        "comments": [
+                            {
+                                "id": 13,
+                                "mainType": "comment",
+                                "type": "comment",
+                                "uri": "comment/13",
+                                "dateCreation": "2023-07-31 11:12:04",
+                                "dateModified": null,
+                                "description": "<div class='content-html'>Phasellus sodales augue vitae sapien tempus tristique.</div>",
+                                "_user": {
+                                    "id": 4,
+                                    "mainType": "user",
+                                    "type": "user",
+                                    "uri": "user/4",
+                                    "dateCreation": "2019-07-09 15:48:26",
+                                    "dateModified": "2019-07-09 15:51:24",
+                                    "title": "Admin1",
+                                    "_url": "/user/4",
+                                    "level": 9
+                                },
+                                "_right": {
+                                    "create": true,
+                                    "read": true,
+                                    "publish": true,
+                                    "administrate": true,
+                                    "update": true,
+                                    "delete": true,
+                                    "comment": true,
+                                    "member": true
+                                },
+                                "_extend": {
+                                    "userImageSecureUrl": "http://jenkins-preprod.jamespot.pro/imagesecure/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXRoIjoiNTAweDUwMFwvdXNlclwvNC5wbmcifQ.fpOAxsrCyDTyPQnIJaGcU6ty-HZOFl2M9ZfszPcHy-g",
+                                    "descriptionSecure": "<div class=\"content-html\">Phasellus sodales augue vitae sapien tempus tristique.</div>\n"
+                                }
+                            }
+                        ]
+                    }
+                },
+                {
+                    "id": 2,
+                    "mainType": "article",
+                    "type": "mpArticle",
+                    "uri": "mpArticle/2",
+                    "dateCreation": "2019-07-19 09:36:25",
+                    "dateModified": "2019-07-19 09:36:25",
+                    "title": "Article groupe public",
+                    "_url": "/article/2",
+                    "_right": {
+                        "create": true,
+                        "read": true,
+                        "publish": false,
+                        "administrate": true,
+                        "update": true,
+                        "delete": true,
+                        "comment": false,
+                        "member": true
+                    },
+                    "description": "<div class='content-html'></div>",
+                    "_user": {
+                        "id": 1,
+                        "mainType": "user",
+                        "type": "user",
+                        "uri": "user/1",
+                        "dateCreation": "2019-03-26 16:29:33",
+                        "dateModified": "2019-07-19 09:39:23",
+                        "title": "AdminJenkins",
+                        "_url": "/user/1",
+                        "level": 9
+                    },
+                    "_extend": { "descriptionSecure": "<div class=\"content-html\"></div>\n", "comments": [] }
+                }
+            ]
+        }
+    }
+}