fix(types): allow Op.contains on a jsonb column (#16167)

sequelize · Jul 21, 2023 · 70c2bf5 · 70c2bf5
1 parent 0012466
commit 70c2bf5
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 1 deletion.
diff --git a/packages/core/src/model.d.ts b/packages/core/src/model.d.ts
@@ -381,7 +381,10 @@ export interface WhereOperators<AttributeType = any> {
   // https://www.postgresql.org/docs/14/functions-array.html array @> array
   [Op.contains]?:
     // RANGE @> ELEMENT
-    | AttributeType extends Range<infer RangeType> ? OperatorValues<OperatorValues<NonNullable<RangeType>>> : never
+    | AttributeType extends Range<infer RangeType> ? OperatorValues<OperatorValues<NonNullable<RangeType>>>
+      // jsonb @> ELEMENT
+      : AttributeType extends object ? OperatorValues<Partial<AttributeType>>
+      : never
     // ARRAY @> ARRAY ; RANGE @> RANGE
     | WhereOperators<AttributeType>[typeof Op.overlap];
 

diff --git a/packages/core/test/unit/sql/where.test.ts b/packages/core/test/unit/sql/where.test.ts
@@ -41,6 +41,10 @@ const dialectSupportsJsonOperations = () => sequelize.dialect.supports.jsonOpera
 const dialectSupportsJsonQuotedExtraction = () => sequelize.dialect.supports.jsonExtraction.quoted;
 const dialectSupportsJsonUnquotedExtraction = () => sequelize.dialect.supports.jsonExtraction.unquoted;
 
+interface SomeInterface {
+  foo: string;
+}
+
 class TestModel extends Model<InferAttributes<TestModel>> {
   declare intAttr1: number;
   declare intAttr2: number;
@@ -64,6 +68,9 @@ class TestModel extends Model<InferAttributes<TestModel>> {
   declare aliasedJsonAttr: object;
   declare aliasedJsonbAttr: object;
 
+  declare jsonbTypeLiteralAttr: { foo: string };
+  declare jsonbInterfaceAttr: SomeInterface;
+
   declare uuidAttr: string;
 }
 
@@ -96,6 +103,8 @@ TestModel.init({
   ...(dialectSupportsJsonB() && {
     jsonbAttr: { type: DataTypes.JSONB },
     aliasedJsonbAttr: { type: DataTypes.JSONB, field: 'aliased_jsonb' },
+    jsonbTypeLiteralAttr: { type: DataTypes.JSONB },
+    jsonbInterfaceAttr: { type: DataTypes.JSONB },
   }),
 
   uuidAttr: DataTypes.UUID,
@@ -2431,6 +2440,32 @@ Caused by: "undefined" cannot be escaped`),
           default: `[jsonbAttr] @> '{"company":"Magnafone"}'`,
         });
 
+        testSql({
+          jsonbTypeLiteralAttr: { [Op.contains]: { foo: 'bar' } },
+        }, {
+          postgres: '"jsonbTypeLiteralAttr" @> \'{"foo":"bar"}\'',
+        });
+
+        testSql({
+          // @ts-expect-error -- key `bad` isn't known
+          jsonbTypeLiteralAttr: { [Op.contains]: { bad: 'bad' } },
+        }, {
+          postgres: '"jsonbTypeLiteralAttr" @> \'{"bad":"bad"}\'',
+        });
+
+        testSql({
+          jsonbInterfaceAttr: { [Op.contains]: { foo: 'bar' } },
+        }, {
+          postgres: '"jsonbInterfaceAttr" @> \'{"foo":"bar"}\'',
+        });
+
+        testSql({
+          // @ts-expect-error -- key `bad` isn't known
+          jsonbInterfaceAttr: { [Op.contains]: { bad: 'bad' } },
+        }, {
+          postgres: '"jsonbInterfaceAttr" @> \'{"bad":"bad"}\'',
+        });
+
         // aliases correctly
 
         testSql({ aliasedJsonbAttr: { key: 'value' } }, {