@loaders.gl/scientific 0.0.0-stage → 5.0.0-alpha.13

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.
Files changed (175) hide show
  1. package/README.md +21 -2
  2. package/dist/index.cjs +4313 -0
  3. package/dist/index.cjs.map +6 -0
  4. package/dist/index.d.ts +11 -0
  5. package/dist/index.d.ts.map +1 -0
  6. package/dist/index.js +8 -0
  7. package/dist/index.js.map +1 -0
  8. package/dist/netcdf/bundled.cjs +1394 -0
  9. package/dist/netcdf/bundled.d.ts +2 -0
  10. package/dist/netcdf/bundled.d.ts.map +1 -0
  11. package/dist/netcdf/bundled.js +5 -0
  12. package/dist/netcdf/bundled.js.map +1 -0
  13. package/dist/netcdf/index.cjs +1394 -0
  14. package/dist/netcdf/index.cjs.map +6 -0
  15. package/dist/netcdf/index.d.ts +7 -0
  16. package/dist/netcdf/index.d.ts.map +1 -0
  17. package/dist/netcdf/index.js +8 -0
  18. package/dist/netcdf/index.js.map +1 -0
  19. package/dist/netcdf/iobuffer/iobuffer.d.ts +253 -0
  20. package/dist/netcdf/iobuffer/iobuffer.d.ts.map +1 -0
  21. package/dist/netcdf/iobuffer/iobuffer.js +450 -0
  22. package/dist/netcdf/iobuffer/iobuffer.js.map +1 -0
  23. package/dist/netcdf/netcdf-format.cjs +39 -0
  24. package/dist/netcdf/netcdf-format.d.ts +11 -0
  25. package/dist/netcdf/netcdf-format.d.ts.map +1 -0
  26. package/dist/netcdf/netcdf-format.js +14 -0
  27. package/dist/netcdf/netcdf-format.js.map +1 -0
  28. package/dist/netcdf/netcdf-loader-with-parser.cjs +995 -0
  29. package/dist/netcdf/netcdf-loader-with-parser.d.ts +60 -0
  30. package/dist/netcdf/netcdf-loader-with-parser.d.ts.map +1 -0
  31. package/dist/netcdf/netcdf-loader-with-parser.js +35 -0
  32. package/dist/netcdf/netcdf-loader-with-parser.js.map +1 -0
  33. package/dist/netcdf/netcdf-loader.cjs +84 -0
  34. package/dist/netcdf/netcdf-loader.d.ts +81 -0
  35. package/dist/netcdf/netcdf-loader.d.ts.map +1 -0
  36. package/dist/netcdf/netcdf-loader.js +41 -0
  37. package/dist/netcdf/netcdf-loader.js.map +1 -0
  38. package/dist/netcdf/netcdf-source-loader-types.cjs +78 -0
  39. package/dist/netcdf/netcdf-source-loader-types.d.ts +28 -0
  40. package/dist/netcdf/netcdf-source-loader-types.d.ts.map +1 -0
  41. package/dist/netcdf/netcdf-source-loader-types.js +32 -0
  42. package/dist/netcdf/netcdf-source-loader-types.js.map +1 -0
  43. package/dist/netcdf/netcdf-source-loader.cjs +1319 -0
  44. package/dist/netcdf/netcdf-source-loader.d.ts +59 -0
  45. package/dist/netcdf/netcdf-source-loader.d.ts.map +1 -0
  46. package/dist/netcdf/netcdf-source-loader.js +421 -0
  47. package/dist/netcdf/netcdf-source-loader.js.map +1 -0
  48. package/dist/netcdf/netcdfjs/netcdf-reader.d.ts +68 -0
  49. package/dist/netcdf/netcdfjs/netcdf-reader.d.ts.map +1 -0
  50. package/dist/netcdf/netcdfjs/netcdf-reader.js +172 -0
  51. package/dist/netcdf/netcdfjs/netcdf-reader.js.map +1 -0
  52. package/dist/netcdf/netcdfjs/netcdf-types.d.ts +70 -0
  53. package/dist/netcdf/netcdfjs/netcdf-types.d.ts.map +1 -0
  54. package/dist/netcdf/netcdfjs/netcdf-types.js +3 -0
  55. package/dist/netcdf/netcdfjs/netcdf-types.js.map +1 -0
  56. package/dist/netcdf/netcdfjs/read-data.d.ts +19 -0
  57. package/dist/netcdf/netcdfjs/read-data.d.ts.map +1 -0
  58. package/dist/netcdf/netcdfjs/read-data.js +51 -0
  59. package/dist/netcdf/netcdfjs/read-data.js.map +1 -0
  60. package/dist/netcdf/netcdfjs/read-header.d.ts +16 -0
  61. package/dist/netcdf/netcdfjs/read-header.d.ts.map +1 -0
  62. package/dist/netcdf/netcdfjs/read-header.js +227 -0
  63. package/dist/netcdf/netcdfjs/read-header.js.map +1 -0
  64. package/dist/netcdf/netcdfjs/read-type.d.ts +36 -0
  65. package/dist/netcdf/netcdfjs/read-type.d.ts.map +1 -0
  66. package/dist/netcdf/netcdfjs/read-type.js +135 -0
  67. package/dist/netcdf/netcdfjs/read-type.js.map +1 -0
  68. package/dist/netcdf/unbundled.cjs +1394 -0
  69. package/dist/netcdf/unbundled.d.ts +2 -0
  70. package/dist/netcdf/unbundled.d.ts.map +1 -0
  71. package/dist/netcdf/unbundled.js +5 -0
  72. package/dist/netcdf/unbundled.js.map +1 -0
  73. package/dist/netcdf.dev.js +3153 -0
  74. package/dist/netcdf.min.js +12 -0
  75. package/dist/zarr/bundled.d.ts +2 -0
  76. package/dist/zarr/bundled.d.ts.map +1 -0
  77. package/dist/zarr/bundled.js +5 -0
  78. package/dist/zarr/bundled.js.map +1 -0
  79. package/dist/zarr/geo-zarr-source-loader.d.ts +121 -0
  80. package/dist/zarr/geo-zarr-source-loader.d.ts.map +1 -0
  81. package/dist/zarr/geo-zarr-source-loader.js +692 -0
  82. package/dist/zarr/geo-zarr-source-loader.js.map +1 -0
  83. package/dist/zarr/index.cjs +14747 -0
  84. package/dist/zarr/index.cjs.map +6 -0
  85. package/dist/zarr/index.d.ts +11 -0
  86. package/dist/zarr/index.d.ts.map +1 -0
  87. package/dist/zarr/index.js +10 -0
  88. package/dist/zarr/index.js.map +1 -0
  89. package/dist/zarr/lib/consolidated-zarr.d.ts +31 -0
  90. package/dist/zarr/lib/consolidated-zarr.d.ts.map +1 -0
  91. package/dist/zarr/lib/consolidated-zarr.js +113 -0
  92. package/dist/zarr/lib/consolidated-zarr.js.map +1 -0
  93. package/dist/zarr/lib/load-zarr.d.ts +11 -0
  94. package/dist/zarr/lib/load-zarr.d.ts.map +1 -0
  95. package/dist/zarr/lib/load-zarr.js +22 -0
  96. package/dist/zarr/lib/load-zarr.js.map +1 -0
  97. package/dist/zarr/lib/spatial-multiscales.d.ts +14 -0
  98. package/dist/zarr/lib/spatial-multiscales.d.ts.map +1 -0
  99. package/dist/zarr/lib/spatial-multiscales.js +34 -0
  100. package/dist/zarr/lib/spatial-multiscales.js.map +1 -0
  101. package/dist/zarr/lib/utils.d.ts +28 -0
  102. package/dist/zarr/lib/utils.d.ts.map +1 -0
  103. package/dist/zarr/lib/utils.js +137 -0
  104. package/dist/zarr/lib/utils.js.map +1 -0
  105. package/dist/zarr/lib/zarr-data-cache.d.ts +13 -0
  106. package/dist/zarr/lib/zarr-data-cache.d.ts.map +1 -0
  107. package/dist/zarr/lib/zarr-data-cache.js +70 -0
  108. package/dist/zarr/lib/zarr-data-cache.js.map +1 -0
  109. package/dist/zarr/lib/zarr-pixel-source.d.ts +41 -0
  110. package/dist/zarr/lib/zarr-pixel-source.d.ts.map +1 -0
  111. package/dist/zarr/lib/zarr-pixel-source.js +97 -0
  112. package/dist/zarr/lib/zarr-pixel-source.js.map +1 -0
  113. package/dist/zarr/lib/zarrita-pixel-source.d.ts +40 -0
  114. package/dist/zarr/lib/zarrita-pixel-source.d.ts.map +1 -0
  115. package/dist/zarr/lib/zarrita-pixel-source.js +96 -0
  116. package/dist/zarr/lib/zarrita-pixel-source.js.map +1 -0
  117. package/dist/zarr/ome-zarr-source-loader.d.ts +195 -0
  118. package/dist/zarr/ome-zarr-source-loader.d.ts.map +1 -0
  119. package/dist/zarr/ome-zarr-source-loader.js +523 -0
  120. package/dist/zarr/ome-zarr-source-loader.js.map +1 -0
  121. package/dist/zarr/spatial-data-source.d.ts +95 -0
  122. package/dist/zarr/spatial-data-source.d.ts.map +1 -0
  123. package/dist/zarr/spatial-data-source.js +242 -0
  124. package/dist/zarr/spatial-data-source.js.map +1 -0
  125. package/dist/zarr/types.d.ts +105 -0
  126. package/dist/zarr/types.d.ts.map +1 -0
  127. package/dist/zarr/types.js +5 -0
  128. package/dist/zarr/types.js.map +1 -0
  129. package/dist/zarr/unbundled.d.ts +2 -0
  130. package/dist/zarr/unbundled.d.ts.map +1 -0
  131. package/dist/zarr/unbundled.js +5 -0
  132. package/dist/zarr/unbundled.js.map +1 -0
  133. package/dist/zarr/zarr-array-source.d.ts +102 -0
  134. package/dist/zarr/zarr-array-source.d.ts.map +1 -0
  135. package/dist/zarr/zarr-array-source.js +132 -0
  136. package/dist/zarr/zarr-array-source.js.map +1 -0
  137. package/dist/zarr/zarr-loader-types.d.ts +236 -0
  138. package/dist/zarr/zarr-loader-types.d.ts.map +1 -0
  139. package/dist/zarr/zarr-loader-types.js +128 -0
  140. package/dist/zarr/zarr-loader-types.js.map +1 -0
  141. package/dist/zarr.dev.js +16574 -0
  142. package/dist/zarr.min.js +79 -0
  143. package/package.json +62 -4
  144. package/src/index.ts +52 -0
  145. package/src/netcdf/bundled.ts +5 -0
  146. package/src/netcdf/index.ts +14 -0
  147. package/src/netcdf/iobuffer/iobuffer.ts +510 -0
  148. package/src/netcdf/netcdf-format.ts +16 -0
  149. package/src/netcdf/netcdf-loader-with-parser.ts +54 -0
  150. package/src/netcdf/netcdf-loader.ts +62 -0
  151. package/src/netcdf/netcdf-source-loader-types.ts +45 -0
  152. package/src/netcdf/netcdf-source-loader.ts +526 -0
  153. package/src/netcdf/netcdfjs/LICENSE +24 -0
  154. package/src/netcdf/netcdfjs/netcdf-reader.ts +196 -0
  155. package/src/netcdf/netcdfjs/netcdf-types.ts +75 -0
  156. package/src/netcdf/netcdfjs/read-data.ts +71 -0
  157. package/src/netcdf/netcdfjs/read-header.ts +277 -0
  158. package/src/netcdf/netcdfjs/read-type.ts +147 -0
  159. package/src/netcdf/unbundled.ts +5 -0
  160. package/src/zarr/bundled.ts +5 -0
  161. package/src/zarr/geo-zarr-source-loader.ts +998 -0
  162. package/src/zarr/index.ts +60 -0
  163. package/src/zarr/lib/consolidated-zarr.ts +190 -0
  164. package/src/zarr/lib/load-zarr.ts +31 -0
  165. package/src/zarr/lib/spatial-multiscales.ts +47 -0
  166. package/src/zarr/lib/utils.ts +162 -0
  167. package/src/zarr/lib/zarr-data-cache.ts +91 -0
  168. package/src/zarr/lib/zarr-pixel-source.ts +134 -0
  169. package/src/zarr/lib/zarrita-pixel-source.ts +141 -0
  170. package/src/zarr/ome-zarr-source-loader.ts +837 -0
  171. package/src/zarr/spatial-data-source.ts +370 -0
  172. package/src/zarr/types.ts +129 -0
  173. package/src/zarr/unbundled.ts +5 -0
  174. package/src/zarr/zarr-array-source.ts +225 -0
  175. package/src/zarr/zarr-loader-types.ts +166 -0
