@nvisy/sdk 0.1.0 → 0.2.0

package/package.json

@@ -1,48 +1,45 @@
 {
 	"name": "@nvisy/sdk",
-	"version": "0.1.0",
-	"description": "Official TypeScript SDK for Nvisy document redaction platform",
+	"version": "0.2.0",
+	"description": "Official TypeScript SDK for Nvisy document processing platform",
+	"type": "module",
+	"private": false,
 	"keywords": [
 		"nvisy",
 		"document",
-		"redaction",
+		"privacy",
 		"sdk",
 		"api",
 		"typescript",
 		"client"
 	],
-	"homepage": "https://github.com/nvisycom/sdk#readme",
-	"bugs": {
-		"url": "https://github.com/nvisycom/sdk/issues"
-	},
+	"author": "Nvisy <support@nvisy.com>",
+	"license": "MIT",
+	"homepage": "https://github.com/nvisycom/sdk-ts#readme",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/nvisycom/sdk.git"
+		"url": "git+https://github.com/nvisycom/sdk-ts.git"
 	},
-	"license": "MIT",
-	"author": "Nvisy <support@nvisy.com>",
-	"type": "module",
+	"bugs": {
+		"url": "https://github.com/nvisycom/sdk-ts/issues"
+	},
+	"main": "./dist/index.js",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/index.d.ts",
 			"import": "./dist/index.js"
 		},
