@nvisy/sdk 0.2.0 → 0.3.0

package/dist/config-L7FKq_q5.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @fileoverview Configuration types and constants for the Nvisy SDK.
+ *
+ * This module provides configuration interfaces, default values, and environment
+ * variable names used throughout the SDK.
+ *
+ * @module config
+ */
+/**
+ * Current SDK version.
+ *
+ * Used in the default user agent string and for version tracking.
+ */
+declare const VERSION = "0.3.0";
+/**
+ * Configuration options for creating a Nvisy client.
+ *
+ * The `apiToken` field is required for authentication. All other fields are optional
+ * and will use sensible defaults when omitted.
+ *
+ * @example
+ * ```typescript
+ * const config: ClientConfig = {
+ *   apiToken: "your-api-token",
+ *   baseUrl: "https://api.nvisy.com",
+ *   headers: { "X-Custom-Header": "value" },
+ * };
+ * const client = new Client(config);
+ * ```
+ */
+interface ClientConfig {
+    /**
+     * API token for authentication.
+     *
+     * Tokens can be obtained from the Nvisy dashboard or via the auth endpoints.
+     */
+    apiToken: string;
+    /**
+     * Base URL for the Nvisy API.
+     *
+     * @default "https://api.nvisy.com"
+     */
+    baseUrl?: string;
+    /**
+     * Custom headers to include with every request.
+     *
+     * These headers are merged with the default headers (Content-Type, User-Agent,
+     * and Authorization). Custom headers take precedence over defaults if there
+     * are conflicts.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom user agent string to identify your application.
+     *
+     * @default "@nvisy/sdk v.{version}"
+     */
+    userAgent?: string;
+    /**
+     * Enable logging for requests and responses.
+     *
+     * When enabled, logs request method, URL, status, and timing to console.
+     *
+     * @default false
+     */
+    withLogging?: boolean;
+}
+/**
+ * Default configuration values used when options are not explicitly provided.
+ */
+declare const DEFAULTS: {
+    /**
+     * Default base URL for the Nvisy API.
+     */
+    readonly BASE_URL: "https://api.nvisy.com";
+    /**
+     * Default user agent string.
+     */
+    readonly USER_AGENT: "@nvisy/sdk v.0.3.0";
+};
+
+export { type ClientConfig as C, DEFAULTS as D, VERSION as V };

package/dist/datatypes/index.d.ts

