@next2d/builder 0.1.7 → 0.1.10

package/dist/cli.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @description ヘルプを出力して終了
+ *              Output help and exit
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+export declare const echoHelp: () => void;
+/**
+ * @typedef {object} ParsedArgs
+ */
+export interface ParsedArgs {
+    platform: string;
+    environment: string;
+    preview: boolean;
+    open: boolean;
+    build: boolean;
+    v8Root: string;
+    hasHelp: boolean;
+}
+/**
+ * @description ビルド対象として受理するプラットフォーム名の集合。
+ * @type {Set<string>}
+ * @constant
+ */
+export declare const SUPPORTED_PLATFORMS: Set<string>;
+/**
+ * @description process.argv 等のトークン列を解析する純関数 (副作用なし)。
+ *              Parse an argv token list into structured flags (pure, no side effects).
+ *
+ * @param  {string[]} argv
+ * @return {ParsedArgs}
+ * @method
+ * @public
+ */
+export declare const parseArgv: (argv: string[]) => ParsedArgs;
+/**
+ * @description プラットフォーム名をパス表現へ変換する ("steam:windows" -> "steam/windows")。
+ *              Convert a platform name to its path form.
+ *
+ * @param  {string} platform
+ * @return {string}
+ * @method
+ * @public
+ */
+export declare const derivePlatformDir: (platform: string) => string;
+/**
+ * @description Node バージョン検証 → process.argv 解析 → ctx 初期化 →
+ *              プラットフォーム妥当性検証 → platformDir 算出 → 環境変数設定。
+ *              不正/ヘルプ要求時は echoHelp() で終了する。
+ *              Validate Node version, parse argv into ctx, validate platform,
+ *              derive platformDir and export env vars. Exits via echoHelp on error.
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+export declare const initCli: () => void;

package/dist/cli.js

@@ -0,0 +1,141 @@
+// CLI 引数の解析とヘルプ表示。process.argv を読み取り ctx を初期化する。
+import pc from "picocolors";
+import { ctx } from "./context.js";
+import { RECOMMENDED_NODE_VERSION } from "./constants.js";
+/**
+ * @description ヘルプを出力して終了
+ *              Output help and exit
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+export const echoHelp = () => {
+    console.log();
+    console.log(pc.green("`--platform` can be specified for macOS, Windows, iOS, Android, Xbox, and Web"));
+    console.log(pc.green("It is not case sensitive."));
+    console.log();
+    console.log("For build example:");
+    console.log("npx @next2d/builder --platform web --env prd");
+    console.log();
+    console.log("For preview example:");
+    console.log("npx @next2d/builder --preview --platform web --env prd");
+    console.log();
+    console.log("For Xbox build example (prebuilt V8 is downloaded automatically):");
+    console.log("npx @next2d/builder --platform xbox --env prd");
+    console.log("To use your own V8 build: --v8-root C:\\path\\to\\v8");
+    console.log();
+    process.exit(1);
+};
+/**
+ * @description ビルド対象として受理するプラットフォーム名の集合。
+ * @type {Set<string>}
+ * @constant
+ */
+export const SUPPORTED_PLATFORMS = new Set([
+    "windows", "macos", "linux",
+    "steam:windows", "steam:macos", "steam:linux",
+    "ios", "android", "xbox", "web"
+]);
+/**
+ * @description process.argv 等のトークン列を解析する純関数 (副作用なし)。
+ *              Parse an argv token list into structured flags (pure, no side effects).
+ *
+ * @param  {string[]} argv
+ * @return {ParsedArgs}
+ * @method
+ * @public
+ */
+export const parseArgv = (argv) => {
+    const result = {
+        "platform": "",
+        "environment": "",
+        "preview": false,
+        "open": false,
+        "build": false,
+        "v8Root": "",
+        "hasHelp": false
+    };
+    for (let idx = 0; idx < argv.length; ++idx) {
+        switch (argv[idx]) {
+            case "--preview":
+                result.preview = true;
+                break;
+            case "--open":
+                result.open = true;
+                break;
+            case "--build":
+                result.build = true;
+                break;
+            case "--help":
+            case "--h":
+                result.hasHelp = true;
+                break;
+            case "--platform":
+                result.platform = (argv[++idx] || "").toLowerCase();
+                break;
+            case "--env":
+                result.environment = argv[++idx] || "";
+                break;
+            case "--v8-root":
+                // Xbox ビルドで使う prebuilt V8 monolith のパス (環境変数 V8_ROOT より優先)
+                result.v8Root = argv[++idx] || "";
+                break;
+            default:
+                break;
+        }
+        if (result.hasHelp) {
+            break;
+        }
+    }
+    if (!result.platform || !result.environment) {
+        result.hasHelp = true;
+    }
+    return result;
+};
+/**
+ * @description プラットフォーム名をパス表現へ変換する ("steam:windows" -> "steam/windows")。
+ *              Convert a platform name to its path form.
+ *
+ * @param  {string} platform
+ * @return {string}
+ * @method
+ * @public
+ */
+export const derivePlatformDir = (platform) => {
+    return platform.indexOf(":") ? platform.split(":").join("/") : platform;
+};
+/**
+ * @description Node バージョン検証 → process.argv 解析 → ctx 初期化 →
+ *              プラットフォーム妥当性検証 → platformDir 算出 → 環境変数設定。
+ *              不正/ヘルプ要求時は echoHelp() で終了する。
+ *              Validate Node version, parse argv into ctx, validate platform,
+ *              derive platformDir and export env vars. Exits via echoHelp on error.
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+export const initCli = () => {
+    const version = process.versions.node;
+    if (RECOMMENDED_NODE_VERSION > parseInt(version.split(".")[0])) {
+        pc.red(`You are running Node Version:${version}.
+View Generator requires Node ${RECOMMENDED_NODE_VERSION} or higher.
+Please update your version of Node.`);
+        process.exit(1);
+    }
+    const parsed = parseArgv(process.argv);
+    ctx.platform = parsed.platform;
+    ctx.environment = parsed.environment;
+    ctx.preview = parsed.preview;
+    ctx.open = parsed.open;
+    ctx.build = parsed.build;
+    ctx.v8Root = parsed.v8Root;
+    if (parsed.hasHelp || !SUPPORTED_PLATFORMS.has(ctx.platform)) {
+        echoHelp();
+    }
+    ctx.platformDir = derivePlatformDir(ctx.platform);
+    // update env variables
+    process.env.NEXT2D_EBUILD_ENVIRONMENT = ctx.environment;
+    process.env.NEXT2D_TARGET_PLATFORM = ctx.platform;
+};

package/dist/constants.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @description 推奨 Node.js メジャーバージョン。
+ * @type {number}
+ * @constant
+ */
+export declare const RECOMMENDED_NODE_VERSION: number;
+/**
+ * @type {string}
+ * @constant
+ */
+export declare const CAPACITOR_CONFIG_NAME: string;
+/**
+ * @type {string}
+ * @constant
+ */
+export declare const XBOX_DIR_NAME: string;
+/**
+ * @type {string}
+ * @constant
+ */
+export declare const XBOX_CONFIG_NAME: string;
+/**
+ * @description 自動ダウンロードする prebuilt V8 のバージョン。
+ *              `.github/workflows/build-v8.yml` で発行した Releases のタグと、
+ *              `xbox-host-ci.yml` の V8_TAG に一致させること。
+ *              The prebuilt V8 version to auto-download. Must match the release tag
+ *              published by `build-v8.yml` and V8_TAG in `xbox-host-ci.yml`.
+ *
+ * @type {string}
+ * @constant
+ */
+export declare const XBOX_V8_VERSION: string;
+/**
+ * @description prebuilt V8 のアセットリビジョン。同一 V8 バージョンでも
+ *              gn フラグ変更でバイナリが変わる場合に上げ、Release タグと
+ *              ローカルキャッシュを分離する。
+ *              Asset revision. Bump when gn flags change for the same V8 version.
+ *
+ * @type {string}
+ * @constant
+ */
+export declare const XBOX_V8_REVISION: string;
+/**
+ * @description ゲーム側の `xbox/` へスキャフォールドしないテンプレート内ファイル。
+ *              - MicrosoftGame.config : ゲーム固有設定 (injectGameConfig が注入)
+ *              - tests / .v8_headers  : builder リポジトリ側の開発用テスト・キャッシュ
+ *              - build 系             : テンプレート内でビルドした場合の生成物
+ *              Template entries excluded from the per-game `xbox/` scaffold.
+ *
+ * @type {Set<string>}
+ * @constant
+ */
+export declare const XBOX_SCAFFOLD_EXCLUDES: Set<string>;

