@nocobase/plugin-user-data-sync 1.4.0-alpha

package/dist/server/actions/user-data.js

@@ -0,0 +1,64 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+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 user_data_exports = {};
+__export(user_data_exports, {
+  default: () => user_data_default
+});
+module.exports = __toCommonJS(user_data_exports);
+var import_plugin = require("../plugin");
+var user_data_default = {
+  listSyncTypes: async (ctx, next) => {
+    const plugin = ctx.app.pm.get(import_plugin.PluginUserDataSyncServer);
+    ctx.body = plugin.sourceManager.listTypes();
+    await next();
+  },
+  pull: async (ctx, next) => {
+    const { name } = ctx.action.params;
+    const plugin = ctx.app.pm.get(import_plugin.PluginUserDataSyncServer);
+    await plugin.syncService.pull(name, ctx);
+    await next();
+  },
+  push: async (ctx, next) => {
+    const data = ctx.action.params.values || {};
+    const plugin = ctx.app.pm.get(import_plugin.PluginUserDataSyncServer);
+    try {
+      const result = await plugin.syncService.push(data);
+      ctx.body = { code: 0, message: "success", result };
+    } catch (error) {
+      ctx.status = 500;
+      ctx.body = { code: 500, message: error.message };
+      return;
+    }
+    await next();
+  },
+  retry: async (ctx, next) => {
+    const { sourceId, id } = ctx.action.params;
+    const plugin = ctx.app.pm.get(import_plugin.PluginUserDataSyncServer);
+    await plugin.syncService.retry(sourceId, id, ctx);
+    await next();
+  }
+};

package/dist/server/collections/user-data-sync-records-resources.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+declare const _default: import("@nocobase/database").CollectionOptions;
+export default _default;

package/dist/server/collections/user-data-sync-records-resources.js

@@ -0,0 +1,54 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+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 user_data_sync_records_resources_exports = {};
+__export(user_data_sync_records_resources_exports, {
+  default: () => user_data_sync_records_resources_default
+});
+module.exports = __toCommonJS(user_data_sync_records_resources_exports);
+var import_database = require("@nocobase/database");
+var user_data_sync_records_resources_default = (0, import_database.defineCollection)({
+  name: "userDataSyncRecordsResources",
+  fields: [
+    {
+      name: "recordId",
+      type: "bigInt",
+      interface: "id"
+    },
+    {
+      name: "resource",
+      interface: "Select",
+      type: "string",
+      allowNull: false
+    },
+    {
+      name: "resourcePk",
+      interface: "Input",
+      type: "string",
+      allowNull: true
+    }
+  ]
+});

package/dist/server/collections/user-data-sync-records.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+declare const _default: import("@nocobase/database").CollectionOptions;
+export default _default;

package/dist/server/collections/user-data-sync-records.js

@@ -0,0 +1,85 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+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 user_data_sync_records_exports = {};
+__export(user_data_sync_records_exports, {
+  default: () => user_data_sync_records_default
+});
+module.exports = __toCommonJS(user_data_sync_records_exports);
+var import_database = require("@nocobase/database");
+var user_data_sync_records_default = (0, import_database.defineCollection)({
+  dumpRules: {
+    group: "third-party"
+  },
+  shared: true,
+  name: "userDataSyncRecords",
+  createdAt: true,
+  updatedAt: true,
+  logging: true,
+  fields: [
+    {
+      name: "id",
+      type: "bigInt",
+      autoIncrement: true,
+      primaryKey: true,
+      allowNull: false,
+      interface: "id"
+    },
+    {
+      name: "sourceName",
+      interface: "Input",
+      type: "string",
+      allowNull: false
+    },
+    {
+      name: "sourceUk",
+      interface: "Input",
+      type: "string",
+      allowNull: false
+    },
+    {
+      name: "dataType",
+      interface: "Select",
+      type: "string",
+      allowNull: false
+    },
+    {
+      name: "resources",
+      type: "hasMany",
+      target: "userDataSyncRecordsResources",
+      sourceKey: "id",
+      foreignKey: "recordId"
+    },
+    {
+      type: "json",
+      name: "metaData"
+    },
+    {
+      type: "json",
+      name: "lastMetaData"
+    }
+  ]
+});

