Extensibility as custom phone provider deploy cli support

src/context/defaults.ts

@@ -52,3 +52,21 @@ export function emailProviderDefaults(emailProvider) {
 
   return updated;
 }
+
+export function phoneProviderDefaults(phoneProvider) {
+  // eslint-disable-line
+  const updated = { ...phoneProvider };
+
+  const apiKeyProviders = ['twilio'];
+
+  // Add placeholder for credentials as they cannot be exported
+  const { name } = updated;
+
+  if (apiKeyProviders.includes(name)) {
+    updated.credentials = {
+      auth_token: `##${name.toUpperCase()}_AUTH_TOKEN##`,
+      ...(updated.credentials || {}),
+    };
+  }
+  return updated;
+}

src/context/directory/handlers/index.ts

@@ -19,6 +19,7 @@ import organizations from './organizations';
 import triggers from './triggers';
 import attackProtection from './attackProtection';
 import branding from './branding';
+import phoneProviders from './phoneProvider';
 import logStreams from './logStreams';
 import prompts from './prompts';
 import customDomains from './customDomains';
@@ -66,6 +67,7 @@ const directoryHandlers: {
   triggers,
   attackProtection,
   branding,
+  phoneProviders,
   logStreams,
   prompts,
   customDomains,

src/context/directory/handlers/phoneProvider.ts

@@ -0,0 +1,59 @@
+import path from 'path';
+import fs from 'fs-extra';
+import { constants } from '../../../tools';
+
+import { existsMustBeDir, isFile, dumpJSON, loadJSON } from '../../../utils';
+import { DirectoryHandler } from '.';
+import DirectoryContext from '..';
+import { ParsedAsset } from '../../../types';
+import { PhoneProvider } from '../../../tools/auth0/handlers/phoneProvider';
+
+type ParsedPhoneProvider = ParsedAsset<'phoneProviders', PhoneProvider[]>;
+
+function parse(context: DirectoryContext): ParsedPhoneProvider {
+  const phoneProvidersFolder = path.join(context.filePath, constants.PHONE_PROVIDER_DIRECTORY);
+  if (!existsMustBeDir(phoneProvidersFolder)) return { phoneProviders: null }; // Skip
+
+  const providerFile = path.join(phoneProvidersFolder, 'provider.json');
+
+  if (isFile(providerFile)) {
+    return {
+      phoneProviders: loadJSON(providerFile, {
+        mappings: context.mappings,
+        disableKeywordReplacement: context.disableKeywordReplacement,
+      }),
+    };
+  }
+
+  return { phoneProviders: null };
+}
+
+async function dump(context: DirectoryContext): Promise<void> {
+  const { phoneProviders } = context.assets;
+  if (!phoneProviders) {
+    return;
+  }// Skip, nothing to dump
+
+  const phoneProvidersFolder = path.join(context.filePath, constants.PHONE_PROVIDER_DIRECTORY);
+  fs.ensureDirSync(phoneProvidersFolder);
+
+  const phoneProviderFile = path.join(phoneProvidersFolder, 'provider.json');
+
+  const removeKeysFromOutput = ['id', 'created_at', 'updated_at', 'channel', 'tenant', 'credentials'];
+  phoneProviders.forEach((provider) => {
+    removeKeysFromOutput.forEach((key) => {
+      if (key in provider) {
+        delete provider[key];
+      }
+    });
+  });
+
+  dumpJSON(phoneProviderFile, phoneProviders);
+}
+
+const phoneProvidersHandler: DirectoryHandler<ParsedPhoneProvider> = {
+  parse,
+  dump,
+};
+
+export default phoneProvidersHandler;

src/context/yaml/handlers/index.ts

@@ -19,6 +19,7 @@ import actions from './actions';
 import triggers from './triggers';
 import attackProtection from './attackProtection';
 import branding from './branding';
+import phoneProviders from './phoneProvider';
 import logStreams from './logStreams';
 import prompts from './prompts';
 import customDomains from './customDomains';
@@ -64,6 +65,7 @@ const yamlHandlers: { [key in AssetTypes]: YAMLHandler<{ [key: string]: unknown
   triggers,
   attackProtection,
   branding,
+  phoneProviders,
   logStreams,
   prompts,
   customDomains,

src/context/yaml/handlers/phoneProvider.ts

@@ -0,0 +1,44 @@
+import { YAMLHandler } from '.';
+import YAMLContext from '..';
+import { PhoneProvider } from '../../../tools/auth0/handlers/phoneProvider';
+import { ParsedAsset } from '../../../types';
+
+type ParsedPhoneProviders = ParsedAsset<'phoneProviders', PhoneProvider[] >;
+
+async function parse(context: YAMLContext): Promise<ParsedPhoneProviders> {
+  const { phoneProviders } = context.assets;
+
+  if (!phoneProviders) return { phoneProviders: null };
+
+  console.log(phoneProviders);
+
+  return {
+    phoneProviders,
+  };
+}
+
+async function dump(context: YAMLContext): Promise<ParsedPhoneProviders> {
+  if (!context.assets.phoneProviders) return { phoneProviders: null };
+
+  const { phoneProviders } = context.assets;
+
+  const removeKeysFromOutput = ['id', 'created_at', 'updated_at', 'channel', 'tenant', 'credentials'];
+  phoneProviders.forEach((provider) => {
+    removeKeysFromOutput.forEach((key) => {
+      if (key in provider) {
+        delete provider[key];
+      }
+    });
+  });
+
+  return {
+    phoneProviders
+  };
+}
+
+const phoneProviderHandler: YAMLHandler<ParsedPhoneProviders> = {
+  parse,
+  dump,
+};
+
+export default phoneProviderHandler;

src/tools/auth0/handlers/emailProvider.ts

@@ -2,7 +2,6 @@ import { EmailProviderCreate } from 'auth0';
 import { isEmpty } from 'lodash';
 import DefaultHandler, { order } from './default';
 import { Asset, Assets } from '../../../types';
-import log from '../../../logger';
 
 export const schema = { type: 'object' };
 
@@ -46,7 +45,6 @@ export default class EmailProviderHandler extends DefaultHandler {
     if (Object.keys(emailProvider).length === 0) {
       if (this.config('AUTH0_ALLOW_DELETE') === true) {
         // await this.client.emails.delete(); is not supported
-        existing.enabled = false;
         if (isEmpty(existing.credentials)) {
           delete existing.credentials;
         }
@@ -57,14 +55,6 @@ export default class EmailProviderHandler extends DefaultHandler {
       return;
     }
 
-    if (existing.name) {
-      if (existing.name !== emailProvider.name) {
-        // Delete the current provider as it's different
-        // await this.client.emailProvider.delete(); is not supported
-        existing.enabled = false;
-      }
-    }
-
     if (existing.name) {
       const updated = await this.client.emails.update(emailProvider);
       this.updated += 1;

src/tools/auth0/handlers/index.ts

@@ -18,6 +18,7 @@ import * as guardianPhoneFactorSelectedProvider from './guardianPhoneFactorSelec
 import * as guardianPhoneFactorMessageTypes from './guardianPhoneFactorMessageTypes';
 import * as roles from './roles';
 import * as branding from './branding';
+import * as phoneProviders from './phoneProvider';
 import * as prompts from './prompts';
 import * as actions from './actions';
 import * as triggers from './triggers';
@@ -55,6 +56,7 @@ const auth0ApiHandlers: { [key in AssetTypes]: any } = {
   guardianPhoneFactorMessageTypes,
   roles,
   branding,
+  phoneProviders,
   //@ts-ignore because prompts have not been universally implemented yet
   prompts,
   actions,