@nocobase/plugin-backups 2.0.56

package/dist/swagger/index.json

@@ -0,0 +1,313 @@
+{
+  "openapi": "3.0.2",
+  "info": {
+    "title": "NocoBase API - Backup manager",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/backupSettings:get": {
+      "get": {
+        "description": "",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/backupSettings:update": {
+      "post": {
+        "description": "",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/backup:list": {
+      "get": {
+        "tags": ["backups"],
+        "summary": "List backup files",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/BackupFile"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backup:create": {
+      "post": {
+        "tags": ["backups"],
+        "summary": "Create a backup file",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "name": { "type": "string" },
+                    "inProgress": { "type": "boolean" }
+                  },
+                  "required": ["name", "inProgress"]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backup:status": {
+      "get": {
+        "tags": ["backups"],
+        "summary": "Get backup task status",
+        "parameters": [
+          {
+            "name": "name",
+            "in": "query",
+            "required": true,
+            "description": "Backup file name returned by `backup create`.",
+            "schema": { "type": "string" }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "$ref": "#/components/schemas/TaskStatus"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backup:download": {
+      "get": {
+        "tags": ["backups"],
+        "summary": "Download a backup file",
+        "parameters": [
+          {
+            "name": "name",
+            "in": "query",
+            "required": true,
+            "schema": { "type": "string" }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Backup file stream",
+            "content": {
+              "application/octet-stream": {
+                "schema": {
+                  "type": "string",
+                  "format": "binary"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backup:remove": {
+      "post": {
+        "tags": ["backups"],
+        "summary": "Remove a backup file",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": { "type": "string" }
+                },
+                "required": ["name"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/StatusOk"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backup:restore": {
+      "post": {
+        "tags": ["backups"],
+        "summary": "Restore from a server-side backup file",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": { "type": "string" },
+                  "password": { "type": "string" },
+                  "dbSchema": {
+                    "type": "string",
+                    "description": "Target application database schema. Required when the backup schema differs from the current application schema."
+                  },
+                  "skipRevertOnError": { "type": "boolean" },
+                  "force": {
+                    "type": "boolean",
+                    "description": "Ignore PostgreSQL database schema mismatch and restore with schema remapping."
+                  }
+                },
+                "required": ["name"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TaskCreated"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backup:restoreUpload": {
+      "post": {
+        "tags": ["backups"],
+        "summary": "Upload and restore a backup file",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "file": {
+                    "type": "string",
+                    "format": "binary"
+                  },
+                  "password": { "type": "string" },
+                  "dbSchema": {
+                    "type": "string",
+                    "description": "Target application database schema. Required when the backup schema differs from the current application schema."
+                  },
+                  "skipRevertOnError": { "type": "boolean" },
+                  "force": {
+                    "type": "boolean",
+                    "description": "Ignore PostgreSQL database schema mismatch and restore with schema remapping."
+                  }
+                },
+                "required": ["file"]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TaskCreated"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backup:restoreStatus": {
+      "get": {
+        "tags": ["backups"],
+        "summary": "Get restore task status",
+        "parameters": [
+          {
+            "name": "task",
+            "in": "query",
+            "required": true,
+            "schema": { "type": "string" }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TaskStatus"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "BackupFile": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "fileSize": { "type": "string" },
+          "createdAt": { "type": "string", "format": "date-time" },
+          "inProgress": { "type": "boolean" }
+        },
+        "additionalProperties": true
+      },
+      "StatusOk": {
+        "type": "object",
+        "properties": {
+          "status": { "type": "string", "enum": ["ok"] }
+        }
+      },
+      "TaskCreated": {
+        "type": "object",
+        "properties": {
+          "status": { "type": "string", "enum": ["ok"] },
+          "task": { "type": "string" }
+        },
+        "required": ["status", "task"]
+      },
+      "TaskStatus": {
+        "type": "object",
+        "properties": {
+          "inProgress": { "type": "boolean" },
+          "message": { "type": "string" }
+        },
+        "additionalProperties": true
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@nocobase/plugin-backups",
+  "displayName": "Backup manager",
+  "displayName.zh-CN": "备份管理器",
+  "description": "Provides backup and restore functionality, supports scheduled backups, and ensures data security and quick recovery.",
+  "description.zh-CN": "提供备份与还原功能，支持定时备份，确保数据安全与快速恢复。",
+  "version": "2.0.56",
+  "license": "Apache-2.0",
+  "main": "dist/server/index.js",
+  "nocobase": {
+    "supportedVersions": [
+      "1.x",
+      "2.x"
+    ],
+    "editionLevel": 0
+  },
+  "devDependencies": {
+    "@koa/multer": "^3.0.2",
+    "@types/ali-oss": "^6.16.11",
+    "@types/archiver": "^5.3.1",
+    "@types/file-saver": "^2.0.7",
+    "@types/yauzl": "^2.10.3",
+    "antd": "5.x",
+    "archiver": "^5.3.1",
+    "content-disposition": "^0.5.4",
+    "dayjs": "^1.11.8",
+    "decompress": "^4.2.1",
+    "inquirer": "^8.0.0",
+    "koa-send": "^5.0.1",
+    "mkdirp": "^1.0.4",
+    "object-path": "^0.11.8",
+    "react": "^18.2.0",
+    "semver": "^7.5.4",
+    "tar": "^7.5.15",
+    "yauzl": "^3.2.0"
+  },
+  "peerDependencies": {
+    "@nocobase/actions": "2.x",
+    "@nocobase/client": "2.x",
+    "@nocobase/database": "2.x",
+    "@nocobase/lock-manager": "2.x",
+    "@nocobase/plugin-file-manager": "2.x",
+    "@nocobase/server": "2.x",
+    "@nocobase/test": "2.x",
+    "@nocobase/utils": "2.x"
+  },
+  "keywords": [
+    "System management"
+  ],
+  "gitHead": "973575b72783db36a23d0dccf1365fbf535261bc"
+}

package/server.d.ts

@@ -0,0 +1,2 @@
+export * from './dist/server';
+export { default } from './dist/server';

package/server.js

@@ -0,0 +1 @@
+module.exports = require('./dist/server/index.js');