@bitruvius/draco 0.3.1

package/dist/wasm-host.d.ts

@@ -0,0 +1,151 @@
+/**
+ * Per-decoder override for where the Draco wasm is loaded from, set via
+ * {@link DracoDecoderOptions.wasmInit}.
+ *
+ * @remarks This is the highest-precedence step of the SDK wasm-asset resolution
+ * chain — documented once on `@bitruvius/geo-core`'s `BitruviusConfig` (caller
+ * `wasmBytes`/`wasmUrl` → `configure({ wasmBaseUrl })` → build default). Leave both
+ * fields unset to fall through to that default chain.
+ */
+export interface WasmHostInit {
+    /** Absolute (or page-relative) URL to fetch `draco_decoder.wasm` from. Takes
+     *  precedence over the SDK-configured base; ignored when {@link wasmBytes} is set. */
+    readonly wasmUrl?: string | URL;
+    /** Pre-fetched wasm bytes — the highest precedence; skips any network fetch. */
+    readonly wasmBytes?: BufferSource;
+}
+/**
+ * Draco decode status object (one embind result).
+ *
+ * @internal Raw Google Draco / Emscripten surface.
+ */
+export interface DracoStatus {
+    ok(): boolean;
+    error_msg(): string;
+}
+/**
+ * One Draco vertex attribute wrapper.
+ *
+ * @internal Raw Google Draco / Emscripten surface.
+ */
+export interface DracoAttribute {
+    /** Raw wasm pointer — 0 when the requested unique-id is not in the geometry. */
+    ptr: number;
+    num_components(): number;
+    /** Draco attribute unique-id (stable across decode) — used to bridge a named/typed
+     *  lookup to the existing `GetAttributeByUniqueId` extraction path. */
+    unique_id(): number;
+    /** Draco `GeometryAttribute::Type` (POSITION/NORMAL/COLOR/TEX_COORD/GENERIC). */
+    attribute_type(): number;
+}
+/** A Draco metadata table (owned by the geometry — not separately destroyed). `ptr===0`
+ *  when an attribute carries no metadata. Read via a {@link DracoMetadataQuerier}.
+ *
+ * @internal Raw Google Draco / Emscripten surface. */
+export interface DracoMetadata {
+    ptr: number;
+}
+/** Reads typed entries out of a {@link DracoMetadata} by name (must be `destroy`ed).
+ *
+ * @internal Raw Google Draco / Emscripten surface. */
+export interface DracoMetadataQuerier {
+    HasEntry(metadata: DracoMetadata, name: string): boolean;
+    GetDoubleEntry(metadata: DracoMetadata, name: string): number;
+    GetStringEntry(metadata: DracoMetadata, name: string): string;
+    NumEntries(metadata: DracoMetadata): number;
+}
+/**
+ * A decoded Draco geometry (Mesh or PointCloud) handle.
+ *
+ * @internal Raw Google Draco / Emscripten surface.
+ */
+export interface DracoGeometry {
+    ptr: number;
+    num_points(): number;
+    num_faces(): number;
+    /** Number of vertex attributes (POSITION, TEX_COORD, COLOR, and the GENERIC I3S
+     *  attributes feature-index / uv-region). Used to resolve GENERIC attributes by metadata. */
+    num_attributes(): number;
+}
+/**
+ * The Draco `Decoder` embind handle (decode + attribute/index extraction).
+ *
+ * @internal Raw Google Draco / Emscripten surface.
+ */
+export interface DracoDecoderHandle {
+    GetEncodedGeometryType(buffer: DracoDecoderBuffer): number;
+    DecodeBufferToMesh(buffer: DracoDecoderBuffer, mesh: DracoGeometry): DracoStatus;
+    DecodeBufferToPointCloud(buffer: DracoDecoderBuffer, pc: DracoGeometry): DracoStatus;
+    GetAttributeByUniqueId(geom: DracoGeometry, uniqueId: number): DracoAttribute;
+    /** Attribute INDEX (or -1) of the first attribute of `attributeType` (POSITION/…). */
+    GetAttributeId(geom: DracoGeometry, attributeType: number): number;
+    /** Attribute by INDEX (pairs with {@link GetAttributeId}). */
+    GetAttribute(geom: DracoGeometry, attributeIndex: number): DracoAttribute;
+    /** Attribute INDEX (or -1) of the attribute whose metadata has `name === value`.
+     *  I3S marks its GENERIC attributes with `i3s-attribute-type` (`feature-index`,
+     *  `uv-region`) — both are GENERIC, so a type lookup can't disambiguate them; this
+     *  resolves each by its metadata entry. */
+    GetAttributeIdByMetadataEntry(geom: DracoGeometry, name: string, value: string): number;
+    /** Metadata table for an attribute (I3S stores `i3s-scale_x/y` on POSITION). */
+    GetAttributeMetadata(geom: DracoGeometry, attributeIndex: number): DracoMetadata;
+    GetAttributeDataArrayForAllPoints(geom: DracoGeometry, attr: DracoAttribute, dataType: number, outByteLength: number, outPtr: number): void;
+    GetTrianglesUInt32Array(mesh: DracoGeometry, outByteLength: number, outPtr: number): void;
+}
+/**
+ * The Draco `DecoderBuffer` embind handle (wraps the input bytes for decode).
+ *
+ * @internal Raw Google Draco / Emscripten surface.
+ */
+export interface DracoDecoderBuffer {
+    Init(data: Int8Array, byteLength: number): void;
+}
+/**
+ * The full Draco decoder Emscripten module surface (constructors, heap views,
+ * `_malloc`/`_free`, and the enum constants the decoder reads). Obtained from
+ * {@link ensureDraco}; passed to {@link decodeDracoGeometry}.
+ *
+ * @internal Raw Google Draco / Emscripten module — not an application-facing type.
+ */
+export interface DracoModule {
+    Decoder: new () => DracoDecoderHandle;
+    DecoderBuffer: new () => DracoDecoderBuffer;
+    Mesh: new () => DracoGeometry;
+    PointCloud: new () => DracoGeometry;
+    MetadataQuerier: new () => DracoMetadataQuerier;
+    destroy(obj: unknown): void;
+    _malloc(byteLength: number): number;
+    _free(ptr: number): void;
+    /** Live heap views (re-read after each `_malloc` — memory growth detaches them). */
+    HEAPF32: Float32Array;
+    HEAPU32: Uint32Array;
+    HEAPU16: Uint16Array;
+    HEAPU8: Uint8Array;
+    TRIANGULAR_MESH: number;
+    POINT_CLOUD: number;
+    DT_FLOAT32: number;
+    DT_UINT32: number;
+    DT_UINT16: number;
+    DT_UINT8: number;
+    POSITION: number;
+    NORMAL: number;
+    COLOR: number;
+    TEX_COORD: number;
+    GENERIC: number;
+}
+/** Best absolute URL for the Draco wasm to hand a Web Worker (which can't resolve
+ *  the package sibling itself): the SDK-configured CDN base if set, else the
+ *  package-relative `wasm/` asset. Mirrors the turbo-* codecs' worker handoff.
+ *
+ * @returns The absolute wasm URL string, or `undefined` if neither source resolves.
+ * @internal Low-level worker wasm-URL helper. */
+export declare function dracoWasmUrl(): string | undefined;
+/** Instantiate the Draco decoder module once; subsequent calls share the promise.
+ *  A failed init is evicted so it can be retried.
+ *
+ * @param init - Optional per-call wasm source ({@link WasmHostInit}); ignored after
+ *   the first successful init (the module is a process singleton).
+ * @returns A promise for the initialized {@link DracoModule}.
+ * @throws Error `draco: failed to fetch wasm (…)` if the resolved wasm URL fetch is
+ *   non-OK.
+ * @internal Low-level wasm host initializer; use {@link DracoDecoder} instead. */
+export declare function ensureDraco(init?: WasmHostInit): Promise<DracoModule>;

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@bitruvius/draco",
+  "version": "0.3.1",
+  "description": "Draco geometry decoder seam for the Bitruvius glTF, 3D Tiles and I3S pipelines: decode-only Google Draco wasm (KHR_draco_mesh_compression / 3DTILES_draco_point_compression), vendored and hardened",
+  "type": "module",
+  "license": "SEE LICENSE IN LICENSE",
+  "bugs": {
+    "url": "https://github.com/bitruvius/support"
+  },
+  "homepage": "https://dev.bitruvius.com/sdks/js/",
+  "keywords": [
+    "bitruvius",
+    "geospatial",
+    "3d-tiles",
+    "gltf",
+    "draco",
+    "mesh",
+    "wasm",
+    "decoder"
+  ],
+  "sideEffects": [
+    "./src/index.ts"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./wasm/*": "./wasm/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "wasm",
+    "LICENSE",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir dist --format esm --target browser --minify --external '@bitruvius/*' --define __dirname='\"\"' --define __filename='\"\"' && tsc --emitDeclarationOnly",
+    "test": "bun test"
+  },
+  "dependencies": {
+    "@bitruvius/geo-core": "^0.3.1"
+  }
+}

package/wasm/LICENSE-Apache-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 Google Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/wasm/LICENSE-MIT.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016-2026 Arseny Kapoulkine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/wasm/NOTICES

@@ -0,0 +1,39 @@
+# Third-Party Notices
+
+This repository **vendors and repackages** third-party codec decoders. Their
+licenses and copyrights are reproduced below, and the full licence texts ship
+alongside this file in the published package. Bitruvius claims no ownership of these components.
+
+## Draco — `draco3d` (Google)
+- License: **Apache License 2.0**
+- Copyright © The Draco Authors / Google LLC
+- Source: https://github.com/google/draco · npm `draco3d`
+- Only the **decoder** (`draco_decoder.js` / `draco_decoder.wasm`) is vendored;
+  the encoder is dropped.
+
+## meshoptimizer — `meshoptimizer` (Arseny Kapoulkine / zeux)
+- License: **MIT**
+- Copyright © 2016- Arseny Kapoulkine
+- Source: https://github.com/zeux/meshoptimizer · npm `meshoptimizer`
+- Only the **decoder** module is vendored.
+
+## Basis Universal transcoder (Binomial LLC / Khronos)
+- License: **Apache License 2.0**
+- Copyright © 2019- Binomial LLC
+- Source: https://github.com/BinomialLLC/basis_universal
+- Only the **transcoder** is vendored (transcode-only; no compressor).
+
+---
+
+The full licence texts ship beside this file as `LICENSE-Apache-2.0.txt` and
+`LICENSE-MIT.txt`, and are included in the published package (`files` lists
+`wasm`). Apache-2.0 section 4(a) requires recipients to receive a copy; that copy
+is those files.
+
+NOTE ON THE SDK LICENCE. The Bitruvius `LICENSE` restricts redistribution and
+reverse engineering of the SDK. Those restrictions do NOT apply to the
+third-party components listed above: they are licensed to you directly by their
+copyright holders under Apache-2.0 and MIT, and nothing in the Bitruvius licence
+can reduce the rights those licences grant you over those files. Where the two
+appear to conflict as applied to a vendored component, the upstream licence
+governs that component.