spire.officejs-service-win-ve 1.0.2

package/README.md

@@ -0,0 +1,70 @@
+# spire.officejs-service-win
+
+The `spire.officejs-service-win` package provides the **Spire.OfficeJS backend server service** for **Windows (x64)** platforms. It is the server-side companion to the [Spire.OfficeJS](https://www.e-iceblue.com/Introduce/spire-office-js.html) front-end library, enabling document processing capabilities such as collaborative editing and persistent storage on Windows systems.
+
+## What's Included
+
+- **Native Server Binary** — `officeserver-win.exe`, the core Office document server compiled for Windows x64
+- **SQLite Native Addon** — `node_sqlite3.node` for local data persistence
+- **Default Configuration** — pre-configured server settings (port, storage, logging, database, security, etc.)
+- **Auto-Config Setup** — a postinstall script that copies the default configuration to your project root as `spire.officejs-server-config.json`
+
+## Installation
+
+```bash
+npm install spire.officejs-service-win
+```
+
+During installation, the postinstall script will automatically copy a default server configuration file (`spire.officejs-server-config.json`) to your project root. If the file already exists, it will not be overwritten — this prevents accidental overwrites of your custom configuration.
+
+## Platform Support
+
+| Platform | Architecture | Package |
+|----------|-------------|---------|
+| Windows  | x64         | `spire.officejs-service-win` |
+| Linux    | x64         | `spire.officejs-service-linux` |
+| Linux    | ARM         | `spire.officejs-service-arm` |
+
+## Running the Server: Development vs Production
+
+The `run_servers.bat` script — the runtime environment is entirely controlled by the `spire.officejs-server-config.json` configuration file. The workflow for both environments is: **configure first, then run**.
+
+### Development Environment
+
+**Step 1 — Prepare the development config**
+
+Edit `spire.officejs-server-config.json` in your project root．
+
+**Step 2 — Start the server**
+
+Run your project　in development environment．
+
+
+**Step 3 — Stop the server**
+
+stop your project　in development environment．
+
+
+### Production Environment
+
+**Step 1 — Prepare the production config**
+
+Before building, edit `spire.officejs-server-config.json` in your project root and ensure the following production settings are properly configured:
+
+**Step 2 — Start the server**
+
+Switch the directory to `/dist/spire.officejs/service`, double-click `run_servers.bat` to launch the server. The script starts `officeserver-win.exe` as a background process. 
+
+**Step 3 — Stop the server**
+
+To stop the server in production:
+
+- If the server was launched via `run_servers.bat` interactively, close the console window or press `Ctrl + C` in the terminal where it is running.
+- If the server is running as a background process, open **Task Manager**, locate `officeserver-win.exe`, and end the task.
+- For unattended deployments (e.g., Windows Service), stop the service via `services.msc` or `sc stop <service-name>`.
+
+## Getting More Help
+
+- Visit the Spire.OfficeJS home page: [https://www.e-iceblue.com/Introduce/spire-office-js.html](https://www.e-iceblue.com/Introduce/spire-office-js.html)
+- Forum: [https://www.e-iceblue.com/forum/](https://www.e-iceblue.com/forum/)
+- Temporary License: [https://www.e-iceblue.com/TemLicense.html](https://www.e-iceblue.com/TemLicense.html)

package/index.d.ts

@@ -0,0 +1 @@
+export default {}

package/index.js

@@ -0,0 +1 @@
+export default {}

package/lib/OfficeServer/config/default.json

@@ -0,0 +1,261 @@
+{
+	"StatsdInformation": {
+		"useMetrics": false,
+		"host": "127.0.0.1",
+		"port": "8125",
+		"prefix": "ds."
+	},
+	"LogInformation": {
+		"filePath": "./config/log4js/production.json",
+		"options": {
+			"replaceConsole": true
+		}
+	},
+	"RabbitmqQueue": {
+		"type": "rabbitmq",
+		"visibilityTimeout": 300,
+		"retentionPeriod": 900
+
+	},
+	"StorageInformation": {
+		"fs": {
+			"folderPath": "../../../storage/App_Data/cache/files",
+			"urlExpires": 2592000,
+			"secretString": "officecloud"
+		},
+		"region": "",
+		"endpoint": "http://127.0.0.1/s3",
+		"bucketName": "cache",
+		"storageFolderName": "files",
+		"urlExpires": 604800,
+		"accessKeyId": "AKID",
+		"secretAccessKey": "SECRET",
+		"useRequestToGetUrl": false,
+		"useSignedUrl": false,
+		"externalHost": null
+	},
+	"DnscacheInformation": {
+		"enable": true,
+		"ttl": 300,
+		"cachesize": 1000
+	},
+	"ServicesInformation": {
+		"OfficeServer": {
+			"server": {
+				"port": 8000,
+				"workerpercpu": 1,
+				"mode": "development",
+				"limitsTempfileUpload": 10485760000,
+				"limitsImageSize": 26214400,
+				"limitsMediaSize": 104857600,
+				"limitsImageDownloadTimeout": {
+					"connectionAndInactivity": "10s",
+					"wholeCycle": "2m"
+				},
+				"limitsMediaDownloadTimeout": {
+					"connectionAndInactivity": "10s",
+					"wholeCycle": "2m"
+				},
+				"callbackRequestTimeout": {
+					"wholeCycle": "2m"
+				},
+				"healthcheckfilepath": "../../public/healthcheck.docx",
+				"savetimeoutdelay": 5000,
+				"edit_singleton": false,
+				"forgottenfiles": "forgotten",
+				"forgottenfilesname": "output",
+				"maxRequestChanges": 20000,
+				"openProtectedFile": true,
+				"editorDataStorage": "editorDataMemory",
+				"customeTokenKey": "",
+				"whiteList": "*",
+				"defineToolbar": true
+			},
+			"requestDefaults": {
+				"headers": {
+					"User-Agent": "Node.js/6.13"
+				},
+				"rejectUnauthorized": true
+			},
+			"autoAssembly": {
+				"enable": false,
+				"interval": "5m",
+				"step": "1m"
+			},
+			"utils": {
+				"utilsCommonFontDir": "../../../../fontsweb",
+				"utilsFontsSearchPatterns": "*.ttf;*.ttc;*.otf;*.gz",
+				"resourceExpires": 31536000,
+				"limitsImageTypesUpload": "jpg;png;gif;bmp",
+				"limitsMediaTypesUpload": "mp4;avi;mov;flv;rmvb;3gp",
+				"limitsImageTypesCopy": "jpg;png;gif;bmp;svg"
+			},
+            "sqlite3": {
+              "path": "../../data/spire_cloud_task_result.db",
+              "tableChanges": "doc_changes",
+              "tableResult": "task_result",
+              "max_allowed_packet": "1048575"
+            },
+			"sql": {
+				"type": "mysql",
+				"dbHost": "127.0.0.1",
+				"dbPort": 3306,
+				"dbUser": "root",
+				"dbPass": "",
+				"charset": "utf8",
+				"connectionlimit": 10,
+				"max_allowed_packet": 1048575,
+				"dbName": "officecloud",
+				"tableChanges": "doc_changes",
+				"tableResult": "task_result",
+				"customer_count_table": "jos_cloud_app_count",
+				"customer_history_table": "jos_use_lists",
+				"customer_item_table": "jos_cloud_app_items"
+			},
+			"redis": {
+				"name": "redis",
+				"prefix": "ds:",
+				"host": "192.168.1.62",
+				"port": 6379,
+				"password": "e-iceblue601",
+				"timeout": 86400,
+				"useMongoDb":true
+			},
+			"mongodb": {
+				"url": "192.168.0.176",
+				"dbName": "admin",
+				"port": 27017,
+				"timeOut": "86400"
+			},
+			"pubsub": {
+				"name": "pubsubRabbitMQ",
+				"maxChanges": 1000
+			},
+			"expire": {
+				"saveLock": 60,
+				"presence": 300,
+				"locks": 604800,
+				"changeindex": 86400,
+				"lockDoc": 60,
+				"message": 86400,
+				"lastsave": 604800,
+				"forcesave": 604800,
+				"saved": 3600,
+				"autosave_interval": 600000,
+				"documentsCron": "0 */2 * * * *",
+				"files": 86400,
+				"filesCron": "00 00 */1 * * *",
+				"filesremovedatonce": 100,
+				"sessionidle": "0",
+				"sessionabsolute": "30d",
+				"sessionclosecommand": "2m",
+				"pemStdTTL": "1h",
+				"pemCheckPeriod": "10m",
+				"updateVersionStatus": "5m",
+				"filesCacheCron": "0 */2 * * *",
+				"filesCache": 7
+			},
+			"ipfilter": {
+				"rules": [
+					{
+						"address": "*",
+						"allowed": true
+					}
+				],
+				"useforrequest": false,
+				"errorcode": 403
+			},
+			"secret": {
+				"browser": {
+					"string": "secret",
+					"file": "",
+					"tenants": {}
+				},
+				"inbox": {
+					"string": "secret",
+					"file": "",
+					"tenants": {}
+				},
+				"outbox": {
+					"string": "secret",
+					"file": ""
+				},
+				"session": {
+					"string": "secret",
+					"file": ""
+				}
+			},
+			"token": {
+				"enable": {
+					"browser": false,
+					"request": {
+						"inbox": false,
+						"outbox": false
+					}
+				},
+				"browser": {
+					"secretFromInbox": true
+				},
+				"inbox": {
+					"header": "Authorization",
+					"prefix": "Bearer ",
+					"inBody": false
+				},
+				"outbox": {
+					"header": "Authorization",
+					"prefix": "Bearer ",
+					"algorithm": "HS256",
+					"expires": "5m",
+					"inBody": false
+				},
+				"session": {
+					"algorithm": "HS256",
+					"expires": "30d"
+				}
+			},
+			"plugins": {
+				"uri": "/sdkjs-plugins",
+				"autostart": []
+			},
+			"editor": {
+				"spellcheckerUrl": "/spellchecker",
+				"reconnection": {
+					"attempts": 50,
+					"delay": "2s"
+				},
+				"websocketMaxPayloadSize": "1.5MB"
+			},
+			"sockjs": {
+				"sockjs_url": "",
+				"websocket": true
+			},
+			"callbackBackoffOptions": {
+				"retries": 0,
+				"timeout": {
+					"factor": 2,
+					"minTimeout": 1000,
+					"maxTimeout": 2147483647,
+					"randomize": false
+				},
+				"httpStatus": "429,500-599"
+			}
+		}
+	},
+	"LicenseInformation": {
+		"license_file": "",
+		"warning_limit_percents": 70
+		
+	},
+	"storage": {
+		"host": "",
+		"port": 4567,
+		"directory": "",
+		"silent": true
+	},
+	"SpellChecker": {
+		"server": {
+			"port": 8080,
+			"mode": "development"
+		}
+	}
+}

package/lib/OfficeServer/config/log4js/development.json

@@ -0,0 +1,14 @@
+{
+	"appenders": {
+		"default": {
+			"type": "console",
+			"layout": {
+				"type": "pattern",
+				"pattern": "%[[%d] [%p] %c -%] %.10000m"
+			}
+		}
+	},
+	"categories": {
+		"default": { "appenders": [ "default" ], "level": "ALL" }
+	}
+}

package/lib/OfficeServer/config/log4js/production.json

@@ -0,0 +1,124 @@
+{
+	"appenders": {
+		"stdout": {
+			"type": "console"
+		},
+		"alllogs": {
+			"type": "dateFile",
+			"filename": "../../logs/alllogs",
+			"pattern": ".yyyy-MM-dd.log",
+			"alwaysIncludePattern": true,
+			"compress": true,
+			"layout": {
+				"type": "pattern",
+				"pattern": "[%d{yyyy-MM-dd hh:mm:ss} %5.5p] %m"
+			}
+		},
+		"errorlogs": {
+			"type": "dateFile",
+			"filename": "../../logs/errorlogs",
+			"pattern": ".yyyy-MM-dd.log",
+			"alwaysIncludePattern": true,
+			"compress": true,
+			"layout": {
+				"type": "pattern",
+				"pattern": "[%d{yyyy-MM-dd hh:mm:ss} %5.5p] %m"
+			}
+		},
+		"onlyerrors": {
+			"type": "logLevelFilter",
+			"appender": "errorlogs",
+			"level": "error"
+		},
+		"officeservice-alllogs": {
+			"type": "dateFile",
+			"filename": "../../logs/office/officeservice-alllogs",
+			"pattern": ".yyyy-MM-dd.log",
+			"alwaysIncludePattern": true,
+			"compress": true,
+			"layout": {
+				"type": "pattern",
+				"pattern": "[%d{yyyy-MM-dd hh:mm:ss} %5.5p] %m"
+			}
+		},
+		"officeservice-errorlogs": {
+			"type": "dateFile",
+			"filename": "../../logs/office/officeservice-errorlogs",
+			"pattern": ".yyyy-MM-dd.log",
+			"alwaysIncludePattern": true,
+			"compress": true,
+			"layout": {
+				"type": "pattern",
+				"pattern": "[%d{yyyy-MM-dd hh:mm:ss} %5.5p] %m"
+			}
+		},
+		"officeservice-onlyerrors": {
+			"type": "logLevelFilter",
+			"appender": "officeservice-errorlogs",
+			"level": "error"
+		},
+		"cleancacheservice-alllogs": {
+			"type": "dateFile",
+			"filename": "../../logs/cleancache/cleancacheservice-alllogs",
+			"pattern": ".yyyy-MM-dd.log",
+			"alwaysIncludePattern": true,
+			"compress": true,
+			"layout": {
+				"type": "pattern",
+				"pattern": "[%d{yyyy-MM-dd hh:mm:ss} %5.5p] %m"
+			}
+		},
+		"cleancacheservice-errorlogs": {
+			"type": "dateFile",
+			"filename": "../../logs/cleancache/cleancacheservice-errorlogs",
+			"pattern": ".yyyy-MM-dd.log",
+			"alwaysIncludePattern": true,
+			"compress": true,
+			"layout": {
+				"type": "pattern",
+				"pattern": "[%d{yyyy-MM-dd hh:mm:ss} %5.5p] %m"
+			}
+		},
+		"cleancacheservice-onlyerrors": {
+			"type": "logLevelFilter",
+			"appender": "cleancacheservice-errorlogs",
+			"level": "error"
+		}
+	},
+	"categories": {
+		"default": {
+			"appenders": [
+				"stdout"
+			],
+			"level": "all"
+		},
+		"nodeJS": {
+			"appenders": [
+				"onlyerrors",
+				"alllogs"
+			],
+			"level": "debug"
+		},
+		"officeService": {
+			"appenders": [
+				"officeservice-onlyerrors",
+				"officeservice-alllogs"
+			],
+			"level": "debug"
+		},
+		"cleancacheService": {
+			"appenders": [
+				"cleancacheservice-onlyerrors",
+				"cleancacheservice-alllogs"
+			],
+			"level": "debug"
+		},
+		"scheduleService": {
+			"appenders": [
+				"cleancacheservice-onlyerrors",
+				"cleancacheservice-alllogs"
+			],
+			"level": "debug"
+		}
+	}
+}

package/lib/run_servers.bat

@@ -0,0 +1,8 @@
+@echo off
+SET CMDDIR=%~dp0
+SET serverServerDir=%CMDDIR%OfficeServer\
+ 
+cd %serverServerDir%
+start "" "officeserver-win.exe"
+
+

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "spire.officejs-service-win-ve",
+  "version": "1.0.2",
+  "description": "",
+  "main": "index.js",
+  "typings": "index.d.ts",
+  "scripts": {
+    "postinstall": "node scripts/copy-config.js"
+  },
+  "keywords": [
+    "Spire.OfficeJS",
+    "windows"
+  ],
+  "author": "",
+  "license": "MIT"
+}

package/scripts/copy-config.js

@@ -0,0 +1,40 @@
+const fs = require('fs');
+const path = require('path');
+
+// 源文件路径：位于当前包内
+const srcFilePath = path.join(__dirname, '../lib/OfficeServer/config/default.json');
+// const srcFilePath2 = path.join(__dirname, '../lib/OfficeServer/sources/config/default.json');
+// 目标路径：用户执行 npm install 的目录（项目根目录）
+const initCwd = process.env.INIT_CWD || process.cwd();
+// const targetDir = path.join(initCwd, 'spire.officejs-config');
+const destFileName = 'spire.officejs-server-config.json'
+const destFilePath = path.join(initCwd, destFileName);
+
+function main() {
+    try {
+        // let filePath = srcFilePath;
+
+        // if (fs.existsSync(srcFilePath))
+        //     filePath = srcFilePath;
+        // else if (fs.existsSync(srcFilePath2))
+        //     filePath = srcFilePath2;
+
+        // 检查源文件是否存在   
+        if (!fs.existsSync(srcFilePath))
+            return;
+
+        // 检查目标文件是否已存在，避免覆盖用户自定义配置
+        if (fs.existsSync(destFilePath))
+            return;
+
+        // // 确保目标目录存在
+        // ensureDirectoryExists(targetDir);
+
+        // 复制配置文件
+        fs.copyFileSync(srcFilePath, destFilePath);
+    } catch (error) {
+        console.error(error)
+    }
+}
+
+main();