cover notifications and analytics in client config (#1003)

Author: Kamil Sobol

.changeset/grumpy-avocados-kick.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/client-config': minor
+---
+
+Add typings for notifications and analytics categories in client config

.eslint_dictionary.json

@@ -3,6 +3,7 @@
   "amazonaws",
   "amazoncognito",
   "amplifyconfiguration",
+  "apns",
   "appleid",
   "appsync",
   "argv",

packages/client-config/API.md

@@ -7,6 +7,16 @@
 import { AwsCredentialIdentityProvider } from '@aws-sdk/types';
 import { DeployedBackendIdentifier } from '@aws-amplify/deployed-backend-client';
 
+// @public (undocumented)
+export type AnalyticsClientConfig = {
+    Analytics?: {
+        AWSPinpoint: {
+            appId: string;
+            region: string;
+        };
+    };
+};
+
 // @public
 export type AuthClientConfig = {
     aws_cognito_region: string;
@@ -36,7 +46,7 @@ export type AuthClientConfig = {
 };
 
 // @public
-export type ClientConfig = Partial<AuthClientConfig & GeoClientConfig & GraphqlClientConfig & StorageClientConfig & PlatformClientConfig & CustomClientConfig>;
+export type ClientConfig = Partial<AnalyticsClientConfig & AuthClientConfig & GeoClientConfig & GraphqlClientConfig & NotificationsClientConfig & StorageClientConfig & PlatformClientConfig & CustomClientConfig>;
 
 // @public (undocumented)
 export enum ClientConfigFormat {
@@ -100,6 +110,42 @@ export type GraphqlClientConfig = {
     modelIntrospection?: unknown;
 };
 
+// @public (undocumented)
+export type NotificationsClientConfig = {
+    Notifications?: {
+        SMS?: {
+            AWSPinpoint: {
+                appId: string;
+                region: string;
+            };
+        };
+        EMAIL?: {
+            AWSPinpoint: {
+                appId: string;
+                region: string;
+            };
+        };
+        APNS?: {
+            AWSPinpoint: {
+                appId: string;
+                region: string;
+            };
+        };
+        FCM?: {
+            AWSPinpoint: {
+                appId: string;
+                region: string;
+            };
+        };
+        InAppMessaging?: {
+            AWSPinpoint: {
+                appId: string;
+                region: string;
+            };
+        };
+    };
+};
+
 // @public (undocumented)
 export type PlatformClientConfig = {
     aws_project_region: string;

packages/client-config/src/client-config-types/analytics_client_config.ts

@@ -0,0 +1,8 @@
+export type AnalyticsClientConfig = {
+  Analytics?: {
+    AWSPinpoint: {
+      appId: string;
+      region: string;
+    };
+  };
+};

packages/client-config/src/client-config-types/client_config.ts

@@ -4,14 +4,18 @@ import { PlatformClientConfig } from './platform_client_config.js';
 import { StorageClientConfig } from './storage_client_config.js';
 import { CustomClientConfig } from './custom_client_config.js';
 import { GeoClientConfig } from './geo_client_config.js';
+import { AnalyticsClientConfig } from './analytics_client_config.js';
+import { NotificationsClientConfig } from './notifications_client_config.js';
 
 /**
  * Merged type of all category client config types
  */
 export type ClientConfig = Partial<
-  AuthClientConfig &
+  AnalyticsClientConfig &
+    AuthClientConfig &
     GeoClientConfig &
     GraphqlClientConfig &
+    NotificationsClientConfig &
     StorageClientConfig &
     PlatformClientConfig &
     CustomClientConfig

packages/client-config/src/client-config-types/mobile/client_config_mobile_types.ts

@@ -1,9 +1,11 @@
 export type ClientConfigMobile = {
   UserAgent: string;
   Version: '1.0';
+  analytics?: ClientConfigMobileAnalytics;
   api?: ClientConfigMobileApi;
   auth?: ClientConfigMobileAuth;
   geo?: ClientConfigMobileGeo;
+  notifications?: ClientConfigMobileNotifications;
 };
 
 export type ClientConfigMobileApi = {
@@ -91,3 +93,38 @@ export type ClientConfigMobileGeo = {
     };
   };
 };
+
+export type ClientConfigMobileAnalytics = {
+  plugins: {
+    awsPinpointAnalyticsPlugin: {
+      pinpointAnalytics: {
+        appId: string;
+        region: string;
+      };
+      pinpointTargeting: {
+        region: string;
+      };
+    };
+  };
+};
+
+export type ClientConfigMobileNotifications = {
+  plugins: {
+    awsPinpointSmsNotificationsPlugin?: {
+      appId: string;
+      region: string;
+    };
+    awsPinpointEmailNotificationsPlugin?: {
+      appId: string;
+      region: string;
+    };
+    awsPinpointPushNotificationsPlugin?: {
+      appId: string;
+      region: string;
+    };
+    awsPinpointInAppMessagingNotificationsPlugin?: {
+      appId: string;
+      region: string;
+    };
+  };
+};

packages/client-config/src/client-config-types/notifications_client_config.ts

@@ -0,0 +1,34 @@
+export type NotificationsClientConfig = {
+  Notifications?: {
+    SMS?: {
+      AWSPinpoint: {
+        appId: string;
+        region: string;
+      };
+    };
+    EMAIL?: {
+      AWSPinpoint: {
+        appId: string;
+        region: string;
+      };
+    };
+    APNS?: {
+      AWSPinpoint: {
+        appId: string;
+        region: string;
+      };
+    };
+    FCM?: {
+      AWSPinpoint: {
+        appId: string;
+        region: string;
+      };
+    };
+    InAppMessaging?: {
+      AWSPinpoint: {
+        appId: string;
+        region: string;
+      };
+    };
+  };
+};

packages/client-config/src/client-config-writer/client_config_converter.test.ts

@@ -279,4 +279,193 @@ void describe('client config converter', () => {
 
     assert.deepStrictEqual(expectedMobileConfig, actualMobileConfig);
   });
+
+  void it('converts analytics config', () => {
+    const clientConfig: ClientConfig = {
+      Analytics: {
+        AWSPinpoint: {
+          appId: 'test_pinpoint_id',
+          region: 'us-west-2',
+        },
+      },
+    };
+
+    const expectedMobileConfig: ClientConfigMobile = {
+      UserAgent: 'test_package_name/test_package_version;',
+      Version: '1.0',
+      analytics: {
+        plugins: {
+          awsPinpointAnalyticsPlugin: {
+            pinpointAnalytics: {
+              appId: 'test_pinpoint_id',
+              region: 'us-west-2',
+            },
+            pinpointTargeting: {
+              region: 'us-west-2',
+            },
+          },
+        },
+      },
+    };
+
+    const actualMobileConfig = converter.convertToMobileConfig(clientConfig);
+
+    assert.deepStrictEqual(expectedMobileConfig, actualMobileConfig);
+  });
+
+  void it('converts full notifications config', () => {
+    const clientConfig: ClientConfig = {
+      Notifications: {
+        SMS: {
+          AWSPinpoint: {
+            appId: 'sms_app_id',
+            region: 'sms_region',
+          },
+        },
+        EMAIL: {
+          AWSPinpoint: {
+            appId: 'email_app_id',
+            region: 'email_region',
+          },
+        },
+        FCM: {
+          AWSPinpoint: {
+            appId: 'push_app_id',
+            region: 'push_region',
+          },
+        },
+        APNS: {
+          AWSPinpoint: {
+            appId: 'push_app_id',
+            region: 'push_region',
+          },
+        },
+        InAppMessaging: {
+          AWSPinpoint: {
+            appId: 'in_app_messaging_app_id',
+            region: 'in_app_messaging_region',
+          },
+        },
+      },
+    };
+
+    const expectedMobileConfig: ClientConfigMobile = {
+      UserAgent: 'test_package_name/test_package_version;',
+      Version: '1.0',
+      notifications: {
+        plugins: {
+          awsPinpointEmailNotificationsPlugin: {
+            appId: 'email_app_id',
+            region: 'email_region',
+          },
+          awsPinpointInAppMessagingNotificationsPlugin: {
+            appId: 'in_app_messaging_app_id',
+            region: 'in_app_messaging_region',
+          },
+          awsPinpointPushNotificationsPlugin: {
+            appId: 'push_app_id',
+            region: 'push_region',
+          },
+          awsPinpointSmsNotificationsPlugin: {
+            appId: 'sms_app_id',
+            region: 'sms_region',
+          },
+        },
+      },
+    };
+
+    const actualMobileConfig = converter.convertToMobileConfig(clientConfig);
+
+    assert.deepStrictEqual(expectedMobileConfig, actualMobileConfig);
+  });
+
+  void it('converts apn notifications config', () => {
+    const clientConfig: ClientConfig = {
+      Notifications: {
+        APNS: {
+          AWSPinpoint: {
+            appId: 'push_app_id',
+            region: 'push_region',
+          },
+        },
+      },
+    };
+
+    const expectedMobileConfig: ClientConfigMobile = {
+      UserAgent: 'test_package_name/test_package_version;',
+      Version: '1.0',
+      notifications: {
+        plugins: {
+          awsPinpointPushNotificationsPlugin: {
+            appId: 'push_app_id',
+            region: 'push_region',
+          },
+        },
+      },
+    };
+
+    const actualMobileConfig = converter.convertToMobileConfig(clientConfig);
+
+    assert.deepStrictEqual(expectedMobileConfig, actualMobileConfig);
+  });
+
+  void it('converts fcm notifications config', () => {
+    const clientConfig: ClientConfig = {
+      Notifications: {
+        FCM: {
+          AWSPinpoint: {
+            appId: 'push_app_id',
+            region: 'push_region',
+          },
+        },
+      },
+    };
+
+    const expectedMobileConfig: ClientConfigMobile = {
+      UserAgent: 'test_package_name/test_package_version;',
+      Version: '1.0',
+      notifications: {
+        plugins: {
+          awsPinpointPushNotificationsPlugin: {
+            appId: 'push_app_id',
+            region: 'push_region',
+          },
+        },
+      },
+    };
+
+    const actualMobileConfig = converter.convertToMobileConfig(clientConfig);
+
+    assert.deepStrictEqual(expectedMobileConfig, actualMobileConfig);
+  });
+
+  void it('throw on ambiguous push config', () => {
+    const clientConfig: ClientConfig = {
+      Notifications: {
+        FCM: {
+          AWSPinpoint: {
+            appId: 'push_app_id_1',
+            region: 'push_region',
+          },
+        },
+        APNS: {
+          AWSPinpoint: {
+            appId: 'push_app_id_2',
+            region: 'push_region',
+          },
+        },
+      },
+    };
+
+    assert.throws(
+      () => converter.convertToMobileConfig(clientConfig),
+      (error: Error) => {
+        assert.strictEqual(
+          error.message,
+          'Cannot convert client config to mobile config if both FCM and APNS are defined with different AWS Pinpoint instance'
+        );
+        return true;
+      }
+    );
+  });
 });