@mercuryworkshop/scramjet 2.0.67-alpha.2 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +62 -0
- package/dist/scramjet-external.mjs +0 -1
- package/dist/scramjet.js +7 -7
- package/dist/scramjet.js.map +1 -1
- package/dist/scramjet.mjs +5 -5
- package/dist/scramjet.mjs.map +1 -1
- package/dist/scramjet.wasm +0 -0
- package/dist/scramjet_bundled.js +6 -6
- package/dist/scramjet_bundled.js.map +1 -1
- package/dist/scramjet_bundled.mjs +6 -6
- package/dist/scramjet_bundled.mjs.map +1 -1
- package/dist/types/Tap.d.ts +1 -1
- package/dist/types/client/client.d.ts +26 -25
- package/dist/types/client/location.d.ts +1 -1
- package/dist/types/client/shared/eval.d.ts +2 -2
- package/dist/types/client/shared/sourcemaps.d.ts +1 -1
- package/dist/types/client/shared/wrap.d.ts +2 -2
- package/dist/types/client/singletonbox.d.ts +1 -1
- package/dist/types/fetch/fetch.d.ts +1 -1
- package/dist/types/fetch/headers.d.ts +1 -1
- package/dist/types/fetch/index.d.ts +129 -0
- package/dist/types/fetch/util.d.ts +1 -1
- package/dist/types/index.d.ts +7 -7
- package/dist/types/shared/htmlRules.d.ts +2 -2
- package/dist/types/shared/index.d.ts +4 -5
- package/dist/types/shared/rewriters/css.d.ts +2 -2
- package/dist/types/shared/rewriters/html.d.ts +3 -3
- package/dist/types/shared/rewriters/js.d.ts +2 -2
- package/dist/types/shared/rewriters/url.d.ts +1 -1
- package/dist/types/shared/rewriters/wasm.d.ts +2 -2
- package/dist/types/shared/rewriters/worker.d.ts +2 -2
- package/dist/types/shared/snapshot.d.ts +1 -0
- package/dist/types/types.d.ts +1 -9
- package/dist/types/typesEntry.d.ts +1 -1
- package/package.json +12 -43
- package/dist/temp-types-build/index.js +0 -23
- package/dist/temp-types-build/index.js.map +0 -1
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
<h1 align="center">Scramjet</h1>
|
|
2
|
+
<div align="center">
|
|
3
|
+
<img src="assets/scramjet.png" height="200" />
|
|
4
|
+
</div>
|
|
5
|
+
|
|
6
|
+
<div align="center">
|
|
7
|
+
<a href="https://www.npmjs.com/package/@mercuryworkshop/scramjet"><img src="https://img.shields.io/npm/v/@mercuryworkshop/scramjet.svg?maxAge=3600" alt="npm version" /></a>
|
|
8
|
+
<img src="https://img.shields.io/github/issues/MercuryWorkshop/scramjet?style=flat&color=orange" />
|
|
9
|
+
<img src="https://img.shields.io/github/stars/MercuryWorkshop/scramjet?style=flat&color=orange" />
|
|
10
|
+
</div>
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
Scramjet is an experimental interception-based web proxy designed to evade internet censorship and bypass arbitrary browser restrictions.<br><br>
|
|
15
|
+
Scramjet allows you to sandbox arbitrary web content, bypass CORS restrictions on loading websites, and instrument and debug websites inside the browser itself. This is accomplished through a combination of interception, rewriting, and sandboxing techniques. You can learn more about the technical details <a href="https://developer.puter.com/blog/how-I-ported-the-web-to-the-web/"><strong>here</strong></a>.<br><br>
|
|
16
|
+
|
|
17
|
+
<div align="center">
|
|
18
|
+
<a href="https://github.com/MercuryWorkshop/scramjet/wiki">Documentation</a> | <a href="https://scramjet.mercurywork.shop">Playground</a> | <a href="https://discord.gg/tmApqGqfX2">Discord</a>
|
|
19
|
+
</div>
|
|
20
|
+
|
|
21
|
+
## Supported Sites
|
|
22
|
+
|
|
23
|
+
Some of the popular websites that Scramjet supports include:
|
|
24
|
+
|
|
25
|
+
- [Google](https://google.com)
|
|
26
|
+
- [Youtube](https://youtube.com)
|
|
27
|
+
- [Instagram](https://instagram.com)
|
|
28
|
+
- [ChatGPT](https://chatgpt.com)
|
|
29
|
+
- [Reddit](https://reddit.com)
|
|
30
|
+
- [Twitter](https://twitter.com)
|
|
31
|
+
- [Discord](https://discord.com)
|
|
32
|
+
- [Spotify](https://spotify.com)
|
|
33
|
+
- [GeForce NOW](https://play.geforcenow.com/)
|
|
34
|
+
- [now.gg](https://now.gg)
|
|
35
|
+
|
|
36
|
+
## Development
|
|
37
|
+
|
|
38
|
+
### Dependencies
|
|
39
|
+
|
|
40
|
+
- Recent versions of `node.js` and `pnpm`
|
|
41
|
+
- `rustup`
|
|
42
|
+
- `wasm-bindgen`
|
|
43
|
+
- [Binaryen's `wasm-opt`](https://github.com/WebAssembly/binaryen)
|
|
44
|
+
- [this `wasm-snip` fork](https://github.com/r58Playz/wasm-snip)
|
|
45
|
+
|
|
46
|
+
#### Building
|
|
47
|
+
|
|
48
|
+
- Clone the repository with `git clone --recursive https://github.com/MercuryWorkshop/scramjet`
|
|
49
|
+
- Install the dependencies with `pnpm i`
|
|
50
|
+
- Change directories with `cd packages/core`
|
|
51
|
+
- Build the rewriter with `pnpm rewriter:build`
|
|
52
|
+
- Build Scramjet with `pnpm build`
|
|
53
|
+
|
|
54
|
+
### Running Scramjet Locally
|
|
55
|
+
|
|
56
|
+
You can run the Scramjet dev server when running this command at the root
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
pnpm dev
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
The demo page for scramjet should now be running at <http://localhost:4141> and should rebuild upon a file being changed (excluding the rewriter).
|