@subconverter/browser 0.0.0-stage → 0.2.1

package/README.md

@@ -1,3 +1,55 @@
-# Temporary Holding Version
+# @subconverter/browser
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Browser build of [subconverter-ts](https://github.com/jinganix/subconverter): convert
+subscriptions entirely in the page, with no server round trip. Built on
+[`@subconverter/core`](https://npmjs.com/package/@subconverter/core) and shipped as ESM
+plus an IIFE global (`SubConverter`).
+
+```bash
+npm i @subconverter/browser
+```
+
+## Quick start
+
+```ts
+import { createExtraSettings, loadNodes, toClash } from "@subconverter/browser";
+
+const nodes = await loadNodes("https://example.com/sub");
+const clash = toClash(nodes, [], createExtraSettings());
+```
+
+`loadNodes` fetches and parses in one step; `toClash` / `toSurge` are the bundled
+generators. Everything else (the full `parseSubscription`, `generate`, `TargetFormat`,
+and all type exports) is re-exported from `@subconverter/core`.
+
+## Script tag
+
+```html
+<script src="https://unpkg.com/@subconverter/browser/dist/subconverter.global.js"></script>
+<script>
+  const nodes = await SubConverter.loadNodes("https://example.com/sub");
+</script>
+```
+
+The IIFE bundle exposes `SubConverter` on `window`.
+
+## CORS
+
+The browser build calls `fetch` directly, so the subscription host must allow cross-origin
+requests. When it does not, run the [server from `@subconverter/node`](https://npmjs.com/package/@subconverter/node)
+and point the browser at your own origin instead.
+
+## Package size
+
+The IIFE bundle is roughly 160 kB because it contains the whole conversion engine,
+including every parser and generator. Import the ESM entry point to let a bundler drop
+unused targets.
+
+## API reference
+
+Every public export with its signature, enum members, and interface fields:
+[docs/API.md](https://github.com/jinganix/subconverter/blob/main/docs/API.md).
+
+## License
+
+GPL-3.0.

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { Proxy } from '@subconverter/core';
+export { ExtraSettings, Proxy, ProxyGroupConfig, RequestSettings, TargetFormat, createExtraSettings, parseSubscription, toClash, toSurge } from '@subconverter/core';
+
+/** Fetch a remote subscription body in the browser. */
+declare function fetchSubscription(url: string, init?: RequestInit): Promise<string>;
+/** Fetch and parse a subscription URL into nodes. */
+declare function loadNodes(url: string, init?: RequestInit): Promise<Proxy[]>;
+
+export { fetchSubscription, loadNodes };

package/dist/index.js

@@ -0,0 +1,27 @@
+// src/index.ts
+import { parseSubscription } from "@subconverter/core";
+import {
+  createExtraSettings,
+  parseSubscription as parseSubscription2,
+  toClash,
+  toSurge
+} from "@subconverter/core";
+async function fetchSubscription(url, init) {
+  const response = await fetch(url, init);
+  if (!response.ok) {
+    throw new Error(`Failed to fetch ${url}: ${response.status} ${response.statusText}`);
+  }
+  return response.text();
+}
+async function loadNodes(url, init) {
+  return parseSubscription(await fetchSubscription(url, init));
+}
+export {
+  createExtraSettings,
+  fetchSubscription,
+  loadNodes,
+  parseSubscription2 as parseSubscription,
+  toClash,
+  toSurge
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { type Proxy, parseSubscription } from \"@subconverter/core\";\n\nexport {\n  type ExtraSettings,\n  type Proxy,\n  type ProxyGroupConfig,\n  type RequestSettings,\n  type TargetFormat,\n  createExtraSettings,\n  parseSubscription,\n  toClash,\n  toSurge,\n} from \"@subconverter/core\";\n\n/** Fetch a remote subscription body in the browser. */\nexport async function fetchSubscription(url: string, init?: RequestInit): Promise<string> {\n  const response = await fetch(url, init);\n  if (!response.ok) {\n    throw new Error(`Failed to fetch ${url}: ${response.status} ${response.statusText}`);\n  }\n  return response.text();\n}\n\n/** Fetch and parse a subscription URL into nodes. */\nexport async function loadNodes(url: string, init?: RequestInit): Promise<Proxy[]> {\n  return parseSubscription(await fetchSubscription(url, init));\n}\n"],"mappings":";AAAA,SAAqB,yBAAyB;AAE9C;AAAA,EAME;AAAA,EACA,qBAAAA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAGP,eAAsB,kBAAkB,KAAa,MAAqC;AACxF,QAAM,WAAW,MAAM,MAAM,KAAK,IAAI;AACtC,MAAI,CAAC,SAAS,IAAI;AAChB,UAAM,IAAI,MAAM,mBAAmB,GAAG,KAAK,SAAS,MAAM,IAAI,SAAS,UAAU,EAAE;AAAA,EACrF;AACA,SAAO,SAAS,KAAK;AACvB;AAGA,eAAsB,UAAU,KAAa,MAAsC;AACjF,SAAO,kBAAkB,MAAM,kBAAkB,KAAK,IAAI,CAAC;AAC7D;","names":["parseSubscription"]}