feat(query): add method and type

packages/provider/src/lib/types/Method.ts

@@ -43,6 +43,8 @@ export enum Method {
 
   Push = 'push',
 
+  Query = 'query',
+
   Random = 'random',
 
   RandomKey = 'randomKey',

packages/provider/src/lib/types/Payload.ts

@@ -482,6 +482,20 @@ export namespace Payload {
     value: Value;
   }
 
+  /**
+   * The payload for {@link Method.Query}
+   * @since 1.0.0
+   */
+  export interface Query<Value> extends Payload, KeyPath {
+    method: Method.Query;
+
+    /**
+     * The built query.
+     * @since 1.0.0
+     */
+    query: Query<Value>;
+  }
+
   /**
    * The payload for {@link Method.Random}
    * @since 1.0.0

packages/provider/src/lib/types/Query.ts

@@ -0,0 +1,38 @@
+enum Operators {
+  Equal = 'equal',
+  NotEqual = 'notEqual',
+  GreaterThan = 'greaterThan',
+  GreaterThanOrEqual = 'greaterThanOrEqual',
+  LessThan = 'lessThan',
+  LessThanOrEqual = 'lessThanOrEqual',
+  In = 'in',
+  NotIn = 'notIn',
+  Contains = 'contains',
+  NotContains = 'notContains',
+  Regex = 'regex'
+}
+
+export interface QueryOperators<Value> {
+  [Operators.Equal]?: Value; // Not equal
+  [Operators.NotEqual]?: Value; // Not equal
+  [Operators.GreaterThan]?: Value; // Greater than
+  [Operators.GreaterThanOrEqual]?: Value; // Greater than or equal
+  [Operators.LessThan]?: Value; // Less than
+  [Operators.LessThanOrEqual]?: Value; // Less than or equal
+  [Operators.In]?: Value[]; // In
+  [Operators.NotIn]?: Value[]; // Not in
+  [Operators.Contains]?: Value; // Contains
+  [Operators.NotContains]?: Value; // Not contains
+  [Operators.Regex]?: RegExp; // Regex
+}
+
+export type QueryOptions<Value> =
+  | {
+      [key in keyof Value]: QueryOptions<Value[keyof Value]> | Value;
+    }
+  | QueryOperators<Value>;
+
+export interface Query<StoredValue> {
+  key?: string | QueryOperators<string>;
+  value?: StoredValue | QueryOptions<StoredValue>;
+}

packages/provider/src/lib/types/index.ts

@@ -3,5 +3,6 @@ export * from './KeyPath';
 export * from './MathOperator';
 export * from './Method';
 export * from './Payload';
+export * from './Query';
 export * from './Semver';
 export * from './Trigger';