@mercuryworkshop/scramjet 2.0.0-alpha → 2.0.2-alpha

package/dist/types/shared/cookie.d.ts

@@ -0,0 +1,18 @@
+export type Cookie = {
+    name: string;
+    value: string;
+    path?: string;
+    expires?: string;
+    maxAge?: number;
+    domain?: string;
+    secure?: boolean;
+    httpOnly?: boolean;
+    sameSite?: "strict" | "lax" | "none";
+};
+export declare class CookieJar {
+    private cookies;
+    setCookies(cookies: string[], url: URL): void;
+    getCookies(url: URL, fromJs: boolean): string;
+    load(cookies: string): null;
+    dump(): string;
+}

package/dist/types/shared/headers.d.ts

@@ -0,0 +1,13 @@
+import { RawHeaders } from "@mercuryworkshop/proxy-transports";
+export declare class ScramjetHeaders {
+    headers: {};
+    set(key: string, v: string): void;
+    get(key: string): string | null;
+    delete(key: string): void;
+    has(key: string): boolean;
+    toRawHeaders(): RawHeaders;
+    toNativeHeaders(): Headers;
+    static fromRawHeaders(raw: RawHeaders): ScramjetHeaders;
+    static fromNativeHeaders(native: Headers): ScramjetHeaders;
+    clone(): ScramjetHeaders;
+}

package/dist/types/shared/htmlRules.d.ts

@@ -0,0 +1,6 @@
+import { URLMeta } from "./rewriters/url";
+import { ScramjetContext } from "../shared";
+export declare const htmlRules: {
+    [key: string]: "*" | string[] | ((...any: any[]) => string | null);
+    fn: (value: string, context: ScramjetContext, meta: URLMeta) => string | null;
+}[];

package/dist/types/shared/index.d.ts

@@ -0,0 +1,23 @@
+import { ScramjetConfig, ScramjetFlags, ScramjetVersionInfo } from "../types";
+import DomHandler, { Element } from "domhandler";
+import { URLMeta } from "./rewriters/url";
+import { CookieJar } from "./cookie";
+export * from "./cookie";
+export * from "./headers";
+export * from "./htmlRules";
+export * from "./rewriters";
+export * from "./security";
+export declare function flagEnabled(flag: keyof ScramjetFlags, context: ScramjetContext, url: URL): boolean;
+export type ScramjetInterface = {
+    codecEncode: (input: string) => string;
+    codecDecode: (input: string) => string;
+    getInjectScripts(meta: URLMeta, handler: DomHandler, script: (src: string) => Element): Element[];
+    getWorkerInjectScripts?(meta: URLMeta, type: "module" | "regular", script: (src: string) => string): string;
+};
+export type ScramjetContext = {
+    config: ScramjetConfig;
+    prefix: URL;
+    interface: ScramjetInterface;
+    cookieJar: CookieJar;
+};
+export declare const versionInfo: ScramjetVersionInfo;

package/dist/types/shared/rewriters/css.d.ts

@@ -0,0 +1,4 @@
+import { URLMeta } from "./url";
+import { ScramjetContext } from "../../shared";
+export declare function rewriteCss(css: string, context: ScramjetContext, meta: URLMeta): string;
+export declare function unrewriteCss(css: string): string;

package/dist/types/shared/rewriters/html.d.ts

@@ -0,0 +1,6 @@
+import { DomHandler } from "domhandler";
+import { URLMeta } from "./url";
+import { ScramjetContext } from "../../shared";
+export declare function rewriteHtml(html: string, context: ScramjetContext, meta: URLMeta, fromTop?: boolean, preRewrite?: (handler: DomHandler) => void, postRewrite?: (handler: DomHandler) => void): string;
+export declare function unrewriteHtml(html: string): string;
+export declare function rewriteSrcset(srcset: string, context: ScramjetContext, meta: URLMeta): string;

package/dist/types/shared/rewriters/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./css";
+export * from "./html";
+export * from "./js";
+export * from "./url";
+export * from "./worker";
+export * from "./wasm";

package/dist/types/shared/rewriters/js.d.ts

