Merge pull request 'Release/1.6.0' from develop into master

Reviewed-on: https://git.onlyoffice.com/ONLYOFFICE/document-editor-react/pulls/2

Author: LinneyS

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## 1.6.0
+- added shardkey property
+
 ## 1.5.1
 - IConfig->document is not required
 

README.md

@@ -55,7 +55,7 @@ var onLoadComponentError = function (errorCode, errorDescription) {
 
 export default function App() {
     return (
-        <pre>
+        <>
             <DocumentEditor
                 id="docxEditor"
                 documentServerUrl="http://documentserver/"
@@ -132,6 +132,7 @@ The application will be deployed on the web server (*http://localhost:3000* by d
 | ------------- | ------------- | ------------- | ------------- | ------------- |
 | `id` | string | null | yes | Component unique identifier. |
 | `documentServerUrl` | string | null | yes | Address of ONLYOFFICE Document Server. |
+| `shardkey` | string \| boolean | true | no | The string or boolean parameter required to request load balancing during collaborative editing: all users editing the same document are served by the same server. [Shard key](https://api.onlyoffice.com/docs/docs-api/get-started/how-it-works/#shard-key)|
 | `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. |

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@onlyoffice/document-editor-react",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "React component for ONLYOFFICE Document Server",
   "license": "Apache-2.0",
   "bugs": {
@@ -25,37 +25,37 @@
     "lodash": "4.17.21"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.9",
-    "@babel/preset-env": "^7.23.9",
-    "@babel/preset-react": "^7.23.3",
-    "@babel/preset-typescript": "^7.23.3",
-    "@rollup/plugin-commonjs": "^25.0.7",
-    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@babel/core": "^7.26.7",
+    "@babel/preset-env": "^7.26.7",
+    "@babel/preset-react": "^7.26.3",
+    "@babel/preset-typescript": "^7.26.0",
+    "@rollup/plugin-commonjs": "^25.0.8",
+    "@rollup/plugin-node-resolve": "^16.0.0",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
-    "@storybook/addon-essentials": "^7.6.11",
-    "@storybook/addon-interactions": "^7.6.11",
-    "@storybook/addon-links": "^7.6.11",
-    "@storybook/addon-onboarding": "1.0.11",
-    "@storybook/blocks": "^7.6.11",
-    "@storybook/react": "^7.6.11",
-    "@storybook/react-webpack5": "^7.6.11",
-    "@storybook/test": "^7.6.11",
-    "@testing-library/react": "^14.2.0",
-    "@types/jest": "^29.5.11",
-    "@types/react": "^18.2.48",
+    "@storybook/addon-essentials": "^7.6.20",
+    "@storybook/addon-interactions": "^7.6.20",
+    "@storybook/addon-links": "^7.6.20",
+    "@storybook/addon-onboarding": "^1.0.11",
+    "@storybook/blocks": "^7.6.20",
+    "@storybook/react": "^7.6.20",
+    "@storybook/react-webpack5": "^7.6.20",
+    "@storybook/test": "^7.6.20",
+    "@testing-library/react": "^16.2.0",
+    "@types/jest": "^29.5.14",
+    "@types/react": "^18.3.18",
     "babel-jest": "^29.7.0",
-    "babel-loader": "^9.1.3",
+    "babel-loader": "^9.2.1",
     "jest-environment-jsdom": "^29.7.0",
-    "react": "^18.2.0",
+    "react": "^18.3.1",
     "react-dom": "^18.2.0",
     "rollup": "^4.9.6",
-    "rollup-plugin-dts": "^6.1.0",
+    "rollup-plugin-dts": "^6.1.1",
     "rollup-plugin-filesize": "^10.0.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
-    "storybook": "^7.6.11",
+    "storybook": "^7.6.20",
     "tslib": "^2.6.2",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.2.5",
     "typescript": "^5.3.3"
   },
   "peerDependencies": {

package.json

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

src/DocumentEditor.stories.tsx

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

src/DocumentEditor.test.tsx

@@ -1,5 +1,5 @@
 /*
-* (c) Copyright Ascensio System SIA 2024
+* (c) Copyright Ascensio System SIA 2025
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -30,6 +30,7 @@ type DocumentEditorProps = {
   id: string;
 
   documentServerUrl: string;
+  shardkey?: string | boolean;
 
   config: IConfig;
 
@@ -78,6 +79,7 @@ const DocumentEditor = (props: DocumentEditorProps) => {
     id,
 
     documentServerUrl,
+    shardkey = true,
 
     config,
 
@@ -141,8 +143,16 @@ const DocumentEditor = (props: DocumentEditorProps) => {
     let url = documentServerUrl;
     if (!url.endsWith("/")) url += "/";
 
-    const docApiUrl = `${url}web-apps/apps/api/documents/api.js`;
-    loadScript(docApiUrl, "onlyoffice-api-script")
+    let docsApiUrl = `${url}web-apps/apps/api/documents/api.js`;
+    if (shardkey) {
+      if (typeof shardkey === "boolean") {
+        docsApiUrl += `?shardkey=${config.document?.key}`;
+      } else {
+        docsApiUrl += `?shardkey=${shardkey}`;
+      }
+    }
+
+    loadScript(docsApiUrl, "onlyoffice-api-script")
       .then(() => onLoad())
       .catch(() => onError(-2));
 
@@ -228,10 +238,12 @@ const DocumentEditor = (props: DocumentEditorProps) => {
       document.fileType = document_fileType;
     }
 
-    if (document_fileType) {
+    if (document_title) {
       document = document || {};
       document.document_title = document_title;
     }
+
+    return document;
   }
 
   const getEditorConfig = () => {
@@ -241,6 +253,8 @@ const DocumentEditor = (props: DocumentEditorProps) => {
       editorConfig = editorConfig || {};
       editorConfig.lang = editorConfig_lang;
     }
+
+    return editorConfig;
   }
 
   const onError = (errorCode: number) => {

src/DocumentEditor.tsx

@@ -1,4 +1,4 @@
 {
     "documentServerUrl": "http://documentserver/",
-    "demoStorage": "https://d2nlctn12v279m.cloudfront.net/assets/docs/samples/"
+    "demoStorage": "https://static.onlyoffice.com/assets/docs/samples/"
 }

src/config/default.json

@@ -1,5 +1,5 @@
 /*
-* (c) Copyright Ascensio System SIA 2024
+* (c) Copyright Ascensio System SIA 2025
 *
 * 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 2024
+* (c) Copyright Ascensio System SIA 2025
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.