@loaders.gl/textures 4.4.0-alpha.1 → 4.4.0-alpha.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/textures",
-  "version": "4.4.0-alpha.1",
+  "version": "4.4.0-alpha.9",
   "description": "Framework-independent loaders for compressed and super compressed (basis) textures ",
   "license": "MIT",
   "type": "module",
@@ -30,6 +30,27 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
+    },
+    "./basis-worker.js": {
+      "import": "./dist/basis-worker.js"
+    },
+    "./basis-worker-node.js": {
+      "import": "./dist/basis-worker-node.js"
+    },
+    "./npy-worker.js": {
+      "import": "./dist/npy-worker.js"
+    },
+    "./compressed-texture-worker.js": {
+      "import": "./dist/compressed-texture-worker.js"
+    },
+    "./crunch-worker.js": {
+      "import": "./dist/crunch-worker.js"
+    },
+    "./ktx2-basis-writer-worker.js": {
+      "import": "./dist/ktx2-basis-writer-worker.js"
+    },
+    "./ktx2-basis-writer-worker-node.js": {
+      "import": "./dist/ktx2-basis-writer-worker-node.js"
     }
   },
   "sideEffects": false,
@@ -54,16 +75,16 @@
     "build-crunch-worker": "esbuild src/workers/crunch-worker.ts --outfile=dist/crunch-worker.js --target=esnext --bundle --define:__VERSION__=\\\"$npm_package_version\\\""
   },
   "dependencies": {
-    "@loaders.gl/images": "4.4.0-alpha.1",
-    "@loaders.gl/loader-utils": "4.4.0-alpha.1",
-    "@loaders.gl/schema": "4.4.0-alpha.1",
-    "@loaders.gl/worker-utils": "4.4.0-alpha.1",
+    "@loaders.gl/images": "4.4.0-alpha.9",
+    "@loaders.gl/loader-utils": "4.4.0-alpha.9",
+    "@loaders.gl/schema": "4.4.0-alpha.9",
+    "@loaders.gl/worker-utils": "4.4.0-alpha.9",
     "@math.gl/types": "^4.1.0",
     "ktx-parse": "^0.7.0",
     "texture-compressor": "^1.0.2"
   },
   "peerDependencies": {
-    "@loaders.gl/core": "4.4.0-alpha.0"
+    "@loaders.gl/core": "4.4.0-alpha.1"
   },
-  "gitHead": "f1732de45907bd500bf4eedb4803beca8bf4bfb0"
+  "gitHead": "e9e6710379718c7663e97eba868c76e15de4cb84"
 }

package/src/basis-worker.ts

@@ -0,0 +1,7 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+// Classic-worker entrypoint that lazily loads the ESM worker implementation.
+// This keeps `importScripts` available in the worker (used by library loading).
+import(new URL('./workers/basis-worker.js', import.meta.url).toString());

package/src/compressed-texture-loader.ts

@@ -2,13 +2,13 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {Loader, LoaderWithParser} from '@loaders.gl/loader-utils';
+import type {Loader, LoaderWithParser, StrictLoaderOptions} from '@loaders.gl/loader-utils';
 import {VERSION} from './lib/utils/version';
 import {parseCompressedTexture} from './lib/parsers/parse-compressed-texture';
 import {parseBasis} from './lib/parsers/parse-basis';
 
 /** Options for the CompressedTextureLoader */
