@data-weave/backend-firestore 0.4.5 → 0.4.6

package/lib/FirestoreDataManager.d.ts

@@ -0,0 +1,48 @@
+import { Cache } from '@data-weave/datamanager/src/Cache';
+import { DataManager, WithMetadata } from '@data-weave/datamanager/src/DataManager';
+import { List, ListPaginationParams } from '@data-weave/datamanager/src/List';
+import { IdentifiableReference, WithoutId } from '@data-weave/datamanager/src/Reference';
+import { FirestoreList, FirestoreListContext } from './FirestoreList';
+import { FirestoreSerializedMetadata } from './FirestoreMetadata';
+import { FirestoreReference, FirestoreReferenceContext } from './FirestoreReference';
+import { FilterBy, FirebaseCreateOptions, Firestore, FirestoreDataConverter, FirestoreReadMode, FirestoreReadOptions, FirestoreTypes, FirestoreWriteOptions, OrderBy, WithFieldValue } from './firestoreTypes';
+export type FirebaseDataManagerDeleteMode = 'soft' | 'hard';
+export interface FirebaseDataManagerOptions {
+    readonly idResolver?: () => string;
+    readonly deleteMode?: FirebaseDataManagerDeleteMode;
+    readonly readMode?: FirestoreReadMode;
+    readonly preventOverwriteOnCreate?: boolean;
+    readonly errorInterceptor?: (error: unknown, ctx: FirestoreReferenceContext | FirestoreListContext) => void;
+    readonly snapshotOptions?: FirestoreTypes.SnapshotOptions;
+    readonly Reference?: typeof FirestoreReference;
+    readonly List?: typeof FirestoreList;
+    readonly listCache?: Cache;
+    readonly refCache?: Cache;
+}
+export interface QueryParams<T extends FirestoreTypes.DocumentData> {
+    readonly filters?: Array<FilterBy<T & FirestoreSerializedMetadata>>;
+    readonly orderBy?: Array<OrderBy<T & FirestoreSerializedMetadata>>;
+}
+export declare class FirestoreDataManager<T extends FirestoreTypes.DocumentData, SerializedT extends FirestoreTypes.DocumentData = T> implements DataManager<T> {
+    private readonly firestore;
+    private readonly collectionPath;
+    private readonly converter;
+    private readonly opts?;
+    private mergedConverter;
+    private collection;
+    private collectionQuery;
+    private managerOptions;
+    private refCache;
+    private listCache;
+    constructor(firestore: Firestore, collectionPath: string, converter: FirestoreDataConverter<T, SerializedT>, opts?: FirebaseDataManagerOptions | undefined);
+    read(id: string, options?: FirestoreReadOptions): Promise<WithMetadata<T> | undefined>;
+    create(data: WithFieldValue<WithoutId<T>>, options?: FirebaseCreateOptions): Promise<IdentifiableReference<WithMetadata<T>>>;
+    private _update;
+    update(id: string, data: WithoutId<Partial<WithFieldValue<T>>>, options?: FirestoreWriteOptions): Promise<void>;
+    upsert(id: string, data: WithFieldValue<WithoutId<T>>, options?: FirestoreWriteOptions): Promise<void>;
+    delete(id: string, options?: FirestoreWriteOptions): Promise<void>;
+    getRef(id: string): IdentifiableReference<WithMetadata<T>>;
+    private _getFilteredQuery;
+    getList(params?: QueryParams<SerializedT> & ListPaginationParams): List<WithMetadata<T>>;
+    private preventOverwriteOnCreate;
+}

package/lib/FirestoreList.d.ts

