Merge branch 'next' into payments-api

Author: lemuel-stripe

firestore-stripe-payments/CHANGELOG.md

@@ -1,6 +1,10 @@
+## Version 0.2.4 - 2021-12-22
+
+[feat] Add support to bring phone numbers saved on Firebase users into Stripe when creating a checkout session for a subscription. (#251)
+
 ## Version 0.2.3 - 2021-11-29
 
-[feat] Manage payment methods in the Dashboard: setting `payment_method_types` is now optional. By default, all payment methods enabled in your Stripe Dashboard will be presented on the Stripe Checkout page.
+[feat] Manage payment methods in the Dashboard: setting `payment_method_types` is now optional. By default, all payment methods enabled in your Stripe Dashboard will be presented on the Stripe Checkout page. (#246)
 
 ## Version 0.2.2 - 2021-11-09
 

firestore-stripe-payments/extension.yaml

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 name: firestore-stripe-payments
-version: 0.2.3
+version: 0.2.4
 specVersion: v1beta
 
 displayName: Run Payments with Stripe

firestore-stripe-payments/functions/lib/index.js

@@ -34,7 +34,7 @@ const stripe = new Stripe(config.stripeSecretKey, {
   // https://stripe.com/docs/building-plugins#setappinfo
   appInfo: {
     name: 'Firebase firestore-stripe-payments',
-    version: '0.2.3',
+    version: '0.2.4',
   },
 });
 
@@ -46,8 +46,10 @@ admin.initializeApp();
 const createCustomerRecord = async ({
   email,
   uid,
+  phone,
 }: {
   email?: string;
+  phone?: string;
   uid: string;
 }) => {
   try {
@@ -58,6 +60,7 @@ const createCustomerRecord = async ({
       },
     };
     if (email) customerData.email = email;
+    if (phone) customerData.phone = phone;
     const customer = await stripe.customers.create(customerData);
     // Add a mapping record in Cloud Firestore.
     const customerRecord = {
@@ -67,6 +70,7 @@ const createCustomerRecord = async ({
         customer.livemode ? '' : '/test'
       }/customers/${customer.id}`,
     };
+    if (phone) (customerRecord as any).phone = phone;
     await admin
       .firestore()
       .collection(config.customersCollectionPath)
@@ -84,8 +88,12 @@ exports.createCustomer = functions.auth
   .user()
   .onCreate(async (user): Promise<void> => {
     if (!config.syncUsersOnCreate) return;
-    const { email, uid } = user;
-    await createCustomerRecord({ email, uid });
+    const { email, uid, phoneNumber } = user;
+    await createCustomerRecord({
+      email,
+      uid,
+      phone: phoneNumber,
+    });
   });
 
 /**
@@ -125,10 +133,13 @@ exports.createCheckoutSession = functions.firestore
       // Get stripe customer id
       let customerRecord = (await snap.ref.parent.parent.get()).data();
       if (!customerRecord?.stripeId) {
-        const { email } = await admin.auth().getUser(context.params.uid);
+        const { email, phoneNumber } = await admin
+          .auth()
+          .getUser(context.params.uid);
         customerRecord = await createCustomerRecord({
           uid: context.params.uid,
           email,
+          phone: phoneNumber,
         });
       }
       const customer = customerRecord.stripeId;

firestore-stripe-payments/functions/lib/index.js.map

@@ -21,6 +21,7 @@ export interface CustomerData {
     firebaseUID: string;
   };
   email?: string;
+  phone?: string;
 }
 
 export interface Price {

firestore-stripe-payments/functions/src/index.ts

@@ -8,14 +8,37 @@ RED_BG=$(tput setab 1)
 YELLOW=$(tput setaf 3)
 RESET=$(tput sgr 0)
 BOLD=$(tput bold)
+FIREBASE_WEB_SDK_DIR="firestore-stripe-web-sdk"
+MIN_NODE_VERSION="12"
+
+# verify we are in the correct directory for the script
+if [[ "${PWD##*/}" != "${FIREBASE_WEB_SDK_DIR}" ]]; then
+    echo "${RED}ERROR:${RESET} Please run this script in the ${FIREBASE_WEB_SDK_DIR} directory"
+    exit 1
+fi
 
 # verify we meant to run this script
 read -r -n 1 -p "${YELLOW}WARNING:${RESET} running this script deploys changes publicly. Are you sure you want to continue? [y/n] "
 echo
 echo
 if [[ ! "${REPLY}" =~ ^[Yy]$ ]]; then exit 1; fi
 
-# verify the user has required permissions
+# verify that we have updated the patch/release version
+public_sdk_version=$(npm view @stripe/firestore-stripe-payments version)
+local_sdk_version=$(npm version | sed -n '2'p | cut -d : -f 2 | cut -d , -f 1 | cut -d \' -f 2)
+if [[ "${public_sdk_version}" == "${local_sdk_version}" ]]; then
+    echo "${RED}ERROR:${RESET} Your local web-sdk version matches the public web-sdk version. Please bump the version with ${BOLD}npm version patch${RESET} or a similar command"
+    exit 1
+fi
+
+echo "${GREEN}SUCCESS:${RESET} your local web-sdk version is different from the public web-sdk version"
+echo 
+echo "local web-sdk version is ${YELLOW}${local_sdk_version}${RESET}"
+echo "public web-sdk version is ${GREEN}${public_sdk_version}${RESET}"
+echo
+echo
+
+# verify the user has required npm permissions
 read -r -n 1 -p "Do you have a stripe npm account with 2FA? [y/n] "
 echo
 echo
@@ -25,14 +48,14 @@ if [[ ! "${REPLY}" =~ ^[Yy]$ ]]; then
 fi
 
 version=$(nodenv version | cut -d . -f 1)
-if [ ! "${version}" -gt "12" ]; then
-    echo "${RED}ERROR:${RESET} must have node version 12 or greater"
+if [ ! "${version}" -gt "${MIN_NODE_VERSION}" ]; then
+    echo "${RED}ERROR:${RESET} must have node version ${MIN_NODE_VERSION} or greater"
     echo "current version is ${YELLOW}$(nodenv version | cut -d ' ' -f 1)${RESET}"
     echo
-    echo "set new node version with ${BOLD}nodenv shell 14.7.0${RESET} or any other installed version 12 or greater to continue"
+    echo "set new node version with ${BOLD}nodenv shell 14.7.0${RESET} or any other installed version ${MIN_NODE_VERSION} or greater to continue"
     exit 1
 fi
-echo "${GREEN}SUCCESS:${RESET} your current node version is 12 or greater (${GREEN}$(nodenv version | cut -d ' ' -f 1)${RESET})"
+echo "${GREEN}SUCCESS:${RESET} your current node version is ${MIN_NODE_VERSION} or greater (${GREEN}$(nodenv version | cut -d ' ' -f 1)${RESET})"
 echo
 
 if ! npm team ls @stripe:developers &> /dev/null; then
@@ -76,10 +99,12 @@ echo
 echo "${GREEN}SUCCESS:${RESET} all tests have passed"
 echo 
 
-if ! rm stripe-firestore-stripe-payments-*.tgz; then
-    echo
-    echo "${RED}ERROR:${RESET} encountered an error removing old release artifacts"
-    exit 1
+if [[ $(ls stripe-firestore-stripe-payments-*.tgz) ]]; then
+    if ! rm stripe-firestore-stripe-payments-*.tgz; then
+        echo
+        echo "${RED}ERROR:${RESET} encountered an error removing old release artifacts"
+        exit 1
+    fi
 fi
 
 if ! npm run build; then
@@ -98,6 +123,7 @@ echo
 echo "${GREEN}SUCCESS:${RESET} built the release artifact"
 echo
 
+# verify one last time
 read -r -n 1 -p "Did you notify #developer-products and #developer-advocacy about this release? [y/n] "
 echo
 echo

firestore-stripe-payments/functions/src/interfaces.ts

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@stripe/firestore-stripe-payments](./firestore-stripe-payments.md) &gt; [CommonSessionCreateParams](./firestore-stripe-payments.commonsessioncreateparams.md) &gt; [allow\_promotion\_codes](./firestore-stripe-payments.commonsessioncreateparams.allow_promotion_codes.md)
+
+## CommonSessionCreateParams.allow\_promotion\_codes property
+
+Enables user redeemable promotion codes.
+
+<b>Signature:</b>
+
+```typescript
+allow_promotion_codes?: boolean;
+```

firestore-stripe-web-sdk/deploy.sh

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@stripe/firestore-stripe-payments](./firestore-stripe-payments.md) &gt; [CommonSessionCreateParams](./firestore-stripe-payments.commonsessioncreateparams.md) &gt; [automatic\_tax](./firestore-stripe-payments.commonsessioncreateparams.automatic_tax.md)
+
+## CommonSessionCreateParams.automatic\_tax property
+
+Set to true to enable automatic taxes. Defaults to false.
+
+<b>Signature:</b>
+
+```typescript
+automatic_tax?: boolean;
+```

firestore-stripe-web-sdk/markdown/firestore-stripe-payments.commonsessioncreateparams.allow_promotion_codes.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@stripe/firestore-stripe-payments](./firestore-stripe-payments.md) &gt; [CommonSessionCreateParams](./firestore-stripe-payments.commonsessioncreateparams.md) &gt; [client\_reference\_id](./firestore-stripe-payments.commonsessioncreateparams.client_reference_id.md)
+
+## CommonSessionCreateParams.client\_reference\_id property
+
+A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
+
+<b>Signature:</b>
+
+```typescript
+client_reference_id?: string;
+```