@swf2es/desktop 0.0.0-stage → 0.1.14

package/src/shared/api.ts

@@ -0,0 +1,204 @@
+// What the shell gives the page, and all it gives: the preload puts it on
+// window.swf2esDesktop. The renderer knows the shell only through it, so
+// another shell (Tauri, later) plays the same page by giving the same API.
+
+/** Flash's sandboxes, as Security.sandboxType names them, and AIR's application sandbox. */
+export type SandboxType = "localWithFile" | "localWithNetwork" | "remote" | "application";
+
+/**
+ * An AIR application the shell opened by its descriptor, as adl runs one:
+ * what NativeApplication and File see of it.
+ */
+export interface AirLaunch {
+  /** The descriptor's XML and its id. */
+  descriptor: string;
+  id: string;
+  /** What followed `--` on the command line. */
+  arguments: string[];
+  /** Where the shell was started, a native path. */
+  currentDirectory: string;
+  /** The system's path separator. */
+  separator: string;
+  /** The directories AIR names: the application's (the descriptor's) and its storage's among them. */
+  directories: {
+    application: string;
+    applicationStorage: string;
+    user: string;
+    documents: string;
+    desktop: string;
+    cache: string;
+  };
+}
+
+/** What is at a path, as the player's FileStat has it. */
+export interface AirFileStat {
+  directory: boolean;
+  size: number;
+  modified: number;
+  created: number;
+  hidden?: boolean;
+  symbolicLink?: boolean;
+}
+
+/** The window as NativeWindow reads it: bounds frame included, and the content's corner in it. */
+export interface AirWindowState {
+  bounds: { x: number; y: number; width: number; height: number };
+  contentOffset: { x: number; y: number };
+  title: string;
+  displayState: string;
+  active: boolean;
+  visible: boolean;
+}
+
+/**
+ * An AIR application's own reach, only while one the user opened plays:
+ * the file system, read and written synchronously as File does, and the
+ * window.
+ */
+export interface DesktopAir {
+  stat(path: string): AirFileStat | null;
+  list(path: string): string[] | null;
+  read(path: string): Promise<Uint8Array | null>;
+  /** A file's bytes at once, as FileStream's open reads them; null where none can be read. */
+  readSync(path: string): Uint8Array | null;
+  /** EncryptedLocalStore's items, at once, as the player's EncryptedStoreHost has them. */
+  getItem(name: string): Uint8Array | null;
+  setItem(name: string, bytes: Uint8Array): void;
+  removeItem(name: string): void;
+  resetItems(): void;
+  /** FileStream's writes and File's changes, at once, as FileSystemHost's; false where they fail. */
+  writeSync(path: string, bytes: Uint8Array, offset: number, length: number): boolean;
+  createDirectory(path: string): boolean;
+  remove(path: string): boolean;
+  move(from: string, to: string): boolean;
+  window(): AirWindowState;
+  setBounds(bounds: { x: number; y: number; width: number; height: number }): void;
+  setTitle(title: string): void;
+  minimize(): void;
+  maximize(): void;
+  restore(): void;
+  activate(): void;
+  setVisible(visible: boolean): void;
+  close(): void;
+  exit(code: number): void;
+}
+
+/** A SWF the shell opened, by the URL the page fetches it from. */
+export interface OpenedMovie {
+  url: string;
+  /** Its file name, for the page to show. */
+  name: string;
+  /** The sandbox it plays in, for Security.sandboxType. */
+  sandbox: SandboxType;
+  /** For an AIR application opened by its descriptor: its launch, which plays it as AIR's. */
+  air?: AirLaunch;
+}
+
+/** The libraries' paths on disk, null for one the shell has not found. */
+/** A playerglobal.abc the user chose in place of swf2es's own; builtin.abc ships with the player. */
+export interface LibraryState {
+  playerglobal: string | null;
+}
+
+/** What the page starts from: the libraries, and the SWF to play, if one is open. */
+export interface StartState {
+  /** The user's opt-in; changing it restarts the page. */
+  stage3D: boolean;
+  libraries: LibraryState;
+  movie: OpenedMovie | null;
+  /** The app's build, a short commit, for the context menu's About item; null where unknown. */
+  build: string | null;
+}
+
+export type LibraryName = keyof LibraryState;
+
+/** What befalls a socket, as player's SocketEvents has it. */
+export type SocketEvent =
+  | {
+      type: "open";
+      localAddress: string;
+      localPort: number;
+      remoteAddress: string;
+      remotePort: number;
+    }
+  | { type: "data"; bytes: Uint8Array }
+  | { type: "close" }
+  | { type: "error"; message: string };
+
+/** flash.net.Socket's TCP connections, opened by the shell. */
+export interface DesktopSockets {
+  /** A connection's id; its events follow, an "error" one if the shell refuses it. */
+  connect(host: string, port: number): number;
+  send(id: number, bytes: Uint8Array): void;
+  close(id: number): void;
+  onEvent(listener: (id: number, event: SocketEvent) => void): void;
+}
+
+/** A request of a SWF's, as player's FetchRequest has it. */
+export interface NetworkRequest {
+  url: string;
+  method: string;
+  headers: [string, string][];
+  body: Uint8Array | null;
+  /** "movie" for the SWF the page plays, else what the SWF loads it for. */
+  purpose: "movie" | "content" | "data" | "send";
+}
+
+/** Its response, as player's FetchResult has it: no bytes for a failure. */
+export interface NetworkResponse {
+  bytes: Uint8Array | null;
+  status: number;
+  headers: [string, string][];
+  url?: string;
+}
+
+/** A SWF's http and https requests, sent and judged by the shell, as Flash's sandboxes had them. */
+export interface DesktopNetwork {
+  /**
+   * The response, or a rejection where the shell refused the request.
+   * `cancel` is called at once with what aborts it.
+   */
+  fetch(request: NetworkRequest, cancel: (abort: () => void) => void): Promise<NetworkResponse>;
+  /** A policy file the SWF named with Security.loadPolicyFile. */
+  loadPolicyFile(url: string): void;
+}
+
+export interface DesktopFile {
+  id: number;
+  name: string;
+  size: number;
+  modificationDate: number;
+  creationDate: number;
+}
+
+export interface DesktopFiles {
+  browse(
+    filters: { description: string; extension: string }[],
+    multiple: boolean,
+  ): Promise<DesktopFile[]>;
+  save(name: string): Promise<{ id: number; name: string } | null>;
+  read(id: number): Promise<Uint8Array>;
+  write(id: number, bytes: Uint8Array): Promise<void>;
+  release(id: number): void;
+}
+
+export interface DesktopApi {
+  files: DesktopFiles;
+  /** The page has loaded and listens: what it is to show. */
+  start(): Promise<StartState>;
+  /** The shell opened a SWF: play it in place of what plays. */
+  onOpen(listener: (movie: OpenedMovie) => void): void;
+  /** The shell closed the SWF playing. */
+  onClose(listener: () => void): void;
+  /** Ask for the open dialog. */
+  openDialog(): void;
+  /** Ask for the dialog that opens a SWF by its URL, which only the user answers. */
+  openUrlDialog(): void;
+  /** A file dropped on the page: the shell opens it if it is a SWF. */
+  openDropped(file: File): void;
+  /** Ask the user for a library; the page reloads once the shell has it. */
+  chooseLibrary(name: LibraryName): void;
+  sockets: DesktopSockets;
+  network: DesktopNetwork;
+  air: DesktopAir;
+}

