firebase-api-surface - npm Package Compare versions

Comparing version 0.6.0 to 0.6.1

lib/index.d.ts

@@ -1,5 +0,7 @@
-export { RTDBEventType, IRTDBDatabase, IRTDBDataSnapshot, IRTDBOnDisconnect, IRTDBQuery, IRTDBReference, IRTDBTransactionResult } from "./rtdb2";
+import * as rtdb from "./rtdb";
 import * as storage from "./storage";
-export { storage };
 import * as firestore from "./firestore";
-export { firestore };
+import * as messaging from "./messaging";
+import * as app from "./app";
+import * as auth from "./auth";
+export { app, auth, rtdb, storage, firestore, messaging };

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const rtdb = require("./rtdb");
+exports.rtdb = rtdb;
 const storage = require("./storage");
@@ -7,1 +9,7 @@ exports.storage = storage;
 exports.firestore = firestore;
+const messaging = require("./messaging");
+exports.messaging = messaging;
+const app = require("./app");
+exports.app = app;
+const auth = require("./auth");
+exports.auth = auth;

lib/rtdb.d.ts

@@ -5,24 +5,24 @@ import { FirebaseApp } from "@firebase/app-types";
     readonly app: FirebaseApp;
-    ref(pathString?: string): Reference;
-    refFromURL(url: string): Reference;
+    ref(pathString?: string): IReference;
+    refFromURL(url: string): IReference;
     goOffline(): void;
     goOnline(): void;
 }