package/dist/constants.js

@@ -0,0 +1,64 @@
+// ビルダー全体で使う定数群。
+// Constants shared across the builder.
+/**
+ * @description 推奨 Node.js メジャーバージョン。
+ * @type {number}
+ * @constant
+ */
+export const RECOMMENDED_NODE_VERSION = 22;
+/**
+ * @type {string}
+ * @constant
+ */
+export const CAPACITOR_CONFIG_NAME = "capacitor.config.json";
+/**
+ * @type {string}
+ * @constant
+ */
+export const XBOX_DIR_NAME = "xbox";
+/**
+ * @type {string}
+ * @constant
+ */
+export const XBOX_CONFIG_NAME = "MicrosoftGame.config";
+/**
+ * @description 自動ダウンロードする prebuilt V8 のバージョン。
+ *              `.github/workflows/build-v8.yml` で発行した Releases のタグと、
+ *              `xbox-host-ci.yml` の V8_TAG に一致させること。
+ *              The prebuilt V8 version to auto-download. Must match the release tag
+ *              published by `build-v8.yml` and V8_TAG in `xbox-host-ci.yml`.
+ *
+ * @type {string}
+ * @constant
+ */
+export const XBOX_V8_VERSION = "13.7.152.19";
+/**
+ * @description prebuilt V8 のアセットリビジョン。同一 V8 バージョンでも
+ *              gn フラグ変更でバイナリが変わる場合に上げ、Release タグと
+ *              ローカルキャッシュを分離する。
+ *              Asset revision. Bump when gn flags change for the same V8 version.
+ *
+ * @type {string}
+ * @constant
+ */
+export const XBOX_V8_REVISION = "r3";
+/**
+ * @description ゲーム側の `xbox/` へスキャフォールドしないテンプレート内ファイル。
+ *              - MicrosoftGame.config : ゲーム固有設定 (injectGameConfig が注入)
+ *              - tests / .v8_headers  : builder リポジトリ側の開発用テスト・キャッシュ
+ *              - build 系             : テンプレート内でビルドした場合の生成物
+ *              Template entries excluded from the per-game `xbox/` scaffold.
+ *
+ * @type {Set<string>}
+ * @constant
+ */
+export const XBOX_SCAFFOLD_EXCLUDES = new Set([
+    XBOX_CONFIG_NAME,
+    "tests",
+    ".v8_headers",
+    "build",
+    "out",
+    "_deps",
+    "CMakeCache.txt",
+    "CMakeFiles"
+]);

