@loaders.gl/core 3.4.11 → 3.4.12

package/dist/lib/loader-utils/option-utils.js

@@ -1,160 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeOptions = exports.setGlobalOptions = exports.getGlobalLoaderOptions = exports.getGlobalLoaderState = void 0;
-const is_type_1 = require("../../javascript-utils/is-type");
-const loggers_1 = require("./loggers");
-const option_defaults_1 = require("./option-defaults");
-/**
- * Helper for safely accessing global loaders.gl variables
- * Wraps initialization of global variable in function to defeat overly aggressive tree-shakers
- */
-function getGlobalLoaderState() {
-    // @ts-ignore
-    globalThis.loaders = globalThis.loaders || {};
-    // @ts-ignore
-    const { loaders } = globalThis;
-    // Add _state object to keep separate from modules added to globalThis.loaders
-    loaders._state = loaders._state || {};
-    return loaders._state;
-}
-exports.getGlobalLoaderState = getGlobalLoaderState;
-/**
- * Store global loader options on the global object to increase chances of cross loaders-version interoperability
- * NOTE: This use case is not reliable but can help when testing new versions of loaders.gl with existing frameworks
- * @returns global loader options merged with default loader options
- */
-const getGlobalLoaderOptions = () => {
-    const state = getGlobalLoaderState();
-    // Ensure all default loader options from this library are mentioned
-    state.globalOptions = state.globalOptions || { ...option_defaults_1.DEFAULT_LOADER_OPTIONS };
-    return state.globalOptions;
-};
-exports.getGlobalLoaderOptions = getGlobalLoaderOptions;
-/**
- * Set global loader options
- * @param options
- */
-function setGlobalOptions(options) {
-    const state = getGlobalLoaderState();
-    const globalOptions = (0, exports.getGlobalLoaderOptions)();
-    state.globalOptions = normalizeOptionsInternal(globalOptions, options);
-}
-exports.setGlobalOptions = setGlobalOptions;
-/**
- * Merges options with global opts and loader defaults, also injects baseUri
- * @param options
- * @param loader
- * @param loaders
- * @param url
- */
-function normalizeOptions(options, loader, loaders, url) {
-    loaders = loaders || [];
-    loaders = Array.isArray(loaders) ? loaders : [loaders];
-    validateOptions(options, loaders);
-    return normalizeOptionsInternal(loader, options, url);
-}
-exports.normalizeOptions = normalizeOptions;
-// VALIDATE OPTIONS
-/**
- * Warn for unsupported options
- * @param options
- * @param loaders
- */
-function validateOptions(options, loaders) {
-    // Check top level options
-    validateOptionsObject(options, null, option_defaults_1.DEFAULT_LOADER_OPTIONS, option_defaults_1.REMOVED_LOADER_OPTIONS, loaders);
-    for (const loader of loaders) {
-        // Get the scoped, loader specific options from the user supplied options
-        const idOptions = (options && options[loader.id]) || {};
-        // Get scoped, loader specific default and deprecated options from the selected loader
-        const loaderOptions = (loader.options && loader.options[loader.id]) || {};
-        const deprecatedOptions = (loader.deprecatedOptions && loader.deprecatedOptions[loader.id]) || {};
-        // Validate loader specific options
-        validateOptionsObject(idOptions, loader.id, loaderOptions, deprecatedOptions, loaders);
-    }
-}
-// eslint-disable-next-line max-params, complexity
-function validateOptionsObject(options, id, defaultOptions, deprecatedOptions, loaders) {
-    const loaderName = id || 'Top level';
-    const prefix = id ? `${id}.` : '';
-    for (const key in options) {
-        // If top level option value is an object it could options for a loader, so ignore
-        const isSubOptions = !id && (0, is_type_1.isObject)(options[key]);
-        const isBaseUriOption = key === 'baseUri' && !id;
-        const isWorkerUrlOption = key === 'workerUrl' && id;
-        // <loader>.workerUrl requires special handling as it is now auto-generated and no longer specified as a default option.
-        if (!(key in defaultOptions) && !isBaseUriOption && !isWorkerUrlOption) {
-            // Issue deprecation warnings
-            if (key in deprecatedOptions) {
-                loggers_1.probeLog.warn(`${loaderName} loader option \'${prefix}${key}\' no longer supported, use \'${deprecatedOptions[key]}\'`)();
-            }
-            else if (!isSubOptions) {
-                const suggestion = findSimilarOption(key, loaders);
-                loggers_1.probeLog.warn(`${loaderName} loader option \'${prefix}${key}\' not recognized. ${suggestion}`)();
-            }
-        }
-    }
-}
-function findSimilarOption(optionKey, loaders) {
-    const lowerCaseOptionKey = optionKey.toLowerCase();
-    let bestSuggestion = '';
-    for (const loader of loaders) {
-        for (const key in loader.options) {
-            if (optionKey === key) {
-                return `Did you mean \'${loader.id}.${key}\'?`;
-            }
-            const lowerCaseKey = key.toLowerCase();
-            const isPartialMatch = lowerCaseOptionKey.startsWith(lowerCaseKey) || lowerCaseKey.startsWith(lowerCaseOptionKey);
-            if (isPartialMatch) {
-                bestSuggestion = bestSuggestion || `Did you mean \'${loader.id}.${key}\'?`;
-            }
-        }
-    }
-    return bestSuggestion;
-}
-function normalizeOptionsInternal(loader, options, url) {
-    const loaderDefaultOptions = loader.options || {};
-    const mergedOptions = { ...loaderDefaultOptions };
-    addUrlOptions(mergedOptions, url);
-    // LOGGING: options.log can be set to `null` to defeat logging
-    if (mergedOptions.log === null) {
-        mergedOptions.log = new loggers_1.NullLog();
-    }
-    mergeNestedFields(mergedOptions, (0, exports.getGlobalLoaderOptions)());
-    mergeNestedFields(mergedOptions, options);
-    return mergedOptions;
-}
-// Merge nested options objects
-function mergeNestedFields(mergedOptions, options) {
-    for (const key in options) {
-        // Check for nested options
-        // object in options => either no key in defaultOptions or object in defaultOptions
-        if (key in options) {
-            const value = options[key];
-            if ((0, is_type_1.isPureObject)(value) && (0, is_type_1.isPureObject)(mergedOptions[key])) {
-                mergedOptions[key] = {
-                    ...mergedOptions[key],
-                    ...options[key]
-                };
-            }
-            else {
-                mergedOptions[key] = options[key];
-            }
-        }
-        // else: No need to merge nested opts, and the initial merge already copied over the nested options
-    }
-}
-/**
- * Harvest information from the url
- * @deprecated This is mainly there to support a hack in the GLTFLoader
- * TODO - baseUri should be a directory, i.e. remove file component from baseUri
- * TODO - extract extension?
- * TODO - extract query parameters?
- * TODO - should these be injected on context instead of options?
- */
-function addUrlOptions(options, url) {
-    if (url && !('baseUri' in options)) {
-        options.baseUri = url;
-    }
-}

