@feathersjs/schema 5.0.0-pre.19 → 5.0.0-pre.20

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 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.20](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.19...v5.0.0-pre.20) (2022-05-04)
+
+
+### Bug Fixes
+
+* **dependencies:** Lock monorepo package version numbers ([#2623](https://github.com/feathersjs/feathers/issues/2623)) ([5640c10](https://github.com/feathersjs/feathers/commit/5640c1020cc139994e695d658c08bad3494db507))
+
+
+### Features
+
+* **schema:** Add querySyntax helper to create full query schemas ([#2621](https://github.com/feathersjs/feathers/issues/2621)) ([2bbb103](https://github.com/feathersjs/feathers/commit/2bbb103b2f3e30fb0fff935f92ad3276a1a67e41))
+
+
+
+
+
 # [5.0.0-pre.19](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.18...v5.0.0-pre.19) (2022-05-01)
 
 

package/lib/query.d.ts

@@ -1,3 +1,28 @@
+import { JSONSchema } from 'json-schema-to-ts';
+export declare type PropertyQuery<D extends JSONSchema> = {
+    anyOf: [
+        D,
+        {
+            type: 'object';
+            additionalProperties: false;
+            properties: {
+                $gt: D;
+                $gte: D;
+                $lt: D;
+                $lte: D;
+                $ne: D;
+                $in: {
+                    type: 'array';
+                    items: D;
+                };
+                $nin: {
+                    type: 'array';
+                    items: D;
+                };
+            };
+        }
+    ];
+};
 export declare const queryProperty: <T extends import("json-schema-to-ts").JSONSchema7>(definition: T) => {
     readonly anyOf: readonly [T, {
         readonly type: "object";
@@ -19,3 +44,32 @@ export declare const queryProperty: <T extends import("json-schema-to-ts").JSONS
         };
     }];
 };
+export declare const queryProperties: <T extends {
+    [key: string]: import("json-schema-to-ts").JSONSchema7;
+}>(definition: T) => { [K in keyof T]: PropertyQuery<T[K]>; };
+export declare const querySyntax: <T extends {
+    [key: string]: import("json-schema-to-ts").JSONSchema7;
+}>(definition: T) => {
+    readonly $limit: {
+        readonly type: "number";
+        readonly minimum: 0;
+    };
+    readonly $skip: {
+        readonly type: "number";
+        readonly minimum: 0;
+    };
+    readonly $sort: {
+        readonly type: "object";
+        readonly properties: { [K in keyof T]: {
+            readonly type: 'number';
+            readonly enum: [1, -1];
+        }; };
+    };
+    readonly $select: {
+        readonly type: "array";
+        readonly items: {
+            readonly type: "string";
+            readonly enum: (keyof T)[];
+        };
+    };
+} & { [K_1 in keyof T]: PropertyQuery<T[K_1]>; };

package/lib/query.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.queryProperty = void 0;
+exports.querySyntax = exports.queryProperties = exports.queryProperty = void 0;
 const queryProperty = (definition) => ({
     anyOf: [
         definition,
@@ -26,4 +26,38 @@ const queryProperty = (definition) => ({
     ]
 });
 exports.queryProperty = queryProperty;
+const queryProperties = (definition) => Object.keys(definition).reduce((res, key) => {
+    res[key] = (0, exports.queryProperty)(definition[key]);
+    return res;
+}, {});
+exports.queryProperties = queryProperties;
+const querySyntax = (definition) => ({
+    $limit: {
+        type: 'number',
+        minimum: 0
+    },
+    $skip: {
+        type: 'number',
+        minimum: 0
+    },
+    $sort: {
+        type: 'object',
+        properties: Object.keys(definition).reduce((res, key) => {
+            res[key] = {
+                type: 'number',
+                enum: [1, -1]
+            };
+            return res;
+        }, {})
+    },
+    $select: {
+        type: 'array',
+        items: {
+            type: 'string',
+            enum: Object.keys(definition)
+        }
+    },
+    ...(0, exports.queryProperties)(definition)
+});
+exports.querySyntax = querySyntax;
 //# sourceMappingURL=query.js.map

package/lib/query.js.map

@@ -1 +1 @@
-{"version":3,"file":"query.js","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":";;;AAEO,MAAM,aAAa,GAAG,CAAwB,UAAa,EAAE,EAAE,CAAC,CAAC;IACtE,KAAK,EAAE;QACL,UAAU;QACV;YACE,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,GAAG,EAAE,UAAU;gBACf,IAAI,EAAE,UAAU;gBAChB,GAAG,EAAE,UAAU;gBACf,IAAI,EAAE,UAAU;gBAChB,GAAG,EAAE,UAAU;gBACf,GAAG,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,UAAU;iBAClB;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,UAAU;iBAClB;aACF;SACF;KACF;CACQ,CAAA,CAAC;AAvBC,QAAA,aAAa,iBAuBd"}
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":";;;AA2BO,MAAM,aAAa,GAAG,CAAwB,UAAa,EAAE,EAAE,CAAC,CAAC;IACtE,KAAK,EAAE;QACL,UAAU;QACV;YACE,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,GAAG,EAAE,UAAU;gBACf,IAAI,EAAE,UAAU;gBAChB,GAAG,EAAE,UAAU;gBACf,IAAI,EAAE,UAAU;gBAChB,GAAG,EAAE,UAAU;gBACf,GAAG,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,UAAU;iBAClB;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,UAAU;iBAClB;aACF;SACF;KACF;CACQ,CAAA,CAAC;AAvBC,QAAA,aAAa,iBAuBd;AAEL,MAAM,eAAe,GAAG,CAA2C,UAAa,EAAE,EAAE,CACzF,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IACzC,GAAW,CAAC,GAAG,CAAC,GAAG,IAAA,qBAAa,EAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;IAElD,OAAO,GAAG,CAAA;AACZ,CAAC,EAAE,EAA6C,CAAC,CAAA;AALtC,QAAA,eAAe,mBAKuB;AAE5C,MAAM,WAAW,GAAG,CAA2C,UAAa,EAAE,EAAE,CAAC,CAAC;IACvF,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC;KACX;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC;KACX;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACrD,GAAW,CAAC,GAAG,CAAC,GAAG;gBAClB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aACd,CAAA;YAED,OAAO,GAAG,CAAA;QACZ,CAAC,EAAE,EAA6E,CAAC;KAClF;IACD,OAAO,EAAE;QACP,IAAI,EAAE,OAAO;QACb,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAuB;SACpD;KACF;IACD,GAAG,IAAA,uBAAe,EAAC,UAAU,CAAC;CACrB,CAAA,CAAA;AA5BE,QAAA,WAAW,eA4Bb"}

package/lib/schema.d.ts

@@ -5,6 +5,10 @@ export { Ajv };
 export declare type JSONSchemaDefinition = JSONSchema & {
     $id: string;
     $async?: boolean;
+    properties?: {
+        [key: string]: JSONSchema;
+    };
+    required?: readonly string[];
 };
 export interface Schema<T> {
     validate<X = T>(...args: Parameters<ValidateFunction<X>>): Promise<X>;
@@ -15,6 +19,8 @@ export declare class SchemaWrapper<S extends JSONSchemaDefinition> implements Sc
     validator: AsyncValidateFunction;
     readonly _type: FromSchema<S>;
     constructor(definition: S, ajv?: Ajv);
+    get properties(): S["properties"];
+    get required(): S["required"];
     validate<T = FromSchema<S>>(...args: Parameters<ValidateFunction<T>>): Promise<T>;
     toJSON(): S;
 }

package/lib/schema.js

@@ -19,6 +19,12 @@ class SchemaWrapper {
             ...this.definition
         });
     }
+    get properties() {
+        return this.definition.properties;
+    }
+    get required() {
+        return this.definition.required;
+    }
     async validate(...args) {
         try {
             const validated = await this.validator(...args);

package/lib/schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAmE;AAQ1D,cARF,aAAG,CAQE;AANZ,+CAAgD;AAEnC,QAAA,WAAW,GAAG,IAAI,aAAG,CAAC;IACjC,WAAW,EAAE,IAAI;CAClB,CAAC,CAAC;AAUH,MAAa,aAAa;IAKxB,YAAoB,UAAa,EAAE,MAAW,mBAAW;QAArC,eAAU,GAAV,UAAU,CAAG;QAC/B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YAChC,MAAM,EAAE,IAAI;YACZ,GAAI,IAAI,CAAC,UAAkB;SAC5B,CAA0B,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,QAAQ,CAAsB,GAAG,IAAqC;QAC1E,IAAI;YACF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAM,CAAC;YAErD,OAAO,SAAS,CAAC;SAClB;QAAC,OAAO,KAAU,EAAE;YACnB,MAAM,IAAI,mBAAU,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACnD;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF;AA1BD,sCA0BC;AAED,SAAgB,MAAM,CAAmC,UAAa,EAAE,MAAW,mBAAW;IAC5F,OAAO,IAAI,aAAa,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;AAC5C,CAAC;AAFD,wBAEC"}
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAmE;AAQ1D,cARF,aAAG,CAQE;AANZ,+CAAgD;AAEnC,QAAA,WAAW,GAAG,IAAI,aAAG,CAAC;IACjC,WAAW,EAAE,IAAI;CAClB,CAAC,CAAC;AAeH,MAAa,aAAa;IAKxB,YAAoB,UAAa,EAAE,MAAW,mBAAW;QAArC,eAAU,GAAV,UAAU,CAAG;QAC/B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YAChC,MAAM,EAAE,IAAI;YACZ,GAAI,IAAI,CAAC,UAAkB;SAC5B,CAA0B,CAAC;IAC9B,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC,UAA6B,CAAC;IACvD,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,UAAU,CAAC,QAAyB,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,QAAQ,CAAsB,GAAG,IAAqC;QAC1E,IAAI;YACF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAM,CAAC;YAErD,OAAO,SAAS,CAAC;SAClB;QAAC,OAAO,KAAU,EAAE;YACnB,MAAM,IAAI,mBAAU,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACnD;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF;AAlCD,sCAkCC;AAED,SAAgB,MAAM,CAAmC,UAAa,EAAE,MAAW,mBAAW;IAC5F,OAAO,IAAI,aAAa,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;AAC5C,CAAC;AAFD,wBAEC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@feathersjs/schema",
   "description": "A common data schema definition format",
-  "version": "5.0.0-pre.19",
+  "version": "5.0.0-pre.20",
   "homepage": "https://feathersjs.com",
   "main": "lib/",
   "types": "lib/",
@@ -53,15 +53,15 @@
     "access": "public"
   },
   "dependencies": {
-    "@feathersjs/errors": "^5.0.0-pre.19",
-    "@feathersjs/feathers": "^5.0.0-pre.19",
+    "@feathersjs/errors": "^5.0.0-pre.20",
+    "@feathersjs/feathers": "^5.0.0-pre.20",
     "@types/json-schema": "^7.0.11",
     "ajv": "^8.11.0",
     "json-schema": "^0.4.0",
     "json-schema-to-ts": "^2.3.0"
   },
   "devDependencies": {
-    "@feathersjs/memory": "^5.0.0-pre.19",
+    "@feathersjs/memory": "^5.0.0-pre.20",
     "@types/mocha": "^9.1.1",
     "@types/node": "^17.0.31",
     "ajv-formats": "^2.1.1",
@@ -69,5 +69,5 @@
     "shx": "^0.3.4",
     "typescript": "^4.6.4"
   },
-  "gitHead": "57f3e18bb62735e1869ffafee90286498738fdfa"
+  "gitHead": "54de749a0b392c7da726c668002b50cafaca530c"
 }

package/src/query.ts

@@ -1,5 +1,30 @@
 import { JSONSchema } from 'json-schema-to-ts';
 
+export type PropertyQuery<D extends JSONSchema> = {
+  anyOf: [
+    D,
+    {
+      type: 'object',
+      additionalProperties: false,
+      properties: {
+        $gt: D,
+        $gte: D,
+        $lt: D,
+        $lte: D,
+        $ne: D,
+        $in: {
+          type: 'array',
+          items: D
+        },
+        $nin: {
+          type: 'array',
+          items: D
+        }
+      }
+    }
+  ]
+}
+
 export const queryProperty = <T extends JSONSchema> (definition: T) => ({
   anyOf: [
     definition,
@@ -24,3 +49,40 @@ export const queryProperty = <T extends JSONSchema> (definition: T) => ({
     }
   ]
 } as const);
+
+export const queryProperties = <T extends { [key: string]: JSONSchema }> (definition: T) =>
+  Object.keys(definition).reduce((res, key) => {
+    (res as any)[key] = queryProperty(definition[key])
+
+    return res
+  }, {} as { [K in keyof T]: PropertyQuery<T[K]> })
+
+export const querySyntax = <T extends { [key: string]: JSONSchema }> (definition: T) => ({
+  $limit: {
+    type: 'number',
+    minimum: 0
+  },
+  $skip: {
+    type: 'number',
+    minimum: 0
+  },
+  $sort: {
+    type: 'object',
+    properties: Object.keys(definition).reduce((res, key) => {
+      (res as any)[key] = {
+        type: 'number',
+        enum: [1, -1]
+      }
+
+      return res
+    }, {} as { [K in keyof T]: { readonly type: 'number', readonly enum: [1, -1] } })
+  },
+  $select: {
+    type: 'array',
+    items: {
+      type: 'string',
+      enum: Object.keys(definition) as any as (keyof T)[]
+    }
+  },
+  ...queryProperties(definition)
+} as const)

package/src/schema.ts

@@ -8,7 +8,12 @@ export const DEFAULT_AJV = new Ajv({
 
 export { Ajv };
 
-export type JSONSchemaDefinition = JSONSchema & { $id: string, $async?: boolean };
+export type JSONSchemaDefinition = JSONSchema & {
+  $id: string,
+  $async?: boolean,
+  properties?: { [key: string]: JSONSchema }
+  required?: readonly string[]
+};
 
 export interface Schema<T> {
   validate <X = T> (...args: Parameters<ValidateFunction<X>>): Promise<X>;
@@ -27,6 +32,14 @@ export class SchemaWrapper<S extends JSONSchemaDefinition> implements Schema<Fro
     }) as AsyncValidateFunction;
   }
 
+  get properties () {
+    return this.definition.properties as S['properties'];
+  }
+
+  get required () {
+    return this.definition.required as S['required'];
+  }
+
   async validate <T = FromSchema<S>> (...args: Parameters<ValidateFunction<T>>) {
     try {
       const validated = await this.validator(...args) as T;