Merge remote-tracking branch 'origin/master' into rsgowman/usermetadata_tojson_lastrefreshtime

Author: rsgowman

.eslintrc.js

@@ -22,7 +22,6 @@ module.exports = {
   ],
   extends: [
     'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
   ],
   rules: {
@@ -33,9 +32,19 @@ module.exports = {
     // Disabled checks
     '@typescript-eslint/no-explicit-any': 0,
     '@typescript-eslint/no-use-before-define': 0,
+    '@typescript-eslint/no-var-requires': 0,
 
     // Required checks
     'indent': ['error', 2],
+    'keyword-spacing': ['error'],
+    'max-len': [
+      'error',
+      {
+        'code': 120,
+        'ignoreUrls': true
+      }
+    ],
+    'object-curly-spacing': [2, 'always'],
     '@typescript-eslint/explicit-function-return-type': [
       'error',
       {
@@ -44,5 +53,65 @@ module.exports = {
         'allowHigherOrderFunctions': true
       }
     ],
+    'no-unused-vars': 'off', // Must be disabled to enable the next rule
+    '@typescript-eslint/no-unused-vars': ['error'],
+    'quotes': ['error', 'single', {'avoidEscape': true}],
+    '@typescript-eslint/naming-convention': [
+      'error',
+      {
+        "selector": "variable",
+        "format": ["camelCase", "UPPER_CASE"]
+      },
+      {
+        "selector": "parameter",
+        "format": ["camelCase"],
+        "leadingUnderscore": "allow"
+      },
+  
+      {
+        "selector": "memberLike",
+        "format": ["camelCase"]
+      },
+  
+      {
+        "selector": "typeLike",
+        "format": ["PascalCase"]
+      },
+
+      // Ignore properties that require quotes (HTTP headers, names that include spaces or dashes etc.).
+      {
+        "selector": [
+          "classProperty",
+          "objectLiteralProperty",
+          "typeProperty",
+          "classMethod",
+          "objectLiteralMethod",
+          "typeMethod",
+          "accessor",
+          "enumMember"
+        ],
+        "format": null,
+        "modifiers": ["requiresQuotes"]
+      },
+
+      // Ignore destructured property names.
+      {
+        "selector": "variable",
+        "modifiers": ["destructured"],
+        "format": null
+      },
+
+      // Following types are temporarily disabled. We shall incrementally enable them in the
+      // future, fixing any violations as we go.
+      {
+        "selector": [
+          "classProperty",
+          "objectLiteralProperty",
+          "typeProperty",
+          "enumMember"
+        ],
+        "format": null
+      }
+    ],
   }
 };

.github/actions/send-email/README.md

@@ -0,0 +1,59 @@
+# Send Email GitHub Action
+
+This is a minimalistic GitHub Action for sending emails using the Mailgun API.
+Specify the Mailgun API key along with the Mailgun domain and message to
+be sent.
+
+## Inputs
+
+### `api-key`
+
+**Required** Mailgun API key.
+
+### `domain`
+
+**Required** Mailgun domain name.
+
+### `from`
+
+**Required** Sender's email address. Ex: 'Hello User <[email protected]>' (defaults to 'user@{domain}`).
+
+### `to`
+
+**Required** Recipient's email address. You can use commas to separate multiple recipients.
+
+### `cc`
+
+Email addresses to Cc.
+
+### `subject`
+
+**Required** Message subject.
+
+### `text`
+
+Text body of the message.
+
+### `html`
+
+HTML body of the message.
+
+## Example usage
+
+```
+- name: Send Email
+  uses: firebase/firebase-admin-node/.github/actions/send-email
+  with:
+    api-key: ${{ secrets.MAILGUN_API_KEY }}
+    domain: ${{ secrets.MAILGUN_DOMAIN }}
+    from: 'User <[email protected]>'
+    html: '<h1>Testing some Mailgun awesomness!</h1>'
+    to: '[email protected]'
+```
+
+## Implementation
+
+This Action uses the `mailgun.js` NPM package to send Emails.
+
+When making a code change remember to run `npm run pack` to rebuild the
+`dist/index.js` file which is the executable of this Action.

.github/actions/send-email/action.yml

@@ -0,0 +1,44 @@
+# Copyright 2021 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.
+
+name: 'Send email Action'
+description: 'Send emails using Mailgun from GitHub Actions workflows.'
+inputs:
+  api-key:
+    description: Mailgun API key.
+    required: true
+  domain:
+    description: Mailgun domain name.
+    required: true
+  from:
+    description: Senders name and email address.
+    required: true
+  to:
+    description: Recipient's email address. You can use commas to separate multiple recipients.
+    required: true
+  cc:
+    description: Email addresses to Cc.
+    required: false
+  subject:
+    description: Message subject.
+    required: true
+  text:
+    description: Text body of the message.
+    required: false
+  html:
+    description: HTML body of the message.
+    required: false
+runs:
+  using: 'node12'
+  main: 'dist/index.js'