package/dist/lib/progress/fetch-progress.js

@@ -1,59 +0,0 @@
-"use strict";
-// Forked from github AnthumChris/fetch-progress-indicators under MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Intercepts the Response stream and creates a new Response
- */
-async function fetchProgress(response, onProgress, // TODO better callback types
-onDone = () => { }, onError = () => { }) {
-    response = await response;
-    if (!response.ok) {
-        // ERROR checking needs to be done separately
-        return response;
-    }
-    const body = response.body;
-    if (!body) {
-        // 'ReadableStream not yet supported in this browser.
-        return response;
-    }
-    const contentLength = response.headers.get('content-length') || 0;
-    const totalBytes = contentLength ? parseInt(contentLength) : 0;
-    if (!(totalBytes > 0)) {
-        return response;
-    }
-    // Currently override only implemented in browser
-    if (typeof ReadableStream === 'undefined' || !body.getReader) {
-        return response;
-    }
-    // Create a new stream that invisbly wraps original stream
-    const progressStream = new ReadableStream({
-        async start(controller) {
-            const reader = body.getReader();
-            await read(controller, reader, 0, totalBytes, onProgress, onDone, onError);
-        }
-    });
-    return new Response(progressStream);
-}
-exports.default = fetchProgress;
-// Forward to original streams controller
-// TODO - this causes a crazy deep "async stack"... rewrite as async iterator?
-// eslint-disable-next-line max-params
-async function read(controller, reader, loadedBytes, totalBytes, onProgress, onDone, onError) {
-    try {
-        const { done, value } = await reader.read();
-        if (done) {
-            onDone();
-            controller.close();
-            return;
-        }
-        loadedBytes += value.byteLength;
-        const percent = Math.round((loadedBytes / totalBytes) * 100);
-        onProgress(percent, { loadedBytes, totalBytes });
-        controller.enqueue(value);
-        await read(controller, reader, loadedBytes, totalBytes, onProgress, onDone, onError);
-    }
-    catch (error) {
-        controller.error(error);
-        onError(error);
-    }
-}

