@entropic-bond/firebase 1.12.0 → 1.13.0

package/src/cloud-storage/firebase-cloud-storage.ts

@@ -0,0 +1,67 @@
+import { registerCloudStorage, CloudStorage, UploadControl, UploadProgress } from 'entropic-bond'
+import { deleteObject, getDownloadURL, ref, uploadBytesResumable, UploadTask, connectStorageEmulator } from 'firebase/storage'
+import { EmulatorConfig, FirebaseHelper } from '../firebase-helper'
+
+@registerCloudStorage( 'FirebaseCloudStorage', ()=> new FirebaseCloudStorage() )
+export class FirebaseCloudStorage extends CloudStorage {
+	constructor( emulator?: EmulatorConfig ) {
+		super()
+		if ( emulator ) FirebaseHelper.useEmulator( emulator )
+		
+		if ( FirebaseHelper.emulator?.emulate ) {
+			const { host, storagePort } = FirebaseHelper.emulator
+			connectStorageEmulator( FirebaseHelper.instance.storage(), host, storagePort )
+		}
+	}
+
+	save( id: string, data: Blob | Uint8Array | ArrayBuffer, progress?: UploadProgress ): Promise<string> {
+		const storage = FirebaseHelper.instance.storage()
+
+		return new Promise<string>(( resolve, reject ) => {
+			this._uploadTask = uploadBytesResumable( ref( storage, id ), data )
+			
+			if ( progress ) {
+				var unsubscribe = this._uploadTask.on( 'state_changed', 
+					snapshot => {
+						progress( snapshot.bytesTransferred, snapshot.totalBytes )
+					},
+					null, 
+					()=>unsubscribe() 
+				);
+			}
+
+			this._uploadTask
+				.then( () => resolve( id ) )
+				.catch( error => reject( error ))
+		})
+	}
+
+	getUrl( reference: string ): Promise<string> {
+		if ( !reference ) return Promise.reject( 'needs a reference' )
+
+		const storage = FirebaseHelper.instance.storage()
+		return getDownloadURL( ref( storage, reference ) )
+	}
+
+	uploadControl(): UploadControl {
+		if ( !this._uploadTask ) throw new Error( `You should call save() before uploadControl()` )
+
+		return {
+			cancel: ()=>this._uploadTask?.cancel(),
+			pause: ()=>this._uploadTask?.pause(),
+			resume: ()=>this._uploadTask?.resume(),
+			onProgress: ( callback )=> this._uploadTask?.on( 'state_changed', snapShot => {
+				if ( callback ) {
+					callback( snapShot.bytesTransferred, snapShot.totalBytes )
+				}
+			})
+		}
+	}
+
+	delete( reference: string ): Promise<void> {
+		const storage = FirebaseHelper.instance.storage()
+		return deleteObject( ref( storage, reference ) )
+	}
+
+	private _uploadTask: UploadTask | undefined
+}

package/src/firebase-helper.ts

