@preference-sl/pref-gltf-transform 1.0.0 → 1.0.2

package/README.md

@@ -1,81 +1,102 @@
-# pref-gltf-transform
+# @preference-sl/pref-gltf-transform
 
-Browser helper utilities built on top of **glTF Transform** that allow you to:
+Helper utilities built on top of [glTF Transform](https://gltf-transform.dev/) to process glTF assets in the browser.
 
-- 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:
+- **Download External References**: Fetch `.bin` buffers referenced by a `.gltf` file from a configurable backend.
+- **Convert to GLB**: Pack a `.gltf` and its buffers into a single `.glb` file.
+- **Caching**: Uses IndexedDB to cache large binary assets to avoid re-downloading.
 
----
-
-## 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)
+## Installation
 
 ```bash
-npm install @gltf-transform/core @gltf-transform/extensions @gltf-transform/functions
-
-npm run build
+npm install @preference-sl/pref-gltf-transform
 ```
 
----
-
-## Integration (in case of pref-gltf-transform.js)
-
-Make sure the compiled file pref-gltf-transform.js is available in your hosted folder.
+## Usage
 
-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.
+### 1. Import in Modern Bundlers (Vite, Webpack, etc.)
 
-- index.html defines a simple UI (inputs + buttons) and loads main.js as an ES module.
+```javascript
+import { 
+  downloadBinsReferencedByGltf, 
+  generateGlbFromGltfAndBins 
+} from '@preference-sl/pref-gltf-transform';
 
- - main.js demonstrates how to call the library functions:
+// ... usage
+```
 
-downloadBinsReferencedByGltf() � downloads external .bin buffers referenced by a .gltf
+### 2. Import in Browser (without bundler)
+
+Browsers require an **Import Map** to resolve the package name if you are not using a build tool.
+
+**index.html**:
+```html
+<script type="importmap">
+{
+  "imports": {
+    "@preference-sl/pref-gltf-transform": "./node_modules/@preference-sl/pref-gltf-transform/www/pref-gltf-transform.js"
+  }
+}
+</script>
+<script type="module">
+  import { downloadBinsReferencedByGltf } from '@preference-sl/pref-gltf-transform';
+</script>
+```
 
-generateGlbFromGltfAndBins() � generates a single .glb file from .gltf + downloaded buffers
+## API
 
----
+### `downloadBinsReferencedByGltf(gltfUrl, options)`
+Crawls a `.gltf` file, finds referenced `.bin` files (via `KB_Key` extras), and downloads/caches them.
 
-## Configuration
+- **gltfUrl**: `string` - URL to the .gltf file.
+- **options**: `{ myserverHost: string, useHttps?: boolean }`
+- **Returns**: `Promise<{ results: Array }>`
 
-The module builds `.bin` download URLs in the form:
+### `generateGlbFromGltfAndBins(gltfUrl, options)`
+Loads the `.gltf` and all cached `.bin` files, then packs them into a `.glb` blob.
 
-```
-{protocol}://{myserverHost}/Files/{Maker}/{Type}/{uri}
-```
+- **Returns**: `Promise<string>` (The Blob URL of the generated .glb).
 
 ---
 
-## Initialization
+## Development
+
+If you want to contribute or modify this package:
 
-```js
-await initPrefGltfTransform("./config.json");
+### Build
+Compiles TypeScript to JavaScript (`www/pref-gltf-transform.js`) and generates types (`www/pref-gltf-transform.d.ts`).
 
-./config.json - is in-memory configuration,
+```bash
+npm run build
+```
 
+### Test
+Runs the verification script in the `playground/` directory.
 
+```bash
+npm test
 ```
 
----
+### Playground
+A local test environment is available in `playground/`.
+1. Build the project: `npm run build`
+2. Pack it: `npm pack`
+3. Go to playground: `cd playground`
+4. Install tarball: `npm install ../preference-sl-pref-gltf-transform-1.0.0.tgz`
+5. Run server: `npx serve .`
 
-## Quick Start
+## Publishing
 
-```js
-await downloadBinsReferencedByGltf(gltfUrl);
-const blobUrl = await generateGlbFromGltfAndBins(gltfUrl);
-```
+1. Increment version in `package.json`.
+2. Run the release script:
+   ```bash
+   npm run release
+   ```
 
----
+The script will automatically:
+- Run `npm run build`
+- Publish to npm with public access
+- Handle errors gracefully
 
-## References
 
-- https://gltf-transform.dev

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@preference-sl/pref-gltf-transform",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "description": "Web component to convert GLTF into GLB",
     "type": "module",
     "main": "./www/pref-gltf-transform.js",
@@ -18,8 +18,9 @@
     ],
     "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"
+        "build:watch": "esbuild src/pref-gltf-transform.ts --bundle --format=esm --target=es2022 --outfile=www/pref-gltf-transform.js --watch",
+        "test": "cd playground && npm test",
+        "release": "node scripts/publish.js"
     },
     "devDependencies": {
         "@gltf-transform/core": "^4.3.0",

package/www/pref-gltf-transform.js

@@ -10251,7 +10251,7 @@ async function loadGltfJsonFromStorage(gltfUrl) {
 }
 function buildKbFileUrl(options, key) {
   const protocol = options.useHttps ? "https" : "http";
-  return `${protocol}://${options.myserverHost}/Files/${encodeURIComponent(key.maker)}/${encodeURIComponent(key.type)}/${encodeURIComponent(key.uri)}`;
+  return `${protocol}://${options.myserverHost}/KB/${encodeURIComponent(key.maker)}/${encodeURIComponent(key.type)}/${encodeURIComponent(key.uri)}`;
 }
 async function ensureBinExists(options, key) {
   const storageKey = `${key.maker}::${key.type}::${key.uri}`;

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

@@ -1,37 +0,0 @@
-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 {};