@@ -1,5 +1,6 @@
-import { ag as components } from '../workspace-3RLqaMcj.js';
-export { A as Account, a as Activity, b as ActivityType, c as Annotation, e as ApiToken, g as ApiTokenType, f as ApiTokenWithSecret, u as ArchiveFormat, j as AuthToken, a6 as CheckHealth, k as Comment, r as ContentSegmentation, C as CreateAnnotation, h as CreateApiToken, l as CreateComment, n as CreateDocument, y as CreateIntegration, K as CreateInvite, a9 as CreateWebhook, ad as CreateWorkspace, D as Document, p as DocumentStatus, t as DownloadArchivedFilesRequest, s as DownloadMultipleFilesRequest, F as File, w as FileFormat, x as FileSortField, M as GenerateInviteCode, I as Integration, a3 as IntegrationRun, G as IntegrationStatus, E as IntegrationType, J as Invite, N as InviteCode, Q as InviteExpiration, W as InviteSortField, O as InviteStatus, v as ListFilesQuery, H as ListIntegrationsQuery, V as ListInvitesQuery, _ as ListMembersQuery, L as Login, Y as Member, $ as MemberSortField, a4 as MonitorStatus, a0 as Notification, a1 as NotificationType, a2 as Pagination, P as ProcessingStatus, R as ReplyInvite, a5 as ServiceStatus, S as Signup, X as SortOrder, T as TokenExpiration, U as UpdateAccount, d as UpdateAnnotation, i as UpdateApiToken, m as UpdateComment, o as UpdateDocument, q as UpdateFile, z as UpdateIntegration, B as UpdateIntegrationCredentials, Z as UpdateMemberRole, aa as UpdateWebhook, ae as UpdateWorkspace, a7 as Webhook, ab as WebhookStatus, a8 as WebhookWithSecret, ac as Workspace, af as WorkspaceRole } from '../workspace-3RLqaMcj.js';
+export { A as Account, c as ActivitiesPage, a as Activity, b as ActivityType, d as Annotation, f as AnnotationsPage, g as ApiToken, i as ApiTokenType, h as ApiTokenWithJWT, l as ApiTokensPage, x as ArchiveFormat, af as CheckHealth, m as Comment, p as CommentsPage, u as ContentSegmentation, C as CreateAnnotation, j as CreateApiToken, n as CreateComment, q as CreateDocument, B as CreateIntegration, N as CreateInvite, ah as CreateWebhook, ap as CreateWorkspace, aa as CursorPagination, w as DeleteFiles, D as Document, s as DocumentsPage, v as DownloadFiles, F as File, y as FileFormat, z as FilesPage, O as GenerateInviteCode, I as Integration, ab as IntegrationRun, ac as IntegrationRunsPage, J as IntegrationStatus, H as IntegrationType, K as IntegrationsPage, M as Invite, Q as InviteCode, V as InviteExpiration, Z as InvitePreview, X as InviteSortField, S as InviteStatus, _ as InvitesPage, L as ListFiles, W as ListInvites, a1 as ListMembers, $ as Member, a2 as MemberSortField, a3 as MembersPage, ad as MonitorStatus, a4 as Notification, a5 as NotificationEvent, a6 as NotificationSettings, a9 as NotificationsPage, P as ProcessingStatus, R as ReplyInvite, ae as ServiceStatus, Y as SortOrder, aj as TestWebhook, T as TokenExpiration, a8 as UnreadStatus, U as UpdateAccount, e as UpdateAnnotation, k as UpdateApiToken, o as UpdateComment, r as UpdateDocument, t as UpdateFile, E as UpdateIntegration, G as UpdateIntegrationCredentials, a0 as UpdateMember, a7 as UpdateNotificationSettings, ai as UpdateWebhook, aq as UpdateWorkspace, ag as Webhook, am as WebhookEvent, ak as WebhookResult, al as WebhookStatus, an as WebhooksPage, ao as Workspace, ar as WorkspaceRole, as as WorkspacesPage } from '../workspace-BjdbMWsa.js';
+import { c as components } from '../auth-CncOz2vx.js';
+export { A as AuthToken, L as Login, S as Signup } from '../auth-CncOz2vx.js';
 
 type Schemas = components["schemas"];
 type ErrorResponse = Schemas["ErrorResponse"];

package/dist/index.d.ts

@@ -1,23 +1,49 @@
-export { b as AccountService, c as ActivitiesService, d as AnnotationsService, A as ApiClient, e as ApiTokensService, f as AuthService, C as Client, a as ClientConfig, g as CommentsService, D as DEFAULTS, h as DocumentsService, F as FilesService, I as IntegrationsService, i as InvitesService, M as MembersService, N as NotificationsService, R as RunsService, S as StatusService, V as VERSION, W as WebhooksService, j as WorkspacesService } from './client-D6GtLRbO.js';
-export { A as Account, a as Activity, b as ActivityType, c as Annotation, e as ApiToken, g as ApiTokenType, f as ApiTokenWithSecret, u as ArchiveFormat, j as AuthToken, a6 as CheckHealth, k as Comment, r as ContentSegmentation, C as CreateAnnotation, h as CreateApiToken, l as CreateComment, n as CreateDocument, y as CreateIntegration, K as CreateInvite, a9 as CreateWebhook, ad as CreateWorkspace, D as Document, p as DocumentStatus, t as DownloadArchivedFilesRequest, s as DownloadMultipleFilesRequest, F as File, w as FileFormat, x as FileSortField, M as GenerateInviteCode, I as Integration, a3 as IntegrationRun, G as IntegrationStatus, E as IntegrationType, J as Invite, N as InviteCode, Q as InviteExpiration, W as InviteSortField, O as InviteStatus, v as ListFilesQuery, H as ListIntegrationsQuery, V as ListInvitesQuery, _ as ListMembersQuery, L as Login, Y as Member, $ as MemberSortField, a4 as MonitorStatus, a0 as Notification, a1 as NotificationType, a2 as Pagination, P as ProcessingStatus, R as ReplyInvite, a5 as ServiceStatus, S as Signup, X as SortOrder, T as TokenExpiration, U as UpdateAccount, d as UpdateAnnotation, i as UpdateApiToken, m as UpdateComment, o as UpdateDocument, q as UpdateFile, z as UpdateIntegration, B as UpdateIntegrationCredentials, Z as UpdateMemberRole, aa as UpdateWebhook, ae as UpdateWorkspace, a7 as Webhook, ab as WebhookStatus, a8 as WebhookWithSecret, ac as Workspace, af as WorkspaceRole } from './workspace-3RLqaMcj.js';
+export { A as ApiClient, N as Nvisy } from './client-DQRisDAK.js';
+export { C as ClientConfig, D as DEFAULTS, V as VERSION } from './config-L7FKq_q5.js';
 import { ErrorResponse } from './datatypes/index.js';
