spplice-api 0.1.0 → 0.2.0

package/dist/docs/example.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=example.d.ts.map

package/dist/docs/example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../../docs/example.ts"],"names":[],"mappings":""}

package/{docs/example.ts → dist/docs/example.js}

@@ -1,29 +1,25 @@
 import * as Spplice from "..";
 import path from "node:path";
-
 // Start Steam interface - Steam must be running, user must be logged in
 const steamClient = new Spplice.SteamClient();
 // Get Portal 2 game directory
 const gameDir = steamClient.getGameDir();
-
 // Load default package repository/repositories
 const repositories = await Promise.all([
-  Spplice.Repository.fromURL("https://p2r3.github.io/spplice-repo/index.json")
+    Spplice.Repository.fromURL("https://p2r3.github.io/spplice-repo/index.json")
 ]);
 // Aggregate all packages into a single list
 const packages = repositories.map(r => Array.from(r.packages)).flat(1);
-
 // Pick a package to install - for this example, the first one on the list
-const packageToInstall = packages[0]!;
+const packageToInstall = packages[0];
 // Extract the package files to portal2_tempcontent
 packageToInstall.extract(path.join(gameDir, "portal2_tempcontent"));
 // Tell Steam to start the game
 Spplice.SteamClient.launchSteam([
-  "-applaunch", steamClient.appID.toString(),
-  "-tempcontent", // Enable reading from portal2_tempcontent
-  "-netconport 22333" // Enable console TCP socket
+    "-applaunch", steamClient.appID.toString(),
+    "-tempcontent", // Enable reading from portal2_tempcontent
+    "-netconport 22333" // Enable console TCP socket
 ]);
-
 // Connect to the game's developer console
 const gameConsole = new Spplice.Console(22333);
 await gameConsole.connect();
@@ -31,8 +27,9 @@ await gameConsole.connect();
 gameConsole.send("echo Hello from Spplice API!");
 // Monitor and print console output
 setInterval(() => {
-  let line;
-  while (line = gameConsole.readLine()) {
-    console.log("[P2]", line);
-  }
+    let line;
+    while (line = gameConsole.readLine()) {
+        console.log("[P2]", line);
+    }
 }, 200);
+//# sourceMappingURL=example.js.map

package/dist/docs/example.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.js","sourceRoot":"","sources":["../../docs/example.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,IAAI,CAAC;AAC9B,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,wEAAwE;AACxE,MAAM,WAAW,GAAG,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;AAC9C,8BAA8B;AAC9B,MAAM,OAAO,GAAG,WAAW,CAAC,UAAU,EAAE,CAAC;AAEzC,+CAA+C;AAC/C,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;IACrC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,gDAAgD,CAAC;CAC7E,CAAC,CAAC;AACH,4CAA4C;AAC5C,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAEvE,0EAA0E;AAC1E,MAAM,gBAAgB,GAAG,QAAQ,CAAC,CAAC,CAAE,CAAC;AACtC,mDAAmD;AACnD,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC;AACpE,+BAA+B;AAC/B,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC;IAC9B,YAAY,EAAE,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE;IAC1C,cAAc,EAAE,0CAA0C;IAC1D,mBAAmB,CAAC,4BAA4B;CACjD,CAAC,CAAC;AAEH,0CAA0C;AAC1C,MAAM,WAAW,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC/C,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;AAC5B,iCAAiC;AACjC,WAAW,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;AACjD,mCAAmC;AACnC,WAAW,CAAC,GAAG,EAAE;IACf,IAAI,IAAI,CAAC;IACT,OAAO,IAAI,GAAG,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;AACH,CAAC,EAAE,GAAG,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { SteamClient } from "./src/SteamTools.js";
+export { SpplicePackage as Package, SppliceRepository as Repository } from "./src/PackageTools.js";
+export { Console } from "./src/ConsoleTools.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,cAAc,IAAI,OAAO,EACzB,iBAAiB,IAAI,UAAU,EAChC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,OAAO,EACR,MAAM,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { SteamClient } from "./src/SteamTools.js";
+export { SpplicePackage as Package, SppliceRepository as Repository } from "./src/PackageTools.js";
+export { Console } from "./src/ConsoleTools.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,cAAc,IAAI,OAAO,EACzB,iBAAiB,IAAI,UAAU,EAChC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,OAAO,EACR,MAAM,uBAAuB,CAAC"}

