@akashic/engine-files-reftest-helper 1.3.0-beta.2 → 1.3.0-beta.3

package/lib/index.d.ts

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

package/lib/index.js

@@ -5,24 +5,23 @@ exports.postConsole = postConsole;
 exports.screenshot = screenshot;
 exports.finish = finish;
 exports.getImageDataUrlFromCanvas = getImageDataUrlFromCanvas;
-exports.getCustomWindow = getCustomWindow;
-exports.setPropsToCustomWindow = setPropsToCustomWindow;
+exports.getReftestHelperBridge = getReftestHelperBridge;
 // 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 reftest = getReftestHelperBridge();
     const headers = {
         "Accept": "application/json",
         "Content-Type": "application/json; charset=utf-8"
     };
-    return fetch(windowAsCustom.consoleApiUrl, { method: "POST", headers, body: JSON.stringify(param) });
+    return fetch(reftest.consoleApiUrl, { method: "POST", headers, body: JSON.stringify(param) });
 }
 function screenshot(fileName, base64) {
-    const windowAsCustom = getCustomWindow();
-    switch (windowAsCustom.outputType) {
+    const reftest = getReftestHelperBridge();
+    switch (reftest.outputType) {
         case "post":
             return postConsole({ commandName: "screenshot", screenshotData: { fileName, base64 } });
         case "console":
@@ -31,8 +30,8 @@ function screenshot(fileName, base64) {
     }
 }
 function finish() {
-    const windowAsCustom = getCustomWindow();
-    switch (windowAsCustom.outputType) {
+    const reftest = getReftestHelperBridge();
+    switch (reftest.outputType) {
         case "post":
             return postConsole({ commandName: "finish" });
         case "console":
@@ -41,7 +40,12 @@ function finish() {
     }
 }
 function getImageDataUrlFromCanvas() {
-    getCustomWindow(); // window の存在確認 のために呼び出す
+    if (typeof window === "undefined" || !window.document) {
+        throw new Error("window or document is undefined");
+    }
+    if (typeof g === "undefined" || !g.game) {
+        throw new Error("g.game is undefined");
+    }
     g.game.render(); // 描画がスキップされてしまうことがあるので、スクリーンショット取得前に現フレームでの描画を行う
     const canvasElements = window.document.getElementsByTagName("canvas");
     const imageUrl = canvasElements[0].toDataURL("image/png");
@@ -51,24 +55,22 @@ function getImageDataUrlFromCanvas() {
     }
     return data[1];
 }
-function getCustomWindow() {
-    if (typeof window === "undefined") {
-        throw new Error("window is undefined");
+function getReftestHelperBridge() {
+    if (typeof g === "undefined" || !g.game || !g.game.vars || !g.game.vars.reftest) {
+        throw new Error("g.game.vars.reftest is undefined");
     }
-    return window;
-}
-function setPropsToCustomWindow(outputType, consoleApiUrl) {
-    const windowAsCustom = getCustomWindow();
-    windowAsCustom.outputType = outputType;
-    windowAsCustom.consoleApiUrl = consoleApiUrl;
-}
-try {
-    setPropsToCustomWindow("console", "");
-}
-catch (e) {
-    // window がない環境で必ずエラーになるので無視する
+    return g.game.vars.reftest;
 }
 if (typeof g !== "undefined") {
+    // reftest 関連のプロパティを g.game.vars にセットする
+    g.game.vars.reftest = {
+        outputType: "console",
+        consoleApiUrl: "",
+        postConsole,
+        screenshot,
+        finish,
+        getImageDataUrlFromCanvas
+    };
     const screenshotPromises = [];
     const handleScenario = (msg) => {
         var _a;
@@ -77,12 +79,8 @@ if (typeof g !== "undefined") {
             switch (eventData.command.name) {
                 case "init":
                     const option = eventData.command.options;
-                    try {
-                        setPropsToCustomWindow(option.outputType, option.outputUrl);
-                    }
-                    catch (e) {
-                        // window がない環境で必ずエラーになるので無視する
-                    }
+                    g.game.vars.reftest.outputType = option.outputType;
+                    g.game.vars.reftest.consoleApiUrl = option.outputUrl;
                     break;
                 case "screenshot":
                     try {
@@ -108,11 +106,4 @@ if (typeof g !== "undefined") {
             scene.message.add({ func: handleScenario, name: handlerName });
         }
     });
-    // エントリポイント以外からも参照できるようにするために g.game.vars に格納しておく
-    g.game.vars = {
-        postConsole,
-        screenshot,
-        finish,
-        getImageDataUrlFromCanvas
-    };
 }

package/lib/types/index.d.ts

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

package/lib/types/index.js

@@ -19,4 +19,3 @@ __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.3.0-beta.2",
+  "version": "1.3.0-beta.3",
   "description": "engine-files-reftestでコンテンツを自動実行するためのライブラリ",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

package/lib/types/CustomWindow.d.ts

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

package/lib/types/CustomWindow.js

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