@loaders.gl/netcdf 4.0.0-alpha.5 → 4.0.0-alpha.7

package/dist/netcdf-loader.d.ts

@@ -1,12 +1,12 @@
 import type { Loader, LoaderWithParser, LoaderOptions } from '@loaders.gl/loader-utils';
 import type { NetCDFHeader } from './netcdfjs/netcdf-types';
-export declare type NetCDF = {
+export type NetCDF = {
     loaderData: NetCDFHeader;
     data: {
         [variableName: string]: any[][];
     };
 };
-export declare type NetCDFLoaderOptions = LoaderOptions & {
+export type NetCDFLoaderOptions = LoaderOptions & {
     netcdf?: {
         loadData?: boolean;
     };

package/dist/netcdf-loader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"netcdf-loader.d.ts","sourceRoot":"","sources":["../src/netcdf-loader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAE,gBAAgB,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AACtF,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,yBAAyB,CAAC;AAO1D,oBAAY,MAAM,GAAG;IACnB,UAAU,EAAE,YAAY,CAAC;IACzB,IAAI,EAAE;QAAC,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG,EAAE,EAAE,CAAA;KAAC,CAAC;CACzC,CAAC;AAEF,oBAAY,mBAAmB,GAAG,aAAa,GAAG;IAChD,MAAM,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;CAiB9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;CAIxB,CAAC;AAiBF,eAAO,MAAM,4BAA4B,EAAE,MAA2B,CAAC;AACvE,eAAO,MAAM,sBAAsB,EAAE,gBAA+B,CAAC"}
+{"version":3,"file":"netcdf-loader.d.ts","sourceRoot":"","sources":["../src/netcdf-loader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAE,gBAAgB,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AACtF,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,yBAAyB,CAAC;AAO1D,MAAM,MAAM,MAAM,GAAG;IACnB,UAAU,EAAE,YAAY,CAAC;IACzB,IAAI,EAAE;QAAC,CAAC,YAAY,EAAE,MAAM,GAAG,GAAG,EAAE,EAAE,CAAA;KAAC,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,aAAa,GAAG;IAChD,MAAM,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;CAiB9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;CAIxB,CAAC;AAiBF,eAAO,MAAM,4BAA4B,EAAE,MAA2B,CAAC;AACvE,eAAO,MAAM,sBAAsB,EAAE,gBAA+B,CAAC"}

package/dist/netcdf-loader.js

@@ -1,42 +1,52 @@
-import { NetCDFReader } from './netcdfjs/netcdf-reader';
-const VERSION = typeof "4.0.0-alpha.5" !== 'undefined' ? "4.0.0-alpha.5" : 'latest';
-export const NetCDFWorkerLoader = {
-  name: 'NetCDF',
-  id: 'mvt',
-  module: 'mvt',
-  version: VERSION,
-  extensions: ['cdf', 'nc'],
-  mimeTypes: ['application/netcdf', 'application/x-netcdf'],
-  category: 'image',
-  options: {
-    netcdf: {
-      loadVariables: false
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._typecheckNetCDFLoader = exports._typecheckNetCDFWorkerLoader = exports.NetCDFLoader = exports.NetCDFWorkerLoader = void 0;
+const netcdf_reader_1 = require("./netcdfjs/netcdf-reader");
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+/**
+ * Worker loader for NETCDF
+ */
+exports.NetCDFWorkerLoader = {
+    name: 'NetCDF',
+    id: 'mvt',
+    module: 'mvt',
+    version: VERSION,
+    extensions: ['cdf', 'nc'],
+    mimeTypes: [
+        'application/netcdf',
+        'application/x-netcdf'
+        // 'application/octet-stream'
+    ],
+    category: 'image',
+    options: {
+        netcdf: {
+            loadVariables: false
+        }
     }
-  }
 };
-export const NetCDFLoader = { ...NetCDFWorkerLoader,
-  parse: async (arrayBuffer, options) => parseNetCDF(arrayBuffer, options),
-  binary: true
+/**
+ * Loader for the NetCDF format
+ */
+exports.NetCDFLoader = {
+    ...exports.NetCDFWorkerLoader,
+    parse: async (arrayBuffer, options) => parseNetCDF(arrayBuffer, options),
+    binary: true
 };
-
 function parseNetCDF(arrayBuffer, options) {
-  var _options$netcdf;
-
-  const reader = new NetCDFReader(arrayBuffer);
-  const variables = {};
-
-  if (options !== null && options !== void 0 && (_options$netcdf = options.netcdf) !== null && _options$netcdf !== void 0 && _options$netcdf.loadData) {
-    for (const variable of reader.variables) {
-      variables[variable.name] = reader.getDataVariable(variable);
+    const reader = new netcdf_reader_1.NetCDFReader(arrayBuffer);
+    const variables = {};
+    if (options?.netcdf?.loadData) {
+        for (const variable of reader.variables) {
+            variables[variable.name] = reader.getDataVariable(variable);
+        }
     }
-  }
-
-  return {
-    loaderData: reader.header,
-    data: variables
-  };
+    return {
+        loaderData: reader.header,
+        data: variables
+    };
 }
-
-export const _typecheckNetCDFWorkerLoader = NetCDFWorkerLoader;
-export const _typecheckNetCDFLoader = NetCDFLoader;
-//# sourceMappingURL=netcdf-loader.js.map
+// Type tests
+exports._typecheckNetCDFWorkerLoader = exports.NetCDFWorkerLoader;
+exports._typecheckNetCDFLoader = exports.NetCDFLoader;

package/dist/netcdfjs/netcdf-reader.js

@@ -1,136 +1,165 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { IOBuffer } from '../iobuffer/iobuffer';
-import { readNetCDFHeader } from './read-header';
-import { readRecord, readNonRecord } from './read-data';
-export class NetCDFReader {
-  constructor(data) {
-    _defineProperty(this, "header", void 0);
-
-    _defineProperty(this, "buffer", void 0);
-
-    const buffer = new IOBuffer(data);
-    buffer.setBigEndian();
-    const magic = buffer.readChars(3);
-
-    if (magic !== 'CDF') {
-      throw new Error("NetCDF: file should start with 'CDF', found ".concat(magic));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetCDFReader = void 0;
+const iobuffer_1 = require("../iobuffer/iobuffer");
+const read_header_1 = require("./read-header");
+const read_data_1 = require("./read-data");
+/**
+ * Reads a NetCDF v3.x file
+ * https://www.unidata.ucar.edu/software/netcdf/docs/file_format_specifications.html
+ * @param {ArrayBuffer} data - ArrayBuffer or any Typed Array (including Node.js' Buffer from v4) with the data
+ * @constructor
+ */
+class NetCDFReader {
+    constructor(data) {
+        const buffer = new iobuffer_1.IOBuffer(data);
+        buffer.setBigEndian();
+        // Validate that it's a NetCDF file
+        const magic = buffer.readChars(3);
+        if (magic !== 'CDF') {
+            throw new Error(`NetCDF: file should start with 'CDF', found ${magic}`);
+        }
+        // Check the NetCDF format
+        const version = buffer.readByte();
+        if (version > 2) {
+            throw new Error(`NetCDF: unsupported version ${version}`);
+        }
+        // Read the header
+        this.header = (0, read_header_1.readNetCDFHeader)(buffer, version);
+        this.buffer = buffer;
     }
-
-    const version = buffer.readByte();
-
-    if (version > 2) {
-      throw new Error("NetCDF: unsupported version ".concat(version));
+    /**
+     * @return {string} - Version for the NetCDF format
+     */
+    get version() {
+        if (this.header.version === 1) {
+            return 'classic format';
+        }
+        return '64-bit offset format';
     }
-
-    this.header = readNetCDFHeader(buffer, version);
-    this.buffer = buffer;
-  }
-
-  get version() {
-    if (this.header.version === 1) {
-      return 'classic format';
+    /**
+     * Get metadata for the record dimension
+     */
+    get recordDimension() {
+        return this.header.recordDimension;
     }
-
-    return '64-bit offset format';
-  }
-
-  get recordDimension() {
-    return this.header.recordDimension;
-  }
-
-  get dimensions() {
-    return this.header.dimensions;
-  }
-
-  get attributes() {
-    return this.header.attributes;
-  }
-
-  get variables() {
-    return this.header.variables;
-  }
-
-  attributeExists(attributeName) {
-    const attribute = this.attributes.find(val => val.name === attributeName);
-    return attribute !== undefined;
-  }
-
-  getAttribute(attributeName) {
-    const attribute = this.attributes.find(val => val.name === attributeName);
-    if (attribute) return attribute.value;
-    return null;
-  }
-
-  dataVariableExists(variableName) {
-    const variable = this.header.variables.find(function (val) {
-      return val.name === variableName;
-    });
-    return variable !== undefined;
-  }
-
-  getDataVariableAsString(variableName) {
-    const variable = this.getDataVariable(variableName);
-    if (variable) return variable.join('');
-    return null;
-  }
-
-  getDataVariable(variableName) {
-    let variable;
-
-    if (typeof variableName === 'string') {
-      variable = this.header.variables.find(function (val) {
-        return val.name === variableName;
-      });
-    } else {
-      variable = variableName;
+    /**
+     * Get list of dimensions (each with `name` and `size`)
+     */
+    get dimensions() {
+        return this.header.dimensions;
     }
-
-    if (variable === undefined) {
-      throw new Error("NetCDF: variable not found: ".concat(variableName));
+    /**
+     * Get list of global attributes with:
+     *  * `name`: String with the name of the attribute
+     *  * `type`: String with the type of the attribute
+     *  * `value`: A number or string with the value of the attribute
+     */
+    get attributes() {
+        return this.header.attributes;
     }
-
-    this.buffer.seek(variable.offset);
-
-    if (variable.record) {
-      return readRecord(this.buffer, variable, this.header.recordDimension);
+    /**
+     * Get list of variables
+     */
+    get variables() {
+        return this.header.variables;
     }
-
-    return readNonRecord(this.buffer, variable);
-  }
-
-  toString() {
-    const result = [];
-    result.push('DIMENSIONS');
-
-    for (const dimension of this.dimensions) {
-      result.push("  ".concat(dimension.name.padEnd(30), " = size: ").concat(dimension.size));
+    /**
+     * Check if an attribute exists
+     * @param attributeName - Name of the attribute to find
+     * @return
+     */
+    attributeExists(attributeName) {
+        const attribute = this.attributes.find((val) => val.name === attributeName);
+        return attribute !== undefined;
     }
-
-    result.push('');
-    result.push('GLOBAL ATTRIBUTES');
-
-    for (const attribute of this.attributes) {
-      result.push("  ".concat(attribute.name.padEnd(30), " = ").concat(attribute.value));
+    /**
+     * Returns the value of an attribute
+     * @param attributeName
+     * @return Value of the attributeName or null
+     */
+    getAttribute(attributeName) {
+        const attribute = this.attributes.find((val) => val.name === attributeName);
+        if (attribute)
+            return attribute.value;
+        return null;
     }
-
-    const variables = JSON.parse(JSON.stringify(this.variables));
-    result.push('');
-    result.push('VARIABLES:');
-
-    for (const variable of variables) {
-      variable.value = this.getDataVariable(variable);
-      let stringify = JSON.stringify(variable.value);
-      if (stringify.length > 50) stringify = stringify.substring(0, 50);
-
-      if (!isNaN(variable.value.length)) {
-        stringify += " (length: ".concat(variable.value.length, ")");
-      }
-
-      result.push("  ".concat(variable.name.padEnd(30), " = ").concat(stringify));
+    /**
+     * Check if a dataVariable exists
+     * @param variableName - Name of the variable to find
+     * @return
+     */
+    dataVariableExists(variableName) {
+        const variable = this.header.variables.find(function (val) {
+            return val.name === variableName;
+        });
+        return variable !== undefined;
+    }
+    /**
+     * Returns the value of a variable as a string
+     * @param variableName
+     * @return Value of the variable as a string or null
+     */
+    getDataVariableAsString(variableName) {
+        const variable = this.getDataVariable(variableName);
+        if (variable)
+            return variable.join('');
+        return null;
+    }
+    /**
+     * Retrieves the data for a given variable
+     * @param variableName - Name of the variable to search or variable object
+     * @return List with the variable values
+     */
+    getDataVariable(variableName) {
+        let variable;
+        if (typeof variableName === 'string') {
+            // search the variable
+            variable = this.header.variables.find(function (val) {
+                return val.name === variableName;
+            });
+        }
+        else {
+            variable = variableName;
+        }
+        // throws if variable not found
+        if (variable === undefined) {
+            throw new Error(`NetCDF: variable not found: ${variableName}`);
+        }
+        // go to the offset position
+        this.buffer.seek(variable.offset);
+        if (variable.record) {
+            // record variable case
+            return (0, read_data_1.readRecord)(this.buffer, variable, this.header.recordDimension);
+        }
+        // non-record variable case
+        return (0, read_data_1.readNonRecord)(this.buffer, variable);
+    }
+    toString() {
+        const result = [];
+        result.push('DIMENSIONS');
+        for (const dimension of this.dimensions) {
+            result.push(`  ${dimension.name.padEnd(30)} = size: ${dimension.size}`);
+        }
+        result.push('');
+        result.push('GLOBAL ATTRIBUTES');
+        for (const attribute of this.attributes) {
+            result.push(`  ${attribute.name.padEnd(30)} = ${attribute.value}`);
+        }
+        const variables = JSON.parse(JSON.stringify(this.variables));
+        result.push('');
+        result.push('VARIABLES:');
+        for (const variable of variables) {
+            variable.value = this.getDataVariable(variable);
+            let stringify = JSON.stringify(variable.value);
+            if (stringify.length > 50)
+                stringify = stringify.substring(0, 50);
+            if (!isNaN(variable.value.length)) {
+                stringify += ` (length: ${variable.value.length})`;
+            }
+            result.push(`  ${variable.name.padEnd(30)} = ${stringify}`);
+        }
+        return result.join('\n');
     }
-
-    return result.join('\n');
-  }
-
 }
-//# sourceMappingURL=netcdf-reader.js.map
+exports.NetCDFReader = NetCDFReader;

package/dist/netcdfjs/netcdf-types.d.ts

@@ -5,7 +5,7 @@
  * @param attributes: List of global attributes
  * @param variables: List of variables
  */
-export declare type NetCDFHeader = {
+export type NetCDFHeader = {
     version: number;
     recordDimension: NetCDFRecordDimension;
     dimensions: NetCDFDimension[];
@@ -19,7 +19,7 @@ export declare type NetCDFHeader = {
  * @param name  name of the record dimension
  * @param recordStep the record variables step size
  */
-export declare type NetCDFRecordDimension = {
+export type NetCDFRecordDimension = {
     length: number;
     id: number;
     name: string;
@@ -32,7 +32,7 @@ export declare type NetCDFRecordDimension = {
  * @param recordId: id of the dimension that has unlimited size or undefined,
  * @param recordName: name of the dimension that has unlimited size
  */
-export declare type NetCDFDimension = {
+export type NetCDFDimension = {
     name: string;
     size: number;
     recordId: number;
@@ -48,7 +48,7 @@ export declare type NetCDFDimension = {
  * @param offset Number with the offset where of the variable begins
  * @param record True if is a record variable, false otherwise (unlimited size)
  */
-export declare type NetCDFVariable = {
+export type NetCDFVariable = {
     name: string;
     dimensions: [];
     attributes: [];
@@ -62,7 +62,7 @@ export declare type NetCDFVariable = {
  * @param type type of the attribute
  * @param value number or string with the value of the attribute
  */
-export declare type NetCDFAttribute = {
+export type NetCDFAttribute = {
     name: string;
     type: string;
     value: string;

package/dist/netcdfjs/netcdf-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"netcdf-types.d.ts","sourceRoot":"","sources":["../../src/netcdfjs/netcdf-types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,oBAAY,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,qBAAqB,CAAC;IACvC,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,SAAS,EAAE,cAAc,EAAE,CAAC;CAC7B,CAAC;AAEF;;;;;;GAMG;AACH,oBAAY,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;GASG;AACH,oBAAY,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,EAAE,CAAC;IACf,UAAU,EAAE,EAAE,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"netcdf-types.d.ts","sourceRoot":"","sources":["../../src/netcdfjs/netcdf-types.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,qBAAqB,CAAC;IACvC,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,SAAS,EAAE,cAAc,EAAE,CAAC;CAC7B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,EAAE,CAAC;IACf,UAAU,EAAE,EAAE,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/netcdfjs/netcdf-types.js

@@ -1,2 +1,2 @@
-export {};
-//# sourceMappingURL=netcdf-types.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/netcdfjs/read-data.js

@@ -1,28 +1,49 @@
-import { readType, str2num, num2bytes } from './read-type';
-export function readNonRecord(buffer, variable) {
-  const type = str2num(variable.type);
-  const size = variable.size / num2bytes(type);
-  const data = new Array(size);
-
-  for (let i = 0; i < size; i++) {
-    data[i] = readType(buffer, type, 1);
-  }
-
-  return data;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readRecord = exports.readNonRecord = void 0;
+const read_type_1 = require("./read-type");
+// const STREAMING = 4294967295;
+/**
+ * Read data for the given non-record variable
+ * @param buffer - Buffer for the file data
+ * @param variable - Variable metadata
+ * @return Data of the element
+ */
+function readNonRecord(buffer, variable) {
+    // variable type
+    const type = (0, read_type_1.str2num)(variable.type);
+    // size of the data
+    const size = variable.size / (0, read_type_1.num2bytes)(type);
+    // iterates over the data
+    const data = new Array(size);
+    for (let i = 0; i < size; i++) {
+        data[i] = (0, read_type_1.readType)(buffer, type, 1);
+    }
+    return data;
 }
-export function readRecord(buffer, variable, recordDimension) {
-  const type = str2num(variable.type);
-  const width = variable.size ? variable.size / num2bytes(type) : 1;
-  const size = recordDimension.length;
-  const data = new Array(size);
-  const step = recordDimension.recordStep;
-
-  for (let i = 0; i < size; i++) {
-    const currentOffset = buffer.offset;
-    data[i] = readType(buffer, type, width);
-    buffer.seek(currentOffset + step);
-  }
-
-  return data;
+exports.readNonRecord = readNonRecord;
+/**
+ * Read data for the given record variable
+ * @param buffer - Buffer for the file data
+ * @param variable - Variable metadata
+ * @param recordDimension - Record dimension metadata
+ * @return - Data of the element
+ */
+function readRecord(buffer, variable, recordDimension) {
+    // variable type
+    const type = (0, read_type_1.str2num)(variable.type);
+    const width = variable.size ? variable.size / (0, read_type_1.num2bytes)(type) : 1;
+    // size of the data
+    // TODO streaming data
+    const size = recordDimension.length;
+    // iterates over the data
+    const data = new Array(size);
+    const step = recordDimension.recordStep;
+    for (let i = 0; i < size; i++) {
+        const currentOffset = buffer.offset;
+        data[i] = (0, read_type_1.readType)(buffer, type, width);
+        buffer.seek(currentOffset + step);
+    }
+    return data;
 }
-//# sourceMappingURL=read-data.js.map
+exports.readRecord = readRecord;