@earthmover/icechunk 1.0.3 → 2.0.0-alpha.10

package/README.md

@@ -1,112 +1,142 @@
-# `@napi-rs/package-template`
+# Icechunk JS
 
-![https://github.com/napi-rs/package-template/actions](https://github.com/napi-rs/package-template/workflows/CI/badge.svg)
+JavaScript/TypeScript library for Icechunk Zarr Stores. Works as a native Node.js addon and in the browser via WASM.
 
-> Template project for writing node packages with napi-rs.
+## Getting Started
 
-# Usage
-
-1. Click **Use this template**.
-2. **Clone** your project.
-3. Run `yarn install` to install dependencies.
-4. Run `yarn napi rename -n [@your-scope/package-name] -b [binary-name]` command under the project folder to rename your package.
-
-## Install this test package
+Install with `npm`
 
 ```
-yarn add @napi-rs/package-template
+npm install @earthmover/icechunk@alpha
 ```
 
-## Ability
-
-### Build
-
-After `yarn build/npm run build` command, you can see `package-template.[darwin|win32|linux].node` file in project root. This is the native addon built from [lib.rs](./src/lib.rs).
-
-### Test
-
-With [ava](https://github.com/avajs/ava), run `yarn test/npm run test` to testing native addon. You can also switch to another testing framework if you want.
-
-### CI
+> [!NOTE]
+> When using in the browser, you must specify to install the wasm package with `--cpu=wasm32`
 
-With GitHub Actions, each commit and pull request will be built and tested automatically in [`node@20`, `@node22`] x [`macOS`, `Linux`, `Windows`] matrix. You will never be afraid of the native addon broken in these platforms.
+```typescript
+import { Repository, Storage } from '@earthmover/icechunk'
+import * as zarr from 'zarrita'
 
-### Release
+const storage = await Storage.newInMemory()
+const repo = await Repository.create(storage)
 
-Release native package is very difficult in old days. Native packages may ask developers who use it to install `build toolchain` like `gcc/llvm`, `node-gyp` or something more.
+const session = await repo.writableSession('main')
+const store = session.store
 
-With `GitHub actions`, we can easily prebuild a `binary` for major platforms. And with `N-API`, we should never be afraid of **ABI Compatible**.
+// zarrita uses the store directly via duck-typing
+const root = zarr.root(store)
+const arr = await zarr.create(root.resolve('/foo'), {
+    shape: [100], dtype: '<i4', chunks: [10],
+})
 
-The other problem is how to deliver prebuild `binary` to users. Downloading it in `postinstall` script is a common way that most packages do it right now. The problem with this solution is it introduced many other packages to download binary that has not been used by `runtime codes`. The other problem is some users may not easily download the binary from `GitHub/CDN` if they are behind a private network (But in most cases, they have a private NPM mirror).
-
-In this package, we choose a better way to solve this problem. We release different `npm packages` for different platforms. And add it to `optionalDependencies` before releasing the `Major` package to npm.
+const snapshotId = await session.commit('Create foo array')
+```
 
-`NPM` will choose which native package should download from `registry` automatically. You can see [npm](./npm) dir for details. And you can also run `yarn add @napi-rs/package-template` to see how it works.
+## Features
+
+### Storage Backends
+
+In-memory storage works on all platforms. The following backends are available on native (non-WASM) builds:
+
+- **S3** — `Storage.newS3(bucket, prefix?, credentials?, options?)`
+- **R2** — `Storage.newR2(bucket?, prefix?, accountId?, credentials?, options?)`
+- **GCS** — `Storage.newGcs(bucket, prefix?, credentials?, config?)`
+- **Azure Blob** — `Storage.newAzureBlob(account, container, prefix?, credentials?, config?)`
+- **Tigris** — `Storage.newTigris(bucket, prefix?, credentials?, options?)`
+- **HTTP** — `Storage.newHttp(baseUrl, config?)`
+- **Local Filesystem** — `Storage.newLocalFilesystem(path)`
+
+### Custom Storage Backends
+
+For WASM builds (or any environment where the built-in backends aren't suitable), you can provide your own storage implementation in JavaScript using `Storage.newCustom()`:
+
+```typescript
+const storage = Storage.newCustom({
+  canWrite: async () => true,
+  getObjectRange: async ({ path, rangeStart, rangeEnd }) => {
+    const headers: Record<string, string> = {}
+    if (rangeStart != null && rangeEnd != null) {
+      headers['Range'] = `bytes=${rangeStart}-${rangeEnd - 1}`
+    }
+    const resp = await fetch(`https://my-bucket.example.com/${path}`, { headers })
+    return { data: new Uint8Array(await resp.arrayBuffer()), version: { etag: resp.headers.get('etag') ?? undefined } }
+  },
+  putObject: async ({ path, data, contentType }) => { /* ... */ },
+  copyObject: async ({ from, to }) => { /* ... */ },
+  listObjects: async (prefix) => { /* return [{ id, createdAt, sizeBytes }] */ },
+  deleteBatch: async ({ prefix, batch }) => { /* return { deletedObjects, deletedBytes } */ },
+  getObjectLastModified: async (path) => { /* return Date */ },
+  getObjectConditional: async ({ path, previousVersion }) => { /* ... */ },
+})
+```
 
-## Develop requirements
+This is the primary way to use cloud storage in the browser, where native Rust networking is unavailable. Each callback method maps to an operation on the underlying `Storage` trait. See the exported `Storage*` TypeScript interfaces for the full type signatures.
 
-- Install the latest `Rust`
-- Install `Node.js@10+` which fully supported `Node-API`
-- Install `yarn@1.x`
+### Virtual Chunks
 
-## Test in local
+Virtual chunks are supported in node but not in WASM builds.
 
-- yarn
-- yarn build
-- yarn test
+## Using in the Browser (WASM)
 
-And you will see:
+Install the package with the `--cpu=wasm32` flag to get the WASM binary:
 
 ```bash
