@nocobase/data-source-manager 2.0.0-alpha.5 → 2.0.0-alpha.50

package/lib/database-introspector/postgres-introspector.js

@@ -0,0 +1,184 @@
+/**
+ * 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+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 postgres_introspector_exports = {};
+__export(postgres_introspector_exports, {
+  PostgresIntrospector: () => PostgresIntrospector
+});
+module.exports = __toCommonJS(postgres_introspector_exports);
+var import_database_introspector = require("./database-introspector");
+var import_lodash = __toESM(require("lodash"));
+const _PostgresIntrospector = class _PostgresIntrospector extends import_database_introspector.DatabaseIntrospector {
+  async getTableConstraints(tableInfo2) {
+    const schema = tableInfo2.schema || "public";
+    const sql = `
+  SELECT
+  tc.constraint_schema,
+  tc.constraint_name,
+  tc.table_name,
+  kcu.column_name,
+  CASE WHEN (SELECT COUNT(*)
+             FROM information_schema.key_column_usage kcu2
+             WHERE kcu2.constraint_name = tc.constraint_name
+               AND kcu2.table_schema = tc.constraint_schema) = 1 THEN TRUE
+       ELSE FALSE END AS is_single_column
+FROM information_schema.table_constraints AS tc
+JOIN information_schema.key_column_usage AS kcu
+  ON tc.constraint_name = kcu.constraint_name
+  AND tc.table_schema = kcu.table_schema
+WHERE tc.constraint_type = 'UNIQUE'
+  AND tc.table_name = :tableName
+  AND tc.table_schema = :schema
+ORDER BY tc.constraint_name, kcu.column_name;
+  `;
+    return await this.db.sequelize.query(sql, {
+      type: "SELECT",
+      replacements: {
+        tableName: tableInfo2.tableName,
+        schema
+      }
+    });
+  }
+  async getTableColumnsInfo(tableInfo2) {
+    const columnsInfo = await this.db.sequelize.getQueryInterface().describeTable(tableInfo2);
+    const primaryKeys = await this.getPrimaryKeysOfTable(tableInfo2);
+    Object.keys(columnsInfo).forEach((columnName) => {
+      const columnInfo = columnsInfo[columnName];
+      const primaryKey = primaryKeys.find((key) => key.column_name === columnName);
+      if (primaryKey) {
+        columnInfo.primaryKey = true;
+      }
+    });
+    await this.appendArrayColumnElementType(tableInfo2, columnsInfo);
+    return columnsInfo;
+  }
+  async getPrimaryKeysOfTable(tableInfo2) {
+    const schema = tableInfo2.schema || "public";
+    const sql = `
+      SELECT pg_attribute.attname  AS column_name,
+             pg_constraint.conname AS constraint_name
+      FROM pg_constraint
+             JOIN pg_class ON pg_constraint.conrelid = pg_class.oid
+             JOIN pg_attribute ON pg_attribute.attnum = ANY (pg_constraint.conkey)
+        AND pg_attribute.attrelid = pg_class.oid
+             JOIN pg_namespace ON pg_namespace.oid = pg_class.relnamespace
+      WHERE pg_class.relname = :tableName
+        AND pg_namespace.nspname = :schema
+        AND pg_constraint.contype = 'p';
+    `;
+    return await this.db.sequelize.query(sql, {
+      type: "SELECT",
+      replacements: {
+        tableName: tableInfo2.tableName,
+        schema
+      }
+    });
+  }
+  columnAttribute(columnsInfo, columnName, indexes) {
+    const columnInfo = columnsInfo[columnName];
+    const attr = {
+      type: columnInfo.type,
+      allowNull: columnInfo.defaultValue ? true : columnInfo.allowNull,
+      primaryKey: columnInfo.primaryKey,
+      unique: false,
+      description: columnInfo.comment
+    };
+    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;
+      }
+    }
+    if (columnInfo.type === "ARRAY") {
+      attr.dataType = "array";
+      if (columnInfo["elementType"]) {
+        const elementType = columnInfo["elementType"].replace(/"/g, "");
+        const { type } = this.inferFieldTypeByRawType(elementType);
+        attr.elementType = type;
+      }
+    }
+    for (const index of indexes) {
+      if (index["is_single_column"] && index["column_name"] === columnName) {
+        attr.unique = true;
+      }
+    }
+    return attr;
+  }
+  async getArrayColumnElementType(tableInfo2, columnNames) {
+    const schema = tableInfo2.schema || "public";
+    const sql = `
+SELECT c.column_name, e.data_type AS element_type
+FROM information_schema.columns c LEFT JOIN information_schema.element_types e
+     ON ((c.table_catalog, c.table_schema, c.table_name, 'TABLE', c.dtd_identifier)
+       = (e.object_catalog, e.object_schema, e.object_name, e.object_type, e.collection_type_identifier))
+WHERE c.table_schema = :schema AND c.table_name = :tableName AND c.column_name in (:columnNames);
+    `;
+    return await this.db.sequelize.query(sql, {
+      type: "SELECT",
+      replacements: {
+        schema,
+        tableName: tableInfo2.tableName,
+        columnNames
+      }
+    });
+  }
+  async appendArrayColumnElementType(tableInfo2, columnsInfo) {
+    const arrayColumns = {};
+    for (const columnName in columnsInfo) {
+      const columnInfo = columnsInfo[columnName];
+      if (columnInfo.type === "ARRAY") {
+        arrayColumns[columnName] = columnInfo;
+      }
+    }
+    const columnNames = Object.keys(arrayColumns);
+    if (!columnNames.length) {
+      return;
+    }
+    const rows = await this.getArrayColumnElementType(tableInfo2, columnNames);
+    const udtNameMap = import_lodash.default.keyBy(rows, "column_name");
+    Object.keys(arrayColumns).forEach((columnName) => {
+      columnsInfo[columnName]["elementType"] = udtNameMap[columnName].element_type;
+    });
+  }
+};
+__name(_PostgresIntrospector, "PostgresIntrospector");
+let PostgresIntrospector = _PostgresIntrospector;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PostgresIntrospector
+});

package/lib/database-introspector/type-interface-map.d.ts

@@ -0,0 +1,242 @@
+/**
+ * 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 const typeInterfaceMap: {
+    array: () => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                autoSize: {
+                    minRows: number;
+                };
+            };
+            default: any;
+        };
+    };
+    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;
+        };
+    };
+    date: () => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                dateFormat: string;
+                showTime: boolean;
+            };
+        };
+    };
+    datetime: () => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                dateFormat: string;
+                showTime: boolean;
+            };
+        };
+    };
+    datetimeTz: () => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                dateFormat: string;
+                showTime: boolean;
+            };
+        };
+    };
+    datetimeNoTz: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                showTime: boolean;
+                utc: boolean;
+            };
+        };
+    };
+    dateOnly: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                dateOnly: boolean;
+            };
+        };
+    };
+    time: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                format: string;
+            };
+        };
+    };
+    integer: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+            'x-component-props': {
+                stringMode: boolean;
+                step: string;
+            };
+            'x-validator': string;
+        };
+    };
+    bigInt: () => {
+        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;
+            };
+        };
+    };
+    string: () => {
+        interface: string;
+        uiSchema: {
+            'x-component': string;
+            'x-component-props': {
+                style: {
+                    width: string;
+                };
+            };
+        };
+    };
+    text: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+        };
+    };
+    password: () => {
+        interface: string;
+        hidden: boolean;
+        uiSchema: {
+            type: string;
+            'x-component': 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;
+                };
+            };
+        };
+    };
+    boolean: () => {
+        interface: string;
+        uiSchema: {
+            type: string;
+            'x-component': string;
+        };
+    };
+    belongsTo: string;
+    belongsToMany: string;
+    hasMany: string;
+    hasOne: string;
+    context: string;
+    virtual: string;
+    radio: string;
+    set: string;
+    sort: string;
+    point: string;
+    polygon: string;
+    lineString: string;
+    circle: string;
+};

package/lib/database-introspector/type-interface-map.js

@@ -0,0 +1,234 @@
+/**
+ * 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 __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+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 type_interface_map_exports = {};
+__export(type_interface_map_exports, {
+  typeInterfaceMap: () => typeInterfaceMap
+});
+module.exports = __toCommonJS(type_interface_map_exports);
+const typeInterfaceMap = {
+  // ---------- JSON / Structured ----------
+  array: /* @__PURE__ */ __name(() => ({
+    interface: "json",
+    uiSchema: {
+      "x-component": "Input.JSON",
+      "x-component-props": {
+        autoSize: { minRows: 5 }
+      },
+      default: null
+    }
+  }), "array"),
+  json: /* @__PURE__ */ __name(() => ({
+    interface: "json",
+    uiSchema: {
+      "x-component": "Input.JSON",
+      "x-component-props": {
+        autoSize: { minRows: 5 }
+      },
+      default: null
+    }
+  }), "json"),
+  jsonb: /* @__PURE__ */ __name(() => ({
+    interface: "json",
+    uiSchema: {
+      "x-component": "Input.JSON",
+      "x-component-props": {
+        autoSize: { minRows: 5 }
+      },
+      default: null
+    }
+  }), "jsonb"),
+  // ---------- Date / Time ----------
+  date: /* @__PURE__ */ __name(() => ({
+    interface: "datetime",
+    uiSchema: {
+      "x-component": "DatePicker",
+      "x-component-props": { dateFormat: "YYYY-MM-DD", showTime: false }
+    }
+  }), "date"),
+  datetime: /* @__PURE__ */ __name(() => ({
+    interface: "datetime",
+    uiSchema: {
+      "x-component": "DatePicker",
+      "x-component-props": { dateFormat: "YYYY-MM-DD", showTime: false }
+    }
+  }), "datetime"),
+  datetimeTz: /* @__PURE__ */ __name(() => ({
+    interface: "datetime",
+    uiSchema: {
+      "x-component": "DatePicker",
+      "x-component-props": { dateFormat: "YYYY-MM-DD", showTime: false }
+    }
+  }), "datetimeTz"),
+  datetimeNoTz: /* @__PURE__ */ __name(() => ({
+    interface: "datetimeNoTz",
+    uiSchema: {
+      type: "string",
+      "x-component": "DatePicker",
+      "x-component-props": { showTime: false, utc: false }
+    }
+  }), "datetimeNoTz"),
+  dateOnly: /* @__PURE__ */ __name(() => ({
+    interface: "dateOnly",
+    uiSchema: {
+      type: "string",
+      "x-component": "DatePicker",
+      "x-component-props": { dateOnly: true }
+    }
+  }), "dateOnly"),
+  time: /* @__PURE__ */ __name(() => ({
+    interface: "time",
+    uiSchema: {
+      type: "string",
+      "x-component": "TimePicker",
+      "x-component-props": { format: "HH:mm:ss" }
+    }
+  }), "time"),
+  // ---------- Numeric ----------
+  integer: /* @__PURE__ */ __name(() => ({
+    interface: "integer",
+    uiSchema: {
+      type: "number",
+      "x-component": "InputNumber",
+      "x-component-props": { stringMode: true, step: "1" },
+      "x-validator": "integer"
+    }
+  }), "integer"),
+  bigInt: /* @__PURE__ */ __name(() => ({
+    interface: "integer",
+    uiSchema: {
+      "x-component": "InputNumber",
+      "x-component-props": {
+        style: { width: "100%" }
+      }
+    }
+  }), "bigInt"),
+  float: /* @__PURE__ */ __name(() => ({
+    interface: "number",
+    uiSchema: {
+      type: "number",
+      "x-component": "InputNumber",
+      "x-component-props": { stringMode: true, step: "1" }
+    }
+  }), "float"),
+  double: /* @__PURE__ */ __name(() => ({
+    interface: "number",
+    uiSchema: {
+      type: "number",
+      "x-component": "InputNumber",
+      "x-component-props": { stringMode: true, step: "1" }
+    }
+  }), "double"),
+  real: /* @__PURE__ */ __name(() => ({
+    interface: "number",
+    uiSchema: {
+      type: "number",
+      "x-component": "InputNumber",
+      "x-component-props": { stringMode: true, step: "1" }
+    }
+  }), "real"),
+  decimal: /* @__PURE__ */ __name(() => ({
+    interface: "number",
+    uiSchema: {
+      type: "number",
+      "x-component": "InputNumber",
+      "x-component-props": { stringMode: true, step: "1" }
+    }
+  }), "decimal"),
+  // ---------- Text / String ----------
+  string: /* @__PURE__ */ __name(() => ({
+    interface: "input",
+    uiSchema: {
+      "x-component": "Input",
+      "x-component-props": {
+        style: { width: "100%" }
+      }
+    }
+  }), "string"),
+  text: /* @__PURE__ */ __name(() => ({
+    interface: "textarea",
+    uiSchema: {
+      type: "string",
+      "x-component": "Input.TextArea"
+    }
+  }), "text"),
+  password: /* @__PURE__ */ __name(() => ({
+    interface: "password",
+    hidden: true,
+    uiSchema: {
+      type: "string",
+      "x-component": "Password"
+    }
+  }), "password"),
+  uid: /* @__PURE__ */ __name(() => ({
+    interface: "input",
+    uiSchema: {
+      "x-component": "Input",
+      "x-component-props": {
+        style: { width: "100%" }
+      }
+    }
+  }), "uid"),
+  uuid: /* @__PURE__ */ __name(() => ({
+    interface: "uuid",
+    uiSchema: {
+      "x-component": "Input",
+      "x-component-props": {
+        style: { width: "100%" }
+      }
+    }
+  }), "uuid"),
+  // ---------- Boolean ----------
+  boolean: /* @__PURE__ */ __name(() => ({
+    interface: "checkbox",
+    uiSchema: {
+      type: "boolean",
+      "x-component": "Checkbox"
+    }
+  }), "boolean"),
+  // ---------- Placeholders (not yet implemented) ----------
+  // Relationships
+  belongsTo: "",
+  belongsToMany: "",
+  hasMany: "",
+  hasOne: "",
+  context: "",
+  virtual: "",
+  // Other
+  radio: "",
+  set: "",
+  sort: "",
+  // Geospatial
+  point: "",
+  polygon: "",
+  lineString: "",
+  circle: ""
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  typeInterfaceMap
+});

