@nvisy/sdk 0.1.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

@@ -0,0 +1,9 @@
+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"];
+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,141 @@
-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 { 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';
 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 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.
+ *
+ * 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.getAccount();
+ * } catch (error) {
+ *   if (error instanceof NvisyApiError) {
+ *     console.log(`API Error: ${error.message}`);
+ *     console.log(`Status: ${error.statusCode}`);
+ *     if (error.isRetryable()) {
+ *       // Implement retry logic
+ *     }
+ *   }
+ * }
+ * ```
+ */
+declare class NvisyApiError extends NvisyError 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 validation?: ErrorResponse["validation"];
+    /**
+     * HTTP status code of the response (e.g., 400, 404, 500).
+     */
+    readonly statusCode: number;
+    /**
+     * 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
+     */
+    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;
+}
+
+export { ErrorResponse, NvisyApiError, NvisyError };