jamespot-user-api 1.0.105 → 1.0.107

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

@@ -1,9 +1,12 @@
 import { JamespotUserApi } from '../apis';
 import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectList, jUserList } from '../types';
+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 validateJArticle: <T extends jArticleLittle>(received: T, expected: T, _format: 'raw-little' | 'raw-list' | 'raw-view') => void;
+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 validateObjectIsFormatLittle: <T extends {
@@ -24,7 +27,9 @@ export declare const validateObjectIsFormatLittle: <T extends {
     dateModified?: string;
     title: string;
     _url: string;
-}>(object: T) => boolean;
-export declare const validateObjectIsFormatList: <T extends jObjectList = jObjectList>(object: T) => boolean;
-export declare const validateUserIsFormatList: <T extends jUserList = jUserList>(object: T) => boolean;
-export declare const validateObjectIsFormatAutocomplete: <T extends jObjectAutocomplete = jObjectAutocomplete>(object: T) => boolean;
+}>(object: T) => void;
+export declare const validateObjectIsFormatList: <T extends jObjectList = jObjectList>(object: T) => void;
+export declare const validateUserIsFormatList: <T extends jUserList = jUserList>(object: T) => void;
+export declare const validateObjectIsFormatAutocomplete: <T extends jObjectAutocomplete = jObjectAutocomplete>(object: T) => void;
+export declare const expectToHaveProperties: <T>(props: string[], payload: T[]) => void;
+export declare const expectToBeArray: <T>(arr: T[]) => void;

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

@@ -1,4 +1,5 @@
 import { BookmarkCustom, BookmarkLink, BookmarkRawList, jObjectBase } from '../types';
+import { AbortApiError, StandardApiError } from './network';
 declare function ensureIsBookmarkLink(bookmark: BookmarkCustom | BookmarkLink): bookmark is BookmarkLink;
 declare function ensureIsBookmarkCustom(bookmark: BookmarkCustom | BookmarkLink): bookmark is BookmarkCustom;
 declare function ensureIsBookmarkRawList(bookmark: jObjectBase | BookmarkRawList): bookmark is BookmarkRawList;
@@ -11,5 +12,7 @@ export declare const jEnsure: {
     isBookmarkCustom: typeof ensureIsBookmarkCustom;
     isBookmarkRawList: typeof ensureIsBookmarkRawList;
     objectIsType: typeof ensureObjectIsType;
+    isStandardApiError: (err: any) => err is StandardApiError<import("../types").BaseMessages>;
+    isAbortApiError: (err: any) => err is AbortApiError;
 };
 export {};

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

@@ -0,0 +1,4 @@
+export * from './ensure';
+export * from './file';
+export * from './network';
+export * from './object';

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

@@ -1,9 +1,20 @@
-import { ApiWrapper, BaseMessages, FileResponse, MaybeWithCsrf, MaybeWithToken } from '../types';
-import { FetchReturnType, WindowInterface } from '../window/Window';
+import { ApiWrapper, BaseMessages, FileResponse, MaybeWithToken } from '../types';
+import { WindowInterface } from '../window/Window';
 export interface OF {
     o: string;
     f: string;
 }
+export declare type ApiError = {
+    error: number;
+};
+export declare type StandardApiError<T = BaseMessages> = ApiError & {
+    errorMsg: string | undefined;
+    messages: T;
+};
+export declare type AbortApiError = ApiError & {
+    error: -1;
+    aborted: true;
+};
 /**
  * deprecated
  */
