Revert "Redesign SDK to get rid of "exports =" and export more types." (#81)

Author: inlined

package.json

@@ -33,7 +33,7 @@
     "@types/sinon": "^1.16.29",
     "chai": "^3.5.0",
     "chai-as-promised": "^5.2.0",
-    "firebase-admin": "^4.0.5",
+    "firebase": "^3.3",
     "istanbul": "^0.4.2",
     "mocha": "^2.4.5",
     "nock": "^8.0.0",
@@ -42,12 +42,12 @@
     "typescript": "^2.0.0"
   },
   "peerDependencies": {
-    "firebase-admin": "^4.0.5"
+    "firebase": "^3.3"
   },
   "dependencies": {
     "@types/bluebird": "^3.0.32",
-    "@types/express": "^4.0.33",
     "@types/jsonwebtoken": "^7.1.32",
+    "@types/express": "^4.0.33",
     "@types/lodash": "^4.14.34",
     "@types/node": "^6.0.38",
     "@types/request": "0.0.30",

spec/apps.spec.ts

@@ -1,13 +1,13 @@
 import { expect } from 'chai';
 
 import { FakeEnv } from './support/helpers';
-import { apps as appsNamespace } from '../src/apps';
-import * as firebase from 'firebase-admin';
+import Apps from '../src/apps';
+import * as firebase from 'firebase';
 
 describe('apps', () => {
-  let apps: appsNamespace.Apps;
+  let apps;
   beforeEach(() => {
-    apps = new appsNamespace.Apps(new FakeEnv());
+    apps = new Apps(new FakeEnv());
   });
 
   it('should load the admin app for admin impersonation', function () {

spec/providers/base.spec.ts renamed to spec/builder.spec.ts

@@ -1,17 +1,16 @@
 import * as sinon from 'sinon';
-import * as Promise from 'bluebird';
 import { expect } from 'chai';
-import { FakeEnv } from '../support/helpers';
-import { AbstractFunctionBuilder } from '../../src/providers/base';
-import { RawEvent } from '../../src/event';
+import { FakeEnv, async } from './support/helpers';
+import { FunctionBuilder } from '../src/builder';
+import { RawEvent } from '../src/event';
 
-describe('AbstractFunctionBuilder', () => {
+describe('FunctionBuilder', () => {
   let subject;
   let env;
 
   beforeEach(() => {
     env = new FakeEnv();
-    subject = new AbstractFunctionBuilder(env);
+    subject = new FunctionBuilder(env);
   });
 
   describe('_makeHandler(handler: Function, event: string)', () => {
@@ -33,7 +32,7 @@ describe('AbstractFunctionBuilder', () => {
         called = true;
       });
       handler();
-      return Promise.resolve().then(() => {
+      return async().then(() => {
         expect(called).to.be.false;
       });
     });
@@ -46,7 +45,7 @@ describe('AbstractFunctionBuilder', () => {
       });
       handler({});
       env.makeReady();
-      return Promise.resolve().then(() => {
+      return async().then(() => {
         expect(called).to.be.true;
       });
     });

spec/providers/auth.spec.ts renamed to spec/builders/auth-builder.spec.ts

@@ -1,17 +1,18 @@
-import { auth } from '../../src/providers/auth';
-import { expect } from 'chai';
+import AuthBuilder from '../../src/builders/auth-builder';
+import { expect as expect } from 'chai';
 import { FakeEnv } from '../support/helpers';
+import { AuthEventData } from '../../src/builders/auth-builder';
 import { Event } from '../../src/event';
 import * as Promise from 'bluebird';
 
 describe('AuthBuilder', () => {
-  let subject: auth.FunctionBuilder;
-  let handler: (e: Event<auth.UserRecord>) => PromiseLike<any> | any;
+  let subject: AuthBuilder;
+  let handler: (e: Event<AuthEventData>) => PromiseLike<any> | any;
   let env: FakeEnv;
 
   beforeEach(() => {
     env = new FakeEnv();
-    subject = new auth.FunctionBuilder(env);
+    subject = new AuthBuilder(env);
     handler = () => {
       return true;
     };
@@ -48,7 +49,7 @@ describe('AuthBuilder', () => {
 
   describe('#_dataConstructor', () => {
     it('should handle an event with the appropriate fields', () => {
-      let func = subject.onCreate((ev: Event<auth.UserRecord>) => {
+      let func = subject.onCreate((ev: Event<AuthEventData>) => {
         return Promise.resolve(ev.data);
       });
       env.makeReady();
@@ -88,7 +89,7 @@ describe('AuthBuilder', () => {
     // This isn't expected to happen in production, but if it does we should
     // handle it gracefully.
     it('should tolerate missing fields in the payload', () => {
-      let func = subject.onCreate((ev: Event<auth.UserRecord>) => {
+      let func = subject.onCreate((ev: Event<AuthEventData>) => {
         return Promise.resolve(ev.data);
       });
       env.makeReady();
@@ -102,7 +103,7 @@ describe('AuthBuilder', () => {
         },
       };
 
-      return expect(func(event as Event<auth.UserRecord>)).to.eventually.deep.equal(event.data);
+      return expect(func(<Event<AuthEventData>>event)).to.eventually.deep.equal(event.data);
     });
   });
 });

spec/builders/database-builder.spec.ts

@@ -0,0 +1,52 @@
+import DatabaseBuilder from '../../src/builders/database-builder';
+import { expect as expect } from 'chai';
+import { FakeEnv } from '../support/helpers';
+import Apps from '../../src/apps';
+import * as _ from 'lodash';
+
+describe('DatabaseBuilder', () => {
+  let subject: DatabaseBuilder;
+  let env: FakeEnv;
+  let apps: Apps;
+
+  beforeEach(() => {
+    env = new FakeEnv();
+    apps = new Apps(env);
+    subject = new DatabaseBuilder(env, apps);
+  });
+
+  describe('#path()', () => {
+    it('should append paths if called multiple times', () => {
+      subject.path('first/bit');
+      subject.path('{id}/second/bit');
+      return expect(subject['_toTrigger']('data.write').eventTrigger.path).to.equal('/first/bit/{id}/second/bit');
+    });
+  });
+
+  describe('#_toTrigger()', () => {
+    it('should return "write" as the default event type', () => {
+      let eventType = subject['_toTrigger']('data.write').eventTrigger.eventType;
+      expect(eventType).to.eq('providers/firebase.database/eventTypes/data.write');
+    });
+  });
+
+  describe('#onWrite()', () => {
+    it('should throw if path has not been called', () => {
+      expect(() => {
+        subject.onWrite(evt => _.noop());
+      }).to.throw('Must call .path(pathValue)');
+    });
+
+    it('should return a handler that emits events with a proper DatabaseDeltaSnapshot', () => {
+      let handler = subject.path('/users/{id}').onWrite(event => {
+        expect(event.data.val()).to.deep.equal({foo: 'bar'});
+      });
+
+      env.makeReady();
+      return handler(<any>{data: {
+        data: null,
+        delta: {foo: 'bar'},
+      }});
+    });
+  });
+});

spec/providers/https.spec.ts renamed to spec/builders/https-builder.spec.ts

@@ -1,18 +1,18 @@
-import { https } from '../../src/providers/https';
+import { default as CloudHttpsBuilder } from '../../src/builders/https-builder';
 import { expect as expect } from 'chai';
 import { FakeEnv } from '../support/helpers';
 
 describe('CloudHttpsBuilder', () => {
-  let subject: https.FunctionBuilder;
+  let subject: CloudHttpsBuilder;
   let env: FakeEnv;
 
   beforeEach(() => {
     env = new FakeEnv();
-    subject = new https.FunctionBuilder(env);
+    subject = new CloudHttpsBuilder(env);
   });
 
   describe('#onRequest', () => {
-    it('should return a Trigger with appropriate values', () => {
+    it('should return a TriggerDefinition with appropriate values', () => {
       let result = subject.onRequest((req, resp) => {
         resp.send(200);
       });

spec/providers/pubsub.spec.ts renamed to spec/builders/pubsub-builder.spec.ts

@@ -1,20 +1,20 @@
-import { pubsub } from '../../src/providers/pubsub';
+import { PubsubMessage, default as CloudPubsubBuilder } from '../../src/builders/pubsub-builder';
 import { expect } from 'chai';
 import { FakeEnv } from '../support/helpers';
 import { Event } from '../../src/event';
 
-describe('pubsub.Message', () => {
+describe('PubsubMessage', () => {
   describe('#json', () => {
     it('should return json decoded from base64', () => {
-      let message = new pubsub.Message({
+      let message = new PubsubMessage({
         data: new Buffer('{"hello":"world"}', 'utf8').toString('base64'),
       });
 
       expect(message.json.hello).to.equal('world');
     });
 
     it('should preserve passed in json', () => {
-      let message = new pubsub.Message({
+      let message = new PubsubMessage({
         data: new Buffer('{"hello":"world"}', 'utf8').toString('base64'),
         json: {goodbye: 'world'},
       });
@@ -26,7 +26,7 @@ describe('pubsub.Message', () => {
   describe('#toJSON', () => {
     it('should be JSON stringify-able', () => {
       let encoded = new Buffer('{"hello":"world"}', 'utf8').toString('base64');
-      let message = new pubsub.Message({
+      let message = new PubsubMessage({
         data: encoded,
       });
 
@@ -38,14 +38,14 @@ describe('pubsub.Message', () => {
   });
 });
 
-describe('pubsub.FunctionBuilder', () => {
-  let subject: pubsub.FunctionBuilder;
+describe('CloudPubsubBuilder', () => {
+  let subject: CloudPubsubBuilder;
   let env: FakeEnv;
   let handler: (any) => any;
 
   beforeEach(() => {
     env = new FakeEnv();
-    subject = new pubsub.FunctionBuilder(env, 'toppy');
+    subject = new CloudPubsubBuilder(env, 'toppy');
     handler = (data: Object) => {
       return true;
     };
@@ -68,7 +68,7 @@ describe('pubsub.FunctionBuilder', () => {
     });
 
     it ('should allow fully qualified topic names', () => {
-      let subjectQualified = new pubsub.FunctionBuilder(env, 'projects/project1/topics/toppy');
+      let subjectQualified = new CloudPubsubBuilder(env, 'projects/project1/topics/toppy');
       let result = subjectQualified.onPublish(handler);
       expect(result.__trigger).to.deep.equal({
         eventTrigger: {
@@ -80,22 +80,22 @@ describe('pubsub.FunctionBuilder', () => {
 
     it ('should throw with improperly formatted topics', () => {
       let func = () => {
-        let badSubject = new pubsub.FunctionBuilder(env, 'bad/topic/format');
+        let badSubject = new CloudPubsubBuilder(env, 'bad/topic/format');
         return badSubject.onPublish(handler);
       };
       expect(func).to.throw(Error);
     });
 
     it ('should throw with when using topic in another project', () => {
       let func = () => {
-        let badSubject = new pubsub.FunctionBuilder(env, 'projects/anotherProject/topics/toppy');
+        let badSubject = new CloudPubsubBuilder(env, 'projects/anotherProject/topics/toppy');
         return badSubject.onPublish(handler);
       };
       expect(func).to.throw(Error);
     });
 
     it('should properly handle a new-style event', () => {
-      let handler2 = (ev: Event<pubsub.Message>) => {
+      let handler2 = (ev: Event<PubsubMessage>) => {
         return {
           raw: ev.data.data,
           json: ev.data.json,

spec/providers/storage.spec.ts renamed to spec/builders/storage-builder.spec.ts

@@ -1,16 +1,17 @@
-import { storage } from '../../src/providers/storage';
+import CloudStorageBuilder from '../../src/builders/storage-builder';
 import { expect as expect } from 'chai';
 import { FakeEnv } from '../support/helpers';
+import { StorageObject } from '../../src/builders/storage-builder';
 import { Event } from '../../src/event';
 
-describe('storage.FunctionBuilder', () => {
-  let subject: storage.FunctionBuilder;
-  let handler: (e: Event<storage.Object>) => PromiseLike<any> | any;
+describe('CloudHttpBuilder', () => {
+  let subject: CloudStorageBuilder;
+  let handler: (e: Event<StorageObject>) => PromiseLike<any> | any;
   let env: FakeEnv;
 
   beforeEach(() => {
     env = new FakeEnv();
-    subject = new storage.FunctionBuilder(env, 'bucky');
+    subject = new CloudStorageBuilder(env, 'bucky');
     handler = (data) => {
       return true;
     };
@@ -28,7 +29,7 @@ describe('storage.FunctionBuilder', () => {
     });
 
     it ('should allow fully qualified bucket names', () => {
-      let subjectQualified = new storage.FunctionBuilder(env, 'projects/_/buckets/bucky');
+      let subjectQualified = new CloudStorageBuilder(env, 'projects/_/buckets/bucky');
       let result = subjectQualified.onChange(handler);
       expect(result.__trigger).to.deep.equal({
         eventTrigger: {
@@ -40,15 +41,15 @@ describe('storage.FunctionBuilder', () => {
 
     it ('should throw with improperly formatted buckets', () => {
       let func = () => {
-        let badSubject = new storage.FunctionBuilder(env, 'bad/bucket/format');
+        let badSubject = new CloudStorageBuilder(env, 'bad/bucket/format');
         return badSubject.onChange(handler);
       };
       expect(func).to.throw(Error);
     });
 
     it ('should throw with when using bucket not in _ project', () => {
       let func = () => {
-        let badSubject = new storage.FunctionBuilder(env, 'projects/anotherProject/buckets/bucky');
+        let badSubject = new CloudStorageBuilder(env, 'projects/anotherProject/buckets/bucky');
         return badSubject.onChange(handler);
       };
       expect(func).to.throw(Error);