fix(queryProperty): allow compound oneOf (#2545)

marshallswain · web-flow · commit 7cfea6264991 · 2022-01-28T08:02:41.000-08:00
diff --git a/packages/schema/src/query.ts b/packages/schema/src/query.ts
@@ -1,7 +1,7 @@
 import { JSONSchema } from 'json-schema-to-ts';
 
 export const queryProperty = <T extends JSONSchema> (definition: T) => ({
-  oneOf: [
+  anyOf: [
     definition,
     {
       type: 'object',
diff --git a/packages/schema/test/schema.test.ts b/packages/schema/test/schema.test.ts
@@ -252,4 +252,49 @@ describe('@feathersjs/schema/schema', () => {
 
     assert.deepStrictEqual(res, { x: 3 });
   });
+
+  it('can handle compound queryProperty', async () => {
+    const formatsSchema = schema({
+      $id: 'compoundQueryProperty',
+      type: 'object',
+      required: [],
+      additionalProperties: false,
+      properties: {
+        dobString: queryProperty({
+          oneOf: [
+            { type: 'string', format: 'date', convert: true },
+            { type: 'string', format: 'date-time', convert: true },
+            { type: 'object' }
+          ]
+        })
+      }
+    } as const, customAjv);
+
+    const validated = await formatsSchema.validate({
+      dobString: { $gt: '2025-04-25', $lte: new Date('2027-04-25') }
+    });
+
+    assert.ok(validated)
+  });
+
+  it('can still fail queryProperty validation', async () => {
+    const formatsSchema = schema({
+      $id: 'compoundQueryPropertyFail',
+      type: 'object',
+      required: [],
+      additionalProperties: false,
+      properties: {
+        dobString: queryProperty({ type: 'string' })
+      }
+    } as const, customAjv);
+
+    try {
+      const validated = await formatsSchema.validate({
+        dobString: { $moose: 'test' }
+      });
+      assert(!validated, 'should not have gotten here')
+    } catch (error: any) {
+      assert.ok(error.data?.length > 0)
+    }
+  });
 });

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`import { JSONSchema } from 'json-schema-to-ts';`
`2`	`2`
`3`	`3`	`export const queryProperty = <T extends JSONSchema> (definition: T) => ({`
`4`		`- oneOf: [`
	`4`	`+ anyOf: [`
`5`	`5`	`definition,`
`6`	`6`	`{`
`7`	`7`	`type: 'object',`