web: Move player stuff to Player module

web/packages/core/src/index.ts

@@ -6,8 +6,5 @@
 
 export * as Setup from "./public/setup";
 export * as Config from "./public/config";
+export * as Player from "./public/player";
 export * from "./build-info";
-export * from "./movie-metadata";
-export * from "./public/flash";
-export * from "./public/legacy";
-export * from "./public/player-element";

web/packages/core/src/internal/internal-source-api.ts

@@ -1,6 +1,6 @@
 import { buildInfo } from "../build-info";
 import { pluginPolyfill, polyfill } from "../polyfills";
-import { PlayerElement } from "../public/player-element";
+import { PlayerElement } from "../public/player";
 import { registerElement } from "./register-element";
 import { RufflePlayerElement } from "./player/ruffle-player-element";
 import { InstallationOptions } from "../public/setup";

web/packages/core/src/internal/player/inner.tsx

@@ -9,7 +9,7 @@ import {
     WindowMode,
     DEFAULT_CONFIG,
 } from "../../public/config";
-import type { MovieMetadata } from "../../movie-metadata";
+import type { MovieMetadata } from "../../public/player";
 import { ruffleShadowTemplate } from "../ui/shadow-template";
 import { text, textAsParagraphs } from "../i18n";
 import { swfFileName } from "../../swf-utils";

web/packages/core/src/internal/player/ruffle-player-element.tsx

@@ -1,7 +1,6 @@
 import type { DataLoadOptions, URLLoadOptions } from "../../public/config";
-import type { MovieMetadata } from "../../movie-metadata";
+import type { MovieMetadata, PlayerElement } from "../../public/player";
 import { InnerPlayer, ReadyState } from "./inner";
