test: verify public interfaces are compliant to TS4.0

.github/workflows/callable-test-tsc-compliance.yml

@@ -0,0 +1,17 @@
+name: Test Github Actions
+on: workflow_call
+
+jobs:
+  tsc_compliance_test:
+    name: TSC Compliance Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@24cb9080177205b6e8c946b17badbe402adc938f # v3.4.0 https://github.com/actions/checkout/commit/24cb9080177205b6e8c946b17badbe402adc938f
+        with:
+          path: amplify-js
+      - name: Setup node and build the repository
+        uses: ./amplify-js/.github/actions/node-and-build
+      - name: Run GithubAction tests
+        working-directory: ./amplify-js
+        run: yarn test:tsc-compliance

.github/workflows/pr.yml

@@ -33,13 +33,17 @@ jobs:
   github-actions-test:
     needs: prebuild
     uses: ./.github/workflows/callable-test-github-actions.yml
+  tsc-compliance-test:
+    needs: prebuild
+    uses: ./.github/workflows/callable-test-tsc-compliance.yml
   all-unit-tests-pass:
     name: Unit and Bundle tests have passed
     needs:
       - unit-tests
       - bundle-size-tests
       - license-test
       - github-actions-test
+      - tsc-compliance-test
     runs-on: ubuntu-latest
     # This is a bit of a hack - Branch protections depend upon selected
     #   workflows that run on hardware, not parents of many callable workflows.

lerna.json

@@ -7,7 +7,8 @@
 		"packages/analytics",
 		"packages/storage",
 		"packages/aws-amplify",
-		"packages/adapter-nextjs"
+		"packages/adapter-nextjs",
+		"scripts/tsc-compliance-test"
 	],
 	"exact": true,
 	"version": "independent",

package.json

@@ -7,11 +7,12 @@
 		"setup-dev": "yarn && yarn bootstrap && yarn link-all && yarn build",
 		"setup-dev:react-native": "node ./scripts/setup-dev-rn",
 		"bootstrap": "lerna bootstrap",
-		"test": "lerna run test --stream && yarn test:license && yarn test:github-actions",
+		"test": "lerna run test --stream && yarn test:license && yarn test:github-actions && test:tsc-compliance",
 		"test:size": "lerna run test:size --no-bail",
 		"test:duplicates": "./scripts/duplicates-yarn.sh",
 		"test:license": "license-check-and-add check -f license_config.json",
 		"test:github-actions": "node ./scripts/test-github-actions.js",
+		"test:tsc-compliance": "yarn workspace tsc-compliance-test test:compliance:ts4.0",
 		"coverage": "codecov || exit 0",
 		"docs": "typedoc packages/**/src --name amplify-js --hideGenerator --excludePrivate --ignoreCompilerErrors --mode file --out docs/api --theme docs/amplify-theme/typedoc/ --readme README.md",
 		"build": "lerna run build --stream && yarn test:duplicates",
@@ -45,7 +46,8 @@
 			"packages/analytics",
 			"packages/storage",
 			"packages/aws-amplify",
-			"packages/adapter-nextjs"
+			"packages/adapter-nextjs",
+			"scripts/tsc-compliance-test"
 		],
 		"nohoist": [
 			"**/@types/react-native",

packages/storage/package.json

@@ -64,7 +64,7 @@
 		"s3"
 	],
 	"dependencies": {
-		"@smithy/md5-js": "2.0.5",
+		"@smithy/md5-js": "2.0.7",
 		"@aws-sdk/types": "3.398.0",
 		"fast-xml-parser": "^4.2.5",
 		"buffer": "4.9.2",

scripts/tsc-compliance-test/README.md

@@ -0,0 +1,5 @@
+This is an **internal-only** package to make sure all the Amplify JS library public interfaces are always compatible
+with TypeScript 4.0 compiler.
+
+If any additional public APIs are added to the library, you must make sure the new API is included in the `ts4_0.ts`
+file.

scripts/tsc-compliance-test/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "tsc-compliance-test",
+  "version": "0.1.0",
+  "license": "MIT",
+  "private": true,
+  "devDependencies": {
+    "@types/node": "^16.11.7",
+	"aws-amplify": "6.0.0",
+    "typescript": "4.0.x"
+  },
+  "scripts": {
+	"test:compliance:ts4.0": "tsc -p tsconfig.json"
+  }
+}

scripts/tsc-compliance-test/ts4_0.ts

@@ -0,0 +1,31 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import * as Amplify from 'aws-amplify';
+import * as analytics from 'aws-amplify/analytics';
+
+import * as auth from 'aws-amplify/auth';
+import * as authCognito from 'aws-amplify/auth/cognito';
+import * as authServer from 'aws-amplify/auth/server';
+import * as authCognitoServer from 'aws-amplify/auth/cognito/server';
+
+import * as storage from 'aws-amplify/storage';
+import * as storageServer from 'aws-amplify/storage/server';
+import * as storageS3 from 'aws-amplify/storage/s3';
+import * as storageS3Server from 'aws-amplify/storage/s3/server';
+
+import * as utils from 'aws-amplify/utils';
+
+export const allPublicPaths = [
+	Amplify,
+	analytics,
+	auth,
+	authCognito,
+	authServer,
+	authCognitoServer,
+	storage,
+	storageServer,
+	storageS3,
+	storageS3Server,
+	utils,
+];

scripts/tsc-compliance-test/tsconfig.json

@@ -0,0 +1,13 @@
+{
+	"compilerOptions": {
+		"noEmit": true,
+		"noImplicitAny": true,
+		"noImplicitReturns": true,
+		"strict": true,
+		"target": "ESNext",
+		"lib": ["DOM", "ESNext.AsyncIterable", "ES2018.AsyncGenerator"],
+		"moduleResolution": "node",
+		"types": ["node"]
+	},
+	"include": ["ts4_0.ts"]
+}