dredless 0.2.0

package/src/browser.d.ts

@@ -0,0 +1,212 @@
+export {
+    Connection,
+    DredlessClient,
+    WrenchMode,
+    TurretMode,
+    WorldStore,
+    WorldState,
+    ModelState,
+    FabricatorType,
+    decodeModelData,
+    generateGeneratorMaze,
+    solveGeneratorMazeSeed,
+    maybeSolveGeneratorMazeSeed,
+    buildBlueprintPlacementMessage,
+    decodeMsgpack,
+    encodeMsgpack,
+    buildCommsMessage,
+    flattenRichText,
+    normalizeCommsEvent,
+    buildSignedCommandPacket,
+    buildEquipItemCommand,
+    buildInventoryDragCommand,
+    buildUnequipItemCommand,
+    equipmentSlotName,
+    normalizeEquipmentSlot,
+    normalizeInventoryEvent,
+    EquipmentSlot,
+    buildBanPlayerMessage,
+    buildDemoteSelfMessage,
+    buildInviteResetMessage,
+    buildKickPlayerMessage,
+    buildPlayerListMessage,
+    buildShipManagementMessage,
+    buildSetPlayerRankMessage,
+    buildShipPrivacyMessage,
+    buildStarterRecoveryMessage,
+    normalizeCaptainSubrank,
+    normalizeShipPlayerList,
+    normalizePlayerRank,
+    normalizePrivacy,
+    normalizeShipConfig,
+    SignDisplayMode,
+    buildSignTextMessage,
+    normalizeSignDisplayMode,
+    signDisplayModeName,
+    buildCargoEjectorClipboardDirectionData,
+    buildCargoEjectorCopyConfigData,
+    buildCargoEjectorDirectionData,
+    buildCargoEjectorPasteConfigData,
+    buildCargoHatchCopyConfigData,
+    buildCargoHatchFilterConfigData,
+    buildCargoHatchFilterItemsData,
+    buildCargoHatchFullConfigData,
+    buildClipboardConfigData,
+    buildClipboardFixedAngleData,
+    buildExpandoClipboardAngleData,
+    buildGeneratorClipboardDirectionData,
+    buildGeneratorMazePuzzleData,
+    buildLoaderClipboardConfigData,
+    buildLoaderConfigData,
+    buildLoaderCopyConfigData,
+    buildLoaderFilterConfigData,
+    buildLoaderFilterItemsData,
+    buildLoaderFullConfigData,
+    buildNavigationUnitClipboardConfigData,
+    buildNavigationUnitConfigData,
+    buildNavigationUnitPasteConfigData,
+    buildPusherConfigData,
+    buildPusherFilterItemsData,
+    PusherMode,
+    LoaderPosition,
+    LoaderFilterMode,
+    FixedAngleDirection,
+    LoaderPriority,
+    decryptPayload,
+    decompressLz4Frame,
+    fetchNoticeVersion,
+    fetchGameVersion,
+    fetchServers
+} from "./index.js";
+
+export type {
+    Server,
+    Ship,
+    ShipList,
+    ShipRef,
+    ShipSpec,
+    ServerRef,
+    SessionSnapshot,
+    Account,
+    ConnectionSnapshot,
+    BlueprintPlacement,
+    BlueprintPlacementMessage,
+    Command,
+    DredlessClientSnapshot,
+    WorldSnapshot,
+    EntitySummary,
+    EntityDebugSummary,
+    InventorySnapshot,
+    ReadWorldScope
+} from "./index.js";
+
+import type {Connection, DredlessClient, Server, ServerRef, SessionSnapshot, Ship, ShipList, ShipRef} from "./index.js";
+
+
+export class BrowserSession {
+    constructor(baseUrl?: string);
+
+    baseUrl: string;
+    gameVersion: string | null;
+    ambientAuth: true;
+    account: unknown | null;
+    geoServer: number | null;
+    upgraded: boolean;
+    isRegistered: boolean;
+    showAds: boolean;
+    forceTutorial: boolean;
+    ban: unknown;
+
+    get gameSession(): string;
+
+    get gameToken(): string;
+
+    get anonKey(): string;
+
+    get noticeVersion(): number | string | null;
+    set noticeVersion(value: number | string | null);
+
+    request(path: string, init?: RequestInit & { body?: BodyInit | Record<string, unknown> | null }): Promise<Response>;
+
+    readAnonKey(): Promise<string>;
+
+    fetchAnonKey(noticeVersion?: number | null): Promise<string>;
+
+    fetchAccountStatus(): Promise<unknown>;
+
+    fetchShips(server: ServerRef): Promise<Ship[]>;
+
+    fetchShipList(server: ServerRef): Promise<ShipList>;
+
+    joinShipConnection(server: ServerRef, ship?: ShipRef): Promise<Connection>;
+
+    startShipConnection(server: ServerRef, ship?: ShipRef): Promise<Connection>;
+
+    startNewShipConnection(server: ServerRef, name?: string, color?: string): Promise<Connection>;
+
+    joinInviteConnection(server: ServerRef, code: string): Promise<Connection>;
+
+    joinShip(server: ServerRef, ship?: ShipRef): Promise<DredlessClient>;
+
+    startShip(server: ServerRef, ship?: ShipRef): Promise<DredlessClient>;
+
+    startNewShip(server: ServerRef, name?: string, color?: string): Promise<DredlessClient>;
+
+    joinInvite(server: ServerRef, code: string): Promise<DredlessClient>;
+
+    toJSON(): SessionSnapshot & { ambientAuth: true };
+}
+
+export function browserSession(baseUrl?: string): BrowserSession;
+
+export function createBrowserSession(baseUrl?: string): BrowserSession;
+
+export function createSession(noticeVersion?: number | null, baseUrl?: string): Promise<BrowserSession>;
+
+export function createAnonSession(anonKey?: string | null, noticeVersion?: number | null, baseUrl?: string): Promise<BrowserSession>;
+
+export function createAnonToken(noticeVersion?: number | null, baseUrl?: string): Promise<string>;
+
+export function fetchAnonKey(noticeVersion?: number | null, baseUrl?: string): Promise<string>;
+
+export function setBrowserSession(session?: BrowserSession | null): BrowserSession | null;
+
+export function fetchAccountStatus(session?: BrowserSession | null): Promise<unknown>;
+
+export function fetchShips(server: ServerRef, session?: BrowserSession | null): Promise<Ship[]>;
+
+export function fetchShipList(server: ServerRef, session?: BrowserSession | null): Promise<ShipList>;
+
+export function joinShip(server: ServerRef, ship?: ShipRef, session?: BrowserSession | null): Promise<DredlessClient>;
+
+export function startShip(server: ServerRef, ship?: ShipRef, session?: BrowserSession | null): Promise<DredlessClient>;
+
+export function startNewShip(server: ServerRef, name?: string, color?: string, session?: BrowserSession | null): Promise<DredlessClient>;
+
+export function joinInvite(server: ServerRef, code: string, session?: BrowserSession | null): Promise<DredlessClient>;
+
+export interface DredlessBrowserNamespace {
+    BrowserSession: typeof BrowserSession;
+    Connection: typeof import("./index.js").Connection;
+    DredlessClient: typeof import("./index.js").DredlessClient;
+    browserSession: typeof browserSession;
+    createBrowserSession: typeof createBrowserSession;
+    createSession: typeof createSession;
+    createAnonSession: typeof createAnonSession;
+    createAnonToken: typeof createAnonToken;
+    fetchAnonKey: typeof fetchAnonKey;
+    setBrowserSession: typeof setBrowserSession;
+    fetchAccountStatus: typeof fetchAccountStatus;
+    fetchNoticeVersion: typeof import("./index.js").fetchNoticeVersion;
+    fetchGameVersion: typeof import("./index.js").fetchGameVersion;
+    fetchServers: typeof import("./index.js").fetchServers;
+    fetchShips: typeof fetchShips;
+    fetchShipList: typeof fetchShipList;
+    joinShip: typeof joinShip;
+    startShip: typeof startShip;
+    startNewShip: typeof startNewShip;
+    joinInvite: typeof joinInvite;
+}
+
+export const DredlessBrowser: DredlessBrowserNamespace;
+export default DredlessBrowser;

