@apps-in-toss/web-framework 2.6.0 → 3.0.0-beta.0c56009

package/dist/cli.js

@@ -0,0 +1,306 @@
+#!/usr/bin/env node
+
+// src/cli/index.ts
+import { Cli } from "clipanion";
+
+// src/cli/commands/build/index.ts
+import * as p from "@clack/prompts";
+import { Command } from "clipanion";
+import path3 from "path";
+
+// src/cli/commands/build/buildArtifact.ts
+import { AppsInTossBundle, PlatformType } from "@apps-in-toss/ait-format";
+import { cosmiconfig } from "cosmiconfig";
+import { TypeScriptLoader } from "cosmiconfig-typescript-loader";
+import path2 from "path";
+import { readdir, readFile, writeFile } from "fs/promises";
+import { uuidv7 } from "uuidv7";
+
+// src/cli/utils/getPackageRoot.ts
+import fs from "fs";
+import path from "path";
+function getPackageRoot(base) {
+  let dirPath = base;
+  const root = path.parse(dirPath).root;
+  while (dirPath !== root) {
+    if (fs.existsSync(path.join(dirPath, "package.json"))) {
+      return dirPath;
+    }
+    dirPath = path.dirname(dirPath);
+  }
+  return dirPath;
+}
+
+// src/cli/commands/build/buildArtifact.ts
+async function buildArtifact() {
+  const projectRoot = getPackageRoot(process.cwd());
+  const projectPackageJsonData = await readFile(
+    path2.resolve(projectRoot, "package.json")
+  );
+  const projectPackageJson = JSON.parse(projectPackageJsonData.toString());
+  const sdkPackageJson = await getSDKPackageJson();
+  const appsInTossConfig = await getAppsInTossConfig();
+  const deploymentId = uuidv7();
+  const writer = AppsInTossBundle.writer({
+    deploymentId,
+    appName: appsInTossConfig.appName,
+    createdBy: sdkPackageJson.name
+  });
+  const unityMetadata = getUnityMetadata();
+  writer.setMetadata({
+    platform: PlatformType.WEB,
+    sdkVersion: sdkPackageJson.version,
+    packageJson: projectPackageJson,
+    extra: { unityMetadata, appsInTossConfig }
+  });
+  appsInTossConfig.permissions.forEach(
+    ({ name, access }) => writer.addPermission(name, access)
+  );
+  const webBundleDir = path2.resolve(
+    projectRoot,
+    appsInTossConfig.webBundleDir
+  );
+  const webBundleFiles = await getWebBundleFiles(webBundleDir);
+  for (const file of webBundleFiles) {
+    writer.addFile("sources/" + file.name, file.data);
+  }
+  const bundleJson = {
+    deploymentId,
+    byteLength: webBundleFiles.reduce(
+      (acc, cur) => acc + cur.data.byteLength,
+      0
+    ),
+    sdk: { name: sdkPackageJson.name, version: sdkPackageJson.version },
+    config: appsInTossConfig
+  };
+  writer.addFile(
+    "bundle.json",
+    new Uint8Array(Buffer.from(JSON.stringify(bundleJson), "utf-8"))
+  );
+  writer.addFile(
+    "project-package.json",
+    new Uint8Array(projectPackageJsonData)
+  );
+  const artifactBuffer = await writer.toBuffer();
+  const outPath = path2.resolve(projectRoot, `${appsInTossConfig.appName}.ait`);
+  await writeFile(outPath, artifactBuffer);
+  return { deploymentId, outPath };
+}
+async function getSDKPackageJson() {
+  const packageJsonPath = path2.resolve(
+    getPackageRoot(import.meta.dirname),
+    "package.json"
+  );
+  const packageJsonString = (await readFile(packageJsonPath)).toString();
+  return JSON.parse(packageJsonString);
+}
+async function getAppsInTossConfig() {
+  const result = await cosmiconfig("apps-in-toss", {
+    loaders: {
+      ".ts": TypeScriptLoader(),
+      ".cts": TypeScriptLoader(),
+      ".mts": TypeScriptLoader()
+    },
+    searchPlaces: [
+      "apps-in-toss.config.ts",
+      "apps-in-toss.config.cts",
+      "apps-in-toss.config.mts",
+      "apps-in-toss.config.js",
+      "apps-in-toss.config.cjs",
+      "apps-in-toss.config.mjs"
+    ]
+  }).search(getPackageRoot(process.cwd()));
+  if (result == null) {
+    throw new Error("Config \uD30C\uC77C\uC744 \uCC3E\uC744 \uC218 \uC5C6\uC2B5\uB2C8\uB2E4.");
+  }
+  return result.config;
+}
+function getUnityMetadata() {
+  const unityMetadataString = process.env.UNITY_METADATA;
+  if (typeof unityMetadataString !== "string") {
+    return null;
+  }
+  try {
+    return JSON.parse(unityMetadataString);
+  } catch (error) {
+    console.warn("UNITY_METADATA is not a valid JSON:", error);
+    return null;
+  }
+}
+async function getWebBundleFiles(webBundleDir) {
+  const filePaths = await getFilePathsInDir(webBundleDir);
+  const files = [];
+  for (const filePath of filePaths) {
+    const name = filePath.replace(webBundleDir + "/", "");
+    const data = new Uint8Array(await readFile(filePath));
+    files.push({ name, data });
+  }
+  return files;
+}
+async function getFilePathsInDir(dir) {
+  const entries = await readdir(dir, { withFileTypes: true });
+  const files = await Promise.all(
+    entries.map((entry) => {
+      const filePath = path2.resolve(dir, entry.name);
+      return entry.isDirectory() ? getFilePathsInDir(filePath) : filePath;
+    })
+  );
+  return files.flat();
+}
+
+// src/cli/commands/build/index.ts
+var BuildCommand = class extends Command {
+  static paths = [["build"]];
+  static usage = Command.Usage({
+    category: "Build",
+    description: "\uC571\uC778\uD1A0\uC2A4 \uBC30\uD3EC\uC6A9 .ait \uC544\uD2F0\uD329\uD2B8\uB97C \uBE4C\uB4DC\uD569\uB2C8\uB2E4.",
+    examples: [["Build artifact", "apps-in-toss build"]]
+  });
+  async execute() {
+    const buildResult = await buildArtifact();
+    p.log.success(
+      `\uC571\uC778\uD1A0\uC2A4 \uBE4C\uB4DC\uAC00 \uC644\uB8CC\uB418\uC5C8\uC2B5\uB2C8\uB2E4. (${path3.basename(buildResult.outPath)})`
+    );
+    p.log.info(`deploymentId: ${buildResult.deploymentId}`);
+  }
+};
+
+// src/cli/commands/migration/index.ts
+import * as p3 from "@clack/prompts";
+import { Command as Command2, Option } from "clipanion";
+
+// src/cli/commands/migration/web-framework-v3.ts
+import * as p2 from "@clack/prompts";
+import { cosmiconfig as cosmiconfig2 } from "cosmiconfig";
+import { TypeScriptLoader as TypeScriptLoader2 } from "cosmiconfig-typescript-loader";
+import { readFile as readFile2, writeFile as writeFile2 } from "fs/promises";
+import { resolve } from "path";
+import jscodeshift from "jscodeshift";
+async function migrateWebFrameworkV3() {
+  const projectRoot = getPackageRoot(process.cwd());
+  p2.log.info("@apps-in-toss/web-framework V3 \uC790\uB3D9 \uB9C8\uC774\uADF8\uB808\uC774\uC158\uC744 \uC2DC\uC791\uD569\uB2C8\uB2E4.");
+  p2.log.info(
+    "\uC790\uB3D9 \uB9C8\uC774\uADF8\uB808\uC774\uC158\uC5D0 \uC2E4\uD328\uD560 \uACBD\uC6B0, \uCEE4\uBBA4\uB2C8\uD2F0\uC5D0\uC11C \uC218\uB3D9 \uB9C8\uC774\uADF8\uB808\uC774\uC158 \uAC00\uC774\uB4DC\uB97C \uCC38\uACE0\uD574\uC8FC\uC138\uC694.\nhttps://techchat-apps-in-toss.toss.im"
+  );
+  const { config: graniteConfig, filepath: graniteConfigPath } = await getGraniteConfig(projectRoot);
+  await migrateAppsInTossConfig(
+    graniteConfigPath,
+    resolve(
+      projectRoot,
+      "apps-in-toss.config." + graniteConfigPath.split(".").pop()
+    )
+  );
+  await migratePackageJsonScripts(
+    resolve(projectRoot, "package.json"),
+    graniteConfig.web.commands.dev,
+    graniteConfig.web.commands.build
+  );
+  p2.log.success("\uB9C8\uC774\uADF8\uB808\uC774\uC158\uC774 \uC644\uB8CC\uB418\uC5C8\uC2B5\uB2C8\uB2E4.");
+}
+async function getGraniteConfig(projectRoot) {
+  p2.log.info("granite.config \uD30C\uC77C \uCC3E\uB294 \uC911..");
+  const result = await cosmiconfig2("granite", {
+    loaders: {
+      ".ts": TypeScriptLoader2(),
+      ".cts": TypeScriptLoader2(),
+      ".mts": TypeScriptLoader2()
+    },
+    searchPlaces: [
+      "granite.config.ts",
+      "granite.config.cts",
+      "granite.config.mts",
+      "granite.config.js",
+      "granite.config.cjs",
+      "granite.config.mjs"
+    ]
+  }).search(projectRoot);
+  if (result == null) {
+    p2.log.error("granite.config \uD30C\uC77C\uC744 \uCC3E\uC744 \uC218 \uC5C6\uC2B5\uB2C8\uB2E4.");
+    process.exit(1);
+  }
+  return result;
+}
+async function migrateAppsInTossConfig(configPath, outputPath) {
+  p2.log.info("granite.config\uB97C apps-in-toss.config\uB85C \uB9C8\uC774\uADF8\uB808\uC774\uC158\uD569\uB2C8\uB2E4.");
+  const root = jscodeshift((await readFile2(configPath)).toString());
+  root.find(jscodeshift.ObjectExpression).forEach((path4) => {
+    const obj = path4.value;
+    for (const prop of obj.properties) {
+      if (jscodeshift.Property.check(prop) && jscodeshift.Identifier.check(prop.key) && prop.key.name === "brand" && jscodeshift.ObjectExpression.check(prop.value)) {
+        prop.value.properties = prop.value.properties.filter(
+          (prop2) => jscodeshift.Property.check(prop2) && jscodeshift.Identifier.check(prop2.key) && prop2.key.name === "primaryColor"
+        );
+      }
+      if (jscodeshift.Property.check(prop) && jscodeshift.Identifier.check(prop.key) && prop.key.name === "webViewProps") {
+        prop.key = jscodeshift.identifier("webView");
+        if (prop.value.type === "ObjectExpression") {
+          prop.value.properties = prop.value.properties.filter(
+            (prop2) => jscodeshift.Property.check(prop2) && jscodeshift.Identifier.check(prop2.key) && prop2.key.name !== "type"
+          );
+        }
+      }
+      if (jscodeshift.Property.check(prop) && jscodeshift.Identifier.check(prop.key) && prop.key.name === "outdir") {
+        prop.key = jscodeshift.identifier("webBundleDir");
+      }
+    }
+    obj.properties = obj.properties.filter((prop) => {
+      if (jscodeshift.Property.check(prop) && jscodeshift.Identifier.check(prop.key) && prop.key.name === "web" && jscodeshift.ObjectExpression.check(prop.value) && prop.value.properties.filter(
+        (prop2) => jscodeshift.Property.check(prop2) && jscodeshift.Identifier.check(prop2.key) && ["host", "port", "commands"].includes(prop2.key.name)
+      ).length > 0) {
+        return false;
+      }
+      return true;
+    });
+  });
+  await writeFile2(outputPath, root.toSource());
+  p2.log.info("apps-in-toss.config\uAC00 \uC0DD\uC131\uB418\uC5C8\uC2B5\uB2C8\uB2E4.");
+}
+async function migratePackageJsonScripts(packageJsonPath, dev, build) {
+  p2.log.info("package.json\uC758 dev, build \uC2A4\uD06C\uB9BD\uD2B8\uB97C \uC218\uC815\uD569\uB2C8\uB2E4.");
+  const packageJson = JSON.parse((await readFile2(packageJsonPath)).toString());
+  if (packageJson.scripts == null) {
+    packageJson.scripts = {};
+  }
+  packageJson.scripts["dev"] = dev;
+  packageJson.scripts["build"] = `${build} && ait build`;
+  await writeFile2(packageJsonPath, JSON.stringify(packageJson, null, 2));
+  p2.log.info("package.json \uC218\uC815\uC774 \uC644\uB8CC\uB418\uC5C8\uC2B5\uB2C8\uB2E4.");
+}
+
+// src/cli/commands/migration/index.ts
+var MIGRATION_TARGETS = {
+  v3: migrateWebFrameworkV3
+};
+var MigrationCommand = class extends Command2 {
+  static paths = [["migrate"]];
+  static usage = Command2.Usage({
+    category: "Migration",
+    description: "\uB9C8\uC774\uADF8\uB808\uC774\uC158\uC744 \uC2E4\uD589\uD569\uB2C8\uB2E4.",
+    examples: [["Run migration", "apps-in-toss migrate <target>"]]
+  });
+  target = Option.String({ required: true });
+  async execute() {
+    const target = MIGRATION_TARGETS[this.target];
+    if (target != null) {
+      await target();
+    } else {
+      p3.log.error(
+        [
+          "\uC798\uBABB\uB41C \uB9C8\uC774\uADF8\uB808\uC774\uC158 target \uC785\uB2C8\uB2E4. \uC544\uB798 \uC911 \uD558\uB098\uB97C \uC785\uB825\uD574\uC8FC\uC138\uC694.\n",
+          ...Object.keys(MIGRATION_TARGETS)
+        ].join("\n")
+      );
+      process.exit(1);
+    }
+  }
+};
+
+// src/cli/index.ts
+var cli = new Cli({
+  binaryLabel: "appsintoss",
+  binaryName: "appsintoss",
+  enableCapture: true
+});
+cli.register(BuildCommand);
+cli.register(MigrationCommand);
+cli.runExit(process.argv.slice(2));

