@loaders.gl/images 3.1.0-alpha.1 → 3.1.0-alpha.5

package/dist/{lib → esm/lib}/parsers/svg-utils.js

@@ -16,7 +16,7 @@ export function getBlobOrSVGDataUrl(arrayBuffer, url) {
       throw new Error(error.message);
     }
 
-    const src = `data:image/svg+xml;base64,${btoa(xmlText)}`;
+    const src = "data:image/svg+xml;base64,".concat(btoa(xmlText));
     return src;
   }
 

package/dist/esm/lib/parsers/svg-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/parsers/svg-utils.ts"],"names":["SVG_DATA_URL_PATTERN","SVG_URL_PATTERN","isSVG","url","test","getBlobOrSVGDataUrl","arrayBuffer","textDecoder","TextDecoder","xmlText","decode","unescape","encodeURIComponent","error","Error","message","src","btoa","getBlob","Blob","Uint8Array"],"mappings":"AAGA,MAAMA,oBAAoB,GAAG,uBAA7B;AACA,MAAMC,eAAe,GAAG,mBAAxB;AAEA,OAAO,SAASC,KAAT,CAAeC,GAAf,EAAoB;AACzB,SAAOA,GAAG,KAAKH,oBAAoB,CAACI,IAArB,CAA0BD,GAA1B,KAAkCF,eAAe,CAACG,IAAhB,CAAqBD,GAArB,CAAvC,CAAV;AACD;AAED,OAAO,SAASE,mBAAT,CAA6BC,WAA7B,EAAuDH,GAAvD,EAAoF;AACzF,MAAID,KAAK,CAACC,GAAD,CAAT,EAAgB;AAEd,UAAMI,WAAW,GAAG,IAAIC,WAAJ,EAApB;AACA,QAAIC,OAAO,GAAGF,WAAW,CAACG,MAAZ,CAAmBJ,WAAnB,CAAd;;AAEA,QAAI;AACF,UAAI,OAAOK,QAAP,KAAoB,UAApB,IAAkC,OAAOC,kBAAP,KAA8B,UAApE,EAAgF;AAC9EH,QAAAA,OAAO,GAAGE,QAAQ,CAACC,kBAAkB,CAACH,OAAD,CAAnB,CAAlB;AACD;AACF,KAJD,CAIE,OAAOI,KAAP,EAAc;AACd,YAAM,IAAIC,KAAJ,CAAWD,KAAD,CAAiBE,OAA3B,CAAN;AACD;;AAED,UAAMC,GAAG,uCAAgCC,IAAI,CAACR,OAAD,CAApC,CAAT;AACA,WAAOO,GAAP;AACD;;AACD,SAAOE,OAAO,CAACZ,WAAD,EAAcH,GAAd,CAAd;AACD;AAED,OAAO,SAASe,OAAT,CAAiBZ,WAAjB,EAA2CH,GAA3C,EAA+D;AACpE,MAAID,KAAK,CAACC,GAAD,CAAT,EAAgB;AAGd,UAAM,IAAIW,KAAJ,CAAU,8CAAV,CAAN;AACD;;AAED,SAAO,IAAIK,IAAJ,CAAS,CAAC,IAAIC,UAAJ,CAAed,WAAf,CAAD,CAAT,CAAP;AACD","sourcesContent":["// SVG parsing has limitations, e.g:\n// https://bugs.chromium.org/p/chromium/issues/detail?id=606319\n\nconst SVG_DATA_URL_PATTERN = /^data:image\\/svg\\+xml/;\nconst SVG_URL_PATTERN = /\\.svg((\\?|#).*)?$/;\n\nexport function isSVG(url) {\n  return url && (SVG_DATA_URL_PATTERN.test(url) || SVG_URL_PATTERN.test(url));\n}\n\nexport function getBlobOrSVGDataUrl(arrayBuffer: ArrayBuffer, url?: string): Blob | string {\n  if (isSVG(url)) {\n    // Prepare a properly tagged data URL, and load using normal mechanism\n    const textDecoder = new TextDecoder();\n    let xmlText = textDecoder.decode(arrayBuffer);\n    // TODO Escape in browser to support e.g. Chinese characters\n    try {\n      if (typeof unescape === 'function' && typeof encodeURIComponent === 'function') {\n        xmlText = unescape(encodeURIComponent(xmlText));\n      }\n    } catch (error) {\n      throw new Error((error as Error).message);\n    }\n    // base64 encoding is safer. utf-8 fails in some browsers\n    const src = `data:image/svg+xml;base64,${btoa(xmlText)}`;\n    return src;\n  }\n  return getBlob(arrayBuffer, url);\n}\n\nexport function getBlob(arrayBuffer: ArrayBuffer, url?: string): Blob {\n  if (isSVG(url)) {\n    // https://bugs.chromium.org/p/chromium/issues/detail?id=606319\n    // return new Blob([new Uint8Array(arrayBuffer)], {type: 'image/svg+xml'});\n    throw new Error('SVG cannot be parsed directly to imagebitmap');\n  }\n  // TODO - how to determine mime type? Param? Sniff here?\n  return new Blob([new Uint8Array(arrayBuffer)]); // MIME type not needed?\n}\n"],"file":"svg-utils.js"}

