jamespot-user-api 1.0.105 → 1.0.106

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/documentation/interfaces/ApiError.html

@@ -1 +0,0 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ApiError | jamespot-user-api</title><meta name="description" content="Documentation for jamespot-user-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">jamespot-user-api</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">jamespot-user-api</a></li><li><a href="ApiError.html">ApiError</a></li></ul><h1>Interface ApiError&lt;U&gt;</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>U = <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ApiError</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ApiError.html#error" class="tsd-kind-icon">error</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ApiError.html#messages" class="tsd-kind-icon">messages</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="error" class="tsd-anchor"></a><h3 class="tsd-anchor-link">error<a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/a9d8840/src/types/utils.ts#L58">types/utils.ts:58</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="messages" class="tsd-anchor"></a><h3 class="tsd-anchor-link">messages<a href="#messages" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">messages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">U</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/a9d8840/src/types/utils.ts#L59">types/utils.ts:59</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-has-type-parameter"><a href="ApiError.html" class="tsd-kind-icon">Api<wbr/>Error</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ApiError.html#error" class="tsd-kind-icon">error</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ApiError.html#messages" class="tsd-kind-icon">messages</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>

package/lib/src/apis/share.d.ts

@@ -1,17 +0,0 @@
-import { ApiWrapper } from '../types';
-import { JBaseApi } from './base';
-import { ShareAccessObject, ShareAccessProps, ShareAccessRequestProps } from '../types/share';
-export declare class JShareApi extends JBaseApi {
-    setObjectAccessRequest(uri: string, idUser: number, requestAccessValue: 'accept' | 'deny', requestResponseMessage?: string): Promise<ApiWrapper<boolean, {
-        code: number;
-        msg: string;
-    }>>;
-    getObjectAccessRequest(uri: string, idUser?: number): Promise<ShareAccessRequestProps[]>;
-    getObject(uri: string): Promise<ShareAccessObject>;
-    askObjectAccess(uri: string, askAccess: 'read' | 'write', askMessage?: string): Promise<boolean>;
-    setObjectAccess(uri: string, access: {
-        read: string[];
-        write: string[];
-    }, message: string, generalAccessRule: string): Promise<boolean>;
-    getObjectAccess(uri: string): Promise<ShareAccessProps>;
-}

package/lib/src/apis/wedoc.d.ts

@@ -1,26 +0,0 @@
-import { ApiWrapper, WedocFileType, WedocQueryResults, WedocQueryType, WedocTemplate } from '../types';
-import { JBaseApi } from './base';
-export declare class JWedocApi extends JBaseApi {
-    getFiles(query: WedocQueryType): Promise<WedocQueryResults>;
-    getFile(idFile: number, hash?: string): Promise<WedocFileType>;
-    getTemplates(): Promise<WedocTemplate[]>;
-    duplicateFile(idFile: number, title: string, publishTo: string[]): Promise<ApiWrapper<boolean, {
-        code: number;
-        msg: string;
-    }>>;
-    deleteFile(idFile: number): Promise<ApiWrapper<boolean, {
-        code: number;
-        msg: string;
-    }>>;
-    createFile(title: string, type: string, publishTo: string[]): Promise<{
-        idFile: number;
-    }>;
-    updateFile(idFile: number, title: string): Promise<ApiWrapper<boolean, {
-        code: number;
-        msg: string;
-    }>>;
-    getFileInfo(idFile: number, mode: string): Promise<ApiWrapper<boolean, {
-        code: number;
-        msg: string;
-    }>>;
-}