@loaders.gl/schema 5.0.0-alpha.4 → 5.0.0-alpha.6
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/dist.dev.js +379 -41
- package/dist/dist.min.js +3 -3
- package/dist/geometry/geoarrow.d.ts +69 -0
- package/dist/geometry/geoarrow.d.ts.map +1 -0
- package/dist/geometry/geoarrow.js +5 -0
- package/dist/geometry/geoarrow.js.map +1 -0
- package/dist/index.cjs +71 -1
- package/dist/index.cjs.map +2 -2
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/metadata.d.ts +40 -0
- package/dist/metadata.d.ts.map +1 -0
- package/dist/metadata.js +86 -0
- package/dist/metadata.js.map +1 -0
- package/dist/types/schema.d.ts +3 -0
- package/dist/types/schema.d.ts.map +1 -1
- package/package.json +2 -2
- package/src/geometry/geoarrow.ts +116 -0
- package/src/index.ts +26 -0
- package/src/metadata.ts +115 -0
- package/src/types/schema.ts +1 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,WAAW,EAAC,+BAA4B;AAErD,uFAAuF;AACvF,MAAM,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEpE,sEAAsE;AACtE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,+CAA+C;IAC/C,MAAM,CAAC,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;KAAC,EAAE,CAAC;CAChD,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAE/E;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAMrF;AAED,kEAAkE;AAClE,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,IAAI,CAkBjF;AAED,gEAAgE;AAChE,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,GAAG,IAAI,CAEjF;AAED,6EAA6E;AAC7E,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAc1D;AAED,uEAAuE;AACvE,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAWtF;AAED,qDAAqD;AACrD,wBAAgB,uBAAuB,CACrC,mBAAmB,EAAE,MAAM,GAC1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAWhC"}
|
package/dist/metadata.js
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
// loaders.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// Copyright (c) vis.gl contributors
|
|
4
|
+
/**
|
|
5
|
+
* Reads one metadata value from an Arrow-like metadata container.
|
|
6
|
+
*
|
|
7
|
+
* @param metadata Metadata map or object.
|
|
8
|
+
* @param key Metadata key.
|
|
9
|
+
* @returns Stored value or `null` when absent.
|
|
10
|
+
*/
|
|
11
|
+
export function getMetadataValue(metadata, key) {
|
|
12
|
+
return metadata instanceof Map ? metadata.get(key) || null : metadata[key] || null;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Writes one metadata value to an Arrow-like metadata container.
|
|
16
|
+
*
|
|
17
|
+
* @param metadata Metadata map or object.
|
|
18
|
+
* @param key Metadata key.
|
|
19
|
+
* @param value Metadata value.
|
|
20
|
+
*/
|
|
21
|
+
export function setMetadataValue(metadata, key, value) {
|
|
22
|
+
if (metadata instanceof Map) {
|
|
23
|
+
metadata.set(key, value);
|
|
24
|
+
}
|
|
25
|
+
else {
|
|
26
|
+
metadata[key] = value;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
/** Reads GeoParquet metadata from a schema metadata container. */
|
|
30
|
+
export function getGeoMetadata(metadata) {
|
|
31
|
+
if (!metadata) {
|
|
32
|
+
return null;
|
|
33
|
+
}
|
|
34
|
+
const stringifiedGeoMetadata = getMetadataValue(metadata, 'geo');
|
|
35
|
+
const geoMetadata = stringifiedGeoMetadata && parseJSONStringMetadata(stringifiedGeoMetadata);
|
|
36
|
+
if (!geoMetadata) {
|
|
37
|
+
return null;
|
|
38
|
+
}
|
|
39
|
+
for (const column of Object.values(geoMetadata.columns || {})) {
|
|
40
|
+
if (column && typeof column === 'object' && typeof column.encoding === 'string') {
|
|
41
|
+
column.encoding = column.encoding.toLowerCase();
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
return geoMetadata;
|
|
45
|
+
}
|
|
46
|
+
/** Stores GeoParquet metadata under the top-level `geo` key. */
|
|
47
|
+
export function setGeoMetadata(metadata, geoMetadata) {
|
|
48
|
+
setMetadataValue(metadata, 'geo', JSON.stringify(geoMetadata));
|
|
49
|
+
}
|
|
50
|
+
/** Unpacks top-level GeoParquet metadata into flattened metadata entries. */
|
|
51
|
+
export function unpackGeoMetadata(metadata) {
|
|
52
|
+
const geoMetadata = getGeoMetadata(metadata);
|
|
53
|
+
if (!geoMetadata) {
|
|
54
|
+
return;
|
|
55
|
+
}
|
|
56
|
+
const { version, primary_column: primaryColumn, columns } = geoMetadata;
|
|
57
|
+
if (version) {
|
|
58
|
+
setMetadataValue(metadata, 'geo.version', version);
|
|
59
|
+
}
|
|
60
|
+
if (primaryColumn) {
|
|
61
|
+
setMetadataValue(metadata, 'geo.primary_column', primaryColumn);
|
|
62
|
+
}
|
|
63
|
+
setMetadataValue(metadata, 'geo.columns', Object.keys(columns || {}).join(','));
|
|
64
|
+
}
|
|
65
|
+
/** Unpacks one JSON metadata value into flattened metadata entries. */
|
|
66
|
+
export function unpackJSONStringMetadata(metadata, metadataKey) {
|
|
67
|
+
const stringifiedMetadata = getMetadataValue(metadata, metadataKey);
|
|
68
|
+
const json = stringifiedMetadata && parseJSONStringMetadata(stringifiedMetadata);
|
|
69
|
+
for (const [key, value] of Object.entries(json || {})) {
|
|
70
|
+
setMetadataValue(metadata, `${metadataKey}.${key}`, typeof value === 'string' ? value : JSON.stringify(value));
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
/** Parses one JSON metadata value into an object. */
|
|
74
|
+
export function parseJSONStringMetadata(stringifiedMetadata) {
|
|
75
|
+
if (!stringifiedMetadata) {
|
|
76
|
+
return null;
|
|
77
|
+
}
|
|
78
|
+
try {
|
|
79
|
+
const metadata = JSON.parse(stringifiedMetadata);
|
|
80
|
+
return metadata && typeof metadata === 'object' ? metadata : null;
|
|
81
|
+
}
|
|
82
|
+
catch {
|
|
83
|
+
return null;
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
//# sourceMappingURL=metadata.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../src/metadata.ts"],"names":[],"mappings":"AAAA,aAAa;AACb,+BAA+B;AAC/B,oCAAoC;AAepC;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAkB,EAAE,GAAW;IAC9D,OAAO,QAAQ,YAAY,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;AACrF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAkB,EAAE,GAAW,EAAE,KAAa;IAC7E,IAAI,QAAQ,YAAY,GAAG,EAAE,CAAC;QAC5B,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACxB,CAAC;AACH,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,cAAc,CAAC,QAA8B;IAC3D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,sBAAsB,GAAG,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACjE,MAAM,WAAW,GAAG,sBAAsB,IAAI,uBAAuB,CAAC,sBAAsB,CAAC,CAAC;IAC9F,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;QAC9D,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAChF,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QAClD,CAAC;IACH,CAAC;IAED,OAAO,WAA0B,CAAC;AACpC,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,cAAc,CAAC,QAAkB,EAAE,WAAwB;IACzE,gBAAgB,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,iBAAiB,CAAC,QAAkB;IAClD,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC7C,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO;IACT,CAAC;IAED,MAAM,EAAC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,EAAC,GAAG,WAAW,CAAC;IACtE,IAAI,OAAO,EAAE,CAAC;QACZ,gBAAgB,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,aAAa,EAAE,CAAC;QAClB,gBAAgB,CAAC,QAAQ,EAAE,oBAAoB,EAAE,aAAa,CAAC,CAAC;IAClE,CAAC;IACD,gBAAgB,CAAC,QAAQ,EAAE,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAClF,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,wBAAwB,CAAC,QAAkB,EAAE,WAAmB;IAC9E,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,mBAAmB,IAAI,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;IAEjF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;QACtD,gBAAgB,CACd,QAAQ,EACR,GAAG,WAAW,IAAI,GAAG,EAAE,EACvB,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAC1D,CAAC;IACJ,CAAC;AACH,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,uBAAuB,CACrC,mBAA2B;IAE3B,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACjD,OAAO,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IACpE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}
|
package/dist/types/schema.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/types/schema.ts"],"names":[],"mappings":"AAIA,0BAA0B;AAC1B,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEjF,+BAA+B;AAC/B,MAAM,MAAM,QAAQ,GAChB,MAAM,GAEN,MAAM,GACN,KAAK,GACL,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,SAAS,GACT,SAAS,GACT,SAAS,GACT,QAAQ,GACR,aAAa,GACb,MAAM,GACN,WAAW,GACX,UAAU,GACV,kBAAkB,GAClB,aAAa,GACb,kBAAkB,GAClB,kBAAkB,GAClB,iBAAiB,GACjB,kBAAkB,GAClB,uBAAuB,GACvB,uBAAuB,GACvB,sBAAsB,GACtB,kBAAkB,GAClB,oBAAoB,GAEpB;IAAC,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAC,GACrE;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,KAAK,EAAE,CAAA;CAAC,GACjC;IAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,KAAK,EAAE,CAAA;CAAC,GACnC;IACE,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,KAAK,EAAE,CAAC;IAClB,kBAAkB,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;CAC7C,GACD;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,KAAK,EAAE,CAAC;IAClB,kBAAkB,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;CAC7C,GACD;IAAC,IAAI,EAAE,mBAAmB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAC,GAC9C;IAAC,IAAI,EAAE,iBAAiB,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,KAAK,EAAE,CAAA;CAAC,GAC9D;IAAC,IAAI,EAAE,KAAK,CAAC;IAAC,UAAU,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,KAAK,EAAE,CAAA;CAAC,GACrD;IAAC,IAAI,EAAE,YAAY,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAC,CAAC;AAGjG;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACpD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEnD,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,QAAQ,EAAE,cAAc,CAAC;CAC1B,CAAC"}
|
|
1
|
+
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/types/schema.ts"],"names":[],"mappings":"AAIA,0BAA0B;AAC1B,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEjF,+BAA+B;AAC/B,MAAM,MAAM,QAAQ,GAChB,MAAM,GAEN,MAAM,GACN,KAAK,GACL,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,SAAS,GACT,SAAS,GACT,SAAS,GACT,QAAQ,GACR,aAAa,GACb,MAAM,GACN,WAAW,GACX,UAAU,GACV,kBAAkB,GAClB,aAAa,GACb,kBAAkB,GAClB,kBAAkB,GAClB,iBAAiB,GACjB,kBAAkB,GAClB,uBAAuB,GACvB,uBAAuB,GACvB,sBAAsB,GACtB,kBAAkB,GAClB,oBAAoB,GAEpB;IAAC,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAC,GACrE;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,KAAK,EAAE,CAAA;CAAC,GACjC;IAAC,IAAI,EAAE,YAAY,CAAC;IAAC,QAAQ,EAAE,KAAK,EAAE,CAAA;CAAC,GACvC;IAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,KAAK,EAAE,CAAA;CAAC,GACnC;IACE,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,KAAK,EAAE,CAAC;IAClB,kBAAkB,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;CAC7C,GACD;IACE,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,KAAK,EAAE,CAAC;IAClB,kBAAkB,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;CAC7C,GACD;IAAC,IAAI,EAAE,mBAAmB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAC,GAC9C;IAAC,IAAI,EAAE,iBAAiB,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,KAAK,EAAE,CAAA;CAAC,GAC9D;IAAC,IAAI,EAAE,KAAK,CAAC;IAAC,UAAU,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,KAAK,EAAE,CAAA;CAAC,GACrD;IAAC,IAAI,EAAE,YAAY,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAC,CAAC;AAGjG;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACpD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEnD,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,QAAQ,EAAE,cAAc,CAAC;CAC1B,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@loaders.gl/schema",
|
|
3
|
-
"version": "5.0.0-alpha.
|
|
3
|
+
"version": "5.0.0-alpha.6",
|
|
4
4
|
"description": "Table format APIs for JSON, CSV, etc...",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -44,5 +44,5 @@
|
|
|
44
44
|
"@types/geojson": "^7946.0.7",
|
|
45
45
|
"apache-arrow": ">= 17.0.0"
|
|
46
46
|
},
|
|
47
|
-
"gitHead": "
|
|
47
|
+
"gitHead": "9b9ea7738e0fe63e55c19c136283705f99e0b9bf"
|
|
48
48
|
}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
// loaders.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
/** Canonical GeoArrow extension names. */
|
|
6
|
+
export type GeoArrowEncoding =
|
|
7
|
+
| 'geoarrow.geometry'
|
|
8
|
+
| 'geoarrow.geometrycollection'
|
|
9
|
+
| 'geoarrow.multipolygon'
|
|
10
|
+
| 'geoarrow.polygon'
|
|
11
|
+
| 'geoarrow.multilinestring'
|
|
12
|
+
| 'geoarrow.linestring'
|
|
13
|
+
| 'geoarrow.multipoint'
|
|
14
|
+
| 'geoarrow.point'
|
|
15
|
+
| 'geoarrow.box'
|
|
16
|
+
| 'geoarrow.wkb'
|
|
17
|
+
| 'geoarrow.wkt';
|
|
18
|
+
|
|
19
|
+
/** Preferred output policy for loader-facing GeoArrow conversions. */
|
|
20
|
+
export type GeoArrowEncodingPreference = 'geoarrow.wkb' | 'geoarrow.geometry' | 'optimized';
|
|
21
|
+
|
|
22
|
+
/** Coordinate dimensions understood by GeoArrow and GeoParquet. */
|
|
23
|
+
export type GeoArrowDimension = 'xy' | 'xyz' | 'xym' | 'xyzm';
|
|
24
|
+
|
|
25
|
+
/** Coordinate memory layouts understood by GeoArrow. */
|
|
26
|
+
export type GeoArrowCoordinateLayout = 'interleaved' | 'separated';
|
|
27
|
+
|
|
28
|
+
/** Offset widths supported by variable-length GeoArrow arrays. */
|
|
29
|
+
export type GeoArrowOffsetType = 'int32' | 'int64';
|
|
30
|
+
|
|
31
|
+
/** One axis-aligned GeoArrow Box value in canonical child order. */
|
|
32
|
+
export type GeoArrowBox = {
|
|
33
|
+
xmin: number;
|
|
34
|
+
ymin: number;
|
|
35
|
+
xmax: number;
|
|
36
|
+
ymax: number;
|
|
37
|
+
zmin?: number;
|
|
38
|
+
zmax?: number;
|
|
39
|
+
mmin?: number;
|
|
40
|
+
mmax?: number;
|
|
41
|
+
};
|
|
42
|
+
|
|
43
|
+
/** Non-planar edge interpretations used by geospatial metadata. */
|
|
44
|
+
export type GeoArrowEdgeType = 'spherical' | 'vincenty' | 'thomas' | 'andoyer' | 'karney';
|
|
45
|
+
|
|
46
|
+
/** Geometry type names used by GeoParquet metadata. */
|
|
47
|
+
export type GeoParquetGeometryType =
|
|
48
|
+
| 'Point'
|
|
49
|
+
| 'LineString'
|
|
50
|
+
| 'Polygon'
|
|
51
|
+
| 'MultiPoint'
|
|
52
|
+
| 'MultiLineString'
|
|
53
|
+
| 'MultiPolygon'
|
|
54
|
+
| 'GeometryCollection'
|
|
55
|
+
| 'Point Z'
|
|
56
|
+
| 'LineString Z'
|
|
57
|
+
| 'Polygon Z'
|
|
58
|
+
| 'MultiPoint Z'
|
|
59
|
+
| 'MultiLineString Z'
|
|
60
|
+
| 'MultiPolygon Z'
|
|
61
|
+
| 'GeometryCollection Z'
|
|
62
|
+
| 'Point M'
|
|
63
|
+
| 'LineString M'
|
|
64
|
+
| 'Polygon M'
|
|
65
|
+
| 'MultiPoint M'
|
|
66
|
+
| 'MultiLineString M'
|
|
67
|
+
| 'MultiPolygon M'
|
|
68
|
+
| 'GeometryCollection M'
|
|
69
|
+
| 'Point ZM'
|
|
70
|
+
| 'LineString ZM'
|
|
71
|
+
| 'Polygon ZM'
|
|
72
|
+
| 'MultiPoint ZM'
|
|
73
|
+
| 'MultiLineString ZM'
|
|
74
|
+
| 'MultiPolygon ZM'
|
|
75
|
+
| 'GeometryCollection ZM';
|
|
76
|
+
|
|
77
|
+
/** JSON-compatible CRS value accepted by GeoArrow extension metadata. */
|
|
78
|
+
export type GeoArrowCRSValue = Record<string, unknown> | string;
|
|
79
|
+
|
|
80
|
+
/** CRS representation tag used by GeoArrow extension metadata. */
|
|
81
|
+
export type GeoArrowCRSType = 'projjson' | 'wkt2:2019' | 'authority_code' | 'srid';
|
|
82
|
+
|
|
83
|
+
/** CRS metadata attached to a GeoArrow field. */
|
|
84
|
+
export type GeoArrowCRSMetadata =
|
|
85
|
+
| {crs?: undefined; crs_type?: undefined}
|
|
86
|
+
| {crs: Record<string, unknown>; crs_type?: 'projjson'}
|
|
87
|
+
| {crs: string; crs_type: 'wkt2:2019' | 'authority_code' | 'srid'}
|
|
88
|
+
| {crs: string; crs_type?: undefined};
|
|
89
|
+
|
|
90
|
+
/** Metadata attached to a GeoArrow extension field. */
|
|
91
|
+
export type GeoArrowMetadata = GeoArrowCRSMetadata & {
|
|
92
|
+
encoding?: GeoArrowEncoding;
|
|
93
|
+
edges?: GeoArrowEdgeType;
|
|
94
|
+
geometry_types?: GeoParquetGeometryType[];
|
|
95
|
+
[key: string]: unknown;
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
/** Metadata for one geometry column in a GeoParquet file. */
|
|
99
|
+
export type GeoColumnMetadata = {
|
|
100
|
+
encoding: string;
|
|
101
|
+
geometry_types: GeoParquetGeometryType[];
|
|
102
|
+
crs?: Record<string, unknown> | null;
|
|
103
|
+
orientation?: 'counterclockwise';
|
|
104
|
+
bbox?: number[];
|
|
105
|
+
edges?: 'planar' | GeoArrowEdgeType;
|
|
106
|
+
epoch?: number;
|
|
107
|
+
[key: string]: unknown;
|
|
108
|
+
};
|
|
109
|
+
|
|
110
|
+
/** File-level GeoParquet metadata stored under the `geo` key. */
|
|
111
|
+
export type GeoMetadata = {
|
|
112
|
+
version?: string;
|
|
113
|
+
primary_column?: string;
|
|
114
|
+
columns: Record<string, GeoColumnMetadata>;
|
|
115
|
+
[key: string]: unknown;
|
|
116
|
+
};
|
package/src/index.ts
CHANGED
|
@@ -16,7 +16,33 @@ export type {
|
|
|
16
16
|
// SCHEMAS AND DATA TYPES
|
|
17
17
|
|
|
18
18
|
export type {Schema, Field, DataType, KeyType, SchemaMetadata, FieldMetadata} from './types/schema';
|
|
19
|
+
export type {Metadata, SchemaWithMetadata} from './metadata';
|
|
20
|
+
export {
|
|
21
|
+
getGeoMetadata,
|
|
22
|
+
getMetadataValue,
|
|
23
|
+
parseJSONStringMetadata,
|
|
24
|
+
setGeoMetadata,
|
|
25
|
+
setMetadataValue,
|
|
26
|
+
unpackGeoMetadata,
|
|
27
|
+
unpackJSONStringMetadata
|
|
28
|
+
} from './metadata';
|
|
19
29
|
export type {Batch} from './types/batch';
|
|
30
|
+
export type {
|
|
31
|
+
GeoArrowEncoding,
|
|
32
|
+
GeoArrowEncodingPreference,
|
|
33
|
+
GeoArrowDimension,
|
|
34
|
+
GeoArrowCoordinateLayout,
|
|
35
|
+
GeoArrowOffsetType,
|
|
36
|
+
GeoArrowBox,
|
|
37
|
+
GeoArrowEdgeType,
|
|
38
|
+
GeoArrowCRSValue,
|
|
39
|
+
GeoArrowCRSType,
|
|
40
|
+
GeoArrowCRSMetadata,
|
|
41
|
+
GeoArrowMetadata,
|
|
42
|
+
GeoParquetGeometryType,
|
|
43
|
+
GeoColumnMetadata,
|
|
44
|
+
GeoMetadata
|
|
45
|
+
} from './geometry/geoarrow';
|
|
20
46
|
|
|
21
47
|
// TABLE CATEGORY TYPES
|
|
22
48
|
export type {
|
package/src/metadata.ts
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
// loaders.gl
|
|
2
|
+
// SPDX-License-Identifier: MIT
|
|
3
|
+
// Copyright (c) vis.gl contributors
|
|
4
|
+
|
|
5
|
+
import type {GeoMetadata} from './geometry/geoarrow';
|
|
6
|
+
|
|
7
|
+
/** Metadata container compatible with Apache Arrow metadata maps and plain objects. */
|
|
8
|
+
export type Metadata = Map<string, string> | Record<string, string>;
|
|
9
|
+
|
|
10
|
+
/** Arrow-like schema shape that exposes schema and field metadata. */
|
|
11
|
+
export type SchemaWithMetadata = {
|
|
12
|
+
/** Schema-level metadata. */
|
|
13
|
+
metadata?: Metadata;
|
|
14
|
+
/** Top-level fields with optional metadata. */
|
|
15
|
+
fields?: {name: string; metadata?: Metadata}[];
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Reads one metadata value from an Arrow-like metadata container.
|
|
20
|
+
*
|
|
21
|
+
* @param metadata Metadata map or object.
|
|
22
|
+
* @param key Metadata key.
|
|
23
|
+
* @returns Stored value or `null` when absent.
|
|
24
|
+
*/
|
|
25
|
+
export function getMetadataValue(metadata: Metadata, key: string): string | null {
|
|
26
|
+
return metadata instanceof Map ? metadata.get(key) || null : metadata[key] || null;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Writes one metadata value to an Arrow-like metadata container.
|
|
31
|
+
*
|
|
32
|
+
* @param metadata Metadata map or object.
|
|
33
|
+
* @param key Metadata key.
|
|
34
|
+
* @param value Metadata value.
|
|
35
|
+
*/
|
|
36
|
+
export function setMetadataValue(metadata: Metadata, key: string, value: string): void {
|
|
37
|
+
if (metadata instanceof Map) {
|
|
38
|
+
metadata.set(key, value);
|
|
39
|
+
} else {
|
|
40
|
+
metadata[key] = value;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/** Reads GeoParquet metadata from a schema metadata container. */
|
|
45
|
+
export function getGeoMetadata(metadata: Metadata | undefined): GeoMetadata | null {
|
|
46
|
+
if (!metadata) {
|
|
47
|
+
return null;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
const stringifiedGeoMetadata = getMetadataValue(metadata, 'geo');
|
|
51
|
+
const geoMetadata = stringifiedGeoMetadata && parseJSONStringMetadata(stringifiedGeoMetadata);
|
|
52
|
+
if (!geoMetadata) {
|
|
53
|
+
return null;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
for (const column of Object.values(geoMetadata.columns || {})) {
|
|
57
|
+
if (column && typeof column === 'object' && typeof column.encoding === 'string') {
|
|
58
|
+
column.encoding = column.encoding.toLowerCase();
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
return geoMetadata as GeoMetadata;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
/** Stores GeoParquet metadata under the top-level `geo` key. */
|
|
66
|
+
export function setGeoMetadata(metadata: Metadata, geoMetadata: GeoMetadata): void {
|
|
67
|
+
setMetadataValue(metadata, 'geo', JSON.stringify(geoMetadata));
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/** Unpacks top-level GeoParquet metadata into flattened metadata entries. */
|
|
71
|
+
export function unpackGeoMetadata(metadata: Metadata): void {
|
|
72
|
+
const geoMetadata = getGeoMetadata(metadata);
|
|
73
|
+
if (!geoMetadata) {
|
|
74
|
+
return;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
const {version, primary_column: primaryColumn, columns} = geoMetadata;
|
|
78
|
+
if (version) {
|
|
79
|
+
setMetadataValue(metadata, 'geo.version', version);
|
|
80
|
+
}
|
|
81
|
+
if (primaryColumn) {
|
|
82
|
+
setMetadataValue(metadata, 'geo.primary_column', primaryColumn);
|
|
83
|
+
}
|
|
84
|
+
setMetadataValue(metadata, 'geo.columns', Object.keys(columns || {}).join(','));
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
/** Unpacks one JSON metadata value into flattened metadata entries. */
|
|
88
|
+
export function unpackJSONStringMetadata(metadata: Metadata, metadataKey: string): void {
|
|
89
|
+
const stringifiedMetadata = getMetadataValue(metadata, metadataKey);
|
|
90
|
+
const json = stringifiedMetadata && parseJSONStringMetadata(stringifiedMetadata);
|
|
91
|
+
|
|
92
|
+
for (const [key, value] of Object.entries(json || {})) {
|
|
93
|
+
setMetadataValue(
|
|
94
|
+
metadata,
|
|
95
|
+
`${metadataKey}.${key}`,
|
|
96
|
+
typeof value === 'string' ? value : JSON.stringify(value)
|
|
97
|
+
);
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/** Parses one JSON metadata value into an object. */
|
|
102
|
+
export function parseJSONStringMetadata(
|
|
103
|
+
stringifiedMetadata: string
|
|
104
|
+
): Record<string, unknown> | null {
|
|
105
|
+
if (!stringifiedMetadata) {
|
|
106
|
+
return null;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
try {
|
|
110
|
+
const metadata = JSON.parse(stringifiedMetadata);
|
|
111
|
+
return metadata && typeof metadata === 'object' ? metadata : null;
|
|
112
|
+
} catch {
|
|
113
|
+
return null;
|
|
114
|
+
}
|
|
115
|
+
}
|
package/src/types/schema.ts
CHANGED
|
@@ -42,6 +42,7 @@ export type DataType =
|
|
|
42
42
|
// Composite types
|
|
43
43
|
| {type: 'decimal'; bitWidth: number; precision: number; scale: number}
|
|
44
44
|
| {type: 'list'; children: Field[]} // one child only
|
|
45
|
+
| {type: 'large-list'; children: Field[]} // one child only, with 64-bit offsets
|
|
45
46
|
| {type: 'struct'; children: Field[]}
|
|
46
47
|
| {
|
|
47
48
|
type: 'sparse-union';
|