@obniz/obniz-now-sdk 0.1.0 → 0.1.11

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026 obniz
+
+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

@@ -3,6 +3,209 @@
 TypeScript/JavaScript SDK for Obniz Now API
 
 ## Installation
+```bash
+npm install @obniz/obniz-now-sdk
+```
+
+## Authentication
+
+The SDK supports authentication using an API token (Bearer token). You can obtain your API token from your [Obniz account settings](https://obniz.com/).
+
+### Using API Token
+```typescript
+import { ObnizNow } from '@obniz/obniz-now-sdk';
+
+const client = new ObnizNow({ 
+  token: 'your-api-token-here'
+});
+```
+
+### Using Environment Variables (Recommended)
+```typescript
+const client = new ObnizNow({ 
+  token: process.env.OBNIZ_NOW_TOKEN
+});
+```
+
+## Basic Usage
+
+### List Machines
+
+```typescript
+import { ObnizNow } from '@obniz/obniz-now-sdk';
+
+const client = new ObnizNow({ token: process.env.OBNIZ_TOKEN });
+
+// Get list of machines
+const response = await client.machines.listMachines({ 
+  limit: 10,
+  offset: 0 
+});
+
+console.log(`Found ${response.count} machines`);
+response.items.forEach((item) => {
+  console.log(`- ${item.machine.name} (${item.machine.id})`);
+});
+```
+
+### Get Machine Details
+```typescript
+// Get specific machine
+const machine = await client.machine.getMachine({ 
+  machineId: 'machine-id' 
+});
+
+console.log(`Name: ${machine.name}`);
+console.log(`Created: ${machine.createdAt}`);
+```
+
+### Get Events
+```typescript
+// Get recent events
+const events = await client.events.listEvents({
+  from: new Date(Date.now() - 24 * 60 * 60 * 1000).toISOString(),
+  to: new Date().toISOString(),
+  limit: 20
+});
+
+console.log(`Found ${events.count} events`);
+```
+
+## Error Handling
+
+All API errors are automatically converted to `ObnizNowApiError` with parsed response data.
+
+```typescript
+import { ObnizNow, ObnizNowApiError } from '@obniz/obniz-now-sdk';
+
+try {
+  const machine = await client.machine.getMachine({ machineId: 'invalid-id' });
+} catch (error) {
+  if (error instanceof ObnizNowApiError) {
+    console.error(`Error ${error.status}: ${error.message}`);
+    console.error('Details:', error.data);
+    
+    // Access response headers
+    const headers = error.getResponseHeaders();
+    const rateLimit = headers.get('x-ratelimit-remaining');
+    
+    // Get request URL for debugging
+    console.error('Failed request:', error.getRequestUrl());
+  }
+}
+```
+
+## Browser Usage (Svelte)
+
+### ⚠️ Security Warning
+**Never expose your API token in client-side code!** Use one of these safe approaches:
+
+### Option 1: Cookie-based Authentication (Recommended for custom pages)
+```typescript
+import { ObnizNow } from '@obniz/obniz-now-sdk';
+
+const client = new ObnizNow({
+  baseUrl: window.location.origin,
+  cookies: {
+    // In browsers, existing same-origin cookies are sent by fetch(credentials: "include").
+    // These values are used only by non-browser runtimes where Cookie headers can be set.
+    token: '',
+    accountId: '',
+  },
+});
+
+const machines = await client.machines.listMachines({ limit: 20 });
+```
 
+Your backend should set httpOnly cookies after user authentication.
+
+For plain custom page HTML, import the browser bundle from a CDN or from a file hosted with the page:
+
+```html
+<script type="module">
+  import { ObnizNow } from "https://cdn.jsdelivr.net/npm/@obniz/obniz-now-sdk@0.1.11/dist/index.mjs";
+
+  const client = new ObnizNow({
+    baseUrl: window.location.origin,
+    cookies: { token: "", accountId: "" },
+  });
+
+  const response = await client.machines.listMachines({ limit: 10, offset: 0 });
+  console.log(response.items);
+</script>
+```
+
+### Option 2: Backend Proxy
+```typescript
+// Frontend - call your backend API
+const machines = await fetch('/api/obniz/machines').then(r => r.json());
+
+// Backend (Node.js) - proxy to Obniz API
+app.get('/api/obniz/machines', async (req, res) => {
+  const client = new ObnizNow({ token: process.env.OBNIZ_TOKEN });
+  const data = await client.machines.listMachines({ limit: 20 });
+  res.json(data);
+});
+```
+
+### SvelteKit Server-Side Example
+```typescript
+// src/routes/+page.server.ts
+import { ObnizNow } from '@obniz/obniz-now-sdk';
+
+export async function load() {
+  const client = new ObnizNow({ token: process.env.OBNIZ_TOKEN });
+  const machines = await client.machines.listMachines({ limit: 20 });
+  
+  return { machines: machines.items };
+}
+```
+
+```svelte
+<!-- src/routes/+page.svelte -->
+<script lang="ts">
+  export let data;
+</script>
+
+<h1>Machines</h1>
+<ul>
+  {#each data.machines as item}
+    <li>{item.machine.name}</li>
+  {/each}
+</ul>
+```
+
+## Examples
+See the examples/ directory for more detailed examples:
+
+`basic-usage.ts` - SDK initialization and basic operations
+
+`analytics.ts` - Working with analytics
+
+`events.ts` - Retrieving and filtering events
+
+`machine-management.ts` - CRUD operations
+
+`custom-config.ts` - Advanced configuration (retry, logging)
+
+`advanced-error-handling.ts` - Error inspection and debugging
+
+## API Categories
+
+The `ObnizNow` client exposes generated API groups including:
+
+`account`, `analytics`, `auditLogs`, `connectionModels`, `connections`, `converters`, `customizes`, `events`, `firmware`, `groups`, `inboundConnections`, `inboundSources`, `integrations`, `intelligences`, `invitations`, `issues`, `machine`, `machines`, `notificationHistory`, `notifications`, `obniz`, `reports`, `session`, `threads`, `units`, and `users`.
+
+### Run any example:
 ```bash
-npm install @obniz/obniz-now-sdk
+npx tsx examples/basic-usage.ts
+```
+
+# Requirements
+Node.js >= 18.0.0
+
+# Links
+Website: 
+https://iot.obniz.com
+
+API documentation: https://now.obniz.com/api/1/docs/

package/dist/ObnizNow.d.ts

@@ -1,4 +1,4 @@
-import { AnalyticsApi, ConnectionModelsApi, ConnectionsApi, EventsApi, GroupsApi, InboundConnectionsApi, InboundSourcesApi, IntegrationsApi, IntelligencesApi, IssuesApi, MachineApi, MachinesApi, NotificationsApi, ReportsApi, ThreadsApi, UnitsApi } from "./sdk-core";
+import { AccountApi, AnalyticsApi, AuditLogsApi, ConnectionModelsApi, ConnectionsApi, ConvertersApi, CustomizesApi, EventsApi, FirmwareApi, GroupsApi, InboundConnectionsApi, InboundSourcesApi, IntegrationsApi, IntelligencesApi, InvitationsApi, IssuesApi, MachineApi, MachinesApi, NotificationHistoryApi, NotificationsApi, ObnizApi, ReportsApi, SessionApi, ThreadsApi, UnitsApi, UsersApi } from "./sdk-core";
 export interface CookieAuthOptions {
     token: string;
     accountId: string;
@@ -52,14 +52,24 @@ export type ObnizNowOptions = (BaseOptions & WithoutCookies) | (BaseOptions & Wi
  * ```
  */
 export declare class ObnizNow {
+    /** Account API - Manage current account settings, members, API keys, plan, entitlements, usages, and secrets */
+    readonly account: AccountApi;
     /** Analytics API - Execute and retrieve analytics results */
     readonly analytics: AnalyticsApi;
+    /** Audit Logs API - Access account audit log entries */
+    readonly auditLogs: AuditLogsApi;
     /** Connection Models API - Manage connection model configurations */
     readonly connectionModels: ConnectionModelsApi;
     /** Connections API - Manage machine connections */
     readonly connections: ConnectionsApi;
+    /** Converters API - Data format conversions */
+    readonly converters: ConvertersApi;
+    /** Customizes API - Resolve account, machine, group, and asset customizations */
+    readonly customizes: CustomizesApi;
     /** Events API - Access event data and history */
     readonly events: EventsApi;
+    /** Firmware API - Inspect and update device firmware */
+    readonly firmware: FirmwareApi;
     /** Groups API - Organize machines into groups */
     readonly groups: GroupsApi;
     /** Inbound Connections API - Manage inbound data connections */
@@ -70,20 +80,30 @@ export declare class ObnizNow {
     readonly integrations: IntegrationsApi;
     /** Intelligences API - AI and intelligence features */
     readonly intelligences: IntelligencesApi;
+    /** Invitations API - Manage account invitations */
+    readonly invitations: InvitationsApi;
     /** Issues API - Track and manage issues */
     readonly issues: IssuesApi;
     /** Machine API - Single machine operations */
     readonly machine: MachineApi;
     /** Machines API - Machine management and operations */
     readonly machines: MachinesApi;
+    /** Notification History API - Access notification delivery history */
+    readonly notificationHistory: NotificationHistoryApi;
     /** Notifications API - Manage notification settings */
     readonly notifications: NotificationsApi;
+    /** Obniz API - Access obniz device metadata */
+    readonly obniz: ObnizApi;
     /** Reports API - Generate and retrieve reports */
     readonly reports: ReportsApi;
+    /** Session API - Browser session account selection and UI configuration */
+    readonly session: SessionApi;
     /** Threads API - Discussion threads and communications */
     readonly threads: ThreadsApi;
     /** Units API - Unit data and state management */
     readonly units: UnitsApi;
+    /** Users API - Manage current user and profile pictures */
+    readonly users: UsersApi;
     /**
      * Creates a new ObnizNow SDK client instance
      *
@@ -101,4 +121,4 @@ export declare class ObnizNow {
      */
     constructor(options: ObnizNowOptions);
 }
-export {};
+export * from "./sdk-core";

package/dist/ObnizNowApiError.d.ts

@@ -1,16 +1,13 @@
 import { ResponseError } from "./sdk-core/runtime";
 /**
- * Enhanced API error with automatically parsed response data
- *
- * All API methods automatically convert ResponseError to ObnizApiError,
- * so you get parsed error information without manual handling.
+ * All API methods automatically convert ResponseError to ObnizApiError
  *
  * @example
  * ```typescript
  * try {
  *   await client.machines.getMachine({ id: 'invalid-id' });
  * } catch (error) {
- *   if (error instanceof ObnizApiError) {
+ *   if (error instanceof ObnizNowApiError) {
  *     console.error(`API Error [${error.status}]: ${error.message}`);
  *     console.error('Error data:', error.data);
  *   }
@@ -28,7 +25,7 @@ export declare class ObnizNowApiError extends Error {
     readonly originalError: ResponseError;
     constructor(responseError: ResponseError, status: number, statusText: string, data: any);
     /**
-     * Create ObnizApiError from ResponseError by parsing the response
+     * Create ObnizNowApiError from ResponseError by parsing the response
      */
     static fromResponseError(error: ResponseError): Promise<ObnizNowApiError>;
     /**
@@ -57,6 +54,6 @@ export declare class ObnizNowApiError extends Error {
     };
 }
 /**
- * Wraps an API object to automatically convert ResponseError to ObnizApiError
+ * Wraps an API object to automatically convert ResponseError to ObnizNowApiError
  */
 export declare function wrapApiWithErrorHandling<T extends object>(api: T): T;

package/dist/index.d.ts

@@ -1,2 +1,5 @@
-export * from "./ObnizNow";
+export { ObnizNow } from "./ObnizNow";
+export type { ObnizNowOptions, ObnizNowTokenOptions, ObnizNowCookiesOptions, } from "./ObnizNow";
 export { ObnizNowApiError } from "./ObnizNowApiError";
+import * as Core from "./sdk-core/index";
+export { Core as Models };