Skip to content

armgit / dbx

Public Imported from GitHub
0

25 MB lightweight cross-platform database client for 100+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 100+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP。

18.4 KB
Raw Blame
import { existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
import { dirname, join, resolve } from "node:path";
import process from "node:process";
import { parse } from "yaml";

const root = resolve(import.meta.dirname, "..");
const connectionTypeDirectory = join(root, "plugins", "connection-types");
const connectionProfileCatalog = join(connectionTypeDirectory, "profiles", "catalog.yaml");
const dialectDirectory = join(root, "plugins", "dialects");
const jsonTarget = join(root, "crates", "dbx-core", "assets", "database-drivers.manifest.json");
const typeTarget = join(root, "apps", "desktop", "src", "types", "generated", "databaseTypes.ts");
const profileTarget = join(root, "apps", "desktop", "src", "types", "generated", "connectionProfiles.ts");
const checkOnly = process.argv.includes("--check");

const runtimeModes = new Set(["native", "file", "agent", "external"]);
const mcpModes = new Set(["direct", "bridge", "unsupported"]);
const supportLevels = new Set(["connect", "browse", "understand", "operate"]);
const transferObjectFamilies = new Set(["mysql", "postgres", "oracle", "sqlserver"]);
const transferSupportLevels = new Set(["verified", "family-compatible", "best-effort"]);
const compareModes = new Set(["schema", "data"]);
const formKinds = new Set(["standard", "jdbc", "mq", "mqtt", "nacos"]);
const profileCategories = new Set(["sql", "analytics", "domestic", "lightweight", "document", "graph_ai", "timeseries", "mq", "registry_config"]);
const descriptorKeys = new Set([
  "schemaVersion",
  "order",
  "dbType",
  "compareModes",
  "transferObjectFamily",
  "transferSupportLevel",
  "rustVariant",
  "label",
  "dialect",
  "runtimeMode",
  "mcpMode",
  "agentKey",
  "driverStoreVisible",
  "driverStoreOrder",
  "driverProfiles",
  "managedDrivers",
  "singleConnectionPool",
  "metadataConnectionScoped",
  "skipTcpProbe",
  "defaultPort",
  "localFile",
  "specializedSurface",
  "formKind",
  "traits",
  "supportLevel",
  "capabilities",
]);
const profileCatalogKeys = new Set(["schemaVersion", "profiles"]);
const connectionProfileKeys = new Set(["id", "dbType", "label", "pickerLabel", "icon", "pickerIcon", "port", "user", "host", "urlParams", "category"]);
const driverProfileKeys = new Set(["profile", "agentKey", "packageKey", "label", "storeVisible", "storeOrder"]);
const managedDriverKeys = new Set(["key", "label", "storeVisible", "storeOrder"]);
const capabilityKeys = new Set(["queryExecution", "metadataBrowse", "objectBrowser", "objectSource", "schemaSearch", "diagram", "tableDataEdit", "tableStructureEdit", "tableImport", "dataTransfer", "sqlFileExecution", "databaseCreate", "fieldLineage", "sqlExplain", "userAdmin", "driverManagement"]);
const traitKeys = new Set(["schemaAware", "databaseSchemaQualified", "singleDatabase", "clearableQuerySchema", "fetchFirst", "treeSchema", "databaseObjectTree", "pgVacuum", "pgLikeStructure", "diagramSql"]);

function connectionTypeFiles() {
  if (!existsSync(connectionTypeDirectory)) throw new Error(`Missing connection type descriptor directory: ${connectionTypeDirectory}`);
  return readdirSync(connectionTypeDirectory)
    .filter((file) => file.endsWith(".yaml") || file.endsWith(".yml"))
    .sort();
}

function dialectNames() {
  return new Set(
    readdirSync(dialectDirectory)
      .filter((file) => file.endsWith(".yaml") || file.endsWith(".yml"))
      .map((file) => {
        const value = parse(readFileSync(join(dialectDirectory, file), "utf8"));
        return value?.dialect?.name;
      })
      .filter(Boolean),
  );
}

function loadDescriptors() {
  const knownDialects = dialectNames();
  const descriptors = connectionTypeFiles().map((file) => {
    const path = join(connectionTypeDirectory, file);
    const descriptor = parse(readFileSync(path, "utf8"));
    validateDescriptor(descriptor, file, knownDialects);
    return descriptor;
  });

  const duplicateDbTypes = duplicateValues(descriptors.map((descriptor) => descriptor.dbType));
  const duplicateRustVariants = duplicateValues(descriptors.map((descriptor) => descriptor.rustVariant));
  const duplicateOrders = duplicateValues(descriptors.map((descriptor) => descriptor.order));
  if (duplicateDbTypes.length > 0) throw new Error(`Duplicate database types: ${duplicateDbTypes.join(", ")}`);
  if (duplicateRustVariants.length > 0) throw new Error(`Duplicate Rust variants: ${duplicateRustVariants.join(", ")}`);
  if (duplicateOrders.length > 0) throw new Error(`Duplicate connection type orders: ${duplicateOrders.join(", ")}`);
  validateDriverStoreOrders(descriptors);

  return descriptors.sort((left, right) => left.order - right.order);
}

function validateDescriptor(descriptor, file, knownDialects) {
  const location = join("plugins", "connection-types", file);
  if (!descriptor || typeof descriptor !== "object") throw new Error(`${location}: descriptor must be a mapping`);
  validateKnownKeys(descriptor, descriptorKeys, location);
  if (descriptor.schemaVersion !== 1) throw new Error(`${location}: schemaVersion must be 1`);
  if (!Number.isInteger(descriptor.order) || descriptor.order <= 0) throw new Error(`${location}: order must be a positive integer`);
  if (!/^[a-z0-9]+(?:-[a-z0-9]+)*$/.test(descriptor.dbType ?? "")) throw new Error(`${location}: invalid dbType`);
  if (descriptor.compareModes !== undefined) {
    if (!Array.isArray(descriptor.compareModes) || descriptor.compareModes.length === 0 || descriptor.compareModes.some((mode) => !compareModes.has(mode))) {
      throw new Error(`${location}: invalid compareModes`);
    }
    if (new Set(descriptor.compareModes).size !== descriptor.compareModes.length) throw new Error(`${location}: duplicate compareModes`);
  }
  if (descriptor.transferObjectFamily !== undefined && !transferObjectFamilies.has(descriptor.transferObjectFamily)) {
    throw new Error(`${location}: invalid transferObjectFamily`);
  }
  if (descriptor.transferSupportLevel !== undefined && !transferSupportLevels.has(descriptor.transferSupportLevel)) {
    throw new Error(`${location}: invalid transferSupportLevel`);
  }
  if (!/^[A-Z][A-Za-z0-9]*$/.test(descriptor.rustVariant ?? "")) throw new Error(`${location}: invalid rustVariant`);
  if (typeof descriptor.label !== "string" || descriptor.label.trim() === "") throw new Error(`${location}: label is required`);
  if (!runtimeModes.has(descriptor.runtimeMode)) throw new Error(`${location}: invalid runtimeMode`);
  if (!mcpModes.has(descriptor.mcpMode)) throw new Error(`${location}: invalid mcpMode`);
  if (!supportLevels.has(descriptor.supportLevel)) throw new Error(`${location}: invalid supportLevel`);
  if (descriptor.dialect && !knownDialects.has(descriptor.dialect)) throw new Error(`${location}: unknown dialect ${descriptor.dialect}`);
  if (descriptor.runtimeMode === "agent" && !descriptor.agentKey) throw new Error(`${location}: agent runtime requires agentKey`);
  if (descriptor.driverStoreVisible && !descriptor.agentKey) throw new Error(`${location}: driverStoreVisible requires agentKey`);
  if (descriptor.driverStoreVisible) validatePositiveInteger(descriptor.driverStoreOrder, `${location}: driverStoreOrder`);
  if (descriptor.defaultPort !== undefined && (!Number.isInteger(descriptor.defaultPort) || descriptor.defaultPort < 0 || descriptor.defaultPort > 65535)) {
    throw new Error(`${location}: invalid defaultPort`);
  }
  if (!descriptor.capabilities || typeof descriptor.capabilities !== "object") throw new Error(`${location}: capabilities are required`);
  validateBooleanMap(descriptor.capabilities, capabilityKeys, `${location}: capabilities`, true);
  if (descriptor.capabilities.dataTransfer !== (descriptor.transferSupportLevel !== undefined)) {
    throw new Error(`${location}: transferSupportLevel must be set exactly when dataTransfer is true`);
  }
  if (descriptor.compareModes?.includes("schema") && !descriptor.capabilities.metadataBrowse) {
    throw new Error(`${location}: schema comparison requires metadataBrowse`);
  }
  if (descriptor.compareModes?.includes("data") && (!descriptor.capabilities.metadataBrowse || !descriptor.capabilities.queryExecution)) {
    throw new Error(`${location}: data comparison requires metadataBrowse and queryExecution`);
  }
  if (descriptor.transferSupportLevel === "family-compatible" && descriptor.transferObjectFamily === undefined) {
    throw new Error(`${location}: family-compatible transfer support requires transferObjectFamily`);
  }
  if (!Object.values(descriptor.capabilities).some(Boolean) && descriptor.specializedSurface !== true) {
    throw new Error(`${location}: enable a product capability or set specializedSurface: true`);
  }
  if (descriptor.specializedSurface !== undefined && typeof descriptor.specializedSurface !== "boolean") {
    throw new Error(`${location}: specializedSurface must be a boolean`);
  }
  if (descriptor.formKind !== undefined && !formKinds.has(descriptor.formKind)) {
    throw new Error(`${location}: invalid formKind`);
  }
  if (descriptor.traits !== undefined) validateBooleanMap(descriptor.traits, traitKeys, `${location}: traits`);
  for (const profile of descriptor.driverProfiles ?? []) {
    validateKnownKeys(profile, driverProfileKeys, `${location}: driver profile`);
    if (!profile.profile || !profile.agentKey || !profile.label) throw new Error(`${location}: driverProfiles entries require profile, agentKey, and label`);
    if (profile.storeVisible !== undefined && typeof profile.storeVisible !== "boolean") throw new Error(`${location}: driver profile ${profile.profile} storeVisible must be a boolean`);
    if (profile.storeVisible) validatePositiveInteger(profile.storeOrder, `${location}: driver profile ${profile.profile} storeOrder`);
  }
  for (const driver of descriptor.managedDrivers ?? []) {
    validateKnownKeys(driver, managedDriverKeys, `${location}: managed driver`);
    if (!driver.key || !driver.label) throw new Error(`${location}: managedDrivers entries require key and label`);
    if (driver.storeVisible !== undefined && typeof driver.storeVisible !== "boolean") throw new Error(`${location}: managed driver ${driver.key} storeVisible must be a boolean`);
    if (driver.storeVisible) validatePositiveInteger(driver.storeOrder, `${location}: managed driver ${driver.key} storeOrder`);
  }
}

function loadConnectionProfiles(descriptors) {
  if (!existsSync(connectionProfileCatalog)) throw new Error(`Missing connection profile catalog: ${connectionProfileCatalog}`);
  const location = join("plugins", "connection-types", "profiles", "catalog.yaml");
  const catalog = parse(readFileSync(connectionProfileCatalog, "utf8"));
  if (!catalog || typeof catalog !== "object") throw new Error(`${location}: catalog must be a mapping`);
  validateKnownKeys(catalog, profileCatalogKeys, location);
  if (catalog.schemaVersion !== 1) throw new Error(`${location}: schemaVersion must be 1`);
  if (!Array.isArray(catalog.profiles) || catalog.profiles.length === 0) throw new Error(`${location}: profiles must be a non-empty list`);

  const knownTypes = new Set(descriptors.map((descriptor) => descriptor.dbType));
  const profileIds = new Set();
  const profiles = catalog.profiles.map((profile, index) => {
    const profileLocation = `${location}: profiles[${index}]`;
    if (!profile || typeof profile !== "object") throw new Error(`${profileLocation} must be a mapping`);
    validateKnownKeys(profile, connectionProfileKeys, profileLocation);
    if (!/^[a-z0-9]+(?:[-_][a-z0-9]+)*$/.test(profile.id ?? "")) throw new Error(`${profileLocation}: invalid id`);
    if (profileIds.has(profile.id)) throw new Error(`${profileLocation}: duplicate id ${profile.id}`);
    profileIds.add(profile.id);
    if (!knownTypes.has(profile.dbType)) throw new Error(`${profileLocation}: unknown dbType ${profile.dbType}`);
    for (const key of ["label", "icon", "user"]) {
      if (typeof profile[key] !== "string") throw new Error(`${profileLocation}: ${key} must be a string`);
    }
    for (const key of ["pickerLabel", "pickerIcon", "host", "urlParams"]) {
      if (profile[key] !== undefined && typeof profile[key] !== "string") throw new Error(`${profileLocation}: ${key} must be a string`);
    }
    if (!Number.isInteger(profile.port) || profile.port < 0 || profile.port > 65535) throw new Error(`${profileLocation}: invalid port`);
    if (profile.category !== undefined && !profileCategories.has(profile.category)) throw new Error(`${profileLocation}: invalid category`);
    return profile;
  });

  return profiles;
}

function validateDriverStoreOrders(descriptors) {
  const entries = descriptors.flatMap((descriptor) => [
    ...(descriptor.driverStoreVisible ? [{ key: descriptor.agentKey, order: descriptor.driverStoreOrder }] : []),
    ...(descriptor.driverProfiles ?? []).filter((profile) => profile.storeVisible).map((profile) => ({ key: profile.packageKey ?? profile.agentKey, order: profile.storeOrder })),
    ...(descriptor.managedDrivers ?? []).filter((driver) => driver.storeVisible).map((driver) => ({ key: driver.key, order: driver.storeOrder })),
  ]);
  const orderByKey = new Map();
  for (const entry of entries) {
    const existingOrder = orderByKey.get(entry.key);
    if (existingOrder !== undefined && existingOrder !== entry.order) {
      throw new Error(`Driver store key ${entry.key} uses conflicting orders: ${existingOrder}, ${entry.order}`);
    }
    orderByKey.set(entry.key, entry.order);
  }
  const duplicateStoreOrders = duplicateValues([...orderByKey.values()]);
  if (duplicateStoreOrders.length > 0) throw new Error(`Duplicate driver store orders: ${duplicateStoreOrders.join(", ")}`);
}

function validatePositiveInteger(value, location) {
  if (!Number.isInteger(value) || value <= 0) throw new Error(`${location} must be a positive integer`);
}

function validateKnownKeys(value, allowedKeys, location) {
  const unknownKeys = Object.keys(value).filter((key) => !allowedKeys.has(key));
  if (unknownKeys.length > 0) throw new Error(`${location} contains unknown keys: ${unknownKeys.join(", ")}`);
}

function validateBooleanMap(value, allowedKeys, location, requireAll = false) {
  if (!value || typeof value !== "object" || Array.isArray(value)) throw new Error(`${location} must be a mapping`);
  validateKnownKeys(value, allowedKeys, location);
  if (requireAll) {
    const missingKeys = [...allowedKeys].filter((key) => !(key in value));
    if (missingKeys.length > 0) throw new Error(`${location} is missing keys: ${missingKeys.join(", ")}`);
  }
  const nonBooleanKeys = Object.entries(value)
    .filter(([, entry]) => typeof entry !== "boolean")
    .map(([key]) => key);
  if (nonBooleanKeys.length > 0) throw new Error(`${location} must use boolean values: ${nonBooleanKeys.join(", ")}`);
}

function duplicateValues(values) {
  return [...new Set(values.filter((value, index) => values.indexOf(value) !== index))];
}

function publicDescriptor(descriptor) {
  const { schemaVersion: _schemaVersion, order: _order, rustVariant: _rustVariant, ...publicFields } = descriptor;
  return publicFields;
}

function jsonOutput(descriptors) {
  return `${JSON.stringify({ schemaVersion: 1, drivers: descriptors.map(publicDescriptor) }, null, 2)}\n`;
}

function typeOutput(descriptors) {
  const values = descriptors.map((descriptor) => `  "${descriptor.dbType}",`).join("\n");
  // "plugin" is the plugin-framework internal connection type: it is not a
  // user-selectable driver (hence absent from DATABASE_TYPES) but connection
  // configs can carry it, so the DatabaseType union must accept it.
  return `// Generated by scripts/sync-connection-types.mjs. Do not edit manually.\nexport const DATABASE_TYPES = [\n${values}\n] as const;\n\nexport type DatabaseType = (typeof DATABASE_TYPES)[number] | "plugin";\n`;
}

function typescriptPropertyName(value) {
  return /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(value) ? value : JSON.stringify(value);
}

function profileTypeOutput(profiles) {
  const profileEntries = profiles
    .map((profile) => {
      const fields = [
        `type: ${JSON.stringify(profile.dbType)}`,
        `port: ${profile.port}`,
        `user: ${JSON.stringify(profile.user)}`,
        `label: ${JSON.stringify(profile.label)}`,
        `icon: ${JSON.stringify(profile.icon)}`,
        ...(profile.host === undefined ? [] : [`host: ${JSON.stringify(profile.host)}`]),
        ...(profile.urlParams === undefined ? [] : [`urlParams: ${JSON.stringify(profile.urlParams)}`]),
      ];
      return `  ${typescriptPropertyName(profile.id)}: { ${fields.join(", ")} },`;
    })
    .join("\n");
  const pickerOptions = profiles
    .filter((profile) => profile.category)
    .map((profile) => `  { value: ${JSON.stringify(profile.id)}, label: ${JSON.stringify(profile.pickerLabel ?? profile.label)}, category: ${JSON.stringify(profile.category)} },`)
    .join("\n");
  const profileIcons = profiles.map((profile) => `  ${typescriptPropertyName(profile.id)}: ${JSON.stringify(profile.pickerIcon ?? profile.icon)},`).join("\n");
  return `// Generated by scripts/sync-connection-types.mjs. Do not edit manually.\nimport type { DatabaseType } from "./databaseTypes";\n\nexport type ConnectionProfileCategory = "sql" | "analytics" | "domestic" | "lightweight" | "document" | "graph_ai" | "timeseries" | "mq" | "registry_config";\n\nexport interface ConnectionProfileDefinition {\n  type: DatabaseType;\n  port: number;\n  user: string;\n  label: string;\n  icon: string;\n  host?: string;\n  urlParams?: string;\n}\n\nexport interface ConnectionPickerOption {\n  value: string;\n  label: string;\n  category: ConnectionProfileCategory;\n}\n\nexport const CONNECTION_PROFILES = {\n${profileEntries}\n} as const satisfies Record<string, ConnectionProfileDefinition>;\n\nexport const CONNECTION_PROFILE_ICONS = {\n${profileIcons}\n} as const satisfies Record<string, string>;\n\nexport const CONNECTION_PICKER_OPTIONS = [\n${pickerOptions}\n] as const satisfies readonly ConnectionPickerOption[];\n`;
}

function syncTarget(path, expected) {
  const current = existsSync(path) ? readFileSync(path, "utf8") : "";
  if (current === expected) return;
  if (checkOnly) throw new Error(`${path.slice(root.length + 1)} is out of date; run pnpm generate:connection-types`);
  mkdirSync(dirname(path), { recursive: true });
  writeFileSync(path, expected);
}

try {
  const descriptors = loadDescriptors();
  const profiles = loadConnectionProfiles(descriptors);
  syncTarget(jsonTarget, jsonOutput(descriptors));
  syncTarget(typeTarget, typeOutput(descriptors));
  syncTarget(profileTarget, profileTypeOutput(profiles));
  console.log(`${checkOnly ? "Validated" : "Generated"} ${descriptors.length} connection type descriptors and ${profiles.length} connection profiles.`);
} catch (error) {
  console.error(error instanceof Error ? error.message : String(error));
  process.exit(1);
}