package/dist/config.cjs

@@ -0,0 +1,52 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/config/index.ts
+var config_exports = {};
+__export(config_exports, {
+  defineConfig: () => defineConfig
+});
+module.exports = __toCommonJS(config_exports);
+function defineConfig(config) {
+  return {
+    ...config,
+    appName: config.appName,
+    brand: config.brand,
+    permissions: config.permissions,
+    webView: {
+      mediaPlaybackRequiresUserAction: true,
+      allowsInlineMediaPlayback: false,
+      bounces: true,
+      allowsBackForwardNavigationGestures: true,
+      pullToRefreshEnabled: true,
+      overScrollMode: "always",
+      ...config.webView
+    },
+    navigationBar: {
+      withBackButton: true,
+      withHomeButton: false,
+      ...config.navigationBar
+    },
+    webBundleDir: config.webBundleDir ?? "dist"
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  defineConfig
+});

package/dist/config.d.cts

@@ -0,0 +1,54 @@
+interface AppsInTossConfig {
+    appName: string;
+    brand: {
+        primaryColor: string;
+    };
+    permissions: ({
+        name: "clipboard";
+        access: "read" | "write";
+    } | {
+        name: "geolocation";
+        access: "access";
+    } | {
+        name: "contacts";
+        access: "read" | "write";
+    } | {
+        name: "photos";
+        access: "read" | "write";
+    } | {
+        name: "camera";
+        access: "access";
+    } | {
+        name: "microphone";
+        access: "access";
+    })[];
+    navigationBar?: {
+        withBackButton?: boolean;
+        withHomeButton?: boolean;
+        initialAccessoryButton?: {
+            id: string;
+            title: string;
+            icon: {
+                source: {
+                    uri: string;
+                };
+                name?: never;
+            } | {
+                name: string;
+                source?: never;
+            };
+        };
+    };
+    webView?: {
+        allowsInlineMediaPlayback?: boolean;
+        bounces?: boolean;
+        pullToRefreshEnabled?: boolean;
+        overScrollMode?: "always" | "content" | "never";
+        mediaPlaybackRequiresUserAction?: boolean;
+        allowsBackForwardNavigationGestures?: boolean;
+    };
+    webBundleDir?: string;
+}
+declare function defineConfig(config: AppsInTossConfig): AppsInTossConfig;
+
+export { type AppsInTossConfig, defineConfig };

