Merge pull request crcn#251 from Helveg/export-query-types

Export constituent query types and operator union

src/core.ts

@@ -33,7 +33,7 @@ export type OperationCreator<TItem> = (
   name: string
 ) => Operation<TItem>;
 
-type BasicValueQuery<TValue> = {
+export type BasicValueQuery<TValue> = {
   $eq?: TValue;
   $ne?: TValue;
   $lt?: TValue;
@@ -56,27 +56,29 @@ type BasicValueQuery<TValue> = {
   $and?: NestedQuery<TValue>[];
 };
 
-type ArrayValueQuery<TValue> = {
+export type ArrayValueQuery<TValue> = {
   $elemMatch?: Query<TValue>;
 } & BasicValueQuery<TValue>;
 type Unpacked<T> = T extends (infer U)[] ? U : T;
 
-type ValueQuery<TValue> = TValue extends Array<any>
+export type ValueQuery<TValue> = TValue extends Array<any>
   ? ArrayValueQuery<Unpacked<TValue>>
   : BasicValueQuery<TValue>;
 
 type NotObject = string | number | Date | boolean | Array<any>;
-type ShapeQuery<TItemSchema> = TItemSchema extends NotObject
+export type ShapeQuery<TItemSchema> = TItemSchema extends NotObject
   ? {}
   : { [k in keyof TItemSchema]?: TItemSchema[k] | ValueQuery<TItemSchema[k]> };
 
-type NestedQuery<TItemSchema> = ValueQuery<TItemSchema> &
+export type NestedQuery<TItemSchema> = ValueQuery<TItemSchema> &
   ShapeQuery<TItemSchema>;
 export type Query<TItemSchema> =
   | TItemSchema
   | RegExp
   | NestedQuery<TItemSchema>;
 
+export type QueryOperators<TValue = any> = keyof ValueQuery<TValue>;
+
 /**
  * Walks through each value given the context - used for nested operations. E.g:
  * { "person.address": { $eq: "blarg" }}

src/index.ts

@@ -1,6 +1,12 @@
 import * as defaultOperations from "./operations";
 import {
   Query,
+  QueryOperators,
+  BasicValueQuery,
+  ArrayValueQuery,
+  ValueQuery,
+  NestedQuery,
+  ShapeQuery,
   Options,
   createQueryTester,
   EqualsOperation,
@@ -30,6 +36,12 @@ const createDefaultQueryTester = <TItem, TSchema extends TItem = TItem>(
 
 export {
   Query,
+  QueryOperators,
+  BasicValueQuery,
+  ArrayValueQuery,
+  ValueQuery,
+  NestedQuery,
+  ShapeQuery,
   EqualsOperation,
   createQueryTester,
   createOperationTester,