package/dist/esm/lib/texture-api/async-deep-map.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/texture-api/async-deep-map.ts"],"names":["isObject","value","asyncDeepMap","tree","func","options","mapSubtree","object","Array","isArray","mapArray","mapObject","url","promises","values","key","promise","then","push","Promise","all","urlArray","map"],"mappings":"AAgBA,MAAMA,QAAQ,GAAIC,KAAD,IAAWA,KAAK,IAAI,OAAOA,KAAP,KAAiB,QAAtD;;AAKA,OAAO,eAAeC,YAAf,CAA4BC,IAA5B,EAAkCC,IAAlC,EAAwCC,OAAO,GAAG,EAAlD,EAAsD;AAC3D,SAAO,MAAMC,UAAU,CAACH,IAAD,EAAOC,IAAP,EAAaC,OAAb,CAAvB;AACD;AAED,OAAO,eAAeC,UAAf,CAA0BC,MAA1B,EAAkCH,IAAlC,EAAwCC,OAAxC,EAAiD;AACtD,MAAIG,KAAK,CAACC,OAAN,CAAcF,MAAd,CAAJ,EAA2B;AACzB,WAAO,MAAMG,QAAQ,CAACH,MAAD,EAASH,IAAT,EAAeC,OAAf,CAArB;AACD;;AAED,MAAIL,QAAQ,CAACO,MAAD,CAAZ,EAAsB;AACpB,WAAO,MAAMI,SAAS,CAACJ,MAAD,EAASH,IAAT,EAAeC,OAAf,CAAtB;AACD;;AAGD,QAAMO,GAAG,GAAGL,MAAZ;AACA,SAAO,MAAMH,IAAI,CAACQ,GAAD,EAAMP,OAAN,CAAjB;AACD;;AAID,eAAeM,SAAf,CAAyBJ,MAAzB,EAAiCH,IAAjC,EAAuCC,OAAvC,EAAgD;AAC9C,QAAMQ,QAAwB,GAAG,EAAjC;AACA,QAAMC,MAAM,GAAG,EAAf;;AAEA,OAAK,MAAMC,GAAX,IAAkBR,MAAlB,EAA0B;AACxB,UAAMK,GAAG,GAAGL,MAAM,CAACQ,GAAD,CAAlB;AACA,UAAMC,OAAO,GAAGV,UAAU,CAACM,GAAD,EAAMR,IAAN,EAAYC,OAAZ,CAAV,CAA+BY,IAA/B,CAAqChB,KAAD,IAAW;AAC7Da,MAAAA,MAAM,CAACC,GAAD,CAAN,GAAcd,KAAd;AACD,KAFe,CAAhB;AAGAY,IAAAA,QAAQ,CAACK,IAAT,CAAcF,OAAd;AACD;;AAED,QAAMG,OAAO,CAACC,GAAR,CAAYP,QAAZ,CAAN;AAEA,SAAOC,MAAP;AACD;;AAED,eAAeJ,QAAf,CAAwBW,QAAxB,EAAkCjB,IAAlC,EAAwCC,OAAO,GAAG,EAAlD,EAAsD;AACpD,QAAMQ,QAAQ,GAAGQ,QAAQ,CAACC,GAAT,CAAcV,GAAD,IAASN,UAAU,CAACM,GAAD,EAAMR,IAAN,EAAYC,OAAZ,CAAhC,CAAjB;AACA,SAAO,MAAMc,OAAO,CAACC,GAAR,CAAYP,QAAZ,CAAb;AACD","sourcesContent":["/*\nAsynchronously maps a deep structure of values (e.g. objects and arrays of urls).\n\nE.g. a mipmapped cubemap\n{\n  [CUBE_FACE_FRONT]: [\n    \"image-front-0.jpg\",\n    \"image-front-1.jpg\",\n    \"image-front-2.jpg\",\n  ],\n  [CUBE_MAP_BACK]: [\n    ...\n  ]\n}\n*/\n\nconst isObject = (value) => value && typeof value === 'object';\n\n// Loads a deep structure of urls (objects and arrays of urls)\n// Returns an object with six key-value pairs containing the images (or image mip arrays)\n// for each cube face\nexport async function asyncDeepMap(tree, func, options = {}) {\n  return await mapSubtree(tree, func, options);\n}\n\nexport async function mapSubtree(object, func, options) {\n  if (Array.isArray(object)) {\n    return await mapArray(object, func, options);\n  }\n\n  if (isObject(object)) {\n    return await mapObject(object, func, options);\n  }\n\n  // TODO - ignore non-urls, non-arraybuffers?\n  const url = object;\n  return await func(url, options);\n}\n\n// HELPERS\n\nasync function mapObject(object, func, options) {\n  const promises: Promise<any>[] = [];\n  const values = {};\n\n  for (const key in object) {\n    const url = object[key];\n    const promise = mapSubtree(url, func, options).then((value) => {\n      values[key] = value;\n    });\n    promises.push(promise);\n  }\n\n  await Promise.all(promises);\n\n  return values;\n}\n\nasync function mapArray(urlArray, func, options = {}) {\n  const promises = urlArray.map((url) => mapSubtree(url, func, options));\n  return await Promise.all(promises);\n}\n"],"file":"async-deep-map.js"}