@@ -0,0 +1,11 @@
+import { ScramjetContext } from "../../shared";
+import { URLMeta } from "./url";
+type RewriterResult = {
+    js: string | Uint8Array;
+    map: Uint8Array | null;
+    tag: string;
+    errors: string[];
+};
+export declare function rewriteJsInner(js: string | Uint8Array, url: string | null, context: ScramjetContext, meta: URLMeta, module?: boolean): RewriterResult;
+export declare function rewriteJs(js: string | Uint8Array, url: string | null, context: ScramjetContext, meta: URLMeta, module?: boolean): string | Uint8Array;
+export {};

package/dist/types/shared/rewriters/url.d.ts

@@ -0,0 +1,11 @@
+import { ScramjetContext } from "../../shared";
+export type URLMeta = {
+    origin: URL;
+    base: URL;
+    topFrameName?: string;
+    parentFrameName?: string;
+};
+export declare function rewriteBlob(url: string, context: ScramjetContext, meta: URLMeta): string;
+export declare function unrewriteBlob(url: string, context: ScramjetContext, meta: URLMeta): string;
+export declare function rewriteUrl(url: string | URL, context: ScramjetContext, meta: URLMeta): string;
+export declare function unrewriteUrl(url: string | URL, context: ScramjetContext): string;

package/dist/types/shared/rewriters/wasm.d.ts

@@ -0,0 +1,8 @@
+import { Rewriter } from "../../../rewriter/wasm/out/wasm.js";
+import type { JsRewriterOutput } from "../../../rewriter/wasm/out/wasm.js";
+import { ScramjetContext } from "../../shared";
+export type { JsRewriterOutput, Rewriter };
+import { URLMeta } from "./url";
+export declare function setWasm(u8: Uint8Array | ArrayBuffer): void;
+export declare const textDecoder: TextDecoder;
+export declare function getRewriter(context: ScramjetContext, meta: URLMeta): [Rewriter, () => void];

package/dist/types/shared/rewriters/worker.d.ts

@@ -0,0 +1,3 @@
+import { ScramjetContext } from "../../shared";
+import { URLMeta } from "./url";
+export declare function rewriteWorkers(context: ScramjetContext, js: string | Uint8Array, type: "module" | "regular", url: string, meta: URLMeta): string;

package/dist/types/shared/security/index.d.ts

@@ -0,0 +1 @@
+export * from "./siteTests";

package/dist/types/shared/security/siteTests.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/symbols.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @fileoverview
+ * See `types.ts` for context on these symbols.
+ */
+export declare const SCRAMJETCLIENTNAME = "scramjet client global";
+export declare const SCRAMJETCLIENT: unique symbol;
+export declare const SCRAMJETFRAME: unique symbol;

package/dist/types/types.d.ts

@@ -0,0 +1,115 @@
+import { ScramjetClient } from "./client/index";
+import { SCRAMJETCLIENT } from "./symbols";
+import { DBSchema } from "idb";
+/**
+ * Version information for the current Scramjet build.
+ * Contains both the semantic version string and the git commit hash for build identification.
+ */
+export interface ScramjetVersionInfo {
+    /** The semantic version */
+    version: string;
+    /** The git commit hash that this build was created from */
+    build: string;
+    /** The date of the build */
+    date: string;
+}
+/**
+ * Scramjet Feature Flags, configured at build time
+ */
+export type ScramjetFlags = {
+    syncxhr: boolean;
+    strictRewrites: boolean;
+    rewriterLogs: boolean;
+    captureErrors: boolean;
+    cleanErrors: boolean;
+    scramitize: boolean;
+    sourcemaps: boolean;
+    destructureRewrites: boolean;
+    allowInvalidJs: boolean;
+    allowFailedIntercepts: boolean;
+    debugTrampolines: boolean;
+    encapsulateWorkers: boolean;
+};
+export interface ScramjetConfig {
+    globals: {
+        wrapfn: string;
+        wrappropertybase: string;
+        wrappropertyfn: string;
+        cleanrestfn: string;
+        importfn: string;
+        rewritefn: string;
+        metafn: string;
+        wrappostmessagefn: string;
+        pushsourcemapfn: string;
+        trysetfn: string;
+        templocid: string;
+        tempunusedid: string;
+    };
+    maskedfiles: string[];
+    flags: ScramjetFlags;
+    siteFlags: Record<string, Partial<ScramjetFlags>>;
+}
+/**
+ * The config for Scramjet initialization.
+ */
+export interface ScramjetInitConfig extends Omit<ScramjetConfig, "codec" | "flags"> {
+    flags: Partial<ScramjetFlags>;
+    codec: {
+        encode: (url: string) => string;
+        decode: (url: string) => string;
+    };
+}
+declare global {
+    interface Window {
+        WASM: string;
+        REAL_WASM: Uint8Array;
+        /**
+         * The scramjet client belonging to a window.
+         */
+        [SCRAMJETCLIENT]: ScramjetClient;
+    }
+    interface HTMLDocument {
+        /**
+         * Should be the same as window.
+         */
+        [SCRAMJETCLIENT]: ScramjetClient;
+    }
+    interface HTMLIFrameElement {
+    }
+}
+export type SiteDirective = "same-origin" | "same-site" | "cross-site" | "none";
+export interface RedirectTracker {
+    originalReferrer: string;
+    mostRestrictiveSite: SiteDirective;
+    referrerPolicy: string;
+    chainStarted: number;
+}
+export interface ReferrerPolicyData {
+    policy: string;
+    referrer: string;
+}
+export interface ScramjetDB extends DBSchema {
+    config: {
+        key: string;
+        value: ScramjetConfig;
+    };
+    cookies: {
+        key: string;
+        value: any;
+    };
+    redirectTrackers: {
+        key: string;
+        value: RedirectTracker;
+    };
+    referrerPolicies: {
+        key: string;
+        value: ReferrerPolicyData;
+    };
+    publicSuffixList: {
+        key: string;
+        value: {
+            data: string[];
+            expiry: number;
+        };
+    };
+}

