@kepler.gl/processors 3.3.0-alpha.2 → 3.3.0-alpha.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/data-processor.js +674 -0
- package/dist/cjs/data-processor.js.map +1 -0
- package/dist/cjs/export/dataset-to-geojson.js +138 -0
- package/dist/cjs/export/dataset-to-geojson.js.map +1 -0
- package/dist/cjs/export/geopackage-writer.js +385 -0
- package/dist/cjs/export/geopackage-writer.js.map +1 -0
- package/dist/cjs/export/geoparquet-writer.js +351 -0
- package/dist/cjs/export/geoparquet-writer.js.map +1 -0
- package/dist/cjs/export/kml-writer.js +347 -0
- package/dist/cjs/export/kml-writer.js.map +1 -0
- package/dist/cjs/export/shapefile-writer.js +708 -0
- package/dist/cjs/export/shapefile-writer.js.map +1 -0
- package/dist/cjs/export/sql-js.js +95 -0
- package/dist/cjs/export/sql-js.js.map +1 -0
- package/dist/cjs/export/vector-export.js +187 -0
- package/dist/cjs/export/vector-export.js.map +1 -0
- package/dist/cjs/file-handler.js +997 -0
- package/dist/cjs/file-handler.js.map +1 -0
- package/dist/cjs/index.js +114 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/kepler-csv-loader.js +163 -0
- package/dist/cjs/kepler-csv-loader.js.map +1 -0
- package/dist/cjs/loader-registry.js +542 -0
- package/dist/cjs/loader-registry.js.map +1 -0
- package/dist/cjs/remote-file.js +675 -0
- package/dist/cjs/remote-file.js.map +1 -0
- package/dist/cjs/shapefile-files.js +281 -0
- package/dist/cjs/shapefile-files.js.map +1 -0
- package/dist/cjs/types.js +6 -0
- package/dist/cjs/types.js.map +1 -0
- package/dist/data-processor.d.ts +30 -16
- package/dist/esm/data-processor.js +655 -0
- package/dist/esm/data-processor.js.map +1 -0
- package/dist/esm/export/dataset-to-geojson.js +132 -0
- package/dist/esm/export/dataset-to-geojson.js.map +1 -0
- package/dist/esm/export/geopackage-writer.js +381 -0
- package/dist/esm/export/geopackage-writer.js.map +1 -0
- package/dist/esm/export/geoparquet-writer.js +336 -0
- package/dist/esm/export/geoparquet-writer.js.map +1 -0
- package/dist/esm/export/kml-writer.js +341 -0
- package/dist/esm/export/kml-writer.js.map +1 -0
- package/dist/esm/export/shapefile-writer.js +701 -0
- package/dist/esm/export/shapefile-writer.js.map +1 -0
- package/dist/esm/export/sql-js.js +80 -0
- package/dist/esm/export/sql-js.js.map +1 -0
- package/dist/esm/export/vector-export.js +176 -0
- package/dist/esm/export/vector-export.js.map +1 -0
- package/dist/esm/file-handler.js +972 -0
- package/dist/esm/file-handler.js.map +1 -0
- package/dist/esm/index.js +12 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/kepler-csv-loader.js +152 -0
- package/dist/esm/kepler-csv-loader.js.map +1 -0
- package/dist/esm/loader-registry.js +510 -0
- package/dist/esm/loader-registry.js.map +1 -0
- package/dist/esm/remote-file.js +664 -0
- package/dist/esm/remote-file.js.map +1 -0
- package/dist/esm/shapefile-files.js +264 -0
- package/dist/esm/shapefile-files.js.map +1 -0
- package/dist/esm/types.js +3 -0
- package/dist/esm/types.js.map +1 -0
- package/dist/export/dataset-to-geojson.d.ts +12 -0
- package/dist/export/geopackage-writer.d.ts +28 -0
- package/dist/export/geoparquet-writer.d.ts +7 -0
- package/dist/export/kml-writer.d.ts +13 -0
- package/dist/export/shapefile-writer.d.ts +28 -0
- package/dist/export/sql-js.d.ts +8 -0
- package/dist/export/vector-export.d.ts +22 -0
- package/dist/file-handler.d.ts +55 -8
- package/dist/index.d.ts +6 -0
- package/dist/kepler-csv-loader.d.ts +12 -0
- package/dist/loader-registry.d.ts +29 -0
- package/dist/remote-file.d.ts +79 -0
- package/dist/shapefile-files.d.ts +39 -0
- package/dist/types.d.ts +13 -0
- package/package.json +44 -26
- package/dist/data-processor.js +0 -637
- package/dist/file-handler.js +0 -409
- package/dist/index.js +0 -39
- package/dist/types.js +0 -6
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { LoaderWithParser } from '@loaders.gl/loader-utils';
|
|
2
|
+
import type { CSVLoaderOptions } from '@loaders.gl/csv';
|
|
3
|
+
type KeplerCSVLoaderType = LoaderWithParser<any, any, CSVLoaderOptions>;
|
|
4
|
+
/**
|
|
5
|
+
* CSV loader used by Kepler's asynchronous file-loading path.
|
|
6
|
+
*
|
|
7
|
+
* The parser implementation is dynamically imported on first use. Kepler's
|
|
8
|
+
* existing row processor remains responsible for null normalization and type
|
|
9
|
+
* inference, preserving the public processCsvData contract.
|
|
10
|
+
*/
|
|
11
|
+
export declare const KeplerCSVLoader: KeplerCSVLoaderType;
|
|
12
|
+
export {};
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { Loader } from '@loaders.gl/loader-utils';
|
|
2
|
+
import { type RemoteFileFormat } from '@kepler.gl/constants';
|
|
3
|
+
export type KeplerLoaderEntry = {
|
|
4
|
+
id: string;
|
|
5
|
+
extensions: string[];
|
|
6
|
+
mimeTypes: string[];
|
|
7
|
+
load: () => Promise<Loader>;
|
|
8
|
+
};
|
|
9
|
+
type FileMetadata = {
|
|
10
|
+
name?: string;
|
|
11
|
+
type?: string;
|
|
12
|
+
};
|
|
13
|
+
export declare const KEPLER_LOADER_ENTRIES: KeplerLoaderEntry[];
|
|
14
|
+
/**
|
|
15
|
+
* True when `extension` is a dataset kepler.gl can parse (not a shapefile
|
|
16
|
+
* sidecar, and not `.zip`, which is an archive rather than a dataset).
|
|
17
|
+
* `acceptedFileFormats` still applies.
|
|
18
|
+
*/
|
|
19
|
+
export declare function isLoadableDatasetExtension(extension: string): boolean;
|
|
20
|
+
export declare function isKeplerFileFormatAccepted(token: string): boolean;
|
|
21
|
+
export declare function getAcceptedKeplerLoaderEntries(): KeplerLoaderEntry[];
|
|
22
|
+
export declare function getAcceptedRemoteFileFormats(): readonly RemoteFileFormat[];
|
|
23
|
+
/**
|
|
24
|
+
* Resolve the loaders needed for a file. Loader modules are imported only for
|
|
25
|
+
* matching extensions/MIME types; extensionless or unknown files retain core's
|
|
26
|
+
* content-based selection by loading all default candidates.
|
|
27
|
+
*/
|
|
28
|
+
export declare function getKeplerLoaders(file: FileMetadata, customLoaders?: Loader[]): Promise<Loader[]>;
|
|
29
|
+
export {};
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { ProcessorResult } from '@kepler.gl/types';
|
|
2
|
+
import { FileCacheItem } from './types';
|
|
3
|
+
export type KeplerRemoteFile = File & {
|
|
4
|
+
keplerSourceUrl?: string;
|
|
5
|
+
keplerFormat?: string;
|
|
6
|
+
keplerRefreshIntervalMs?: number;
|
|
7
|
+
keplerEtag?: string;
|
|
8
|
+
keplerLastModified?: string;
|
|
9
|
+
};
|
|
10
|
+
export type RemoteLoadProgress = {
|
|
11
|
+
loaded: number;
|
|
12
|
+
total?: number;
|
|
13
|
+
percent: number;
|
|
14
|
+
/** Set once the bytes are in memory and parsing is about to block the main thread. */
|
|
15
|
+
phase?: 'processing';
|
|
16
|
+
};
|
|
17
|
+
export type FetchRemoteFileOptions = {
|
|
18
|
+
format?: string | null;
|
|
19
|
+
onProgress?: (progress: RemoteLoadProgress) => void;
|
|
20
|
+
etag?: string;
|
|
21
|
+
lastModified?: string;
|
|
22
|
+
/** Bypass the HTTP cache. Used for poll/reload, not the first remote URL load. */
|
|
23
|
+
bypassCache?: boolean;
|
|
24
|
+
};
|
|
25
|
+
export type FetchRemoteFileResult = {
|
|
26
|
+
file: KeplerRemoteFile | null;
|
|
27
|
+
notModified: boolean;
|
|
28
|
+
etag?: string;
|
|
29
|
+
lastModified?: string;
|
|
30
|
+
size?: number;
|
|
31
|
+
};
|
|
32
|
+
export type LoadExternallyHostedDatasetResult = {
|
|
33
|
+
data: NonNullable<ProcessorResult> | null;
|
|
34
|
+
notModified: boolean;
|
|
35
|
+
etag?: string;
|
|
36
|
+
lastModified?: string;
|
|
37
|
+
size?: number;
|
|
38
|
+
};
|
|
39
|
+
export declare function getExtensionFromUrl(url: string): string;
|
|
40
|
+
export declare function getMimeTypeForFormat(format?: string | null): string | undefined;
|
|
41
|
+
export declare function isRemoteDatasetUrl(url: string): boolean;
|
|
42
|
+
/**
|
|
43
|
+
* Build a filename loaders.gl can use to pick a parser.
|
|
44
|
+
* Prefers an explicit format, then the URL path extension, then Content-Type.
|
|
45
|
+
*/
|
|
46
|
+
export declare function getFileNameForRemoteUrl(url: string, format?: string | null, mimeType?: string | null): string;
|
|
47
|
+
/**
|
|
48
|
+
* Fetch a remote dataset URL. Uses conditional headers for same-origin requests
|
|
49
|
+
* (or outside a browser) so unchanged files can skip a re-parse.
|
|
50
|
+
*/
|
|
51
|
+
export declare function fetchRemoteFile(url: string, options?: FetchRemoteFileOptions): Promise<FetchRemoteFileResult>;
|
|
52
|
+
/**
|
|
53
|
+
* A remote URL to hold until Add Data. Rows stay empty so adding it runs the
|
|
54
|
+
* externally hosted download instead of parsing a file in the modal.
|
|
55
|
+
*/
|
|
56
|
+
export declare function remoteDatasetFromUrl(url: string, format?: string | null): FileCacheItem;
|
|
57
|
+
/**
|
|
58
|
+
* Fetch a remote dataset URL and wrap it as a File the existing loadFiles pipeline can parse.
|
|
59
|
+
* Sets File.type from an explicit format or the response Content-Type so extensionless
|
|
60
|
+
* URLs (SAS keys) still select the right loader.
|
|
61
|
+
*/
|
|
62
|
+
export declare function fetchRemoteFileAsKeplerFile(url: string, format?: string | null, onProgress?: (progress: RemoteLoadProgress) => void): Promise<KeplerRemoteFile>;
|
|
63
|
+
/**
|
|
64
|
+
* Fetch, parse, and process a remote file into Kepler dataset data.
|
|
65
|
+
* Used when reloading an `externally-hosted` dataset from a saved map config
|
|
66
|
+
* and when refreshing a live remote dataset.
|
|
67
|
+
*/
|
|
68
|
+
export declare function loadExternallyHostedDataset(metadata: {
|
|
69
|
+
source: string;
|
|
70
|
+
format?: string;
|
|
71
|
+
size?: number;
|
|
72
|
+
etag?: string;
|
|
73
|
+
lastModified?: string;
|
|
74
|
+
bypassCache?: boolean;
|
|
75
|
+
onProgress?: (progress: RemoteLoadProgress) => void;
|
|
76
|
+
/** Established CSV columns, supplied only when refreshing an existing table. */
|
|
77
|
+
csvHeader?: string[];
|
|
78
|
+
}): Promise<LoadExternallyHostedDatasetResult>;
|
|
79
|
+
export declare function isExternallyHostedFile(file: File): file is KeplerRemoteFile;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
export declare const SHAPEFILE_SIDECAR_EXTENSIONS: readonly ["dbf", "shx", "prj", "cpg"];
|
|
2
|
+
export declare const SHAPEFILE_SOURCE_EXTENSIONS: readonly ["shp", "zip"];
|
|
3
|
+
type NamedFile = {
|
|
4
|
+
name: string;
|
|
5
|
+
};
|
|
6
|
+
export declare function getDroppedFileExtension(fileName?: string): string;
|
|
7
|
+
export declare function isShapefileSidecarFileName(fileName: string): boolean;
|
|
8
|
+
export declare function isZipFileName(fileName: string): boolean;
|
|
9
|
+
export declare function isShapefileSourceFileName(fileName: string): boolean;
|
|
10
|
+
/**
|
|
11
|
+
* Sidecar files (.dbf, .shx, .prj, .cpg) are not datasets. Skip them when a
|
|
12
|
+
* .shp or shapefile .zip is also present so they can be used as companions.
|
|
13
|
+
*/
|
|
14
|
+
export declare function getFilesToParse<T extends NamedFile>(files: T[]): T[];
|
|
15
|
+
export declare function createCompanionFetch(files?: File[]): ((url: string) => Promise<Response>) | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* Unpack a zip that contains a shapefile. Only top-level .shp plus sidecars
|
|
18
|
+
* are returned; nested folders are ignored.
|
|
19
|
+
*/
|
|
20
|
+
export declare function unzipShapefileArchive(zipFile: File): Promise<File[]>;
|
|
21
|
+
export type ZipArchiveExpansion = {
|
|
22
|
+
/** One shapefile and no other datasets. The load keeps the zip's name. */
|
|
23
|
+
kind: 'shapefile';
|
|
24
|
+
shapefile: File;
|
|
25
|
+
companions: File[];
|
|
26
|
+
} | {
|
|
27
|
+
/** One dataset per supported top-level file, named from that file. */
|
|
28
|
+
kind: 'datasets';
|
|
29
|
+
datasets: File[];
|
|
30
|
+
companions: File[];
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* Split a zip into datasets. A single shapefile plus sidecars stays one
|
|
34
|
+
* shapefile archive. Any other mix (CSV, GeoJSON, several shapefiles, …)
|
|
35
|
+
* becomes one file per supported member. Sidecars are returned as companions
|
|
36
|
+
* and are not datasets. Nested folders and unsupported files are skipped.
|
|
37
|
+
*/
|
|
38
|
+
export declare function expandZipArchive(zipFile: File, extraExtensions?: string[]): Promise<ZipArchiveExpansion>;
|
|
39
|
+
export {};
|
package/dist/types.d.ts
CHANGED
|
@@ -1,9 +1,22 @@
|
|
|
1
1
|
export type FileCacheItem = {
|
|
2
2
|
data: any;
|
|
3
|
+
/**
|
|
4
|
+
* Cumulative Arrow snapshots replayed after the user confirms Add Data.
|
|
5
|
+
* Kept outside `data` so the final staged dataset remains available for
|
|
6
|
+
* validation and row-count display without being added to the map early.
|
|
7
|
+
*/
|
|
8
|
+
progressiveData?: any[];
|
|
3
9
|
info: {
|
|
4
10
|
id?: string;
|
|
5
11
|
label: string;
|
|
6
12
|
format: string;
|
|
13
|
+
type?: string;
|
|
14
|
+
};
|
|
15
|
+
metadata?: {
|
|
16
|
+
source?: string;
|
|
17
|
+
format?: string;
|
|
18
|
+
sourceFormat?: string;
|
|
19
|
+
[key: string]: unknown;
|
|
7
20
|
};
|
|
8
21
|
};
|
|
9
22
|
export type ValidKeplerGlMap = {
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kepler.gl/processors",
|
|
3
3
|
"author": "Shan He <shan@uber.com>",
|
|
4
|
-
"version": "3.3.0-alpha.
|
|
4
|
+
"version": "3.3.0-alpha.21",
|
|
5
5
|
"description": "kepler.gl constants used by kepler.gl components, actions and reducers",
|
|
6
6
|
"license": "MIT",
|
|
7
|
-
"main": "dist/index.js",
|
|
7
|
+
"main": "dist/cjs/index.js",
|
|
8
8
|
"types": "dist/index.d.ts",
|
|
9
9
|
"keywords": [
|
|
10
10
|
"babel",
|
|
@@ -19,37 +19,43 @@
|
|
|
19
19
|
"url": "https://github.com/keplergl/kepler.gl.git"
|
|
20
20
|
},
|
|
21
21
|
"scripts": {
|
|
22
|
-
"build": "rm -fr dist && babel src --out-dir dist --source-maps
|
|
23
|
-
"build:umd": "NODE_OPTIONS=--openssl-legacy-provider webpack --config ./webpack/umd.js --progress --env.prod",
|
|
22
|
+
"build": "rm -fr dist && babel src --out-dir dist/cjs --source-maps true --extensions '.ts,.tsx,.js,.jsx' --ignore '**/*.d.ts,**/*.spec.ts,**/*.spec.tsx,**/*.spec.js,**/*.spec.jsx,**/*.test.ts,**/*.test.tsx,**/*.test.js,**/*.test.jsx' && BABEL_ENV=esm babel src --out-dir dist/esm --source-maps true --extensions '.ts,.tsx,.js,.jsx' --ignore '**/*.d.ts,**/*.spec.ts,**/*.spec.tsx,**/*.spec.js,**/*.spec.jsx,**/*.test.ts,**/*.test.tsx,**/*.test.js,**/*.test.jsx'",
|
|
24
23
|
"build:types": "tsc --project ./tsconfig.production.json",
|
|
25
24
|
"prepublishOnly": "babel-node ../../scripts/license-header/bin --license ../../FILE-HEADER && yarn build && yarn build:types",
|
|
26
|
-
"stab": "mkdir -p dist && touch dist/index.js"
|
|
25
|
+
"stab": "mkdir -p dist/cjs dist/esm && touch dist/cjs/index.js dist/esm/index.js"
|
|
27
26
|
},
|
|
28
27
|
"files": [
|
|
29
|
-
"dist"
|
|
30
|
-
"umd"
|
|
28
|
+
"dist"
|
|
31
29
|
],
|
|
32
30
|
"dependencies": {
|
|
33
|
-
"@deck.gl-community/editable-layers": "9.
|
|
34
|
-
"@kepler.gl/common-utils": "3.3.0-alpha.
|
|
35
|
-
"@kepler.gl/constants": "3.3.0-alpha.
|
|
36
|
-
"@kepler.gl/
|
|
37
|
-
"@kepler.gl/
|
|
38
|
-
"@kepler.gl/
|
|
39
|
-
"@kepler.gl/
|
|
40
|
-
"@
|
|
41
|
-
"@loaders.gl/
|
|
42
|
-
"@loaders.gl/
|
|
43
|
-
"@loaders.gl/
|
|
44
|
-
"@loaders.gl/
|
|
45
|
-
"@loaders.gl/
|
|
46
|
-
"@loaders.gl/
|
|
47
|
-
"@loaders.gl/
|
|
48
|
-
"@loaders.gl/
|
|
31
|
+
"@deck.gl-community/editable-layers": "9.4.1",
|
|
32
|
+
"@kepler.gl/common-utils": "3.3.0-alpha.21",
|
|
33
|
+
"@kepler.gl/constants": "3.3.0-alpha.21",
|
|
34
|
+
"@kepler.gl/layers": "3.3.0-alpha.21",
|
|
35
|
+
"@kepler.gl/schemas": "3.3.0-alpha.21",
|
|
36
|
+
"@kepler.gl/table": "3.3.0-alpha.21",
|
|
37
|
+
"@kepler.gl/types": "3.3.0-alpha.21",
|
|
38
|
+
"@kepler.gl/utils": "3.3.0-alpha.21",
|
|
39
|
+
"@loaders.gl/arrow": "^4.4.5",
|
|
40
|
+
"@loaders.gl/core": "^4.4.5",
|
|
41
|
+
"@loaders.gl/csv": "^4.4.5",
|
|
42
|
+
"@loaders.gl/excel": "^4.4.5",
|
|
43
|
+
"@loaders.gl/flatgeobuf": "^4.4.5",
|
|
44
|
+
"@loaders.gl/gis": "^4.4.5",
|
|
45
|
+
"@loaders.gl/json": "^4.4.5",
|
|
46
|
+
"@loaders.gl/kml": "^4.4.5",
|
|
47
|
+
"@loaders.gl/loader-utils": "^4.4.5",
|
|
48
|
+
"@loaders.gl/parquet": "^4.4.5",
|
|
49
|
+
"@loaders.gl/schema": "^4.4.5",
|
|
50
|
+
"@loaders.gl/shapefile": "^4.4.5",
|
|
51
|
+
"@loaders.gl/wkt": "^4.4.5",
|
|
52
|
+
"@loaders.gl/zip": "^4.4.5",
|
|
49
53
|
"@mapbox/geojson-normalize": "0.0.1",
|
|
50
|
-
"@turf/helpers": "^
|
|
54
|
+
"@turf/helpers": "^7.2.0",
|
|
51
55
|
"apache-arrow": ">=15.0.0",
|
|
52
56
|
"d3-dsv": "^2.0.0",
|
|
57
|
+
"parquet-wasm": "0.6.1",
|
|
58
|
+
"sql.js": "1.13.0",
|
|
53
59
|
"type-analyzer": "0.4.0"
|
|
54
60
|
},
|
|
55
61
|
"nyc": {
|
|
@@ -66,8 +72,20 @@
|
|
|
66
72
|
"node": ">=20"
|
|
67
73
|
},
|
|
68
74
|
"volta": {
|
|
69
|
-
"node": "
|
|
75
|
+
"node": "24.21.0",
|
|
70
76
|
"yarn": "4.4.0"
|
|
71
77
|
},
|
|
72
|
-
"packageManager": "yarn@4.4.0"
|
|
78
|
+
"packageManager": "yarn@4.4.0",
|
|
79
|
+
"module": "dist/esm/index.js",
|
|
80
|
+
"exports": {
|
|
81
|
+
".": {
|
|
82
|
+
"types": "./dist/index.d.ts",
|
|
83
|
+
"import": "./dist/esm/index.js",
|
|
84
|
+
"require": "./dist/cjs/index.js",
|
|
85
|
+
"default": "./dist/cjs/index.js"
|
|
86
|
+
}
|
|
87
|
+
},
|
|
88
|
+
"devDependencies": {
|
|
89
|
+
"@types/sql.js": "^1"
|
|
90
|
+
}
|
|
73
91
|
}
|