package/dist/lib/utils/log.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.log = void 0;
-// loaders.gl, MIT license
-const log_1 = require("@probe.gl/log");
-exports.log = new log_1.Log({ id: 'loaders.gl' });

package/dist/lib/utils/mime-type-utils.js

@@ -1,42 +0,0 @@
-"use strict";
-// TODO - build/integrate proper MIME type parsing
-// https://mimesniff.spec.whatwg.org/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseMIMETypeFromURL = exports.parseMIMEType = void 0;
-const DATA_URL_PATTERN = /^data:([-\w.]+\/[-\w.+]+)(;|,)/;
-const MIME_TYPE_PATTERN = /^([-\w.]+\/[-\w.+]+)/;
-/**
- * Remove extra data like `charset` from MIME types
- * @param mimeString
- * @returns A clean MIME type, or an empty string
- *
- * @todo - handle more advanced MIMETYpes, multiple types
- * @todo - extract charset etc
- */
-function parseMIMEType(mimeString) {
-    // If resource is a data url, extract any embedded mime type
-    const matches = MIME_TYPE_PATTERN.exec(mimeString);
-    if (matches) {
-        return matches[1];
-    }
-    return mimeString;
-}
-exports.parseMIMEType = parseMIMEType;
-/**
- * Extract MIME type from data URL
- *
- * @param mimeString
- * @returns A clean MIME type, or an empty string
- *
- * @todo - handle more advanced MIMETYpes, multiple types
- * @todo - extract charset etc
- */
-function parseMIMETypeFromURL(url) {
-    // If resource is a data URL, extract any embedded mime type
-    const matches = DATA_URL_PATTERN.exec(url);
-    if (matches) {
-        return matches[1];
-    }
-    return '';
-}
-exports.parseMIMETypeFromURL = parseMIMETypeFromURL;

package/dist/lib/utils/resource-utils.js

