Merge pull request #15 from techsavvyash/documentation

Documentation #11

Author: sooraj1002

README.md

@@ -1,2 +1,28 @@
 # dynamo-prisma
-Create Prisma Models Dynamically
+
+Generate Prisma schema dynamically using json file.
+
+## Installation
+
+### using git-clone
+
+```bash
+git clone https://github.com/techsavvyash/dynamo-prisma.git
+npm link
+```
+
+### using npm
+
+```bash
+npm install @techsavvyash/dynamo-prisma
+```
+
+## Usage
+
+Visit [dynamo-prisma function](./docs/functions.md) for more details.
+
+for info on schema you should follow, visit: [JSON Schema](./docs/schema.md)
+
+## License
+
+[MIT License](./LICENSE)

docs/functions.md

@@ -0,0 +1,23 @@
+# Exported Function in dynamo Prisma
+
+## Installation
+
+Follow guide given in [README.md](../README.md)
+
+- #### generateSchemaFromJson(jsonData, prismaFilePath);
+
+  Argument of function:
+
+  - `jsonData: Schema` - JSON as per schema model which is defined in [JSON Schema](./schema.md)
+
+  - OPTIONAL `prismaFilePath?: string` - Path of the prisma schema file. If file is present, it will append the new schema to the existing schema. If file is not present, it will create a new schema file. Default value is `./prisma/schema.prisma`
+
+  Returns: {status: boolean, message: string, error: string}
+
+- #### GenerateSchemaFile(filePath);
+
+  Argument of function:
+
+  - `filePath: String` - file path of the json file.
+
+  Returns: {status: boolean, message: string, error: string}

docs/schema.md

@@ -0,0 +1,39 @@
+# dynamo-prisma schema:
+
+example json file: [JSON DEMO](../demo.json)
+
+```yaml
+Schema:
+  schema:
+    - schemaName: string
+      fields:
+        - fieldName: string
+          type: string
+          description: string
+          maxLength?: number | null
+          nullable: boolean
+          unique: boolean
+          default?: string | null
+          autoincrement?: boolean
+          uuid?: boolean
+          isId?: boolean
+          vectorEmbed?: boolean
+          embeddingAlgo?: string
+          isForeignKey?: boolean
+          isList?: boolean
+      description: string
+  dataSource:
+    name: string
+    provider: DataSourceProvider
+    url:
+      url: string
+      fromEnv: DataSourceURLEnv
+  enum:
+    - name: string
+      values: [string]
+  generator:
+    generatorName: string
+    provider: string
+    output: string
+    binaryTargets: [string]
+```

src/fileExists.ts

@@ -11,7 +11,10 @@ export function generateSchemaFromJson(
   prismaFilePath: string = "./prisma/schema.prisma"
 ) {
   if (!verifyFilePath(prismaFilePath)) {
-    throw new Error("File cannot have '-' in between its name");
+    return {
+      status: false,
+      message: "File cannot have '-' in between its name",
+    };
   }
   if (fs.existsSync(prismaFilePath)) {
     console.log("File exists");
@@ -26,11 +29,13 @@ export function generateSchemaFromJson(
     }
 
     JsonChecks(jsonData, models);
-    generateSchemaWhenFilePresent(jsonData, prismaFilePath);
+    const output = generateSchemaWhenFilePresent(jsonData, prismaFilePath);
+    return output;
   } else {
     console.log("Applying Checks....");
     JsonChecks(jsonData, []);
-    generateIfNoSchema(jsonData);
+    const output = generateIfNoSchema(jsonData);
+    return output;
   }
 }
 
@@ -85,7 +90,9 @@ export function readJsonFile(filePath: string): Promise<Schema> {
   });
 }
 
-export async function generateIfNoSchema(jsonData: Schema): Promise<void> {
+export async function generateIfNoSchema(
+  jsonData: Schema
+): Promise<{ status: boolean; message?: string; error?: string }> {
   const models: any[] = createModels(jsonData.schema);
   console.log("Model generated");
   // console.log(models);
@@ -138,7 +145,11 @@ export async function generateIfNoSchema(jsonData: Schema): Promise<void> {
   fs.mkdirSync("./prisma", { recursive: true });
   fs.writeFile("./prisma/schema.prisma", result, (err) => {
     if (err) {
-      console.error("Error writing Prisma schema:", err);
+      return {
+        status: false,
+        message: "Error writing Prisma schema",
+        error: err,
+      };
     } else {
       console.log("Prisma schema generated successfully!");
       let migrateModels: string[] = jsonData.schema.map(
@@ -147,13 +158,21 @@ export async function generateIfNoSchema(jsonData: Schema): Promise<void> {
       validateAndMigrate(migrateModels);
     }
   });
+
+  return {
+    status: true,
+    message: "Prisma schema generated successfully!",
+  };
 }
 export async function generateSchemaWhenFilePresent(
   jsonData: Schema,
   prismaFilePath: string
 ) {
   if (!verifyFilePath(prismaFilePath)) {
-    throw new Error("File cannot have '-' in between its name");
+    return {
+      status: false,
+      message: "File cannot have '-' in between its name",
+    };
   }
   const FileData = fs.readFileSync(prismaFilePath, "utf8");
   const models: any[] = createModels(jsonData.schema);
@@ -174,7 +193,11 @@ export async function generateSchemaWhenFilePresent(
   fs.mkdirSync("./prisma", { recursive: true });
   fs.writeFile("./prisma/schema.prisma", result, (err) => {
     if (err) {
-      console.error("Error writing Prisma schema:", err);
+      return {
+        status: false,
+        message: "Error writing Prisma schema",
+        error: err,
+      };
     } else {
       console.log("Prisma schema generated successfully!");
       let migrateModels: string[] = jsonData.schema.map(
@@ -183,16 +206,24 @@ export async function generateSchemaWhenFilePresent(
       validateAndMigrate(migrateModels);
     }
   });
+
+  return {
+    status: true,
+    message: "Prisma schema generated successfully!",
+  };
 }
 
 function validateAndMigrate(migrateModels: string[]) {
   // TODO: DONE RUN: npx prisma validate
   exec("npx prisma validate", (error, stdout, stderr) => {
     if (error) {
-      console.error("Error executing 'npx prisma validate':", error);
-      return;
+      return {
+        status: false,
+        message: "Error executing 'npx prisma validate'",
+        error: error,
+      };
     }
-    console.log("commands executed successfully", stdout);
+    return { status: true, message: "commands executed successfully", stdout };
   });
 
   // TODO: DONE RUN: prisma migrate dev
@@ -203,7 +234,18 @@ function validateAndMigrate(migrateModels: string[]) {
       stdio: "inherit",
     }
   );
+  shell.on("error", (err) => {
+    return {
+      status: false,
+      message: "Error executing 'npx prisma migrate dev'",
+      error: err,
+    };
+  });
   shell.on("close", (code) => {
     console.log("[shell] terminated:", code);
   });
+  return {
+    status: true,
+    message: "commands executed successfully",
+  };
 }

test/schemaGenerator.spec.ts

@@ -1,5 +1,5 @@
-import { Schema, createFields } from "../src/schemaGenerator";
-import * as fs from "fs";
+// import { Schema, createFields } from "../src/schemaGenerator";
+// import * as fs from "fs";
 
 // describe("createFields", () => {
 //   it("should create an array of fields based on the input", () => {