Create index.d.ts file

package.json

@@ -4,6 +4,7 @@
   "description": "Generate ERD UML file from Schema DDL file",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
+  "types": "./src/index.d.ts",
   "files": [
     "dist"
   ],

src/index.d.ts

@@ -0,0 +1,11 @@
+export type parseDdlType = {
+  [tableName: string]: {
+    columnNames: string[],
+    primaryKeys: string[],
+  }
+};
+
+export type pumlOutputType = {
+  pumlFilePath: string;
+  pumlStr: string;
+};

src/parse_ddl.ts

@@ -2,6 +2,7 @@ import { Parser } from 'sql-ddl-to-json-schema';
 import assert from 'assert';
 import { JSONSchema7 } from 'json-schema';
 import config from './unparsable.config';
+import { parseDdlType } from './index.d';
 
 const parser = new Parser('mysql');
 
@@ -128,13 +129,6 @@ const removeSqlComments = (sqlStr: string): string => sqlStr
   .replace(/COMMENT\s+['"](.*?)['"]/gi, '') // https://stackoverflow.com/a/171483
   .replace(/\/\*.*?\*\/|--.*?\n/gs, ''); // https://stackoverflow.com/a/21018155
 
-export type parseDdlType = {
-  [tableName: string]: {
-    columnNames: string[],
-    primaryKeys: string[],
-  }
-};
-
 export default (sqlStr: string): parseDdlType => splitDdl(removeSqlComments(sqlStr))
   .reduce(
     (acc, sql) => {

src/plantuml_table.ts

@@ -1,4 +1,4 @@
-import { parseDdlType } from './parse_ddl';
+import { parseDdlType } from './index.d';
 
 function generateEntity(
   tableName: string,

src/schema_to_erd.ts

@@ -1,13 +1,9 @@
 import { promises as fs } from 'fs';
 import path from 'path';
 import { PathLike } from 'node:fs';
-import parseDdl, { parseDdlType } from './parse_ddl';
+import parseDdl from './parse_ddl';
 import generatePlantUml from './plantuml_table';
-
-export type pumlOutputType = {
-  pumlFilePath: string;
-  pumlStr: string;
-};
+import { parseDdlType, pumlOutputType } from './index.d';
 
 export default async function schemaToErd(
   schemaFilePath: PathLike,