-export interface Query<T = any> {
+export interface IQuery<T = any> {
     off(eventType?: EventType, callback?: ISnapshotCallback, context?: Object): void;
-    once(eventType: EventType, userCallback?: ISnapshotCallback, cancelOrContext?: ((a: Error) => void) | Object, context?: Object): Promise<DataSnapshot<T>>;
-    limitToFirst(limit: number): Query<T>;
-    limitToLast(limit: number): Query<T>;
-    orderByChild(path: string): Query<T>;
-    orderByKey(): Query<T>;
-    orderByPriority(): Query<T>;
-    orderByValue(): Query<T>;
-    startAt(value?: number | string | boolean | null, name?: string | null): Query<T>;
-    endAt(value?: number | string | boolean | null, name?: string | null): Query<T>;
-    equalTo(value: number | string | boolean | null, name?: string): Query;
+    once(eventType: EventType, userCallback?: ISnapshotCallback, cancelOrContext?: ((a: Error) => void) | Object, context?: Object): Promise<IDataSnapshot<T>>;
+    limitToFirst(limit: number): IQuery<T>;
+    limitToLast(limit: number): IQuery<T>;
+    orderByChild(path: string): IQuery<T>;
+    orderByKey(): IQuery<T>;
+    orderByPriority(): IQuery<T>;
+    orderByValue(): IQuery<T>;
+    startAt(value?: number | string | boolean | null, name?: string | null): IQuery<T>;
+    endAt(value?: number | string | boolean | null, name?: string | null): IQuery<T>;
+    equalTo(value: number | string | boolean | null, name?: string): IQuery;
     toString(): string;
     toJSON(): string;
-    isEqual(other: Query): boolean;
+    isEqual(other: IQuery): boolean;
 }
-export interface Reference<T = any> extends Query {
+export interface IReference<T = any> extends IQuery {
     set(newVal: T, onComplete?: (a: Error | null) => void): Promise<void>;
@@ -32,21 +32,21 @@ update(objectToMerge: Partial<T>, onComplete?: (a: Error | null) => void): Promise<void>;
     remove(onComplete?: (a: Error | null) => void): Promise<void>;
-    transaction(transactionUpdate: (a: Partial<T>) => Partial<T>, onComplete?: (a: Error | null, b: boolean, c: DataSnapshot<T> | null) => void, applyLocally?: boolean): Promise<TransactionResult<T>>;
+    transaction(transactionUpdate: (a: Partial<T>) => Partial<T>, onComplete?: (a: Error | null, b: boolean, c: IDataSnapshot<T> | null) => void, applyLocally?: boolean): Promise<ITransactionResult<T>>;
     setPriority(priority: string | number | null, onComplete?: (a: Error | null) => void): Promise<void>;
-    push(value?: any, onComplete?: (a: Error | null) => void): Reference<T>;
-    onDisconnect(): OnDisconnect<T>;
+    push(value?: any, onComplete?: (a: Error | null) => void): IReference<T>;
+    onDisconnect(): IOnDisconnect<T>;
     readonly key: string | null;
-    readonly parent: Reference | null;
-    readonly root: Reference;
+    readonly parent: IReference | null;
+    readonly root: IReference;
 }
-export interface TransactionResult<T = any> {
+export interface ITransactionResult<T = any> {
     committed: boolean;
-    snapshot: DataSnapshot<T>;
+    snapshot: IDataSnapshot<T>;
     toJSON(): object;
 }
-export interface DataSnapshot<T = any> {
-    readonly ref: Reference<T>;
+export interface IDataSnapshot<T = any> {
+    readonly ref: IReference<T>;
     readonly key: string;
-    child<T = any>(childPathString: string): DataSnapshot<T>;
+    child<T = any>(childPathString: string): IDataSnapshot<T>;
     exists(): boolean;
-    forEach(action: (d: DataSnapshot) => void): boolean;
+    forEach(action: (d: IDataSnapshot) => void): boolean;
     getPriority(): string | number | null;
@@ -59,3 +59,3 @@ hasChild(childPathString: string): boolean;
 }
-export interface OnDisconnect<T = any> {
+export interface IOnDisconnect<T = any> {
     cancel(onComplete?: (a: Error | null) => void): Promise<void>;
@@ -68,3 +68,3 @@ remove(onComplete?: (a: Error | null) => void): Promise<void>;
 export interface ISnapshotCallback<T = any> {
-    (a: DataSnapshot<T>, b?: string): any;
+    (a: IDataSnapshot<T>, b?: string): any;
 }

package.json

 {
   "name": "firebase-api-surface",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "the publically exposed firebase API",
@@ -18,5 +18,2 @@ "license": "MIT",
       "nyc --reporter=text --reporter=html mocha --compilers ts:ts-node/register",
-    "watch": "ts-node ./scripts/watch.ts",
-    "watch:test": "ts-node ./scripts/watch.ts test",
-    "watch:all": "ts-node ./scripts/watch.ts all",
     "deploy": "ts-node ./scripts/deploy.ts "
@@ -26,2 +23,3 @@ },
     "@firebase/app-types": "^0.1.1",
+    "@firebase/auth-types": "^0.1.1",
     "@firebase/database-types": "^0.1.1",
@@ -37,6 +35,12 @@ "@firebase/firestore-types": "^0.2.1",
     "chalk": "^2.3.0",
+    "common-types": "^1.5.2",
+    "js-yaml": "^3.10.0",
+    "lodash.first": "^3.0.0",
+    "lodash.last": "^3.0.0",
     "rimraf": "^2.6.2",
     "shelljs": "^0.8.1",
-    "test-console": "^1.1.0"
+    "test-console": "^1.1.0",
+    "tslint": "^5.9.1",
+    "typescript": "^2.8.0-dev.20180131"
   }
 }

README.md

@@ -25,4 +25,7 @@ # Firebase API Surface
 * **Interface naming** - in TypeScript it is recommended that you export interfaces names as starting with a capital **I** and though I sometimes am tempted to avoid this as I find "Settings" _sexier_ than "ISettings" it comes at the cost of loss of contextual information and in this case I think holds particularly useful value. For that reason all interface names are renamed to with an _I_-prefix.
-* **Class to Interface** - Google mixes a combination of "types", "interfaces", and "classes" into their typing. In the case of of class definitions though the intent is not entirely clear as no implementation is actually provided so they are in essence just serving as interfaces under a differnt name. For that reason, these classes will be converted to an interfaced (and renamed with the above naming convention)
-  > If anyone can shed any design insight into this count me as interested. My guess is that the admin and client API's both implement these classes in slightly different ways and there was a desire to strictly type the private constructor across both API's to be the same? Not sure but that's all I could come up with.
+* **Class to Interface**
+  * Google mixes a combination of "types", "interfaces", and "classes" into their typing.
+  * In the case of of **Class** definitions though the intent is not entirely clear as no implementation is actually provided so they are in essence just serving as interfaces under a differnt name. For that reason, these classes will be converted to an interfaced (and renamed with the above naming convention)
+    > If anyone can shed any design insight into this count me as interested. My guess is that the admin and client API's both implement these classes in slightly different ways and there was a desire to strictly type the private constructor across both API's to be the same? Not sure but that's all I could come up with.
+  * There are a few cases where the Class syntax is used to add _static_ properties to the class. There isn't any way to do this with an interface so in these instances the class is left as-is (see "auth" interface for examples).
 
@@ -29,0 +32,0 @@ ## Example Usage

scripts/build.ts

@@ -6,3 +6,3 @@ // tslint:disable:no-implicit-dependencies
 import * as process from "process";
-import "../test/testing/test-console";
+import "../types/test-console";
 import { stdout, stderr } from "test-console";
@@ -9,0 +9,0 @@

scripts/tsconfig.json

@@ -11,10 +11,5 @@ {
     "removeComments": true,
-    "typeRoots": [
-      "./node_modules/@types"
-    ]
+    "typeRoots": ["./node_modules/@types", "../types"]
   },
-  "include": [
-    "src/**/*.ts",
-    "scripts/*.ts"
-  ],
+  "include": ["src/**/*.ts", "scripts/*.ts"],
   "exclude": [
@@ -25,2 +20,2 @@ "node_modules",
   ]
-}
+}

src/index.ts

@@ -1,15 +0,8 @@
-export {
-  RTDBEventType,
-  IRTDBDatabase,
-  IRTDBDataSnapshot,
-  IRTDBOnDisconnect,
-  IRTDBQuery,
-  IRTDBReference,
-  IRTDBTransactionResult
-} from "./rtdb2";
-
+import * as rtdb from "./rtdb";
 import * as storage from "./storage";
-export { storage };
+import * as firestore from "./firestore";
+import * as messaging from "./messaging";
+import * as app from "./app";
+import * as auth from "./auth";
 
-import * as firestore from "./firestore";
-export { firestore };
+export { app, auth, rtdb, storage, firestore, messaging };

src/rtdb.ts

@@ -13,3 +13,3 @@ import { FirebaseApp } from "@firebase/app-types";
   /** Returns a reference to the root or the path specified in opt_pathString. */
-  ref(pathString?: string): Reference;
+  ref(pathString?: string): IReference;
   /**
@@ -20,3 +20,3 @@ * Returns a reference to the root or the path specified in url.
    */
-  refFromURL(url: string): Reference;
+  refFromURL(url: string): IReference;
   /** Disconnects from the server (all Database operations will be completed offline). */
@@ -28,3 +28,5 @@ goOffline(): void;
 
-export interface Query<T = any> {
+import { Query } from "@firebase/database-types";
+export interface IQuery<T = any> {
+  /** Detaches a callback previously attached with on() */
   off(
@@ -35,2 +37,9 @@ eventType?: EventType,
   ): void;
+  /** Listens for data changes at a particular location */
+  on(
+    eventType: EventType,
+    callback: (a: IDataSnapshot | null, b?: string) => any,
+    cancelCallbackOrContext?: Object | null,
+    context?: Object | null
+  ): (a: IDataSnapshot | null, b?: string) => any;
   /** Attaches a listener, waits for the first event, and then removes the listener */
@@ -42,23 +51,20 @@ once(
     context?: Object
-  ): Promise<DataSnapshot<T>>;
+  ): Promise<IDataSnapshot<T>>;
   /** Set a limit and anchor it to the start of the window. */
-  limitToFirst(limit: number): Query<T>;
+  limitToFirst(limit: number): IQuery<T>;
   /** Set a limit and anchor it to the end of the window. */
-  limitToLast(limit: number): Query<T>;
+  limitToLast(limit: number): IQuery<T>;
   /** Given a child path, return a new query ordered by the specified grandchild path. */
-  orderByChild(path: string): Query<T>;
+  orderByChild(path: string): IQuery<T>;
   /** Return a new query ordered by the KeyIndex */
-  orderByKey(): Query<T>;
+  orderByKey(): IQuery<T>;
   /** Return a new query ordered by the PriorityIndex */
-  orderByPriority(): Query<T>;
+  orderByPriority(): IQuery<T>;
   /** Return a new query ordered by the ValueIndex */
-  orderByValue(): Query<T>;
+  orderByValue(): IQuery<T>;
   startAt(
     value?: number | string | boolean | null,
     name?: string | null
-  ): Query<T>;
-  endAt(
-    value?: number | string | boolean | null,
-    name?: string | null
-  ): Query<T>;
+  ): IQuery<T>;
+  endAt(value: number | string | boolean | null, key?: string): IQuery;
   /**
@@ -68,3 +74,3 @@ * Load the selection of children with exactly the specified value, and, optionally,
    */
-  equalTo(value: number | string | boolean | null, name?: string): Query;
+  equalTo(value: number | string | boolean | null, name?: string): IQuery;
   /** URL for this location. */
@@ -74,6 +80,6 @@ toString(): string;
   /** Return true if this query and the provided query are equivalent; otherwise, return false. */
-  isEqual(other: Query): boolean;
+  isEqual(other: IQuery): boolean;
 }
 
-export interface Reference<T = any> extends Query {
+export interface IReference<T = any> extends IQuery {
   /** Writes data to a Database location */
@@ -100,6 +106,6 @@ set(newVal: T, onComplete?: (a: Error | null) => void): Promise<void>;
       b: boolean,
-      c: DataSnapshot<T> | null
+      c: IDataSnapshot<T> | null
     ) => void,
     applyLocally?: boolean
-  ): Promise<TransactionResult<T>>;
+  ): Promise<ITransactionResult<T>>;
   /** Sets a priority for the data at this Database location. */
