ts-prorm-orm 1.1.0

package/dist/decorators/set-column.js

@@ -0,0 +1,83 @@
+"use strict";
+/**
+ * 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;
+ * }
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SetColumn = SetColumn;
+exports.SetColumnWithOptions = SetColumnWithOptions;
+exports.getSetColumnMetadata = getSetColumnMetadata;
+exports.getAllSetColumnMetadata = getAllSetColumnMetadata;
+exports.isSetColumn = isSetColumn;
+exports.generateSetFindInSetSQL = generateSetFindInSetSQL;
+const SETCOLUMN_METADATA_KEY = Symbol('setColumn');
+/**
+ * Decorator to mark a field as a SET column
+ * @param values - Either an array of values or individual string values
+ */
+function SetColumn(values, ...additionalValues) {
+    return (target, propertyKey) => {
+        let setValues;
+        if (Array.isArray(values)) {
+            setValues = values;
+        }
+        else {
+            setValues = [values, ...additionalValues];
+        }
+        const metadata = { values: setValues };
+        target[`${String(propertyKey)}_setcolumn`] = metadata;
+    };
+}
+/**
+ * Decorator to mark a field as a SET column with options
+ * @param options - Options for the SET column
+ */
+function SetColumnWithOptions(options) {
+    return (target, propertyKey) => {
+        const metadata = {
+            values: options.values,
+            name: options.name,
+        };
+        target[`${String(propertyKey)}_setcolumn`] = metadata;
+    };
+}
+/**
+ * Get SET column metadata for a field
+ */
+function getSetColumnMetadata(target, propertyKey) {
+    return target[`${propertyKey}_setcolumn`];
+}
+/**
+ * Get all SET column metadata for a model
+ */
+function getAllSetColumnMetadata(target) {
+    const metadata = new Map();
+    const keys = Object.keys(target);
+    for (const key of keys) {
+        const setMeta = target[`${key}_setcolumn`];
+        if (setMeta) {
+            metadata.set(key, setMeta);
+        }
+    }
+    return metadata;
+}
+/**
+ * Check if a field is marked as SET column
+ */
+function isSetColumn(target, propertyKey) {
+    return !!getSetColumnMetadata(target, propertyKey);
+}
+/**
+ * Generate SQL to check if a SET value contains a specific value
+ */
+function generateSetFindInSetSQL(columnName, value) {
+    return `FIND_IN_SET('${value}', \`${columnName}\`)`;
+}

package/dist/decorators/spatial.js

@@ -0,0 +1,114 @@
+"use strict";
+/**
+ * Spatial column decorator for MySQL spatial types
+ *
+ * @example
+ * class Location extends Model {
+ *   @Spatial('POINT', 4326)
+ *   point: DataTypes.POINT;
+ *
+ *   @Spatial('POLYGON')
+ *   area: DataTypes.POLYGON;
+ * }
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Spatial = Spatial;
+exports.getSpatialMetadata = getSpatialMetadata;
+exports.getAllSpatialMetadata = getAllSpatialMetadata;
+exports.isSpatialColumn = isSpatialColumn;
+exports.generateSpatialIndexSQL = generateSpatialIndexSQL;
+const SPATIAL_METADATA_KEY = Symbol('spatial');
+/**
+ * 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)
+ */
+function Spatial(type, srid) {
+    return (target, propertyKey) => {
+        const metadata = { type, srid };
+        target[`${String(propertyKey)}_spatial`] = metadata;
+    };
+}
+/**
+ * Get spatial metadata for a field
+ */
+function getSpatialMetadata(target, propertyKey) {
+    return target[`${propertyKey}_spatial`];
+}
+/**
+ * Get all spatial metadata for a model
+ */
+function getAllSpatialMetadata(target) {
+    const metadata = new Map();
+    const keys = Object.keys(target);
+    for (const key of keys) {
+        const spatialMeta = target[`${key}_spatial`];
+        if (spatialMeta) {
+            metadata.set(key, spatialMeta);
+        }
+    }
+    return metadata;
+}
+/**
+ * Check if a field is marked as spatial
+ */
+function isSpatialColumn(target, propertyKey) {
+    return !!getSpatialMetadata(target, propertyKey);
+}
+/**
+ * Quote an identifier using the quoting convention for the given dialect.
+ */
+function quoteSpatialIdentifier(identifier, dialect) {
+    switch (dialect) {
+        case 'mysql':
+        case 'mariadb':
+            return `\`${identifier}\``;
+        case 'mssql':
+            return `[${identifier}]`;
+        case 'postgres':
+        case 'oracle':
+        case 'sqlite':
+        default:
+            return `"${identifier}"`;
+    }
+}
+/**
+ * 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)
+ */
+function generateSpatialIndexSQL(tableName, columnName, indexName, dialect = 'mysql') {
+    const idxName = indexName || `idx_${tableName}_${columnName}`;
+    const qIdx = quoteSpatialIdentifier(idxName, dialect);
+    const qTable = quoteSpatialIdentifier(tableName, dialect);
+    const qColumn = quoteSpatialIdentifier(columnName, dialect);
+    switch (dialect) {
+        case 'postgres':
+            return `CREATE INDEX ${qIdx} ON ${qTable} USING gist (${qColumn})`;
+        case 'mysql':
+        case 'mariadb':
+        case 'mssql':
+            return `CREATE SPATIAL INDEX ${qIdx} ON ${qTable}(${qColumn})`;
+        case 'oracle':
+            return `CREATE INDEX ${qIdx} ON ${qTable} (${qColumn}) INDEXTYPE IS MDSYS.SPATIAL_INDEX`;
+        case 'sqlite':
+            return `CREATE VIRTUAL TABLE ${qIdx} USING rtree(${columnName})`;
+        default:
+            throw new Error(`Spatial indexes are not supported for the "${dialect}" dialect.`);
+    }
+}