@arcadible/sdk 0.0.0-stage → 0.3.0

package/LICENSE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -1,3 +1,62 @@
-# Temporary Holding Version
+<p align="center">
+  <a href="https://arcadible.com">
+    <img src="https://adn-arcadible.imgix.net/images/i18n/core/www/appicon-512.png?w=256" alt="Arcadible" height="96">
+  </a>
+</p>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<h1 align="center">Arcadible SDK</h1>
+
+<p align="center">
+  Saves that carry over from one version of your game to the next.
+</p>
+
+<p align="center">
+  <a href="https://developer.arcadible.com/references/arcadible-sdk">Docs</a> ·
+  <a href="https://developer.arcadible.com/build/saves">Saves</a> ·
+  <a href="https://arcadible.com">Arcadible</a> ·
+  <a href="https://studio.arcadible.com">Studio</a>
+</p>
+
+<br>
+
+Each version of a game on [Arcadible](https://arcadible.com) has its own origin, so its browser storage starts empty with every update. Saves made through the Arcadible SDK are kept by the play page instead, on the player's device, so they carry over. The SDK is optional, and saves are all it does.
+
+## Install
+
+```sh
+npm install @arcadible/sdk
+```
+
+For a game with a build step, such as a Vite project. A game without one includes the hosted script instead, served on Arcadible from every game's own origin:
+
+```html
+<script src="/arcadible/sdk/v1.js"></script>
+```
+
+## Save and load
+
+```js
+import { arcadible } from "@arcadible/sdk";
+
+await arcadible.ready;
+
+const saved = arcadible.saves.readSync("progress");
+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.
+
+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`.
+
+## Learn more
+
+- [Saves](https://developer.arcadible.com/build/saves): adding the SDK, what to save, and other versions' saves.
+- [`arcadible.saves`](https://developer.arcadible.com/references/arcadible-sdk/saves): every call, what it returns, and when it fails.
+- [Arcadible SDK](https://developer.arcadible.com/references/arcadible-sdk): `ready` and `build`, and every code.
+- [Limits](https://developer.arcadible.com/references/limits#saves): how many saves, and how large.
+
+## License
+
+Apache-2.0

package/dist/bus/client.d.ts

@@ -0,0 +1,16 @@
+import { type Welcome } from "./protocol.js";
+import type { Server } from "./server.js";
+export type BusOptions = {
+    client: string;
+    window?: Window | undefined;
+    origins?: readonly string[] | undefined;
+    handshakeTimeout?: number | undefined;
+    requestTimeout?: number | undefined;
+    standalone: () => Server;
+};
+export type Bus = {
+    readonly welcomed: Promise<Welcome>;
+    request(name: string, params?: object): Promise<unknown>;
+    on(name: string, listener: (data: unknown) => void): () => void;
+};
+export declare function openBus(options: BusOptions): Bus;

package/dist/bus/client.js

@@ -0,0 +1,133 @@
+// The game's end of the bus: it says hello to the play page, and stands
+// alone when no page answers, running the page's end itself, in its own
+// page, so the rules are the same.
+// [import]
+import { ArcadibleError, BUS_VERSION, Codes, HANDSHAKE_TIMEOUT, HOST_ORIGINS, isMessage, isWelcome, REQUEST_TIMEOUT, } from "./protocol.js";
+// [function]
+export function openBus(options) {
+    const win = options.window ?? (typeof window === "undefined" ? undefined : window);
+    const origins = options.origins ?? HOST_ORIGINS;
+    const requestTimeout = options.requestTimeout ?? REQUEST_TIMEOUT;
+    let state = "waiting";
+    let port = null;
+    let nextId = 1;
+    let handshakeTimer;
+    const pending = new Map();
+    const listeners = new Map();
+    let welcome = () => undefined;
+    const welcomed = new Promise((resolve) => {
+        welcome = resolve;
+    });
+    // [function]
+    const onPortMessage = function (event) {
+        const message = event.data;
+        if (!isMessage(message))
+            return;
+        handle(message);
+    };
+    // [function]
+    const handle = function (message) {
+        if (message.kind === "response") {
+            const call = pending.get(message.id);
+            if (!call)
+                return;
+            pending.delete(message.id);
+            clearTimeout(call.timer);
+            if ("error" in message) {
+                const { code, message: text } = message.error;
+                call.reject(new ArcadibleError(code, text));
+            }
+            else {
+                call.resolve(message.result);
+            }
+        }
+        else if (message.kind === "event") {
+            for (const listener of [...(listeners.get(message.name) ?? [])]) {
+                listener(message.data);
+            }
+        }
+        else {
+            // the page asks nothing yet; a newer page's request gets `unsupported`.
+            port?.postMessage({
+                kind: "response",
+                id: message.id,
+                error: {
+                    code: Codes.Unsupported,
+                    message: `Unknown request: ${message.name}`,
+                },
+            });
+        }
+    };
+    // [function]
+    const attach = function (link, body) {
+        port = link;
+        port.onmessage = onPortMessage;
+        welcome(body);
+    };
+    // [function]
+    // no play page: the page's end runs here, over a channel within this page.
+    const standAlone = function () {
+        if (state !== "waiting")
+            return;
+        state = "standalone";
+        win?.removeEventListener("message", onWindowMessage);
+        const channel = new MessageChannel();
+        attach(channel.port1, options.standalone().connect(channel.port2));
+    };
+    // [function]
+    const onWindowMessage = function (event) {
+        if (state !== "waiting" ||
+            !win ||
+            event.source !== win.parent ||
+            !origins.includes(event.origin) ||
+            !isWelcome(event.data) ||
+            !event.ports[0]) {
+            return;
+        }
+        state = "connected";
+        clearTimeout(handshakeTimer);
+        win.removeEventListener("message", onWindowMessage);
+        attach(event.ports[0], event.data);
+    };
+    // [start]
+    if (!win || win.parent === win) {
+        // not in a frame, so there's no play page to wait for.
+        standAlone();
+    }
+    else {
+        win.addEventListener("message", onWindowMessage);
+        handshakeTimer = setTimeout(standAlone, options.handshakeTimeout ?? HANDSHAKE_TIMEOUT);
+        win.parent.postMessage({ arcadible: "hello", v: BUS_VERSION, client: options.client }, "*");
+    }
+    return {
+        welcomed,
+        async request(name, params) {
+            await welcomed;
+            // welcomed, so there's a channel: the play page's, or this page's own.
+            const link = port;
+            if (!link) {
+                throw new ArcadibleError(Codes.Unavailable, "Not connected.");
+            }
+            const id = nextId++;
+            return new Promise((resolve, reject) => {
+                const timer = setTimeout(() => {
+                    pending.delete(id);
+                    reject(new ArcadibleError(Codes.Timeout, `${name} timed out.`));
+                }, requestTimeout);
+                pending.set(id, { resolve, reject, timer });
+                link.postMessage({ kind: "request", id, name, params });
+            });
+        },
+        on(name, listener) {
+            let set = listeners.get(name);
+            if (!set) {
+                set = new Set();
+                listeners.set(name, set);
+            }
+            set.add(listener);
+            return () => {
+                set.delete(listener);
+            };
+        },
+    };
+}

package/dist/bus/protocol.d.ts

@@ -0,0 +1,68 @@
+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 MAX_IN_FLIGHT = 64;
+export declare const MAX_MESSAGE: number;
+export declare const Codes: {
+    readonly Busy: "busy";
+    readonly Full: "full";
+    readonly Invalid: "invalid";
+    readonly NotReady: "not_ready";
+    readonly Timeout: "timeout";
+    readonly TooLarge: "too_large";
+    readonly TooMany: "too_many";
+    readonly Unavailable: "unavailable";
+    readonly Unsupported: "unsupported";
+};
+export type Code = (typeof Codes)[keyof typeof Codes];
+export type Build = {
+    version: string;
+    channel: string;
+};
+export type Hello = {
+    arcadible: "hello";
+    v: number;
+    client: string;
+};
+export type Welcome = {
+    arcadible: "welcome";
+    v: number;
+    build: Build | null;
+};
+export type ErrorBody = {
+    code: string;
+    message: string;
+};
+export type Request = {
+    kind: "request";
+    id: number;
+    name: string;
+    params?: unknown;
+};
+export type Response = {
+    kind: "response";
+    id: number;
+    result: unknown;
+} | {
+    kind: "response";
+    id: number;
+    error: ErrorBody;
+};
+export type BusEvent = {
+    kind: "event";
+    name: string;
+    data?: unknown;
+};
+export type Message = Request | Response | BusEvent;
+export declare class ArcadibleError extends Error {
+    readonly code: Code;
+    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;

package/dist/bus/protocol.js

@@ -0,0 +1,140 @@
+// The bus's rules, shared by both ends so they can't drift apart: the
+// handshake, the message shapes, the error codes, and the limits on what
+// crosses it (DESIGN.md, section 4). It knows nothing of any module.
+// [declare]
+// The bus's own version: the handshake and the message shapes. New modules,
+// names, and fields are additions within it.
+export const BUS_VERSION = 1;
+// How long a game waits for the play page's welcome before it stands alone.
+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 only. A
+// development page (play.arcadible.test, `arc preview`) 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"];
+// The most requests one game can have waiting on the page; past it, a
+// request fails with `busy`.
+export const MAX_IN_FLIGHT = 64;
+// One message, checked by the side that receives it: room for a whole 1 MB
+// save, and the rest of the message.
+export const MAX_MESSAGE = 1024 * 1024 + 64 * 1024;
+// [declare]
+// Every code a call can fail with. Worth retrying: `busy`, `timeout`, and
+// `unavailable`. Not: `full` (the device has no room; the player must free
+// some), `invalid`, `too_large`, and `too_many`. More may come: a game
+// treats a code it doesn't know as `unavailable`.
+export const Codes = {
+    Busy: "busy",
+    Full: "full",
+    Invalid: "invalid",
+    NotReady: "not_ready",
+    Timeout: "timeout",
+    TooLarge: "too_large",
+    TooMany: "too_many",
+    Unavailable: "unavailable",
+    Unsupported: "unsupported",
+};
+// [class]
+// A failed call. Match on `code`; the message is for people.
+export class ArcadibleError extends Error {
+    // [field]
+    code;
+    // [constructor]
+    constructor(code, message) {
+        super(message);
+        this.code = code;
+        this.name = "ArcadibleError";
+    }
+    // [method]
+    toJSON() {
+        return { code: this.code, message: this.message };
+    }
+}
+// [function]
+export function isObject(value) {
+    return typeof value === "object" && value !== null;
+}
+// [function]
+export function isHello(value) {
+    return (isObject(value) &&
+        value["arcadible"] === "hello" &&
+        typeof value["v"] === "number" &&
+        value["v"] >= 1);
+}
+// [function]
+export function isWelcome(value) {
+    return (isObject(value) &&
+        value["arcadible"] === "welcome" &&
+        value["v"] === BUS_VERSION);
+}
+// [function]
+export function isMessage(value) {
+    if (!isObject(value))
+        return false;
+    switch (value["kind"]) {
+        case "request":
+            return (typeof value["id"] === "number" && typeof value["name"] === "string");
+        case "response":
+            return typeof value["id"] === "number";
+        case "event":
+            return typeof value["name"] === "string";
+        default:
+            return false;
+    }
+}
+// [function]
+// A string's size in UTF-8 bytes, without encoding it.
+export function utf8Size(text) {
+    let size = 0;
+    for (let i = 0; i < text.length; i++) {
+        const unit = text.charCodeAt(i);
+        if (unit < 0x80)
+            size += 1;
+        else if (unit < 0x800)
+            size += 2;
+        else if (unit >= 0xd800 && unit <= 0xdbff) {
+            // a pair is one 4-byte character.
+            size += 4;
+            i++;
+        }
+        else
+            size += 3;
+    }
+    return size;
+}
+// [function]
+// A rough size of a message as the browser copies it: strings by their
+// UTF-8 bytes, and a few bytes for anything else. It only has to be close
+// enough to refuse a message far over the limit, so it stops counting once
+// past `limit`, and counts an object it has seen (a cycle) once.
+export function messageSize(value, limit = Number.POSITIVE_INFINITY) {
+    const seen = new WeakSet();
+    let size = 0;
+    const stack = [value];
+    while (stack.length > 0 && size <= limit) {
+        const item = stack.pop();
+        if (typeof item === "string")
+            size += utf8Size(item) + 2;
+        else if (!isObject(item))
+            size += 8;
+        else if (seen.has(item))
+            size += 8;
+        else {
+            seen.add(item);
+            size += 2;
+            if (Array.isArray(item)) {
+                for (const entry of item)
+                    stack.push(entry);
+            }
+            else {
+                for (const [key, entry] of Object.entries(item)) {
+                    size += utf8Size(key);
+                    stack.push(entry);
+                }
+            }
+        }
+    }
+    return size;
+}

package/dist/bus/server.d.ts

@@ -0,0 +1,32 @@
+import { type Build, type Welcome } from "./protocol.js";
+export type Params = Record<string, unknown>;
+export type Handler = {
+    run(params: Params): Promise<unknown>;
+    coalesce?(params: Params): string;
+};
+export type ModuleContext = {
+    broadcast(name: string, data: unknown): void;
+};
+export type Module = {
+    handlers: Record<string, Handler>;
+    open?(send: (name: string, data: unknown) => void): Promise<void>;
+    close?(): void;
+};
+export type ServerOptions = {
+    build: Build | null;
+    modules: ((context: ModuleContext) => Module)[];
+};
+export type Server = {
+    connect(port: MessagePort): Welcome;
+    disconnect(port: MessagePort): void;
+    close(): void;
+};
+export declare function createServer(options: ServerOptions): Server;
+export declare function answerHellos({ frame, origin, server, window: win, }: {
+    frame: HTMLIFrameElement;
+    origin: string;
+    server: Server;
+    window: Window;
+}): {
+    close(): void;
+};