@feathersjs/typebox 5.0.0-pre.33 → 5.0.0-pre.34

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.34](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.33...v5.0.0-pre.34) (2022-12-14)
+
+### Bug Fixes
+
+- **schema:** Allow query schemas with no properties, error on unsupported types ([#2904](https://github.com/feathersjs/feathers/issues/2904)) ([b66c734](https://github.com/feathersjs/feathers/commit/b66c734357478f51b2d38fa7f3eee08640cea26e))
+- **typebox:** Improve query syntax defaults ([#2888](https://github.com/feathersjs/feathers/issues/2888)) ([59f3cdc](https://github.com/feathersjs/feathers/commit/59f3cdca6376e34fe39a7b91db837d0325aeb5db))
+
 # [5.0.0-pre.33](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.32...v5.0.0-pre.33) (2022-11-08)
 
 ### Features

package/lib/default-schemas.d.ts

@@ -85,4 +85,4 @@ export declare const defaultAppConfiguration: import("@sinclair/typebox").TObjec
         connection: import("@sinclair/typebox").TString<string>;
     }>>;
 }>;
-export declare type DefaultAppConfiguration = Static<typeof defaultAppConfiguration>;
+export type DefaultAppConfiguration = Static<typeof defaultAppConfiguration>;

package/lib/index.d.ts

@@ -1,8 +1,8 @@
-import { TObject, TInteger, TOptional, TSchema, TIntersect } from '@sinclair/typebox';
+import { TObject, TInteger, TOptional, TSchema, TIntersect, ObjectOptions } from '@sinclair/typebox';
 import { Validator, DataValidatorMap, Ajv } from '@feathersjs/schema';
 export * from '@sinclair/typebox';
 export * from './default-schemas';
-export declare type TDataSchemaMap = {
+export type TDataSchemaMap = {
     create: TObject;
     update?: TObject;
     patch?: TObject;
@@ -32,43 +32,81 @@ export declare const getDataValidator: (def: TObject | TDataSchemaMap, validator
  * @returns TypeBox.Type
  */
 export declare function StringEnum<T extends string[]>(allowedValues: [...T]): import("@sinclair/typebox").TUnsafe<T[number]>;
+/**
+ * Creates the `$sort` Feathers query syntax schema for an object schema
+ *
+ * @param schema The TypeBox object schema
+ * @returns The `$sort` syntax schema
+ */
 export declare function sortDefinition<T extends TObject>(schema: T): TObject<T["properties"] extends infer T_1 ? { [K in keyof T_1]: TOptional<TInteger>; } : never>;
-export declare const queryProperty: <T extends TSchema>(def: T) => TOptional<import("@sinclair/typebox").TUnion<[T, TObject<{
-    $gt: TOptional<T>;
-    $gte: TOptional<T>;
-    $lt: TOptional<T>;
-    $lte: TOptional<T>;
-    $ne: TOptional<T>;
-    $in: TOptional<import("@sinclair/typebox").TArray<T>>;
-    $nin: TOptional<import("@sinclair/typebox").TArray<T>>;
-}>]>>;
-export declare const queryProperties: <T extends TObject<import("@sinclair/typebox").TProperties>>(type: T) => TObject<T["properties"] extends infer T_1 ? { [K in keyof T_1]: TOptional<import("@sinclair/typebox").TUnion<[T["properties"][K], TObject<{
-    $gt: TOptional<T["properties"][K]>;
-    $gte: TOptional<T["properties"][K]>;
-    $lt: TOptional<T["properties"][K]>;
-    $lte: TOptional<T["properties"][K]>;
-    $ne: TOptional<T["properties"][K]>;
-    $in: TOptional<import("@sinclair/typebox").TArray<T["properties"][K]>>;
-    $nin: TOptional<import("@sinclair/typebox").TArray<T["properties"][K]>>;
-}>]>>; } : never>;
 /**
- * Creates a TypeBox schema for the complete Feathers query syntax including `$limit`, $skip`
+ * Returns the standard Feathers query syntax for a property schema,
+ * including operators like `$gt`, `$lt` etc. for a single property
+ *
+ * @param def The property definition
+ * @returns The Feathers query syntax schema
+ */
+export declare const queryProperty: <T extends TSchema>(def: T) => TOptional<import("@sinclair/typebox").TUnion<[T, import("@sinclair/typebox").TPartial<TObject<{
+    $gt: T;
+    $gte: T;
+    $lt: T;
+    $lte: T;
+    $ne: T;
+    $in: import("@sinclair/typebox").TArray<T>;
+    $nin: import("@sinclair/typebox").TArray<T>;
+}>>]>>;
+/**
+ * Creates a Feathers query syntax schema for the properties defined in `definition`.
+ *
+ * @param definition The properties to create the Feathers query syntax schema for
+ * @returns The Feathers query syntax schema
+ */
+export declare const queryProperties: <T extends TObject<import("@sinclair/typebox").TProperties>>(definition: T) => TOptional<TObject<T["properties"] extends infer T_1 ? { [K in keyof T_1]: TOptional<import("@sinclair/typebox").TUnion<[T["properties"][K], import("@sinclair/typebox").TPartial<TObject<{
+    $gt: T["properties"][K];
+    $gte: T["properties"][K];
+    $lt: T["properties"][K];
+    $lte: T["properties"][K];
+    $ne: T["properties"][K];
+    $in: import("@sinclair/typebox").TArray<T["properties"][K]>;
+    $nin: import("@sinclair/typebox").TArray<T["properties"][K]>;
+}>>]>>; } : never>>;
+/**
+ * Creates a TypeBox schema for the complete Feathers query syntax including `$limit`, $skip`, `$or`
  * and `$sort` and `$select` for the allowed properties.
  *
  * @param type The properties to create the query syntax for
+ * @param options Options for the TypeBox object schema
  * @returns A TypeBox object representing the complete Feathers query syntax for the given properties
  */
-export declare const querySyntax: <T extends TObject<import("@sinclair/typebox").TProperties> | TIntersect<TObject<import("@sinclair/typebox").TProperties>[]>>(type: T) => TIntersect<[TObject<{
-    $limit: TOptional<import("@sinclair/typebox").TNumber>;
-    $skip: TOptional<import("@sinclair/typebox").TNumber>;
-    $sort: TOptional<TObject<T["properties"] extends infer T_1 ? { [K in keyof T_1]: TOptional<TInteger>; } : never>>;
-    $select: TOptional<import("@sinclair/typebox").TUnsafe<(keyof T["properties"])[]>>;
-}>, TObject<T["properties"] extends infer T_2 ? { [K_1 in keyof T_2]: TOptional<import("@sinclair/typebox").TUnion<[T["properties"][K_1], TObject<{
-    $gt: TOptional<T["properties"][K_1]>;
-    $gte: TOptional<T["properties"][K_1]>;
-    $lt: TOptional<T["properties"][K_1]>;
-    $lte: TOptional<T["properties"][K_1]>;
-    $ne: TOptional<T["properties"][K_1]>;
-    $in: TOptional<import("@sinclair/typebox").TArray<T["properties"][K_1]>>;
-    $nin: TOptional<import("@sinclair/typebox").TArray<T["properties"][K_1]>>;
-}>]>>; } : never>]>;
+export declare const querySyntax: <T extends TObject<import("@sinclair/typebox").TProperties> | TIntersect<TObject<import("@sinclair/typebox").TProperties>[]>>(type: T, options?: ObjectOptions) => TIntersect<[import("@sinclair/typebox").TPartial<TObject<{
+    $limit: import("@sinclair/typebox").TNumber;
+    $skip: import("@sinclair/typebox").TNumber;
+    $sort: TObject<T["properties"] extends infer T_1 ? { [K in keyof T_1]: TOptional<TInteger>; } : never>;
+    $select: import("@sinclair/typebox").TUnsafe<(keyof T["properties"])[]>;
+    $or: import("@sinclair/typebox").TArray<TOptional<TObject<T["properties"] extends infer T_2 ? { [K_1 in keyof T_2]: TOptional<import("@sinclair/typebox").TUnion<[T["properties"][K_1], import("@sinclair/typebox").TPartial<TObject<{
+        $gt: T["properties"][K_1];
+        $gte: T["properties"][K_1];
+        $lt: T["properties"][K_1];
+        $lte: T["properties"][K_1];
+        $ne: T["properties"][K_1];
+        $in: import("@sinclair/typebox").TArray<T["properties"][K_1]>;
+        $nin: import("@sinclair/typebox").TArray<T["properties"][K_1]>;
+    }>>]>>; } : never>>>;
+    $and: import("@sinclair/typebox").TArray<TOptional<TObject<T["properties"] extends infer T_2 ? { [K_1 in keyof T_2]: TOptional<import("@sinclair/typebox").TUnion<[T["properties"][K_1], import("@sinclair/typebox").TPartial<TObject<{
+        $gt: T["properties"][K_1];
+        $gte: T["properties"][K_1];
+        $lt: T["properties"][K_1];
+        $lte: T["properties"][K_1];
+        $ne: T["properties"][K_1];
+        $in: import("@sinclair/typebox").TArray<T["properties"][K_1]>;
+        $nin: import("@sinclair/typebox").TArray<T["properties"][K_1]>;
+    }>>]>>; } : never>>>;
+}>>, TOptional<TObject<T["properties"] extends infer T_3 ? { [K_1 in keyof T_3]: TOptional<import("@sinclair/typebox").TUnion<[T["properties"][K_1], import("@sinclair/typebox").TPartial<TObject<{
+    $gt: T["properties"][K_1];
+    $gte: T["properties"][K_1];
+    $lt: T["properties"][K_1];
+    $lte: T["properties"][K_1];
+    $ne: T["properties"][K_1];
+    $in: import("@sinclair/typebox").TArray<T["properties"][K_1]>;
+    $nin: import("@sinclair/typebox").TArray<T["properties"][K_1]>;
+}>>]>>; } : never>>]>;

package/lib/index.js

@@ -40,10 +40,6 @@ exports.getValidator = getValidator;
  */
 const getDataValidator = (def, validator) => schema_1.jsonSchema.getDataValidator(def, validator);
 exports.getDataValidator = getDataValidator;
-const arrayOfKeys = (type) => {
-    const keys = Object.keys(type.properties);
-    return typebox_1.Type.Unsafe({ type: 'array', items: { type: 'string', enum: keys } });
-};
 /**
  * A TypeBox utility that converts an array of provided strings into a string enum.
  * @param allowedValues array of strings for the enum
@@ -53,64 +49,92 @@ function StringEnum(allowedValues) {
     return typebox_1.Type.Unsafe({ type: 'string', enum: allowedValues });
 }
 exports.StringEnum = StringEnum;
+const arrayOfKeys = (type) => {
+    const keys = Object.keys(type.properties);
+    return typebox_1.Type.Unsafe({
+        type: 'array',
+        maxItems: keys.length,
+        items: {
+            type: 'string',
+            ...(keys.length > 0 ? { enum: keys } : {})
+        }
+    });
+};
+/**
+ * Creates the `$sort` Feathers query syntax schema for an object schema
+ *
+ * @param schema The TypeBox object schema
+ * @returns The `$sort` syntax schema
+ */
 function sortDefinition(schema) {
     const properties = Object.keys(schema.properties).reduce((res, key) => {
         const result = res;
         result[key] = typebox_1.Type.Optional(typebox_1.Type.Integer({ minimum: -1, maximum: 1 }));
         return result;
     }, {});
-    return {
-        type: 'object',
-        additionalProperties: false,
-        properties
-    };
+    return typebox_1.Type.Object(properties, { additionalProperties: false });
 }
 exports.sortDefinition = sortDefinition;
-const queryProperty = (def) => {
-    return typebox_1.Type.Optional(typebox_1.Type.Union([
-        def,
-        typebox_1.Type.Object({
-            $gt: typebox_1.Type.Optional(def),
-            $gte: typebox_1.Type.Optional(def),
-            $lt: typebox_1.Type.Optional(def),
-            $lte: typebox_1.Type.Optional(def),
-            $ne: typebox_1.Type.Optional(def),
-            $in: typebox_1.Type.Optional(typebox_1.Type.Array(def)),
-            $nin: typebox_1.Type.Optional(typebox_1.Type.Array(def))
-        })
-    ]));
-};
+/**
+ * Returns the standard Feathers query syntax for a property schema,
+ * including operators like `$gt`, `$lt` etc. for a single property
+ *
+ * @param def The property definition
+ * @returns The Feathers query syntax schema
+ */
+const queryProperty = (def) => typebox_1.Type.Optional(typebox_1.Type.Union([
+    def,
+    typebox_1.Type.Partial(typebox_1.Type.Object({
+        $gt: def,
+        $gte: def,
+        $lt: def,
+        $lte: def,
+        $ne: def,
+        $in: typebox_1.Type.Array(def),
+        $nin: typebox_1.Type.Array(def)
+    }), { additionalProperties: false })
+]));
 exports.queryProperty = queryProperty;
-const queryProperties = (type) => {
-    const properties = Object.keys(type.properties).reduce((res, key) => {
+/**
+ * Creates a Feathers query syntax schema for the properties defined in `definition`.
+ *
+ * @param definition The properties to create the Feathers query syntax schema for
+ * @returns The Feathers query syntax schema
+ */
+const queryProperties = (definition) => {
+    const properties = Object.keys(definition.properties).reduce((res, key) => {
         const result = res;
-        result[key] = (0, exports.queryProperty)(type.properties[key]);
+        const value = definition.properties[key];
+        if (value.$ref || !schema_1.SUPPORTED_TYPES.includes(value.type)) {
+            throw new Error(`Can not create query syntax schema for property '${key}'. Only types ${schema_1.SUPPORTED_TYPES.join(', ')} are allowed.`);
+        }
+        result[key] = (0, exports.queryProperty)(value);
         return result;
     }, {});
-    return {
-        type: 'object',
-        additionalProperties: false,
-        properties
-    };
+    return typebox_1.Type.Optional(typebox_1.Type.Object(properties, { additionalProperties: false }));
 };
 exports.queryProperties = queryProperties;
 /**
- * Creates a TypeBox schema for the complete Feathers query syntax including `$limit`, $skip`
+ * Creates a TypeBox schema for the complete Feathers query syntax including `$limit`, $skip`, `$or`
  * and `$sort` and `$select` for the allowed properties.
  *
  * @param type The properties to create the query syntax for
+ * @param options Options for the TypeBox object schema
  * @returns A TypeBox object representing the complete Feathers query syntax for the given properties
  */
-const querySyntax = (type) => {
+const querySyntax = (type, options = { additionalProperties: false }) => {
+    const propertySchema = (0, exports.queryProperties)(type);
     return typebox_1.Type.Intersect([
-        typebox_1.Type.Object({
-            $limit: typebox_1.Type.Optional(typebox_1.Type.Number({ minimum: 0 })),
-            $skip: typebox_1.Type.Optional(typebox_1.Type.Number({ minimum: 0 })),
-            $sort: typebox_1.Type.Optional(sortDefinition(type)),
-            $select: typebox_1.Type.Optional(arrayOfKeys(type))
-        }, { additionalProperties: false }),
-        (0, exports.queryProperties)(type)
-    ]);
+        typebox_1.Type.Partial(typebox_1.Type.Object({
+            $limit: typebox_1.Type.Number({ minimum: 0 }),
+            $skip: typebox_1.Type.Number({ minimum: 0 }),
+            $sort: sortDefinition(type),
+            $select: arrayOfKeys(type),
+            $or: typebox_1.Type.Array(propertySchema),
+            $and: typebox_1.Type.Array(propertySchema)
+        }, { additionalProperties: false })),
+        propertySchema
+    ], options);
 };
 exports.querySyntax = querySyntax;
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+CAA2F;AAC3F,+CAAiF;AAEjF,oDAAiC;AACjC,oDAAiC;AAQjC;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,CAAiB,MAAe,EAAE,SAAc,EAAmB,EAAE,CAC/F,mBAAU,CAAC,YAAY,CAAC,MAAa,EAAE,SAAS,CAAC,CAAA;AADtC,QAAA,YAAY,gBAC0B;AAEnD;;;;;;;;;GASG;AACI,MAAM,gBAAgB,GAAG,CAAC,GAA6B,EAAE,SAAc,EAAoB,EAAE,CAClG,mBAAU,CAAC,gBAAgB,CAAC,GAAU,EAAE,SAAS,CAAC,CAAA;AADvC,QAAA,gBAAgB,oBACuB;AAEpD,MAAM,WAAW,GAAG,CAAoB,IAAO,EAAE,EAAE;IACjD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACzC,OAAO,cAAI,CAAC,MAAM,CAA4B,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAA;AACzG,CAAC,CAAA;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAqB,aAAqB;IAClE,OAAO,cAAI,CAAC,MAAM,CAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;AACxE,CAAC;AAFD,gCAEC;AAED,SAAgB,cAAc,CAAoB,MAAS;IACzD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACpE,MAAM,MAAM,GAAG,GAAU,CAAA;QAEzB,MAAM,CAAC,GAAG,CAAC,GAAG,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAEtE,OAAO,MAAM,CAAA;IACf,CAAC,EAAE,EAA2D,CAAC,CAAA;IAE/D,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,oBAAoB,EAAE,KAAK;QAC3B,UAAU;KACmB,CAAA;AACjC,CAAC;AAdD,wCAcC;AAEM,MAAM,aAAa,GAAG,CAAoB,GAAM,EAAE,EAAE;IACzD,OAAO,cAAI,CAAC,QAAQ,CAClB,cAAI,CAAC,KAAK,CAAC;QACT,GAAG;QACH,cAAI,CAAC,MAAM,CAAC;YACV,GAAG,EAAE,cAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACxB,GAAG,EAAE,cAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACxB,GAAG,EAAE,cAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YACvB,GAAG,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACrC,CAAC;KACH,CAAC,CACH,CAAA;AACH,CAAC,CAAA;AAfY,QAAA,aAAa,iBAezB;AAIM,MAAM,eAAe,GAAG,CAAoB,IAAO,EAAE,EAAE;IAC5D,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAClE,MAAM,MAAM,GAAG,GAAU,CAAA;QAEzB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAA,qBAAa,EAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;QAEjD,OAAO,MAAM,CAAA;IACf,CAAC,EAAE,EAAyE,CAAC,CAAA;IAE7E,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,oBAAoB,EAAE,KAAK;QAC3B,UAAU;KACmB,CAAA;AACjC,CAAC,CAAA;AAdY,QAAA,eAAe,mBAc3B;AAED;;;;;;GAMG;AACI,MAAM,WAAW,GAAG,CAAiC,IAAO,EAAE,EAAE;IACrE,OAAO,cAAI,CAAC,SAAS,CAAC;QACpB,cAAI,CAAC,MAAM,CACT;YACE,MAAM,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;YAClD,KAAK,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;YACjD,KAAK,EAAE,cAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC1C,OAAO,EAAE,cAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;SAC1C,EACD,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAChC;QACD,IAAA,uBAAe,EAAC,IAAI,CAAC;KACtB,CAAC,CAAA;AACJ,CAAC,CAAA;AAbY,QAAA,WAAW,eAavB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+CAA0G;AAC1G,+CAAkG;AAElG,oDAAiC;AACjC,oDAAiC;AAQjC;;;;;;GAMG;AACI,MAAM,YAAY,GAAG,CAAiB,MAAe,EAAE,SAAc,EAAmB,EAAE,CAC/F,mBAAU,CAAC,YAAY,CAAC,MAAa,EAAE,SAAS,CAAC,CAAA;AADtC,QAAA,YAAY,gBAC0B;AAEnD;;;;;;;;;GASG;AACI,MAAM,gBAAgB,GAAG,CAAC,GAA6B,EAAE,SAAc,EAAoB,EAAE,CAClG,mBAAU,CAAC,gBAAgB,CAAC,GAAU,EAAE,SAAS,CAAC,CAAA;AADvC,QAAA,gBAAgB,oBACuB;AAEpD;;;;GAIG;AACH,SAAgB,UAAU,CAAqB,aAAqB;IAClE,OAAO,cAAI,CAAC,MAAM,CAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAA;AACxE,CAAC;AAFD,gCAEC;AAED,MAAM,WAAW,GAAG,CAAoB,IAAO,EAAE,EAAE;IACjD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACzC,OAAO,cAAI,CAAC,MAAM,CAA4B;QAC5C,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,IAAI,CAAC,MAAM;QACrB,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC3C;KACF,CAAC,CAAA;AACJ,CAAC,CAAA;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAAoB,MAAS;IACzD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACpE,MAAM,MAAM,GAAG,GAAU,CAAA;QAEzB,MAAM,CAAC,GAAG,CAAC,GAAG,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAEtE,OAAO,MAAM,CAAA;IACf,CAAC,EAAE,EAA2D,CAAC,CAAA;IAE/D,OAAO,cAAI,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC,CAAA;AACjE,CAAC;AAVD,wCAUC;AAED;;;;;;GAMG;AACI,MAAM,aAAa,GAAG,CAAoB,GAAM,EAAE,EAAE,CACzD,cAAI,CAAC,QAAQ,CACX,cAAI,CAAC,KAAK,CAAC;IACT,GAAG;IACH,cAAI,CAAC,OAAO,CACV,cAAI,CAAC,MAAM,CAAC;QACV,GAAG,EAAE,GAAG;QACR,IAAI,EAAE,GAAG;QACT,GAAG,EAAE,GAAG;QACR,IAAI,EAAE,GAAG;QACT,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,cAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QACpB,IAAI,EAAE,cAAI,CAAC,KAAK,CAAC,GAAG,CAAC;KACtB,CAAC,EACF,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAChC;CACF,CAAC,CACH,CAAA;AAjBU,QAAA,aAAa,iBAiBvB;AAIH;;;;;GAKG;AACI,MAAM,eAAe,GAAG,CAAoB,UAAa,EAAE,EAAE;IAClE,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACxE,MAAM,MAAM,GAAG,GAAU,CAAA;QACzB,MAAM,KAAK,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QAExC,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,wBAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YACvD,MAAM,IAAI,KAAK,CACb,oDAAoD,GAAG,iBAAiB,wBAAe,CAAC,IAAI,CAC1F,IAAI,CACL,eAAe,CACjB,CAAA;SACF;QAED,MAAM,CAAC,GAAG,CAAC,GAAG,IAAA,qBAAa,EAAC,KAAK,CAAC,CAAA;QAElC,OAAO,MAAM,CAAA;IACf,CAAC,EAAE,EAAyE,CAAC,CAAA;IAE7E,OAAO,cAAI,CAAC,QAAQ,CAAC,cAAI,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;AAChF,CAAC,CAAA;AAnBY,QAAA,eAAe,mBAmB3B;AAED;;;;;;;GAOG;AACI,MAAM,WAAW,GAAG,CACzB,IAAO,EACP,UAAyB,EAAE,oBAAoB,EAAE,KAAK,EAAE,EACxD,EAAE;IACF,MAAM,cAAc,GAAG,IAAA,uBAAe,EAAC,IAAI,CAAC,CAAA;IAE5C,OAAO,cAAI,CAAC,SAAS,CACnB;QACE,cAAI,CAAC,OAAO,CACV,cAAI,CAAC,MAAM,CACT;YACE,MAAM,EAAE,cAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;YACnC,KAAK,EAAE,cAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;YAClC,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC;YAC3B,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC;YAC1B,GAAG,EAAE,cAAI,CAAC,KAAK,CAAC,cAAc,CAAC;YAC/B,IAAI,EAAE,cAAI,CAAC,KAAK,CAAC,cAAc,CAAC;SACjC,EACD,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAChC,CACF;QACD,cAAc;KACf,EACD,OAAO,CACR,CAAA;AACH,CAAC,CAAA;AAzBY,QAAA,WAAW,eAyBvB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@feathersjs/typebox",
   "description": "TypeBox integration for @feathersjs/schema",
-  "version": "5.0.0-pre.33",
+  "version": "5.0.0-pre.34",
   "homepage": "https://feathersjs.com",
   "main": "lib/",
   "types": "lib/",
@@ -54,15 +54,15 @@
     "access": "public"
   },
   "dependencies": {
-    "@feathersjs/schema": "^5.0.0-pre.33",
-    "@sinclair/typebox": "^0.25.2"
+    "@feathersjs/schema": "^5.0.0-pre.34",
+    "@sinclair/typebox": "^0.25.10"
   },
   "devDependencies": {
-    "@types/mocha": "^10.0.0",
-    "@types/node": "^18.11.9",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^18.11.10",
     "mocha": "^10.1.0",
     "shx": "^0.3.4",
-    "typescript": "^4.8.4"
+    "typescript": "^4.9.3"
   },
-  "gitHead": "89f516bcb1457e23a02c6212e9cd8bacc4d267d4"
+  "gitHead": "42cca600d00f0b3b9d89fa79be30fcd46bc50132"
 }

package/src/index.ts

@@ -1,5 +1,5 @@
-import { Type, TObject, TInteger, TOptional, TSchema, TIntersect } from '@sinclair/typebox'
-import { jsonSchema, Validator, DataValidatorMap, Ajv } from '@feathersjs/schema'
+import { Type, TObject, TInteger, TOptional, TSchema, TIntersect, ObjectOptions } from '@sinclair/typebox'
+import { jsonSchema, Validator, DataValidatorMap, Ajv, SUPPORTED_TYPES } from '@feathersjs/schema'
 
 export * from '@sinclair/typebox'
 export * from './default-schemas'
@@ -33,11 +33,6 @@ export const getValidator = <T = any, R = T>(schema: TObject, validator: Ajv): V
 export const getDataValidator = (def: TObject | TDataSchemaMap, validator: Ajv): DataValidatorMap =>
   jsonSchema.getDataValidator(def as any, validator)
 
-const arrayOfKeys = <T extends TObject>(type: T) => {
-  const keys = Object.keys(type.properties)
-  return Type.Unsafe<(keyof T['properties'])[]>({ type: 'array', items: { type: 'string', enum: keys } })
-}
-
 /**
  * A TypeBox utility that converts an array of provided strings into a string enum.
  * @param allowedValues array of strings for the enum
@@ -47,6 +42,24 @@ export function StringEnum<T extends string[]>(allowedValues: [...T]) {
   return Type.Unsafe<T[number]>({ type: 'string', enum: allowedValues })
 }
 
+const arrayOfKeys = <T extends TObject>(type: T) => {
+  const keys = Object.keys(type.properties)
+  return Type.Unsafe<(keyof T['properties'])[]>({
+    type: 'array',
+    maxItems: keys.length,
+    items: {
+      type: 'string',
+      ...(keys.length > 0 ? { enum: keys } : {})
+    }
+  })
+}
+
+/**
+ * Creates the `$sort` Feathers query syntax schema for an object schema
+ *
+ * @param schema The TypeBox object schema
+ * @returns The `$sort` syntax schema
+ */
 export function sortDefinition<T extends TObject>(schema: T) {
   const properties = Object.keys(schema.properties).reduce((res, key) => {
     const result = res as any
@@ -56,66 +69,95 @@ export function sortDefinition<T extends TObject>(schema: T) {
     return result
   }, {} as { [K in keyof T['properties']]: TOptional<TInteger> })
 
-  return {
-    type: 'object',
-    additionalProperties: false,
-    properties
-  } as TObject<typeof properties>
+  return Type.Object(properties, { additionalProperties: false })
 }
 
-export const queryProperty = <T extends TSchema>(def: T) => {
-  return Type.Optional(
+/**
+ * Returns the standard Feathers query syntax for a property schema,
+ * including operators like `$gt`, `$lt` etc. for a single property
+ *
+ * @param def The property definition
+ * @returns The Feathers query syntax schema
+ */
+export const queryProperty = <T extends TSchema>(def: T) =>
+  Type.Optional(
     Type.Union([
       def,
-      Type.Object({
-        $gt: Type.Optional(def),
-        $gte: Type.Optional(def),
-        $lt: Type.Optional(def),
-        $lte: Type.Optional(def),
-        $ne: Type.Optional(def),
-        $in: Type.Optional(Type.Array(def)),
-        $nin: Type.Optional(Type.Array(def))
-      })
+      Type.Partial(
+        Type.Object({
+          $gt: def,
+          $gte: def,
+          $lt: def,
+          $lte: def,
+          $ne: def,
+          $in: Type.Array(def),
+          $nin: Type.Array(def)
+        }),
+        { additionalProperties: false }
+      )
     ])
   )
-}
 
 type QueryProperty<T extends TSchema> = ReturnType<typeof queryProperty<T>>
 
-export const queryProperties = <T extends TObject>(type: T) => {
-  const properties = Object.keys(type.properties).reduce((res, key) => {
+/**
+ * Creates a Feathers query syntax schema for the properties defined in `definition`.
+ *
+ * @param definition The properties to create the Feathers query syntax schema for
+ * @returns The Feathers query syntax schema
+ */
+export const queryProperties = <T extends TObject>(definition: T) => {
+  const properties = Object.keys(definition.properties).reduce((res, key) => {
     const result = res as any
+    const value = definition.properties[key]
 
-    result[key] = queryProperty(type.properties[key])
+    if (value.$ref || !SUPPORTED_TYPES.includes(value.type)) {
+      throw new Error(
+        `Can not create query syntax schema for property '${key}'. Only types ${SUPPORTED_TYPES.join(
+          ', '
+        )} are allowed.`
+      )
+    }
+
+    result[key] = queryProperty(value)
 
     return result
   }, {} as { [K in keyof T['properties']]: QueryProperty<T['properties'][K]> })
 
-  return {
-    type: 'object',
-    additionalProperties: false,
-    properties
-  } as TObject<typeof properties>
+  return Type.Optional(Type.Object(properties, { additionalProperties: false }))
 }
 
 /**
- * Creates a TypeBox schema for the complete Feathers query syntax including `$limit`, $skip`
+ * Creates a TypeBox schema for the complete Feathers query syntax including `$limit`, $skip`, `$or`
  * and `$sort` and `$select` for the allowed properties.
  *
  * @param type The properties to create the query syntax for
+ * @param options Options for the TypeBox object schema
  * @returns A TypeBox object representing the complete Feathers query syntax for the given properties
  */
-export const querySyntax = <T extends TObject | TIntersect>(type: T) => {
-  return Type.Intersect([
-    Type.Object(
-      {
-        $limit: Type.Optional(Type.Number({ minimum: 0 })),
-        $skip: Type.Optional(Type.Number({ minimum: 0 })),
-        $sort: Type.Optional(sortDefinition(type)),
-        $select: Type.Optional(arrayOfKeys(type))
-      },
-      { additionalProperties: false }
-    ),
-    queryProperties(type)
-  ])
+export const querySyntax = <T extends TObject | TIntersect>(
+  type: T,
+  options: ObjectOptions = { additionalProperties: false }
+) => {
+  const propertySchema = queryProperties(type)
+
+  return Type.Intersect(
+    [
+      Type.Partial(
+        Type.Object(
+          {
+            $limit: Type.Number({ minimum: 0 }),
+            $skip: Type.Number({ minimum: 0 }),
+            $sort: sortDefinition(type),
+            $select: arrayOfKeys(type),
+            $or: Type.Array(propertySchema),
+            $and: Type.Array(propertySchema)
+          },
+          { additionalProperties: false }
+        )
+      ),
+      propertySchema
+    ],
+    options
+  )
 }