castle-web-sdk 0.4.11 → 0.4.12

package/README.md

@@ -412,6 +412,23 @@ await writeFile("scenes/main.scene", JSON.stringify(scene, null, 2));
 Only works while editing locally with `castle-web serve`. Calls from a
 published deck fail.
 
+### `fileUrl(path): string`
+
+A URL that serves a deck file as raw bytes. Point an `<img>`, `<audio>`,
+or `<video>` at it when editor UI has to show a file the browser renders
+natively — `writeFile`'s counterpart reads text, which is nothing an
+image or a sound can be read as.
+
+```js
+import { fileUrl } from "castle-web-sdk";
+
+<img src={fileUrl("assets/logo.png")} alt="" />;
+```
+
+Like `writeFile`, this only means anything while editing locally with
+`castle-web serve` — a published deck has no serve to ask, and should
+load its assets through the bundler instead.
+
 ## CastleError
 
 Every error the SDK throws is a `CastleError`. Check `code` to tell

package/dist/castle.d.ts

@@ -11,7 +11,7 @@ export { Pass } from "./passes";
 export type { CastlePassApi, PassOfferResult, PassOfferStatus, } from "./passes";
 export { Portal } from "./portal";
 export type { CastlePortalApi, PortalOpenResult, PortalOpenStatus, PortalPrefetchResult, PortalPrefetchStatus, } from "./portal";
-export { CARD_RATIO, initCard, onBeforeRestart, onFilesChanged, onSaveReloadState, requestReload, setup, takeReloadState, writeFile, } from "./runtime";
+export { CARD_RATIO, fileUrl, initCard, onBeforeRestart, onFilesChanged, onSaveReloadState, requestReload, setup, takeReloadState, writeFile, } from "./runtime";
 export type { FileChange, FilesChangedEvent } from "./runtime";
 export { SharedStorage, Storage } from "./storage";
 export { Time } from "./time";

package/dist/castle.js

@@ -7,7 +7,7 @@ export { Leaderboard } from "./leaderboard";
 export { Lifecycle } from "./lifecycle";
 export { Pass } from "./passes";
 export { Portal } from "./portal";
-export { CARD_RATIO, initCard, onBeforeRestart, onFilesChanged, onSaveReloadState, requestReload, setup, takeReloadState, writeFile, } from "./runtime";
+export { CARD_RATIO, fileUrl, initCard, onBeforeRestart, onFilesChanged, onSaveReloadState, requestReload, setup, takeReloadState, writeFile, } from "./runtime";
 export { SharedStorage, Storage } from "./storage";
 export { Time } from "./time";
 export { User } from "./user";

package/dist/runtime.d.ts

@@ -25,6 +25,7 @@ export interface FilesChangedEvent {
 }
 export declare function setup(): void;
 export declare function writeFile(path: string, contents: string): Promise<LocalResponse>;
+export declare function fileUrl(path: string): string;
 export declare function initCard(): HTMLDivElement;
 export declare function sendLocalCommand<C extends CommandName>(command: C, params: CommandParams[C]): Promise<CommandResponseEnvelope>;
 export declare function onFilesChanged(listener: (event: FilesChangedEvent) => void): () => void;

package/dist/runtime.js

@@ -30,6 +30,14 @@ export function writeFile(path, contents) {
         contents,
     });
 }
+// A same-origin URL that serves a deck file as raw bytes. Editor UI that shows
+// a file the browser renders natively -- an image in an `<img>`, a sound in an
+// `<audio>` -- points at this instead of reading the file, which only speaks
+// text. Only meaningful while editing locally with `castle-web serve`; a
+// published deck has no serve to ask.
+export function fileUrl(path) {
+    return `/__castle/files/raw?path=${encodeURIComponent(path)}`;
+}
 export function initCard() {
     const style = document.createElement("style");
     style.textContent = `

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "castle-web-sdk",
-  "version": "0.4.11",
+  "version": "0.4.12",
   "type": "module",
   "main": "dist/castle.js",
   "types": "dist/castle.d.ts",