@fy-stack/auth-construct 0.0.124 → 0.0.126

package/README.md

@@ -1,7 +1,22 @@
-# auth-construct
 
-This library was generated with [Nx](https://nx.dev).
+# Auth Construct Documentation
 
-## Building
+## `AuthConstruct`
 
-Run `nx build auth-construct` to build the library.
+The `AuthConstruct` class is a custom AWS CDK construct that sets up authentication infrastructure using Amazon Cognito. It creates a user pool, a user pool domain, and a user pool client with configurable authentication flows and token validity. Additionally, it can create user groups within the user pool. This construct implements the `Attachable` and `Grantable` interfaces.
+
+- **Properties**
+    - `userPool: cognito.UserPool`
+        - The Cognito user pool created by this construct.
+    - `domain: cognito.UserPoolDomain`
+        - The domain associated with the user pool.
+    - `client: cognito.UserPoolClient`
+        - The client application for the user pool.
+
+- **Constructor**
+    - `constructor(scope: Construct, id: string, props: AuthConstructProps)`
+        - Initializes the authentication construct with a unique identifier and configuration options defined by `AuthConstructProps`.
+        - **Parameters**
+            - `scope`: The scope in which this construct is defined.
+            - `id`: The unique identifier for this construct.
+            - `props`: Properties required to set up the authentication construct.

package/dist/lib/auth-construct.d.ts

@@ -3,15 +3,22 @@ import * as cognito from 'aws-cdk-lib/aws-cognito';
 import * as iam from 'aws-cdk-lib/aws-iam';
 import { Construct } from 'constructs';
 import { AuthConstructProps } from './types';
+/**
+ * AuthConstruct is a construct that sets up an authentication infrastructure
+ * using Amazon Cognito. It creates a user pool, a domain for the user pool,
+ * and a client for the user pool with configurable authentication flows and
+ * token validity. Additionally, it can create user groups within the user pool.
+ *
+ * It extends the Construct class and implements the {@link Attachable `Attachable`} and {@link Grantable `Grantable`} interfaces.
+ */
 export declare class AuthConstruct extends Construct implements Attachable, Grantable {
     userPool: cognito.UserPool;
-    domain: cognito.UserPoolDomain;
+    domain?: cognito.UserPoolDomain;
     client: cognito.UserPoolClient;
     constructor(scope: Construct, id: string, props: AuthConstructProps);
     attachable(): {
         arn: string;
         id: string;
-        domainName: string;
         clientId: string;
         clientSecret: string;
     };

package/dist/lib/auth-construct.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth-construct.d.ts","sourceRoot":"","sources":["../../src/lib/auth-construct.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C,qBAAa,aAAc,SAAQ,SAAU,YAAW,UAAU,EAAE,SAAS;IACpE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC;IAC3B,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC;IAC/B,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC;gBAE1B,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB;IAyCnE,UAAU;;;;;;;IAUV,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,UAAU;CAOhC"}
+{"version":3,"file":"auth-construct.d.ts","sourceRoot":"","sources":["../../src/lib/auth-construct.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAE7C;;;;;;;GAOG;AACH,qBAAa,aAAc,SAAQ,SAAU,YAAW,UAAU,EAAE,SAAS;IACpE,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAChC,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC;gBAE1B,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB;IA2CnE,UAAU;;;;;;IAeV,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,UAAU;CAGhC"}

package/dist/lib/auth-construct.js

@@ -4,8 +4,15 @@ exports.AuthConstruct = void 0;
 const tslib_1 = require("tslib");
 const aws_cdk_lib_1 = require("aws-cdk-lib");
 const cognito = tslib_1.__importStar(require("aws-cdk-lib/aws-cognito"));
-const iam = tslib_1.__importStar(require("aws-cdk-lib/aws-iam"));
 const constructs_1 = require("constructs");
+/**
+ * AuthConstruct is a construct that sets up an authentication infrastructure
+ * using Amazon Cognito. It creates a user pool, a domain for the user pool,
+ * and a client for the user pool with configurable authentication flows and
+ * token validity. Additionally, it can create user groups within the user pool.
+ *
+ * It extends the Construct class and implements the {@link Attachable `Attachable`} and {@link Grantable `Grantable`} interfaces.
+ */
 class AuthConstruct extends constructs_1.Construct {
     userPool;
     domain;
@@ -17,10 +24,12 @@ class AuthConstruct extends constructs_1.Construct {
             selfSignUpEnabled: true,
             signInCaseSensitive: false,
         });
-        this.domain = new cognito.UserPoolDomain(this, 'UserPoolDomain', {
-            userPool: this.userPool,
-            cognitoDomain: { domainPrefix: id.toLowerCase() },
-        });
+        if (props.domainPrefix) {
+            this.domain = new cognito.UserPoolDomain(this, 'UserPoolDomain', {
+                userPool: this.userPool,
+                cognitoDomain: { domainPrefix: props.domainPrefix },
+            });
+        }
         this.client = new cognito.UserPoolClient(this, 'WebClient', {
             userPool: this.userPool,
             authFlows: {
@@ -43,20 +52,19 @@ class AuthConstruct extends constructs_1.Construct {
         }
     }
     attachable() {
-        return {
+        const params = {
             arn: this?.userPool.userPoolArn,
             id: this?.userPool.userPoolId,
-            domainName: this.domain.domainName,
             clientId: this?.client.userPoolClientId,
             clientSecret: this?.client.userPoolClientSecret.unsafeUnwrap(),
         };
+        if (this.domain) {
+            Object.assign(params, { domainName: this.domain.domainName, });
+        }
+        return params;
     }
     grantable(grant) {
-        grant.grantPrincipal.addToPrincipalPolicy(new iam.PolicyStatement({
-            effect: iam.Effect.ALLOW,
-            actions: ['cognito-idp:*', 'cognito-identity:*'],
-            resources: [this.userPool.userPoolArn],
-        }));
+        this.userPool.grant(grant, 'cognito-idp:*', 'cognito-identity:*');
     }
 }
 exports.AuthConstruct = AuthConstruct;

package/dist/lib/types.d.ts

@@ -10,5 +10,7 @@ export interface AuthConstructProps {
         /** Refresh token validity in hours */
         refreshTokenValidity?: number;
     };
+    /** Domain name prefix */
+    domainPrefix?: string;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;SAEK;IACL,KAAK,CAAC,EAAE;QACN,qCAAqC;QACrC,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,sCAAsC;QACtC,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B,CAAC;CACH"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;SAEK;IACL,KAAK,CAAC,EAAE;QACN,qCAAqC;QACrC,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,sCAAsC;QACtC,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B,CAAC;IACF,yBAAyB;IACzB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@fy-stack/auth-construct",
-  "version": "0.0.124",
+  "version": "0.0.126",
   "dependencies": {
-    "@fy-stack/types": "0.0.124",
+    "@fy-stack/types": "0.0.126",
     "tslib": "^2.3.0"
   },
   "peerDependencies": {
-    "aws-cdk-lib": "2.164.1",
+    "aws-cdk-lib": "2.166.0",
     "constructs": "10.4.2"
   },
   "main": "./dist/index.js",