@aws-amplify/api-rest 4.0.17-unstable.e316a2e.0 → 4.0.17

package/package.json

@@ -1,102 +1,103 @@
 {
-  "name": "@aws-amplify/api-rest",
-  "private": false,
-  "version": "4.0.17-unstable.e316a2e.0+e316a2e",
-  "description": "Api-rest category of aws-amplify",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.mjs",
-  "typings": "./dist/esm/index.d.ts",
-  "react-native": "./src/index.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "test": "npm run lint && jest -w 1 --coverage --logHeapUsage",
-    "test:watch": "tslint 'src/**/*.ts' && jest -w 1 --watch",
-    "build-with-test": "npm test && npm build",
-    "build:umd": "webpack && webpack --config ./webpack.config.dev.js",
-    "build:esm-cjs": "rollup -c rollup.config.mjs",
-    "build:watch": "npm run build:esm-cjs -- --watch",
-    "build": "npm run clean && npm run build:esm-cjs && npm run build:umd",
-    "clean": "npm run clean:size && rimraf dist lib lib-esm",
-    "clean:size": "rimraf dual-publish-tmp tmp*",
-    "format": "echo \"Not implemented\"",
-    "lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
-    "ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 70.0"
-  },
-  "exports": {
-    ".": {
-      "types": "./dist/esm/index.d.ts",
-      "import": "./dist/esm/index.mjs",
-      "require": "./dist/cjs/index.js",
-      "react-native": "./src/index.ts"
-    },
-    "./server": {
-      "types": "./dist/esm/server.d.ts",
-      "import": "./dist/esm/server.mjs",
-      "require": "./dist/cjs/server.js"
-    },
-    "./internals": {
-      "types": "./dist/esm/internals/index.d.ts",
-      "import": "./dist/esm/internals/index.mjs",
-      "require": "./dist/cjs/internals/index.js",
-      "react-native": "./src/internals/index.ts"
-    },
-    "./internals/server": {
-      "types": "./dist/esm/internals/server.d.ts",
-      "import": "./dist/esm/internals/server.mjs",
-      "require": "./dist/cjs/internals/server.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "typesVersions": {
-    ">=4.2": {
-      "server": [
-        "./dist/esm/server.d.ts"
-      ],
-      "internals": [
-        "./dist/esm/internals/index.d.ts"
-      ],
-      "internals/server": [
-        "./dist/esm/internals/server.d.ts"
-      ]
-    }
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/aws-amplify/amplify-js.git"
-  },
-  "author": "Amazon Web Services",
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/aws/aws-amplify/issues"
-  },
-  "homepage": "https://aws-amplify.github.io/",
-  "files": [
-    "dist/cjs",
-    "dist/esm",
-    "src",
-    "internals",
-    "server"
-  ],
-  "dependencies": {
-    "tslib": "^2.5.0"
-  },
-  "peerDependencies": {
-    "@aws-amplify/core": "6.0.17-unstable.e316a2e.0+e316a2e"
-  },
-  "devDependencies": {
-    "@aws-amplify/core": "6.0.17-unstable.e316a2e.0+e316a2e",
-    "@aws-amplify/react-native": "1.0.17-unstable.e316a2e.0+e316a2e",
-    "typescript": "5.0.2"
-  },
-  "size-limit": [
-    {
-      "name": "API (rest client)",
-      "path": "./dist/esm/index.mjs",
-      "import": "{ Amplify, RestAPI }",
-      "limit": "31.5 kB"
-    }
-  ],
-  "gitHead": "e316a2eb6129a30a16008892e7cdc17aefd914f9"
+	"name": "@aws-amplify/api-rest",
+	"private": false,
+	"version": "4.0.17",
+	"description": "Api-rest category of aws-amplify",
+	"main": "./dist/cjs/index.js",
+	"module": "./dist/esm/index.mjs",
+	"typings": "./dist/esm/index.d.ts",
+	"react-native": "./src/index.ts",
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"test": "npm run lint && jest -w 1 --coverage --logHeapUsage",
+		"test:watch": "tslint 'src/**/*.ts' && jest -w 1 --watch",
+		"build-with-test": "npm test && npm build",
+		"build:umd": "webpack && webpack --config ./webpack.config.dev.js",
+		"build:esm-cjs": "rollup -c rollup.config.mjs",
+		"build:watch": "npm run build:esm-cjs -- --watch",
+		"build": "npm run clean && npm run build:esm-cjs && npm run build:umd",
+		"clean": "npm run clean:size && rimraf dist lib lib-esm",
+		"clean:size": "rimraf dual-publish-tmp tmp*",
+		"format": "echo \"Not implemented\"",
+		"lint": "eslint '**/*.{ts,tsx}' && npm run ts-coverage",
+		"lint:fix": "eslint '**/*.{ts,tsx}' --fix",
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 70.0"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/esm/index.d.ts",
+			"import": "./dist/esm/index.mjs",
+			"require": "./dist/cjs/index.js",
+			"react-native": "./src/index.ts"
+		},
+		"./server": {
+			"types": "./dist/esm/server.d.ts",
+			"import": "./dist/esm/server.mjs",
+			"require": "./dist/cjs/server.js"
+		},
+		"./internals": {
+			"types": "./dist/esm/internals/index.d.ts",
+			"import": "./dist/esm/internals/index.mjs",
+			"require": "./dist/cjs/internals/index.js",
+			"react-native": "./src/internals/index.ts"
+		},
+		"./internals/server": {
+			"types": "./dist/esm/internals/server.d.ts",
+			"import": "./dist/esm/internals/server.mjs",
+			"require": "./dist/cjs/internals/server.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"typesVersions": {
+		">=4.2": {
+			"server": [
+				"./dist/esm/server.d.ts"
+			],
+			"internals": [
+				"./dist/esm/internals/index.d.ts"
+			],
+			"internals/server": [
+				"./dist/esm/internals/server.d.ts"
+			]
+		}
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/aws-amplify/amplify-js.git"
+	},
+	"author": "Amazon Web Services",
+	"license": "Apache-2.0",
+	"bugs": {
+		"url": "https://github.com/aws/aws-amplify/issues"
+	},
+	"homepage": "https://aws-amplify.github.io/",
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"src",
+		"internals",
+		"server"
+	],
+	"dependencies": {
+		"tslib": "^2.5.0"
+	},
+	"peerDependencies": {
+		"@aws-amplify/core": "^6.0.0"
+	},
+	"devDependencies": {
+		"@aws-amplify/core": "6.0.17",
+		"@aws-amplify/react-native": "1.0.17",
+		"typescript": "5.0.2"
+	},
+	"size-limit": [
+		{
+			"name": "API (rest client)",
+			"path": "./dist/esm/index.mjs",
+			"import": "{ Amplify, RestAPI }",
+			"limit": "31.5 kB"
+		}
+	],
+	"gitHead": "c54a19c8a654a47d559cb0fd41c74bd2c3eb79ca"
 }

