@archipelago-js/client 0.1.0

package/README.md

@@ -0,0 +1,15 @@
+# @archipelago-js/client
+
+Core client utilities for Archipelago islands.
+
+## Install
+
+```bash
+yarn add @archipelago-js/client
+```
+
+## API
+
+- `islandFetch(component, operation, payload, options)`
+- `buildIslandPayload(payload, fixedParams, overridePayload)`
+- `parseIslandResponse(value)`

package/dist/csrf.d.ts

@@ -0,0 +1,3 @@
+export declare function getCsrfToken(doc?: Document): string | null;
+export declare function refreshCsrfToken(doc?: Document): string | null;
+export declare function clearCsrfCache(): void;

package/dist/csrf.js

@@ -0,0 +1,20 @@
+let cachedToken = null;
+export function getCsrfToken(doc = document) {
+    if (cachedToken !== null) {
+        return cachedToken;
+    }
+    const token = doc
+        .querySelector("meta[name='csrf-token']")
+        ?.getAttribute("content")
+        ?.trim();
+    cachedToken = token && token.length > 0 ? token : null;
+    return cachedToken;
+}
+export function refreshCsrfToken(doc = document) {
+    cachedToken = null;
+    return getCsrfToken(doc);
+}
+export function clearCsrfCache() {
+    cachedToken = null;
+}
+//# sourceMappingURL=csrf.js.map

package/dist/csrf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"csrf.js","sourceRoot":"","sources":["../src/csrf.ts"],"names":[],"mappings":"AAAA,IAAI,WAAW,GAAkB,IAAI,CAAA;AAErC,MAAM,UAAU,YAAY,CAAC,MAAgB,QAAQ;IACnD,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,MAAM,KAAK,GAAG,GAAG;SACd,aAAa,CAAC,yBAAyB,CAAC;QACzC,EAAE,YAAY,CAAC,SAAS,CAAC;QACzB,EAAE,IAAI,EAAE,CAAA;IAEV,WAAW,GAAG,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAA;IACtD,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAgB,QAAQ;IACvD,WAAW,GAAG,IAAI,CAAA;IAClB,OAAO,YAAY,CAAC,GAAG,CAAC,CAAA;AAC1B,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,WAAW,GAAG,IAAI,CAAA;AACpB,CAAC"}

package/dist/fetch.d.ts

@@ -0,0 +1,13 @@
+import { IslandResponse } from "./types";
+export type IslandFetchOptions = {
+    endpoint?: string;
+    fixedParams?: Record<string, unknown>;
+    overridePayload?: Record<string, unknown>;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+    fetchImpl?: typeof fetch;
+    navigate?: (location: string) => void;
+};
+export type IslandFetchPayload = Record<string, unknown>;
+export declare function buildIslandPayload(payload?: IslandFetchPayload, fixedParams?: Record<string, unknown>, overridePayload?: Record<string, unknown>): Record<string, unknown>;
+export declare function islandFetch(component: string, operation: string, payload?: IslandFetchPayload, options?: IslandFetchOptions): Promise<IslandResponse>;

package/dist/fetch.js

@@ -0,0 +1,60 @@
+import { clearCsrfCache, getCsrfToken } from "./csrf";
+import { parseIslandResponse } from "./types";
+function defaultNavigate(location) {
+    const turbo = window.Turbo;
+    if (turbo?.visit) {
+        turbo.visit(location);
+        return;
+    }
+    window.location.assign(location);
+}
+function hasContent(response) {
+    const contentLength = response.headers.get("content-length");
+    return contentLength == null || contentLength !== "0";
+}
+export function buildIslandPayload(payload = {}, fixedParams = {}, overridePayload = {}) {
+    return {
+        ...fixedParams,
+        ...payload,
+        ...overridePayload
+    };
+}
+export async function islandFetch(component, operation, payload = {}, options = {}) {
+    const fetchImpl = options.fetchImpl ?? fetch;
+    const endpoint = options.endpoint ?? "/islands";
+    const mergedPayload = buildIslandPayload(payload, options.fixedParams, options.overridePayload);
+    const csrfToken = getCsrfToken();
+    const response = await fetchImpl(`${endpoint}/${encodeURIComponent(component)}/${encodeURIComponent(operation)}`, {
+        method: "POST",
+        signal: options.signal,
+        credentials: "same-origin",
+        headers: {
+            "content-type": "application/json",
+            "x-requested-with": "XMLHttpRequest",
+            ...(csrfToken ? { "x-csrf-token": csrfToken } : {}),
+            ...(options.headers ?? {})
+        },
+        body: JSON.stringify(mergedPayload)
+    });
+    if (response.status === 422) {
+        // Rails may rotate CSRF token; force re-read on next request.
+        clearCsrfCache();
+    }
+    if (response.status === 403 && !hasContent(response)) {
+        return { status: "forbidden" };
+    }
+    if (!hasContent(response)) {
+        return { status: "ok", props: {}, version: Date.now() };
+    }
+    const text = await response.text();
+    if (text.trim().length === 0) {
+        return { status: "ok", props: {}, version: Date.now() };
+    }
+    const parsed = parseIslandResponse(JSON.parse(text));
+    if (parsed.status === "redirect") {
+        const navigate = options.navigate ?? defaultNavigate;
+        navigate(parsed.location);
+    }
+    return parsed;
+}
+//# sourceMappingURL=fetch.js.map