-$ ava --verbose
-
-  ✔ sync function from native code
-  ✔ sleep function from native code (201ms)
-  ─
-
-  2 tests passed
-✨  Done in 1.12s.
+npm install @earthmover/icechunk --cpu=wasm32
 ```
 
-## Release package
-
-Ensure you have set your **NPM_TOKEN** in the `GitHub` project setting.
-
-In `Settings -> Secrets`, add **NPM_TOKEN** into it.
-
-When you want to release the package:
+The WASM build uses `SharedArrayBuffer` for threading, which requires your server to send these headers:
 
 ```
-npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
+Cross-Origin-Opener-Policy: same-origin
+Cross-Origin-Embedder-Policy: require-corp
+```
 
-git push
+With Vite, you'll also need the `vite-plugin-wasm` and `vite-plugin-top-level-await` plugins, and must exclude the icechunk packages from dependency optimization:
+
+```typescript
+// vite.config.ts
+import wasm from 'vite-plugin-wasm'
+import topLevelAwait from 'vite-plugin-top-level-await'
+
+export default defineConfig({
+  plugins: [wasm(), topLevelAwait()],
+  optimizeDeps: {
+    exclude: ['@earthmover/icechunk', '@earthmover/icechunk-wasm32-wasi'],
+  },
+  server: {
+    headers: {
+      'Cross-Origin-Opener-Policy': 'same-origin',
+      'Cross-Origin-Embedder-Policy': 'require-corp',
+    },
+  },
+})
 ```
 
-GitHub actions will do the rest job for you.
+See the [NAPI-RS WebAssembly docs](https://napi.rs/docs/concepts/webassembly) for more details.
 
-###  Notes
+## Examples
 
-Build wasm binary for npm
-```
-yarn build --target wasm32-wasip1-threads -o npm/wasm32-wasi
-```
+See [`examples/react-wasm`](examples/react-wasm) for an interactive React app demonstrating repository management, branching, tagging, and Zarr store operations in the browser.
 
-Create package dirs
-```
-yarn napi create-npm-dirs
-```
+## For Development
 
-publish
-```
-npm publish --access=public
+```bash
+cd icechunk-js
+yarn install
+yarn build
+yarn test
 ```
 
-Started on adding icechunk, need to turn off all the stuff that doesnt compile for wasm target
-
-https://github.com/gyscos/zstd-rs/issues/93#issuecomment-2110684816
+For WASM:
 
