sonamu 0.5.7 → 0.7.0

package/src/syncer/file-patterns.ts

@@ -0,0 +1,56 @@
+import path from "path";
+import { Sonamu } from "../api/sonamu";
+import type { AbsolutePath, ApiRelativePath } from "../utils/path-utils";
+
+export type FileType =
+  | "model"
+  | "types"
+  | "functions"
+  | "generated"
+  | "entity"
+  | "frame"
+  | "config";
+
+export type GlobPattern<T extends ApiRelativePath | AbsolutePath> = {
+  [key in FileType]: T;
+};
+
+/**
+ * Syncer가 관심 가지고 지켜보는 파일들입니다.
+ * 이 파일들에 변경이 생기면 추가적인 작업(이하 "싱크" 또는 "싱크 액션")을 수행합니다.
+ * 이 작업이라 함은 파일 복사 또는 템플릿 렌더링을 통한 code generation을 의미합니다.
+ *
+ * **경로 형식**: API 상대 경로 (src/로 시작)
+ * **사용**: getChecksumPatternGroupInAbsolutePath()로 절대 경로 변환 후 glob 사용
+ */
+export const checksumPatternGroup: GlobPattern<ApiRelativePath> = {
+  entity: "src/application/**/*.entity.json",
+  types: "src/application/**/*.types.ts",
+  generated: "src/application/sonamu.generated.ts",
+  model: "src/application/**/*.model.ts",
+  frame: "src/application/**/*.frame.ts",
+  functions: "src/application/**/*.functions.ts",
+  config: "sonamu.config.ts",
+};
+
+/**
+ * API 상대 경로 패턴을 절대 경로 패턴으로 변환합니다.
+ *
+ * **목적**: Glob 패턴을 파일시스템에서 사용할 수 있는 절대 경로로 변환
+ *
+ * **사용처**: checksum.ts에서 실제 파일을 찾을 때
+ *
+ * @returns 절대 경로 기반 Glob 패턴 맵
+ *
+ * @example
+ * // 입력: { entity: "src/application/**\/*.entity.json" }
+ * // 출력: { entity: "/Users/.../api/src/application/**\/*.entity.json" }
+ */
+export function getChecksumPatternGroupInAbsolutePath(): GlobPattern<AbsolutePath> {
+  return Object.fromEntries(
+    Object.entries(checksumPatternGroup).map(([key, value]) => [
+      key,
+      path.join(Sonamu.apiRootPath, value), // API 상대 경로 → 절대 경로
+    ]),
+  ) as GlobPattern<AbsolutePath>;
+}

package/src/syncer/index.ts

@@ -1 +1,7 @@
+export * from "./api-parser";
+export * from "./checksum";
+export * from "./code-generator";
+export * from "./entity-operations";
+export * from "./file-patterns";
+export * from "./module-loader";
 export * from "./syncer";

package/src/syncer/module-loader.ts

