@nvisy/sdk 0.1.0 → 0.2.0

package/dist/datatypes/index.d.ts

@@ -0,0 +1,8 @@
+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';
+
+type Schemas = components["schemas"];
+type ErrorResponse = Schemas["ErrorResponse"];
+type ValidationErrorDetail = Schemas["ValidationErrorDetail"];
+
+export type { ErrorResponse, ValidationErrorDetail };

package/dist/datatypes/index.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/datatypes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/index.d.ts

@@ -1,3 +1,255 @@
-export { a as Client, C as ClientBuilder, b as ClientConfig, R as ResolvedClientConfig, g as getEnvironmentVariables, l as loadConfigFromEnv, r as resolveConfig } from './builder-BEUIGfoZ.js';
-export { ApiError, ClientError, ConfigError, ErrorResponse, NetworkError } from './errors.js';
+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';
+import { ErrorResponse } from './datatypes/index.js';
+export { ValidationErrorDetail } from './datatypes/index.js';
 import 'openapi-fetch';
+
+/**
+ * @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.
+ *
+ * @module errors
+ */
+
+/**
+ * Error thrown when the Nvisy API returns an error response.
+ *
+ * This error class wraps the API's {@link ErrorResponse} format and adds
+ * the HTTP status code. It provides helper methods to categorize errors
+ * and determine if they are retryable.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   await client.account.get();
+ * } catch (error) {
+ *   if (error instanceof ApiError) {
+ *     console.log(`API Error: ${error.message}`);
+ *     console.log(`Status: ${error.statusCode}`);
+ *     if (error.isRetryable()) {
+ *       // Implement retry logic
+ *     }
+ *   }
+ * }
+ * ```
+ */
+declare class ApiError extends Error implements ErrorResponse {
+    /**
+     * The error type identifier (e.g., "ValidationError", "NotFoundError").
+     */
+    readonly name: string;
+    /**
+     * Human-readable error message safe for display to end users.
+     */
+    readonly message: string;
+    /**
+     * The resource type that the error relates to (e.g., "account", "project").
+     * May be null if the error is not resource-specific.
+     */
+    readonly resource?: string | null;
+    /**
+     * A helpful suggestion for resolving the error.
+     * May be null if no suggestion is available.
+     */
+    readonly suggestion?: string | null;
+    /**
+     * Field-specific validation errors.
+     * Present when the error is due to invalid input data.
+     */
+    readonly validationErrors?: ErrorResponse["validationErrors"];
+    /**
+     * HTTP status code of the response (e.g., 400, 404, 500).
+     */
+    readonly statusCode: number;
+    /**
+     * Creates a new ApiError from an API error response.
+     *
+     * @param response - The error response from the API
+     * @param statusCode - The HTTP status code of the response
+     */
+    constructor(response: ErrorResponse, statusCode: number);
+    /**
+     * Checks if this is a client error (4xx status code).
+     *
+     * Client errors indicate problems with the request itself, such as
+     * invalid input, missing authentication, or accessing non-existent resources.
+     *
+     * @returns True if the status code is in the 4xx range
+     */
+    isClientError(): boolean;
+    /**
+     * Checks if this is a server error (5xx status code).
+     *
+     * Server errors indicate problems on the API side. These are typically
+     * transient and may succeed if retried.
+     *
+     * @returns True if the status code is in the 5xx range
+     */
+    isServerError(): boolean;
+    /**
+     * Determines if this error is safe to retry.
+     *
+     * An error is considered retryable if it's a server error (5xx),
+     * a request timeout (408), or rate limiting (429).
+     *
+     * @returns True if the request may succeed on retry
+     */
+    isRetryable(): boolean;
+    /**
+     * Converts the error to a plain {@link ErrorResponse} object.
+     *
+     * Useful for serialization or logging.
+     *
+     * @returns A plain object representation of the error
+     */
+    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 };