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

package/dist/lib/node/fs.js

@@ -1,29 +1,42 @@
-import fs from 'fs';
-import { toArrayBuffer } from './buffer-utils.node';
-import { promisify } from 'util';
-
-const error = fsFunction => () => {
-  throw new Error(`${fsFunction} not available in browser`);
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-
-export const isSupported = Boolean(fs);
-export const open = fs !== null && fs !== void 0 && fs.open ? promisify(fs.open) : error('fs.open');
-export const close = fs !== null && fs !== void 0 && fs.close ? promisify(fs.close) : error('fs.close');
-export const read = fs !== null && fs !== void 0 && fs.read ? promisify(fs.read) : error('fs.read');
-export const readFile = fs !== null && fs !== void 0 && fs.readFile ? promisify(fs.readFile) : error('fs.readFile');
-export const readFileSync = fs !== null && fs !== void 0 && fs.readFileSync ? fs.readFileSync : error('fs.readFileSync');
-export const writeFile = fs !== null && fs !== void 0 && fs.writeFile ? promisify(fs.writeFile) : error('fs.writeFile');
-export const writeFileSync = fs !== null && fs !== void 0 && fs.writeFileSync ? fs.writeFileSync : error('fs.writeFileSync');
-export async function _readToArrayBuffer(fd, start, length) {
-  const buffer = Buffer.alloc(length);
-  const {
-    bytesRead
-  } = await read(fd, buffer, 0, length, start);
-
-  if (bytesRead !== length) {
-    throw new Error('fs.read failed');
-  }
-
-  return toArrayBuffer(buffer);
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._readToArrayBuffer = exports.isSupported = exports.fstat = exports.read = exports.close = exports.open = exports.writeFileSync = exports.writeFile = exports.readFileSync = exports.readFile = exports.stat = exports.readdir = void 0;
+// fs wrapper (promisified fs + avoids bundling fs in browsers)
+const fs_1 = __importDefault(require("fs"));
+const buffer_1 = require("./buffer");
+const util_1 = require("./util");
+// paths
+/** Wrapper for Node.js fs method */
+exports.readdir = (0, util_1.promisify)(fs_1.default.readdir);
+/** Wrapper for Node.js fs method */
+exports.stat = (0, util_1.promisify)(fs_1.default.stat);
+/** Wrapper for Node.js fs method */
+exports.readFile = (0, util_1.promisify)(fs_1.default.readFile);
+/** Wrapper for Node.js fs method */
+exports.readFileSync = fs_1.default.readFileSync;
+/** Wrapper for Node.js fs method */
+exports.writeFile = (0, util_1.promisify)(fs_1.default.writeFile);
+/** Wrapper for Node.js fs method */
+exports.writeFileSync = fs_1.default.writeFileSync;
+// file descriptors
+/** Wrapper for Node.js fs method */
+exports.open = (0, util_1.promisify)(fs_1.default.open);
+/** Wrapper for Node.js fs method */
+exports.close = (0, util_1.promisify)(fs_1.default.close);
+/** Wrapper for Node.js fs method */
+exports.read = (0, util_1.promisify)(fs_1.default.read);
+/** Wrapper for Node.js fs method */
+exports.fstat = (0, util_1.promisify)(fs_1.default.fstat);
+exports.isSupported = Boolean(fs_1.default);
+async function _readToArrayBuffer(fd, start, length) {
+    const buffer = Buffer.alloc(length);
+    const { bytesRead } = await (0, exports.read)(fd, buffer, 0, length, start);
+    if (bytesRead !== length) {
+        throw new Error('fs.read failed');
+    }
+    return (0, buffer_1.toArrayBuffer)(buffer);
 }
-//# sourceMappingURL=fs.js.map
+exports._readToArrayBuffer = _readToArrayBuffer;

package/dist/lib/node/util.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+import * as util from 'util';
+/** Wrapper for Node.js promisify */
+export declare const promisify: typeof util.promisify;
+//# sourceMappingURL=util.d.ts.map

package/dist/lib/node/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/lib/node/util.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,oCAAoC;AACpC,eAAO,MAAM,SAAS,uBAAiB,CAAC"}

package/dist/lib/node/util.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promisify = void 0;
+const util = __importStar(require("util"));
+/** Wrapper for Node.js promisify */
+exports.promisify = util.promisify;

package/dist/lib/parser-utils/parse-json.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Minimal JSON parser that throws more meaningful error messages
+ */
+export declare function parseJSON(string: string): any;
+//# sourceMappingURL=parse-json.d.ts.map

package/dist/lib/parser-utils/parse-json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-json.d.ts","sourceRoot":"","sources":["../../../src/lib/parser-utils/parse-json.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,GAAG,CAM7C"}

package/dist/lib/parser-utils/parse-json.js

@@ -1,9 +1,16 @@
-import { getFirstCharacters } from '../binary-utils/get-first-characters';
-export function parseJSON(string) {
-  try {
-    return JSON.parse(string);
-  } catch (_) {
-    throw new Error(`Failed to parse JSON from data starting with "${getFirstCharacters(string)}"`);
-  }
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseJSON = void 0;
+const get_first_characters_1 = require("../binary-utils/get-first-characters");
+/**
+ * Minimal JSON parser that throws more meaningful error messages
+ */
+function parseJSON(string) {
+    try {
+        return JSON.parse(string);
+    }
+    catch (_) {
+        throw new Error(`Failed to parse JSON from data starting with "${(0, get_first_characters_1.getFirstCharacters)(string)}"`);
+    }
 }
-//# sourceMappingURL=parse-json.js.map
+exports.parseJSON = parseJSON;

package/dist/lib/path-utils/file-aliases.d.ts

@@ -0,0 +1,17 @@
+export declare function setPathPrefix(prefix: string): void;
+export declare function getPathPrefix(): string;
+/**
+ *
+ * @param aliases
+ *
+ * Note: addAliases are an experimental export, they are only for testing of loaders.gl loaders
+ * not intended as a generic aliasing mechanism
+ */
+export declare function addAliases(aliases: {
+    [aliasPath: string]: string;
+}): void;
+/**
+ * Resolves aliases and adds path-prefix to paths
+ */
+export declare function resolvePath(filename: string): string;
+//# sourceMappingURL=file-aliases.d.ts.map

package/dist/lib/path-utils/file-aliases.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-aliases.d.ts","sourceRoot":"","sources":["../../../src/lib/path-utils/file-aliases.ts"],"names":[],"mappings":"AAQA,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAElD;AAKD,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE;IAAC,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAAA;CAAC,GAAG,IAAI,CAEvE;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAWpD"}

package/dist/lib/path-utils/file-aliases.js

@@ -1,26 +1,47 @@
+"use strict";
+// Simple file alias mechanisms for tests.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolvePath = exports.addAliases = exports.getPathPrefix = exports.setPathPrefix = void 0;
 let pathPrefix = '';
 const fileAliases = {};
-export function setPathPrefix(prefix) {
-  pathPrefix = prefix;
+/*
+ * Set a relative path prefix
+ */
+function setPathPrefix(prefix) {
+    pathPrefix = prefix;
 }
-export function getPathPrefix() {
-  return pathPrefix;
+exports.setPathPrefix = setPathPrefix;
+/*
+ * Get the relative path prefix
+ */
+function getPathPrefix() {
+    return pathPrefix;
 }
-export function addAliases(aliases) {
-  Object.assign(fileAliases, aliases);
+exports.getPathPrefix = getPathPrefix;
+/**
+ *
+ * @param aliases
+ *
+ * Note: addAliases are an experimental export, they are only for testing of loaders.gl loaders
+ * not intended as a generic aliasing mechanism
+ */
+function addAliases(aliases) {
+    Object.assign(fileAliases, aliases);
 }
-export function resolvePath(filename) {
-  for (const alias in fileAliases) {
-    if (filename.startsWith(alias)) {
-      const replacement = fileAliases[alias];
-      filename = filename.replace(alias, replacement);
+exports.addAliases = addAliases;
+/**
+ * Resolves aliases and adds path-prefix to paths
+ */
+function resolvePath(filename) {
+    for (const alias in fileAliases) {
+        if (filename.startsWith(alias)) {
+            const replacement = fileAliases[alias];
+            filename = filename.replace(alias, replacement);
+        }
     }
-  }
-
-  if (!filename.startsWith('http://') && !filename.startsWith('https://')) {
-    filename = `${pathPrefix}${filename}`;
-  }
-
-  return filename;
+    if (!filename.startsWith('http://') && !filename.startsWith('https://')) {
+        filename = `${pathPrefix}${filename}`;
+    }
+    return filename;
 }
-//# sourceMappingURL=file-aliases.js.map
+exports.resolvePath = resolvePath;

package/dist/lib/path-utils/path.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Replacement for Node.js path.filename
+ * @param url
+ */
+export declare function filename(url: string): string;
+/**
+ * Replacement for Node.js path.dirname
+ * @param url
+ */
+export declare function dirname(url: string): string;
+/**
+ * Replacement for Node.js path.join
+ * @param parts
+ */
+export declare function join(...parts: string[]): string;
+//# sourceMappingURL=path.d.ts.map

package/dist/lib/path-utils/path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../../src/lib/path-utils/path.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAG5C;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAG3C;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAY/C"}

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

@@ -1,20 +1,40 @@
-export function dirname(url) {
-  const slashIndex = url && url.lastIndexOf('/');
-  return slashIndex >= 0 ? url.substr(0, slashIndex) : '';
+"use strict";
+// Beginning of a minimal implementation of the Node.js path API, that doesn't pull in big polyfills.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.join = exports.dirname = exports.filename = void 0;
+/**
+ * Replacement for Node.js path.filename
+ * @param url
+ */
+function filename(url) {
+    const slashIndex = url && url.lastIndexOf('/');
+    return slashIndex >= 0 ? url.substr(slashIndex + 1) : '';
 }
-export function join(...parts) {
-  const separator = '/';
-  parts = parts.map((part, index) => {
-    if (index) {
-      part = part.replace(new RegExp(`^${separator}`), '');
-    }
-
-    if (index !== parts.length - 1) {
-      part = part.replace(new RegExp(`${separator}$`), '');
-    }
-
-    return part;
-  });
-  return parts.join(separator);
+exports.filename = filename;
+/**
+ * Replacement for Node.js path.dirname
+ * @param url
+ */
+function dirname(url) {
+    const slashIndex = url && url.lastIndexOf('/');
+    return slashIndex >= 0 ? url.substr(0, slashIndex) : '';
 }
-//# sourceMappingURL=path.js.map
+exports.dirname = dirname;
+/**
+ * Replacement for Node.js path.join
+ * @param parts
+ */
+function join(...parts) {
+    const separator = '/';
+    parts = parts.map((part, index) => {
+        if (index) {
+            part = part.replace(new RegExp(`^${separator}`), '');
+        }
+        if (index !== parts.length - 1) {
+            part = part.replace(new RegExp(`${separator}$`), '');
+        }
+        return part;
+    });
+    return parts.join(separator);
+}
+exports.join = join;

package/dist/lib/request-utils/request-scheduler.d.ts

@@ -0,0 +1,62 @@
+import { Stats } from '@probe.gl/stats';
+declare type Handle = any;
+declare type DoneFunction = () => any;
+declare type GetPriorityFunction = () => number;
+declare type RequestResult = {
+    done: DoneFunction;
+} | null;
+/** RequestScheduler Options */
+export declare type RequestSchedulerProps = {
+    id?: string;
+    throttleRequests?: boolean;
+    maxRequests?: number;
+};
+/** Tracks one request */
+declare type Request = {
+    handle: Handle;
+    priority: number;
+    getPriority: GetPriorityFunction;
+    resolve?: (value: any) => any;
+};
+/**
+ * Used to issue a request, without having them "deeply queued" by the browser.
+ * @todo - Track requests globally, across multiple servers
+ */
+export default class RequestScheduler {
+    readonly props: Required<RequestSchedulerProps>;
+    readonly stats: Stats;
+    activeRequestCount: number;
+    /** Tracks the number of active requests and prioritizes/cancels queued requests. */
+    private requestQueue;
+    private requestMap;
+    private deferredUpdate;
+    constructor(props?: RequestSchedulerProps);
+    /**
+     * Called by an application that wants to issue a request, without having it deeply queued by the browser
+     *
+     * When the returned promise resolved, it is OK for the application to issue a request.
+     * The promise resolves to an object that contains a `done` method.
+     * When the application's request has completed (or failed), the application must call the `done` function
+     *
+     * @param handle
+     * @param getPriority will be called when request "slots" open up,
+     *    allowing the caller to update priority or cancel the request
+     *    Highest priority executes first, priority < 0 cancels the request
+     * @returns a promise
+     *   - resolves to a object (with a `done` field) when the request can be issued without queueing,
+     *   - resolves to `null` if the request has been cancelled (by the callback return < 0).
+     *     In this case the application should not issue the request
+     */
+    scheduleRequest(handle: Handle, getPriority?: GetPriorityFunction): Promise<RequestResult>;
+    _issueRequest(request: Request): Promise<any>;
+    /** We check requests asynchronously, to prevent multiple updates */
+    _issueNewRequests(): void;
+    /** Refresh all requests  */
+    _issueNewRequestsAsync(): void;
+    /** Ensure all requests have updated priorities, and that no longer valid requests are cancelled */
+    _updateAllRequests(): void;
+    /** Update a single request by calling the callback */
+    _updateRequest(request: any): boolean;
+}
+export {};
+//# sourceMappingURL=request-scheduler.d.ts.map

package/dist/lib/request-utils/request-scheduler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-scheduler.d.ts","sourceRoot":"","sources":["../../../src/lib/request-utils/request-scheduler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAEtC,aAAK,MAAM,GAAG,GAAG,CAAC;AAClB,aAAK,YAAY,GAAG,MAAM,GAAG,CAAC;AAC9B,aAAK,mBAAmB,GAAG,MAAM,MAAM,CAAC;AACxC,aAAK,aAAa,GAAG;IACnB,IAAI,EAAE,YAAY,CAAC;CACpB,GAAG,IAAI,CAAC;AAET,+BAA+B;AAC/B,oBAAY,qBAAqB,GAAG;IAClC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAgBF,yBAAyB;AACzB,aAAK,OAAO,GAAG;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,mBAAmB,CAAC;IACjC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC;IAChD,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAK;IAE/B,oFAAoF;IACpF,OAAO,CAAC,YAAY,CAAiB;IACrC,OAAO,CAAC,UAAU,CAAkD;IACpE,OAAO,CAAC,cAAc,CAAa;gBAEvB,KAAK,GAAE,qBAA0B;IAY7C;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,WAAW,GAAE,mBAA6B,GACzC,OAAO,CAAC,aAAa,CAAC;IA0BzB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAuB7C,oEAAoE;IACpE,iBAAiB,IAAI,IAAI;IAMzB,4BAA4B;IAC5B,sBAAsB;IAwBtB,mGAAmG;IACnG,kBAAkB;IAgBlB,sDAAsD;IACtD,cAAc,CAAC,OAAO,KAAA;CAUvB"}