@preference-sl/pref-gltf-transform 1.0.0

package/README.md

@@ -0,0 +1,81 @@
+# pref-gltf-transform
+
+Browser helper utilities built on top of **glTF Transform** that allow you to:
+
+- Download all external `.bin` buffers referenced by a `.gltf`
+- Pack a `.gltf` + its `.bin` buffers into a single `.glb`
+- Return a **Blob URL** that can be downloaded in the browser
+
+---
+
+## Features
+
+- Browser-compatible (`fetch`, `Blob`, `URL.createObjectURL`)
+- Uses glTF Transform `WebIO`
+- Supports embedded `data:` buffer URIs
+- Downloads external buffers via configurable backend endpoint
+- In-memory caching for glTF JSON and buffers
+- Applies `unpartition()` before GLB generation
+
+---
+
+## Installation (in case of pref-gltf-transform.ts)
+
+```bash
+npm install @gltf-transform/core @gltf-transform/extensions @gltf-transform/functions
+
+npm run build
+```
+
+---
+
+## Integration (in case of pref-gltf-transform.js)
+
+Make sure the compiled file pref-gltf-transform.js is available in your hosted folder.
+
+The files index.html and main.js are provided as a working example of how to integrate pref-gltf-transform.js in a browser environment.
+
+- index.html defines a simple UI (inputs + buttons) and loads main.js as an ES module.
+
+ - main.js demonstrates how to call the library functions:
+
+downloadBinsReferencedByGltf() � downloads external .bin buffers referenced by a .gltf
+
+generateGlbFromGltfAndBins() � generates a single .glb file from .gltf + downloaded buffers
+
+---
+
+## Configuration
+
+The module builds `.bin` download URLs in the form:
+
+```
+{protocol}://{myserverHost}/Files/{Maker}/{Type}/{uri}
+```
+
+---
+
+## Initialization
+
+```js
+await initPrefGltfTransform("./config.json");
+
+./config.json - is in-memory configuration,
+
+
+```
+
+---
+
+## Quick Start
+
+```js
+await downloadBinsReferencedByGltf(gltfUrl);
+const blobUrl = await generateGlbFromGltfAndBins(gltfUrl);
+```
+
+---
+
+## References
+
+- https://gltf-transform.dev

package/package.json

@@ -0,0 +1,32 @@
+{
+    "name": "@preference-sl/pref-gltf-transform",
+    "version": "1.0.0",
+    "description": "Web component to convert GLTF into GLB",
+    "type": "module",
+    "main": "./www/pref-gltf-transform.js",
+    "module": "./www/pref-gltf-transform.js",
+    "types": "./www/pref-gltf-transform.d.ts",
+    "exports": {
+        ".": {
+            "types": "./www/pref-gltf-transform.d.ts",
+            "import": "./www/pref-gltf-transform.js",
+            "require": "./www/pref-gltf-transform.js"
+        }
+    },
+    "files": [
+        "www"
+    ],
+    "scripts": {
+        "build": "esbuild src/pref-gltf-transform.ts --bundle --format=esm --target=es2022 --outfile=www/pref-gltf-transform.js",
+        "prebuild": "tsc --emitDeclarationOnly",
+        "build:watch": "esbuild src/pref-gltf-transform.ts --bundle --format=esm --target=es2022 --outfile=www/pref-gltf-transform.js --watch"
+    },
+    "devDependencies": {
+        "@gltf-transform/core": "^4.3.0",
+        "@gltf-transform/extensions": "^4.3.0",
+        "@gltf-transform/functions": "^4.3.0",
+        "esbuild": "^0.27.3",
+        "marked": "^17.0.1",
+        "typescript": "^5.9.3"
+    }
+}

package/www/pref-gltf-transform.d.ts

@@ -0,0 +1,37 @@
+export type PrefGltfTransformConfig = {
+    myserverHost: string;
+    useHttps?: boolean;
+    protocol?: "http" | "https";
+};
+type Options = {
+    myserverHost: string;
+    useHttps: boolean;
+};
+/**
+ * Provide config directly (called by main.js on page load).
+ */
+export declare function setPrefGltfTransformConfig(cfg: PrefGltfTransformConfig): void;
+/**
+ * Load config from a JSON URL (called by main.js on page load).
+ * Example config.json:
+ * {
+ *   "protocol": "https",
+ *   "myserverHost": "example.com:8443"
+ * }
+ */
+export declare function initPrefGltfTransform(configJsonUrl: string): Promise<void>;
+/**
+ * Same logic as your main.ts, but:
+ * - no UI refs
+ * - options optional if config was initialized via initPrefGltfTransform()/setPrefGltfTransformConfig()
+ */
+export declare function downloadBinsReferencedByGltf(gltfUrl: string, options?: Options): Promise<{
+    results: Array<Record<string, unknown>>;
+}>;
+/**
+ * Same logic as your main.ts, but returns blobUrl:
+ *   const blob = new Blob([glbBytes], { type: "model/gltf-binary" });
+ *   return URL.createObjectURL(blob);
+ */
+export declare function generateGlbFromGltfAndBins(gltfUrl: string, options?: Options): Promise<string>;
+export {};