@phaserjs/phaser-editor-layout 1.0.0

package/global/phaser-editor-layout.global.d.ts

@@ -0,0 +1,81 @@
+// Editor-facing global type declarations for @phaserjs/phaser-editor-layout.
+//
+// The library ships as a browser global (the IIFE build, dist/phaser-editor-layout.js)
+// exposing `PhaserEditorLayout`, exactly like Phaser ships as the `Phaser` global. This
+// file types that global for hosts that consume the lib as a plain <script> instead of
+// an ESM import (the Phaser Editor workbench).
+//
+// It is the hand-authored counterpart of the lib's generated ESM `.d.ts`; keep it in
+// sync with the public API in ../src. The workbench copies this file into the scene
+// plugin as a `.ts` (see workbench/scripts/get-latest-layout.sh) so that, under the
+// plugin's `outFile` build, the namespace is re-emitted and visible to other plugins.
+
+declare namespace PhaserEditorLayout {
+
+    type HAnchor = "left" | "center" | "right" | "none";
+
+    type VAnchor = "top" | "center" | "bottom" | "none";
+
+    type TargetType = "screen" | "safeArea" | "parent" | "custom";
+
+    type VariantName = "base" | "portrait" | "landscape";
+
+    interface AnchorProps {
+        targetType?: TargetType;
+        targetZone?: LayoutZone;
+        horizontalAnchor?: HAnchor;
+        horizontalOffset?: number;
+        verticalAnchor?: VAnchor;
+        verticalOffset?: number;
+    }
+
+    interface AnchorLayoutData {
+        enabled: boolean;
+        base: AnchorProps;
+        portrait: AnchorProps;
+        landscape: AnchorProps;
+    }
+
+    interface ZoneMargins {
+        marginTop: number;
+        marginRight: number;
+        marginBottom: number;
+        marginLeft: number;
+    }
+
+    interface VariantProvider {
+        readonly variant: VariantName;
+        readonly designSize: { width: number; height: number } | null;
+    }
+
+    class LayoutZone {
+        base: ZoneMargins;
+        portrait: Partial<ZoneMargins>;
+        landscape: Partial<ZoneMargins>;
+        constructor(scene: Phaser.Scene, provider: VariantProvider, marginTop?: number, marginRight?: number, marginBottom?: number, marginLeft?: number);
+        getRect(out?: Phaser.Geom.Rectangle): Phaser.Geom.Rectangle;
+    }
+
+    const LAYOUT_UPDATE_EVENT: string;
+
+    class LayoutPlugin extends Phaser.Plugins.ScenePlugin {
+        readonly safeArea: LayoutZone;
+        readonly screen: LayoutZone;
+        readonly events: Phaser.Events.EventEmitter;
+        variant: VariantName;
+        get designSize(): { width: number; height: number } | null;
+        setDesignSize(width: number, height: number): void;
+        clearDesignSize(): void;
+        get orientation(): "portrait" | "landscape";
+        setVariant(variant: VariantName): void;
+        autoVariant(enabled?: boolean): void;
+        add<T extends Phaser.GameObjects.GameObject>(obj: T): AnchorLayoutData;
+        remove(obj: Phaser.GameObjects.GameObject): void;
+        createZone(marginTop?: number, marginRight?: number, marginBottom?: number, marginLeft?: number): LayoutZone;
+        refresh(): void;
+        resolveList(objects: Phaser.GameObjects.GameObject[]): void;
+        on(event: string, fn: Function, context?: any): this;
+        once(event: string, fn: Function, context?: any): this;
+        off(event: string, fn?: Function, context?: any): this;
+    }
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+    "name": "@phaserjs/phaser-editor-layout",
+    "version": "1.0.0",
+    "description": "Responsive layout runtime for Phaser 3 — anchors, zones and safe areas. The runtime counterpart to Phaser Editor's responsive layout system.",
+    "type": "module",
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        },
+        "./global": "./dist/phaser-editor-layout.js"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "dist",
+        "global",
+        "README.md"
+    ],
+    "scripts": {
+        "build": "npm run clean && npm run build:types && npm run build:global",
+        "build:types": "tsc -p tsconfig.json",
+        "build:global": "node scripts/build-global.mjs",
+        "watch": "tsc -p tsconfig.json -w",
+        "clean": "rimraf dist",
+        "prepublishOnly": "npm run build"
+    },
+    "keywords": [
+        "phaser",
+        "phaser3",
+        "layout",
+        "responsive",
+        "anchor",
+        "constraint",
+        "safe-area",
+        "scale",
+        "ui"
+    ],
+    "author": "Phaser Studio (https://phaser.io/)",
+    "license": "MIT",
+    "peerDependencies": {
+        "phaser": "^3.60.0"
+    },
+    "devDependencies": {
+        "esbuild": "^0.28.1",
+        "phaser": "^3.90.0",
+        "rimraf": "^5.0.5",
+        "typescript": "^5.4.5"
+    }
+}