ts-prorm-orm 1.1.0 → 1.2.0

package/dist/decorators/range.d.ts

@@ -0,0 +1,122 @@
+/**
+ * Range Decorator for the ORM
+ *
+ * Provides PostgreSQL Range Types support.
+ * Range types: int4range, int8range, numrange, tsrange, tstzrange, daterange
+ *
+ * Usage:
+ *
+ *   // Timestamp range
+ *   @Range('tsrange')
+ *   duration: [Date, Date];
+ *
+ *   // Integer range
+ *   @Range('int4range')
+ *   quantity: [number, number];
+ *
+ *   // Date range
+ *   @Range('daterange')
+ *   dates: [string, string];
+ */
+import type { RangeSubtype } from '../types';
+/**
+ * PostgreSQL Range subtypes
+ */
+export type { RangeSubtype };
+/**
+ * Options for Range column type
+ */
+export interface RangeDecoratorOptions {
+    /** The range subtype */
+    subtype: RangeSubtype;
+    /** Whether the column allows null */
+    allowNull?: boolean;
+    /** Default value for the column */
+    defaultValue?: [any, any];
+    /** Comment for the column */
+    comment?: string;
+    /** Custom column name in the database */
+    field?: string;
+}
+/**
+ * Metadata stored on the property
+ */
+export interface RangeMetadata {
+    options: RangeDecoratorOptions;
+}
+/**
+ * Range decorator for PostgreSQL Range columns
+ *
+ * @param options - Required range options (subtype is required)
+ *
+ * @example
+ * // Timestamp range
+ * class Reservation extends Model {
+ *   @Range({ subtype: 'tsrange' })
+ *   during: [Date, Date];
+ * }
+ *
+ * // Date range
+ * class Event extends Model {
+ *   @Range({ subtype: 'daterange' })
+ *   dates: [string, string];
+ * }
+ *
+ * // Integer range
+ * class Inventory extends Model {
+ *   @Range({ subtype: 'int4range', allowNull: false })
+ *   quantity: [number, number];
+ * }
+ */
+export declare function Range(options: RangeDecoratorOptions): PropertyDecorator;
+/**
+ * Get Range metadata for a property
+ *
+ * @param target - The target class
+ * @param propertyKey - The property name
+ * @returns Range metadata or undefined if not found
+ */
+export declare function getRangeMetadata(target: object, propertyKey: string | symbol): RangeMetadata | undefined;
+/**
+ * Get all Range metadata for a class
+ *
+ * @param target - The target class
+ * @returns Map of property names to Range metadata
+ */
+export declare function getAllRangeMetadata(target: object): Map<string, RangeMetadata>;
+/**
+ * Check if a property is a Range column
+ *
+ * @param target - The target class
+ * @param propertyKey - The property name
+ * @returns True if the property is a Range column
+ */
+export declare function isRangeColumn(target: object, propertyKey: string | symbol): boolean;
+/**
+ * Clear Range metadata (useful for testing)
+ */
+export declare function clearRangeMetadata(): void;
+/**
+ * Build the SQL for a range literal
+ *
+ * @param lower - Lower bound of the range
+ * @param upper - Upper bound of the range
+ * @param options - Options for the range
+ * @returns SQL for the range literal
+ */
+export declare function buildRangeLiteral(lower: any, upper: any, options?: {
+    inclusiveLower?: boolean;
+    inclusiveUpper?: boolean;
+}): string;
+/**
+ * Get the SQL operator for range containment
+ *
+ * @returns SQL for the @> operator
+ */
+export declare function getRangeContainedBySQL(): string;
+/**
+ * Get the SQL operator for range overlap
+ *
+ * @returns SQL for the && operator
+ */
+export declare function getRangeOverlapSQL(): string;

package/dist/decorators/set-column.d.ts

