@akanjs/devkit 1.0.20 → 2.1.0-rc.1

package/akanConfig/akanConfig.ts

@@ -0,0 +1,384 @@
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { type AkanI18nConfig, resolveAkanI18nConfig } from "akanjs/common";
+import type { AkanImageConfig } from "akanjs/server";
+import type { App, Lib } from "../commandDecorators";
+import { WorkspaceExecutor } from "../executors";
+import type { BaseDevEnv, PackageJson } from "../types";
+import {
+  type AkanMobileConfig,
+  type AkanMobileTargetConfig,
+  type AkanRouteConfig,
+  type AppConfigResult,
+  type Arch,
+  archs,
+  type DatabaseMode,
+  type DeepPartial,
+  type DockerConfig,
+  type LibConfigResult,
+} from "./types";
+
+const DEFAULT_BARREL_IMPORTS = ["akanjs/webkit", "akanjs/common", "akanjs/ui"];
+const DEFAULT_OPTIMIZE_IMPORTS = [
+  "lucide-react",
+  "date-fns",
+  "lodash-es",
+  "ramda",
+  "antd",
+  "react-bootstrap",
+  "ahooks",
+  "@ant-design/icons",
+  "@headlessui/react",
+  "@headlessui-float/react",
+  "@heroicons/react/20/solid",
+  "@heroicons/react/24/solid",
+  "@heroicons/react/24/outline",
+  "@visx/visx",
+  "@tremor/react",
+  "rxjs",
+  "@mui/material",
+  "@mui/icons-material",
+  "recharts",
+  "react-use",
+  "@material-ui/core",
+  "@material-ui/icons",
+  "@tabler/icons-react",
+  "mui-core",
+  "react-icons/*",
+];
+const WORKSPACE_BARREL_FACETS = ["ui", "webkit", "common", "client", "server"] as const;
+const SSR_RUNTIME_PACKAGES = ["react", "react-dom", "react-server-dom-webpack"] as const;
+const NATIVE_RUNTIME_PACKAGES = ["sharp"] as const;
+const AKAN_RUNTIME_PACKAGES = new Set<string>([...SSR_RUNTIME_PACKAGES, ...NATIVE_RUNTIME_PACKAGES]);
+const DEFAULT_AKAN_IMAGE_CONFIG: AkanImageConfig = {
+  deviceSizes: [640, 750, 828, 1080, 1200, 1920, 2048, 3840],
+  imageSizes: [32, 48, 64, 96, 128, 256, 384],
+  formats: ["image/webp"],
+  qualities: [75],
+  minimumCacheTTL: 14400,
+  remotePatterns: [],
+  localPatterns: [{ pathname: "/**" }],
+  dangerouslyAllowSVG: false,
+  maximumRedirects: 3,
+  fetchTimeoutMs: 7000,
+  maxRemoteBytes: 25 * 1024 * 1024,
+};
+
+export class AkanAppConfig implements AppConfigResult {
+  app: App;
+  rootPackageJson: PackageJson;
+  docker: DockerConfig;
+  defaultDatabaseMode: DatabaseMode;
+  externalLibs: string[];
+  barrelImports: string[];
+  optimizeImports: string[];
+  images: AkanImageConfig;
+  i18n: AkanI18nConfig;
+  publicEnv: string[];
+  mobile: AkanMobileConfig;
+  baseDevEnv: BaseDevEnv;
+  libs: string[];
+  domains = new Set<string>();
+  subRoutes = new Map<string, Set<string>>();
+  basePaths = new Set<string>();
+  branches = new Set<string>(["debug", "develop", "main"]);
+  constructor(
+    app: App,
+    libs: string[],
+    rootPackageJson: PackageJson,
+    config: DeepPartial<AppConfigResult>,
+    baseDevEnv: BaseDevEnv,
+  ) {
+    this.app = app;
+    this.rootPackageJson = rootPackageJson;
+    this.libs = libs;
+    this.baseDevEnv = baseDevEnv;
+    this.#applyRoutes(config?.routes);
+    this.defaultDatabaseMode = config?.defaultDatabaseMode ?? "single";
+    this.externalLibs = config?.externalLibs ?? [];
+    this.barrelImports = [
+      ...DEFAULT_BARREL_IMPORTS,
+      ...WORKSPACE_BARREL_FACETS.map((facet) => `@apps/${app.name}/${facet}`),
+      ...libs.flatMap((lib) => WORKSPACE_BARREL_FACETS.map((facet) => `@libs/${lib}/${facet}`)),
+      ...(config?.barrelImports ?? []),
+    ];
+    this.optimizeImports = [...new Set([...DEFAULT_OPTIMIZE_IMPORTS, ...(config?.optimizeImports ?? [])])];
+    this.images = mergeImageConfig(config?.images as Partial<AkanImageConfig> | undefined);
+    this.i18n = resolveAkanI18nConfig(config?.i18n);
+    process.env.AKAN_PUBLIC_DEFAULT_LOCALE = this.i18n.defaultLocale;
+    process.env.AKAN_PUBLIC_LOCALES = this.i18n.locales.join(",");
+    this.publicEnv = (config?.publicEnv as string[] | undefined) ?? ([] as string[]);
+    this.mobile = this.#resolveMobileConfig(config.mobile);
+    this.docker = this.#makeDockerContent(config?.docker ?? {});
+  }
+  #resolveMobileConfig(mobile: DeepPartial<AkanMobileConfig> | undefined): AkanMobileConfig {
+    const { targets: rawTargets, ...rawMobile } = mobile ?? {};
+    const appName = rawMobile.appName ?? this.app.name;
+    const appId = rawMobile.appId ?? `com.${this.app.name}.app`;
+    const version = rawMobile.version ?? "0.0.1";
+    const buildNum = rawMobile.buildNum ?? 1;
+    const defaultTargetName = this.#defaultMobileTargetName(rawTargets);
+    const targetEntries = Object.entries(
+      rawTargets ?? {
+        [defaultTargetName]: {},
+      },
+    );
+    const targets = Object.fromEntries(
+      targetEntries.map(([name, rawTarget]) => {
+        const target = rawTarget as DeepPartial<AkanMobileTargetConfig>;
+        const fallbackBasePath = !rawTargets && this.basePaths.has(name) ? name : undefined;
+        const basePath = (target.basePath ?? fallbackBasePath)?.replace(/^\/+|\/+$/g, "") || undefined;
+        if (basePath && !this.basePaths.has(basePath)) {
+          throw new Error(
+            `Mobile target '${name}' uses unknown basePath '${basePath}' in apps/${this.app.name}/akan.config.ts`,
+          );
+        }
+        const resolved = {
+          ...rawMobile,
+          ...target,
+          name,
+          basePath,
+          appName: target.appName ?? appName,
+          appId: target.appId ?? appId,
+          version: target.version ?? version,
+          buildNum: target.buildNum ?? buildNum,
+          plugins: {
+            ...rawMobile.plugins,
+            ...target.plugins,
+          },
+          android: {
+            ...rawMobile.android,
+            ...target.android,
+          },
+          ios: {
+            ...rawMobile.ios,
+            ...target.ios,
+          },
+        } satisfies AkanMobileTargetConfig;
+        return [name, resolved];
+      }),
+    );
+    return {
+      ...rawMobile,
+      appName,
+      appId,
+      version,
+      buildNum,
+      targets,
+      plugins: rawMobile.plugins,
+    } as AkanMobileConfig;
+  }
+  #defaultMobileTargetName(rawTargets: DeepPartial<AkanMobileConfig>["targets"] | undefined) {
+    if (rawTargets && Object.keys(rawTargets).length > 0) return Object.keys(rawTargets)[0] as string;
+    return this.basePaths.has(this.app.name) ? this.app.name : "default";
+  }
+  #applyRoutes(routes: AkanRouteConfig[] = []) {
+    for (const route of routes) {
+      if (route.basePath) {
+        const basePath = route.basePath.replace(/^\/+|\/+$/g, "");
+        this.basePaths.add(basePath);
+        const domains = this.subRoutes.getOrInsert(basePath, new Set());
+        Object.keys(route.domains).forEach((branch) => void this.branches.add(branch));
+        Object.values(route.domains)
+          .flat()
+          .forEach((domain) => {
+            if (domain) domains.add(domain.toLowerCase().replace(/:\d+$/, ""));
+          });
+      } else {
+        Object.keys(route.domains).forEach((branch) => void this.branches.add(branch));
+        Object.values(route.domains)
+          .flat()
+          .forEach((domain) => {
+            if (domain) this.domains.add(domain.toLowerCase().replace(/:\d+$/, ""));
+          });
+      }
+    }
+    const appName = this.app.name.toLowerCase();
+    const serveDomain = this.baseDevEnv.serveDomain.toLowerCase();
+    if (this.subRoutes.size === 0)
+      this.branches.forEach((branch) => void this.domains.add(`${appName}-${branch}.${serveDomain}`));
+    else
+      Array.from(this.subRoutes.entries()).forEach(([basePath, domains]) => {
+        this.branches.forEach((domain) => void domains.add(`${basePath}-${domain}.${serveDomain}`));
+      });
+  }
+  #getDockerRunScripts(runs: (string | { [key in Arch]?: string })[]) {
+    return runs.map((run) => {
+      if (typeof run === "string") return `RUN ${run}`;
+      else
+        return Object.entries(run)
+          .map(
+            ([arch, script]) => `RUN if [ "$TARGETARCH" = "${arch}" ]; then \
+    ${script}; \
+  fi`,
+          )
+          .join("\n");
+    });
+  }
+  #getDockerImageScript(image: string | { [key in Arch]?: string }, defaultImage: string) {
+    if (typeof image === "string") return `FROM ${image}`;
+    else return archs.map((arch) => `FROM ${image[arch] ?? defaultImage} AS ${arch}`).join("\n");
+  }
+  #makeDockerContent(docker: DeepPartial<DockerConfig>): DockerConfig {
+    if (docker.content) return { content: docker.content, image: {}, preRuns: [], postRuns: [], command: [] };
+    const preRunScripts = this.#getDockerRunScripts(docker.preRuns ?? []);
+    const postRunScripts = this.#getDockerRunScripts(docker.postRuns ?? []);
+
+    const imageScript = docker.image
+      ? this.#getDockerImageScript(docker.image, "oven/bun:1-slim")
+      : "FROM oven/bun:1-slim";
+    const command = docker.command ?? ["bun", "main.js"];
+    const content = `${imageScript}
+RUN ln -sf /usr/share/zoneinfo/Asia/Seoul /etc/localtime
+RUN apt-get update && apt-get upgrade -y
+RUN apt-get install -y --no-install-recommends git redis build-essential python3 ca-certificates fonts-liberation libappindicator3-1 libasound2 libatk-bridge2.0-0 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgbm1 libgcc1 libglib2.0-0 libgtk-3-0 libnspr4 libnss3 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 lsb-release wget xdg-utils udev ffmpeg
+ARG TARGETARCH
+${preRunScripts.join("\n")}
+RUN mkdir -p /workspace
+WORKDIR /workspace
+COPY ./package.json ./package.json
+RUN bun install --production
+${postRunScripts.join("\n")}
+COPY . .
+ENV PORT=8282
+ENV NODE_ENV=production
+ENV AKAN_PUBLIC_REPO_NAME=${this.baseDevEnv.repoName}
+ENV AKAN_PUBLIC_SERVE_DOMAIN=${this.baseDevEnv.serveDomain}
+ENV AKAN_PUBLIC_APP_NAME=${this.app.name}
+ENV AKAN_PUBLIC_ENV=${this.baseDevEnv.env}
+${this.basePaths.size ? `ENV AKAN_PUBLIC_BASE_PATHS=${[...this.basePaths].join(",")}` : ""}
+ENV AKAN_PUBLIC_DEFAULT_LOCALE=${this.i18n.defaultLocale}
+ENV AKAN_PUBLIC_LOCALES=${this.i18n.locales.join(",")}
+ENV AKAN_PUBLIC_OPERATION_MODE=cloud
+
+CMD [${command.map((c) => `"${c}"`).join(",")}]`;
+    return { content, image: imageScript, preRuns: docker.preRuns ?? [], postRuns: docker.postRuns ?? [], command };
+  }
+  static async from(app: App) {
+    const [configImp, baseDevEnv, libs, rootPackageJson] = await Promise.all([
+      import(`${app.cwdPath}/akan.config.ts`).then((mod) => mod.default),
+      WorkspaceExecutor.getBaseDevEnv(path.join(app.workspace.workspaceRoot, ".env")),
+      app.workspace.getLibs(),
+      app.workspace.getPackageJson(),
+    ]);
+    const config = typeof configImp === "function" ? configImp(app) : configImp;
+    return new AkanAppConfig(app, libs, rootPackageJson, config, baseDevEnv);
+  }
+  #resolveProductionDependencyVersion(lib: string) {
+    const rootVersion = this.rootPackageJson.dependencies?.[lib] ?? this.rootPackageJson.devDependencies?.[lib];
+    if (rootVersion) return rootVersion;
+    const akanPackageJson = getAkanPackageJson();
+    if (AKAN_RUNTIME_PACKAGES.has(lib))
+      return akanPackageJson.dependencies?.[lib] ?? akanPackageJson.peerDependencies?.[lib];
+  }
+  getProductionPackageJson(data: Partial<PackageJson> = {}): PackageJson {
+    return {
+      name: this.app.name,
+      description: this.app.name,
+      version: "1.0.0",
+      main: "./main.js",
+      dependencies: Object.fromEntries(
+        [...new Set([...this.externalLibs, ...SSR_RUNTIME_PACKAGES, ...NATIVE_RUNTIME_PACKAGES])].map((lib) => {
+          const version = this.#resolveProductionDependencyVersion(lib);
+          if (!version) throw new Error(`Dependency ${lib} not found in package.json`);
+          return [lib, version];
+        }),
+      ),
+      ...data,
+    };
+  }
+}
+
+let akanPackageJson: PackageJson | null = null;
+
+function getAkanPackageJson() {
+  if (akanPackageJson) return akanPackageJson;
+  const sourceDir = path.dirname(fileURLToPath(import.meta.url));
+  const packageJsonPaths = [
+    path.join(sourceDir, "../../../akanjs/package.json"),
+    path.join(process.cwd(), "pkgs/akanjs/package.json"),
+    path.join(path.dirname(Bun.main), "node_modules/akanjs/package.json"),
+  ];
+  try {
+    packageJsonPaths.unshift(Bun.resolveSync("akanjs/package.json", sourceDir));
+  } catch {
+    // Monorepo source execution usually resolves Akan packages through tsconfig paths, not node_modules.
+  }
+  for (const packageJsonPath of packageJsonPaths) {
+    try {
+      akanPackageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8")) as PackageJson;
+      return akanPackageJson;
+    } catch {
+      // Try the next known layout: source package first, bundled CLI package second.
+    }
+  }
+  akanPackageJson = { name: "akanjs", version: "0.0.0", description: "akanjs", dependencies: {} };
+  return akanPackageJson;
+}
+
+function mergeImageConfig(config: Partial<AkanImageConfig> = {}): AkanImageConfig {
+  return {
+    ...DEFAULT_AKAN_IMAGE_CONFIG,
+    ...config,
+    deviceSizes: config.deviceSizes ?? DEFAULT_AKAN_IMAGE_CONFIG.deviceSizes,
+    imageSizes: config.imageSizes ?? DEFAULT_AKAN_IMAGE_CONFIG.imageSizes,
+    formats: config.formats ?? DEFAULT_AKAN_IMAGE_CONFIG.formats,
+    qualities: config.qualities ?? DEFAULT_AKAN_IMAGE_CONFIG.qualities,
+    remotePatterns: config.remotePatterns ?? DEFAULT_AKAN_IMAGE_CONFIG.remotePatterns,
+    localPatterns: config.localPatterns ?? DEFAULT_AKAN_IMAGE_CONFIG.localPatterns,
+  };
+}
+
+export class AkanLibConfig implements LibConfigResult {
+  lib: Lib;
+  externalLibs: string[];
+  constructor(lib: Lib, config: DeepPartial<LibConfigResult>) {
+    this.lib = lib;
+    this.externalLibs = config?.externalLibs ?? [];
+  }
+  static async from(lib: Lib) {
+    const [configImp] = await Promise.all([import(`${lib.cwdPath}/akan.config.ts`).then((mod) => mod.default)]);
+    const config = typeof configImp === "function" ? configImp(lib) : configImp;
+    return new AkanLibConfig(lib, config);
+  }
+}
+
+// export const getCapacitorConfig = (configImp: AppConfig, appInfo: AppScanResult, tsconfig: TsConfigJson) => {
+//   const props: RunnerProps = {
+//     type: "app",
+//     name: appInfo.name,
+//     repoName: appInfo.repoName,
+//     serveDomain: appInfo.serveDomain,
+//     env: (process.env.AKAN_PUBLIC_ENV ?? "debug") as "testing" | "local" | "debug" | "develop" | "main",
+//     libs: appInfo.libDeps,
+//     tsconfig,
+//   };
+//   const config = typeof configImp === "function" ? configImp(props) : configImp;
+//   const akanConfig = makeAppConfig(config, props);
+//   return akanConfig;
+// };
+
+//! need to refactor
+export const increaseBuildNum = async (app: App) => {
+  const appConfig = await AkanAppConfig.from(app);
+  const akanConfigPath = path.join(app.cwdPath, "akan.config.ts");
+  const akanConfig = fs.readFileSync(akanConfigPath, "utf8");
+  const akanConfigContent = akanConfig.replace(
+    `buildNum: ${appConfig.mobile.buildNum}`,
+    `buildNum: ${appConfig.mobile.buildNum + 1}`,
+  );
+  //? 개선할 여지가 있는지 확인
+  fs.writeFileSync(akanConfigPath, akanConfigContent);
+};
+
+export const decreaseBuildNum = async (app: App) => {
+  const appConfig = await AkanAppConfig.from(app);
+  const akanConfigPath = path.join(app.cwdPath, "akan.config.ts");
+  const akanConfig = fs.readFileSync(akanConfigPath, "utf8");
+  const akanConfigContent = akanConfig.replace(
+    `buildNum: ${appConfig.mobile.buildNum}`,
+    `buildNum: ${appConfig.mobile.buildNum - 1}`,
+  );
+  fs.writeFileSync(akanConfigPath, akanConfigContent);
+};