package/src/shared/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "../../dist/shared",
+    "tsBuildInfoFile": "../../dist/shared/.tsbuildinfo",
+    "types": [],
+    "lib": ["ES2022", "DOM"]
+  },
+  "include": ["*.ts"]
+}

package/static/index.html

@@ -0,0 +1,22 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<title>swf2es</title>
+<script type="importmap">{"imports":{"@swf2es/native/compress":"/modules/native/compress/index.js","@swf2es/format":"/modules/format/index.js","@swf2es/native/mp3":"/modules/native/mp3/index.js","@swf2es/native/atf":"/modules/native/atf/index.js","@swf2es/native/audio":"/modules/native/audio/index.js","@swf2es/native/render":"/modules/native/render/index.js","@swf2es/codegen":"/modules/codegen/index.js","@swf2es/runtime":"/modules/runtime/index.js","@swf2es/player":"/modules/player/index.js","@swf2es/player-hosts/indexeddb":"/modules/player-hosts/indexeddb.js","@swf2es/player-hosts/precompiled":"/modules/player-hosts/precompiled.js","@swf2es/player-hosts/websocket":"/modules/player-hosts/websocket.js","@swf2es/player-hosts/workers":"/modules/player-hosts/workers.js","@swf2es/web":"/modules/web/index.js","@swf2es/codegen/codegen.wasm":"/modules/codegen/codegen.wasm","@swf2es/context3d":"/modules/context3d/index.js","@swf2es/context3d/webgl":"/modules/context3d/webgl/index.js","@swf2es/render":"/modules/render/index.js","@swf2es/render/webgl":"/modules/render/webgl/index.js","@swf2es/context3d/device":"/modules/context3d/device/index.js","@swf2es/player/scene":"/modules/player/scene/view.js","@swf2es/player/context3d":"/modules/player/playerglobal/context3d.js","@swf2es/player-hosts/stage3d":"/modules/player-hosts/stage3d.js"}}</script>
+<link rel="stylesheet" href="/style.css">
+<script type="module" src="/renderer/index.js"></script>
+</head>
+<body>
+<swf2es-player id="player" allowscriptaccess="never" scale="showAll" hidden></swf2es-player>
+<main id="welcome">
+  <h1>swf2es</h1>
+  <p>Open a SWF with File › Open, by its URL with File › Open URL, or drop one on this window.</p>
+  <p>
+    <button id="open" type="button">Open a SWF…</button>
+    <button id="open-url" type="button">Open a URL…</button>
+  </p>
+</main>
+<p id="failure" role="alert" hidden></p>
+</body>
+</html>

