Merge pull request #66 from firebase/next

November 7, 2019 Release

Author: laurenzlong

.prettierignore

@@ -1,11 +1,15 @@
 package.json
 extension.yaml
-webpack.config.js
+package-lock.json
+
 **/node_modules/**
 
 # generated files
 README.md
-POSTINSTALL.md
-PREINSTALL.md
 **/functions/lib/**
 **/dist/**
+
+# extension install md files
+#   - excluded as prettier escapes variables e.g. `${PROJECT_ID}` becomes `\${PROJECT_ID}`
+POSTINSTALL.md
+PREINSTALL.md

.prettierrc.yaml

@@ -15,6 +15,6 @@
 trailingComma: es5
 arrowParens: always
 overrides:
-  - files: "*.yaml"
+  - files: "*.{yml,yaml}"
     options:
       proseWrap: always

.travis.yml

@@ -0,0 +1,21 @@
+language: node_js
+
+node_js:
+  - 8
+  - 10
+  - 12
+
+stages:
+  - validate
+  - test
+
+jobs:
+  include:
+    - stage: validate
+      name: "TypeScript Compile"
+      script: npm run clean && npm run build
+    - stage: validate
+      name: "Prettier Format Check"
+      script: npm run lint
+    - stage: test
+      script: npm run test-coverage

auth-mailchimp-sync/README.md

@@ -1,52 +1,52 @@
-# auth-mailchimp-sync
+# Sync with Mailchimp
 
-**VERSION**: 0.1.0
+**Description**: Adds new users from Firebase Authentication to a specified Mailchimp audience.
 
-**DESCRIPTION**: Adds new users from Firebase Authentication to a specified Mailchimp audience.
 
 
+**Details**: Use this extension to add new users to an existing [Mailchimp](https://mailchimp.com) audience.
 
-**CONFIGURATION PARAMETERS:**
+This extension adds the email address of each new user to your specified Mailchimp audience. Also, if the user deletes their user account for your app, this extension removes the user from the Mailchimp audience.
 
-* Deployment location: Where should the extension be deployed? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
+**Note:** To use this extension, you need to manage your users with Firebase Authentication.
 
-* Mailchimp API key: What is your Mailchimp API key? To obtain a Mailchimp API key, go to your [Mailchimp account](https://admin.mailchimp.com/account/api/).
+This extension uses Mailchimp, so you'll need to supply your Mailchimp API Key and Audience ID when installing this extension.
 
-* Audience ID: What is the Mailchimp Audience ID to which you want to subscribe new users? To find your Audience ID: visit https://admin.mailchimp.com/lists, click on the desired audience or create a new audience, then select **Settings**. Look for **Audience ID** (for example, `27735fc60a`).
+#### Additional setup
 
-* Contact status: When the extension adds a new user to the Mailchimp audience, what is their initial status? This value can be `subscribed` or `pending`. `subscribed` means the user can receive campaigns; `pending` means the user still needs to opt-in to receive campaigns.
+Make sure that you've set up [Firebase Authentication](https://firebase.google.com/docs/auth) to manage your users.
 
+You must also have a Mailchimp account before installing this extension.
 
+#### Billing
 
-**CLOUD FUNCTIONS CREATED:**
+This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
 
-* addUserToList (providers/firebase.auth/eventTypes/user.create)
+- Firebase Realtime Database
+- Cloud Functions
 
-* removeUserFromList (providers/firebase.auth/eventTypes/user.delete)
+When you use Firebase Extensions, you're only charged for the underlying resources that you use. A paid-tier billing plan is only required if the extension uses a service that requires a paid-tier plan, for example calling to a Google Cloud Platform API or making outbound network requests to non-Google services. All Firebase services offer a free tier of usage. [Learn more about Firebase billing.](https://firebase.google.com/pricing)
 
+Usage of this extension also requires you to have a Mailchimp account. You are responsible for any associated costs with your usage of Mailchimp.
 
 
-**DETAILS**: Use this extension to add new users to an existing [Mailchimp](https://mailchimp.com) audience.
 
-This extension adds the email address of each new user to your specified Mailchimp audience. Also, if the user deletes their user account for your app, this extension removes the user from the Mailchimp audience.
 
-**Note:** To use this extension, you need to manage your users with Firebase Authentication.
 
-This extension uses Mailchimp, so you'll need to supply your Mailchimp API Key and Audience ID when installing this extension.
+**Configuration Parameters:**
 
-#### Additional setup
+* Deployment location: Where should the extension be deployed? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
 
-Make sure that you've set up [Firebase Authentication](https://firebase.google.com/docs/auth) to manage your users.
+* Mailchimp API key: What is your Mailchimp API key? To obtain a Mailchimp API key, go to your [Mailchimp account](https://admin.mailchimp.com/account/api/).
 
-You must also have a Mailchimp account before installing this extension.
+* Audience ID: What is the Mailchimp Audience ID to which you want to subscribe new users? To find your Audience ID: visit https://admin.mailchimp.com/lists, click on the desired audience or create a new audience, then select **Settings**. Look for **Audience ID** (for example, `27735fc60a`).
 
-#### Billing
+* Contact status: When the extension adds a new user to the Mailchimp audience, what is their initial status? This value can be `subscribed` or `pending`. `subscribed` means the user can receive campaigns; `pending` means the user still needs to opt-in to receive campaigns.
 
-This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
 
-- Firebase Realtime Database
-- Cloud Functions
 
-When you use Firebase Extensions, you're only charged for the underlying resources that you use. A paid-tier billing plan is only required if the extension uses a service that requires a paid-tier plan, for example calling to a Google Cloud Platform API or making outbound network requests to non-Google services. All Firebase services offer a free tier of usage. [Learn more about Firebase billing.](https://firebase.google.com/pricing)
+**Cloud Functions:**
 
-Usage of this extension also requires you to have a Mailchimp account. You are responsible for any associated costs with your usage of Mailchimp.
+* **addUserToList:** Listens for new user accounts (as managed by Firebase Authentication), then automatically adds the new user to your specified MailChimp audience.
+
+* **removeUserFromList:** Listens for existing user accounts to be deleted (as managed by Firebase Authentication), then automatically removes them from your specified MailChimp audience.

auth-mailchimp-sync/extension.yaml

@@ -23,7 +23,7 @@ description:
 license: Apache-2.0
 billingRequired: true
 sourceUrl: https://github.com/firebase/extensions/tree/master/auth-mailchimp-sync
-releaseNotesUrl: https://github.com/firebase/extensions/commits/master
+releaseNotesUrl: https://github.com/firebase/extensions/releases
 
 author:
   authorName: Firebase

auth-mailchimp-sync/jest.config.js

@@ -6,7 +6,5 @@ module.exports = {
   rootDir: "./",
   preset: "ts-jest",
   globalSetup: "./jest.setup.js",
-  globalTeardown: "./jest.teardown.js"
+  globalTeardown: "./jest.teardown.js",
 };
-
-

auth-mailchimp-sync/package-lock.json

@@ -1,6 +1,5 @@
 {
   "name": "auth-mailchimp-sync",
-  "version": "0.1.0",
   "description": "Add new users to a Mailchimp list, and delete them from the list when they delete their account.",
   "main": "functions/lib/index.js",
   "scripts": {
@@ -19,5 +18,6 @@
   "devDependencies": {
     "rimraf": "^2.6.3",
     "typescript": "^3.2.4"
-  }
+  },
+  "private": true
 }

auth-mailchimp-sync/package.json

@@ -3,7 +3,5 @@
   "compilerOptions": {
     "outDir": "functions/lib"
   },
-  "include": [
-    "functions/src"
-  ]
+  "include": ["functions/src"]
 }

auth-mailchimp-sync/tsconfig.json

@@ -0,0 +1,4 @@
+## Version 0.1.2
+
+feature - Add a new param for recursively deleting subcollections in Cloud Firestore (issue #14).
+fixed - Fixed "cold start" errors experienced when the extension runs after a period of inactivity (issue #48).