@ketrics/sdk-backend 0.2.0

package/dist/index.d.ts

@@ -0,0 +1,377 @@
+/**
+ * Ketrics SDK - Type Definitions
+ *
+ * TypeScript type definitions for building tenant applications
+ * on the Ketrics platform.
+ *
+ * @packageDocumentation
+ *
+ * @example
+ * ```typescript
+ * // Import types only if needed for type annotations
+ * import type { FileContent, IVolume, IDatabaseConnection } from '@ketrics/sdk';
+ *
+ * export async function handler() {
+ *   // Access the global ketrics object (auto-typed)
+ *   console.log(ketrics.tenant.name);
+ *   console.log(ketrics.user.email);
+ *
+ *   // Use ketrics.Volume.connect() for S3 storage
+ *   try {
+ *     const volume = await ketrics.Volume.connect('uploads');
+ *     const file = await volume.get('documents/report.pdf');
+ *     return { contentType: file.contentType, size: file.contentLength };
+ *   } catch (error) {
+ *     if (error instanceof ketrics.VolumeNotFoundError) {
+ *       return { error: `Volume not found: ${error.volumeCode}` };
+ *     }
+ *     throw error;
+ *   }
+ *
+ *   // Use ketrics.DatabaseConnection.connect() for databases
+ *   try {
+ *     const db = await ketrics.DatabaseConnection.connect('main-db');
+ *     const result = await db.query('SELECT * FROM users');
+ *     await db.close();
+ *     return { users: result.rows };
+ *   } catch (error) {
+ *     if (error instanceof ketrics.DatabaseNotFoundError) {
+ *       return { error: `Database not found: ${error.databaseCode}` };
+ *     }
+ *     throw error;
+ *   }
+ *
+ *   // Use ketrics.Secret.get() for secrets
+ *   try {
+ *     const apiKey = await ketrics.Secret.get('stripe-api-key');
+ *     // Use the API key
+ *   } catch (error) {
+ *     if (error instanceof ketrics.SecretNotFoundError) {
+ *       return { error: `Secret not found: ${error.secretCode}` };
+ *     }
+ *     throw error;
+ *   }
+ * }
+ * ```
+ */
+export { TenantContext, ApplicationContext, UserContext, EnvironmentContext, } from './context';
+export { ConsoleLogger } from './console';
+export { HttpRequestConfig, HttpResponse, HttpClient } from './http';
+export { DatabaseQueryResult, DatabaseExecuteResult, IDatabaseConnection, DatabaseManager, } from './databases';
+export { DatabaseError, DatabaseNotFoundError, DatabaseAccessDeniedError, DatabaseConnectionError, DatabaseQueryError, DatabaseTransactionError, isDatabaseError, isDatabaseErrorType, } from './database-errors';
+export { ISecret } from './secrets';
+export { SecretError, SecretNotFoundError, SecretAccessDeniedError, SecretDecryptionError, isSecretError, isSecretErrorType, } from './secret-errors';
+export { PutContent, FileContent, FileMetadata, FileInfo, PutOptions, PutResult, DeleteResult, DeleteError, DeleteByPrefixResult, ListOptions, ListResult, CopyOptions, CopyResult, MoveOptions, MoveResult, DownloadUrlOptions, UploadUrlOptions, PresignedUrl, IVolume, } from './volumes';
+export { VolumePermissionValue, VolumeError, VolumeNotFoundError, VolumeAccessDeniedError, VolumePermissionDeniedError, FileNotFoundError, FileAlreadyExistsError, InvalidPathError, FileSizeLimitError, ContentTypeNotAllowedError, isVolumeError, isVolumeErrorType, } from './errors';
+import type { TenantContext, ApplicationContext, UserContext, EnvironmentContext } from './context';
+import type { ConsoleLogger } from './console';
+import type { HttpClient } from './http';
+import type { IDatabaseConnection } from './databases';
+import type { IVolume } from './volumes';
+import { VolumeError as VolumeErrorClass, VolumeNotFoundError as VolumeNotFoundErrorClass, VolumeAccessDeniedError as VolumeAccessDeniedErrorClass, VolumePermissionDeniedError as VolumePermissionDeniedErrorClass, FileNotFoundError as FileNotFoundErrorClass, FileAlreadyExistsError as FileAlreadyExistsErrorClass, InvalidPathError as InvalidPathErrorClass, FileSizeLimitError as FileSizeLimitErrorClass, ContentTypeNotAllowedError as ContentTypeNotAllowedErrorClass } from './errors';
+import { DatabaseError as DatabaseErrorClass, DatabaseNotFoundError as DatabaseNotFoundErrorClass, DatabaseAccessDeniedError as DatabaseAccessDeniedErrorClass, DatabaseConnectionError as DatabaseConnectionErrorClass, DatabaseQueryError as DatabaseQueryErrorClass, DatabaseTransactionError as DatabaseTransactionErrorClass } from './database-errors';
+import { SecretError as SecretErrorClass, SecretNotFoundError as SecretNotFoundErrorClass, SecretAccessDeniedError as SecretAccessDeniedErrorClass, SecretDecryptionError as SecretDecryptionErrorClass } from './secret-errors';
+/**
+ * Ketrics Platform SDK Interface
+ *
+ * The complete SDK interface available as the global `ketrics` object
+ * in tenant application code.
+ *
+ * @example
+ * ```typescript
+ * // Access tenant context
+ * console.log(ketrics.tenant.name);
+ * console.log(ketrics.application.code);
+ * console.log(ketrics.user.email);
+ * console.log(ketrics.env.region);
+ *
+ * // Use console logging (forwarded to CloudWatch)
+ * ketrics.console.log('Processing request...');
+ * ketrics.console.error('Something went wrong');
+ *
+ * // Make HTTP requests
+ * const response = await ketrics.http.get('https://api.example.com/data');
+ * console.log(response.data);
+ *
+ * // Access databases (new static factory pattern)
+ * const db = await ketrics.DatabaseConnection.connect('main-db');
+ * const result = await db.query('SELECT * FROM users');
+ * await db.close();
+ *
+ * // Access secrets
+ * const apiKey = await ketrics.Secret.get('stripe-api-key');
+ *
+ * // Access volumes
+ * const volume = await ketrics.Volume.connect('uploads');
+ * const file = await volume.get('document.pdf');
+ * ```
+ */
+export interface KetricsSdkV1 {
+    /** Current tenant information */
+    tenant: TenantContext;
+    /** Current application information */
+    application: ApplicationContext;
+    /** Current user information */
+    user: UserContext;
+    /** Runtime environment information */
+    env: EnvironmentContext;
+    /** Console logging (forwarded to CloudWatch) */
+    console: ConsoleLogger;
+    /** HTTP client for external API requests */
+    http: HttpClient;
+}
+/**
+ * Volume - S3-backed storage for tenant applications
+ *
+ * Access via `ketrics.Volume.connect()` to obtain an instance.
+ *
+ * @example
+ * ```typescript
+ * export async function handler() {
+ *   try {
+ *     // Connect to a volume via ketrics object
+ *     const volume = await ketrics.Volume.connect('uploads');
+ *
+ *     // Read a file
+ *     const file = await volume.get('documents/report.pdf');
+ *     console.log(file.contentType, file.contentLength);
+ *
+ *     // Write a file
+ *     const result = await volume.put('output/data.json', JSON.stringify(data));
+ *     console.log('Uploaded:', result.key, result.etag);
+ *
+ *     // List files
+ *     const list = await volume.list({ prefix: 'documents/' });
+ *     for (const file of list.files) {
+ *       console.log(file.key, file.size);
+ *     }
+ *
+ *   } catch (error) {
+ *     // Error classes are on the ketrics object
+ *     if (error instanceof ketrics.VolumeNotFoundError) {
+ *       console.log('Volume not found');
+ *     } else if (error instanceof ketrics.FileNotFoundError) {
+ *       console.log('File not found:', error.key);
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare class Volume {
+    private constructor();
+    /** Volume code (read-only) */
+    readonly code: string;
+    /** Granted permissions (read-only) */
+    readonly permissions: ReadonlySet<string>;
+    /**
+     * Connect to a volume by code
+     *
+     * @param volumeCode - Volume code (e.g., "uploads", "documents")
+     * @returns Connected Volume instance
+     * @throws VolumeNotFoundError if volume doesn't exist
+     * @throws VolumeAccessDeniedError if application has no access grant
+     */
+    static connect(volumeCode: string): Promise<IVolume>;
+}
+/**
+ * DatabaseConnection - External database access for tenant applications
+ *
+ * Access via `ketrics.DatabaseConnection.connect()` to obtain an instance.
+ *
+ * @example
+ * ```typescript
+ * export async function handler() {
+ *   try {
+ *     // Connect to a database
+ *     const db = await ketrics.DatabaseConnection.connect('main-db');
+ *
+ *     // Query data
+ *     const result = await db.query('SELECT * FROM users WHERE id = ?', [1]);
+ *     console.log(result.rows);
+ *
+ *     // Execute statement
+ *     await db.execute('INSERT INTO users (name, email) VALUES (?, ?)', ['John', 'john@example.com']);
+ *
+ *     // Transaction
+ *     await db.transaction(async (tx) => {
+ *       await tx.execute('UPDATE accounts SET balance = balance - ? WHERE id = ?', [100, 1]);
+ *       await tx.execute('UPDATE accounts SET balance = balance + ? WHERE id = ?', [100, 2]);
+ *     });
+ *
+ *     // Close connection
+ *     await db.close();
+ *
+ *   } catch (error) {
+ *     if (error instanceof ketrics.DatabaseNotFoundError) {
+ *       console.log('Database not found');
+ *     } else if (error instanceof ketrics.DatabaseAccessDeniedError) {
+ *       console.log('No access to database');
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare class DatabaseConnection {
+    private constructor();
+    /** Database code (read-only) */
+    readonly code: string;
+    /** Granted permissions (read-only) */
+    readonly permissions: ReadonlySet<string>;
+    /**
+     * Connect to a database by code
+     *
+     * @param databaseCode - Database code (e.g., "main-db", "analytics-db")
+     * @returns Connected DatabaseConnection instance
+     * @throws DatabaseNotFoundError if database doesn't exist
+     * @throws DatabaseAccessDeniedError if application has no access grant
+     * @throws DatabaseConnectionError if connection cannot be established
+     */
+    static connect(databaseCode: string): Promise<IDatabaseConnection>;
+}
+/**
+ * Secret - Encrypted secret values for tenant applications
+ *
+ * Access via `ketrics.Secret.get()` to retrieve secret values.
+ *
+ * @example
+ * ```typescript
+ * export async function handler() {
+ *   try {
+ *     // Get a secret value
+ *     const apiKey = await ketrics.Secret.get('stripe-api-key');
+ *     console.log('API Key retrieved');
+ *
+ *     // Check if a secret exists
+ *     if (await ketrics.Secret.exists('optional-api-key')) {
+ *       const key = await ketrics.Secret.get('optional-api-key');
+ *       // Use the key
+ *     }
+ *
+ *   } catch (error) {
+ *     if (error instanceof ketrics.SecretNotFoundError) {
+ *       console.log('Secret not found');
+ *     } else if (error instanceof ketrics.SecretAccessDeniedError) {
+ *       console.log('No access to secret');
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare class Secret {
+    private constructor();
+    /**
+     * Get a secret value by code
+     *
+     * @param secretCode - Secret code (e.g., "api-key", "db-password")
+     * @returns The decrypted secret value
+     * @throws SecretNotFoundError if secret doesn't exist
+     * @throws SecretAccessDeniedError if application has no access grant
+     * @throws SecretDecryptionError if decryption fails
+     */
+    static get(secretCode: string): Promise<string>;
+    /**
+     * Check if a secret exists and is accessible
+     *
+     * @param secretCode - Secret code to check
+     * @returns True if secret exists and is accessible
+     */
+    static exists(secretCode: string): Promise<boolean>;
+}
+/**
+ * Global declaration for the Ketrics VM sandbox.
+ *
+ * The `ketrics` global object provides:
+ * - Context: tenant, application, user, env
+ * - Utilities: console, http
+ * - Volume: Static class for S3 storage
+ * - DatabaseConnection: Static class for database access
+ * - Secret: Static class for secret retrieval
+ * - Error classes: For instanceof checks
+ */
+declare global {
+    /** Ketrics SDK global object - available in all tenant application code */
+    const ketrics: KetricsSdkV1 & {
+        /**
+         * Volume class for S3-backed storage
+         *
+         * Use `ketrics.Volume.connect()` to get a connected volume instance.
+         *
+         * @example
+         * ```typescript
+         * const volume = await ketrics.Volume.connect('uploads');
+         * const file = await volume.get('document.pdf');
+         * ```
+         */
+        Volume: {
+            connect(volumeCode: string): Promise<IVolume>;
+        };
+        /**
+         * DatabaseConnection class for external database access
+         *
+         * Use `ketrics.DatabaseConnection.connect()` to get a connected database instance.
+         *
+         * @example
+         * ```typescript
+         * const db = await ketrics.DatabaseConnection.connect('main-db');
+         * const result = await db.query('SELECT * FROM users');
+         * await db.close();
+         * ```
+         */
+        DatabaseConnection: {
+            connect(databaseCode: string): Promise<IDatabaseConnection>;
+        };
+        /**
+         * Secret class for encrypted secret retrieval
+         *
+         * Use `ketrics.Secret.get()` to retrieve a secret value.
+         *
+         * @example
+         * ```typescript
+         * const apiKey = await ketrics.Secret.get('stripe-api-key');
+         * ```
+         */
+        Secret: {
+            get(secretCode: string): Promise<string>;
+            exists(secretCode: string): Promise<boolean>;
+        };
+        /** Base class for all volume errors */
+        VolumeError: typeof VolumeErrorClass;
+        /** Thrown when a volume does not exist */
+        VolumeNotFoundError: typeof VolumeNotFoundErrorClass;
+        /** Thrown when application has no access grant to volume */
+        VolumeAccessDeniedError: typeof VolumeAccessDeniedErrorClass;
+        /** Thrown when operation requires a permission not granted */
+        VolumePermissionDeniedError: typeof VolumePermissionDeniedErrorClass;
+        /** Thrown when a file does not exist */
+        FileNotFoundError: typeof FileNotFoundErrorClass;
+        /** Thrown when file already exists (with ifNotExists option) */
+        FileAlreadyExistsError: typeof FileAlreadyExistsErrorClass;
+        /** Thrown when file path is invalid */
+        InvalidPathError: typeof InvalidPathErrorClass;
+        /** Thrown when file exceeds size limit */
+        FileSizeLimitError: typeof FileSizeLimitErrorClass;
+        /** Thrown when content type is not allowed */
+        ContentTypeNotAllowedError: typeof ContentTypeNotAllowedErrorClass;
+        /** Base class for all database errors */
+        DatabaseError: typeof DatabaseErrorClass;
+        /** Thrown when a database does not exist */
+        DatabaseNotFoundError: typeof DatabaseNotFoundErrorClass;
+        /** Thrown when application has no access grant to database */
+        DatabaseAccessDeniedError: typeof DatabaseAccessDeniedErrorClass;
+        /** Thrown when database connection cannot be established */
+        DatabaseConnectionError: typeof DatabaseConnectionErrorClass;
+        /** Thrown when a database query fails */
+        DatabaseQueryError: typeof DatabaseQueryErrorClass;
+        /** Thrown when a database transaction fails */
+        DatabaseTransactionError: typeof DatabaseTransactionErrorClass;
+        /** Base class for all secret errors */
+        SecretError: typeof SecretErrorClass;
+        /** Thrown when a secret does not exist */
+        SecretNotFoundError: typeof SecretNotFoundErrorClass;
+        /** Thrown when application has no access grant to secret */
+        SecretAccessDeniedError: typeof SecretAccessDeniedErrorClass;
+        /** Thrown when secret decryption fails */
+        SecretDecryptionError: typeof SecretDecryptionErrorClass;
+    };
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AAMH,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,kBAAkB,GACnB,MAAM,WAAW,CAAC;AAMnB,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAM1C,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAMrE,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,GAChB,MAAM,aAAa,CAAC;AAMrB,OAAO,EACL,aAAa,EACb,qBAAqB,EACrB,yBAAyB,EACzB,uBAAuB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,eAAe,EACf,mBAAmB,GACpB,MAAM,mBAAmB,CAAC;AAM3B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMpC,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,aAAa,EACb,iBAAiB,GAClB,MAAM,iBAAiB,CAAC;AAMzB,OAAO,EAEL,UAAU,EAEV,WAAW,EACX,YAAY,EACZ,QAAQ,EAER,UAAU,EACV,SAAS,EAET,YAAY,EACZ,WAAW,EACX,oBAAoB,EAEpB,WAAW,EACX,UAAU,EAEV,WAAW,EACX,UAAU,EACV,WAAW,EACX,UAAU,EAEV,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,EAEZ,OAAO,GACR,MAAM,WAAW,CAAC;AAMnB,OAAO,EAEL,qBAAqB,EAErB,WAAW,EACX,mBAAmB,EACnB,uBAAuB,EACvB,2BAA2B,EAC3B,iBAAiB,EACjB,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,0BAA0B,EAE1B,aAAa,EACb,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAMlB,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,kBAAkB,EACnB,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EACL,WAAW,IAAI,gBAAgB,EAC/B,mBAAmB,IAAI,wBAAwB,EAC/C,uBAAuB,IAAI,4BAA4B,EACvD,2BAA2B,IAAI,gCAAgC,EAC/D,iBAAiB,IAAI,sBAAsB,EAC3C,sBAAsB,IAAI,2BAA2B,EACrD,gBAAgB,IAAI,qBAAqB,EACzC,kBAAkB,IAAI,uBAAuB,EAC7C,0BAA0B,IAAI,+BAA+B,EAC9D,MAAM,UAAU,CAAC;AAGlB,OAAO,EACL,aAAa,IAAI,kBAAkB,EACnC,qBAAqB,IAAI,0BAA0B,EACnD,yBAAyB,IAAI,8BAA8B,EAC3D,uBAAuB,IAAI,4BAA4B,EACvD,kBAAkB,IAAI,uBAAuB,EAC7C,wBAAwB,IAAI,6BAA6B,EAC1D,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,WAAW,IAAI,gBAAgB,EAC/B,mBAAmB,IAAI,wBAAwB,EAC/C,uBAAuB,IAAI,4BAA4B,EACvD,qBAAqB,IAAI,0BAA0B,EACpD,MAAM,iBAAiB,CAAC;AAMzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,WAAW,YAAY;IAE3B,iCAAiC;IACjC,MAAM,EAAE,aAAa,CAAC;IACtB,sCAAsC;IACtC,WAAW,EAAE,kBAAkB,CAAC;IAChC,+BAA+B;IAC/B,IAAI,EAAE,WAAW,CAAC;IAClB,sCAAsC;IACtC,GAAG,EAAE,kBAAkB,CAAC;IAGxB,gDAAgD;IAChD,OAAO,EAAE,aAAa,CAAC;IACvB,4CAA4C;IAC5C,IAAI,EAAE,UAAU,CAAC;CAClB;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO;IAEP,8BAA8B;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,sCAAsC;IACtC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAE1C;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CACrD;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAkB;IACrC,OAAO;IAEP,gCAAgC;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,sCAAsC;IACtC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAE1C;;;;;;;;OAQG;IACH,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;CACnE;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACzB,OAAO;IAEP;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAE/C;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CACpD;AAMD;;;;;;;;;;GAUG;AACH,OAAO,CAAC,MAAM,CAAC;IACb,2EAA2E;IAC3E,MAAM,OAAO,EAAE,YAAY,GAAG;QAK5B;;;;;;;;;;WAUG;QACH,MAAM,EAAE;YACN,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;SAC/C,CAAC;QAEF;;;;;;;;;;;WAWG;QACH,kBAAkB,EAAE;YAClB,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;SAC7D,CAAC;QAEF;;;;;;;;;WASG;QACH,MAAM,EAAE;YACN,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YACzC,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;SAC9C,CAAC;QAMF,uCAAuC;QACvC,WAAW,EAAE,OAAO,gBAAgB,CAAC;QACrC,0CAA0C;QAC1C,mBAAmB,EAAE,OAAO,wBAAwB,CAAC;QACrD,4DAA4D;QAC5D,uBAAuB,EAAE,OAAO,4BAA4B,CAAC;QAC7D,8DAA8D;QAC9D,2BAA2B,EAAE,OAAO,gCAAgC,CAAC;QACrE,wCAAwC;QACxC,iBAAiB,EAAE,OAAO,sBAAsB,CAAC;QACjD,gEAAgE;QAChE,sBAAsB,EAAE,OAAO,2BAA2B,CAAC;QAC3D,uCAAuC;QACvC,gBAAgB,EAAE,OAAO,qBAAqB,CAAC;QAC/C,0CAA0C;QAC1C,kBAAkB,EAAE,OAAO,uBAAuB,CAAC;QACnD,8CAA8C;QAC9C,0BAA0B,EAAE,OAAO,+BAA+B,CAAC;QAMnE,yCAAyC;QACzC,aAAa,EAAE,OAAO,kBAAkB,CAAC;QACzC,4CAA4C;QAC5C,qBAAqB,EAAE,OAAO,0BAA0B,CAAC;QACzD,8DAA8D;QAC9D,yBAAyB,EAAE,OAAO,8BAA8B,CAAC;QACjE,4DAA4D;QAC5D,uBAAuB,EAAE,OAAO,4BAA4B,CAAC;QAC7D,yCAAyC;QACzC,kBAAkB,EAAE,OAAO,uBAAuB,CAAC;QACnD,+CAA+C;QAC/C,wBAAwB,EAAE,OAAO,6BAA6B,CAAC;QAM/D,uCAAuC;QACvC,WAAW,EAAE,OAAO,gBAAgB,CAAC;QACrC,0CAA0C;QAC1C,mBAAmB,EAAE,OAAO,wBAAwB,CAAC;QACrD,4DAA4D;QAC5D,uBAAuB,EAAE,OAAO,4BAA4B,CAAC;QAC7D,0CAA0C;QAC1C,qBAAqB,EAAE,OAAO,0BAA0B,CAAC;KAC1D,CAAC;CACH"}

package/dist/index.js

@@ -0,0 +1,99 @@
+"use strict";
+/**
+ * Ketrics SDK - Type Definitions
+ *
+ * TypeScript type definitions for building tenant applications
+ * on the Ketrics platform.
+ *
+ * @packageDocumentation
+ *
+ * @example
+ * ```typescript
+ * // Import types only if needed for type annotations
+ * import type { FileContent, IVolume, IDatabaseConnection } from '@ketrics/sdk';
+ *
+ * export async function handler() {
+ *   // Access the global ketrics object (auto-typed)
+ *   console.log(ketrics.tenant.name);
+ *   console.log(ketrics.user.email);
+ *
+ *   // Use ketrics.Volume.connect() for S3 storage
+ *   try {
+ *     const volume = await ketrics.Volume.connect('uploads');
+ *     const file = await volume.get('documents/report.pdf');
+ *     return { contentType: file.contentType, size: file.contentLength };
+ *   } catch (error) {
+ *     if (error instanceof ketrics.VolumeNotFoundError) {
+ *       return { error: `Volume not found: ${error.volumeCode}` };
+ *     }
+ *     throw error;
+ *   }
+ *
+ *   // Use ketrics.DatabaseConnection.connect() for databases
+ *   try {
+ *     const db = await ketrics.DatabaseConnection.connect('main-db');
+ *     const result = await db.query('SELECT * FROM users');
+ *     await db.close();
+ *     return { users: result.rows };
+ *   } catch (error) {
+ *     if (error instanceof ketrics.DatabaseNotFoundError) {
+ *       return { error: `Database not found: ${error.databaseCode}` };
+ *     }
+ *     throw error;
+ *   }
+ *
+ *   // Use ketrics.Secret.get() for secrets
+ *   try {
+ *     const apiKey = await ketrics.Secret.get('stripe-api-key');
+ *     // Use the API key
+ *   } catch (error) {
+ *     if (error instanceof ketrics.SecretNotFoundError) {
+ *       return { error: `Secret not found: ${error.secretCode}` };
+ *     }
+ *     throw error;
+ *   }
+ * }
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isVolumeErrorType = exports.isVolumeError = exports.ContentTypeNotAllowedError = exports.FileSizeLimitError = exports.InvalidPathError = exports.FileAlreadyExistsError = exports.FileNotFoundError = exports.VolumePermissionDeniedError = exports.VolumeAccessDeniedError = exports.VolumeNotFoundError = exports.VolumeError = exports.isSecretErrorType = exports.isSecretError = exports.SecretDecryptionError = exports.SecretAccessDeniedError = exports.SecretNotFoundError = exports.SecretError = exports.isDatabaseErrorType = exports.isDatabaseError = exports.DatabaseTransactionError = exports.DatabaseQueryError = exports.DatabaseConnectionError = exports.DatabaseAccessDeniedError = exports.DatabaseNotFoundError = exports.DatabaseError = void 0;
+// ============================================================================
+// Database Error Exports
+// ============================================================================
+var database_errors_1 = require("./database-errors");
+Object.defineProperty(exports, "DatabaseError", { enumerable: true, get: function () { return database_errors_1.DatabaseError; } });
+Object.defineProperty(exports, "DatabaseNotFoundError", { enumerable: true, get: function () { return database_errors_1.DatabaseNotFoundError; } });
+Object.defineProperty(exports, "DatabaseAccessDeniedError", { enumerable: true, get: function () { return database_errors_1.DatabaseAccessDeniedError; } });
+Object.defineProperty(exports, "DatabaseConnectionError", { enumerable: true, get: function () { return database_errors_1.DatabaseConnectionError; } });
+Object.defineProperty(exports, "DatabaseQueryError", { enumerable: true, get: function () { return database_errors_1.DatabaseQueryError; } });
+Object.defineProperty(exports, "DatabaseTransactionError", { enumerable: true, get: function () { return database_errors_1.DatabaseTransactionError; } });
+Object.defineProperty(exports, "isDatabaseError", { enumerable: true, get: function () { return database_errors_1.isDatabaseError; } });
+Object.defineProperty(exports, "isDatabaseErrorType", { enumerable: true, get: function () { return database_errors_1.isDatabaseErrorType; } });
+// ============================================================================
+// Secret Error Exports
+// ============================================================================
+var secret_errors_1 = require("./secret-errors");
+Object.defineProperty(exports, "SecretError", { enumerable: true, get: function () { return secret_errors_1.SecretError; } });
+Object.defineProperty(exports, "SecretNotFoundError", { enumerable: true, get: function () { return secret_errors_1.SecretNotFoundError; } });
+Object.defineProperty(exports, "SecretAccessDeniedError", { enumerable: true, get: function () { return secret_errors_1.SecretAccessDeniedError; } });
+Object.defineProperty(exports, "SecretDecryptionError", { enumerable: true, get: function () { return secret_errors_1.SecretDecryptionError; } });
+Object.defineProperty(exports, "isSecretError", { enumerable: true, get: function () { return secret_errors_1.isSecretError; } });
+Object.defineProperty(exports, "isSecretErrorType", { enumerable: true, get: function () { return secret_errors_1.isSecretErrorType; } });
+// ============================================================================
+// Volume Error Exports
+// ============================================================================
+var errors_1 = require("./errors");
+// Error classes
+Object.defineProperty(exports, "VolumeError", { enumerable: true, get: function () { return errors_1.VolumeError; } });
+Object.defineProperty(exports, "VolumeNotFoundError", { enumerable: true, get: function () { return errors_1.VolumeNotFoundError; } });
+Object.defineProperty(exports, "VolumeAccessDeniedError", { enumerable: true, get: function () { return errors_1.VolumeAccessDeniedError; } });
+Object.defineProperty(exports, "VolumePermissionDeniedError", { enumerable: true, get: function () { return errors_1.VolumePermissionDeniedError; } });
+Object.defineProperty(exports, "FileNotFoundError", { enumerable: true, get: function () { return errors_1.FileNotFoundError; } });
+Object.defineProperty(exports, "FileAlreadyExistsError", { enumerable: true, get: function () { return errors_1.FileAlreadyExistsError; } });
+Object.defineProperty(exports, "InvalidPathError", { enumerable: true, get: function () { return errors_1.InvalidPathError; } });
+Object.defineProperty(exports, "FileSizeLimitError", { enumerable: true, get: function () { return errors_1.FileSizeLimitError; } });
+Object.defineProperty(exports, "ContentTypeNotAllowedError", { enumerable: true, get: function () { return errors_1.ContentTypeNotAllowedError; } });
+// Type guards
+Object.defineProperty(exports, "isVolumeError", { enumerable: true, get: function () { return errors_1.isVolumeError; } });
+Object.defineProperty(exports, "isVolumeErrorType", { enumerable: true, get: function () { return errors_1.isVolumeErrorType; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;;;AAoCH,+EAA+E;AAC/E,yBAAyB;AACzB,+EAA+E;AAE/E,qDAS2B;AARzB,gHAAA,aAAa,OAAA;AACb,wHAAA,qBAAqB,OAAA;AACrB,4HAAA,yBAAyB,OAAA;AACzB,0HAAA,uBAAuB,OAAA;AACvB,qHAAA,kBAAkB,OAAA;AAClB,2HAAA,wBAAwB,OAAA;AACxB,kHAAA,eAAe,OAAA;AACf,sHAAA,mBAAmB,OAAA;AASrB,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E,iDAOyB;AANvB,4GAAA,WAAW,OAAA;AACX,oHAAA,mBAAmB,OAAA;AACnB,wHAAA,uBAAuB,OAAA;AACvB,sHAAA,qBAAqB,OAAA;AACrB,8GAAA,aAAa,OAAA;AACb,kHAAA,iBAAiB,OAAA;AAqCnB,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E,mCAgBkB;AAbhB,gBAAgB;AAChB,qGAAA,WAAW,OAAA;AACX,6GAAA,mBAAmB,OAAA;AACnB,iHAAA,uBAAuB,OAAA;AACvB,qHAAA,2BAA2B,OAAA;AAC3B,2GAAA,iBAAiB,OAAA;AACjB,gHAAA,sBAAsB,OAAA;AACtB,0GAAA,gBAAgB,OAAA;AAChB,4GAAA,kBAAkB,OAAA;AAClB,oHAAA,0BAA0B,OAAA;AAC1B,cAAc;AACd,uGAAA,aAAa,OAAA;AACb,2GAAA,iBAAiB,OAAA"}

package/dist/secret-errors.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Ketrics SDK - Secret Error Classes
+ *
+ * Provides typed errors for secret operations in tenant applications.
+ *
+ * Error Hierarchy:
+ * - SecretError (base)
+ *   - SecretNotFoundError
+ *   - SecretAccessDeniedError
+ *   - SecretDecryptionError
+ */
+/**
+ * Base error class for all Secret errors
+ *
+ * All Secret errors extend this class and include:
+ * - secretCode: The secret code that caused the error
+ * - operation: The operation that failed
+ * - timestamp: When the error occurred
+ */
+export declare abstract class SecretError extends Error {
+    /** Secret code that caused the error */
+    readonly secretCode: string;
+    /** Operation that failed */
+    readonly operation: string;
+    /** When the error occurred */
+    readonly timestamp: Date;
+    constructor(message: string, secretCode: string, operation: string);
+    /**
+     * Serialize error for logging
+     */
+    toJSON(): Record<string, unknown>;
+}
+/**
+ * Error thrown when a secret is not found
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const secret = await ketrics.Secret.get('unknown-secret');
+ * } catch (error) {
+ *   if (error instanceof ketrics.SecretNotFoundError) {
+ *     console.log(`Secret '${error.secretCode}' not found`);
+ *   }
+ * }
+ * ```
+ */
+export declare class SecretNotFoundError extends SecretError {
+    constructor(secretCode: string);
+}
+/**
+ * Error thrown when application does not have access to a secret
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const secret = await ketrics.Secret.get('restricted-secret');
+ * } catch (error) {
+ *   if (error instanceof ketrics.SecretAccessDeniedError) {
+ *     console.log(`No access to secret '${error.secretCode}'`);
+ *   }
+ * }
+ * ```
+ */
+export declare class SecretAccessDeniedError extends SecretError {
+    constructor(secretCode: string);
+}
+/**
+ * Error thrown when secret decryption fails
+ *
+ * This typically indicates a KMS key issue or corrupted data.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const secret = await ketrics.Secret.get('encrypted-secret');
+ * } catch (error) {
+ *   if (error instanceof ketrics.SecretDecryptionError) {
+ *     console.log(`Failed to decrypt secret: ${error.reason}`);
+ *   }
+ * }
+ * ```
+ */
+export declare class SecretDecryptionError extends SecretError {
+    /** Reason for decryption failure */
+    readonly reason: string;
+    constructor(secretCode: string, reason: string);
+    toJSON(): Record<string, unknown>;
+}
+/**
+ * Type guard to check if an error is a SecretError
+ *
+ * @param error - The error to check
+ * @returns True if the error is a SecretError
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const secret = await ketrics.Secret.get('my-secret');
+ * } catch (error) {
+ *   if (isSecretError(error)) {
+ *     console.log(`Secret error: ${error.secretCode}`);
+ *   }
+ * }
+ * ```
+ */
+export declare function isSecretError(error: unknown): error is SecretError;
+/**
+ * Type guard to check if an error is a specific SecretError type
+ *
+ * @param error - The error to check
+ * @param errorClass - The error class to check against
+ * @returns True if the error is an instance of the specified class
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const secret = await ketrics.Secret.get('my-secret');
+ * } catch (error) {
+ *   if (isSecretErrorType(error, SecretNotFoundError)) {
+ *     console.log('Secret not found');
+ *   } else if (isSecretErrorType(error, SecretAccessDeniedError)) {
+ *     console.log('Access denied');
+ *   }
+ * }
+ * ```
+ */
+export declare function isSecretErrorType<T extends SecretError>(error: unknown, errorClass: new (...args: never[]) => T): error is T;
+//# sourceMappingURL=secret-errors.d.ts.map

package/dist/secret-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"secret-errors.d.ts","sourceRoot":"","sources":["../src/secret-errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAMH;;;;;;;GAOG;AACH,8BAAsB,WAAY,SAAQ,KAAK;IAC7C,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B,4BAA4B;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,8BAA8B;IAC9B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAalE;;OAEG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CASlC;AAMD;;;;;;;;;;;;;GAaG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;gBACtC,UAAU,EAAE,MAAM;CAO/B;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,uBAAwB,SAAQ,WAAW;gBAC1C,UAAU,EAAE,MAAM;CAO/B;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;IACpD,oCAAoC;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEZ,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAS9C,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAMlC;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAElE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,WAAW,EACrD,KAAK,EAAE,OAAO,EACd,UAAU,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,GACtC,KAAK,IAAI,CAAC,CAEZ"}