@mxpicture/gcp-functions 0.1.11 → 0.1.12

package/dist/cjs/base/BaseApi.js

@@ -14,11 +14,11 @@ class BaseApi {
     async get(p) {
         return this.store.get(p.id);
     }
-    async query() {
-        return this.store.query();
+    async query(payload) {
+        return this.store.query(payload?.filters);
     }
-    async count() {
-        return { count: await this.store.count() };
+    async count(payload) {
+        return { count: await this.store.count(payload?.filters) };
     }
     async exists(p) {
         return { exists: await this.store.exists(p.id) };

package/dist/cjs/base/BaseHttp.js

@@ -32,9 +32,9 @@ class BaseHttp {
             throw new https_1.HttpsError("not-found", `Id ${req.keys?.id} not found`);
         }
     }
-    async query() {
+    async query(req) {
         try {
-            return this.api.query();
+            return this.api.query(req.content);
         }
         catch (error) {
             if (error instanceof https_1.HttpsError)
@@ -42,9 +42,9 @@ class BaseHttp {
             throw new https_1.HttpsError("unknown", "Unknown error");
         }
     }
-    async count() {
+    async count(req) {
         try {
-            return this.api.count();
+            return this.api.count(req.content);
         }
         catch (error) {
             if (error instanceof https_1.HttpsError)

package/dist/cjs/store/Store.js

@@ -63,6 +63,22 @@ class Store {
             updateTime: doc.updateTime.toDate(),
         }));
     }
+    async querySnapshot(p) {
+        if (!p)
+            return this.db().get();
+        if (p.parentId)
+            return this.refByParent(p.parentId).get();
+        let query;
+        for (const [field, filter] of Object.entries(p)) {
+            if (typeof filter === "string")
+                continue;
+            if (!query)
+                query = this.db().where(field, filter.op, filter.value);
+            else
+                query = query.where(field, filter.op, filter.value);
+        }
+        return (query ?? this.db()).get();
+    }
     async count(p) {
         const snapshot = p && p.parentId
             ? await this.refByParent(p.parentId).count().get()

package/dist/cjs/types/types.apiRoutes.js

@@ -1,2 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiFilterOp = void 0;
+var ApiFilterOp;
+(function (ApiFilterOp) {
+    ApiFilterOp["lessThan"] = "<";
+    ApiFilterOp["lessEquals"] = "<=";
+    ApiFilterOp["equals"] = "==";
+    ApiFilterOp["notEquals"] = "!=";
+    ApiFilterOp["greaterEquals"] = ">=";
+    ApiFilterOp["greaterThan"] = ">";
+    ApiFilterOp["arrayContains"] = "array-contains";
+    ApiFilterOp["in"] = "in";
+    ApiFilterOp["notIn"] = "not-in";
+    ApiFilterOp["arrayContainsAny"] = "array-contains-any";
+})(ApiFilterOp || (exports.ApiFilterOp = ApiFilterOp = {}));

package/dist/esm/base/BaseApi.js

@@ -14,11 +14,11 @@ class BaseApi {
     async get(p) {
         return this.store.get(p.id);
     }
-    async query() {
-        return this.store.query();
+    async query(payload) {
+        return this.store.query(payload?.filters);
     }
-    async count() {
-        return { count: await this.store.count() };
+    async count(payload) {
+        return { count: await this.store.count(payload?.filters) };
     }
     async exists(p) {
         return { exists: await this.store.exists(p.id) };

package/dist/esm/base/BaseHttp.js

@@ -32,9 +32,9 @@ class BaseHttp {
             throw new https_1.HttpsError("not-found", `Id ${req.keys?.id} not found`);
         }
     }
-    async query() {
+    async query(req) {
         try {
-            return this.api.query();
+            return this.api.query(req.content);
         }
         catch (error) {
             if (error instanceof https_1.HttpsError)
@@ -42,9 +42,9 @@ class BaseHttp {
             throw new https_1.HttpsError("unknown", "Unknown error");
         }
     }
-    async count() {
+    async count(req) {
         try {
-            return this.api.count();
+            return this.api.count(req.content);
         }
         catch (error) {
             if (error instanceof https_1.HttpsError)

package/dist/esm/store/Store.js

@@ -63,6 +63,22 @@ class Store {
             updateTime: doc.updateTime.toDate(),
         }));
     }
+    async querySnapshot(p) {
+        if (!p)
+            return this.db().get();
+        if (p.parentId)
+            return this.refByParent(p.parentId).get();
+        let query;
+        for (const [field, filter] of Object.entries(p)) {
+            if (typeof filter === "string")
+                continue;
+            if (!query)
+                query = this.db().where(field, filter.op, filter.value);
+            else
+                query = query.where(field, filter.op, filter.value);
+        }
+        return (query ?? this.db()).get();
+    }
     async count(p) {
         const snapshot = p && p.parentId
             ? await this.refByParent(p.parentId).count().get()

package/dist/esm/types/types.apiRoutes.js

@@ -1,2 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiFilterOp = void 0;
+var ApiFilterOp;
+(function (ApiFilterOp) {
+    ApiFilterOp["lessThan"] = "<";
+    ApiFilterOp["lessEquals"] = "<=";
+    ApiFilterOp["equals"] = "==";
+    ApiFilterOp["notEquals"] = "!=";
+    ApiFilterOp["greaterEquals"] = ">=";
+    ApiFilterOp["greaterThan"] = ">";
+    ApiFilterOp["arrayContains"] = "array-contains";
+    ApiFilterOp["in"] = "in";
+    ApiFilterOp["notIn"] = "not-in";
+    ApiFilterOp["arrayContainsAny"] = "array-contains-any";
+})(ApiFilterOp || (exports.ApiFilterOp = ApiFilterOp = {}));

package/dist/types/base/BaseApi.d.ts

@@ -1,5 +1,5 @@
 import { MetaItem } from "@mxpicture/zod-meta";
-import { ApiRoutes, ApiFromRoutes, ApiKey } from "../types/types.apiRoutes";
+import { ApiRoutes, ApiFromRoutes, ApiKey, ApiFilter } from "../types/types.apiRoutes";
 import { Store } from "../store/Store";
 import { DocumentData, WithKey } from "../types/types.document";
 import { Validation } from "../validation/Validation";
@@ -11,8 +11,8 @@ export declare class BaseApi<DTO extends DocumentData, STORE extends Store<DTO>
     constructor(store: STORE, validation: VAL, shape: ZodRawShape);
     delete(p: ApiKey): Promise<void>;
     get(p: ApiKey): Promise<WithKey<DTO>>;
-    query(): Promise<WithKey<DTO>[]>;
-    count(): Promise<{
+    query(payload?: ApiFilter): Promise<WithKey<DTO>[]>;
+    count(payload?: ApiFilter): Promise<{
         count: number;
     }>;
     exists(p: ApiKey): Promise<{

package/dist/types/base/BaseHttp.d.ts

@@ -1,4 +1,4 @@
-import { ApiKey, ApiRoutes } from "../types/types.apiRoutes";
+import { ApiFilter, ApiKey, ApiRoutes } from "../types/types.apiRoutes";
 import { FunctionPayload } from "../types/types.function";
 import { HttpHandlers } from "../types/types.httpHandler";
 import { BaseApi } from "./BaseApi";
@@ -8,8 +8,8 @@ export declare class BaseHttp<DTO extends DocumentData, API extends BaseApi<DTO>
     constructor(api: API);
     delete(req: FunctionPayload<never, ApiKey>): Promise<void>;
     get(req: FunctionPayload<never, ApiKey>): Promise<import("../types/types.document").WithKey<DTO>>;
-    query(): Promise<import("../types/types.document").WithKey<DTO>[]>;
-    count(): Promise<{
+    query(req: FunctionPayload<ApiFilter>): Promise<import("../types/types.document").WithKey<DTO>[]>;
+    count(req: FunctionPayload<ApiFilter>): Promise<{
         count: number;
     }>;
     exists(req: FunctionPayload<never, ApiKey>): Promise<{

package/dist/types/store/Store.d.ts

@@ -1,5 +1,6 @@
-import { CollectionReference, DocumentReference, FirestoreDataConverter } from "firebase-admin/firestore";
+import { CollectionReference, DocumentReference, FirestoreDataConverter, Query, QuerySnapshot } from "firebase-admin/firestore";
 import { DocumentData, WithKey } from "../types/types.document.js";
+import { ApiFilterItems } from "../types/types.apiRoutes.js";
 export declare class Store<DTO extends DocumentData> {
     readonly collectionName: string;
     protected readonly converter?: FirestoreDataConverter<DTO> | undefined;
@@ -7,9 +8,8 @@ export declare class Store<DTO extends DocumentData> {
     protected _db?: CollectionReference<DTO>;
     constructor(collectionName: string, converter?: FirestoreDataConverter<DTO> | undefined, namespace?: string);
     db(): CollectionReference<DTO>;
-    query(p?: {
-        parentId?: string;
-    }): Promise<WithKey<DTO>[]>;
+    query(p?: ApiFilterItems): Promise<WithKey<DTO>[]>;
+    protected querySnapshot(p?: ApiFilterItems): Promise<QuerySnapshot<DTO>>;
     count(p?: {
         parentId?: string;
     }): Promise<number>;
@@ -20,5 +20,5 @@ export declare class Store<DTO extends DocumentData> {
     update(id: string, doc: Partial<DTO>): Promise<WithKey<DTO>>;
     delete(...ids: string[]): Promise<void>;
     deleteByParent(parentId: string): Promise<void>;
-    refByParent(parentId: string): FirebaseFirestore.Query<DTO, FirebaseFirestore.DocumentData>;
+    refByParent(parentId: string): Query<DTO, FirebaseFirestore.DocumentData>;
 }

package/dist/types/types/types.apiRoutes.d.ts

@@ -10,13 +10,37 @@ export type WithApiRoutes<R extends ApiRoutesMap> = R;
 export interface ApiKey {
     id: string;
 }
+export declare enum ApiFilterOp {
+    lessThan = "<",
+    lessEquals = "<=",
+    equals = "==",
+    notEquals = "!=",
+    greaterEquals = ">=",
+    greaterThan = ">",
+    arrayContains = "array-contains",
+    in = "in",
+    notIn = "not-in",
+    arrayContainsAny = "array-contains-any"
+}
+export interface ApiFilterItem {
+    op: ApiFilterOp;
+    value: string | number | Date;
+}
+export type ApiFilterItems = {
+    [key: string]: ApiFilterItem;
+} & {
+    parentId?: string;
+};
+export interface ApiFilter {
+    filters?: ApiFilterItems;
+}
 export type ApiRoutes<DTO extends DocumentData> = WithApiRoutes<{
     create: ApiRouteDef<never, DTO, WithKey<DTO>>;
     update: ApiRouteDef<ApiKey, Partial<DTO>, WithKey<DTO>>;
     delete: ApiRouteDef<ApiKey, never, void>;
     get: ApiRouteDef<ApiKey, never, WithKey<DTO>>;
-    query: ApiRouteDef<never, never, WithKey<DTO>[]>;
-    count: ApiRouteDef<never, never, {
+    query: ApiRouteDef<never, ApiFilter, WithKey<DTO>[]>;
+    count: ApiRouteDef<never, ApiFilter, {
         count: number;
     }>;
     exists: ApiRouteDef<ApiKey, never, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mxpicture/gcp-functions",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "description": "Utils for google cloud functions, publishing both CommonJS and ESM builds",
   "author": "MXPicture",
   "license": "MIT",