Add android builds

and refactoring

.github/workflows/git-operations.yml

@@ -0,0 +1,88 @@
+name: Git Operations
+
+on:
+  workflow_dispatch:
+    inputs:
+      operation:
+        description: 'Operation to perform'
+        required: true
+        type: choice
+        options:
+          - create
+          - remove
+        default: 'create'
+      
+      branch_name:
+        description: 'Branch name to create or remove'
+        required: true
+        type: string
+      
+      base_branch:
+        description: 'Base branch to work from (for create operation)'
+        required: false
+        type: string
+        default: 'develop'
+      
+      branding:
+        description: 'Branding name'
+        required: false
+        type: string
+        default: 'onlyoffice'
+      
+      branding_url:
+        description: 'Branding repository URL (relative to git host)'
+        required: false
+        type: string
+        default: 'ONLYOFFICE/onlyoffice.git'
+
+jobs:
+  git-operations:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          path: ONLYOFFICE/build_tools
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+      
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          # Install any Python dependencies if requirements.txt exists
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      
+      - name: Configure Git
+        run: |
+          git config --global user.name "GitHub Actions Bot"
+          git config --global user.email "actions@github.com"
+      
+      - name: Run Git Operations
+        run: |
+          cd ONLYOFFICE/build_tools/scripts/develop
+          python git_operations.py ${{ inputs.operation }} "${{ inputs.branch_name }}" \
+            --base-branch="${{ inputs.base_branch }}" \
+            --branding="${{ inputs.branding }}" \
+            --branding-url="${{ inputs.branding_url }}" \
+            --modules="${{ inputs.modules }}"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Operation Summary
+        run: |
+          echo "## Git Operations Summary" >> $GITHUB_STEP_SUMMARY
+          echo "- **Operation**: ${{ inputs.operation }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Branch Name**: ${{ inputs.branch_name }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Base Branch**: ${{ inputs.base_branch }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Branding**: ${{ inputs.branding }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Branding URL**: ${{ inputs.branding_url }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **Modules**: ${{ inputs.modules }}" >> $GITHUB_STEP_SUMMARY
+          if [ "${{ inputs.operation }}" = "remove" ] && [ "${{ inputs.force_remove }}" = "true" ]; then
+            echo "- **Force Remove**: Yes" >> $GITHUB_STEP_SUMMARY
+          fi

README.md

@@ -8,8 +8,8 @@ necessary for the compilation process, all the dependencies required for the
  correct work, as well as to get the latest version of
 **ONLYOFFICE products** source code and build all their components.
 
-**Important!**  We can only guarantee the correct work of the products built from
-the `master` branch.
+**Important!**  We can only guarantee the correct work of the products built
+from the `master` branch.
 
 ## How to use - Linux
 

develop/README.md

@@ -7,7 +7,8 @@ but don't want to compile pretty compilcated core product to make those changes.
 ## System requirements
 
 **Note**: ARM-based architectures are currently **NOT** supported;
-attempting to run the images on ARM devices may result in startup failures or other runtime issues.
+attempting to run the images on ARM devices may result in startup failures 
+or other runtime issues.
 
 ### Windows
 

scripts/base.py

@@ -72,7 +72,7 @@ def check_build_version(dir):
       version_number = version_number.replace("\n", "")
       set_env("PRODUCT_VERSION", version_number)
   if ("" == get_env("BUILD_NUMBER")):
-    set_env("BUILD_NUMBER", "0")      
+    set_env("BUILD_NUMBER", "0")
   return
 
 def print_info(info=""):
@@ -196,11 +196,11 @@ def move_dir(src, dst):
     delete_dir(src)
   return
 
-def copy_dir(src, dst):
+def copy_dir(src, dst, symlinks=False):
   if is_dir(dst):
     delete_dir(dst)
   try:
-    shutil.copytree(get_path(src), get_path(dst))
+    shutil.copytree(get_path(src), get_path(dst), symlinks=symlinks)
   except:
     if ("windows" == host_platform()) and copy_dir_windows(src, dst):
       return
@@ -254,7 +254,7 @@ def delete_dir(path):
 
 def copy_lib(src, dst, name):
   if (config.check_option("config", "bundle_dylibs")) and is_dir(src + "/" + name + ".framework"):
-    copy_dir(src + "/" + name + ".framework", dst + "/" + name + ".framework")
+    copy_dir(src + "/" + name + ".framework", dst + "/" + name + ".framework", symlinks=True)
 
     if (config.check_option("config", "bundle_xcframeworks")) and is_dir(src + "/simulator/" + name + ".framework"):
         create_dir(dst + "/simulator")
@@ -263,9 +263,9 @@ def copy_lib(src, dst, name):
         if is_dir(dst + "/" + name + ".xcframework"):
           delete_dir(dst + "/" + name + ".xcframework")
 