package/lib/index.d.ts

@@ -10,8 +10,10 @@ export * from './collection-manager';
 export * from './collection';
 export * from './data-source';
 export * from './data-source-manager';
+export * from './database-data-source';
 export * from './sequelize-collection-manager';
 export * from './sequelize-data-source';
 export * from './load-default-actions';
 export * from './types';
+export * from './database-introspector/database-introspector';
 export * from './utils';

package/lib/index.js

@@ -27,10 +27,12 @@ __reExport(src_exports, require("./collection-manager"), module.exports);
 __reExport(src_exports, require("./collection"), module.exports);
 __reExport(src_exports, require("./data-source"), module.exports);
 __reExport(src_exports, require("./data-source-manager"), module.exports);
+__reExport(src_exports, require("./database-data-source"), module.exports);
 __reExport(src_exports, require("./sequelize-collection-manager"), module.exports);
 __reExport(src_exports, require("./sequelize-data-source"), module.exports);
 __reExport(src_exports, require("./load-default-actions"), module.exports);
 __reExport(src_exports, require("./types"), module.exports);
+__reExport(src_exports, require("./database-introspector/database-introspector"), module.exports);
 __reExport(src_exports, require("./utils"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -38,9 +40,11 @@ __reExport(src_exports, require("./utils"), module.exports);
   ...require("./collection"),
   ...require("./data-source"),
   ...require("./data-source-manager"),
+  ...require("./database-data-source"),
   ...require("./sequelize-collection-manager"),
   ...require("./sequelize-data-source"),
   ...require("./load-default-actions"),
   ...require("./types"),
+  ...require("./database-introspector/database-introspector"),
   ...require("./utils")
 });