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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. package/dist/bundle.d.ts +2 -0
  2. package/dist/bundle.d.ts.map +1 -0
  3. package/dist/bundle.js +4 -6
  4. package/dist/dist.min.js +2 -2
  5. package/dist/dist.min.js.map +7 -1
  6. package/dist/es5/bundle.js +7 -0
  7. package/dist/es5/bundle.js.map +1 -0
  8. package/dist/es5/image-loader.js +38 -0
  9. package/dist/es5/image-loader.js.map +1 -0
  10. package/dist/es5/image-writer.js +27 -0
  11. package/dist/es5/image-writer.js.map +1 -0
  12. package/dist/es5/index.js +86 -0
  13. package/dist/es5/index.js.map +1 -0
  14. package/dist/es5/lib/category-api/binary-image-api.js +126 -0
  15. package/dist/es5/lib/category-api/binary-image-api.js.map +1 -0
  16. package/dist/es5/lib/category-api/image-format.js +53 -0
  17. package/dist/es5/lib/category-api/image-format.js.map +1 -0
  18. package/dist/es5/lib/category-api/image-type.js +53 -0
  19. package/dist/es5/lib/category-api/image-type.js.map +1 -0
  20. package/dist/es5/lib/category-api/parsed-image-api.js +79 -0
  21. package/dist/es5/lib/category-api/parsed-image-api.js.map +1 -0
  22. package/dist/es5/lib/encoders/encode-image.js +79 -0
  23. package/dist/es5/lib/encoders/encode-image.js.map +1 -0
  24. package/dist/es5/lib/parsers/parse-image.js +67 -0
  25. package/dist/es5/lib/parsers/parse-image.js.map +1 -0
  26. package/dist/es5/lib/parsers/parse-to-image-bitmap.js +55 -0
  27. package/dist/es5/lib/parsers/parse-to-image-bitmap.js.map +1 -0
  28. package/dist/es5/lib/parsers/parse-to-image.js +44 -0
  29. package/dist/es5/lib/parsers/parse-to-image.js.map +1 -0
  30. package/dist/es5/lib/parsers/parse-to-node-image.js +20 -0
  31. package/dist/es5/lib/parsers/parse-to-node-image.js.map +1 -0
  32. package/dist/es5/lib/parsers/svg-utils.js +43 -0
  33. package/dist/es5/lib/parsers/svg-utils.js.map +1 -0
  34. package/dist/es5/lib/texture-api/async-deep-map.js +48 -0
  35. package/dist/es5/lib/texture-api/async-deep-map.js.map +1 -0
  36. package/dist/es5/lib/texture-api/deep-load.js +20 -0
  37. package/dist/es5/lib/texture-api/deep-load.js.map +1 -0
  38. package/dist/es5/lib/texture-api/generate-url.js +30 -0
  39. package/dist/es5/lib/texture-api/generate-url.js.map +1 -0
  40. package/dist/es5/lib/texture-api/load-image.js +69 -0
  41. package/dist/es5/lib/texture-api/load-image.js.map +1 -0
  42. package/dist/es5/lib/utils/version.js +9 -0
  43. package/dist/es5/lib/utils/version.js.map +1 -0
  44. package/dist/es5/types.js +2 -0
  45. package/dist/{types.js.map → es5/types.js.map} +0 -0
  46. package/dist/esm/bundle.js +5 -0
  47. package/dist/esm/bundle.js.map +1 -0
  48. package/dist/esm/image-loader.js +24 -0
  49. package/dist/esm/image-loader.js.map +1 -0
  50. package/dist/esm/image-writer.js +17 -0
  51. package/dist/esm/image-writer.js.map +1 -0
  52. package/dist/esm/index.js +8 -0
  53. package/dist/esm/index.js.map +1 -0
  54. package/dist/esm/lib/category-api/binary-image-api.js +118 -0
  55. package/dist/esm/lib/category-api/binary-image-api.js.map +1 -0
  56. package/dist/esm/lib/category-api/image-format.js +44 -0
  57. package/dist/esm/lib/category-api/image-format.js.map +1 -0
  58. package/dist/esm/lib/category-api/image-type.js +42 -0
  59. package/dist/esm/lib/category-api/image-type.js.map +1 -0
  60. package/dist/esm/lib/category-api/parsed-image-api.js +64 -0
  61. package/dist/esm/lib/category-api/parsed-image-api.js.map +1 -0
  62. package/dist/esm/lib/encoders/encode-image.js +69 -0
  63. package/dist/esm/lib/encoders/encode-image.js.map +1 -0
  64. package/dist/esm/lib/parsers/parse-image.js +52 -0
  65. package/dist/esm/lib/parsers/parse-image.js.map +1 -0
  66. package/dist/esm/lib/parsers/parse-to-image-bitmap.js +43 -0
  67. package/dist/esm/lib/parsers/parse-to-image-bitmap.js.map +1 -0
  68. package/dist/esm/lib/parsers/parse-to-image.js +34 -0
  69. package/dist/esm/lib/parsers/parse-to-image.js.map +1 -0
  70. package/dist/esm/lib/parsers/parse-to-node-image.js +11 -0
  71. package/dist/esm/lib/parsers/parse-to-node-image.js.map +1 -0
  72. package/dist/esm/lib/parsers/svg-utils.js +32 -0
  73. package/dist/esm/lib/parsers/svg-utils.js.map +1 -0
  74. package/dist/esm/lib/texture-api/async-deep-map.js +39 -0
  75. package/dist/esm/lib/texture-api/async-deep-map.js.map +1 -0
  76. package/dist/esm/lib/texture-api/deep-load.js +10 -0
  77. package/dist/esm/lib/texture-api/deep-load.js.map +1 -0
  78. package/dist/esm/lib/texture-api/generate-url.js +22 -0
  79. package/dist/esm/lib/texture-api/generate-url.js.map +1 -0
  80. package/dist/esm/lib/texture-api/load-image.js +52 -0
  81. package/dist/esm/lib/texture-api/load-image.js.map +1 -0
  82. package/dist/esm/lib/utils/version.js +2 -0
  83. package/dist/esm/lib/utils/version.js.map +1 -0
  84. package/dist/esm/types.js +2 -0
  85. package/dist/esm/types.js.map +1 -0
  86. package/dist/image-loader.d.ts +26 -0
  87. package/dist/image-loader.d.ts.map +1 -0
  88. package/dist/image-loader.js +39 -19
  89. package/dist/image-writer.d.ts +16 -0
  90. package/dist/image-writer.d.ts.map +1 -0
  91. package/dist/image-writer.js +19 -16
  92. package/dist/index.d.ts +10 -0
  93. package/dist/index.d.ts.map +1 -0
  94. package/dist/index.js +27 -7
  95. package/dist/lib/category-api/binary-image-api.d.ts +19 -0
  96. package/dist/lib/category-api/binary-image-api.d.ts.map +1 -0
  97. package/dist/lib/category-api/binary-image-api.js +125 -102
  98. package/dist/lib/category-api/image-format.d.ts +5 -0
  99. package/dist/lib/category-api/image-format.d.ts.map +1 -0
  100. package/dist/lib/category-api/image-format.js +63 -0
  101. package/dist/lib/category-api/image-type.d.ts +12 -0
  102. package/dist/lib/category-api/image-type.d.ts.map +1 -0
  103. package/dist/lib/category-api/image-type.js +44 -38
  104. package/dist/lib/category-api/parsed-image-api.d.ts +10 -0
  105. package/dist/lib/category-api/parsed-image-api.d.ts.map +1 -0
  106. package/dist/lib/category-api/parsed-image-api.js +62 -57
  107. package/dist/lib/encoders/encode-image.d.ts +12 -0
  108. package/dist/lib/encoders/encode-image.d.ts.map +1 -0
  109. package/dist/lib/encoders/encode-image.js +73 -61
  110. package/dist/lib/parsers/parse-image.d.ts +5 -0
  111. package/dist/lib/parsers/parse-image.d.ts.map +1 -0
  112. package/dist/lib/parsers/parse-image.js +54 -49
  113. package/dist/lib/parsers/parse-to-image-bitmap.d.ts +10 -0
  114. package/dist/lib/parsers/parse-to-image-bitmap.d.ts.map +1 -0
  115. package/dist/lib/parsers/parse-to-image-bitmap.js +53 -35
  116. package/dist/lib/parsers/parse-to-image.d.ts +4 -0
  117. package/dist/lib/parsers/parse-to-image.d.ts.map +1 -0
  118. package/dist/lib/parsers/parse-to-image.js +43 -30
  119. package/dist/lib/parsers/parse-to-node-image.d.ts +4 -0
  120. package/dist/lib/parsers/parse-to-node-image.d.ts.map +1 -0
  121. package/dist/lib/parsers/parse-to-node-image.js +13 -13
  122. package/dist/lib/parsers/svg-utils.d.ts +4 -0
  123. package/dist/lib/parsers/svg-utils.d.ts.map +1 -0
  124. package/dist/lib/parsers/svg-utils.js +36 -26
  125. package/dist/lib/texture-api/async-deep-map.d.ts +3 -0
  126. package/dist/lib/texture-api/async-deep-map.d.ts.map +1 -0
  127. package/dist/lib/texture-api/async-deep-map.js +49 -32
  128. package/dist/lib/texture-api/deep-load.d.ts +3 -0
  129. package/dist/lib/texture-api/deep-load.d.ts.map +1 -0
  130. package/dist/lib/texture-api/deep-load.js +13 -8
  131. package/dist/lib/texture-api/generate-url.d.ts +2 -0
  132. package/dist/lib/texture-api/generate-url.d.ts.map +1 -0
  133. package/dist/lib/texture-api/generate-url.js +19 -22
  134. package/dist/lib/texture-api/load-image.d.ts +7 -0
  135. package/dist/lib/texture-api/load-image.d.ts.map +1 -0
  136. package/dist/lib/texture-api/load-image.js +42 -47
  137. package/dist/lib/utils/version.d.ts +2 -0
  138. package/dist/lib/utils/version.d.ts.map +1 -0
  139. package/dist/lib/utils/version.js +7 -2
  140. package/dist/types.d.ts +18 -0
  141. package/dist/types.d.ts.map +1 -0
  142. package/dist/types.js +2 -2
  143. package/package.json +7 -8
  144. package/src/bundle.ts +2 -3
  145. package/src/image-loader.ts +18 -8
  146. package/src/index.ts +4 -0
  147. package/src/lib/category-api/image-format.ts +66 -0
  148. package/src/lib/category-api/image-type.ts +2 -2
  149. package/src/lib/encoders/encode-image.ts +1 -2
  150. package/src/lib/parsers/parse-image.ts +9 -2
  151. package/src/lib/parsers/parse-to-image-bitmap.ts +10 -2
  152. package/src/lib/parsers/parse-to-image.ts +7 -2
  153. package/src/lib/parsers/parse-to-node-image.ts +24 -6
  154. package/src/lib/parsers/svg-utils.ts +2 -2
  155. package/src/lib/texture-api/generate-url.ts +1 -2
  156. package/src/lib/texture-api/load-image.ts +1 -1
  157. package/dist/bundle.js.map +0 -1
  158. package/dist/image-loader.js.map +0 -1
  159. package/dist/image-writer.js.map +0 -1
  160. package/dist/index.js.map +0 -1
  161. package/dist/lib/category-api/binary-image-api.js.map +0 -1
  162. package/dist/lib/category-api/image-type.js.map +0 -1
  163. package/dist/lib/category-api/parsed-image-api.js.map +0 -1
  164. package/dist/lib/encoders/encode-image.js.map +0 -1
  165. package/dist/lib/parsers/parse-image.js.map +0 -1
  166. package/dist/lib/parsers/parse-to-image-bitmap.js.map +0 -1
  167. package/dist/lib/parsers/parse-to-image.js.map +0 -1
  168. package/dist/lib/parsers/parse-to-node-image.js.map +0 -1
  169. package/dist/lib/parsers/svg-utils.js.map +0 -1
  170. package/dist/lib/texture-api/async-deep-map.js.map +0 -1
  171. package/dist/lib/texture-api/deep-load.js.map +0 -1
  172. package/dist/lib/texture-api/generate-url.js.map +0 -1
  173. package/dist/lib/texture-api/load-image.js.map +0 -1
  174. package/dist/lib/utils/assert.js +0 -6
  175. package/dist/lib/utils/assert.js.map +0 -1
  176. package/dist/lib/utils/globals.js +0 -16
  177. package/dist/lib/utils/globals.js.map +0 -1
  178. package/dist/lib/utils/version.js.map +0 -1
  179. package/src/lib/utils/assert.js +0 -5
  180. package/src/lib/utils/globals.ts +0 -48