package/dist/src/ConsoleTools.d.ts

@@ -0,0 +1,40 @@
+import net from "net";
+export declare class Console {
+    socket: net.Socket;
+    port: number;
+    error: Error | null;
+    connected: boolean;
+    private closing;
+    private writeBuffer;
+    private readBuffer;
+    /**
+     * Creates and configures TCP socket for Portal 2 netcon.
+     * @param port Network port number for connection.
+     */
+    constructor(port: number);
+    /**
+     * Connects to the Portal 2 console TCP socket.
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnects from the Portal 2 console socket.
+     */
+    disconnect(): void;
+    /**
+     * Sends a console command to the game.
+     * @param command Command to execute.
+     */
+    send(command: string): void;
+    /**
+     * Reads output from the game console.
+     * @param length Max amount of bytes to read. Default is -1 (read all).
+     */
+    read(length?: number): string;
+    /**
+     * Reads and returns one full line of console output. Does not read
+     * incomplete lines. Removes newline and carriage return characters.
+     * @returns One full line of console output, or `null` if no output.
+     */
+    readLine(): string | null;
+}
+//# sourceMappingURL=ConsoleTools.d.ts.map

package/dist/src/ConsoleTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConsoleTools.d.ts","sourceRoot":"","sources":["../../src/ConsoleTools.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,qBAAa,OAAO;IAGlB,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,KAAK,GAAG,IAAI,CAAQ;IAE3B,SAAS,EAAE,OAAO,CAAS;IAI3B,OAAO,CAAC,OAAO,CAAkB;IAEjC,OAAO,CAAC,WAAW,CAAc;IAEjC,OAAO,CAAC,UAAU,CAAc;IAEhC;;;OAGG;gBACU,IAAI,EAAE,MAAM;IAsBzB;;OAEG;IACG,OAAO;IAsBb;;OAEG;IACH,UAAU;IAOV;;;OAGG;IACH,IAAI,CAAE,OAAO,EAAE,MAAM;IAMrB;;;OAGG;IACH,IAAI,CAAE,MAAM,GAAE,MAAW,GAAG,MAAM;IAYlC;;;;OAIG;IACH,QAAQ,IAAK,MAAM,GAAG,IAAI;CAM3B"}

package/dist/src/ConsoleTools.js