@@ -0,0 +1,92 @@
+import { FirebaseApp, initializeApp } from "firebase/app"
+import { CollectionReference, DocumentData, getFirestore, Query } from 'firebase/firestore'
+import { getAuth } from 'firebase/auth'
+import { getStorage } from 'firebase/storage'
+import { getFunctions } from 'firebase/functions'
+
+export type FirebaseQuery = CollectionReference<DocumentData> 
+							| Query<DocumentData>
+
+export interface FirebaseConfig {
+	apiKey?: string,
+	authDomain?: string,
+	projectId: string,
+	databaseURL?: string,
+	storageBucket?: string,
+	messagingSenderId?: string,
+	appId?: string,
+	measurementId?: string
+}
+
+export interface EmulatorConfig {
+	host: string
+	firestorePort: number
+	storagePort: number
+	authPort: number
+	functionsPort: number
+	emulate: boolean
+}
+
+export class FirebaseHelper {
+	
+	static setFirebaseConfig( config: FirebaseConfig ) {
+		FirebaseHelper._firebaseConfig = config
+	}
+
+	private static defaultEmulatorConfig = {
+		host: 'localhost',
+		firestorePort: 8080,
+		storagePort: 9199,
+		authPort: 9099,
+		functionsPort: 5001,
+		emulate: false
+	}
+
+	static useEmulator( emulatorConfig?: Partial<EmulatorConfig> ) {
+
+		this._emulatorConfig = {
+			...FirebaseHelper.defaultEmulatorConfig,
+			emulate: true,
+			...emulatorConfig
+		}
+	}
+
+	static get emulator() {
+		return this._emulatorConfig
+	}
+
+	private constructor() {
+		if ( !FirebaseHelper._firebaseConfig ) throw new Error( 'You should set a firebase config object before using Firebase' )
+		this._firebaseApp = initializeApp( FirebaseHelper._firebaseConfig )
+	}
+
+	static get instance() {
+		return this._instance || ( this._instance = new FirebaseHelper() )
+	}
+
+	firestore() {
+		return getFirestore( this._firebaseApp )
+	}
+
+	storage() {
+		return getStorage( this._firebaseApp )
+	}
+
+	auth() {
+		return getAuth( this._firebaseApp )
+	}
+
+	functions() {
+		return getFunctions( this._firebaseApp, FirebaseHelper._region )
+	}
+
+	static setRegion( region: string ) {
+		this._region = region
+	}
+
+	private static _instance: FirebaseHelper
+	private static _firebaseConfig: FirebaseConfig
+	private static _emulatorConfig: EmulatorConfig = FirebaseHelper.defaultEmulatorConfig
+	private static _region: string
+	private _firebaseApp: FirebaseApp
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from './store/firebase-datasource'
+export * from './firebase-helper'
+export * from './cloud-storage/firebase-cloud-storage'
+export * from './auth/firebase-auth'
+export * from './cloud-functions/firebase-cloud-functions'

package/src/mocks/mock-data.json

@@ -0,0 +1,148 @@
+{
+	"TestUser": {
+		"user1": {
+			"__className": "TestUser",
+			"id": "user1",
+			"name": {
+				"firstName": "userFirstName1",
+				"lastName": "userLastName1"
+			},
+			"age": 23,
+			"admin": true,
+			"skills": ["skill1", "skill2", "skill3"]
+		},
+		"user2": {
+			"__className": "TestUser",
+			"id": "user2",
+			"name": {
+				"firstName": "userFirstName2",
+				"lastName": "userLastName2",
+				"ancestorName": {
+					"father": "user2Father"
+				}
+			},
+			"age": 21,
+			"admin": false,
+			"skills": ["skill1", "skill2", "skill3"],
+			"colleagues": [
+				{ 
+					"id": "colleague1",
+					"__className": "TestUser"
+				},
+				{ 
+					"id": "user3",
+					"__className": "TestUser"
+				}
+			],
+			"__colleagues_searchable": [ "colleague1", "user3" ]
+		},
+		"user3": {
+			"__className": "TestUser",
+			"id": "user3",
+			"name": {
+				"firstName": "userFirstName3",
+				"lastName": "userLastName3",
+				"ancestorName": {
+					"father": "user3Father"
+				}
+			},
+			"age": 56,
+			"admin": true,
+			"skills": ["skill21", "skill22", "skill23"],
+			"colleagues": [
+				{ 
+					"id": "user1",
+					"__className": "TestUser"
+				},
+				{ 
+					"id": "user3",
+					"__className": "TestUser"
+				}
+			],
+			"__colleagues_searchable": [ "user1", "user3" ]
+		},
+		"user4": {
+			"__className": "DerivedUser",
+			"id": "user4",
+			"name": {
+				"firstName": "userFirstName4",
+				"lastName": "userLastName4"
+			},
+			"age": 35,
+			"admin": false,
+			"skills": ["skill41", "skill42", "skill43"],
+			"salary": 2800,
+			"colleagues": [
+				{ 
+					"id": "colleague1",
+					"__className": "TestUser"
+				},
+				{ 
+					"id": "colleague2",
+					"__className": "TestUser"
+				}
+			],
+			"__colleagues_searchable": [ "colleague1", "colleague2" ]
+		},
+		"user5": {
+			"__className": "TestUser",
+			"id": "user5",
+			"name": {
+				"firstName": "userFirstName5",
+				"lastName": "userLastName5",
+				"ancestorName": {
+					"father": "user5Father"
+				}
+			},
+			"age": 41,
+			"skills": ["skill21", "skill22", "skill23"],
+			"derived": {
+				"id": "user3",
+				"__className": "DerivedUser",
+				"__documentReference": {
+					"storedInCollection": "DerivedUser"
+				}
+			}	
+		},
+		"user6": {
+			"__className": "TestUser",
+			"id": "user6",
+			"name": {
+				"firstName": "userFirstName6",
+				"lastName": "userLastName6",
+				"ancestorName": {
+					"father": "user6Father"
+				}
+			},
+			"age": 40,
+			"skills": ["skill21", "skill22", "skill23"],
+			"derived": {
+				"id": "user4",
+				"__className": "DerivedUser",
+				"__documentReference": {
+					"storedInCollection": "TestUser"
+				}
+			},
+			"colleagues": [
+				{ 
+					"id": "colleague2",
+					"__className": "TestUser"
+				}
+			],
+			"__colleagues_searchable": [ "colleague2" ]
+		}
+	},
+	"DerivedUser": {
+		"user4": {
+			"__className": "DerivedUser",
+			"id": "user5",
+			"name": {
+				"firstName": "userFirstName5",
+				"lastName": "userLastName5"
+			},
+			"age": 35,
+			"admin": false,
+			"salary": 2300
+		}
+	}
+}

package/src/mocks/test-user.ts

@@ -0,0 +1,121 @@
+import { persistent, Persistent, persistentReference, persistentReferenceAt, registerPersistentClass, searchableArray } from 'entropic-bond'
+
+interface Name { 
+	firstName: string, 
+	lastName: string 
+	ancestorName?: {
+		father?: string
+		mother?: string
+	}
+}
+
+@registerPersistentClass( 'SubClass' )
+export class SubClass extends Persistent {
+	set year( value: number | undefined ) {
+		this._year = value
+	}
+
+	get year() {
+		return this._year
+	}
+
+	@persistent private _year: number | undefined
+}
+
+@registerPersistentClass( 'TestUser' )
+export class TestUser extends Persistent {
+	set name( value: Name | undefined ) {
+		this._name = value
+	}
+
+	get name() {
+		return this._name
+	}
+
+	set age( value: number | undefined ) {
+		this._age = value
+	}
+
+	get age() {
+		return this._age
+	}
+
+	set admin( value: boolean | undefined ) {
+		this._admin = value
+	}
+
+	get admin() {
+		return this._admin
+	}
+
+	set skills( value: string[] | undefined ) {
+		this._skills = value
+	}
+
+	get skills() {
+		return this._skills
+	}
+
+	set documentRef( value: SubClass | undefined ) {
+		this._documentRef = value
+	}
+
+	get documentRef() {
+		return this._documentRef
+	}
+
+	set manyRefs(value: SubClass[]) {
+		this._manyRefs = value
+	}
+	
+	get manyRefs(): SubClass[] {
+		return this._manyRefs
+	}
+
+	set derived( value: DerivedUser | undefined ) {
+		this._derived = value
+	}
+	
+	get derived(): DerivedUser | undefined {
+		return this._derived
+	}
+	
+	set manyDerived( value: DerivedUser[] | undefined ) {
+		this._manyDerived = value
+	}
+	
+	get manyDerived(): DerivedUser[] | undefined {
+		return this._manyDerived
+	}
+
+	set colleagues( value: TestUser[] ) {
+		this._colleagues = value
+	}
+	
+	get colleagues(): TestUser[] {
+		return this._colleagues
+	}
+	
+	@persistent @searchableArray private _colleagues: TestUser[] = []
+	@persistent private _name: Name | undefined
+	@persistent private _age: number | undefined
+	@persistent private _admin: boolean | undefined
+	@persistent private _skills: string[] | undefined
+	@persistentReference private _documentRef: SubClass | undefined
+	@persistentReference private _manyRefs: SubClass[] = []
+	@persistentReferenceAt('TestUser') private _derived: DerivedUser | undefined
+	@persistentReferenceAt('TestUser') private _manyDerived: DerivedUser[] | undefined
+}
+
+@registerPersistentClass( 'DerivedUser' )
+export class DerivedUser extends TestUser {
+	set salary(value: number | undefined ) {
+		this._salary = value
+	}
+	
+	get salary(): number | undefined {
+		return this._salary
+	}
+	
+	@persistent private _salary: number | undefined
+}