-		"./client": {
-			"types": "./dist/client.d.ts",
-			"import": "./dist/client.js"
+		"./services": {
+			"types": "./dist/services/index.d.ts",
+			"import": "./dist/services/index.js"
 		},
-		"./builder": {
-			"types": "./dist/builder.d.ts",
-			"import": "./dist/builder.js"
-		},
-		"./errors": {
-			"types": "./dist/errors.d.ts",
-			"import": "./dist/errors.js"
+		"./datatypes": {
+			"types": "./dist/datatypes/index.d.ts",
+			"import": "./dist/datatypes/index.js"
 		}
 	},
-	"main": "./dist/index.js",
-	"module": "./dist/index.js",
-	"types": "./dist/index.d.ts",
 	"files": [
 		"dist",
 		"README.md",
@@ -67,21 +64,24 @@
 		"typecheck": "tsc --noEmit",
 		"clean": "rimraf dist",
 		"prepublishOnly": "npm run clean && npm run build && npm run test",
-		"release": "npm run prepublishOnly && npm publish"
+		"release": "npm run prepublishOnly && npm publish",
+		"generate": "openapi-typescript https://api.nvisy.com/openapi.json -o ./src/schema/api.d.ts",
+		"generate:local": "openapi-typescript http://127.0.0.1:8080/api/openapi.json -o ./src/schema/api.d.ts",
+		"generate:clean": "rimraf ./src/schema/api.d.ts"
 	},
 	"dependencies": {
 		"openapi-fetch": "^0.15.0"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "^2.2.6",
-		"@types/node": "^24.7.2",
-		"@vitest/coverage-v8": "^3.2.4",
-		"@vitest/ui": "^3.2.4",
-		"openapi-typescript": "^7.9.1",
-		"rimraf": "^6.0.1",
-		"tsup": "^8.0.1",
+		"@biomejs/biome": "^2.3.10",
+		"@types/node": "^25.0.3",
+		"@vitest/coverage-v8": "^4.0.16",
+		"@vitest/ui": "^4.0.16",
+		"openapi-typescript": "^7.10.1",
+		"rimraf": "^6.1.2",
+		"tsup": "^8.5.1",
 		"typescript": "^5.9.3",
-		"vitest": "^3.2.4"
+		"vitest": "^4.0.16"
 	},
 	"engines": {
 		"node": ">=20.0.0"

package/dist/builder-BEUIGfoZ.d.ts

@@ -1,138 +0,0 @@
-import createClient from 'openapi-fetch';
-
-/**
- * Configuration options for the Nvisy client
- */
-interface ClientConfig {
-    /**
-     * API key for authentication
-     */
-    apiKey: string;
-    /**
-     * Base URL for the Nvisy API
-     * @default "https://api.nvisy.com"
-     */
-    baseUrl?: string;
-    /**
-     * Request timeout in milliseconds
-     * @default 30000
-     */
-    timeout?: number;
-    /**
-     * Maximum number of retry attempts for failed requests
-     * @default 3
-     */
-    maxRetries?: number;
-    /**
-     * Custom headers to include with requests
-     */
-    headers?: Record<string, string>;
-}
-/**
- * Internal fully-resolved configuration
- */
-type ResolvedClientConfig = Required<ClientConfig>;
-/**
- * Load configuration from environment variables
- */
-declare function loadConfigFromEnv(): Partial<ClientConfig>;
-/**
- * Resolve configuration with defaults
- */
-declare function resolveConfig(userConfig: ClientConfig): ResolvedClientConfig;
-/**
- * Get available environment variable names
- */
-declare function getEnvironmentVariables(): Record<string, string>;
-
-/**
- * Main client class for interacting with the Nvisy document redaction API
- */
-declare class Client {
-    #private;
-    /**
-     * Create a new Nvisy client instance
-     */
-    constructor(userConfig: ClientConfig);
-    /**
-     * Create a new ClientBuilder for fluent configuration
-     */
-    static builder(): ClientBuilder;
-    /**
-     * Create a client from environment variables
-     */
-    static fromEnvironment(): Client;
-    /**
-     * Get the current configuration (readonly copy)
-     */
-    getConfig(): Readonly<ResolvedClientConfig>;
-    /**
-     * Get the underlying openapi-fetch client for advanced usage
-     */
-    getOpenApiClient(): ReturnType<typeof createClient>;
-    /**
-     * Create a new client with modified configuration
-     */
-    withConfig(configChanges: Partial<ClientConfig>): Client;
-    /**
-     * Create a new client with additional headers
-     */
-    withHeaders(additionalHeaders: Record<string, string>): Client;
-    /**
-     * Create a new client with a different timeout
-     */
-    withTimeout(timeoutMs: number): Client;
-    /**
-     * Create a new client with different retry settings
-     */
-    withMaxRetries(maxRetries: number): Client;
-}
-
-/**
- * Builder class for constructing client instances with a fluent API
- */
-declare class ClientBuilder {
-    #private;
-    /**
-     * Create a ClientBuilder instance with an API key
-     */
-    static fromApiKey(apiKey: string): ClientBuilder;
-    /**
-     * Create a ClientBuilder instance from environment variables
-     */
-    static fromEnvironment(): ClientBuilder;
-    /**
-     * Set the API key for authentication
-     */
-    withApiKey(apiKey: string): this;
-    /**
-     * Set the base URL for the API
-     */
-    withBaseUrl(baseUrl: string): this;
-    /**
-     * Set the request timeout in milliseconds
-     */
-    withTimeout(timeoutMs: number): this;
-    /**
-     * Set the maximum number of retry attempts
-     */
-    withMaxRetries(maxRetries: number): this;
-    /**
-     * Add a single custom header (merges with existing headers)
-     */
-    withHeader(name: string, value: string): this;
-    /**
-     * Set custom headers (merges with existing headers)
-     */
-    withHeaders(headers: Record<string, string>): this;
-    /**
-     * Build and return the configured client instance
-     */
-    build(): Client;
-    /**
-     * Get the current configuration (for debugging/testing)
-     */
-    getConfig(): Readonly<Partial<ClientConfig>>;
-}
-
-export { ClientBuilder as C, type ResolvedClientConfig as R, Client as a, type ClientConfig as b, getEnvironmentVariables as g, loadConfigFromEnv as l, resolveConfig as r };

package/dist/builder.d.ts

@@ -1,2 +0,0 @@
-export { C as ClientBuilder } from './builder-BEUIGfoZ.js';
-import 'openapi-fetch';

package/dist/builder.js

@@ -1,424 +0,0 @@
-import createClient from 'openapi-fetch';
-
-// src/client.ts
-
-// src/config.ts
-var ENV_VARS = {
-  API_KEY: "NVISY_API_KEY",
-  BASE_URL: "NVISY_BASE_URL",
-  TIMEOUT: "NVISY_TIMEOUT",
-  MAX_RETRIES: "NVISY_MAX_RETRIES"
-};
-var DEFAULTS = {
-  baseUrl: "https://api.nvisy.com",
-  timeout: 3e4,
-  maxRetries: 3,
-  headers: {}
-};
-function loadConfigFromEnv() {
-  const config = {};
-  const apiKey = process.env[ENV_VARS.API_KEY];
-  if (apiKey) {
-    config.apiKey = apiKey;
-  }
-  const baseUrl = process.env[ENV_VARS.BASE_URL];
-  if (baseUrl) {
-    config.baseUrl = baseUrl;
-  }
-  const timeout = process.env[ENV_VARS.TIMEOUT];
-  if (timeout) {
-    const timeoutMs = parseInt(timeout, 10);
-    if (!Number.isNaN(timeoutMs)) {
-      config.timeout = timeoutMs;
-    }
-  }
-  const maxRetries = process.env[ENV_VARS.MAX_RETRIES];
-  if (maxRetries) {
-    const retries = parseInt(maxRetries, 10);
-    if (!Number.isNaN(retries)) {
-      config.maxRetries = retries;
-    }
-  }
-  return config;
-}
-function resolveConfig(userConfig) {
-  const envConfig = loadConfigFromEnv();
-  const mergedConfig = { ...envConfig, ...userConfig };
-  return {
-    apiKey: mergedConfig.apiKey || "",
-    baseUrl: mergedConfig.baseUrl || DEFAULTS.baseUrl,
-    timeout: mergedConfig.timeout ?? DEFAULTS.timeout,
-    maxRetries: mergedConfig.maxRetries ?? DEFAULTS.maxRetries,
-    headers: { ...DEFAULTS.headers, ...mergedConfig.headers }
-  };
-}
-
-// src/errors.ts
-var ClientError = class extends Error {
-  name;
-  constructor(message) {
-    super(message);
-    this.name = this.constructor.name;
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, this.constructor);
-    }
-  }
-  /**
-   * Convert error to JSON representation
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      context: ""
-    };
-  }
-};
-var ConfigError = class _ConfigError extends ClientError {
-  /** Field that caused the error (for validation errors) */
-  field;
-  /** Reason why the configuration is invalid */
-  reason;
-  constructor(message, options) {
-    super(message);
-    this.field = options?.field;
-    this.reason = options?.reason;
-  }
-  /**
-   * Create error for missing API key
-   */
-  static missingApiKey() {
-    return new _ConfigError("API key is required", {
-      field: "apiKey",
-      reason: "API key must be provided in configuration"
-    });
-  }
-  /**
-   * Create error for invalid configuration field
-   */
-  static invalidField(field, reason) {
-    return new _ConfigError(`Invalid configuration for ${field}: ${reason}`, {
-      field,
-      reason
-    });
-  }
-  /**
-   * Create error for missing required field
-   */
-  static missingField(field) {
-    return new _ConfigError(`Missing required configuration field: ${field}`, {
-      field,
-      reason: "This field is required"
-    });
-  }
-  /**
-   * Convert error to JSON representation
-   */
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message,
-      context: this.field || this.reason ? `field: ${this.field}, reason: ${this.reason}` : ""
-    };
-  }
-};
-
-// src/client.ts
-var Client = class _Client {
-  #config;
-  #openApiClient;
-  /**
-   * Create a new Nvisy client instance
-   */
-  constructor(userConfig) {
-    try {
-      this.#validateConfig(userConfig);
-      this.#config = resolveConfig(userConfig);
-    } catch (error) {
-      if (error instanceof ConfigError) {
-        throw error;
-      }
-      throw ConfigError.invalidField(
-        "config",
-        `Configuration error: ${String(error)}`
-      );
-    }
-    this.#openApiClient = createClient({
-      baseUrl: this.#config.baseUrl,
-      headers: {
-        Authorization: `Bearer ${this.#config.apiKey}`,
-        "Content-Type": "application/json",
-        "User-Agent": this.#buildUserAgent(),
-        ...this.#config.headers
-      }
-    });
-  }
-  /**
-   * Create a new ClientBuilder for fluent configuration
-   */
-  static builder() {
-    return new ClientBuilder();
-  }
-  /**
-   * Create a client from environment variables
-   */
-  static fromEnvironment() {
-    return ClientBuilder.fromEnvironment().build();
-  }
-  /**
-   * Get the current configuration (readonly copy)
-   */
-  getConfig() {
-    return Object.freeze({ ...this.#config });
-  }
-  /**
-   * Get the underlying openapi-fetch client for advanced usage
-   */
-  getOpenApiClient() {
-    return this.#openApiClient;
-  }
-  /**
-   * Validate configuration by reusing ClientBuilder validation
-   */
-  #validateConfig(config) {
-    const builder = new ClientBuilder().withApiKey(config.apiKey);
-    if (config.baseUrl !== void 0) {
-      builder.withBaseUrl(config.baseUrl);
-    }
-    if (config.timeout !== void 0) {
-      builder.withTimeout(config.timeout);
-    }
-    if (config.maxRetries !== void 0) {
-      builder.withMaxRetries(config.maxRetries);
-    }
-    if (config.headers !== void 0) {
-      builder.withHeaders(config.headers);
-    }
-  }
-  /**
-   * Build user agent string
-   */
-  #buildUserAgent() {
-    const sdkVersion = "1.0.0";
-    const nodeVersion = process.version;
-    const platform = process.platform;
-    return `@nvisy/sdk/${sdkVersion} (${platform}; Node.js ${nodeVersion})`;
-  }
-  /**
-   * Create a new client with modified configuration
-   */
-  withConfig(configChanges) {
-    const newConfig = {
-      apiKey: this.#config.apiKey,
-      baseUrl: this.#config.baseUrl,
-      timeout: this.#config.timeout,
-      maxRetries: this.#config.maxRetries,
-      headers: this.#config.headers,
-      ...configChanges
-    };
-    return new _Client(newConfig);
-  }
-  /**
-   * Create a new client with additional headers
-   */
-  withHeaders(additionalHeaders) {
-    return this.withConfig({
-      headers: { ...this.#config.headers, ...additionalHeaders }
-    });
-  }
-  /**
-   * Create a new client with a different timeout
-   */
-  withTimeout(timeoutMs) {
-    return this.withConfig({ timeout: timeoutMs });
-  }
-  /**
-   * Create a new client with different retry settings
-   */
-  withMaxRetries(maxRetries) {
-    return this.withConfig({ maxRetries });
-  }
-};
-
-// src/builder.ts
-var RESERVED_HEADERS = ["authorization", "content-type", "user-agent"];
-var ClientBuilder = class _ClientBuilder {
-  #config = {};
-  /**
-   * Create a ClientBuilder instance with an API key
-   */
-  static fromApiKey(apiKey) {
-    return new _ClientBuilder().withApiKey(apiKey);
-  }
-  /**
-   * Create a ClientBuilder instance from environment variables
-   */
-  static fromEnvironment() {
-    const envConfig = loadConfigFromEnv();
-    if (!envConfig.apiKey) {
-      throw ConfigError.missingApiKey();
-    }
-    const builder = new _ClientBuilder().withApiKey(envConfig.apiKey);
-    if (envConfig.baseUrl) {
-      builder.withBaseUrl(envConfig.baseUrl);
-    }
-    if (envConfig.timeout) {
-      builder.withTimeout(envConfig.timeout);
-    }
-    if (envConfig.maxRetries !== void 0) {
-      builder.withMaxRetries(envConfig.maxRetries);
-    }
-    if (envConfig.headers) {
-      builder.withHeaders(envConfig.headers);
-    }
-    return builder;
-  }
-  /**
-   * Set the API key for authentication
-   */
-  withApiKey(apiKey) {
-    this.#validateString("apiKey", apiKey);
-    const trimmedKey = apiKey.trim();
-    if (trimmedKey.length < 10) {
-      throw ConfigError.invalidField(
-        "apiKey",
-        "must be at least 10 characters"
-      );
-    }
-    if (!/^[a-zA-Z0-9_-]+$/.test(trimmedKey)) {
-      throw ConfigError.invalidField("apiKey", "contains invalid characters");
-    }
-    this.#config.apiKey = trimmedKey;
-    return this;
-  }
-  /**
-   * Set the base URL for the API
-   */
-  withBaseUrl(baseUrl) {
-    this.#validateString("baseUrl", baseUrl);
-    this.#validateUrl(baseUrl);
-    this.#config.baseUrl = baseUrl;
-    return this;
-  }
-  /**
-   * Set the request timeout in milliseconds
-   */
-  withTimeout(timeoutMs) {
-    this.#validateInteger("timeout", timeoutMs, 1e3, 3e5);
-    this.#config.timeout = timeoutMs;
-    return this;
-  }
-  /**
-   * Set the maximum number of retry attempts
-   */
-  withMaxRetries(maxRetries) {
-    this.#validateInteger("maxRetries", maxRetries, 0, 5);
-    this.#config.maxRetries = maxRetries;
-    return this;
-  }
-  /**
-   * Add a single custom header (merges with existing headers)
-   */
-  withHeader(name, value) {
-    this.#validateSingleHeader(name, value);
-    if (!this.#config.headers) {
-      this.#config.headers = {};
-    }
-    this.#config.headers[name] = value;
-    return this;
-  }
-  /**
-   * Set custom headers (merges with existing headers)
-   */
-  withHeaders(headers) {
-    if (!headers || typeof headers !== "object" || Array.isArray(headers)) {
-      throw ConfigError.invalidField("headers", "must be a valid object");
-    }
-    for (const [name, value] of Object.entries(headers)) {
-      this.withHeader(name, value);
-    }
-    return this;
-  }
-  /**
-   * Build and return the configured client instance
-   */
-  build() {
-    if (!this.#config.apiKey) {
-      throw ConfigError.missingApiKey();
-    }
-    return new Client(this.#config);
-  }
-  /**
-   * Get the current configuration (for debugging/testing)
-   */
-  getConfig() {
-    return { ...this.#config };
-  }
-  /**
-   * Validate string field
-   */
-  #validateString(fieldName, value) {
-    if (!value || typeof value !== "string" || value.trim().length === 0) {
-      throw ConfigError.invalidField(fieldName, "must be a non-empty string");
-    }
-  }
-  /**
-   * Validate integer field with range
-   */
-  #validateInteger(fieldName, value, min, max) {
-    if (!Number.isInteger(value) || value < min) {
-      throw ConfigError.invalidField(fieldName, `must be an integer >= ${min}`);
-    }
-    if (value > max) {
-      throw ConfigError.invalidField(fieldName, `must not exceed ${max}`);
-    }
-  }
-  /**
-   * Validate URL format
-   */
-  #validateUrl(baseUrl) {
-    let url;
-    try {
-      url = new URL(baseUrl);
-    } catch {
-      throw ConfigError.invalidField("baseUrl", "must be a valid URL");
-    }
-    const allowedProtocols = ["https:", "http:"];
-    if (!allowedProtocols.includes(url.protocol)) {
-      throw ConfigError.invalidField(
-        "baseUrl",
-        `protocol must be one of: ${allowedProtocols.join(", ")}`
-      );
-    }
-  }
-  /**
-   * Validate single header name and value
-   */
-  #validateSingleHeader(name, value) {
-    if (!name || typeof name !== "string" || name.trim().length === 0) {
-      throw ConfigError.invalidField(
-        "header name",
-        "must be a non-empty string"
-      );
-    }
-    if (typeof value !== "string") {
-      throw ConfigError.invalidField("header value", "must be a string");
-    }
-    if (!/^[a-zA-Z0-9!#$%&'*+\-.^_`|~]+$/.test(name)) {
-      throw ConfigError.invalidField(
-        "header name",
-        `invalid header name: ${name}`
-      );
-    }
-    if (RESERVED_HEADERS.includes(name.toLowerCase())) {
-      throw ConfigError.invalidField(
-        "header name",
-        `header "${name}" is reserved and cannot be overridden`
-      );
-    }
-  }
-};
-
-export { ClientBuilder };
-//# sourceMappingURL=builder.js.map
-//# sourceMappingURL=builder.js.map