monsqlize 1.3.0 → 2.0.0

package/dist/types/base.d.ts

@@ -0,0 +1,81 @@
+export type DbType = 'mongodb';
+
+export interface ExpressionObject {
+    __expr__: string;
+    __compiled__: boolean;
+}
+
+export type ExpressionFunction = (expression: string) => ExpressionObject;
+
+/** Context in which an expression is evaluated. @since v1.0.0 */
+export type ExpressionContext = '$match' | '$project' | '$group' | 'unknown';
+
+export interface LoggerLike {
+    debug?: (...args: unknown[]) => void;
+    info?: (...args: unknown[]) => void;
+    warn?: (...args: unknown[]) => void;
+    error?: (...args: unknown[]) => void;
+    /** Wrap a function execution with a trace ID. @since v1.3.0 */
+    withTraceId?: (fn: Function, traceId?: string) => any;
+    /** Retrieve the current trace ID. @since v1.3.0 */
+    getTraceId?: () => string | null;
+}
+
+/** Logger configuration options. @since v1.3.0 */
+export interface LoggerOptions {
+    /** Enable structured (JSON) log output. */
+    structured?: boolean;
+    /** Enable automatic trace ID injection into log entries. */
+    enableTraceId?: boolean;
+}
+
+export declare const enum ErrorCodes {
+    INVALID_ARGUMENT = 'INVALID_ARGUMENT',
+    INVALID_COLLECTION_NAME = 'INVALID_COLLECTION_NAME',
+    INVALID_DATABASE_NAME = 'INVALID_DATABASE_NAME',
+    INVALID_EXPRESSION = 'INVALID_EXPRESSION',
+    INVALID_PAGINATION = 'INVALID_PAGINATION',
+    INVALID_OPERATION = 'INVALID_OPERATION',
+    INVALID_CURSOR = 'INVALID_CURSOR',
+    INVALID_CONFIG = 'INVALID_CONFIG',
+    INVALID_MODEL_DEFINITION = 'INVALID_MODEL_DEFINITION',
+    INVALID_SCHEMA_TYPE = 'INVALID_SCHEMA_TYPE',
+    NOT_CONNECTED = 'NOT_CONNECTED',
+    NO_POOL_MANAGER = 'NO_POOL_MANAGER',
+    POOL_NOT_FOUND = 'POOL_NOT_FOUND',
+    MODEL_NOT_DEFINED = 'MODEL_NOT_DEFINED',
+    MODEL_ALREADY_EXISTS = 'MODEL_ALREADY_EXISTS',
+    MISSING_SCHEMA = 'MISSING_SCHEMA',
+    UNSUPPORTED_DATABASE = 'UNSUPPORTED_DATABASE',
+    CONNECTION_FAILED = 'CONNECTION_FAILED',
+    CONNECTION_CLOSED = 'CONNECTION_CLOSED',
+    CONNECTION_TIMEOUT = 'CONNECTION_TIMEOUT',
+    OPERATION_TIMEOUT = 'OPERATION_TIMEOUT',
+    QUERY_TIMEOUT = 'QUERY_TIMEOUT',
+    DATABASE_ERROR = 'DATABASE_ERROR',
+    CACHE_UNAVAILABLE = 'CACHE_UNAVAILABLE',
+    CACHE_ERROR = 'CACHE_ERROR',
+    CACHE_TIMEOUT = 'CACHE_TIMEOUT',
+    MANAGEMENT_OPERATION_FAILED = 'MANAGEMENT_OPERATION_FAILED',
+    VALIDATION_ERROR = 'VALIDATION_ERROR',
+    DOCUMENT_REQUIRED = 'DOCUMENT_REQUIRED',
+    DOCUMENTS_REQUIRED = 'DOCUMENTS_REQUIRED',
+    DUPLICATE_KEY = 'DUPLICATE_KEY',
+    WRITE_ERROR = 'WRITE_ERROR',
+    WRITE_CONFLICT = 'WRITE_CONFLICT',
+    CURSOR_SORT_MISMATCH = 'CURSOR_SORT_MISMATCH',
+    JUMP_TOO_FAR = 'JUMP_TOO_FAR',
+    STREAM_NO_JUMP = 'STREAM_NO_JUMP',
+    STREAM_NO_TOTALS = 'STREAM_NO_TOTALS',
+    STREAM_NO_EXPLAIN = 'STREAM_NO_EXPLAIN',
+    MONGODB_ERROR = 'MONGODB_ERROR',
+    LOCK_ACQUIRE_FAILED = 'LOCK_ACQUIRE_FAILED',
+    LOCK_TIMEOUT = 'LOCK_TIMEOUT',
+}
+
+export interface MonSQLizeError extends Error {
+    code: string;
+    details?: unknown[];
+    cause?: Error;
+}
+