package/package.json CHANGED
@@ -1,6 +1,64 @@
1
1
  {
2
2
  "name": "@loaders.gl/scientific",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "5.0.0-alpha.13",
4
+ "description": "Scientific data format loaders with metadata roots and explicit format subpaths",
5
+ "license": "MIT",
6
+ "type": "module",
7
+ "publishConfig": {
8
+ "access": "public"
9
+ },
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "https://github.com/visgl/loaders.gl"
13
+ },
14
+ "types": "dist/index.d.ts",
15
+ "main": "dist/index.cjs",
16
+ "module": "dist/index.js",
17
+ "exports": {
18
+ ".": {
19
+ "types": "./dist/index.d.ts",
20
+ "import": "./dist/index.js",
21
+ "require": "./dist/index.cjs"
22
+ },
23
+ "./netcdf": {
24
+ "types": "./dist/netcdf/index.d.ts",
25
+ "import": "./dist/netcdf/index.js",
26
+ "require": "./dist/netcdf/index.cjs"
27
+ },
28
+ "./netcdf/*": {
29
+ "types": "./dist/netcdf/*.d.ts",
30
+ "import": "./dist/netcdf/*.js",
31
+ "require": "./dist/netcdf/*.cjs"
32
+ },
33
+ "./zarr": {
34
+ "types": "./dist/zarr/index.d.ts",
35
+ "import": "./dist/zarr/index.js",
36
+ "require": "./dist/zarr/index.cjs"
37
+ },
38
+ "./zarr/*": {
39
+ "types": "./dist/zarr/*.d.ts",
40
+ "import": "./dist/zarr/*.js"
41
+ }
42
+ },
43
+ "sideEffects": false,
44
+ "files": [
45
+ "src",
46
+ "dist",
47
+ "README.md"
48
+ ],
49
+ "scripts": {
50
+ "pre-build": "npm run build-bundle && npm run build-bundle-dev && npm run build-cjs-netcdf && npm run build-cjs-zarr",
51
+ "build-bundle": "ocular-bundle ./netcdf-bundle.ts --output=dist/netcdf.min.js && ocular-bundle ./zarr-bundle.ts --output=dist/zarr.min.js",
52
+ "build-bundle-dev": "ocular-bundle ./netcdf-bundle.ts --env=dev --output=dist/netcdf.dev.js && ocular-bundle ./zarr-bundle.ts --env=dev --output=dist/zarr.dev.js",
53
+ "build-cjs-netcdf": "esbuild src/netcdf/*.ts --bundle --format=cjs --platform=node --target=node22 --outdir=dist/netcdf --out-extension:.js=.cjs --external:@loaders.gl/* --external:@math.gl/*",
54
+ "build-cjs-zarr": "esbuild src/zarr/index.ts --bundle --format=cjs --platform=node --target=node22 --outfile=dist/zarr/index.cjs --external:@loaders.gl/* --external:@math.gl/*"
55
+ },
56
+ "dependencies": {
57
+ "@math.gl/geospatial": "5.0.0-alpha.19",
58
+ "zarr": "^0.5.0",
59
+ "zarrita": "~0.7.1"
60
+ },
61
+ "peerDependencies": {
62
+ "@loaders.gl/core": "~5.0.0-alpha.0"
63
+ }
64
+ }
package/src/index.ts ADDED
@@ -0,0 +1,52 @@
1
+ // loaders.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // Copyright (c) vis.gl contributors
4
+
5
+ export {NetCDFFormat} from './netcdf/netcdf-format';
6
+ export {NetCDFLoader, NetCDFWorkerLoader} from './netcdf/netcdf-loader';
7
+ export type {NetCDF, NetCDFLoaderOptions} from './netcdf/netcdf-loader';
8
+ export {NetCDFSourceLoader} from './netcdf/netcdf-source-loader-types';
9
+ export type {NetCDFRasterQueryOptions, NetCDFSourceOptions} from './netcdf/netcdf-source-loader';
10
+ export {
11
+ OMEZarrSourceLoader,
12
+ GeoZarrSourceLoader,
13
+ ZarrArraySourceLoader,
14
+ SpatialDataSourceLoader
15
+ } from './zarr/zarr-loader-types';
16
+ export type {
17
+ GetZarrArrayParameters,
18
+ ZarrArrayData,
19
+ ZarrArraySelection,
20
+ ZarrArraySlice,
21
+ ZarrArraySourceLoaderOptions,
22
+ ZarrArraySourceMetadata
23
+ } from './zarr/zarr-array-source';
24
+ export type {
25
+ SpatialDataElementFormat,
26
+ SpatialDataElementKind,
27
+ SpatialDataElementMetadata,
28
+ SpatialDataSourceLoaderOptions,
29
+ SpatialDataSourceMetadata,
30
+ SpatialDataZarrElementSource
31
+ } from './zarr/spatial-data-source';
32
+ export type {
33
+ GetOMEZarrParameters,
34
+ LoadConsolidatedMetadataOptions,
35
+ LoadZarrConsolidatedMetadataOptions,
36
+ OMEZarrChannelMetadata,
37
+ OMEZarrLevelMetadata,
38
+ OMEZarrSourceLoaderMetadata,
39
+ ZarrConsolidatedFormat,
40
+ ZarrConsolidatedMetadata,
41
+ ZarrMetadataPath,
42
+ ZarrSourceLoader,
43
+ ZarrSourceLoaderOptions
44
+ } from './zarr/ome-zarr-source-loader';
45
+ export type {
46
+ GeoZarrLevelMetadata,
47
+ GeoZarrAffineTransform,
48
+ GeoZarrSelectionDimension,
49
+ GeoZarrSourceLoaderOptions,
50
+ GeoZarrSourceMetadata,
51
+ GetGeoZarrParameters
52
+ } from './zarr/geo-zarr-source-loader';
@@ -0,0 +1,5 @@
1
+ // loaders.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // Copyright (c) vis.gl contributors
4
+
5
+ export * from './index';
@@ -0,0 +1,14 @@
1
+ // loaders.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // Copyright (c) vis.gl contributors
4
+
5
+ export {NetCDFReader} from './netcdfjs/netcdf-reader';
6
+ export {NetCDFFormat} from './netcdf-format';
7
+ export type {NetCDF, NetCDFLoaderOptions} from './netcdf-loader';
8
+ export {NetCDFLoaderWithParser, NetCDFWorkerLoaderWithParser} from './netcdf-loader-with-parser';
9
+ export {
10
+ NetCDFSourceLoaderWithParser,
11
+ NetCDFSourceLoaderWithParser as NetCDFSourceLoader,
12
+ NetCDFSource
13
+ } from './netcdf-source-loader';
14
+ export type {NetCDFRasterQueryOptions, NetCDFSourceOptions} from './netcdf-source-loader';
@@ -0,0 +1,510 @@
1
+ // SPDX-License-Identifier: MIT
2
+
3
+ const DEFAULT_BYTE_LENGTH = 1024 * 8;
4
+
5
+ type InputData = number | ArrayBufferLike | ArrayBufferView | IOBuffer | Buffer;
6
+
7
+ interface IOBufferOptions {
8
+ /**
9
+ * Ignore the first n bytes of the ArrayBuffer.
10
+ */
11
+ offset?: number;
12
+ }
13
+
14
+ export class IOBuffer {
15
+ /**
16
+ * Reference to the internal ArrayBuffer object.
17
+ */
18
+ public buffer: ArrayBufferLike;
19
+
20
+ /**
21
+ * Byte length of the internal ArrayBuffer.
22
+ */
23
+ public byteLength: number;
24
+
25
+ /**
26
+ * Byte offset of the internal ArrayBuffer.
27
+ */
28
+ public byteOffset: number;
29
+
30
+ /**
31
+ * Byte length of the internal ArrayBuffer.
32
+ */
33
+ public length: number;
34
+
35
+ /**
36
+ * The current offset of the buffer's pointer.
37
+ */
38
+ public offset: number;
39
+
40
+ private lastWrittenByte: number;
41
+ private littleEndian: boolean;
42
+
43
+ private _data: DataView;
44
+ private _mark: number;
45
+ private _marks: number[];
46
+
47
+ private textDecoder = new TextDecoder();
48
+ private textEncoder = new TextEncoder();
49
+
50
+ /**
51
+ * @param data - The data to construct the IOBuffer with.
52
+ * If data is a number, it will be the new buffer's length<br>
53
+ * If data is `undefined`, the buffer will be initialized with a default length of 8Kb<br>
54
+ * If data is an ArrayBuffer, SharedArrayBuffer, an ArrayBufferView (Typed Array), an IOBuffer instance,
55
+ * or a Node.js Buffer, a view will be created over the underlying ArrayBuffer.
56
+ * @param options
57
+ */
58
+ public constructor(data: InputData = DEFAULT_BYTE_LENGTH, options: IOBufferOptions = {}) {
59
+ let dataIsGiven = false;
60
+ if (typeof data === 'number') {
61
+ data = new ArrayBuffer(data);
62
+ } else {
63
+ dataIsGiven = true;
64
+ this.lastWrittenByte = data.byteLength;
65
+ }
66
+
67
+ const offset = options.offset ? options.offset >>> 0 : 0;
68
+ const byteLength = data.byteLength - offset;
69
+ let dvOffset = offset;
70
+ if (ArrayBuffer.isView(data) || data instanceof IOBuffer) {
71
+ if (data.byteLength !== data.buffer.byteLength) {
72
+ dvOffset = data.byteOffset + offset;
73
+ }
74
+ data = data.buffer;
75
+ }
76
+ if (dataIsGiven) {
77
+ this.lastWrittenByte = byteLength;
78
+ } else {
79
+ this.lastWrittenByte = 0;
80
+ }
81
+ this.buffer = data;
82
+ this.length = byteLength;
83
+ this.byteLength = byteLength;
84
+ this.byteOffset = dvOffset;
85
+ this.offset = 0;
86
+ this.littleEndian = true;
87
+ this._data = new DataView(this.buffer, dvOffset, byteLength);
88
+ this._mark = 0;
89
+ this._marks = [];
90
+ }
91
+
92
+ /**
93
+ * Checks if the memory allocated to the buffer is sufficient to store more
94
+ * bytes after the offset.
95
+ * @param byteLength - The needed memory in bytes.
96
+ * @returns `true` if there is sufficient space and `false` otherwise.
97
+ */
98
+ public available(byteLength = 1): boolean {
99
+ return this.offset + byteLength <= this.length;
100
+ }
101
+
102
+ /**
103
+ * Check if little-endian mode is used for reading and writing multi-byte
104
+ * values.
105
+ * @returns `true` if little-endian mode is used, `false` otherwise.
106
+ */
107
+ public isLittleEndian(): boolean {
108
+ return this.littleEndian;
109
+ }
110
+
111
+ /**
112
+ * Set little-endian mode for reading and writing multi-byte values.
113
+ */
114
+ public setLittleEndian(): this {
115
+ this.littleEndian = true;
116
+ return this;
117
+ }
118
+
119
+ /**
120
+ * Check if big-endian mode is used for reading and writing multi-byte values.
121
+ * @returns `true` if big-endian mode is used, `false` otherwise.
122
+ */
123
+ public isBigEndian(): boolean {
124
+ return !this.littleEndian;
125
+ }
126
+
127
+ /**
128
+ * Switches to big-endian mode for reading and writing multi-byte values.
129
+ */
130
+ public setBigEndian(): this {
131
+ this.littleEndian = false;
132
+ return this;
133
+ }
134
+
135
+ /**
136
+ * Move the pointer n bytes forward.
137
+ * @param n - Number of bytes to skip.
138
+ */
139
+ public skip(n = 1): this {
140
+ this.offset += n;
141
+ return this;
142
+ }
143
+
144
+ /**
145
+ * Move the pointer to the given offset.
146
+ * @param offset
147
+ */
148
+ public seek(offset: number): this {
149
+ this.offset = offset;
150
+ return this;
151
+ }
152
+
153
+ /**
154
+ * Store the current pointer offset.
155
+ * @see {@link IOBuffer#reset}
156
+ */
157
+ public mark(): this {
158
+ this._mark = this.offset;
159
+ return this;
160
+ }
161
+
162
+ /**
163
+ * Move the pointer back to the last pointer offset set by mark.
164
+ * @see {@link IOBuffer#mark}
165
+ */
166
+ public reset(): this {
167
+ this.offset = this._mark;
168
+ return this;
169
+ }
170
+
171
+ /**
172
+ * Push the current pointer offset to the mark stack.
173
+ * @see {@link IOBuffer#popMark}
174
+ */
175
+ public pushMark(): this {
176
+ this._marks.push(this.offset);
177
+ return this;
178
+ }
179
+
180
+ /**
181
+ * Pop the last pointer offset from the mark stack, and set the current
182
+ * pointer offset to the popped value.
183
+ * @see {@link IOBuffer#pushMark}
184
+ */
185
+ public popMark(): this {
186
+ const offset = this._marks.pop();
187
+ if (offset === undefined) {
188
+ throw new Error('Mark stack empty');
189
+ }
190
+ this.seek(offset);
191
+ return this;
192
+ }
193
+
194
+ /**
195
+ * Move the pointer offset back to 0.
196
+ */
197
+ public rewind(): this {
198
+ this.offset = 0;
199
+ return this;
200
+ }
201
+
202
+ /**
203
+ * Make sure the buffer has sufficient memory to write a given byteLength at
204
+ * the current pointer offset.
205
+ * If the buffer's memory is insufficient, this method will create a new
206
+ * buffer (a copy) with a length that is twice (byteLength + current offset).
207
+ * @param byteLength
208
+ */
209
+ public ensureAvailable(byteLength = 1): this {
210
+ if (!this.available(byteLength)) {
211
+ const lengthNeeded = this.offset + byteLength;
212
+ const newLength = lengthNeeded * 2;
213
+ const newArray = new Uint8Array(newLength);
214
+ newArray.set(new Uint8Array(this.buffer));
215
+ this.buffer = newArray.buffer;
216
+ this.length = this.byteLength = newLength;
217
+ this._data = new DataView(this.buffer);
218
+ }
219
+ return this;
220
+ }
221
+
222
+ /**
223
+ * Read a byte and return false if the byte's value is 0, or true otherwise.
224
+ * Moves pointer forward by one byte.
225
+ */
226
+ public readBoolean(): boolean {
227
+ return this.readUint8() !== 0;
228
+ }
229
+
230
+ /**
231
+ * Read a signed 8-bit integer and move pointer forward by 1 byte.
232
+ */
233
+ public readInt8(): number {
234
+ return this._data.getInt8(this.offset++);
235
+ }
236
+
237
+ /**
238
+ * Read an unsigned 8-bit integer and move pointer forward by 1 byte.
239
+ */
240
+ public readUint8(): number {
241
+ return this._data.getUint8(this.offset++);
242
+ }
243
+
244
+ /**
245
+ * Alias for {@link IOBuffer#readUint8}.
246
+ */
247
+ public readByte(): number {
248
+ return this.readUint8();
249
+ }
250
+
251
+ /**
252
+ * Read `n` bytes and move pointer forward by `n` bytes.
253
+ */
254
+ public readBytes(n = 1): Uint8Array {
255
+ const bytes = new Uint8Array(n);
256
+ for (let i = 0; i < n; i++) {
257
+ bytes[i] = this.readByte();
258
+ }
259
+ return bytes;
260
+ }
261
+
262
+ /**
263
+ * Read a 16-bit signed integer and move pointer forward by 2 bytes.
264
+ */
265
+ public readInt16(): number {
266
+ const value = this._data.getInt16(this.offset, this.littleEndian);
267
+ this.offset += 2;
268
+ return value;
269
+ }
270
+
271
+ /**
272
+ * Read a 16-bit unsigned integer and move pointer forward by 2 bytes.
273
+ */
274
+ public readUint16(): number {
275
+ const value = this._data.getUint16(this.offset, this.littleEndian);
276
+ this.offset += 2;
277
+ return value;
278
+ }
279
+
280
+ /**
281
+ * Read a 32-bit signed integer and move pointer forward by 4 bytes.
282
+ */
283
+ public readInt32(): number {
284
+ const value = this._data.getInt32(this.offset, this.littleEndian);
285
+ this.offset += 4;
286
+ return value;
287
+ }
288
+
289
+ /**
290
+ * Read a 32-bit unsigned integer and move pointer forward by 4 bytes.
291
+ */
292
+ public readUint32(): number {
293
+ const value = this._data.getUint32(this.offset, this.littleEndian);
294
+ this.offset += 4;
295
+ return value;
296
+ }
297
+
298
+ /**
299
+ * Read a 32-bit floating number and move pointer forward by 4 bytes.
300
+ */
301
+ public readFloat32(): number {
302
+ const value = this._data.getFloat32(this.offset, this.littleEndian);
303
+ this.offset += 4;
304
+ return value;
305
+ }
306
+
307
+ /**
308
+ * Read a 64-bit floating number and move pointer forward by 8 bytes.
309
+ */
310
+ public readFloat64(): number {
311
+ const value = this._data.getFloat64(this.offset, this.littleEndian);
312
+ this.offset += 8;
313
+ return value;
314
+ }
315
+
316
+ /**
317
+ * Read a 1-byte ASCII character and move pointer forward by 1 byte.
318
+ */
319
+ public readChar(): string {
320
+ return String.fromCharCode(this.readInt8());
321
+ }
322
+
323
+ /**
324
+ * Read `n` 1-byte ASCII characters and move pointer forward by `n` bytes.
325
+ */
326
+ public readChars(n = 1): string {
327
+ let result = '';
328
+ for (let i = 0; i < n; i++) {
329
+ result += this.readChar();
330
+ }
331
+ return result;
332
+ }
333
+
334
+ /**
335
+ * Read the next `n` bytes, return a UTF-8 decoded string and move pointer
336
+ * forward by `n` bytes.
337
+ */
338
+ public readUtf8(n = 1): string {
339
+ return this.textDecoder.decode(this.readBytes(n));
340
+ }
341
+
342
+ /**
343
+ * Write 0xff if the passed value is truthy, 0x00 otherwise and move pointer
344
+ * forward by 1 byte.
345
+ */
346
+ public writeBoolean(value: unknown): this {
347
+ this.writeUint8(value ? 0xff : 0x00);
348
+ return this;
349
+ }
350
+
351
+ /**
352
+ * Write `value` as an 8-bit signed integer and move pointer forward by 1 byte.
353
+ */
354
+ public writeInt8(value: number): this {
355
+ this.ensureAvailable(1);
356
+ this._data.setInt8(this.offset++, value);
357
+ this._updateLastWrittenByte();
358
+ return this;
359
+ }
360
+
361
+ /**
362
+ * Write `value` as an 8-bit unsigned integer and move pointer forward by 1
363
+ * byte.
364
+ */
365
+ public writeUint8(value: number): this {
366
+ this.ensureAvailable(1);
367
+ this._data.setUint8(this.offset++, value);
368
+ this._updateLastWrittenByte();
369
+ return this;
370
+ }
371
+
372
+ /**
373
+ * An alias for {@link IOBuffer#writeUint8}.
374
+ */
375
+ public writeByte(value: number): this {
376
+ return this.writeUint8(value);
377
+ }
378
+
379
+ /**
380
+ * Write all elements of `bytes` as uint8 values and move pointer forward by
381
+ * `bytes.length` bytes.
382
+ */
383
+ public writeBytes(bytes: ArrayLike<number>): this {
384
+ this.ensureAvailable(bytes.length);
385
+ for (let i = 0; i < bytes.length; i++) {
386
+ this._data.setUint8(this.offset++, bytes[i]);
387
+ }
388
+ this._updateLastWrittenByte();
389
+ return this;
390
+ }
391
+
392
+ /**
393
+ * Write `value` as a 16-bit signed integer and move pointer forward by 2
394
+ * bytes.
395
+ */
396
+ public writeInt16(value: number): this {
397
+ this.ensureAvailable(2);
398
+ this._data.setInt16(this.offset, value, this.littleEndian);
399
+ this.offset += 2;
400
+ this._updateLastWrittenByte();
401
+ return this;
402
+ }
403
+
404
+ /**
405
+ * Write `value` as a 16-bit unsigned integer and move pointer forward by 2
406
+ * bytes.
407
+ */
408
+ public writeUint16(value: number): this {
409
+ this.ensureAvailable(2);
410
+ this._data.setUint16(this.offset, value, this.littleEndian);
411
+ this.offset += 2;
412
+ this._updateLastWrittenByte();
413
+ return this;
414
+ }
415
+
416
+ /**
417
+ * Write `value` as a 32-bit signed integer and move pointer forward by 4
418
+ * bytes.
419
+ */
420
+ public writeInt32(value: number): this {
421
+ this.ensureAvailable(4);
422
+ this._data.setInt32(this.offset, value, this.littleEndian);
423
+ this.offset += 4;
424
+ this._updateLastWrittenByte();
425
+ return this;
426
+ }
427
+
428
+ /**
429
+ * Write `value` as a 32-bit unsigned integer and move pointer forward by 4
430
+ * bytes.
431
+ */
432
+ public writeUint32(value: number): this {
433
+ this.ensureAvailable(4);
434
+ this._data.setUint32(this.offset, value, this.littleEndian);
435
+ this.offset += 4;
436
+ this._updateLastWrittenByte();
437
+ return this;
438
+ }
439
+
440
+ /**
441
+ * Write `value` as a 32-bit floating number and move pointer forward by 4
442
+ * bytes.
443
+ */
444
+ public writeFloat32(value: number): this {
445
+ this.ensureAvailable(4);
446
+ this._data.setFloat32(this.offset, value, this.littleEndian);
447
+ this.offset += 4;
448
+ this._updateLastWrittenByte();
449
+ return this;
450
+ }
451
+
452
+ /**
453
+ * Write `value` as a 64-bit floating number and move pointer forward by 8
454
+ * bytes.
455
+ */
456
+ public writeFloat64(value: number): this {
457
+ this.ensureAvailable(8);
458
+ this._data.setFloat64(this.offset, value, this.littleEndian);
459
+ this.offset += 8;
460
+ this._updateLastWrittenByte();
461
+ return this;
462
+ }
463
+
464
+ /**
465
+ * Write the charCode of `str`'s first character as an 8-bit unsigned integer
466
+ * and move pointer forward by 1 byte.
467
+ */
468
+ public writeChar(str: string): this {
469
+ return this.writeUint8(str.charCodeAt(0));
470
+ }
471
+
472
+ /**
473
+ * Write the charCodes of all `str`'s characters as 8-bit unsigned integers
474
+ * and move pointer forward by `str.length` bytes.
475
+ */
476
+ public writeChars(str: string): this {
477
+ for (let i = 0; i < str.length; i++) {
478
+ this.writeUint8(str.charCodeAt(i));
479
+ }
480
+ return this;
481
+ }
482
+
483
+ /**
484
+ * UTF-8 encode and write `str` to the current pointer offset and move pointer
485
+ * forward according to the encoded length.
486
+ */
487
+ public writeUtf8(str: string): this {
488
+ const bytes = this.textEncoder.encode(str);
489
+ return this.writeBytes(bytes);
490
+ }
491
+
492
+ /**
493
+ * Export a Uint8Array view of the internal buffer.
494
+ * The view starts at the byte offset and its length
495
+ * is calculated to stop at the last written byte or the original length.
496
+ */
497
+ public toArray(): Uint8Array {
498
+ return new Uint8Array(this.buffer, this.byteOffset, this.lastWrittenByte);
499
+ }
500
+
501
+ /**
502
+ * Update the last written byte offset
503
+ * @private
504
+ */
505
+ private _updateLastWrittenByte(): void {
506
+ if (this.offset > this.lastWrittenByte) {
507
+ this.lastWrittenByte = this.offset;
508
+ }
509
+ }
510
+ }
@@ -0,0 +1,16 @@
1
+ // loaders.gl
2
+ // SPDX-License-Identifier: MIT
3
+ // Copyright (c) vis.gl contributors
4
+
5
+ import type {Format} from '@loaders.gl/core/loader-utils';
6
+
7
+ export const NetCDFFormat = {
8
+ name: 'NetCDF',
9
+ id: 'netcdf',
10
+ module: 'netcdf',
11
+ encoding: 'binary',
12
+ format: 'netcdf',
13
+ extensions: ['cdf', 'nc'],
14
+ mimeTypes: ['application/x-netcdf'],
15
+ binary: true
16
+ } as const satisfies Format;