+```bash
+# Requires brew install llvm and env vars (see docs/docs/contributing.md)
+yarn build --target wasm32-wasip1-threads
+NAPI_RS_FORCE_WASI=1 yarn test
 ```
-export PATH="/opt/homebrew/opt/llvm/bin/:$PATH"
-export CC=/opt/homebrew/opt/llvm/bin/clang
-export AR=/opt/homebrew/opt/llvm/bin/llvm-ar
-```
+
+> [!IMPORTANT]
+> Building the WASM target requires Rust 1.95+ (or a nightly after 2026-01-19).
+> Rust 1.94 has a bug where `std::thread::spawn` is unconditionally disabled on all WASI targets,
+> including `wasm32-wasip1-threads` which supports threading.
+> See [rust-lang/rust#151309](https://github.com/rust-lang/rust/pull/151309) for the fix.

package/index.d.ts

@@ -1,3 +1,120 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-export declare function plus100(input: number): number
+export declare class Repository {
+  static create(storage: JsStorage, config?: RepositoryConfig | undefined | null, specVersion?: number | undefined | null, authorizeVirtualChunkAccess?: Record<string, JsCredentials | undefined | null> | undefined | null, checkCleanRoot?: boolean | undefined | null): Promise<Repository>
+  static open(storage: JsStorage, config?: RepositoryConfig | undefined | null, authorizeVirtualChunkAccess?: Record<string, JsCredentials | undefined | null> | undefined | null): Promise<Repository>
+  static openOrCreate(storage: JsStorage, config?: RepositoryConfig | undefined | null, specVersion?: number | undefined | null, authorizeVirtualChunkAccess?: Record<string, JsCredentials | undefined | null> | undefined | null, checkCleanRoot?: boolean | undefined | null): Promise<Repository>
+  static exists(storage: JsStorage, storageSettings?: StorageSettings | undefined | null): Promise<boolean>
+  readonlySession(options?: ReadonlySessionOptions | undefined | null): Promise<JsSession>
+  writableSession(branch: string): Promise<JsSession>
+  listBranches(): Promise<Array<string>>
+  createBranch(name: string, snapshotId: string): Promise<void>
+  listTags(): Promise<Array<string>>
+  createTag(name: string, snapshotId: string): Promise<void>
+  lookupManifestFiles(snapshotId: string): Promise<Array<JsManifestFileInfo>>
+}
+export type JsRepository = Repository
+
+export declare class Session {
+  get readOnly(): boolean
+  get snapshotId(): string
+  get branch(): string | null
+  get hasUncommittedChanges(): boolean
+  get store(): JsStore
+  commit(message: string): Promise<string>
+  discardChanges(): Promise<void>
+}
+export type JsSession = Session
+
+export declare class Storage {
+  static newInMemory(): Promise<Storage>
+}
+export type JsStorage = Storage
+
+export declare class Store {
+  get(key: string): Promise<Buffer | null>
+  getRange(key: string, offset: number, length?: number | undefined | null): Promise<Buffer | null>
+  set(key: string, value: Buffer): Promise<void>
+  exists(key: string): Promise<boolean>
+  delete(key: string): Promise<void>
+  list(): Promise<Array<string>>
+  listPrefix(prefix: string): Promise<Array<string>>
+  listDir(prefix: string): Promise<Array<string>>
+  get supportsWrites(): boolean
+  get supportsDeletes(): boolean
+  get supportsListing(): boolean
+}
+export type JsStore = Store
+
+/** Caching configuration */
+export interface CachingConfig {
+  numSnapshotNodes?: number
+  numChunkRefs?: number
+  numTransactionChanges?: number
+  numBytesAttributes?: number
+  numBytesChunks?: number
+}
+
+/** Compression algorithm */
+export declare const enum CompressionAlgorithm {
+  Zstd = 0
+}
+
+/** Compression configuration */
+export interface CompressionConfig {
+  algorithm?: CompressionAlgorithm
+  level?: number
+}
+
+export interface ManifestFileInfo {
+  id: string
+  sizeBytes: number
+  numChunkRefs: number
+}
+
+export interface ReadonlySessionOptions {
+  branch?: string
+  tag?: string
+  snapshotId?: string
+}
+
+/** Repository configuration (WASM build — no virtual chunk support) */
+export interface RepositoryConfig {
+  inlineChunkThresholdBytes?: number
+  getPartialValuesConcurrency?: number
+  compression?: CompressionConfig
+  maxConcurrentRequests?: number
+  caching?: CachingConfig
+  storage?: StorageSettings
+  /**
+   * Manifest configuration, passed as a JSON-compatible object.
+   * The object is deserialized using serde, matching the Rust ManifestConfig structure.
+   */
+  manifest?: any
+}
+
+/** Storage concurrency settings */
+export interface StorageConcurrencySettings {
+  maxConcurrentRequestsForObject?: number
+  idealConcurrentRequestSize?: number
+}
+
+/** Storage retries settings */
+export interface StorageRetriesSettings {
+  maxTries?: number
+  initialBackoffMs?: number
+  maxBackoffMs?: number
+}
+
+/** Storage settings */
+export interface StorageSettings {
+  concurrency?: StorageConcurrencySettings
+  retries?: StorageRetriesSettings
+  unsafeUseConditionalUpdate?: boolean
+  unsafeUseConditionalCreate?: boolean
+  unsafeUseMetadata?: boolean
+  storageClass?: string
+  metadataStorageClass?: string
+  chunksStorageClass?: string
+  minimumSizeForMultipartUpload?: number
+}

package/index.js

@@ -66,30 +66,40 @@ const isMuslFromChildProcess = () => {
 function requireNative() {
   if (process.env.NAPI_RS_NATIVE_LIBRARY_PATH) {
     try {
-      nativeBinding = require(process.env.NAPI_RS_NATIVE_LIBRARY_PATH);
+      return require(process.env.NAPI_RS_NATIVE_LIBRARY_PATH);
     } catch (err) {
       loadErrors.push(err)
     }
   } else if (process.platform === 'android') {
     if (process.arch === 'arm64') {
       try {
-        return require('./icechunk-js.android-arm64.node')
+        return require('./icechunk.android-arm64.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-android-arm64')
+        const binding = require('@earthmover/icechunk-android-arm64')
+        const bindingPackageVersion = require('@earthmover/icechunk-android-arm64/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
     } else if (process.arch === 'arm') {
       try {
-        return require('./icechunk-js.android-arm-eabi.node')
+        return require('./icechunk.android-arm-eabi.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-android-arm-eabi')
+        const binding = require('@earthmover/icechunk-android-arm-eabi')
+        const bindingPackageVersion = require('@earthmover/icechunk-android-arm-eabi/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
@@ -99,34 +109,49 @@ function requireNative() {
   } else if (process.platform === 'win32') {
     if (process.arch === 'x64') {
       try {
-        return require('./icechunk-js.win32-x64-msvc.node')
+        return require('./icechunk.win32-x64-msvc.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-win32-x64-msvc')
+        const binding = require('@earthmover/icechunk-win32-x64-msvc')
+        const bindingPackageVersion = require('@earthmover/icechunk-win32-x64-msvc/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
     } else if (process.arch === 'ia32') {
       try {
-        return require('./icechunk-js.win32-ia32-msvc.node')
+        return require('./icechunk.win32-ia32-msvc.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-win32-ia32-msvc')
+        const binding = require('@earthmover/icechunk-win32-ia32-msvc')
+        const bindingPackageVersion = require('@earthmover/icechunk-win32-ia32-msvc/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
     } else if (process.arch === 'arm64') {
       try {
-        return require('./icechunk-js.win32-arm64-msvc.node')
+        return require('./icechunk.win32-arm64-msvc.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-win32-arm64-msvc')
+        const binding = require('@earthmover/icechunk-win32-arm64-msvc')
+        const bindingPackageVersion = require('@earthmover/icechunk-win32-arm64-msvc/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
@@ -135,34 +160,49 @@ function requireNative() {
     }
   } else if (process.platform === 'darwin') {
     try {
-      return require('./icechunk-js.darwin-universal.node')
+      return require('./icechunk.darwin-universal.node')
     } catch (e) {
       loadErrors.push(e)
     }
     try {
-      return require('@earthmover/icechunk-darwin-universal')
+      const binding = require('@earthmover/icechunk-darwin-universal')
+      const bindingPackageVersion = require('@earthmover/icechunk-darwin-universal/package.json').version
+      if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+        throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+      }
+      return binding
     } catch (e) {
       loadErrors.push(e)
     }
     if (process.arch === 'x64') {
       try {
-        return require('./icechunk-js.darwin-x64.node')
+        return require('./icechunk.darwin-x64.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-darwin-x64')
+        const binding = require('@earthmover/icechunk-darwin-x64')
+        const bindingPackageVersion = require('@earthmover/icechunk-darwin-x64/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
     } else if (process.arch === 'arm64') {
       try {
-        return require('./icechunk-js.darwin-arm64.node')
+        return require('./icechunk.darwin-arm64.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-darwin-arm64')
+        const binding = require('@earthmover/icechunk-darwin-arm64')
+        const bindingPackageVersion = require('@earthmover/icechunk-darwin-arm64/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
@@ -172,23 +212,33 @@ function requireNative() {
   } else if (process.platform === 'freebsd') {
     if (process.arch === 'x64') {
       try {
-        return require('./icechunk-js.freebsd-x64.node')
+        return require('./icechunk.freebsd-x64.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-freebsd-x64')
+        const binding = require('@earthmover/icechunk-freebsd-x64')
+        const bindingPackageVersion = require('@earthmover/icechunk-freebsd-x64/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
     } else if (process.arch === 'arm64') {
       try {
-        return require('./icechunk-js.freebsd-arm64.node')
+        return require('./icechunk.freebsd-arm64.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-freebsd-arm64')
+        const binding = require('@earthmover/icechunk-freebsd-arm64')
+        const bindingPackageVersion = require('@earthmover/icechunk-freebsd-arm64/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
@@ -199,23 +249,33 @@ function requireNative() {
     if (process.arch === 'x64') {
       if (isMusl()) {
         try {
-          return require('./icechunk-js.linux-x64-musl.node')
+          return require('./icechunk.linux-x64-musl.node')
         } catch (e) {
           loadErrors.push(e)
         }
         try {
-          return require('@earthmover/icechunk-linux-x64-musl')
+          const binding = require('@earthmover/icechunk-linux-x64-musl')
+          const bindingPackageVersion = require('@earthmover/icechunk-linux-x64-musl/package.json').version
+          if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          }
+          return binding
         } catch (e) {
           loadErrors.push(e)
         }
       } else {
         try {
-          return require('./icechunk-js.linux-x64-gnu.node')
+          return require('./icechunk.linux-x64-gnu.node')
         } catch (e) {
           loadErrors.push(e)
         }
         try {
-          return require('@earthmover/icechunk-linux-x64-gnu')
+          const binding = require('@earthmover/icechunk-linux-x64-gnu')
+          const bindingPackageVersion = require('@earthmover/icechunk-linux-x64-gnu/package.json').version
+          if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          }
+          return binding
         } catch (e) {
           loadErrors.push(e)
         }
@@ -223,23 +283,33 @@ function requireNative() {
     } else if (process.arch === 'arm64') {
       if (isMusl()) {
         try {
-          return require('./icechunk-js.linux-arm64-musl.node')
+          return require('./icechunk.linux-arm64-musl.node')
         } catch (e) {
           loadErrors.push(e)
         }
         try {
-          return require('@earthmover/icechunk-linux-arm64-musl')
+          const binding = require('@earthmover/icechunk-linux-arm64-musl')
+          const bindingPackageVersion = require('@earthmover/icechunk-linux-arm64-musl/package.json').version
+          if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          }
+          return binding
         } catch (e) {
           loadErrors.push(e)
         }
       } else {
         try {
-          return require('./icechunk-js.linux-arm64-gnu.node')
+          return require('./icechunk.linux-arm64-gnu.node')
         } catch (e) {
           loadErrors.push(e)
         }
         try {
-          return require('@earthmover/icechunk-linux-arm64-gnu')
+          const binding = require('@earthmover/icechunk-linux-arm64-gnu')
+          const bindingPackageVersion = require('@earthmover/icechunk-linux-arm64-gnu/package.json').version
+          if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          }
+          return binding
         } catch (e) {
           loadErrors.push(e)
         }
@@ -247,23 +317,67 @@ function requireNative() {
     } else if (process.arch === 'arm') {
       if (isMusl()) {
         try {
-          return require('./icechunk-js.linux-arm-musleabihf.node')
+          return require('./icechunk.linux-arm-musleabihf.node')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+        try {
+          const binding = require('@earthmover/icechunk-linux-arm-musleabihf')
+          const bindingPackageVersion = require('@earthmover/icechunk-linux-arm-musleabihf/package.json').version
+          if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          }
+          return binding
+        } catch (e) {
+          loadErrors.push(e)
+        }
+      } else {
+        try {
+          return require('./icechunk.linux-arm-gnueabihf.node')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+        try {
+          const binding = require('@earthmover/icechunk-linux-arm-gnueabihf')
+          const bindingPackageVersion = require('@earthmover/icechunk-linux-arm-gnueabihf/package.json').version
+          if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          }
+          return binding
+        } catch (e) {
+          loadErrors.push(e)
+        }
+      }
+    } else if (process.arch === 'loong64') {
+      if (isMusl()) {
+        try {
+          return require('./icechunk.linux-loong64-musl.node')
         } catch (e) {
           loadErrors.push(e)
         }
         try {
-          return require('@earthmover/icechunk-linux-arm-musleabihf')
+          const binding = require('@earthmover/icechunk-linux-loong64-musl')
+          const bindingPackageVersion = require('@earthmover/icechunk-linux-loong64-musl/package.json').version
+          if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          }
+          return binding
         } catch (e) {
           loadErrors.push(e)
         }
       } else {
         try {
-          return require('./icechunk-js.linux-arm-gnueabihf.node')
+          return require('./icechunk.linux-loong64-gnu.node')
         } catch (e) {
           loadErrors.push(e)
         }
         try {
-          return require('@earthmover/icechunk-linux-arm-gnueabihf')
+          const binding = require('@earthmover/icechunk-linux-loong64-gnu')
+          const bindingPackageVersion = require('@earthmover/icechunk-linux-loong64-gnu/package.json').version
+          if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          }
+          return binding
         } catch (e) {
           loadErrors.push(e)
         }
@@ -271,46 +385,66 @@ function requireNative() {
     } else if (process.arch === 'riscv64') {
       if (isMusl()) {
         try {
-          return require('./icechunk-js.linux-riscv64-musl.node')
+          return require('./icechunk.linux-riscv64-musl.node')
         } catch (e) {
           loadErrors.push(e)
         }
         try {
-          return require('@earthmover/icechunk-linux-riscv64-musl')
+          const binding = require('@earthmover/icechunk-linux-riscv64-musl')
+          const bindingPackageVersion = require('@earthmover/icechunk-linux-riscv64-musl/package.json').version
+          if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          }
+          return binding
         } catch (e) {
           loadErrors.push(e)
         }
       } else {
         try {
-          return require('./icechunk-js.linux-riscv64-gnu.node')
+          return require('./icechunk.linux-riscv64-gnu.node')
         } catch (e) {
           loadErrors.push(e)
         }
         try {
-          return require('@earthmover/icechunk-linux-riscv64-gnu')
+          const binding = require('@earthmover/icechunk-linux-riscv64-gnu')
+          const bindingPackageVersion = require('@earthmover/icechunk-linux-riscv64-gnu/package.json').version
+          if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          }
+          return binding
         } catch (e) {
           loadErrors.push(e)
         }
       }
     } else if (process.arch === 'ppc64') {
       try {
-        return require('./icechunk-js.linux-ppc64-gnu.node')
+        return require('./icechunk.linux-ppc64-gnu.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-linux-ppc64-gnu')
+        const binding = require('@earthmover/icechunk-linux-ppc64-gnu')
+        const bindingPackageVersion = require('@earthmover/icechunk-linux-ppc64-gnu/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
     } else if (process.arch === 's390x') {
       try {
-        return require('./icechunk-js.linux-s390x-gnu.node')
+        return require('./icechunk.linux-s390x-gnu.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-linux-s390x-gnu')
+        const binding = require('@earthmover/icechunk-linux-s390x-gnu')
+        const bindingPackageVersion = require('@earthmover/icechunk-linux-s390x-gnu/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
@@ -320,34 +454,49 @@ function requireNative() {
   } else if (process.platform === 'openharmony') {
     if (process.arch === 'arm64') {
       try {
-        return require('./icechunk-js.linux-arm64-ohos.node')
+        return require('./icechunk.openharmony-arm64.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-linux-arm64-ohos')
+        const binding = require('@earthmover/icechunk-openharmony-arm64')
+        const bindingPackageVersion = require('@earthmover/icechunk-openharmony-arm64/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
     } else if (process.arch === 'x64') {
       try {
-        return require('./icechunk-js.linux-x64-ohos.node')
+        return require('./icechunk.openharmony-x64.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-linux-x64-ohos')
+        const binding = require('@earthmover/icechunk-openharmony-x64')
+        const bindingPackageVersion = require('@earthmover/icechunk-openharmony-x64/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
     } else if (process.arch === 'arm') {
       try {
-        return require('./icechunk-js.linux-arm-ohos.node')
+        return require('./icechunk.openharmony-arm.node')
       } catch (e) {
         loadErrors.push(e)
       }
       try {
-        return require('@earthmover/icechunk-linux-arm-ohos')
+        const binding = require('@earthmover/icechunk-openharmony-arm')
+        const bindingPackageVersion = require('@earthmover/icechunk-openharmony-arm/package.json').version
+        if (bindingPackageVersion !== '2.0.0-alpha.6' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 2.0.0-alpha.6 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        }
+        return binding
       } catch (e) {
         loadErrors.push(e)
       }
@@ -362,22 +511,32 @@ function requireNative() {
 nativeBinding = requireNative()
 
 if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
+  let wasiBinding = null
+  let wasiBindingError = null
   try {
-    nativeBinding = require('./icechunk-js.wasi.cjs')
+    wasiBinding = require('./icechunk.wasi.cjs')
+    nativeBinding = wasiBinding
   } catch (err) {
     if (process.env.NAPI_RS_FORCE_WASI) {
-      loadErrors.push(err)
+      wasiBindingError = err
     }
   }
   if (!nativeBinding) {
     try {
-      nativeBinding = require('@earthmover/icechunk-wasm32-wasi')
+      wasiBinding = require('@earthmover/icechunk-wasm32-wasi')
+      nativeBinding = wasiBinding
     } catch (err) {
       if (process.env.NAPI_RS_FORCE_WASI) {
+        wasiBindingError.cause = err
         loadErrors.push(err)
       }
     }
   }
+  if (process.env.NAPI_RS_FORCE_WASI === 'error' && !wasiBinding) {
+    const error = new Error('WASI binding not found and NAPI_RS_FORCE_WASI is set to error')
+    error.cause = wasiBindingError
+    throw error
+  }
 }
 
 if (!nativeBinding) {
@@ -386,11 +545,25 @@ if (!nativeBinding) {
       `Cannot find native binding. ` +
         `npm has a bug related to optional dependencies (https://github.com/npm/cli/issues/4828). ` +
         'Please try `npm i` again after removing both package-lock.json and node_modules directory.',
-      { cause: loadErrors }
+      {
+        cause: loadErrors.reduce((err, cur) => {
+          cur.cause = err
+          return cur
+        }),
+      },
     )
   }
   throw new Error(`Failed to load native binding`)
 }
 
 module.exports = nativeBinding
