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

package/dist/3d-tiles-archive/3d-tiles-archive-archive.d.ts

@@ -0,0 +1,29 @@
+import { FileProvider, HashElement } from '@loaders.gl/zip';
+/**
+ * Class for handling information about 3tz file
+ */
+export declare class Tiles3DArchive {
+    /** FileProvider with whe whole file */
+    private fileProvider;
+    /** hash info */
+    private hashArray;
+    /**
+     * creates Tiles3DArchive handler
+     * @param fileProvider - FileProvider with the whole file
+     * @param hashFile - hash info
+     */
+    constructor(fileProvider: FileProvider, hashFile: HashElement[]);
+    /**
+     * Returns file with the given path from 3tz archive
+     * @param path - path inside the 3tz
+     * @returns buffer with ready to use file
+     */
+    getFile(path: string): Promise<ArrayBuffer>;
+    /**
+     * Trying to get raw file data by adress
+     * @param path - path inside the archive
+     * @returns buffer with the raw file data
+     */
+    private getFileBytes;
+}
+//# sourceMappingURL=3d-tiles-archive-archive.d.ts.map

package/dist/3d-tiles-archive/3d-tiles-archive-archive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"3d-tiles-archive-archive.d.ts","sourceRoot":"","sources":["../../src/3d-tiles-archive/3d-tiles-archive-archive.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAA2B,WAAW,EAAU,MAAM,iBAAiB,CAAC;AAe5F;;GAEG;AACH,qBAAa,cAAc;IACzB,uCAAuC;IACvC,OAAO,CAAC,YAAY,CAAe;IACnC,gBAAgB;IAChB,OAAO,CAAC,SAAS,CAAgB;IAEjC;;;;OAIG;gBACS,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE;IAK/D;;;;OAIG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAcjD;;;;OAIG;YACW,YAAY;CAwB3B"}

package/dist/3d-tiles-archive/3d-tiles-archive-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.Tiles3DArchive = 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: (data) => new compression_1.NoCompression().decompress(data),
+    /** Deflation */
+    8: (data) => new compression_1.DeflateCompression({ raw: true }).decompress(data)
+};
+/**
+ * Class for handling information about 3tz file
+ */
+class Tiles3DArchive {
+    /**
+     * creates Tiles3DArchive handler
+     * @param fileProvider - FileProvider with the whole file
+     * @param hashFile - hash info
+     */
+    constructor(fileProvider, hashFile) {
+        this.fileProvider = fileProvider;
+        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 archive');
+        }
+        return data;
+    }
+    /**
+     * 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.fileProvider);
+        if (!localFileHeader) {
+            return null;
+        }
+        const compressedFile = await this.fileProvider.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.Tiles3DArchive = Tiles3DArchive;

package/dist/3d-tiles-archive/3d-tiles-archive-parser.d.ts

@@ -0,0 +1,10 @@
+import { FileProvider } from '@loaders.gl/zip';
+import { Tiles3DArchive } from './3d-tiles-archive-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 parse3DTilesArchive: (fileProvider: FileProvider, cb?: ((msg: string) => void) | undefined) => Promise<Tiles3DArchive>;
+//# sourceMappingURL=3d-tiles-archive-parser.d.ts.map

package/dist/3d-tiles-archive/3d-tiles-archive-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"3d-tiles-archive-parser.d.ts","sourceRoot":"","sources":["../../src/3d-tiles-archive/3d-tiles-archive-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAQb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAC;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,iBAChB,YAAY,cACf,MAAM,KAAK,IAAI,kBACzB,QAAQ,cAAc,CA8BxB,CAAC"}

package/dist/3d-tiles-archive/3d-tiles-archive-parser.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parse3DTilesArchive = void 0;
+const zip_1 = require("@loaders.gl/zip");
+const _3d_tiles_archive_archive_1 = require("./3d-tiles-archive-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 parse3DTilesArchive = 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 _3d_tiles_archive_archive_1.Tiles3DArchive(fileProvider, hashData);
+};
+exports.parse3DTilesArchive = parse3DTilesArchive;

package/dist/3d-tiles-archive-loader.d.ts

@@ -0,0 +1,13 @@
+import { LoaderOptions, LoaderWithParser } from '@loaders.gl/loader-utils';
+/** options to load data from 3tz */
+export type Tiles3DArchiveFileLoaderOptions = LoaderOptions & {
+    '3d-tiles-archive'?: {
+        /** path inside the 3tz archive */
+        path?: string;
+    };
+};
+/**
+ * Loader for 3tz packages
+ */
+export declare const Tiles3DArchiveFileLoader: LoaderWithParser<ArrayBuffer, never, Tiles3DArchiveFileLoaderOptions>;
+//# sourceMappingURL=3d-tiles-archive-loader.d.ts.map

package/dist/3d-tiles-archive-loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"3d-tiles-archive-loader.d.ts","sourceRoot":"","sources":["../src/3d-tiles-archive-loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAQzE,oCAAoC;AACpC,MAAM,MAAM,+BAA+B,GAAG,aAAa,GAAG;IAC5D,kBAAkB,CAAC,EAAE;QACnB,kCAAkC;QAClC,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,gBAAgB,CACrD,WAAW,EACX,KAAK,EACL,+BAA+B,CAUhC,CAAC"}

package/dist/3d-tiles-archive-loader.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tiles3DArchiveFileLoader = void 0;
+const zip_1 = require("@loaders.gl/zip");
+const _3d_tiles_archive_parser_1 = require("./3d-tiles-archive/3d-tiles-archive-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.Tiles3DArchiveFileLoader = {
+    name: '3tz',
+    id: '3tz',
+    module: '3d-tiles',
+    version: VERSION,
+    mimeTypes: ['application/octet-stream', 'application/vnd.maxar.archive.3tz+zip'],
+    parse: parse3DTilesArchive,
+    extensions: ['3tz'],
+    options: {}
+};
+/**
+ * returns a single file from the 3tz archive
+ * @param data 3tz archive data
+ * @param options options
+ * @returns requested file
+ */
+async function parse3DTilesArchive(data, options = {}) {
+    const archive = await (0, _3d_tiles_archive_parser_1.parse3DTilesArchive)(new zip_1.DataViewFile(new DataView(data)));
+    return archive.getFile(options['3d-tiles-archive']?.path ?? '');
+}