@@ -12,14 +23,12 @@ export declare class Network {
     private readonly window;
     constructor(window: WindowInterface, action?: string);
     static _formatPostOptions(body: object): RequestInit;
-    static _formatQueryOptions(options: Record<string, string | boolean | number>): string;
     getUrl(o: string, f: string): Promise<string>;
     getHostname(): Promise<string>;
-    fetch({ o, f, ...body }: OF, signal?: AbortSignal | null): FetchReturnType;
+    fetch<T>({ o, f, ...body }: OF, signal?: AbortSignal | null): Promise<import("../window/Window").FetchResponseType<T>>;
     post<T, U = BaseMessages>(body: OF, signal?: AbortSignal): Promise<ApiWrapper<T, U>>;
     postFile(body: FormData): Promise<ApiWrapper<FileResponse, BaseMessages>>;
     postCSRF<T, U = BaseMessages>(body: OF): Promise<ApiWrapper<T, U>>;
-    maybePostCSRF<T, U = BaseMessages>(body: MaybeWithCsrf<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>>;
     token(): Promise<ApiWrapper<string>>;

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

@@ -1,3 +1,4 @@
-import { ApiWrapper } from '../types';
+import { ApiDefaultWrapper, ApiWrapper } from '../types';
+export declare const miscTokenError: ApiDefaultWrapper;
 export declare const miscToken: ApiWrapper<string>;
 export declare const miscTokenCSRF: ApiWrapper<string>;

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

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

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

@@ -0,0 +1 @@
+export declare function deepEqual(a: any, b: any, ignoreAttributes?: Array<string>): boolean;

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

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

package/lib/src/window/Window.d.ts

@@ -1,7 +1,8 @@
-export declare type FetchReturnType = Promise<{
-    json: () => unknown;
-}>;
+export declare type FetchResponseType<T> = {
+    json: () => Promise<T>;
+};
+export declare type FetchReturnType<T> = Promise<FetchResponseType<T>>;
 export interface WindowInterface {
     getBackendUrl: () => Promise<string>;
-    fetch: (url: string, init?: RequestInit) => FetchReturnType;
+    fetch: <T>(url: string, init?: RequestInit) => FetchReturnType<T>;
 }

package/lib/src/window/WindowBrowser.d.ts

@@ -1,5 +1,5 @@
-import { WindowInterface } from './Window';
+import { FetchReturnType, WindowInterface } from './Window';
 export declare class WindowBrowser implements WindowInterface {
     getBackendUrl(): Promise<string>;
-    fetch(url: string, init?: RequestInit): Promise<Response>;
+    fetch<T>(url: string, init?: RequestInit): FetchReturnType<T>;
 }

package/lib/src/window/WindowBrowser.test.d.ts

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

package/package.json

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

package/phpunitMock/bookmarksAdd-url.json

@@ -0,0 +1,35 @@
+{
+    "o": "bookmarks",
+    "f": "add",
+    "error": 0,
+    "messages": [{ "code": 200, "msg": "Enregistrement r\u00e9ussi" }],
+    "result": {
+        "id": 46,
+        "mainType": "link",
+        "type": "bookmarkLink",
+        "uri": "bookmarkLink/46",
+        "dateCreation": "2023-06-09 16:26:25",
+        "dateModified": "2023-06-09 16:26:25",
+        "srcId": 1,
+        "srcType": "user",
+        "targetId": 0,
+        "targetType": null,
+        "value": null,
+        "_src": {
+            "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
+        },
+        "bookmarkOrder": -13,
+        "bookmarkLabel": "www.example.com",
+        "bookmarkUrl": "https://www.example.com",
+        "bookmarkMeta": null,
+        "url": null
+    }
+}

package/phpunitMock/bookmarksDelete-spot1Article.json

@@ -0,0 +1,7 @@
+{
+    "o": "bookmarks",
+    "f": "delete",
+    "error": 0,
+    "messages": [{ "code": 200, "msg": "Suppression r\u00e9ussie" }],
+    "result": null
+}

package/phpunitMock/bookmarksMove-spot1Article.json

@@ -0,0 +1,7 @@
+{
+    "o": "bookmarks",
+    "f": "move",
+    "error": 0,
+    "messages": [{ "code": 200, "msg": "Enregistrement r\u00e9ussi" }],
+    "result": null
+}

package/phpunitMock/bookmarksRename-spot1Article.json

@@ -0,0 +1,7 @@
+{
+    "o": "bookmarks",
+    "f": "rename",
+    "error": 0,
+    "messages": [{ "code": 200, "msg": "Enregistrement r\u00e9ussi" }],
+    "result": null
+}

package/phpunitMock/customActionAdd-bookmarkSpot1Article.json

@@ -0,0 +1,45 @@
+{
+    "o": "custom",
+    "f": "actionAdd",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "id": 31,
+        "mainType": "link",
+        "type": "bookmarkLink",
+        "uri": "bookmarkLink/31",
+        "dateCreation": "2023-06-09 16:18:47",
+        "dateModified": "2023-06-09 16:18:47",
+        "srcId": 1,
+        "srcType": "user",
+        "targetId": 2,
+        "targetType": "mpArticle",
+        "value": null,
+        "_src": {
+            "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
+        },
+        "_target": {
+            "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"
+        },
+        "bookmarkOrder": -1,
+        "bookmarkLabel": "Article groupe public",
+        "bookmarkUrl": "",
+        "bookmarkMeta": null,
+        "url": "http://jenkins-preprod.jamespot.pro/index.php?action=article&idArticle=2"
+    }
+}

package/phpunitMock/objectList-bookmarksList.json

@@ -0,0 +1,92 @@
+{
+    "o": "object",
+    "f": "list",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "limit": 10,
+        "page": 1,
+        "cnt": 2,
+        "data": [
+            {
+                "id": 34,
+                "mainType": "link",
+                "type": "bookmarkLink",
+                "uri": "bookmarkLink/34",
+                "dateCreation": "2023-06-09 16:26:22",
+                "dateModified": "2023-06-09 16:26:22",
+                "srcId": 1,
+                "srcType": "user",
+                "targetId": 4,
+                "targetType": "mpArticle",
+                "value": null,
+                "_src": {
+                    "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
+                },
+                "_target": {
+                    "id": 4,
+                    "mainType": "article",
+                    "type": "mpArticle",
+                    "uri": "mpArticle/4",
+                    "dateCreation": "2019-07-19 09:36:48",
+                    "dateModified": "2019-07-19 09:36:48",
+                    "title": "Article groupe priv\u00e9",
+                    "_url": "/article/4"
+                },
+                "bookmarkOrder": -3,
+                "bookmarkLabel": "Article groupe priv\u00e9",
+                "bookmarkUrl": "",
+                "bookmarkMeta": null,
+                "url": "http://jenkins-preprod.jamespot.pro/index.php?action=article&idArticle=4"
+            },
+            {
+                "id": 33,
+                "mainType": "link",
+                "type": "bookmarkLink",
+                "uri": "bookmarkLink/33",
+                "dateCreation": "2023-06-09 16:26:22",
+                "dateModified": "2023-06-09 16:26:22",
+                "srcId": 1,
+                "srcType": "user",
+                "targetId": 2,
+                "targetType": "mpArticle",
+                "value": null,
+                "_src": {
+                    "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
+                },
+                "_target": {
+                    "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"
+                },
+                "bookmarkOrder": -2,
+                "bookmarkLabel": "Article groupe public",
+                "bookmarkUrl": "",
+                "bookmarkMeta": null,
+                "url": "http://jenkins-preprod.jamespot.pro/index.php?action=article&idArticle=2"
+            }
+        ],
+        "facets": null
+    }
+}