package/src/apis/common/handler.ts

@@ -2,12 +2,12 @@
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyClassV6 } from '@aws-amplify/core';
 import {
-	HttpRequest,
-	unauthenticatedHandler,
 	Headers,
+	HttpRequest,
+	authenticatedHandler,
 	getRetryDecider,
 	jitteredBackoff,
-	authenticatedHandler,
+	unauthenticatedHandler,
 } from '@aws-amplify/core/internals/aws-client-utils';
 import {
 	AWSCredentials,
@@ -28,10 +28,10 @@ type HandlerOptions = Omit<HttpRequest, 'body' | 'headers'> & {
 	withCredentials?: boolean;
 };
 
-type SigningServiceInfo = {
+interface SigningServiceInfo {
 	service?: string;
 	region?: string;
-};
+}
 
 /**
  * Make REST API call with best-effort IAM auth.
@@ -46,7 +46,7 @@ type SigningServiceInfo = {
 export const transferHandler = async (
 	amplify: AmplifyClassV6,
 	options: HandlerOptions & { abortSignal: AbortSignal },
-	signingServiceInfo?: SigningServiceInfo
+	signingServiceInfo?: SigningServiceInfo,
 ): Promise<RestApiResponse> => {
 	const { url, method, headers, body, withCredentials, abortSignal } = options;
 	const resolvedBody = body
@@ -88,6 +88,7 @@ export const transferHandler = async (
 			...baseOptions,
 		});
 	}
+
 	// Clean-up un-modeled properties from response.
 	return {
 		statusCode: response.statusCode,
@@ -98,11 +99,11 @@ export const transferHandler = async (
 
 const iamAuthApplicable = (
 	{ headers }: HttpRequest,
-	signingServiceInfo?: SigningServiceInfo
+	signingServiceInfo?: SigningServiceInfo,
 ) => !headers.authorization && !headers['x-api-key'] && !!signingServiceInfo;
 
 const resolveCredentials = async (
-	amplify: AmplifyClassV6
+	amplify: AmplifyClassV6,
 ): Promise<AWSCredentials | null> => {
 	try {
 		const { credentials } = await amplify.Auth.fetchAuthSession();
@@ -112,5 +113,6 @@ const resolveCredentials = async (
 	} catch (e) {
 		logger.debug('No credentials available, the request will be unsigned.');
 	}
+
 	return null;
 };

package/src/apis/common/internalPost.ts

@@ -4,9 +4,10 @@
 import { AmplifyClassV6 } from '@aws-amplify/core';
 
 import { InternalPostInput, RestApiResponse } from '../../types';
-import { transferHandler } from './handler';
 import { createCancellableOperation } from '../../utils';
 
+import { transferHandler } from './handler';
+
 /**
  * This weak map provides functionality to cancel a request given the promise containing the `post` request.
  *
@@ -25,7 +26,7 @@ const cancelTokenMap = new WeakMap<Promise<any>, AbortController>();
  */
 export const post = (
 	amplify: AmplifyClassV6,
-	{ url, options, abortController }: InternalPostInput
+	{ url, options, abortController }: InternalPostInput,
 ): Promise<RestApiResponse> => {
 	const controller = abortController ?? new AbortController();
 	const responsePromise = createCancellableOperation(async () => {
@@ -37,14 +38,16 @@ export const post = (
 				...options,
 				abortSignal: controller.signal,
 			},
-			options?.signingServiceInfo
+			options?.signingServiceInfo,
 		);
+
 		return response;
 	}, controller);
 
 	const responseWithCleanUp = responsePromise.finally(() => {
 		cancelTokenMap.delete(responseWithCleanUp);
 	});
+
 	return responseWithCleanUp;
 };
 
