improved documentation

Author: lastlink

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@funktechno/little-mermaid-2-the-sql",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

readme.md

@@ -9,6 +9,131 @@
 ## Generating Mermaid erDiagram
 * see [samples](./samples/readme.md) for more information
 
+## Ala Cart
+1. `npm install --save @funktechno/little-mermaid-2-the-sql`
+1. Example
+    * from markdown content
+      ```typescript
+      import { GenerateSqlFromMermaid } from "@funktechno/little-mermaid-2-the-sql/lib/src/Library";
+      import { MarkdownContentResponseI } from "@funktechno/little-mermaid-2-the-sql/lib/src/types";
+
+      
+      const markdownContent:MarkdownContentResponseI ={
+        settings: {
+            database: "postgres",
+            outputName: "result",
+            isRaw: false,
+            src: ""
+        },
+        content:`
+        #Test
+        \`\`\`mermaid
+        erDiagram
+            %% comment 1
+            Persons {
+                int PersonID PK "NOT NULL"
+                varchar255 LastName
+                varchar255 FirstName
+                varchar255 Address
+                varchar255 City
+            }
+
+            %% comment 2
+            Orders {
+                int OrderID PK "NOT NULL"
+                int PersonID FK "NOT NULL"
+            }
+  
+            Persons ||--o{ Orders : "[Persons.PersonId] to [Orders.PersonId]"
+        \`\`\`
+        `
+      };
+
+      const sqlOutputs = GenerateSqlFromMermaid(markdownContent);
+      ```
+
+    * manual mermaid db model
+      ```typescript
+      import { DbParser } from "@funktechno/little-mermaid-2-the-sql/lib/src/generate-sql-ddl";
+      import erDb from "@funktechno/little-mermaid-2-the-sql/lib/src/mermaid/src/diagrams/er/erDb";
+
+      const db = erDb;
+
+      let entityName = "Persons";
+      // load mermaid db with entities
+      db.addEntity(entityName);
+      let attributes:DbEntityAttributesDefinition[] = [
+        {
+          attributeName: "PersonID",
+          attributeKeyType: "PK",
+          attributeType: "int",
+          attributeComment: "NOT NULL"
+        },
+        {
+          attributeName: "LastName",
+          attributeType: "varchar255"
+        },
+        {
+          attributeName: "FirstName",
+          attributeType: "varchar255"
+        },
+        {
+          attributeName: "Address",
+          attributeType: "varchar255"
+        },
+        {
+          attributeName: "City",
+          attributeType: "varchar255"
+        }
+      ];
+      db.addAttributes(entityName,attributes);
+
+      entityName = "Orders";
+      db.addEntity(entityName);
+      attributes = [
+        {
+          attributeName: "OrderID",
+          attributeKeyType: "PK",
+          attributeType: "int",
+          attributeComment: "NOT NULL"
+        },
+        {
+          attributeName: "PersonID",
+          attributeKeyType: "FK",
+          attributeType: "int",
+          attributeComment: "NOT NULL"
+        }
+      ];
+      db.addAttributes(entityName,attributes);
+
+      const relSpec:DbRelSpec= {
+        cardA: "ZERO_OR_MORE",
+        cardB: "ONLY_ONE",
+        relType: "IDENTIFYING"
+      };
+
+      db.addRelationship("Persons", `[Persons.PersonId] to [${entityName}.PersonId]`, entityName, relSpec);
+      const ddlSyntax = new DbParser('sqlite', db).getSQLDataDefinition();
+      ```
+    * sql output
+      ```sql
+      CREATE TABLE "Persons" (
+        "City" varchar(255),
+        "Address" varchar(255),
+        "FirstName" varchar(255),
+        "LastName" varchar(255),
+        "PersonID" int NOT NULL,
+        PRIMARY KEY("PersonID")
+      );
+
+      CREATE TABLE "Orders" (
+        "PersonID" int NOT NULL,
+        "OrderID" int NOT NULL,
+        PRIMARY KEY("OrderID"),
+        FOREIGN KEY ("PersonId") REFERENCES "Persons"("PersonId")
+      );
+      ```
+
 ## Development
 
 1. git clone repo

tests/data/results/GenerateSqlFromMermaid.json

@@ -0,0 +1 @@
+{}

tests/data/results/getSQLDataDefinition.json

@@ -1,3 +1,3 @@
 {
-    "Generate DDL examples Should generate create table SQL syntax": "CREATE TABLE \"Persons\" (\n\t\"City\" varchar(255),\n\t\"Address\" varchar(255),\n\t\"FirstName\" varchar(255),\n\t\"LastName\" varchar(255),\n\t\"PersonID\" int NOT NULL,\n\tPRIMARY KEY(\"PersonID\")\n);\n\nCREATE TABLE \"Orders\" (\n\t\"PersonID\" int NOT NULL,\n\t\"OrderID\" int NOT NULL,\n\tPRIMARY KEY(\"OrderID\")\n);\n\n"
+    "Generate DDL examples Should generate create table SQL syntax": "CREATE TABLE \"Persons\" (\n\t\"City\" varchar(255),\n\t\"Address\" varchar(255),\n\t\"FirstName\" varchar(255),\n\t\"LastName\" varchar(255),\n\t\"PersonID\" int NOT NULL,\n\tPRIMARY KEY(\"PersonID\")\n);\n\nCREATE TABLE \"Orders\" (\n\t\"PersonID\" int NOT NULL,\n\t\"OrderID\" int NOT NULL,\n\tPRIMARY KEY(\"OrderID\"),\n\tFOREIGN KEY (\"PersonId\") REFERENCES \"Persons\"(\"PersonId\")\n);\n\n"
 }

tests/src/Library.spec.ts

@@ -0,0 +1,53 @@
+import { getExpected, updateExpected } from "../utils/helper";
+import { GenerateSqlFromMermaid } from "../../src/Library";
+import { MarkdownContentResponseI } from "../../src/types";
+
+const dataSource = "GenerateSqlFromMermaid";
+
+describe("Generate DDL examples from markdown", () => {
+    it("Create DLL", async () => {
+      const markdownContent:MarkdownContentResponseI ={
+        settings: {
+            database: "postgres",
+            outputName: "result",
+            isRaw: false,
+            src: ""
+        },
+        content:`
+        #Test
+        \`\`\`mermaid
+        erDiagram
+            %% comment 1
+            Persons {
+                int PersonID PK "NOT NULL"
+                varchar255 LastName
+                varchar255 FirstName
+                varchar255 Address
+                varchar255 City
+            }
+
+            %% comment 2
+            Orders {
+                int OrderID PK "NOT NULL"
+                int PersonID FK "NOT NULL"
+            }
+  
+            Persons ||--o{ Orders : "[Persons.PersonId] to [Orders.PersonId]"
+        \`\`\`
+        `
+      };
+      // junit compile error for require parser.js export
+    //   const sqlOutputs = GenerateSqlFromMermaid(markdownContent);
+  
+    //   const dataKey = expect.getState().currentTestName || "unknown";
+  
+    //   const expectedResult = await getExpected(dataSource, dataKey);
+  
+    //   if (sqlOutputs != expectedResult) {
+    //     await updateExpected(dataSource, dataKey, sqlOutputs);
+    //   }
+  
+    //   expect(sqlOutputs).toStrictEqual(expectedResult);
+    });
+  });
+  