-import { PlayerElement } from "../../public/player-element";
 
 /**
  * The ruffle player element that should be inserted onto the page.

web/packages/core/src/public/player/index.ts

@@ -0,0 +1,4 @@
+export * from "./flash";
+export * from "./player-element";
+export * from "./movie-metadata";
+export * from "./legacy";

web/packages/core/src/public/legacy.ts → web/packages/core/src/public/player/legacy.ts

@@ -1,6 +1,6 @@
-import { DataLoadOptions, URLLoadOptions } from "./config";
-import { MovieMetadata } from "../movie-metadata";
-import { ReadyState } from "../internal/player/inner";
+import { DataLoadOptions, URLLoadOptions } from "../config";
+import { MovieMetadata } from "./movie-metadata";
+import { ReadyState } from "../../internal/player/inner";
 
 /**
  * Legacy interface to the Ruffle API.

web/packages/core/src/public/setup/source-api.ts

@@ -1,4 +1,4 @@
-import { PlayerElement } from "../player-element";
+import { PlayerElement } from "../player";
 
 /**
  * Represents this particular version of Ruffle.

web/packages/demo/src/App.tsx

@@ -1,6 +1,6 @@
 import { Player } from "./player.tsx";
 import { useRef, useState, DragEvent, useCallback } from "react";
-import type { Config, MovieMetadata } from "ruffle-core";
+import type { Config, Player as RufflePlayer } from "ruffle-core";
 import { Navbar } from "./navbar.tsx";
 import { MetadataPanel } from "./metadata.tsx";
 
@@ -15,7 +15,9 @@ export function App({
     allowUrlLoading,
     allowSampleSwfs,
 }: AppProperties) {
-    const [metadata, setMetadata] = useState<MovieMetadata | null>(null);
+    const [metadata, setMetadata] = useState<RufflePlayer.MovieMetadata | null>(
+        null,
+    );
     const [metadataVisible, setMetadataVisible] = useState<boolean>(false);
     const [selectedFilename, setSelectedFilename] = useState<string | null>(
         null,

web/packages/demo/src/metadata.tsx

@@ -1,8 +1,8 @@
-import { MovieMetadata } from "ruffle-core";
+import { Player } from "ruffle-core";
 
 interface MetadataProps {
     visible: boolean;
-    metadata: MovieMetadata | null;
+    metadata: Player.MovieMetadata | null;
 }
 
 const swfToFlashVersion: { [key: number]: string } = {
@@ -68,7 +68,7 @@ export function MetadataPanel({ visible, metadata }: MetadataProps) {
                 <span>FP Version</span>
                 <span id="flashVersion">
                     {metadata
-                        ? swfToFlashVersion[metadata.swfVersion] ?? "Unknown"
+                        ? (swfToFlashVersion[metadata.swfVersion] ?? "Unknown")
                         : ""}
                 </span>
             </div>

web/packages/demo/src/player.tsx

@@ -1,10 +1,10 @@
 import React, { ReactNode, DragEvent } from "react";
-import { Setup, PlayerElement, MovieMetadata, Config } from "ruffle-core";
+import { Setup, Player as RufflePlayer, Config } from "ruffle-core";
 
 export interface PlayerAttributes {
     id?: string | undefined;
     children?: ReactNode;
-    onLoadedMetadata: (metadata: MovieMetadata) => void;
+    onLoadedMetadata: (metadata: RufflePlayer.MovieMetadata) => void;
     baseConfig?: Config.BaseLoadOptions;
     onDragEnter: (event: DragEvent<HTMLElement>) => void;
     onDragLeave: (event: DragEvent<HTMLElement>) => void;
@@ -14,7 +14,7 @@ export interface PlayerAttributes {
 
 export class Player extends React.Component<PlayerAttributes> {
     private readonly container: React.RefObject<HTMLDivElement>;
-    private player: PlayerElement | null = null;
+    private player: RufflePlayer.PlayerElement | null = null;
 
     // [NA] Ruffle has a bug where if you load a swf whilst it's already loading another swf, it breaks
     // Combine this with React testing everything by loading things twice to catch bugs - well, they caught the bug for sure.

web/packages/extension/src/player.ts

@@ -1,7 +1,7 @@
 import * as utils from "./utils";
 import { Setup } from "ruffle-core";
 
-import type { Config, PlayerElement } from "ruffle-core";
+import type { Config, Player } from "ruffle-core";
 
 declare global {
     interface Navigator {
@@ -15,7 +15,7 @@ declare global {
 
 Setup.installRuffle("local");
 const ruffle = (window.RufflePlayer as Setup.PublicAPI).newest()!;
-let player: PlayerElement;
+let player: Player.PlayerElement;
 
 const playerContainer = document.getElementById("player-container")!;
 const overlay = document.getElementById("overlay")!;

web/packages/selfhosted/test/js_api/load.ts

@@ -1,7 +1,7 @@
 import { loadJsAPI, playAndMonitor } from "../utils.js";
 import { use } from "chai";
 import chaiHtml from "chai-html";
-import { PlayerElement } from "ruffle-core";
+import { Player } from "ruffle-core";
 
 use(chaiHtml);
 
@@ -12,7 +12,7 @@ describe("RufflePlayer.load", () => {
         const player = await browser.$("<ruffle-player>");
         await browser.execute(async (playerElement) => {
             // https://github.com/webdriverio/webdriverio/issues/6486
-            const player = playerElement as unknown as PlayerElement;
+            const player = playerElement as unknown as Player.PlayerElement;
             await player.load("/test_assets/example.swf");
         }, player);
         await playAndMonitor(browser, player);

web/packages/selfhosted/test/js_api/metadata.ts

@@ -1,7 +1,7 @@
 import { loadJsAPI } from "../utils.js";
 import { expect, use } from "chai";
 import chaiHtml from "chai-html";
-import { PlayerElement } from "ruffle-core";
+import { Player } from "ruffle-core";
 
 use(chaiHtml);
 
@@ -12,7 +12,7 @@ describe("RufflePlayer.metadata", () => {
         const player = await browser.$("<ruffle-player>");
         const metadata = await browser.execute(
             // https://github.com/webdriverio/webdriverio/issues/6486
-            (player) => (player as unknown as PlayerElement).metadata,
+            (player) => (player as unknown as Player.PlayerElement).metadata,
             player,
         );
         // [NA] Work around a chrome 87 bug where it's (somehow) adding extra data to this object

web/packages/selfhosted/test/utils.ts

@@ -1,13 +1,13 @@
 import { expect } from "chai";
-import { PlayerElement, Setup } from "ruffle-core";
+import { Player, Setup } from "ruffle-core";
 
 declare global {
     interface Window {
         ruffleErrors: ErrorEvent[];
     }
 }
 
-declare module "ruffle-core" {
+declare module "ruffle-core/dist/public/player" {
     interface PlayerElement {
         __ruffle_log__: string;
     }
@@ -31,7 +31,7 @@ export async function isRufflePlayerLoaded(
             (player) =>
                 // https://github.com/webdriverio/webdriverio/issues/6486
                 // TODO: How can we import ReadyState enum?
-                (player as unknown as PlayerElement).readyState,
+                (player as unknown as Player.PlayerElement).readyState,
             player,
         )) === 2
     );
@@ -103,7 +103,7 @@ export async function setupAndPlay(
 ) {
     await browser.execute((playerElement) => {
         // https://github.com/webdriverio/webdriverio/issues/6486
-        const player = playerElement as unknown as PlayerElement;
+        const player = playerElement as unknown as Player.PlayerElement;
         player.__ruffle_log__ = "";
         player.traceObserver = (msg) => {
             player.__ruffle_log__ += msg + "\n";
@@ -122,7 +122,8 @@ export async function getTraceOutput(
             return (
                 (await browser.execute((player) => {
                     // https://github.com/webdriverio/webdriverio/issues/6486
-                    return (player as unknown as PlayerElement).__ruffle_log__;
+                    return (player as unknown as Player.PlayerElement)
+                        .__ruffle_log__;
                 }, player)) !== ""
             );
         },
@@ -134,7 +135,7 @@ export async function getTraceOutput(
     // Get the output, and replace it with an empty string for any future test
     return await browser.execute((playerElement) => {
         // https://github.com/webdriverio/webdriverio/issues/6486
-        const player = playerElement as unknown as PlayerElement;
+        const player = playerElement as unknown as Player.PlayerElement;
         const log = player.__ruffle_log__;
         player.__ruffle_log__ = "";
         return log;
@@ -190,7 +191,7 @@ export function loadJsAPI(swf?: string) {
             await browser.execute(
                 async (player, swf) => {
                     // https://github.com/webdriverio/webdriverio/issues/6486
-                    await (player as unknown as PlayerElement).load(swf);
+                    await (player as unknown as Player.PlayerElement).load(swf);
                 },
                 player,
                 swf,