@@ -0,0 +1,43 @@
+/**
+ * SET Column decorator for MySQL SET type
+ *
+ * @example
+ * class Options extends Model {
+ *   @SetColumn(['red', 'green', 'blue'])
+ *   colors: DataTypes.SET;
+ *
+ *   @SetColumn('a', 'b', 'c')
+ *   flags: DataTypes.SET;
+ * }
+ */
+import { SetColumnOptions } from '../types';
+export interface SetColumnMetadata {
+    values: string[];
+    name?: string;
+}
+/**
+ * Decorator to mark a field as a SET column
+ * @param values - Either an array of values or individual string values
+ */
+export declare function SetColumn(values: string | string[], ...additionalValues: string[]): PropertyDecorator;
+/**
+ * Decorator to mark a field as a SET column with options
+ * @param options - Options for the SET column
+ */
+export declare function SetColumnWithOptions(options: SetColumnOptions): PropertyDecorator;
+/**
+ * Get SET column metadata for a field
+ */
+export declare function getSetColumnMetadata(target: object, propertyKey: string): SetColumnMetadata | undefined;
+/**
+ * Get all SET column metadata for a model
+ */
+export declare function getAllSetColumnMetadata(target: object): Map<string, SetColumnMetadata>;
+/**
+ * Check if a field is marked as SET column
+ */
+export declare function isSetColumn(target: object, propertyKey: string): boolean;
+/**
+ * Generate SQL to check if a SET value contains a specific value
+ */
+export declare function generateSetFindInSetSQL(columnName: string, value: string): string;

package/dist/decorators/spatial.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Spatial column decorator for MySQL spatial types
+ *
+ * @example
+ * class Location extends Model {
+ *   @Spatial('POINT', 4326)
+ *   point: DataTypes.POINT;
+ *
+ *   @Spatial('POLYGON')
+ *   area: DataTypes.POLYGON;
+ * }
+ */
+import { SpatialType } from '../types';
+export interface SpatialMetadata {
+    type: SpatialType;
+    srid?: number;
+}
+/**
+ * Decorator to mark a field as a spatial column
+ * @param type - The spatial type (POINT, LINESTRING, POLYGON, etc.)
+ * @param srid - Optional SRID (Spatial Reference System Identifier)
+ */
+export declare function Spatial(type: SpatialType, srid?: number): PropertyDecorator;
+/**
+ * Get spatial metadata for a field
+ */
+export declare function getSpatialMetadata(target: object, propertyKey: string): SpatialMetadata | undefined;
+/**
+ * Get all spatial metadata for a model
+ */
+export declare function getAllSpatialMetadata(target: object): Map<string, SpatialMetadata>;
+/**
+ * Check if a field is marked as spatial
+ */
+export declare function isSpatialColumn(target: object, propertyKey: string): boolean;
+/**
+ * Supported SQL dialect identifiers used throughout the ORM
+ */
+export type SpatialDialect = 'mysql' | 'mariadb' | 'postgres' | 'mssql' | 'oracle' | 'sqlite';
+/**
+ * Generate SQL for spatial index creation.
+ *
+ * Mirrors the per-dialect `createSpatialIndex` implementations found under
+ * `src/dialects/*\/index.ts`, and is consistent with the dialects that
+ * `DataTypes.GEOMETRY`/`GEOGRAPHY` (src/models/data-types.ts) actually
+ * generate column syntax for:
+ * - PostgreSQL/PostGIS: `CREATE INDEX ... USING gist (col)`
+ * - MySQL/MariaDB: `CREATE SPATIAL INDEX ...`
+ * - Oracle: `CREATE INDEX ... INDEXTYPE IS MDSYS.SPATIAL_INDEX`
+ * - MSSQL: `CREATE SPATIAL INDEX ...` (default grid tessellation)
+ * - SQLite: `CREATE VIRTUAL TABLE ... USING rtree(...)` (SQLite has no
+ *   native spatial index — the R-Tree virtual table module is the closest
+ *   equivalent)
+ *
+ * @param tableName - The table to index
+ * @param columnName - The spatial column to index
+ * @param indexName - Optional explicit index name
+ * @param dialect - The target SQL dialect (defaults to 'mysql' for backwards compatibility)
+ */
+export declare function generateSpatialIndexSQL(tableName: string, columnName: string, indexName?: string, dialect?: SpatialDialect): string;