@@ -0,0 +1,116 @@
+import net from "net";
+export class Console {
+    // TCP socket handle
+    socket;
+    // Network port number
+    port;
+    // Last connection error, or null if none
+    error = null;
+    // Connection state - true if connected, false otherwise
+    connected = false;
+    // Whether we expect the socket to close intentionally.
+    // Determines whether a repeat connection is attempted.
+    closing = false;
+    // Stores unflushed writes, re-sent if the socket reconnects.
+    writeBuffer = "";
+    // Stores output read from the socket, but not yet read by the client.
+    readBuffer = "";
+    /**
+     * Creates and configures TCP socket for Portal 2 netcon.
+     * @param port Network port number for connection.
+     */
+    constructor(port) {
+        this.socket = new net.Socket();
+        this.socket.setNoDelay(true);
+        this.socket.setKeepAlive(false);
+        this.port = port;
+        // Listen for incoming data and log to read buffer
+        this.socket.on("data", data => {
+            this.readBuffer += data;
+        });
+        // Clear pending write buffer when data gets flushed
+        this.socket.on("drain", () => {
+            this.writeBuffer = "";
+        });
+        // Reconnect if the socket ever closes unexpectedly
+        this.socket.on("close", () => {
+            this.connected = false;
+            if (!this.closing) {
+                setTimeout(() => this.connect(), 200);
+            }
+        });
+    }
+    /**
+     * Connects to the Portal 2 console TCP socket.
+     */
+    async connect() {
+        // Attempt connection to the socket
+        this.error = await new Promise(resolve => {
+            let onConnect, onError;
+            this.socket.once("error", onError = (err) => {
+                this.socket.off("connect", onConnect);
+                resolve(err);
+            });
+            this.socket.once("connect", onConnect = () => {
+                this.socket.off("error", onError);
+                resolve(null);
+            });
+            this.socket.connect(this.port, "127.0.0.1");
+        });
+        if (!this.error)
+            this.connected = true;
+        // Re-send anything that remains in the write buffer from the last session
+        if (this.writeBuffer) {
+            const success = this.socket.write(this.writeBuffer);
+            if (success)
+                this.writeBuffer = "";
+        }
+    }
+    /**
+     * Disconnects from the Portal 2 console socket.
+     */
+    disconnect() {
+        this.closing = true;
+        this.writeBuffer = "";
+        this.readBuffer = "";
+        this.socket.end();
+    }
+    /**
+     * Sends a console command to the game.
+     * @param command Command to execute.
+     */
+    send(command) {
+        const data = command + "\n";
+        const success = this.socket.write(data);
+        if (!success)
+            this.writeBuffer += data;
+    }
+    /**
+     * Reads output from the game console.
+     * @param length Max amount of bytes to read. Default is -1 (read all).
+     */
+    read(length = -1) {
+        let output;
+        if (length < 0) {
+            output = this.readBuffer;
+            this.readBuffer = "";
+        }
+        else {
+            output = this.readBuffer.slice(0, length);
+            this.readBuffer = this.readBuffer.slice(length);
+        }
+        return output;
+    }
+    /**
+     * Reads and returns one full line of console output. Does not read
+     * incomplete lines. Removes newline and carriage return characters.
+     * @returns One full line of console output, or `null` if no output.
+     */
+    readLine() {
+        const newlineIndex = this.readBuffer.indexOf("\n");
+        if (newlineIndex === -1)
+            return null;
+        return this.read(newlineIndex + 1).slice(0, -1).replaceAll("\r", "");
+    }
+}
+//# sourceMappingURL=ConsoleTools.js.map

package/dist/src/ConsoleTools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConsoleTools.js","sourceRoot":"","sources":["../../src/ConsoleTools.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,MAAM,OAAO,OAAO;IAElB,oBAAoB;IACpB,MAAM,CAAa;IACnB,sBAAsB;IACtB,IAAI,CAAS;IACb,yCAAyC;IACzC,KAAK,GAAiB,IAAI,CAAC;IAC3B,wDAAwD;IACxD,SAAS,GAAY,KAAK,CAAC;IAE3B,uDAAuD;IACvD,uDAAuD;IAC/C,OAAO,GAAY,KAAK,CAAC;IACjC,6DAA6D;IACrD,WAAW,GAAW,EAAE,CAAC;IACjC,sEAAsE;IAC9D,UAAU,GAAW,EAAE,CAAC;IAEhC;;;OAGG;IACH,YAAa,IAAY;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,kDAAkD;QAClD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;YAC5B,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,oDAAoD;QACpD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC3B,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;QACH,mDAAmD;QACnD,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC3B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;YACxC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,mCAAmC;QACnC,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YACvC,IAAI,SAAc,EAAE,OAAY,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,CAAC,GAAU,EAAE,EAAE;gBACjD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;gBACtC,OAAO,CAAC,GAAG,CAAC,CAAC;YACf,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,GAAG,GAAG,EAAE;gBAC3C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAClC,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACvC,0EAA0E;QAC1E,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACpD,IAAI,OAAO;gBAAE,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACrC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,IAAI,CAAE,OAAe;QACnB,MAAM,IAAI,GAAG,OAAO,GAAG,IAAI,CAAC;QAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO;YAAE,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,IAAI,CAAE,SAAiB,CAAC,CAAC;QACvB,IAAI,MAAc,CAAC;QACnB,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;YACf,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;YACzB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC1C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,YAAY,KAAK,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACrC,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACvE,CAAC;CAEF"}

package/dist/src/PackageTools.d.ts

@@ -0,0 +1,52 @@
+import { Readable } from "node:stream";
+declare class SpplicePackage {
+    title: string;
+    author: string;
+    description: string;
+    version: string;
+    args: string[];
+    file: string;
+    icon: string;
+    /**
+     * @param foreignPackage Untrusted "foreign" object (e.g. from an online repo),
+     * assumed to be shaped roughly like a Spplice package.
+     */
+    constructor(foreignPackage: any);
+    /**
+     * Extracts a readable stream of a tar.xz archive to the given folder.
+     * @param inputStream Readable stream of input tar.xz file.
+     * @param destinationPath Path to directory in which to extract the archive.
+     */
+    static extractFromStream(inputStream: Readable, destinationPath: string): Promise<unknown>;
+    /**
+     * Extracts a tar.xz archive file to the given folder.
+     * @param filePath Input tar.xz archive path.
+     * @param destinationPath Path to directory in which to extract the archive.
+     */
+    static extractFromFile(filePath: string, destinationPath: string): Promise<unknown>;
+    /**
+     * Downloads a tar.xz archive from a URL and extracts it to the given folder.
+     * @param fileURL Input tar.xz archive URL.
+     * @param destinationPath Path to directory in which to extract the archive.
+     */
+    static extractFromURL(fileURL: string, destinationPath: string): Promise<unknown>;
+    /**
+     * Downloads and extracts the package's file archive to the given folder.
+     * @param destinationPath Path to directory in which to extract the archive.
+     */
+    extract(destinationPath: string): Promise<unknown>;
+}
+declare class SppliceRepository {
+    packages: Set<SpplicePackage>;
+    addPackage(newPackage: SpplicePackage): void;
+    removePackage(removedPackage: SpplicePackage): void;
+    /**
+     * Fetches a Spplice repository from its URL.
+     * @param repositoryURL Link to Spplice repository index (JSON).
+     * @param strict Whether to throw an error when package parsing fails.
+     * @returns A new Spplice repository.
+     */
+    static fromURL(repositoryURL: string, strict?: boolean): Promise<SppliceRepository>;
+}
+export { SpplicePackage, SppliceRepository };
+//# sourceMappingURL=PackageTools.d.ts.map

package/dist/src/PackageTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageTools.d.ts","sourceRoot":"","sources":["../../src/PackageTools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAMvC,cAAM,cAAc;IAElB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAM;IACzB,OAAO,EAAE,MAAM,CAAW;IAC1B,IAAI,EAAE,MAAM,EAAE,CAAM;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;gBACU,cAAc,EAAE,GAAG;IA6BhC;;;;OAIG;WACU,iBAAiB,CAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM;IAgC9E;;;;OAIG;WACU,eAAe,CAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM;IAKvE;;;;OAIG;WACU,cAAc,CAAE,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM;IAQrE;;;OAGG;IACG,OAAO,CAAE,eAAe,EAAE,MAAM;CAIvC;AAED,cAAM,iBAAiB;IAErB,QAAQ,EAAE,GAAG,CAAC,cAAc,CAAC,CAAa;IAE1C,UAAU,CAAE,UAAU,EAAE,cAAc;IAGtC,aAAa,CAAE,cAAc,EAAE,cAAc;IAI7C;;;;;OAKG;WACU,OAAO,CAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;CA4BlG;AAED,OAAO,EACL,cAAc,EACd,iBAAiB,EAClB,CAAC"}

package/dist/src/PackageTools.js

@@ -0,0 +1,160 @@
+import { Readable } from "node:stream";
+import path from "node:path";
+import fs from "node:fs";
+import * as tar from "tar-stream";
+import * as lzma from "lzma-native";
+class SpplicePackage {
+    title;
+    author;
+    description = "";
+    version = "1.0.0";
+    args = [];
+    file;
+    icon;
+    /**
+     * @param foreignPackage Untrusted "foreign" object (e.g. from an online repo),
+     * assumed to be shaped roughly like a Spplice package.
+     */
+    constructor(foreignPackage) {
+        // Title is required
+        this.title = foreignPackage.title.toString().trim();
+        if (!this.title)
+            throw "Invalid package title";
+        // Author is required
+        this.author = foreignPackage.author.toString().trim();
+        if (!this.author)
+            throw "Invalid package author";
+        // Description is optional
+        if (typeof foreignPackage.description === "string") {
+            this.description = foreignPackage.description.trim();
+        }
+        // File URL is required
+        if (typeof foreignPackage.file !== "string")
+            throw "Invalid package file URL";
+        this.file = foreignPackage.file;
+        // Icon URL is required
+        if (typeof foreignPackage.icon !== "string")
+            throw "Invalid package icon URL";
+        this.icon = foreignPackage.icon;
+        // Version is optional
+        if (typeof foreignPackage.version === "string") {
+            this.version = foreignPackage.version;
+        }
+        // Command line arguments are optional
+        if (Array.isArray(foreignPackage.args)) {
+            this.args = foreignPackage.args;
+        }
+        else if (typeof foreignPackage.args === "string") {
+            this.args = [foreignPackage.args];
+        }
+    }
+    /**
+     * Extracts a readable stream of a tar.xz archive to the given folder.
+     * @param inputStream Readable stream of input tar.xz file.
+     * @param destinationPath Path to directory in which to extract the archive.
+     */
+    static async extractFromStream(inputStream, destinationPath) {
+        return await new Promise((resolve, reject) => {
+            try {
+                const lzmaDecompressor = lzma.createDecompressor();
+                const tarExtractor = tar.extract();
+                tarExtractor.on("entry", (header, stream, next) => {
+                    // Get just entry name and type from header.
+                    // It's probably best not to replicate permissions/users/groups.
+                    const { name, type } = header;
+                    const fullPath = path.join(destinationPath, name);
+                    // Set up handler to continue when this entry has been parsed
+                    stream.on("end", () => next());
+                    // For files, pipe them to a write stream.
+                    // For directories, quietly create them recursively.
+                    if (type === "file") {
+                        stream.pipe(fs.createWriteStream(fullPath));
+                    }
+                    else if (type === "directory") {
+                        fs.mkdirSync(fullPath, { recursive: true });
+                    }
+                    // Drain the rest of the stream if anything remains
+                    stream.resume();
+                });
+                // Resolve promise once archive has been extracted
+                tarExtractor.on("finish", resolve);
+                // Pipe the input file - first decompress, then extract
+                inputStream.pipe(lzmaDecompressor).pipe(tarExtractor);
+            }
+            catch (err) {
+                reject(err);
+            }
+        });
+    }
+    /**
+     * Extracts a tar.xz archive file to the given folder.
+     * @param filePath Input tar.xz archive path.
+     * @param destinationPath Path to directory in which to extract the archive.
+     */
+    static async extractFromFile(filePath, destinationPath) {
+        const inputStream = fs.createReadStream(filePath);
+        return await SpplicePackage.extractFromStream(inputStream, destinationPath);
+    }
+    /**
+     * Downloads a tar.xz archive from a URL and extracts it to the given folder.
+     * @param fileURL Input tar.xz archive URL.
+     * @param destinationPath Path to directory in which to extract the archive.
+     */
+    static async extractFromURL(fileURL, destinationPath) {
+        const response = await fetch(fileURL);
+        if (response.status !== 200)
+            throw `Server returned response ${response.status}`;
+        if (!response.body)
+            throw `Server did not return any content.`;
+        const inputStream = Readable.fromWeb(response.body);
+        return await SpplicePackage.extractFromStream(inputStream, destinationPath);
+    }
+    /**
+     * Downloads and extracts the package's file archive to the given folder.
+     * @param destinationPath Path to directory in which to extract the archive.
+     */
+    async extract(destinationPath) {
+        return await SpplicePackage.extractFromURL(this.file, destinationPath);
+    }
+}
+class SppliceRepository {
+    packages = new Set();
+    addPackage(newPackage) {
+        this.packages.add(newPackage);
+    }
+    removePackage(removedPackage) {
+        this.packages.delete(removedPackage);
+    }
+    /**
+     * Fetches a Spplice repository from its URL.
+     * @param repositoryURL Link to Spplice repository index (JSON).
+     * @param strict Whether to throw an error when package parsing fails.
+     * @returns A new Spplice repository.
+     */
+    static async fromURL(repositoryURL, strict = false) {
+        // Get JSON data from input URL
+        const response = await fetch(repositoryURL.trim());
+        if (response.status !== 200)
+            throw `Server returned response ${response.status}`;
+        const repositoryData = (await response.json());
+        // Validate repository structure
+        if (!Array.isArray(repositoryData.packages)) {
+            throw "Malformed repository index.";
+        }
+        const repository = new SppliceRepository();
+        // Try to convert each entry to a Spplice package, skip any that fail
+        for (const entry of repositoryData.packages) {
+            try {
+                const newPackage = new SpplicePackage(entry);
+                repository.addPackage(newPackage);
+            }
+            catch (err) {
+                if (strict)
+                    throw err;
+            }
+        }
+        return repository;
+    }
+}
+export { SpplicePackage, SppliceRepository };
+//# sourceMappingURL=PackageTools.js.map

package/dist/src/PackageTools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageTools.js","sourceRoot":"","sources":["../../src/PackageTools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,KAAK,GAAG,MAAM,YAAY,CAAC;AAClC,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC;AAEpC,MAAM,cAAc;IAElB,KAAK,CAAS;IACd,MAAM,CAAS;IACf,WAAW,GAAW,EAAE,CAAC;IACzB,OAAO,GAAW,OAAO,CAAC;IAC1B,IAAI,GAAa,EAAE,CAAC;IACpB,IAAI,CAAS;IACb,IAAI,CAAS;IAEb;;;OAGG;IACH,YAAa,cAAmB;QAC9B,oBAAoB;QACpB,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;QACpD,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,MAAM,uBAAuB,CAAC;QAC/C,qBAAqB;QACrB,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,wBAAwB,CAAC;QACjD,0BAA0B;QAC1B,IAAI,OAAO,cAAc,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YACnD,IAAI,CAAC,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QACvD,CAAC;QACD,uBAAuB;QACvB,IAAI,OAAO,cAAc,CAAC,IAAI,KAAK,QAAQ;YAAE,MAAM,0BAA0B,CAAC;QAC9E,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC;QAChC,uBAAuB;QACvB,IAAI,OAAO,cAAc,CAAC,IAAI,KAAK,QAAQ;YAAE,MAAM,0BAA0B,CAAC;QAC9E,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC;QAChC,sBAAsB;QACtB,IAAI,OAAO,cAAc,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC/C,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;QACxC,CAAC;QACD,sCAAsC;QACtC,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC;QAClC,CAAC;aAAM,IAAI,OAAO,cAAc,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACnD,IAAI,CAAC,IAAI,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAE,WAAqB,EAAE,eAAuB;QAC5E,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC3C,IAAI,CAAC;gBACH,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBACnD,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;gBACnC,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;oBAChD,4CAA4C;oBAC5C,gEAAgE;oBAChE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;oBAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;oBAClD,6DAA6D;oBAC7D,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;oBAC/B,0CAA0C;oBAC1C,oDAAoD;oBACpD,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;wBACpB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC;oBAC9C,CAAC;yBAAM,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;wBAChC,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC9C,CAAC;oBACD,mDAAmD;oBACnD,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,CAAC,CAAC,CAAC;gBACH,kDAAkD;gBAClD,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACnC,uDAAuD;gBACvD,WAAW,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACxD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,eAAe,CAAE,QAAgB,EAAE,eAAuB;QACrE,MAAM,WAAW,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAClD,OAAO,MAAM,cAAc,CAAC,iBAAiB,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,cAAc,CAAE,OAAe,EAAE,eAAuB;QACnE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,MAAM,4BAA4B,QAAQ,CAAC,MAAM,EAAE,CAAC;QACjF,IAAI,CAAC,QAAQ,CAAC,IAAI;YAAE,MAAM,oCAAoC,CAAC;QAC/D,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACpD,OAAO,MAAM,cAAc,CAAC,iBAAiB,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAE,eAAuB;QACpC,OAAO,MAAM,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IACzE,CAAC;CAEF;AAED,MAAM,iBAAiB;IAErB,QAAQ,GAAwB,IAAI,GAAG,EAAE,CAAC;IAE1C,UAAU,CAAE,UAA0B;QACpC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAChC,CAAC;IACD,aAAa,CAAE,cAA8B;QAC3C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,OAAO,CAAE,aAAqB,EAAE,SAAkB,KAAK;QAElE,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;QACnD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,MAAM,4BAA4B,QAAQ,CAAC,MAAM,EAAE,CAAC;QACjF,MAAM,cAAc,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAQ,CAAC;QAEtD,gCAAgC;QAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5C,MAAM,6BAA6B,CAAC;QACtC,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,iBAAiB,EAAE,CAAC;QAE3C,qEAAqE;QACrE,KAAK,MAAM,KAAK,IAAI,cAAc,CAAC,QAAQ,EAAE,CAAC;YAC5C,IAAI,CAAC;gBACH,MAAM,UAAU,GAAG,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC;gBAC7C,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACpC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,MAAM;oBAAE,MAAM,GAAG,CAAC;YACxB,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IAEpB,CAAC;CAEF;AAED,OAAO,EACL,cAAc,EACd,iBAAiB,EAClB,CAAC"}

