@akashic/engine-files-reftest-helper 1.2.3 → 1.3.0-beta.1

package/README.md

@@ -54,6 +54,15 @@ npm test
 
 TODO: `globalThis.fetch`が無い環境でも動作できるようにする
 
+## 開発者向け
+
+### 本ツールの publish について
+* 以下の手順を踏むことで publish が行われます。
+  1. package.json の version を更新したコミットを作成
+  2. 1 のコミットで master ブランチを更新する
+  3. GitHub Actions のリリースワークフローが実行される
+* package-lock.json が原因で publish に失敗した場合は、`npm i --before <実行時の7日前の日付(yyyy-mm-dd)>` を実行して package-lock.json を更新し、再度 publish 処理を行なってください。
+
 ## ライセンス
 本リポジトリは MIT License の元で公開されています。
 詳しくは [LICENSE](https://github.com/akashic-games/engine-files-reftest-helper/blob/main/LICENSE) をご覧ください。

package/lib/index.d.ts

@@ -1,4 +1,11 @@
+import type { CustomWindow, ConsoleApiParameter, OutputType } from "./types";
 /** engine-files-reftest側にスクリーンショットの保存を要求するためのメッセージ */
 export declare const SCREENSHOT_NOTIFICATION_MESSAGE = "engine-files-reftest:image";
 /** engine-files-reftest側にコンテンツ実行終了を要求するためのメッセージ */
 export declare const END_NOTIFICATION_MESSAGE = "engine-files-reftest:finish";
+export declare function postConsole(param: ConsoleApiParameter): Promise<Response>;
+export declare function screenshot(fileName: string, base64: string): Promise<Response | void>;
+export declare function finish(): Promise<Response | void>;
+export declare function getImageDataUrlFromCanvas(): string;
+export declare function getCustomWindow(): CustomWindow;
+export declare function setPropsToCustomWindow(outputType: OutputType, consoleApiUrl: string): void;

package/lib/index.js

@@ -1,22 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.END_NOTIFICATION_MESSAGE = exports.SCREENSHOT_NOTIFICATION_MESSAGE = void 0;
-let outputType = "console"; // デフォルトはコンソール出力とする
-let consoleApiUrl = "";
+exports.postConsole = postConsole;
+exports.screenshot = screenshot;
+exports.finish = finish;
+exports.getImageDataUrlFromCanvas = getImageDataUrlFromCanvas;
+exports.getCustomWindow = getCustomWindow;
+exports.setPropsToCustomWindow = setPropsToCustomWindow;
 // TODO 以下2つの定数は大規模化したら別リポジトリに切り出す
 /** engine-files-reftest側にスクリーンショットの保存を要求するためのメッセージ */
 exports.SCREENSHOT_NOTIFICATION_MESSAGE = "engine-files-reftest:image";
 /** engine-files-reftest側にコンテンツ実行終了を要求するためのメッセージ */
 exports.END_NOTIFICATION_MESSAGE = "engine-files-reftest:finish";
 function postConsole(param) {
+    const windowAsCustom = getCustomWindow();
     const headers = {
         "Accept": "application/json",
         "Content-Type": "application/json; charset=utf-8"
     };
-    return fetch(consoleApiUrl, { method: "POST", headers, body: JSON.stringify(param) });
+    return fetch(windowAsCustom.consoleApiUrl, { method: "POST", headers, body: JSON.stringify(param) });
 }
 function screenshot(fileName, base64) {
-    switch (outputType) {
+    const windowAsCustom = getCustomWindow();
+    switch (windowAsCustom.outputType) {
         case "post":
             return postConsole({ commandName: "screenshot", screenshotData: { fileName, base64 } });
         case "console":
@@ -25,7 +31,8 @@ function screenshot(fileName, base64) {
     }
 }
 function finish() {
-    switch (outputType) {
+    const windowAsCustom = getCustomWindow();
+    switch (windowAsCustom.outputType) {
         case "post":
             return postConsole({ commandName: "finish" });
         case "console":
@@ -33,6 +40,34 @@ function finish() {
             return Promise.resolve();
     }
 }
+function getImageDataUrlFromCanvas() {
+    getCustomWindow(); // window の存在確認 のために呼び出す
+    g.game.render(); // 描画がスキップされてしまうことがあるので、スクリーンショット取得前に現フレームでの描画を行う
+    const canvasElements = window.document.getElementsByTagName("canvas");
+    const imageUrl = canvasElements[0].toDataURL("image/png");
+    const data = imageUrl.match(/^data:image\/png;base64,(.+)$/);
+    if (!data) {
+        throw new Error("Invalid image data URL");
+    }
+    return data[1];
+}
+function getCustomWindow() {
+    if (typeof window === "undefined") {
+        throw new Error("window is undefined");
+    }
+    return window;
+}
+function setPropsToCustomWindow(outputType, consoleApiUrl) {
+    const windowAsCustom = getCustomWindow();
+    windowAsCustom.outputType = outputType;
+    windowAsCustom.consoleApiUrl = consoleApiUrl;
+}
+try {
+    setPropsToCustomWindow("console", "");
+}
+catch (e) {
+    // window がない環境で必ずエラーになるので無視する
+}
 if (typeof g !== "undefined") {
     const screenshotPromises = [];
     const handleScenario = (msg) => {
@@ -42,18 +77,20 @@ if (typeof g !== "undefined") {
             switch (eventData.command.name) {
                 case "init":
                     const option = eventData.command.options;
-                    outputType = option.outputType;
-                    consoleApiUrl = option.outputUrl;
+                    try {
+                        setPropsToCustomWindow(option.outputType, option.outputUrl);
+                    }
+                    catch (e) {
+                        // window がない環境で必ずエラーになるので無視する
+                    }
                     break;
                 case "screenshot":
-                    if (typeof window !== "undefined") {
-                        g.game.render(); // 描画がスキップされてしまうことがあるので、スクリーンショット取得前に現フレームでの描画を行う
-                        const canvasElements = window.document.getElementsByTagName("canvas");
-                        const imageUrl = canvasElements[0].toDataURL("image/png");
-                        const data = imageUrl.match(/^data:image\/png;base64,(.+)$/);
-                        if (data.length === 2) {
-                            screenshotPromises.push(screenshot(eventData.command.options.fileName, data[1]));
-                        }
+                    try {
+                        const url = getImageDataUrlFromCanvas();
+                        screenshotPromises.push(screenshot(eventData.command.options.fileName, url));
+                    }
+                    catch (e) {
+                        // window がない環境で必ずエラーになるので無視する
                     }
                     break;
                 case "finish":

package/lib/types/CustomWindow.d.ts

@@ -0,0 +1,5 @@
+import type { OutputType } from ".";
+export interface CustomWindow extends Window {
+    consoleApiUrl: string;
+    outputType: OutputType;
+}

package/lib/types/CustomWindow.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/index.d.ts

@@ -3,3 +3,4 @@ export * from "./ConsoleApiParameter";
 export * from "./InitCommandOption";
 export * from "./OutputType";
 export * from "./ScreenshotData";
+export * from "./CustomWindow";

package/lib/types/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./ConsoleApiParameter"), exports);
 __exportStar(require("./InitCommandOption"), exports);
 __exportStar(require("./OutputType"), exports);
 __exportStar(require("./ScreenshotData"), exports);
+__exportStar(require("./CustomWindow"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akashic/engine-files-reftest-helper",
-  "version": "1.2.3",
+  "version": "1.3.0-beta.1",
   "description": "engine-files-reftestでコンテンツを自動実行するためのライブラリ",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",