dredless 0.5.2 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "dredless",
-    "version": "0.5.2",
+    "version": "0.6.0",
     "description": "A fully-featured and from-scratch headless drednot.io client implementation written in pure js.",
     "license": "MIT",
     "homepage": "https://github.com/certainhuman/dredless#readme",

package/src/index.d.ts

@@ -23,6 +23,18 @@ export interface ShipList {
     ships: Ship[];
 }
 
+export interface InviteMetadata {
+    shipId: string | null;
+    name: string | null;
+    color: string | null;
+    previewImageUrl: string | null;
+    hostname: string;
+    inviteCode: string;
+}
+export interface InviteFetchOptions { fetchImpl?: typeof fetch; }
+export function fetchInviteMetadata(invite: string | URL, options?: InviteFetchOptions): Promise<InviteMetadata>;
+export function parseInviteMetadata(html: string): InviteMetadata;
+
 export type ShipSpec =
     | { type: "join_or_load"; id: number | string }
     | { type: "new"; name?: string | null; color?: string | null }

package/src/index.js

@@ -77,12 +77,14 @@ export {
 } from "./protocol/outbound/ui-config.js";
 export {decryptPayload} from "./crypto/chacha.js";
 export {decompressLz4Frame} from "./compression/lz4.js";
+export {fetchInviteMetadata, parseInviteMetadata} from "./network/invites.js";
 
 import {AnonSession, createAnonSession, createAnonToken, createSession, Session} from "./network/session.js";
 import {Connection} from "./network/connection.js";
 import {DredlessClient} from "./client/index.js";
 import {fetchGameVersion, fetchNoticeVersion, fetchServerStatus, fetchServerStatuses, fetchServers} from "./network/servers.js";
 import {fetchShipList, fetchShips} from "./network/ships.js";
+import {fetchInviteMetadata} from "./network/invites.js";
 
 async function sessionOrAnon(session) {
     return session || createAnonSession();
@@ -119,6 +121,7 @@ export const Dredless = {
     fetchServers,
     fetchShips,
     fetchShipList,
+    fetchInviteMetadata,
     joinShip,
     startShip,
     startNewShip,

package/src/network/index.d.ts

@@ -2,3 +2,4 @@ export * from "./connection.js";
 export * from "./servers.js";
 export * from "./ships.js";
 export * from "./session.js";
+export * from "./invites.js";

package/src/network/index.js

@@ -2,3 +2,4 @@ export {Connection} from "./connection.js";
 export {fetchGameVersion, fetchNoticeVersion, fetchServerStatus, fetchServerStatuses, fetchServers, resolveServer} from "./servers.js";
 export {fetchShips, fetchShipList, createShipSpec, createInviteShipSpec, shipRef} from "./ships.js";
 export {Session, AnonSession, createSession, createAnonSession, createAnonToken} from "./session.js";
+export {fetchInviteMetadata, parseInviteMetadata} from "./invites.js";

package/src/network/invites.d.ts

@@ -0,0 +1,11 @@
+export interface InviteMetadata {
+    shipId: string | null;
+    name: string | null;
+    color: string | null;
+    previewImageUrl: string | null;
+    hostname: string;
+    inviteCode: string;
+}
+export interface InviteFetchOptions { fetchImpl?: typeof fetch; }
+export function fetchInviteMetadata(invite: string | URL, options?: InviteFetchOptions): Promise<InviteMetadata>;
+export function parseInviteMetadata(html: string): InviteMetadata;

package/src/network/invites.js

@@ -0,0 +1,60 @@
+import {getFetch} from "../runtime.js";
+
+export async function fetchInviteMetadata(invite, {fetchImpl = null} = {}) {
+    const url = normalizeInviteUrl(invite);
+    const response = await (fetchImpl || getFetch())(url.href, {headers: {accept: "text/html"}});
+    if (!response.ok) throw new Error(`Invite metadata request failed: ${response.status} ${response.statusText}`);
+    return parseInviteMetadata(await response.text());
+}
+
+export function parseInviteMetadata(html) {
+    const embeddedUrl = metaContent(html, "og:url");
+    const url = normalizeInviteUrl(embeddedUrl);
+    const parsedTitle = parseInviteTitle(metaContent(html, "title") || "");
+    const preview = metaContent(html, "og:image") || metaContent(html, "twitter:image");
+    return Object.freeze({
+        shipId: parsedTitle.shipId,
+        name: parsedTitle.name,
+        color: metaContent(html, "theme-color") || metaContent(html, "color") || null,
+        previewImageUrl: preview ? new URL(preview, url).href : null,
+        hostname: url.hostname,
+        inviteCode: url.pathname.split("/").filter(Boolean).at(-1)
+    });
+}
+
+function normalizeInviteUrl(invite) {
+    const url = new URL(String(invite));
+    if (!/^\/invite\/[^/]+\/?$/i.test(url.pathname)) throw new TypeError("Expected a Drednot invite URL");
+    return url;
+}
+
+function parseInviteTitle(title) {
+    const match = title.match(/^Invite:\s*(.*?)\s*\{([^{}]+)}(?:\s*-\s*drednot\.io)?\s*$/i);
+    return match ? {name: decodeHtml(match[1]), shipId: decodeHtml(match[2])} : {name: null, shipId: null};
+}
+
+function metaContent(html, key) {
+    if (key === "title") {
+        const match = html.match(/<title\b[^>]*>([\s\S]*?)<\/title\s*>/i);
+        return match ? decodeHtml(match[1].trim()) : null;
+    }
+    for (const tag of html.matchAll(/<meta\b[^>]*>/gi)) {
+        const property = attribute(tag[0], "property") || attribute(tag[0], "name");
+        if (property?.toLowerCase() === key.toLowerCase()) return attribute(tag[0], "content");
+    }
+    return null;
+}
+
+function attribute(tag, name) {
+    const match = tag.match(new RegExp(`\\b${name}\\s*=\\s*(["'])([\\s\\S]*?)\\1`, "i"));
+    return match ? decodeHtml(match[2]) : null;
+}
+
+function decodeHtml(value) {
+    return value.replace(/&(#x?[0-9a-f]+|amp|lt|gt|quot|apos|#39);/gi, (_, entity) => {
+        const named = {amp: "&", lt: "<", gt: ">", quot: '"', apos: "'"};
+        if (named[entity.toLowerCase()]) return named[entity.toLowerCase()];
+        const number = entity[1].toLowerCase() === "x" ? parseInt(entity.slice(2), 16) : parseInt(entity.slice(1), 10);
+        return Number.isFinite(number) ? String.fromCodePoint(number) : _;
+    });
+}