@@ -0,0 +1,128 @@
+import path from "path";
+import { z } from "zod";
+import type { BaseFrameClass } from "../api/base-frame";
+import type { ApiDecoratorOptions } from "../api/decorators";
+import { Sonamu } from "../api/sonamu";
+import type { BaseModelClass } from "../database/base-model";
+import type { ApiParam, ApiParamType } from "../types/types";
+import { globAsync } from "../utils/async-utils";
+import { importMembers } from "../utils/esm-utils";
+import { type AbsolutePath, runtimePath } from "../utils/path-utils";
+import { readApisFromFile } from "./api-parser";
+
+export type LoadedApis = {
+  typeParameters: ApiParamType.TypeParam[];
+  parameters: ApiParam[];
+  returnType: ApiParamType;
+  modelName: string;
+  methodName: string;
+  path: string;
+  options: ApiDecoratorOptions;
+}[];
+
+// biome-ignore lint/suspicious/noExplicitAny: zod 스키마를 로드할 때 사용하는 타입
+export type LoadedTypes = { [typeName: string]: z.ZodObject<any> };
+
+export type LoadedModels = {
+  [modelName: string]: BaseModelClass | BaseFrameClass;
+};
+
+/**
+ * *.model.ts와 *.frame.ts 파일들에서 API 메소드를 파싱하여 로드합니다.
+ * registeredApis에 API가 등록되어 있어야 하기 때문에, *.model.ts 파일들을 먼저 import해야 합니다.
+ * 따라서 loadModels()를 먼저 호출해야 합니다.
+ */
+export async function loadApis(): Promise<LoadedApis> {
+  // 얘는 특이하게도 환경에 따라 .ts나 .js를 import하는 경우가 아니고,
+  // 타입이 살아있는 .ts 소스 코드만을 읽어야 합니다.
+  // 이것은 dev서버(hot reload)가 아닌 production 환경에서도 동일합니다.
+  // 모델들의 .ts 파일이 있어야 이를 읽어서 라우트를 등록할 수 있어요!
+  const modelPathsPattern = path.join(
+    Sonamu.apiRootPath,
+    "src/application/**/*.{model,frame}.ts", // !! runtimePath 안 씀 주의 !!
+  );
+  const modelPaths = (await globAsync(modelPathsPattern)) as AbsolutePath[];
+
+  const apis: LoadedApis = [];
+  for (const filePath of modelPaths) {
+    const parsedApis = await readApisFromFile(filePath);
+    apis.push(...parsedApis);
+  }
+  // console.log(
+  //   chalk.gray(`[Loading] Loaded APIs from "*.model.ts" files: ${count} files.`)
+  // );
+
+  for (const api of apis) {
+    if (api.path === "") {
+      // api의 경로(path)가 "텅 비어있음"인 상태입니다.
+      // 이는 @api와 함께 사용해야 하는 데코레이터(가령 @upload)가 @api 없이 붙은 상황입니다.
+      throw new Error(
+        `API ${api.modelName}.${api.methodName} has no path. Please attach @api decorator to the method.`,
+      );
+    }
+  }
+
+  return apis;
+}
+
+/**
+ * *.model.ts와 *.frame.ts 파일들에서 Model/Frame 클래스 인스턴스를 로드합니다.
+ */
+export async function loadModels(): Promise<LoadedModels> {
+  const modelPathsPattern = path.join(
+    Sonamu.apiRootPath,
+    runtimePath("src/application/**/*.{model,frame}.ts"),
+  );
+  const modelPaths = await globAsync(modelPathsPattern);
+
+  const models: LoadedModels = {};
+  let _count = 0;
+  for (const filePath of modelPaths) {
+    const importedMembers = await importMembers<BaseModelClass | BaseFrameClass>(filePath);
+
+    for (const { name, value } of importedMembers) {
+      if (name.endsWith("Model") || name.endsWith("Frame")) {
+        models[name] = value;
+      }
+    }
+    _count++;
+  }
+  // console.log(
+  //   chalk.gray(
+  //     `[Loading] Loaded model/frame instances from ${runtimePath("*.{model,frame}.ts")} files: ${count} files.`
+  //   )
+  // );
+
+  return models;
+}
+
+/**
+ * *.types.ts와 *.generated.ts 파일들에서 Zod 스키마를 로드합니다.
+ */
+export async function loadTypes(): Promise<LoadedTypes> {
+  const typePathsPatterns = [
+    path.join(Sonamu.apiRootPath, runtimePath("src/application/**/*.types.ts")),
+    path.join(Sonamu.apiRootPath, runtimePath("src/application/**/*.generated.ts")),
+  ];
+  const typePaths = (await Promise.all(typePathsPatterns.map(globAsync))).flat();
+
+  const types: LoadedTypes = {};
+  let _count = 0;
+  for (const filePath of typePaths) {
+    // biome-ignore lint/suspicious/noExplicitAny: zod 스키마를 로드할 때 사용하는 타입
+    const importedMembers = await importMembers<z.ZodObject<any>>(filePath);
+    for (const { name, value } of importedMembers) {
+      if (value instanceof z.ZodObject) {
+        types[name] = value;
+      }
+    }
+    _count++;
+  }
+  // console.log(
+  //   chalk.gray(
+  //     `[Loading] Loaded zod types from ${runtimePath("*.types.ts")} and ${runtimePath("*.generated.ts")} files: ${count} files.`
+  //   )
+  // );
+
+  return types;
+}