@earthmover/icechunk 2.0.0-alpha.4 → 2.0.0-alpha.5
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/index.d.ts +1 -129
- package/package.json +5 -5
package/index.d.ts
CHANGED
|
@@ -23,21 +23,11 @@ export declare class Session {
|
|
|
23
23
|
get store(): JsStore
|
|
24
24
|
commit(message: string): Promise<string>
|
|
25
25
|
discardChanges(): Promise<void>
|
|
26
|
-
/** Get all virtual chunk locations referenced by this session */
|
|
27
|
-
allVirtualChunkLocations(): Promise<Array<string>>
|
|
28
26
|
}
|
|
29
27
|
export type JsSession = Session
|
|
30
28
|
|
|
31
29
|
export declare class Storage {
|
|
32
30
|
static newInMemory(): Promise<Storage>
|
|
33
|
-
static newLocalFilesystem(path: string): Promise<Storage>
|
|
34
|
-
static newS3(bucket: string, prefix?: string | undefined | null, credentials?: S3Credentials | undefined | null, options?: S3Options | undefined | null): Storage
|
|
35
|
-
static newR2(bucket?: string | undefined | null, prefix?: string | undefined | null, accountId?: string | undefined | null, credentials?: S3Credentials | undefined | null, options?: S3Options | undefined | null): Storage
|
|
36
|
-
static newTigris(bucket: string, prefix?: string | undefined | null, credentials?: S3Credentials | undefined | null, options?: S3Options | undefined | null, useWeakConsistency?: boolean | undefined | null): Storage
|
|
37
|
-
static newS3ObjectStore(bucket: string, prefix?: string | undefined | null, credentials?: S3Credentials | undefined | null, options?: S3Options | undefined | null): Promise<Storage>
|
|
38
|
-
static newGcs(bucket: string, prefix?: string | undefined | null, credentials?: GcsCredentials | undefined | null, config?: Record<string, string> | undefined | null): Storage
|
|
39
|
-
static newAzureBlob(account: string, container: string, prefix?: string | undefined | null, credentials?: AzureCredentials | undefined | null, config?: Record<string, string> | undefined | null): Promise<Storage>
|
|
40
|
-
static newHttp(baseUrl: string, config?: Record<string, string> | undefined | null): Storage
|
|
41
31
|
}
|
|
42
32
|
export type JsStorage = Storage
|
|
43
33
|
|
|
@@ -53,32 +43,9 @@ export declare class Store {
|
|
|
53
43
|
get supportsWrites(): boolean
|
|
54
44
|
get supportsDeletes(): boolean
|
|
55
45
|
get supportsListing(): boolean
|
|
56
|
-
/**
|
|
57
|
-
* Set a single virtual reference to a chunk
|
|
58
|
-
*
|
|
59
|
-
* For checksum validation, provide either etag_checksum (string) or last_modified (JS Date object).
|
|
60
|
-
* If both are provided, etag_checksum takes precedence.
|
|
61
|
-
*/
|
|
62
|
-
setVirtualRef(key: string, location: string, offset: number, length: number, etagChecksum: string | undefined | null, lastModified: Date | undefined | null, validateContainer: boolean): Promise<void>
|
|
63
|
-
/**
|
|
64
|
-
* Set multiple virtual references for the same array
|
|
65
|
-
* Returns the indices of failed chunk references if any
|
|
66
|
-
*/
|
|
67
|
-
setVirtualRefs(arrayPath: string, chunks: Array<VirtualChunkSpec>, validateContainers: boolean): Promise<Array<Array<number>> | null>
|
|
68
46
|
}
|
|
69
47
|
export type JsStore = Store
|
|
70
48
|
|
|
71
|
-
/** Azure credentials */
|
|
72
|
-
export type AzureCredentials =
|
|
73
|
-
| { type: 'FromEnv' }
|
|
74
|
-
| { type: 'Static', field0: AzureStaticCredentials }
|
|
75
|
-
|
|
76
|
-
/** Azure static credentials */
|
|
77
|
-
export type AzureStaticCredentials =
|
|
78
|
-
| { type: 'AccessKey', field0: string }
|
|
79
|
-
| { type: 'SasToken', field0: string }
|
|
80
|
-
| { type: 'BearerToken', field0: string }
|
|
81
|
-
|
|
82
49
|
/** Caching configuration */
|
|
83
50
|
export interface CachingConfig {
|
|
84
51
|
numSnapshotNodes?: number
|
|
@@ -99,70 +66,19 @@ export interface CompressionConfig {
|
|
|
99
66
|
level?: number
|
|
100
67
|
}
|
|
101
68
|
|
|
102
|
-
/** Credentials for virtual chunk access */
|
|
103
|
-
export type Credentials =
|
|
104
|
-
| { type: 'S3', field0: S3Credentials }
|
|
105
|
-
| { type: 'Gcs', field0: GcsCredentials }
|
|
106
|
-
| { type: 'Azure', field0: AzureCredentials }
|
|
107
|
-
|
|
108
|
-
/** GCS credentials */
|
|
109
|
-
export type GcsCredentials =
|
|
110
|
-
| { type: 'Anonymous' }
|
|
111
|
-
| { type: 'FromEnv' }
|
|
112
|
-
| { type: 'Static', field0: GcsStaticCredentials }
|
|
113
|
-
|
|
114
|
-
/** GCS static credentials */
|
|
115
|
-
export type GcsStaticCredentials =
|
|
116
|
-
| { type: 'ServiceAccount', field0: string }
|
|
117
|
-
| { type: 'ServiceAccountKey', field0: string }
|
|
118
|
-
| { type: 'ApplicationCredentials', field0: string }
|
|
119
|
-
| { type: 'BearerToken', field0: string }
|
|
120
|
-
|
|
121
69
|
export interface ManifestFileInfo {
|
|
122
70
|
id: string
|
|
123
71
|
sizeBytes: number
|
|
124
72
|
numChunkRefs: number
|
|
125
73
|
}
|
|
126
74
|
|
|
127
|
-
/** Object store configuration for virtual chunk containers */
|
|
128
|
-
export type ObjectStoreConfig =
|
|
129
|
-
| { type: 'InMemory' }
|
|
130
|
-
| { type: 'LocalFileSystem', field0: string }
|
|
131
|
-
| { type: 'Http', field0: Record<string, string> }
|
|
132
|
-
| { type: 'S3Compatible', field0: S3Options }
|
|
133
|
-
| { type: 'S3', field0: S3Options }
|
|
134
|
-
| { type: 'Gcs', field0: Record<string, string> }
|
|
135
|
-
| { type: 'Azure', field0: Record<string, string> }
|
|
136
|
-
| { type: 'Tigris', field0: S3Options }
|
|
137
|
-
|
|
138
75
|
export interface ReadonlySessionOptions {
|
|
139
76
|
branch?: string
|
|
140
77
|
tag?: string
|
|
141
78
|
snapshotId?: string
|
|
142
79
|
}
|
|
143
80
|
|
|
144
|
-
/**
|
|
145
|
-
* Repository configuration
|
|
146
|
-
*
|
|
147
|
-
* The `manifest` field accepts a JSON object matching the serde serialization
|
|
148
|
-
* of `ManifestConfig`. Example:
|
|
149
|
-
* ```js
|
|
150
|
-
* {
|
|
151
|
-
* manifest: {
|
|
152
|
-
* preload: {
|
|
153
|
-
* max_total_refs: 1000,
|
|
154
|
-
* preload_if: { true: null },
|
|
155
|
-
* max_arrays_to_scan: 10
|
|
156
|
-
* },
|
|
157
|
-
* splitting: {
|
|
158
|
-
* split_sizes: [
|
|
159
|
-
* [{ path_matches: { regex: ".*" } }, [{ condition: "any", num_chunks: 100 }]]
|
|
160
|
-
* ]
|
|
161
|
-
* }
|
|
162
|
-
* }
|
|
163
|
-
* }
|
|
164
|
-
* ```
|
|
165
|
-
*/
|
|
81
|
+
/** Repository configuration (WASM build — no virtual chunk support) */
|
|
166
82
|
export interface RepositoryConfig {
|
|
167
83
|
inlineChunkThresholdBytes?: number
|
|
168
84
|
getPartialValuesConcurrency?: number
|
|
@@ -175,32 +91,6 @@ export interface RepositoryConfig {
|
|
|
175
91
|
* The object is deserialized using serde, matching the Rust ManifestConfig structure.
|
|
176
92
|
*/
|
|
177
93
|
manifest?: any
|
|
178
|
-
/** Virtual chunk containers configuration (non-WASM only) */
|
|
179
|
-
virtualChunkContainers?: Record<string, VirtualChunkContainer>
|
|
180
|
-
}
|
|
181
|
-
|
|
182
|
-
/** S3 credentials */
|
|
183
|
-
export type S3Credentials =
|
|
184
|
-
| { type: 'FromEnv' }
|
|
185
|
-
| { type: 'Anonymous' }
|
|
186
|
-
| { type: 'Static', field0: S3StaticCredentials }
|
|
187
|
-
|
|
188
|
-
/** S3 options */
|
|
189
|
-
export interface S3Options {
|
|
190
|
-
region?: string
|
|
191
|
-
endpointUrl?: string
|
|
192
|
-
allowHttp?: boolean
|
|
193
|
-
anonymous?: boolean
|
|
194
|
-
forcePathStyle?: boolean
|
|
195
|
-
networkStreamTimeoutSeconds?: number
|
|
196
|
-
requesterPays?: boolean
|
|
197
|
-
}
|
|
198
|
-
|
|
199
|
-
/** S3 static credentials */
|
|
200
|
-
export interface S3StaticCredentials {
|
|
201
|
-
accessKeyId: string
|
|
202
|
-
secretAccessKey: string
|
|
203
|
-
sessionToken?: string
|
|
204
94
|
}
|
|
205
95
|
|
|
206
96
|
/** Storage concurrency settings */
|
|
@@ -228,21 +118,3 @@ export interface StorageSettings {
|
|
|
228
118
|
chunksStorageClass?: string
|
|
229
119
|
minimumSizeForMultipartUpload?: number
|
|
230
120
|
}
|
|
231
|
-
|
|
232
|
-
/** Virtual chunk container configuration */
|
|
233
|
-
export interface VirtualChunkContainer {
|
|
234
|
-
name?: string
|
|
235
|
-
urlPrefix: string
|
|
236
|
-
store: JsObjectStoreConfig
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
/** Specification for a virtual chunk reference */
|
|
240
|
-
export interface VirtualChunkSpec {
|
|
241
|
-
index: Array<number>
|
|
242
|
-
location: string
|
|
243
|
-
offset: number
|
|
244
|
-
length: number
|
|
245
|
-
etagChecksum?: string
|
|
246
|
-
/** Last modified datetime (accepts JS Date object) */
|
|
247
|
-
lastModified?: Date
|
|
248
|
-
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@earthmover/icechunk",
|
|
3
|
-
"version": "2.0.0-alpha.
|
|
3
|
+
"version": "2.0.0-alpha.5",
|
|
4
4
|
"description": "JavaScript/TypeScript bindings for Icechunk",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"repository": {
|
|
@@ -108,9 +108,9 @@
|
|
|
108
108
|
},
|
|
109
109
|
"packageManager": "yarn@4.12.0",
|
|
110
110
|
"optionalDependencies": {
|
|
111
|
-
"@earthmover/icechunk-win32-x64-msvc": "2.0.0-alpha.
|
|
112
|
-
"@earthmover/icechunk-linux-x64-gnu": "2.0.0-alpha.
|
|
113
|
-
"@earthmover/icechunk-darwin-arm64": "2.0.0-alpha.
|
|
114
|
-
"@earthmover/icechunk-wasm32-wasi": "2.0.0-alpha.
|
|
111
|
+
"@earthmover/icechunk-win32-x64-msvc": "2.0.0-alpha.5",
|
|
112
|
+
"@earthmover/icechunk-linux-x64-gnu": "2.0.0-alpha.5",
|
|
113
|
+
"@earthmover/icechunk-darwin-arm64": "2.0.0-alpha.5",
|
|
114
|
+
"@earthmover/icechunk-wasm32-wasi": "2.0.0-alpha.5"
|
|
115
115
|
}
|
|
116
116
|
}
|