Feat: Add pagination to Amplify Default Auth storage Browser

packages/aws-amplify/package.json

@@ -461,7 +461,7 @@
 			"name": "[Storage] copy (S3)",
 			"path": "./dist/esm/storage/index.mjs",
 			"import": "{ copy }",
-			"limit": "16.05 kB"
+			"limit": "16.08 kB"
 		},
 		{
 			"name": "[Storage] downloadData (S3)",
@@ -491,7 +491,7 @@
 			"name": "[Storage] remove (S3)",
 			"path": "./dist/esm/storage/index.mjs",
 			"import": "{ remove }",
-			"limit": "15.50 kB"
+			"limit": "15.52 kB"
 		},
 		{
 			"name": "[Storage] uploadData (S3)",

packages/core/src/parseAmplifyOutputs.ts

@@ -5,7 +5,6 @@
 /* eslint-disable camelcase */
 
 /* Does not like exhaustive checks */
-/* eslint-disable no-case-declarations */
 
 import {
 	APIConfig,
@@ -87,12 +86,14 @@ function parseAuth(
 		oauth,
 		username_attributes,
 		standard_required_attributes,
+		groups,
 	} = amplifyOutputsAuthProperties;
 
 	const authConfig = {
 		Cognito: {
 			userPoolId: user_pool_id,
 			userPoolClientId: user_pool_client_id,
+			groups,
 		},
 	} as AuthConfig;
 

packages/core/src/singleton/AmplifyOutputs/types.ts

@@ -13,7 +13,8 @@ export type AmplifyOutputsAuthMFAConfiguration =
 	| 'NONE';
 
 export type AmplifyOutputsAuthMFAMethod = 'SMS' | 'TOTP';
-
+type UserGroupName = string;
+type UserGroupPrecedence = Record<string, number>;
 export interface AmplifyOutputsAuthProperties {
 	aws_region: string;
 	authentication_flow_type?: 'USER_SRP_AUTH' | 'CUSTOM_AUTH';
@@ -41,6 +42,7 @@ export interface AmplifyOutputsAuthProperties {
 	unauthenticated_identities_enabled?: boolean;
 	mfa_configuration?: string;
 	mfa_methods?: string[];
+	groups?: Record<UserGroupName, UserGroupPrecedence>[];
 }
 
 export interface AmplifyOutputsStorageBucketProperties {

packages/core/src/singleton/Auth/types.ts

@@ -108,6 +108,9 @@ export type LegacyUserAttributeKey = Uppercase<AuthStandardAttributeKey>;
 
 export type AuthVerifiableAttributeKey = 'email' | 'phone_number';
 
+type UserGroupName = string;
+type UserGroupPrecedence = Record<string, number>;
+
 export type AuthConfigUserAttributes = Partial<
 	Record<AuthStandardAttributeKey, { required: boolean }>
 >;
@@ -130,6 +133,7 @@ export interface AuthIdentityPoolConfig {
 		userAttributes?: never;
 		mfa?: never;
 		passwordFormat?: never;
+		groups?: never;
 	};
 }
 
@@ -171,6 +175,7 @@ export interface CognitoUserPoolConfig {
 		requireNumbers?: boolean;
 		requireSpecialCharacters?: boolean;
 	};
+	groups?: Record<UserGroupName, UserGroupPrecedence>[];
 }
 
 export interface OAuthConfig {

packages/storage/__tests__/internals/amplifyAuthAdapter/createAmplifyAuthConfigAdapter.test.ts

@@ -33,12 +33,24 @@ const mockFetchAuthSession = fetchAuthSession as jest.Mock;
 const mockResolveLocationsFromCurrentSession =
 	resolveLocationsForCurrentSession as jest.Mock;
 
+const mockAuthConfig = {
+	Auth: {
+		Cognito: {
+			userPoolClientId: 'userPoolClientId',
+			userPoolId: 'userPoolId',
+			identityPoolId: 'identityPoolId',
+			groups: [{ admin: { precedence: 0 } }],
+		},
+	},
+};
+
 describe('createAmplifyAuthConfigAdapter', () => {
 	beforeEach(() => {
 		jest.clearAllMocks();
 	});
 
 	mockGetConfig.mockReturnValue({
+		...mockAuthConfig,
 		Storage: {
 			S3: {
 				bucket: 'bucket1',
@@ -70,7 +82,10 @@ describe('createAmplifyAuthConfigAdapter', () => {
 	});
 
 	it('should return empty locations when buckets are not defined', async () => {
-		mockGetConfig.mockReturnValue({ Storage: { S3: { buckets: undefined } } });
+		mockGetConfig.mockReturnValue({
+			...mockAuthConfig,
+			Storage: { S3: { buckets: undefined } },
+		});
 
 		const adapter = createAmplifyAuthConfigAdapter();
 		const result = await adapter.listLocations();
@@ -93,16 +108,15 @@ describe('createAmplifyAuthConfigAdapter', () => {
 		};
 
 		mockGetConfig.mockReturnValue({
+			...mockAuthConfig,
 			Storage: { S3: { buckets: mockBuckets } },
 		});
 		mockResolveLocationsFromCurrentSession.mockReturnValue([
 			{
 				type: 'PREFIX',
 				permission: ['read', 'write'],
-				scope: {
-					bucketName: 'bucket1',
-					path: '/path1',
-				},
+				bucket: 'bucket1',
+				prefix: '/path1',
 			},
 		]);
 
@@ -114,10 +128,8 @@ describe('createAmplifyAuthConfigAdapter', () => {
 				{
 					type: 'PREFIX',
 					permission: ['read', 'write'],
-					scope: {
-						bucketName: 'bucket1',
-						path: '/path1',
-					},
+					bucket: 'bucket1',
+					prefix: '/path1',
 				},
 			],
 		});

packages/storage/__tests__/internals/amplifyAuthAdapter/getHighestPrecedenceUserGroup.test.ts

@@ -0,0 +1,57 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	UserGroupConfig,
+	getHighestPrecedenceUserGroup,
+} from '../../../src/internals/amplifyAuthConfigAdapter/getHighestPrecedenceUserGroup';
+
+const userGroupsFromConfig: UserGroupConfig = [
+	{
+		editor: {
+			precedence: 0,
+		},
+	},
+	{
+		admin: {
+			precedence: 1,
+		},
+	},
+	{
+		auditor: {
+			precedence: 2,
+		},
+	},
+];
+const currentUserGroups = ['guest', 'user', 'admin'];
+
+describe('getHighestPrecedenceUserGroup', () => {
+	it('should return the user group with the highest precedence', () => {
+		const result = getHighestPrecedenceUserGroup(
+			userGroupsFromConfig,
+			currentUserGroups,
+		);
+		expect(result).toBe('admin');
+	});
+
+	it('should return undefined if userGroupsFromConfig is undefined', () => {
+		const result = getHighestPrecedenceUserGroup(undefined, currentUserGroups);
+		expect(result).toBeUndefined();
+	});
+
+	it('should return undefined if currentUserGroups is undefined', () => {
+		const result = getHighestPrecedenceUserGroup(
+			userGroupsFromConfig,
+			undefined,
+		);
+		expect(result).toBeUndefined();
+	});
+
+	it('should handle currentUserGroups containing groups not present in userGroupsFromConfig', () => {
+		const result = getHighestPrecedenceUserGroup(userGroupsFromConfig, [
+			'unknown',
+			'user',
+		]);
+		expect(result).toBe(undefined);
+	});
+});

packages/storage/__tests__/internals/amplifyAuthAdapter/getPaginatedLocations.test.ts

@@ -0,0 +1,90 @@
+import { getPaginatedLocations } from '../../../src/internals/amplifyAuthConfigAdapter/getPaginatedLocations';
+import { PathAccess } from '../../../src/internals/types/credentials';
+
+describe('getPaginatedLocations', () => {
+	const mockLocations: PathAccess[] = [
+		{
+			type: 'PREFIX',
+			permission: ['read'],
+			bucket: 'bucket1',
+			prefix: 'path1/',
+		},
+		{
+			type: 'PREFIX',
+			permission: ['write'],
+			bucket: 'bucket2',
+			prefix: 'path2/',
+		},
+		{
+			type: 'PREFIX',
+			permission: ['read', 'write'],
+			bucket: 'bucket3',
+			prefix: 'path3/',
+		},
+	];
+
+	it('should return all locations when no pagination is specified', () => {
+		const result = getPaginatedLocations({ locations: mockLocations });
+		expect(result).toEqual({ locations: mockLocations });
+	});
+
+	it('should return paginated locations when pageSize is specified', () => {
+		const result = getPaginatedLocations({
+			locations: mockLocations,
+			pageSize: 2,
+		});
+		expect(result).toEqual({
+			locations: mockLocations.slice(0, 2),
+			nextToken: '1',
+		});
+	});
+
+	it('should return paginated locations when pageSize and nextToken are specified', () => {
+		const result = getPaginatedLocations({
+			locations: mockLocations,
+			pageSize: 1,
+			nextToken: '2',
+		});
+		expect(result).toEqual({
+			locations: mockLocations.slice(1, 2),
+			nextToken: '1',
+		});
+	});
+
+	it('should return empty locations when locations array is empty', () => {
+		const result = getPaginatedLocations({ locations: [], pageSize: 2 });
+		expect(result).toEqual({ locations: [] });
+	});
+
+	it('should return empty location when nextToken is beyond array length', () => {
+		const result = getPaginatedLocations({
+			locations: mockLocations,
+			pageSize: 2,
+			nextToken: '5',
+		});
+		expect(result).toEqual({ locations: [], nextToken: undefined });
+	});
+
+	it('should return all remaining location when page size is greater than remaining locations length', () => {
+		const result = getPaginatedLocations({
+			locations: mockLocations,
+			pageSize: 5,
+			nextToken: '2',
+		});
+		expect(result).toEqual({
+			locations: mockLocations.slice(-2),
+			nextToken: undefined,
+		});
+	});
+
+	it('should return undefined nextToken when end of array is reached', () => {
+		const result = getPaginatedLocations({
+			locations: mockLocations,
+			pageSize: 5,
+		});
+		expect(result).toEqual({
+			locations: mockLocations.slice(0, 3),
+			nextToken: undefined,
+		});
+	});
+});

packages/storage/__tests__/internals/amplifyAuthAdapter/resolveLocationsForCurrentSession.test.ts

@@ -37,7 +37,6 @@ describe('resolveLocationsForCurrentSession', () => {
 			buckets: mockBuckets,
 			isAuthenticated: true,
 			identityId: '12345',
-			userGroup: 'admin',
 		});
 
 		expect(result).toEqual([
@@ -47,12 +46,6 @@ describe('resolveLocationsForCurrentSession', () => {
 				bucket: 'bucket1',
 				prefix: 'path1/*',
 			},
-			{
-				type: 'PREFIX',
-				permission: ['get', 'list', 'write', 'delete'],
-				bucket: 'bucket1',
-				prefix: 'path2/*',
-			},
 			{
 				type: 'PREFIX',
 				permission: ['get', 'list', 'write', 'delete'],
@@ -62,30 +55,35 @@ describe('resolveLocationsForCurrentSession', () => {
 		]);
 	});
 
-	it('should generate locations correctly when tokens are true & bad userGroup', () => {
+	it('should generate locations correctly when tokens are true & userGroup', () => {
 		const result = resolveLocationsForCurrentSession({
 			buckets: mockBuckets,
 			isAuthenticated: true,
 			identityId: '12345',
-			userGroup: 'editor',
+			userGroup: 'admin',
 		});
 
 		expect(result).toEqual([
-			{
-				type: 'PREFIX',
-				permission: ['get', 'list', 'write'],
-				bucket: 'bucket1',
-				prefix: 'path1/*',
-			},
 			{
 				type: 'PREFIX',
 				permission: ['get', 'list', 'write', 'delete'],
 				bucket: 'bucket1',
-				prefix: 'profile-pictures/12345/*',
+				prefix: 'path2/*',
 			},
 		]);
 	});
 
+	it('should return empty locations when tokens are true & bad userGroup', () => {
+		const result = resolveLocationsForCurrentSession({
+			buckets: mockBuckets,
+			isAuthenticated: true,
+			identityId: '12345',
+			userGroup: 'editor',
+		});
+
+		expect(result).toEqual([]);
+	});
+
 	it('should continue to next bucket when paths are not defined', () => {
 		const result = resolveLocationsForCurrentSession({
 			buckets: {
@@ -107,7 +105,6 @@ describe('resolveLocationsForCurrentSession', () => {
 			},
 			isAuthenticated: true,
 			identityId: '12345',
-			userGroup: 'admin',
 		});
 
 		expect(result).toEqual([