package/phpunitMock/onlyOfficeAskObjectAccess-ask-read.json

@@ -0,0 +1 @@
+{ "o": "onlyOffice", "f": "askObjectAccess", "error": 0, "messages": [], "result": true }

package/phpunitMock/onlyOfficeCreateFile-create-file.json

@@ -0,0 +1,19 @@
+{
+    "o": "onlyOffice",
+    "f": "createFile",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "idFile": 58,
+        "article": {
+            "id": 314,
+            "mainType": "article",
+            "type": "mpSocialFile",
+            "uri": "mpSocialFile/314",
+            "title": "xlsx_document",
+            "_url": "/article/314",
+            "dateCreation": "2023-04-14 14:52:36",
+            "dateModified": "2023-04-14 14:52:36"
+        }
+    }
+}

package/phpunitMock/onlyOfficeDeleteFile-delete-file.json

@@ -0,0 +1 @@
+{ "o": "onlyOffice", "f": "deleteFile", "error": 0, "messages": [], "result": true }

package/phpunitMock/onlyOfficeDuplicateFile-duplicate-file.json

@@ -0,0 +1,19 @@
+{
+    "o": "onlyOffice",
+    "f": "duplicateFile",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "idFile": 163,
+        "article": {
+            "id": 91,
+            "mainType": "article",
+            "type": "mpSocialFile",
+            "uri": "mpSocialFile/91",
+            "title": "DUPLICATED",
+            "_url": "/article/91",
+            "dateCreation": "2023-04-14 15:54:17",
+            "dateModified": "2023-04-14 15:54:17"
+        }
+    }
+}