@@ -0,0 +1,23 @@
+import { ListPaginationParams, LiveList, LiveListOptions } from '@data-weave/datamanager/src';
+import { DocumentData, Firestore, FirestoreReadMode, FirestoreTypes } from './firestoreTypes';
+export interface FirestoreListContext {
+    query: FirestoreTypes.Query<unknown>;
+    readMode?: FirestoreReadMode;
+    type: 'list';
+}
+export interface FirestoreListOptions<T> extends LiveListOptions<T> {
+    readMode?: FirestoreReadMode;
+    errorInterceptor?: (error: unknown, ctx: FirestoreListContext) => void;
+}
+export declare class FirestoreList<T extends DocumentData, S extends DocumentData> extends LiveList<T> {
+    private readonly firestore;
+    private readonly query;
+    private readonly options;
+    private unsubscribeFromSnapshot;
+    constructor(firestore: Firestore, query: FirestoreTypes.Query<T, S>, options: FirestoreListOptions<T> & ListPaginationParams);
+    resolve(): Promise<T[]>;
+    protected handleInitialDataChange(values: FirestoreTypes.QueryDocumentSnapshot<T, S>[]): void;
+    protected handleSubsequentDataChanges(changes: FirestoreTypes.DocumentChange<T, S>[]): void;
+    unSubscribe(): void;
+    protected onError(error: unknown): void;
+}

package/lib/FirestoreMetadata.d.ts

@@ -0,0 +1,32 @@
+import { Metadata, WithoutId } from '@data-weave/datamanager/src';
+import { DocumentData, FirestoreQuery, FirestoreTypes, FirestoreWhere, InternalFirestoreDataConverter, WithFieldValue } from './firestoreTypes';
+declare enum FIRESTORE_INTERAL_KEYS {
+    DELETED = "__deleted",
+    CREATED_AT = "__createdAt",
+    UPDATED_AT = "__updatedAt"
+}
+export declare enum FIRESTORE_KEYS {
+    DELETED = "deleted",
+    CREATED_AT = "createdAt",
+    UPDATED_AT = "updatedAt"
+}
+export type FirestoreSerializedMetadata = {
+    [FIRESTORE_INTERAL_KEYS.DELETED]: boolean;
+    [FIRESTORE_INTERAL_KEYS.CREATED_AT]: FirestoreTypes.Timestamp;
+    [FIRESTORE_INTERAL_KEYS.UPDATED_AT]: FirestoreTypes.Timestamp;
+};
+export declare class FirestoreMetadataConverter implements InternalFirestoreDataConverter<Metadata, FirestoreSerializedMetadata> {
+    toFirestore(data: WithFieldValue<WithoutId<Metadata>>): {
+        __deleted: FirestoreTypes.FieldValue | FirestoreTypes.WithFieldValue<boolean>;
+        __createdAt: FirestoreTypes.Timestamp;
+        __updatedAt: FirestoreTypes.Timestamp;
+    };
+    fromFirestore(snapshot: FirestoreTypes.QueryDocumentSnapshot<DocumentData, DocumentData>, options: FirestoreTypes.SnapshotOptions): {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        deleted: boolean;
+    };
+}
+export declare const queryNotDeleted: <T extends DocumentData, SerializedT extends DocumentData>(query: FirestoreTypes.Query<T, SerializedT>, firestoreQuery: FirestoreQuery<T, SerializedT>, firestoreWhere: FirestoreWhere) => FirestoreTypes.Query<T, SerializedT>;
+export {};

package/lib/FirestoreReference.d.ts

@@ -0,0 +1,27 @@
+import { LiveReference, LiveReferenceOptions } from '@data-weave/datamanager/src';
+import { DocumentData, Firestore, FirestoreReadMode, FirestoreTypes } from './firestoreTypes';
+export interface FirestoreReferenceContext {
+    path: string;
+    id: string;
+    readMode?: FirestoreReadMode;
+    snapshotOptions?: FirestoreTypes.SnapshotOptions;
+    type: 'reference';
+}
+export interface FirestoreReferenceOptions<T> extends LiveReferenceOptions<T> {
+    readMode?: FirestoreReadMode;
+    snapshotOptions?: FirestoreTypes.SnapshotOptions;
+    errorInterceptor?: (error: unknown, ctx: FirestoreReferenceContext) => void;
+}
+export declare class FirestoreReference<T extends DocumentData, S extends DocumentData> extends LiveReference<T> {
+    private readonly firestore;
+    private readonly docRef;
+    readonly options: FirestoreReferenceOptions<T>;
+    private unsubscribeFromSnapshot;
+    constructor(firestore: Firestore, docRef: FirestoreTypes.DocumentReference<T, S>, options: FirestoreReferenceOptions<T>);
+    resolve(): Promise<T | undefined>;
+    get id(): string;
+    get path(): string;
+    protected onError(error: unknown): void;
+    unSubscribe(): void;
+    private parseDocumentSnapshot;
+}

