@tachybase/module-backup 0.23.8

package/dist/swagger/index.js

@@ -0,0 +1,447 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var swagger_exports = {};
+__export(swagger_exports, {
+  default: () => swagger_default
+});
+module.exports = __toCommonJS(swagger_exports);
+var swagger_default = {
+  info: {
+    title: "TachyBase API - Backup & Restore plugin"
+  },
+  tags: [],
+  paths: {
+    "/backupFiles:create": {
+      post: {
+        summary: "Create a new backup file",
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/DumpOptions"
+              }
+            }
+          }
+        },
+        responses: {
+          "200": {
+            description: "Dump successful",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    key: {
+                      type: "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backupFiles:list": {
+      get: {
+        summary: "Get backup file list",
+        parameters: [
+          {
+            name: "page",
+            in: "query",
+            description: "Page number of item to retrieve",
+            required: false,
+            schema: {
+              type: "integer",
+              format: "int32",
+              default: 1
+            }
+          },
+          {
+            name: "pageSize",
+            in: "query",
+            description: "Number of item to retrieve per page",
+            required: false,
+            schema: {
+              type: "integer",
+              format: "int32",
+              default: 10
+            }
+          }
+        ],
+        responses: {
+          "200": {
+            description: "A paged array of backup statuses",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    data: {
+                      type: "array",
+                      items: {
+                        oneOf: [
+                          {
+                            $ref: "#/components/schemas/BackUpStatusOk"
+                          },
+                          {
+                            $ref: "#/components/schemas/BackUpStatusDoing"
+                          }
+                        ]
+                      }
+                    },
+                    meta: {
+                      type: "object",
+                      properties: {
+                        page: {
+                          type: "integer",
+                          format: "int32"
+                        },
+                        pageSize: {
+                          type: "integer",
+                          format: "int32"
+                        },
+                        count: {
+                          type: "integer",
+                          format: "int64"
+                        },
+                        totalPage: {
+                          type: "integer",
+                          format: "int32"
+                        }
+                      }
+                    }
+                  },
+                  required: ["data", "meta"]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backupFiles:get": {
+      get: {
+        summary: "Get backup file info",
+        parameters: [
+          {
+            name: "filterByTk",
+            in: "query",
+            required: true,
+            schema: {
+              type: "string"
+            }
+          }
+        ],
+        responses: {
+          "200": {
+            description: "Status of the backup operation",
+            content: {
+              "application/json": {
+                schema: {
+                  oneOf: [
+                    {
+                      $ref: "#/components/schemas/BackUpStatusOk"
+                    },
+                    {
+                      $ref: "#/components/schemas/BackUpStatusDoing"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backupFiles:download": {
+      get: {
+        summary: "Download a backup file",
+        parameters: [
+          {
+            name: "filterByTk",
+            in: "query",
+            required: true,
+            schema: {
+              type: "string"
+            }
+          }
+        ],
+        responses: {
+          "200": {
+            description: "Download successful",
+            content: {
+              "application/octet-stream": {
+                schema: {
+                  type: "string",
+                  format: "binary"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backupFiles:destroy": {
+      post: {
+        summary: "Destroy a backup file",
+        parameters: [
+          {
+            name: "filterByTk",
+            in: "query",
+            required: true,
+            schema: {
+              type: "string"
+            }
+          }
+        ],
+        responses: {
+          "200": {
+            description: "Destroy successful",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    status: {
+                      type: "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backupFiles:upload": {
+      post: {
+        summary: "Upload a backup file",
+        requestBody: {
+          required: true,
+          content: {
+            "multipart/form-data": {
+              schema: {
+                type: "object",
+                properties: {
+                  file: {
+                    type: "string",
+                    format: "binary"
+                  }
+                }
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            description: "Upload successful",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    key: {
+                      type: "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backupFiles:restore": {
+      post: {
+        summary: "Restore from a backup file",
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  filterByTk: {
+                    type: "string"
+                  },
+                  dataTypes: {
+                    type: "array",
+                    items: {
+                      $ref: "#/components/schemas/DumpDataType"
+                    },
+                    uniqueItems: true
+                  },
+                  key: {
+                    type: "string"
+                  }
+                },
+                oneOf: [
+                  {
+                    required: ["filterByTk", "dataTypes"]
+                  },
+                  {
+                    required: ["key", "dataTypes"]
+                  }
+                ]
+              }
+            }
+          }
+        },
+        responses: {
+          "200": {
+            description: "Restore successful",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    status: {
+                      type: "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/backupFiles:dumpableCollections": {
+      get: {
+        summary: "Get dumpable collections",
+        responses: {
+          "200": {
+            description: "A list of dumpable collections",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    meta: {
+                      type: "array",
+                      items: {
+                        type: "object",
+                        properties: {
+                          name: {
+                            type: "string"
+                          },
+                          title: {
+                            type: "string"
+                          }
+                        }
+                      }
+                    },
+                    config: {
+                      type: "array",
+                      items: {
+                        type: "object",
+                        properties: {
+                          name: {
+                            type: "string"
+                          },
+                          title: {
+                            type: "string"
+                          }
+                        }
+                      }
+                    },
+                    business: {
+                      type: "array",
+                      items: {
+                        type: "object",
+                        properties: {
+                          name: {
+                            type: "string"
+                          },
+                          title: {
+                            type: "string"
+                          }
+                        }
+                      }
+                    }
+                  },
+                  required: ["meta", "config", "business"]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  components: {
+    schemas: {
+      BackUpStatusOk: {
+        type: "object",
+        properties: {
+          name: {
+            type: "string"
+          },
+          createdAt: {
+            type: "string",
+            format: "date-time"
+          },
+          fileSize: {
+            type: "string"
+          },
+          status: {
+            type: "string",
+            enum: ["ok"]
+          }
+        },
+        required: ["name", "createdAt", "fileSize", "status"]
+      },
+      BackUpStatusDoing: {
+        type: "object",
+        properties: {
+          name: {
+            type: "string"
+          },
+          inProgress: {
+            type: "boolean",
+            enum: [true]
+          },
+          status: {
+            type: "string",
+            enum: ["in_progress"]
+          }
+        },
+        required: ["name", "inProgress", "status"]
+      },
+      DumpDataType: {
+        type: "string",
+        enum: ["meta", "config", "business"]
+      },
+      DumpOptions: {
+        type: "object",
+        properties: {
+          dataTypes: {
+            type: "array",
+            items: {
+              $ref: "#/components/schemas/DumpDataType"
+            },
+            uniqueItems: true
+          }
+        },
+        required: ["dataTypes"]
+      }
+    }
+  }
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@tachybase/module-backup",
+  "displayName": "App backup & restore",
+  "version": "0.23.8",
+  "description": "Backup and restore applications for scenarios such as application replication, migration, and upgrades.",
+  "keywords": [
+    "System management"
+  ],
+  "license": "Apache-2.0",
+  "main": "./dist/server/index.js",
+  "devDependencies": {
+    "@ant-design/icons": "^5.5.2",
+    "@hapi/topo": "^6.0.2",
+    "@types/archiver": "^5.3.4",
+    "@types/file-saver": "^2.0.7",
+    "@types/lodash": "4.17.13",
+    "antd": "5.22.5",
+    "archiver": "^5.3.2",
+    "content-disposition": "^0.5.4",
+    "dayjs": "1.11.13",
+    "decompress": "^4.2.1",
+    "file-saver": "^2.0.5",
+    "inquirer": "^8.2.6",
+    "koa-send": "^5.0.1",
+    "lodash": "4.17.21",
+    "mkdirp": "^1.0.4",
+    "object-path": "^0.11.8",
+    "react": "^18.3.1",
+    "react-i18next": "^15.2.0",
+    "semver": "^7.6.3",
+    "tar": "^6.2.1",
+    "@tachybase/components": "0.23.8",
+    "@tachybase/module-worker-thread": "0.23.8"
+  },
+  "peerDependencies": {
+    "@tachybase/actions": "0.23.8",
+    "@tachybase/test": "0.23.8",
+    "@tachybase/server": "0.23.8",
+    "@tachybase/client": "0.23.8",
+    "@tachybase/utils": "0.23.8",
+    "@tachybase/database": "0.23.8"
+  },
+  "description.zh-CN": "备份和还原应用，可用于应用的复制、迁移、升级等场景。",
+  "displayName.zh-CN": "应用的备份与还原",
+  "scripts": {
+    "build": "tachybase-build --no-dts @tachybase/module-backup"
+  }
+}

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');