@ariacompute/engine-ts 1.13.0 → 1.14.0

package/README.md

@@ -16,11 +16,17 @@ eng.close();
 
 `Engine.open(modelRef, { token, site })` accepts a local bundle path **or** an
 Aria model name (e.g. `gemma-4-e2b-it_q4`). A value containing `/` or already on
-disk is loaded directly; otherwise the SDK downloads it from the Dashboard
-private source (requires `token`; `site` defaults to `https://ariacompute.com`)
-into `~/.ariacompute/models/{model}` and then loads it. A valid cached bundle is
-reused without re-downloading.
+disk is loaded directly; otherwise the SDK downloads it from the regional public
+hub (same as `aria-engine download`: `.com` → Hugging Face, `.cn` → ModelScope;
+`site` defaults to `https://ariacompute.com`) into `~/.ariacompute/models/{model}`
+and then loads it. Dashboard is not used. A Dashboard `sk-` / `bfvk-` token is
+ignored for hub auth. Token is optional for public models. A valid cached bundle
+is reused without re-downloading.
+
+Gated files: pass `hfToken` (`.com`) or `modelscopeApiToken` (`.cn`) — same keys as
+`aria-engine auth`. If omitted, the SDK reads `~/.ariacompute/config.yml`.
 
 ```ts
-const eng = await Engine.open("gemma-4-e2b-it_q4", { token: "API_TOKEN" });
+const eng = await Engine.open("gemma-4-e2b-it_q4");
+const gated = await Engine.open("gemma-4-e2b-it_q4", { hfToken: "hf_..." });
 ```

package/dist/index.d.ts

