@loaders.gl/3d-tiles 4.0.0-alpha.20 → 4.0.0-alpha.21

package/dist/tz3/tz3-archive.js

@@ -0,0 +1,72 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TZ3Archive = void 0;
+const md5_1 = __importDefault(require("md5"));
+const zip_1 = require("@loaders.gl/zip");
+const compression_1 = require("@loaders.gl/compression");
+/**
+ * Handling different compression types in zip
+ */
+const COMPRESSION_METHODS = {
+    /** No compression */
+    0: async (compressedFile) => compressedFile,
+    /** Deflation */
+    8: async (compressedFile) => {
+        const compression = new compression_1.DeflateCompression({ raw: true });
+        const decompressedData = await compression.decompress(compressedFile);
+        return decompressedData;
+    }
+};
+/**
+ * Class for handling information about 3tz file
+ */
+class TZ3Archive {
+    constructor(tz3Archive, hashFile) {
+        this.tz3Archive = tz3Archive;
+        this.hashArray = hashFile;
+    }
+    /**
+     * Returns file with the given path from 3tz archive
+     * @param path - path inside the 3tz
+     * @returns buffer with ready to use file
+     */
+    async getFile(path) {
+        // sometimes paths are not in lower case when hash file is created,
+        // so first we're looking for lower case file name and then for original one
+        let data = await this.getFileBytes(path.toLocaleLowerCase());
+        if (!data) {
+            data = await this.getFileBytes(path);
+        }
+        if (!data) {
+            throw new Error('No such file in the archieve');
+        }
+        const decompressedFile = Buffer.from(data);
+        return decompressedFile;
+    }
+    /**
+     * Trying to get raw file data by adress
+     * @param path - path inside the archive
+     * @returns buffer with the raw file data
+     */
+    async getFileBytes(path) {
+        const nameHash = Buffer.from((0, md5_1.default)(path), 'hex');
+        const fileInfo = (0, zip_1.findBin)(nameHash, this.hashArray); // implement binary search
+        if (!fileInfo) {
+            return null;
+        }
+        const localFileHeader = await (0, zip_1.parseZipLocalFileHeader)(fileInfo.offset, this.tz3Archive);
+        if (!localFileHeader) {
+            return null;
+        }
+        const compressedFile = await this.tz3Archive.slice(localFileHeader.fileDataOffset, localFileHeader.fileDataOffset + localFileHeader.compressedSize);
+        const compressionMethod = COMPRESSION_METHODS[localFileHeader.compressionMethod];
+        if (!compressionMethod) {
+            throw Error('Only Deflation compression is supported');
+        }
+        return compressionMethod(compressedFile);
+    }
+}
+exports.TZ3Archive = TZ3Archive;

package/dist/tz3/tz3-parser.d.ts

@@ -0,0 +1,10 @@
+import { FileProvider } from '@loaders.gl/zip';
+import { TZ3Archive } from './tz3-archive';
+/**
+ * Creates 3tz file handler from raw file
+ * @param fileProvider raw file data
+ * @param cb is called with information message during parsing
+ * @returns 3tz file handler
+ */
+export declare const parse3tz: (fileProvider: FileProvider, cb?: ((msg: string) => void) | undefined) => Promise<TZ3Archive>;
+//# sourceMappingURL=tz3-parser.d.ts.map

package/dist/tz3/tz3-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tz3-parser.d.ts","sourceRoot":"","sources":["../../src/tz3/tz3-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAQb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAEzC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,iBACL,YAAY,cACf,MAAM,KAAK,IAAI,kBACzB,QAAQ,UAAU,CA8BpB,CAAC"}

package/dist/tz3/tz3-parser.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parse3tz = void 0;
+const zip_1 = require("@loaders.gl/zip");
+const tz3_archive_1 = require("./tz3-archive");
+/**
+ * Creates 3tz file handler from raw file
+ * @param fileProvider raw file data
+ * @param cb is called with information message during parsing
+ * @returns 3tz file handler
+ */
+const parse3tz = async (fileProvider, cb) => {
+    const hashCDOffset = await (0, zip_1.searchFromTheEnd)(fileProvider, zip_1.cdSignature);
+    const cdFileHeader = await (0, zip_1.parseZipCDFileHeader)(hashCDOffset, fileProvider);
+    let hashData;
+    if (cdFileHeader?.fileName !== '@3dtilesIndex1@') {
+        cb?.('3tz doesnt contain hash file');
+        hashData = await (0, zip_1.generateHashInfo)(fileProvider);
+        cb?.('hash info has been composed according to central directory records');
+    }
+    else {
+        cb?.('3tz contains hash file');
+        const localFileHeader = await (0, zip_1.parseZipLocalFileHeader)(cdFileHeader.localHeaderOffset, fileProvider);
+        if (!localFileHeader) {
+            throw new Error('corrupted 3tz');
+        }
+        const fileDataOffset = localFileHeader.fileDataOffset;
+        const hashFile = await fileProvider.slice(fileDataOffset, fileDataOffset + localFileHeader.compressedSize);
+        hashData = (0, zip_1.parseHashFile)(hashFile);
+    }
+    return new tz3_archive_1.TZ3Archive(fileProvider, hashData);
+};
+exports.parse3tz = parse3tz;

