Merge branch 'next' into rachelsaunders-githubrepo

Author: rachelsaunders

auth-mailchimp-sync/README.md

@@ -8,19 +8,21 @@
 
 **CONFIGURATION PARAMETERS:**
 
-* 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).*
+* 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).
 
-* 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/).*
+* 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/).
 
-* 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`).*
+* 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`).
 
+* Contact status: When a new contact is added to the Mailchimp list/audience, what is their initial status? If the status is `subscribed` the contact can immediately receive campaigns. If the status is `pending`, a double opt-in confirmation email will be sent to the user. Once accepted they will be set to a `subscribed` status.
 
 
-**NON-CLOUD FUNCTION RESOURCES CREATED**:
 
-* addUserToList (firebaseextensions.v1beta.function)
+**CLOUD FUNCTIONS CREATED:**
 
-* removeUserFromList (firebaseextensions.v1beta.function)
+* addUserToList (providers/firebase.auth/eventTypes/user.create)
+
+* removeUserFromList (providers/firebase.auth/eventTypes/user.delete)
 
 
 

auth-mailchimp-sync/extension.yaml

@@ -22,8 +22,8 @@ description:
 
 license: Apache-2.0
 billingRequired: true
-sourceUrl: https://accounts.google.com/AccountChooser/signinchooser?service=gerritcodereview&continue=https%3A%2F%2Fdev-partners.googlesource.com%2Flogin%2Fsamples%2Ffirebase%2Fmods%2F%2B%2Fmaster%2Fauth-mailchimp-sync
-releaseNotesUrl: https://dev-partners.googlesource.com/samples/firebase/mods/+log
+sourceUrl: https://github.com/firebase/extensions/tree/master/auth-mailchimp-sync
+releaseNotesUrl: https://github.com/firebase/extensions/commits/master
 
 author:
   authorName: Firebase
@@ -35,6 +35,9 @@ contributors:
   - authorName: Chris Bianca
     email: chris@csfrequency.com
     url: https://github.com/chrisbianca
+  - authorName: Elliot Hesp
+    email: elliot@invertase.io
+    url: https://github.com/ehesp
 
 resources:
   - name: addUserToList
@@ -51,8 +54,9 @@ resources:
   - name: removeUserFromList
     type: firebaseextensions.v1beta.function
     description:
-      Listens for existing user accounts to be deleted (as managed by Firebase Authentication),
-      then automatically removes them from your specified MailChimp audience.
+      Listens for existing user accounts to be deleted (as managed by Firebase
+      Authentication), then automatically removes them from your specified
+      MailChimp audience.
     properties:
       sourceDirectory: .
       location: ${LOCATION}
@@ -65,9 +69,9 @@ params:
     type: select
     label: Deployment location
     description: >-
