@databricks/zerobus-ingest-sdk 1.0.1 → 1.0.2

package/Cargo.lock

@@ -2889,7 +2889,7 @@ dependencies = [
 
 [[package]]
 name = "zerobus-sdk-ts"
-version = "1.0.1"
+version = "1.0.2"
 dependencies = [
  "arrow-array",
  "arrow-ipc",

package/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "zerobus-sdk-ts"
-version = "1.0.1"
+version = "1.0.2"
 authors = ["Databricks"]
 edition = "2021"
 license = "Apache-2.0"

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!) The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,40 @@
+Copyright (2025) Databricks, Inc.
+
+This Software includes software developed at Databricks (https://www.databricks.com/) and its use is subject to the included LICENSE file.
+
+---
+
+This Software includes the following open source components:
+
+## Rust Dependencies
+
+### MIT License
+
+- **napi**: Copyright (c) 2020 LongYinan (https://github.com/napi-rs/napi-rs)
+- **napi-derive**: Copyright (c) 2020 LongYinan (https://github.com/napi-rs/napi-rs)
+- **tokio**: Copyright (c) 2019 Tokio Contributors (https://github.com/tokio-rs/tokio)
+- **serde**: Copyright (c) 2014 David Tolnay (https://github.com/serde-rs/serde)
+- **serde_json**: Copyright (c) 2014 David Tolnay (https://github.com/serde-rs/json)
+- **thiserror**: Copyright (c) 2019 David Tolnay (https://github.com/dtolnay/thiserror)
+- **async-trait**: Copyright (c) 2019 David Tolnay (https://github.com/dtolnay/async-trait)
+
+### Apache License 2.0
+
+- **prost**: Copyright (c) 2017 Dan Burkert (https://github.com/tokio-rs/prost)
+- **prost-types**: Copyright (c) 2017 Dan Burkert (https://github.com/tokio-rs/prost)
+- **base64**: Copyright (c) 2015 Alice Maz and Marshall Pierce (https://github.com/marshallpierce/rust-base64)
+
+### Optional: Arrow Flight support (Apache License 2.0)
+
+These components are only included when the `arrow-flight` feature is enabled:
+
+- **arrow-array**: Copyright (c) 2020 Apache Arrow contributors (https://github.com/apache/arrow-rs)
+- **arrow-schema**: Copyright (c) 2020 Apache Arrow contributors (https://github.com/apache/arrow-rs)
+- **arrow-ipc**: Copyright (c) 2020 Apache Arrow contributors (https://github.com/apache/arrow-rs)
+
+## JavaScript Peer Dependencies (optional, user-supplied)
+
+- **protobufjs**: Copyright (c) 2016 Daniel Wirtz (https://github.com/protobufjs/protobuf.js) — BSD 3-Clause
+- **apache-arrow**: Copyright (c) 2020 Apache Arrow contributors (https://github.com/apache/arrow-js) — Apache License 2.0
+
+For a complete list of dependencies and their licenses, see `Cargo.toml` and `package.json`.

package/README.md

@@ -1177,4 +1177,4 @@ This is an open source project. We welcome contributions, feedback, and bug repo
 
 ## License
 
-This SDK is licensed under the Apache License 2.0. See the [LICENSE](https://github.com/databricks/zerobus-sdk/blob/main/LICENSE) file for the full license text.
+This SDK is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for the full text.

package/index.d.ts

@@ -1 +1,485 @@
-export { }
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+/**
+ * Record serialization format.
+ *
+ * Specifies how records should be encoded when ingested into the stream.
+ */
+export const enum RecordType {
+  /** JSON encoding - records are JSON-encoded strings */
+  Json = 0,
+  /** Protocol Buffers encoding - records are binary protobuf messages */
+  Proto = 1
+}
+/**
+ * Configuration options for the Zerobus stream.
+ *
+ * These options control stream behavior including recovery, timeouts, and inflight limits.
+ */
+export interface StreamConfigurationOptions {
+  /**
+   * Maximum number of unacknowledged requests that can be in flight.
+   * Default: 10,000
+   */
+  maxInflightRequests?: number
+  /**
+   * Enable automatic stream recovery on transient failures.
+   * Default: true
+   */
+  recovery?: boolean
+  /**
+   * Timeout for recovery operations in milliseconds.
+   * Default: 15,000 (15 seconds)
+   */
+  recoveryTimeoutMs?: number
+  /**
+   * Delay between recovery retry attempts in milliseconds.
+   * Default: 2,000 (2 seconds)
+   */
+  recoveryBackoffMs?: number
+  /**
+   * Maximum number of recovery attempts before giving up.
+   * Default: 4
+   */
+  recoveryRetries?: number
+  /**
+   * Timeout for flush operations in milliseconds.
+   * Default: 300,000 (5 minutes)
+   */
+  flushTimeoutMs?: number
+  /**
+   * Timeout waiting for server acknowledgments in milliseconds.
+   * Default: 60,000 (1 minute)
+   */
+  serverLackOfAckTimeoutMs?: number
+  /**
+   * Record serialization format.
+   * Use RecordType.Json for JSON encoding or RecordType.Proto for Protocol Buffers.
+   * Default: RecordType.Proto (Protocol Buffers)
+   */
+  recordType?: number
+  /**
+   * Maximum wait time during graceful stream close in milliseconds.
+   * When the server signals stream closure, this controls how long to wait
+   * for in-flight records to be acknowledged.
+   * - None (undefined): Wait for full server-specified duration
+   * - Some(0): Immediately trigger recovery without waiting
+   * - Some(x): Wait up to min(x, server_duration) milliseconds
+   * Default: None (wait for full server duration)
+   */
+  streamPausedMaxWaitTimeMs?: number
+}
+/**
+ * Properties of the target Delta table for ingestion.
+ *
+ * Specifies which Unity Catalog table to write to and optionally the schema descriptor
+ * for Protocol Buffers encoding.
+ */
+export interface TableProperties {
+  /** Full table name in Unity Catalog (e.g., "catalog.schema.table") */
+  tableName: string
+  /**
+   * Optional Protocol Buffer descriptor as a base64-encoded string.
+   * If not provided, JSON encoding will be used.
+   */
+  descriptorProto?: string
+}
+/**
+ * JavaScript headers provider callback wrapper.
+ *
+ * Allows TypeScript code to provide custom authentication headers
+ * by implementing a getHeaders() function.
+ */
+export interface JsHeadersProvider {
+  /** JavaScript function: () => Promise<Array<[string, string]>> */
+  getHeadersCallback: (...args: any[]) => any
+}
+/**
+ * Custom error type for Zerobus operations.
+ *
+ * This error type includes information about whether the error is retryable,
+ * which helps determine if automatic recovery can resolve the issue.
+ */
+export declare class ZerobusError {
+  /** Returns true if this error can be automatically retried by the SDK. */
+  get isRetryable(): boolean
+  /** Get the error message. */
+  get message(): string
+}
+/**
+ * A stream for ingesting data into a Databricks Delta table.
+ *
+ * The stream manages a bidirectional gRPC connection, handles acknowledgments,
+ * and provides automatic recovery on transient failures.
+ *
+ * # Example
+ *
+ * ```typescript
+ * const stream = await sdk.createStream(tableProps, clientId, clientSecret, options);
+ * const ackPromise = await stream.ingestRecord(Buffer.from([1, 2, 3]));
+ * const offset = await ackPromise;
+ * await stream.close();
+ * ```
+ */
+export declare class ZerobusStream {
+  /**
+   * Ingests a single record into the stream.
+   *
+   * **@deprecated** Use `ingestRecordOffset()` instead, which returns the offset directly
+   * after queuing. Then use `waitForOffset()` to wait for acknowledgment when needed.
+   *
+   * This method accepts either:
+   * - A Protocol Buffer encoded record as a Buffer (Vec<u8>)
+   * - A JSON string
+   *
+   * This method BLOCKS until the record is sent to the SDK's internal landing zone,
+   * then returns a Promise for the server acknowledgment. This allows you to send
+   * many records immediately without waiting for acknowledgments:
+   *
+   * ```typescript
+   * let lastAckPromise;
+   * for (let i = 0; i < 1000; i++) {
+   *     // This call blocks until record is sent (in SDK)
+   *     lastAckPromise = stream.ingestRecord(record);
+   * }
+   * // All 1000 records are now in the SDK's internal queue
+   * // Wait for the last acknowledgment
+   * await lastAckPromise;
+   * // Flush to ensure all records are acknowledged
+   * await stream.flush();
+   * ```
+   *
+   * # Arguments
+   *
+   * * `payload` - The record data. Accepts:
+   *   - Buffer (low-level proto bytes)
+   *   - string (low-level JSON string)
+   *   - Protobuf message object with .encode() method (high-level, auto-serializes)
+   *   - Plain JavaScript object (high-level, auto-stringifies to JSON)
+   *
+   * # Returns
+   *
+   * A Promise that resolves to the offset ID when the server acknowledges the record.
+   */
+  ingestRecord(payload: unknown): Promise<bigint>
+  /**
+   * Ingests multiple records as a single atomic batch.
+   *
+   * **@deprecated** Use `ingestRecordsOffset()` instead, which returns the offset directly
+   * after queuing. Then use `waitForOffset()` to wait for acknowledgment when needed.
+   *
+   * This method accepts an array of records (Protocol Buffer buffers or JSON strings)
+   * and ingests them as a batch. The batch receives a single acknowledgment from
+   * the server with all-or-nothing semantics.
+   *
+   * Similar to ingestRecord(), this BLOCKS until the batch is sent to the SDK's
+   * internal landing zone, then returns a Promise for the server acknowledgment.
+   *
+   * # Arguments
+   *
+   * * `records` - Array of record data (Buffer for protobuf, string for JSON)
+   *
+   * # Returns
+   *
+   * Promise resolving to:
+   * - `bigint`: offset ID for non-empty batches
+   * - `null`: for empty batches
+   *
+   * # Example
+   *
+   * ```typescript
+   * const buffers = records.map(r => Buffer.from(encode(r)));
+   * const offsetId = await stream.ingestRecords(buffers);
+   *
+   * if (offsetId !== null) {
+   *   console.log('Batch acknowledged at offset:', offsetId);
+   * }
+   * ```
+   */
+  ingestRecords(records: Array<unknown>): Promise<bigint | null>
+  /**
+   * Ingests a single record and returns a future that resolves to the offset ID after queuing.
+   *
+   * Unlike `ingestRecord()`, this method's Promise resolves immediately after
+   * the record is queued, without waiting for server acknowledgment. Use
+   * `waitForOffset()` to wait for acknowledgment when needed.
+   *
+   * This is the recommended API for high-throughput scenarios where you want to
+   * decouple record ingestion from acknowledgment tracking.
+   *
+   * # Arguments
+   *
+   * * `payload` - The record data (Buffer, string, protobuf message, or plain object)
+   *
+   * # Returns
+   *
+   * `Promise<bigint>` - Resolves to the offset ID immediately after the record is queued
+   * (does not wait for server acknowledgment).
+   *
+   * # Example
+   *
+   * ```typescript
+   * // Promise resolves immediately with offset (before server ack)
+   * const offset1 = await stream.ingestRecordOffset(record1);
+   * const offset2 = await stream.ingestRecordOffset(record2);
+   * // Wait for both to be acknowledged
+   * await stream.waitForOffset(offset2);
+   * ```
+   */
+  ingestRecordOffset(payload: unknown): Promise<bigint>
+  /**
+   * Ingests multiple records as a batch and returns a future that resolves to the offset ID after queuing.
+   *
+   * Unlike `ingestRecords()`, this method's Promise resolves immediately after
+   * the batch is queued, without waiting for server acknowledgment. Use
+   * `waitForOffset()` to wait for acknowledgment when needed.
+   *
+   * # Arguments
+   *
+   * * `records` - Array of record data
+   *
+   * # Returns
+   *
+   * `Promise<bigint | null>` - Resolves to the offset ID immediately after the batch
+   * is queued (does not wait for server acknowledgment). Returns null for empty batches.
+   *
+   * # Example
+   *
+   * ```typescript
+   * // Promise resolves immediately with offset (before server ack)
+   * const offset = await stream.ingestRecordsOffset(batch);
+   * if (offset !== null) {
+   *   await stream.waitForOffset(offset);
+   * }
+   * ```
+   */
+  ingestRecordsOffset(records: Array<unknown>): Promise<bigint | null>
+  /**
+   * Waits for a specific offset to be acknowledged by the server.
+   *
+   * Use this method with `ingestRecordOffset()` and `ingestRecordsOffset()` to
+   * selectively wait for acknowledgments. This allows you to ingest many records
+   * quickly and then wait only for specific offsets when needed.
+   *
+   * # Arguments
+   *
+   * * `offset_id` - The offset ID to wait for (returned by ingestRecordOffset/ingestRecordsOffset)
+   *
+   * # Errors
+   *
+   * - Timeout if acknowledgment takes too long
+   * - Server errors propagated immediately (no waiting for timeout)
+   *
+   * # Example
+   *
+   * ```typescript
+   * const offsets = [];
+   * for (const record of records) {
+   *   offsets.push(await stream.ingestRecordOffset(record));
+   * }
+   * // Wait for the last offset (implies all previous are also acknowledged)
+   * await stream.waitForOffset(offsets[offsets.length - 1]);
+   * ```
+   */
+  waitForOffset(offsetId: bigint): Promise<void>
+  /**
+   * Flushes all pending records and waits for acknowledgments.
+   *
+   * This method ensures all previously ingested records have been sent to the server
+   * and acknowledged. It's useful for checkpointing or ensuring data durability.
+   *
+   * # Errors
+   *
+   * - Timeout errors if flush takes longer than configured timeout
+   * - Network errors if the connection fails during flush
+   */
+  flush(): Promise<void>
+  /**
+   * Closes the stream gracefully.
+   *
+   * This method flushes all pending records, waits for acknowledgments, and then
+   * closes the underlying gRPC connection. Always call this method when done with
+   * the stream to ensure data integrity.
+   *
+   * # Errors
+   *
+   * - Returns an error if some records could not be acknowledged
+   * - Network errors during the close operation
+   */
+  close(): Promise<void>
+  /**
+   * Gets the list of unacknowledged records.
+   *
+   * This method should only be called after a stream failure to retrieve records
+   * that were sent but not acknowledged by the server. These records can be
+   * re-ingested into a new stream.
+   *
+   * # Returns
+   *
+   * An array of Buffers containing the unacknowledged record payloads.
+   */
+  getUnackedRecords(): Promise<Array<Buffer>>
+  /**
+   * Gets unacknowledged records grouped by their original batches.
+   *
+   * This preserves the batch structure from ingestion:
+   * - Each ingestRecord() call → 1-element batch
+   * - Each ingestRecords() call → N-element batch
+   *
+   * Should only be called after stream failure. All records returned as Buffers
+   * (JSON strings are converted to UTF-8 bytes).
+   *
+   * # Returns
+   *
+   * Array of batches, where each batch is an array of Buffers
+   *
+   * # Example
+   *
+   * ```typescript
+   * try {
+   *   await stream.ingestRecords(batch1);
+   *   await stream.ingestRecords(batch2);
+   * } catch (error) {
+   *   const unackedBatches = await stream.getUnackedBatches();
+   *
+   *   // Re-ingest with new stream
+   *   for (const batch of unackedBatches) {
+   *     await newStream.ingestRecords(batch);
+   *   }
+   * }
+   * ```
+   */
+  getUnackedBatches(): Promise<Array<Array<Buffer>>>
+}
+/**
+ * The main SDK for interacting with the Databricks Zerobus service.
+ *
+ * This is the entry point for creating ingestion streams to Delta tables.
+ *
+ * # Example
+ *
+ * ```typescript
+ * const sdk = new ZerobusSdk(
+ *   "https://workspace-id.zerobus.region.cloud.databricks.com",
+ *   "https://workspace.cloud.databricks.com"
+ * );
+ *
+ * const stream = await sdk.createStream(
+ *   { tableName: "catalog.schema.table" },
+ *   "client-id",
+ *   "client-secret"
+ * );
+ * ```
+ */
+export declare class ZerobusSdk {
+  /**
+   * Creates a new Zerobus SDK instance.
+   *
+   * # Arguments
+   *
+   * * `zerobus_endpoint` - The Zerobus API endpoint URL
+   *   (e.g., "https://workspace-id.zerobus.region.cloud.databricks.com")
+   * * `unity_catalog_url` - The Unity Catalog endpoint URL
+   *   (e.g., "https://workspace.cloud.databricks.com")
+   *
+   * # Errors
+   *
+   * - Invalid endpoint URLs
+   * - Failed to extract workspace ID from the endpoint
+   */
+  constructor(zerobusEndpoint: string, unityCatalogUrl: string)
+  /**
+   * Creates a new ingestion stream to a Delta table.
+   *
+   * This method establishes a bidirectional gRPC connection to the Zerobus service
+   * and prepares it for data ingestion. By default, it uses OAuth 2.0 Client Credentials
+   * authentication. For custom authentication (e.g., Personal Access Tokens), provide
+   * a custom headers_provider.
+   *
+   * # Arguments
+   *
+   * * `table_properties` - Properties of the target table including name and optional schema
+   * * `client_id` - OAuth 2.0 client ID (ignored if headers_provider is provided)
+   * * `client_secret` - OAuth 2.0 client secret (ignored if headers_provider is provided)
+   * * `options` - Optional stream configuration (timeouts, recovery settings, etc.)
+   * * `headers_provider` - Optional custom headers provider for authentication.
+   *   If not provided, uses OAuth with client_id and client_secret.
+   *
+   * # Returns
+   *
+   * A Promise that resolves to a ZerobusStream ready for data ingestion.
+   *
+   * # Errors
+   *
+   * - Authentication failures (invalid credentials)
+   * - Invalid table name or insufficient permissions
+   * - Network connectivity issues
+   * - Schema validation errors
+   *
+   * # Example
+   *
+   * ```typescript
+   * // OAuth authentication (default)
+   * const stream = await sdk.createStream(
+   *   { tableName: "catalog.schema.table" },
+   *   "client-id",
+   *   "client-secret"
+   * );
+   *
+   * // Custom authentication with headers provider
+   * const stream = await sdk.createStream(
+   *   { tableName: "catalog.schema.table" },
+   *   "", // ignored
+   *   "", // ignored
+   *   undefined,
+   *   {
+   *     getHeadersCallback: async () => [
+   *       ["authorization", `Bearer ${myToken}`],
+   *       ["x-databricks-zerobus-table-name", tableName]
+   *     ]
+   *   }
+   * );
+   * ```
+   */
+  createStream(tableProperties: TableProperties, clientId: string, clientSecret: string, options?: StreamConfigurationOptions | undefined | null, headersProvider?: JsHeadersProvider | undefined | null): Promise<ZerobusStream>
+  /**
+   * Recreates a stream with the same configuration and re-ingests unacknowledged batches.
+   *
+   * This method is the recommended approach for recovering from stream failures. It:
+   * 1. Retrieves all unacknowledged batches from the failed stream
+   * 2. Creates a new stream with identical configuration
+   * 3. Re-ingests all unacknowledged batches in order
+   * 4. Returns the new stream ready for continued ingestion
+   *
+   * # Arguments
+   *
+   * * `stream` - The failed or closed stream to recreate
+   *
+   * # Returns
+   *
+   * A Promise that resolves to a new ZerobusStream with all unacknowledged batches re-ingested.
+   *
+   * # Errors
+   *
+   * - Failed to retrieve unacknowledged batches from the original stream
+   * - Authentication failures when creating the new stream
+   * - Network connectivity issues during re-ingestion
+   *
+   * # Examples
+   *
+   * ```typescript
+   * try {
+   *   await stream.ingestRecords(batch);
+   * } catch (error) {
+   *   await stream.close();
+   *   // Recreate stream with all unacked batches re-ingested
+   *   const newStream = await sdk.recreateStream(stream);
+   *   // Continue ingesting with newStream
+   * }
+   * ```
+   */
+  recreateStream(stream: ZerobusStream): Promise<ZerobusStream>
+}

package/index.js

@@ -1,21 +1,318 @@
-if (process.platform === "linux" && process.arch === "x64") {
-  try { module.exports = require("@databricks/zerobus-ingest-sdk-linux-x64-gnu"); } catch(e) {
-    module.exports = require("./zerobus-ingest-sdk.linux-x64-gnu.node"); }
-} else
-if (process.platform === "linux" && process.arch === "arm64") {
-  try { module.exports = require("@databricks/zerobus-ingest-sdk-linux-arm64-gnu"); } catch(e) {
-    module.exports = require("./zerobus-ingest-sdk.linux-arm64-gnu.node"); }
-} else
-if (process.platform === "win32" && process.arch === "x64") {
-  try { module.exports = require("@databricks/zerobus-ingest-sdk-win32-x64-msvc"); } catch(e) {
-    module.exports = require("./zerobus-ingest-sdk.win32-x64-msvc.node"); }
-} else
-if (process.platform === "darwin" && process.arch === "x64") {
-  try { module.exports = require("@databricks/zerobus-ingest-sdk-darwin-x64"); } catch(e) {
-    module.exports = require("./zerobus-ingest-sdk.darwin-x64.node"); }
-} else
-if (process.platform === "darwin" && process.arch === "arm64") {
-  try { module.exports = require("@databricks/zerobus-ingest-sdk-darwin-arm64"); } catch(e) {
-    module.exports = require("./zerobus-ingest-sdk.darwin-arm64.node"); }
-} else
-{ throw new Error("Unsupported platform: " + process.platform + "-" + process.arch); }
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'zerobus-ingest-sdk.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zerobus-ingest-sdk.android-arm64.node')
+          } else {
+            nativeBinding = require('@databricks/zerobus-ingest-sdk-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'zerobus-ingest-sdk.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zerobus-ingest-sdk.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@databricks/zerobus-ingest-sdk-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'zerobus-ingest-sdk.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zerobus-ingest-sdk.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@databricks/zerobus-ingest-sdk-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'zerobus-ingest-sdk.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zerobus-ingest-sdk.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@databricks/zerobus-ingest-sdk-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'zerobus-ingest-sdk.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zerobus-ingest-sdk.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@databricks/zerobus-ingest-sdk-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'zerobus-ingest-sdk.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./zerobus-ingest-sdk.darwin-universal.node')
+      } else {
+        nativeBinding = require('@databricks/zerobus-ingest-sdk-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'zerobus-ingest-sdk.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zerobus-ingest-sdk.darwin-x64.node')
+          } else {
+            nativeBinding = require('@databricks/zerobus-ingest-sdk-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'zerobus-ingest-sdk.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zerobus-ingest-sdk.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@databricks/zerobus-ingest-sdk-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'zerobus-ingest-sdk.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./zerobus-ingest-sdk.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@databricks/zerobus-ingest-sdk-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'zerobus-ingest-sdk.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zerobus-ingest-sdk.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@databricks/zerobus-ingest-sdk-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'zerobus-ingest-sdk.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zerobus-ingest-sdk.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@databricks/zerobus-ingest-sdk-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'zerobus-ingest-sdk.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zerobus-ingest-sdk.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@databricks/zerobus-ingest-sdk-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'zerobus-ingest-sdk.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zerobus-ingest-sdk.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@databricks/zerobus-ingest-sdk-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'zerobus-ingest-sdk.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zerobus-ingest-sdk.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@databricks/zerobus-ingest-sdk-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'zerobus-ingest-sdk.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zerobus-ingest-sdk.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@databricks/zerobus-ingest-sdk-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'zerobus-ingest-sdk.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zerobus-ingest-sdk.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@databricks/zerobus-ingest-sdk-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'zerobus-ingest-sdk.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./zerobus-ingest-sdk.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@databricks/zerobus-ingest-sdk-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'zerobus-ingest-sdk.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./zerobus-ingest-sdk.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@databricks/zerobus-ingest-sdk-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { RecordType, ZerobusError, ZerobusStream, ZerobusSdk } = nativeBinding
+
+module.exports.RecordType = RecordType
+module.exports.ZerobusError = ZerobusError
+module.exports.ZerobusStream = ZerobusStream
+module.exports.ZerobusSdk = ZerobusSdk

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@databricks/zerobus-ingest-sdk",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "TypeScript/Node.js SDK for streaming data ingestion into Databricks Delta tables using Zerobus",
   "main": "index.js",
   "types": "index.d.ts",
@@ -23,13 +23,13 @@
     "index.d.ts",
     "README.md",
     "LICENSE",
+    "NOTICE",
     "src/",
     "utils/",
     "schemas/",
     "Cargo.toml",
     "Cargo.lock",
-    "build.rs",
-    "*.node"
+    "build.rs"
   ],
   "napi": {
     "name": "zerobus-ingest-sdk",
@@ -66,6 +66,11 @@
     "example:arrow:single": "tsx examples/arrow/single.ts",
     "example:arrow:batch": "tsx examples/arrow/batch.ts"
   },
+  "optionalDependencies": {
+    "@databricks/zerobus-ingest-sdk-linux-x64-gnu": "1.0.2",
+    "@databricks/zerobus-ingest-sdk-linux-arm64-gnu": "1.0.2",
+    "@databricks/zerobus-ingest-sdk-win32-x64-msvc": "1.0.2"
+  },
   "peerDependencies": {
     "protobufjs": "^7.0.0",
     "apache-arrow": "^56.0.0"