package/phpunitMock/onlyOfficeGetFile-get-file.json

@@ -0,0 +1,50 @@
+{
+    "o": "onlyOffice",
+    "f": "getFile",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "id": 56,
+        "title": "xlsx_document.xlsx",
+        "mimetype": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+        "type": "fileArticle",
+        "mainType": "fileArticle",
+        "uri": "fileArticle/56",
+        "dateModified": "2023-04-14 14:39:17",
+        "dateCreation": "2023-04-14 14:39:17",
+        "_extend": {
+            "generalAccessRule": "link",
+            "dateModified": "2023-04-14 14:39:17",
+            "dateCreation": "2023-04-14 14:39:17",
+            "fileInfo": {
+                "color": "#218273",
+                "description": "Tableur",
+                "extension": "xlsx",
+                "icon": "icon-file-excel-o",
+                "label": "Tableur"
+            }
+        },
+        "_user": {
+            "id": 4,
+            "mainType": "user",
+            "type": "user",
+            "uri": "user/4",
+            "title": "Admin1",
+            "_url": "/user/4",
+            "dateCreation": "2019-07-09 15:48:26",
+            "dateModified": "2023-04-14 14:29:47",
+            "level": 9
+        },
+        "_right": {
+            "create": true,
+            "read": true,
+            "publish": false,
+            "administrate": true,
+            "update": true,
+            "delete": true,
+            "comment": true,
+            "member": true
+        },
+        "_audience": []
+    }
+}

package/phpunitMock/onlyOfficeGetFiles-get-files.json

@@ -0,0 +1,58 @@
+{
+    "o": "onlyOffice",
+    "f": "getFiles",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "data": [
+            {
+                "id": 56,
+                "title": "xlsx_document.xlsx",
+                "mimetype": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+                "type": "fileArticle",
+                "mainType": "fileArticle",
+                "uri": "fileArticle/56",
+                "dateModified": "2023-04-14 14:39:17",
+                "dateCreation": "2023-04-14 14:39:17",
+                "_extend": {
+                    "generalAccessRule": "link",
+                    "dateModified": "2023-04-14 14:39:17",
+                    "dateCreation": "2023-04-14 14:39:17",
+                    "fileInfo": {
+                        "color": "#218273",
+                        "description": "Tableur",
+                        "extension": "xlsx",
+                        "icon": "icon-file-excel-o",
+                        "label": "Tableur"
+                    }
+                },
+                "_user": {
+                    "id": 4,
+                    "mainType": "user",
+                    "type": "user",
+                    "uri": "user/4",
+                    "title": "Admin1",
+                    "_url": "/user/4",
+                    "dateCreation": "2019-07-09 15:48:26",
+                    "dateModified": "2023-04-14 14:29:47",
+                    "level": 9
+                },
+                "_right": {
+                    "create": true,
+                    "read": true,
+                    "publish": false,
+                    "administrate": true,
+                    "update": true,
+                    "delete": true,
+                    "comment": true,
+                    "member": true
+                },
+                "_audience": []
+            }
+        ],
+        "limit": 100,
+        "page": 1,
+        "facets": [],
+        "cnt": 1
+    }
+}

package/phpunitMock/onlyOfficeGetObject-default.json

