@databricks/zerobus-ingest-sdk 0.2.0 → 1.0.0

package/Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "zerobus-sdk-ts"
-version = "0.2.0"
+version = "1.0.0"
 authors = ["Databricks"]
 edition = "2021"
 license-file = "LICENSE"
 description = "TypeScript/Node.js bindings for the Databricks Zerobus SDK"
-repository = "https://github.com/databricks/zerobus-sdk-ts"
+repository = "https://github.com/databricks/zerobus-sdk"
 
 [lib]
 crate-type = ["cdylib"]
@@ -16,7 +16,7 @@ napi = { version = "2", features = ["async", "tokio_rt", "serde-json"] }
 napi-derive = "2"
 
 # The Rust SDK we're wrapping
-databricks-zerobus-ingest-sdk = { git = "https://github.com/databricks/zerobus-sdk-rs", tag = "v0.4.0" }
+databricks-zerobus-ingest-sdk = "1.0.0"
 
 # Async runtime (same as the Rust SDK)
 tokio = { version = "1.42", features = ["macros", "rt-multi-thread"] }

package/README.md

@@ -1,17 +1,12 @@
 # Databricks Zerobus Ingest SDK for TypeScript
 
-[Public Preview](https://docs.databricks.com/release-notes/release-types.html): This SDK is supported for production use cases and is available to all customers. Databricks is actively working on stabilizing the Zerobus Ingest SDK for TypeScript. Minor version updates may include backwards-incompatible changes.
-
-We are keen to hear feedback from you on this SDK. Please [file issues](https://github.com/databricks/zerobus-sdk-ts/issues), and we will address them.
-
-The Databricks Zerobus Ingest SDK for TypeScript provides a high-performance client for ingesting data directly into Databricks Delta tables using the Zerobus streaming protocol. This SDK wraps the high-performance [Rust SDK](https://github.com/databricks/zerobus-sdk-rs) using native bindings for optimal performance. | See also the [SDK for Rust](https://github.com/databricks/zerobus-sdk-rs) | See also the [SDK for Python](https://github.com/databricks/zerobus-sdk-py) | See also the [SDK for Java](https://github.com/databricks/zerobus-sdk-java) | See also the [SDK for Go](https://github.com/databricks/zerobus-sdk-go)
+The Databricks Zerobus Ingest SDK for TypeScript provides a high-performance client for ingesting data directly into Databricks Delta tables using the Zerobus streaming protocol. This SDK wraps the high-performance [Rust SDK](https://github.com/databricks/zerobus-sdk/tree/main/rust) using native bindings for optimal performance.
 
 ## Table of Contents
 
 - [Features](#features)
 - [Requirements](#requirements)
 - [Quick Start User Guide](#quick-start-user-guide)
-  - [Prerequisites](#prerequisites)
   - [Installation](#installation)
   - [Choose Your Serialization Format](#choose-your-serialization-format)
   - [Option 1: Using JSON (Quick Start)](#option-1-using-json-quick-start)
@@ -25,8 +20,8 @@ The Databricks Zerobus Ingest SDK for TypeScript provides a high-performance cli
 - [Best Practices](#best-practices)
 - [Platform Support](#platform-support)
 - [Architecture](#architecture)
-- [Contributing](#contributing)
-- [Related Projects](#related-projects)
+- [Community and Contributing](#community-and-contributing)
+- [License](#license)
 
 ## Features
 
@@ -67,65 +62,7 @@ These will be installed automatically:
 
 ### Prerequisites
 
-Before using the SDK, you'll need the following:
-
-#### 1. Workspace URL and Workspace ID
-
-After logging into your Databricks workspace, look at the browser URL:
-
-```
-https://<databricks-instance>.cloud.databricks.com/?o=<workspace-id>
-```
-
-- **Workspace URL**: The part before `/?o=` → `https://<databricks-instance>.cloud.databricks.com`
-- **Workspace ID**: The part after `?o=` → `<workspace-id>`
-- **Zerobus Endpoint**: `https://<workspace-id>.zerobus.<region>.cloud.databricks.com`
-
-> **Note:** The examples above show AWS endpoints (`.cloud.databricks.com`). For Azure deployments, the workspace URL will be `https://<databricks-instance>.azuredatabricks.net` and Zerobus endpoint will use `.azuredatabricks.net`.
-
-Example:
-- Full URL: `https://dbc-a1b2c3d4-e5f6.cloud.databricks.com/?o=1234567890123456`
-- Workspace URL: `https://dbc-a1b2c3d4-e5f6.cloud.databricks.com`
-- Workspace ID: `1234567890123456`
-- Zerobus Endpoint: `https://1234567890123456.zerobus.us-west-2.cloud.databricks.com`
-
-#### 2. Create a Delta Table
-
-Create a table using Databricks SQL:
-
-```sql
-CREATE TABLE <catalog_name>.default.air_quality (
-    device_name STRING,
-    temp INT,
-    humidity BIGINT
-)
-USING DELTA;
-```
-
-Replace `<catalog_name>` with your catalog name (e.g., `main`).
-
-#### 3. Create a Service Principal
-
-1. Navigate to **Settings > Identity and Access** in your Databricks workspace
-2. Click **Service principals** and create a new service principal
-3. Generate a new secret for the service principal and save it securely
-4. Grant the following permissions:
-   - `USE_CATALOG` on the catalog (e.g., `main`)
-   - `USE_SCHEMA` on the schema (e.g., `default`)
-   - `MODIFY` and `SELECT` on the table (e.g., `air_quality`)
-
-Grant permissions using SQL:
-
-```sql
--- Grant catalog permission
-GRANT USE CATALOG ON CATALOG <catalog_name> TO `<service-principal-application-id>`;
-
--- Grant schema permission
-GRANT USE SCHEMA ON SCHEMA <catalog_name>.default TO `<service-principal-application-id>`;
-
--- Grant table permissions
-GRANT SELECT, MODIFY ON TABLE <catalog_name>.default.air_quality TO `<service-principal-application-id>`;
-```
+Before using the SDK, you need a Databricks workspace URL, a Delta table, and a service principal. See the [monorepo prerequisites](https://github.com/databricks/zerobus-sdk/blob/main/README.md#prerequisites) for detailed setup instructions.
 
 ### Installation
 
@@ -202,10 +139,10 @@ source $HOME/.cargo/env
 
 **Note for macOS users**: Pre-built binaries are not available. The package will automatically build from source during `npm install`. Ensure you have Rust toolchain and Xcode Command Line Tools installed (see prerequisites above).
 
-1. Extract the SDK package:
+1. Clone the repository:
    ```bash
-   unzip zerobus-sdk-ts.zip
-   cd zerobus-sdk-ts
+   git clone https://github.com/databricks/zerobus-sdk.git
+   cd zerobus-sdk/ts
    ```
 
 2. Install dependencies:
@@ -256,7 +193,7 @@ import { ZerobusSdk, RecordType } from '@databricks/zerobus-ingest-sdk';
 
 // Configuration
 // For AWS:
-const zerobusEndpoint = '<workspace-id>.zerobus.<region>.cloud.databricks.com';
+const zerobusEndpoint = 'https://<workspace-id>.zerobus.<region>.cloud.databricks.com';
 const workspaceUrl = 'https://<workspace-name>.cloud.databricks.com';
 // For Azure:
 // const zerobusEndpoint = '<workspace-id>.zerobus.<region>.azuredatabricks.net';
@@ -419,7 +356,7 @@ import * as airQuality from './examples/generated/air_quality';
 import { loadDescriptorProto } from '@databricks/zerobus-ingest-sdk/utils/descriptor';
 
 // Configuration
-const zerobusEndpoint = '<workspace-id>.zerobus.<region>.cloud.databricks.com';
+const zerobusEndpoint = 'https://<workspace-id>.zerobus.<region>.cloud.databricks.com';
 const workspaceUrl = 'https://<workspace-name>.cloud.databricks.com';
 const tableName = 'main.default.air_quality';
 const clientId = process.env.DATABRICKS_CLIENT_ID!;
@@ -614,7 +551,7 @@ See the `examples/` directory for complete, runnable examples. See [examples/REA
 
 ```bash
 # Set environment variables
-export ZEROBUS_SERVER_ENDPOINT="<workspace-id>.zerobus.<region>.cloud.databricks.com"
+export ZEROBUS_SERVER_ENDPOINT="https://<workspace-id>.zerobus.<region>.cloud.databricks.com"
 export DATABRICKS_WORKSPACE_URL="https://<workspace-name>.cloud.databricks.com"
 export DATABRICKS_CLIENT_ID="your-client-id"
 export DATABRICKS_CLIENT_SECRET="your-client-secret"
@@ -873,7 +810,7 @@ new ZerobusSdk(zerobusEndpoint: string, unityCatalogUrl: string)
 ```
 
 **Parameters:**
-- `zerobusEndpoint` (string) - The Zerobus gRPC endpoint (e.g., `<workspace-id>.zerobus.<region>.cloud.databricks.com` for AWS, or `<workspace-id>.zerobus.<region>.azuredatabricks.net` for Azure)
+- `zerobusEndpoint` (string) - The Zerobus gRPC endpoint (e.g., `https://<workspace-id>.zerobus.<region>.cloud.databricks.com` for AWS, or `https://<workspace-id>.zerobus.<region>.azuredatabricks.net` for Azure)
 - `unityCatalogUrl` (string) - The Unity Catalog endpoint (your workspace URL)
 
 **Methods:**
@@ -1203,7 +1140,7 @@ The build process happens automatically during installation and typically takes
 
 ## Architecture
 
-This SDK wraps the high-performance [Rust Zerobus SDK](https://github.com/databricks/zerobus-sdk-rs) using [NAPI-RS](https://napi.rs):
+This SDK wraps the high-performance [Rust Zerobus SDK](https://github.com/databricks/zerobus-sdk/tree/main/rust) using [NAPI-RS](https://napi.rs):
 
 ```
 ┌─────────────────────────────┐
@@ -1228,13 +1165,16 @@ This SDK wraps the high-performance [Rust Zerobus SDK](https://github.com/databr
 - **Automatic memory management** - No manual cleanup required
 - **Type safety** - Compile-time checks on both sides
 
-## Contributing
+## Community and Contributing
+
+This is an open source project. We welcome contributions, feedback, and bug reports.
 
-We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+- **[Contributing Guide](https://github.com/databricks/zerobus-sdk/blob/main/typescript/CONTRIBUTING.md)**: TypeScript-specific development setup and workflow.
+- **[General Contributing Guide](https://github.com/databricks/zerobus-sdk/blob/main/CONTRIBUTING.md)**: Pull request process, commit requirements, and policies.
+- **[Changelog](https://github.com/databricks/zerobus-sdk/blob/main/typescript/CHANGELOG.md)**: See the history of changes in the SDK.
+- **[Security Policy](https://github.com/databricks/zerobus-sdk/blob/main/SECURITY.md)**: Read about our security process and how to report vulnerabilities.
+- **[Developer Certificate of Origin (DCO)](https://github.com/databricks/zerobus-sdk/blob/main/DCO)**: Understand the agreement for contributions.
 
-## Related Projects
+## License
 
-- [Zerobus Rust SDK](https://github.com/databricks/zerobus-sdk-rs) - The underlying Rust implementation
-- [Zerobus Python SDK](https://github.com/databricks/zerobus-sdk-py) - Python SDK for Zerobus
-- [Zerobus Java SDK](https://github.com/databricks/zerobus-sdk-java) - Java SDK for Zerobus
-- [NAPI-RS](https://napi.rs) - Rust/Node.js binding framework
+This SDK is licensed under the Databricks License. See the [LICENSE](https://github.com/databricks/zerobus-sdk/blob/main/LICENSE) file for the full license text. The license is also available online at [https://www.databricks.com/legal/db-license](https://www.databricks.com/legal/db-license).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@databricks/zerobus-ingest-sdk",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "TypeScript/Node.js SDK for streaming data ingestion into Databricks Delta tables using Zerobus",
   "main": "index.js",
   "types": "index.d.ts",
@@ -15,7 +15,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/databricks/zerobus-sdk-ts.git"
+    "url": "https://github.com/databricks/zerobus-sdk"
   },
   "license": "Databricks License",
   "files": [
@@ -34,12 +34,13 @@
   "napi": {
     "name": "zerobus-ingest-sdk",
     "triples": {
-      "defaults": true,
+      "defaults": false,
       "additional": [
-        "x86_64-unknown-linux-musl",
+        "x86_64-unknown-linux-gnu",
         "aarch64-unknown-linux-gnu",
-        "aarch64-apple-darwin",
-        "aarch64-unknown-linux-musl"
+        "x86_64-pc-windows-msvc",
+        "x86_64-apple-darwin",
+        "aarch64-apple-darwin"
       ]
     }
   },
@@ -92,12 +93,10 @@
     "glob": "^10.0.0"
   },
   "optionalDependencies": {
-    "@databricks/zerobus-ingest-sdk-win32-x64-msvc": "0.2.0",
-    "@databricks/zerobus-ingest-sdk-darwin-x64": "0.2.0",
-    "@databricks/zerobus-ingest-sdk-linux-x64-gnu": "0.2.0",
-    "@databricks/zerobus-ingest-sdk-linux-x64-musl": "0.2.0",
-    "@databricks/zerobus-ingest-sdk-linux-arm64-gnu": "0.2.0",
-    "@databricks/zerobus-ingest-sdk-darwin-arm64": "0.2.0",
-    "@databricks/zerobus-ingest-sdk-linux-arm64-musl": "0.2.0"
+    "@databricks/zerobus-ingest-sdk-linux-x64-gnu": "1.0.0",
+    "@databricks/zerobus-ingest-sdk-linux-arm64-gnu": "1.0.0",
+    "@databricks/zerobus-ingest-sdk-win32-x64-msvc": "1.0.0",
+    "@databricks/zerobus-ingest-sdk-darwin-x64": "1.0.0",
+    "@databricks/zerobus-ingest-sdk-darwin-arm64": "1.0.0"
   }
-}
+}

package/src/lib.rs

@@ -901,7 +901,10 @@ impl ZerobusSdk {
                 Error::from_reason("Failed to extract workspace_id from zerobus_endpoint".to_string())
             })?;
 
-        let inner = RustZerobusSdk::new(zerobus_endpoint, unity_catalog_url.clone())
+        let inner = RustZerobusSdk::builder()
+            .endpoint(&zerobus_endpoint)
+            .unity_catalog_url(&unity_catalog_url)
+            .build()
             .map_err(|e| Error::from_reason(format!("Failed to create SDK: {}", e)))?;
 
         Ok(ZerobusSdk {