-        cmd("xcodebuild", ["-create-xcframework", 
-            "-framework", dst + "/" + name + ".framework", 
-            "-framework", dst + "/simulator/" + name + ".framework", 
+        cmd("xcodebuild", ["-create-xcframework",
+            "-framework", dst + "/" + name + ".framework",
+            "-framework", dst + "/simulator/" + name + ".framework",
             "-output", dst + "/" + name + ".xcframework"])
 
         delete_dir(dst + "/" + name + ".framework")
@@ -368,7 +368,7 @@ def writeFile(path, data):
   return
 
 # system cmd methods ------------------------------------
-def cmd(prog, args=[], is_no_errors=False):  
+def cmd(prog, args=[], is_no_errors=False):
   ret = 0
   if ("windows" == host_platform()):
     sub_args = args[:]
@@ -383,7 +383,7 @@ def cmd(prog, args=[], is_no_errors=False):
     sys.exit("Error (" + prog + "): " + str(ret))
   return ret
 
-def cmd2(prog, args=[], is_no_errors=False):  
+def cmd2(prog, args=[], is_no_errors=False):
   ret = 0
   command = prog if ("windows" != host_platform()) else get_path(prog)
   for arg in args:
@@ -453,7 +453,7 @@ def run_command(sCommand):
   finally:
     popen.stdout.close()
     popen.stderr.close()
-  
+
   return result
 
 def run_command_in_dir(directory, sCommand):
@@ -468,7 +468,7 @@ def run_command_in_dir(directory, sCommand):
   if (host == 'windows'):
     os.chdir(cur_dir)
   return ret
-  
+
 def exec_command_in_dir(directory, sCommand):
   host = host_platform()
   if (host == 'windows'):
@@ -521,6 +521,27 @@ def git_get_origin():
   os.chdir(cur_dir)
   return ret
 
+def git_get_base_url():
+  """Get the base URL for git operations, with fallback to GitHub"""
+  origin = git_get_origin()
+  if origin:
+    # Extract base URL from origin
+    if origin.startswith("https://"):
+      # For HTTPS URLs like https://git.example.com/owner/repo.git
+      parts = origin.split("/")
+      if len(parts) >= 4:
+        return "/".join(parts[:3]) + "/"
+    elif ":" in origin and "@" in origin:
+      # For SSH URLs like git@git.example.com:owner/repo.git
+      at_pos = origin.find("@")
+      colon_pos = origin.find(":", at_pos)
+      if at_pos != -1 and colon_pos != -1:
+        host = origin[at_pos+1:colon_pos]
+        return f"https://{host}/"
+
+  # Fallback to GitHub
+  return "https://github.com/"
+
 def git_is_ssh():
   git_protocol = config.option("git-protocol")
   if (git_protocol == "https"):
@@ -542,7 +563,7 @@ def get_ssh_base_url():
 def git_update(repo, is_no_errors=False, is_current_dir=False, git_owner=""):
   print("[git] update: " + repo)
   owner = git_owner if git_owner else "ONLYOFFICE"
-  url = "https://github.com/" + owner + "/" + repo + ".git"
+  url = git_get_base_url() + owner + "/" + repo + ".git"
   if git_is_ssh():
     url = get_ssh_base_url() + repo + ".git"
   folder = get_script_dir() + "/../../" + repo
@@ -614,7 +635,7 @@ def get_branding_repositories(checker):
 
 def create_pull_request(branches_to, repo, is_no_errors=False, is_current_dir=False):
   print("[git] create pull request: " + repo)
-  url = "https://github.com/ONLYOFFICE/" + repo + ".git"
+  url = git_get_base_url() + "ONLYOFFICE/" + repo + ".git"
   if git_is_ssh():
     url = get_ssh_base_url() + repo + ".git"
   folder = get_script_dir() + "/../../" + repo
@@ -641,7 +662,7 @@ def create_pull_request(branches_to, repo, is_no_errors=False, is_current_dir=Fa
         cmd("git", ["merge", "--abort"], is_no_errors)
       else:
         cmd("git", ["push"], is_no_errors)
-      
+
   os.chdir(old_cur)
   return
 
@@ -723,7 +744,7 @@ def qt_setup(platform):
       set_env("ARM64_TOOLCHAIN_BIN", cross_compiler_arm64)
       set_env("ARM64_TOOLCHAIN_BIN_PREFIX", get_prefix_cross_compiler_arm64())
 
-  return qt_dir  
+  return qt_dir
 
 def qt_version():
   qt_dir = get_env("QT_DEPLOY")
@@ -879,7 +900,7 @@ def qt_copy_plugin(name, out):
   src = get_env("QT_DEPLOY") + "/../plugins/" + name
   if not is_dir(src):
     return
-    
+
   copy_dir(src, out + "/" + name)
 
   if ("windows" == host_platform()):
@@ -891,7 +912,7 @@ def qt_copy_plugin(name, out):
         else:
           delete_file(fileCheck)
     for file in glob.glob(out + "/" + name + "/*.pdb"):
-      delete_file(file)      
+      delete_file(file)
   return
 
 def qt_dst_postfix():
@@ -956,14 +977,14 @@ def generate_doctrenderer_config(path, root, product, vendor = "", dictionaries
   file.close()
   return
 
-def generate_plist_framework_folder(file):
+def generate_plist_framework_folder(file, platform):
   bundle_id_url = "com.onlyoffice."
   if ("" != get_env("PUBLISHER_BUNDLE_ID")):
     bundle_id_url = get_env("PUBLISHER_BUNDLE_ID")
   bundle_creator = "Ascensio System SIA"
   if ("" != get_env("PUBLISHER_NAME")):
     bundle_creator = get_env("PUBLISHER_NAME")
-  
+
   bundle_version_natural = readFile(get_script_dir() + "/../../core/Common/version.txt").split(".")
   bundle_version = []
   for n in bundle_version_natural:
@@ -990,11 +1011,14 @@ def generate_plist_framework_folder(file):
   content += "\t<string>????</string>\n"
   content += "\t<key>CFBundleVersion</key>\n"
   content += "\t<string>" + bundle_version[0] + "." + bundle_version[1] + "." + bundle_version[2] + "</string>\n"
-  content += "\t<key>MinimumOSVersion</key>\n"
-  content += "\t<string>13.0</string>\n"
+  if platform.find("ios") == 0:
+    content += "\t<key>MinimumOSVersion</key>\n"
+    content += "\t<string>13.0</string>\n"
   content += "</dict>\n"
   content += "</plist>"
 
+  if platform.find("mac") == 0:
+    file += "/Resources"
   fileDst = file + "/Info.plist"
   if is_file(fileDst):
     delete_file(fileDst)
@@ -1004,7 +1028,11 @@ def generate_plist_framework_folder(file):
   fileInfo.close()
   return
 
-def generate_plist(path):
+def generate_plist(path, platform, max_depth=512):
+  if not config.check_option("config", "bundle_dylibs"):
+    return
+  if max_depth == 0:
+    return
   src_folder = path
   if ("/" != path[-1:]):
     src_folder += "/"
@@ -1012,9 +1040,9 @@ def generate_plist(path):
   for file in glob.glob(src_folder):
     if (is_dir(file)):
       if file.endswith(".framework"):
-        generate_plist_framework_folder(file)
+        generate_plist_framework_folder(file, platform)
       else:
-        generate_plist(file)
+        generate_plist(file, platform, max_depth - 1)
   return
 
 def correct_bundle_identifier(bundle_identifier):
@@ -1213,12 +1241,29 @@ def get_file_last_modified_url(url):
     key = key.upper()
     if key == "LAST-MODIFIED":
       retvalue = value
-  
+
   return retvalue
 
+def mac_change_rpath_binary(bin, old, new):
+  cmd("install_name_tool", ["-change", old, new, bin], True)
+
+def mac_change_rpath_library(lib_name, old, new):
+  # converts library name to actual library file name (dylib or binary file in framework)
+  def lib_name_to_file_name(lib_name):
+    if config.check_option("config", "bundle_dylibs"):
+      lib = lib_name + ".framework/" + lib_name
+    else:
+      lib = "lib" + lib_name + ".dylib"
+    return lib
+  mac_change_rpath_binary(lib_name_to_file_name(lib_name), old, new)
+
 def mac_correct_rpath_binary(path, libs):
+  # if framework are built, instead of correcting lib paths add `@loader_path` to rpaths with `mac_add_loader_path_to_rpath()`
+  if config.check_option("config", "bundle_dylibs"):
+    return
+
   for lib in libs:
-    cmd("install_name_tool", ["-change", "lib" + lib + ".dylib", "@rpath/lib" + lib + ".dylib", path], True)
+    mac_change_rpath_binary(path, "lib" + lib + ".dylib", "@rpath/lib" + lib + ".dylib")
   return
 
 def mac_correct_rpath_library(name, libs):
@@ -1266,19 +1311,25 @@ def mac_correct_rpath_x2t(dir):
   os.chdir(cur_dir)
   return
 
+def mac_add_loader_path_to_rpath(libs):
+  icu_libs = {"icudata.58", "icuuc.58"}
+  for lib in libs:
+    if config.check_option("config", "bundle_dylibs"):
+      # icu libs are linked statically for frameworks
+      if lib in icu_libs:
+        continue
+      cmd("install_name_tool", ["-add_rpath", "@loader_path/../../..", lib + ".framework/" + lib], True)
+    else:
+      cmd("install_name_tool", ["-add_rpath", "@loader_path", "lib" + lib + ".dylib"], True)
+
 def mac_correct_rpath_docbuilder(dir):
   cur_dir = os.getcwd()
   os.chdir(dir)
   cmd("chmod", ["-v", "+x", "./docbuilder"])
   cmd("install_name_tool", ["-add_rpath", "@executable_path", "./docbuilder"], True)
-  mac_correct_rpath_binary("./docbuilder", ["icudata.58", "icuuc.58", "UnicodeConverter", "kernel", "kernel_network", "graphics", "PdfFile", "XpsFile", "OFDFile", "DjVuFile", "HtmlFile2", "Fb2File", "EpubFile", "IWorkFile", "HWPFile", "doctrenderer", "DocxRenderer"])  
+  mac_correct_rpath_binary("./docbuilder", ["icudata.58", "icuuc.58", "UnicodeConverter", "kernel", "kernel_network", "graphics", "PdfFile", "XpsFile", "OFDFile", "DjVuFile", "HtmlFile2", "Fb2File", "EpubFile", "IWorkFile", "HWPFile", "doctrenderer", "DocxRenderer"])
   mac_correct_rpath_library("docbuilder.c", ["icudata.58", "icuuc.58", "UnicodeConverter", "kernel", "kernel_network", "graphics", "doctrenderer", "PdfFile", "XpsFile", "OFDFile", "DjVuFile", "DocxRenderer"])
-
-  def add_loader_path_to_rpath(libs):
-    for lib in libs:
-      cmd("install_name_tool", ["-add_rpath", "@loader_path", "lib" + lib + ".dylib"], True)
-
-  add_loader_path_to_rpath(["icuuc.58", "UnicodeConverter", "kernel", "kernel_network", "graphics", "doctrenderer", "PdfFile", "XpsFile", "OFDFile", "DjVuFile", "DocxRenderer", "docbuilder.c"])
+  mac_add_loader_path_to_rpath(["icuuc.58", "UnicodeConverter", "kernel", "kernel_network", "graphics", "doctrenderer", "PdfFile", "XpsFile", "OFDFile", "DjVuFile", "DocxRenderer", "docbuilder.c"])
   os.chdir(cur_dir)
   return
 
@@ -1288,9 +1339,9 @@ def mac_correct_rpath_desktop(dir):
   os.chdir(dir)
   mac_correct_rpath_library("hunspell", [])
   mac_correct_rpath_library("ooxmlsignature", ["kernel"])
-  mac_correct_rpath_library("ascdocumentscore", ["UnicodeConverter", "kernel", "graphics", "kernel_network", "PdfFile", "XpsFile", "DjVuFile", "hunspell", "ooxmlsignature"])
-  cmd("install_name_tool", ["-change", "@executable_path/../Frameworks/Chromium Embedded Framework.framework/Chromium Embedded Framework", "@rpath/Chromium Embedded Framework.framework/Chromium Embedded Framework", "libascdocumentscore.dylib"])
-  mac_correct_rpath_binary("./editors_helper.app/Contents/MacOS/editors_helper", ["ascdocumentscore", "UnicodeConverter", "kernel", "kernel_network", "graphics", "PdfFile", "XpsFile", "OFDFile", "DjVuFile", "hunspell", "ooxmlsignature"])
+  mac_correct_rpath_library("ascdocumentscore", ["UnicodeConverter", "kernel", "graphics", "kernel_network", "PdfFile", "XpsFile", "DjVuFile", "hunspell", "ooxmlsignature", "doctrenderer"])
+  mac_change_rpath_library("ascdocumentscore", "@executable_path/../Frameworks/Chromium Embedded Framework.framework/Chromium Embedded Framework", "@rpath/Chromium Embedded Framework.framework/Chromium Embedded Framework")
+  mac_correct_rpath_binary("./editors_helper.app/Contents/MacOS/editors_helper", ["ascdocumentscore", "UnicodeConverter", "kernel", "kernel_network", "graphics", "PdfFile", "XpsFile", "OFDFile", "DjVuFile", "hunspell", "ooxmlsignature", "doctrenderer"])
   cmd("install_name_tool", ["-add_rpath", "@executable_path/../../../../Frameworks", "./editors_helper.app/Contents/MacOS/editors_helper"], True)
   cmd("install_name_tool", ["-add_rpath", "@executable_path/../../../../Resources/converter", "./editors_helper.app/Contents/MacOS/editors_helper"], True)
   cmd("chmod", ["-v", "+x", "./editors_helper.app/Contents/MacOS/editors_helper"])
@@ -1412,7 +1463,7 @@ def copy_sdkjs_plugins(dst_dir, is_name_as_guid=False, is_desktop_local=False, i
     return
   plugins_list = plugins_list_config.rsplit(", ")
   for name in plugins_list:
-    copy_sdkjs_plugin(plugins_dir, dst_dir, name, is_name_as_guid, is_desktop_local)    
+    copy_sdkjs_plugin(plugins_dir, dst_dir, name, is_name_as_guid, is_desktop_local)
   return
 
 def copy_sdkjs_plugins_server(dst_dir, is_name_as_guid=False, is_desktop_local=False):
@@ -1422,7 +1473,7 @@ def copy_sdkjs_plugins_server(dst_dir, is_name_as_guid=False, is_desktop_local=F
     return
   plugins_list = plugins_list_config.rsplit(", ")
   for name in plugins_list:
-    copy_sdkjs_plugin(plugins_dir, dst_dir, name, is_name_as_guid, is_desktop_local)    
+    copy_sdkjs_plugin(plugins_dir, dst_dir, name, is_name_as_guid, is_desktop_local)
   return
 
 def support_old_versions_plugins(out_dir):
@@ -1436,11 +1487,11 @@ def support_old_versions_plugins(out_dir):
     content_plugin_base += file.read()
   content_plugin_base += "\n\n"
   with open(get_path(out_dir + "/plugins-ui.js"), "r") as file:
-    content_plugin_base += file.read()  
+    content_plugin_base += file.read()
   with open(get_path(out_dir + "/pluginBase.js"), "w") as file:
     file.write(content_plugin_base)
   delete_file(out_dir + "/plugins.js")
-  delete_file(out_dir + "/plugins-ui.js")  
+  delete_file(out_dir + "/plugins-ui.js")
   return
 
 def generate_sdkjs_plugin_list(dst):
@@ -1473,7 +1524,7 @@ def hack_xcode_ios():
   filedata += "\n"
   filedata += content_hack
   filedata += "\n\n"
-  
+
   delete_file(qmake_spec_file)
   with open(get_path(qmake_spec_file), "w") as file:
     file.write(filedata)
@@ -1554,12 +1605,12 @@ def copy_v8_files(core_dir, deploy_dir, platform, is_xp=False):
   if (-1 != config.option("config").find("use_javascript_core")):
     return
   directory_v8 = core_dir + "/Common/3dParty"
-  
+
   if is_xp:
     directory_v8 += "/v8/v8_xp"
     copy_files(directory_v8 + platform + "/release/icudt*.dll", deploy_dir + "/")
     return
-  
+
   if config.check_option("config", "v8_version_60"):
     directory_v8 += "/v8/v8/out.gn/"
   else:
@@ -1571,7 +1622,7 @@ def copy_v8_files(core_dir, deploy_dir, platform, is_xp=False):
     copy_files(directory_v8 + platform + "/icudt*.dat", deploy_dir + "/")
   return
 
-def clone_marketplace_plugin(out_dir, is_name_as_guid=False, is_replace_paths=False, is_delete_git_dir=True, git_owner=""):  
+def clone_marketplace_plugin(out_dir, is_name_as_guid=False, is_replace_paths=False, is_delete_git_dir=True, git_owner=""):
   old_cur = os.getcwd()
   os.chdir(out_dir)
   git_update("onlyoffice.github.io", False, True, git_owner)
@@ -1592,11 +1643,11 @@ def clone_marketplace_plugin(out_dir, is_name_as_guid=False, is_replace_paths=Fa
   if is_dir(dst_dir_path):
     delete_dir(dst_dir_path)
   copy_dir(out_dir + "/onlyoffice.github.io/store/plugin", dst_dir_path)
-  
+
   if is_replace_paths:
     for file in glob.glob(dst_dir_path + "/*.html"):
       replaceInFile(file, "https://onlyoffice.github.io/sdkjs-plugins/", "../")
-        
+
   if is_delete_git_dir:
     delete_dir_with_access_error(out_dir + "/onlyoffice.github.io")
   return
@@ -1633,20 +1684,20 @@ def generate_check_linux_system(build_tools_dir, out_dir):
 def convert_ios_framework_to_xcframework(folder, lib):
   cur_dir = os.getcwd()
   os.chdir(folder)
-  
+
   create_dir(lib + "_xc_tmp")
   create_dir(lib + "_xc_tmp/iphoneos")
   create_dir(lib + "_xc_tmp/iphonesimulator")
   copy_dir(lib + ".framework", lib + "_xc_tmp/iphoneos/" + lib + ".framework")
   copy_dir(lib + ".framework", lib + "_xc_tmp/iphonesimulator/" + lib + ".framework")
 
-  cmd("xcrun", ["lipo", "-remove", "x86_64", "./" + lib + "_xc_tmp/iphoneos/" + lib + ".framework/" + lib, 
+  cmd("xcrun", ["lipo", "-remove", "x86_64", "./" + lib + "_xc_tmp/iphoneos/" + lib + ".framework/" + lib,
     "-o", "./" + lib + "_xc_tmp/iphoneos/" + lib + ".framework/" + lib])
-  cmd("xcrun", ["lipo", "-remove", "arm64", "./" + lib + "_xc_tmp/iphonesimulator/" + lib + ".framework/" + lib, 
+  cmd("xcrun", ["lipo", "-remove", "arm64", "./" + lib + "_xc_tmp/iphonesimulator/" + lib + ".framework/" + lib,
     "-o", "./" + lib + "_xc_tmp/iphonesimulator/" + lib + ".framework/" + lib])
 
-  cmd("xcodebuild", ["-create-xcframework", 
-    "-framework", "./" + lib + "_xc_tmp/iphoneos/" + lib + ".framework/", 
+  cmd("xcodebuild", ["-create-xcframework",
+    "-framework", "./" + lib + "_xc_tmp/iphoneos/" + lib + ".framework/",
     "-framework", "./" + lib + "_xc_tmp/iphonesimulator/" + lib + ".framework/",
     "-output", lib + ".xcframework"])
 
@@ -1694,7 +1745,7 @@ def change_elf_rpath(path, origin):
     cmd(tools_dir + "patchelf", ["--set-rpath", new_path, path], True)
   #print("[" + os.path.basename(path) + "] old: " + old_path + "; new: " + new_path)
   return
-  
+
 def correct_elf_rpath_directory(directory, origin, is_recursion = True):
   for file in glob.glob(directory + "/*"):
     if is_file(file):
@@ -1747,14 +1798,14 @@ def copy_dictionaries(src, dst, is_hyphen = True, is_spell = True):
 
     if is_hyphen and is_hyphen_present:
       copy_dir_content(file, lang_folder, "hyph_", "")
-    
+
     if is_spell and is_spell_present:
       copy_dir_content(file, lang_folder, "", "hyph_")
 
   if is_file(dst + "/en_US/en_US_thes.dat"):
     delete_file(dst + "/en_US/en_US_thes.dat")
     delete_file(dst + "/en_US/en_US_thes.idx")
-  
+
   if is_file(dst + "/ru_RU/ru_RU_oo3.dic"):
     delete_file(dst + "/ru_RU/ru_RU_oo3.dic")
     delete_file(dst + "/ru_RU/ru_RU_oo3.aff")
@@ -1817,7 +1868,7 @@ def get_autobuild_version(product, platform="", branch="", build=""):
     isArm = False
     if (-1 != osType.find("arm")) or (-1 != osType.find("aarch64")):
       isArm = True
-    
+
     if ("windows" == host_platform()):
       download_platform = "win-"
     elif ("linux" == host_platform()):
@@ -1842,8 +1893,11 @@ def get_autobuild_version(product, platform="", branch="", build=""):
   return "http://repo-doc-onlyoffice-com.s3.amazonaws.com/archive/" + download_addon
 
 def create_x2t_js_cache(dir, product, platform):
-  if is_file(dir + "/libdoctrenderer.dylib") and (os.path.getsize(dir + "/libdoctrenderer.dylib") < 5*1024*1024):
-    return
+  # mac
+  if is_file(dir + "/libdoctrenderer.dylib") or is_dir(dir + "/doctrenderer.framework"):
+    doctrenderer_lib = "libdoctrenderer.dylib" if is_file(dir + "/libdoctrenderer.dylib") else "doctrenderer.framework/doctrenderer"
+    if os.path.getsize(dir + "/" + doctrenderer_lib) < 5*1024*1024:
+      return
 
   if ((platform == "linux_arm64") and not is_os_arm()):
     cmd_in_dir_qemu(platform, dir, "./x2t", ["-create-js-snapshots"], True)
@@ -1854,6 +1908,5 @@ def create_x2t_js_cache(dir, product, platform):
 
 def setup_local_qmake(dir_qmake):
   dir_base = os.path.dirname(dir_qmake)
-  writeFile(dir_base + "/onlyoffice_qt.conf", "Prefix = " + dir_base)  
+  writeFile(dir_base + "/onlyoffice_qt.conf", "Prefix = " + dir_base)
   return
-  

scripts/build_js.py

@@ -46,21 +46,13 @@ def make():
 
   # builder
   if not isOnlyMobile:
-    print("LOG: start merge web-apps langs");
     base.cmd_in_dir(base_dir + "/../web-apps/translation", "python", ["merge_and_check.py"])
-    print("LOG: start build_interface");
     build_interface(base_dir + "/../web-apps/build")
-    print("LOG: start build_sdk_builder");
     build_sdk_builder(base_dir + "/../sdkjs/build")
-    print("LOG: create_dir builder");
     base.create_dir(out_dir + "/builder")
-    print("LOG: copy_dir web-apps");
     base.copy_dir(base_dir + "/../web-apps/deploy/web-apps", out_dir + "/builder/web-apps")
-    print("LOG: copy_dir sdkjs");
     base.copy_dir(base_dir + "/../sdkjs/deploy/sdkjs", out_dir + "/builder/sdkjs")
-    print("LOG: correct_sdkjs_licence");
     correct_sdkjs_licence(out_dir + "/builder/sdkjs")
-    print("LOG: correct_sdkjs_licence finished");
 
   # desktop
   if config.check_option("module", "desktop") and not isOnlyMobile:
@@ -117,7 +109,10 @@ def make():
 
 # JS build
 def _run_npm(directory):
-  return base.cmd_in_dir(directory, "npm", ["install"])
+  retValue = base.cmd_in_dir(directory, "npm", ["install"], True)
+  if (0 != retValue):
+    retValue = base.cmd_in_dir(directory, "npm", ["install", "--verbose"])
+  return retValue
 
 def _run_npm_ci(directory):
   return base.cmd_in_dir(directory, "npm", ["ci"])
@@ -130,7 +125,7 @@ def _run_grunt(directory, params=[]):
 
 def build_interface(directory):
   _run_npm(directory)
-  _run_grunt(directory, ["--force"] + base.web_apps_addons_param())
+  _run_grunt(directory, ["--force", "--verbose"] + base.web_apps_addons_param())
   return
 
 def get_build_param(minimize=True):

scripts/core_common/make_common.py

@@ -24,6 +24,7 @@ import harfbuzz
 import hyphen
 import googletest
 import libvlc
+import heif
 
 def check_android_ndk_macos_arm(dir):
   if base.is_dir(dir + "/darwin-x86_64") and not base.is_dir(dir + "/darwin-arm64"):
@@ -51,6 +52,7 @@ def make():
   glew.make()
   hyphen.make()
   googletest.make()
+  heif.make()
 
   if config.check_option("build-libvlc", "1"):
     libvlc.make()

scripts/core_common/modules/heif.py

@@ -0,0 +1,366 @@
+import sys
+sys.path.append('../..')
+import base
+import os
+import config
+
+# NOTE:
+#  - requires CMake >= 3.21, < 4.0.0
+
+# libs versions
+X265_VERSION = "4.1"
+DE265_VERSION = "1.0.16"
+# 1.18.2 - the latest version of libheif supporting C++11 builds (as for now)
+HEIF_VERSION = "1.18.2"
+
+# ios cmake toolchain
+IOS_CMAKE_VERSION = "4.5.0"
+IOS_CMAKE_TOOLCHAIN_FILE = "ios-cmake/ios.toolchain.cmake"
+
+# android cmake toolchain
+ANDROID_CMAKE_TOOLCHAIN_FILE = base.get_env("ANDROID_NDK_ROOT") + "/build/cmake/android.toolchain.cmake"
+
+
+def get_vs_version():
+  vs_version = "14 2015"
+  if config.option("vs-version") == "2019":
+    vs_version = "16 2019"
+  return vs_version
+
+def get_xcode_sdk(platform):
+  xcode_sdk = "iphoneos"
+  if "simulator" in platform:
+    xcode_sdk = "iphonesimulator"
+  return xcode_sdk
+
+def fetch_repo(repo_url, branch_or_tag):
+  base.cmd("git", ["clone", "--depth", "1", "--branch", branch_or_tag, repo_url])
+  return
+
+def get_build_dir(base_dir, repo_dir, platform, build_type):
+  return os.path.join(base_dir, repo_dir, "build", platform, build_type.lower())
+
+# general build function that builds for ONE platform (supposing we are located in the build directory)
+def build_with_cmake(platform, cmake_args, build_type):
+  # extend cmake arguments
+  cmake_args_ext = []
+  # WINDOWS
+  if "win" in platform:
+    cmake_args_ext = [
+      "-G", f"Visual Studio {get_vs_version()}"
+    ]
+    if platform == "win_64":
+      cmake_args_ext += ["-A", "x64"]
+    elif platform == "win_32":
+      cmake_args_ext += ["-A", "Win32"]
+  # LINUX, MAC
+  elif "linux" in platform or "mac" in platform:
+    cmake_args_ext = [
+      "-G", "Unix Makefiles",
+      "-DCMAKE_POSITION_INDEPENDENT_CODE=ON"  # on UNIX we need to compile with fPIC
+    ]
+    if platform == "mac_64":
+      cmake_args_ext += ["-DCMAKE_OSX_DEPLOYMENT_TARGET=10.11"]
+      if base.is_os_arm():
+        cmake_args_ext += [
+          "-DCMAKE_OSX_ARCHITECTURES=x86_64"
+        ]
+    elif platform == "mac_arm64":
+      cmake_args_ext += ["-DCMAKE_OSX_DEPLOYMENT_TARGET=11.0"]
+  # IOS
+  elif "ios" in platform:
+    cmake_args_ext = [
+      "-G", "Xcode",
+      "-DCMAKE_TOOLCHAIN_FILE=" + IOS_CMAKE_TOOLCHAIN_FILE,
+      "-DDEPLOYMENT_TARGET=11.0"
+    ]
+    if platform == "ios":
+      cmake_args_ext += ["-DPLATFORM=OS64"]
+    elif platform == "ios_simulator":
+      cmake_args_ext += ["-DPLATFORM=SIMULATOR64COMBINED"]
+  # ANDROID
+  elif "android" in platform:
+    cmake_args_ext = [
+      "-G", "Unix Makefiles",
+      "-DCMAKE_TOOLCHAIN_FILE=" + ANDROID_CMAKE_TOOLCHAIN_FILE,
+      "-DCMAKE_POSITION_INDEPENDENT_CODE=ON"
+    ]
+    def get_cmake_args_android(arch, api_level):
+      return [
+        "-DANDROID_ABI=" + arch,
+        "-DANDROID_NATIVE_API_LEVEL=" + api_level
+      ]
+    if platform == "android_arm64_v8a":
+      cmake_args_ext += get_cmake_args_android("arm64-v8a", "21")
+    elif platform == "android_armv7":
+      cmake_args_ext += get_cmake_args_android("armeabi-v7a", "16")
+    elif platform == "android_x86":
+      cmake_args_ext += get_cmake_args_android("x86", "16")
+    elif platform == "android_x86_64":
+      cmake_args_ext += get_cmake_args_android("x86_64", "21")
+
+  # run cmake
+  base.cmd("cmake", cmake_args + cmake_args_ext)
+  # build
+  if "Unix Makefiles" in cmake_args_ext:
+    base.cmd("make", ["-j4"])
+  else:
+    base.cmd("cmake", ["--build", ".", "--config", build_type])
+  return
+
+# general make function that calls `build_func` callback for configured platform(s) with specified cmake arguments
+def make_common(build_func, cmake_args):
+  # WINDOWS
+  if "windows" == base.host_platform():
+    # win_64
+    if config.check_option("platform", "win_64"):
+      build_func("win_64", cmake_args)
+    # win_32
+    if config.check_option("platform", "win_32"):
+      build_func("win_32", cmake_args)
+
+  # LINUX
+  elif "linux" == base.host_platform():
+    # linux_64
+    if config.check_option("platform", "linux_64"):
+      build_func("linux_64", cmake_args)
+    # linux_arm64
+    if config.check_option("platform", "linux_arm64"):
+      build_func("linux_arm64", cmake_args)
+
+  # MAC
+  elif "mac" == base.host_platform():
+    # mac_64
+    if config.check_option("platform", "mac_64"):
+      build_func("mac_64", cmake_args)
+    # mac_arm64
+    if config.check_option("platform", "mac_arm64"):
+      build_func("mac_arm64", cmake_args)
+
+    # IOS
+    if -1 != config.option("platform").find("ios"):
+      # ios (arm64)
+      build_func("ios", cmake_args)
+      # ios simulator (x86_64 and arm64 FAT lib)
+      build_func("ios_simulator", cmake_args)
+
+  # ANDROID
+  if -1 != config.option("platform").find("android"):
+    # android_arm64_v8a
+    if config.check_option("platform", "android_arm64_v8a"):
+      build_func("android_arm64_v8a", cmake_args)
+    # android_armv7
+    if config.check_option("platform", "android_armv7"):
+      build_func("android_armv7", cmake_args)
+    # android_x86
+    if config.check_option("platform", "android_x86"):
+      build_func("android_x86", cmake_args)
+    # android_x86_64
+    if config.check_option("platform", "android_x86_64"):
+      build_func("android_x86_64", cmake_args)
+
+  return
+
+def make_x265(base_dir, build_type):
+  # fetch lib repo
+  if not base.is_dir("x265_git"):
+    fetch_repo("https://bitbucket.org/multicoreware/x265_git.git", f"Release_{X265_VERSION}")
+    # fix x265 version detection so it reads version from x265Version.txt instead of parsing it from .git
+    base.replaceInFile(
+      base_dir + "/x265_git/source/cmake/Version.cmake",
+      "elseif(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/../x265Version.txt)",
+      "endif()\n    if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/../x265Version.txt)"
+    )
+
+  # prepare cmake args
+  cmake_dir = base_dir + "/x265_git/source"
+  cmake_args = [
+    cmake_dir,
+    "-DCMAKE_BUILD_TYPE=" + build_type,
+    "-DENABLE_CLI=OFF",                 # do not build standalone CLI app
+    "-DENABLE_SHARED=OFF",              # do not build shared libs
+    "-DENABLE_ASSEMBLY=OFF",            # disable assembly optimizations
+  ]
+
+  # lib build function
+  def build_x265(platform, cmake_args):
+    # check if target lib has already been built
+    build_dir = get_build_dir(base_dir, "x265_git", platform, build_type)
+    if platform.find("win") != -1:
+      target_lib = os.path.join(build_dir, build_type, "x265-static.lib")
+    else:
+      target_lib = os.path.join(build_dir, "libx265.a")
+    if base.is_file(target_lib):
+      return
+    # go to the build directory
+    base.create_dir(build_dir)
+    os.chdir(build_dir)
+    # run build
+    build_with_cmake(platform, cmake_args, build_type)
+    # for iOS there is no target for building libx265.a, so we need to form it ourselves from libcommon.a and libencoder.a
+    if platform.find("ios") != -1:
+      xcode_sdk = get_xcode_sdk(platform)
+      base.cmd("libtool", [
+        "-static",
+        "-o", "libx265.a",
+        f"build/common.build/{build_type}-{xcode_sdk}/libcommon.a",
+        f"build/encoder.build/{build_type}-{xcode_sdk}/libencoder.a"
+      ])
+    # copy header
+    base.copy_file(base_dir + "/x265_git/source/x265.h", build_dir)
+    # reset directory
+    os.chdir(base_dir)
+    return
+
+  make_common(build_x265, cmake_args)
+  return
+
+def make_de265(base_dir, build_type):
+  # fetch lib repo
+  if not base.is_dir("libde265"):
+    fetch_repo("https://github.com/strukturag/libde265.git", f"v{DE265_VERSION}")
+
+  # prepare cmake args
+  cmake_dir = base_dir + "/libde265"
+  cmake_args = [
+    cmake_dir,
+    "-DCMAKE_BUILD_TYPE=" + build_type,
+    "-DBUILD_SHARED_LIBS=OFF",            # do not build shared libs
+    "-DENABLE_SDL=OFF",                   # disable SDL
+    "-DENABLE_DECODER=OFF",               # do not build decoder CLI executable
+    "-DENABLE_ENCODER=OFF",               # do not build encoder CLI executable
+  ]
+
+  # lib build function
+  def build_de265(platform, cmake_args):
+    # check if target lib has already been built
+    build_dir = get_build_dir(base_dir, "libde265", platform, build_type)
+    if platform.find("win") != -1:
+      target_lib = os.path.join(build_dir, "libde265", build_type, "libde265.lib")
+    else:
+      target_lib = os.path.join(build_dir, "libde265/libde265.a")
+    if base.is_file(target_lib):
+      return
+    # go to the build directory
+    base.create_dir(build_dir)
+    os.chdir(build_dir)
+    # run build
+    build_with_cmake(platform, cmake_args, build_type)
+    # for ios copy target library from the default build path
+    if platform.find("ios") != -1:
+      xcode_sdk = get_xcode_sdk(platform)
+      base.copy_file(f"libde265/{build_type}-{xcode_sdk}/libde265.a", "libde265")
+    # copy header
+    base.copy_file(base_dir + "/libde265/libde265/de265.h", "libde265")
+    # reset directory
+    os.chdir(base_dir)
+    return
+
+  make_common(build_de265, cmake_args)
+  return
+
+def make_heif(base_dir, build_type):
+  # fetch lib repo
+  if not base.is_dir("libheif"):
+    fetch_repo("https://github.com/strukturag/libheif.git", f"v{HEIF_VERSION}")
+    # do not build heifio module
+    base.replaceInFile(
+      base_dir + "/libheif/CMakeLists.txt",
+      "add_subdirectory(heifio)",
+      "# add_subdirectory(heifio)"
+    )
+
+  # prepare cmake args
+  cmake_dir = base_dir + "/libheif"
+  cmake_args = [
+    cmake_dir,
+    "--preset=release-noplugins",                     # preset to disable plugins system
+    "-DCMAKE_BUILD_TYPE=" + build_type,
+    "-DBUILD_SHARED_LIBS=OFF",                        # do not build shared libs
+    "-DWITH_LIBSHARPYUV=OFF",                         # do not build libsharpyuv (for RGB <--> YUV color space conversions)
+    "-DWITH_AOM_DECODER=OFF",                         # do not build AOM V1 decoder (for AVIF image format)
+    "-DWITH_AOM_ENCODER=OFF",                         # do not build AOM V1 encoder (for AVIF image format)
+    "-DWITH_GDK_PIXBUF=OFF",                          # do not build gdk-pixbuf plugin (UNIX only)
+    "-DWITH_GNOME=OFF",                               # do not build gnome plugin (Linux only)
+    "-DWITH_EXAMPLES=OFF",                            # do not build examples
+    "-DWITH_EXAMPLE_HEIF_VIEW=OFF",                   # do not build heif-view CLI tool
+    "-DWITH_X265=ON",                                 # enable x265 codec
+    "-DWITH_LIBDE265=ON",                             # enable de265 codec
+    "-DCMAKE_CXX_FLAGS=-DLIBDE265_STATIC_BUILD",      # add macro definition to properly compile with de265 static library
+    "-DCMAKE_C_FLAGS=-DLIBDE265_STATIC_BUILD",        # same ^
+  ]
+
+  # lib build function
+  def build_heif(platform, cmake_args):
+    # check if target lib has already been built
+    build_dir = get_build_dir(base_dir, "libheif", platform, build_type)
+    if platform.find("win") != -1:
+      target_lib = os.path.join(build_dir, "libheif", build_type, "heif.lib")
+    else:
+      target_lib = os.path.join(build_dir, "libheif/libheif.a")
+    if base.is_file(target_lib):
+      return
+    # go to the build directory
+    base.create_dir(build_dir)
+    os.chdir(build_dir)
+    # add paths to dependent libraries and includes to cmake args
+    de265_build_dir = get_build_dir(base_dir, "libde265", platform, build_type)
+    x265_build_dir = get_build_dir(base_dir, "x265_git", platform, build_type)
+    cmake_args_ext = [
+      f"-DLIBDE265_INCLUDE_DIR={de265_build_dir}",
+      f"-DX265_INCLUDE_DIR={x265_build_dir}"
+    ]
+    if platform.find("win") != -1:
+      cmake_args_ext += [
+        f"-DLIBDE265_LIBRARY={de265_build_dir}/libde265/{build_type}/libde265.lib",
+        f"-DX265_LIBRARY={x265_build_dir}/{build_type}/x265-static.lib"
+      ]
+    else:
+      cmake_args_ext += [
+        f"-DLIBDE265_LIBRARY={de265_build_dir}/libde265/libde265.a",
+        f"-DX265_LIBRARY={x265_build_dir}/libx265.a"
+      ]
+    # run build
+    build_with_cmake(platform, cmake_args + cmake_args_ext, build_type)
+    # for ios copy target library from the default build path
+    if platform.find("ios") != -1:
+      xcode_sdk = get_xcode_sdk(platform)
+      base.copy_file(f"libheif/{build_type}-{xcode_sdk}/libheif.a", "libheif")
+    # reset directory
+    os.chdir(base_dir)
+    return
+
+  make_common(build_heif, cmake_args)
+  return
+
+def make():
+  print("[fetch & build]: heif")
+
+  base_dir = base.get_script_dir() + "/../../core/Common/3dParty/heif"
+  old_dir = os.getcwd()
+  os.chdir(base_dir)
+
+  build_type = "Release"
+  if (-1 != config.option("config").lower().find("debug")):
+    build_type = "Debug"
+
+  # fetch custom cmake toolchain for ios
+  if -1 != config.option("platform").find("ios"):
+    if not base.is_dir("ios-cmake"):
+      fetch_repo("https://github.com/leetal/ios-cmake.git", IOS_CMAKE_VERSION)
+    global IOS_CMAKE_TOOLCHAIN_FILE
+    IOS_CMAKE_TOOLCHAIN_FILE = os.path.join(base_dir, IOS_CMAKE_TOOLCHAIN_FILE)
+
+  # build encoder library
+  make_x265(base_dir, build_type)
+  # build decoder library
+  make_de265(base_dir, build_type)
+
+  # build libheif
+  make_heif(base_dir, build_type)
+
+  os.chdir(old_dir)
+  return
+
+if __name__ == '__main__':
+  make()

scripts/core_common/modules/icu_mac.py

@@ -47,7 +47,7 @@ if not base.is_dir(current_dir + "/mac_cross_64"):
   os.chdir(current_dir + "/mac_cross_64")
 
   base.cmd("../icu/source/runConfigureICU", ["MacOSX",
-    "--prefix=" + current_dir + "/mac_cross_64", "CFLAGS=-Os CXXFLAGS=--std=c++11"])
+    "--prefix=" + current_dir + "/mac_cross_64", "--enable-static", "CFLAGS=-Os CXXFLAGS=--std=c++11"])
 
   change_icu_defs(current_dir + "/mac_cross_64", "x86_64")
 
@@ -60,8 +60,8 @@ if not base.is_dir(current_dir + "/mac_cross_64"):
 
 os.chdir(current_dir + "/icu/source")
 
-base.cmd("./configure", ["--prefix=" + current_dir + "/mac_arm_64", 
-  "--with-cross-build=" + current_dir + "/mac_cross_64", "VERBOSE=1"])
+base.cmd("./configure", ["--prefix=" + current_dir + "/mac_arm_64",
+  "--with-cross-build=" + current_dir + "/mac_cross_64", "--enable-static", "VERBOSE=1"])
 
 change_icu_defs(current_dir + "/icu/source", "arm64")
 
@@ -85,12 +85,22 @@ base.create_dir(current_dir + "/mac_arm64")
 base.create_dir(current_dir + "/mac_arm64/build")
 
 base.copy_dir(current_dir + "/mac_cross_64/include", current_dir + "/mac_64/build/include")
+# copy shared libs
 base.copy_file(current_dir + "/mac_cross_64/lib/libicudata." + icu_major + "." + icu_minor + ".dylib", current_dir + "/mac_64/build/libicudata." + icu_major + ".dylib")
 base.copy_file(current_dir + "/mac_cross_64/lib/libicuuc." + icu_major + "." + icu_minor + ".dylib", current_dir + "/mac_64/build/libicuuc." + icu_major + ".dylib")
+# copy static libs
+base.copy_file(current_dir + "/mac_cross_64/lib/libicudata.a", current_dir + "/mac_64/build")
+base.copy_file(current_dir + "/mac_cross_64/lib/libicui18n.a", current_dir + "/mac_64/build")
+base.copy_file(current_dir + "/mac_cross_64/lib/libicuuc.a", current_dir + "/mac_64/build")
 
 base.copy_dir(current_dir + "/mac_arm_64/include", current_dir + "/mac_arm64/build/include")
+# copy shared libs
 base.copy_file(current_dir + "/mac_arm_64/lib/libicudata." + icu_major + "." + icu_minor + ".dylib", current_dir + "/mac_arm64/build/libicudata." + icu_major + ".dylib")
 base.copy_file(current_dir + "/mac_arm_64/lib/libicuuc." + icu_major + "." + icu_minor + ".dylib", current_dir + "/mac_arm64/build/libicuuc." + icu_major + ".dylib")
+# copy static libs
+base.copy_file(current_dir + "/mac_arm_64/lib/libicudata.a", current_dir + "/mac_arm64/build")
+base.copy_file(current_dir + "/mac_arm_64/lib/libicui18n.a", current_dir + "/mac_arm64/build")
+base.copy_file(current_dir + "/mac_arm_64/lib/libicuuc.a", current_dir + "/mac_arm64/build")
 
 base.delete_dir(current_dir + "/mac_cross_64")
 base.delete_dir(current_dir + "/mac_arm_64")

scripts/deploy_builder.py

@@ -65,7 +65,7 @@ def make():
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicudata.so.58", root_dir + "/libicudata.so.58")
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicuuc.so.58", root_dir + "/libicuuc.so.58")
 
-    if (0 == platform.find("mac")):
+    if (0 == platform.find("mac") and not config.check_option("config", "bundle_dylibs")):
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicudata.58.dylib", root_dir + "/libicudata.58.dylib")
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicuuc.58.dylib", root_dir + "/libicuuc.58.dylib")
 
@@ -106,33 +106,34 @@ def make():
     if (0 == platform.find("win")):
       base.copy_file(core_dir + "/DesktopEditor/doctrenderer/docbuilder.com/src/docbuilder_midl.h", root_dir + "/include/docbuilder_midl.h")
     base.replaceInFile(root_dir + "/include/docbuilder.h", "Q_DECL_EXPORT", "BUILDING_DOCBUILDER")
-    
+
     if ("win_64" == platform):
       base.copy_file(core_dir + "/DesktopEditor/doctrenderer/docbuilder.com/deploy/win_64/docbuilder.com.dll", root_dir + "/docbuilder.com.dll")
       base.copy_file(core_dir + "/DesktopEditor/doctrenderer/docbuilder.net/deploy/win_64/docbuilder.net.dll", root_dir + "/docbuilder.net.dll")
-      
+
     elif ("win_32" == platform):
       base.copy_file(core_dir + "/DesktopEditor/doctrenderer/docbuilder.com/deploy/win_32/docbuilder.com.dll", root_dir + "/docbuilder.com.dll")
       base.copy_file(core_dir + "/DesktopEditor/doctrenderer/docbuilder.net/deploy/win_32/docbuilder.net.dll", root_dir + "/docbuilder.net.dll")
 
     # correct ios frameworks
     if ("ios" == platform):
-      base.generate_plist(root_dir)
+      base.generate_plist(root_dir, "ios")
 
     if (0 == platform.find("linux")):
       base.linux_correct_rpath_docbuilder(root_dir)
 
     if (0 == platform.find("mac")):
+      base.generate_plist(root_dir, "mac", max_depth=1)
       base.mac_correct_rpath_x2t(root_dir)
       base.mac_correct_rpath_docbuilder(root_dir)
 
     base.create_x2t_js_cache(root_dir, "builder", platform)
-  
+
     # delete unnecessary builder files
     def delete_files(files):
       for file in files:
         base.delete_file(file)
-    
+
     delete_files(base.find_files(root_dir, "*.wasm"))
     delete_files(base.find_files(root_dir, "*_ie.js"))
     base.delete_file(root_dir + "/sdkjs/pdf/src/engine/cmap.bin")
@@ -143,7 +144,6 @@ def make():
     base.delete_dir(root_dir + "/sdkjs/cell/css")
     base.delete_file(root_dir + "/sdkjs/pdf/src/engine/viewer.js")
     base.delete_file(root_dir + "/sdkjs/common/spell/spell/spell.js.mem")
-    base.delete_dir(root_dir + "/sdkjs/common/Images")   
+    base.delete_dir(root_dir + "/sdkjs/common/Images")
 
   return
-

scripts/deploy_core.py

@@ -53,7 +53,8 @@ def make():
     if ("windows" == base.host_platform()):
       base.copy_files(core_dir + "/Common/3dParty/icu/" + platform + "/build/*.dll", archive_dir + "/")
     else:
-      base.copy_files(core_dir + "/Common/3dParty/icu/" + platform + "/build/*", archive_dir + "/")
+      if not (0 == platform.find("mac") and config.check_option("config", "bundle_dylibs")):
+        base.copy_files(core_dir + "/Common/3dParty/icu/" + platform + "/build/*", archive_dir + "/")
     base.copy_v8_files(core_dir, archive_dir, platform)
 
     base.copy_exe(core_build_dir + "/bin/" + platform_postfix, archive_dir, "allfontsgen")
@@ -66,6 +67,10 @@ def make():
     base.copy_exe(core_build_dir + "/bin/" + platform_postfix, archive_dir, "metafiletester")
     base.copy_exe(core_build_dir + "/bin/" + platform_postfix, archive_dir, "dictionariestester")
 
+    # correct mac frameworks
+    if (0 == platform.find("mac")):
+      base.generate_plist(archive_dir, "mac", max_depth=1)
+
     # js cache
     base.generate_doctrenderer_config(archive_dir + "/DoctRenderer.config", "./", "builder", "", "./dictionaries")
     base.create_x2t_js_cache(archive_dir, "core", platform)
@@ -74,4 +79,3 @@ def make():
     # dictionaries
     base.copy_dictionaries(git_dir + "/dictionaries", archive_dir + "/dictionaries", True, False)
   return
-

scripts/deploy_desktop.py

@@ -12,7 +12,7 @@ def copy_lib_with_links(src_dir, dst_dir, lib, version):
   lib_major_name = lib + "." + major_version
 
   base.copy_file(src_dir + "/" + lib_full_name, dst_dir + "/" + lib_full_name)
-  
+
   base.cmd_in_dir(dst_dir, "ln", ["-s", "./" + lib_full_name, "./" + lib_major_name])
   base.cmd_in_dir(dst_dir, "ln", ["-s", "./" + lib_major_name, "./" + lib])
 
@@ -72,7 +72,7 @@ def make():
     base.copy_lib(build_libraries_path, root_dir + "/converter", "IWorkFile")
     base.copy_lib(build_libraries_path, root_dir + "/converter", "HWPFile")
     base.copy_lib(build_libraries_path, root_dir + "/converter", "DocxRenderer")
-    
+
     if ("ios" == platform):
       base.copy_lib(build_libraries_path, root_dir + "/converter", "x2t")
     else:
@@ -91,7 +91,7 @@ def make():
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicudata.so.58", root_dir + "/converter/libicudata.so.58")
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicuuc.so.58", root_dir + "/converter/libicuuc.so.58")
 
-    if (0 == platform.find("mac")):
+    if (0 == platform.find("mac") and not config.check_option("config", "bundle_dylibs")):
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicudata.58.dylib", root_dir + "/converter/libicudata.58.dylib")
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicuuc.58.dylib", root_dir + "/converter/libicuuc.58.dylib")
 
@@ -99,7 +99,7 @@ def make():
     if isWindowsXP:
       base.copy_lib(build_libraries_path + "/xp", root_dir + "/converter", "doctrenderer")
     else:
-      base.copy_lib(build_libraries_path, root_dir + "/converter", "doctrenderer")      
+      base.copy_lib(build_libraries_path, root_dir + "/converter", "doctrenderer")
     base.copy_v8_files(core_dir, root_dir + "/converter", platform, isWindowsXP)
 
     base.generate_doctrenderer_config(root_dir + "/converter/DoctRenderer.config", "../editors/", "desktop", "", "../dictionaries")
@@ -117,7 +117,7 @@ def make():
     base.copy_file(git_dir + "/core-fonts/ASC.ttf",    root_dir + "/fonts/ASC.ttf")
 
     base.copy_file(git_dir + "/desktop-apps/common/package/license/3dparty/3DPARTYLICENSE", root_dir + "/3DPARTYLICENSE")
-  
+
     # cef
     build_dir_name = "build"
     if (0 == platform.find("linux")) and (config.check_option("config", "cef_version_107")):
@@ -140,18 +140,18 @@ def make():
     base.copy_lib(build_libraries_path + ("/xp" if isWindowsXP else ""), root_dir, "ascdocumentscore")
     if (0 != platform.find("mac")):
       base.copy_lib(build_libraries_path + ("/xp" if isWindowsXP else ""), root_dir, "qtascdocumentscore")
-    
+
     if (0 == platform.find("mac")):
       base.copy_dir(core_build_dir + "/bin/" + platform_postfix + "/editors_helper.app", root_dir + "/editors_helper.app")
     else:
       base.copy_exe(core_build_dir + "/bin/" + platform_postfix + ("/xp" if isWindowsXP else ""), root_dir, "editors_helper")
-    
+
     if isUseQt:
       base.qt_copy_lib("Qt5Core", root_dir)
       base.qt_copy_lib("Qt5Gui", root_dir)
       base.qt_copy_lib("Qt5PrintSupport", root_dir)
       base.qt_copy_lib("Qt5Svg", root_dir)
-      base.qt_copy_lib("Qt5Widgets", root_dir)      
+      base.qt_copy_lib("Qt5Widgets", root_dir)
       base.qt_copy_lib("Qt5Network", root_dir)
       base.qt_copy_lib("Qt5OpenGL", root_dir)
 
@@ -160,7 +160,7 @@ def make():
       base.qt_copy_plugin("imageformats", root_dir)
       base.qt_copy_plugin("platforms", root_dir)
       base.qt_copy_plugin("platforminputcontexts", root_dir)
-      base.qt_copy_plugin("printsupport", root_dir)      
+      base.qt_copy_plugin("printsupport", root_dir)
 
       base.qt_copy_plugin("platformthemes", root_dir)
       base.qt_copy_plugin("xcbglintegrations", root_dir)
@@ -194,9 +194,9 @@ def make():
 
       if base.check_congig_option_with_platfom(platform, "libvlc"):
         vlc_dir = git_dir + "/core/Common/3dParty/libvlc/build/" + platform + "/lib"
-        
+
         if (0 == platform.find("win")):
-          base.copy_dir(vlc_dir + "/plugins", root_dir + "/plugins")          
+          base.copy_dir(vlc_dir + "/plugins", root_dir + "/plugins")
           base.copy_files(vlc_dir + "/*.dll", root_dir)
           base.copy_file(vlc_dir + "/vlc-cache-gen.exe", root_dir + "/vlc-cache-gen.exe")
         elif (0 == platform.find("linux")):
@@ -242,7 +242,7 @@ def make():
     #base.copy_dir(git_dir + "/desktop-sdk/ChromiumBasedEditors/plugins/encrypt/ui/common/{14A8FC87-8E26-4216-B34E-F27F053B2EC4}", root_dir + "/editors/sdkjs-plugins/{14A8FC87-8E26-4216-B34E-F27F053B2EC4}")
     #base.copy_dir(git_dir + "/desktop-sdk/ChromiumBasedEditors/plugins/encrypt/ui/engine/database/{9AB4BBA8-A7E5-48D5-B683-ECE76A020BB1}", root_dir + "/editors/sdkjs-plugins/{9AB4BBA8-A7E5-48D5-B683-ECE76A020BB1}")
     base.copy_sdkjs_plugin(git_dir + "/desktop-sdk/ChromiumBasedEditors/plugins", root_dir + "/editors/sdkjs-plugins", "sendto", True)
-  
+
     base.copy_file(base_dir + "/js/" + branding + "/desktop/index.html", root_dir + "/index.html")
     base.create_dir(root_dir + "/editors/webext")
     base.copy_file(base_dir + "/js/" + branding + "/desktop/noconnect.html", root_dir + "/editors/webext/noconnect.html")
@@ -255,7 +255,10 @@ def make():
 
     isUseJSC = False
     if (0 == platform.find("mac")):
-      file_size_doctrenderer = os.path.getsize(root_dir + "/converter/libdoctrenderer.dylib")
+      doctrenderer_lib = "libdoctrenderer.dylib"
+      if config.check_option("config", "bundle_dylibs"):
+        doctrenderer_lib = "doctrenderer.framework/doctrenderer"
+      file_size_doctrenderer = os.path.getsize(root_dir + "/converter/" + doctrenderer_lib)
       print("file_size_doctrenderer: " + str(file_size_doctrenderer))
       if (file_size_doctrenderer < 5*1024*1024):
         isUseJSC = True
@@ -278,6 +281,8 @@ def make():
     base.copy_exe(core_build_dir + "/bin/" + platform_postfix, root_dir + "/converter", "allthemesgen")
 
     if (0 == platform.find("mac")):
+      # gen plists with max_depth 2 because frameworks are only located in root_dir and converter subdirectory
+      base.generate_plist(root_dir, "mac", max_depth=2)
       base.mac_correct_rpath_desktop(root_dir)
 
     if isMacArmPlaformOnIntel:
@@ -303,4 +308,3 @@ def make():
       base.delete_file(root_dir + "/editors/sdkjs/slide/sdk-all.cache")
 
   return
-

scripts/deploy_mobile.py

@@ -18,7 +18,7 @@ def deploy_fonts(git_dir, root_dir, platform=""):
   if (platform == "android"):
     base.copy_dir(git_dir + "/core-fonts/dejavu", root_dir + "/fonts/dejavu")
     base.copy_dir(git_dir + "/core-fonts/liberation", root_dir + "/fonts/liberation")
-  return 
+  return
 
 def make():
   base_dir = base.get_script_dir() + "/../out"
@@ -35,7 +35,7 @@ def make():
 
     if base.get_env("DESTDIR_BUILD_OVERRIDE") != "":
       return
-      
+
     if (base.is_dir(root_dir)):
       base.delete_dir(root_dir)
     base.create_dir(root_dir)
@@ -84,7 +84,7 @@ def make():
     if (0 == platform.find("mac")):
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicudata.58.dylib", root_dir + "/libicudata.58.dylib")
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicuuc.58.dylib", root_dir + "/libicuuc.58.dylib")
-    
+
     if (0 == platform.find("android")):
       #base.copy_file(core_dir + "/Common/3dParty/icu/android/build/" + platform[8:] + "/libicudata.so", root_dir + "/libicudata.so")
       #base.copy_file(core_dir + "/Common/3dParty/icu/android/build/" + platform[8:] + "/libicuuc.so", root_dir + "/libicuuc.so")
@@ -95,7 +95,7 @@ def make():
 
     # correct ios frameworks
     if ("ios" == platform):
-      base.generate_plist(root_dir)
+      base.generate_plist(root_dir, "ios")
       deploy_fonts(git_dir, root_dir)
       base.copy_dictionaries(git_dir + "/dictionaries", root_dir + "/dictionaries", True, False)
 
@@ -115,7 +115,7 @@ def make():
       deploy_fonts(git_dir, root_dir, "android")
       base.copy_dictionaries(git_dir + "/dictionaries", root_dir + "/dictionaries", True, False)
       # app
-      base.generate_doctrenderer_config(root_dir + "/DoctRenderer.config", "./", "builder", "", "./dictionaries")      
+      base.generate_doctrenderer_config(root_dir + "/DoctRenderer.config", "./", "builder", "", "./dictionaries")
       libs_dir = root_dir + "/lib"
       base.create_dir(libs_dir + "/arm64-v8a")
       base.copy_files(base_dir + "/android_arm64_v8a/" + branding + "/mobile/*.so", libs_dir + "/arm64-v8a")

scripts/deploy_osign.py

@@ -18,7 +18,7 @@ def make():
 
     if base.get_env("DESTDIR_BUILD_OVERRIDE") != "":
       return
-      
+
     if (base.is_dir(root_dir)):
       base.delete_dir(root_dir)
     base.create_dir(root_dir)
@@ -37,7 +37,7 @@ def make():
 
     # correct ios frameworks
     if ("ios" == platform):
-      base.generate_plist(root_dir)
+      base.generate_plist(root_dir, "ios")
 
   for native_platform in platforms:
     if native_platform == "android":

scripts/deploy_server.py

@@ -102,16 +102,20 @@ def make():
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicudata.so.58", converter_dir + "/libicudata.so.58")
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicuuc.so.58", converter_dir + "/libicuuc.so.58")
 
-    if (0 == platform.find("mac")):
+    if (0 == platform.find("mac") and not config.check_option("config", "bundle_dylibs")):
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicudata.58.dylib", converter_dir + "/libicudata.58.dylib")
       base.copy_file(core_dir + "/Common/3dParty/icu/" + platform + "/build/libicuuc.58.dylib", converter_dir + "/libicuuc.58.dylib")
-    
+
     base.copy_v8_files(core_dir, converter_dir, platform)
 
     # builder
     base.copy_exe(core_build_dir + "/bin/" + platform_postfix, converter_dir, "docbuilder")
     base.copy_dir(git_dir + "/document-templates/new/en-US", converter_dir + "/empty")
 
+    # correct mac frameworks
+    if (0 == platform.find("mac")):
+      base.generate_plist(converter_dir, "mac", max_depth=1)
+
     # js
     js_dir = root_dir
     base.copy_dir(base_dir + "/js/" + branding + "/builder/sdkjs", js_dir + "/sdkjs")
@@ -124,7 +128,7 @@ def make():
 
     # add embed worker code
     base.cmd_in_dir(git_dir + "/sdkjs/common/embed", "python", ["make.py", js_dir + "/web-apps/apps/api/documents/api.js"])
-    
+
     # plugins
     base.create_dir(js_dir + "/sdkjs-plugins")
     base.copy_marketplace_plugin(js_dir + "/sdkjs-plugins", False, True)
@@ -146,7 +150,7 @@ def make():
     base.copy_exe(core_build_dir + "/bin/" + platform_postfix, tools_dir, "allthemesgen")
     if ("1" != config.option("preinstalled-plugins")):
       base.copy_exe(core_build_dir + "/bin/" + platform_postfix, tools_dir, "pluginsmanager")
-    
+
     branding_dir = server_dir + "/branding"
     if("" != config.option("branding") and "onlyoffice" != config.option("branding")):
       branding_dir = git_dir + '/' + config.option("branding") + '/server'
@@ -228,4 +232,3 @@ def make():
       base.delete_file(root_dir_snap + '/example/nodejs/example')
 
   return
-

scripts/develop/git_operations.py

@@ -0,0 +1,342 @@
+#!/usr/bin/env python3
+"""
+Git Operations Script
+Provides functionality to clone repositories and create branches.
+Uses existing methods from base module and integrates with release.py patterns.
+"""
+
+import sys
+import argparse
+import logging
+from typing import Dict
+
+# Add parent directory to path to import modules
+sys.path.append('../')
+import base
+import config
+import dependence
+
+# Setup logging
+logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
+logger = logging.getLogger(__name__)
+
+
+class GitOperations:
+    """Class to handle git clone and branch creation using existing base module methods."""
+    
+    def __init__(self, branding: str = "onlyoffice", base_branch: str = "develop", 
+                 branding_url: str = "ONLYOFFICE/onlyoffice.git", branch_name: str = None,
+                 modules: str = "core desktop builder server mobile"):
+        """
+        Initialize GitOperations with branding configuration and configure repositories.
+        
+        Args:
+            branding: Branding name (default: onlyoffice)
+            base_branch: Base branch to work from (default: develop)
+            branding_url: Relative path from git host base (default: ONLYOFFICE/onlyoffice.git)
+            branch_name: Name of the branch to create (required for branch operations)
+            modules: Modules to include (default: core desktop builder server mobile)
+        """
+        self.branding = branding
+        self.base_branch = base_branch
+        self.branding_url = branding_url
+        self.branch_name = branch_name
+        self.modules = modules
+        self.work_dir = None
+        
+        # Configure repositories immediately
+        self._configure()
+        
+        # Update repositories after configuration
+        repositories = self.get_configured_repositories()
+        #base.update_repositories(repositories)
+    
+    def create_branch(self, branch_name: str, repo_dir: str = None) -> bool:
+        """
+        Create a new branch using base.cmd_in_dir.
+        
+        Args:
+            branch_name: Name of the new branch
+            repo_dir: Repository directory (optional, uses current if not specified)
+            from_branch: Branch to create from (optional, uses current if not specified)
+        
+        Returns:
+            bool: True if successful, False otherwise
+        """
+        work_dir = repo_dir or self.work_dir
+        logger.info(f"Creating branch '{branch_name}' in {work_dir}")
+        
+        try:
+            # Create and checkout new branch
+            base.cmd_in_dir(work_dir, "git", ["checkout", "-b", branch_name], True)
+            logger.info(f"Successfully created branch: {branch_name}")
+            return True
+        except SystemExit:
+            logger.error(f"Failed to create branch: {branch_name}")
+            return False
+    
+    def push_branch(self, branch_name: str, repo_dir: str = None, set_upstream: bool = True) -> bool:
+        """
+        Push a branch to remote repository using base.cmd_in_dir.
+        
+        Args:
+            branch_name: Name of the branch to push
+            repo_dir: Repository directory (optional, uses current if not specified)
+            set_upstream: Whether to set upstream tracking (default: True)
+        
+        Returns:
+            bool: True if successful, False otherwise
+        """
+        work_dir = repo_dir or self.work_dir
+        logger.info(f"Pushing branch '{branch_name}' in {work_dir}")
+        
+        try:
+            if set_upstream:
+                # Push branch and set upstream tracking
+                base.cmd_in_dir(work_dir, "git", ["push", "-u", "origin", branch_name], True)
+            else:
+                # Just push the branch
+                base.cmd_in_dir(work_dir, "git", ["push", "origin", branch_name], True)
+            
+            logger.info(f"Successfully pushed branch: {branch_name}")
+            return True
+        except SystemExit:
+            logger.error(f"Failed to push branch: {branch_name}")
+            return False
+    
+    def _configure(self) -> bool:
+        """
+        Configure repositories using existing configure.py pattern from release.py.
+        
+        Returns:
+            bool: True if successful, False otherwise
+        """
+        logger.info(f"Configuring and cloning repositories for branch: {self.base_branch}")
+        
+        try:
+            # Get build_tools origin and construct branding URL from git host base
+            build_tools_origin = base.git_get_origin()
+            # Extract git host base (everything up to the host)
+            # For https://github.com/ORG/build_tools.git -> https://github.com/
+            # For git@github.com:ORG/build_tools.git -> git@github.com:
+            if '://' in build_tools_origin:  # HTTPS
+                host_base = build_tools_origin.split('/', 3)[0] + '//' + build_tools_origin.split('/', 3)[2] + '/'
+            else:  # SSH
+                host_base = build_tools_origin.split(':', 1)[0] + ':'
+            
+            branding_url = host_base + self.branding_url
+            
+            logger.info(f"Build tools origin: {build_tools_origin}")
+            logger.info(f"Git host base: {host_base}")
+            logger.info(f"Using branding URL: {branding_url}")
+            
+            # Check platform and dependencies like in release.py
+            platform = base.host_platform()
+            if platform == "windows":
+                dependence.check_pythonPath()
+                dependence.check_gitPath()
+            
+            # Run configure.py like in release.py
+            configure_args = [
+                'configure.py',
+                '--branding', self.branding,
+                '--branding-url', branding_url,
+                '--branch', self.base_branch,
+                '--module', self.modules,
+                '--update', '1',
+                '--clean', '0'
+            ]
+            
+            base.cmd_in_dir('../../', 'python', configure_args)
+            
+            # Parse configuration like in release.py
+            config.parse()
+            
+            # Update build_tools repository
+            base.git_update('build_tools')
+
+            # Update branding repository
+            base.git_update(self.branding)
+            
+            # Correct defaults (the branding repo is already updated)
+            config.parse_defaults()
+            
+            logger.info("Successfully configured")
+            return True
+            
+        except Exception as e:
+            logger.error(f"Failed to configure and clone: {e}")
+            return False
+    
+    def get_configured_repositories(self) -> Dict:
+        """Get repositories using existing base.get_repositories() pattern from release.py."""
+        repositories = base.get_repositories()
+        repositories['core-ext'] = [True, False]
+        repositories['build_tools'] = [True, False]
+        repositories[self.branding] = [True, False]
+        return repositories
+    
+    def _iterate_repositories(self, operation_func, operation_name: str) -> bool:
+        """
+        Iterate over all repositories and apply the given operation function.
+        
+        Args:
+            operation_func: Function to apply to each repository (takes repo_name and repo_path)
+            operation_name: Name of the operation for logging
+        
+        Returns:
+            bool: True if at least one operation succeeded, False otherwise
+        """
+        repositories = self.get_configured_repositories()
+        success_count = 0
+        total_count = len(repositories)
+        
+        for repo_name in repositories:
+            current_dir = repositories[repo_name][1]
+            repo_path = f"../../../{repo_name}" if current_dir == False else current_dir
+            
+            if base.is_dir(repo_path):
+                if operation_func(repo_name, repo_path):
+                    success_count += 1
+                else:
+                    logger.warning(f"✗ Failed to {operation_name} in {repo_name}")
+            else:
+                logger.warning(f"Repository {repo_name} not found at {repo_path}")
+        
+        logger.info(f"{operation_name.capitalize()} completed in {success_count}/{total_count} repositories")
+        return success_count > 0
+    
+    def delete_branch(self, branch_name: str, repo_dir: str = None, force: bool = False) -> bool:
+        """
+        Delete a branch using base.cmd_in_dir.
+        
+        Args:
+            branch_name: Name of the branch to delete
+            repo_dir: Repository directory (optional, uses current if not specified)
+            force: Whether to force delete the branch (default: False)
+        
+        Returns:
+            bool: True if successful, False otherwise
+        """
+        work_dir = repo_dir or self.work_dir
+        logger.info(f"Deleting branch '{branch_name}' in {work_dir}")
+        
+        try:
+            # Switch to base branch first to avoid deleting current branch
+            base.cmd_in_dir(work_dir, "git", ["checkout", self.base_branch], True)
+            
+            # Delete local branch
+            delete_flag = "-D" if force else "-d"
+            base.cmd_in_dir(work_dir, "git", ["branch", delete_flag, branch_name], True)
+            logger.info(f"Successfully deleted local branch: {branch_name}")
+            
+            # Delete remote branch
+            try:
+                base.cmd_in_dir(work_dir, "git", ["push", "origin", "--delete", branch_name], True)
+                logger.info(f"Successfully deleted remote branch: {branch_name}")
+            except SystemExit:
+                logger.warning(f"Failed to delete remote branch: {branch_name} (may not exist)")
+            
+            return True
+        except SystemExit:
+            logger.error(f"Failed to delete branch: {branch_name}")
+            return False
+
+    def create_branches(self) -> bool:
+        """
+        Create a branch with the given name in all repositories.
+        
+        Returns:
+            bool: True if successful, False otherwise
+        """
+        logger.info(f"Creating branch '{self.branch_name}' in all repositories")
+        
+        def create_and_push_branch(repo_name: str, repo_path: str) -> bool:
+            """Create and push branch for a single repository."""
+            if self.create_branch(self.branch_name, repo_path):
+                logger.info(f"✓ Created branch '{self.branch_name}' in {repo_name}")
+                # Push the created branch
+                if self.push_branch(self.branch_name, repo_path):
+                    logger.info(f"✓ Pushed branch '{self.branch_name}' in {repo_name}")
+                    return True
+                else:
+                    logger.warning(f"✗ Failed to push branch '{self.branch_name}' in {repo_name}")
+                    return False
+            else:
+                logger.warning(f"✗ Failed to create branch '{self.branch_name}' in {repo_name}")
+                return False
+        
+        try:
+            return self._iterate_repositories(create_and_push_branch, f"create and push branch '{self.branch_name}'")
+        except Exception as e:
+            logger.error(f"Failed to create branch in all repositories: {e}")
+            return False
+
+    def remove_branches(self, force: bool = False) -> bool:
+        """
+        Remove a branch with the given name from all repositories.
+        
+        Args:
+            force: Whether to force delete the branch (default: False)
+        
+        Returns:
+            bool: True if successful, False otherwise
+        """
+        logger.info(f"Removing branch '{self.branch_name}' from all repositories")
+        
+        def delete_branch_operation(repo_name: str, repo_path: str) -> bool:
+            """Delete branch for a single repository."""
+            if self.delete_branch(self.branch_name, repo_path, force):
+                logger.info(f"✓ Removed branch '{self.branch_name}' from {repo_name}")
+                return True
+            else:
+                logger.warning(f"✗ Failed to remove branch '{self.branch_name}' from {repo_name}")
+                return False
+        
+        try:
+            return self._iterate_repositories(delete_branch_operation, f"remove branch '{self.branch_name}'")
+        except Exception as e:
+            logger.error(f"Failed to remove branch from all repositories: {e}")
+            return False
+
+
+def main():
+    """Main function to handle command line arguments."""
+    parser = argparse.ArgumentParser(description='Git Operations Tool - Create and Remove Branches')
+    subparsers = parser.add_subparsers(dest='command', help='Available commands')
+    
+    # Create branch command (configure, clone and create branch in all repositories)
+    branch_parser = subparsers.add_parser('create', help='Configure, clone and create branch in all repositories')
+    branch_parser.add_argument('branch_name', help='Name of the branch to create')
+    branch_parser.add_argument('--base-branch', default='develop', help='Base branch to work from (default: develop)')
+    branch_parser.add_argument('--branding', default='onlyoffice', help='Branding name')
+    branch_parser.add_argument('--branding-url', default='ONLYOFFICE/onlyoffice.git', help='Relative path from git host base (default: ONLYOFFICE/onlyoffice.git)')
+    branch_parser.add_argument('--modules', default='core desktop builder server mobile', help='Modules to include')
+    
+    # Remove branch command (configure, clone and remove branch from all repositories)
+    remove_parser = subparsers.add_parser('remove', help='Configure, clone and remove branch from all repositories')
+    remove_parser.add_argument('branch_name', help='Name of the branch to remove')
+    remove_parser.add_argument('--base-branch', default='develop', help='Base branch to work from (default: develop)')
+    remove_parser.add_argument('--branding', default='onlyoffice', help='Branding name')
+    remove_parser.add_argument('--branding-url', default='ONLYOFFICE/onlyoffice.git', help='Relative path from git host base (default: ONLYOFFICE/onlyoffice.git)')
+    remove_parser.add_argument('--modules', default='core desktop builder server mobile', help='Modules to include')
+    remove_parser.add_argument('--force', action='store_true', help='Force delete the branch (equivalent to git branch -D)')
+    
+    args = parser.parse_args()
+    
+    if not args.command:
+        parser.print_help()
+        return
+    
+    git_ops = GitOperations(args.branding, args.base_branch, args.branding_url, args.branch_name, args.modules)
+    
+    if args.command == 'create':
+        success = git_ops.create_branches()
+        sys.exit(0 if success else 1)
+    elif args.command == 'remove':
+        success = git_ops.remove_branches(args.force)
+        sys.exit(0 if success else 1)
+
+
+if __name__ == '__main__':
+    main()

scripts/sdkjs_common/jsdoc/README.md

@@ -1,7 +1,14 @@
-
 # Documentation Generation Guide
 
-This guide explains how to generate documentation for Onlyoffice Builder/Plugins API using the provided Python scripts: `generate_docs_json.py`, `generate_docs_plugins_json.py`, `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.
+This guide explains how to generate documentation for Onlyoffice Builder
+and Plugins (Methods/Events) API using the following Python scripts:
+
+- `office-api/generate_docs_json.py`
+- `office-api/generate_docs_md.py`
+- `plugins/generate_docs_methods_json.py`
+- `plugins/generate_docs_methods_md.py`
+- `plugins/generate_docs_events_json.py`
+- `plugins/generate_docs_events_md.py`
 
 ## Requirements
 
@@ -20,61 +27,112 @@ npm install
 
 ## Scripts Overview
 
-### `generate_docs_json.py`
+### `office-api/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 `../../../../office-js-api-declarations/office-js-api`.
+  - `output_path` (optional): The directory where the JSON documentation
+    will be saved. If not specified, the default path is
+    `../../../../office-js-api-declarations/office-js-api`.
 
-### `generate_docs_plugins_json.py`
-
-This script generates JSON documentation based on the `api_plugins.js` files.
-
-- **Usage**:
-  ```bash
-  python generate_docs_plugins_json.py output_path
-  ```
-
-- **Parameters**:
-  - `output_path` (optional): The directory where the JSON documentation will be saved. If not specified, the default path is `../../../../office-js-api-declarations/office-js-api-plugins`.
-
-### `generate_docs_md.py`
+### `office-api/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 `../../../../office-js-api/`.
+  - `output_path` (optional): The directory where the Markdown documentation
+    will be saved. If not specified, the default path is
+    `../../../../office-js-api/`.
+
+### `plugins/generate_docs_methods_json.py`
+
+This script generates JSON documentation based on the `api_plugins.js` files.
+
+- **Usage**:
+
+  ```bash
+  python generate_docs_methods_json.py output_path
+  ```
+
+- **Parameters**:
+  - `output_path` (optional): The directory where the JSON documentation
+    will be saved. If not specified, the default path is
+    `../../../../office-js-api-declarations/office-js-api-plugins`.
+
+### `plugins/generate_docs_events_json.py`
+
+This script generates JSON documentation based on the `plugin-events.js` files.
+
+- **Usage**:
+
+  ```bash
+  python generate_docs_events_json.py output_path
+  ```
+
+- **Parameters**:
+  - `output_path` (optional): The directory where the JSON documentation
+    will be saved. If not specified, the default path is
+    `../../../../office-js-api-declarations/office-js-api-plugins`.
+
+### `plugins/generate_docs_methods_md.py`
+
+This script generates Markdown documentation from the `api_plugins.js` files.
+
+- **Usage**:
+
+  ```bash
+  python generate_docs_methods_md.py output_path
+  ```
+
+- **Parameters**:
+  - `output_path` (optional): The directory where the Markdown documentation
+    will be saved. If not specified, the default path is
+    `../../../../office-js-api/`.
+
+### `plugins/generate_docs_events_md.py`
+
+This script generates Markdown documentation from the `plugin-events.js` files.
+
+- **Usage**:
+
+  ```bash
+  python generate_docs_events_md.py output_path
+  ```
+
+- **Parameters**:
+  - `output_path` (optional): The directory where the Markdown documentation
+    will be saved. If not specified, the default path is
+    `../../../../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 JSON documentation with the default output path:
-```bash
-python generate_docs_plugins_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.
+- 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/plugins/events/cell.json

@@ -1,6 +1,6 @@
 {
   "source": {
-    "include": ["../../../../sdkjs/cell/api_plugins.js"]
+    "include": ["../../../../sdkjs/cell/plugin-events.js"]
   },
   "plugins": ["./correct_doclets.js"],
   "opts": {

scripts/sdkjs_common/jsdoc/config/plugins/events/common.json

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

scripts/sdkjs_common/jsdoc/config/plugins/events/slide.json

@@ -1,6 +1,6 @@
 {
   "source": {
-    "include": ["../../../../sdkjs/slide/api_plugins.js"]
+    "include": ["../../../../sdkjs/slide/plugin-events.js"]
   },
   "plugins": ["./correct_doclets.js"],
   "opts": {

scripts/sdkjs_common/jsdoc/config/plugins/events/word.json

@@ -1,6 +1,6 @@
 {
   "source": {
-    "include": ["../../../../sdkjs/word/apiBuilder.js"]
+    "include": ["../../../../sdkjs/word/plugin-events.js"]
   },
   "plugins": ["./correct_doclets.js"],
   "opts": {

scripts/sdkjs_common/jsdoc/generate_docs_md_site.py

@@ -1,586 +0,0 @@
-import os
-import json
-import re
-import shutil
-import argparse
-import generate_docs_json
-
-# Configuration files
-editors = {
-    "word": "text-document-api",
-    "cell": "spreadsheet-api",
-    "slide": "presentation-api",
-    "forms": "form-api"
-}
-
-missing_examples = []
-used_enumerations = set()
-
-cur_editor_name = None
-
-_CODE_BLOCK_RE = re.compile(r'(```.*?```)', re.DOTALL)
-_QSTRING_RE    = re.compile(r'(["\'])(.*?)(?<!\\)\1', re.DOTALL)
-_BRACKET_TABLE = {ord('['): '&#91;', ord(']'): '&#93;'}
-
-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):
-    text = re.sub(r'^\s*//.*$', '', text, flags=re.MULTILINE)  # single-line
-    text = re.sub(r'/\*.*?\*/', '', text, flags=re.DOTALL)     # multi-line
-    return text.strip()
-
-def process_link_tags(text, root=''):
-    """
-    Finds patterns like {@link ...} and replaces them with Markdown links.
-    If the prefix 'global#' is found, a link to a typedef is generated,
-    otherwise, a link to a class method is created.
-    For a method, if an alias is not specified, the name is left in the format 'Class#Method'.
-    """
-    reserved_links = {
-        '/docbuilder/global#ShapeType': f"{'../../../../../../' if root == '' else '../../../../../' if root == '../' else root}docs/office-api/usage-api/text-document-api/Enumeration/ShapeType.md",
-        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/manifest/',
-        '/docbuilder/basic': 'https://api.onlyoffice.com/docs/office-api/usage-api/text-document-api/'
-    }
-
-    def replace_link(match):
-        content = match.group(1).strip()  # Example: "/docbuilder/global#ShapeType shape type" or "global#ErrorValue ErrorValue"
-        parts = content.split()
-        ref = parts[0]
-        label = parts[1] if len(parts) > 1 else None
-
-        if ref.startswith('/'):
-            # Handle reserved links using mapping
-            if ref in reserved_links:
-                url = reserved_links[ref]
-                display_text = label if label else ref
-                return f"[{display_text}]({url})"
-            else:
-                # If the link is not in the mapping, return the original construction
-                return match.group(0)
-        elif ref.startswith("global#"):
-            # Handle links to typedef (similar logic as before)
-            typedef_name = ref.split("#")[1]
-            used_enumerations.add(typedef_name)
-            display_text = label if label else typedef_name
-            return f"[{display_text}]({root}Enumeration/{typedef_name}.md)"
-        else:
-            # Handle links to class methods like ClassName#MethodName
-            try:
-                class_name, method_name = ref.split("#")
-            except ValueError:
-                return match.group(0)
-            display_text = label if label else ref  # Keep the full notation, e.g., "Api#CreateSlide"
-            return f"[{display_text}]({root}{class_name}/Methods/{method_name}.md)"
-
-    return re.sub(r'{@link\s+([^}]+)}', replace_link, text)
-
-def correct_description(string, root=''):
-    """
-    Cleans or transforms specific tags in the doclet description:
-      - <b> => ** (bold text)
-      - <note>...</note> => 💡 ...
-      - {@link ...} is replaced with a Markdown link
-      - If the description is missing, returns a default value.
-      - All '\r' characters are replaced with '\n'.
-    """
-    if string is None:
-        return 'No description provided.'
-
-    # Line breaks
-    string = string.replace('\r', '\\\n')
-    
-    # Replace <b> tags with Markdown bold formatting
-    string = re.sub(r'<b>', '-**', string)
-    string = re.sub(r'</b>', '**', string)
-    
-    # Replace <note> tags with an icon and text
-    string = re.sub(r'<note>(.*?)</note>', r'💡 \1', string, flags=re.DOTALL)
-    
-    # Process {@link ...} constructions
-    string = process_link_tags(string, root)
-    
-    return string
-
-def correct_default_value(value, enumerations, classes):
-    if value is None or value == '':
-        return ''
-    
-    if isinstance(value, bool):
-        value = "true" if value else "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)
-
-# Convert Array.<T> => T[] (including nested arrays).
-def convert_jsdoc_array_to_ts(type_str: str) -> str:
-    """
-    Recursively replaces 'Array.<T>' with 'T[]',
-    handling nested arrays like 'Array.<Array.<string>>' => 'string[][]'.
-    """
-    pattern = re.compile(r'Array\.<([^>]+)>')
-    
-    while True:
-        match = pattern.search(type_str)
-        if not match:
-            break
-        
-        inner_type = match.group(1).strip()
-        # Recursively convert inner parts
-        inner_type = convert_jsdoc_array_to_ts(inner_type)
-        
-        # Replace the outer Array.<...> with ...[]
-        type_str = (
-            type_str[:match.start()] 
-            + f"{inner_type}[]" 
-            + type_str[match.end():]
-        )
-    
-    return type_str
-
-def escape_text_outside_code_blocks(markdown: str) -> str:
-    """
-    Splits content by fenced code blocks, escapes MDX-unsafe characters
-    (<, >, {, }) only in the text outside those code blocks.
-    """
-    # A regex to capture fenced code blocks with ```
-    parts = re.split(r'(```.*?```)', markdown, flags=re.DOTALL)
-    
-    # Even indices (0, 2, 4, ...) are outside code blocks,
-    # odd indices (1, 3, 5, ...) are actual code blocks.
-    for i in range(0, len(parts), 2):
-        text = (parts[i]
-                .replace('<', '&lt;')
-                .replace('>', '&gt;')
-                .replace('{', '&#123;')
-                .replace('}', '&#125;'))
-        parts[i] = escape_brackets_in_quotes(text)
-    
-    return "".join(parts)
-
-def escape_brackets_in_quotes(text: str) -> str:
-    return re.sub(
-        r"(['\"])(.*?)(?<!\\)\1",
-        lambda m: m.group(1)
-                  + m.group(2).replace('[', r'\[').replace(']', r'\]')
-                  + m.group(1),
-        text
-    )
-
-def get_base_type(ts_type: str) -> str:
-    """
-    Given a TypeScript-like type (e.g. "Drawing[][]"), return the
-    'base' portion by stripping trailing "[]". For "Drawing[][]",
-    returns "Drawing". For "Array.<Drawing>", you'd convert it first
-    to "Drawing[]" then return "Drawing".
-    """
-    while ts_type.endswith('[]'):
-        ts_type = ts_type[:-2]
-    return ts_type
-
-def generate_data_types_markdown(types, enumerations, classes, root='../../'):
-    """
-    1) Converts each type from JSDoc (e.g., Array.<T>) to T[].
-    2) Processes union types by splitting them using '|'.
-    3) Supports multidimensional arrays, e.g., (string|ApiRange|number)[].
-    4) If the base type matches the name of an enumeration or class, generates a link.
-    5) The final types are joined using " | ".
-    """
-    # Convert each type from JSDoc format to TypeScript format (e.g., T[])
-    converted = [convert_jsdoc_array_to_ts(t) for t in types]
-
-    # Set of primitive types
-    primitive_types = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "{}"}
-
-    def is_primitive(type):
-        if (type.lower() in primitive_types or
-            (type.startswith('"') and type.endswith('"')) or
-            (type.startswith("'") and type.endswith("'")) or
-            type.replace('.', '', 1).isdigit() or
-            (type.startswith('-') and type[1:].replace('.', '', 1).isdigit())):
-            return True
-        return False
-
-    def link_if_known(ts_type):
-        ts_type = ts_type.strip()
-        # Count the number of array dimensions, e.g., "[][]" has 2 dimensions
-        array_dims = 0
-        while ts_type.endswith("[]"):
-            array_dims += 1
-            ts_type = ts_type[:-2].strip()
-
-        # Process generic types, e.g., Object.<string, editorType>
-        if ".<" in ts_type and ts_type.endswith(">"):
-            import re
-            m = re.match(r'^(.*?)\.<(.*)>$', ts_type)
-            if m:
-                base_part = m.group(1).strip()
-                generic_args_str = m.group(2).strip()
-                # Process the base part of the type
-                found = False
-                for enum in enumerations:
-                    if enum['name'] == base_part:
-                        used_enumerations.add(base_part)
-                        base_result = f"[{base_part}]({root}Enumeration/{base_part}.md)"
-                        found = True
-                        break
-                if not found:
-                    if base_part in classes:
-                        base_result = f"[{base_part}]({root}{base_part}/{base_part}.md)"
-                    elif is_primitive(base_part):
-                        base_result = base_part
-                    elif cur_editor_name == "forms":
-                        base_result = f"[{base_part}]({root}../text-document-api/{base_part}/{base_part}.md)"
-                    else:
-                        print(f"Unknown type encountered: {base_part}")
-                        base_result = base_part
-                # Split the generic parameters by commas and process each recursively
-                generic_args = [link_if_known(x) for x in generic_args_str.split(",")]
-                result = base_result + ".&lt;" + ", ".join(generic_args) + "&gt;"
-                result += "[]" * array_dims
-                return result
-
-        # Process union types: if the type is enclosed in parentheses
-        if ts_type.startswith("(") and ts_type.endswith(")"):
-            inner = ts_type[1:-1].strip()
-            subtypes = [sub.strip() for sub in inner.split("|")]
-            if len(subtypes) == 1:
-                result = link_if_known(subtypes[0])
-            else:
-                processed = [link_if_known(subtype) for subtype in subtypes]
-                result = "(" + " | ".join(processed) + ")"
-            result += "[]" * array_dims
-            return result
-
-        # If not a generic or union type – process the base type
-        else:
-            base = ts_type
-            found = False
-            for enum in enumerations:
-                if enum['name'] == base:
-                    used_enumerations.add(base)
-                    result = f"[{base}]({root}Enumeration/{base}.md)"
-                    found = True
-                    break
-            if not found:
-                if base in classes:
-                    result = f"[{base}]({root}{base}/{base}.md)"
-                elif is_primitive(base):
-                    result = base
-                elif cur_editor_name == "forms":
-                    result = f"[{base}]({root}../text-document-api/{base}/{base}.md)"
-                else:
-                    print(f"Unknown type encountered: {base}")
-                    result = base
-            result += "[]" * array_dims
-            return result
-
-    # Apply link_if_known to each converted type
-    linked = [link_if_known(ts_t) for ts_t in converted]
-
-    # Join results using " | "
-    param_types_md = r' | '.join(linked)
-    param_types_md = param_types_md.replace("|", r"\|")
-
-    # Escape remaining angle brackets for generics
-    def replace_leftover_generics(match):
-        element = match.group(1).strip()
-        return f"&lt;{element}&gt;"
-
-    param_types_md = re.sub(r'<([^<>]+)>', replace_leftover_generics, param_types_md)
-
-    return 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 += "\n## Methods\n\n"
-    content += "| Method | Returns | Description |\n"
-    content += "| ------ | ------- | ----------- |\n"
-    
-    for method in sorted(methods, key=lambda m: m['name']):
-        method_name = method['name']
-        
-        # Get the type of return values
-        returns = method.get('returns', [])
-        if returns:
-            return_type_list = returns[0].get('type', {}).get('names', [])
-            returns_markdown = generate_data_types_markdown(return_type_list, enumerations, classes, '../')
-        else:
-            returns_markdown = "None"
-        
-        # Processing the method description
-        description = remove_line_breaks(correct_description(method.get('description', 'No description provided.'), '../'))
-        
-        # Form a link to the method document
-        method_link = f"[{method_name}](./Methods/{method_name}.md)"
-        
-        content += f"| {method_link} | {returns_markdown} | {description} |\n"
-    
-    return escape_text_outside_code_blocks(content)
-
-def generate_method_markdown(method, enumerations, classes, example_editor_name):
-    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
-    param_list = ', '.join([param['name'] for param in params if '.' not in param['name']]) if params else ''
-    content += f"## Syntax\n\n```javascript\nexpression.{method_name}({param_list});\n```\n\n"
-    if memberof:
-        content += f"`expression` - A variable that represents a [{memberof}](../{memberof}.md) class.\n\n"
-
-    # Parameters
-    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"
-
-    # Returns
-    content += "\n## Returns\n\n"
-    if returns:
-        return_type_list = returns[0].get('type', {}).get('names', [])
-        return_type_md = generate_data_types_markdown(return_type_list, enumerations, classes)
-        content += return_type_md
-    else:
-        content += "This method doesn't return any data."
-    
-    # Example
-    if example:
-        # Separate comment and code, remove JS comments
-        if '```js' in example:
-            comment, code = example.split('```js', 1)
-            comment = remove_js_comments(comment)
-            content += f"\n\n## Example\n\n{comment}\n\n```javascript {example_editor_name}\n{code.strip()}\n"
-        else:
-            # If there's no triple-backtick structure, just show it as code
-            cleaned_example = remove_js_comments(example)
-            content += f"\n\n## Example\n\n```javascript {example_editor_name}\n{cleaned_example}\n```\n"
-
-    return escape_text_outside_code_blocks(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 sorted(properties, key=lambda m: m['name']):
-        prop_name = prop['name']
-        prop_description = prop.get('description', 'No description provided.')
-        prop_description = remove_line_breaks(correct_description(prop_description, root))
-        prop_types = prop['type']['names'] if prop.get('type') else []
-        param_types_md = generate_data_types_markdown(prop_types, enumerations, classes, root)
-        content += f"| {prop_name} | {param_types_md} | {prop_description} |\n"
-
-    # Escape outside code blocks
-    return escape_text_outside_code_blocks(content)
-
-def generate_enumeration_markdown(enumeration, enumerations, classes, example_editor_name):
-    enum_name = enumeration['name']
-    
-    if enum_name not in used_enumerations:
-            return None
-    
-    description = enumeration.get('description', 'No description provided.')
-    description = correct_description(description, '../')
-    example = enumeration.get('example', '')
-
-    content = f"# {enum_name}\n\n{description}\n\n"
-    
-    ptype = enumeration['type']['parsedType']
-    if ptype['type'] == 'TypeUnion':
-        enum_empty = True # is empty enum
-
-        content += "## Type\n\nEnumeration\n\n"
-        content += "## Values\n\n"
-        # Each top-level name in the union
-        for raw_t in enumeration['type']['names']:
-            ts_t = convert_jsdoc_array_to_ts(raw_t)
-
-            # Attempt linking: we compare the raw type to enumerations/classes
-            if any(enum['name'] == raw_t for enum in enumerations):
-                used_enumerations.add(raw_t)
-                content += f"- [{ts_t}](../Enumeration/{raw_t}.md)\n"
-                enum_empty = False
-            elif raw_t in classes:
-                content += f"- [{ts_t}](../{raw_t}/{raw_t}.md)\n"
-                enum_empty = False
-            elif ts_t.find('Api') == -1:
-                content += f"- {ts_t}\n"
-                enum_empty = False
-        
-        if enum_empty == True:
-            return None
-    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"
-        # If it's not a union and has no properties, simply print the type(s).
-        types = enumeration['type']['names']
-        t_md = generate_data_types_markdown(types, enumerations, classes)
-        content += t_md + "\n\n"
-
-    # Example
-    if example:
-        if '```js' in example:
-            comment, code = example.split('```js', 1)
-            comment = remove_js_comments(comment)
-            content += f"\n\n## Example\n\n{comment}\n\n```javascript {example_editor_name}\n{code.strip()}\n"
-        else:
-            # If there's no triple-backtick structure
-            cleaned_example = remove_js_comments(example)
-            content += f"\n\n## Example\n\n```javascript {example_editor_name}\n{cleaned_example}\n```\n"
-
-    return escape_text_outside_code_blocks(content)
-
-def process_doclets(data, output_dir, editor_name):
-    global cur_editor_name
-    cur_editor_name = editor_name
-
-    classes = {}
-    classes_props = {}
-    enumerations = []
-    editor_dir = os.path.join(output_dir, editors[editor_name])
-    example_editor_name = 'editor-'
-    
-    if editor_name == 'word':
-        example_editor_name += 'docx'
-    elif editor_name == 'forms':
-        example_editor_name += 'pdf'
-    elif editor_name == 'slide':
-        example_editor_name += 'pptx'
-    elif editor_name == 'cell':
-        example_editor_name += 'xlsx'
-
-    for doclet in data:
-        if doclet['kind'] == 'class':
-            class_name = doclet['name']
-            if class_name:
-                if class_name not in classes:
-                    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():
-        if (len(methods) == 0):
-            continue
-
-        class_dir = os.path.join(editor_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_file_path = os.path.join(methods_dir, f"{method['name']}.md")
-            method_content = generate_method_markdown(method, enumerations, classes, example_editor_name)
-            write_markdown_file(method_file_path, method_content)
-
-            if not method.get('example', ''):
-                missing_examples.append(os.path.relpath(method_file_path, output_dir))
-
-    # Process enumerations
-    enum_dir = os.path.join(editor_dir, 'Enumeration')
-    os.makedirs(enum_dir, exist_ok=True)
-
-    # idle run
-    prev_used_count = -1
-    while len(used_enumerations) != prev_used_count:
-        prev_used_count = len(used_enumerations)
-        for enum in [e for e in enumerations if e['name'] in used_enumerations]:
-            enum_content = generate_enumeration_markdown(enum, enumerations, classes, example_editor_name)
-
-    for enum in enumerations:
-        enum_file_path = os.path.join(enum_dir, f"{enum['name']}.md")
-        enum_content = generate_enumeration_markdown(enum, enumerations, classes, example_editor_name)
-        if enum_content is None:
-            continue
-
-        write_markdown_file(enum_file_path, enum_content)
-        if not enum.get('example', ''):
-            missing_examples.append(os.path.relpath(enum_file_path, output_dir))
-
-def generate(output_dir):
-    print('Generating Markdown documentation...')
-    
-    generate_docs_json.generate(output_dir + 'tmp_json', md=True)
-    for editor_name, folder_name in editors.items():
-        input_file = os.path.join(output_dir + '/tmp_json', editor_name + ".json")
-
-        editor_folder_path = os.path.join(output_dir, folder_name)
-        for folder_name in os.listdir(editor_folder_path):
-            folder_path_to_del = os.path.join(editor_folder_path, folder_name)
-            if os.path.isdir(folder_path_to_del):
-                shutil.rmtree(folder_path_to_del, ignore_errors=True)
-
-        data = load_json(input_file)
-        used_enumerations.clear()
-        process_doclets(data, output_dir, 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="../../../../api.onlyoffice.com/site/docs/office-api/usage-api/"  # Default value
-    )
-    args = parser.parse_args()
-    generate(args.destination)
-    print("START_MISSING_EXAMPLES")
-    print(",".join(missing_examples))
-    print("END_MISSING_EXAMPLES")

scripts/sdkjs_common/jsdoc/generate_docs_plugins_events_json.py

@@ -6,11 +6,10 @@ import re
 
 # Configuration files
 configs = [
-    "./config/plugins/common.json",
-    "./config/plugins/word.json",
-    "./config/plugins/cell.json",
-    "./config/plugins/slide.json",
-    "./config/plugins/forms.json"
+    "./config/plugins/events/common.json",
+    "./config/plugins/events/word.json",
+    "./config/plugins/events/cell.json",
+    "./config/plugins/events/slide.json"
 ]
 
 root = '../../../..'
@@ -105,7 +104,7 @@ if __name__ == "__main__":
         type=str, 
         help="Destination directory for the generated documentation",
         nargs='?',  # Indicates the argument is optional
-        default=f"{root}/office-js-api-declarations/office-js-api-plugins"
+        default=f"{root}/office-js-api-declarations/office-js-api-plugins/events"
     )
     args = parser.parse_args()
     generate(args.destination)

scripts/sdkjs_common/jsdoc/generate_docs_plugins_events_md_site.py

@@ -0,0 +1,356 @@
+#!/usr/bin/env python3
+import os
+import json
+import re
+import shutil
+import argparse
+import generate_docs_plugins_events_json
+
+# Папки для каждого editor_name
+editors = {
+    "word": "text-document-api",
+    "cell": "spreadsheet-api",
+    "slide": "presentation-api"
+}
+
+missing_examples = []
+used_enumerations = set()
+
+
+def load_json(path):
+    with open(path, 'r', encoding='utf-8') as f:
+        return json.load(f)
+
+
+def write_markdown_file(path, content):
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+    with open(path, 'w', encoding='utf-8') as f:
+        f.write(content)
+
+
+def remove_js_comments(text):
+    text = re.sub(r'^\s*//.*$', '', text, flags=re.MULTILINE)
+    text = re.sub(r'/\*.*?\*/', '', text, flags=re.DOTALL)
+    return text.strip()
+
+
+def correct_description(string, root=''):
+    """
+    Cleans or transforms specific tags in the doclet description:
+      - <b> => ** (bold text)
+      - <note>...</note> => 💡 ...
+      - {@link ...} is replaced with a Markdown link
+      - If the description is missing, returns a default value.
+      - All '\r' characters are replaced with '\n'.
+    """
+    if string is None:
+        return 'No description provided.'
+
+    # Line breaks
+    string = string.replace('\r', '\\\n')
+    
+    # Replace <b> tags with Markdown bold formatting
+    string = re.sub(r'<b>', '-**', string)
+    string = re.sub(r'</b>', '**', string)
+    
+    # Replace <note> tags with an icon and text
+    string = re.sub(r'<note>(.*?)</note>', r'💡 \1', string, flags=re.DOTALL)
+    
+    # Process {@link ...} constructions
+    string = process_link_tags(string, root)
+    
+    return string
+
+def process_link_tags(text, root=''):
+    """
+    Finds patterns like {@link ...} and replaces them with Markdown links.
+    If the prefix 'global#' is found, a link to a typedef is generated,
+    otherwise, a link to a class method is created.
+    For a method, if an alias is not specified, the name is left in the format 'Class#Method'.
+    """
+    reserved_links = {
+        '/docbuilder/global#ShapeType': f"{'../../../../../../' if root == '' else '../../../../../' if root == '../' else root}docs/office-api/usage-api/text-document-api/Enumeration/ShapeType.md",
+        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/manifest/',
+        '/docbuilder/basic': 'https://api.onlyoffice.com/docs/office-api/usage-api/text-document-api/'
+    }
+
+    def replace_link(match):
+        content = match.group(1).strip()  # Example: "/docbuilder/global#ShapeType shape type" or "global#ErrorValue ErrorValue"
+        parts = content.split()
+        ref = parts[0]
+        label = parts[1] if len(parts) > 1 else None
+
+        if ref.startswith('/'):
+            # Handle reserved links using mapping
+            if ref in reserved_links:
+                url = reserved_links[ref]
+                display_text = label if label else ref
+                return f"[{display_text}]({url})"
+            elif ref.startswith('/plugins/methods/'):
+                url = f'../../{ref.split('/plugins/')[1]}.md'
+                display_text = label if label else ref
+                return f"[{display_text}]({url})"
+            else:
+                # If the link is not in the mapping, return the original construction
+                return match.group(0)
+        elif ref.startswith("global#"):
+            # Handle links to typedef (similar logic as before)
+            typedef_name = ref.split("#")[1]
+            used_enumerations.add(typedef_name)
+            display_text = label if label else typedef_name
+            return f"[{display_text}]({root}Enumeration/{typedef_name}.md)"
+        else:
+            # Handle links to class methods like ClassName#MethodName
+            try:
+                class_name, method_name = ref.split("#")
+            except ValueError:
+                return match.group(0)
+            display_text = label if label else ref  # Keep the full notation, e.g., "Api#CreateSlide"
+            return f"[{display_text}]({root}{class_name}/Methods/{method_name}.md)"
+
+    return re.sub(r'{@link\s+([^}]+)}', replace_link, text)
+
+def remove_line_breaks(s):
+    return re.sub(r'[\r\n]+', ' ', s)
+
+
+def convert_jsdoc_array_to_ts(type_str):
+    p = re.compile(r'Array\.<([^>]+)>')
+    while True:
+        m = p.search(type_str)
+        if not m:
+            break
+        inner = convert_jsdoc_array_to_ts(m.group(1).strip())
+        type_str = type_str[:m.start()] + inner + '[]' + type_str[m.end():]
+    return type_str
+
+
+def generate_data_types_markdown(types, enumerations, root=''):
+    converted = [convert_jsdoc_array_to_ts(t) for t in types]
+    primitives = {"string", "number", "boolean", "null", "undefined", "any", "object", "true", "false"}
+    result = []
+    enum_names = {e['name'] for e in enumerations}
+    for t in converted:
+        base = t.rstrip('[]')
+        dims = t[len(base):]
+        if base in enum_names:
+            used_enumerations.add(base)
+            link = f"[{base}]({root}Enumeration/{base}.md)"
+        elif base in primitives or re.match(r"^['\"].*['\"]$", base) or re.match(r"^-?\d+(\.\d+)?$", base):
+            link = base
+        else:
+            link = base
+        result.append(link + dims)
+    return " | ".join(result)
+
+
+def escape_text_outside_code_blocks(md):
+    parts = re.split(r'(```.*?```)', md, flags=re.DOTALL)
+    for i in range(0, len(parts), 2):
+        parts[i] = parts[i].replace('<', '&lt;').replace('>', '&gt;')
+    return "".join(parts)
+
+
+def generate_event_markdown(event, enumerations):
+    name = event['name']
+    desc = correct_description(event.get('description', ''))
+    params = event.get('params', [])
+
+    md = f"# {name}\n\n{desc}\n\n"
+
+    # Parameters
+    md += "## Parameters\n\n"
+    if params:
+        md += "| **Name** | **Data type** | **Description** |\n"
+        md += "| --------- | ------------- | ----------- |\n"
+        for p in params:
+            t_md = generate_data_types_markdown(
+                p.get('type', {}).get('names', []),
+                enumerations
+            )
+            d = remove_line_breaks(correct_description(p.get('description', '')))
+            md += f"| {p['name']} | {t_md} | {d} |\n"
+        md += "\n"
+    else:
+        md += "This event has no parameters.\n\n"
+
+    for ex in event.get('examples', []):
+        code = remove_js_comments(ex).strip()
+        md += f"```javascript\n{code}\n```\n\n"
+
+    return escape_text_outside_code_blocks(md)
+
+
+def generate_enumeration_markdown(enumeration, enumerations):
+    """
+    Generates Markdown documentation for a 'typedef' doclet.
+    This version only works with `enumeration['examples']` (an array of strings),
+    ignoring any single `enumeration['examples']` field.
+    """
+    enum_name = enumeration['name']
+
+    if enum_name not in used_enumerations:
+        return None
+    
+    description = enumeration.get('description', 'No description provided.')
+    description = correct_description(description, '../')
+
+    # Only use the 'examples' array
+    examples = enumeration.get('examples', [])
+
+    content = f"# {enum_name}\n\n{description}\n\n"
+
+    parsed_type = enumeration['type'].get('parsedType')
+    if not parsed_type:
+        # If parsedType is missing, just list 'type.names' if available
+        type_names = enumeration['type'].get('names', [])
+        if type_names:
+            content += "## Type\n\n"
+            t_md = generate_data_types_markdown(type_names, enumerations)
+            content += t_md + "\n\n"
+    else:
+        ptype = parsed_type['type']
+
+        # 1) Handle TypeUnion
+        if ptype == 'TypeUnion':
+            content += "## Type\n\nEnumeration\n\n"
+            content += "## Values\n\n"
+            for raw_t in enumeration['type']['names']:
+                # Attempt linking
+                if any(enum['name'] == raw_t for enum in enumerations):
+                    used_enumerations.add(raw_t)
+                    content += f"- [{raw_t}](../Enumeration/{raw_t}.md)\n"
+                else:
+                    content += f"- {raw_t}\n"
+
+        # 2) Handle TypeApplication (e.g. Object.<string, string>)
+        elif ptype == 'TypeApplication':
+            content += "## Type\n\nObject\n\n"
+            type_names = enumeration['type'].get('names', [])
+            if type_names:
+                t_md = generate_data_types_markdown(type_names, enumerations)
+                content += f"**Type:** {t_md}\n\n"
+
+        # 3) If properties are present, treat it like an object
+        if enumeration.get('properties') is not None:
+            content += generate_properties_markdown(enumeration['properties'], enumerations)
+
+        # 4) If it's neither TypeUnion nor TypeApplication, just output the type names
+        if ptype not in ('TypeUnion', 'TypeApplication'):
+            type_names = enumeration['type'].get('names', [])
+            if type_names:
+                content += "## Type\n\n"
+                t_md = generate_data_types_markdown(type_names, enumerations)
+                content += t_md + "\n\n"
+
+    # Process examples array
+    if examples:
+        if len(examples) > 1:
+            content += "\n\n## Examples\n\n"
+        else:
+            content += "\n\n## Example\n\n"
+
+        for i, ex_line in enumerate(examples, start=1):
+            # Remove JS comments
+            cleaned_example = remove_js_comments(ex_line).strip()
+
+            # Attempt splitting if the user used ```js
+            if '```js' in cleaned_example:
+                comment, code = cleaned_example.split('```js', 1)
+                comment = comment.strip()
+                code = code.strip()
+                if len(examples) > 1:
+                    content += f"**Example {i}:**\n\n{comment}\n\n"
+                
+                content += f"```javascript\n{code}\n```\n"
+            else:
+                if len(examples) > 1:
+                    content += f"**Example {i}:**\n\n{comment}\n\n"
+                # No special fences, just show as code
+                content += f"```javascript\n{cleaned_example}\n```\n"
+
+    return escape_text_outside_code_blocks(content)
+
+def generate_properties_markdown(properties, enumerations, root='../'):
+    if properties is None:
+        return ''
+    
+    content = "## Properties\n\n"
+    content += "| Name | Type | Description |\n"
+    content += "| ---- | ---- | ----------- |\n"
+
+    for prop in sorted(properties, key=lambda m: m['name']):
+        prop_name = prop['name']
+        prop_description = prop.get('description', 'No description provided.')
+        prop_description = remove_line_breaks(correct_description(prop_description))
+        prop_types = prop['type']['names'] if prop.get('type') else []
+        param_types_md = generate_data_types_markdown(prop_types, enumerations, root)
+        content += f"| {prop_name} | {param_types_md} | {prop_description} |\n"
+
+    # Escape outside code blocks
+    return escape_text_outside_code_blocks(content)
+
+def process_events(data, events_root):
+    enumerations = []
+    events = []
+
+    for doclet in data:
+        kind = doclet.get('kind')
+        if kind == 'typedef':
+            enumerations.append(doclet)
+        elif kind == 'event':
+            events.append(doclet)
+
+    os.makedirs(events_root, exist_ok=True)
+    used_enumerations.clear()
+
+    # пишем события
+    for ev in events:
+        path = os.path.join(events_root, f"{ev['name']}.md")
+        write_markdown_file(path, generate_event_markdown(ev, enumerations))
+        if not ev.get('examples'):
+            missing_examples.append(os.path.relpath(path, events_root))
+
+    # пишем перечисления, используемые событиями
+    enum_dir = os.path.join(events_root, 'Enumeration')
+    os.makedirs(enum_dir, exist_ok=True)
+    prev = -1
+    while len(used_enumerations) != prev:
+        prev = len(used_enumerations)
+        for e in enumerations:
+            if e['name'] in used_enumerations:
+                generate_enumeration_markdown(e, enumerations)
+    for e in enumerations:
+        if e['name'] in used_enumerations:
+            path = os.path.join(enum_dir, f"{e['name']}.md")
+            write_markdown_file(path, generate_enumeration_markdown(e, enumerations))
+            if not e.get('examples'):
+                missing_examples.append(os.path.relpath(path, events_root))
+
+
+def generate_events(output_dir):
+    if output_dir.endswith('/'):
+        output_dir = output_dir[:-1]
+    tmp = os.path.join(output_dir, 'tmp_json')
+
+    shutil.rmtree(output_dir, ignore_errors=True)
+    generate_docs_plugins_events_json.generate(tmp, md=True)
+
+    for editor_name, folder in editors.items():
+        data = load_json(os.path.join(tmp, f"{editor_name}.json"))
+        process_events(data, os.path.join(output_dir, folder))
+
+    shutil.rmtree(tmp)
+    print("Done. Missing examples:", missing_examples)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Generate events documentation")
+    parser.add_argument(
+        "destination",
+        nargs="?",
+        default="../../../../api.onlyoffice.com/site/docs/plugin-and-macros/interacting-with-editors/events/",
+        help="Output directory"
+    )
+    args = parser.parse_args()
+    generate_events(args.destination)

scripts/sdkjs_common/jsdoc/generate_docs_plugins_md_site.py

@@ -1,634 +0,0 @@
-import os
-import json
-import re
-import shutil
-import argparse
-import generate_docs_plugins_json
-
-# Configuration files
-editors = {
-    "word": "text-document-api",
-    "cell": "spreadsheet-api",
-    "slide": "presentation-api",
-    "forms": "form-api"
-}
-
-missing_examples = []
-used_enumerations = set()
-
-cur_editor_name = None
-
-_CODE_BLOCK_RE = re.compile(r'(```.*?```)', re.DOTALL)
-_QSTRING_RE    = re.compile(r'(["\'])(.*?)(?<!\\)\1', re.DOTALL)
-_BRACKET_TABLE = {ord('['): '&#91;', ord(']'): '&#93;'}
-
-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):
-    text = re.sub(r'^\s*//.*$', '', text, flags=re.MULTILINE)  # single-line
-    text = re.sub(r'/\*.*?\*/', '', text, flags=re.DOTALL)     # multi-line
-    return text.strip()
-
-def process_link_tags(text, root=''):
-    """
-    Finds patterns like {@link ...} and replaces them with Markdown links.
-    If the prefix 'global#' is found, a link to a typedef is generated,
-    otherwise, a link to a class method is created.
-    For a method, if an alias is not specified, the name is left in the format 'Class#Method'.
-    """
-    reserved_links = {
-        '/docbuilder/global#ShapeType': f"{'../../../../../../' if root == '' else '../../../../../' if root == '../' else root}docs/office-api/usage-api/text-document-api/Enumeration/ShapeType.md",
-        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/manifest/',
-        '/docbuilder/basic': 'https://api.onlyoffice.com/docs/office-api/usage-api/text-document-api/'
-    }
-
-    def replace_link(match):
-        content = match.group(1).strip()  # Example: "/docbuilder/global#ShapeType shape type" or "global#ErrorValue ErrorValue"
-        parts = content.split()
-        ref = parts[0]
-        label = parts[1] if len(parts) > 1 else None
-
-        if ref.startswith('/'):
-            # Handle reserved links using mapping
-            if ref in reserved_links:
-                url = reserved_links[ref]
-                display_text = label if label else ref
-                return f"[{display_text}]({url})"
-            else:
-                # If the link is not in the mapping, return the original construction
-                return match.group(0)
-        elif ref.startswith("global#"):
-            # Handle links to typedef (similar logic as before)
-            typedef_name = ref.split("#")[1]
-            used_enumerations.add(typedef_name)
-            display_text = label if label else typedef_name
-            return f"[{display_text}]({root}Enumeration/{typedef_name}.md)"
-        else:
-            # Handle links to class methods like ClassName#MethodName
-            try:
-                class_name, method_name = ref.split("#")
-            except ValueError:
-                return match.group(0)
-            display_text = label if label else ref  # Keep the full notation, e.g., "Api#CreateSlide"
-            return f"[{display_text}]({root}{class_name}/Methods/{method_name}.md)"
-
-    return re.sub(r'{@link\s+([^}]+)}', replace_link, text)
-
-def correct_description(string, root=''):
-    """
-    Cleans or transforms specific tags in the doclet description:
-      - <b> => ** (bold text)
-      - <note>...</note> => 💡 ...
-      - {@link ...} is replaced with a Markdown link
-      - If the description is missing, returns a default value.
-      - All '\r' characters are replaced with '\n'.
-    """
-    if string is None:
-        return 'No description provided.'
-
-    # Line breaks
-    string = string.replace('\r', '\\\n')
-    
-    # Replace <b> tags with Markdown bold formatting
-    string = re.sub(r'<b>', '-**', string)
-    string = re.sub(r'</b>', '**', string)
-    
-    # Replace <note> tags with an icon and text
-    string = re.sub(r'<note>(.*?)</note>', r'💡 \1', string, flags=re.DOTALL)
-    
-    # Process {@link ...} constructions
-    string = process_link_tags(string, root)
-    
-    return string
-
-def correct_default_value(value, enumerations, classes):
-    if value is None or value == '':
-        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)
-
-# Convert Array.<T> => T[] (including nested arrays).
-def convert_jsdoc_array_to_ts(type_str: str) -> str:
-    """
-    Recursively replaces 'Array.<T>' with 'T[]',
-    handling nested arrays like 'Array.<Array.<string>>' => 'string[][]'.
-    """
-    pattern = re.compile(r'Array\.<([^>]+)>')
-    
-    while True:
-        match = pattern.search(type_str)
-        if not match:
-            break
-        
-        inner_type = match.group(1).strip()
-        # Recursively convert inner parts
-        inner_type = convert_jsdoc_array_to_ts(inner_type)
-        
-        # Replace the outer Array.<...> with ...[]
-        type_str = (
-            type_str[:match.start()] 
-            + f"{inner_type}[]" 
-            + type_str[match.end():]
-        )
-    
-    return type_str
-
-def escape_text_outside_code_blocks(markdown: str) -> str:
-    """
-    Splits content by fenced code blocks, escapes MDX-unsafe characters
-    (<, >, {, }) only in the text outside those code blocks.
-    """
-    # A regex to capture fenced code blocks with ```
-    parts = re.split(r'(```.*?```)', markdown, flags=re.DOTALL)
-    
-    # Even indices (0, 2, 4, ...) are outside code blocks,
-    # odd indices (1, 3, 5, ...) are actual code blocks.
-    for i in range(0, len(parts), 2):
-        text = (parts[i]
-                .replace('<', '&lt;')
-                .replace('>', '&gt;')
-                .replace('{', '&#123;')
-                .replace('}', '&#125;'))
-        parts[i] = escape_brackets_in_quotes(text)
-    
-    return "".join(parts)
-
-def escape_brackets_in_quotes(text: str) -> str:
-    return re.sub(
-        r"(['\"])(.*?)(?<!\\)\1",
-        lambda m: m.group(1)
-                  + m.group(2).replace('[', r'\[').replace(']', r'\]')
-                  + m.group(1),
-        text
-    )
-
-def get_base_type(ts_type: str) -> str:
-    """
-    Given a TypeScript-like type (e.g. "Drawing[][]"), return the
-    'base' portion by stripping trailing "[]". For "Drawing[][]",
-    returns "Drawing". For "Array.<Drawing>", you'd convert it first
-    to "Drawing[]" then return "Drawing".
-    """
-    while ts_type.endswith('[]'):
-        ts_type = ts_type[:-2]
-    return ts_type
-
-def generate_data_types_markdown(types, enumerations, classes, root='../../'):
-    """
-    1) Converts each type from JSDoc (e.g., Array.<T>) to T[].
-    2) Processes union types by splitting them using '|'.
-    3) Supports multidimensional arrays, e.g., (string|ApiRange|number)[].
-    4) If the base type matches the name of an enumeration or class, generates a link.
-    5) The final types are joined using " | ".
-    """
-    # Convert each type from JSDoc format to TypeScript format (e.g., T[])
-    converted = [convert_jsdoc_array_to_ts(t) for t in types]
-
-    # Set of primitive types
-    primitive_types = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "{}"}
-
-    def is_primitive(type):
-        if (type.lower() in primitive_types or
-            (type.startswith('"') and type.endswith('"')) or
-            (type.startswith("'") and type.endswith("'")) or
-            type.replace('.', '', 1).isdigit() or
-            (type.startswith('-') and type[1:].replace('.', '', 1).isdigit())):
-            return True
-        return False
-
-    def link_if_known(ts_type):
-        ts_type = ts_type.strip()
-        # Count the number of array dimensions, e.g., "[][]" has 2 dimensions
-        array_dims = 0
-        while ts_type.endswith("[]"):
-            array_dims += 1
-            ts_type = ts_type[:-2].strip()
-
-        # Process generic types, e.g., Object.<string, editorType>
-        if ".<" in ts_type and ts_type.endswith(">"):
-            import re
-            m = re.match(r'^(.*?)\.<(.*)>$', ts_type)
-            if m:
-                base_part = m.group(1).strip()
-                generic_args_str = m.group(2).strip()
-                # Process the base part of the type
-                found = False
-                for enum in enumerations:
-                    if enum['name'] == base_part:
-                        used_enumerations.add(base_part)
-                        base_result = f"[{base_part}]({root}Enumeration/{base_part}.md)"
-                        found = True
-                        break
-                if not found:
-                    if base_part in classes:
-                        base_result = f"[{base_part}]({root}{base_part}/{base_part}.md)"
-                    elif is_primitive(base_part):
-                        base_result = base_part
-                    elif cur_editor_name == "forms":
-                        base_result = f"[{base_part}]({root}../text-document-api/{base_part}/{base_part}.md)"
-                    else:
-                        print(f"Unknown type encountered: {base_part}")
-                        base_result = base_part
-                # Split the generic parameters by commas and process each recursively
-                generic_args = [link_if_known(x) for x in generic_args_str.split(",")]
-                result = base_result + ".&lt;" + ", ".join(generic_args) + "&gt;"
-                result += "[]" * array_dims
-                return result
-
-        # Process union types: if the type is enclosed in parentheses
-        if ts_type.startswith("(") and ts_type.endswith(")"):
-            inner = ts_type[1:-1].strip()
-            subtypes = [sub.strip() for sub in inner.split("|")]
-            if len(subtypes) == 1:
-                result = link_if_known(subtypes[0])
-            else:
-                processed = [link_if_known(subtype) for subtype in subtypes]
-                result = "(" + " | ".join(processed) + ")"
-            result += "[]" * array_dims
-            return result
-
-        # If not a generic or union type – process the base type
-        else:
-            base = ts_type
-            found = False
-            for enum in enumerations:
-                if enum['name'] == base:
-                    used_enumerations.add(base)
-                    result = f"[{base}]({root}Enumeration/{base}.md)"
-                    found = True
-                    break
-            if not found:
-                if base in classes:
-                    result = f"[{base}]({root}{base}/{base}.md)"
-                elif is_primitive(base):
-                    result = base
-                elif cur_editor_name == "forms":
-                    result = f"[{base}]({root}../text-document-api/{base}/{base}.md)"
-                else:
-                    print(f"Unknown type encountered: {base}")
-                    result = base
-            result += "[]" * array_dims
-            return result
-
-    # Apply link_if_known to each converted type
-    linked = [link_if_known(ts_t) for ts_t in converted]
-
-    # Join results using " | "
-    param_types_md = r' | '.join(linked)
-    param_types_md = param_types_md.replace("|", r"\|")
-
-    # Escape remaining angle brackets for generics
-    def replace_leftover_generics(match):
-        element = match.group(1).strip()
-        return f"&lt;{element}&gt;"
-
-    param_types_md = re.sub(r'<([^<>]+)>', replace_leftover_generics, param_types_md)
-
-    return 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 += "\n## Methods\n\n"
-    content += "| Method | Returns | Description |\n"
-    content += "| ------ | ------- | ----------- |\n"
-    
-    for method in sorted(methods, key=lambda m: m['name']):
-        method_name = method['name']
-        
-        # Get the type of return values
-        returns = method.get('returns', [])
-        if returns:
-            return_type_list = returns[0].get('type', {}).get('names', [])
-            returns_markdown = generate_data_types_markdown(return_type_list, enumerations, classes, '../')
-        else:
-            returns_markdown = "None"
-        
-        # Processing the method description
-        description = remove_line_breaks(correct_description(method.get('description', 'No description provided.'), '../'))
-        
-        # Form a link to the method document
-        method_link = f"[{method_name}](./Methods/{method_name}.md)"
-        
-        content += f"| {method_link} | {returns_markdown} | {description} |\n"
-    
-    return escape_text_outside_code_blocks(content)
-
-def generate_method_markdown(method, enumerations, classes):
-    """
-    Generates Markdown for a method doclet, relying only on `method['examples']`
-    (array of strings). Ignores any single `method['example']` field.
-    """
-
-    method_name = method['name']
-    description = method.get('description', 'No description provided.')
-    description = correct_description(description, '../../')
-    params = method.get('params', [])
-    returns = method.get('returns', [])
-    memberof = method.get('memberof', '')
-
-    # Use the 'examples' array only
-    examples = method.get('examples', [])
-
-    content = f"# {method_name}\n\n{description}\n\n"
-    
-    # Syntax
-    param_list = ', '.join([param['name'] for param in params if '.' not in param['name']]) if params else ''
-    content += f"## Syntax\n\n```javascript\nexpression.{method_name}({param_list});\n```\n\n"
-    if memberof:
-        content += f"`expression` - A variable that represents a [{memberof}](../{memberof}.md) class.\n\n"
-
-    # Parameters
-    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"
-
-    # Returns
-    content += "\n## Returns\n\n"
-    if returns:
-        return_type_list = returns[0].get('type', {}).get('names', [])
-        return_type_md = generate_data_types_markdown(return_type_list, enumerations, classes)
-        content += return_type_md
-    else:
-        content += "This method doesn't return any data."
-
-    # Process examples array
-    if examples:
-        if len(examples) > 1:
-            content += "\n\n## Examples\n\n"
-        else:
-            content += "\n\n## Example\n\n"
-
-        for i, ex_line in enumerate(examples, start=1):
-            # Remove JS comments
-            cleaned_example = remove_js_comments(ex_line).strip()
-
-            # Attempt splitting if the user used ```js
-            if '```js' in cleaned_example:
-                comment, code = cleaned_example.split('```js', 1)
-                comment = comment.strip()
-                code = code.strip()
-                if len(examples) > 1:
-                    content += f"**Example {i}:**\n\n{comment}\n\n"
-                
-                content += f"```javascript\n{code}\n```\n"
-            else:
-                if len(examples) > 1:
-                    content += f"**Example {i}:**\n\n{comment}\n\n"
-                # No special fences, just show as code
-                content += f"```javascript\n{cleaned_example}\n```\n"
-
-    return escape_text_outside_code_blocks(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 sorted(properties, key=lambda m: m['name']):
-        prop_name = prop['name']
-        prop_description = prop.get('description', 'No description provided.')
-        prop_description = remove_line_breaks(correct_description(prop_description))
-        prop_types = prop['type']['names'] if prop.get('type') else []
-        param_types_md = generate_data_types_markdown(prop_types, enumerations, classes, root)
-        content += f"| {prop_name} | {param_types_md} | {prop_description} |\n"
-
-    # Escape outside code blocks
-    return escape_text_outside_code_blocks(content)
-
-def generate_enumeration_markdown(enumeration, enumerations, classes):
-    """
-    Generates Markdown documentation for a 'typedef' doclet.
-    This version only works with `enumeration['examples']` (an array of strings),
-    ignoring any single `enumeration['examples']` field.
-    """
-    enum_name = enumeration['name']
-
-    if enum_name not in used_enumerations:
-        return None
-    
-    description = enumeration.get('description', 'No description provided.')
-    description = correct_description(description, '../')
-
-    # Only use the 'examples' array
-    examples = enumeration.get('examples', [])
-
-    content = f"# {enum_name}\n\n{description}\n\n"
-
-    parsed_type = enumeration['type'].get('parsedType')
-    if not parsed_type:
-        # If parsedType is missing, just list 'type.names' if available
-        type_names = enumeration['type'].get('names', [])
-        if type_names:
-            content += "## Type\n\n"
-            t_md = generate_data_types_markdown(type_names, enumerations, classes)
-            content += t_md + "\n\n"
-    else:
-        ptype = parsed_type['type']
-
-        # 1) Handle TypeUnion
-        if ptype == 'TypeUnion':
-            content += "## Type\n\nEnumeration\n\n"
-            content += "## Values\n\n"
-            for raw_t in enumeration['type']['names']:
-                # Attempt linking
-                if any(enum['name'] == raw_t for enum in enumerations):
-                    used_enumerations.add(raw_t)
-                    content += f"- [{raw_t}](../Enumeration/{raw_t}.md)\n"
-                elif raw_t in classes:
-                    content += f"- [{raw_t}](../{raw_t}/{raw_t}.md)\n"
-                else:
-                    content += f"- {raw_t}\n"
-
-        # 2) Handle TypeApplication (e.g. Object.<string, string>)
-        elif ptype == 'TypeApplication':
-            content += "## Type\n\nObject\n\n"
-            type_names = enumeration['type'].get('names', [])
-            if type_names:
-                t_md = generate_data_types_markdown(type_names, enumerations, classes)
-                content += f"**Type:** {t_md}\n\n"
-
-        # 3) If properties are present, treat it like an object
-        if enumeration.get('properties') is not None:
-            content += generate_properties_markdown(enumeration['properties'], enumerations, classes)
-
-        # 4) If it's neither TypeUnion nor TypeApplication, just output the type names
-        if ptype not in ('TypeUnion', 'TypeApplication'):
-            type_names = enumeration['type'].get('names', [])
-            if type_names:
-                content += "## Type\n\n"
-                t_md = generate_data_types_markdown(type_names, enumerations, classes)
-                content += t_md + "\n\n"
-
-    # Process examples array
-    if examples:
-        if len(examples) > 1:
-            content += "\n\n## Examples\n\n"
-        else:
-            content += "\n\n## Example\n\n"
-
-        for i, ex_line in enumerate(examples, start=1):
-            # Remove JS comments
-            cleaned_example = remove_js_comments(ex_line).strip()
-
-            # Attempt splitting if the user used ```js
-            if '```js' in cleaned_example:
-                comment, code = cleaned_example.split('```js', 1)
-                comment = comment.strip()
-                code = code.strip()
-                if len(examples) > 1:
-                    content += f"**Example {i}:**\n\n{comment}\n\n"
-                
-                content += f"```javascript\n{code}\n```\n"
-            else:
-                if len(examples) > 1:
-                    content += f"**Example {i}:**\n\n{comment}\n\n"
-                # No special fences, just show as code
-                content += f"```javascript\n{cleaned_example}\n```\n"
-
-    return escape_text_outside_code_blocks(content)
-
-def process_doclets(data, output_dir, editor_name):
-    global cur_editor_name
-    cur_editor_name = editor_name
-
-    classes = {}
-    classes_props = {}
-    enumerations = []
-    editor_dir = os.path.join(output_dir, editors[editor_name])
-
-    for doclet in data:
-        if doclet['kind'] == 'class':
-            class_name = doclet['name']
-            if class_name:
-                if class_name not in classes:
-                    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():
-        if (len(methods) == 0):
-            continue
-
-        class_dir = os.path.join(editor_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_file_path = os.path.join(methods_dir, f"{method['name']}.md")
-            method_content = generate_method_markdown(method, enumerations, classes)
-            write_markdown_file(method_file_path, method_content)
-
-            if not method.get('examples', ''):
-                missing_examples.append(os.path.relpath(method_file_path, output_dir))
-
-    # Process enumerations
-    enum_dir = os.path.join(editor_dir, 'Enumeration')
-    os.makedirs(enum_dir, exist_ok=True)
-
-    # idle run
-    prev_used_count = -1
-    while len(used_enumerations) != prev_used_count:
-        prev_used_count = len(used_enumerations)
-        for enum in [e for e in enumerations if e['name'] in used_enumerations]:
-            enum_content = generate_enumeration_markdown(enum, enumerations, classes)
-
-    for enum in enumerations:
-        enum_file_path = os.path.join(enum_dir, f"{enum['name']}.md")
-        enum_content = generate_enumeration_markdown(enum, enumerations, classes)
-        if enum_content is None:
-            continue
-
-        write_markdown_file(enum_file_path, enum_content)
-        if not enum.get('examples', ''):
-            missing_examples.append(os.path.relpath(enum_file_path, output_dir))
-
-def generate(output_dir):
-    print('Generating Markdown documentation...')
-    
-    if output_dir[-1] == '/':
-        output_dir = output_dir[:-1]
-    
-    generate_docs_plugins_json.generate(output_dir + '/tmp_json', md=True)
-    for editor_name, folder_name in editors.items():
-        input_file = os.path.join(output_dir + '/tmp_json', editor_name + ".json")
-
-        editor_folder_path = os.path.join(output_dir, folder_name)
-        for folder_name in os.listdir(editor_folder_path):
-            folder_path_to_del = os.path.join(editor_folder_path, folder_name)
-            if os.path.isdir(folder_path_to_del):
-                shutil.rmtree(folder_path_to_del, ignore_errors=True)
-
-        data = load_json(input_file)
-        used_enumerations.clear()
-        process_doclets(data, output_dir, 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="../../../../api.onlyoffice.com/site/docs/plugin-and-macros/interacting-with-editors/methods/"  # Default value
-    )
-    args = parser.parse_args()
-    generate(args.destination)
-    print("START_MISSING_EXAMPLES")
-    print(",".join(missing_examples))
-    print("END_MISSING_EXAMPLES")

scripts/sdkjs_common/jsdoc/office-api/config/cell.json

@@ -1,6 +1,6 @@
 {
   "source": {
-    "include": ["../../../../sdkjs/word/apiBuilder.js", "../../../../sdkjs/slide/apiBuilder.js", "../../../../sdkjs/cell/apiBuilder.js"]
+    "include": ["../../../../../sdkjs/word/apiBuilder.js", "../../../../../sdkjs/slide/apiBuilder.js", "../../../../../sdkjs/cell/apiBuilder.js"]
   },
   "plugins": ["./correct_doclets.js"],
   "opts": {

scripts/sdkjs_common/jsdoc/office-api/config/forms.json

@@ -1,6 +1,6 @@
 {
   "source": {
-    "include": ["../../../../sdkjs/word/apiBuilder.js", "../../../../sdkjs-forms/apiBuilder.js"]
+    "include": ["../../../../../sdkjs/word/apiBuilder.js", "../../../../../sdkjs-forms/apiBuilder.js"]
   },
   "plugins": ["./correct_doclets.js"],
   "opts": {

scripts/sdkjs_common/jsdoc/office-api/config/pdf.json

@@ -1,6 +1,6 @@
 {
   "source": {
-    "include": ["../../../../sdkjs-forms/apiPlugins.js"]
+    "include": ["../../../../../sdkjs/pdf/apiBuilder.js"]
   },
   "plugins": ["./correct_doclets.js"],
   "opts": {

scripts/sdkjs_common/jsdoc/office-api/config/slide.json

@@ -1,6 +1,6 @@
 {
   "source": {
-    "include": ["../../../../sdkjs/word/apiBuilder.js", "../../../../sdkjs/slide/apiBuilder.js"]
+    "include": ["../../../../../sdkjs/word/apiBuilder.js", "../../../../../sdkjs/slide/apiBuilder.js"]
   },
   "plugins": ["./correct_doclets.js"],
   "opts": {

scripts/sdkjs_common/jsdoc/office-api/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/office-api/generate_docs_json.py

@@ -5,14 +5,14 @@ import argparse
 import re
 import platform
 
-root = '../../../..'
+root = '../../../../..'
 
 # Configuration files
 configs = [
-    "./config/builder/word.json",
-    "./config/builder/cell.json",
-    "./config/builder/slide.json",
-    "./config/builder/forms.json"
+    "./config/word.json",
+    "./config/cell.json",
+    "./config/slide.json",
+    "./config/forms.json"
 ]
 
 editors_maps = {

scripts/sdkjs_common/jsdoc/office-api/generate_docs_md.py

@@ -39,8 +39,8 @@ def process_link_tags(text, root=''):
     For a method, if an alias is not specified, the name is left in the format 'Class#Method'.
     """
     reserved_links = {
-        '/docbuilder/global#ShapeType': f"{'../../../' if root == '' else '../../' if root == '../' else root}text-document-api/Enumeration/ShapeType.md",
-        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/manifest/',
+        '/docbuilder/global#ShapeType': f"{'../../../../../../' if root == '' else '../../../../../' if root == '../' else root}docs/office-api/usage-api/text-document-api/Enumeration/ShapeType.md",
+        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/configuration/',
         '/docbuilder/basic': 'https://api.onlyoffice.com/docs/office-api/usage-api/text-document-api/'
     }
 
@@ -76,7 +76,7 @@ def process_link_tags(text, root=''):
 
     return re.sub(r'{@link\s+([^}]+)}', replace_link, text)
 
-def correct_description(string, root=''):
+def correct_description(string, root='', isInTable=False):
     """
     Cleans or transforms specific tags in the doclet description:
       - <b> => ** (bold text)
@@ -88,11 +88,14 @@ def correct_description(string, root=''):
     if string is None:
         return 'No description provided.'
 
-    # Line breaks
-    string = string.replace('\r', '\\\n')
+    if False == isInTable:
+        # Line breaks
+        string = string.replace('\r', '\\\n')
+        # Replace <b> tags with Markdown bold formatting
+        string = re.sub(r'<b>', '-**', string)
+    else:
+        string = re.sub(r'<b>', '**', string)
     
-    # Replace <b> tags with Markdown bold formatting
-    string = re.sub(r'<b>', '-**', string)
     string = re.sub(r'</b>', '**', string)
     
     # Replace <note> tags with an icon and text
@@ -195,7 +198,7 @@ def generate_data_types_markdown(types, enumerations, classes, root='../../'):
     converted = [convert_jsdoc_array_to_ts(t) for t in types]
 
     # Set of primitive types
-    primitive_types = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "{}"}
+    primitive_types = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "date", "{}"}
 
     def is_primitive(type):
         if (type.lower() in primitive_types or
@@ -318,7 +321,7 @@ def generate_class_markdown(class_name, methods, properties, enumerations, class
             returns_markdown = "None"
         
         # Processing the method description
-        description = remove_line_breaks(correct_description(method.get('description', 'No description provided.'), '../'))
+        description = remove_line_breaks(correct_description(method.get('description', 'No description provided.'), '../', True))
         
         # Form a link to the method document
         method_link = f"[{method_name}](./Methods/{method_name}.md)"
@@ -353,7 +356,7 @@ def generate_method_markdown(method, enumerations, classes, example_editor_name)
             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_desc = remove_line_breaks(correct_description(param.get('description', 'No description provided.'), '../../', True))
             param_required = "Required" if not param.get('optional') else "Optional"
             param_default = correct_default_value(param.get('defaultvalue', ''), enumerations, classes)
 
@@ -395,7 +398,7 @@ def generate_properties_markdown(properties, enumerations, classes, root='../'):
     for prop in sorted(properties, key=lambda m: m['name']):
         prop_name = prop['name']
         prop_description = prop.get('description', 'No description provided.')
-        prop_description = remove_line_breaks(correct_description(prop_description, root))
+        prop_description = remove_line_breaks(correct_description(prop_description, root, True))
         prop_types = prop['type']['names'] if prop.get('type') else []
         param_types_md = generate_data_types_markdown(prop_types, enumerations, classes, root)
         content += f"| {prop_name} | {param_types_md} | {prop_description} |\n"
@@ -553,8 +556,11 @@ def generate(output_dir):
     for editor_name, folder_name in editors.items():
         input_file = os.path.join(output_dir + '/tmp_json', editor_name + ".json")
 
-        shutil.rmtree(output_dir + f'/{folder_name}', ignore_errors=True)
-        os.makedirs(output_dir + f'/{folder_name}')
+        editor_folder_path = os.path.join(output_dir, folder_name)
+        for folder_name in os.listdir(editor_folder_path):
+            folder_path_to_del = os.path.join(editor_folder_path, folder_name)
+            if os.path.isdir(folder_path_to_del):
+                shutil.rmtree(folder_path_to_del, ignore_errors=True)
 
         data = load_json(input_file)
         used_enumerations.clear()
@@ -570,7 +576,7 @@ if __name__ == "__main__":
         type=str, 
         help="Destination directory for the generated documentation",
         nargs='?',  # Indicates the argument is optional
-        default="../../../../office-js-api/"  # Default value
+        default="../../../../../api.onlyoffice.com/site/docs/office-api/usage-api/"  # Default value
     )
     args = parser.parse_args()
     generate(args.destination)

scripts/sdkjs_common/jsdoc/office-api/generate_jsonl_dataset.py

@@ -21,7 +21,7 @@ editors_names = {
     "forms": "Forms"
 }
 
-root = '../../../..'
+root = '../../../../..'
 missing_examples = []
 
 def load_json(file_path):
@@ -228,7 +228,7 @@ if __name__ == "__main__":
         type=str, 
         help="Destination directory for the generated documentation",
         nargs='?',  # Indicates the argument is optional
-        default="../../../../office-js-api/dataset"  # Default value
+        default="../../../../../office-js-api/dataset"  # Default value
     )
     parser.add_argument(
         "model", 

scripts/sdkjs_common/jsdoc/plugins/config/correct_doclets.js

@@ -0,0 +1,85 @@
+exports.handlers = {
+    processingComplete: function(e) {
+        const filteredDoclets = [];
+
+        function checkNullProps(oDoclet) {
+            for (let key of Object.keys(oDoclet)) {
+                if (oDoclet[key] == null) {
+                    delete oDoclet[key];
+                }
+                if (typeof(oDoclet[key]) == "object") {
+                    checkNullProps(oDoclet[key]);
+                }
+            }
+        }
+
+        for (let i = 0; i < e.doclets.length; i++) {
+            const doclet = e.doclets[i];
+            if (true == doclet.undocumented || doclet.kind == 'package') {
+                continue;
+            }
+
+            const filteredDoclet = {
+                comment:        doclet.comment,
+
+                meta: doclet.meta ? {
+                    lineno:   doclet.meta.lineno,
+                    columnno: doclet.meta.columnno
+                } : doclet.meta,
+
+                kind:           doclet.kind,
+                since:          doclet.since,
+                name:           doclet.name,
+                type: doclet.type ? {
+                    names: doclet.type.names,
+                    parsedType: doclet.type.parsedType
+                } : doclet.type,
+
+                description:    doclet.description,
+                memberof:       doclet.memberof,
+
+                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,
+
+                longname:       doclet.longname,
+                scope:          doclet.scope,
+                alias:          doclet.alias,
+
+                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,
+                see: doclet.see
+            };
+
+            checkNullProps(filteredDoclet)
+
+            filteredDoclets.push(filteredDoclet);
+        }
+
+        e.doclets.splice(0, e.doclets.length, ...filteredDoclets);
+    }
+};

scripts/sdkjs_common/jsdoc/plugins/config/events/cell.json

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

scripts/sdkjs_common/jsdoc/plugins/config/events/common.json

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

scripts/sdkjs_common/jsdoc/plugins/config/events/forms.json

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

scripts/sdkjs_common/jsdoc/plugins/config/events/slide.json

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

scripts/sdkjs_common/jsdoc/plugins/config/events/word.json

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

scripts/sdkjs_common/jsdoc/plugins/config/methods/cell.json

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

scripts/sdkjs_common/jsdoc/plugins/config/methods/common.json

@@ -1,8 +1,8 @@
 {
   "source": {
-    "include": ["../../../../sdkjs/common/plugins/plugin_base_api.js" ,"../../../../sdkjs/common/apiBase_plugins.js"]
+    "include": ["../../../../../sdkjs/common/plugins/plugin_base_api.js" ,"../../../../../sdkjs/common/apiBase_plugins.js"]
   },
-  "plugins": ["./correct_doclets.js"],
+  "plugins": ["../correct_doclets.js"],
   "opts": {
     "destination": "./out",
     "recurse": true,

scripts/sdkjs_common/jsdoc/plugins/config/methods/forms.json

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

scripts/sdkjs_common/jsdoc/plugins/config/methods/slide.json

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

scripts/sdkjs_common/jsdoc/plugins/config/methods/word.json

@@ -1,8 +1,8 @@
 {
   "source": {
-    "include": ["../../../../sdkjs/word/api_plugins.js", "../../../../sdkjs-forms/apiPlugins.js"]
+    "include": ["../../../../../sdkjs/word/api_plugins.js", "../../../../../sdkjs-forms/apiPlugins.js"]
   },
-  "plugins": ["./correct_doclets.js"],
+  "plugins": ["../correct_doclets.js"],
   "opts": {
     "destination": "./out",
     "recurse": true,

scripts/sdkjs_common/jsdoc/plugins/generate_docs_events_json.py

@@ -0,0 +1,111 @@
+import os
+import subprocess
+import json
+import argparse
+import re
+
+# Configuration files
+configs = [
+    "./config/events/common.json",
+    "./config/events/word.json",
+    "./config/events/cell.json",
+    "./config/events/slide.json",
+    "./config/events/forms.json"
+]
+
+root = '../../../../..'
+
+def generate(output_dir, md=False):
+    if not os.path.exists(output_dir):
+        os.makedirs(output_dir)
+
+    # 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"npx jsdoc -c {config} -X > {output_file}"
+        print(f"Generating {editor_name}.json: {command}")
+        subprocess.run(command, shell=True)
+
+    common_doclets_file = os.path.join(output_dir, 'common.json')
+    with open(common_doclets_file, 'r', encoding='utf-8') as f:
+        common_doclets_json = json.dumps(json.load(f))
+    os.remove(common_doclets_file)
+    
+    # Append examples to JSON documentation
+    for config in configs:
+        if (config.find('common') != -1):
+            continue
+        
+        editor_name = config.split('/')[-1].replace('.json', '')
+        example_folder_name = editor_name # name of folder with examples
+        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)
+            start_common_doclet_idx = len(data)
+            data += json.loads(common_doclets_json)
+        
+        # Modify JSON data
+        for idx, doclet in enumerate(data):
+            if idx >= start_common_doclet_idx:
+                example_folder_name = 'common'
+            elif editor_name == 'forms':
+                example_folder_name = 'word'
+
+            if 'see' in doclet:
+                if doclet['see'] is not None:
+                    doclet['see'][0] = doclet['see'][0].replace('{Editor}', example_folder_name.title())
+                    file_path = f'{root}/' + 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
+                        
+                        doclet['examples'] = [remove_js_comments(comment) + code_content]
+                        
+                        if md == False:
+                            document_type = editor_name
+                            if "forms" == document_type:
+                                document_type = "pdf"
+                            doclet['description'] = doclet['description'] + f'\n\n## Try it\n\n ```js document-builder={{"documentType": "{document_type}"}}\n{code_content}\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 for plugin events 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()
+    
+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=f"{root}/office-js-api-declarations/office-js-api-plugins"
+    )
+    args = parser.parse_args()
+    generate(args.destination)

scripts/sdkjs_common/jsdoc/plugins/generate_docs_events_md.py

@@ -0,0 +1,380 @@
+#!/usr/bin/env python3
+import os
+import json
+import re
+import shutil
+import argparse
+import generate_docs_events_json
+
+# Папки для каждого editor_name
+editors = {
+    "word": "text-document-api",
+    "cell": "spreadsheet-api",
+    "slide": "presentation-api",
+    "forms": "form-api"
+}
+
+missing_examples = []
+used_enumerations = set()
+
+
+def load_json(path):
+    with open(path, 'r', encoding='utf-8') as f:
+        return json.load(f)
+
+
+def write_markdown_file(path, content):
+    os.makedirs(os.path.dirname(path), exist_ok=True)
+    with open(path, 'w', encoding='utf-8') as f:
+        f.write(content)
+
+
+def remove_js_comments(text):
+    text = re.sub(r'^\s*//.*$', '', text, flags=re.MULTILINE)
+    text = re.sub(r'/\*.*?\*/', '', text, flags=re.DOTALL)
+    return text.strip()
+
+
+def correct_description(string, root='', isInTable=False):
+    """
+    Cleans or transforms specific tags in the doclet description:
+      - <b> => ** (bold text)
+      - <note>...</note> => 💡 ...
+      - {@link ...} is replaced with a Markdown link
+      - If the description is missing, returns a default value.
+      - All '\r' characters are replaced with '\n'.
+    """
+    if string is None:
+        return 'No description provided.'
+
+    if False == isInTable:
+        # Line breaks
+        string = string.replace('\r', '\\\n')
+        # Replace <b> tags with Markdown bold formatting
+        string = re.sub(r'<b>', '-**', string)
+    else:
+        string = re.sub(r'<b>', '**', string)
+    
+    string = re.sub(r'</b>', '**', string)
+    
+    # Replace <note> tags with an icon and text
+    string = re.sub(r'<note>(.*?)</note>', r'💡 \1', string, flags=re.DOTALL)
+    
+    # Process {@link ...} constructions
+    string = process_link_tags(string, root)
+    
+    return string
+
+def process_link_tags(text, root=''):
+    """
+    Finds patterns like {@link ...} and replaces them with Markdown links.
+    If the prefix 'global#' is found, a link to a typedef is generated,
+    otherwise, a link to a class method is created.
+    For a method, if an alias is not specified, the name is left in the format 'Class#Method'.
+    """
+    reserved_links = {
+        '/docbuilder/global#ShapeType': f"{'../../../../../../' if root == '' else '../../../../../' if root == '../' else root}docs/office-api/usage-api/text-document-api/Enumeration/ShapeType.md",
+        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/configuration/',
+        '/docbuilder/basic': 'https://api.onlyoffice.com/docs/office-api/usage-api/text-document-api/'
+    }
+
+    def replace_link(match):
+        content = match.group(1).strip()  # Example: "/docbuilder/global#ShapeType shape type" or "global#ErrorValue ErrorValue"
+        parts = content.split()
+        ref = parts[0]
+        label = parts[1] if len(parts) > 1 else None
+
+        if ref.startswith('/'):
+            # Handle reserved links using mapping
+            if ref in reserved_links:
+                url = reserved_links[ref]
+                display_text = label if label else ref
+                return f"[{display_text}]({url})"
+            elif ref.startswith('/docs/plugins/'):
+                url = f'../../{ref.split('/docs/plugins/')[1]}.md'
+                display_text = label if label else ref
+                return f"[{display_text}]({url})"
+            else:
+                # If the link is not in the mapping, return the original construction
+                return match.group(0)
+        elif ref.startswith("global#"):
+            # Handle links to typedef (similar logic as before)
+            typedef_name = ref.split("#")[1]
+            used_enumerations.add(typedef_name)
+            display_text = label if label else typedef_name
+            return f"[{display_text}]({root}Enumeration/Event_{typedef_name}.md)"
+        else:
+            # Handle links to class methods like ClassName#MethodName
+            try:
+                class_name, method_name = ref.split("#")
+            except ValueError:
+                return match.group(0)
+            display_text = label if label else ref  # Keep the full notation, e.g., "Api#CreateSlide"
+            return f"[{display_text}]({root}{class_name}/Methods/{method_name}.md)"
+
+    return re.sub(r'{@link\s+([^}]+)}', replace_link, text)
+
+def remove_line_breaks(s):
+    return re.sub(r'[\r\n]+', ' ', s)
+
+
+def convert_jsdoc_array_to_ts(type_str):
+    p = re.compile(r'Array\.<([^>]+)>')
+    while True:
+        m = p.search(type_str)
+        if not m:
+            break
+        inner = convert_jsdoc_array_to_ts(m.group(1).strip())
+        type_str = type_str[:m.start()] + inner + '[]' + type_str[m.end():]
+    return type_str
+
+
+def generate_data_types_markdown(types, enumerations, root=''):
+    converted = [convert_jsdoc_array_to_ts(t) for t in types]
+    primitives = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "date", "{}"}
+    result = []
+    enum_names = {e['name'] for e in enumerations}
+    for t in converted:
+        base = t.rstrip('[]')
+        dims = t[len(base):]
+        if base in enum_names:
+            used_enumerations.add(base)
+            link = f"[Event_{base}]({root}../Enumeration/Event_{base}.md)"
+        elif base in primitives or re.match(r"^['\"].*['\"]$", base) or re.match(r"^-?\d+(\.\d+)?$", base):
+            link = base
+        else:
+            link = base
+        result.append(link + dims)
+    return " | ".join(result)
+
+
+def escape_text_outside_code_blocks(md):
+    parts = re.split(r'(```.*?```)', md, flags=re.DOTALL)
+    for i in range(0, len(parts), 2):
+        parts[i] = parts[i].replace('<', '&lt;').replace('>', '&gt;')
+    return "".join(parts)
+
+
+def generate_event_markdown(event, enumerations):
+    name = event['name']
+    desc = correct_description(event.get('description', ''))
+    params = event.get('params', [])
+
+    md = f"# {name}\n\n{desc}\n\n"
+
+    # Parameters
+    md += "## Parameters\n\n"
+    if params:
+        md += "| **Name** | **Data type** | **Description** |\n"
+        md += "| --------- | ------------- | ----------- |\n"
+        for p in params:
+            t_md = generate_data_types_markdown(
+                p.get('type', {}).get('names', []),
+                enumerations
+            )
+            d = remove_line_breaks(correct_description(p.get('description', ''), isInTable=True))
+            md += f"| {p['name']} | {t_md} | {d} |\n"
+        md += "\n"
+    else:
+        md += "This event has no parameters.\n\n"
+
+    for ex in event.get('examples', []):
+        code = remove_js_comments(ex).strip()
+        md += f"```javascript\n{code}\n```\n\n"
+
+    return escape_text_outside_code_blocks(md)
+
+
+def generate_enumeration_markdown(enumeration, enumerations):
+    """
+    Generates Markdown documentation for a 'typedef' doclet.
+    This version only works with `enumeration['examples']` (an array of strings),
+    ignoring any single `enumeration['examples']` field.
+    """
+    enum_name = enumeration['name']
+
+    if enum_name not in used_enumerations:
+        return None
+    
+    description = enumeration.get('description', 'No description provided.')
+    description = correct_description(description, '../')
+
+    # Only use the 'examples' array
+    examples = enumeration.get('examples', [])
+
+    content = f"# Event_{enum_name}\n\n{description}\n\n"
+
+    parsed_type = enumeration['type'].get('parsedType')
+    if not parsed_type:
+        # If parsedType is missing, just list 'type.names' if available
+        type_names = enumeration['type'].get('names', [])
+        if type_names:
+            content += "## Type\n\n"
+            t_md = generate_data_types_markdown(type_names, enumerations)
+            content += t_md + "\n\n"
+    else:
+        ptype = parsed_type['type']
+
+        # 1) Handle TypeUnion
+        if ptype == 'TypeUnion':
+            content += "## Type\n\nEnumeration\n\n"
+            content += "## Values\n\n"
+            for raw_t in enumeration['type']['names']:
+                # Attempt linking
+                if any(enum['name'] == raw_t for enum in enumerations):
+                    used_enumerations.add(raw_t)
+                    content += f"- [{raw_t}](../Enumeration/Event_{raw_t}.md)\n"
+                else:
+                    content += f"- {raw_t}\n"
+
+        # 2) Handle TypeApplication (e.g. Object.<string, string>)
+        elif ptype == 'TypeApplication':
+            content += "## Type\n\nObject\n\n"
+            type_names = enumeration['type'].get('names', [])
+            if type_names:
+                t_md = generate_data_types_markdown(type_names, enumerations)
+                content += f"**Type:** {t_md}\n\n"
+
+        # 3) If properties are present, treat it like an object
+        if enumeration.get('properties') is not None:
+            content += generate_properties_markdown(enumeration['properties'], enumerations)
+
+        # 4) If it's neither TypeUnion nor TypeApplication, just output the type names
+        if ptype not in ('TypeUnion', 'TypeApplication'):
+            type_names = enumeration['type'].get('names', [])
+            if type_names:
+                content += "## Type\n\n"
+                t_md = generate_data_types_markdown(type_names, enumerations)
+                content += t_md + "\n\n"
+
+    # Process examples array
+    if examples:
+        if len(examples) > 1:
+            content += "\n\n## Examples\n\n"
+        else:
+            content += "\n\n## Example\n\n"
+
+        for i, ex_line in enumerate(examples, start=1):
+            # Remove JS comments
+            cleaned_example = remove_js_comments(ex_line).strip()
+
+            # Attempt splitting if the user used ```js
+            if '```js' in cleaned_example:
+                comment, code = cleaned_example.split('```js', 1)
+                comment = comment.strip()
+                code = code.strip()
+                if len(examples) > 1:
+                    content += f"**Example {i}:**\n\n{comment}\n\n"
+                
+                content += f"```javascript\n{code}\n```\n"
+            else:
+                if len(examples) > 1:
+                    content += f"**Example {i}:**\n\n{comment}\n\n"
+                # No special fences, just show as code
+                content += f"```javascript\n{cleaned_example}\n```\n"
+
+    return escape_text_outside_code_blocks(content)
+
+def generate_properties_markdown(properties, enumerations):
+    if properties is None:
+        return ''
+    
+    content = "## Properties\n\n"
+    content += "| Name | Type | Description |\n"
+    content += "| ---- | ---- | ----------- |\n"
+
+    for prop in sorted(properties, key=lambda m: m['name']):
+        prop_name = prop['name']
+        prop_description = prop.get('description', 'No description provided.')
+        prop_description = remove_line_breaks(correct_description(prop_description, isInTable=True))
+        prop_types = prop['type']['names'] if prop.get('type') else []
+        param_types_md = generate_data_types_markdown(prop_types, enumerations)
+        content += f"| {prop_name} | {param_types_md} | {prop_description} |\n"
+
+    # Escape outside code blocks
+    return escape_text_outside_code_blocks(content)
+
+def clean_editor_dir(editor_dir):
+    for root, dirs, files in os.walk(editor_dir, topdown=False):
+        for file in files:
+            if not file.endswith(('.json')):
+                os.remove(os.path.join(root, file))
+        for dir in dirs:
+            dir_path = os.path.join(root, dir)
+            # remove empty folder
+            if not os.listdir(dir_path):
+                os.rmdir(dir_path)
+
+def clean_enum_files(editor_dir: str):
+    for root, _, files in os.walk(editor_dir, topdown=False):
+        for file in files:
+            if True == file.startswith('Event_') and False == file.endswith('.json'):
+                os.remove(os.path.join(root, file))
+
+def process_events(data, editor_dir):
+    enumerations = []
+    events = []
+
+    for doclet in data:
+        kind = doclet.get('kind')
+        if kind == 'typedef':
+            enumerations.append(doclet)
+        elif kind == 'event':
+            events.append(doclet)
+
+    events_dir = f'{editor_dir}/Events'
+    clean_editor_dir(events_dir)
+    os.makedirs(events_dir, exist_ok=True)
+    used_enumerations.clear()
+
+    # пишем события
+    for ev in events:
+        path = os.path.join(events_dir, f"{ev['name']}.md")
+        write_markdown_file(path, generate_event_markdown(ev, enumerations))
+        if not ev.get('examples'):
+            missing_examples.append(os.path.relpath(path, events_dir))
+
+    # пишем перечисления, используемые событиями
+    enum_dir = os.path.join(editor_dir, 'Enumeration')
+    clean_enum_files(enum_dir)
+    
+    os.makedirs(enum_dir, exist_ok=True)
+    prev = -1
+    while len(used_enumerations) != prev:
+        prev = len(used_enumerations)
+        for e in enumerations:
+            if e['name'] in used_enumerations:
+                generate_enumeration_markdown(e, enumerations)
+    for e in enumerations:
+        if e['name'] in used_enumerations:
+            path = os.path.join(enum_dir, f"Event_{e['name']}.md")
+            write_markdown_file(path, generate_enumeration_markdown(e, enumerations))
+            if not e.get('examples'):
+                missing_examples.append(os.path.relpath(path, editor_dir))
+
+
+def generate_events(output_dir):
+    if output_dir.endswith('/'):
+        output_dir = output_dir[:-1]
+    tmp = os.path.join(output_dir, 'tmp_json')
+
+    generate_docs_events_json.generate(tmp, md=True)
+
+    for editor_name, folder in editors.items():
+        data = load_json(os.path.join(tmp, f"{editor_name}.json"))
+        process_events(data, os.path.join(output_dir, folder))
+
+    shutil.rmtree(tmp)
+    print("Done. Missing examples:", missing_examples)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Generate events documentation")
+    parser.add_argument(
+        "destination",
+        nargs="?",
+        default="../../../../../api.onlyoffice.com/site/docs/plugin-and-macros/interacting-with-editors/",
+        help="Output directory"
+    )
+    args = parser.parse_args()
+    generate_events(args.destination)

scripts/sdkjs_common/jsdoc/plugins/generate_docs_methods_json.py

@@ -0,0 +1,111 @@
+import os
+import subprocess
+import json
+import argparse
+import re
+
+# Configuration files
+configs = [
+    "./config/methods/common.json",
+    "./config/methods/word.json",
+    "./config/methods/cell.json",
+    "./config/methods/slide.json",
+    "./config/methods/forms.json"
+]
+
+root = '../../../../..'
+
+def generate(output_dir, md=False):
+    if not os.path.exists(output_dir):
+        os.makedirs(output_dir)
+
+    # 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"npx jsdoc -c {config} -X > {output_file}"
+        print(f"Generating {editor_name}.json: {command}")
+        subprocess.run(command, shell=True)
+
+    common_doclets_file = os.path.join(output_dir, 'common.json')
+    with open(common_doclets_file, 'r', encoding='utf-8') as f:
+        common_doclets_json = json.dumps(json.load(f))
+    os.remove(common_doclets_file)
+    
+    # Append examples to JSON documentation
+    for config in configs:
+        if (config.find('common') != -1):
+            continue
+        
+        editor_name = config.split('/')[-1].replace('.json', '')
+        example_folder_name = editor_name # name of folder with examples
+        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)
+            start_common_doclet_idx = len(data)
+            data += json.loads(common_doclets_json)
+        
+        # Modify JSON data
+        for idx, doclet in enumerate(data):
+            if idx >= start_common_doclet_idx:
+                example_folder_name = 'common'
+            elif editor_name == 'forms':
+                example_folder_name = 'word'
+
+            if 'see' in doclet:
+                if doclet['see'] is not None:
+                    doclet['see'][0] = doclet['see'][0].replace('{Editor}', example_folder_name.title())
+                    file_path = f'{root}/' + 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
+                        
+                        doclet['examples'] = [remove_js_comments(comment) + code_content]
+                        
+                        if md == False:
+                            document_type = editor_name
+                            if "forms" == document_type:
+                                document_type = "pdf"
+                            doclet['description'] = doclet['description'] + f'\n\n## Try it\n\n ```js document-builder={{"documentType": "{document_type}"}}\n{code_content}\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 for plugin methods 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()
+    
+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=f"{root}/office-js-api-declarations/office-js-api-plugins"
+    )
+    args = parser.parse_args()
+    generate(args.destination)

scripts/sdkjs_common/jsdoc/plugins/generate_docs_methods_md.py

@@ -3,7 +3,7 @@ import json
 import re
 import shutil
 import argparse
-import generate_docs_plugins_json
+import generate_docs_methods_json
 
 # Configuration files
 editors = {
@@ -18,10 +18,6 @@ used_enumerations = set()
 
 cur_editor_name = None
 
-_CODE_BLOCK_RE = re.compile(r'(```.*?```)', re.DOTALL)
-_QSTRING_RE    = re.compile(r'(["\'])(.*?)(?<!\\)\1', re.DOTALL)
-_BRACKET_TABLE = {ord('['): '&#91;', ord(']'): '&#93;'}
-
 def load_json(file_path):
     with open(file_path, 'r', encoding='utf-8') as f:
         return json.load(f)
@@ -43,8 +39,8 @@ def process_link_tags(text, root=''):
     For a method, if an alias is not specified, the name is left in the format 'Class#Method'.
     """
     reserved_links = {
-        '/docbuilder/global#ShapeType': f"{'../../../' if root == '' else '../../' if root == '../' else root}text-document-api/Enumeration/ShapeType.md",
-        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/manifest/',
+        '/docbuilder/global#ShapeType': f"{'../../../../../' if root == '' else '../../../../' if root == '../' else root}docs/office-api/usage-api/text-document-api/Enumeration/ShapeType.md",
+        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/configuration/',
         '/docbuilder/basic': 'https://api.onlyoffice.com/docs/office-api/usage-api/text-document-api/'
     }
 
@@ -69,6 +65,9 @@ def process_link_tags(text, root=''):
             used_enumerations.add(typedef_name)
             display_text = label if label else typedef_name
             return f"[{display_text}]({root}Enumeration/{typedef_name}.md)"
+        elif ref.startswith("https"):
+            display_text = label if label else ref  # Keep the full notation, e.g., "Api#CreateSlide"
+            return f"[{display_text}]({ref})"
         else:
             # Handle links to class methods like ClassName#MethodName
             try:
@@ -80,7 +79,7 @@ def process_link_tags(text, root=''):
 
     return re.sub(r'{@link\s+([^}]+)}', replace_link, text)
 
-def correct_description(string, root=''):
+def correct_description(string, root='', isInTable=False):
     """
     Cleans or transforms specific tags in the doclet description:
       - <b> => ** (bold text)
@@ -92,11 +91,14 @@ def correct_description(string, root=''):
     if string is None:
         return 'No description provided.'
 
-    # Line breaks
-    string = string.replace('\r', '\\\n')
+    if False == isInTable:
+        # Line breaks
+        string = string.replace('\r', '\\\n')
+        # Replace <b> tags with Markdown bold formatting
+        string = re.sub(r'<b>', '-**', string)
+    else:
+        string = re.sub(r'<b>', '**', string)
     
-    # Replace <b> tags with Markdown bold formatting
-    string = re.sub(r'<b>', '-**', string)
     string = re.sub(r'</b>', '**', string)
     
     # Replace <note> tags with an icon and text
@@ -189,7 +191,7 @@ def get_base_type(ts_type: str) -> str:
         ts_type = ts_type[:-2]
     return ts_type
 
-def generate_data_types_markdown(types, enumerations, classes, root='../../'):
+def generate_data_types_markdown(types, enumerations, classes, root='../'):
     """
     1) Converts each type from JSDoc (e.g., Array.<T>) to T[].
     2) Processes union types by splitting them using '|'.
@@ -201,7 +203,7 @@ def generate_data_types_markdown(types, enumerations, classes, root='../../'):
     converted = [convert_jsdoc_array_to_ts(t) for t in types]
 
     # Set of primitive types
-    primitive_types = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "{}"}
+    primitive_types = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "date", "{}"}
 
     def is_primitive(type):
         if (type.lower() in primitive_types or
@@ -323,10 +325,10 @@ def generate_class_markdown(class_name, methods, properties, enumerations, class
             returns_markdown = "None"
         
         # Processing the method description
-        description = remove_line_breaks(correct_description(method.get('description', 'No description provided.'), '../'))
+        description = remove_line_breaks(correct_description(method.get('description', 'No description provided.'), '../', True))
         
         # Form a link to the method document
-        method_link = f"[{method_name}](./Methods/{method_name}.md)"
+        method_link = f"[{method_name}](./{method_name}.md)"
         
         content += f"| {method_link} | {returns_markdown} | {description} |\n"
     
@@ -340,7 +342,7 @@ def generate_method_markdown(method, enumerations, classes):
 
     method_name = method['name']
     description = method.get('description', 'No description provided.')
-    description = correct_description(description, '../../')
+    description = correct_description(description, '../')
     params = method.get('params', [])
     returns = method.get('returns', [])
     memberof = method.get('memberof', '')
@@ -354,7 +356,7 @@ def generate_method_markdown(method, enumerations, classes):
     param_list = ', '.join([param['name'] for param in params if '.' not in param['name']]) if params else ''
     content += f"## Syntax\n\n```javascript\nexpression.{method_name}({param_list});\n```\n\n"
     if memberof:
-        content += f"`expression` - A variable that represents a [{memberof}](../{memberof}.md) class.\n\n"
+        content += f"`expression` - A variable that represents a [{memberof}](Methods.md) class.\n\n"
 
     # Parameters
     content += "## Parameters\n\n"
@@ -365,7 +367,7 @@ def generate_method_markdown(method, enumerations, classes):
             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_desc = remove_line_breaks(correct_description(param.get('description', 'No description provided.'), '../', True))
             param_required = "Required" if not param.get('optional') else "Optional"
             param_default = correct_default_value(param.get('defaultvalue', ''), enumerations, classes)
 
@@ -421,7 +423,7 @@ def generate_properties_markdown(properties, enumerations, classes, root='../'):
     for prop in sorted(properties, key=lambda m: m['name']):
         prop_name = prop['name']
         prop_description = prop.get('description', 'No description provided.')
-        prop_description = remove_line_breaks(correct_description(prop_description))
+        prop_description = remove_line_breaks(correct_description(prop_description, isInTable=True))
         prop_types = prop['type']['names'] if prop.get('type') else []
         param_types_md = generate_data_types_markdown(prop_types, enumerations, classes, root)
         content += f"| {prop_name} | {param_types_md} | {prop_description} |\n"
@@ -521,6 +523,23 @@ def generate_enumeration_markdown(enumeration, enumerations, classes):
 
     return escape_text_outside_code_blocks(content)
 
+def clean_methods_dir(methods_dir):
+    for root, dirs, files in os.walk(methods_dir, topdown=False):
+        for file in files:
+            if not file.endswith(('.json')):
+                os.remove(os.path.join(root, file))
+        for dir in dirs:
+            dir_path = os.path.join(root, dir)
+            # remove empty folder
+            if not os.listdir(dir_path):
+                os.rmdir(dir_path)
+        
+def clean_enum_files(editor_dir: str):
+    for root, _, files in os.walk(editor_dir, topdown=False):
+        for file in files:
+            if False == file.startswith('Event_') and False == file.endswith('.json'):
+                os.remove(os.path.join(root, file))
+
 def process_doclets(data, output_dir, editor_name):
     global cur_editor_name
     cur_editor_name = editor_name
@@ -529,6 +548,10 @@ def process_doclets(data, output_dir, editor_name):
     classes_props = {}
     enumerations = []
     editor_dir = os.path.join(output_dir, editors[editor_name])
+    methods_dir = os.path.join(output_dir, editors[editor_name], 'Methods')
+
+    clean_methods_dir(methods_dir)
+    os.makedirs(methods_dir, exist_ok=True)
 
     for doclet in data:
         if doclet['kind'] == 'class':
@@ -546,36 +569,31 @@ def process_doclets(data, output_dir, editor_name):
         elif doclet['kind'] == 'typedef':
             enumerations.append(doclet)
 
-    # Process classes
-    for class_name, methods in classes.items():
-        if (len(methods) == 0):
-            continue
+    # Process api methods
+    class_name = 'Api'
+    methods = classes[class_name]
+    # Write class file
+    class_content = generate_class_markdown(
+        class_name, 
+        methods, 
+        classes_props[class_name], 
+        enumerations, 
+        classes
+    )
+    write_markdown_file(os.path.join(methods_dir, f"Methods.md"), class_content)
 
-        class_dir = os.path.join(editor_dir, class_name)
-        methods_dir = os.path.join(class_dir, 'Methods')
-        os.makedirs(methods_dir, exist_ok=True)
+    # Write method files
+    for method in methods:
+        method_file_path = os.path.join(methods_dir, f"{method['name']}.md")
+        method_content = generate_method_markdown(method, enumerations, classes)
+        write_markdown_file(method_file_path, method_content)
 
-        # 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_file_path = os.path.join(methods_dir, f"{method['name']}.md")
-            method_content = generate_method_markdown(method, enumerations, classes)
-            write_markdown_file(method_file_path, method_content)
-
-            if not method.get('examples', ''):
-                missing_examples.append(os.path.relpath(method_file_path, output_dir))
+        if not method.get('examples', ''):
+            missing_examples.append(os.path.relpath(method_file_path, output_dir))
 
     # Process enumerations
     enum_dir = os.path.join(editor_dir, 'Enumeration')
+    clean_enum_files(enum_dir)
     os.makedirs(enum_dir, exist_ok=True)
 
     # idle run
@@ -601,13 +619,10 @@ def generate(output_dir):
     if output_dir[-1] == '/':
         output_dir = output_dir[:-1]
     
-    generate_docs_plugins_json.generate(output_dir + '/tmp_json', md=True)
+    generate_docs_methods_json.generate(output_dir + '/tmp_json', md=True)
     for editor_name, folder_name in editors.items():
         input_file = os.path.join(output_dir + '/tmp_json', editor_name + ".json")
 
-        shutil.rmtree(output_dir + f'/{folder_name}', ignore_errors=True)
-        os.makedirs(output_dir + f'/{folder_name}')
-
         data = load_json(input_file)
         used_enumerations.clear()
         process_doclets(data, output_dir, editor_name)
@@ -622,7 +637,7 @@ if __name__ == "__main__":
         type=str, 
         help="Destination directory for the generated documentation",
         nargs='?',  # Indicates the argument is optional
-        default="../../../../office-js-api/plugins/"  # Default value
+        default="../../../../../api.onlyoffice.com/site/docs/plugin-and-macros/interacting-with-editors/"  # Default value
     )
     args = parser.parse_args()
     generate(args.destination)

version

@@ -1 +1 @@
-9.0.0
+9.0.3