Update helper class build functions to return explicit interface types instead of anonymous values in an array

[georgebearden]

While working on a new construct in #849, it was mentioned that we should consider defining explicit interfaces for the return values of the build functions from our helper classes. See here for an example.

Use Case

By defining explicit interface types as the return values for the helper class build functions, we can improve the usability of the APIs. This will help consumers of the helper classes by using actual strongly-typed property names, and not have to index into arrays.

Proposed Solution

Change the helper classes build methods from this (using sns-helper as an example):

export function buildTopic(scope: Construct, props: BuildTopicProps): [sns.Topic, kms.Key?] {
  if (!props.existingTopicObj) {  
   ...
    return [topic, snsTopicProps.masterKey];
  } else {
    return [props.existingTopicObj];
  }
}

to this:

export interface BuildTopicResult {
  readonly topic: sns.Topic;
  readonly encryptionKey?: kms.Key;
}

export function buildTopic(scope: Construct, props: BuildTopicProps): BuildTopicResult {
  if (!props.existingTopicObj) {  
   ...
    return {
      topic, 
      encryptionKey: snsTopicProps.masterKey
    }
  } else {
    return {
      topic
    }
  }
}

Other

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

---

This is a 🚀 Feature Request