@goatlab/fluent-firebase 0.6.15 → 0.7.1

package/README.md

@@ -12,20 +12,38 @@
        <img src="https://docs.goatlab.io/logo.png" alt="Logo" width="150" height="150">
   </a>
 
-  <h3 align="center">GOAT-FLUENT</h3>
+  <h3 align="center">GOAT - FLUENT-FIREBASE</h3>
 
   <p align="center">
-    Readable query Interface & API generator
+    Fluent - Time Saving (TS) utils
     <br />
-    <a href="https://docs.goatlab.io/#/0.5.x/fluent/fluent"><strong>Explore the docs »</strong></a>
+    <a href="https://docs.goatlab.io/#/0.7.x/fluent/fluent"><strong>Explore the docs »</strong></a>
     <br />
     <br />
-    <a href="https://codesandbox.io/s/goat-nestjs-tytmv?file=/src/main.ts">View Demo</a>
     ·
     <a href="https://github.com/goat-io/fluent/issues">Report Bug</a>
     ·
     <a href="https://github.com/goat-io/fluent/issues">Request Feature</a>
   </p>
+  </p>
 </p>
 
 # Goat - Fluent
+
+Fluent query interface for Multiple database types and helpers for fast API generation and general App building.
+
+## Supported Databases
+
+1. Firebase\*
+
+### Installing
+
+To install this package in your project, you can use the following command within your terminal.
+
+```bash
+yarn add @goatlab/fluent-firebase
+```
+
+### Documentation
+
+To learn how to use this visit the [Goat Docs](https://docs.goatlab.io/#/0.7.x/fluent/fluent)

package/dist/Firebase.d.ts

@@ -1,7 +1,9 @@
 import * as admin from 'firebase-admin';
 import { getAuth as firebaseGetAuth } from 'firebase-admin/auth';
 export declare type FirebaseUser = admin.auth.DecodedIdToken;
-export declare const Firebase: Readonly<{
+declare class FirebaseClass {
     verifyIdToken: (token: string) => Promise<import("firebase-admin/auth").DecodedIdToken>;
     getAuth: typeof firebaseGetAuth;
-}>;
+}
+export declare const Firebase: FirebaseClass;
+export {};

package/dist/Firebase.js

@@ -4,8 +4,10 @@ exports.Firebase = void 0;
 const tslib_1 = require("tslib");
 const admin = tslib_1.__importStar(require("firebase-admin"));
 const auth_1 = require("firebase-admin/auth");
-exports.Firebase = (() => {
-    const verifyIdToken = (token) => admin.auth().verifyIdToken(token);
-    const getAuth = auth_1.getAuth;
-    return Object.freeze({ verifyIdToken, getAuth });
-})();
+class FirebaseClass {
+    constructor() {
+        this.verifyIdToken = (token) => admin.auth().verifyIdToken(token);
+        this.getAuth = auth_1.getAuth;
+    }
+}
+exports.Firebase = new FirebaseClass();

package/dist/FirebaseConnector.d.ts

@@ -1,41 +1,36 @@
 import * as admin from 'firebase-admin';
-import { BaseFirestoreRepository } from 'fireorm';
-import type { Filter, BaseDataElement, PaginatedData, Paginator, Sure } from '@goatlab/fluent';
-import { BaseConnector, DataSource, FluentConnectorInterface } from '@goatlab/fluent';
-export declare const createFirebaseRepository: (Entity: any, dataSource: DataSource) => {
-    repository: BaseFirestoreRepository<import("fireorm").IEntity>;
-    name: string;
-    path: string;
-    keys: string[];
-    relations: {};
-};
-export declare class FirebaseConnector<ModelDTO = BaseDataElement, InputDTO = ModelDTO, OutputDTO = InputDTO> extends BaseConnector<ModelDTO, InputDTO, OutputDTO> implements FluentConnectorInterface<InputDTO, OutputDTO> {
-    private repository;
+import { AnyObject, FluentQuery, LoadedResult, QueryOutput } from '@goatlab/fluent';
+import { BaseConnector, FluentConnectorInterface } from '@goatlab/fluent';
+import { z } from 'zod';
+import { FindByIdFilter } from '@goatlab/fluent';
+import { SingleQueryOutput } from '@goatlab/fluent';
+export interface FirebaseConnectorParams<Input, Output> {
+    entity: any;
+    inputSchema: z.ZodType<Input>;
+    outputSchema?: z.ZodType<Output>;
+}
+export declare class FirebaseConnector<ModelDTO = AnyObject, InputDTO = ModelDTO, OutputDTO = InputDTO> extends BaseConnector<ModelDTO, InputDTO, OutputDTO> implements FluentConnectorInterface<ModelDTO, InputDTO, OutputDTO> {
+    private readonly inputSchema;
+    private readonly outputSchema;
     private readonly collection;
-    constructor(Entity: any, dataSource: DataSource, relationQuery?: any);
-    get(): Promise<OutputDTO[]>;
-    getPaginated(): Promise<PaginatedData<OutputDTO>>;
-    all(): Promise<OutputDTO[]>;
-    find(filter?: Filter): Promise<OutputDTO[]>;
-    paginate(paginator: Paginator): Promise<PaginatedData<OutputDTO>>;
+    private readonly entity;
+    constructor({ entity, inputSchema, outputSchema }: FirebaseConnectorParams<InputDTO, OutputDTO>);
+    insert(data: InputDTO): Promise<OutputDTO>;
+    insertMany(data: InputDTO[]): Promise<OutputDTO[]>;
     raw(): admin.firestore.CollectionReference<ModelDTO>;
-    insert(data: InputDTO, forcedId?: string | number): Promise<OutputDTO>;
-    insertMany(data: InputDTO[], forcedId?: string | number): Promise<OutputDTO[]>;
-    batchInsert(data: InputDTO[]): Promise<OutputDTO[]>;
+    rawFirebase(): admin.firestore.Firestore;
+    protected loadRelatedData(data: any[], loadedKeys: AnyObject): Promise<admin.firestore.DocumentData[]>;
+    findMany<T extends FluentQuery<ModelDTO>>(query?: T): Promise<QueryOutput<T, ModelDTO, OutputDTO>>;
+    loadFirst(query?: FluentQuery<ModelDTO>): FirebaseConnector<ModelDTO, InputDTO, OutputDTO>;
+    private getGeneratedQueries;
+    private getFirebaseWhereQuery;
     updateById(id: string, data: InputDTO): Promise<OutputDTO>;
     replaceById(id: string, data: InputDTO): Promise<OutputDTO>;
-    clear({ sure }: Sure): Promise<unknown>;
-    deleteById(id: string): Promise<string>;
-    findById(id: string): Promise<OutputDTO>;
-    findByIds(ids: string[]): Promise<OutputDTO[] | null>;
-    private getPage;
-    private getPaginatorLimit;
-    private getPopulate;
-    private getGeneratedQuery;
-    private getFilters;
-    private getOrderBy;
-    private getLimit;
-    private getSkip;
-    private getSelect;
+    clear(): Promise<boolean>;
     private deleteQueryBatch;
+    loadById(id: string): LoadedResult<this>;
+    protected clone(): any;
+    findByIds<T extends FindByIdFilter<ModelDTO>>(ids: string[], q?: T): Promise<QueryOutput<T, ModelDTO, OutputDTO>>;
+    findById<T extends FindByIdFilter<ModelDTO>>(id: string, q?: T): Promise<SingleQueryOutput<T, ModelDTO, OutputDTO>>;
+    requireById(id: string, q?: FindByIdFilter<ModelDTO>): Promise<SingleQueryOutput<FindByIdFilter<ModelDTO>, ModelDTO, OutputDTO>>;
 }