feat: add support for enabling self signup in Cognito

aws · Jun 18, 2024 · 300a8db · 300a8db
1 parent cc4f95a
commit 300a8db
Show file tree

Hide file tree

Showing 10 changed files with 125 additions and 5 deletions.
diff --git a/...act-ts-website/samples/cloudscape-react-ts-website/src/components/Auth/index.tsx.mustache b/...act-ts-website/samples/cloudscape-react-ts-website/src/components/Auth/index.tsx.mustache
@@ -24,6 +24,24 @@ const Auth: React.FC<any> = ({ children }) => {
       clientId={runtimeContext.userPoolWebClientId}
       region={runtimeContext.region}
       identityPoolId={runtimeContext.identityPoolId}
+      {{#allowSignup}}allowSignup={true}
+      {{/allowSignup}}signUpAttributes={[
+        {
+            displayName: "Email",
+            name: "email",
+            required: true,
+        },
+        {
+            displayName: "Given name",
+            name: "given_name",
+            required: true,
+        },
+        {
+            displayName: "Last name",
+            name: "family_name",
+            required: true,
+        }
+      ]}
     >
       {children}
     </CognitoAuth>

diff --git a/packages/cloudscape-react-ts-website/src/cloudscape-react-ts-website-project.ts b/packages/cloudscape-react-ts-website/src/cloudscape-react-ts-website-project.ts
@@ -30,6 +30,13 @@ export interface CloudscapeReactTsWebsiteProjectOptions
    */
   readonly publicDir?: string;
 
+  /**
+   * Whether to enable self sign-up.
+   *
+   * @default false
+   */
+  readonly allowSignup?: boolean;
+
   /**
    * TypeSafeApi instance to use when setting up the initial project sample code.
    * @deprecated use typeSafeApis
@@ -54,6 +61,7 @@ export interface CloudscapeReactTsWebsiteProjectOptions
  */
 export class CloudscapeReactTsWebsiteProject extends ReactTypeScriptProject {
   public readonly applicationName: string;
+  public readonly allowSignup: boolean;
   public readonly publicDir: string;
   public readonly typeSafeApis?: TypeSafeApiProject[];
   public readonly typeSafeWebSocketApis?: TypeSafeWebSocketApiProject[];
@@ -106,6 +114,7 @@ export class CloudscapeReactTsWebsiteProject extends ReactTypeScriptProject {
     this.testTask.exec("react-scripts test --watchAll=false --passWithNoTests");
 
     this.applicationName = options.applicationName ?? "Sample App";
+    this.allowSignup = options.allowSignup ?? false;
     this.publicDir = options.publicDir ?? "public";
     const srcDir = path.resolve(
       __dirname,
@@ -173,6 +182,7 @@ export class CloudscapeReactTsWebsiteProject extends ReactTypeScriptProject {
       typeSafeApisReversed: [...apis].reverse(),
       typeSafeWebSocketApis: webSocketApis,
       typeSafeWebSocketApisReversed: [...webSocketApis].reverse(),
+      allowSignup: options.allowSignup ?? false,
     };
 
     new SampleDir(this, this.srcdir, {

diff --git a/...cape-react-ts-website/test/__snapshots__/cloudscape-react-ts-website-project.test.ts.snap b/...cape-react-ts-website/test/__snapshots__/cloudscape-react-ts-website-project.test.ts.snap
diff --git a/packages/identity/src/user-identity.ts b/packages/identity/src/user-identity.ts
@@ -16,6 +16,13 @@ const WEB_CLIENT_ID = "WebClient";
  * Properties which configures the Identity Pool.
  */
 export interface UserIdentityProps {
+  /**
+   * Allow self sign up
+   *
+   * @default - false
+   */
+  readonly allowSignup?: boolean;
+
   /**
    * User provided Cognito UserPool.
    *
@@ -42,7 +49,11 @@ export class UserIdentity extends Construct {
 
     // Unless explicitly stated, created a default Cognito User Pool and Web Client.
     this.userPool = !props?.userPool
-      ? new UserPoolWithMfa(this, "UserPool")
+      ? new UserPoolWithMfa(
+          this,
+          "UserPool",
+          props?.allowSignup ? { selfSignUpEnabled: true } : undefined
+        )
       : props.userPool;
 
     this.identityPool = new IdentityPool(

diff --git a/...ucture/samples/infrastructure/java/src/java/groupId/stacks/ApplicationStack.java.mustache b/...ucture/samples/infrastructure/java/src/java/groupId/stacks/ApplicationStack.java.mustache
@@ -9,7 +9,8 @@ import {{{groupId}}}.constructs.apis.{{{apiName}}};
 import {{{groupId}}}.constructs.websites.{{{websiteName}}};
 {{/cloudscapeReactTsWebsites}}
 import software.aws.pdk.identity.UserIdentity;
-import software.constructs.Construct;
+{{#allowSignup}}import software.aws.pdk.identity.UserIdentityProps;
+{{/allowSignup}}import software.constructs.Construct;
 
 public class ApplicationStack extends Stack {
     public ApplicationStack(Construct scope, String id) {
@@ -19,7 +20,10 @@ public class ApplicationStack extends Stack {
     public ApplicationStack(Construct scope, String id, StackProps props) {
         super(scope, id, props);
 
-        UserIdentity userIdentity = new UserIdentity(this, String.format("%sUserIdentity", id));
+        UserIdentity userIdentity = new UserIdentity(this, String.format("%sUserIdentity", id){{#allowSignup}},
+          UserIdentityProps.builder()
+            .allowSignup(true)
+            .build(){{/allowSignup}});
         {{#typeSafeApis}}
         {{#cloudscapeReactTsWebsites.0}}{{{apiName}}} {{{apiNameLowercase}}} = {{/cloudscapeReactTsWebsites.0}}new {{{apiName}}}(this, "{{{apiName}}}", userIdentity);
         {{/typeSafeApis}}

diff --git a/...ges/infrastructure/samples/infrastructure/python/src/stacks/application_stack.py.mustache b/...ges/infrastructure/samples/infrastructure/python/src/stacks/application_stack.py.mustache
@@ -12,7 +12,7 @@ class ApplicationStack(Stack):
     def __init__(self, scope: Construct, id: str, **kwargs) -> None:
         super().__init__(scope, id, **kwargs)
 
-        user_identity = UserIdentity(self, '{}UserIdentity'.format(id))
+        user_identity = UserIdentity(self, '{}UserIdentity'.format(id){{#allowSignup}}, allow_signup=True{{/allowSignup}})
         {{#typeSafeApis}}
         {{#cloudscapeReactTsWebsites.0}}{{{apiNameLowercase}}} = {{/cloudscapeReactTsWebsites.0}}{{{apiName}}}(self, '{{{apiName}}}', user_identity)
         {{/typeSafeApis}}

diff --git a/...infrastructure/samples/infrastructure/typescript/src/stacks/application-stack.ts.mustache b/...infrastructure/samples/infrastructure/typescript/src/stacks/application-stack.ts.mustache
@@ -15,7 +15,9 @@ export class ApplicationStack extends Stack {
   constructor(scope: Construct, id: string, props?: StackProps) {
     super(scope, id, props);
 
-    const userIdentity = new UserIdentity(this, `${id}UserIdentity`);
+    const userIdentity = new UserIdentity(this, `${id}UserIdentity`{{#allowSignup}}, {
+      allowSignup: true,
+    }{{/allowSignup}});
     {{#typeSafeApis}}
     {{#cloudscapeReactTsWebsites.0}}const {{{apiNameLowercase}}} = {{/cloudscapeReactTsWebsites.0}}new {{{apiName}}}(this, "{{{apiName}}}", {
       userIdentity,

diff --git a/packages/infrastructure/src/projects/java/infrastructure-java-project.ts b/packages/infrastructure/src/projects/java/infrastructure-java-project.ts
@@ -23,6 +23,13 @@ export interface InfrastructureJavaProjectOptions extends AwsCdkJavaAppOptions {
    */
   readonly stackName?: string;
 
+  /**
+   * Allow self sign up for the UserIdentity construct.
+   *
+   * @default - false
+   */
+  readonly allowSignup?: boolean;
+
   /**
    * TypeSafeApi instance to use when setting up the initial project sample code.
    * @deprecated use typeSafeApis
@@ -149,6 +156,7 @@ export class InfrastructureJavaProject extends AwsCdkJavaApp {
 
     const mustacheConfig = {
       stackName: options.stackName || DEFAULT_STACK_NAME,
+      allowSignup: options.allowSignup ?? false,
       groupId,
       typeSafeApis: this.generateTypeSafeMustacheConfig(groupId, typeSafeApis),
       cloudscapeReactTsWebsites: cloudscapeReactTsWebsites.map((csWebsite) => {

diff --git a/packages/infrastructure/src/projects/python/infrastructure-py-project.ts b/packages/infrastructure/src/projects/python/infrastructure-py-project.ts
@@ -23,6 +23,13 @@ export interface InfrastructurePyProjectOptions extends AwsCdkPythonAppOptions {
    */
   readonly stackName?: string;
 
+  /**
+   * Allow self sign up for the UserIdentity construct.
+   *
+   * @default - false
+   */
+  readonly allowSignup?: boolean;
+
   /**
    * TypeSafeApi instance to use when setting up the initial project sample code.
    * @deprecated use typeSafeApis
@@ -128,6 +135,7 @@ export class InfrastructurePyProject extends AwsCdkPythonApp {
 
     const mustacheConfig = {
       stackName: options.stackName || DEFAULT_STACK_NAME,
+      allowSignup: options.allowSignup ?? false,
       moduleName,
       typeSafeApis: this.generateTypeSafeMustacheConfig(
         moduleName,

diff --git a/packages/infrastructure/src/projects/typescript/infrastructure-ts-project.ts b/packages/infrastructure/src/projects/typescript/infrastructure-ts-project.ts
@@ -28,6 +28,13 @@ export interface InfrastructureTsProjectOptions
    */
   readonly stackName?: string;
 
+  /**
+   * Allow self sign up for the UserIdentity construct.
+   *
+   * @default - false
+   */
+  readonly allowSignup?: boolean;
+
   /**
    * TypeSafeApi instance to use when setting up the initial project sample code.
    * @deprecated use typeSafeApis
@@ -135,6 +142,7 @@ export class InfrastructureTsProject extends AwsCdkTypeScriptApp {
 
     const mustacheConfig = {
       stackName: options.stackName || DEFAULT_STACK_NAME,
+      allowSignup: options.allowSignup ?? false,
       typeSafeApis: this.generateTypeSafeMustacheConfig(typeSafeApis),
       typeSafeWebSocketApis: this.generateTypeSafeMustacheConfig(
         typeSafeWebSocketApis