package/dist/fetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AACrD,OAAO,EAAkB,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAc7D,SAAS,eAAe,CAAC,QAAgB;IACvC,MAAM,KAAK,GAAI,MAAwE,CAAC,KAAK,CAAA;IAE7F,IAAI,KAAK,EAAE,KAAK,EAAE,CAAC;QACjB,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QACrB,OAAM;IACR,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;AAClC,CAAC;AAED,SAAS,UAAU,CAAC,QAAkB;IACpC,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;IAC5D,OAAO,aAAa,IAAI,IAAI,IAAI,aAAa,KAAK,GAAG,CAAA;AACvD,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,UAA8B,EAAE,EAChC,cAAuC,EAAE,EACzC,kBAA2C,EAAE;IAE7C,OAAO;QACL,GAAG,WAAW;QACd,GAAG,OAAO;QACV,GAAG,eAAe;KACnB,CAAA;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,SAAiB,EACjB,SAAiB,EACjB,UAA8B,EAAE,EAChC,UAA8B,EAAE;IAEhC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,KAAK,CAAA;IAC5C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,UAAU,CAAA;IAC/C,MAAM,aAAa,GAAG,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,eAAe,CAAC,CAAA;IAC/F,MAAM,SAAS,GAAG,YAAY,EAAE,CAAA;IAEhC,MAAM,QAAQ,GAAG,MAAM,SAAS,CAC9B,GAAG,QAAQ,IAAI,kBAAkB,CAAC,SAAS,CAAC,IAAI,kBAAkB,CAAC,SAAS,CAAC,EAAE,EAC/E;QACE,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,WAAW,EAAE,aAAa;QAC1B,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;YAClC,kBAAkB,EAAE,gBAAgB;YACpC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnD,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;SAC3B;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC;KACpC,CACF,CAAA;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAC5B,8DAA8D;QAC9D,cAAc,EAAE,CAAA;IAClB,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrD,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAA;IAChC,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAA;IACzD,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IAClC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAA;IACzD,CAAC;IAED,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;IAEpD,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAA;QACpD,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAC3B,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./csrf";
+export * from "./fetch";
+export * from "./types";

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from "./csrf";
+export * from "./fetch";
+export * from "./types";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,19 @@
+export type IslandProps = Record<string, unknown>;
+export type IslandOkResponse = {
+    status: "ok";
+    props: IslandProps;
+    version?: number;
+};
+export type IslandRedirectResponse = {
+    status: "redirect";
+    location: string;
+};
+export type IslandErrorResponse = {
+    status: "error";
+    errors: Record<string, string[]>;
+};
+export type IslandForbiddenResponse = {
+    status: "forbidden";
+};
+export type IslandResponse = IslandOkResponse | IslandRedirectResponse | IslandErrorResponse | IslandForbiddenResponse;
+export declare function parseIslandResponse(value: unknown): IslandResponse;

package/dist/types.js

@@ -0,0 +1,48 @@
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isErrorMap(value) {
+    if (!isRecord(value)) {
+        return false;
+    }
+    return Object.values(value).every((messages) => {
+        return Array.isArray(messages) && messages.every((message) => typeof message === "string");
+    });
+}
+export function parseIslandResponse(value) {
+    if (!isRecord(value) || typeof value.status !== "string") {
+        throw new Error("Invalid island response payload");
+    }
+    switch (value.status) {
+        case "ok": {
+            if (!isRecord(value.props)) {
+                throw new Error("Invalid ok payload");
+            }
+            if (value.version != null && typeof value.version !== "number") {
+                throw new Error("Invalid ok version");
+            }
+            return {
+                status: "ok",
+                props: value.props,
+                version: typeof value.version === "number" ? value.version : undefined
+            };
+        }
+        case "redirect": {
+            if (typeof value.location !== "string") {
+                throw new Error("Invalid redirect payload");
+            }
+            return { status: "redirect", location: value.location };
+        }
+        case "error": {
+            if (!isErrorMap(value.errors)) {
+                throw new Error("Invalid error payload");
+            }
+            return { status: "error", errors: value.errors };
+        }
+        case "forbidden":
+            return { status: "forbidden" };
+        default:
+            throw new Error("Unknown island response status");
+    }
+}
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AA4BA,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC7E,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAChC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7C,OAAO,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAA;IAC5F,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAc;IAChD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QACzD,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;IACpD,CAAC;IAED,QAAQ,KAAK,CAAC,MAAM,EAAE,CAAC;QACrB,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;YACvC,CAAC;YAED,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC/D,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;YACvC,CAAC;YAED,OAAO;gBACL,MAAM,EAAE,IAAI;gBACZ,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,OAAO,EAAE,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;aACvE,CAAA;QACH,CAAC;QACD,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACvC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;YAC7C,CAAC;YAED,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAA;QACzD,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;YAC1C,CAAC;YAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAA;QAClD,CAAC;QACD,KAAK,WAAW;YACd,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAA;QAChC;YACE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;IACrD,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@archipelago-js/client",
+  "version": "0.1.0",
+  "description": "Core client utilities for Archipelago islands",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "yarn clean && tsc -p tsconfig.build.json",
+    "test": "vitest run packages/client/test",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/robrace/archipelago.git",
+    "directory": "packages/client"
+  },
+  "bugs": {
+    "url": "https://github.com/robrace/archipelago/issues"
+  },
+  "homepage": "https://github.com/robrace/archipelago/tree/main/packages/client"
+}