sonamu 0.6.0 → 0.7.1

package/src/entity/entity-manager.ts

@@ -1,23 +1,16 @@
-import { glob } from "fs/promises";
+import assert from "assert";
+import chalk from "chalk";
+import { glob, readFile } from "fs/promises";
 import inflection from "inflection";
-import * as _ from "lodash-es";
 import path from "path";
-import { Entity } from "./entity";
-import { EntityJson } from "../types/types";
+import { prettifyError } from "zod";
 import { Sonamu } from "../api/sonamu";
-import { readFile } from "fs/promises";
-import { AbsolutePath } from "../utils/path-utils";
-import assert from "assert";
+import { type EntityJson, EntityJsonSchema } from "../types/types";
+import type { AbsolutePath } from "../utils/path-utils";
+import { Entity } from "./entity";
 
 export type EntityNamesRecord = Record<
-  | "fs"
-  | "fsPlural"
-  | "camel"
-  | "camelPlural"
-  | "capital"
-  | "capitalPlural"
-  | "upper"
-  | "constant",
+  "fs" | "fsPlural" | "camel" | "camelPlural" | "capital" | "capitalPlural" | "upper" | "constant",
   string
 >;
 type TableSpec = {
@@ -35,15 +28,22 @@ class EntityManagerClass {
     if (this.isAutoloaded) {
       return;
     }
-    const pathPattern = path.join(
-      Sonamu.apiRootPath,
-      "/src/application/**/*.entity.json"
-    );
-
-    let count = 0;
-    for await (const file of glob(path.resolve(pathPattern!))) {
-      await this.register(JSON.parse((await readFile(file)).toString()));
-      count++;
+    const pathPattern = path.join(Sonamu.apiRootPath, "/src/application/**/*.entity.json");
+
+    for await (const file of glob(path.resolve(pathPattern))) {
+      const json = JSON.parse((await readFile(file)).toString());
+
+      // entity.json 스키마 검증
+      const error = this.schemaValidate(json);
+      if (error) {
+        const relativePath = path.relative(Sonamu.apiRootPath, file);
+        const errorMessage = prettifyError(error);
+        console.error(
+          chalk.red(`Invalid entity.json schema: ${relativePath}\n${chalk.yellow(errorMessage)}`),
+        );
+      }
+
+      await this.register(json);
     }
     // !doSilent &&
     //   console.log(
@@ -55,6 +55,11 @@ class EntityManagerClass {
     this.isAutoloaded = true;
   }
 
+  schemaValidate(json: unknown) {
+    const result = EntityJsonSchema.safeParse(json);
+    return result.success ? null : result.error;
+  }
+
   async reload(doSilent: boolean = false) {
     this.entities.clear();
     this.modulePaths.clear();
@@ -139,9 +144,7 @@ class EntityManagerClass {
 
     return {
       fs: inflection.dasherize(inflection.underscore(entityId)).toLowerCase(),
-      fsPlural: inflection
-        .dasherize(inflection.underscore(pluralized))
-        .toLowerCase(),
+      fsPlural: inflection.dasherize(inflection.underscore(pluralized)).toLowerCase(),
       camel: inflection.camelize(entityId, true),
       camelPlural: inflection.camelize(pluralized, true),
       capital: entityId,
@@ -151,10 +154,15 @@ class EntityManagerClass {
     };
   }
 
+  /**
+   * EntityId는 Model을 제외한 PascalCase 이름입니다. (ex. "User")
+   * @param filePath
+   * @returns
+   */
   getEntityIdFromPath(filePath: AbsolutePath): string {
     const matched = filePath.match(/application\/(.+)\//);
     assert(matched?.[1]);
-    return inflection.camelize(matched[1].replace(/\-/g, "_"));
+    return inflection.camelize(matched[1].replace(/-/g, "_"));
   }
 }