package/static/open-url.html

@@ -0,0 +1,21 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<title>Open URL</title>
+<link rel="stylesheet" href="/style.css">
+<script type="module" src="/renderer/open-url.js"></script>
+</head>
+<body class="prompt">
+<form id="form">
+  <label for="url">Open a SWF by its URL (http or https):</label>
+  <input id="url" type="text" inputmode="url" spellcheck="false" autocomplete="off"
+    placeholder="https://example.com/movie.swf" required>
+  <p id="problem" role="alert" hidden>Only an http or https URL opens.</p>
+  <div class="buttons">
+    <button id="cancel" type="button">Cancel</button>
+    <button type="submit">Open</button>
+  </div>
+</form>
+</body>
+</html>

package/static/style.css

@@ -0,0 +1,96 @@
+:root {
+  color-scheme: light dark;
+  font-family: system-ui, sans-serif;
+  --muted: #666;
+  --panel: #f3f3f3;
+  --error: #c0392b;
+}
+
+@media (prefers-color-scheme: dark) {
+  :root {
+    --muted: #aaa;
+    --panel: #2a2a2a;
+    --error: #ff7b6b;
+  }
+}
+
+html,
+body {
+  height: 100%;
+  margin: 0;
+  overflow: hidden;
+}
+
+swf2es-player {
+  display: block;
+  position: fixed;
+  inset: 0;
+  width: 100%;
+  height: 100%;
+}
+
+[hidden] {
+  display: none;
+}
+
+#welcome {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  height: 100%;
+  color: var(--muted);
+}
+
+#welcome[hidden] {
+  display: none;
+}
+
+#welcome h1 {
+  margin: 0 0 0.5em;
+  font-weight: 600;
+}
+
+#failure {
+  position: fixed;
+  left: 16px;
+  right: 16px;
+  max-width: 640px;
+  margin: 0 auto;
+  padding: 12px 16px;
+  border-radius: 8px;
+  background: var(--panel);
+}
+
+#failure {
+  top: 16px;
+  color: var(--error);
+}
+
+/* The URL dialog. */
+body.prompt {
+  overflow: auto;
+}
+
+.prompt form {
+  display: flex;
+  flex-direction: column;
+  gap: 8px;
+  padding: 16px;
+}
+
+.prompt input {
+  font: inherit;
+  padding: 4px 6px;
+}
+
+.prompt #problem {
+  margin: 0;
+  color: var(--error);
+}
+
+.prompt .buttons {
+  display: flex;
+  justify-content: flex-end;
+  gap: 8px;
+}