@@ -27,9 +27,13 @@ export interface CompleteResult {
     generation?: Generation;
 }
 export interface OpenOptions {
-    /** Dashboard bearer token. Required when modelRef is a model name. */
+    /** Legacy generic hub token. Dashboard sk-/bfvk- keys are ignored. */
     token?: string;
-    /** Dashboard base URL. Defaults to https://ariacompute.com. */
+    /** Hugging Face hub token (`.com`). Same field as `aria-engine auth` `hf_token`. */
+    hfToken?: string;
+    /** ModelScope hub token (`.cn`). Same field as `aria-engine auth` `modelscope_api_token`. */
+    modelscopeApiToken?: string;
+    /** Site used to pick the regional hub. Defaults to https://ariacompute.com (.com → HF, .cn → ModelScope). */
     site?: string;
     /** Explicit path to the FFI library. */
     ffiLib?: string;
@@ -39,10 +43,16 @@ export declare function parseBundleName(model: string): {
     slug: string;
     quant: string;
 };
-/** Download `model` from the Dashboard private source into
+export declare function preferredPublicHub(site?: string): "huggingface" | "modelscope";
+export declare function hubBearer(token?: string): string | undefined;
+export declare function configYmlScalar(key: string): string | undefined;
+export declare function resolveHubToken(source: "huggingface" | "modelscope", opts?: Pick<OpenOptions, "token" | "hfToken" | "modelscopeApiToken">): string | undefined;
+export declare function hubFileUrls(source: "huggingface" | "modelscope", model: string, file: string, sdk?: string): string[];
+/** Download `model` from the regional public hub into
  * `~/.ariacompute/models/{model}` and return that directory.
- * Skips the download when a valid bundle is already cached. */
-export declare function downloadModel(model: string, token: string, site?: string): Promise<string>;
+ * Matches aria-engine download: .com → Hugging Face, .cn → ModelScope.
+ * Dashboard is not used. Skips the download when a valid bundle is already cached. */
+export declare function downloadModel(model: string, tokenOrOpts?: string | OpenOptions, site?: string): Promise<string>;
 export declare function isLocalRef(modelRef: string): boolean;
 export declare class Engine {
     private lib;
@@ -56,8 +66,7 @@ export declare class Engine {
     /** Construct from a local bundle directory. */
     constructor(bundle: string, opts?: OpenOptions);
     /** Auto-detect: a value containing a separator or already on disk is a local
-     * path; otherwise it is a model name that is downloaded (requires `token`)
-     * then loaded. */
+     * path; otherwise it is a model name downloaded from the regional public hub. */
     static open(modelRef: string, opts?: OpenOptions): Promise<Engine>;
     complete(messages: Turn[], opts?: GenerateOptions): CompleteResult;
     embed(text: string): number[];

package/dist/index.js

@@ -35,13 +35,29 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports._internal = exports.Engine = void 0;
 exports.parseBundleName = parseBundleName;
+exports.preferredPublicHub = preferredPublicHub;
+exports.hubBearer = hubBearer;
+exports.configYmlScalar = configYmlScalar;
+exports.resolveHubToken = resolveHubToken;
+exports.hubFileUrls = hubFileUrls;
 exports.downloadModel = downloadModel;
 exports.isLocalRef = isLocalRef;
 const fs = __importStar(require("node:fs"));
 const os = __importStar(require("node:os"));
 const path = __importStar(require("node:path"));
-const fflate = __importStar(require("fflate"));
+const promises_1 = require("node:stream/promises");
+const node_stream_1 = require("node:stream");
 const DEFAULT_SITE = "https://ariacompute.com";
+const DEFAULT_SDK = "v1.0";
+const HUB_REQUIRED = ["config.json", "weight.bin"];
+const HUB_OPTIONAL = [
+    "tokenizer.json",
+    "tokenizer.model",
+    "tokenizer_config.json",
+    "special_tokens_map.json",
+    "vocab.json",
+    "merges.txt",
+];
 function ariaHome() {
     return process.env.ARIA_COMPUTE_HOME || path.join(os.homedir(), ".ariacompute");
 }
@@ -56,7 +72,10 @@ function parseBundleName(model) {
     const idx = model.lastIndexOf("_q");
     if (idx !== -1) {
         const slug = model.slice(0, idx);
-        const suffix = model.slice(idx + 2);
+        let suffix = model.slice(idx + 2);
+        if (suffix.endsWith("_channel") || suffix.endsWith("_group")) {
+            suffix = suffix.slice(0, suffix.lastIndexOf("_"));
+        }
         const quant = suffix === "4"
             ? "int4"
             : suffix === "8"
@@ -83,81 +102,185 @@ function isValidBundle(dir) {
         return false;
     }
 }
-function flattenSingleSubdir(dir) {
-    const entries = fs.readdirSync(dir).filter((e) => !e.startsWith("."));
-    if (entries.length !== 1)
-        return;
-    const only = path.join(dir, entries[0]);
-    if (!fs.statSync(only).isDirectory())
-        return;
-    if (!fs.existsSync(path.join(only, "config.json")))
-        return;
-    for (const name of fs.readdirSync(only)) {
-        fs.renameSync(path.join(only, name), path.join(dir, name));
+function preferredPublicHub(site) {
+    if (site && site.toLowerCase().includes("ariacompute.cn"))
+        return "modelscope";
+    return "huggingface";
+}
+function hubBearer(token) {
+    const t = (token || "").trim();
+    if (!t)
+        return undefined;
+    const low = t.toLowerCase();
+    if (low.startsWith("sk-") || low.startsWith("bfvk-"))
+        return undefined;
+    return t;
+}
+function unquoteYaml(v) {
+    const t = v.trim();
+    if (t.length >= 2 && ((t.startsWith('"') && t.endsWith('"')) || (t.startsWith("'") && t.endsWith("'")))) {
+        return t.slice(1, -1);
+    }
+    return t;
+}
+function configYmlScalar(key) {
+    try {
+        const raw = fs.readFileSync(path.join(ariaHome(), "config.yml"), "utf8");
+        for (const line of raw.split("\n")) {
+            if (line.startsWith(" ") || line.startsWith("\t"))
+                continue;
+            const s = line.trim();
+            if (!s || s.startsWith("#") || !s.includes(":"))
+                continue;
+            const idx = s.indexOf(":");
+            if (s.slice(0, idx).trim() !== key)
+                continue;
+            const v = unquoteYaml(s.slice(idx + 1));
+            return v || undefined;
+        }
+    }
+    catch {
+        return undefined;
+    }
+    return undefined;
+}
+function resolveHubToken(source, opts = {}) {
+    const named = source === "modelscope" ? opts.modelscopeApiToken : opts.hfToken;
+    const field = source === "modelscope" ? "modelscope_api_token" : "hf_token";
+    for (const cand of [named, opts.token, configYmlScalar(field)]) {
+        const b = hubBearer(cand);
+        if (b)
+            return b;
     }
-    fs.rmdirSync(only);
+    return undefined;
 }
-async function extractZip(data, dest) {
-    if (data[0] !== 0x50 || data[1] !== 0x4b) {
-        throw new Error("downloaded archive is not a valid zip");
+function hubPathNames(model) {
+    const names = [model];
+    let lower = model.toLowerCase();
+    let core = model;
+    for (const suf of ["_channel", "_group"]) {
+        if (lower.endsWith(suf)) {
+            core = model.slice(0, -suf.length);
+            lower = core.toLowerCase();
+            break;
+        }
     }
-    fs.mkdirSync(dest, { recursive: true });
-    const entries = fflate.unzipSync(data);
-    for (const [name, content] of Object.entries(entries)) {
-        const out = path.join(dest, name);
-        if (name.endsWith("/")) {
-            fs.mkdirSync(out, { recursive: true });
+    const stems = [core];
+    if (lower.endsWith("_q326"))
+        stems.push(`${core.slice(0, -5)}q3.26`);
+    else if (lower.endsWith("_q3.26"))
+        stems.push(`${core.slice(0, -6)}q326`);
+    for (const stem of stems) {
+        for (const share of ["", "_channel", "_group"]) {
+            const cand = `${stem}${share}`;
+            if (!names.includes(cand))
+                names.push(cand);
+        }
+    }
+    return names;
+}
+function hubFileUrls(source, model, file, sdk = DEFAULT_SDK) {
+    const urls = [];
+    for (const name of hubPathNames(model)) {
+        if (source === "modelscope") {
+            for (const repo of [`AriaCompute/${name}`, "AriaCompute/model"]) {
+                urls.push(`https://www.modelscope.cn/models/${repo}/resolve/master/${sdk}/${name}/${file}`);
+                urls.push(`https://modelscope.cn/models/${repo}/resolve/master/${sdk}/${name}/${file}`);
+            }
         }
         else {
-            fs.mkdirSync(path.dirname(out), { recursive: true });
-            fs.writeFileSync(out, content);
+            for (const repo of [`ariacompute/${name}`, "ariacompute/model"]) {
+                urls.push(`https://huggingface.co/${repo}/resolve/main/${sdk}/${name}/${file}`);
+            }
         }
     }
-    flattenSingleSubdir(dest);
+    return urls;
 }
-async function httpGet(url, token) {
-    const resp = await fetch(url, { headers: { Authorization: `Bearer ${token}` } });
+class HubHttpError extends Error {
+    constructor(status, message) {
+        super(message);
+        this.status = status;
+    }
+}
+async function fetchUrlToFile(url, dest, token) {
+    const headers = {};
+    if (token)
+        headers.Authorization = `Bearer ${token}`;
+    const resp = await fetch(url, { headers });
+    if (resp.status === 401 || resp.status === 403) {
+        throw new HubHttpError(resp.status, `HTTP ${resp.status}`);
+    }
     if (!resp.ok)
-        return { ok: false, status: resp.status, body: null };
-    const ct = resp.headers.get("content-type") || "";
-    if (ct.includes("json"))
-        return { ok: true, status: resp.status, body: await resp.json() };
-    return { ok: true, status: resp.status, body: Buffer.from(await resp.arrayBuffer()) };
+        throw new HubHttpError(resp.status, `HTTP ${resp.status}`);
+    if (!resp.body)
+        throw new Error("empty response body");
+    fs.mkdirSync(path.dirname(dest), { recursive: true });
+    await (0, promises_1.pipeline)(node_stream_1.Readable.fromWeb(resp.body), fs.createWriteStream(dest));
+}
+async function fetchHubFile(source, model, file, dest, token, required) {
+    let last;
+    for (const url of hubFileUrls(source, model, file)) {
+        try {
+            await fetchUrlToFile(url, dest, token);
+            return true;
+        }
+        catch (e) {
+            last = e;
+            if (e instanceof HubHttpError && (e.status === 401 || e.status === 403)) {
+                const field = source === "modelscope" ? "modelscope_api_token" : "hf_token";
+                throw new Error(`auth failed HTTP ${e.status}; set ${field} via aria-engine auth (do not pass a Dashboard sk-/bfvk- key as the hub token)`);
+            }
+        }
+    }
+    if (required)
+        throw new Error(`${source}: missing ${file}${last ? `: ${last}` : ""}`);
+    return false;
 }
 const encoder = new TextEncoder();
-/** Download `model` from the Dashboard private source into
+/** Download `model` from the regional public hub into
  * `~/.ariacompute/models/{model}` and return that directory.
- * Skips the download when a valid bundle is already cached. */
-async function downloadModel(model, token, site = DEFAULT_SITE) {
-    if (!token)
-        throw new Error("api token is required to download a model");
-    const { slug, quant } = parseBundleName(model);
+ * Matches aria-engine download: .com → Hugging Face, .cn → ModelScope.
+ * Dashboard is not used. Skips the download when a valid bundle is already cached. */
+async function downloadModel(model, tokenOrOpts, site = DEFAULT_SITE) {
+    const opts = tokenOrOpts && typeof tokenOrOpts === "object"
+        ? tokenOrOpts
+        : { token: tokenOrOpts, site };
+    parseBundleName(model);
+    const resolvedSite = opts.site ?? site ?? DEFAULT_SITE;
+    const source = preferredPublicHub(resolvedSite);
+    const hubToken = resolveHubToken(source, opts);
     const cache = cacheDir(model);
     if (fs.existsSync(cache) && isValidBundle(cache))
         return cache;
-    const metaUrl = `${site.replace(/\/$/, "")}/api/dashboard/models/${encodeURIComponent(slug)}/download?quant=${encodeURIComponent(quant)}&sdk=v1.0&format=json`;
-    const metaResp = await httpGet(metaUrl, token);
-    if (!metaResp.ok)
-        throw new Error(`dashboard request failed: ${metaResp.status}`);
-    const meta = metaResp.body;
-    if (!meta.url)
-        throw new Error("dashboard meta returned empty url");
-    const zipResp = await httpGet(meta.url, token);
-    if (!zipResp.ok)
-        throw new Error(`download stream failed: ${zipResp.status}`);
-    const data = zipResp.body;
     const staging = path.join(ariaHome(), "models", `.${model}.partial`);
-    if (fs.existsSync(staging))
-        fs.rmSync(staging, { recursive: true, force: true });
-    await extractZip(data, staging);
-    if (!isValidBundle(staging)) {
-        fs.rmSync(staging, { recursive: true, force: true });
-        throw new Error("downloaded archive did not contain a valid aria-quant-bundle");
-    }
-    if (fs.existsSync(cache))
-        fs.rmSync(cache, { recursive: true, force: true });
-    fs.renameSync(staging, cache);
-    return cache;
+    try {
+        if (fs.existsSync(staging))
+            fs.rmSync(staging, { recursive: true, force: true });
+        fs.mkdirSync(staging, { recursive: true });
+        for (const file of HUB_REQUIRED) {
+            await fetchHubFile(source, model, file, path.join(staging, file), hubToken, true);
+        }
+        for (const extra of HUB_OPTIONAL) {
+            try {
+                await fetchHubFile(source, model, extra, path.join(staging, extra), hubToken, false);
+            }
+            catch {
+                /* optional tokenizer sidecar */
+            }
+        }
+        if (!isValidBundle(staging)) {
+            throw new Error(`${source} fetch completed but bundle invalid (need weight.bin + aria-quant-bundle config.json)`);
+        }
+        if (fs.existsSync(cache))
+            fs.rmSync(cache, { recursive: true, force: true });
+        fs.renameSync(staging, cache);
+        return cache;
+    }
+    catch (e) {
+        if (fs.existsSync(staging))
+            fs.rmSync(staging, { recursive: true, force: true });
+        throw e;
+    }
 }
 function loadLib(ffiLib) {
     const libPath = ffiLib || process.env.ARIA_FFI_LIB;
@@ -186,15 +309,11 @@ class Engine {
         }
     }
     /** Auto-detect: a value containing a separator or already on disk is a local
-     * path; otherwise it is a model name that is downloaded (requires `token`)
-     * then loaded. */
+     * path; otherwise it is a model name downloaded from the regional public hub. */
     static async open(modelRef, opts = {}) {
         if (isLocalRef(modelRef))
             return new Engine(modelRef, opts);
-        if (!opts.token) {
-            throw new Error(`model name '${modelRef}' requires an api token to download`);
-        }
-        const bundle = await downloadModel(modelRef, opts.token, opts.site ?? DEFAULT_SITE);
+        const bundle = await downloadModel(modelRef, opts);
         return new Engine(bundle, opts);
     }
     complete(messages, opts = {}) {

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "@ariacompute/engine-ts",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "description": "TypeScript/Node SDK for Aria Engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc -p .",
-    "test": "node --test test/binding.test.mjs"
+    "test": "node --test test/binding.test.mjs test/download.test.mjs"
   },
   "license": "MIT",
   "dependencies": {
-    "fflate": "^0.8.2",
     "koffi": "^2.8.0"
   },
   "devDependencies": {