package/dist/server/collections/user-data-sync-sources.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+declare const _default: import("@nocobase/database").CollectionOptions;
+export default _default;

package/dist/server/collections/user-data-sync-sources.js

@@ -0,0 +1,109 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+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 user_data_sync_sources_exports = {};
+__export(user_data_sync_sources_exports, {
+  default: () => user_data_sync_sources_default
+});
+module.exports = __toCommonJS(user_data_sync_sources_exports);
+var import_database = require("@nocobase/database");
+var user_data_sync_sources_default = (0, import_database.defineCollection)({
+  dumpRules: {
+    group: "third-party"
+  },
+  shared: true,
+  name: "userDataSyncSources",
+  title: '{{t("Sync Sources")}}',
+  sortable: true,
+  model: "SyncSourceModel",
+  createdBy: true,
+  updatedBy: true,
+  logging: true,
+  fields: [
+    {
+      name: "id",
+      type: "bigInt",
+      autoIncrement: true,
+      primaryKey: true,
+      allowNull: false,
+      interface: "id"
+    },
+    {
+      interface: "input",
+      type: "string",
+      name: "name",
+      allowNull: false,
+      unique: true,
+      uiSchema: {
+        type: "string",
+        title: '{{t("Source name")}}',
+        "x-component": "Input",
+        required: true
+      }
+    },
+    {
+      interface: "input",
+      type: "string",
+      name: "sourceType",
+      allowNull: false,
+      uiSchema: {
+        type: "string",
+        title: '{{t("Source Type")}}',
+        "x-component": "Input",
+        required: true
+      }
+    },
+    {
+      interface: "input",
+      type: "string",
+      name: "displayName",
+      uiSchema: {
+        type: "string",
+        title: '{{t("Source display name")}}',
+        "x-component": "Input"
+      },
+      translation: true
+    },
+    {
+      type: "boolean",
+      name: "enabled",
+      defaultValue: false
+    },
+    {
+      type: "json",
+      name: "options",
+      allowNull: false,
+      defaultValue: {}
+    },
+    {
+      type: "hasMany",
+      name: "tasks",
+      target: "userDataSyncTasks",
+      sourceKey: "id",
+      foreignKey: "sourceId"
+    }
+  ]
+});

package/dist/server/collections/user-data-sync-tasks.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+declare const _default: import("@nocobase/database").CollectionOptions;
+export default _default;

package/dist/server/collections/user-data-sync-tasks.js

