@feathersjs/schema 5.0.0-pre.34 → 5.0.0-pre.35

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.0.0-pre.35](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.34...v5.0.0-pre.35) (2023-01-12)
+
+### Features
+
+- **generators:** Move core code generators to shared generators package ([#2982](https://github.com/feathersjs/feathers/issues/2982)) ([0328d22](https://github.com/feathersjs/feathers/commit/0328d2292153870bc43958f73d2c6f288a8cec17))
+- **schema:** Allow to add additional operators to the query syntax ([#2941](https://github.com/feathersjs/feathers/issues/2941)) ([f324940](https://github.com/feathersjs/feathers/commit/f324940d5795b41e8c6fc113defb0beb7ab03a0a))
+
 # [5.0.0-pre.34](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.33...v5.0.0-pre.34) (2022-12-14)
 
 ### Bug Fixes

package/lib/json-schema.d.ts

@@ -29,7 +29,7 @@ export declare const getValidator: <T = any, R = T>(schema: JSONSchemaDefinition
  * @returns A map of validator functions
  */
 export declare const getDataValidator: (def: JSONSchemaDefinition | DataSchemaMap, validator: Ajv) => DataValidatorMap;
-export type PropertyQuery<D extends JSONSchema> = {
+export type PropertyQuery<D extends JSONSchema, X> = {
     anyOf: [
         D,
         {
@@ -49,7 +49,7 @@ export type PropertyQuery<D extends JSONSchema> = {
                     type: 'array';
                     items: D;
                 };
-            };
+            } & X;
         }
     ];
 };
@@ -57,9 +57,12 @@ export type PropertyQuery<D extends JSONSchema> = {
  * Create a Feathers query syntax compatible JSON schema definition for a property definition.
  *
  * @param def The property definition (e.g. `{ type: 'string' }`)
+ * @param extensions Additional properties to add to the query property schema
  * @returns A JSON schema definition for the Feathers query syntax for this property.
  */
-export declare const queryProperty: <T extends import("json-schema-to-ts").JSONSchema7>(def: T) => {
+export declare const queryProperty: <T extends import("json-schema-to-ts").JSONSchema7, X extends {
+    [key: string]: import("json-schema-to-ts").JSONSchema7;
+}>(def: T, extensions?: X) => {
     readonly anyOf: readonly [any, {
         readonly type: "object";
         readonly additionalProperties: false;
@@ -77,29 +80,34 @@ export declare const queryProperty: <T extends import("json-schema-to-ts").JSONS
                 readonly type: "array";
                 readonly items: any;
             };
-        };
+        } & X;
     }];
 };
-export declare const SUPPORTED_TYPES: string[];
 /**
  * Creates Feathers a query syntax compatible JSON schema for multiple properties.
  *
  * @param definitions A map of property definitions
+ * @param extensions Additional properties to add to the query property schema
  * @returns The JSON schema definition for the Feathers query syntax for multiple properties
  */
 export declare const queryProperties: <T extends {
     [key: string]: import("json-schema-to-ts").JSONSchema7;
-}>(definitions: T) => { [K in keyof T]: PropertyQuery<T[K]>; };
+}, X extends { [K in keyof T]?: {
+    [key: string]: import("json-schema-to-ts").JSONSchema7;
+}; }>(definitions: T, extensions?: X) => { [K_1 in keyof T]: PropertyQuery<T[K_1], X[K_1]>; };
 /**
  * Creates a JSON schema for the complete Feathers query syntax including `$limit`, $skip`
  * and `$sort` and `$select` for the allowed properties.
  *
  * @param definition The property definitions to create the query syntax schema for
+ * @param extensions Additional properties to add to the query property schema
  * @returns A JSON schema for the complete query syntax
  */
 export declare const querySyntax: <T extends {
     [key: string]: import("json-schema-to-ts").JSONSchema7;
-}>(definition: T) => {
+}, X extends { [K in keyof T]?: {
+    [key: string]: import("json-schema-to-ts").JSONSchema7;
+}; }>(definition: T, extensions?: X) => {
     readonly $limit: {
         readonly type: "number";
         readonly minimum: 0;
@@ -110,7 +118,7 @@ export declare const querySyntax: <T extends {
     };
     readonly $sort: {
         readonly type: "object";
-        readonly properties: { [K in keyof T]: {
+        readonly properties: { [K_1 in keyof T]: {
             readonly type: 'number';
             readonly enum: [1, -1];
         }; };
@@ -128,7 +136,7 @@ export declare const querySyntax: <T extends {
         readonly items: {
             readonly type: "object";
             readonly additionalProperties: false;
-            readonly properties: { [K_1 in keyof T]: PropertyQuery<T[K_1]>; };
+            readonly properties: { [K_2 in keyof T]: PropertyQuery<T[K_2], X[K_2]>; };
         };
     };
-} & { [K_1 in keyof T]: PropertyQuery<T[K_1]>; };
+} & { [K_2 in keyof T]: PropertyQuery<T[K_2], X[K_2]>; };

package/lib/json-schema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.querySyntax = exports.queryProperties = exports.SUPPORTED_TYPES = exports.queryProperty = exports.getDataValidator = exports.getValidator = void 0;
+exports.querySyntax = exports.queryProperties = exports.queryProperty = exports.getDataValidator = exports.getValidator = void 0;
 const commons_1 = require("@feathersjs/commons");
 /**
  * Returns a compiled validation function for a schema and AJV validator instance.
@@ -44,9 +44,10 @@ exports.getDataValidator = getDataValidator;
  * Create a Feathers query syntax compatible JSON schema definition for a property definition.
  *
  * @param def The property definition (e.g. `{ type: 'string' }`)
+ * @param extensions Additional properties to add to the query property schema
  * @returns A JSON schema definition for the Feathers query syntax for this property.
  */
-const queryProperty = (def) => {
+const queryProperty = (def, extensions = {}) => {
     const definition = commons_1._.omit(def, 'default');
     return {
         anyOf: [
@@ -67,28 +68,29 @@ const queryProperty = (def) => {
                     $nin: {
                         type: 'array',
                         items: definition
-                    }
+                    },
+                    ...extensions
                 }
             }
         ]
     };
 };
 exports.queryProperty = queryProperty;
-exports.SUPPORTED_TYPES = ['string', 'number', 'integer', 'boolean', 'null'];
 /**
  * Creates Feathers a query syntax compatible JSON schema for multiple properties.
  *
  * @param definitions A map of property definitions
+ * @param extensions Additional properties to add to the query property schema
  * @returns The JSON schema definition for the Feathers query syntax for multiple properties
  */
-const queryProperties = (definitions) => Object.keys(definitions).reduce((res, key) => {
+const queryProperties = (definitions, extensions = {}) => Object.keys(definitions).reduce((res, key) => {
     const result = res;
     const definition = definitions[key];
-    const { type, $ref } = definition;
-    if ($ref || !exports.SUPPORTED_TYPES.includes(type)) {
-        throw new Error(`Can not create query syntax schema for property '${key}'. Only types ${exports.SUPPORTED_TYPES.join(', ')} are allowed.`);
+    const { $ref } = definition;
+    if ($ref) {
+        throw new Error(`Can not create query syntax schema for reference property '${key}'`);
     }
-    result[key] = (0, exports.queryProperty)(definition);
+    result[key] = (0, exports.queryProperty)(definition, extensions[key]);
     return result;
 }, {});
 exports.queryProperties = queryProperties;
@@ -97,11 +99,12 @@ exports.queryProperties = queryProperties;
  * and `$sort` and `$select` for the allowed properties.
  *
  * @param definition The property definitions to create the query syntax schema for
+ * @param extensions Additional properties to add to the query property schema
  * @returns A JSON schema for the complete query syntax
  */
-const querySyntax = (definition) => {
+const querySyntax = (definition, extensions = {}) => {
     const keys = Object.keys(definition);
-    const props = (0, exports.queryProperties)(definition);
+    const props = (0, exports.queryProperties)(definition, extensions);
     return {
         $limit: {
             type: 'number',

package/lib/json-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"json-schema.js","sourceRoot":"","sources":["../src/json-schema.ts"],"names":[],"mappings":";;;AAAA,iDAAuC;AAgBvC;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,CAAiB,MAA4B,EAAE,SAAc,EAAmB,EAAE,CAC5G,SAAS,CAAC,OAAO,CAAC;IAChB,MAAM,EAAE,IAAI;IACZ,GAAI,MAAc;CACnB,CAA2B,CAAA;AAJjB,QAAA,YAAY,gBAIK;AAE9B;;;;;;;;;GASG;AACI,MAAM,gBAAgB,GAAG,CAC9B,GAAyC,EACzC,SAAc,EACI,EAAE;IACpB,MAAM,MAAM,GAAG,CAAE,GAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAkB,CAAA;IAE7E,OAAO;QACL,MAAM,EAAE,IAAA,oBAAY,EAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;QAC9C,MAAM,EAAE,IAAA,oBAAY,EAClB,MAAM,CAAC,MAAM,IAAI;YACf,GAAI,MAAM,CAAC,MAAc;YACzB,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ;SAClC,EACD,SAAS,CACV;QACD,KAAK,EAAE,IAAA,oBAAY,EACjB,MAAM,CAAC,KAAK,IAAI;YACd,GAAI,MAAM,CAAC,MAAc;YACzB,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO;YAChC,QAAQ,EAAE,EAAE;SACb,EACD,SAAS,CACV;KACF,CAAA;AACH,CAAC,CAAA;AAxBY,QAAA,gBAAgB,oBAwB5B;AA2BD;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAuB,GAAM,EAAE,EAAE;IAC5D,MAAM,UAAU,GAAG,WAAC,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;IACzC,OAAO;QACL,KAAK,EAAE;YACL,UAAU;YACV;gBACE,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,KAAK;gBAC3B,UAAU,EAAE;oBACV,GAAG,EAAE,UAAU;oBACf,IAAI,EAAE,UAAU;oBAChB,GAAG,EAAE,UAAU;oBACf,IAAI,EAAE,UAAU;oBAChB,GAAG,EAAE,UAAU;oBACf,GAAG,EAAE;wBACH,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,UAAU;qBAClB;oBACD,IAAI,EAAE;wBACJ,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,UAAU;qBAClB;iBACF;aACF;SACF;KACO,CAAA;AACZ,CAAC,CAAA;AA1BY,QAAA,aAAa,iBA0BzB;AAEY,QAAA,eAAe,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;AAEjF;;;;;GAKG;AACI,MAAM,eAAe,GAAG,CAA0C,WAAc,EAAE,EAAE,CACzF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,GAAU,CAAA;IACzB,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IACnC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,UAAiB,CAAA;IAExC,IAAI,IAAI,IAAI,CAAC,uBAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QAC3C,MAAM,IAAI,KAAK,CACb,oDAAoD,GAAG,iBAAiB,uBAAe,CAAC,IAAI,CAC1F,IAAI,CACL,eAAe,CACjB,CAAA;KACF;IAED,MAAM,CAAC,GAAG,CAAC,GAAG,IAAA,qBAAa,EAAC,UAAU,CAAC,CAAA;IAEvC,OAAO,MAAM,CAAA;AACf,CAAC,EAAE,EAA6C,CAAC,CAAA;AAjBtC,QAAA,eAAe,mBAiBuB;AAEnD;;;;;;GAMG;AACI,MAAM,WAAW,GAAG,CAA0C,UAAa,EAAE,EAAE;IACpF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACpC,MAAM,KAAK,GAAG,IAAA,uBAAe,EAAC,UAAU,CAAC,CAAA;IAEzC,OAAO;QACL,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;SACX;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;SACX;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACnC,MAAM,MAAM,GAAG,GAAU,CAAA;gBAEzB,MAAM,CAAC,GAAG,CAAC,GAAG;oBACZ,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;iBACd,CAAA;gBAED,OAAO,MAAM,CAAA;YACf,CAAC,EAAE,EAA6E,CAAC;SAClF;QACD,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,IAAI,CAAC,MAAM;YACrB,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAA0B,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACjE;SACF;QACD,GAAG,EAAE;YACH,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,KAAK;gBAC3B,UAAU,EAAE,KAAK;aAClB;SACF;QACD,GAAG,KAAK;KACA,CAAA;AACZ,CAAC,CAAA;AA5CY,QAAA,WAAW,eA4CvB"}
+{"version":3,"file":"json-schema.js","sourceRoot":"","sources":["../src/json-schema.ts"],"names":[],"mappings":";;;AAAA,iDAAuC;AAgBvC;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,CAAiB,MAA4B,EAAE,SAAc,EAAmB,EAAE,CAC5G,SAAS,CAAC,OAAO,CAAC;IAChB,MAAM,EAAE,IAAI;IACZ,GAAI,MAAc;CACnB,CAA2B,CAAA;AAJjB,QAAA,YAAY,gBAIK;AAE9B;;;;;;;;;GASG;AACI,MAAM,gBAAgB,GAAG,CAC9B,GAAyC,EACzC,SAAc,EACI,EAAE;IACpB,MAAM,MAAM,GAAG,CAAE,GAAW,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAkB,CAAA;IAE7E,OAAO;QACL,MAAM,EAAE,IAAA,oBAAY,EAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC;QAC9C,MAAM,EAAE,IAAA,oBAAY,EAClB,MAAM,CAAC,MAAM,IAAI;YACf,GAAI,MAAM,CAAC,MAAc;YACzB,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ;SAClC,EACD,SAAS,CACV;QACD,KAAK,EAAE,IAAA,oBAAY,EACjB,MAAM,CAAC,KAAK,IAAI;YACd,GAAI,MAAM,CAAC,MAAc;YACzB,GAAG,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO;YAChC,QAAQ,EAAE,EAAE;SACb,EACD,SAAS,CACV;KACF,CAAA;AACH,CAAC,CAAA;AAxBY,QAAA,gBAAgB,oBAwB5B;AA2BD;;;;;;GAMG;AACI,MAAM,aAAa,GAAG,CAC3B,GAAM,EACN,aAAgB,EAAO,EACvB,EAAE;IACF,MAAM,UAAU,GAAG,WAAC,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;IACzC,OAAO;QACL,KAAK,EAAE;YACL,UAAU;YACV;gBACE,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,KAAK;gBAC3B,UAAU,EAAE;oBACV,GAAG,EAAE,UAAU;oBACf,IAAI,EAAE,UAAU;oBAChB,GAAG,EAAE,UAAU;oBACf,IAAI,EAAE,UAAU;oBAChB,GAAG,EAAE,UAAU;oBACf,GAAG,EAAE;wBACH,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,UAAU;qBAClB;oBACD,IAAI,EAAE;wBACJ,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,UAAU;qBAClB;oBACD,GAAG,UAAU;iBACd;aACF;SACF;KACO,CAAA;AACZ,CAAC,CAAA;AA9BY,QAAA,aAAa,iBA8BzB;AAED;;;;;;GAMG;AACI,MAAM,eAAe,GAAG,CAI7B,WAAc,EACd,aAAgB,EAAO,EACvB,EAAE,CACF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,GAAU,CAAA;IACzB,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IACnC,MAAM,EAAE,IAAI,EAAE,GAAG,UAAiB,CAAA;IAElC,IAAI,IAAI,EAAE;QACR,MAAM,IAAI,KAAK,CAAC,8DAA8D,GAAG,GAAG,CAAC,CAAA;KACtF;IAED,MAAM,CAAC,GAAG,CAAC,GAAG,IAAA,qBAAa,EAAC,UAAkC,EAAE,UAAU,CAAC,GAAc,CAAC,CAAC,CAAA;IAE3F,OAAO,MAAM,CAAA;AACf,CAAC,EAAE,EAAmD,CAAC,CAAA;AAnB5C,QAAA,eAAe,mBAmB6B;AAEzD;;;;;;;GAOG;AACI,MAAM,WAAW,GAAG,CAIzB,UAAa,EACb,aAAgB,EAAO,EACvB,EAAE;IACF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACpC,MAAM,KAAK,GAAG,IAAA,uBAAe,EAAC,UAAU,EAAE,UAAU,CAAC,CAAA;IAErD,OAAO;QACL,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;SACX;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;SACX;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBACnC,MAAM,MAAM,GAAG,GAAU,CAAA;gBAEzB,MAAM,CAAC,GAAG,CAAC,GAAG;oBACZ,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;iBACd,CAAA;gBAED,OAAO,MAAM,CAAA;YACf,CAAC,EAAE,EAA6E,CAAC;SAClF;QACD,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,IAAI,CAAC,MAAM;YACrB,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAA0B,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACjE;SACF;QACD,GAAG,EAAE;YACH,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,KAAK;gBAC3B,UAAU,EAAE,KAAK;aAClB;SACF;QACD,GAAG,KAAK;KACA,CAAA;AACZ,CAAC,CAAA;AAlDY,QAAA,WAAW,eAkDvB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@feathersjs/schema",
   "description": "A common data schema definition format",
-  "version": "5.0.0-pre.34",
+  "version": "5.0.0-pre.35",
   "homepage": "https://feathersjs.com",
   "main": "lib/",
   "types": "lib/",
@@ -42,7 +42,7 @@
   ],
   "scripts": {
     "prepublish": "npm run compile",
-    "pack": "npm pack --pack-destination ../cli/test/build",
+    "pack": "npm pack --pack-destination ../generators/test/build",
     "compile": "shx rm -rf lib/ && tsc && npm run pack",
     "mocha": "mocha --config ../../.mocharc.json --recursive test/**.test.ts test/**/*.test.ts",
     "test": "npm run compile && npm run mocha"
@@ -54,24 +54,24 @@
     "access": "public"
   },
   "dependencies": {
-    "@feathersjs/adapter-commons": "^5.0.0-pre.34",
-    "@feathersjs/commons": "^5.0.0-pre.34",
-    "@feathersjs/errors": "^5.0.0-pre.34",
-    "@feathersjs/feathers": "^5.0.0-pre.34",
+    "@feathersjs/adapter-commons": "^5.0.0-pre.35",
+    "@feathersjs/commons": "^5.0.0-pre.35",
+    "@feathersjs/errors": "^5.0.0-pre.35",
+    "@feathersjs/feathers": "^5.0.0-pre.35",
     "@feathersjs/hooks": "^0.7.6",
     "@types/json-schema": "^7.0.11",
     "ajv": "^8.11.2",
     "ajv-formats": "^2.1.1",
-    "json-schema-to-ts": "^2.6.1"
+    "json-schema-to-ts": "^2.6.2"
   },
   "devDependencies": {
-    "@feathersjs/memory": "^5.0.0-pre.34",
+    "@feathersjs/memory": "^5.0.0-pre.35",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.11.10",
+    "@types/node": "^18.11.18",
     "ajv-formats": "^2.1.1",
-    "mocha": "^10.1.0",
+    "mocha": "^10.2.0",
     "shx": "^0.3.4",
-    "typescript": "^4.9.3"
+    "typescript": "^4.9.4"
   },
-  "gitHead": "42cca600d00f0b3b9d89fa79be30fcd46bc50132"
+  "gitHead": "c641598d9a4de3ceda10f56cf2af288a4236b15e"
 }

package/src/json-schema.ts

@@ -63,7 +63,7 @@ export const getDataValidator = (
   }
 }
 
-export type PropertyQuery<D extends JSONSchema> = {
+export type PropertyQuery<D extends JSONSchema, X> = {
   anyOf: [
     D,
     {
@@ -83,7 +83,7 @@ export type PropertyQuery<D extends JSONSchema> = {
           type: 'array'
           items: D
         }
-      }
+      } & X
     }
   ]
 }
@@ -92,9 +92,13 @@ export type PropertyQuery<D extends JSONSchema> = {
  * Create a Feathers query syntax compatible JSON schema definition for a property definition.
  *
  * @param def The property definition (e.g. `{ type: 'string' }`)
+ * @param extensions Additional properties to add to the query property schema
  * @returns A JSON schema definition for the Feathers query syntax for this property.
  */
-export const queryProperty = <T extends JSONSchema>(def: T) => {
+export const queryProperty = <T extends JSONSchema, X extends { [key: string]: JSONSchema }>(
+  def: T,
+  extensions: X = {} as X
+) => {
   const definition = _.omit(def, 'default')
   return {
     anyOf: [
@@ -115,50 +119,59 @@ export const queryProperty = <T extends JSONSchema>(def: T) => {
           $nin: {
             type: 'array',
             items: definition
-          }
+          },
+          ...extensions
         }
       }
     ]
   } as const
 }
 
-export const SUPPORTED_TYPES = ['string', 'number', 'integer', 'boolean', 'null']
-
 /**
  * Creates Feathers a query syntax compatible JSON schema for multiple properties.
  *
  * @param definitions A map of property definitions
+ * @param extensions Additional properties to add to the query property schema
  * @returns The JSON schema definition for the Feathers query syntax for multiple properties
  */
-export const queryProperties = <T extends { [key: string]: JSONSchema }>(definitions: T) =>
+export const queryProperties = <
+  T extends { [key: string]: JSONSchema },
+  X extends { [K in keyof T]?: { [key: string]: JSONSchema } }
+>(
+  definitions: T,
+  extensions: X = {} as X
+) =>
   Object.keys(definitions).reduce((res, key) => {
     const result = res as any
     const definition = definitions[key]
-    const { type, $ref } = definition as any
+    const { $ref } = definition as any
 
-    if ($ref || !SUPPORTED_TYPES.includes(type)) {
-      throw new Error(
-        `Can not create query syntax schema for property '${key}'. Only types ${SUPPORTED_TYPES.join(
-          ', '
-        )} are allowed.`
-      )
+    if ($ref) {
+      throw new Error(`Can not create query syntax schema for reference property '${key}'`)
     }
 
-    result[key] = queryProperty(definition)
+    result[key] = queryProperty(definition as JSONSchemaDefinition, extensions[key as keyof T])
 
     return result
-  }, {} as { [K in keyof T]: PropertyQuery<T[K]> })
+  }, {} as { [K in keyof T]: PropertyQuery<T[K], X[K]> })
 
 /**
  * Creates a JSON schema for the complete Feathers query syntax including `$limit`, $skip`
  * and `$sort` and `$select` for the allowed properties.
  *
  * @param definition The property definitions to create the query syntax schema for
+ * @param extensions Additional properties to add to the query property schema
  * @returns A JSON schema for the complete query syntax
  */
-export const querySyntax = <T extends { [key: string]: JSONSchema }>(definition: T) => {
+export const querySyntax = <
+  T extends { [key: string]: JSONSchema },
+  X extends { [K in keyof T]?: { [key: string]: JSONSchema } }
+>(
+  definition: T,
+  extensions: X = {} as X
+) => {
   const keys = Object.keys(definition)
-  const props = queryProperties(definition)
+  const props = queryProperties(definition, extensions)
 
   return {
     $limit: {