Regenerate READMEs

Author: Lauren Long

auth-mailchimp-sync/README.md

@@ -1,3 +1,4 @@
+i  extensions: reading extension from directory: .
 # Sync with Mailchimp
 
 **Description**: Adds new users from Firebase Authentication to a specified Mailchimp audience.
@@ -35,7 +36,7 @@ Usage of this extension also requires you to have a Mailchimp account. You are r
 
 **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).
+* Cloud Functions location: Where do you want to deploy the functions created for this extension?
 
 * 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/).
 

delete-user-data/functions/lib/index.js

@@ -15,10 +15,11 @@
  * limitations under the License.
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
@@ -36,7 +37,7 @@ logs.init();
  * Storage, and Firestore. It waits for all deletions to complete, and then
  * returns a success message.
  */
-exports.clearData = functions.auth.user().onDelete((user) => __awaiter(this, void 0, void 0, function* () {
+exports.clearData = functions.auth.user().onDelete((user) => __awaiter(void 0, void 0, void 0, function* () {
     logs.start();
     const { firestorePaths, rtdbPaths, storagePaths } = config_1.default;
     const { uid } = user;
@@ -62,10 +63,10 @@ exports.clearData = functions.auth.user().onDelete((user) => __awaiter(this, voi
     yield Promise.all(promises);
     logs.complete(uid);
 }));
-const clearDatabaseData = (databasePaths, uid) => __awaiter(this, void 0, void 0, function* () {
+const clearDatabaseData = (databasePaths, uid) => __awaiter(void 0, void 0, void 0, function* () {
     logs.rtdbDeleting();
     const paths = extractUserPaths(databasePaths, uid);
-    const promises = paths.map((path) => __awaiter(this, void 0, void 0, function* () {
+    const promises = paths.map((path) => __awaiter(void 0, void 0, void 0, function* () {
         try {
             logs.rtdbPathDeleting(path);
             yield admin
@@ -81,10 +82,10 @@ const clearDatabaseData = (databasePaths, uid) => __awaiter(this, void 0, void 0
     yield Promise.all(promises);
     logs.rtdbDeleted();
 });
-const clearStorageData = (storagePaths, uid) => __awaiter(this, void 0, void 0, function* () {
+const clearStorageData = (storagePaths, uid) => __awaiter(void 0, void 0, void 0, function* () {
     logs.storageDeleting();
     const paths = extractUserPaths(storagePaths, uid);
-    const promises = paths.map((path) => __awaiter(this, void 0, void 0, function* () {
+    const promises = paths.map((path) => __awaiter(void 0, void 0, void 0, function* () {
         const parts = path.split("/");
         const bucketName = parts[0];
         const bucket = bucketName === "{DEFAULT}"
@@ -110,10 +111,10 @@ const clearStorageData = (storagePaths, uid) => __awaiter(this, void 0, void 0,
     yield Promise.all(promises);
     logs.storageDeleted();
 });
-const clearFirestoreData = (firestorePaths, uid) => __awaiter(this, void 0, void 0, function* () {
+const clearFirestoreData = (firestorePaths, uid) => __awaiter(void 0, void 0, void 0, function* () {
     logs.firestoreDeleting();
     const paths = extractUserPaths(firestorePaths, uid);
-    const promises = paths.map((path) => __awaiter(this, void 0, void 0, function* () {
+    const promises = paths.map((path) => __awaiter(void 0, void 0, void 0, function* () {
         try {
             const isRecursive = config_1.default.firestoreDeleteMode === "recursive";
             if (!isRecursive) {

firestore-bigquery-export/README.md

@@ -1,3 +1,4 @@
+i  extensions: reading extension from directory: .
 # Export Collections to BigQuery
 
 **Description**: Sends realtime, incremental updates from a specified Cloud Firestore collection to BigQuery.
@@ -22,11 +23,15 @@ Before installing this extension, you'll need to:
 +   [Set up Cloud Firestore in your Firebase project.](https://firebase.google.com/docs/firestore/quickstart)
 +   [Link your Firebase project to BigQuery.](https://support.google.com/firebase/answer/6318765)
 
-This extension only sends the content of documents that have been changed -- it does not export your full dataset of existing documents into BigQuery. So, to backfill your BigQuery dataset with all the documents in your collection, you can run the import script provided by this extension.
+##### Backfill your BigQuery dataset
 
-**Important:** Run the script over the entire collection _after_ installing this extension, otherwise all writes to your database during the import might be lost.
+This extension only sends the content of documents that have been changed -- it does not export your full dataset of existing documents into BigQuery. So, to backfill your BigQuery dataset with all the documents in your collection, you can run the [import script](https://github.com/firebase/extensions/blob/master/firestore-bigquery-export/guides/IMPORT_EXISTING_DOCUMENTS.md) provided by this extension.
 
-Learn more about using this script to [backfill your existing collection](https://github.com/firebase/extensions/blob/master/firestore-bigquery-export/guides/IMPORT_EXISTING_DOCUMENTS.md).
+**Important:** Run the import script over the entire collection _after_ installing this extension, otherwise all writes to your database during the import might be lost.
+
+##### Generate schema views
+
+After your data is in BigQuery, you can run the [schema-views script](https://github.com/firebase/extensions/blob/master/firestore-bigquery-export/guides/GENERATE_SCHEMA_VIEWS.md) (provided by this extension) to create views that make it easier to query relevant data. You only need to provide a JSON schema file that describes your data structure, and the schema-views script will create the views.
 
 #### Billing
 
@@ -43,7 +48,7 @@ When you use Firebase Extensions, you're only charged for the underlying resourc
 
 **Configuration Parameters:**
 
-* Deployment location: Where should the extension be deployed? You usually want a location close to your database. For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
+* Cloud Functions location: Where do you want to deploy the functions created for this extension?  You usually want a location close to your database. For help selecting a  location, refer to the [location selection  guide](https://firebase.google.com/docs/functions/locations).  Note that this extension locates your BigQuery dataset in `us-central1`.
 
 * Collection path: What is the path of the collection that you would like to export? You may use `{wildcard}` notation to match a subcollection of all documents in a collection (for example: `chatrooms/{chatid}/posts`).
 

firestore-counter/README.md

@@ -1,3 +1,4 @@
+i  extensions: reading extension from directory: .
 # Distributed Counter
 
 **Description**: Records event counters at scale to accommodate high-velocity writes to Cloud Firestore.
@@ -24,7 +25,7 @@ Before installing this extension, make sure that you've [set up a Cloud Firestor
 After installing this extension, you'll need to:
 
 - Update your [database security rules](https://firebase.google.com/docs/rules).
-- Set up a [scheduled function](https://firebase.google.com/docs/functions/schedule-functions) to regularly call the controller function, which is created by this extension and monitors the extension's workload.
+- Set up a [Cloud Scheduler job](https://cloud.google.com/scheduler/docs/quickstart) to regularly call the controllerCore function, which is created by this extension. It works by either aggregating shards itself or scheduling and monitoring workers to aggregate shards.
 - Install the provided [Counter SDK](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts) in your app. You can then use this library in your code to specify your document path and increment values.
 
 Detailed information for these post-installation tasks are provided after you install this extension.
@@ -44,19 +45,21 @@ When you use Firebase Extensions, you're only charged for the underlying resourc
 
 **Configuration Parameters:**
 
-* Deployment location: Where should the extension be deployed? You usually want a location close to your database. For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
+* Cloud Functions location: Where do you want to deploy the functions created for this extension?  You usually want a location close to your database. For help selecting a  location, refer to the [location selection  guide](https://firebase.google.com/docs/functions/locations).
 
 * Document path for internal state: What is the path to the document where the extension can keep its internal state?
 
 
 
 **Cloud Functions:**
 
-* **controller:** Scheduled to run every minute. This function either aggregates shards itself, or it schedules and monitors workers to aggregate shards.
+* **controllerCore:** Scheduled to run every minute. This function either aggregates shards itself, or it schedules and monitors workers to aggregate shards.
+
+* **controller:** Maintained for backwards compatibility. This function relays a message to the extension's Pub/Sub topic to trigger the controllerCore function.
 
 * **onWrite:** Listens for changes on counter shards that may need aggregating. This function is limited to max 1 instance.
 
-* **worker:** Monitors a range of shards and aggregates them, as needed. There may be 0 or more worker functions running at any point in time. The controller function is responsible for scheduling and monitoring these workers.
+* **worker:** Monitors a range of shards and aggregates them, as needed. There may be 0 or more worker functions running at any point in time. The controllerCore function is responsible for scheduling and monitoring these workers.
 
 
 
@@ -67,3 +70,5 @@ When you use Firebase Extensions, you're only charged for the underlying resourc
 This extension will operate with the following project IAM roles:
 
 * datastore.user (Reason: Allows the extension to aggregate Cloud Firestore counter shards.)
+
+* pubsub.publisher (Reason: Allows the HTTPS controller function to publish a message to the extension's Pub/Sub topic, which triggers the controllerCore function.)

firestore-counter/functions/lib/worker.js

@@ -30,7 +30,7 @@ const planner_1 = require("./planner");
 const aggregator_1 = require("./aggregator");
 const firestore_1 = require("@google-cloud/firestore");
 const uuid = require("uuid");
-const SHARDS_LIMIT = 499;
+const SHARDS_LIMIT = 100;
 const WORKER_TIMEOUT_MS = 45000;
 /**
  * Worker is controlled by WorkerMetadata document stored at process.env.MODS_INTERNAL_COLLECTION

firestore-send-email/README.md

@@ -1,3 +1,4 @@
+i  extensions: reading extension from directory: .
 # Trigger Email
 
 **Description**: Composes and sends an email based on the contents of a document written to a specified Cloud Firestore collection.
@@ -44,7 +45,7 @@ Usage of this extension also requires you to have SMTP credentials for mail deli
 
 **Configuration Parameters:**
 
-* Deployment location: Where should the extension be deployed? You usually want a location close to your database. For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
+* Cloud Functions location: Where do you want to deploy the functions created for this extension?  You usually want a location close to your database. For help selecting a  location, refer to the [location selection  guide](https://firebase.google.com/docs/functions/locations).
 
 * SMTP connection URI: A URI representing an SMTP server that this extension can use to deliver email.
 

firestore-shorten-urls-bitly/README.md

@@ -1,3 +1,4 @@
+i  extensions: reading extension from directory: .
 # Shorten URLs
 
 **Description**: Shortens URLs written to a specified Cloud Firestore collection (uses Bitly).
@@ -37,7 +38,7 @@ Usage of this extension also requires you to have a Bit.ly account. You are resp
 
 **Configuration Parameters:**
 
-* Deployment location: Where should the extension be deployed? You usually want a location close to your database. For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
+* Cloud Functions location: Where do you want to deploy the functions created for this extension?  You usually want a location close to your database. For help selecting a  location, refer to the [location selection  guide](https://firebase.google.com/docs/functions/locations).
 
 * Bitly access token: What is your Bitly access token? Generate this access token using [Bitly](https://bitly.com/a/oauth_apps).
 

firestore-translate-text/README.md

@@ -1,3 +1,4 @@
+i  extensions: reading extension from directory: .
 # Translate Text
 
 **Description**: Translates strings written to a Cloud Firestore collection into multiple languages (uses Cloud Translation API).
@@ -34,7 +35,7 @@ When you use Firebase Extensions, you're only charged for the underlying resourc
 
 **Configuration Parameters:**
 
-* Deployment location: Where should the extension be deployed? You usually want a location close to your database. For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
+* Cloud Functions location: Where do you want to deploy the functions created for this extension?  You usually want a location close to your database. For help selecting a  location, refer to the [location selection  guide](https://firebase.google.com/docs/functions/locations).
 
 * Target languages for translations, as a comma-separated list: Into which target languages do you want to translate new strings? The languages are identified using ISO-639-1 codes in a comma-separated list, for example: en,es,de,fr. For these codes, visit the [supported languages list](https://cloud.google.com/translate/docs/languages).
 

rtdb-limit-child-nodes/README.md

@@ -1,3 +1,4 @@
+i  extensions: reading extension from directory: .
 # Limit Child Nodes
 
 **Description**: Limits the number of nodes to a specified maximum count in a specified Realtime Database path.
@@ -26,7 +27,7 @@ When you use Firebase Extensions, you're only charged for the underlying resourc
 
 **Configuration Parameters:**
 
-* Deployment location: Where should the extension be deployed? You usually want a location close to your database. Realtime Database instances are located in us-central1. For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
+* Cloud Functions location: Where do you want to deploy the functions created for this extension?  You usually want a location close to your database. Realtime Database  instances are located in `us-central1`. For help selecting a  location, refer to the [location selection  guide](https://firebase.google.com/docs/functions/locations).
 
 * Realtime Database path: What is the Realtime Database path for which you want to limit the number of child nodes?
 

storage-resize-images/README.md

@@ -1,3 +1,4 @@
+i  extensions: reading extension from directory: .
 # Resize Images
 
 **Description**: Resizes images uploaded to Cloud Storage to a specified size, and optionally keeps or deletes the original image.
@@ -40,7 +41,7 @@ When you use Firebase Extensions, you're only charged for the underlying resourc
 
 **Configuration Parameters:**
 
-* Deployment location: Where should the extension be deployed? You usually want a location close to your Storage bucket. For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
+* Cloud Functions location: Where do you want to deploy the functions created for this extension?  You usually want a location close to your Storage bucket. For help selecting a  location, refer to the [location selection  guide](https://firebase.google.com/docs/functions/locations).
 
 * Cloud Storage bucket for images: To which Cloud Storage bucket will you upload images that you want to resize? Resized images will be stored in this bucket. Depending on your extension configuration, original images are either kept or deleted.