Fixed jsdoc md generation

* Fix deploy desktop editors linux packages (#842)

* Small fix

* Fix make targets

* Small fix

* Refactoring linux packages deploy

.github/workflows/check.yml

@@ -1,25 +1,24 @@
-name: Markdown check
+name: Markdown Lint
 
 on:
   workflow_dispatch:
   push:
     branches:
-      - '*'
+      - '**'
     paths:
       - '*.md'
       - 'develop/*.md'
       - 'scripts/**.md'
+      - '.markdownlint.jsonc'
 
 jobs:
   markdownlint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: DavidAnson/markdownlint-cli2-action@v9
+      - uses: actions/checkout@v4
+      - uses: DavidAnson/markdownlint-cli2-action@v16
         with:
-          command: config
           globs: |
-            .markdownlint.jsonc
             *.md
             develop/*.md
-            scripts/**.md
+            scripts/**.md

.github/workflows/update-version.yml

@@ -3,16 +3,13 @@ name: Update hard-coded version
 on: workflow_dispatch
 
 jobs:
-
   update-version:
     if: >-
       ${{ contains(github.ref, 'refs/heads/hotfix/v') ||
           contains(github.ref, 'refs/heads/release/v') }}
     runs-on: ubuntu-latest
     steps:
-
-      - name: Checkout
-        uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           token: ${{ secrets.PUSH_TOKEN }}
 
@@ -25,9 +22,9 @@ jobs:
         run: echo "${{ env.version }}" > version
 
       - name: Commit & push changes
-        uses: EndBug/add-and-commit@v8
+        uses: EndBug/add-and-commit@v9
         with:
           author_name: github-actions[bot]
           author_email: github-actions[bot]@users.noreply.github.com
-          message: Update hard-coded version to v${{ env.version }}
+          message: Update hard-coded version to ${{ env.version }}
           add: version

.gitignore

@@ -12,3 +12,5 @@ tests/puppeteer/node_modules
 tests/puppeteer/work_directory
 tests/puppeteer/package.json
 tests/puppeteer/package-lock.json
+scripts/sdkjs_common/jsdoc/node_modules
+scripts/sdkjs_common/jsdoc/package-lock.json

README.md

@@ -196,9 +196,8 @@ LD_LIBRARY_PATH=./ ./DesktopEditors
     **Note**: The created database must have **onlyoffice** both for user and password.
 
     ```bash
-    sudo -i -u postgres psql -c "CREATE DATABASE onlyoffice;"
-    sudo -i -u postgres psql -c "CREATE USER onlyoffice WITH password 'onlyoffice';"
-    sudo -i -u postgres psql -c "GRANT ALL privileges ON DATABASE onlyoffice TO onlyoffice;"
+    sudo -i -u postgres psql -c "CREATE USER onlyoffice WITH PASSWORD 'onlyoffice';"
+    sudo -i -u postgres psql -c "CREATE DATABASE onlyoffice OWNER onlyoffice;"
     ```
 
 3. Configure the database:

configure.py

@@ -21,6 +21,7 @@ parser.add_option("--qt-dir-xp", action="store", type="string", dest="qt-dir-xp"
 parser.add_option("--external-folder", action="store", type="string", dest="external-folder", default="", help="defines a directory with external folder")
 parser.add_option("--sql-type", action="store", type="string", dest="sql-type", default="postgres", help="defines the sql type wich will be used")
 parser.add_option("--db-port", action="store", type="string", dest="db-port", default="5432", help="defines the sql db-port wich will be used")
+parser.add_option("--db-name", action="store", type="string", dest="db-name", default="onlyoffice", help="defines the sql db-name wich will be used")
 parser.add_option("--db-user", action="store", type="string", dest="db-user", default="onlyoffice", help="defines the sql db-user wich will be used")
 parser.add_option("--db-pass", action="store", type="string", dest="db-pass", default="onlyoffice", help="defines the sql db-pass wich will be used")
 parser.add_option("--compiler", action="store", type="string", dest="compiler", default="", help="defines compiler name. It is not recommended to use it as it's defined automatically (msvc2015, msvc2015_64, gcc, gcc_64, clang, clang_64, etc)")

develop/README.md

@@ -61,7 +61,6 @@ Clone development modules to the work dir
 * `server` repo is located [here](https://github.com/ONLYOFFICE/server/)
 
 ```bash
-cd ../..
 git clone https://github.com/ONLYOFFICE/sdkjs.git
 git clone https://github.com/ONLYOFFICE/web-apps.git
 git clone https://github.com/ONLYOFFICE/server.git
@@ -75,14 +74,15 @@ along with the relative paths to the required folders.
 The folders `sdkjs` and `web-apps` are required for proper development workflow.
 The folders `server` is optional
 
+**Note**: Run command with the current working directory
+containing `sdkjs`, `web-apps`...
+
 **Note**: ONLYOFFICE server uses port 80.
 Look for another application using port 80 and stop it
 
 **Note**: Server start with `sdkjs` and `web-apps` takes 15 minutes
 and takes 20 minutes with `server`
 
-**Note**: Run command from work dir with development modules
-
 ### docker run on Windows (PowerShell)
 
 **Note**: Run PowerShell as administrator to fix EACCES error when installing

make.py

@@ -11,7 +11,7 @@ sys.path.append(__dir__name__ + '/scripts/core_common/modules')
 sys.path.append(__dir__name__ + '/scripts/core_common/modules/android')
 import config
 import base
-import build
+import build_sln
 import build_js
 import build_server
 import deploy
@@ -94,7 +94,7 @@ if config.check_option("module", "desktop"):
     base.set_env("DESKTOP_URL_UPDATES_DEV_CHANNEL", "https://download.onlyoffice.com/install/desktop/editors/windows/onlyoffice/appcastdev.json")
 
 # build
-build.make()
+build_sln.make()
 
 # js
 build_js.make()

scripts/base.py

@@ -384,7 +384,7 @@ def cmd2(prog, args=[], is_no_errors=False):
     sys.exit("Error (" + prog + "): " + str(ret))
   return ret
 
-def cmd_exe(prog, args):
+def cmd_exe(prog, args, is_no_errors=False):
   prog_dir = os.path.dirname(prog)
   env_dir = os.environ
   if ("linux" == host_platform()):
@@ -406,7 +406,7 @@ def cmd_exe(prog, args):
       command += (" \"" + arg + "\"")
     process = subprocess.Popen(command, stderr=subprocess.STDOUT, shell=True, env=env_dir)
     ret = process.wait()
-  if ret != 0:
+  if ret != 0 and True != is_no_errors:
     sys.exit("Error (" + prog + "): " + str(ret))
   return ret
 
@@ -1046,15 +1046,15 @@ def web_apps_addons_param():
 def download(url, dst):
   return cmd_exe("curl", ["-L", "-o", dst, url])
 
-def extract(src, dst):
+def extract(src, dst, is_no_errors=False):
   app = "7za" if ("mac" == host_platform()) else "7z"
-  return cmd_exe(app, ["x", "-y", src, "-o" + dst])
+  return cmd_exe(app, ["x", "-y", src, "-o" + dst], is_no_errors)
 
-def extract_unicode(src, dst):
+def extract_unicode(src, dst, is_no_errors=False):
   if "windows" == host_platform():
     run_as_bat_win_isolate([u"chcp 65001", u"call 7z.exe x -y \"" + src + u"\" \"-o" + dst + u"\"", u"exit"])
     return
-  return extract(src, dst)
+  return extract(src, dst, is_no_errors)
 
 def archive_folder(src, dst):
   app = "7za" if ("mac" == host_platform()) else "7z"
@@ -1354,7 +1354,7 @@ def copy_sdkjs_plugins(dst_dir, is_name_as_guid=False, is_desktop_local=False, i
   plugins_dir = __file__script__path__ + "/../../onlyoffice.github.io/sdkjs-plugins/content"
   plugins_list_config = config.option("sdkjs-plugin")
   if isXp:
-    plugins_list_config="photoeditor, macros, drawio, highlightcode, doc2md"
+    plugins_list_config="photoeditor, macros, highlightcode, doc2md"
   if ("" == plugins_list_config):
     return
   plugins_list = plugins_list_config.rsplit(", ")
@@ -1743,3 +1743,14 @@ def check_tools():
         create_dir(directory + "/qt")
       cmd("python", [directory + "/arm/build_qt.py", "--arch", "arm64", directory + "/qt/arm64"])
   return
+
+def apply_patch(file, patch):
+  patch_content = readFile(patch)
+  index1 = patch_content.find("<<<<<<<")
+  index2 = patch_content.find("=======")
+  index3 = patch_content.find(">>>>>>>")
+  file_content_old = patch_content[index1 + 7:index2].strip()
+  file_content_new = patch_content[index2 + 7:index3].strip()
+  #file_content_new = "\n#if 0" + file_content_old + "#else" + file_content_new + "#endif\n"
+  replaceInFile(file, file_content_old, file_content_new)
+  return

scripts/build_js.py

@@ -146,15 +146,25 @@ def build_sdk_native(directory, minimize=True):
   _run_grunt(directory, get_build_param(minimize) + ["--mobile=true"] + addons)
   return
 
+
+def build_sdkjs_develop(root_dir):
+  external_folder = config.option("--external-folder")
+  if (external_folder != ""):
+    external_folder = "/" + external_folder
+
+  _run_npm_ci(root_dir + external_folder + "/sdkjs/build")
+  _run_grunt(root_dir + external_folder + "/sdkjs/build", get_build_param(False) + base.sdkjs_addons_param())
+  _run_grunt(root_dir + external_folder + "/sdkjs/build", ["develop"] + base.sdkjs_addons_param())
+
+
 def build_js_develop(root_dir):
   #_run_npm_cli(root_dir + "/sdkjs/build")
   external_folder = config.option("--external-folder")
   if (external_folder != ""):
     external_folder = "/" + external_folder
     
-  _run_npm_ci(root_dir + external_folder + "/sdkjs/build")
-  _run_grunt(root_dir + external_folder + "/sdkjs/build", get_build_param(False) + base.sdkjs_addons_param())
-  _run_grunt(root_dir + external_folder + "/sdkjs/build", ["develop"] + base.sdkjs_addons_param())
+  build_sdkjs_develop(root_dir)
+
   _run_npm(root_dir + external_folder + "/web-apps/build")
   _run_npm_ci(root_dir + external_folder + "/web-apps/build/sprites")
   _run_grunt(root_dir + external_folder + "/web-apps/build/sprites", [])

scripts/core_common/make_common.py

@@ -13,7 +13,7 @@ import cef
 import icu
 import openssl
 import curl
-import websocket
+import websocket_all
 import v8
 import html2
 import hunspell
@@ -54,5 +54,5 @@ def make():
   if config.check_option("module", "mobile"):
     if (config.check_option("platform", "android")):
       curl.make()
-    websocket.make()
+    websocket_all.make()
   return

scripts/core_common/modules/android/icu_android.py

@@ -49,7 +49,6 @@ cpp_flags = [
   
   "-DUCONFIG_NO_COLLATION=0",
   "-DUCONFIG_NO_FORMATTING=0",
-  "-DUCONFIG_NO_LEGACY_CONVERSION=1",
   "-DUCONFIG_NO_REGULAR_EXPRESSIONS=0",
   "-DUCONFIG_NO_TRANSLITERATION=0",
 

scripts/core_common/modules/libvlc.py

@@ -62,6 +62,7 @@ def make():
   vlc_dir = base_dir + "/vlc"
   vlc_version = "3.0.18"
 
+  tools_dir = base.get_script_dir() + "/../tools"
   old_cur = os.getcwd()
   os.chdir(base_dir)
 
@@ -73,7 +74,7 @@ def make():
     base.cmd("git", ["clone", "https://code.videolan.org/videolan/vlc.git", "--branch", vlc_version])
     if "windows" == base.host_platform():
       base.cmd("git", ["config", "--global", "core.autocrlf", autocrlf_old])
-  
+
   base.create_dir("build")
   base.copy_file("tools/ignore-cache-time.patch", "vlc")
 
@@ -83,7 +84,7 @@ def make():
       base.copy_file("tools/win_64/build.patch", "vlc")
       docker_build("libvlc-win64", base_dir + "/tools/win_64", base_dir)
       form_build_win(vlc_dir + "/build/win64/vlc-" + vlc_version, base_dir + "/build/win_64")
-      
+
     if config.check_option("platform", "win_32"):
       base.copy_file("tools/win_32/build.patch", "vlc")
       docker_build("libvlc-win32", base_dir + "/tools/win_32", base_dir)
@@ -91,9 +92,11 @@ def make():
 
   # linux
   if config.check_option("platform", "linux_64"):
+    base.copy_file(tools_dir + "/linux/elf/patchelf", "vlc")
+    base.copy_file("tools/linux_64/change-rpaths.sh", "vlc")
     docker_build("libvlc-linux64", base_dir + "/tools/linux_64", base_dir)
     form_build_linux(vlc_dir + "/build/linux_64", base_dir + "/build/linux_64")
-  
+
   # mac
   if "mac" == base.host_platform():
     os.chdir(vlc_dir)

scripts/core_common/modules/socket_io.py

@@ -27,8 +27,16 @@ def make():
   base_dir = base.get_script_dir() + "/../../core/Common/3dParty/socketio"
   if not base.is_dir(base_dir + "/socket.io-client-cpp"):
     base.cmd_in_dir(base_dir, "git", ["clone", "https://github.com/socketio/socket.io-client-cpp.git"])
+    base.cmd_in_dir(base_dir + "/socket.io-client-cpp", "git", ["checkout", "da779141a7379cc30c870d48295033bc16a23c66"])
     base.cmd_in_dir(base_dir + "/socket.io-client-cpp", "git", ["submodule", "init"])
     base.cmd_in_dir(base_dir + "/socket.io-client-cpp", "git", ["submodule", "update"])
+    base.cmd_in_dir(base_dir + "/socket.io-client-cpp/lib/asio", "git", ["checkout", "230c0d2ae035c5ce1292233fcab03cea0d341264"])
+    base.cmd_in_dir(base_dir + "/socket.io-client-cpp/lib/websocketpp", "git", ["checkout", "56123c87598f8b1dd471be83ca841ceae07f95ba"])
+    # patches
+    base.apply_patch(base_dir + "/socket.io-client-cpp/lib/websocketpp/websocketpp/impl/connection_impl.hpp", base_dir + "/patches/websocketpp.patch")
+    base.apply_patch(base_dir + "/socket.io-client-cpp/src/internal/sio_client_impl.cpp", base_dir + "/patches/sio_client_impl_fail.patch")
+    base.apply_patch(base_dir + "/socket.io-client-cpp/src/internal/sio_client_impl.cpp", base_dir + "/patches/sio_client_impl_open.patch")
+    base.apply_patch(base_dir + "/socket.io-client-cpp/src/internal/sio_client_impl.cpp", base_dir + "/patches/sio_client_impl_close_timeout.patch")
 
     # no tls realization (remove if socket.io fix this)
     dst_dir = base_dir + "/socket.io-client-cpp/src_no_tls"

scripts/core_common/modules/websocket_all.py

@@ -8,8 +8,6 @@ import base
 #import socketrocket
 import socket_io
 
-config_file = base.get_script_dir() + "/../../core/Common/WebSocket/websocket.pri"
-
 def make():
   #ixwebsocket.make()
   #socketrocket.make()

scripts/deploy_desktop.py

@@ -213,6 +213,8 @@ def make():
 
     base.create_dir(root_dir + "/editors")
     base.copy_dir(base_dir + "/js/" + branding + "/desktop/sdkjs", root_dir + "/editors/sdkjs")
+    if len(os.listdir(root_dir + "/editors/sdkjs")) == 0:
+      base.delete_dir(root_dir + "/editors/sdkjs") # delete empty folder. for bug 62528
     base.copy_dir(base_dir + "/js/" + branding + "/desktop/web-apps", root_dir + "/editors/web-apps")
     for file in glob.glob(root_dir + "/editors/web-apps/apps/*/*/*.js.map"):
       base.delete_file(file)

scripts/develop/config_server.py

@@ -132,6 +132,8 @@ def make():
     sql["type"] = config.option("sql-type")
   if (config.option("db-port") != ""):
     sql["dbPort"] = config.option("db-port")
+  if (config.option("db-name") != ""):
+    sql["dbName"] = config.option("db-name")
   if (config.option("db-user") != ""):
     sql["dbUser"] = config.option("db-user")
   if (config.option("db-pass") != ""):

scripts/develop/dependence.py

@@ -483,8 +483,8 @@ def get_mysql_path_to_bin(mysqlPath = ''):
       mysqlPath = os.environ['PROGRAMW6432'] + '\\MySQL\\MySQL Server 8.0\\'
     mysqlPath += 'bin'
   return mysqlPath
-def get_mysqlLoginSrting():
-  return 'mysql -u ' + install_params['MySQLServer']['user'] + ' -p' +  install_params['MySQLServer']['pass']
+def get_mysqlLoginString():
+  return 'mysql -u ' + config.option("db-user") + ' -p' + config.option("db-pass")
 def get_mysqlServersInfo():
   arrInfo = []
 
@@ -511,14 +511,14 @@ def get_mysqlServersInfo():
 def check_mysqlServer():
   base.print_info('Check MySQL Server')
   dependence = CDependencies()
-  mysqlLoginSrt = get_mysqlLoginSrting()
+  mysqlLoginSrt = get_mysqlLoginString()
   connectionString = mysqlLoginSrt + ' -e "SHOW GLOBAL VARIABLES LIKE ' + r"'PORT';" + '"'
 
   if (host_platform != 'windows'):
     result = os.system(mysqlLoginSrt + ' -e "exit"')
     if (result == 0):
       connectionResult = base.run_command(connectionString)['stdout']
-      if (connectionResult.find('port') != -1 and connectionResult.find(install_params['MySQLServer']['port']) != -1):
+      if (connectionResult.find('port') != -1 and connectionResult.find(config.option("db-port")) != -1):
         print('MySQL configuration is valid')
         dependence.sqlPath = 'mysql'
         return dependence
@@ -535,7 +535,7 @@ def check_mysqlServer():
     mysql_full_name = 'MySQL Server ' + info['Version'] + ' '
 
     connectionResult = base.run_command_in_dir(get_mysql_path_to_bin(info['Location']), connectionString)['stdout']
-    if (connectionResult.find('port') != -1 and connectionResult.find(install_params['MySQLServer']['port']) != -1):
+    if (connectionResult.find('port') != -1 and connectionResult.find(config.option("db-port")) != -1):
       print(mysql_full_name + 'configuration is valid')
       dependence.sqlPath = info['Location']
       return dependence
@@ -559,23 +559,43 @@ def check_mysqlServer():
   return dependence
 def check_MySQLConfig(mysqlPath = ''):
   result = True
-  mysqlLoginSrt = get_mysqlLoginSrting()
+  mysqlLoginSrt = get_mysqlLoginString()
   mysql_path_to_bin = get_mysql_path_to_bin(mysqlPath)
 
-  if (base.run_command_in_dir(mysql_path_to_bin, mysqlLoginSrt + ' -e "SHOW DATABASES;"')['stdout'].find('onlyoffice') == -1):
-    print('Database onlyoffice not found')
+  if (base.run_command_in_dir(mysql_path_to_bin, mysqlLoginSrt + ' -e "SHOW DATABASES;"')['stdout'].lower().find(config.option("db-name").lower()) == -1):
+    print('Database "' + config.option("db-name") + '" not found')
+    result = create_MySQLDb(mysql_path_to_bin, config.option("db-name"), config.option("db-user"), config.option("db-pass"))
+    if (not result):
+        return False
+    print('Creating ' + config.option("db-name") + ' tables ...')
     creatdb_path = base.get_script_dir() + "/../../server/schema/mysql/createdb.sql"
-    result = execMySQLScript(mysql_path_to_bin, creatdb_path)
-  if (base.run_command_in_dir(mysql_path_to_bin, mysqlLoginSrt + ' -e "SELECT plugin from mysql.user where User=' + "'" + install_params['MySQLServer']['user'] + "';" + '"')['stdout'].find('mysql_native_password') == -1):
+    result = execMySQLScript(mysql_path_to_bin, config.option("db-name"), creatdb_path)
+  if (base.run_command_in_dir(mysql_path_to_bin, mysqlLoginSrt + ' -e "SELECT plugin from mysql.user where User=' + "'" + config.option("db-user") + "';" + '"')['stdout'].find('mysql_native_password') == -1):
     print('Password encryption is not valid')
     result = set_MySQLEncrypt(mysql_path_to_bin, 'mysql_native_password') and result
 
   return result
-def execMySQLScript(mysql_path_to_bin, scriptPath):
-  print('Execution ' + scriptPath)
-  mysqlLoginSrt = get_mysqlLoginSrting()
+def create_MySQLDb(mysql_path_to_bin, dbName, dbUser, dbPass):
+  mysqlLoginSrt = get_mysqlLoginString()
+  print('CREATE DATABASE ' + dbName + ';')
+  if (base.exec_command_in_dir(mysql_path_to_bin, mysqlLoginSrt + ' -e "CREATE DATABASE ' + dbName + ';"') != 0):
+    print('failed CREATE DATABASE ' + dbName + ';')
+    return False
+  # print('CREATE USER IF NOT EXISTS ' + dbUser + ' IDENTIFIED BY \'' + dbPass + '\';')
+  # if (base.exec_command_in_dir(mysql_path_to_bin, mysqlLoginSrt + ' -e "CREATE USER IF NOT EXISTS ' + dbUser + ' IDENTIFIED BY \'' + dbPass + '\';"') != 0):
+    # print('failed: CREATE USER IF NOT EXISTS ' + dbUser + ' IDENTIFIED BY \'' + dbPass + '\';')
+    # return False
+  # print('GRANT ALL PRIVILEGES ON ' + dbName + '.* TO ' + dbUser + ';')
+  # if (base.exec_command_in_dir(mysql_path_to_bin, mysqlLoginSrt + ' -e "GRANT ALL PRIVILEGES ON ' + dbName + '.* TO ' + dbUser + ';"') != 0):
+    # print('failed: GRANT ALL PRIVILEGES ON ' + dbName + '.* TO ' + dbUser + ';')
+    # return False
+  return True
   
-  code = base.exec_command_in_dir(mysql_path_to_bin, get_mysqlLoginSrting() + ' < "' + scriptPath + '"')
+def execMySQLScript(mysql_path_to_bin, dbName, scriptPath):
+  print('Execution ' + scriptPath)
+  mysqlLoginSrt = get_mysqlLoginString()
+  
+  code = base.exec_command_in_dir(mysql_path_to_bin, get_mysqlLoginString() + ' -D ' + dbName + ' < "' + scriptPath + '"')
   if (code != 0):
     print('Execution failed!')
     return False
@@ -584,7 +604,7 @@ def execMySQLScript(mysql_path_to_bin, scriptPath):
 def set_MySQLEncrypt(mysql_path_to_bin, sEncrypt):
   print('Setting MySQL password encrypting...')
 
-  code = base.exec_command_in_dir(mysql_path_to_bin, get_mysqlLoginSrting() + ' -e "' + "ALTER USER '" + install_params['MySQLServer']['user'] + "'@'localhost' IDENTIFIED WITH " + sEncrypt + " BY '" + install_params['MySQLServer']['pass'] + "';" + '"')
+  code = base.exec_command_in_dir(mysql_path_to_bin, get_mysqlLoginString() + ' -e "' + "ALTER USER '" + config.option("db-user") + "'@'localhost' IDENTIFIED WITH " + sEncrypt + " BY '" + config.option("db-pass") + "';" + '"')
   if (code != 0):
     print('Setting password encryption failed!')
     return False
@@ -611,7 +631,7 @@ def get_postrgre_path_to_bin(postgrePath = ''):
 def get_postgreLoginSrting(userName):
   if (host_platform == 'windows'):
     return 'psql -U' + userName + ' '
-  return 'PGPASSWORD="' + install_params['PostgreSQL']['dbPass'] + '" psql -U' + userName + ' -hlocalhost '
+  return 'PGPASSWORD="' + config.option("db-pass") + '" psql -U' + userName + ' -hlocalhost '
 def get_postgreSQLInfoByFlag(flag):
   arrInfo = []
 
@@ -647,7 +667,7 @@ def check_postgreSQL():
     result = os.system(postgreLoginSrt + ' -c "\q"')
     connectionResult = base.run_command(connectionString)['stdout']
 
-    if (result != 0 or connectionResult.find(install_params['PostgreSQL']['dbPort']) == -1):
+    if (result != 0 or connectionResult.find(config.option("db-port")) == -1):
       print('Valid PostgreSQL not found!')
       dependence.append_install('PostgreSQL')
       dependence.append_uninstall('PostgreSQL')
@@ -657,7 +677,7 @@ def check_postgreSQL():
     return dependence
 
   arrInfo = get_postgreSQLInfo()
-  base.set_env('PGPASSWORD', install_params['PostgreSQL']['dbPass'])
+  base.set_env('PGPASSWORD', config.option("db-pass"))
   for info in arrInfo:
     if (base.is_dir(info['Location']) == False):
       continue
@@ -665,7 +685,7 @@ def check_postgreSQL():
     postgre_full_name = 'PostgreSQL ' + info['Version'][:2] + ' '
     connectionResult = base.run_command_in_dir(get_postrgre_path_to_bin(info['Location']), connectionString)['stdout']
 
-    if (connectionResult.find(install_params['PostgreSQL']['dbPort']) != -1):
+    if (connectionResult.find(config.option("db-port")) != -1):
       print(postgre_full_name + 'configuration is valid')
       dependence.sqlPath = info['Location']
       return dependence
@@ -683,12 +703,12 @@ def check_postgreSQL():
 def check_postgreConfig(postgrePath = ''):
   result = True
   if (host_platform == 'windows'):
-    base.set_env('PGPASSWORD', install_params['PostgreSQL']['dbPass'])
+    base.set_env('PGPASSWORD', config.option("db-pass"))
 
   rootUser = install_params['PostgreSQL']['root']
-  dbUser = install_params['PostgreSQL']['dbUser']
-  dbName = install_params['PostgreSQL']['dbName']
-  dbPass = install_params['PostgreSQL']['dbPass']
+  dbUser = config.option("db-user")
+  dbName = config.option("db-name")
+  dbPass = config.option("db-pass")
   postgre_path_to_bin = get_postrgre_path_to_bin(postgrePath)
   postgreLoginRoot = get_postgreLoginSrting(rootUser)
   postgreLoginDbUser = get_postgreLoginSrting(dbUser)
@@ -705,7 +725,7 @@ def check_postgreConfig(postgrePath = ''):
     base.print_info('Creating ' + dbName + ' user...')
     result = create_postgreUser(dbUser, dbPass, postgre_path_to_bin) and result
 
-  if (base.run_command_in_dir(postgre_path_to_bin, postgreLoginRoot + ' -c "SELECT datname FROM pg_database;"')['stdout'].find('onlyoffice') == -1):
+  if (base.run_command_in_dir(postgre_path_to_bin, postgreLoginRoot + ' -c "SELECT datname FROM pg_database;"')['stdout'].find(config.option("db-name")) == -1):
     print('Database ' + dbName + ' not found')
     base.print_info('Creating ' + dbName + ' database...')
     result = create_postgreDb(dbName, postgre_path_to_bin) and configureDb(dbUser, dbName, creatdb_path, postgre_path_to_bin)
@@ -884,13 +904,13 @@ def install_gruntcli():
 
 def install_mysqlserver():
   if (host_platform == 'windows'):
-    return os.system('"' + os.environ['ProgramFiles(x86)'] + '\\MySQL\\MySQL Installer for Windows\\MySQLInstallerConsole" community install server;' + install_params['MySQLServer']['version'] + ';x64:*:type=config;openfirewall=true;generallog=true;binlog=true;serverid=' + install_params['MySQLServer']['port'] + 'enable_tcpip=true;port=' + install_params['MySQLServer']['port'] + ';rootpasswd=' + install_params['MySQLServer']['pass'] + ' -silent')
+    return os.system('"' + os.environ['ProgramFiles(x86)'] + '\\MySQL\\MySQL Installer for Windows\\MySQLInstallerConsole" community install server;' + install_params['MySQLServer']['version'] + ';x64:*:type=config;openfirewall=true;generallog=true;binlog=true;serverid=' + config.option("db-port") + 'enable_tcpip=true;port=' + config.option("db-port") + ';rootpasswd=' + config.option("db-pass") + ' -silent')
   elif (host_platform == 'linux'):
-    os.system('sudo kill ' + base.run_command('sudo fuser -vn tcp ' + install_params['MySQLServer']['port'])['stdout'])
+    os.system('sudo kill ' + base.run_command('sudo fuser -vn tcp ' + config.option("db-port"))['stdout'])
     code = os.system('sudo ufw enable && sudo ufw allow 22 && sudo ufw allow 3306')
     code = os.system('sudo apt-get -y install zsh htop') and code
-    code = os.system('echo "mysql-server mysql-server/root_password password ' + install_params['MySQLServer']['pass'] + '" | sudo debconf-set-selections') and code
-    code = os.system('echo "mysql-server mysql-server/root_password_again password ' + install_params['MySQLServer']['pass'] + '" | sudo debconf-set-selections') and code
+    code = os.system('echo "mysql-server mysql-server/root_password password ' + config.option("db-pass") + '" | sudo debconf-set-selections') and code
+    code = os.system('echo "mysql-server mysql-server/root_password_again password ' + config.option("db-pass") + '" | sudo debconf-set-selections') and code
     return os.system('yes | sudo apt install mysql-server') and code
   return 1
 
@@ -912,7 +932,7 @@ def install_postgresql():
     file_name = "install.exe"
     base.download(download_url, file_name)
     base.print_info("Install PostgreSQL...")
-    install_command = file_name + ' --mode unattended --unattendedmodeui none --superpassword ' + install_params['PostgreSQL']['dbPass'] + ' --serverport ' + install_params['PostgreSQL']['dbPort']
+    install_command = file_name + ' --mode unattended --unattendedmodeui none --superpassword ' + config.option("db-pass") + ' --serverport ' + config.option("db-port")
   else:
     base.print_info("Install PostgreSQL...")
     install_command = 'sudo apt install postgresql -y'
@@ -923,7 +943,7 @@ def install_postgresql():
   if (host_platform == 'windows'):
     base.delete_file(file_name)
   else:
-    code = os.system('sudo -i -u postgres psql -c "ALTER USER postgres PASSWORD ' + "'" + install_params['PostgreSQL']['dbPass'] + "'" + ';"') and code
+    code = os.system('sudo -i -u postgres psql -c "ALTER USER postgres PASSWORD ' + "'" + config.option("db-pass") + "'" + ';"') and code
 
   return code
 
@@ -974,18 +994,11 @@ install_params = {
   'BuildTools': '--add Microsoft.VisualStudio.Workload.VCTools --includeRecommended --quiet --wait',
   'Git': '/VERYSILENT /NORESTART',
   'MySQLServer': {
-    'port': '3306',
-	'user': 'root',
-	'pass': 'onlyoffice',
 	'version': '8.0.21'
   },
   'Redis': 'PORT=6379 ADD_FIREWALL_RULE=1',
   'PostgreSQL': {
-    'root': 'postgres',
-    'dbPort': '5432',
-    'dbName': 'onlyoffice',
-    'dbUser': 'onlyoffice',
-    'dbPass': 'onlyoffice'
+    'root': 'postgres'
   }
 }
 uninstall_params = {

scripts/develop/run_server.py

@@ -49,7 +49,18 @@ def run_integration_example():
 
 def start_linux_services():
   base.print_info('Restart MySQL Server')
-  
+
+
+def update_config(args):
+  platform = base.host_platform()
+  branch = base.run_command('git rev-parse --abbrev-ref HEAD')['stdout']
+
+  if ("linux" == platform):
+  	base.cmd_in_dir(base_dir + '/../../', 'python', ['configure.py', '--branch', branch or 'develop', '--develop', '1', '--module', 'server', '--update', '1', '--update-light', '1', '--clean', '0'] + args)
+  else:
+  	base.cmd_in_dir(base_dir + '/../../', 'python', ['configure.py', '--branch', branch or 'develop', '--develop', '1', '--module', 'server', '--update', '1', '--update-light', '1', '--clean', '0', '--sql-type', 'mysql', '--db-port', '3306', '--db-name', 'onlyoffice', '--db-user', 'root', '--db-pass', 'onlyoffice'] + args)
+  	
+
 def make_start():
   base.configure_common_apps()
   
@@ -64,15 +75,8 @@ def make_start():
     start_linux_services()
 
 def make_configure(args):
-  platform = base.host_platform()
-  branch = base.run_command('git rev-parse --abbrev-ref HEAD')['stdout']
-  
   base.print_info('Build modules')
-  if ("linux" == platform):
-  	base.cmd_in_dir(base_dir + '/../../', 'python', ['configure.py', '--branch', branch or 'develop', '--develop', '1', '--module', 'server', '--update', '1', '--update-light', '1', '--clean', '0'] + args)
-  else:
-  	base.cmd_in_dir(base_dir + '/../../', 'python', ['configure.py', '--branch', branch or 'develop', '--develop', '1', '--module', 'server', '--update', '1', '--update-light', '1', '--clean', '0', '--sql-type', 'mysql', '--db-port', '3306', '--db-user', 'root', '--db-pass', 'onlyoffice'] + args)
-  	
+  update_config(args)
   base.cmd_in_dir(base_dir + '/../../', 'python', ['make.py'])
 def make_install():
   platform = base.host_platform()

scripts/package_branding.py

@@ -17,10 +17,7 @@ if utils.is_windows():
   desktop_product_name = "Desktop Editors"
   desktop_product_name_s = desktop_product_name.replace(" ","")
   desktop_package_name = company_name + "-" + desktop_product_name_s
-  desktop_vcredist_list = ["2022"]
   desktop_changes_dir = "desktop-apps/win-linux/package/windows/update/changes"
-  desktop_changes_url = "https://download.onlyoffice.com/install/desktop/editors/windows/onlyoffice/changes"
-  desktop_updates_url = "https://download.onlyoffice.com/install/desktop/editors/windows/onlyoffice/updates"
 
 if utils.is_macos():
   desktop_package_name = "ONLYOFFICE"
@@ -33,6 +30,59 @@ if utils.is_macos():
 builder_product_name = "Document Builder"
 
 if utils.is_linux():
-  desktop_make_targets = ["deb", "rpm", "suse-rpm", "tar"]
-  builder_make_targets = ["deb", "rpm"] # tar
-  server_make_targets = ["deb", "rpm", "tar"]
+  builder_make_targets = [
+    {
+      "make": "tar",
+      "src": "tar/*.tar*",
+      "dst": "builder/linux/generic/"
+    },
+    {
+      "make": "deb",
+      "src": "deb/*.deb",
+      "dst": "builder/linux/debian/"
+    },
+    {
+      "make": "rpm",
+      "src": "rpm/builddir/RPMS/*/*.rpm",
+      "dst": "builder/linux/rhel/"
+    }
+  ]
+  desktop_make_targets = [
+    {
+      "make": "tar",
+      "src": "tar/*.tar*",
+      "dst": "desktop/linux/generic/"
+    },
+    {
+      "make": "deb",
+      "src": "deb/*.deb",
+      "dst": "desktop/linux/debian/"
+    },
+    {
+      "make": "rpm",
+      "src": "rpm/build/RPMS/*/*.rpm",
+      "dst": "desktop/linux/rhel/"
+    },
+    {
+      "make": "rpm-suse",
+      "src": "rpm-suse/build/RPMS/*/*.rpm",
+      "dst": "desktop/linux/suse/"
+    }
+  ]
+  server_make_targets = [
+    {
+      "make": "deb",
+      "src": "deb/*.deb",
+      "dst": "server/linux/debian/"
+    },
+    {
+      "make": "rpm",
+      "src": "rpm/builddir/RPMS/*/*.rpm",
+      "dst": "server/linux/rhel/"
+    },
+    {
+      "make": "tar",
+      "src": "*.tar*",
+      "dst": "server/linux/snap/"
+    }
+  ]

scripts/package_builder.py

@@ -137,7 +137,7 @@ def make_linux():
   utils.set_cwd("document-builder-package")
 
   utils.log_h2("builder build")
-  make_args = branding.builder_make_targets
+  make_args = [t["make"] for t in branding.builder_make_targets]
   if common.platform == "linux_aarch64":
     make_args += ["-e", "UNAME_M=aarch64"]
   if not branding.onlyoffice:
@@ -146,32 +146,10 @@ def make_linux():
   utils.set_summary("builder build", ret)
 
   if common.deploy:
-    if ret:
-      if "tar" in branding.builder_make_targets:
-        utils.log_h2("builder tar deploy")
-        ret = s3_upload(
-          utils.glob_path("tar/*.tar.gz"),
-          "builder/linux/generic/")
-        utils.set_summary("builder tar deploy", ret)
-      if "deb" in branding.builder_make_targets:
-        utils.log_h2("builder deb deploy")
-        ret = s3_upload(
-          utils.glob_path("deb/*.deb"),
-          "builder/linux/debian/")
-        utils.set_summary("builder deb deploy", ret)
-      if "rpm" in branding.builder_make_targets:
-        utils.log_h2("builder rpm deploy")
-        ret = s3_upload(
-          utils.glob_path("rpm/builddir/RPMS/*/*.rpm"),
-          "builder/linux/rhel/")
-        utils.set_summary("builder rpm deploy", ret)
-    else:
-      if "tar" in branding.builder_make_targets:
-        utils.set_summary("builder tar deploy", False)
-      if "deb" in branding.builder_make_targets:
-        utils.set_summary("builder deb deploy", False)
-      if "rpm" in branding.builder_make_targets:
-        utils.set_summary("builder rpm deploy", False)
+    for t in branding.builder_make_targets:
+      utils.log_h2("builder " + t["make"] + " deploy")
+      ret = s3_upload(utils.glob_path(t["src"]), t["dst"])
+      utils.set_summary("builder " + t["make"] + " deploy", ret)
 
   utils.set_cwd(common.workspace_dir)
   return

scripts/package_desktop.py

@@ -36,33 +36,22 @@ def s3_upload(files, dst):
 #
 
 def make_windows():
-  global package_version, arch_list, source_dir, branding_dir, desktop_dir, viewer_dir, \
-    inno_file, inno_sa_file, inno_update_file, inno_update_file_new, advinst_file
+  global package_name, package_version, arch, xp, suffix
   utils.set_cwd("desktop-apps\\win-linux\\package\\windows")
 
   package_name = branding.desktop_package_name
   package_version = common.version + "." + common.build
-  arch_list = {
+  arch = {
     "windows_x64":    "x64",
     "windows_x64_xp": "x64",
     "windows_x86":    "x86",
     "windows_x86_xp": "x86"
-  }
-  suffix = arch_list[common.platform]
-  if common.platform.endswith("_xp"): suffix += "-xp"
-  inno_file = "%s-%s-%s.exe" % (package_name, package_version, suffix)
-  inno_sa_file = "%s-Standalone-%s-%s.exe" % (package_name, package_version, suffix)
-  inno_update_file = "update\\editors_update_%s.exe" % suffix.replace("-","_")
-  inno_update_file_new = "%s-Update-%s-%s.exe" % (package_name, package_version, suffix)
-  advinst_file = "%s-%s-%s.msi" % (package_name, package_version, suffix)
-  if branding.onlyoffice:
-    branding_dir = "."
-  else:
-    branding_dir = common.workspace_dir + "\\" + common.branding + "\\desktop-apps\\win-linux\\package\\windows"
+  }[common.platform]
+  xp = common.platform.endswith("_xp")
+  suffix = arch + ("-xp" if xp else "")
 
   if common.clean:
     utils.log_h2("desktop clean")
-    utils.delete_dir("build")
     utils.delete_dir("DesktopEditors-cache")
     utils.delete_files("*.exe")
     utils.delete_files("*.msi")
@@ -70,135 +59,81 @@ def make_windows():
     utils.delete_files("*.tmp")
     utils.delete_files("*.zip")
     utils.delete_files("data\\*.exe")
-    utils.delete_files("update\\*.exe")
-
-  utils.log_h2("copy arifacts")
-  source_dir = "%s\\build_tools\\out\\%s\\%s" \
-    % (common.workspace_dir, common.prefix, branding.company_name)
-  utils.create_dir("build")
-  desktop_dir = "build\\" + branding.desktop_product_name_s
-  utils.copy_dir(source_dir + "\\" + branding.desktop_product_name_s, desktop_dir)
-  if not branding.onlyoffice:
-    viewer_dir = "build\\" + branding.viewer_product_name_s
-    utils.copy_dir(source_dir + "\\" + branding.viewer_product_name_s, viewer_dir)
 
+  make_prepare()
   make_zip()
-
-  if not download_vcredist():
-    utils.set_summary("desktop inno build", False)
-    utils.set_summary("desktop inno standalone build", False)
-    utils.set_summary("desktop inno update build", False)
-    utils.set_summary("desktop advinst build", False)
-    utils.set_cwd(common.workspace_dir)
-    return
-
   make_inno()
-
-  if common.platform == "windows_x64":
-    make_update_files()
-
-  if common.platform in ["windows_x64", "windows_x86"]:
-    make_advinst()
+  make_advinst()
 
   utils.set_cwd(common.workspace_dir)
   return
 
-def make_zip():
-  utils.log_h2("desktop zip build")
-
+def make_prepare():
   args = [
-    "-Target", common.platform,
-    "-BuildDir", "build",
-    "-DesktopDir", branding.desktop_product_name_s
+    "-Version", package_version,
+    "-Arch", arch
   ]
-  if not branding.onlyoffice:
-    args += ["-MultimediaDir", branding.viewer_product_name_s]
-    args += ["-BrandingDir", branding_dir]
-  if branding.onlyoffice and not common.platform.endswith("_xp"):
-    args += ["-ExcludeHelp"]
+  if xp:
+    args += ["-Target", "xp"]
   if common.sign:
-    args += ["-Sign", "-CertName", branding.cert_name]
+    args += ["-Sign"]
+
+  utils.log_h2("desktop prepare")
+  ret = utils.ps1("make.ps1", args, verbose=True)
+  utils.set_summary("desktop prepare", ret)
+  return
+
+def make_zip():
+  zip_file = "%s-%s-%s.zip" % (package_name, package_version, suffix)
+  args = [
+    "-Version", package_version,
+    "-Arch", arch
+  ]
+  if xp:
+    args += ["-Target", "xp"]
+  # if common.sign:
+  #   args += ["-Sign"]
+
+  utils.log_h2("desktop zip build")
   ret = utils.ps1("make_zip.ps1", args, verbose=True)
   utils.set_summary("desktop zip build", ret)
 
   if common.deploy and ret:
     utils.log_h2("desktop zip deploy")
-    ret = s3_upload(utils.glob_path("*.zip"), "desktop/win/generic/")
+    ret = s3_upload([zip_file], "desktop/win/generic/")
     utils.set_summary("desktop zip deploy", ret)
   return
 
-def download_vcredist():
-  vcredist = {
-    # Microsoft Visual C++ 2015-2022 Redistributable - 14.38.33135
-    "windows_x64": {
-      "url": "https://aka.ms/vs/17/release/vc_redist.x64.exe",
-      "md5": "1d545507009cc4ec7409c1bc6e93b17b"
-    },
-    "windows_x86": {
-      "url": "https://aka.ms/vs/17/release/vc_redist.x86.exe",
-      "md5": "8457542fd4be74cb2c3a92b3386ae8e9"
-    },
-    # Microsoft Visual C++ 2015-2019 Redistributable - 14.27.29114
-    "windows_x64_xp": {
-      "url": "https://download.visualstudio.microsoft.com/download/pr/722d59e4-0671-477e-b9b1-b8da7d4bd60b/591CBE3A269AFBCC025681B968A29CD191DF3C6204712CBDC9BA1CB632BA6068/VC_redist.x64.exe",
-      "md5": "bc8e3e714b727b3bb18614bd6a51a3d3"
-    },
-    "windows_x86_xp": {
-      "url": "https://download.visualstudio.microsoft.com/download/pr/c168313d-1754-40d4-8928-18632c2e2a71/D305BAA965C9CD1B44EBCD53635EE9ECC6D85B54210E2764C8836F4E9DEFA345/VC_redist.x86.exe",
-      "md5": "ec3bee79a85ae8e3581a8c181b336d1e"
-    }
-  }
-  vcredist_file = "data\\vcredist_%s.exe" % arch_list[common.platform]
-
-  utils.log_h2("vcredist download " + vcredist_file)
-  ret = utils.download_file(
-    vcredist[common.platform]["url"],
-    vcredist_file,
-    vcredist[common.platform]["md5"],
-    verbose=True)
-  utils.set_summary("vcredist download", ret)
-  return ret
-
 def make_inno():
-  utils.log_h2("desktop inno build")
-
-  inno_arch_list = {
-    "windows_x64":    "64",
-    "windows_x86":    "32",
-    "windows_x64_xp": "64",
-    "windows_x86_xp": "32"
-  }
-  iscc_args = [
-    "/Qp",
-    "/DVERSION=" + package_version,
-    "/DsAppVersion=" + package_version,
-    "/DDEPLOY_PATH=" + desktop_dir,
-    "/DARCH=" + arch_list[common.platform],
-    "/D_ARCH=" + inno_arch_list[common.platform],
+  inno_file = "%s-%s-%s.exe" % (package_name, package_version, suffix)
+  inno_sa_file = "%s-Standalone-%s-%s.exe" % (package_name, package_version, suffix)
+  inno_update_file = "%s-Update-%s-%s.exe" % (package_name, package_version, suffix)
+  update_wrapper = not (hasattr(branding, 'desktop_updates_skip_iss_wrapper') and branding.desktop_updates_skip_iss_wrapper)
+  args = [
+    "-Version", package_version,
+    "-Arch", arch
   ]
-  if branding.onlyoffice:
-    iscc_args.append("/D_ONLYOFFICE=1")
-  else:
-    iscc_args.append("/DsBrandingFolder=" + \
-        utils.get_abspath(common.workspace_dir + "\\" + common.branding + "\\desktop-apps"))
-  if common.platform.endswith("_xp"):
-    iscc_args.append("/D_WIN_XP=1")
   if common.sign:
-    iscc_args.append("/DENABLE_SIGNING=1")
-    iscc_args.append("/Sbyparam=signtool.exe sign /a /v /n $q" + \
-        branding.cert_name + "$q /t " + common.tsa_server + " $f")
-  args = ["iscc"] + iscc_args + ["common.iss"]
-  ret = utils.cmd(*args, creates=inno_file, verbose=True)
+    args += ["-Sign"]
+
+  utils.log_h2("desktop inno build")
+  if xp:
+    ret = utils.ps1("make_inno.ps1", args + ["-Target", "xp"], verbose=True)
+  else:
+    ret = utils.ps1("make_inno.ps1", args, verbose=True)
   utils.set_summary("desktop inno build", ret)
 
-  if branding.onlyoffice and not common.platform.endswith("_xp"):
-    args = ["iscc"] + iscc_args + ["/DEMBED_HELP", "/DsPackageEdition=Standalone", "common.iss"]
-    ret = utils.cmd(*args, creates=inno_sa_file, verbose=True)
+  if branding.onlyoffice and not xp:
+    utils.log_h2("desktop inno standalone")
+    ret = utils.ps1("make_inno.ps1", args + ["-Target", "standalone"], verbose=True)
     utils.set_summary("desktop inno standalone build", ret)
 
-  if not (hasattr(branding, 'desktop_updates_skip_iss_wrapper') and branding.desktop_updates_skip_iss_wrapper):
-    args = ["iscc"] + iscc_args + ["/DTARGET_NAME=" + inno_file, "update_common.iss"]
-    ret = utils.cmd(*args, creates=inno_update_file, verbose=True)
+  if update_wrapper:
+    utils.log_h2("desktop inno update build")
+    if xp:
+      ret = utils.ps1("make_inno.ps1", args + ["-Target", "xp_update"], verbose=True)
+    else:
+      ret = utils.ps1("make_inno.ps1", args + ["-Target", "update"], verbose=True)
     utils.set_summary("desktop inno update build", ret)
 
   if common.deploy:
@@ -206,47 +141,44 @@ def make_inno():
     ret = s3_upload([inno_file], "desktop/win/inno/")
     utils.set_summary("desktop inno deploy", ret)
 
-    if branding.onlyoffice and not common.platform.endswith("_xp"):
+    if branding.onlyoffice and not xp:
       utils.log_h2("desktop inno standalone deploy")
       ret = s3_upload([inno_sa_file], "desktop/win/inno/")
       utils.set_summary("desktop inno standalone deploy", ret)
 
     utils.log_h2("desktop inno update deploy")
     if utils.is_file(inno_update_file):
-      ret = s3_upload(
-        [inno_update_file], "desktop/win/inno/" + inno_update_file_new)
+      ret = s3_upload([inno_update_file], "desktop/win/inno/")
     elif utils.is_file(inno_file):
-      ret = s3_upload(
-        [inno_file], "desktop/win/inno/" + inno_update_file_new)
+      ret = s3_upload([inno_file], "desktop/win/inno/" + inno_update_file)
     else:
       ret = False
     utils.set_summary("desktop inno update deploy", ret)
-  return
 
-def make_update_files():
-  utils.log_h2("desktop update files build")
-
-  changes_dir = common.workspace_dir + "\\" + utils.get_path(branding.desktop_changes_dir) + "\\" + common.version
-
-  if common.deploy and utils.glob_path(changes_dir + "\\*.html"):
-    utils.log_h2("desktop update files deploy")
+  changes_dir = common.workspace_dir + "\\" \
+    + utils.get_path(branding.desktop_changes_dir) + "\\" + common.version
+  if common.platform == "windows_x64" and \
+     common.deploy and \
+     utils.glob_path(changes_dir + "\\*.html"):
+    utils.log_h2("desktop changelog deploy")
     ret = s3_upload(
       utils.glob_path(changes_dir + "\\*.html"),
       "desktop/win/update/%s/%s/" % (common.version, common.build))
-    utils.set_summary("desktop update files deploy", ret)
+    utils.set_summary("desktop changelog deploy", ret)
   return
 
 def make_advinst():
-  utils.log_h2("desktop advinst build")
-
+  if not common.platform in ["windows_x64", "windows_x86"]:
+    return
+  advinst_file = "%s-%s-%s.msi" % (package_name, package_version, suffix)
   args = [
     "-Version", package_version,
-    "-Arch", arch_list[common.platform]
+    "-Arch", arch
   ]
   if common.sign:
     args += ["-Sign"]
-  if not branding.onlyoffice:
-    args += ["-BrandingDir", branding_dir]
+
+  utils.log_h2("desktop advinst build")
   ret = utils.ps1("make_advinst.ps1", args, verbose=True)
   utils.set_summary("desktop advinst build", ret)
 
@@ -397,7 +329,7 @@ def make_linux():
   utils.set_cwd("desktop-apps/win-linux/package/linux")
 
   utils.log_h2("desktop build")
-  make_args = branding.desktop_make_targets
+  make_args = [t["make"] for t in branding.desktop_make_targets]
   if common.platform == "linux_aarch64":
     make_args += ["-e", "UNAME_M=aarch64"]
   if not branding.onlyoffice:
@@ -405,68 +337,11 @@ def make_linux():
   ret = utils.sh("make clean && make " + " ".join(make_args), verbose=True)
   utils.set_summary("desktop build", ret)
 
-  rpm_arch = "*"
-  if common.platform == "linux_aarch64": rpm_arch = "aarch64"
-
   if common.deploy:
-    if ret:
-      utils.log_h2("desktop tar deploy")
-      if "tar" in branding.desktop_make_targets:
-        ret = s3_upload(
-          utils.glob_path("tar/*.tar*"),
-          "desktop/linux/generic/")
-        utils.set_summary("desktop tar deploy", ret)
-      if "deb" in branding.desktop_make_targets:
-        utils.log_h2("desktop deb deploy")
-        ret = s3_upload(
-          utils.glob_path("deb/*.deb"),
-          "desktop/linux/debian/")
-        utils.set_summary("desktop deb deploy", ret)
-      if "deb-astra" in branding.desktop_make_targets:
-        utils.log_h2("desktop deb-astra deploy")
-        ret = s3_upload(
-          utils.glob_path("deb-astra/*.deb"),
-          "desktop/linux/astra/")
-        utils.set_summary("desktop deb-astra deploy", ret)
-      if "rpm" in branding.desktop_make_targets:
-        utils.log_h2("desktop rpm deploy")
-        ret = s3_upload(
-          utils.glob_path("rpm/builddir/RPMS/" + rpm_arch + "/*.rpm"),
-          "desktop/linux/rhel/")
-        utils.set_summary("desktop rpm deploy", ret)
-      if "suse-rpm" in branding.desktop_make_targets:
-        utils.log_h2("desktop suse-rpm deploy")
-        ret = s3_upload(
-          utils.glob_path("suse-rpm/builddir/RPMS/" + rpm_arch + "/*.rpm"),
-          "desktop/linux/suse/")
-        utils.set_summary("desktop suse-rpm deploy", ret)
-      if "apt-rpm" in branding.desktop_make_targets:
-        utils.log_h2("desktop apt-rpm deploy")
-        ret = s3_upload(
-          utils.glob_path("apt-rpm/builddir/RPMS/" + rpm_arch + "/*.rpm"),
-          "desktop/linux/altlinux/")
-        utils.set_summary("desktop apt-rpm deploy", ret)
-      if "urpmi" in branding.desktop_make_targets:
-        utils.log_h2("desktop urpmi deploy")
-        ret = s3_upload(
-          utils.glob_path("urpmi/builddir/RPMS/" + rpm_arch + "/*.rpm"),
-          "desktop/linux/rosa/")
-        utils.set_summary("desktop urpmi deploy", ret)
-    else:
-      if "tar" in branding.desktop_make_targets:
-        utils.set_summary("desktop tar deploy", False)
-      if "deb" in branding.desktop_make_targets:
-        utils.set_summary("desktop deb deploy", False)
-      if "deb-astra" in branding.desktop_make_targets:
-        utils.set_summary("desktop deb-astra deploy", False)
-      if "rpm" in branding.desktop_make_targets:
-        utils.set_summary("desktop rpm deploy", False)
-      if "suse-rpm" in branding.desktop_make_targets:
-        utils.set_summary("desktop suse-rpm deploy", False)
-      if "apt-rpm" in branding.desktop_make_targets:
-        utils.set_summary("desktop apt-rpm deploy", False)
-      if "urpmi" in branding.desktop_make_targets:
-        utils.set_summary("desktop urpmi deploy", False)
+    for t in branding.desktop_make_targets:
+      utils.log_h2("desktop " + t["make"] + " deploy")
+      ret = s3_upload(utils.glob_path(t["src"]), t["dst"])
+      utils.set_summary("desktop " + t["make"] + " deploy", ret)
 
   utils.set_cwd(common.workspace_dir)
   return

scripts/package_server.py

@@ -61,7 +61,8 @@ def make_linux(edition):
   utils.set_cwd("document-server-package")
 
   utils.log_h2("server " + edition + " build")
-  make_args = branding.server_make_targets + ["-e", "PRODUCT_NAME=" + product_name]
+  make_args = [t["make"] for t in branding.server_make_targets]
+  make_args += ["-e", "PRODUCT_NAME=" + product_name]
   if common.platform == "linux_aarch64":
     make_args += ["-e", "UNAME_M=aarch64"]
   if not branding.onlyoffice:
@@ -70,40 +71,10 @@ def make_linux(edition):
   utils.set_summary("server " + edition + " build", ret)
 
   if common.deploy:
-    if ret:
-      if "deb" in branding.server_make_targets:
-        utils.log_h2("server " + edition + " deb deploy")
-        ret = s3_upload(
-          utils.glob_path("deb/*.deb"),
-          "server/linux/debian/")
-        utils.set_summary("server " + edition + " deb deploy", ret)
-      if "rpm" in branding.server_make_targets:
-        utils.log_h2("server " + edition + " rpm deploy")
-        ret = s3_upload(
-          utils.glob_path("rpm/builddir/RPMS/*/*.rpm"),
-          "server/linux/rhel/")
-        utils.set_summary("server " + edition + " rpm deploy", ret)
-      if "apt-rpm" in branding.server_make_targets:
-        utils.log_h2("server " + edition + " apt-rpm deploy")
-        ret = s3_upload(
-          utils.glob_path("apt-rpm/builddir/RPMS/*/*.rpm"),
-          "server/linux/altlinux/")
-        utils.set_summary("server " + edition + " apt-rpm deploy", ret)
-      if "tar" in branding.server_make_targets:
-        utils.log_h2("server " + edition + " snap deploy")
-        ret = s3_upload(
-          utils.glob_path("*.tar.gz"),
-          "server/linux/snap/")
-        utils.set_summary("server " + edition + " snap deploy", ret)
-    else:
-      if "deb" in branding.server_make_targets:
-        utils.set_summary("server " + edition + " deb deploy", False)
-      if "rpm" in branding.server_make_targets:
-        utils.set_summary("server " + edition + " rpm deploy", False)
-      if "apt-rpm" in branding.server_make_targets:
-        utils.set_summary("server " + edition + " apt-rpm deploy", False)
-      if "tar" in branding.server_make_targets:
-        utils.set_summary("server " + edition + " snap deploy", False)
+    for t in branding.server_make_targets:
+      utils.log_h2("server " + edition + " " + t["make"] + " deploy")
+      ret = s3_upload(utils.glob_path(t["src"]), t["dst"])
+      utils.set_summary("server " + edition + " " + t["make"] + " deploy", ret)
 
   utils.set_cwd(common.workspace_dir)
   return

scripts/package_utils.py

@@ -12,7 +12,6 @@ import subprocess
 import sys
 import time
 import package_common as common
-import base
 
 def host_platform():
   return platform.system().lower()
@@ -202,13 +201,12 @@ def copy_files(src, dst, override=True, verbose=True):
       copy_files(file + "/*", dst + "/" + file_name, override)
   return
 
-def copy_dir(src, dst, override=True, verbose=True):
+def copy_dir(src, dst, verbose=True):
   if verbose:
     log("- copy_dir:")
     log("    src: " + src)
     log("    dst: " + dst)
-    log("    override: " + str(override))
-  base.copy_dir(src, dst)
+  shutil.copytree(src, dst)
   return
 
 def copy_dir_content(src, dst, filter_include = "", filter_exclude = "", verbose=True):
@@ -218,20 +216,18 @@ def copy_dir_content(src, dst, filter_include = "", filter_exclude = "", verbose
     log("    dst: " + dst)
     log("    include: " + filter_include)
     log("    exclude: " + filter_exclude)
-  src_folder = src
-  if ("/" != src[-1:]):
-    src_folder += "/"
-  src_folder += "*"
-  for file in glob.glob(src_folder):
-    basename = os.path.basename(file)
-    if ("" != filter_include) and (-1 == basename.find(filter_include)):
+  for item in os.listdir(src):
+    s = os.path.join(src, item)
+    d = os.path.join(dst, item)
+    if ("" != filter_include) and (-1 == item.find(filter_include)):
       continue
-    if ("" != filter_exclude) and (-1 != basename.find(filter_exclude)):
+    if ("" != filter_exclude) and (-1 != item.find(filter_exclude)):
       continue
-    if is_file(file):
-      copy_file(file, dst, verbose=False)
-    elif is_dir(file):
-      copy_dir(file, dst + "/" + basename, verbose=False)
+    if os.path.isdir(s):
+      shutil.copytree(s, d)
+    else:
+      shutil.copy2(s, d)
+    log(item)
   return
 
 def delete_file(path, verbose=True):
@@ -326,33 +322,11 @@ def ps1(file, args=[], **kwargs):
   if kwargs.get("creates") and is_exist(kwargs["creates"]):
     return True
   ret = subprocess.call(
-      ["powershell", "-File", file] + args, stderr=subprocess.STDOUT, shell=True
+    ["powershell", "-ExecutionPolicy", "ByPass", "-File", file] + args,
+    stderr=subprocess.STDOUT, shell=True
   ) == 0
   return ret
 
-def download_file(url, path, md5, verbose=False):
-  if verbose:
-    log("- download_file:")
-    log("    url: " + path)
-    log("    path: " + url)
-    log("    md5: " + md5)
-  if is_file(path):
-    if get_hash_md5(path) == md5:
-      log_err("file already exist (match checksum)")
-      return True
-    else:
-      log_err("wrong checksum (%s), delete" % md5)
-      os.remove(path)
-  ret = powershell(
-      "(New-Object System.Net.WebClient).DownloadFile('%s','%s')" % (url, path),
-      verbose=True
-  )
-  md5_new = get_hash_md5(path)
-  if md5 != md5_new:
-    log_err("checksum didn't match (%s != %s)" % (md5, md5_new))
-    return False
-  return ret
-
 def sh(command, **kwargs):
   if kwargs.get("verbose"):
     log("- sh:")

scripts/sdkjs_common/generate_builder_intarface.py

@@ -2,6 +2,8 @@
 import os
 import shutil
 import re
+import argparse
+
 def readFile(path):
   with open(path, "r", errors='replace') as file:
     filedata = file.read()
@@ -112,6 +114,8 @@ class EditorApi(object):
       line = line.replace("}", "")
       lineWithoutSpaces = line.replace(" ", "")
       if not is_found_function and 0 == line.find("function "):
+        if -1 == decoration.find("@constructor"):
+          return
         codeCorrect += (line + addon_for_func + "\n")
         is_found_function = True
       if not is_found_function and -1 != line.find(".prototype."):
@@ -177,7 +181,7 @@ class EditorApi(object):
 
   def generate(self):
     for file in self.files:
-      file_content = readFile(file)
+      file_content = readFile(f'{sdkjs_dir}/{file}')
       arrRecords = file_content.split("/**")
       arrRecords = arrRecords[1:-1]
       for record in arrRecords:
@@ -185,8 +189,8 @@ class EditorApi(object):
       self.numfile += 1
     correctContent = ''.join(self.records)
     correctContent += "\n"
-    os.mkdir('deploy/api_builder/' + self.folder)
-    writeFile("deploy/api_builder/" + self.folder + "/api.js", correctContent)
+    os.mkdir(args.destination + self.folder)
+    writeFile(args.destination + self.folder + "/api.js", correctContent)
     return
 
 def convert_to_interface(arrFiles, sEditorType):
@@ -195,12 +199,27 @@ def convert_to_interface(arrFiles, sEditorType):
   editor.generate()
   return
 
-old_cur = os.getcwd()
-os.chdir("../../../sdkjs")
-if True == os.path.isdir('deploy/api_builder'):
-  shutil.rmtree('deploy/api_builder', ignore_errors=True)
-os.mkdir('deploy/api_builder')
-convert_to_interface(["word/apiBuilder.js"], "word")
-convert_to_interface(["word/apiBuilder.js", "slide/apiBuilder.js"], "slide")
-convert_to_interface(["word/apiBuilder.js", "slide/apiBuilder.js", "cell/apiBuilder.js"], "cell")
-os.chdir(old_cur)
+sdkjs_dir = "../../../sdkjs"
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Generate documentation")
+    parser.add_argument(
+        "destination", 
+        type=str, 
+        help="Destination directory for the generated documentation",
+        nargs='?',  # Indicates the argument is optional
+        default="../../../onlyoffice.github.io\sdkjs-plugins\content\macros\libs/"  # Default value
+    )
+    args = parser.parse_args()
+    
+    old_cur = os.getcwd()
+    
+    if True == os.path.isdir(args.destination):
+      shutil.rmtree(args.destination, ignore_errors=True)
+    os.mkdir(args.destination)
+    convert_to_interface(["word/apiBuilder.js"], "word")
+    convert_to_interface(["word/apiBuilder.js", "slide/apiBuilder.js"], "slide")
+    convert_to_interface(["word/apiBuilder.js", "slide/apiBuilder.js", "cell/apiBuilder.js"], "cell")
+    os.chdir(old_cur)
+
+

scripts/sdkjs_common/jsdoc/README.md

@@ -0,0 +1,57 @@
+
+# Documentation Generation Guide
+
+This guide explains how to generate documentation for Onlyoffice API using the provided Python scripts, `generate_docs_json.py` and `generate_docs_md.py`. These scripts are used to create JSON and Markdown documentation for the `apiBuilder.js` files from the word, cell, and slide editors.
+
+## Prerequisites
+
+1. **Node.js and npm**: Ensure you have Node.js and npm installed on your machine. You can download them from [Node.js official website](https://nodejs.org/).
+
+2. **jsdoc**: The scripts use `jsdoc` to generate documentation. Install it using npm:
+   ```bash
+   npm install
+   ```
+
+## Scripts Overview
+
+### `generate_docs_json.py`
+
+This script generates JSON documentation based on the `apiBuilder.js` files.
+
+- **Usage**:
+  ```bash
+  python generate_docs_json.py output_path
+  ```
+
+- **Parameters**:
+  - `output_path` (optional): The directory where the JSON documentation will be saved. If not specified, the default path is `Onlyoffice/sdkjs/deploy/api_builder/json`.
+
+### `generate_docs_md.py`
+
+This script generates Markdown documentation from the `apiBuilder.js` files.
+
+- **Usage**:
+  ```bash
+  python generate_docs_md.py output_path
+  ```
+
+- **Parameters**:
+  - `output_path` (optional): The directory where the Markdown documentation will be saved. If not specified, the default path is `Onlyoffice/office-js-api`.
+
+## Example
+
+To generate JSON documentation with the default output path:
+```bash
+python generate_docs_json.py /path/to/save/json
+```
+
+To generate Markdown documentation and specify a custom output path:
+```bash
+python generate_docs_md.py /path/to/save/markdown
+```
+
+## Notes
+
+- Make sure to have all necessary permissions to run these scripts and write to the specified directories.
+- The output directories will be created if they do not exist.
+

scripts/sdkjs_common/jsdoc/config/cell.json

@@ -0,0 +1,16 @@
+{
+  "source": {
+    "include": ["../../../../sdkjs/word/apiBuilder.js", "../../../../sdkjs/slide/apiBuilder.js", "../../../../sdkjs/cell/apiBuilder.js"]
+  },
+  "plugins": ["./correct_doclets.js"],
+  "opts": {
+    "destination": "./out",
+    "recurse": true,
+    "encoding": "utf8"
+  },
+  "templates": {
+    "json": {
+      "pretty": true
+    }
+  }
+}

scripts/sdkjs_common/jsdoc/config/correct_doclets.js

@@ -0,0 +1,216 @@
+exports.handlers = {
+    processingComplete: function(e) {
+        // array for filtered doclets
+        let filteredDoclets = [];
+
+        const cleanName = name => name ? name.replace('<anonymous>~', '').replaceAll('"', '') : name;
+
+        const classesDocletsMap = {}; // doclets for classes write at the end
+        let passedClasses = []; // passed classes for current editor
+
+        // Remove dublicates doclets
+        const latestDoclets = {};
+        e.doclets.forEach(doclet => {
+            const isMethod = doclet.kind === 'function' || doclet.kind === 'method';
+            const hasTypeofEditorsTag = isMethod && doclet.tags && doclet.tags.some(tag => tag.title === 'typeofeditors' && tag.value.includes(process.env.EDITOR));
+
+            const shouldAddMethod = 
+                doclet.kind !== 'member' &&
+                (!doclet.longname || doclet.longname.search('private') === -1) &&
+                doclet.scope !== 'inner' && hasTypeofEditorsTag;
+
+            if (shouldAddMethod || doclet.kind == 'typedef' || doclet.kind == 'class') {
+                latestDoclets[doclet.longname] = doclet;
+            }
+        });
+        e.doclets.splice(0, e.doclets.length, ...Object.values(latestDoclets));
+
+        // check available classess for current editor
+        for (let i = 0; i < e.doclets.length; i++) {
+            const doclet = e.doclets[i];
+            const isMethod = doclet.kind === 'function' || doclet.kind === 'method';
+            const hasTypeofEditorsTag = isMethod && doclet.tags && doclet.tags.some(tag => tag.title === 'typeofeditors' && tag.value.includes(process.env.EDITOR));
+
+            const shouldAdd = 
+                doclet.kind !== 'member' &&
+                (!doclet.longname || doclet.longname.search('private') === -1) &&
+                doclet.scope !== 'inner' &&
+                (!isMethod || hasTypeofEditorsTag);
+
+            if (shouldAdd) {
+                if (doclet.memberof && false == passedClasses.includes(cleanName(doclet.memberof))) {
+                    passedClasses.push(cleanName(doclet.memberof));
+                }
+            }
+            else if (doclet.kind == 'class') {
+                classesDocletsMap[cleanName(doclet.name)] = doclet;
+            }
+        }
+
+        // remove unavailave classes in current editor
+        passedClasses = passedClasses.filter(className => {
+            const doclet = classesDocletsMap[className];
+            if (!doclet) {
+                return true;
+            }
+
+            const hasTypeofEditorsTag = !!(doclet.tags && doclet.tags.some(tag => tag.title === 'typeofeditors'));
+
+            // class is passes if there is no editor tag or the current editor is among the tags
+            const isPassed = false == hasTypeofEditorsTag || doclet.tags.some(tag => tag.title === 'typeofeditors' && tag.value && tag.value.includes(process.env.EDITOR));
+            return isPassed;
+        });
+
+        for (let i = 0; i < e.doclets.length; i++) {
+            const doclet = e.doclets[i];
+            const isMethod = doclet.kind === 'function' || doclet.kind === 'method';
+            const hasTypeofEditorsTag = isMethod && doclet.tags && doclet.tags.some(tag => tag.title === 'typeofeditors' && tag.value.includes(process.env.EDITOR));
+
+            const shouldAddMethod = 
+                doclet.kind !== 'member' &&
+                (!doclet.longname || doclet.longname.search('private') === -1) &&
+                doclet.scope !== 'inner' && hasTypeofEditorsTag;
+
+            if (shouldAddMethod) {
+                // if the class is not in our map, then we deleted it ourselves -> not available in the editor
+                if (false == passedClasses.includes(cleanName(doclet.memberof))) {
+                    continue;
+                }
+
+                // We leave only the necessary fields
+                doclet.memberof = cleanName(doclet.memberof);
+                doclet.longname = cleanName(doclet.longname);
+                doclet.name     = cleanName(doclet.name);
+
+                const filteredDoclet = {
+                    comment:        doclet.comment,
+                    description:    doclet.description,
+                    memberof:       cleanName(doclet.memberof),
+
+                    params: doclet.params ? doclet.params.map(param => ({
+                        type: param.type ? {
+                            names:      param.type.names,
+                            parsedType: param.type.parsedType
+                        } : param.type,
+
+                        name:           param.name,
+                        description:    param.description,
+                        optional:       param.optional,
+                        defaultvalue:   param.defaultvalue
+                    })) : doclet.params,
+
+                    returns: doclet.returns ? doclet.returns.map(returnObj => ({
+                        type: {
+                          names:        returnObj.type.names,
+                          parsedType:   returnObj.type.parsedType
+                        }
+                    })) : doclet.returns,
+
+                    name:           doclet.name,
+                    longname:       cleanName(doclet.longname),
+                    kind:           doclet.kind,
+                    scope:          doclet.scope,
+
+                    type: doclet.type ? {
+                        names: doclet.type.names,
+                        parsedType: doclet.type.parsedType
+                    } : doclet.type,
+                    
+                    properties: doclet.properties ? doclet.properties.map(property => ({
+                        type: property.type ? {
+                            names:      property.type.names,
+                            parsedType: property.type.parsedType
+                        } : property.type,
+
+                        name:           property.name,
+                        description:    property.description,
+                        optional:       property.optional,
+                        defaultvalue:   property.defaultvalue
+                    })) : doclet.properties,
+                    
+                    meta: doclet.meta ? {
+                        lineno:   doclet.meta.lineno,
+                        columnno: doclet.meta.columnno
+                    } : doclet.meta,
+
+                    see: doclet.see 
+                };
+
+                // Add the filtered doclet to the array
+                filteredDoclets.push(filteredDoclet);
+            }
+            else if (doclet.kind == 'class') {
+                // if the class is not in our map, then we deleted it ourselves -> not available in the editor
+                if (false == passedClasses.includes(cleanName(doclet.name))) {
+                    continue;
+                }
+
+                const filteredDoclet = {
+                    comment:        doclet.comment,
+                    description:    doclet.description,
+                    name:           cleanName(doclet.name),
+                    longname:       cleanName(doclet.longname),
+                    kind:           doclet.kind,
+                    scope:          "global",
+                    augments:       doclet.augments || undefined,
+                    meta: doclet.meta ? {
+                        lineno:   doclet.meta.lineno,
+                        columnno: doclet.meta.columnno
+                    } : doclet.meta,
+                    properties: doclet.properties ? doclet.properties.map(property => ({
+                        type: property.type ? {
+                            names:      property.type.names,
+                            parsedType: property.type.parsedType
+                        } : property.type,
+
+                        name:           property.name,
+                        description:    property.description,
+                        optional:       property.optional,
+                        defaultvalue:   property.defaultvalue
+                    })) : doclet.properties,
+                    see: doclet.see || undefined
+                };
+    
+                filteredDoclets.push(filteredDoclet);
+            }
+            else if (doclet.kind == 'typedef') {
+                const filteredDoclet = {
+                    comment:        doclet.comment,
+                    description:    doclet.description,
+                    name:           cleanName(doclet.name),
+                    longname:       cleanName(doclet.longname),
+                    kind:           doclet.kind,
+                    scope:          "global",
+
+                    meta: doclet.meta ? {
+                        lineno:   doclet.meta.lineno,
+                        columnno: doclet.meta.columnno
+                    } : doclet.meta,
+
+                    properties: doclet.properties ? doclet.properties.map(property => ({
+                        type: property.type ? {
+                            names:      property.type.names,
+                            parsedType: property.type.parsedType
+                        } : property.type,
+
+                        name:           property.name,
+                        description:    property.description,
+                        optional:       property.optional,
+                        defaultvalue:   property.defaultvalue
+                    })) : doclet.properties,
+
+                    see: doclet.see,
+                    type: doclet.type ? {
+                        names: doclet.type.names,
+                        parsedType: doclet.type.parsedType
+                    } : doclet.type
+                };
+
+                filteredDoclets.push(filteredDoclet);
+            }
+        }
+
+        // Replace doclets with a filtered array
+        e.doclets.splice(0, e.doclets.length, ...filteredDoclets);
+    }
+};

scripts/sdkjs_common/jsdoc/config/forms.json

@@ -0,0 +1,16 @@
+{
+  "source": {
+    "include": ["../../../../sdkjs/word/apiBuilder.js", "../../../../sdkjs-forms/apiBuilder.js"]
+  },
+  "plugins": ["./correct_doclets.js"],
+  "opts": {
+    "destination": "./out",
+    "recurse": true,
+    "encoding": "utf8"
+  },
+  "templates": {
+    "json": {
+      "pretty": true
+    }
+  }
+}

scripts/sdkjs_common/jsdoc/config/slide.json

@@ -0,0 +1,16 @@
+{
+  "source": {
+    "include": ["../../../../sdkjs/word/apiBuilder.js", "../../../../sdkjs/slide/apiBuilder.js"]
+  },
+  "plugins": ["./correct_doclets.js"],
+  "opts": {
+    "destination": "./out",
+    "recurse": true,
+    "encoding": "utf8"
+  },
+  "templates": {
+    "json": {
+      "pretty": true
+    }
+  }
+}

scripts/sdkjs_common/jsdoc/config/word.json

@@ -0,0 +1,16 @@
+{
+  "source": {
+    "include": ["../../../../sdkjs/word/apiBuilder.js"]
+  },
+  "plugins": ["./correct_doclets.js"],
+  "opts": {
+    "destination": "./out",
+    "recurse": true,
+    "encoding": "utf8"
+  },
+  "templates": {
+    "json": {
+      "pretty": true
+    }
+  }
+}

scripts/sdkjs_common/jsdoc/generate_docs_json.py

@@ -0,0 +1,136 @@
+import os
+import subprocess
+import json
+import argparse
+import re
+
+# Configuration files
+configs = [
+    "./config/word.json",
+    "./config/cell.json",
+    "./config/slide.json",
+    "./config/forms.json"
+]
+
+editors_maps = {
+    "word":     "CDE",
+    "cell":     "CSE",
+    "slide":    "CPE",
+    "forms":    "CFE"
+}
+
+def generate(output_dir, md=False):
+    missing_examples_file = f'{output_dir}/missing_examples.txt'
+
+    if not os.path.exists(output_dir):
+        os.makedirs(output_dir)
+
+    # Recreate missing_examples.txt file
+    with open(missing_examples_file, 'w', encoding='utf-8') as f:
+        f.write('')
+
+    # Generate JSON documentation
+    for config in configs:
+        editor_name = config.split('/')[-1].replace('.json', '')
+        output_file = os.path.join(output_dir, editor_name + ".json")
+        command = f"set EDITOR={editors_maps[editor_name]} && npx jsdoc -c {config} -X > {output_file}"
+        print(f"Generating {editor_name}.json: {command}")
+        subprocess.run(command, shell=True)
+
+    # Append examples to JSON documentation
+    for config in configs:
+        editor_name = config.split('/')[-1].replace('.json', '')
+        output_file = os.path.join(output_dir, editor_name + ".json")
+        
+        # Read the JSON file
+        with open(output_file, 'r', encoding='utf-8') as f:
+            data = json.load(f)
+        
+        # Modify JSON data
+        for doclet in data:
+            if 'see' in doclet:
+                if doclet['see'] is not None:
+                    if editor_name == 'forms':
+                        doclet['see'][0] = doclet['see'][0].replace('{Editor}', 'Word')
+                    else:
+                        doclet['see'][0] = doclet['see'][0].replace('{Editor}', editor_name.title())
+
+                    file_path = '../../../../' + doclet['see'][0]
+
+                    if os.path.exists(file_path):
+                        with open(file_path, 'r', encoding='utf-8') as see_file:
+                            example_content = see_file.read()
+                        
+                        # Extract the first line as a comment if it exists
+                        lines = example_content.split('\n')
+                        if lines[0].startswith('//'):
+                            comment = lines[0] + '\n'
+                            code_content = '\n'.join(lines[1:])
+                        else:
+                            comment = ''
+                            code_content = example_content
+                        
+                        # Format content for doclet['example']
+                        doclet['example'] = remove_js_comments(comment) + "```js\n" + code_content + "\n```"
+                        
+                        if md == False:
+                            doclet['description'] = doclet['description'] + f'\n\n## Try it\n\n ```js document-builder={{"documentType": "{editor_name.title()}"}}\n{code_content}\n```'
+                        
+                    else:
+                        # Record missing examples in missing_examples.txt
+                        with open(missing_examples_file, 'a', encoding='utf-8') as missing_file:
+                            missing_file.write(f"{file_path}\n")
+        
+        # Write the modified JSON file back
+        with open(output_file, 'w', encoding='utf-8') as f:
+            json.dump(data, f, ensure_ascii=False, indent=4)
+
+    print("Documentation generation completed.")
+
+def remove_builder_lines(text):
+    lines = text.splitlines()  # Split text into lines
+    filtered_lines = [line for line in lines if not line.strip().startswith("builder.")]
+    return "\n".join(filtered_lines)
+
+def remove_js_comments(text):
+    # Remove single-line comments, leaving text after //
+    text = re.sub(r'^\s*//\s?', '', text, flags=re.MULTILINE)
+    # Remove multi-line comments, leaving text after /*
+    text = re.sub(r'/\*\s*|\s*\*/', '', text, flags=re.DOTALL)
+    return text.strip()
+
+def get_current_branch(path):
+    try:
+        # Navigate to the specified directory and get the current branch name
+        result = subprocess.run(
+            ["git", "rev-parse", "--abbrev-ref", "HEAD"],
+            cwd=path,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True
+        )
+        if result.returncode == 0:
+            return result.stdout.strip()
+        else:
+            print(f"Error: {result.stderr}")
+            return None
+    except Exception as e:
+        print(f"Exception: {e}")
+        return None
+    
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Generate documentation")
+    parser.add_argument(
+        "destination", 
+        type=str, 
+        help="Destination directory for the generated documentation",
+        nargs='?',  # Indicates the argument is optional
+        default="../../../../document-builder-declarations/document-builder"  # Default value
+    )
+    args = parser.parse_args()
+    
+    branch_name = get_current_branch("../../../../sdkjs")
+    if branch_name:
+        args.destination = f"{args.destination}/{branch_name}"
+    
+    generate(args.destination)

scripts/sdkjs_common/jsdoc/generate_docs_md.py

@@ -0,0 +1,266 @@
+import os
+import json
+import re
+import shutil
+import argparse
+import generate_docs_json
+
+# Configuration files
+editors = [
+    "word",
+    "cell",
+    "slide",
+    "forms"
+]
+
+def load_json(file_path):
+    with open(file_path, 'r', encoding='utf-8') as f:
+        return json.load(f)
+
+def write_markdown_file(file_path, content):
+    with open(file_path, 'w', encoding='utf-8') as md_file:
+        md_file.write(content)
+
+def remove_js_comments(text):
+    # Remove single-line comments, leaving text after //
+    text = re.sub(r'^\s*//\s?', '', text, flags=re.MULTILINE)
+    # Remove multi-line comments, leaving text after /*
+    text = re.sub(r'/\*\s*|\s*\*/', '', text, flags=re.DOTALL)
+    return text.strip()
+
+def correct_description(string):
+    if string is None:
+        return 'No description provided.'
+    
+    # Replace opening <b> tag with **
+    string = re.sub(r'<b>', '**', string)
+    # Replace closing </b> tag with **
+    string = re.sub(r'</b>', '**', string)
+    # Note
+    return re.sub(r'<note>(.*?)</note>', r'💡 \1', string, flags=re.DOTALL)
+
+def correct_default_value(value, enumerations, classes):
+    if value is None:
+        return ''
+    
+    if value == True:
+        value = "true"
+    elif value == False:
+        value = "false"
+    else:
+        value = str(value)
+    
+    return generate_data_types_markdown([value], enumerations, classes)
+
+def remove_line_breaks(string):
+    return re.sub(r'[\r\n]', '', string)
+
+def generate_data_types_markdown(types, enumerations, classes, root='../../'):
+    param_types_md = ' &#124;'.join(types)
+
+    for enum in enumerations:
+        if enum['name'] in types:
+            param_types_md = param_types_md.replace(enum['name'], f"[{enum['name']}]({root}Enumeration/{enum['name']}.md)")
+    for cls in classes:
+        if cls in types:
+            param_types_md = param_types_md.replace(cls, f"[{cls}]({root}{cls}/{cls}.md)")
+
+    def replace_with_links(match):
+        element = match.group(1).strip()
+        base_type = element.split('.')[0]  # Take only the first part before the dot, if any
+        if any(enum['name'] == base_type for enum in enumerations):
+            return f"<[{element}](../../Enumeration/{base_type}.md)>"
+        elif base_type in classes:
+            return f"<[{element}](../../{base_type}/{base_type}.md)>"
+        return f"<{element}>"
+    
+    return re.sub(r'<([^<>]+)>', replace_with_links, param_types_md)
+
+def generate_class_markdown(class_name, methods, properties, enumerations, classes):
+    content = f"# {class_name}\n\nRepresents the {class_name} class.\n\n"
+    
+    content += generate_properties_markdown(properties, enumerations, classes, '../')
+
+    content += "## Methods\n\n"
+    for method in methods:
+        method_name = method['name']
+        content += f"- [{method_name}](./Methods/{method_name}.md)\n"
+    return content
+
+def generate_method_markdown(method, enumerations, classes):
+    method_name = method['name']
+    description = method.get('description', 'No description provided.')
+    description = correct_description(description)
+    params = method.get('params', [])
+    returns = method.get('returns', [])
+    example = method.get('example', '')
+    memberof = method.get('memberof', '')
+
+    content = f"# {method_name}\n\n{description}\n\n"
+    
+    # Syntax section
+    param_list = ', '.join([param['name'] for param in params]) if params else ''
+    content += f"## Syntax\n\nexpression.{method_name}({param_list});\n\n"
+    if memberof:
+        content += f"`expression` - A variable that represents a [{memberof}](../{memberof}.md) class.\n\n"
+
+    content += "## Parameters\n\n"
+
+    if params:
+        content += "| **Name** | **Required/Optional** | **Data type** | **Default** | **Description** |\n"
+        content += "| ------------- | ------------- | ------------- | ------------- | ------------- |\n"
+        for param in params:
+            param_name = param.get('name', 'Unnamed')
+            param_types = param.get('type', {}).get('names', []) if param.get('type') else []
+            param_types_md = generate_data_types_markdown(param_types, enumerations, classes)
+            param_desc = remove_line_breaks(correct_description(param.get('description', 'No description provided.')))
+            param_required = "Required" if not param.get('optional') else "Optional"
+            param_default = correct_default_value(param.get('defaultvalue', ''), enumerations, classes)
+
+            content += f"| {param_name} | {param_required} | {param_types_md} | {param_default} | {param_desc} |\n"
+    else:
+        content += "This method doesn't have any parameters.\n"
+
+    content += "\n## Returns\n\n"
+    if returns:
+        return_type = ', '.join(returns[0].get('type', {}).get('names', [])) if returns[0].get('type') else 'Unknown'
+        
+        # Check for enumerations and classes in return type and add links if they exist
+        return_type_md = generate_data_types_markdown([return_type], enumerations, classes)
+        content += return_type_md
+    else:
+        content += "This method doesn't return any data."
+    
+    if example:
+        # Separate comment and code, and remove comment symbols
+        comment, code = example.split('```js', 1)
+        comment = remove_js_comments(comment)
+        content += f"\n\n## Example\n\n{comment}\n\n```javascript\n{code.strip()}\n"
+
+    return content
+
+def generate_properties_markdown(properties, enumerations, classes, root='../../'):
+    if (properties is None):
+        return ''
+    
+    content = "## Properties\n\n"
+    content += "| Name | Type | Description |\n"
+    content += "| ---- | ---- | ----------- |\n"
+    for prop in properties:
+        prop_name = prop['name']
+        prop_description = prop.get('description', 'No description provided.')
+        prop_description = remove_line_breaks(correct_description(prop_description))
+        param_types_md = generate_data_types_markdown(prop['type']['names'], enumerations, classes, root)
+        content += f"| {prop_name} | {param_types_md} | {prop_description} |\n"
+    content += "\n"
+
+    return content
+        
+
+def generate_enumeration_markdown(enumeration, enumerations, classes):
+    enum_name = enumeration['name']
+    description = enumeration.get('description', 'No description provided.')
+    description = correct_description(description)
+    example = enumeration.get('example', '')
+
+    content = f"# {enum_name}\n\n{description}\n\n"
+    
+    if 'TypeUnion' == enumeration['type']['parsedType']['type']:
+        content += "## Type\n\nEnumeration\n\n"
+        content += "## Values\n\n"
+        elements = enumeration['type']['parsedType']['elements']
+        for element in elements:
+            element_name = element['name'] if element['type'] != 'NullLiteral' else 'null'
+            # Check if element is in enumerations or classes before adding link
+            if any(enum['name'] == element_name for enum in enumerations):
+                content += f"- [{element_name}](../../Enumeration/{element_name}.md)\n"
+            elif element_name in classes:
+                content += f"- [{element_name}](../../{element_name}/{element_name}.md)\n"
+            else:
+                content += f"- {element_name}\n"
+    elif enumeration['properties'] is not None:
+        content += "## Type\n\nObject\n\n"
+        content += generate_properties_markdown(enumeration['properties'], enumerations, classes)
+    else:
+        content += "## Type\n\n"
+        types = enumeration['type']['names']
+        for t in types:
+            t = generate_data_types_markdown([t], enumerations, classes)
+            content += t + "\n\n"
+
+    if example:
+        # Separate comment and code, and remove comment symbols
+        comment, code = example.split('```js', 1)
+        comment = remove_js_comments(comment)
+        content += f"\n\n## Example\n\n{comment}\n\n```javascript\n{code.strip()}\n"
+
+    return content
+
+def process_doclets(data, output_dir):
+    classes = {}
+    classes_props = {}
+    enumerations = []
+
+    for doclet in data:
+        if doclet['kind'] == 'class':
+            class_name = doclet['name']
+            classes[class_name] = []
+            classes_props[class_name] = doclet.get('properties', None)
+        elif doclet['kind'] == 'function':
+            class_name = doclet.get('memberof')
+            if class_name:
+                if class_name not in classes:
+                    classes[class_name] = []
+                classes[class_name].append(doclet)
+        elif doclet['kind'] == 'typedef':
+            enumerations.append(doclet)
+
+    # Process classes
+    for class_name, methods in classes.items():
+        class_dir = os.path.join(output_dir, class_name)
+        methods_dir = os.path.join(class_dir, 'Methods')
+        os.makedirs(methods_dir, exist_ok=True)
+
+        # Write class file
+        class_content = generate_class_markdown(class_name, methods, classes_props[class_name], enumerations, classes)
+        write_markdown_file(os.path.join(class_dir, f"{class_name}.md"), class_content)
+
+        # Write method files
+        for method in methods:
+            method_content = generate_method_markdown(method, enumerations, classes)
+            write_markdown_file(os.path.join(methods_dir, f"{method['name']}.md"), method_content)
+
+    # Process enumerations
+    enum_dir = os.path.join(output_dir, 'Enumeration')
+    os.makedirs(enum_dir, exist_ok=True)
+
+    for enum in enumerations:
+        enum_content = generate_enumeration_markdown(enum, enumerations, classes)
+        write_markdown_file(os.path.join(enum_dir, f"{enum['name']}.md"), enum_content)
+
+def generate(output_dir):
+    print('Generating Markdown documentation...')
+    
+    generate_docs_json.generate(output_dir + 'tmp_json', md=True)
+    for editor_name in editors:
+        input_file = os.path.join(output_dir + 'tmp_json', editor_name + ".json")
+        os.makedirs(output_dir + f'/{editor_name.title()}', exist_ok=True)
+
+        data = load_json(input_file)
+        process_doclets(data, output_dir + f'/{editor_name}')
+    
+    shutil.rmtree(output_dir + 'tmp_json')
+    print('Done')
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Generate documentation")
+    parser.add_argument(
+        "destination", 
+        type=str, 
+        help="Destination directory for the generated documentation",
+        nargs='?',  # Indicates the argument is optional
+        default="../../../../office-js-api/"  # Default value
+    )
+    args = parser.parse_args()
+    
+    generate(args.destination)

scripts/sdkjs_common/jsdoc/package.json

@@ -0,0 +1,7 @@
+{
+  "dependencies": {
+    "jsdoc-to-markdown": "7.1.1",
+    "dmd": "6.1.0",
+    "handlebars": "4.7.7"
+  }
+}

version

@@ -1 +1 @@
-8.0.1
+8.1.1