-export { ValidationErrorDetail } from './datatypes/index.js';
 import 'openapi-fetch';
+import './auth-CncOz2vx.js';
+import './workspace-BjdbMWsa.js';
 
 /**
  * @fileoverview Error types for the Nvisy SDK.
  *
  * This module defines the error hierarchy used throughout the SDK:
- * - {@link ApiError} - Errors returned by the Nvisy API (4xx/5xx responses)
- * - {@link ConfigError} - Client configuration validation errors
- * - {@link NetworkError} - Network connectivity and request failures
- *
- * All errors extend the built-in Error class and include additional context
- * to help with debugging and error handling.
+ * - {@link NvisyError} - Base error class for all SDK errors
+ * - {@link NvisyApiError} - Errors returned by the Nvisy API (4xx/5xx responses)
  *
  * @module errors
  */
 
+/**
+ * Base error class for all Nvisy SDK errors.
+ *
+ * This class provides common functionality for all SDK errors.
+ * It ensures proper error naming and stack traces.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const client = new Client({ apiToken: "" });
+ * } catch (error) {
+ *   if (error instanceof NvisyError) {
+ *     console.log("SDK error:", error.message);
+ *   }
+ * }
+ * ```
+ */
+declare class NvisyError extends Error {
+    /**
+     * The error class name.
+     */
+    readonly name: string;
+    /**
+     * Creates a new NvisyError.
+     *
+     * @param message - The error message
+     */
+    constructor(message: string);
+}
 /**
  * Error thrown when the Nvisy API returns an error response.
  *
@@ -28,9 +54,9 @@ import 'openapi-fetch';
  * @example
  * ```typescript
  * try {
- *   await client.account.get();
+ *   await client.account.getAccount();
  * } catch (error) {
- *   if (error instanceof ApiError) {
+ *   if (error instanceof NvisyApiError) {
  *     console.log(`API Error: ${error.message}`);
  *     console.log(`Status: ${error.statusCode}`);
  *     if (error.isRetryable()) {
@@ -40,7 +66,7 @@ import 'openapi-fetch';
  * }
  * ```
  */