@@ -1,14 +1,14 @@
1
- import { global } from '../utils/globals';
2
- import { assert } from '../utils/assert';
3
- import { getBinaryImageMetadata } from '../category-api/binary-image-api';
4
- export default function parseToNodeImage(arrayBuffer, options) {
5
- const {
6
- mimeType
7
- } = getBinaryImageMetadata(arrayBuffer) || {};
8
- const {
9
- _parseImageNode
10
- } = global;
11
- assert(_parseImageNode);
12
- return _parseImageNode(arrayBuffer, mimeType, options);
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const loader_utils_1 = require("@loaders.gl/loader-utils");
4
+ const binary_image_api_1 = require("../category-api/binary-image-api");
5
+ // Use polyfills if installed to parsed image using get-pixels
6
+ async function parseToNodeImage(arrayBuffer, options) {
7
+ const { mimeType } = (0, binary_image_api_1.getBinaryImageMetadata)(arrayBuffer) || {};
8
+ // @ts-ignore
9
+ const _parseImageNode = globalThis._parseImageNode;
10
+ (0, loader_utils_1.assert)(_parseImageNode); // '@loaders.gl/polyfills not installed'
11
+ // @ts-expect-error TODO should we throw error in this case?
12
+ return await _parseImageNode(arrayBuffer, mimeType);
13
13
  }
14
- //# sourceMappingURL=parse-to-node-image.js.map
14
+ exports.default = parseToNodeImage;
@@ -0,0 +1,4 @@
1
+ export declare function isSVG(url: any): any;
2
+ export declare function getBlobOrSVGDataUrl(arrayBuffer: ArrayBuffer, url?: string): Blob | string;
3
+ export declare function getBlob(arrayBuffer: ArrayBuffer, url?: string): Blob;
4
+ //# sourceMappingURL=svg-utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"svg-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/svg-utils.ts"],"names":[],"mappings":"AAMA,wBAAgB,KAAK,CAAC,GAAG,KAAA,OAExB;AAED,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAkBzF;AAED,wBAAgB,OAAO,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAQpE"}
@@ -1,32 +1,42 @@
1
+ "use strict";
2
+ // SVG parsing has limitations, e.g:
3
+ // https://bugs.chromium.org/p/chromium/issues/detail?id=606319
4
+ Object.defineProperty(exports, "__esModule", { value: true });
5
+ exports.getBlob = exports.getBlobOrSVGDataUrl = exports.isSVG = void 0;
1
6
  const SVG_DATA_URL_PATTERN = /^data:image\/svg\+xml/;
2
7
  const SVG_URL_PATTERN = /\.svg((\?|#).*)?$/;
3
- export function isSVG(url) {
4
- return url && (SVG_DATA_URL_PATTERN.test(url) || SVG_URL_PATTERN.test(url));
8
+ function isSVG(url) {
9
+ return url && (SVG_DATA_URL_PATTERN.test(url) || SVG_URL_PATTERN.test(url));
5
10
  }
6
- export function getBlobOrSVGDataUrl(arrayBuffer, url) {
7
- if (isSVG(url)) {
8
- const textDecoder = new TextDecoder();
9
- let xmlText = textDecoder.decode(arrayBuffer);
10
-
11
- try {
12
- if (typeof unescape === 'function' && typeof encodeURIComponent === 'function') {
13
- xmlText = unescape(encodeURIComponent(xmlText));
14
- }
15
- } catch (error) {
16
- throw new Error(error.message);
11
+ exports.isSVG = isSVG;
12
+ function getBlobOrSVGDataUrl(arrayBuffer, url) {
13
+ if (isSVG(url)) {
14
+ // Prepare a properly tagged data URL, and load using normal mechanism
15
+ const textDecoder = new TextDecoder();
16
+ let xmlText = textDecoder.decode(arrayBuffer);
17
+ // TODO Escape in browser to support e.g. Chinese characters
18
+ try {
19
+ if (typeof unescape === 'function' && typeof encodeURIComponent === 'function') {
20
+ xmlText = unescape(encodeURIComponent(xmlText));
21
+ }
22
+ }
23
+ catch (error) {
24
+ throw new Error(error.message);
25
+ }
26
+ // base64 encoding is safer. utf-8 fails in some browsers
27
+ const src = `data:image/svg+xml;base64,${btoa(xmlText)}`;
28
+ return src;
17
29
  }
18
-
19
- const src = `data:image/svg+xml;base64,${btoa(xmlText)}`;
20
- return src;
21
- }
22
-
23
- return getBlob(arrayBuffer, url);
30
+ return getBlob(arrayBuffer, url);
24
31
  }
25
- export function getBlob(arrayBuffer, url) {
26
- if (isSVG(url)) {
27
- throw new Error('SVG cannot be parsed directly to imagebitmap');
28
- }
29
-
30
- return new Blob([new Uint8Array(arrayBuffer)]);
32
+ exports.getBlobOrSVGDataUrl = getBlobOrSVGDataUrl;
33
+ function getBlob(arrayBuffer, url) {
34
+ if (isSVG(url)) {
35
+ // https://bugs.chromium.org/p/chromium/issues/detail?id=606319
36
+ // return new Blob([new Uint8Array(arrayBuffer)], {type: 'image/svg+xml'});
37
+ throw new Error('SVG cannot be parsed directly to imagebitmap');
38
+ }
39
+ // TODO - how to determine mime type? Param? Sniff here?
40
+ return new Blob([new Uint8Array(arrayBuffer)]); // MIME type not needed?
31
41
  }
32
- //# sourceMappingURL=svg-utils.js.map
42
+ exports.getBlob = getBlob;
@@ -0,0 +1,3 @@
1
+ export declare function asyncDeepMap(tree: any, func: any, options?: {}): Promise<any>;
2
+ export declare function mapSubtree(object: any, func: any, options: any): Promise<any>;
3
+ //# sourceMappingURL=async-deep-map.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"async-deep-map.d.ts","sourceRoot":"","sources":["../../../src/lib/texture-api/async-deep-map.ts"],"names":[],"mappings":"AAqBA,wBAAsB,YAAY,CAAC,IAAI,KAAA,EAAE,IAAI,KAAA,EAAE,OAAO,KAAK,gBAE1D;AAED,wBAAsB,UAAU,CAAC,MAAM,KAAA,EAAE,IAAI,KAAA,EAAE,OAAO,KAAA,gBAYrD"}
@@ -1,39 +1,56 @@
1
- const isObject = value => value && typeof value === 'object';
1
+ "use strict";
2
+ /*
3
+ Asynchronously maps a deep structure of values (e.g. objects and arrays of urls).
2
4
 
3
- export async function asyncDeepMap(tree, func, options = {}) {
4
- return await mapSubtree(tree, func, options);
5
+ E.g. a mipmapped cubemap
6
+ {
7
+ [CUBE_FACE_FRONT]: [
8
+ "image-front-0.jpg",
9
+ "image-front-1.jpg",
10
+ "image-front-2.jpg",
11
+ ],
12
+ [CUBE_MAP_BACK]: [
13
+ ...
14
+ ]
5
15
  }
6
- export async function mapSubtree(object, func, options) {
7
- if (Array.isArray(object)) {
8
- return await mapArray(object, func, options);
9
- }
10
-
11
- if (isObject(object)) {
12
- return await mapObject(object, func, options);
13
- }
14
-
15
- const url = object;
16
- return await func(url, options);
16
+ */
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ exports.mapSubtree = exports.asyncDeepMap = void 0;
19
+ const isObject = (value) => value && typeof value === 'object';
20
+ // Loads a deep structure of urls (objects and arrays of urls)
21
+ // Returns an object with six key-value pairs containing the images (or image mip arrays)
22
+ // for each cube face
23
+ async function asyncDeepMap(tree, func, options = {}) {
24
+ return await mapSubtree(tree, func, options);
17
25
  }
18
-
26
+ exports.asyncDeepMap = asyncDeepMap;
27
+ async function mapSubtree(object, func, options) {
28
+ if (Array.isArray(object)) {
29
+ return await mapArray(object, func, options);
30
+ }
31
+ if (isObject(object)) {
32
+ return await mapObject(object, func, options);
33
+ }
34
+ // TODO - ignore non-urls, non-arraybuffers?
35
+ const url = object;
36
+ return await func(url, options);
37
+ }
38
+ exports.mapSubtree = mapSubtree;
39
+ // HELPERS
19
40
  async function mapObject(object, func, options) {
20
- const promises = [];
21
- const values = {};
22
-
23
- for (const key in object) {
24
- const url = object[key];
25
- const promise = mapSubtree(url, func, options).then(value => {
26
- values[key] = value;
27
- });
28
- promises.push(promise);
29
- }
30
-
31
- await Promise.all(promises);
32
- return values;
41
+ const promises = [];
42
+ const values = {};
43
+ for (const key in object) {
44
+ const url = object[key];
45
+ const promise = mapSubtree(url, func, options).then((value) => {
46
+ values[key] = value;
47
+ });
48
+ promises.push(promise);
49
+ }
50
+ await Promise.all(promises);
51
+ return values;
33
52
  }
34
-
35
53
  async function mapArray(urlArray, func, options = {}) {
36
- const promises = urlArray.map(url => mapSubtree(url, func, options));
37
- return await Promise.all(promises);
54
+ const promises = urlArray.map((url) => mapSubtree(url, func, options));
55
+ return await Promise.all(promises);
38
56
  }
39
- //# sourceMappingURL=async-deep-map.js.map
@@ -0,0 +1,3 @@
1
+ export declare function deepLoad(urlTree: any, load: any, options: any): Promise<any>;
2
+ export declare function shallowLoad(url: any, load: any, options: any): Promise<any>;
3
+ //# sourceMappingURL=deep-load.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"deep-load.d.ts","sourceRoot":"","sources":["../../../src/lib/texture-api/deep-load.ts"],"names":[],"mappings":"AAEA,wBAAsB,QAAQ,CAAC,OAAO,KAAA,EAAE,IAAI,KAAA,EAAE,OAAO,KAAA,gBAEpD;AAED,wBAAsB,WAAW,CAAC,GAAG,KAAA,EAAE,IAAI,KAAA,EAAE,OAAO,KAAA,gBAKnD"}
@@ -1,10 +1,15 @@
1
- import { asyncDeepMap } from './async-deep-map';
2
- export async function deepLoad(urlTree, load, options) {
3
- return await asyncDeepMap(urlTree, url => shallowLoad(url, load, options));
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.shallowLoad = exports.deepLoad = void 0;
4
+ const async_deep_map_1 = require("./async-deep-map");
5
+ async function deepLoad(urlTree, load, options) {
6
+ return await (0, async_deep_map_1.asyncDeepMap)(urlTree, (url) => shallowLoad(url, load, options));
4
7
  }
5
- export async function shallowLoad(url, load, options) {
6
- const response = await fetch(url, options.fetch);
7
- const arrayBuffer = await response.arrayBuffer();
8
- return await load(arrayBuffer, options);
8
+ exports.deepLoad = deepLoad;
9
+ async function shallowLoad(url, load, options) {
10
+ // console.error('loading', url);
11
+ const response = await fetch(url, options.fetch);
12
+ const arrayBuffer = await response.arrayBuffer();
13
+ return await load(arrayBuffer, options);
9
14
  }
10
- //# sourceMappingURL=deep-load.js.map
15
+ exports.shallowLoad = shallowLoad;
@@ -0,0 +1,2 @@
1
+ export declare function generateUrl(getUrl: any, options: any, urlOptions: any): string;
2
+ //# sourceMappingURL=generate-url.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-url.d.ts","sourceRoot":"","sources":["../../../src/lib/texture-api/generate-url.ts"],"names":[],"mappings":"AAGA,wBAAgB,WAAW,CAAC,MAAM,KAAA,EAAE,OAAO,KAAA,EAAE,UAAU,KAAA,UAetD"}
@@ -1,23 +1,20 @@
1
- import { resolvePath } from '@loaders.gl/loader-utils';
2
- import { assert } from '../utils/assert';
3
- export function generateUrl(getUrl, options, urlOptions) {
4
- let url = getUrl;
5
-
6
- if (typeof getUrl === 'function') {
7
- url = getUrl({ ...options,
8
- ...urlOptions
9
- });
10
- }
11
-
12
- assert(typeof url === 'string');
13
- const {
14
- baseUrl
15
- } = options;
16
-
17
- if (baseUrl) {
18
- url = baseUrl[baseUrl.length - 1] === '/' ? `${baseUrl}${url}` : `${baseUrl}/${url}`;
19
- }
20
-
21
- return resolvePath(url);
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.generateUrl = void 0;
4
+ const loader_utils_1 = require("@loaders.gl/loader-utils");
5
+ // Generate a url by calling getUrl with mix of options, applying options.baseUrl
6
+ function generateUrl(getUrl, options, urlOptions) {
7
+ // Get url
8
+ let url = getUrl;
9
+ if (typeof getUrl === 'function') {
10
+ url = getUrl({ ...options, ...urlOptions });
11
+ }
12
+ (0, loader_utils_1.assert)(typeof url === 'string');
13
+ // Apply options.baseUrl
14
+ const { baseUrl } = options;
15
+ if (baseUrl) {
16
+ url = baseUrl[baseUrl.length - 1] === '/' ? `${baseUrl}${url}` : `${baseUrl}/${url}`;
17
+ }
18
+ return (0, loader_utils_1.resolvePath)(url);
22
19
  }
23
- //# sourceMappingURL=generate-url.js.map
20
+ exports.generateUrl = generateUrl;
@@ -0,0 +1,7 @@
1
+ export declare function loadImage(getUrl: any, options?: {}): Promise<any>;
2
+ export declare function getImageUrls(getUrl: any, options: any, urlOptions?: {}): Promise<string | string[]>;
3
+ export declare function getMipLevels({ width, height }: {
4
+ width: any;
5
+ height: any;
6
+ }): number;
7
+ //# sourceMappingURL=load-image.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"load-image.d.ts","sourceRoot":"","sources":["../../../src/lib/texture-api/load-image.ts"],"names":[],"mappings":"AAMA,wBAAsB,SAAS,CAAC,MAAM,KAAA,EAAE,OAAO,KAAK,gBAGnD;AAED,wBAAsB,YAAY,CAAC,MAAM,KAAA,EAAE,OAAO,KAAA,EAAE,UAAU,KAAK,8BAKlE;AA6BD,wBAAgB,YAAY,CAAC,EAAC,KAAK,EAAE,MAAM,EAAC;;;CAAA,UAE3C"}
@@ -1,52 +1,47 @@
1
- import { assert } from '../utils/assert';
2
- import parseImage from '../parsers/parse-image';
3
- import { getImageSize } from '../category-api/parsed-image-api';
4
- import { generateUrl } from './generate-url';
5
- import { deepLoad, shallowLoad } from './deep-load';
6
- export async function loadImage(getUrl, options = {}) {
7
- const imageUrls = await getImageUrls(getUrl, options);
8
- return await deepLoad(imageUrls, parseImage, options);
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.getMipLevels = exports.getImageUrls = exports.loadImage = void 0;
7
+ const loader_utils_1 = require("@loaders.gl/loader-utils");
8
+ const parse_image_1 = __importDefault(require("../parsers/parse-image"));
9
+ const parsed_image_api_1 = require("../category-api/parsed-image-api");
10
+ const generate_url_1 = require("./generate-url");
11
+ const deep_load_1 = require("./deep-load");
12
+ async function loadImage(getUrl, options = {}) {
13
+ const imageUrls = await getImageUrls(getUrl, options);
14
+ return await (0, deep_load_1.deepLoad)(imageUrls, parse_image_1.default, options);
9
15
  }
10
- export async function getImageUrls(getUrl, options, urlOptions = {}) {
11
- const mipLevels = options && options.image && options.image.mipLevels || 0;
12
- return mipLevels !== 0 ? await getMipmappedImageUrls(getUrl, mipLevels, options, urlOptions) : generateUrl(getUrl, options, urlOptions);
16
+ exports.loadImage = loadImage;
17
+ async function getImageUrls(getUrl, options, urlOptions = {}) {
18
+ const mipLevels = (options && options.image && options.image.mipLevels) || 0;
19
+ return mipLevels !== 0
20
+ ? await getMipmappedImageUrls(getUrl, mipLevels, options, urlOptions)
21
+ : (0, generate_url_1.generateUrl)(getUrl, options, urlOptions);
13
22
  }
14
-
23
+ exports.getImageUrls = getImageUrls;
15
24
  async function getMipmappedImageUrls(getUrl, mipLevels, options, urlOptions) {
16
- const urls = [];
17
-
18
- if (mipLevels === 'auto') {
19
- const url = generateUrl(getUrl, options, { ...urlOptions,
20
- lod: 0
21
- });
22
- const image = await shallowLoad(url, parseImage, options);
23
- const {
24
- width,
25
- height
26
- } = getImageSize(image);
27
- mipLevels = getMipLevels({
28
- width,
29
- height
30
- });
31
- urls.push(url);
32
- }
33
-
34
- assert(mipLevels > 0);
35
-
36
- for (let mipLevel = urls.length; mipLevel < mipLevels; ++mipLevel) {
37
- const url = generateUrl(getUrl, options, { ...urlOptions,
38
- lod: mipLevel
39
- });
40
- urls.push(url);
41
- }
42
-
43
- return urls;
25
+ const urls = [];
26
+ // If no mip levels supplied, we need to load the level 0 image and calculate based on size
27
+ if (mipLevels === 'auto') {
28
+ const url = (0, generate_url_1.generateUrl)(getUrl, options, { ...urlOptions, lod: 0 });
29
+ const image = await (0, deep_load_1.shallowLoad)(url, parse_image_1.default, options);
30
+ const { width, height } = (0, parsed_image_api_1.getImageSize)(image);
31
+ mipLevels = getMipLevels({ width, height });
32
+ // TODO - push image and make `deepLoad` pass through non-url values, avoid loading twice?
33
+ urls.push(url);
34
+ }
35
+ // We now know how many mipLevels we need, remaining image urls can now be constructed
36
+ (0, loader_utils_1.assert)(mipLevels > 0);
37
+ for (let mipLevel = urls.length; mipLevel < mipLevels; ++mipLevel) {
38
+ const url = (0, generate_url_1.generateUrl)(getUrl, options, { ...urlOptions, lod: mipLevel });
39
+ urls.push(url);
40
+ }
41
+ return urls;
44
42
  }
45
-
46
- export function getMipLevels({
47
- width,
48
- height
49
- }) {
50
- return 1 + Math.floor(Math.log2(Math.max(width, height)));
43
+ // Calculates number of mipmaps based on texture size (log2)
44
+ function getMipLevels({ width, height }) {
45
+ return 1 + Math.floor(Math.log2(Math.max(width, height)));
51
46
  }
52
- //# sourceMappingURL=load-image.js.map
47
+ exports.getMipLevels = getMipLevels;
@@ -0,0 +1,2 @@
1
+ export declare const VERSION: any;
2
+ //# sourceMappingURL=version.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/version.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO,KAA8D,CAAC"}
@@ -1,2 +1,7 @@
1
- export const VERSION = typeof "3.1.0-alpha.2" !== 'undefined' ? "3.1.0-alpha.2" : 'latest';
2
- //# sourceMappingURL=version.js.map
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.VERSION = void 0;
4
+ // Version constant cannot be imported, it needs to correspond to the build version of **this** module.
5
+ // __VERSION__ is injected by babel-plugin-version-inline
6
+ // @ts-ignore TS2304: Cannot find name '__VERSION__'.
7
+ exports.VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
@@ -0,0 +1,18 @@
1
+ /**
2
+ * data images
3
+ */
4
+ export declare type ImageDataType = {
5
+ data: Uint8Array;
6
+ width: number;
7
+ height: number;
8
+ compressed?: boolean;
9
+ };
10
+ /**
11
+ * Supported Image Types
12
+ */
13
+ export declare type ImageType = ImageBitmap | typeof Image | ImageDataType;
14
+ /**
15
+ * Image type string used to control or determine the type of images returned from ImageLoader
16
+ */
17
+ export declare type ImageTypeEnum = 'imagebitmap' | 'image' | 'data';
18
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,aAAa,GAAG;IAC1B,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS,GAAG,WAAW,GAAG,OAAO,KAAK,GAAG,aAAa,CAAC;AAEnE;;GAEG;AACH,oBAAY,aAAa,GAAG,aAAa,GAAG,OAAO,GAAG,MAAM,CAAC"}
package/dist/types.js CHANGED
@@ -1,2 +1,2 @@
1
- export {};
2
- //# sourceMappingURL=types.js.map
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@loaders.gl/images",
3
- "version": "3.1.0-alpha.2",
3
+ "version": "3.1.0-beta.1",
4
4
  "description": "Framework-independent loaders and writers for images (PNG, JPG, ...)",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
@@ -18,9 +18,9 @@
18
18
  "point cloud",
19
19
  "PLY"
20
20
  ],
21
- "types": "src/index.ts",
22
- "main": "dist/index.js",
23
- "module": "dist/index.js",
21
+ "types": "dist/index.d.ts",
22
+ "main": "dist/es5/index.js",
23
+ "module": "dist/esm/index.js",
24
24
  "sideEffects": false,
25
25
  "files": [
26
26
  "src",
@@ -29,11 +29,10 @@
29
29
  ],
30
30
  "scripts": {
31
31
  "pre-build": "npm run build-bundle",
32
- "build-bundle": "webpack --display=minimal --config ../../scripts/webpack/bundle.js",
33
- "build-worker": "webpack --entry ./src/image-worker.js --output ./dist/image-worker.js --config ../../scripts/webpack/worker.js"
32
+ "build-bundle": "esbuild src/bundle.ts --outfile=dist/dist.min.js --bundle --minify --sourcemap"
34
33
  },
35
34
  "dependencies": {
36
- "@loaders.gl/loader-utils": "3.1.0-alpha.2"
35
+ "@loaders.gl/loader-utils": "3.1.0-beta.1"
37
36
  },
38
- "gitHead": "ca83b8f05a6874db93051d446266d9ea360affb2"
37
+ "gitHead": "980cdefb4e8ec9ef9c951d20c78cf77777707f49"
39
38
  }
package/src/bundle.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  // @ts-nocheck
2
2
  const moduleExports = require('./index');
3
- const _global = typeof window === 'undefined' ? global : window;
4
- _global.loaders = _global.loaders || {};
5
- module.exports = Object.assign(_global.loaders, moduleExports);
3
+ globalThis.loaders = globalThis.loaders || {};
4
+ module.exports = Object.assign(globalThis.loaders, moduleExports);
@@ -1,4 +1,4 @@
1
- import type {LoaderWithParser} from '@loaders.gl/loader-utils';
1
+ import type {LoaderOptions, LoaderWithParser} from '@loaders.gl/loader-utils';
2
2
  import {VERSION} from './lib/utils/version';
3
3
  import parseImage from './lib/parsers/parse-image';
4
4
  import {getBinaryImageMetadata} from './lib/category-api/binary-image-api';
@@ -14,6 +14,22 @@ const MIME_TYPES = [
14
14
  'image/svg+xml'
15
15
  ];
16
16
 
17
+ export type ImageLoaderOptions = LoaderOptions & {
18
+ image?: {
19
+ type?: 'auto' | 'data' | 'imagebitmap' | 'image';
20
+ decode?: boolean;
21
+ };
22
+ imagebitmap?: ImageBitmapOptions;
23
+ };
24
+
25
+ const DEFAULT_IMAGE_LOADER_OPTIONS: ImageLoaderOptions = {
26
+ image: {
27
+ type: 'auto',
28
+ decode: true // if format is HTML
29
+ }
30
+ // imagebitmap: {} - passes (platform dependent) parameters to ImageBitmap constructor
31
+ };
32
+
17
33
  /**
18
34
  * Loads a platform-specific image type
19
35
  * Note: This type can be used as input data to WebGL texture creation
@@ -28,13 +44,7 @@ export const ImageLoader = {
28
44
  parse: parseImage,
29
45
  // TODO: byteOffset, byteLength;
30
46
  tests: [(arrayBuffer) => Boolean(getBinaryImageMetadata(new DataView(arrayBuffer)))],
31
- options: {
32
- image: {
33
- type: 'auto',
34
- decode: true // if format is HTML
35
- }
36
- // imagebitmap: {} - passes (platform dependent) parameters to ImageBitmap constructor
37
- }
47
+ options: DEFAULT_IMAGE_LOADER_OPTIONS
38
48
  };
39
49
 
40
50
  export const _typecheckImageLoader: LoaderWithParser = ImageLoader;
package/src/index.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  // TYPES
2
2
  export type {ImageDataType, ImageType, ImageTypeEnum} from './types';
3
+ export type {ImageLoaderOptions} from './image-loader';
3
4
 
4
5
  // LOADERS AND WRITERS
5
6
  export {ImageLoader} from './image-loader';
@@ -20,5 +21,8 @@ export {
20
21
  getImageData
21
22
  } from './lib/category-api/parsed-image-api';
22
23
 
24
+ // EXPERIMENTAL
25
+ export {_isImageFormatSupported} from './lib/category-api/image-format';
26
+
23
27
  // DEPRECATED - Remove in V3 (fix dependency in luma.gl)
24
28
  export {loadImage} from './lib/texture-api/load-image';
@@ -0,0 +1,66 @@
1
+ import {isBrowser} from '@loaders.gl/loader-utils';
2
+
3
+ // The following formats are supported by loaders.gl polyfills
4
+ const NODE_FORMAT_SUPPORT = ['image/png', 'image/jpeg', 'image/gif'];
5
+
6
+ /** Cache values for speed */
7
+ const mimeTypeSupported: {[mimeType: string]: boolean} = {};
8
+
9
+ /**
10
+ * Check if image MIME type is supported. Result is cached.
11
+ */
12
+ export function _isImageFormatSupported(mimeType: string): boolean {
13
+ if (mimeTypeSupported[mimeType] === undefined) {
14
+ mimeTypeSupported[mimeType] = checkFormatSupport(mimeType);
15
+ }
16
+ return mimeTypeSupported[mimeType];
17
+ }
18
+
19
+ /**
20
+ * Check if image MIME type is supported.
21
+ */
22
+ function checkFormatSupport(mimeType: string): boolean {
23
+ switch (mimeType) {
24
+ case 'image/webp':
25
+ return checkWebPSupport();
26
+ case 'image/svg':
27
+ return isBrowser;
28
+ default:
29
+ if (!isBrowser) {
30
+ // @ts-ignore
31
+ const {_parseImageNode} = globalThis;
32
+ return Boolean(_parseImageNode) && NODE_FORMAT_SUPPORT.includes(mimeType);
33
+ }
34
+ return true;
35
+ }
36
+ }
37
+
38
+ /** Check WebPSupport synchronously */
39
+ function checkWebPSupport() {
40
+ if (!isBrowser) {
41
+ return false;
42
+ }
43
+ try {
44
+ const element = document.createElement('canvas');
45
+ return element.toDataURL('image/webp').indexOf('data:image/webp') === 0;
46
+ } catch {
47
+ // Probably Safari...
48
+ return false;
49
+ }
50
+ }
51
+
52
+ // Note: better test but asynchronous
53
+
54
+ // Lossy test image. Support for lossy images doesn't guarantee support for all WebP images.
55
+ // https://stackoverflow.com/questions/5573096/detecting-webp-support
56
+ // const WEBP_TEST_IMAGE = 'data:image/webp;base64,UklGRiIAAABXRUJQVlA4IBYAAAAwAQCdASoBAAEADsD+JaQAA3AAAAAA';
57
+
58
+ // Check WebPSupport asynchronously
59
+ // async function isWebPSupported() {
60
+ // return new Promise( resolve => {
61
+ // const image = new Image();
62
+ // image.src = WEBP_TEST_IMAGE;
63
+ // image.onload = image.onerror = function () {
64
+ // resolve( image.height === 1 );
65
+ // }
66
+ // }
@@ -1,8 +1,8 @@
1
+ import {isBrowser} from '@loaders.gl/loader-utils';
1
2
  import type {ImageTypeEnum} from '../../types';
2
- import {global, isBrowser} from '../utils/globals';
3
3
 
4
4
  // @ts-ignore TS2339: Property does not exist on type
5
- const {_parseImageNode} = global;
5
+ const {_parseImageNode} = globalThis;
6
6
 
7
7
  const IMAGE_SUPPORTED = typeof Image !== 'undefined'; // NOTE: "false" positives if jsdom is installed
8
8
  const IMAGE_BITMAP_SUPPORTED = typeof ImageBitmap !== 'undefined';