-module.exports.plus100 = nativeBinding.plus100
+module.exports.Repository = nativeBinding.Repository
+module.exports.JsRepository = nativeBinding.JsRepository
+module.exports.Session = nativeBinding.Session
+module.exports.JsSession = nativeBinding.JsSession
+module.exports.Storage = nativeBinding.Storage
+module.exports.JsStorage = nativeBinding.JsStorage
+module.exports.Store = nativeBinding.Store
+module.exports.JsStore = nativeBinding.JsStore
+module.exports.CompressionAlgorithm = nativeBinding.CompressionAlgorithm
+module.exports.JsCompressionAlgorithm = nativeBinding.JsCompressionAlgorithm

package/package.json

@@ -1,35 +1,40 @@
 {
   "name": "@earthmover/icechunk",
-  "version": "1.0.3",
-  "description": "Expirimental Icechunk bindings for JavaScript",
-  "browser": "browser.js",
+  "version": "2.0.0-alpha.10",
+  "description": "JavaScript/TypeScript bindings for Icechunk",
   "main": "index.js",
-  "repository": "git@github.com:napi-rs/package-template.git",
-  "license": "n",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/earth-mover/icechunk.git",
+    "directory": "icechunk-js"
+  },
+  "license": "Apache 2",
+  "browser": "browser.js",
   "keywords": [
-    "napi-rs",
-    "NAPI",
-    "N-API",
-    "Rust",
-    "node-addon",
-    "node-addon-api"
+    "icechunk",
+    "zarr",
+    "zarrita",
+    "version-control",
+    "data",
+    "science",
+    "geospatial"
   ],
   "files": [
     "index.d.ts",
-    "index.js"
+    "index.js",
+    "browser.js"
   ],
   "napi": {
-    "binaryName": "icechunk-js",
+    "binaryName": "icechunk",
     "targets": [
       "x86_64-pc-windows-msvc",
-      "x86_64-apple-darwin",
       "x86_64-unknown-linux-gnu",
       "aarch64-apple-darwin",
       "wasm32-wasip1-threads"
     ]
   },
   "engines": {
-    "node": ">= 10.16.0 < 11 || >= 11.8.0 < 12 || >= 12.0.0"
+    "node": ">= 12.22.0 < 13 || >= 14.17.0 < 15 || >= 15.12.0 < 16 || >= 16.0.0"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -45,27 +50,29 @@
     "format:toml": "taplo format",
     "format:rs": "cargo fmt",
     "lint": "oxlint .",
-    "prepublishOnly": "napi prepublish -t npm",
+    "prepublishOnly": "napi prepublish -t npm --no-gh-release",
     "test": "ava",
+    "preversion": "napi build --platform && git add .",
     "version": "napi version",
     "prepare": "husky"
   },
   "devDependencies": {
-    "@emnapi/core": "^1.4.5",
-    "@emnapi/runtime": "^1.4.5",
-    "@napi-rs/cli": "^3.0.3",
-    "@oxc-node/core": "^0.0.30",
+    "@emnapi/core": "^1.8.1",
+    "@emnapi/runtime": "^1.8.1",
+    "@napi-rs/cli": "^3.2.0",
+    "@napi-rs/wasm-runtime": "^1.1.1",
+    "@oxc-node/core": "^0.0.35",
     "@taplo/cli": "^0.7.0",
-    "@tybys/wasm-util": "^0.10.0",
+    "@tybys/wasm-util": "^0.10.1",
     "ava": "^6.4.1",
-    "chalk": "^5.4.1",
+    "chalk": "^5.6.2",
     "husky": "^9.1.7",
-    "lint-staged": "^16.1.2",
+    "lint-staged": "^16.1.6",
     "npm-run-all2": "^8.0.4",
-    "oxlint": "^1.8.0",
+    "oxlint": "^1.14.0",
     "prettier": "^3.6.2",
-    "tinybench": "^4.0.1",
-    "typescript": "^5.8.3"
+    "tinybench": "^6.0.0",
+    "typescript": "^5.9.2"
   },
   "lint-staged": {
     "*.@(js|ts|tsx)": [
@@ -99,12 +106,11 @@
     "singleQuote": true,
     "arrowParens": "always"
   },
-  "packageManager": "yarn@4.9.2",
+  "packageManager": "yarn@4.12.0",
   "optionalDependencies": {
-    "@earthmover/icechunk-win32-x64-msvc": "1.0.3",
-    "@earthmover/icechunk-darwin-x64": "1.0.3",
-    "@earthmover/icechunk-linux-x64-gnu": "1.0.3",
-    "@earthmover/icechunk-darwin-arm64": "1.0.3",
-    "@earthmover/icechunk-wasm32-wasi": "1.0.3"
+    "@earthmover/icechunk-win32-x64-msvc": "2.0.0-alpha.10",
+    "@earthmover/icechunk-linux-x64-gnu": "2.0.0-alpha.10",
+    "@earthmover/icechunk-darwin-arm64": "2.0.0-alpha.10",
+    "@earthmover/icechunk-wasm32-wasi": "2.0.0-alpha.10"
   }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 N-API for Rust
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.