package/lib/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @fileoverview
+ * Scramjet path export for routing functionality
+ */
+
 declare const scramjetPath: string;
 
 export { scramjetPath };

package/package.json

@@ -1,85 +1,97 @@
 {
-	"name": "@mercuryworkshop/scramjet",
-	"version": "2.0.0-alpha",
-	"description": "An experimental web proxy that aims to be the successor to Ultraviolet",
-	"type": "module",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/MercuryWorkshop/scramjet"
-	},
-	"scripts": {
-		"build": "rspack build --mode production",
-		"rewriter:build": "cd rewriter/wasm/ && bash build.sh && cd ../../",
-		"dev": "node server.js",
-		"dev:debug": "DEBUG=1 node server.js",
-		"prepack": "RELEASE=1 npm run rewriter:build && tsc && tsc-alias && npm run build",
-		"pub": "npm publish --no-git-checks --access public",
-		"format": "prettier --write .",
-		"lint": "eslint ./src/",
-		"lint:fix": "eslint ./src/ --fix",
-		"test": "npx playwright test",
-		"preinstall": "npx only-allow pnpm"
-	},
-	"exports": {
-		".": {
-			"types": "./lib/types.d.ts",
-			"default": "./lib/noop.js"
-		},
-		"./path": {
-			"types": "./lib/index.d.ts",
-			"default": "./lib/index.cjs"
-		},
-		"./bundled": {
-			"types": "./dist/types/index.d.ts",
-			"default": "./dist/scramjet.bundle.js"
-		}
-	},
-	"files": [
-		"dist/*.js",
-		"dist/*.js.map",
-		"dist/*.wasm",
-		"lib"
-	],
-	"keywords": [],
-	"author": "",
-	"license": "MIT",
-	"devDependencies": {
-		"@eslint/eslintrc": "^3.3.1",
-		"@eslint/js": "^9.32.0",
-		"@estruyf/github-actions-reporter": "^1.10.0",
-		"@fastify/static": "^8.2.0",
-		"@mercuryworkshop/bare-as-module3": "^2.2.5",
-		"@mercuryworkshop/epoxy-transport": "^2.1.28",
-		"@mercuryworkshop/libcurl-transport": "^1.5.0",
-		"@mercuryworkshop/wisp-js": "^0.3.3",
-		"@nebula-services/bare-server-node": "^2.0.4",
-		"@playwright/test": "^1.54.2",
-		"@rsdoctor/rspack-plugin": "^1.1.5",
-		"@rspack/cli": "^1.4.8",
-		"@rspack/core": "^1.4.8",
-		"@types/eslint": "^9.6.1",
-		"@types/estree": "^1.0.8",
-		"@types/node": "^24.1.0",
-		"@types/serviceworker": "^0.0.148",
-		"@typescript-eslint/eslint-plugin": "^8.38.0",
-		"@typescript-eslint/parser": "^8.38.0",
-		"dotenv": "^17.2.1",
-		"eslint": "^9.32.0",
-		"fastify": "^5.4.0",
-		"playwright": "^1.54.2",
-		"prettier": "^3.6.2",
-		"ts-checker-rspack-plugin": "^1.1.4",
-		"tsc-alias": "^1.8.16",
-		"tslib": "^2.8.1",
-		"typescript": "^5.9.2"
-	},
-	"dependencies": {
-		"@mercuryworkshop/epoxy-tls": "2.1.18-1",
-		"dom-serializer": "^2.0.0",
-		"domhandler": "^5.0.3",
-		"domutils": "^3.2.2",
-		"htmlparser2": "10.0.0",
-		"parse-domain": "^8.2.2",
-		"set-cookie-parser": "^2.7.1"
-	}
-}
+  "name": "@mercuryworkshop/scramjet",
+  "version": "2.0.2-alpha",
+  "description": "An experimental web proxy that aims to be the successor to Ultraviolet",
+  "type": "module",
+  "types": "./dist/types/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MercuryWorkshop/scramjet"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/scramjet.mjs"
+    },
+    "./path": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.cjs"
+    },
+    "./bundled": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/scramjet_bundled.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "lib"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "ava": {
+    "files": [
+      "tests/ci/**/*.js"
+    ],
+    "verbose": true
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.35.0",
+    "@estruyf/github-actions-reporter": "^1.10.0",
+    "@fastify/static": "^8.2.0",
+    "@mercuryworkshop/wisp-js": "^0.4.0",
+    "@nebula-services/bare-server-node": "^2.0.4",
+    "@playwright/test": "^1.55.0",
+    "@types/eslint": "^9.6.1",
+    "@types/estree": "^1.0.8",
+    "@types/node": "^24.3.1",
+    "@types/serviceworker": "^0.0.160",
+    "@typescript-eslint/eslint-plugin": "^8.43.0",
+    "@typescript-eslint/parser": "^8.43.0",
+    "actionlint": "^2.0.6",
+    "ava": "^6.4.1",
+    "dotenv": "^17.2.2",
+    "eslint": "^9.35.0",
+    "fastify": "^5.6.0",
+    "glob": "^11.0.3",
+    "playwright": "^1.55.0",
+    "prettier": "^3.6.2",
+    "remark": "^15.0.1",
+    "remark-cli": "^12.0.1",
+    "remark-frontmatter": "^5.0.0",
+    "remark-mdx": "^3.1.1",
+    "remark-stringify": "^11.0.0",
+    "ts-checker-rspack-plugin": "^1.1.5",
+    "tsc-alias": "^1.8.16",
+    "tslib": "^2.8.1",
+    "typescript": "^5.9.2"
+  },
+  "dependencies": {
+    "@mercuryworkshop/proxy-transports": "1.0.2",
+    "dom-serializer": "^2.0.0",
+    "domhandler": "^5.0.3",
+    "domutils": "^3.2.2",
+    "htmlparser2": "^10.0.0",
+    "idb": "^8.0.3",
+    "parse-domain": "^8.2.2",
+    "set-cookie-parser": "^2.7.1"
+  },
+  "scripts": {
+    "build": "cd ../.. && rspack build --mode production",
+    "rewriter:build": "cd rewriter/wasm/ && bash build.sh && cd ../../",
+    "dev": "node server.js",
+    "dev:debug": "DEBUG=1 node server.js",
+    "pub": "npm publish --no-git-checks --access public",
+    "format": "prettier --write .",
+    "format:docs": "remark \"docs/**/*.{md,mdx}\" --output",
+    "lint": "eslint ./src/",
+    "lint:fix": "eslint ./src/ --fix",
+    "lint:workflows": "actionlint .github/workflows/*.yml",
+    "lint:all": "npm run lint && npm run lint:workflows",
+    "test": "npm run test:package && npm run test:integration",
+    "test:package": "ava tests/ci/packageValidation.js",
+    "test:integration": "npx playwright test",
+    "preinstall": "npx only-allow pnpm"
+  }
+}