@obniz/obniz-now-sdk 0.1.0

package/README.md

@@ -0,0 +1,8 @@
+# Obniz SDK
+
+TypeScript/JavaScript SDK for Obniz Now API
+
+## Installation
+
+```bash
+npm install @obniz/obniz-now-sdk

package/dist/ObnizApiError.d.ts

@@ -0,0 +1,62 @@
+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.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await client.machines.getMachine({ id: 'invalid-id' });
+ * } catch (error) {
+ *   if (error instanceof ObnizApiError) {
+ *     console.error(`API Error [${error.status}]: ${error.message}`);
+ *     console.error('Error data:', error.data);
+ *   }
+ * }
+ * ```
+ */
+export declare class ObnizApiError extends Error {
+    /** HTTP status code (e.g., 404, 500) */
+    readonly status: number;
+    /** HTTP status text (e.g., "Not Found", "Internal Server Error") */
+    readonly statusText: string;
+    /** Parsed response body data */
+    readonly data: any;
+    /** Original ResponseError for advanced use cases */
+    readonly originalError: ResponseError;
+    constructor(responseError: ResponseError, status: number, statusText: string, data: any);
+    /**
+     * Create ObnizApiError from ResponseError by parsing the response
+     */
+    static fromResponseError(error: ResponseError): Promise<ObnizApiError>;
+    /**
+     * Get response headers (useful for rate limiting, caching, etc.)
+     *
+     * @example
+     * ```typescript
+     * const rateLimit = error.getResponseHeaders().get('x-ratelimit-remaining');
+     * ```
+     */
+    getResponseHeaders(): Headers;
+    /**
+     * Get full request URL
+     */
+    getRequestUrl(): string;
+    /**
+     * Control JSON serialization - don't include originalError
+     */
+    toJSON(): {
+        name: string;
+        message: string;
+        status: number;
+        statusText: string;
+        data: any;
+        stack: string | undefined;
+    };
+}
+/**
+ * Wraps an API object to automatically convert ResponseError to ObnizApiError
+ */
+export declare function wrapApiWithErrorHandling<T extends object>(api: T): T;

package/dist/ObnizNow.d.ts

