Improved types

Author: ankane

src/mikro-orm/halfvec.js

@@ -22,7 +22,7 @@ export class HalfvecType extends Type {
   /**
    * @param {string} value
    * @param {Platform} platform
-   * @return {number[]}
+   * @return {?number[]}
    */
   convertToJSValue(value, platform) {
     return halfvecFromSql(value);

src/mikro-orm/vector.js

@@ -22,7 +22,7 @@ export class VectorType extends Type {
   /**
    * @param {string} value
    * @param {Platform} platform
-   * @return {number[]}
+   * @return {?number[]}
    */
   convertToJSValue(value, platform) {
     return vectorFromSql(value);

src/sequelize/halfvec.js

@@ -1,13 +1,15 @@
-// @ts-nocheck
-
 import { inherits } from 'node:util';
 import { Sequelize, DataTypes, Utils } from 'sequelize';
 import { halfvecType, halfvecToSql, halfvecFromSql } from '../utils.js';
 
+// @ts-ignore
 const PgTypes = DataTypes.postgres;
 const ABSTRACT = DataTypes.ABSTRACT.prototype.constructor;
 
 class HALFVEC extends ABSTRACT {
+  /**
+   * @param {number} [dimensions]
+   */
   constructor(dimensions) {
     super();
     this._dimensions = dimensions;
@@ -17,30 +19,42 @@ class HALFVEC extends ABSTRACT {
     return halfvecType(this._dimensions).toUpperCase();
   }
 
+  /**
+   * @param {?number[]} value
+   */
   _stringify(value) {
     return halfvecToSql(value);
   }
 
+  /**
+   * @param {?string} value
+   */
   static parse(value) {
     return halfvecFromSql(value);
   }
 }
 
 HALFVEC.prototype.key = HALFVEC.key = 'halfvec';
 
+// @ts-ignore
 DataTypes.HALFVEC = Utils.classToInvokable(HALFVEC);
+// @ts-ignore
 DataTypes.HALFVEC.types.postgres = ['halfvec'];
 
 PgTypes.HALFVEC = function HALFVEC() {
   if (!(this instanceof PgTypes.HALFVEC)) {
     return new PgTypes.HALFVEC();
   }
+  // @ts-ignore
   DataTypes.HALFVEC.apply(this, arguments);
 };
 inherits(PgTypes.HALFVEC, DataTypes.HALFVEC);
+// @ts-ignore
 PgTypes.HALFVEC.parse = DataTypes.HALFVEC.parse;
 PgTypes.HALFVEC.types = {postgres: ['halfvec']};
+// @ts-ignore
 DataTypes.postgres.HALFVEC.key = 'halfvec';
 
 // for migrations
+// @ts-ignore
 Sequelize.HALFVEC ??= DataTypes.HALFVEC;

src/sequelize/sparsevec.js

@@ -1,13 +1,17 @@
-// @ts-nocheck
-
 import { inherits } from 'node:util';
 import { Sequelize, DataTypes, Utils } from 'sequelize';
 import { sparsevecType, sparsevecToSql, sparsevecFromSql } from '../utils.js';
 
+/** @import { SparseVector } from '../index.js' */
+
+// @ts-ignore
 const PgTypes = DataTypes.postgres;
 const ABSTRACT = DataTypes.ABSTRACT.prototype.constructor;
 
 class SPARSEVEC extends ABSTRACT {
+  /**
+   * @param {number} [dimensions]
+   */
   constructor(dimensions) {
     super();
     this._dimensions = dimensions;
@@ -17,30 +21,42 @@ class SPARSEVEC extends ABSTRACT {
     return sparsevecType(this._dimensions).toUpperCase();
   }
 
+  /**
+   * @param {?SparseVector} value
+   */
   _stringify(value) {
     return sparsevecToSql(value);
   }
 
+  /**
+   * @param {?string} value
+   */
   static parse(value) {
     return sparsevecFromSql(value);
   }
 }
 
 SPARSEVEC.prototype.key = SPARSEVEC.key = 'sparsevec';
 
+// @ts-ignore
 DataTypes.SPARSEVEC = Utils.classToInvokable(SPARSEVEC);
+// @ts-ignore
 DataTypes.SPARSEVEC.types.postgres = ['sparsevec'];
 
 PgTypes.SPARSEVEC = function SPARSEVEC() {
   if (!(this instanceof PgTypes.SPARSEVEC)) {
     return new PgTypes.SPARSEVEC();
   }
+  // @ts-ignore
   DataTypes.SPARSEVEC.apply(this, arguments);
 };
 inherits(PgTypes.SPARSEVEC, DataTypes.SPARSEVEC);
+// @ts-ignore
 PgTypes.SPARSEVEC.parse = DataTypes.SPARSEVEC.parse;
 PgTypes.SPARSEVEC.types = {postgres: ['sparsevec']};
+// @ts-ignore
 DataTypes.postgres.SPARSEVEC.key = 'sparsevec';
 
 // for migrations
+// @ts-ignore
 Sequelize.SPARSEVEC ??= DataTypes.SPARSEVEC;

src/sequelize/vector.js

@@ -1,13 +1,15 @@
-// @ts-nocheck
-
 import { inherits } from 'node:util';
 import { Sequelize, DataTypes, Utils } from 'sequelize';
 import { vectorType, vectorToSql, vectorFromSql } from '../utils.js';
 
+// @ts-ignore
 const PgTypes = DataTypes.postgres;
 const ABSTRACT = DataTypes.ABSTRACT.prototype.constructor;
 
 class VECTOR extends ABSTRACT {
+  /**
+   * @param {number} [dimensions]
+   */
   constructor(dimensions) {
     super();
     this._dimensions = dimensions;
@@ -17,30 +19,42 @@ class VECTOR extends ABSTRACT {
     return vectorType(this._dimensions).toUpperCase();
   }
 
+  /**
+   * @param {?number[]} value
+   */
   _stringify(value) {
     return vectorToSql(value);
   }
 
+  /**
+   * @param {?string} value
+   */
   static parse(value) {
     return vectorFromSql(value);
   }
 }
 
 VECTOR.prototype.key = VECTOR.key = 'vector';
 
+// @ts-ignore
 DataTypes.VECTOR = Utils.classToInvokable(VECTOR);
+// @ts-ignore
 DataTypes.VECTOR.types.postgres = ['vector'];
 
 PgTypes.VECTOR = function VECTOR() {
   if (!(this instanceof PgTypes.VECTOR)) {
     return new PgTypes.VECTOR();
   }
+  // @ts-ignore
   DataTypes.VECTOR.apply(this, arguments);
 };
 inherits(PgTypes.VECTOR, DataTypes.VECTOR);
+// @ts-ignore
 PgTypes.VECTOR.parse = DataTypes.VECTOR.parse;
 PgTypes.VECTOR.types = {postgres: ['vector']};
+// @ts-ignore
 DataTypes.postgres.VECTOR.key = 'vector';
 
 // for migrations
+// @ts-ignore
 Sequelize.VECTOR ??= DataTypes.VECTOR;

src/utils.js

@@ -1,18 +1,6 @@
 import { format } from 'node:util';
 import { SparseVector } from './sparse-vector.js';
 
-/**
- * @overload
- * @param {string} value
- * @returns {number[]}
- */
-
-/**
- * @overload
- * @param {null} value
- * @returns {null}
- */
-
 /**
  * @param {?string} value
  * @returns {?number[]}

types/mikro-orm/halfvec.d.ts

@@ -1,7 +1,7 @@
 export class HalfvecType extends Type<number[] | null, string | null> {
     constructor();
     convertToDatabaseValue(value: number[] | null, platform: Platform): string | null;
-    convertToJSValue(value: string, platform: Platform): number[];
+    convertToJSValue(value: string, platform: Platform): number[] | null;
     getColumnType(prop: any, platform: Platform): string;
 }
 import { Type } from '@mikro-orm/core';

types/mikro-orm/vector.d.ts

@@ -1,7 +1,7 @@
 export class VectorType extends Type<number[] | null, string | null> {
     constructor();
     convertToDatabaseValue(value: number[] | null, platform: Platform): string | null;
-    convertToJSValue(value: string, platform: Platform): number[];
+    convertToJSValue(value: string, platform: Platform): number[] | null;
     getColumnType(prop: any, platform: Platform): string;
 }
 import { Type } from '@mikro-orm/core';

types/utils.d.ts

@@ -1,5 +1,4 @@
-export function vectorFromSql(value: string): number[];
-export function vectorFromSql(value: null): null;
+export function vectorFromSql(value: string | null): number[] | null;
 export function vectorToSql(value: number[] | null): string | null;
 export function sparsevecFromSql(value: string | null): SparseVector | null;
 export function sparsevecToSql(value: SparseVector | null): string | null;