@draco-rust/decoder 0.2.0 → 0.3.1

package/README.md

@@ -60,7 +60,9 @@ if (!result.success) throw new Error(result.error);
 const { index, attributes } = result; // attributes[i]: { name, array, itemSize, normalized, ... }
 ```
 
-Without the second argument every attribute comes back in its own type.
+Without the second argument every attribute comes back in its own type. The
+index is a `Uint32Array`; a third argument `{ index: "auto" }` makes it a
+`Uint16Array` wherever the points number at most 65536, half the bytes.
 
 ### On workers
 
@@ -80,6 +82,10 @@ them. The stream is copied to the worker; `pool.decode(bytes, requests, {
 transfer: true })` hands over the buffer itself instead. The pool runs on Web
 Workers, on Node's worker threads (Node 20.16 and later), and from a CDN. With
 `workers: 0`, or where there are no workers, it decodes on the calling thread.
+`pool.decode` also takes `index`, as `decode_draco` does, and an `AbortSignal`
+as `signal`: aborting rejects the promise at once. A decode a worker has
+already started still runs to its end and its result is dropped; one not yet
+sent is never sent.
 A bundler that follows `new URL("./worker.js", import.meta.url)`, as Vite and
 webpack do, emits the worker on its own.
 
@@ -114,7 +120,7 @@ package's other entries do not need it.
 ### From a CDN, without a bundler
 
 ```js