@@ -0,0 +1,104 @@
+import { AnalyticsApi, ConnectionModelsApi, ConnectionsApi, EventsApi, GroupsApi, InboundConnectionsApi, InboundSourcesApi, IntegrationsApi, IntelligencesApi, IssuesApi, MachineApi, MachinesApi, NotificationsApi, ReportsApi, ThreadsApi, UnitsApi } from "./sdk-core";
+export interface CookieAuthOptions {
+    token: string;
+    accountId: string;
+}
+type BaseOptions = {
+    baseUrl?: string;
+    fetch?: typeof fetch;
+};
+type WithoutCookies = {
+    token: string;
+    cookies?: never;
+};
+type WithCookies = {
+    cookies: CookieAuthOptions;
+    token?: never;
+};
+export type ObnizNowTokenOptions = BaseOptions & WithoutCookies;
+export type ObnizNowCookiesOptions = BaseOptions & WithCookies;
+export type ObnizNowOptions = (BaseOptions & WithoutCookies) | (BaseOptions & WithCookies);
+/**
+ * ObnizNow SDK main class
+ *
+ * Provides access to all Obniz Now API endpoints.
+ *
+ * @example
+ * ```typescript
+ * import { ObnizNow } from '@obniz/sdk';
+ *
+ * // Initialize with your API token
+ * const client = new ObnizNow({
+ *   token: 'your-api-token'
+ * });
+ *
+ * // List machines
+ * const machines = await client.machines.listMachines({ limit: 10 });
+ *
+ * // Get analytics results
+ * const analytics = await client.analytics.getAnalyticsResults(
+ *   'basic_statistics',
+ *   'machine-123'
+ * );
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Custom base URL for local development
+ * const devClient = new ObnizNow({
+ *   token: 'your-token',
+ *   baseUrl: 'http://localhost:8080'
+ * });
+ * ```
+ */
+export declare class ObnizNow {
+    /** Analytics API - Execute and retrieve analytics results */
+    readonly analytics: AnalyticsApi;
+    /** Connection Models API - Manage connection model configurations */
+    readonly connectionModels: ConnectionModelsApi;
+    /** Connections API - Manage machine connections */
+    readonly connections: ConnectionsApi;
+    /** Events API - Access event data and history */
+    readonly events: EventsApi;
+    /** Groups API - Organize machines into groups */
+    readonly groups: GroupsApi;
+    /** Inbound Connections API - Manage inbound data connections */
+    readonly inboundConnections: InboundConnectionsApi;
+    /** Inbound Sources API - Configure data sources */
+    readonly inboundSources: InboundSourcesApi;
+    /** Integrations API - Manage third-party integrations */
+    readonly integrations: IntegrationsApi;
+    /** Intelligences API - AI and intelligence features */
+    readonly intelligences: IntelligencesApi;
+    /** 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;
+    /** Notifications API - Manage notification settings */
+    readonly notifications: NotificationsApi;
+    /** Reports API - Generate and retrieve reports */
+    readonly reports: ReportsApi;
+    /** Threads API - Discussion threads and communications */
+    readonly threads: ThreadsApi;
+    /** Units API - Unit data and state management */
+    readonly units: UnitsApi;
+    /**
+     * Creates a new ObnizNow SDK client instance
+     *
+     * @param options - Configuration options
+     * @param options.token - API authentication token (required)
+     * @param options.baseUrl - Base URL for API requests (optional, defaults to 'https://api.obniz.com')
+     * @param options.fetch - Custom fetch implementation (optional, for Node.js < 18 or custom scenarios)
+     *
+     * @throws {Error} When token is not provided
+     *
+     * @example
+     * ```typescript
+     * const client = new ObnizNow({ token: 'your-api-token' });
+     * ```
+     */
+    constructor(options: ObnizNowOptions);
+}
+export {};

package/dist/ObnizNow.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/ObnizNowApiError.d.ts

@@ -0,0 +1,62 @@
+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.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await client.machines.getMachine({ id: 'invalid-id' });
+ * } catch (error) {
+ *   if (error instanceof ObnizApiError) {
+ *     console.error(`API Error [${error.status}]: ${error.message}`);
+ *     console.error('Error data:', error.data);
+ *   }
+ * }
+ * ```
+ */
+export declare class ObnizNowApiError extends Error {
+    /** HTTP status code (e.g., 404, 500) */
+    readonly status: number;
+    /** HTTP status text (e.g., "Not Found", "Internal Server Error") */
+    readonly statusText: string;
+    /** Parsed response body data */
+    readonly data: any;
+    /** Original ResponseError for advanced use cases */
+    readonly originalError: ResponseError;
+    constructor(responseError: ResponseError, status: number, statusText: string, data: any);
+    /**
+     * Create ObnizApiError from ResponseError by parsing the response
+     */
+    static fromResponseError(error: ResponseError): Promise<ObnizNowApiError>;
+    /**
+     * Get response headers (useful for rate limiting, caching, etc.)
+     *
+     * @example
+     * ```typescript
+     * const rateLimit = error.getResponseHeaders().get('x-ratelimit-remaining');
+     * ```
+     */
+    getResponseHeaders(): Headers;
+    /**
+     * Get full request URL
+     */
+    getRequestUrl(): string;
+    /**
+     * Control JSON serialization - don't include originalError
+     */
+    toJSON(): {
+        name: string;
+        message: string;
+        status: number;
+        statusText: string;
+        data: any;
+        stack: string | undefined;
+    };
+}
+/**
+ * Wraps an API object to automatically convert ResponseError to ObnizApiError
+ */
+export declare function wrapApiWithErrorHandling<T extends object>(api: T): T;