Proxy Script Template

一个简单的模板协助你快速完成 Proxy Tool 脚本的开发。

在这里我们提供了一个通用的 Client 类和一些常用的方法，用于兼容不同客户端的差异并减少重复工作。

即使不使用该类，模板也定义了常见的全局变量，实现部分方法的代码联想。

1 开始

安装 nodejs 以进行后续项目的部署
在项目下执行 npm i 以安装 esbuild
使用 npm run build 将代码打包成完整的 js 文件

2 内置方法

2.1 lib/client.js

封装的通用客户端类[早期版本]，该类无需手动去判断客户端版本，使用通用的接口进行调用。

实现细节查看链接

1 生成实例

import Client from "./lib/client.js";

const $ = Client.getInstance("Script Name", { debug: true });

2 使用方法

$.request == $request;
$.response == $response;

$.request.url = "https://exmaple.com";
$.response.body = "abc";

$.fetch({ url: "https://exmaple.com", method: "GET" }).then(res => {});

$.setJSON("json", { "a": 1 });
$.getJSON("json");

$.timeStart("Show Timer");
/** do action*/
$.timeEnd("Show Timer"); // [log] Show Timer: x ms

$.done({ body: "" });

需要注意的是，客户端之间内置的接口存在差异，需要做一些转换

bodyBytes 成为通用接口

// 类似 Qx $response.bodyBytes,Surge $response.body
$.response.bodyBytes; // 将返回 Uint8Array

// 类似 surge binary-mode=true
$.fetch({ bodyBytes: Uint8Array });

id 成为通用接口

// 等价于 Qx $request.sessionIndex
$.request.id

done 统一用法

$.done({
    status?: number,
    headers?: Record<string, string>,
    body?: string,
    bodyBytes?: Uint8Array
})

// 或者在 request 类型脚本中直接返回结果

$.done({
    response: {
        status?: number,
        headers?: Record<string, string>, 
        body?: string, 
        bodyBytes?: Uint8Array
    }
})

常用接口

所有类型相关的定义可以在 types 文件夹中查看

属性

// 等价于 $request
request: CRequest;

// 等价于 $response
response: CResponse;

方法

interface Client {
  // 静态方法，返回客户端的实例。
  static getInstance(name?: string, options?: { debug?: boolean; }): Client;

  // 获取持久化存储的值
  getVal(key: string): any;

  // 写入持久化存储的值
  setVal(val: string, key: string): void;

  // 以JSON 的形式读取持久化存储
  getJSON(key: string, alter?: object): object;

  // 以JSON 的形式写入持久化存储
  setJSON(val: object, key: string): void;

  // 发送请求
  fetch(request: CFetchRequest): Promise<CFetchResponse>;

  // 显示通知
  msg(title?: string, subTitle?: string, desc?: string, url?: string): void;

  // 等价于 console.log
  log(val: any): void;

  // 计时器开始
  timeStart(label: string): void;

  // 计时器结束
  timeEnd(label: string): void;

  // 等价于 $done(obj)
  done(done: CDone): void;

  // 等价于 $done({})
  exit(): void;

  // 等价于 $done()
  reject(): void;
}

2.2 lib/urls.js

使用正则解析 URL @DualSubs

import URLs from "./lib/urls.js";

const url = new URLs("https://www.baidu.com/path?a=1")

console.log(url)

url.params.a = 2
const newURL = url.toString()

console.log(newURL)

output:

URLs {
  name: 'URL v1.0.2',
  scheme: 'https',
  host: 'www.baidu.com',
  path: 'path',
  params: { a: '1' }
}

https://www.baidu.com/path?a=2

2.3 lib/textPolyfill.js

用于添加 TextDecoder 和 TextEncoder 作为全局变量,需要时取消 build.js 中的注释

2.4 script/decodeProtobuf.js

使用 protoc 反序列化 protobuf/grpc

下载 protoc, 并为其配置全局变量
修改以下代码

const fileName = "path to your file";
// 是否为 grpc
const isGRPC = false;

使用 node 运行

Maasea / proxy-script-template