@@ -0,0 +1,26 @@
+{
+    "o": "onlyOffice",
+    "f": "getObject",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "id": 101,
+        "type": "fileArticle",
+        "title": "ASK.xlsx",
+        "idUser": 4,
+        "uri": "fileArticle/101",
+        "generalAccessRule": "link",
+        "generalAccessHash": null,
+        "_right": {
+            "create": true,
+            "read": true,
+            "publish": false,
+            "administrate": true,
+            "update": true,
+            "delete": true,
+            "comment": true,
+            "member": true
+        },
+        "_audience": []
+    }
+}

package/phpunitMock/onlyOfficeGetObjectAccess-default.json

@@ -0,0 +1,34 @@
+{
+    "o": "onlyOffice",
+    "f": "getObjectAccess",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "audience": [
+            {
+                "id": 6,
+                "mainType": "user",
+                "type": "user",
+                "uri": "user/6",
+                "dateCreation": "2019-07-09 15:49:06",
+                "dateModified": "2019-07-09 15:51:35",
+                "title": "User1",
+                "_url": "/user/6",
+                "level": 5
+            },
+            {
+                "id": 7,
+                "mainType": "user",
+                "type": "user",
+                "uri": "user/7",
+                "dateCreation": "2019-07-09 15:49:25",
+                "dateModified": "2019-07-09 15:51:50",
+                "title": "User2",
+                "_url": "/user/7",
+                "level": 5
+            }
+        ],
+        "read": ["user/6", "user/7"],
+        "write": ["user/6"]
+    }
+}

package/phpunitMock/onlyOfficeGetObjectAccessRequest-all-request.json

@@ -0,0 +1,19 @@
+{
+    "o": "onlyOffice",
+    "f": "getObjectAccessRequest",
+    "error": 0,
+    "messages": [],
+    "result": [
+        {
+            "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
+        }
+    ]
+}

package/phpunitMock/onlyOfficeGetTemplates-get-templates.json

@@ -0,0 +1,29 @@
+{
+    "o": "onlyOffice",
+    "f": "getTemplates",
+    "error": 0,
+    "messages": [],
+    "result": [
+        {
+            "label": "Traitement de texte",
+            "description": "Traitement de texte",
+            "extension": "docx",
+            "icon": "icon-file-word-o",
+            "color": "#566DC6"
+        },
+        {
+            "label": "Tableur",
+            "description": "Tableur",
+            "extension": "xlsx",
+            "icon": "icon-file-excel-o",
+            "color": "#218273"
+        },
+        {
+            "label": "Pr\u00e9sentation",
+            "description": "Pr\u00e9sentation",
+            "extension": "pptx",
+            "icon": "icon-file-powerpoint-o",
+            "color": "#E2472D"
+        }
+    ]
+}

package/phpunitMock/onlyOfficeSetObjectAccess-default.json

@@ -0,0 +1 @@
+{ "o": "onlyOffice", "f": "setObjectAccess", "error": 0, "messages": [], "result": true }

package/phpunitMock/onlyOfficeSetObjectAccessRequest-accept.json

@@ -0,0 +1 @@
+{ "o": "onlyOffice", "f": "setObjectAccessRequest", "error": 0, "messages": [], "result": [] }

package/phpunitMock/onlyOfficeUpdateFile-update-file.json

@@ -0,0 +1 @@
+{ "o": "onlyOffice", "f": "updateFile", "error": 0, "messages": [], "result": true }

package/phpunitMock/spotGet-default.json

@@ -0,0 +1,25 @@
+{
+    "o": "spot",
+    "f": "get",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "id": 2,
+        "mainType": "spot",
+        "type": "spot",
+        "uri": "spot/2",
+        "dateCreation": "2019-07-19 18:36:24",
+        "dateModified": "2023-06-08 09:19:44",
+        "title": "Groupe public",
+        "_url": "/group/2",
+        "privacy": 1,
+        "idCategory": 1,
+        "category": "1",
+        "description": "",
+        "edito": null,
+        "language": "fr",
+        "image": null,
+        "spotBanner": [],
+        "useTeaser": ""
+    }
+}