Merge pull request #13 from ONLYOFFICE/develop

Release/1.2.0

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## 1.2.0
+- added component property onLoadComponentError(), fixed issue [#7](https://github.com/ONLYOFFICE/onlyoffice-alfresco/issues/7)
+
 ## 1.1.0
 - added IConfig
 

README.md

@@ -23,6 +23,7 @@ Find below the component usage example:
     documentServerUrl="http://documentserver/"
     :config="config"
     :events_onDocumentReady="onDocumentReady"
+    :onLoadComponentError="onLoadComponentError"
     /> 
 </template>
 
@@ -54,6 +55,20 @@ export default defineComponent({
   methods: {
     onDocumentReady() {
       console.log("Document is loaded");
+    },
+    onLoadComponentError (errorCode, errorDescription) {
+      switch(errorCode) {
+        case -1: // Unknown error loading component
+          console.log(errorDescription);
+          break;
+
+        case -2: // Error load DocsAPI from http://documentserver/
+          console.log(errorDescription);
+          break;
+
+        case -3: // DocsAPI is not defined
+          console.log(errorDescription);
+          break;
     }
   },
 });
@@ -66,7 +81,8 @@ export default defineComponent({
 | ------------- | ------------- | ------------- | ------------- | ------------- |
 | `id` | string | null | yes | Component unique identifier. |
 | `documentServerUrl` | string | null | yes | Address ONLYOFFICE Document Server. |
-| `config` | object | null | yes | Generic configuration object for opening a file with token. [Config API](https://api.onlyoffice.com/editors/config/) | |
+| `config` | object | null | yes | Generic configuration object for opening a file with token. [Config API](https://api.onlyoffice.com/editors/config/) |
+| `onLoadComponentError` | (errorCode: number, errorDescription: string) => void | null | no | The function called when an error occurs while loading a component |
 | `document_fileType` | string | null | no | The type of the file. |
 | `document_title` | string | null | no | The file name. |
 | `documentType` | string | null | no | The document type. |

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onlyoffice/document-editor-vue",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Vue component for ONLYOFFICE Document Server",
   "license": "Apache-2.0",
   "bugs": {

src/components/DocumentEditor.stories.js

@@ -1,5 +1,5 @@
 /*
-* (c) Copyright Ascensio System SIA 2022
+* (c) Copyright Ascensio System SIA 2023
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

src/components/DocumentEditor.vue

@@ -1,5 +1,5 @@
 /*
-* (c) Copyright Ascensio System SIA 2022
+* (c) Copyright Ascensio System SIA 2023
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -33,8 +33,14 @@ declare global {
 export default defineComponent({
   name: 'DocumentEditor',
   props: {
-    id: String,
-    documentServerUrl: String,
+    id: {
+      type: String,
+      required: true
+    },
+    documentServerUrl: {
+      type: String,
+      required: true
+    },
     config: {
       type: Object as PropType<IConfig>,
       required: true
@@ -47,6 +53,8 @@ export default defineComponent({
     type: String,
     width: String,
 
+    onLoadComponentError: Function,
+
     events_onAppReady: Function,
     events_onDocumentStateChange: Function,
     events_onMetaChange: Function,
@@ -74,7 +82,7 @@ export default defineComponent({
     const docApiUrl = `${url}web-apps/apps/api/documents/api.js`;
     loadScript(docApiUrl, "onlyoffice-api-script")
       .then(() => this.onLoad())
-      .catch((err) => console.error(err));
+      .catch(()=> {this.onError(-2)});
   },
   unmounted() {
     const id = this.id || "";
@@ -104,7 +112,7 @@ export default defineComponent({
        try {
         const id = this.id || "";
 
-        if (!window.DocsAPI) throw new Error("DocsAPI is not defined");
+        if (!window.DocsAPI) this.onError(-3);
         if (window?.DocEditor?.instances[id]) {
           console.log("Skip loading. Instance already exists", id);
           return;
@@ -153,7 +161,28 @@ export default defineComponent({
         window.DocEditor.instances[id] = editor;
       } catch (err: any) {
         console.error(err);
-        this.events_onError!(err);
+        this.onError(-1);
+      }
+    },
+    onError(errorCode: Number) {
+      let message;
+
+      switch(errorCode) {
+        case -2:
+          message = "Error load DocsAPI from " + this.documentServerUrl;
+          break;
+        case -3:
+          message = "DocsAPI is not defined";
+          break;
+        default:
+          message = "Unknown error loading component";
+          errorCode = -1;
+      }
+
+      if (typeof this.onLoadComponentError == "undefined") {
+        console.error(message);
+      } else {
+        this.onLoadComponentError(errorCode, message);
       }
     },
     onAppReady() {

src/components/DocumentsEditor.spec.ts

@@ -1,5 +1,5 @@
 /*
-* (c) Copyright Ascensio System SIA 2022
+* (c) Copyright Ascensio System SIA 2023
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

src/index.ts

@@ -1,5 +1,5 @@
 /*
-* (c) Copyright Ascensio System SIA 2022
+* (c) Copyright Ascensio System SIA 2023
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

src/model/config.ts

@@ -1,5 +1,5 @@
 /*
-* (c) Copyright Ascensio System SIA 2022
+* (c) Copyright Ascensio System SIA 2023
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

src/shims-vue.d.ts

@@ -1,5 +1,5 @@
 /*
-* (c) Copyright Ascensio System SIA 2022
+* (c) Copyright Ascensio System SIA 2023
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

src/utils/loadScript.ts

@@ -1,5 +1,5 @@
 /*
-* (c) Copyright Ascensio System SIA 2022
+* (c) Copyright Ascensio System SIA 2023
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.