fix: allow SerializableValueType to include Record types with optiona…

…l fields (fixes #222) (#223)
gajus · Oct 30, 2020 · 849453b · 849453b
1 parent 46e4b8f
commit 849453b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/.eslintrc b/.eslintrc
@@ -14,6 +14,7 @@
     "@typescript-eslint/no-non-null-assertion": 1,
     "@typescript-eslint/prefer-ts-expect-error": 1,
     "unicorn/prevent-abbreviations": 0,
+    "unicorn/numeric-separators-style": 0,
     "no-undef": 0,
     "linebreak-style": 0,
     // https://github.com/typescript-eslint/typescript-eslint/issues/1624#issuecomment-589731039

diff --git a/src/types.ts b/src/types.ts
@@ -39,7 +39,7 @@ export type SerializableValueType =
   | boolean
   | null
   | {
-      [key: string]: SerializableValueType;
+      [key: string]: SerializableValueType | undefined;
     }
   | ReadonlyArray<SerializableValueType>;
 

diff --git a/test/slonik/templateTags/sql/json.ts b/test/slonik/templateTags/sql/json.ts
@@ -122,3 +122,18 @@ test('the resulting object is immutable', (t) => {
     token.foo = 'bar';
   });
 });
+
+test('Object types with optional properties are allowed', (t) => {
+  type TypeWithOptionalProperty = { foo: string; opt?: string };
+  const testValue: TypeWithOptionalProperty = {foo: 'bar'};
+
+  const query = sql`SELECT ${sql.json(testValue)}`;
+
+  t.deepEqual(query, {
+    sql: 'SELECT $1',
+    type: SqlToken,
+    values: [
+      '{"foo":"bar"}',
+    ],
+  });
+});