doc: improved description of the project

Author: sladg

.gitignore

@@ -5,5 +5,3 @@ dist/**
 
 # Temporary build folder.
 nodejs/**
-.next/**
-next.out/**

README.md

@@ -1,8 +1,11 @@
 # NextJS Lambda Utils
 
-This is a set of utils needed for deploying NextJS into AWS Lambda.
-It includes a wrapper for `next/server/image-optimizer` allowing to use S3.
-And includes CLI and custom server handler to integrate with ApiGw.
+This is a project allowing to deploy Next applications (standalone options turned on) to AWS Lambda without hassle.
+
+This is an alternative to existing Lambda@Edge implementation ([see](https://www.npmjs.com/package/@sls-next/lambda-at-edge)) as it has too many limitations (primarily inability to use env vars) and deployments take too long.
+
+This library uses Cloudfront, S3, ApiGateway and Lambdas to deploy easily in seconds (hotswap supported).
+
 
 - [NextJS Lambda Utils](#nextjs-lambda-utils)
   - [TL;DR](#tldr)
@@ -106,7 +109,7 @@ const sharpLayer = new LayerVersion(this, 'SharpDependenciesLayer', {
 
 To provide both image and server handlers with all depdencies (next is using `require.resolve` inside, so it cannot be bundled standalone for now).
 
-We pre-package this layer so it can be included in Lambda without hasle.
+We pre-package this layer so it can be included in Lambda without hassle.
 ```
 import { nextLayerZipPath } from '@sladg/nextjs-lambda'
 

lib/contruct.ts renamed to lib/construct.ts

@@ -6,6 +6,7 @@ import { Code, Function, LayerVersion, Runtime } from 'aws-cdk-lib/aws-lambda'
 import { Bucket, BucketAccessControl } from 'aws-cdk-lib/aws-s3'
 import { BucketDeployment, Source } from 'aws-cdk-lib/aws-s3-deployment'
 import { Construct } from 'constructs'
+import packageJson from '../package.json'
 
 import { imageHandlerZipPath, sharpLayerZipPath, nextLayerZipPath } from './consts'
 
@@ -38,14 +39,21 @@ export class NextStandaloneStack extends Stack {
 		})
 
 		const sharpLayer = new LayerVersion(this, 'SharpLayer', {
-			code: Code.fromAsset(props.sharpLayerZipPath ?? sharpLayerZipPath, { assetHash: 'static', assetHashType: AssetHashType.CUSTOM }),
+			code: Code.fromAsset(props.sharpLayerZipPath ?? sharpLayerZipPath, {
+				assetHash: `static-sharp-${packageJson.version}`,
+				assetHashType: AssetHashType.CUSTOM,
+			}),
 		})
 
 		const nextLayer = new LayerVersion(this, 'NextLayer', {
-			code: Code.fromAsset(props.nextLayerZipPath ?? nextLayerZipPath, { assetHash: 'static-next', assetHashType: AssetHashType.CUSTOM }),
+			code: Code.fromAsset(props.nextLayerZipPath ?? nextLayerZipPath, {
+				assetHash: `static-next-${packageJson.version}`,
+				assetHashType: AssetHashType.CUSTOM,
+			}),
 		})
 
 		const assetsBucket = new Bucket(this, 'NextAssetsBucket', {
+			// @NOTE: Considering not having public ACL.
 			publicReadAccess: true,
 			autoDeleteObjects: true,
 			removalPolicy: RemovalPolicy.DESTROY,
@@ -147,8 +155,8 @@ export class NextStandaloneStack extends Stack {
 			sources: [Source.asset(props.assetsZipPath)],
 			accessControl: BucketAccessControl.PUBLIC_READ,
 			// Invalidate all paths after deployment.
-			// distributionPaths: ['/*'],
-			// distribution: this.cfnDistro,
+			distributionPaths: ['/*'],
+			distribution: this.cfnDistro,
 		})
 
 		new CfnOutput(this, 'cfnDistroUrl', { value: this.cfnDistro.distributionDomainName })

lib/index.ts

@@ -1,4 +1,4 @@
-export { NextStandaloneStack } from './contruct'
+export { NextStandaloneStack } from './construct'
 export { imageHandlerZipPath, serverHandlerZipPath, sharpLayerZipPath } from './consts'
 
 export { handler as serverHandler } from './standalone/server-handler'