libfw-client 0.1.0

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "libfw-client",
+  "version": "0.1.0",
+  "description": "High-performance streaming file & folder transfer SDK for the browser (libfw WASM engine + File System Access API + IndexedDB resume).",
+  "license": "MIT OR Apache-2.0",
+  "type": "module",
+  "main": "index.js",
+  "module": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    },
+    "./pkg/*": "./pkg/*"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "pkg/libfw_client.js",
+    "pkg/libfw_client_bg.wasm",
+    "pkg/libfw_client.d.ts",
+    "pkg/libfw_client_bg.wasm.d.ts",
+    "pkg/package.json"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build:wasm": "wasm-pack build ../crates/libfw-client --target web --out-dir ../sdk/pkg --release",
+    "build:umd": "rollup -c rollup.config.mjs",
+    "build": "npm run build:wasm && npm run build:umd"
+  },
+  "keywords": [
+    "libfw",
+    "transfer",
+    "upload",
+    "download",
+    "wasm",
+    "file-system-access",
+    "resumable"
+  ],
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.0.0",
+    "rollup": "^4.0.0"
+  }
+}

package/pkg/libfw_client.d.ts

@@ -0,0 +1,123 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * WASM engine facade. Construct via `new LibfwClient(options)`.
+ */
+export class LibfwClient {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Cancel the active transfer (state → `failed`).
+     */
+    cancel(): void;
+    /**
+     * Bytes transferred so far.
+     */
+    done_bytes(): number;
+    /**
+     * Download every file under the virtual `dirPath` (empty = root).
+     *
+     * Resolves with the number of bytes written.
+     */
+    download_folder(base_url: string, token: string, dir_path: string): Promise<any>;
+    /**
+     * Whether callbacks have been installed.
+     */
+    has_callbacks(): boolean;
+    /**
+     * Create an engine. `options` may include:
+     * `{ concurrency, compress, chunkSize, maxRetries, baseRetryDelayMs,
+     * maxRetryDelayMs, timeoutMs }`.
+     */
+    constructor(opts: any);
+    /**
+     * Pause the active transfer (state → `paused`).
+     */
+    pause(): void;
+    /**
+     * Progress in `[0, 1]`.
+     */
+    progress(): number;
+    /**
+     * Resume a paused transfer.
+     */
+    resume(): void;
+    /**
+     * Install the JS callbacks object (required before any transfer).
+     */
+    set_callbacks(callbacks: any): void;
+    /**
+     * Current state: `idle | downloading | uploading | paused | completed |
+     * failed`.
+     */
+    state(): string;
+    /**
+     * Total bytes to transfer.
+     */
+    total_bytes(): number;
+    /**
+     * Upload the files reported by the JS `getFileList` callback.
+     *
+     * Resolves with the number of bytes uploaded.
+     */
+    upload(base_url: string, token: string): Promise<any>;
+}
+
+/**
+ * Read an optional string field from a JS object (helper for the SDK).
+ */
+export function js_option_string(obj: any, key: string): string | undefined;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_libfwclient_free: (a: number, b: number) => void;
+    readonly js_option_string: (a: any, b: number, c: number) => [number, number];
+    readonly libfwclient_cancel: (a: number) => void;
+    readonly libfwclient_done_bytes: (a: number) => number;
+    readonly libfwclient_download_folder: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => any;
+    readonly libfwclient_has_callbacks: (a: number) => number;
+    readonly libfwclient_new: (a: any) => number;
+    readonly libfwclient_pause: (a: number) => void;
+    readonly libfwclient_progress: (a: number) => number;
+    readonly libfwclient_resume: (a: number) => void;
+    readonly libfwclient_set_callbacks: (a: number, b: any) => void;
+    readonly libfwclient_state: (a: number) => [number, number];
+    readonly libfwclient_total_bytes: (a: number) => number;
+    readonly libfwclient_upload: (a: number, b: number, c: number, d: number, e: number) => any;
+    readonly wasm_bindgen_1e05ddb24c0b7df4___convert__closures_____invoke___wasm_bindgen_1e05ddb24c0b7df4___JsValue__core_9b3796e30d99ddb7___result__Result_____wasm_bindgen_1e05ddb24c0b7df4___JsError___true_: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen_1e05ddb24c0b7df4___convert__closures_____invoke___js_sys_bb6c79d0abe11c10___Function_fn_wasm_bindgen_1e05ddb24c0b7df4___JsValue_____wasm_bindgen_1e05ddb24c0b7df4___sys__Undefined___js_sys_bb6c79d0abe11c10___Function_fn_wasm_bindgen_1e05ddb24c0b7df4___JsValue_____wasm_bindgen_1e05ddb24c0b7df4___sys__Undefined_______true_: (a: number, b: number, c: any, d: any) => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_destroy_closure: (a: number, b: number) => void;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;