@aws-amplify/storage/src/internals/apis/list.ts

Storage category of aws-amplify

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

import {
	AmplifyContext,
	getGlobalContext,
	isAmplifyContext,
} from '@aws-amplify/core';

import { list as listInternal } from '../../providers/s3/apis/internal/list';
import { ListAllInput, ListInput, ListPaginateInput } from '../types/inputs';
import {
	ListAllWithPathOutput,
	ListPaginateWithPathOutput,
} from '../../providers/s3';
import { ListOutput } from '../types/outputs';

/**
 * @internal
 */
export function list(
	ctx: AmplifyContext,
	input: ListAllInput,
): Promise<ListAllWithPathOutput>;
/**
 * @internal
 */
export function list(
	ctx: AmplifyContext,
	input: ListPaginateInput,
): Promise<ListPaginateWithPathOutput>;
/**
 * @internal
 */
export function list(input: ListAllInput): Promise<ListAllWithPathOutput>;
/**
 * @internal
 */
export function list(
	input: ListPaginateInput,
): Promise<ListPaginateWithPathOutput>;
export function list(
	ctxOrInput: AmplifyContext | ListInput,
	maybeInput?: ListInput,
): Promise<ListOutput> {
	// Resolve the optional leading context. The global context is resolved at
	// CALL time (never cached) so single-arg callers follow live configuration.
	const [ctx, input]: [AmplifyContext, ListInput] = isAmplifyContext(ctxOrInput)
		? [ctxOrInput, maybeInput as ListInput]
		: [getGlobalContext(), ctxOrInput];

	return listInternal(ctx, {
		path: input.path,
		options: {
			bucket: input.options?.bucket,
			subpathStrategy: input.options?.subpathStrategy,
			useAccelerateEndpoint: input.options?.useAccelerateEndpoint,
			listAll: input.options?.listAll,
			expectedBucketOwner: input.options?.expectedBucketOwner,

			// Pagination options
			nextToken: (input as ListPaginateInput).options?.nextToken,
			pageSize: (input as ListPaginateInput).options?.pageSize,
			// Advanced options
			locationCredentialsProvider: input.options?.locationCredentialsProvider,
			customEndpoint: input?.options?.customEndpoint,
		},
		// Type casting is necessary because `listInternal` supports both Gen1 and Gen2 signatures, but here
		// given in input can only be Gen2 signature, the return can only ben Gen2 signature.
	} as ListInput) as Promise<ListOutput>;
}