@arcadible/sdk 0.3.1 → 1.1.0

package/README.md

@@ -46,7 +46,7 @@ const progress = saved ? JSON.parse(saved) : { level: 1 };
 await arcadible.saves.write("progress", JSON.stringify(progress));
 ```
 
-A save is a name holding one string. `ready` settles once the game's saves have loaded, and never fails; from then on, `readSync` answers from memory. Every call that fails rejects with an `ArcadibleError`, whose `code` says what to do.
+A save is a name holding one string. `ready` settles once the game's saves have loaded, and never fails; from then on, `readSync` answers from memory. Every call that fails rejects (or, for `readSync`, throws) with an `ArcadibleError`, whose `code` says what to do.
 
 Off Arcadible, such as on your dev server, the package works on its own, with the same rules and limits: saves are kept on the page's own origin, and `arcadible.build` is `null`.
 

package/dist/bus/protocol.d.ts

@@ -1,8 +1,6 @@
 export declare const BUS_VERSION = 1;
 export declare const HANDSHAKE_TIMEOUT = 1000;
 export declare const REQUEST_TIMEOUT = 10000;
-export declare const HOST_ORIGINS: readonly string[];
-export declare const LOCAL_ORIGIN: RegExp;
 export declare function isHostOrigin(origin: string, origins: readonly string[] | undefined): boolean;
 export declare const MAX_IN_FLIGHT = 64;
 export declare const MAX_MESSAGE: number;
@@ -42,7 +40,7 @@ export type Request = {
     name: string;
     params?: unknown;
 };
-export type Response = {
+type Response = {
     kind: "response";
     id: number;
     result: unknown;
@@ -51,7 +49,7 @@ export type Response = {
     id: number;
     error: ErrorBody;
 };
-export type BusEvent = {
+type BusEvent = {
     kind: "event";
     name: string;
     data?: unknown;
@@ -62,9 +60,9 @@ export declare class ArcadibleError extends Error {
     constructor(code: Code, message: string);
     toJSON(): ErrorBody;
 }
-export declare function isObject(value: unknown): value is Record<string, unknown>;
 export declare function isHello(value: unknown): value is Hello;
 export declare function isWelcome(value: unknown): value is Welcome;
 export declare function isMessage(value: unknown): value is Message;
 export declare function utf8Size(text: string): number;
 export declare function messageSize(value: unknown, limit?: number): number;
+export {};

package/dist/bus/protocol.js

@@ -9,22 +9,19 @@ export const BUS_VERSION = 1;
 export const HANDSHAKE_TIMEOUT = 1000;
 // How long a request waits for its response.
 export const REQUEST_TIMEOUT = 10_000;
-// The play pages a game accepts a welcome from: production's, and `arc
-// serve`'s on this machine. Another development page (play.arcadible.test)
-// is passed with `createClient({ origins })`, never trusted by what games
-// ship, since a hostile network could pose as an http one.
-export const HOST_ORIGINS = ["https://play.arcadible.com"];
-// `arc serve`'s play page, on any port. The network can't pose as loopback,
-// and on Arcadible a build's `frame-ancestors` lets only the play page frame
-// it, so no local page can reach a player's saves there.
-export const LOCAL_ORIGIN = /^http:\/\/localhost:\d+$/u;
 // [function]
 // Whether a game accepts a welcome from `origin`: one of `origins` when it
-// was given, or else production's or `arc serve`'s.
+// was given (tests, and development pages), or else any real origin, `http`
+// included, whatever framed it. Who may frame a build is decided outside the
+// game, where it can change: on Arcadible by each build's `frame-ancestors`,
+// which the browser enforces before the game runs, and elsewhere by whoever
+// serves it. So the host is never trusted with anything of value (DESIGN.md,
+// section 4). Only `null` is refused: a `file://` page or a sandboxed frame,
+// which can't be told apart.
 export function isHostOrigin(origin, origins) {
     return origins
         ? origins.includes(origin)
-        : HOST_ORIGINS.includes(origin) || LOCAL_ORIGIN.test(origin);
+        : origin !== "null" && origin !== "";
 }
 // The most requests one game can have waiting on the page; past it, a
 // request fails with `busy`.