@@ -110,20 +116,19 @@ setPriority(
   ): Promise<void>;
-  /** Generates a new child location using a unique key and returns its Reference. */
-  push(value?: any, onComplete?: (a: Error | null) => void): Reference<T>;
+  /** Generates a new child location using a unique key and returns its IReference. */
+  push(value?: any, onComplete?: (a: Error | null) => void): IReference<T>;
   /** Returns an OnDisconnect object - see Enabling Offline Capabilities in JavaScript for more information on how to use it. */
-  onDisconnect(): OnDisconnect<T>;
+  onDisconnect(): IOnDisconnect<T>;
   readonly key: string | null;
-  readonly parent: Reference | null;
-  readonly root: Reference;
+  readonly parent: IReference | null;
+  readonly root: IReference;
 }
-
-export interface TransactionResult<T = any> {
+export interface ITransactionResult<T = any> {
   committed: boolean;
-  snapshot: DataSnapshot<T>;
+  snapshot: IDataSnapshot<T>;
   toJSON(): object;
 }
 
-export interface DataSnapshot<T = any> {
-  /** The Reference for the location that generated this DataSnapshot. */
-  readonly ref: Reference<T>;
+export interface IDataSnapshot<T = any> {
+  /** The IReference for the location that generated this DataSnapshot. */
+  readonly ref: IReference<T>;
   /** The key (last part of the path) of the location of this DataSnapshot. */
@@ -133,7 +138,7 @@ readonly key: string;
   /** Gets another DataSnapshot for the location at the specified relative path. */
-  child<T = any>(childPathString: string): DataSnapshot<T>;
+  child<T = any>(childPathString: string): IDataSnapshot<T>;
   /** Returns true if this DataSnapshot contains any data. It is slightly more efficient than using snapshot.val() !== null. */
   exists(): boolean;
   /** Enumerates the top-level children in the DataSnapshot. */
-  forEach(action: (d: DataSnapshot) => void): boolean;
+  forEach(action: (d: IDataSnapshot) => void): boolean;
   /** Gets the priority value of the data in this DataSnapshot. */
@@ -153,3 +158,3 @@ getPriority(): string | number | null;
 
-export interface OnDisconnect<T = any> {
+export interface IOnDisconnect<T = any> {
   cancel(onComplete?: (a: Error | null) => void): Promise<void>;
@@ -170,3 +175,3 @@ remove(onComplete?: (a: Error | null) => void): Promise<void>;
 export interface ISnapshotCallback<T = any> {
-  (a: DataSnapshot<T>, b?: string): any;
+  (a: IDataSnapshot<T>, b?: string): any;
 }

No alert changes

Improved metrics

Number of lines in readme file

76

4.11%

Worsened metrics

Total package byte prevSize

54037

-2.78%

Dependency count

7

16.67%

Dev dependency count

12

100%

Lines of code

725

-18.17%

Dependency changes

• + Added

  @firebase/auth-types@^0.1.1

• + Added

  @firebase/auth-types@0.1.2
  (transitive)