package/dist/context.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @typedef {object} BuildContext
+ */
+export interface BuildContext {
+    /** ビルド対象プラットフォーム (例 "web" / "xbox" / "steam:windows") */
+    platform: string;
+    /** 環境識別子 (例 "prd" / "dev") */
+    environment: string;
+    /** --preview */
+    preview: boolean;
+    /** --open */
+    open: boolean;
+    /** --build */
+    build: boolean;
+    /** --v8-root (Xbox) */
+    v8Root: string;
+    /** vite の loadConfigFromFile 結果 */
+    configObject: any | null;
+    /** ビルド出力ディレクトリ (dist/<platformDir>/<env>) */
+    buildDir: string;
+    /** vite build.outDir (既定 "dist") */
+    outDir: string;
+    /** プラットフォームのパス表現 ("steam:windows" -> "steam/windows") */
+    platformDir: string;
+}
+/**
+ * @type {BuildContext}
+ */
+export declare const ctx: BuildContext;

package/dist/context.js

@@ -0,0 +1,19 @@
+// ビルド全体で共有する可変状態。CLI 解析結果 (platform/environment/フラグ) と
+// loadConfig が設定するビルドディレクトリ等を保持し、各モジュールが参照/更新する。
+// 単一のオブジェクトにまとめることで、ESM 間でも生きた状態を共有できる。
+// Mutable build-wide state shared across modules via a single object.
+/**
+ * @type {BuildContext}
+ */
+export const ctx = {
+    "platform": "",
+    "environment": "",
+    "preview": false,
+    "open": false,
+    "build": false,
+    "v8Root": "",
+    "configObject": null,
+    "buildDir": "",
+    "outDir": "dist",
+    "platformDir": ""
+};