package/lib/firestoreTypes.d.ts

@@ -0,0 +1,117 @@
+import { WithoutId } from '@data-weave/datamanager/src';
+import type * as FirestoreTypes from '@firebase/firestore';
+import type { FieldPath, WithFieldValue as FirestoreWithFieldValue, QueryConstraint } from '@firebase/firestore';
+import type { HttpsCallable, HttpsCallableOptions } from '@firebase/functions-types';
+import { FieldValue, Transaction } from '@google-cloud/firestore';
+export type DocumentData = FirestoreTypes.DocumentData;
+export { FieldValue, FirestoreTypes, Transaction };
+/**
+ * Same as Partial but all fields are required to be included
+ */
+type OptionallyUndefined<T> = {
+    [P in keyof T]: T[P] | undefined;
+};
+export declare interface InternalFirestoreDataConverter<T extends DocumentData, SerializedT extends DocumentData = DocumentData> {
+    toFirestore(modelObject: Partial<WithFieldValue<WithoutId<T>>>, options?: FirestoreTypes.SetOptions): WithFieldValue<WithoutId<SerializedT>>;
+    fromFirestore(snapshot: FirestoreTypes.QueryDocumentSnapshot<T, SerializedT>, options?: FirestoreTypes.SnapshotOptions): T;
+}
+export type WithTimestamps<T> = {
+    [K in keyof T]: T[K] extends Date ? FirestoreTypes.Timestamp : T[K] extends Date | null ? FirestoreTypes.Timestamp | null : T[K] extends Date | undefined ? FirestoreTypes.Timestamp | undefined : T[K] extends Date | null | undefined ? FirestoreTypes.Timestamp | null | undefined : T[K] extends object ? T[K] extends any[] ? T[K] extends (infer U)[] ? WithTimestamps<U>[] : T[K] : WithTimestamps<T[K]> : T[K];
+};
+/**
+ * Converts data between model and serialized data. Differs from InternalFirestoreDataConverter
+ * by using `OptionallyUndefined` and `Required` to ensure that all fields are included in de/serialization
+ * even if some model defined properties are optional.
+ */
+export declare interface FirestoreDataConverter<ModelObject, SerializedModelObject = ModelObject> {
+    toFirestore(modelObject: WithoutId<ModelObject>, options?: FirestoreTypes.SetOptions): OptionallyUndefined<Required<WithoutId<WithFieldValue<SerializedModelObject>>>>;
+    fromFirestore(snapshot: FirestoreTypes.QueryDocumentSnapshot<WithTimestamps<SerializedModelObject>>, options?: FirestoreTypes.SnapshotOptions): ModelObject;
+}
+export type FirestoreQuery<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> = (reference: FirestoreTypes.Query<AppModelType, DbModelType>, filter: any) => FirestoreTypes.Query<AppModelType, DbModelType>;
+export type FirestoreWhere = (field: string | FieldPath, op: string, value: unknown) => any;
+export type FirestoreReadMode = 'realtime' | 'static';
+export interface FirestoreReadOptions {
+    readonly transaction?: FirestoreTypes.Transaction;
+}
+export interface FirestoreWriteOptions {
+    readonly transaction?: FirestoreTypes.Transaction;
+    readonly batcher?: FirestoreTypes.WriteBatch;
+}
+export interface FirebaseCreateOptions extends FirestoreWriteOptions {
+    id?: string;
+    merge?: boolean;
+}
+export declare type WithFieldValue<T> = {
+    [K in keyof T]: FirestoreWithFieldValue<T[K]> | FirestoreTypes.FieldValue;
+};
+type GenNode<K extends string, IsRoot extends boolean> = IsRoot extends true ? `${K}` : `.${K}`;
+export type FilterableFields<T extends object, IsRoot extends boolean = true, K extends keyof T = keyof T> = K extends string ? T[K] extends FirestoreTypes.Timestamp ? `${K}` : T[K] extends Date ? `${K}` : T[K] extends any[] ? GenNode<K, IsRoot> : T[K] extends object ? `${GenNode<K, IsRoot>}${FilterableFields<T[K], false>}` : GenNode<K, IsRoot> : never;
+type GetValue<T, K extends string> = K extends `${infer L}.${infer R}` ? L extends keyof T ? GetValue<T[L], R> : never : K extends keyof T ? T[K] extends Date ? Date | FirestoreTypes.Timestamp : T[K] : K extends string ? string | number | boolean : never;
+export type PrimitiveFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>';
+export type FilterBy<T extends object, Field extends string = FilterableFields<T>> = Field extends string ? GetValue<T, Field> extends any[] ? [Field, 'array-contains', string] | [Field, 'array-contains-any', string[]] : [Field, PrimitiveFilterOp, GetValue<T, Field>] | [Field, 'in', string[]] : never;
+export type OrderBy<T extends DocumentData, Fields extends string = FilterableFields<T>> = [
+    Fields,
+    FirestoreTypes.OrderByDirection
+];
+export declare abstract class FieldValues {
+    abstract serverTimestamp(): FirestoreTypes.FieldValue;
+    abstract delete(): FirestoreTypes.FieldValue;
+    abstract increment(n: number): FirestoreTypes.FieldValue;
+    abstract arrayUnion(...elements: any[]): FirestoreTypes.FieldValue;
+    abstract arrayRemove(...elements: any[]): FirestoreTypes.FieldValue;
+}
+/**********
+ *
+ *
+ * INJECTABLES
+ *
+ *
+ * **********/
+export interface FirestoreAppSettings {
+    persistence?: boolean;
+    cacheSizeBytes?: number;
+    host?: string;
+    ssl?: boolean;
+    ignoreUndefinedProperties?: boolean;
+    serverTimestampBehavior?: 'estimate' | 'previous' | 'none';
+}
+export declare abstract class FirestoreApp {
+    abstract type?: string;
+    abstract toJSON?(): object;
+    abstract terminate?(): Promise<void>;
+    abstract settings?(settings: FirestoreAppSettings): void;
+    abstract useEmulator?(host: string, port: number): void;
+    abstract runTransaction?<T>(updateFunction: (transaction: Transaction) => Promise<T>, options?: FirestoreTypes.TransactionOptions): Promise<T>;
+}
+export declare abstract class Firestore {
+    abstract app: FirestoreApp;
+    abstract collection(reference: FirestoreTypes.CollectionReference | FirestoreApp, path: string): any;
+    abstract getDocs<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(reference: FirestoreTypes.Query<AppModelType, DbModelType>): Promise<FirestoreTypes.QuerySnapshot<AppModelType, DbModelType>>;
+    abstract getDoc<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(reference: FirestoreTypes.DocumentReference<AppModelType, DbModelType>, path?: string): Promise<FirestoreTypes.DocumentSnapshot<AppModelType, DbModelType>>;
+    abstract serverTimestamp(): FirestoreTypes.FieldValue;
+    abstract increment(n: number): FirestoreTypes.FieldValue;
+    abstract query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(reference: FirestoreTypes.Query<AppModelType, DbModelType>, filter: any): FirestoreTypes.Query<AppModelType, DbModelType>;
+    abstract where(field: string | FieldPath, op: string, value: unknown): QueryConstraint;
+    abstract limit(limit: number): any;
+    abstract orderBy(orderBy: string, direction: FirestoreTypes.OrderByDirection): any;
+    abstract setDoc<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(reference: FirestoreTypes.DocumentReference<AppModelType, DbModelType>, data: any, options?: FirestoreTypes.SetOptions): Promise<void>;
+    abstract updateDoc<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(reference: FirestoreTypes.DocumentReference<AppModelType, DbModelType>, data: any): Promise<void>;
+    abstract doc<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(reference: FirestoreTypes.Query<AppModelType, DbModelType>, path?: string): FirestoreTypes.DocumentReference<AppModelType, DbModelType>;
+    abstract deleteDoc<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(reference: FirestoreTypes.DocumentReference<AppModelType, DbModelType>): Promise<void>;
+    abstract onSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(reference: FirestoreTypes.DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: FirestoreTypes.DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: Error) => void): () => void;
+    abstract onSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>(reference: FirestoreTypes.Query<AppModelType, DbModelType>, onNext: (snapshot: FirestoreTypes.QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: Error) => void): () => void;
+    abstract runTransaction<T>(firestore: FirestoreApp, transaction: (transaction: Transaction) => Promise<T>, options?: FirestoreTypes.TransactionOptions): Promise<T>;
+}
+export declare abstract class FirestoreSettings {
+    abstract readMode: FirestoreReadMode;
+}
+export declare abstract class FirestoreFunctions {
+    abstract httpsCallable(name: string, options?: HttpsCallableOptions): HttpsCallable;
+    abstract useEmulator(host: string, port: number): void;
+    abstract useFunctionsEmulator(origin: string): void;
+}
+export declare class DummyFirestoreFunctions implements FirestoreFunctions {
+    httpsCallable(): HttpsCallable;
+    useEmulator(): void;
+    useFunctionsEmulator(): void;
+}

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+export * from './FirestoreDataManager';
+export * from './FirestoreList';
+export * from './FirestoreMetadata';
+export * from './FirestoreReference';
+export * from './firestoreTypes';
+export * from './utils';