package/dist/tz3-loader.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { LoaderOptions, LoaderWithParser } from '@loaders.gl/loader-utils';
+/** options to load data from 3tz */
+export type TZ3LoaderOptions = LoaderOptions & {
+    tz3?: {
+        /** path inside the 3tz archive */
+        path?: string;
+    };
+};
+/**
+ * Loader for 3tz packages
+ */
+export declare const TZ3Loader: LoaderWithParser<Buffer, never, TZ3LoaderOptions>;
+//# sourceMappingURL=tz3-loader.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tz3-loader.d.ts","sourceRoot":"","sources":["../src/tz3-loader.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,aAAa,EAAE,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAQzE,oCAAoC;AACpC,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,GAAG,CAAC,EAAE;QACJ,kCAAkC;QAClC,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,gBAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,gBAAgB,CASvE,CAAC"}

package/dist/tz3-loader.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TZ3Loader = void 0;
+const zip_1 = require("@loaders.gl/zip");
+const tz3_parser_1 = require("./tz3/tz3-parser");
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+/**
+ * Loader for 3tz packages
+ */
+exports.TZ3Loader = {
+    name: '3tz',
+    id: '3tz',
+    module: 'i3s',
+    version: VERSION,
+    mimeTypes: ['application/octet-stream'],
+    parse: parse3tz,
+    extensions: ['3tz'],
+    options: {}
+};
+/**
+ * returns a single file from the 3tz archive
+ * @param data 3tz archive data
+ * @param options options
+ * @returns requested file
+ */
+async function parse3tz(data, options = {}) {
+    return (await (0, tz3_parser_1.parse3tz)(new zip_1.DataViewFile(new DataView(data)))).getFile(options.tz3?.path ?? '');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/3d-tiles",
-  "version": "4.0.0-alpha.20",
+  "version": "4.0.0-alpha.21",
   "description": "3D Tiles, an open standard for streaming massive heterogeneous 3D geospatial datasets.",
   "license": "MIT",
   "publishConfig": {
@@ -34,11 +34,11 @@
     "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/dist.min.js"
   },
   "dependencies": {
-    "@loaders.gl/draco": "4.0.0-alpha.20",
-    "@loaders.gl/gltf": "4.0.0-alpha.20",
-    "@loaders.gl/loader-utils": "4.0.0-alpha.20",
-    "@loaders.gl/math": "4.0.0-alpha.20",
-    "@loaders.gl/tiles": "4.0.0-alpha.20",
+    "@loaders.gl/draco": "4.0.0-alpha.21",
+    "@loaders.gl/gltf": "4.0.0-alpha.21",
+    "@loaders.gl/loader-utils": "4.0.0-alpha.21",
+    "@loaders.gl/math": "4.0.0-alpha.21",
+    "@loaders.gl/tiles": "4.0.0-alpha.21",
     "@math.gl/core": "^3.5.1",
     "@math.gl/geospatial": "^3.5.1",
     "@probe.gl/log": "^4.0.4",
@@ -47,5 +47,5 @@
   "peerDependencies": {
     "@loaders.gl/core": "^4.0.0-alpha.8"
   },
-  "gitHead": "ac122e83102657c38207d59c631a5ce4e7aa46bd"
+  "gitHead": "df5d670b136192b26941396e944f9c46be788e83"
 }

package/src/index.ts

@@ -2,6 +2,8 @@
 export {Tiles3DLoader} from './tiles-3d-loader';
 export {CesiumIonLoader} from './cesium-ion-loader';
 export {Tile3DSubtreeLoader} from './tile-3d-subtree-loader';
+export type {TZ3LoaderOptions} from './tz3-loader';
+export {TZ3Loader} from './tz3-loader';
 
 // WRITERS
 export {Tile3DWriter} from './tile-3d-writer';

package/src/tz3/tz3-archive.ts

@@ -0,0 +1,82 @@
+import md5 from 'md5';
+import {FileProvider, parseZipLocalFileHeader, HashElement, findBin} from '@loaders.gl/zip';
+import {DeflateCompression} from '@loaders.gl/compression';
+
+type CompressionHandler = (compressedFile: ArrayBuffer) => Promise<ArrayBuffer>;
+
+/**
+ * Handling different compression types in zip
+ */
+const COMPRESSION_METHODS: {[key: number]: CompressionHandler} = {
+  /** No compression */
+  0: async (compressedFile) => compressedFile,
+
+  /** Deflation */
+  8: async (compressedFile) => {
+    const compression = new DeflateCompression({raw: true});
+    const decompressedData = await compression.decompress(compressedFile);
+    return decompressedData;
+  }
+};
+
+/**
+ * Class for handling information about 3tz file
+ */
+export class TZ3Archive {
+  private tz3Archive: FileProvider;
+  private hashArray: HashElement[];
+  constructor(tz3Archive: FileProvider, hashFile: HashElement[]) {
+    this.tz3Archive = tz3Archive;
+    this.hashArray = hashFile;
+  }
+
+  /**
+   * Returns file with the given path from 3tz archive
+   * @param path - path inside the 3tz
+   * @returns buffer with ready to use file
+   */
+  async getFile(path: string): Promise<Buffer> {
+    // sometimes paths are not in lower case when hash file is created,
+    // so first we're looking for lower case file name and then for original one
+    let data = await this.getFileBytes(path.toLocaleLowerCase());
+    if (!data) {
+      data = await this.getFileBytes(path);
+    }
+    if (!data) {
+      throw new Error('No such file in the archieve');
+    }
+    const decompressedFile = Buffer.from(data);
+
+    return decompressedFile;
+  }
+
+  /**
+   * Trying to get raw file data by adress
+   * @param path - path inside the archive
+   * @returns buffer with the raw file data
+   */
+  private async getFileBytes(path: string): Promise<ArrayBuffer | null> {
+    const nameHash = Buffer.from(md5(path), 'hex');
+    const fileInfo = findBin(nameHash, this.hashArray); // implement binary search
+    if (!fileInfo) {
+      return null;
+    }
+
+    const localFileHeader = await parseZipLocalFileHeader(fileInfo.offset, this.tz3Archive);
+    if (!localFileHeader) {
+      return null;
+    }
+
+    const compressedFile = await this.tz3Archive.slice(
+      localFileHeader.fileDataOffset,
+      localFileHeader.fileDataOffset + localFileHeader.compressedSize
+    );
+
+    const compressionMethod = COMPRESSION_METHODS[localFileHeader.compressionMethod];
+    if (!compressionMethod) {
+      throw Error('Only Deflation compression is supported');
+    }
+
+    return compressionMethod(compressedFile);
+  }
+}

package/src/tz3/tz3-parser.ts

@@ -0,0 +1,52 @@
+import {
+  FileProvider,
+  HashElement,
+  cdSignature as cdHeaderSignature,
+  generateHashInfo,
+  parseHashFile,
+  parseZipCDFileHeader,
+  parseZipLocalFileHeader,
+  searchFromTheEnd
+} from '@loaders.gl/zip';
+import {TZ3Archive} from './tz3-archive';
+
+/**
+ * Creates 3tz file handler from raw file
+ * @param fileProvider raw file data
+ * @param cb is called with information message during parsing
+ * @returns 3tz file handler
+ */
+export const parse3tz = async (
+  fileProvider: FileProvider,
+  cb?: (msg: string) => void
+): Promise<TZ3Archive> => {
+  const hashCDOffset = await searchFromTheEnd(fileProvider, cdHeaderSignature);
+
+  const cdFileHeader = await parseZipCDFileHeader(hashCDOffset, fileProvider);
+
+  let hashData: HashElement[];
+  if (cdFileHeader?.fileName !== '@3dtilesIndex1@') {
+    cb?.('3tz doesnt contain hash file');
+    hashData = await generateHashInfo(fileProvider);
+    cb?.('hash info has been composed according to central directory records');
+  } else {
+    cb?.('3tz contains hash file');
+    const localFileHeader = await parseZipLocalFileHeader(
+      cdFileHeader.localHeaderOffset,
+      fileProvider
+    );
+    if (!localFileHeader) {
+      throw new Error('corrupted 3tz');
+    }
+
+    const fileDataOffset = localFileHeader.fileDataOffset;
+    const hashFile = await fileProvider.slice(
+      fileDataOffset,
+      fileDataOffset + localFileHeader.compressedSize
+    );
+
+    hashData = parseHashFile(hashFile);
+  }
+
+  return new TZ3Archive(fileProvider, hashData);
+};

package/src/tz3-loader.ts

@@ -0,0 +1,41 @@
+import {LoaderOptions, LoaderWithParser} from '@loaders.gl/loader-utils';
+import {DataViewFile} from '@loaders.gl/zip';
+import {parse3tz as parse3tzFromProvider} from './tz3/tz3-parser';
+
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+
+/** options to load data from 3tz */
+export type TZ3LoaderOptions = LoaderOptions & {
+  tz3?: {
+    /** path inside the 3tz archive */
+    path?: string;
+  };
+};
+
+/**
+ * Loader for 3tz packages
+ */
+export const TZ3Loader: LoaderWithParser<Buffer, never, TZ3LoaderOptions> = {
+  name: '3tz',
+  id: '3tz',
+  module: 'i3s',
+  version: VERSION,
+  mimeTypes: ['application/octet-stream'],
+  parse: parse3tz,
+  extensions: ['3tz'],
+  options: {}
+};
+
+/**
+ * returns a single file from the 3tz archive
+ * @param data 3tz archive data
+ * @param options options
+ * @returns requested file
+ */
+async function parse3tz(data: ArrayBuffer, options: TZ3LoaderOptions = {}) {
+  return (await parse3tzFromProvider(new DataViewFile(new DataView(data)))).getFile(
+    options.tz3?.path ?? ''
+  );
+}