Skip to content
Merged
Prev Previous commit
Next Next commit
Updated type definitions - #311
  • Loading branch information
prescottprue committed Oct 29, 2017
commit 6a89f75c59acbac3dec570006df72d376414058c
275 changes: 225 additions & 50 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
// import * as firebase from 'firebase/app.d'
/** Declaration file generated by dts-gen */
//** Declaration file generated by dts-gen */

export const actionTypes: {
AUTHENTICATION_INIT_FINISHED: string;
AUTHENTICATION_INIT_STARTED: string;
AUTH_EMPTY_CHANGE: string;
AUTH_LINK_ERROR: string;
AUTH_LINK_START: string;
AUTH_LINK_SUCCESS: string;
AUTH_RELOAD_ERROR: string;
AUTH_RELOAD_START: string;
AUTH_RELOAD_SUCCESS: string;
AUTH_UPDATE_ERROR: string;
AUTH_UPDATE_START: string;
AUTH_UPDATE_SUCCESS: string;
CLEAR_ERRORS: string;
EMAIL_UPDATE_ERROR: string;
EMAIL_UPDATE_START: string;
EMAIL_UPDATE_SUCCESS: string;
Expand All @@ -21,11 +29,16 @@ export const actionTypes: {
LOGIN: string;
LOGIN_ERROR: string;
LOGOUT: string;
MERGE: string;
NO_VALUE: string;
PROFILE_UPDATE_ERROR: string;
PROFILE_UPDATE_START: string;
PROFILE_UPDATE_SUCCESS: string;
REMOVE: string;
SESSION_END: string;
SESSION_START: string;
SET: string;
SET_LISTENER: string;
SET_PROFILE: string;
START: string;
UNAUTHORIZED_ERROR: string;
Expand All @@ -36,9 +49,17 @@ export const constants: {
actionTypes: {
AUTHENTICATION_INIT_FINISHED: string;
AUTHENTICATION_INIT_STARTED: string;
AUTH_EMPTY_CHANGE: string;
AUTH_LINK_ERROR: string;
AUTH_LINK_START: string;
AUTH_LINK_SUCCESS: string;
AUTH_RELOAD_ERROR: string;
AUTH_RELOAD_START: string;
AUTH_RELOAD_SUCCESS: string;
AUTH_UPDATE_ERROR: string;
AUTH_UPDATE_START: string;
AUTH_UPDATE_SUCCESS: string;
CLEAR_ERRORS: string;
EMAIL_UPDATE_ERROR: string;
EMAIL_UPDATE_START: string;
EMAIL_UPDATE_SUCCESS: string;
Expand All @@ -53,129 +74,228 @@ export const constants: {
LOGIN: string;
LOGIN_ERROR: string;
LOGOUT: string;
MERGE: string;
NO_VALUE: string;
PROFILE_UPDATE_ERROR: string;
PROFILE_UPDATE_START: string;
PROFILE_UPDATE_SUCCESS: string;
REMOVE: string;
SESSION_END: string;
SESSION_START: string;
SET: string;
SET_LISTENER: string;
SET_PROFILE: string;
START: string;
UNAUTHORIZED_ERROR: string;
UNSET_LISTENER: string;
};
defaultConfig: ReduxFirebaseConfig;
defaultConfig: {
attachAuthIsReady: boolean;
autoPopulateProfile: boolean;
dispatchOnUnsetListener: boolean;
dispatchRemoveAction: boolean;
enableEmptyAuthChanges: boolean;
enableLogging: boolean;
enableRedirectHandling: boolean;
firebaseStateName: string;
presence: any;
preserveOnEmptyAuthChange: any;
preserveOnLogout: any;
resetBeforeLogin: boolean;
sessions: string;
setProfilePopulateResults: boolean;
updateProfileOnLogin: boolean;
userProfile: any;
};
};

/**
* Object whose values correspond to different reducer functions.
*/
export interface ReduxFirebaseConfig {
autoPopulateProfile: boolean;
dispatchOnUnsetListener: boolean;
enableEmptyAuthChanges: boolean;
enableLogging: boolean;
enableRedirectHandling: boolean;
setProfilePopulateResults: boolean;
updateProfileOnLogin: boolean;
userProfile: string;
}

export interface listenerConfigFunc {
(): string[] | object[]
}

export interface FirebaseInstance {

}


/**
* Promise which resolves when auth state has loaded.
*/
export function authIsReady(store: object, ...args: any[]): any;

/**
* Factory function for creating a firebaseConnect Higher Order Component
*/
export function createFirebaseConnect(...args: any[]): any;

export function createFirebaseInstance(firebase: any, configs: any, dispatch: any, ...args: any[]): any;

export function createFirestoreConnect(...args: any[]): any;

export function createWithFirebase(storeKey: any): any;

export function createWithFirestore(storeKey: any): any;

export function firebase(...args: any[]): any;

/**
* React HOC that attaches/detaches listeners on mount/unmount.
* React HOC that attaches/detaches Firebase Real Time Database listeners on mount/unmount
*/
export function firebaseConnect(...args: any[]): any;

/**
* Reducer for Firebase state
*/
export function firebaseStateReducer(state: object, action : object): object;
export function firebaseReducer(...args: any[]): any;

export function getFirebase(): object;
/**
* Reducer for Firebase state
*/
export function firebaseStateReducer(...args: any[]): any;

export function isEmpty(...args: any[]): boolean;
/**
* React HOC that attaches/detaches Cloud Firestore listeners on mount/unmount
*/
export function firestoreConnect(...args: any[]): any;

/**
* Reducer for Firestore state
*/
export function firestoreReducer(...args: any[]): any;

export function fixPath(path: string): string;

/**
* Checks whether or not data is empty
* Get Firebase instance
*/
export function getFirebase(): any;

export function getVal(firebase: object, path: string, notSetValue: any): any;

export function isEmpty(...args: any[]): boolean;

export function isLoaded(...args: any[]): boolean;

export function ordered(firebaseState: object, path: string, notSetValue: any): any;
export function populate(state: object, path: string, populates: any, notSetValue: any): any;

export function populate(firebaseState: object, path: string, populates: object[], notSetValue: any): any;
export function reactReduxFirebase(instance: object, otherConfig: any): any;

export function reduxFirebase(instance: any, otherConfig: any): any;

export function reduxReactFirebase(instance: object, otherConfig: any): any;

/**
* React Higher Order Component that passes firebase as a prop (comes from context.store.firebase)
*/
export function withFirebase(...args: any[]): any;
/**
* Redux store enhancer that adds store.firebase (for use with firebaseConnect)
* React Higher Order Component that passes firestore as a prop (comes from context.store.firestore)
*/
export function reactReduxFirebase(fbInstance: FirebaseInstance, config: ReduxFirebaseConfig): object;
export function withFirestore(...args: any[]): any;

export namespace authIsReady {
const prototype: {
};

}

export namespace createFirebaseConnect {
const prototype: {
};

}

export namespace createFirebaseInstance {
const prototype: {
};

export function reduxFirebase(fbInstance: FirebaseInstance, config: ReduxFirebaseConfig): object;
}

export function reduxReactFirebase(fbInstance: FirebaseInstance, config: ReduxFirebaseConfig): object;
export namespace createFirestoreConnect {
const prototype: {
};

}

export namespace createWithFirebase {
const prototype: {
};

}

export namespace createWithFirestore {
const prototype: {
};

}

export namespace firebase {
const prototype: {
};

}

export namespace firebaseConnect {
const prototype: {
};

}

export namespace firebaseReducer {
const prototype: {
};

}

export namespace firebaseStateReducer {
const prototype: {
};

}

export namespace getFirebase {
export namespace firestoreConnect {
const prototype: {
};

}

/**
* Checks whether or not data is empty
*/
export namespace isEmpty {
export namespace firestoreReducer {
const prototype: {
};

}

/**
* Checks whether or not data has been loaded
*/
export namespace isLoaded {
export namespace fixPath {
const prototype: {
};

}

export namespace reactReduxFirebase {
export namespace getFirebase {
const prototype: {
};

}

export namespace reduxFirebase {
export namespace getVal {
const prototype: {
};

}

export namespace helpers {
function isEmpty(data: any): any;
function fixPath(path: any): any;

function getVal(firebase: any, path: any, notSetValue: any): any;

function isEmpty(...args: any[]): any;

function isLoaded(...args: any[]): any;

function ordered(data: any, path: any, notSetValue: any): any;
function populate(state: any, path: any, populates: any, notSetValue: any): any;

namespace fixPath {
const prototype: {
};

function populate(data: any, path: any, populates: any, notSetValue: any): any;
}

namespace getVal {
const prototype: {
};

}

namespace isEmpty {
const prototype: {
Expand All @@ -188,4 +308,59 @@ export namespace helpers {
};

}

namespace populate {
const prototype: {
};

}

}

export namespace isEmpty {
const prototype: {
};

}

export namespace isLoaded {
const prototype: {
};

}

export namespace populate {
const prototype: {
};

}

export namespace reactReduxFirebase {
const prototype: {
};

}

export namespace reduxFirebase {
const prototype: {
};

}

export namespace reduxReactFirebase {
const prototype: {
};

}

export namespace withFirebase {
const prototype: {
};

}

export namespace withFirestore {
const prototype: {
};

}