@tachybase/plugin-data-source-common 0.23.8

package/dist/server/mysql/database-introspector.js

@@ -0,0 +1,254 @@
+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 __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 database_introspector_exports = {};
+__export(database_introspector_exports, {
+  DatabaseIntrospector: () => DatabaseIntrospector
+});
+module.exports = __toCommonJS(database_introspector_exports);
+var import_events = require("events");
+var import_database = require("@tachybase/database");
+var import_module_data_source = require("@tachybase/module-data-source");
+var import_lodash = __toESM(require("lodash"));
+class DatabaseIntrospector extends import_events.EventEmitter {
+  db;
+  typeInterfaceMap;
+  constructor(options) {
+    super();
+    this.db = options.db;
+    this.typeInterfaceMap = options.typeInterfaceMap;
+  }
+  async getCollections(options = {}) {
+    let tableList = await this.db.sequelize.getQueryInterface().showAllTables();
+    const views = (await this.db.queryInterface.listViews()).map((view) => view.name);
+    tableList = tableList.concat(views);
+    if (this.db.options.tablePrefix) {
+      tableList = tableList.filter((tableName) => {
+        return tableName.startsWith(this.db.options.tablePrefix);
+      });
+    }
+    const batchSize = 5;
+    const results = [];
+    for (let i = 0; i < tableList.length; i += batchSize) {
+      const batch = tableList.slice(i, i + batchSize);
+      const batchResults = await Promise.all(
+        batch.map(async (tableName) => {
+          var _a;
+          const tableInfo = {
+            tableName
+          };
+          this.emit("loadMessage", {
+            message: `load table ${tableName}`
+          });
+          const collectionOptions = this.tableInfoToCollectionOptions(tableInfo);
+          const localOptions = (_a = options.localData) == null ? void 0 : _a[collectionOptions.name];
+          try {
+            return await this.getCollection({
+              tableInfo,
+              localOptions,
+              mergedOptions: views.includes(tableName) ? { view: true, template: "view" } : {}
+            });
+          } catch (e) {
+            if (e.message.includes("No description found for")) {
+              return false;
+            }
+            throw e;
+          }
+        })
+      );
+      results.push(...batchResults);
+    }
+    return results.filter(Boolean);
+  }
+  async getCollection(options) {
+    const { tableInfo } = options;
+    const columnsInfo = await this.db.sequelize.getQueryInterface().describeTable(tableInfo);
+    const collectionOptions = this.tableInfoToCollectionOptions(tableInfo);
+    const constraints = await this.db.sequelize.getQueryInterface().showIndex(this.db.inDialect("postgres") ? tableInfo : tableInfo.tableName);
+    try {
+      const fields = Object.keys(columnsInfo).map((columnName) => {
+        return this.columnInfoToFieldOptions(columnsInfo, columnName, constraints);
+      });
+      const unsupportedFields = fields.filter((field) => {
+        return field.supported === false;
+      });
+      const supportFields = fields.filter((field) => {
+        return field.supported !== false;
+      });
+      const remoteCollectionInfo = {
+        ...collectionOptions,
+        ...(options == null ? void 0 : options.mergedOptions) || {},
+        ...this.collectionOptionsByFields(supportFields),
+        fields: supportFields
+      };
+      if (unsupportedFields.length) {
+        remoteCollectionInfo.unsupportedFields = unsupportedFields;
+      }
+      const finalOptions = this.mergeLocalDataIntoCollectionOptions(remoteCollectionInfo, options.localOptions);
+      if (finalOptions.view && !finalOptions.filterTargetKey && supportFields.find((field) => field.name === "id")) {
+        finalOptions.filterTargetKey = "id";
+      }
+      return finalOptions;
+    } catch (e) {
+      throw new Error(`table ${tableInfo.tableName} introspection error: ${e.message}`);
+    }
+  }
+  loadCollection(options) {
+    this.db.collection({
+      ...options,
+      introspected: true
+    });
+  }
+  loadCollections(options) {
+    options.collections.forEach((collection) => {
+      this.loadCollection(collection);
+    });
+  }
+  tableInfoToCollectionOptions(tableInfo) {
+    const tableName = tableInfo.tableName;
+    let name = tableName;
+    if (this.db.options.tablePrefix) {
+      name = tableName.replace(this.db.options.tablePrefix, "");
+    }
+    return {
+      name,
+      title: name,
+      schema: tableInfo.schema,
+      tableName
+    };
+  }
+  collectionOptionsByFields(fields) {
+    const options = {
+      timestamps: false,
+      autoGenId: false
+    };
+    const autoIncrementField = fields.find((field) => field.autoIncrement);
+    if (autoIncrementField) {
+      options.filterTargetKey = autoIncrementField.name;
+    }
+    const primaryKeys = fields.filter((field) => field.primaryKey);
+    if (!options.filterTargetKey && primaryKeys.length === 1) {
+      options.filterTargetKey = primaryKeys[0].name;
+    }
+    const uniques = fields.filter((field) => field.unique);
+    if (!options.filterTargetKey && uniques.length === 1) {
+      options.filterTargetKey = uniques[0].name;
+    }
+    return options;
+  }
+  mergeLocalDataIntoCollectionOptions(collectionOptions, localData) {
+    var _a;
+    if (!localData) {
+      return collectionOptions;
+    }
+    const collectionFields = collectionOptions.fields || [];
+    const localFieldsAsObject = import_lodash.default.keyBy(localData.fields, "name");
+    const newFields = collectionFields.map((field) => {
+      const localField = localFieldsAsObject[field.name];
+      if (!localField) {
+        return field;
+      }
+      return (0, import_module_data_source.mergeOptions)(field, localField);
+    });
+    const localAssociationFields = (_a = localData.fields) == null ? void 0 : _a.filter((field) => {
+      return ["belongsTo", "belongsToMany", "hasMany", "hasOne"].includes(field.type);
+    });
+    if (localAssociationFields) {
+      newFields.push(...localAssociationFields);
+    }
+    return {
+      ...collectionOptions,
+      ...import_lodash.default.omit(localData, ["fields"]),
+      fields: newFields
+    };
+  }
+  columnInfoToFieldOptions(columnsInfo, columnName, indexes) {
+    const columnInfo = columnsInfo[columnName];
+    let fieldOptions = {
+      ...this.columnAttribute(columnsInfo, columnName, indexes),
+      ...import_database.ViewFieldInference.inferToFieldType({
+        dialect: this.db.options.dialect,
+        type: columnInfo.type,
+        name: columnName
+      }),
+      rawType: columnInfo.type,
+      name: columnName
+    };
+    if (!fieldOptions.type) {
+      return {
+        rawType: columnInfo.type,
+        name: columnName,
+        supported: false
+      };
+    }
+    const interfaceConfig = this.getDefaultInterfaceByType(columnsInfo, columnName, fieldOptions.type);
+    if (typeof interfaceConfig === "string") {
+      fieldOptions.interface = interfaceConfig;
+    } else {
+      fieldOptions = {
+        ...fieldOptions,
+        ...interfaceConfig
+      };
+    }
+    import_lodash.default.set(fieldOptions, "uiSchema.title", columnName);
+    return fieldOptions;
+  }
+  getDefaultInterfaceByType(columnsInfo, columnName, type) {
+    const interfaceConfig = this.typeInterfaceMap[type];
+    if (typeof interfaceConfig === "function") {
+      return interfaceConfig(columnsInfo[columnName]);
+    }
+    return interfaceConfig;
+  }
+  columnAttribute(columnsInfo, columnName, indexes) {
+    const columnInfo = columnsInfo[columnName];
+    const attr = {
+      type: columnInfo.type,
+      allowNull: columnInfo.allowNull,
+      primaryKey: columnInfo.primaryKey,
+      unique: false,
+      autoIncrement: columnInfo.autoIncrement
+    };
+    if (columnInfo.defaultValue && typeof columnInfo.defaultValue === "string") {
+      const isSerial = columnInfo.defaultValue.match(/^nextval\(/);
+      const isUUID = columnInfo.defaultValue.match(/^uuid_generate_v4\(/);
+      if (isSerial || isUUID) {
+        attr.autoIncrement = true;
+      }
+    }
+    for (const index of indexes) {
+      if (index.fields.length === 1 && index.fields[0].attribute === columnName && index.unique) {
+        attr.unique = true;
+      }
+    }
+    return attr;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DatabaseIntrospector
+});

package/dist/server/mysql/mysql-collection-manager.d.ts

@@ -0,0 +1,3 @@
+import { SequelizeCollectionManager } from '@tachybase/data-source';
+export declare class MySQLCollectionManager extends SequelizeCollectionManager {
+}

package/dist/server/mysql/mysql-collection-manager.js

@@ -0,0 +1,29 @@
+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 mysql_collection_manager_exports = {};
+__export(mysql_collection_manager_exports, {
+  MySQLCollectionManager: () => MySQLCollectionManager
+});
+module.exports = __toCommonJS(mysql_collection_manager_exports);
+var import_data_source = require("@tachybase/data-source");
+class MySQLCollectionManager extends import_data_source.SequelizeCollectionManager {
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MySQLCollectionManager
+});

package/dist/server/mysql/mysql-data-source.d.ts

@@ -0,0 +1,7 @@
+import { DataSource } from '@tachybase/data-source';
+import { MySQLCollectionManager } from './mysql-collection-manager';
+export declare class MySQLDataSource extends DataSource {
+    static testConnection(options: any): Promise<boolean>;
+    load(options: any): Promise<void>;
+    createCollectionManager(options: any): MySQLCollectionManager;
+}

package/dist/server/mysql/mysql-data-source.js

@@ -0,0 +1,111 @@
+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 __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 mysql_data_source_exports = {};
+__export(mysql_data_source_exports, {
+  MySQLDataSource: () => MySQLDataSource
+});
+module.exports = __toCommonJS(mysql_data_source_exports);
+var import_data_source = require("@tachybase/data-source");
+var import_database = require("@tachybase/database");
+var import_database_introspector = require("./database-introspector");
+var import_mysql_collection_manager = require("./mysql-collection-manager");
+var import_type_interface_map = __toESM(require("./type-interface-map"));
+class MySQLDataSource extends import_data_source.DataSource {
+  static async testConnection(options) {
+    const database = new import_database.Database({
+      dialect: "mysql",
+      ...options
+    });
+    try {
+      await database.sequelize.authenticate();
+    } catch (e) {
+      throw e;
+    } finally {
+      await database.close();
+    }
+    return true;
+  }
+  async load(options) {
+    const db = this.collectionManager.db;
+    const introspector = new import_database_introspector.DatabaseIntrospector({
+      db,
+      typeInterfaceMap: import_type_interface_map.default
+    });
+    introspector.on("loadMessage", ({ message }) => {
+      this.emit("loadMessage", { message });
+    });
+    const { localData } = options;
+    const collections = await introspector.getCollections({
+      localData
+    });
+    const delayFields = /* @__PURE__ */ new Map();
+    for (const collection of collections) {
+      try {
+        const fields = collection.fields;
+        for (const field of fields) {
+          if (field.type === "belongsToMany") {
+            if (!delayFields.has(collection.name)) {
+              delayFields.set(collection.name, []);
+            }
+            delayFields.get(collection.name).push(field);
+          }
+        }
+        this.collectionManager.defineCollection({
+          ...collection,
+          fields: fields.filter((field) => field.type !== "belongsToMany"),
+          introspected: true
+        });
+      } catch (e) {
+        db.logger.error(`load collection failed, ${e}`);
+        delayFields.delete(collection.name);
+      }
+    }
+    for (const [name, fields] of delayFields.entries()) {
+      try {
+        for (const field of fields) {
+          this.collectionManager.getCollection(name).setField(field.name, field);
+        }
+      } catch (e) {
+        db.logger.error(`load belongs to many field failed, ${e}`);
+      }
+    }
+  }
+  createCollectionManager(options) {
+    const database = new import_database.Database({
+      dialect: "mysql",
+      ...options
+    });
+    return new import_mysql_collection_manager.MySQLCollectionManager({
+      database
+    });
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MySQLDataSource
+});

package/dist/server/mysql/type-interface-map.d.ts

@@ -0,0 +1,193 @@
+declare const typeInterfaceMap: {
+    array: string;
+    belongsTo: string;
+    belongsToMany: string;
+    boolean: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+        };
+    };
+    context: string;
+    date: () => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                dateFormat: string;
+                showTime: boolean;
+            };
+        };
+    };
+    hasMany: string;
+    hasOne: string;
+    json: () => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                autoSize: {
+                    minRows: number;
+                };
+            };
+            default: any;
+        };
+    };
+    jsonb: () => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                autoSize: {
+                    minRows: number;
+                };
+            };
+            default: any;
+        };
+    };
+    integer: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                stringMode: boolean;
+                step: string;
+            };
+            'x-validator': string;
+        };
+    };
+    bigInt: (columnInfo: any) => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                style: {
+                    width: string;
+                };
+            };
+        };
+    };
+    float: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                stringMode: boolean;
+                step: string;
+            };
+        };
+    };
+    double: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                stringMode: boolean;
+                step: string;
+            };
+        };
+    };
+    real: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                stringMode: boolean;
+                step: string;
+            };
+        };
+    };
+    decimal: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                stringMode: boolean;
+                step: string;
+            };
+        };
+    };
+    password: () => {
+        interface: string;
+        hidden: boolean;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+        };
+    };
+    radio: string;
+    set: string;
+    sort: string;
+    string: (columnInfo: any) => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            enum: any;
+            'x-component-props'?: undefined;
+        };
+    } | {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                style: {
+                    width: string;
+                };
+            };
+            type?: undefined;
+            enum?: undefined;
+        };
+    };
+    text: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+        };
+    };
+    time: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                format: string;
+            };
+        };
+    };
+    uid: () => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                style: {
+                    width: string;
+                };
+            };
+        };
+    };
+    uuid: () => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                style: {
+                    width: string;
+                };
+            };
+        };
+    };
+    virtual: string;
+    point: string;
+    polygon: string;
+    lineString: string;
+    circle: string;
+};
+export default typeInterfaceMap;