@@ -55,7 +58,7 @@ export const post = (
  */
 export const cancel = (
 	promise: Promise<RestApiResponse>,
-	message?: string
+	message?: string,
 ): boolean => {
 	const controller = cancelTokenMap.get(promise);
 	if (controller) {
@@ -63,10 +66,12 @@ export const cancel = (
 		if (message && controller.signal.reason !== message) {
 			// In runtimes where `AbortSignal.reason` is not supported, we track the reason ourselves.
 			// @ts-expect-error reason is read-only property.
-			controller.signal['reason'] = message;
+			controller.signal.reason = message;
 		}
+
 		return true;
 	}
+
 	return false;
 };
 
@@ -75,7 +80,7 @@ export const cancel = (
  */
 export const updateRequestToBeCancellable = (
 	promise: Promise<any>,
-	controller: AbortController
+	controller: AbortController,
 ) => {
 	cancelTokenMap.set(promise, controller);
 };

package/src/apis/common/publicApis.ts

@@ -2,34 +2,36 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { AmplifyClassV6 } from '@aws-amplify/core';
+
 import {
-	GetInput,
-	GetOperation,
-	PostInput,
-	PostOperation,
-	PutInput,
-	PutOperation,
+	ApiInput,
 	DeleteInput,
 	DeleteOperation,
+	GetInput,
+	GetOperation,
 	HeadInput,
 	HeadOperation,
 	PatchInput,
 	PatchOperation,
-	ApiInput,
+	PostInput,
+	PostOperation,
+	PutInput,
+	PutOperation,
 	RestApiOptionsBase,
 } from '../../types';
 import {
-	resolveApiUrl,
 	createCancellableOperation,
 	logger,
 	parseSigningInfo,
+	resolveApiUrl,
 } from '../../utils';
+
 import { transferHandler } from './handler';
 
 const publicHandler = (
 	amplify: AmplifyClassV6,
 	options: ApiInput<RestApiOptionsBase>,
-	method: string
+	method: string,
 ) =>
 	createCancellableOperation(async abortSignal => {
 		const { apiName, options: apiOptions = {}, path: apiPath } = options;
@@ -37,7 +39,7 @@ const publicHandler = (
 			amplify,
 			apiName,
 			apiPath,
-			apiOptions?.queryParams
+			apiOptions?.queryParams,
 		);
 		const libraryConfigHeaders =
 			await amplify.libraryOptions?.API?.REST?.headers?.({
@@ -57,8 +59,9 @@ const publicHandler = (
 			method,
 			url,
 			headers,
-			`IAM signing options: ${JSON.stringify(signingServiceInfo)}`
+			`IAM signing options: ${JSON.stringify(signingServiceInfo)}`,
 		);
+
 		return transferHandler(
 			amplify,
 			{
@@ -68,7 +71,7 @@ const publicHandler = (
 				headers,
 				abortSignal,
 			},
-			signingServiceInfo
+			signingServiceInfo,
 		);
 	});
 
@@ -77,7 +80,7 @@ export const get = (amplify: AmplifyClassV6, input: GetInput): GetOperation =>
 
 export const post = (
 	amplify: AmplifyClassV6,
-	input: PostInput
+	input: PostInput,
 ): PostOperation => publicHandler(amplify, input, 'POST');
 
 export const put = (amplify: AmplifyClassV6, input: PutInput): PutOperation =>
@@ -85,15 +88,15 @@ export const put = (amplify: AmplifyClassV6, input: PutInput): PutOperation =>
 
 export const del = (
 	amplify: AmplifyClassV6,
-	input: DeleteInput
+	input: DeleteInput,
 ): DeleteOperation => publicHandler(amplify, input, 'DELETE');
 
 export const head = (
 	amplify: AmplifyClassV6,
-	input: HeadInput
+	input: HeadInput,
 ): HeadOperation => publicHandler(amplify, input, 'HEAD');
 
 export const patch = (
 	amplify: AmplifyClassV6,
-	input: PatchInput
+	input: PatchInput,
 ): PatchOperation => publicHandler(amplify, input, 'PATCH');

package/src/apis/index.ts

@@ -2,14 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Amplify } from '@aws-amplify/core';
-import {
-	get as commonGet,
-	post as commonPost,
-	put as commonPut,
-	del as commonDel,
-	head as commonHead,
-	patch as commonPatch,
-} from './common/publicApis';
+
 import {
 	DeleteInput,
 	DeleteOperation,
@@ -26,6 +19,15 @@ import {
 } from '../types';
 import { RestApiError } from '../errors';
 
+import {
+	del as commonDel,
+	get as commonGet,
+	head as commonHead,
+	patch as commonPatch,
+	post as commonPost,
+	put as commonPut,
+} from './common/publicApis';
+
 /**
  * GET HTTP request
  * @param {GetInput} input - Input for GET operation

package/src/apis/server.ts

@@ -5,14 +5,7 @@ import {
 	AmplifyServer,
 	getAmplifyServerContext,
 } from '@aws-amplify/core/internals/adapter-core';
-import {
-	get as commonGet,
-	post as commonPost,
-	put as commonPut,
-	del as commonDel,
-	head as commonHead,
-	patch as commonPatch,
-} from './common/publicApis';
+
 import {
 	DeleteInput,
 	DeleteOperation,
@@ -29,6 +22,15 @@ import {
 } from '../types';
 import { RestApiError } from '../errors';
 
+import {
+	del as commonDel,
+	get as commonGet,
+	head as commonHead,
+	patch as commonPatch,
+	post as commonPost,
+	put as commonPut,
+} from './common/publicApis';
+
 /**
  * GET HTTP request (server-side)
  * @param {AmplifyServer.ContextSpec} contextSpec - The context spec used to get the Amplify server context.
@@ -52,11 +54,10 @@ import { RestApiError } from '../errors';
  *   },
  * });
  * ```
- * @see {@link clientGet}
  */
 export const get = (
 	contextSpec: AmplifyServer.ContextSpec,
-	input: GetInput
+	input: GetInput,
 ): GetOperation =>
 	commonGet(getAmplifyServerContext(contextSpec).amplify, input);
 
@@ -86,7 +87,7 @@ export const get = (
  */
 export const post = (
 	contextSpec: AmplifyServer.ContextSpec,
-	input: PostInput
+	input: PostInput,
 ): PostOperation =>
 	commonPost(getAmplifyServerContext(contextSpec).amplify, input);
 
@@ -116,7 +117,7 @@ export const post = (
  */
 export const put = (
 	contextSpec: AmplifyServer.ContextSpec,
-	input: PutInput
+	input: PutInput,
 ): PutOperation =>
 	commonPut(getAmplifyServerContext(contextSpec).amplify, input);
 
@@ -145,7 +146,7 @@ export const put = (
  */
 export const del = (
 	contextSpec: AmplifyServer.ContextSpec,
-	input: DeleteInput
+	input: DeleteInput,
 ): DeleteOperation =>
 	commonDel(getAmplifyServerContext(contextSpec).amplify, input);
 
@@ -174,7 +175,7 @@ export const del = (
  */
 export const head = (
 	contextSpec: AmplifyServer.ContextSpec,
-	input: HeadInput
+	input: HeadInput,
 ): HeadOperation =>
 	commonHead(getAmplifyServerContext(contextSpec).amplify, input);
 
@@ -204,6 +205,6 @@ export const head = (
  */
 export const patch = (
 	contextSpec: AmplifyServer.ContextSpec,
-	input: PatchInput
+	input: PatchInput,
 ): PatchOperation =>
 	commonPatch(getAmplifyServerContext(contextSpec).amplify, input);

package/src/errors/CanceledError.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { AmplifyErrorParams } from '@aws-amplify/core/internals/utils';
+
 import { RestApiError } from './RestApiError';
 
 /**

package/src/errors/assertValidatonError.ts

@@ -9,7 +9,7 @@ import { RestApiValidationErrorCode, validationErrorMap } from './validation';
  */
 export function assertValidationError(
 	assertion: boolean,
-	name: RestApiValidationErrorCode
+	name: RestApiValidationErrorCode,
 ): asserts assertion {
 	const { message, recoverySuggestion } = validationErrorMap[name];
 

package/src/internals/server.ts

@@ -26,7 +26,7 @@ import { InternalPostInput } from '../types';
  */
 export const post = (
 	contextSpec: AmplifyServer.ContextSpec,
-	input: InternalPostInput
+	input: InternalPostInput,
 ) => {
 	return internalPost(getAmplifyServerContext(contextSpec).amplify, input);
 };

package/src/types/index.ts

@@ -19,7 +19,7 @@ export type HeadOperation = Operation<Omit<RestApiResponse, 'body'>>;
 /**
  * @internal
  */
-export type RestApiOptionsBase = {
+export interface RestApiOptionsBase {
 	headers?: Headers;
 	queryParams?: Record<string, string>;
 	body?: DocumentType | FormData;
@@ -35,7 +35,7 @@ export type RestApiOptionsBase = {
 	 * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials}
 	 */
 	withCredentials?: boolean;
-};
+}
 
 type Headers = Record<string, string>;
 
@@ -44,16 +44,16 @@ type Headers = Record<string, string>;
  *
  * @internal
  */
-export type Operation<Response> = {
+export interface Operation<Response> {
 	response: Promise<Response>;
-	cancel: (abortMessage?: string) => void;
-};
+	cancel(abortMessage?: string): void;
+}
 
-type ResponsePayload = {
-	blob: () => Promise<Blob>;
-	json: () => Promise<DocumentType>;
-	text: () => Promise<string>;
-};
+interface ResponsePayload {
+	blob(): Promise<Blob>;
+	json(): Promise<DocumentType>;
+	text(): Promise<string>;
+}
 
 /**
  * Basic response type of REST API.
@@ -69,7 +69,7 @@ export interface RestApiResponse {
 /**
  * @internal
  */
-export type ApiInput<Options> = {
+export interface ApiInput<Options> {
 	/**
 	 * Name of the REST API configured in Amplify singleton.
 	 */
@@ -82,13 +82,13 @@ export type ApiInput<Options> = {
 	 * Options to overwrite the REST API call behavior.
 	 */
 	options?: Options;
-};
+}
 
 /**
  * Input type to invoke REST POST API from GraphQl client.
  * @internal
  */
-export type InternalPostInput = {
+export interface InternalPostInput {
 	// Resolved GraphQl endpoint url
 	url: URL;
 	options?: RestApiOptionsBase & {
@@ -111,4 +111,4 @@ export type InternalPostInput = {
 	 * controller.
 	 */
 	abortController?: AbortController;
-};
+}