Fixing a TS compilation error in index.d.ts (#71)

* Fixing a TS compilation error in index.d.ts; Adding a verifyReleaseTarball script to sanity check the release builds

* Documented verify script

Author: hiranya911

createReleaseTarball.sh

@@ -157,6 +157,18 @@ echo
 mv firebase-admin-${VERSION_WITHOUT_RC}.tgz firebase-admin-${VERSION}.tgz
 
 
+############################
+#  VERIFY RELEASE TARBALL  #
+############################
+echo "[INFO] Running release tarball verification..."
+bash verifyReleaseTarball.sh firebase-admin-${VERSION}.tgz
+if [[ $? -ne 0 ]]; then
+  echo "Error: Release tarball failed verification."
+  exit 1
+fi
+echo
+
+
 ##############
 #  EPILOGUE  #
 ##############

src/index.d.ts

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
- import {Bucket} from '@google-cloud/storage';
-
 declare namespace admin {
   interface FirebaseError {
     code: string;
@@ -388,7 +386,7 @@ declare namespace admin.messaging {
 declare namespace admin.storage {
   interface Storage {
     app: admin.app.App;
-    bucket(name?: string): Bucket;
+    bucket(name?: string): any;
   }
 }
 

test/integration/typescript/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "firebase-admin-typescript-test",
+  "version": "1.0.0",
+  "devDependencies": {
+    "@types/chai": "^3.4.35",
+    "@types/mocha": "^2.2.39",
+    "@types/node": "^7.0.8",
+    "chai": "^3.5.0",
+    "mocha": "^3.5.0",
+    "ts-node": "^3.3.0",
+    "typescript": "^2.4.2"
+  }
+}

test/integration/typescript/src/example.test.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2017 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import initApp from './example'
+import {expect} from 'chai';
+
+const serviceAccount = require('../mock.key.json');
+
+describe('Init App', () => {
+    it('Should return an initialized App', () => {
+        const app = initApp(serviceAccount, 'TestApp');
+        expect(app.name).to.equal('TestApp');
+    });
+});

test/integration/typescript/src/example.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright 2017 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as firebase from 'firebase-admin';
+
+export function initApp(serviceAcct: any, name: string) {
+    return firebase.initializeApp({
+        credential: firebase.credential.cert(serviceAcct)
+    }, name);
+}
+
+export default initApp;

test/integration/typescript/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es5",
+    "noImplicitAny": false,
+    "lib": ["es5", "es2015.promise"],
+    "outDir": "lib",
+    "typeRoots": [
+      "node_modules/@types"
+    ]
+  },
+  "files": [
+    "src/example.ts"
+  ]
+}

verifyReleaseTarball.sh

@@ -0,0 +1,75 @@
+# Copyright 2017 Google Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#!/bin/bash
+
+# This helper script installs the firebase-admin package locally as a
+# typical developer would, and runs some test code using the
+# installed package as a dependency. This ensures that the distros
+# built by our tools can be installed and consumed by downstream
+# applications.
+
+set -e
+
+if [ -z "$1" ]; then
+    echo "[ERROR] No package name provided."
+    echo "[INFO] Usage: ./verifyReleaseTarball.sh <PACKAGE_NAME>"
+    exit 1
+fi
+
+# Variables
+PKG_NAME="$1"
+ROOT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+MOCHA_CLI="$ROOT/node_modules/.bin/mocha -r ts-node/register"
+DIR="$ROOT/test/integration/typescript"
+WORK_DIR=`mktemp -d`
+
+if [ ! -f "$ROOT/$PKG_NAME" ]; then
+  echo "Package $PKG_NAME does not exist."
+  exit 1
+fi
+
+# check if tmp dir was created
+if [[ ! "$WORK_DIR" || ! -d "$WORK_DIR" ]]; then
+  echo "Could not create temp dir"
+  exit 1
+fi
+
+# deletes the temp directory
+function cleanup {      
+  rm -rf "$WORK_DIR"
+  echo "Deleted temp working directory $WORK_DIR"
+}
+
+# register the cleanup function to be called on the EXIT signal
+trap cleanup EXIT
+
+# Enter work dir
+pushd "$WORK_DIR"
+
+# Copy test sources into working directory
+cp -r $DIR/* .
+cp "$ROOT/test/resources/mock.key.json" .
+
+# Install the test package
+npm install
+
+# Install firebase-admin package
+npm install "$ROOT/$PKG_NAME"
+
+echo "> tsc -p tsconfig.json"
+tsc -p tsconfig.json
+
+echo "> $MOCHA_CLI src/*.test.ts"
+$MOCHA_CLI src/*.test.ts