-      Where should the extension be deployed?
-      For help selecting a location, refer to the
-      [location selection guide](https://firebase.google.com/docs/functions/locations).
+      Where should the extension be deployed? For help selecting a location,
+      refer to the [location selection
+      guide](https://firebase.google.com/docs/functions/locations).
     options:
       - label: Iowa (us-central1)
         value: us-central1
@@ -90,18 +94,34 @@ params:
     type: string
     label: Mailchimp API key
     description: >-
-      What is your Mailchimp API key?
-      To obtain a Mailchimp API key, go to your [Mailchimp account](https://admin.mailchimp.com/account/api/).
+      What is your Mailchimp API key? To obtain a Mailchimp API key, go to your
+      [Mailchimp account](https://admin.mailchimp.com/account/api/).
     example: a1b2c3d4e5f6g7
     required: true
 
   - param: MAILCHIMP_AUDIENCE_ID
     type: string
     label: Audience ID
     description: >-
-      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`).
+      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`).
     example: 1ab2345c67
     required: true
+
+  - param: MAILCHIMP_CONTACT_STATUS
+    type: select
+    label: Contact status
+    description: >-
+      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.
+    options:
+      - label: Subscribed
+        value: subscribed
+      - label: Pending
+        value: pending
+    default: subscribed
+    required: true

auth-mailchimp-sync/functions/lib/config.js

@@ -19,4 +19,5 @@ exports.default = {
     location: process.env.LOCATION,
     mailchimpApiKey: process.env.MAILCHIMP_API_KEY,
     mailchimpAudienceId: process.env.MAILCHIMP_AUDIENCE_ID,
+    mailchimpContactStatus: process.env.MAILCHIMP_CONTACT_STATUS,
 };

auth-mailchimp-sync/functions/lib/index.js

@@ -52,9 +52,9 @@ exports.addUserToList = functions.handler.auth.user.onCreate((user) => __awaiter
         logs.userAdding(uid, config_1.default.mailchimpAudienceId);
         const results = yield mailchimp.post(`/lists/${config_1.default.mailchimpAudienceId}/members`, {
             email_address: email,
-            status: "subscribed",
+            status: config_1.default.mailchimpContactStatus,
         });
-        logs.userAdded(uid, config_1.default.mailchimpAudienceId, results.id);
+        logs.userAdded(uid, config_1.default.mailchimpAudienceId, results.id, config_1.default.mailchimpContactStatus);
         logs.complete();
     }
     catch (err) {

auth-mailchimp-sync/functions/lib/logs.js

@@ -38,8 +38,8 @@ exports.mailchimpNotInitialized = () => {
 exports.start = () => {
     console.log("Started execution of extension with configuration", obfuscatedConfig);
 };
-exports.userAdded = (userId, audienceId, mailchimpId) => {
-    console.log(`Added user: ${userId} to Mailchimp audience: ${audienceId} with Mailchimp ID: ${mailchimpId}`);
+exports.userAdded = (userId, audienceId, mailchimpId, status) => {
+    console.log(`Added user: ${userId} with status '${status}' to Mailchimp audience: ${audienceId} with Mailchimp ID: ${mailchimpId}`);
 };
 exports.userAdding = (userId, audienceId) => {
     console.log(`Adding user: ${userId} to Mailchimp audience: ${audienceId}`);

auth-mailchimp-sync/functions/src/config.ts

@@ -18,4 +18,5 @@ export default {
   location: process.env.LOCATION,
   mailchimpApiKey: process.env.MAILCHIMP_API_KEY,
   mailchimpAudienceId: process.env.MAILCHIMP_AUDIENCE_ID,
+  mailchimpContactStatus: process.env.MAILCHIMP_CONTACT_STATUS,
 };

auth-mailchimp-sync/functions/src/index.ts

@@ -52,10 +52,15 @@ export const addUserToList = functions.handler.auth.user.onCreate(
         `/lists/${config.mailchimpAudienceId}/members`,
         {
           email_address: email,
-          status: "subscribed",
+          status: config.mailchimpContactStatus,
         }
       );
-      logs.userAdded(uid, config.mailchimpAudienceId, results.id);
+      logs.userAdded(
+        uid,
+        config.mailchimpAudienceId,
+        results.id,
+        config.mailchimpContactStatus
+      );
       logs.complete();
     } catch (err) {
       logs.errorAddUser(err);

auth-mailchimp-sync/functions/src/logs.ts

@@ -48,16 +48,20 @@ export const mailchimpNotInitialized = () => {
 };
 
 export const start = () => {
-  console.log("Started execution of extension with configuration", obfuscatedConfig);
+  console.log(
+    "Started execution of extension with configuration",
+    obfuscatedConfig
+  );
 };
 
 export const userAdded = (
   userId: string,
   audienceId: string,
-  mailchimpId: string
+  mailchimpId: string,
+  status: string
 ) => {
   console.log(
-    `Added user: ${userId} to Mailchimp audience: ${audienceId} with Mailchimp ID: ${mailchimpId}`
+    `Added user: ${userId} with status '${status}' to Mailchimp audience: ${audienceId} with Mailchimp ID: ${mailchimpId}`
   );
 };
 

delete-user-data/extension.yaml

@@ -23,8 +23,8 @@ description:
 
 license: Apache-2.0
 billingRequired: false
-sourceUrl: https://accounts.google.com/AccountChooser/signinchooser?service=gerritcodereview&continue=https%3A%2F%2Fdev-partners.googlesource.com%2Flogin%2Fsamples%2Ffirebase%2Fmods%2F%2B%2Fmaster%2Fdelete-user-data
-releaseNotesUrl: https://dev-partners.googlesource.com/samples/firebase/mods/+log
+sourceUrl: https://github.com/firebase/extensions/tree/master/delete-user-data
+releaseNotesUrl: https://github.com/firebase/extensions/commits/master
 
 author:
   authorName: Firebase

firestore-bigquery-export/POSTINSTALL.md

@@ -22,7 +22,7 @@ You can test out this extension right away:
     SELECT * FROM `${param:PROJECT_ID}.${param:DATASET_ID}.${param:TABLE_ID}_raw_latest`
     ```
 
-1.  Delete the `bigquery-mirror-test` document from [Cloud Firestore](https://console.firebase.google.com/project/${param:PROJECT_ID}/database/firestore/data).  
+1.  Delete the `bigquery-mirror-test` document from [Cloud Firestore](https://console.firebase.google.com/project/${param:PROJECT_ID}/database/firestore/data).
 The `bigquery-mirror-test` document will disappear from the **latest view** and a `DELETE` event will be added to the **raw changelog table**.
 
 1.  You can check the changelogs of a single document with this query: