@scrthq/runlog 0.0.24

package/dist/types/base64url.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Base64url, the unpadded kind, for the salt and IV in a container header.
+ *
+ * Written out rather than pulled in: it is nine lines each way, and this
+ * package's whole point is to have nothing underneath it.
+ */
+export declare function toBase64Url(bytes: Uint8Array): string;
+/**
+ * Backed by a plain `ArrayBuffer` on purpose.
+ *
+ * `Uint8Array.from` produces one typed as `ArrayBufferLike`, which since
+ * TypeScript 5.7 includes `SharedArrayBuffer` and so is not accepted where
+ * Web Crypto wants bytes. Allocating the buffer explicitly says what is
+ * actually true here and avoids a cast at every call site.
+ */
+export declare function fromBase64Url(text: string): Uint8Array<ArrayBuffer>;

package/dist/types/container.d.ts

@@ -0,0 +1,48 @@
+/** What travels in the clear, so a seller can act on a leak without the key. */
+export interface ContainerHeader {
+    v: 1;
+    alg: "aes-256-gcm";
+    kdf: "pbkdf2-sha256";
+    iterations: number;
+    salt: string;
+    iv: string;
+    /**
+     * The seller's own reference for the sale, if they set one.
+     *
+     * Deliberately not the buyer's name. A leaked file should let the seller
+     * trace the sale through their own records; it should not publish somebody's
+     * name to everyone who downloads it.
+     */
+    ref?: string;
+    /** Shown before asking for a key, so the prompt can say what it is for. */
+    title?: string;
+}
+/**
+ * A license key a person can be given and can type.
+ *
+ * Grouped and from an alphabet without the characters people confuse, because
+ * this gets pasted out of a receipt email by someone who wants to play.
+ */
+export declare function generateLicenseKey(): string;
+/**
+ * Seal a document.
+ *
+ * The whole document goes in, including its signature: verification happens
+ * after opening, against the same bytes the author signed.
+ */
+export declare function seal(document: unknown, licenseKey: string, extra?: {
+    ref?: string;
+    title?: string;
+}): Promise<Uint8Array<ArrayBuffer>>;
+export declare function isSealed(data: Uint8Array): boolean;
+/** Read the clear header without needing a key. */
+export declare function readHeader(data: Uint8Array): ContainerHeader | null;
+export type OpenResult = {
+    ok: true;
+    document: unknown;
+} | {
+    ok: false;
+    reason: "not-sealed" | "unsupported" | "wrong-key" | "damaged";
+    message: string;
+};
+export declare function open(data: Uint8Array, licenseKey: string): Promise<OpenResult>;

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The sealed-copy container, on its own.
+ *
+ * This is the part of Runlog a seller's backend needs and nothing else: seal
+ * a pack behind a license key, read a sealed file's clear header, open one
+ * with its key, and make keys people can type. It has no idea what a pack
+ * is — it seals a JSON document — and no opinion about who is selling, so
+ * it depends on nothing and runs wherever Web Crypto does: Node 20 and up,
+ * and every current browser.
+ *
+ * The format is documented in docs/selling.md, and the promise the app makes
+ * about it is the reason this package exists: any file in this shape opens
+ * with its key, on any address, with nothing checked online.
+ */
+export { generateLicenseKey, isSealed, open, readHeader, seal, type ContainerHeader, type OpenResult, } from "./container.ts";
+export { fromBase64Url, toBase64Url } from "./base64url.ts";

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@scrthq/runlog",
+  "version": "0.0.24",
+  "description": "Validate, lint, bundle and test Runlog rule packs.",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SCRT-HQ/runlog.git"
+  },
+  "homepage": "https://github.com/SCRT-HQ/runlog#readme",
+  "bugs": "https://github.com/SCRT-HQ/runlog/issues",
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "runlog": "./dist/runlog.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "runlog",
+    "tabletop",
+    "rule-pack",
+    "cli",
+    "rlpack",
+    "seal",
+    "license"
+  ]
+}