@@ -1,90 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getResourceContentLength = exports.getResourceMIMEType = exports.getResourceUrl = void 0;
-const is_type_1 = require("../../javascript-utils/is-type");
-const mime_type_utils_1 = require("./mime-type-utils");
-const url_utils_1 = require("./url-utils");
-/**
- * Returns the URL associated with this resource.
- * The returned value may include a query string and need further processing.
- * If it cannot determine url, the corresponding value will be an empty string
- *
- * @todo string parameters are assumed to be URLs
- */
-function getResourceUrl(resource) {
-    // If resource is a `Response`, it contains the information directly as a field
-    if ((0, is_type_1.isResponse)(resource)) {
-        const response = resource;
-        return response.url;
-    }
-    // If the resource is a Blob or a File (subclass of Blob)
-    if ((0, is_type_1.isBlob)(resource)) {
-        const blob = resource;
-        // File objects have a "name" property. Blob objects don't have any
-        // url (name) information
-        return blob.name || '';
-    }
-    if (typeof resource === 'string') {
-        return resource;
-    }
-    // Unknown
-    return '';
-}
-exports.getResourceUrl = getResourceUrl;
-/**
- * Returns the URL associated with this resource.
- * The returned value may include a query string and need further processing.
- * If it cannot determine url, the corresponding value will be an empty string
- *
- * @todo string parameters are assumed to be URLs
- */
-function getResourceMIMEType(resource) {
-    // If resource is a response, it contains the information directly
-    if ((0, is_type_1.isResponse)(resource)) {
-        const response = resource;
-        const contentTypeHeader = response.headers.get('content-type') || '';
-        const noQueryUrl = (0, url_utils_1.stripQueryString)(response.url);
-        return (0, mime_type_utils_1.parseMIMEType)(contentTypeHeader) || (0, mime_type_utils_1.parseMIMETypeFromURL)(noQueryUrl);
-    }
-    // If the resource is a Blob or a File (subclass of Blob)
-    if ((0, is_type_1.isBlob)(resource)) {
-        const blob = resource;
-        return blob.type || '';
-    }
-    if (typeof resource === 'string') {
-        return (0, mime_type_utils_1.parseMIMETypeFromURL)(resource);
-    }
-    // Unknown
-    return '';
-}
-exports.getResourceMIMEType = getResourceMIMEType;
-/**
-  * Returns (approximate) content length for a resource if it can be determined.
-  * Returns -1 if content length cannot be determined.
-  * @param resource
-
-  * @note string parameters are NOT assumed to be URLs
-  */
-function getResourceContentLength(resource) {
-    if ((0, is_type_1.isResponse)(resource)) {
-        const response = resource;
-        return response.headers['content-length'] || -1;
-    }
-    if ((0, is_type_1.isBlob)(resource)) {
-        const blob = resource;
-        return blob.size;
-    }
-    if (typeof resource === 'string') {
-        // TODO - handle data URL?
-        return resource.length;
-    }
-    if (resource instanceof ArrayBuffer) {
-        return resource.byteLength;
-    }
-    if (ArrayBuffer.isView(resource)) {
-        return resource.byteLength;
-    }
-    return -1;
-}
-exports.getResourceContentLength = getResourceContentLength;

package/dist/lib/utils/response-utils.js

@@ -1,115 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkResponseSync = exports.checkResponse = exports.makeResponse = void 0;
-const is_type_1 = require("../../javascript-utils/is-type");
-const resource_utils_1 = require("./resource-utils");
-/**
- * Returns a Response object
- * Adds content-length header when possible
- *
- * @param resource
- */
-async function makeResponse(resource) {
-    if ((0, is_type_1.isResponse)(resource)) {
-        return resource;
-    }
-    // Add content-length header if possible
-    const headers = {};
-    const contentLength = (0, resource_utils_1.getResourceContentLength)(resource);
-    if (contentLength >= 0) {
-        headers['content-length'] = String(contentLength);
-    }
-    // `new Response(File)` does not preserve content-type and URL
-    // so we add them here
-    const url = (0, resource_utils_1.getResourceUrl)(resource);
-    const type = (0, resource_utils_1.getResourceMIMEType)(resource);
-    if (type) {
-        headers['content-type'] = type;
-    }
-    // Add a custom header with initial bytes if available
-    const initialDataUrl = await getInitialDataUrl(resource);
-    if (initialDataUrl) {
-        headers['x-first-bytes'] = initialDataUrl;
-    }
-    // TODO - is this the best way of handling strings?
-    // Maybe package as data URL instead?
-    if (typeof resource === 'string') {
-        // Convert to ArrayBuffer to avoid Response treating it as a URL
-        resource = new TextEncoder().encode(resource);
-    }
-    // Attempt to create a Response from the resource, adding headers and setting url
-    const response = new Response(resource, { headers });
-    // We can't control `Response.url` via constructor, use a property override to record URL.
-    Object.defineProperty(response, 'url', { value: url });
-    return response;
-}
-exports.makeResponse = makeResponse;
-/**
- * Checks response status (async) and throws a helpful error message if status is not OK.
- * @param response
- */
-async function checkResponse(response) {
-    if (!response.ok) {
-        const message = await getResponseError(response);
-        throw new Error(message);
-    }
-}
-exports.checkResponse = checkResponse;
-/**
- * Checks response status (sync) and throws a helpful error message if status is not OK.
- * @param response
- */
-function checkResponseSync(response) {
-    if (!response.ok) {
-        let message = `${response.status} ${response.statusText}`;
-        message = message.length > 60 ? `${message.slice(0, 60)}...` : message;
-        throw new Error(message);
-    }
-}
-exports.checkResponseSync = checkResponseSync;
-// HELPERS
-async function getResponseError(response) {
-    let message = `Failed to fetch resource ${response.url} (${response.status}): `;
-    try {
-        const contentType = response.headers.get('Content-Type');
-        let text = response.statusText;
-        if (contentType.includes('application/json')) {
-            text += ` ${await response.text()}`;
-        }
-        message += text;
-        message = message.length > 60 ? `${message.slice(0, 60)}...` : message;
-    }
-    catch (error) {
-        // eslint forbids return in a finally statement, so we just catch here
-    }
-    return message;
-}
-async function getInitialDataUrl(resource) {
-    const INITIAL_DATA_LENGTH = 5;
-    if (typeof resource === 'string') {
-        return `data:,${resource.slice(0, INITIAL_DATA_LENGTH)}`;
-    }
-    if (resource instanceof Blob) {
-        const blobSlice = resource.slice(0, 5);
-        return await new Promise((resolve) => {
-            const reader = new FileReader();
-            reader.onload = (event) => resolve(event?.target?.result);
-            reader.readAsDataURL(blobSlice);
-        });
-    }
-    if (resource instanceof ArrayBuffer) {
-        const slice = resource.slice(0, INITIAL_DATA_LENGTH);
-        const base64 = arrayBufferToBase64(slice);
-        return `data:base64,${base64}`;
-    }
-    return null;
-}
-// https://stackoverflow.com/questions/9267899/arraybuffer-to-base64-encoded-string
-function arrayBufferToBase64(buffer) {
-    let binary = '';
-    const bytes = new Uint8Array(buffer);
-    for (let i = 0; i < bytes.byteLength; i++) {
-        binary += String.fromCharCode(bytes[i]);
-    }
-    return btoa(binary);
-}