tests/src/generate-sql-ddl.spec.ts

@@ -2,6 +2,7 @@ import { DbParser } from "../../src/generate-sql-ddl";
 import erDb from "../../src/mermaid/src/diagrams/er/erDb";
 import { DbEntityAttributesDefinition, DbRelSpec } from "../../src/types";
 import { getExpected, updateExpected } from "../utils/helper";
+import * as fs from "fs";
 
 const dataSource = "getSQLDataDefinition";
 describe("Generate DDL examples", () => {
@@ -59,7 +60,7 @@ describe("Generate DDL examples", () => {
       relType: "IDENTIFYING"
     };
 
-    db.addRelationship("Persons", entityName,`[Persons.PersonId] to [${entityName}.PersonId]`, relSpec);
+    db.addRelationship("Persons", `[Persons.PersonId] to [${entityName}.PersonId]`,entityName, relSpec);
     // `erDiagram artists { }`;
     const ddlSyntax = new DbParser("sqlite", db).getSQLDataDefinition();
 
@@ -74,5 +75,10 @@ describe("Generate DDL examples", () => {
     // console.log(result);
     expect(ddlSyntax).toStrictEqual(expectedResult);
     // expect(ddlSyntax).toBe('CREATE TABLE artists');
+
+    // await fs.writeFileSync(
+    //   "output-sqlite.sql",
+    //   ddlSyntax
+    // );
   });
 });