@lark-apaas/db-schema-sync 0.1.0-alpha.1

package/dist/index.d.ts

@@ -0,0 +1,186 @@
+interface SchemaData {
+    tables: TableSchema[];
+    views: ViewSchema[];
+    materializedViews: ViewSchema[];
+    enums: EnumSchema[];
+    sequences: SequenceSchema[];
+    syncedTableMap: SyncedTableMap;
+}
+interface TableSchema {
+    tableName: string;
+    identifier: string;
+    comment?: string;
+    fields: FieldSchema[];
+    relationships: RelationshipSchema[];
+    indexes: IndexSchema[];
+}
+interface FieldSchema {
+    fieldName: string;
+    type: string;
+    isPrimary: boolean;
+    isNullable: boolean;
+    isUnique: boolean;
+    isArray: boolean;
+    isEnum: boolean;
+    isSystem: boolean;
+    defaultValue?: string;
+    comment?: string;
+    extraInfo?: Record<string, unknown>;
+}
+interface RelationshipSchema {
+    fieldNames: string[];
+    targetTableName: string;
+    targetFieldNames: string[];
+    updatePolicy: string;
+    removePolicy: string;
+}
+interface IndexSchema {
+    indexName: string;
+    indexColumns: string[];
+    indexType: string;
+    indexCreationType?: string;
+    indexDef?: string;
+}
+interface ViewSchema {
+    viewName: string;
+    identifier: string;
+    comment?: string;
+    fields: FieldSchema[];
+    viewDef?: string;
+}
+interface EnumSchema {
+    enumName: string;
+    identifier: string;
+    values: string[];
+}
+interface SequenceSchema {
+    sequenceName: string;
+    identifier: string;
+}
+type SyncedTableMap = Map<string, Set<string>>;
+interface ApiFieldItem {
+    fieldName: string;
+    type: string;
+    isPrimary: boolean;
+    isNullable: boolean;
+    isUnique: boolean;
+    isArray: boolean;
+    isEnum: boolean;
+    defaultValue?: string | null;
+    comment?: string;
+    extraInfo?: Record<string, unknown>;
+    arrayElementType?: string | null;
+    [key: string]: unknown;
+}
+interface ApiRelationshipItem {
+    fieldName: string[];
+    fkTableName: string;
+    fkFieldName: string[];
+    fkSchema?: string;
+    updateMethod: string;
+    removeMethod: string;
+    [key: string]: unknown;
+}
+interface ApiIndexItem {
+    indexName: string;
+    indexColumns: string[] | null;
+    indexType: string;
+    indexCreationType?: string;
+    indexDef?: string;
+    [key: string]: unknown;
+}
+interface ApiBitableSyncTask {
+    fieldApiNameList: string[];
+    [key: string]: unknown;
+}
+interface ApiTableItem {
+    tableName: string;
+    comment?: string;
+    fields: ApiFieldItem[];
+    relationships?: ApiRelationshipItem[];
+    indexes?: ApiIndexItem[];
+    bitableSyncTask?: ApiBitableSyncTask;
+    tableDef?: string;
+    [key: string]: unknown;
+}
+interface ApiEnumValueItem {
+    enumValueName: string;
+    apiID?: string;
+    [key: string]: unknown;
+}
+interface ApiEnumItem {
+    enumName: string;
+    enumValues?: ApiEnumValueItem[];
+    values?: string[];
+    [key: string]: unknown;
+}
+interface ApiSequenceItem {
+    sequenceName: string;
+    [key: string]: unknown;
+}
+/**
+ * API response format. Supports both old and new interfaces:
+ * - Old (listTableView): { table, view, materializedView }
+ * - New (/v1/app/:appID/dataloom/schema): { tables, views, materializedViews, enums, sequences }
+ */
+interface ApiTableViewResponse {
+    table?: {
+        data: ApiTableItem[];
+        count: number;
+    };
+    view?: {
+        data: ApiTableItem[];
+        count: number;
+    };
+    materializedView?: {
+        data: ApiTableItem[];
+        count: number;
+    };
+    tables?: {
+        data: ApiTableItem[];
+        count: number;
+    };
+    views?: {
+        data: ApiTableItem[];
+        count: number;
+    };
+    materializedViews?: {
+        data: ApiTableItem[];
+        count: number;
+    };
+    enums?: ApiEnumItem[];
+    sequences?: ApiSequenceItem[];
+}
+
+interface FetchOptions {
+    appId: string;
+    workspace: string;
+    dbBranch?: string;
+    timeoutMs?: number;
+}
+declare function resolveEnvOptions(env?: Record<string, string | undefined>): FetchOptions;
+
+declare function normalizeApiResponse(response: ApiTableViewResponse): SchemaData;
+
+declare function generateSchemaCode(data: SchemaData): string;
+
+interface GenerateSchemaOptions extends FetchOptions {
+    /** Skip specific enhancers by name */
+    skipEnhancers?: string[];
+    /** Export custom type definitions (userProfile, fileAttachment, etc.). Default: false */
+    exportCustomTypes?: boolean;
+}
+/**
+ * Full pipeline: fetch API data → generate code → enhance.
+ * Returns the final schema.ts content as a string.
+ */
+declare function generateSchema(options: GenerateSchemaOptions): Promise<string>;
+/**
+ * Generate from pre-fetched SchemaData (useful for testing without API).
+ */
+declare function generateSchemaFromData(schemaData: SchemaData, options?: {
+    skipEnhancers?: string[];
+    exportCustomTypes?: boolean;
+}): string;
+
+export { type EnumSchema, type FetchOptions, type FieldSchema, type GenerateSchemaOptions, type SchemaData, type TableSchema, type ViewSchema, generateSchema, generateSchemaCode, generateSchemaFromData, normalizeApiResponse, resolveEnvOptions };

package/dist/index.js

@@ -0,0 +1,15 @@
+import { createRequire } from "node:module"; const require = createRequire(import.meta.url);
+import {
+  generateSchema,
+  generateSchemaCode,
+  generateSchemaFromData,
+  normalizeApiResponse,
+  resolveEnvOptions
+} from "./chunk-QO7QQCAM.js";
+export {
+  generateSchema,
+  generateSchemaCode,
+  generateSchemaFromData,
+  normalizeApiResponse,
+  resolveEnvOptions
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@lark-apaas/db-schema-sync",
+  "version": "0.1.0-alpha.1",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": "./dist/bin.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@lark-apaas/http-client": "^0.1.2",
+    "dotenv": "^17.3.1",
+    "tiny-pinyin": "^1.3.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsup": "^8.3.5",
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4"
+  }
+}