-declare class ApiError extends Error implements ErrorResponse {
+declare class NvisyApiError extends NvisyError implements ErrorResponse {
     /**
      * The error type identifier (e.g., "ValidationError", "NotFoundError").
      */
@@ -63,13 +89,13 @@ declare class ApiError extends Error implements ErrorResponse {
      * Field-specific validation errors.
      * Present when the error is due to invalid input data.
      */
-    readonly validationErrors?: ErrorResponse["validationErrors"];
+    readonly validation?: ErrorResponse["validation"];
     /**
      * HTTP status code of the response (e.g., 400, 404, 500).
      */
     readonly statusCode: number;
     /**
-     * Creates a new ApiError from an API error response.
+     * Creates a new NvisyApiError from an API error response.
      *
      * @param response - The error response from the API
      * @param statusCode - The HTTP status code of the response
@@ -111,145 +137,5 @@ declare class ApiError extends Error implements ErrorResponse {
      */
     toJSON(): ErrorResponse;
 }
-/**
- * Abstract base class for SDK-specific errors.
- *
- * This class provides common functionality for all client-side errors
- * (as opposed to API errors). It ensures proper error naming and stack traces.
- *
- * @internal
- */
-declare abstract class ClientError extends Error {
-    /**
-     * The error class name (e.g., "ConfigError", "NetworkError").
-     */
-    readonly name: string;
-    /**
-     * Creates a new ClientError.
-     *
-     * @param message - The error message
-     */
-    constructor(message: string);
-}
-/**
- * Error thrown when client configuration is invalid.
- *
- * This error is thrown during client initialization if the provided
- * configuration is missing required fields or contains invalid values.
- *
- * @example
- * ```typescript
- * try {
- *   const client = new Client().withApiToken("short");
- * } catch (error) {
- *   if (error instanceof ConfigError) {
- *     console.log(`Config error in field '${error.field}': ${error.reason}`);
- *   }
- * }
- * ```
- */
-declare class ConfigError extends ClientError {
-    /**
-     * The configuration field that caused the error.
-     * May be undefined for general configuration errors.
-     */
-    readonly field?: string;
-    /**
-     * A description of why the configuration is invalid.
-     * May be undefined for simple errors.
-     */
-    readonly reason?: string;
-    /**
-     * Creates a new ConfigError.
-     *
-     * @param message - The error message
-     * @param options - Additional error context
-     * @param options.field - The field that caused the error
-     * @param options.reason - Why the configuration is invalid
-     */
-    constructor(message: string, options?: {
-        field?: string;
-        reason?: string;
-    });
-    /**
-     * Creates a ConfigError for a missing API token.
-     *
-     * @returns A ConfigError indicating the API token is required
-     *
-     * @internal
-     */
-    static missingApiToken(): ConfigError;
-    /**
-     * Creates a ConfigError for an invalid configuration field.
-     *
-     * @param field - The name of the invalid field
-     * @param reason - Why the field value is invalid
-     * @returns A ConfigError with field and reason context
-     *
-     * @internal
-     */
-    static invalidField(field: string, reason: string): ConfigError;
-    /**
-     * Creates a ConfigError for a missing required field.
-     *
-     * @param field - The name of the missing field
-     * @returns A ConfigError indicating the field is required
-     *
-     * @internal
-     */
-    static missingField(field: string): ConfigError;
-}
-/**
- * Error thrown when a network request fails.
- *
- * This error wraps underlying network errors (connection failures, timeouts,
- * aborted requests) and provides a consistent interface for handling them.
- *
- * @example
- * ```typescript
- * try {
- *   await client.account.get();
- * } catch (error) {
- *   if (error instanceof NetworkError) {
- *     console.log("Network error:", error.message);
- *     if (error.cause) {
- *       console.log("Caused by:", error.cause.message);
- *     }
- *   }
- * }
- * ```
- */
-declare class NetworkError extends ClientError {
-    /**
-     * The underlying error that caused this network error.
-     * May be undefined if no underlying error is available.
-     */
-    readonly cause?: Error;
-    /**
-     * Creates a new NetworkError.
-     *
-     * @param message - The error message
-     * @param cause - The underlying error that caused this failure
-     */
-    constructor(message: string, cause?: Error);
-    /**
-     * Creates a NetworkError for connection issues.
-     *
-     * @param message - Description of the connection problem
-     * @param cause - The underlying error
-     * @returns A NetworkError for connection failures
-     *
-     * @internal
-     */
-    static connection(message: string, cause?: Error): NetworkError;
-    /**
-     * Creates a NetworkError for aborted requests.
-     *
-     * @returns A NetworkError indicating the request was aborted
-     *
-     * @internal
-     */
-    static aborted(): NetworkError;
-}
 
-export { ApiError, ClientError, ConfigError, ErrorResponse, NetworkError };
+export { ErrorResponse, NvisyApiError, NvisyError };