crossbar-client 1.0.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,136 @@
+# crossbar
+
+TypeScript HTTP client for the [Kazoo](https://www.2600hz.org/) (2600hz) Crossbar REST API.
+
+- Zero runtime dependencies (native `fetch`)
+- Full TypeScript types with generics
+- Automatic auth token management
+- Transparent request/response envelope handling
+- Dual ESM/CJS support
+
+## Install
+
+```bash
+npm install crossbar
+```
+
+## Quick Start
+
+```typescript
+import { CrossbarClient } from "crossbar";
+
+const client = new CrossbarClient({
+  url: "http://kazoo.example.com:8000",
+  auth: {
+    type: "credentials",
+    credentials: "md5_hash_of_username:password",
+    accountName: "my_account",
+  },
+});
+
+// Authenticate (stores token automatically)
+await client.authenticate();
+
+// List devices with typed response
+interface Device {
+  id: string;
+  name: string;
+  sip: { ip: string };
+}
+
+const response = await client.get<Device[]>("/accounts/{ACCOUNT_ID}/devices");
+console.log(response.data); // Device[]
+
+// Create a user (PUT = create in Crossbar)
+const user = await client.put("/accounts/{ACCOUNT_ID}/users", {
+  first_name: "John",
+  last_name: "Doe",
+  email: "john@example.com",
+});
+```
+
+## Authentication
+
+### User Credentials
+
+```typescript
+const client = new CrossbarClient({
+  url: "http://kazoo.example.com:8000",
+  auth: {
+    type: "credentials",
+    credentials: "md5_hash",
+    accountName: "my_account", // or accountId
+  },
+});
+await client.authenticate();
+```
+
+### API Key
+
+```typescript
+const client = new CrossbarClient({
+  url: "http://kazoo.example.com:8000",
+  auth: {
+    type: "api_key",
+    apiKey: "your_api_key",
+  },
+});
+await client.authenticate();
+```
+
+### Pre-existing Token
+
+```typescript
+const client = new CrossbarClient({
+  url: "http://kazoo.example.com:8000",
+  auth: {
+    type: "token",
+    token: "existing_auth_token",
+  },
+});
+```
+
+## Configuration
+
+```typescript
+const client = new CrossbarClient({
+  url: "http://kazoo.example.com:8000", // required
+  version: "v2",                         // default: "v2"
+  timeout: 30000,                        // default request timeout (ms)
+  headers: {                             // custom headers sent with every request
+    "X-Custom-Header": "value",
+  },
+  auth: { /* ... */ },
+});
+```
+
+## Per-Request Options
+
+```typescript
+const response = await client.get("/accounts/{id}/users", {
+  headers: { "X-Request-Header": "value" },
+  query: { page_size: "10" },
+  timeout: 5000,
+  signal: AbortSignal.timeout(10000),
+});
+```
+
+## HTTP Methods
+
+Crossbar uses non-standard HTTP method semantics:
+
+| Method   | Crossbar Meaning | Client Method |
+|----------|-----------------|---------------|
+| `GET`    | Read            | `client.get(path, options?)` |
+| `PUT`    | **Create**      | `client.put(path, data?, options?)` |
+| `POST`   | **Update**      | `client.post(path, data?, options?)` |
+| `PATCH`  | Partial update  | `client.patch(path, data?, options?)` |
+| `DELETE` | Delete          | `client.delete(path, options?)` |
+
+## Requirements
+
+- Node.js >= 22.0.0
+
+## License
+
+ISC