package/akanConfig/index.ts

@@ -0,0 +1,2 @@
+export * from "./akanConfig";
+export * from "./types";

package/akanConfig/types.ts

@@ -0,0 +1,23 @@
+export { archs } from "akanjs";
+export type {
+  AkanConfigFile,
+  AkanMobileConfig,
+  AkanMobileTargetConfig,
+  AkanRouteConfig,
+  AppConfig,
+  AppConfigResult,
+  AppScanResult,
+  Arch,
+  DatabaseMode,
+  DeepPartial,
+  DockerConfig,
+  FileConventionScanResult,
+  LibConfig,
+  LibConfigResult,
+  LibScanResult,
+  MobileEnv,
+  MobilePermission,
+  PkgScanResult,
+  ScanResult,
+  WorkspaceScanResult,
+} from "akanjs";

package/applicationBuildReporter.ts

@@ -0,0 +1,69 @@
+import { Logger } from "akanjs/common";
+
+export interface ApplicationBuildPhaseResult {
+  id: string;
+  label: string;
+  durationMs: number;
+  summary?: string;
+  skipped?: boolean;
+}
+
+export interface ApplicationBuildResult {
+  phases: ApplicationBuildPhaseResult[];
+  durationMs: number;
+  outputDir: string;
+  artifactDir: string;
+}
+
+export interface ApplicationBuildProgressReporter {
+  phaseStart?(phase: Pick<ApplicationBuildPhaseResult, "id" | "label">): void;
+  phaseDone?(phase: ApplicationBuildPhaseResult): void;
+  phaseFail?(phase: Pick<ApplicationBuildPhaseResult, "id" | "label">, error: unknown): void;
+}
+
+export class ApplicationBuildReporter {
+  static create(): ApplicationBuildProgressReporter {
+    return {
+      phaseDone: (phase) => Logger.rawLog(ApplicationBuildReporter.formatPhaseLine(phase)),
+    };
+  }
+
+  static printSummary(result: ApplicationBuildResult) {
+    Logger.rawLog("");
+    Logger.rawLog(`Route artifacts: ${result.artifactDir}`);
+    Logger.rawLog(`Server output: ${result.outputDir}`);
+    Logger.rawLog(`Done in ${ApplicationBuildReporter.formatDuration(result.durationMs)}`);
+  }
+
+  static formatError(error: unknown): string {
+    if (error instanceof AggregateError) {
+      const nestedMessages = error.errors
+        .map(
+          (nestedError, index) =>
+            ApplicationBuildReporter.formatError(nestedError).trim() || `Unknown error ${index + 1}`,
+        )
+        .map((message) => message.replace(/^/gm, "  "))
+        .join("\n");
+
+      return nestedMessages ? `${error.message}\n${nestedMessages}` : error.message;
+    }
+    if (error instanceof Error) {
+      const causeMessage = error.cause ? `\nCaused by: ${ApplicationBuildReporter.formatError(error.cause)}` : "";
+      return `${error.message}${causeMessage}`;
+    }
+    if (typeof error === "object" && error !== null && "message" in error) return String(error.message);
+    return String(error);
+  }
+
+  static formatDuration(ms: number): string {
+    if (ms < 1000) return `${ms}ms`;
+    if (ms < 60_000) return `${Math.round(ms / 100) / 10}s`;
+    const seconds = Math.floor(ms / 1000);
+    return `${Math.floor(seconds / 60)}m ${seconds % 60}s`;
+  }
+
+  static formatPhaseLine(phase: ApplicationBuildPhaseResult): string {
+    const summary = phase.summary ? `: ${phase.summary}` : "";
+    return `✓ ${phase.label}${summary} (${ApplicationBuildReporter.formatDuration(phase.durationMs)})`;
+  }
+}