📝 docs: README to reflect new features and breaking changes

Author: aryasaatvik

packages/construct/README.md

@@ -18,8 +18,8 @@ The Turborepo Remote Cache API allows teams to share and reuse build artifacts a
 ## Features
 
 - :zap: High-performance S3 integration for artifact storage
-- :lock: Secure authentication using bearer token
-- :chart_with_upwards_trend: Scalable architecture using serverless AWS services
+- :lock: Flexible authentication with custom authorizer support
+- :key: Pre-signed URL support for direct S3 access
 - :globe_with_meridians: Optional custom domain support
 - :gear: Easy integration with existing CDK stacks
 - :moneybag: Cost-effective usage-based pricing model
@@ -51,6 +51,7 @@ import * as cdk from 'aws-cdk-lib';
 import { Construct } from 'constructs';
 import { TurboRemoteCache } from 'turbo-remote-cache-construct';
 import * as acm from 'aws-cdk-lib/aws-certificatemanager';
+import * as lambda from 'aws-cdk-lib/aws-lambda';
 import * as apigateway from 'aws-cdk-lib/aws-apigateway';
 
 export class TurboRemoteCacheStack extends cdk.Stack {
@@ -91,7 +92,28 @@ export class TurboRemoteCacheStack extends cdk.Stack {
 }
 ```
 
-The S3 bucket, DynamoDB table, and API Gateway can be configured using the optional props. The defaults are are provided in the jsdoc comments and can be viewed in the [source code](/packages/construct/src/index.ts). The example above uses apiProps to configure a custom domain name for the API Gateway. It also uses artifactsBucketProps to customize the bucketName and removalPolicy to retain the bucket when the stack is deleted. Similar options are available for the DynamoDB table.
+The S3 bucket, DynamoDB table, and API Gateway can be configured using the optional props. The defaults are are provided in the jsdoc 
+comments and can be viewed in the [source code](/packages/construct/src/index.ts). The example above uses apiProps to configure a custom 
+domain name for the API Gateway. It also uses artifactsBucketProps to customize the bucketName and removalPolicy to retain the bucket when 
+the stack is deleted. Similar options are available for the DynamoDB table.
+
+## Breaking Changes in 2.0
+
+### Authentication
+- Deprecated simple token-based authentication (`turboToken`)
+- Added support for custom authorizers via `authorizerFunction`
+- Authorizer must provide `teamId` in the context
+
+### Team Identification
+- Removed support for `teamSlug` in favor of `teamId`
+- All artifact paths now use `teamId` instead of `slug`
+- API endpoints expect `teamId` query parameter
+
+### New Features
+- Added preflight/presigned URL support for S3 operations
+- Added CORS support for S3 bucket
+- Added custom user info endpoint support
+- Support for direct S3 access using presigned URLs
 
 ## Architecture
 
@@ -101,7 +123,7 @@ The construct uses API Gateway, Lambda, S3 integration, and DynamoDB to create a
 
 - **API Gateway**: Used to create a REST API that will be used to interact with the Remote Cache.
 - **Lambda**: Used to handle the API requests and responses for non-artifact related endpoints.
-- **S3 Integration**: Allows API Gateway to integrate with S3 without a Lambda function which allows for a larger payload size and lower latency.
+- **S3 Integration**: Allows API Gateway to integrate with S3 without a Lambda function which allows for a larger payload size and lower latency. Supports presigned URLs for direct S3 access using preflight requests.
 - **S3**: Used to store the Remote Cache artifacts.
 - **DynamoDB**: Used to store the Remote Cache events.
 

packages/construct/src/index.ts

@@ -10,11 +10,37 @@ import * as apigateway from 'aws-cdk-lib/aws-apigateway';
 export interface TurboRemoteCacheProps {
   /**
    * Turbo Token
-   * used to authenticate requests to the API
+   * @deprecated Use authorizerFunction instead for authentication
+   * Used only if custom authorizer is not provided
    * @example generate a random string using `openssl rand -base64 32`
-   * required if custom authorizer (apiProps.defaultMethodOptions.authorizer) is not provided
    */
   turboToken?: string;
+
+  /**
+   * Custom authorizer lambda function for API authentication
+   * This function should return the teamId in the authorizer context
+   * Replaces the deprecated turboToken authentication
+   * @example
+   * ```typescript
+   * new TurboRemoteCache(this, 'Cache', {
+   *   authorizerFunction: myCustomAuthorizer,
+   * });
+   * ```
+   */
+  authorizerFunction?: lambda.Function;
+
+  /**
+   * Custom user info lambda function
+   * Implements the /v2/user endpoint for retrieving authenticated user information
+   * @example
+   * ```typescript
+   * new TurboRemoteCache(this, 'Cache', {
+   *   userInfoFunction: myUserInfoFunction,
+   * });
+   * ```
+   */
+  userInfoFunction?: lambda.Function;
+
   /**
    * API Gateway props
    * @default
@@ -31,19 +57,23 @@ export interface TurboRemoteCacheProps {
    *  },
    *  binaryMediaTypes: ['application/octet-stream'],
    */
-  apiProps?: Partial<apigateway.RestApiProps>,
+  apiProps?: Partial<apigateway.RestApiProps>;
+
   /**
    * S3 bucket props for the artifacts bucket
    * @default
    *  bucketName: 'turbo-remote-cache-artifacts',
-   *  lifecycleRules: [
-   *    {
-   *      expiration: cdk.Duration.days(30),
-   *    },
-   *  ],
+   *  lifecycleRules: [{ expiration: cdk.Duration.days(30) }],
+   *  cors: [{
+   *    allowedHeaders: ['*'],
+   *    allowedMethods: [s3.HttpMethods.GET, s3.HttpMethods.PUT, s3.HttpMethods.HEAD],
+   *    allowedOrigins: ['*'],
+   *    exposedHeaders: ['User-Agent', 'Content-Type', 'Content-Length', 'x-artifact-duration', 'x-artifact-tag'],
+   *  }],
    *  removalPolicy: cdk.RemovalPolicy.DESTROY,
    */
-  artifactsBucketProps?: Partial<s3.BucketProps>,
+  artifactsBucketProps?: Partial<s3.BucketProps>;
+
   /**
    * DynamoDB table props for the events table
    * @default
@@ -54,19 +84,12 @@ export interface TurboRemoteCacheProps {
    *  timeToLiveAttribute: 'ttl',
    *  removalPolicy: cdk.RemovalPolicy.DESTROY,
    */
-  eventsTableProps?: Partial<dynamodb.TableProps>
-  /**
-   * common lambda function props for all lambda functions
-   */
-  lambdaProps?: Partial<lambda.FunctionProps>
-  /**
-   * custom authorizer lambda function
-   */
-  authorizerFunction?: lambda.Function
+  eventsTableProps?: Partial<dynamodb.TableProps>;
+
   /**
-   * custom user info lambda function
+   * Common lambda function props for all lambda functions
    */
-  userInfoFunction?: lambda.Function
+  lambdaProps?: Partial<lambda.FunctionProps>;
 }
 
 export class TurboRemoteCache extends Construct {