-import init, { parse_drc_bytes } from "https://cdn.jsdelivr.net/npm/@draco-rust/decoder@0.2/mesh/index.js";
+import init, { parse_drc_bytes } from "https://cdn.jsdelivr.net/npm/@draco-rust/decoder@0.3/mesh/index.js";
 await init(); // finds index_bg.wasm next to the script
 ```
 
@@ -141,4 +147,4 @@ For a subpath entry, resolve its own file, for example
 - Licensed under Apache-2.0, like Draco.
 ## This build
 
-`@draco-rust/decoder@0.2.0` was built from draco-rust commit `8650e1ca`, with draco-core 2.3.2, draco-io 0.6.0, draco-gltf 0.7.0.
+`@draco-rust/decoder@0.3.1` was built from draco-rust commit `18d16cdc`, with draco-core 2.3.3, draco-io 0.6.1, draco-gltf 0.7.0.

package/index.d.ts

@@ -3,8 +3,8 @@
 
 /** The name of a typed array `decode_draco` can convert an attribute to. */
 export type DracoArrayType =
-| "Int8Array" | "Uint8Array" | "Int16Array" | "Uint16Array"
-| "Int32Array" | "Uint32Array" | "Float32Array";
+  | "Int8Array" | "Uint8Array" | "Int16Array" | "Uint16Array"
+  | "Int32Array" | "Uint32Array" | "Float32Array";
 
 /** A Draco attribute type, as `semantic` names it. */
 export type DracoSemantic = "POSITION" | "NORMAL" | "COLOR" | "TEX_COORD" | "GENERIC";
@@ -14,62 +14,58 @@ export type DracoSemantic = "POSITION" | "NORMAL" | "COLOR" | "TEX_COORD" | "GEN
  * attribute of that type. `name` is handed back unchanged.
  */
 export interface DracoAttributeRequest {
-    name?: string;
-    id?: number;
-    semantic?: DracoSemantic;
-    type?: DracoArrayType;
+  name?: string;
+  id?: number;
+  semantic?: DracoSemantic;
+  type?: DracoArrayType;
 }
 
 /** The typed arrays an attribute can come back in. */
 export type DracoArray =
-| Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array
-| Float32Array | Float64Array | BigInt64Array | BigUint64Array;
+  | Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array
+  | Float32Array | Float64Array | BigInt64Array | BigUint64Array;
 
 export interface DracoAttribute {
-    /** The request's `name`, or else the name the stream's metadata gives it. */
-    name?: string;
-    uniqueId: number;
-    semantic: DracoSemantic;
-    array: DracoArray;
-    itemSize: number;
-    normalized: boolean;
+  /** The request's `name`, or else the name the stream's metadata gives it. */
+  name?: string;
+  uniqueId: number;
+  semantic: DracoSemantic;
+  array: DracoArray;
+  itemSize: number;
+  normalized: boolean;
 }
 
-export interface DracoDecodeResult {
-    success: boolean;
-    error?: string;
-    warnings: string[];
-    geometry?: "mesh" | "point_cloud";
-    /** Triangle corners for a mesh, `null` for a point cloud. */
-    index: Uint32Array | null;
-    attributes: DracoAttribute[];
+export interface DracoDecodeOptions {
+  /**
+   * The index's array: `"Uint32Array"`, the default, or `"auto"`, which uses a
+   * `Uint16Array` when every point number fits, at most 65536 points, and
+   * halves what a worker sends back.
+   */
+  index?: "Uint32Array" | "auto";
 }
 
-
+export interface DracoDecodeResult {
+  success: boolean;
+  error?: string;
+  warnings: string[];
+  geometry?: "mesh" | "point_cloud";
+  /** Triangle corners for a mesh, `null` for a point cloud. */
+  index: Uint32Array | Uint16Array | null;
+  attributes: DracoAttribute[];
+}
 
 /**
- * Decodes a Draco stream and returns its attributes as typed arrays.
- *
- * `attributes` is `undefined` for every attribute in its own component type,
- * or an array of requests `{ name, id, semantic, type }`:
- *
- * - `id`, a unique id, finds that attribute, as glTF's
- *   `KHR_draco_mesh_compression` names them; a missing one is an error.
- * - `semantic` (`"POSITION"`, `"NORMAL"`, `"COLOR"`, `"TEX_COORD"` or
- *   `"GENERIC"`) finds the first attribute of that type instead, as a `.drc`
- *   file is read; a missing one is left out.
- * - `type`, a typed array's name such as `"Float32Array"` or
- *   `"Uint16Array"`, converts the values the way upstream's
- *   `GetAttributeDataArrayForAllPoints` does; without it the values keep
- *   their own type. A value the type cannot hold is an error.
- *
- * The result is `{ success, error, warnings, geometry, index, attributes }`,
- * where `geometry` is `"mesh"` or `"point_cloud"` as the stream's header says,
- * `index` a `Uint32Array` of triangle corners for a mesh and `null` for a
- * point cloud, and each attribute `{ name, uniqueId, semantic, array,
- * itemSize, normalized }`.
+ * Decodes a Draco stream and returns its attributes as typed arrays: every
+ * attribute in its own type, or the ones `attributes` requests, converted as
+ * upstream's `GetAttributeDataArrayForAllPoints` converts them.
  */
-export function decode_draco(data: Uint8Array, attributes: DracoAttributeRequest[] | undefined): DracoDecodeResult;
+export function decode_draco(
+  data: Uint8Array,
+  attributes?: DracoAttributeRequest[],
+  options?: DracoDecodeOptions,
+): DracoDecodeResult;
+
+
 
 /**
  * Install the panic hook, so a panic reads as a message rather than a trap.
@@ -94,38 +90,38 @@ export function version(): string;
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
-    readonly memory: WebAssembly.Memory;
-    readonly decode_draco: (a: number, b: number, c: number) => number;
-    readonly init: () => void;
-    readonly parse_drc_bytes: (a: number, b: number) => number;
-    readonly supported_extensions: (a: number) => void;
-    readonly version: (a: number) => void;
-    readonly __wbindgen_export: (a: number, b: number) => number;
-    readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
-    readonly __wbindgen_export3: (a: number) => void;
-    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
-    readonly __wbindgen_export4: (a: number, b: number, c: number) => void;
-    readonly __wbindgen_start: () => void;
+  readonly memory: WebAssembly.Memory;
+  readonly decode_draco: (a: number, b: number, c: number, d: number) => number;
+  readonly parse_drc_bytes: (a: number, b: number) => number;
+  readonly supported_extensions: (a: number) => void;
+  readonly version: (a: number) => void;
+  readonly init: () => void;
+  readonly __wbindgen_export: (a: number, b: number) => number;
+  readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_export3: (a: number) => void;
+  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+  readonly __wbindgen_export4: (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}
- */
+* 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>}
- */
+* 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>;