package/dist/electron.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @description Electron ベースのデスクトップアプリ書き出し関数
+ *              (Windows / macOS / Linux、Steam・Epic Games Store 等の配布に共通)。
+ *              Export function for Electron-based desktop apps.
+ *
+ * @return {Promise}
+ * @method
+ * @public
+ */
+export declare const buildElectron: () => Promise<void>;

package/dist/electron.js

@@ -0,0 +1,142 @@
+// Electron ベースのデスクトップ配布 (Steam / Epic Games Store など)。
+import pc from "picocolors";
+import fs from "fs";
+import cp from "child_process";
+import { api } from "@electron-forge/core";
+import { ctx } from "./context.js";
+import { $spawn } from "./utils.js";
+/**
+ * @description electronがインストールされてなければインストールを実行
+ *              If electron is not installed, run install.
+ *
+ * @return {Promise}
+ * @method
+ * @private
+ */
+const installElectron = () => {
+    return new Promise((resolve, reject) => {
+        if (fs.existsSync(`${process.cwd()}/electron/node_modules`)) {
+            return resolve();
+        }
+        const stream = $spawn("npm", [
+            "--prefix",
+            `${process.cwd()}/electron`,
+            "install",
+            `${process.cwd()}/electron`
+        ], { "stdio": "inherit" });
+        stream.on("close", (code) => {
+            if (code !== 0) {
+                reject("`Electron` installation failed.");
+            }
+            console.log(pc.green("`Electron` successfully installed."));
+            resolve();
+        });
+    });
+};
+/**
+ * @description electronに含むリソースを初期化
+ *              Initialize resources included in electron
+ *
+ * @return {Promise}
+ * @method
+ * @private
+ */
+const removeResources = () => {
+    return new Promise((resolve, reject) => {
+        const stream = cp.spawn("rm", [
+            "-rf",
+            `${process.cwd()}/electron/resources/`
+        ], { "stdio": "inherit" });
+        stream.on("close", (code) => {
+            if (code !== 0) {
+                reject("Failed to remove built resources.");
+            }
+            console.log(pc.green("Successfully remove built resources."));
+            resolve();
+        });
+    });
+};
+/**
+ * @description ビルドしたリソースをコピー
+ *              Copy built resources
+ *
+ * @return {Promise}
+ * @method
+ * @private
+ */
+const copyResources = () => {
+    return new Promise((resolve, reject) => {
+        const stream = cp.spawn("cp", [
+            "-r",
+            `${ctx.buildDir}/`,
+            `${process.cwd()}/electron/resources`
+        ], { "stdio": "inherit" });
+        stream.on("close", (code) => {
+            if (code !== 0) {
+                reject("Failed to copy built resources.");
+            }
+            console.log(pc.green("Successfully copy built resources."));
+            resolve();
+        });
+    });
+};
+/**
+ * @description Electron ベースのデスクトップアプリ書き出し関数
+ *              (Windows / macOS / Linux、Steam・Epic Games Store 等の配布に共通)。
+ *              Export function for Electron-based desktop apps.
+ *
+ * @return {Promise}
+ * @method
+ * @public
+ */
+export const buildElectron = async () => {
+    // reset
+    await removeResources();
+    // copy HTML, JavaScript
+    await copyResources();
+    if (ctx.preview) {
+        $spawn("npx", [
+            "electron",
+            `${process.cwd()}/electron/index.js`
+        ], { "stdio": "inherit" });
+    }
+    else {
+        await installElectron();
+        console.log(pc.green("Start the `Electron` build process."));
+        console.log();
+        const packageOptions = {
+            "dir": `${process.cwd()}/electron`,
+            "outDir": `${ctx.outDir}/${ctx.platformDir}/build`,
+            "platform": "",
+            "arch": "all"
+        };
+        switch (ctx.platform) {
+            case "windows":
+            case "steam:windows":
+                packageOptions.platform = "win32";
+                break;
+            case "macos":
+            case "steam:macos":
+                packageOptions.platform = "mas";
+                break;
+            case "linux":
+            case "steam:linux":
+                packageOptions.platform = "linux";
+                break;
+            default:
+                console.log(pc.red("There is an error in the export platform settings."));
+                console.log();
+                process.exit(1);
+        }
+        api
+            .package(packageOptions)
+            .then(() => {
+            console.log(pc.green(`Finished building \`Electron\` for ${ctx.platform}.`));
+            console.log();
+        })
+            .catch((error) => {
+            console.log(pc.red("Export of Electron failed."));
+            console.log(pc.red(error));
+        });
+    }
+};