package/lib/utils.d.ts

@@ -0,0 +1,14 @@
+import { WithoutId } from '@data-weave/datamanager/src';
+import { DocumentData, Firestore, FirestoreTypes, InternalFirestoreDataConverter, Transaction, WithFieldValue } from './firestoreTypes';
+import { Firestore as FirebaseFirestore } from 'firebase/firestore';
+export declare class MergeConverters<T extends DocumentData, SerializedT extends DocumentData, G extends DocumentData, SerializedG extends DocumentData> implements InternalFirestoreDataConverter<T & G, SerializedT & SerializedG> {
+    private converter1;
+    private converter2;
+    constructor(converter1: InternalFirestoreDataConverter<T, SerializedT>, converter2: InternalFirestoreDataConverter<G, SerializedG>);
+    toFirestore(modelObject: WithoutId<Partial<WithFieldValue<T>>> & WithoutId<Partial<WithFieldValue<G>>>, options?: FirestoreTypes.SetOptions): WithFieldValue<WithoutId<SerializedT>> & WithFieldValue<WithoutId<SerializedG>>;
+    fromFirestore(snapshot: FirestoreTypes.QueryDocumentSnapshot<T & G, SerializedT & SerializedG>, options: FirestoreTypes.SnapshotOptions): T & G;
+}
+export declare function createModularFirestoreAdapter(firestore: FirebaseFirestore): Firestore;
+export declare const isFieldValue: (value: any) => value is FirestoreTypes.FieldValue;
+export declare const checkIfReferenceExists: (value: any) => boolean;
+export declare const withTransaction: (firestore: Firestore, transaction: (transaction: Transaction) => Promise<void>, options?: FirestoreTypes.TransactionOptions) => Promise<void>;

package/lib/version.d.ts

@@ -0,0 +1,2 @@
+declare const _exports: string;
+export = _exports;

package/lib/version.js

@@ -1,3 +1,3 @@
 "use strict";
 // Generated by genversion.
-module.exports = '0.4.5';
+module.exports = '0.4.6';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@data-weave/backend-firestore",
-    "version": "0.4.5",
+    "version": "0.4.6",
     "author": "",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -23,8 +23,8 @@
         "registry": "https://registry.npmjs.org/"
     },
     "peerDependencies": {
-        "@data-weave/datamanager": "0.4.3",
+        "@data-weave/datamanager": "0.4.5",
         "firebase": ">=11.0.0"
     },
-    "gitHead": "e78bab6280bc98003ab4dc48a4fda336b5c0f80f"
+    "gitHead": "2c6e04cf115b898b39b24782c3c2f15a92cc1604"
 }