-export type CompressedTextureLoaderOptions = {
+export type CompressedTextureLoaderOptions = StrictLoaderOptions & {
   'compressed-texture'?: {
     /** @deprecated Specify path to libraries */
     libraryPath?: string;
@@ -59,14 +59,13 @@ export const CompressedTextureWorkerLoader = {
 export const CompressedTextureLoader = {
   ...CompressedTextureWorkerLoader,
   parse: async (arrayBuffer: ArrayBuffer, options?: CompressedTextureLoaderOptions) => {
+    options = {...options};
     if (options?.['compressed-texture']?.useBasis) {
-      // @ts-expect-error TODO not allowed to modify inputs
       options.basis = {
         format: {
           alpha: 'BC3',
           noAlpha: 'BC1'
         },
-        // @ts-expect-error TODO not allowed to modify inputs
         ...options.basis,
         containerFormat: 'ktx2',
         module: 'encoder'

package/src/compressed-texture-worker.ts

@@ -0,0 +1,6 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+// Classic-worker entrypoint that lazily loads the ESM worker implementation.
+import(new URL('./workers/compressed-texture-worker.js', import.meta.url).toString());

package/src/crunch-worker.ts

@@ -0,0 +1,6 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+// Classic-worker entrypoint that lazily loads the ESM worker implementation.
+import(new URL('./workers/crunch-worker.js', import.meta.url).toString());

package/src/ktx2-basis-writer-worker.ts

@@ -0,0 +1,6 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+// Classic-worker entrypoint that lazily loads the ESM worker implementation.
+import(new URL('./workers/ktx2-basis-writer-worker.js', import.meta.url).toString());

package/src/lib/encoders/encode-ktx.ts

@@ -4,7 +4,7 @@
 
 import {read} from 'ktx-parse';
 
-export function encodeKTX(texture) {
+export function encodeKTX(texture: Uint8Array) {
   const ktx = read(texture);
   // post process
   return ktx;

package/src/lib/encoders/encode-ktx2-basis-texture.ts

@@ -4,6 +4,7 @@
 
 import type {ImageDataType} from '@loaders.gl/images';
 import {loadBasisEncoderModule} from '../parsers/basis-module-loader';
+import {type KTX2BasisWriterOptions} from '../../ktx2-basis-writer';
 
 /**
  * Encodes image to Basis Universal Supercompressed GPU Texture.
@@ -14,7 +15,7 @@ import {loadBasisEncoderModule} from '../parsers/basis-module-loader';
  */
 export async function encodeKTX2BasisTexture(
   image: ImageDataType,
-  options: any = {}
+  options: KTX2BasisWriterOptions = {}
 ): Promise<ArrayBuffer> {
   // TODO remove default values after writer options will be normalized like it done in load module.
   const {
@@ -23,7 +24,7 @@ export async function encodeKTX2BasisTexture(
     encodeUASTC = false,
     mipmaps = false
   } = options?.['ktx2-basis-writer'] || {};
-  const {BasisEncoder} = await loadBasisEncoderModule(options);
+  const {BasisEncoder} = await loadBasisEncoderModule(options.core || {});
   const basisEncoder = new BasisEncoder();
 
   try {

package/src/lib/parsers/basis-module-loader.ts

@@ -3,7 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 import {registerJSModules, getJSModuleOrNull} from '@loaders.gl/loader-utils';
-import {loadLibrary} from '@loaders.gl/worker-utils';
+import {loadLibrary, LoadLibraryOptions} from '@loaders.gl/worker-utils';
 
 export const BASIS_EXTERNAL_LIBRARIES = {
   /** Basis transcoder, javascript wrapper part */
@@ -23,7 +23,7 @@ let loadBasisTranscoderPromise;
  * @param options
  * @returns {BasisFile} promise
  */
-export async function loadBasisTranscoderModule(options) {
+export async function loadBasisTranscoderModule(options: LoadLibraryOptions) {
   registerJSModules(options.modules);
   const basis = getJSModuleOrNull('basis');
   if (basis) {
@@ -39,7 +39,7 @@ export async function loadBasisTranscoderModule(options) {
  * @param options
  * @returns {BasisFile} promise
  */
-async function loadBasisTranscoder(options) {
+async function loadBasisTranscoder(options: LoadLibraryOptions) {
   let BASIS = null;
   let wasmBinary = null;
 
@@ -84,7 +84,7 @@ let loadBasisEncoderPromise;
  * @param options
  * @returns {BasisFile, KTX2File} promise
  */
-export async function loadBasisEncoderModule(options) {
+export async function loadBasisEncoderModule(options: LoadLibraryOptions) {
   const modules = options.modules || {};
   if (modules.basisEncoder) {
     return modules.basisEncoder;
@@ -99,7 +99,7 @@ export async function loadBasisEncoderModule(options) {
  * @param options
  * @returns {BasisFile, KTX2File} promise
  */
-async function loadBasisEncoder(options) {
+async function loadBasisEncoder(options: LoadLibraryOptions) {
   let BASIS_ENCODER = null;
   let wasmBinary = null;
 

package/src/lib/parsers/parse-basis.ts

@@ -9,6 +9,9 @@ import {GL_EXTENSIONS_CONSTANTS} from '../gl-extensions';
 import {getSupportedGPUTextureFormats} from '../utils/texture-formats';
 import {isKTX} from './parse-ktx';
 
+// TODO - circular type import
+import type {BasisLoaderOptions} from '../../basis-loader';
+
 export type BasisFormat =
   | 'etc1'
   | 'etc2'
@@ -78,24 +81,35 @@ const OutputFormat: Record<string, BasisOutputOptions> = {
   rgba4444: {basisFormat: 16, compressed: false}
 };
 
+export type ParseBasisOptions = {
+  format: 'auto' | BasisFormat | {alpha: BasisFormat; noAlpha: BasisFormat};
+  libraryPath?: string;
+  containerFormat: 'auto' | 'ktx2' | 'basis';
+  module: 'transcoder' | 'encoder';
+};
+
 /**
  * parse data with a Binomial Basis_Universal module
  * @param data
  * @param options
  * @returns compressed texture data
  */
-export async function parseBasis(data: ArrayBuffer, options): Promise<TextureLevel[][]> {
-  if (options.basis.containerFormat === 'auto') {
+// eslint-disable-next-line complexity
+export async function parseBasis(
+  data: ArrayBuffer,
+  options: BasisLoaderOptions = {}
+): Promise<TextureLevel[][]> {
+  if (!options.basis?.containerFormat || options.basis.containerFormat === 'auto') {
     if (isKTX(data)) {
-      const fileConstructors = await loadBasisEncoderModule(options);
+      const fileConstructors = await loadBasisEncoderModule(options?.core || {});
       return parseKTX2File(fileConstructors.KTX2File, data, options);
     }
-    const {BasisFile} = await loadBasisTranscoderModule(options);
+    const {BasisFile} = await loadBasisTranscoderModule(options?.core || {});
     return parseBasisFile(BasisFile, data, options);
   }
   switch (options.basis.module) {
     case 'encoder':
-      const fileConstructors = await loadBasisEncoderModule(options);
+      const fileConstructors = await loadBasisEncoderModule(options?.core || {});
       switch (options.basis.containerFormat) {
         case 'ktx2':
           return parseKTX2File(fileConstructors.KTX2File, data, options);
@@ -105,7 +119,7 @@ export async function parseBasis(data: ArrayBuffer, options): Promise<TextureLev
       }
     case 'transcoder':
     default:
-      const {BasisFile} = await loadBasisTranscoderModule(options);
+      const {BasisFile} = await loadBasisTranscoderModule(options.core || {});
       return parseBasisFile(BasisFile, data, options);
   }
 }
@@ -117,7 +131,11 @@ export async function parseBasis(data: ArrayBuffer, options): Promise<TextureLev
  * @param options
  * @returns compressed texture data
  */
-function parseBasisFile(BasisFile, data, options): TextureLevel[][] {
+function parseBasisFile(
+  BasisFile,
+  data: ArrayBuffer,
+  options: BasisLoaderOptions
+): TextureLevel[][] {
   const basisFile = new BasisFile(new Uint8Array(data));
 
   try {
@@ -154,7 +172,12 @@ function parseBasisFile(BasisFile, data, options): TextureLevel[][] {
  * @param options
  * @returns compressed texture data
  */
-function transcodeImage(basisFile, imageIndex, levelIndex, options): TextureLevel {
+function transcodeImage(
+  basisFile,
+  imageIndex: number,
+  levelIndex: number,
+  options: BasisLoaderOptions
+): TextureLevel {
   const width = basisFile.getImageWidth(imageIndex, levelIndex);
   const height = basisFile.getImageHeight(imageIndex, levelIndex);
 
@@ -192,7 +215,7 @@ function transcodeImage(basisFile, imageIndex, levelIndex, options): TextureLeve
  * @param options
  * @returns compressed texture data
  */
-function parseKTX2File(KTX2File, data: ArrayBuffer, options): TextureLevel[][] {
+function parseKTX2File(KTX2File, data: ArrayBuffer, options: BasisLoaderOptions): TextureLevel[][] {
   const ktx2File = new KTX2File(new Uint8Array(data));
 
   try {
@@ -220,7 +243,11 @@ function parseKTX2File(KTX2File, data: ArrayBuffer, options): TextureLevel[][] {
  * @param options
  * @returns
  */
-function transcodeKTX2Image(ktx2File, levelIndex: number, options): TextureLevel {
+function transcodeKTX2Image(
+  ktx2File,
+  levelIndex: number,
+  options: BasisLoaderOptions
+): TextureLevel {
   const {alphaFlag, height, width} = ktx2File.getImageLevelInfo(levelIndex, 0, 0);
 
   // Check options for output format etc
@@ -269,8 +296,9 @@ function transcodeKTX2Image(ktx2File, levelIndex: number, options): TextureLevel
  * @param hasAlpha
  * @returns BasisFormat data
  */
-function getBasisOptions(options, hasAlpha: boolean): BasisOutputOptions {
-  let format = options && options.basis && options.basis.format;
+function getBasisOptions(options: BasisLoaderOptions, hasAlpha: boolean): BasisOutputOptions {
+  // TODO - any
+  let format: any = options.basis?.format;
   if (format === 'auto') {
     format = selectSupportedBasisFormat();
   }

package/src/npy-worker.ts

@@ -0,0 +1,6 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+// Classic-worker entrypoint that lazily loads the ESM worker implementation.
+import(new URL('./workers/npy-worker.js', import.meta.url).toString());

package/src/workers/compressed-texture-worker.ts

@@ -5,5 +5,4 @@
 import {createLoaderWorker} from '@loaders.gl/loader-utils';
 import {CompressedTextureLoader} from '../compressed-texture-loader';
 
-// @ts-expect-error
 createLoaderWorker(CompressedTextureLoader);