package/src/browser.js

@@ -0,0 +1,133 @@
+export {Connection} from "./network/connection.js";
+export {DredlessClient, WrenchMode, TurretMode} from "./client/index.js";
+export {WorldStore, WorldState} from "./state/world/index.js";
+export {FabricatorType, ModelState, decodeModelData} from "./state/model/index.js";
+export {generateGeneratorMaze, solveGeneratorMazeSeed, maybeSolveGeneratorMazeSeed} from "./state/generator-maze.js";
+export {buildBlueprintPlacementMessage} from "./protocol/outbound/blueprint.js";
+export {decodeMsgpack, encodeMsgpack} from "./protocol/codec/msgpack.js";
+export {buildCommsMessage, flattenRichText, normalizeCommsEvent} from "./protocol/outbound/comms.js";
+export {buildSignedCommandPacket} from "./protocol/outbound/commands.js";
+export {
+    buildEquipItemCommand,
+    buildInventoryDragCommand,
+    buildUnequipItemCommand,
+    equipmentSlotName,
+    normalizeEquipmentSlot,
+    normalizeInventoryEvent,
+    EquipmentSlot
+} from "./protocol/outbound/inventory.js";
+export {
+    buildBanPlayerMessage,
+    buildDemoteSelfMessage,
+    buildInviteResetMessage,
+    buildKickPlayerMessage,
+    buildPlayerListMessage,
+    buildShipManagementMessage,
+    buildSetPlayerRankMessage,
+    buildShipPrivacyMessage,
+    buildStarterRecoveryMessage,
+    normalizeCaptainSubrank,
+    normalizeShipPlayerList,
+    normalizePlayerRank,
+    normalizePrivacy,
+    normalizeShipConfig
+} from "./protocol/outbound/ship-management.js";
+export {SignDisplayMode, buildSignTextMessage, normalizeSignDisplayMode, signDisplayModeName} from "./protocol/outbound/sign.js";
+export {
+    buildCargoEjectorClipboardDirectionData,
+    buildCargoEjectorCopyConfigData,
+    buildCargoEjectorDirectionData,
+    buildCargoEjectorPasteConfigData,
+    buildCargoHatchCopyConfigData,
+    buildCargoHatchFilterConfigData,
+    buildCargoHatchFilterItemsData,
+    buildCargoHatchFullConfigData,
+    buildClipboardConfigData,
+    buildClipboardFixedAngleData,
+    buildExpandoClipboardAngleData,
+    buildGeneratorClipboardDirectionData,
+    buildGeneratorMazePuzzleData,
+    buildLoaderClipboardConfigData,
+    buildLoaderConfigData,
+    buildLoaderCopyConfigData,
+    buildLoaderFilterConfigData,
+    buildLoaderFilterItemsData,
+    buildLoaderFullConfigData,
+    buildNavigationUnitClipboardConfigData,
+    buildNavigationUnitConfigData,
+    buildNavigationUnitPasteConfigData,
+    buildPusherConfigData,
+    buildPusherFilterItemsData,
+    PusherMode,
+    LoaderPosition,
+    LoaderFilterMode,
+    FixedAngleDirection,
+    LoaderPriority
+} from "./protocol/outbound/ui-config.js";
+export {decryptPayload} from "./crypto/chacha.js";
+export {decompressLz4Frame} from "./compression/lz4.js";
+export {fetchNoticeVersion, fetchGameVersion, fetchServers} from "./network/servers.js";
+export {fetchShips as fetchShipsWithSession, fetchShipList as fetchShipListWithSession} from "./network/ships.js";
+export {
+    BrowserSession,
+    browserSession,
+    createBrowserSession,
+    createSession,
+    createAnonSession,
+    createAnonToken,
+    fetchAnonKey,
+    setBrowserSession,
+    fetchAccountStatus,
+    fetchShips,
+    fetchShipListForBrowser as fetchShipList,
+    joinShip,
+    startShip,
+    startNewShip,
+    joinInvite
+} from "./network/browser-session.js";
+
+import {Connection} from "./network/connection.js";
+import {DredlessClient} from "./client/index.js";
+import {fetchGameVersion, fetchNoticeVersion, fetchServers} from "./network/servers.js";
+import {
+    BrowserSession,
+    browserSession,
+    createAnonSession,
+    createAnonToken,
+    createBrowserSession,
+    createSession,
+    fetchAccountStatus,
+    fetchAnonKey,
+    fetchShipListForBrowser,
+    fetchShips,
+    joinInvite,
+    joinShip,
+    setBrowserSession,
+    startNewShip,
+    startShip
+} from "./network/browser-session.js";
+
+export const DredlessBrowser = {
+    BrowserSession,
+    Connection,
+    DredlessClient,
+    browserSession,
+    createBrowserSession,
+    createSession,
+    createAnonSession,
+    createAnonToken,
+    fetchAnonKey,
+    setBrowserSession,
+    fetchAccountStatus,
+    fetchNoticeVersion,
+    fetchGameVersion,
+    fetchServers,
+    fetchShips,
+    fetchShipList: fetchShipListForBrowser,
+    joinShip,
+    startShip,
+    startNewShip,
+    joinInvite
+};
+
+export default DredlessBrowser;