@@ -65,7 +62,7 @@ export class ArcadibleError extends Error {
     }
 }
 // [function]
-export function isObject(value) {
+function isObject(value) {
     return typeof value === "object" && value !== null;
 }
 // [function]

package/dist/host.d.ts

@@ -7,7 +7,7 @@ export type ServeOptions = {
     backend: Backend;
     now?: () => Date;
 };
-export type HostOptions = ServeOptions & {
+type HostOptions = ServeOptions & {
     frame: HTMLIFrameElement;
     origin: string;
     window?: Window;
@@ -18,6 +18,4 @@ export declare function createHost(options: HostOptions): {
 };
 export type { Server } from "./bus/server.js";
 export { indexedDBBackend } from "./saves/backend/indexeddb.js";
-export type { IndexedDBOptions } from "./saves/backend/indexeddb.js";
 export { memoryBackend } from "./saves/backend/memory.js";
-export type { Backend, Change, NewRecord, SaveRecord, Scope, } from "./saves/backend/types.js";

package/dist/host.js

@@ -1,4 +1,4 @@
-// `@arcadible/sdk/host`: the page's side. The play page uses `createHost`;
+// The page's side of the bus. The play page uses `createHost`;
 // a game standing alone runs `serve` in its own page.
 // [import]
 import { answerHellos, createServer } from "./bus/server.js";

package/dist/saves/rules.d.ts

@@ -28,7 +28,6 @@ export type SavesChange = {
     save: Save | null;
     revision: number;
 };
-export declare function isWellFormed(text: string): boolean;
 export declare function checkName(name: unknown): ArcadibleError | null;
 export declare function checkWrite(saves: ReadonlyMap<string, {
     info: SaveMeta;

package/dist/saves/rules.js

@@ -11,7 +11,7 @@ const NAME = /^[A-Za-z0-9_.-]{1,64}$/u;
 // A lone surrogate: half a character, which storage and the network corrupt.
 const LONE_SURROGATE = /\p{Surrogate}/u;
 // [function]
-export function isWellFormed(text) {
+function isWellFormed(text) {
     return !LONE_SURROGATE.test(text);
 }
 // [function]

package/dist/saves/server.d.ts

@@ -1,11 +1,10 @@
 import type { Module, ModuleContext } from "../bus/server.js";
-import type { Backend, SaveRecord, Scope } from "./backend/types.js";
-import { type Save } from "./rules.js";
-export type SavesServerOptions = {
+import type { Backend, Scope } from "./backend/types.js";
+type SavesServerOptions = {
     scope: Scope;
     version: string | null;
     backend: Backend;
     now: () => Date;
 };
-export declare function toSave(record: SaveRecord): Save;
 export declare function savesServer(options: SavesServerOptions): (context: ModuleContext) => Module;
+export {};

package/dist/saves/server.js

@@ -5,7 +5,7 @@
 import { ArcadibleError, Codes, utf8Size } from "../bus/protocol.js";
 import { checkName, checkWrite, } from "./rules.js";
 // [function]
-export function toSave(record) {
+function toSave(record) {
     const { name, data, version, savedAt, size, revision } = record;
     return { name, data, info: { version, savedAt, size, revision } };
 }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.3.1";
+export declare const VERSION = "1.1.0";

package/dist/version.js

@@ -1,3 +1,3 @@
 // The client's version, sent in its hello and shown as `arcadible.version`,
 // for bug reports. It matches package.json (test/unit/protocol.test.ts).
-export const VERSION = "0.3.1";
+export const VERSION = "1.1.0";

package/package.json

@@ -43,5 +43,5 @@
   ],
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "0.3.1"
+  "version": "1.1.0"
 }