ducjs 3.0.3 → 3.0.5

package/dist/ducjs_wasm.d.ts

@@ -0,0 +1,148 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Fetch a single external file from a `.duc` buffer by file ID.
+ *
+ * Returns the file entry as a JS object, or `undefined` if not found.
+ */
+export function getExternalFile(buf: Uint8Array, file_id: string): any;
+/**
+ * Restore a specific checkpoint by its ID from a `.duc` file buffer.
+ *
+ * Returns a JS object `{ versionNumber, schemaVersion, data, fromCheckpoint }`.
+ */
+export function restoreCheckpoint(duc_buf: Uint8Array, checkpoint_id: string): any;
+/**
+ * List all versions (checkpoints + deltas) from a `.duc` file buffer.
+ *
+ * Returns a JS array of `VersionEntry` objects (no heavy data blobs).
+ */
+export function listVersions(duc_buf: Uint8Array): any;
+/**
+ * Read the full VersionGraph from a `.duc` file buffer.
+ *
+ * Returns a JS object matching the `VersionGraph` TypeScript interface,
+ * or `undefined` if no version graph exists.
+ */
+export function readVersionGraph(duc_buf: Uint8Array): any;
+/**
+ * Returns the current version-control schema version defined in Rust.
+ *
+ * TypeScript should use this as the source of truth instead of hardcoding
+ * its own constant. When this value is bumped in Rust, the version control
+ * system will automatically handle migration bookkeeping (closing old chains,
+ * recording migrations) the next time a checkpoint or delta is created.
+ */
+export function getCurrentSchemaVersion(): number;
+/**
+ * Restore the document state at `version_number` from a `.duc` file buffer.
+ *
+ * The `.duc` file is a SQLite database — this function opens it and queries
+ * the `checkpoints` / `deltas` tables directly for version restoration.
+ *
+ * Returns a JS object `{ versionNumber, schemaVersion, data, fromCheckpoint }`.
+ */
+export function restoreVersion(duc_buf: Uint8Array, version_number: number): any;
+/**
+ * Revert the document to a specific version, removing all newer versions.
+ *
+ * Returns a JS object `{ versionNumber, schemaVersion, data, fromCheckpoint }`.
+ */
+export function revertToVersion(duc_buf: Uint8Array, target_version: number): any;
+/**
+ * Apply a changeset to reconstruct document state.
+ *
+ * `base_state` must be the exact checkpoint data used when the changeset
+ * was created. Returns the full document state as `Uint8Array`.
+ *
+ * Handles all changeset formats transparently:
+ *   - v3 (bsdiff), v2 (XOR diff), v1 (zlib full snapshot)
+ */
+export function applyDeltaChangeset(base_state: Uint8Array, changeset: Uint8Array): Uint8Array;
+/**
+ * List metadata for all external files (without loading the heavy data blobs).
+ */
+export function listExternalFiles(buf: Uint8Array): any;
+/**
+ * Serialize a JS object (ExportedDataState) into `.duc` bytes (Uint8Array).
+ */
+export function serializeDuc(data: any): Uint8Array;
+/**
+ * Compute a checkpoint-relative binary diff changeset using bsdiff.
+ *
+ * `base_state` is the checkpoint's full data blob.
+ * `current_state` is the full document state at the new version.
+ *
+ * Returns an encoded changeset (`Uint8Array`) ready for storage in a
+ * `Delta.payload`. bsdiff finds matching blocks even when they shift
+ * offsets, which is critical for SQLite databases.
+ */
+export function createDeltaChangeset(base_state: Uint8Array, current_state: Uint8Array): Uint8Array;
+/**
+ * Parse a `.duc` file (Uint8Array) into a JS object (ExportedDataState).
+ */
+export function parseDuc(buf: Uint8Array): any;
+/**
+ * Parse a `.duc` file lazily — returns everything EXCEPT external file data blobs.
+ *
+ * Use `getExternalFile()` or `listExternalFiles()` for on-demand access.
+ */
+export function parseDucLazy(buf: Uint8Array): any;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly applyDeltaChangeset: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+  readonly createDeltaChangeset: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+  readonly getCurrentSchemaVersion: () => number;
+  readonly getExternalFile: (a: number, b: number, c: number, d: number) => [number, number, number];
+  readonly listExternalFiles: (a: number, b: number) => [number, number, number];
+  readonly listVersions: (a: number, b: number) => [number, number, number];
+  readonly parseDuc: (a: number, b: number) => [number, number, number];
+  readonly parseDucLazy: (a: number, b: number) => [number, number, number];
+  readonly readVersionGraph: (a: number, b: number) => [number, number, number];
+  readonly restoreCheckpoint: (a: number, b: number, c: number, d: number) => [number, number, number];
+  readonly restoreVersion: (a: number, b: number, c: number) => [number, number, number];
+  readonly revertToVersion: (a: number, b: number, c: number) => [number, number, number];
+  readonly serializeDuc: (a: any) => [number, number, number, number];
+  readonly rust_sqlite_wasm_abort: () => void;
+  readonly rust_sqlite_wasm_assert_fail: (a: number, b: number, c: number, d: number) => void;
+  readonly rust_sqlite_wasm_calloc: (a: number, b: number) => number;
+  readonly rust_sqlite_wasm_malloc: (a: number) => number;
+  readonly rust_sqlite_wasm_free: (a: number) => void;
+  readonly rust_sqlite_wasm_getentropy: (a: number, b: number) => number;
+  readonly rust_sqlite_wasm_localtime: (a: number) => number;
+  readonly rust_sqlite_wasm_realloc: (a: number, b: number) => number;
+  readonly sqlite3_os_end: () => number;
+  readonly sqlite3_os_init: () => number;
+  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_export_4: WebAssembly.Table;
+  readonly __externref_table_dealloc: (a: number) => void;
+  readonly __wbindgen_free: (a: number, b: number, c: 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>;