package/dist/src/SteamTools.d.ts

@@ -0,0 +1,47 @@
+import { SteamworksSDK } from "steamworks-ffi-node";
+type UserDetails = {
+    steamid: BigInt;
+    name: string;
+};
+declare class SteamClient {
+    steamworksClient: SteamworksSDK;
+    appID: number;
+    /**
+     * Initialize Steamworks API.
+     * @param appID Game's Steam AppID (default 620 = Portal 2)
+     * Note: This makes Steam think that the specified game (Portal 2) is running.
+     */
+    constructor(appID?: number);
+    /**
+     * @returns {string} Absolute path to game directory.
+     */
+    getGameDir(): string;
+    /**
+     * @returns {UserDetails} Current user's SteamID64 and username.
+     */
+    getUserDetails(): UserDetails;
+    /**
+     * Checks whether the currently logged-in user has access to the game on Steam.
+     * @returns {boolean} true if current user has the game, false otherwise.
+     */
+    doesUserOwnGame(): boolean;
+    /**
+     * Searches for Steam binaries and returns all that were found. Output is
+     * sorted by how relevant the results are. The most useful result is first.
+     *
+     * @returns {string[]} Array of absolute paths to found Steam executables,
+     * sorted by descending relevance.
+     */
+    static findSteam(): Promise<string[]>;
+    /**
+     * Runs the Steam executable with the given command-line arguments.
+     * Can be used to start Steam, or to start a Steam game by using "-applaunch".
+     *
+     * TODO: Replace with manual game launch, hooking virtual file system.
+     *
+     * @param args Command-line arguments for Steam.
+     */
+    static launchSteam(args?: string[]): Promise<void>;
+}
+export { type UserDetails, SteamClient };
+//# sourceMappingURL=SteamTools.d.ts.map

package/dist/src/SteamTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SteamTools.d.ts","sourceRoot":"","sources":["../../src/SteamTools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAOpD,KAAK,WAAW,GAAG;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAA;CACb,CAAC;AAEF,cAAM,WAAW;IAEf,gBAAgB,EAAE,aAAa,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;gBACU,KAAK,GAAE,MAAY;IAahC;;OAEG;IACH,UAAU,IAAK,MAAM;IAKrB;;OAEG;IACH,cAAc,IAAK,WAAW;IAM9B;;;OAGG;IACH,eAAe,IAAK,OAAO;IAI3B;;;;;;OAMG;WACU,SAAS,IAAK,OAAO,CAAC,MAAM,EAAE,CAAC;IA4F5C;;;;;;;OAOG;WACU,WAAW,CAAE,IAAI,GAAE,MAAM,EAAO;CAsB9C;AAED,OAAO,EACL,KAAK,WAAW,EAChB,WAAW,EACZ,CAAC"}