package/dist/esm/lib/texture-api/deep-load.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/texture-api/deep-load.ts"],"names":["asyncDeepMap","deepLoad","urlTree","load","options","url","shallowLoad","response","fetch","arrayBuffer"],"mappings":"AAAA,SAAQA,YAAR,QAA2B,kBAA3B;AAEA,OAAO,eAAeC,QAAf,CAAwBC,OAAxB,EAAiCC,IAAjC,EAAuCC,OAAvC,EAAgD;AACrD,SAAO,MAAMJ,YAAY,CAACE,OAAD,EAAWG,GAAD,IAASC,WAAW,CAACD,GAAD,EAAMF,IAAN,EAAYC,OAAZ,CAA9B,CAAzB;AACD;AAED,OAAO,eAAeE,WAAf,CAA2BD,GAA3B,EAAgCF,IAAhC,EAAsCC,OAAtC,EAA+C;AAEpD,QAAMG,QAAQ,GAAG,MAAMC,KAAK,CAACH,GAAD,EAAMD,OAAO,CAACI,KAAd,CAA5B;AACA,QAAMC,WAAW,GAAG,MAAMF,QAAQ,CAACE,WAAT,EAA1B;AACA,SAAO,MAAMN,IAAI,CAACM,WAAD,EAAcL,OAAd,CAAjB;AACD","sourcesContent":["import {asyncDeepMap} from './async-deep-map';\n\nexport async function deepLoad(urlTree, load, options) {\n  return await asyncDeepMap(urlTree, (url) => shallowLoad(url, load, options));\n}\n\nexport async function shallowLoad(url, load, options) {\n  // console.error('loading', url);\n  const response = await fetch(url, options.fetch);\n  const arrayBuffer = await response.arrayBuffer();\n  return await load(arrayBuffer, options);\n}\n"],"file":"deep-load.js"}

package/dist/{lib → esm/lib}/texture-api/generate-url.js

@@ -1,5 +1,4 @@
-import { resolvePath } from '@loaders.gl/loader-utils';
-import { assert } from '../utils/assert';
+import { resolvePath, assert } from '@loaders.gl/loader-utils';
 export function generateUrl(getUrl, options, urlOptions) {
   let url = getUrl;
 
@@ -15,7 +14,7 @@ export function generateUrl(getUrl, options, urlOptions) {
   } = options;
 
   if (baseUrl) {
-    url = baseUrl[baseUrl.length - 1] === '/' ? `${baseUrl}${url}` : `${baseUrl}/${url}`;
+    url = baseUrl[baseUrl.length - 1] === '/' ? "".concat(baseUrl).concat(url) : "".concat(baseUrl, "/").concat(url);
   }
 
   return resolvePath(url);

package/dist/esm/lib/texture-api/generate-url.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/texture-api/generate-url.ts"],"names":["resolvePath","assert","generateUrl","getUrl","options","urlOptions","url","baseUrl","length"],"mappings":"AAAA,SAAQA,WAAR,EAAqBC,MAArB,QAAkC,0BAAlC;AAGA,OAAO,SAASC,WAAT,CAAqBC,MAArB,EAA6BC,OAA7B,EAAsCC,UAAtC,EAAkD;AAEvD,MAAIC,GAAG,GAAGH,MAAV;;AACA,MAAI,OAAOA,MAAP,KAAkB,UAAtB,EAAkC;AAChCG,IAAAA,GAAG,GAAGH,MAAM,CAAC,EAAC,GAAGC,OAAJ;AAAa,SAAGC;AAAhB,KAAD,CAAZ;AACD;;AACDJ,EAAAA,MAAM,CAAC,OAAOK,GAAP,KAAe,QAAhB,CAAN;AAGA,QAAM;AAACC,IAAAA;AAAD,MAAYH,OAAlB;;AACA,MAAIG,OAAJ,EAAa;AACXD,IAAAA,GAAG,GAAGC,OAAO,CAACA,OAAO,CAACC,MAAR,GAAiB,CAAlB,CAAP,KAAgC,GAAhC,aAAyCD,OAAzC,SAAmDD,GAAnD,cAA8DC,OAA9D,cAAyED,GAAzE,CAAN;AACD;;AAED,SAAON,WAAW,CAACM,GAAD,CAAlB;AACD","sourcesContent":["import {resolvePath, assert} from '@loaders.gl/loader-utils';\n\n// Generate a url by calling getUrl with mix of options, applying options.baseUrl\nexport function generateUrl(getUrl, options, urlOptions) {\n  // Get url\n  let url = getUrl;\n  if (typeof getUrl === 'function') {\n    url = getUrl({...options, ...urlOptions});\n  }\n  assert(typeof url === 'string');\n\n  // Apply options.baseUrl\n  const {baseUrl} = options;\n  if (baseUrl) {\n    url = baseUrl[baseUrl.length - 1] === '/' ? `${baseUrl}${url}` : `${baseUrl}/${url}`;\n  }\n\n  return resolvePath(url);\n}\n"],"file":"generate-url.js"}

package/dist/{lib → esm/lib}/texture-api/load-image.js

@@ -1,4 +1,4 @@
-import { assert } from '../utils/assert';
+import { assert } from '@loaders.gl/loader-utils';
 import parseImage from '../parsers/parse-image';
 import { getImageSize } from '../category-api/parsed-image-api';
 import { generateUrl } from './generate-url';

package/dist/esm/lib/texture-api/load-image.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/texture-api/load-image.ts"],"names":["assert","parseImage","getImageSize","generateUrl","deepLoad","shallowLoad","loadImage","getUrl","options","imageUrls","getImageUrls","urlOptions","mipLevels","image","getMipmappedImageUrls","urls","url","lod","width","height","getMipLevels","push","mipLevel","length","Math","floor","log2","max"],"mappings":"AAAA,SAAQA,MAAR,QAAqB,0BAArB;AACA,OAAOC,UAAP,MAAuB,wBAAvB;AACA,SAAQC,YAAR,QAA2B,kCAA3B;AACA,SAAQC,WAAR,QAA0B,gBAA1B;AACA,SAAQC,QAAR,EAAkBC,WAAlB,QAAoC,aAApC;AAEA,OAAO,eAAeC,SAAf,CAAyBC,MAAzB,EAAiCC,OAAO,GAAG,EAA3C,EAA+C;AACpD,QAAMC,SAAS,GAAG,MAAMC,YAAY,CAACH,MAAD,EAASC,OAAT,CAApC;AACA,SAAO,MAAMJ,QAAQ,CAACK,SAAD,EAAYR,UAAZ,EAAwBO,OAAxB,CAArB;AACD;AAED,OAAO,eAAeE,YAAf,CAA4BH,MAA5B,EAAoCC,OAApC,EAA6CG,UAAU,GAAG,EAA1D,EAA8D;AACnE,QAAMC,SAAS,GAAIJ,OAAO,IAAIA,OAAO,CAACK,KAAnB,IAA4BL,OAAO,CAACK,KAAR,CAAcD,SAA3C,IAAyD,CAA3E;AACA,SAAOA,SAAS,KAAK,CAAd,GACH,MAAME,qBAAqB,CAACP,MAAD,EAASK,SAAT,EAAoBJ,OAApB,EAA6BG,UAA7B,CADxB,GAEHR,WAAW,CAACI,MAAD,EAASC,OAAT,EAAkBG,UAAlB,CAFf;AAGD;;AAED,eAAeG,qBAAf,CAAqCP,MAArC,EAA6CK,SAA7C,EAAwDJ,OAAxD,EAAiEG,UAAjE,EAA6E;AAC3E,QAAMI,IAAc,GAAG,EAAvB;;AAGA,MAAIH,SAAS,KAAK,MAAlB,EAA0B;AACxB,UAAMI,GAAG,GAAGb,WAAW,CAACI,MAAD,EAASC,OAAT,EAAkB,EAAC,GAAGG,UAAJ;AAAgBM,MAAAA,GAAG,EAAE;AAArB,KAAlB,CAAvB;AACA,UAAMJ,KAAK,GAAG,MAAMR,WAAW,CAACW,GAAD,EAAMf,UAAN,EAAkBO,OAAlB,CAA/B;AAEA,UAAM;AAACU,MAAAA,KAAD;AAAQC,MAAAA;AAAR,QAAkBjB,YAAY,CAACW,KAAD,CAApC;AACAD,IAAAA,SAAS,GAAGQ,YAAY,CAAC;AAACF,MAAAA,KAAD;AAAQC,MAAAA;AAAR,KAAD,CAAxB;AAGAJ,IAAAA,IAAI,CAACM,IAAL,CAAUL,GAAV;AACD;;AAGDhB,EAAAA,MAAM,CAACY,SAAS,GAAG,CAAb,CAAN;;AAEA,OAAK,IAAIU,QAAQ,GAAGP,IAAI,CAACQ,MAAzB,EAAiCD,QAAQ,GAAGV,SAA5C,EAAuD,EAAEU,QAAzD,EAAmE;AACjE,UAAMN,GAAG,GAAGb,WAAW,CAACI,MAAD,EAASC,OAAT,EAAkB,EAAC,GAAGG,UAAJ;AAAgBM,MAAAA,GAAG,EAAEK;AAArB,KAAlB,CAAvB;AACAP,IAAAA,IAAI,CAACM,IAAL,CAAUL,GAAV;AACD;;AAED,SAAOD,IAAP;AACD;;AAGD,OAAO,SAASK,YAAT,CAAsB;AAACF,EAAAA,KAAD;AAAQC,EAAAA;AAAR,CAAtB,EAAuC;AAC5C,SAAO,IAAIK,IAAI,CAACC,KAAL,CAAWD,IAAI,CAACE,IAAL,CAAUF,IAAI,CAACG,GAAL,CAAST,KAAT,EAAgBC,MAAhB,CAAV,CAAX,CAAX;AACD","sourcesContent":["import {assert} from '@loaders.gl/loader-utils';\nimport parseImage from '../parsers/parse-image';\nimport {getImageSize} from '../category-api/parsed-image-api';\nimport {generateUrl} from './generate-url';\nimport {deepLoad, shallowLoad} from './deep-load';\n\nexport async function loadImage(getUrl, options = {}) {\n  const imageUrls = await getImageUrls(getUrl, options);\n  return await deepLoad(imageUrls, parseImage, options);\n}\n\nexport async function getImageUrls(getUrl, options, urlOptions = {}) {\n  const mipLevels = (options && options.image && options.image.mipLevels) || 0;\n  return mipLevels !== 0\n    ? await getMipmappedImageUrls(getUrl, mipLevels, options, urlOptions)\n    : generateUrl(getUrl, options, urlOptions);\n}\n\nasync function getMipmappedImageUrls(getUrl, mipLevels, options, urlOptions) {\n  const urls: string[] = [];\n\n  // If no mip levels supplied, we need to load the level 0 image and calculate based on size\n  if (mipLevels === 'auto') {\n    const url = generateUrl(getUrl, options, {...urlOptions, lod: 0});\n    const image = await shallowLoad(url, parseImage, options);\n\n    const {width, height} = getImageSize(image);\n    mipLevels = getMipLevels({width, height});\n\n    // TODO - push image and make `deepLoad` pass through non-url values, avoid loading twice?\n    urls.push(url);\n  }\n\n  // We now know how many mipLevels we need, remaining image urls can now be constructed\n  assert(mipLevels > 0);\n\n  for (let mipLevel = urls.length; mipLevel < mipLevels; ++mipLevel) {\n    const url = generateUrl(getUrl, options, {...urlOptions, lod: mipLevel});\n    urls.push(url);\n  }\n\n  return urls;\n}\n\n// Calculates number of mipmaps based on texture size (log2)\nexport function getMipLevels({width, height}) {\n  return 1 + Math.floor(Math.log2(Math.max(width, height)));\n}\n"],"file":"load-image.js"}

package/dist/esm/lib/utils/version.js

@@ -0,0 +1,2 @@
+export const VERSION = typeof "3.1.0-alpha.5" !== 'undefined' ? "3.1.0-alpha.5" : 'latest';
+//# sourceMappingURL=version.js.map

package/dist/esm/lib/utils/version.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/lib/utils/version.ts"],"names":["VERSION"],"mappings":"AAGA,OAAO,MAAMA,OAAO,GAAG,2BAAuB,WAAvB,qBAAmD,QAAnE","sourcesContent":["// Version constant cannot be imported, it needs to correspond to the build version of **this** module.\n// __VERSION__ is injected by babel-plugin-version-inline\n// @ts-ignore TS2304: Cannot find name '__VERSION__'.\nexport const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';\n"],"file":"version.js"}

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[],"file":"types.js"}

package/dist/image-loader.d.ts

@@ -0,0 +1,25 @@
+import type { LoaderOptions, LoaderWithParser } from '@loaders.gl/loader-utils';
+import parseImage from './lib/parsers/parse-image';
+export declare type ImageLoaderOptions = LoaderOptions & {
+    image?: {
+        type?: 'auto' | 'data' | 'imagebitmap' | 'image';
+        decode?: boolean;
+    };
+    imagebitmap?: ImageBitmapOptions;
+};
+/**
+ * Loads a platform-specific image type
+ * Note: This type can be used as input data to WebGL texture creation
+ */
+export declare const ImageLoader: {
+    id: string;
+    module: string;
+    name: string;
+    version: any;
+    mimeTypes: string[];
+    extensions: string[];
+    parse: typeof parseImage;
+    tests: ((arrayBuffer: any) => boolean)[];
+    options: ImageLoaderOptions;
+};
+export declare const _typecheckImageLoader: LoaderWithParser;

package/dist/image-writer.d.ts

@@ -0,0 +1,15 @@
+import { encodeImage } from './lib/encoders/encode-image';
+export declare const ImageWriter: {
+    name: string;
+    id: string;
+    module: string;
+    version: any;
+    extensions: string[];
+    options: {
+        image: {
+            mimeType: string;
+            jpegQuality: null;
+        };
+    };
+    encode: typeof encodeImage;
+};

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export type { ImageDataType, ImageType, ImageTypeEnum } from './types';
+export type { ImageLoaderOptions } from './image-loader';
+export { ImageLoader } from './image-loader';
+export { ImageWriter } from './image-writer';
+export { getBinaryImageMetadata } from './lib/category-api/binary-image-api';
+export { isImageTypeSupported, getDefaultImageType } from './lib/category-api/image-type';
+export { isImage, getImageType, getImageSize, getImageData } from './lib/category-api/parsed-image-api';
+export { _isImageFormatSupported } from './lib/category-api/image-format';
+export { loadImage } from './lib/texture-api/load-image';

package/dist/lib/category-api/binary-image-api.d.ts

@@ -0,0 +1,18 @@
+/** MIME type, width and height extracted from binary compressed image data */
+export declare type BinaryImageMetadata = {
+    mimeType: string;
+    width: number;
+    height: number;
+};
+/**
+ * Extracts `{mimeType, width and height}` from a memory buffer containing a known image format
+ * Currently supports `image/png`, `image/jpeg`, `image/bmp` and `image/gif`.
+ * @param binaryData image file memory to parse
+ * @returns metadata or null if memory is not a valid image file format layout.
+ */
+export declare function getBinaryImageMetadata(binaryData: DataView | ArrayBuffer): BinaryImageMetadata | null;
+export declare function getBmpMetadata(binaryData: any): {
+    mimeType: string;
+    width: number;
+    height: number;
+} | null;

package/dist/lib/category-api/image-format.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Check if image MIME type is supported. Result is cached.
+ */
+export declare function _isImageFormatSupported(mimeType: string): boolean;

package/dist/lib/category-api/image-type.d.ts

@@ -0,0 +1,11 @@
+import type { ImageTypeEnum } from '../../types';
+/**
+ * Checks if a loaders.gl image type is supported
+ * @param type image type string
+ */
+export declare function isImageTypeSupported(type: string): boolean;
+/**
+ * Returns the "most performant" supported image type on this platform
+ * @returns image type string
+ */
+export declare function getDefaultImageType(): ImageTypeEnum;

package/dist/lib/category-api/parsed-image-api.d.ts

@@ -0,0 +1,9 @@
+import type { ImageType, ImageTypeEnum, ImageDataType } from '../../types';
+export declare function isImage(image: ImageType): boolean;
+export declare function deleteImage(image: ImageType): void;
+export declare function getImageType(image: ImageType): ImageTypeEnum;
+export declare function getImageSize(image: ImageType): {
+    width: number;
+    height: number;
+};
+export declare function getImageData(image: ImageType): ImageDataType | ImageData;

package/dist/lib/encoders/encode-image.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Returns data bytes representing a compressed image in PNG or JPG format,
+ * This data can be saved using file system (f) methods or used in a request.
+ * @param image - ImageBitmap Image or Canvas
+ * @param options
+ * param opt.type='png' - png, jpg or image/png, image/jpg are valid
+ * param mimeType= - Whether to include a data URI header
+ */
+export declare function encodeImage(image: any, options?: {
+    [key: string]: any;
+}): Promise<ArrayBuffer>;

package/dist/lib/parsers/parse-image.d.ts

@@ -0,0 +1,4 @@
+import type { LoaderContext } from '@loaders.gl/loader-utils';
+import type { ImageType } from '../../types';
+import type { ImageLoaderOptions } from '../../image-loader';
+export default function parseImage(arrayBuffer: ArrayBuffer, options?: ImageLoaderOptions, context?: LoaderContext): Promise<ImageType>;

package/dist/lib/parsers/parse-to-image-bitmap.d.ts

@@ -0,0 +1,9 @@
+import type { ImageLoaderOptions } from '../../image-loader';
+/**
+ * Asynchronously parses an array buffer into an ImageBitmap - this contains the decoded data
+ * ImageBitmaps are supported on worker threads, but not supported on Edge, IE11 and Safari
+ * https://developer.mozilla.org/en-US/docs/Web/API/ImageBitmap#Browser_compatibility
+ *
+ * TODO - createImageBitmap supports source rect (5 param overload), pass through?
+ */
+export default function parseToImageBitmap(arrayBuffer: ArrayBuffer, options: ImageLoaderOptions, url?: string): Promise<ImageBitmap>;

package/dist/lib/parsers/parse-to-image.d.ts

@@ -0,0 +1,3 @@
+import type { ImageLoaderOptions } from '../../image-loader';
+export default function parseToImage(arrayBuffer: ArrayBuffer, options: ImageLoaderOptions, url?: string): Promise<HTMLImageElement>;
+export declare function loadToImage(url: any, options: any): Promise<HTMLImageElement>;

package/dist/lib/parsers/parse-to-node-image.d.ts

@@ -0,0 +1,3 @@
+import type { ImageLoaderOptions } from '../../image-loader';
+import type { ImageDataType } from '../../types';
+export default function parseToNodeImage(arrayBuffer: ArrayBuffer, options: ImageLoaderOptions): Promise<ImageDataType>;

package/dist/lib/parsers/svg-utils.d.ts

@@ -0,0 +1,3 @@
+export declare function isSVG(url: any): any;
+export declare function getBlobOrSVGDataUrl(arrayBuffer: ArrayBuffer, url?: string): Blob | string;
+export declare function getBlob(arrayBuffer: ArrayBuffer, url?: string): Blob;

package/dist/lib/texture-api/async-deep-map.d.ts

@@ -0,0 +1,2 @@
+export declare function asyncDeepMap(tree: any, func: any, options?: {}): Promise<any>;
+export declare function mapSubtree(object: any, func: any, options: any): Promise<any>;

package/dist/lib/texture-api/deep-load.d.ts

@@ -0,0 +1,2 @@
+export declare function deepLoad(urlTree: any, load: any, options: any): Promise<any>;
+export declare function shallowLoad(url: any, load: any, options: any): Promise<any>;

package/dist/lib/texture-api/generate-url.d.ts

@@ -0,0 +1 @@
+export declare function generateUrl(getUrl: any, options: any, urlOptions: any): string;

package/dist/lib/texture-api/load-image.d.ts

@@ -0,0 +1,6 @@
+export declare function loadImage(getUrl: any, options?: {}): Promise<any>;
+export declare function getImageUrls(getUrl: any, options: any, urlOptions?: {}): Promise<string | string[]>;
+export declare function getMipLevels({ width, height }: {
+    width: any;
+    height: any;
+}): number;

package/dist/lib/utils/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION: any;

package/dist/types.d.ts

@@ -0,0 +1,17 @@
+/**
+ * data images
+ */
+export declare type ImageDataType = {
+    data: Uint8Array;
+    width: number;
+    height: number;
+    compressed?: boolean;
+};
+/**
+ * Supported Image Types
+ */
+export declare type ImageType = ImageBitmap | typeof Image | ImageDataType;
+/**
+ * Image type string used to control or determine the type of images returned from ImageLoader
+ */
+export declare type ImageTypeEnum = 'imagebitmap' | 'image' | 'data';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/images",
-  "version": "3.1.0-alpha.1",
+  "version": "3.1.0-alpha.5",
   "description": "Framework-independent loaders and writers for images (PNG, JPG, ...)",
   "license": "MIT",
   "publishConfig": {
@@ -18,9 +18,9 @@
     "point cloud",
     "PLY"
   ],
-  "types": "src/index.ts",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "main": "dist/es5/index.js",
+  "module": "dist/esm/index.js",
   "sideEffects": false,
   "files": [
     "src",
@@ -29,11 +29,12 @@
   ],
   "scripts": {
     "pre-build": "npm run build-bundle",
+    "post-build": "tsc",
     "build-bundle": "webpack  --display=minimal --config ../../scripts/webpack/bundle.js",
     "build-worker": "webpack --entry ./src/image-worker.js --output ./dist/image-worker.js --config ../../scripts/webpack/worker.js"
   },
   "dependencies": {
-    "@loaders.gl/loader-utils": "3.1.0-alpha.1"
+    "@loaders.gl/loader-utils": "3.1.0-alpha.5"
   },
-  "gitHead": "725f6ceeb9d76dacff6305f01bc45873680f17d5"
+  "gitHead": "352241dd910a8c6307a235dadbe154ca915b885b"
 }

package/src/bundle.ts

@@ -1,5 +1,4 @@
 // @ts-nocheck
 const moduleExports = require('./index');
-const _global = typeof window === 'undefined' ? global : window;
-_global.loaders = _global.loaders || {};
-module.exports = Object.assign(_global.loaders, moduleExports);
+globalThis.loaders = globalThis.loaders || {};
+module.exports = Object.assign(globalThis.loaders, moduleExports);

package/src/image-loader.ts

@@ -1,4 +1,4 @@
-import type {LoaderWithParser} from '@loaders.gl/loader-utils';
+import type {LoaderOptions, LoaderWithParser} from '@loaders.gl/loader-utils';
 import {VERSION} from './lib/utils/version';
 import parseImage from './lib/parsers/parse-image';
 import {getBinaryImageMetadata} from './lib/category-api/binary-image-api';
@@ -14,6 +14,22 @@ const MIME_TYPES = [
   'image/svg+xml'
 ];
 
+export type ImageLoaderOptions = LoaderOptions & {
+  image?: {
+    type?: 'auto' | 'data' | 'imagebitmap' | 'image';
+    decode?: boolean;
+  };
+  imagebitmap?: ImageBitmapOptions;
+};
+
+const DEFAULT_IMAGE_LOADER_OPTIONS: ImageLoaderOptions = {
+  image: {
+    type: 'auto',
+    decode: true // if format is HTML
+  }
+  // imagebitmap: {} - passes (platform dependent) parameters to ImageBitmap constructor
+};
+
 /**
  * Loads a platform-specific image type
  * Note: This type can be used as input data to WebGL texture creation
@@ -28,13 +44,7 @@ export const ImageLoader = {
   parse: parseImage,
   // TODO: byteOffset, byteLength;
   tests: [(arrayBuffer) => Boolean(getBinaryImageMetadata(new DataView(arrayBuffer)))],
-  options: {
-    image: {
-      type: 'auto',
-      decode: true // if format is HTML
-    }
-    // imagebitmap: {} - passes (platform dependent) parameters to ImageBitmap constructor
-  }
+  options: DEFAULT_IMAGE_LOADER_OPTIONS
 };
 
 export const _typecheckImageLoader: LoaderWithParser = ImageLoader;

package/src/index.ts

@@ -1,5 +1,6 @@
 // TYPES
 export type {ImageDataType, ImageType, ImageTypeEnum} from './types';
+export type {ImageLoaderOptions} from './image-loader';
 
 // LOADERS AND WRITERS
 export {ImageLoader} from './image-loader';
@@ -20,5 +21,8 @@ export {
   getImageData
 } from './lib/category-api/parsed-image-api';
 
+// EXPERIMENTAL
+export {_isImageFormatSupported} from './lib/category-api/image-format';
+
 // DEPRECATED - Remove in V3 (fix dependency in luma.gl)
 export {loadImage} from './lib/texture-api/load-image';

package/src/lib/category-api/image-format.ts

@@ -0,0 +1,66 @@
+import {isBrowser} from '@loaders.gl/loader-utils';
+
+// The following formats are supported by loaders.gl polyfills
+const NODE_FORMAT_SUPPORT = ['image/png', 'image/jpeg', 'image/gif'];
+
+/** Cache values for speed */
+const mimeTypeSupported: {[mimeType: string]: boolean} = {};
+
+/**
+ * Check if image MIME type is supported. Result is cached.
+ */
+export function _isImageFormatSupported(mimeType: string): boolean {
+  if (mimeTypeSupported[mimeType] === undefined) {
+    mimeTypeSupported[mimeType] = checkFormatSupport(mimeType);
+  }
+  return mimeTypeSupported[mimeType];
+}
+
+/**
+ * Check if image MIME type is supported.
+ */
+function checkFormatSupport(mimeType: string): boolean {
+  switch (mimeType) {
+    case 'image/webp':
+      return checkWebPSupport();
+    case 'image/svg':
+      return isBrowser;
+    default:
+      if (!isBrowser) {
+        // @ts-ignore
+        const {_parseImageNode} = globalThis;
+        return Boolean(_parseImageNode) && NODE_FORMAT_SUPPORT.includes(mimeType);
+      }
+      return true;
+  }
+}
+
+/** Check WebPSupport synchronously */
+function checkWebPSupport() {
+  if (!isBrowser) {
+    return false;
+  }
+  try {
+    const element = document.createElement('canvas');
+    return element.toDataURL('image/webp').indexOf('data:image/webp') === 0;
+  } catch {
+    // Probably Safari...
+    return false;
+  }
+}
+
+// Note: better test but asynchronous
+
+// Lossy test image. Support for lossy images doesn't guarantee support for all WebP images.
+// https://stackoverflow.com/questions/5573096/detecting-webp-support
+// const WEBP_TEST_IMAGE = 'data:image/webp;base64,UklGRiIAAABXRUJQVlA4IBYAAAAwAQCdASoBAAEADsD+JaQAA3AAAAAA';
+
+// Check WebPSupport asynchronously
+// async function isWebPSupported() {
+//   return new Promise( resolve => {
+//     const image = new Image();
+//     image.src = WEBP_TEST_IMAGE;
+//     image.onload = image.onerror = function () {
+//     resolve( image.height === 1 );
+//   }
+// }

package/src/lib/category-api/image-type.ts

@@ -1,8 +1,8 @@
+import {isBrowser} from '@loaders.gl/loader-utils';
 import type {ImageTypeEnum} from '../../types';
-import {global, isBrowser} from '../utils/globals';
 
 // @ts-ignore TS2339: Property does not exist on type
-const {_parseImageNode} = global;
+const {_parseImageNode} = globalThis;
 
 const IMAGE_SUPPORTED = typeof Image !== 'undefined'; // NOTE: "false" positives if jsdom is installed
 const IMAGE_BITMAP_SUPPORTED = typeof ImageBitmap !== 'undefined';

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

@@ -1,9 +1,8 @@
 // Image loading/saving for browser and Node.js
-import {global} from '../utils/globals';
 import {getImageSize} from '../category-api/parsed-image-api';
 
 // @ts-ignore TS2339: Property does not exist on type
-const {_encodeImageNode} = global;
+const {_encodeImageNode} = globalThis;
 
 /**
  * Returns data bytes representing a compressed image in PNG or JPG format,

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

@@ -1,4 +1,7 @@
-import {assert} from '../utils/assert';
+import type {LoaderContext} from '@loaders.gl/loader-utils';
+import {assert} from '@loaders.gl/loader-utils';
+import type {ImageType} from '../../types';
+import type {ImageLoaderOptions} from '../../image-loader';
 import {isImageTypeSupported, getDefaultImageType} from '../category-api/image-type';
 import {getImageData} from '../category-api/parsed-image-api';
 import parseToImage from './parse-to-image';
@@ -7,7 +10,11 @@ import parseToNodeImage from './parse-to-node-image';
 
 // Parse to platform defined image type (data on node, ImageBitmap or HTMLImage on browser)
 // eslint-disable-next-line complexity
-export default async function parseImage(arrayBuffer, options, context) {
+export default async function parseImage(
+  arrayBuffer: ArrayBuffer,
+  options?: ImageLoaderOptions,
+  context?: LoaderContext
+): Promise<ImageType> {
   options = options || {};
   const imageOptions = options.image || {};
 

package/src/lib/parsers/parse-to-image-bitmap.ts

@@ -1,3 +1,4 @@
+import type {ImageLoaderOptions} from '../../image-loader';
 import {isSVG, getBlob} from './svg-utils';
 import parseToImage from './parse-to-image';
 
@@ -12,7 +13,11 @@ let imagebitmapOptionsSupported = true;
  *
  * TODO - createImageBitmap supports source rect (5 param overload), pass through?
  */
-export default async function parseToImageBitmap(arrayBuffer, options, url) {
+export default async function parseToImageBitmap(
+  arrayBuffer: ArrayBuffer,
+  options: ImageLoaderOptions,
+  url?: string
+): Promise<ImageBitmap> {
   let blob;
 
   // Cannot parse SVG directly to ImageBitmap, parse to Image first
@@ -36,7 +41,10 @@ export default async function parseToImageBitmap(arrayBuffer, options, url) {
  * Firefox crashes if imagebitmapOptions is supplied
  * Avoid supplying if not provided or supported, remember if not supported
  */
-async function safeCreateImageBitmap(blob, imagebitmapOptions = null) {
+async function safeCreateImageBitmap(
+  blob: Blob,
+  imagebitmapOptions: ImageBitmapOptions | null = null
+): Promise<ImageBitmap> {
   if (isEmptyObject(imagebitmapOptions) || !imagebitmapOptionsSupported) {
     imagebitmapOptions = null;
   }

package/src/lib/parsers/parse-to-image.ts

@@ -1,7 +1,12 @@
+import type {ImageLoaderOptions} from '../../image-loader';
 import {getBlobOrSVGDataUrl} from './svg-utils';
 
 // Parses html image from array buffer
-export default async function parseToImage(arrayBuffer, options, url) {
+export default async function parseToImage(
+  arrayBuffer: ArrayBuffer,
+  options: ImageLoaderOptions,
+  url?: string
+): Promise<HTMLImageElement> {
   // Note: image parsing requires conversion to Blob (for createObjectURL).
   // Potentially inefficient for not using `response.blob()` (and for File / Blob inputs)...
   // But presumably not worth adding 'blob' flag to loader objects?
@@ -18,7 +23,7 @@ export default async function parseToImage(arrayBuffer, options, url) {
   }
 }
 
-export async function loadToImage(url, options) {
+export async function loadToImage(url, options): Promise<HTMLImageElement> {
   const image = new Image();
   image.src = url;
 

package/src/lib/parsers/parse-to-node-image.ts

@@ -1,14 +1,32 @@
-import {global} from '../utils/globals';
-import {assert} from '../utils/assert';
+import type {ImageLoaderOptions} from '../../image-loader';
+import type {ImageDataType} from '../../types';
+import {assert} from '@loaders.gl/loader-utils';
 import {getBinaryImageMetadata} from '../category-api/binary-image-api';
 
-// Use polyfills if installed to p[arsed image using get-pixels
-export default function parseToNodeImage(arrayBuffer, options) {
+// Note: These types should be consistent with loaders.gl/polyfills
+
+type NDArray = {
+  shape: number[];
+  data: Uint8Array;
+  width: number;
+  height: number;
+  components: number;
+  layers: number[];
+};
+
+type ParseImageNode = (arrayBuffer: ArrayBuffer, mimeType: string) => Promise<NDArray>;
+
+// Use polyfills if installed to parsed image using get-pixels
+export default async function parseToNodeImage(
+  arrayBuffer: ArrayBuffer,
+  options: ImageLoaderOptions
+): Promise<ImageDataType> {
   const {mimeType} = getBinaryImageMetadata(arrayBuffer) || {};
 
   // @ts-ignore
-  const {_parseImageNode} = global;
+  const _parseImageNode: ParseImageNode = globalThis._parseImageNode;
   assert(_parseImageNode); // '@loaders.gl/polyfills not installed'
 
-  return _parseImageNode(arrayBuffer, mimeType, options);
+  // @ts-expect-error TODO should we throw error in this case?
+  return await _parseImageNode(arrayBuffer, mimeType);
 }

package/src/lib/parsers/svg-utils.ts

@@ -8,7 +8,7 @@ export function isSVG(url) {
   return url && (SVG_DATA_URL_PATTERN.test(url) || SVG_URL_PATTERN.test(url));
 }
 
-export function getBlobOrSVGDataUrl(arrayBuffer, url) {
+export function getBlobOrSVGDataUrl(arrayBuffer: ArrayBuffer, url?: string): Blob | string {
   if (isSVG(url)) {
     // Prepare a properly tagged data URL, and load using normal mechanism
     const textDecoder = new TextDecoder();
@@ -28,7 +28,7 @@ export function getBlobOrSVGDataUrl(arrayBuffer, url) {
   return getBlob(arrayBuffer, url);
 }
 
-export function getBlob(arrayBuffer, url) {
+export function getBlob(arrayBuffer: ArrayBuffer, url?: string): Blob {
   if (isSVG(url)) {
     // https://bugs.chromium.org/p/chromium/issues/detail?id=606319
     // return new Blob([new Uint8Array(arrayBuffer)], {type: 'image/svg+xml'});

package/src/lib/texture-api/generate-url.ts

@@ -1,5 +1,4 @@
-import {resolvePath} from '@loaders.gl/loader-utils';
-import {assert} from '../utils/assert';
+import {resolvePath, assert} from '@loaders.gl/loader-utils';
 
 // Generate a url by calling getUrl with mix of options, applying options.baseUrl
 export function generateUrl(getUrl, options, urlOptions) {