package/dist/config.d.ts

@@ -0,0 +1,54 @@
+interface AppsInTossConfig {
+    appName: string;
+    brand: {
+        primaryColor: string;
+    };
+    permissions: ({
+        name: "clipboard";
+        access: "read" | "write";
+    } | {
+        name: "geolocation";
+        access: "access";
+    } | {
+        name: "contacts";
+        access: "read" | "write";
+    } | {
+        name: "photos";
+        access: "read" | "write";
+    } | {
+        name: "camera";
+        access: "access";
+    } | {
+        name: "microphone";
+        access: "access";
+    })[];
+    navigationBar?: {
+        withBackButton?: boolean;
+        withHomeButton?: boolean;
+        initialAccessoryButton?: {
+            id: string;
+            title: string;
+            icon: {
+                source: {
+                    uri: string;
+                };
+                name?: never;
+            } | {
+                name: string;
+                source?: never;
+            };
+        };
+    };
+    webView?: {
+        allowsInlineMediaPlayback?: boolean;
+        bounces?: boolean;
+        pullToRefreshEnabled?: boolean;
+        overScrollMode?: "always" | "content" | "never";
+        mediaPlaybackRequiresUserAction?: boolean;
+        allowsBackForwardNavigationGestures?: boolean;
+    };
+    webBundleDir?: string;
+}
+declare function defineConfig(config: AppsInTossConfig): AppsInTossConfig;
+
+export { type AppsInTossConfig, defineConfig };

package/dist/config.js

@@ -0,0 +1,27 @@
+// src/config/index.ts
+function defineConfig(config) {
+  return {
+    ...config,
+    appName: config.appName,
+    brand: config.brand,
+    permissions: config.permissions,
+    webView: {
+      mediaPlaybackRequiresUserAction: true,
+      allowsInlineMediaPlayback: false,
+      bounces: true,
+      allowsBackForwardNavigationGestures: true,
+      pullToRefreshEnabled: true,
+      overScrollMode: "always",
+      ...config.webView
+    },
+    navigationBar: {
+      withBackButton: true,
+      withHomeButton: false,
+      ...config.navigationBar
+    },
+    webBundleDir: config.webBundleDir ?? "dist"
+  };
+}
+export {
+  defineConfig
+};