@@ -0,0 +1,131 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+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 user_data_sync_tasks_exports = {};
+__export(user_data_sync_tasks_exports, {
+  default: () => user_data_sync_tasks_default
+});
+module.exports = __toCommonJS(user_data_sync_tasks_exports);
+var import_database = require("@nocobase/database");
+var user_data_sync_tasks_default = (0, import_database.defineCollection)({
+  dumpRules: {
+    group: "third-party"
+  },
+  name: "userDataSyncTasks",
+  title: '{{t("Sync Tasks")}}',
+  sortable: "sort",
+  model: "SyncTaskModel",
+  createdBy: true,
+  updatedBy: true,
+  createdAt: true,
+  updatedAt: true,
+  logging: true,
+  shared: true,
+  fields: [
+    {
+      name: "id",
+      type: "bigInt",
+      autoIncrement: true,
+      primaryKey: true,
+      allowNull: false,
+      interface: "id"
+    },
+    {
+      name: "batch",
+      interface: "input",
+      type: "string",
+      allowNull: false,
+      unique: true,
+      uiSchema: {
+        type: "string",
+        title: '{{t("Batch")}}',
+        "x-component": "Input",
+        required: true
+      }
+    },
+    {
+      name: "source",
+      interface: "input",
+      type: "belongsTo",
+      target: "userDataSyncSources",
+      targetKey: "id",
+      foreignKey: "sourceId",
+      allowNull: false,
+      uiSchema: {
+        type: "object",
+        title: '{{t("Source")}}',
+        "x-component": "AssociationField",
+        "x-component-props": {
+          fieldNames: {
+            value: "id",
+            label: "name"
+          }
+        },
+        required: true,
+        "x-read-pretty": true
+      }
+    },
+    {
+      name: "status",
+      interface: "Select",
+      type: "string",
+      allowNull: false,
+      uiSchema: {
+        type: "string",
+        title: '{{t("Status")}}',
+        "x-component": "Select",
+        required: true
+      }
+    },
+    {
+      name: "message",
+      interface: "input",
+      type: "string",
+      allowNull: true,
+      uiSchema: {
+        type: "string",
+        title: '{{t("Message")}}',
+        "x-component": "Input",
+        required: false
+      }
+    },
+    {
+      name: "cost",
+      interface: "input",
+      type: "integer",
+      allowNull: true,
+      uiSchema: {
+        type: "integer",
+        title: '{{t("Cost")}}',
+        "x-component": "InputNumber",
+        "x-component-props": {
+          precision: 0
+        },
+        required: false
+      }
+    }
+  ]
+});

package/dist/server/error.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export declare class ExternalAPIError extends Error {
+    code: number;
+    constructor(message: string);
+}
+export declare class ErrorCodes {
+    static SUCCESS: number;
+    static UNAUTHORIZED: number;
+    static EXTERNAL_API_ERROR: number;
+    static messages: {
+        [x: number]: string;
+    };
+    static getErrorMessage(code: any): string;
+}

package/dist/server/error.js

@@ -0,0 +1,58 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+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 error_exports = {};
+__export(error_exports, {
+  ErrorCodes: () => ErrorCodes,
+  ExternalAPIError: () => ExternalAPIError
+});
+module.exports = __toCommonJS(error_exports);
+class ExternalAPIError extends Error {
+  code;
+  constructor(message) {
+    super(message);
+    this.name = "ExternalAPIError";
+    this.code = ErrorCodes.EXTERNAL_API_ERROR;
+  }
+}
+class ErrorCodes {
+  static SUCCESS = 0;
+  static UNAUTHORIZED = 401;
+  static EXTERNAL_API_ERROR = 510;
+  static messages = {
+    [ErrorCodes.SUCCESS]: "Success",
+    [ErrorCodes.UNAUTHORIZED]: "Unauthorized",
+    [ErrorCodes.EXTERNAL_API_ERROR]: "External API Error"
+  };
+  static getErrorMessage(code) {
+    return this.messages[code] || "Unknown Error";
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ErrorCodes,
+  ExternalAPIError
+});

package/dist/server/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export { SyncSource } from './sync-source';
+export { ExternalAPIError, ErrorCodes } from './error';
+export * from './user-data-resource-manager';
+export { default } from './plugin';

package/dist/server/index.js

@@ -0,0 +1,56 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var server_exports = {};
+__export(server_exports, {
+  ErrorCodes: () => import_error.ErrorCodes,
+  ExternalAPIError: () => import_error.ExternalAPIError,
+  SyncSource: () => import_sync_source.SyncSource,
+  default: () => import_plugin.default
+});
+module.exports = __toCommonJS(server_exports);
+var import_sync_source = require("./sync-source");
+var import_error = require("./error");
+__reExport(server_exports, require("./user-data-resource-manager"), module.exports);
+var import_plugin = __toESM(require("./plugin"));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ErrorCodes,
+  ExternalAPIError,
+  SyncSource,
+  ...require("./user-data-resource-manager")
+});

package/dist/server/models/sync-source.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Model } from '@nocobase/database';
+export declare class SyncSourceModel extends Model {
+    id: number;
+    name: string;
+    sourceType: string;
+    options: any;
+}