relq 1.0.5 → 1.0.6

package/dist/index.d.ts

@@ -191,6 +191,14 @@ export type IsolationLevel = "READ UNCOMMITTED" | "READ COMMITTED" | "REPEATABLE
  * Transaction access modes
  */
 export type TransactionMode = "READ WRITE" | "READ ONLY";
+/**
+ * Type-safe PostgreSQL DEFAULT value helpers
+ * Covers all PostgreSQL default value types with 100% typed output
+ */
+export interface DefaultValue {
+	readonly $sql: string;
+	readonly $isDefault: true;
+}
 declare const EMPTY_OBJECT: unique symbol;
 declare const EMPTY_ARRAY: unique symbol;
 export interface ColumnConfig<T = unknown> {
@@ -198,7 +206,7 @@ export interface ColumnConfig<T = unknown> {
 	$sqlType?: string;
 	$tsType?: T;
 	$nullable?: boolean;
-	$default?: T | (() => T) | string | object | typeof EMPTY_OBJECT | typeof EMPTY_ARRAY;
+	$default?: T | (() => T) | string | object | typeof EMPTY_OBJECT | typeof EMPTY_ARRAY | DefaultValue;
 	$primaryKey?: boolean;
 	$unique?: boolean;
 	$references?: {
@@ -220,6 +228,7 @@ export interface ColumnConfig<T = unknown> {
 	$scale?: number;
 	$withTimezone?: boolean;
 	$columnName?: string;
+	$trackingId?: string;
 }
 /**
  * Partition Types and Builders
@@ -270,6 +279,58 @@ export interface IndexDefinition {
 	include?: string[];
 	/** Expression for expression-based indexes */
 	expression?: string;
+	/**
+	 * Generate CREATE INDEX IF NOT EXISTS instead of CREATE INDEX.
+	 *
+	 * When true, the generated SQL will be:
+	 * `CREATE INDEX IF NOT EXISTS index_name ON table_name (...)`
+	 *
+	 * This makes index creation idempotent - if the index already exists,
+	 * PostgreSQL will skip creation instead of throwing an error.
+	 *
+	 * Use cases:
+	 * - Idempotent migrations that can be run multiple times safely
+	 * - Manual schema management where you want to avoid errors on re-runs
+	 * - Incremental schema updates in development environments
+	 * - CI/CD pipelines where schema might already exist
+	 *
+	 * @default false
+	 */
+	ifNotExists?: boolean;
+	/**
+	 * Use ON ONLY clause for partitioned tables.
+	 *
+	 * When true, the generated SQL will be:
+	 * `CREATE INDEX index_name ON ONLY table_name (...)`
+	 *
+	 * This creates an index on the parent partitioned table only, without
+	 * automatically creating matching indexes on child partitions. Each
+	 * partition must have its own index created separately.
+	 *
+	 * Use cases:
+	 * - When you want different index configurations per partition
+	 * - When partitions have different access patterns
+	 * - When you want to control index creation timing per partition
+	 * - For declarative partitioning with custom index strategies
+	 * - When some partitions don't need certain indexes (e.g., archive partitions)
+	 *
+	 * @default false
+	 * @see https://www.postgresql.org/docs/current/ddl-partitioning.html#DDL-PARTITIONING-DECLARATIVE-MAINTENANCE
+	 */
+	tableOnly?: boolean;
+	/** Index comment/description */
+	comment?: string;
+	/** Tracking ID for rename detection */
+	trackingId?: string;
+}
+/** Constraint definition result */
+export interface ConstraintDef {
+	readonly $type: "PRIMARY KEY" | "UNIQUE" | "EXCLUDE";
+	readonly $name: string;
+	readonly $columns: string[];
+	readonly $expression?: string;
+	/** Tracking ID for rename detection */
+	readonly $trackingId?: string;
 }
 export type IsSerialType<T extends string> = T extends "SERIAL" | "BIGSERIAL" | "SMALLSERIAL" | "SERIAL4" | "SERIAL2" | "SERIAL8" ? true : false;
 export type HasDefault<C> = C extends {
@@ -355,6 +416,8 @@ export interface TableDefinition<T extends Record<string, ColumnConfig>> {
 		expression: string;
 		name?: string;
 	}>;
+	/** Table-level constraints (composite PKs, etc.) */
+	$constraints?: ConstraintDef[];
 	$foreignKeys?: Array<{
 		columns: string[];
 		references: {
@@ -364,12 +427,18 @@ export interface TableDefinition<T extends Record<string, ColumnConfig>> {
 		onDelete?: string;
 		onUpdate?: string;
 		name?: string;
+		/** Tracking ID for rename detection */
+		trackingId?: string;
 	}>;
 	$indexes?: IndexDefinition[];
 	$inherits?: string[];
 	$partitionBy?: PartitionStrategyDef;
 	$tablespace?: string;
 	$withOptions?: Record<string, unknown>;
+	/** Whether to use CREATE TABLE IF NOT EXISTS */
+	$ifNotExists?: boolean;
+	/** Tracking ID for rename detection */
+	$trackingId?: string;
 	$inferSelect: BuildSelectType<T>;
 	$inferInsert: BuildInsertType<T>;
 	toSQL(): string;
@@ -5006,6 +5075,76 @@ export interface QueryResultRow {
 export interface QueryResult<R extends QueryResultRow = any> extends QueryResultBase {
 	rows: R[];
 }
+/**
+ * AWS regions with autocomplete support
+ * Includes all standard AWS regions that may support DSQL
+ */
+export type AwsRegion = "us-east-1" | "us-east-2" | "us-west-1" | "us-west-2" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "eu-central-1" | "eu-central-2" | "eu-north-1" | "eu-south-1" | "eu-south-2" | "ap-east-1" | "ap-south-1" | "ap-south-2" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-southeast-4" | "me-south-1" | "me-central-1" | "af-south-1" | "il-central-1" | "sa-east-1" | "ca-central-1" | "ca-west-1" | "us-gov-east-1" | "us-gov-west-1" | (string & {});
+/**
+ * AWS DSQL (Aurora Serverless) configuration
+ * When provided, Relq automatically handles IAM token generation and caching
+ *
+ * @example
+ * ```typescript
+ * const db = new Relq(schema, {
+ *     database: 'postgres',
+ *     aws: {
+ *         hostname: 'abc123.dsql.us-east-1.on.aws',
+ *         region: 'us-east-1', // Autocomplete supported!
+ *         accessKeyId: 'AKIA...',
+ *         secretAccessKey: '...'
+ *     }
+ * });
+ * ```
+ */
+export interface AwsDbConfig {
+	/**
+	 * DSQL cluster hostname
+	 * @example "7btnrhwkzis7lsxg24cqdyzsm4.dsql.us-east-1.on.aws"
+	 */
+	hostname: string;
+	/**
+	 * AWS region with autocomplete support
+	 * @example "us-east-1"
+	 */
+	region: AwsRegion;
+	/**
+	 * AWS Access Key ID
+	 * Required unless useDefaultCredentials is true
+	 */
+	accessKeyId?: string;
+	/**
+	 * AWS Secret Access Key
+	 * Required unless useDefaultCredentials is true
+	 */
+	secretAccessKey?: string;
+	/**
+	 * Database port (inherited from root config if not specified)
+	 * @default 5432
+	 */
+	port?: number;
+	/**
+	 * Database user (inherited from root config if not specified)
+	 * @default 'admin'
+	 */
+	user?: string;
+	/**
+	 * Enable SSL/TLS for connection
+	 * @default true (DSQL typically requires SSL)
+	 */
+	ssl?: boolean;
+	/**
+	 * Use AWS default credential provider chain
+	 * (env vars, IAM role, ~/.aws/credentials)
+	 * @default false
+	 */
+	useDefaultCredentials?: boolean;
+	/**
+	 * Token expiration time in seconds
+	 * @default 604800 (7 days)
+	 */
+	tokenExpiresIn?: number;
+}
 /**
  * Relq database configuration
  * Supports both pooled and single connection modes
@@ -5204,6 +5343,25 @@ export interface RelqConfig {
 	 * @default 1000
 	 */
 	commitLimit?: number;
+	/**
+	 * AWS DSQL configuration
+	 * When provided, enables first-class AWS Aurora DSQL support
+	 * with automatic IAM token generation and caching
+	 *
+	 * @example
+	 * ```typescript
+	 * const db = new Relq(schema, {
+	 *     database: 'postgres',
+	 *     aws: {
+	 *         hostname: 'abc123.dsql.us-east-1.on.aws',
+	 *         region: 'us-east-1', // Autocomplete!
+	 *         accessKeyId: 'AKIA...',
+	 *         secretAccessKey: '...'
+	 *     }
+	 * });
+	 * ```
+	 */
+	aws?: AwsDbConfig;
 }
 /**
  * Metadata returned with all database operations