@loaders.gl/images 3.1.0-alpha.2 → 3.1.0-beta.1

package/dist/image-loader.js

@@ -1,23 +1,43 @@
-import { VERSION } from './lib/utils/version';
-import parseImage from './lib/parsers/parse-image';
-import { getBinaryImageMetadata } from './lib/category-api/binary-image-api';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._typecheckImageLoader = exports.ImageLoader = void 0;
+const version_1 = require("./lib/utils/version");
+const parse_image_1 = __importDefault(require("./lib/parsers/parse-image"));
+const binary_image_api_1 = require("./lib/category-api/binary-image-api");
 const EXTENSIONS = ['png', 'jpg', 'jpeg', 'gif', 'webp', 'bmp', 'ico', 'svg'];
-const MIME_TYPES = ['image/png', 'image/jpeg', 'image/gif', 'image/webp', 'image/bmp', 'image/vnd.microsoft.icon', 'image/svg+xml'];
-export const ImageLoader = {
-  id: 'image',
-  module: 'images',
-  name: 'Images',
-  version: VERSION,
-  mimeTypes: MIME_TYPES,
-  extensions: EXTENSIONS,
-  parse: parseImage,
-  tests: [arrayBuffer => Boolean(getBinaryImageMetadata(new DataView(arrayBuffer)))],
-  options: {
+const MIME_TYPES = [
+    'image/png',
+    'image/jpeg',
+    'image/gif',
+    'image/webp',
+    'image/bmp',
+    'image/vnd.microsoft.icon',
+    'image/svg+xml'
+];
+const DEFAULT_IMAGE_LOADER_OPTIONS = {
     image: {
-      type: 'auto',
-      decode: true
+        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
+ */
+exports.ImageLoader = {
+    id: 'image',
+    module: 'images',
+    name: 'Images',
+    version: version_1.VERSION,
+    mimeTypes: MIME_TYPES,
+    extensions: EXTENSIONS,
+    parse: parse_image_1.default,
+    // TODO: byteOffset, byteLength;
+    tests: [(arrayBuffer) => Boolean((0, binary_image_api_1.getBinaryImageMetadata)(new DataView(arrayBuffer)))],
+    options: DEFAULT_IMAGE_LOADER_OPTIONS
 };
-export const _typecheckImageLoader = ImageLoader;
-//# sourceMappingURL=image-loader.js.map
+exports._typecheckImageLoader = exports.ImageLoader;

package/dist/image-writer.d.ts

@@ -0,0 +1,16 @@
+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;
+};
+//# sourceMappingURL=image-writer.d.ts.map

package/dist/image-writer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-writer.d.ts","sourceRoot":"","sources":["../src/image-writer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,WAAW,EAAC,MAAM,6BAA6B,CAAC;AAExD,eAAO,MAAM,WAAW;;;;;;;;;;;;;CAavB,CAAC"}

package/dist/image-writer.js

@@ -1,17 +1,20 @@
-import { VERSION } from './lib/utils/version';
-import { encodeImage } from './lib/encoders/encode-image';
-export const ImageWriter = {
-  name: 'Images',
-  id: 'image',
-  module: 'images',
-  version: VERSION,
-  extensions: ['jpeg'],
-  options: {
-    image: {
-      mimeType: 'image/png',
-      jpegQuality: null
-    }
-  },
-  encode: encodeImage
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ImageWriter = void 0;
+// import type {Writer} from '@loaders.gl/loader-utils';
+const version_1 = require("./lib/utils/version");
+const encode_image_1 = require("./lib/encoders/encode-image");
+exports.ImageWriter = {
+    name: 'Images',
+    id: 'image',
+    module: 'images',
+    version: version_1.VERSION,
+    extensions: ['jpeg'],
+    options: {
+        image: {
+            mimeType: 'image/png',
+            jpegQuality: null
+        }
+    },
+    encode: encode_image_1.encodeImage
 };
-//# sourceMappingURL=image-writer.js.map

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+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';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EAAC,aAAa,EAAE,SAAS,EAAE,aAAa,EAAC,MAAM,SAAS,CAAC;AACrE,YAAY,EAAC,kBAAkB,EAAC,MAAM,gBAAgB,CAAC;AAGvD,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAK3C,OAAO,EAAC,sBAAsB,EAAC,MAAM,qCAAqC,CAAC;AAG3E,OAAO,EAAC,oBAAoB,EAAE,mBAAmB,EAAC,MAAM,+BAA+B,CAAC;AAExF,OAAO,EACL,OAAO,EACP,YAAY,EACZ,YAAY,EACZ,YAAY,EACb,MAAM,qCAAqC,CAAC;AAG7C,OAAO,EAAC,uBAAuB,EAAC,MAAM,iCAAiC,CAAC;AAGxE,OAAO,EAAC,SAAS,EAAC,MAAM,8BAA8B,CAAC"}

package/dist/index.js

@@ -1,7 +1,27 @@
-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 { loadImage } from './lib/texture-api/load-image';
-//# sourceMappingURL=index.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadImage = exports._isImageFormatSupported = exports.getImageData = exports.getImageSize = exports.getImageType = exports.isImage = exports.getDefaultImageType = exports.isImageTypeSupported = exports.getBinaryImageMetadata = exports.ImageWriter = exports.ImageLoader = void 0;
+// LOADERS AND WRITERS
+var image_loader_1 = require("./image-loader");
+Object.defineProperty(exports, "ImageLoader", { enumerable: true, get: function () { return image_loader_1.ImageLoader; } });
+var image_writer_1 = require("./image-writer");
+Object.defineProperty(exports, "ImageWriter", { enumerable: true, get: function () { return image_writer_1.ImageWriter; } });
+// IMAGE CATEGORY API
+// Binary Image API
+var binary_image_api_1 = require("./lib/category-api/binary-image-api");
+Object.defineProperty(exports, "getBinaryImageMetadata", { enumerable: true, get: function () { return binary_image_api_1.getBinaryImageMetadata; } });
+// Parsed Image API
+var image_type_1 = require("./lib/category-api/image-type");
+Object.defineProperty(exports, "isImageTypeSupported", { enumerable: true, get: function () { return image_type_1.isImageTypeSupported; } });
+Object.defineProperty(exports, "getDefaultImageType", { enumerable: true, get: function () { return image_type_1.getDefaultImageType; } });
+var parsed_image_api_1 = require("./lib/category-api/parsed-image-api");
+Object.defineProperty(exports, "isImage", { enumerable: true, get: function () { return parsed_image_api_1.isImage; } });
+Object.defineProperty(exports, "getImageType", { enumerable: true, get: function () { return parsed_image_api_1.getImageType; } });
+Object.defineProperty(exports, "getImageSize", { enumerable: true, get: function () { return parsed_image_api_1.getImageSize; } });
+Object.defineProperty(exports, "getImageData", { enumerable: true, get: function () { return parsed_image_api_1.getImageData; } });
+// EXPERIMENTAL
+var image_format_1 = require("./lib/category-api/image-format");
+Object.defineProperty(exports, "_isImageFormatSupported", { enumerable: true, get: function () { return image_format_1._isImageFormatSupported; } });
+// DEPRECATED - Remove in V3 (fix dependency in luma.gl)
+var load_image_1 = require("./lib/texture-api/load-image");
+Object.defineProperty(exports, "loadImage", { enumerable: true, get: function () { return load_image_1.loadImage; } });

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

@@ -0,0 +1,19 @@
+/** 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;
+//# sourceMappingURL=binary-image-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"binary-image-api.d.ts","sourceRoot":"","sources":["../../../src/lib/category-api/binary-image-api.ts"],"names":[],"mappings":"AAQA,8EAA8E;AAC9E,oBAAY,mBAAmB,GAAG;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAKF;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,QAAQ,GAAG,WAAW,GACjC,mBAAmB,GAAG,IAAI,CAQ5B;AA2CD,wBAAgB,cAAc,CAAC,UAAU,KAAA;;;;SAmBxC"}

package/dist/lib/category-api/binary-image-api.js

@@ -1,118 +1,141 @@
+"use strict";
+// Attributions
+// * Based on binary-gltf-utils under MIT license: Copyright (c) 2016-17 Karl Cheng
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBmpMetadata = exports.getBinaryImageMetadata = void 0;
 const BIG_ENDIAN = false;
 const LITTLE_ENDIAN = true;
-export function getBinaryImageMetadata(binaryData) {
-  const dataView = toDataView(binaryData);
-  return getPngMetadata(dataView) || getJpegMetadata(dataView) || getGifMetadata(dataView) || getBmpMetadata(dataView);
+/**
+ * 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.
+ */
+function getBinaryImageMetadata(binaryData) {
+    const dataView = toDataView(binaryData);
+    return (getPngMetadata(dataView) ||
+        getJpegMetadata(dataView) ||
+        getGifMetadata(dataView) ||
+        getBmpMetadata(dataView));
 }
-
+exports.getBinaryImageMetadata = getBinaryImageMetadata;
+// PNG
 function getPngMetadata(binaryData) {
-  const dataView = toDataView(binaryData);
-  const isPng = dataView.byteLength >= 24 && dataView.getUint32(0, BIG_ENDIAN) === 0x89504e47;
-
-  if (!isPng) {
-    return null;
-  }
-
-  return {
-    mimeType: 'image/png',
-    width: dataView.getUint32(16, BIG_ENDIAN),
-    height: dataView.getUint32(20, BIG_ENDIAN)
-  };
+    const dataView = toDataView(binaryData);
+    // Check file contains the first 4 bytes of the PNG signature.
+    const isPng = dataView.byteLength >= 24 && dataView.getUint32(0, BIG_ENDIAN) === 0x89504e47;
+    if (!isPng) {
+        return null;
+    }
+    // Extract size from a binary PNG file
+    return {
+        mimeType: 'image/png',
+        width: dataView.getUint32(16, BIG_ENDIAN),
+        height: dataView.getUint32(20, BIG_ENDIAN)
+    };
 }
-
+// GIF
+// Extract size from a binary GIF file
+// TODO: GIF is not this simple
 function getGifMetadata(binaryData) {
-  const dataView = toDataView(binaryData);
-  const isGif = dataView.byteLength >= 10 && dataView.getUint32(0, BIG_ENDIAN) === 0x47494638;
-
-  if (!isGif) {
-    return null;
-  }
-
-  return {
-    mimeType: 'image/gif',
-    width: dataView.getUint16(6, LITTLE_ENDIAN),
-    height: dataView.getUint16(8, LITTLE_ENDIAN)
-  };
+    const dataView = toDataView(binaryData);
+    // Check first 4 bytes of the GIF signature ("GIF8").
+    const isGif = dataView.byteLength >= 10 && dataView.getUint32(0, BIG_ENDIAN) === 0x47494638;
+    if (!isGif) {
+        return null;
+    }
+    // GIF is little endian.
+    return {
+        mimeType: 'image/gif',
+        width: dataView.getUint16(6, LITTLE_ENDIAN),
+        height: dataView.getUint16(8, LITTLE_ENDIAN)
+    };
 }
-
-export function getBmpMetadata(binaryData) {
-  const dataView = toDataView(binaryData);
-  const isBmp = dataView.byteLength >= 14 && dataView.getUint16(0, BIG_ENDIAN) === 0x424d && dataView.getUint32(2, LITTLE_ENDIAN) === dataView.byteLength;
-
-  if (!isBmp) {
-    return null;
-  }
-
-  return {
-    mimeType: 'image/bmp',
-    width: dataView.getUint32(18, LITTLE_ENDIAN),
-    height: dataView.getUint32(22, LITTLE_ENDIAN)
-  };
+// BMP
+// TODO: BMP is not this simple
+function getBmpMetadata(binaryData) {
+    const dataView = toDataView(binaryData);
+    // Check magic number is valid (first 2 characters should be "BM").
+    // The mandatory bitmap file header is 14 bytes long.
+    const isBmp = dataView.byteLength >= 14 &&
+        dataView.getUint16(0, BIG_ENDIAN) === 0x424d &&
+        dataView.getUint32(2, LITTLE_ENDIAN) === dataView.byteLength;
+    if (!isBmp) {
+        return null;
+    }
+    // BMP is little endian.
+    return {
+        mimeType: 'image/bmp',
+        width: dataView.getUint32(18, LITTLE_ENDIAN),
+        height: dataView.getUint32(22, LITTLE_ENDIAN)
+    };
 }
-
+exports.getBmpMetadata = getBmpMetadata;
+// JPEG
+// Extract width and height from a binary JPEG file
 function getJpegMetadata(binaryData) {
-  const dataView = toDataView(binaryData);
-  const isJpeg = dataView.byteLength >= 3 && dataView.getUint16(0, BIG_ENDIAN) === 0xffd8 && dataView.getUint8(2) === 0xff;
-
-  if (!isJpeg) {
-    return null;
-  }
-
-  const {
-    tableMarkers,
-    sofMarkers
-  } = getJpegMarkers();
-  let i = 2;
-
-  while (i + 9 < dataView.byteLength) {
-    const marker = dataView.getUint16(i, BIG_ENDIAN);
-
-    if (sofMarkers.has(marker)) {
-      return {
-        mimeType: 'image/jpeg',
-        height: dataView.getUint16(i + 5, BIG_ENDIAN),
-        width: dataView.getUint16(i + 7, BIG_ENDIAN)
-      };
+    const dataView = toDataView(binaryData);
+    // Check file contains the JPEG "start of image" (SOI) marker
+    // followed by another marker.
+    const isJpeg = dataView.byteLength >= 3 &&
+        dataView.getUint16(0, BIG_ENDIAN) === 0xffd8 &&
+        dataView.getUint8(2) === 0xff;
+    if (!isJpeg) {
+        return null;
     }
-
-    if (!tableMarkers.has(marker)) {
-      return null;
+    const { tableMarkers, sofMarkers } = getJpegMarkers();
+    // Exclude the two byte SOI marker.
+    let i = 2;
+    while (i + 9 < dataView.byteLength) {
+        const marker = dataView.getUint16(i, BIG_ENDIAN);
+        // The frame that contains the width and height of the JPEG image.
+        if (sofMarkers.has(marker)) {
+            return {
+                mimeType: 'image/jpeg',
+                height: dataView.getUint16(i + 5, BIG_ENDIAN),
+                width: dataView.getUint16(i + 7, BIG_ENDIAN) // Number of pixels per line
+            };
+        }
+        // Miscellaneous tables/data preceding the frame header.
+        if (!tableMarkers.has(marker)) {
+            return null;
+        }
+        // Length includes size of length parameter but not the two byte header.
+        i += 2;
+        i += dataView.getUint16(i, BIG_ENDIAN);
     }
-
-    i += 2;
-    i += dataView.getUint16(i, BIG_ENDIAN);
-  }
-
-  return null;
+    return null;
 }
-
 function getJpegMarkers() {
-  const tableMarkers = new Set([0xffdb, 0xffc4, 0xffcc, 0xffdd, 0xfffe]);
-
-  for (let i = 0xffe0; i < 0xfff0; ++i) {
-    tableMarkers.add(i);
-  }
-
-  const sofMarkers = new Set([0xffc0, 0xffc1, 0xffc2, 0xffc3, 0xffc5, 0xffc6, 0xffc7, 0xffc9, 0xffca, 0xffcb, 0xffcd, 0xffce, 0xffcf, 0xffde]);
-  return {
-    tableMarkers,
-    sofMarkers
-  };
+    // Tables/misc header markers.
+    // DQT, DHT, DAC, DRI, COM, APP_n
+    const tableMarkers = new Set([0xffdb, 0xffc4, 0xffcc, 0xffdd, 0xfffe]);
+    for (let i = 0xffe0; i < 0xfff0; ++i) {
+        tableMarkers.add(i);
+    }
+    // SOF markers and DHP marker.
+    // These markers are after tables/misc data.
+    const sofMarkers = new Set([
+        0xffc0, 0xffc1, 0xffc2, 0xffc3, 0xffc5, 0xffc6, 0xffc7, 0xffc9, 0xffca, 0xffcb, 0xffcd, 0xffce,
+        0xffcf, 0xffde
+    ]);
+    return { tableMarkers, sofMarkers };
 }
-
+// TODO - move into image module?
 function toDataView(data) {
-  if (data instanceof DataView) {
-    return data;
-  }
-
-  if (ArrayBuffer.isView(data)) {
-    return new DataView(data.buffer);
-  }
-
-  if (data instanceof ArrayBuffer) {
-    return new DataView(data);
-  }
-
-  throw new Error('toDataView');
+    if (data instanceof DataView) {
+        return data;
+    }
+    if (ArrayBuffer.isView(data)) {
+        return new DataView(data.buffer);
+    }
+    // TODO: make these functions work for Node.js buffers?
+    // if (bufferToArrayBuffer) {
+    //   data = bufferToArrayBuffer(data);
+    // }
+    // Careful - Node Buffers will look like ArrayBuffers (keep after isBuffer)
+    if (data instanceof ArrayBuffer) {
+        return new DataView(data);
+    }
+    throw new Error('toDataView');
 }
-//# sourceMappingURL=binary-image-api.js.map

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

@@ -0,0 +1,5 @@
+/**
+ * Check if image MIME type is supported. Result is cached.
+ */
+export declare function _isImageFormatSupported(mimeType: string): boolean;
+//# sourceMappingURL=image-format.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"image-format.d.ts","sourceRoot":"","sources":["../../../src/lib/category-api/image-format.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAKjE"}

package/dist/lib/category-api/image-format.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._isImageFormatSupported = void 0;
+const loader_utils_1 = require("@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 = {};
+/**
+ * Check if image MIME type is supported. Result is cached.
+ */
+function _isImageFormatSupported(mimeType) {
+    if (mimeTypeSupported[mimeType] === undefined) {
+        mimeTypeSupported[mimeType] = checkFormatSupport(mimeType);
+    }
+    return mimeTypeSupported[mimeType];
+}
+exports._isImageFormatSupported = _isImageFormatSupported;
+/**
+ * Check if image MIME type is supported.
+ */
+function checkFormatSupport(mimeType) {
+    switch (mimeType) {
+        case 'image/webp':
+            return checkWebPSupport();
+        case 'image/svg':
+            return loader_utils_1.isBrowser;
+        default:
+            if (!loader_utils_1.isBrowser) {
+                // @ts-ignore
+                const { _parseImageNode } = globalThis;
+                return Boolean(_parseImageNode) && NODE_FORMAT_SUPPORT.includes(mimeType);
+            }
+            return true;
+    }
+}
+/** Check WebPSupport synchronously */
+function checkWebPSupport() {
+    if (!loader_utils_1.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/dist/lib/category-api/image-type.d.ts

@@ -0,0 +1,12 @@
+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;
+//# sourceMappingURL=image-type.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"image-type.d.ts","sourceRoot":"","sources":["../../../src/lib/category-api/image-type.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,aAAa,CAAC;AAU/C;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAgB1D;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,aAAa,CAanD"}

package/dist/lib/category-api/image-type.js

@@ -1,42 +1,48 @@
-import { global, isBrowser } from '../utils/globals';
-const {
-  _parseImageNode
-} = global;
-const IMAGE_SUPPORTED = typeof Image !== 'undefined';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultImageType = exports.isImageTypeSupported = void 0;
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+// @ts-ignore TS2339: Property does not exist on type
+const { _parseImageNode } = globalThis;
+const IMAGE_SUPPORTED = typeof Image !== 'undefined'; // NOTE: "false" positives if jsdom is installed
 const IMAGE_BITMAP_SUPPORTED = typeof ImageBitmap !== 'undefined';
 const NODE_IMAGE_SUPPORTED = Boolean(_parseImageNode);
-const DATA_SUPPORTED = isBrowser ? true : NODE_IMAGE_SUPPORTED;
-export function isImageTypeSupported(type) {
-  switch (type) {
-    case 'auto':
-      return IMAGE_BITMAP_SUPPORTED || IMAGE_SUPPORTED || DATA_SUPPORTED;
-
-    case 'imagebitmap':
-      return IMAGE_BITMAP_SUPPORTED;
-
-    case 'image':
-      return IMAGE_SUPPORTED;
-
-    case 'data':
-      return DATA_SUPPORTED;
-
-    default:
-      throw new Error(`@loaders.gl/images: image ${type} not supported in this environment`);
-  }
+const DATA_SUPPORTED = loader_utils_1.isBrowser ? true : NODE_IMAGE_SUPPORTED;
+/**
+ * Checks if a loaders.gl image type is supported
+ * @param type image type string
+ */
+function isImageTypeSupported(type) {
+    switch (type) {
+        case 'auto':
+            // Should only ever be false in Node.js, if polyfills have not been installed...
+            return IMAGE_BITMAP_SUPPORTED || IMAGE_SUPPORTED || DATA_SUPPORTED;
+        case 'imagebitmap':
+            return IMAGE_BITMAP_SUPPORTED;
+        case 'image':
+            return IMAGE_SUPPORTED;
+        case 'data':
+            return DATA_SUPPORTED;
+        default:
+            throw new Error(`@loaders.gl/images: image ${type} not supported in this environment`);
+    }
 }
-export function getDefaultImageType() {
-  if (IMAGE_BITMAP_SUPPORTED) {
-    return 'imagebitmap';
-  }
-
-  if (IMAGE_SUPPORTED) {
-    return 'image';
-  }
-
-  if (DATA_SUPPORTED) {
-    return 'data';
-  }
-
-  throw new Error('Install \'@loaders.gl/polyfills\' to parse images under Node.js');
+exports.isImageTypeSupported = isImageTypeSupported;
+/**
+ * Returns the "most performant" supported image type on this platform
+ * @returns image type string
+ */
+function getDefaultImageType() {
+    if (IMAGE_BITMAP_SUPPORTED) {
+        return 'imagebitmap';
+    }
+    if (IMAGE_SUPPORTED) {
+        return 'image';
+    }
+    if (DATA_SUPPORTED) {
+        return 'data';
+    }
+    // This should only happen in Node.js
+    throw new Error('Install \'@loaders.gl/polyfills\' to parse images under Node.js');
 }
-//# sourceMappingURL=image-type.js.map
+exports.getDefaultImageType = getDefaultImageType;

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

@@ -0,0 +1,10 @@
+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;
+//# sourceMappingURL=parsed-image-api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parsed-image-api.d.ts","sourceRoot":"","sources":["../../../src/lib/category-api/parsed-image-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAE,aAAa,EAAE,aAAa,EAAC,MAAM,aAAa,CAAC;AAEzE,wBAAgB,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAEjD;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAQlD;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,aAAa,CAM5D;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAC,CAE9E;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,aAAa,GAAG,SAAS,CA0BxE"}