package/dist/lib/utils/url-utils.js

@@ -1,14 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stripQueryString = exports.extractQueryString = void 0;
-const QUERY_STRING_PATTERN = /\?.*/;
-function extractQueryString(url) {
-    const matches = url.match(QUERY_STRING_PATTERN);
-    return matches && matches[0];
-}
-exports.extractQueryString = extractQueryString;
-function stripQueryString(url) {
-    return url.replace(QUERY_STRING_PATTERN, '');
-}
-exports.stripQueryString = stripQueryString;

package/dist/null-loader.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NullLoader = exports.NullWorkerLoader = void 0;
-// __VERSION__ is injected by babel-plugin-version-inline
-// @ts-ignore TS2304: Cannot find name '__VERSION__'.
-const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
-/**
- * Loads any data and returns null (or optionally passes through data unparsed)
- */
-exports.NullWorkerLoader = {
-    name: 'Null loader',
-    id: 'null',
-    module: 'core',
-    version: VERSION,
-    worker: true,
-    mimeTypes: ['application/x.empty'],
-    extensions: ['null'],
-    tests: [() => false],
-    options: {
-        null: {}
-    }
-};
-/**
- * Returns arguments passed to the parse API in a format that can be transfered to a
- * web worker. The `context` parameter is stripped using JSON.stringify & parse.
- */
-function parseSync(arrayBuffer, options, context) {
-    if (!options.null.echoParameters)
-        return null;
-    context = context && JSON.parse(JSON.stringify(context));
-    return { arrayBuffer, options, context };
-}
-/**
- * Loads any data and returns null (or optionally passes through data unparsed)
- */
-exports.NullLoader = {
-    name: 'Null loader',
-    id: 'null',
-    module: 'core',
-    version: VERSION,
-    mimeTypes: ['application/x.empty'],
-    extensions: ['null'],
-    parse: async (arrayBuffer, options, context) => parseSync(arrayBuffer, options, context),
-    parseSync,
-    parseInBatches: async function* generator(asyncIterator, options, context) {
-        for await (const batch of asyncIterator) {
-            yield parseSync(batch, options, context);
-        }
-    },
-    tests: [() => false],
-    options: {
-        null: {
-            echoParameters: false
-        }
-    }
-};

package/dist/workers/null-worker.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const loader_utils_1 = require("@loaders.gl/loader-utils");
-const null_loader_1 = require("../null-loader");
-(0, loader_utils_1.createLoaderWorker)(null_loader_1.NullLoader);