react-query-firebase 2.1.0 → 2.1.1

package/package.json

@@ -57,6 +57,7 @@
     "files": [
         "./web/",
         "./react-native/",
+        "./types",
         "package.json",
         "package-lock.json",
         "README.md",
@@ -73,5 +74,5 @@
         "docs:build": "vitepress build docs",
         "docs:preview": "vitepress preview docs"
     },
-    "version": "2.1.0"
+    "version": "2.1.1"
 }

package/types/AppModel.ts

@@ -0,0 +1,7 @@
+/**
+ * Generic definition for a data model
+ * @group Models
+ */
+export type AppModel = {
+    [key: string]: unknown;
+};

package/types/QueryConstraints.ts

@@ -0,0 +1,58 @@
+import { AppModel } from "./AppModel";
+
+/**
+ * Order by constraint
+ * @group Query Constraints
+ */
+export type OrderByConstraint<AppModelType extends AppModel = AppModel> = {
+    /**
+     * Type of a constraint
+     */
+    type: "orderBy";
+    /**
+     * Field path to use for ordering
+     */
+    fieldPath: keyof AppModelType;
+    /**
+     * Direction of ordering: asc or desc
+     */
+    directionStr: "asc" | "desc";
+};
+
+/**
+ * Start from value constraint
+ * @group Query Constraints
+ */
+export type StartConstraint = {
+    type: "startAt" | "startAfter";
+    arguments: unknown[];
+};
+
+/**
+ * End by value constraint
+ * @group Query Constraints
+ */
+export type EndConstraint = {
+    type: "endAt" | "endBefore";
+    value: number | string | boolean | null;
+    key?: string;
+};
+
+/**
+ * Limit constraint
+ * @group Query Constraints
+ */
+export type LimitConstraint = {
+    type: "limitToLast" | "limit";
+    limit: number;
+};
+
+/**
+ * Non filtering query constaints
+ * @group Query Constraints
+ */
+export type NonFilterQueryConstraint<AppModelType extends AppModel = AppModel> =
+    | OrderByConstraint<AppModelType>
+    | StartConstraint
+    | EndConstraint
+    | LimitConstraint;

package/types/index.ts

@@ -0,0 +1,2 @@
+export * from "./AppModel";
+export * from "./QueryConstraints";