@aws-amplify/rtn-web-browser 1.0.0

package/lib-esm/apis/openAuthSessionAsync.d.ts

@@ -0,0 +1 @@
+export declare const openAuthSessionAsync: (url: string, redirectUrls: string[], prefersEphemeralSession?: boolean) => Promise<string | null | undefined>;

package/lib-esm/apis/openAuthSessionAsync.js

@@ -0,0 +1,64 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { AppState, Linking, Platform, } from 'react-native';
+import { nativeModule } from '../nativeModule';
+let appStateListener;
+let redirectListener;
+export const openAuthSessionAsync = async (url, redirectUrls, prefersEphemeralSession) => {
+    // enforce HTTPS
+    const httpsUrl = url.replace('http://', 'https://');
+    if (Platform.OS === 'ios') {
+        return openAuthSessionIOS(httpsUrl, redirectUrls, prefersEphemeralSession);
+    }
+    if (Platform.OS === 'android') {
+        return openAuthSessionAndroid(httpsUrl, redirectUrls);
+    }
+};
+const openAuthSessionIOS = async (url, redirectUrls, prefersEphemeralSession = false) => {
+    const redirectUrl = redirectUrls.find(
+    // take the first non-web url as the deeplink
+    item => !item.startsWith('https://') && !item.startsWith('http://'));
+    return nativeModule.openAuthSessionAsync(url, redirectUrl, prefersEphemeralSession);
+};
+const openAuthSessionAndroid = async (url, redirectUrls) => {
+    try {
+        const [redirectUrl] = await Promise.all([
+            Promise.race([
+                // wait for app to redirect, resulting in a redirectUrl
+                getRedirectPromise(redirectUrls),
+                // wait for app to return some other way, resulting in null
+                getAppStatePromise(),
+            ]),
+            // open chrome tab
+            nativeModule.openAuthSessionAsync(url),
+        ]);
+        return redirectUrl;
+    }
+    finally {
+        appStateListener?.remove();
+        redirectListener?.remove();
+        appStateListener = undefined;
+        redirectListener = undefined;
+    }
+};
+const getAppStatePromise = () => new Promise(resolve => {
+    appStateListener = AppState.addEventListener('change', nextAppState => {
+        // if current state is null, the change is from initialization
+        if (AppState.currentState === null) {
+            return;
+        }
+        if (nextAppState === 'active') {
+            appStateListener?.remove();
+            appStateListener = undefined;
+            resolve(null);
+        }
+    });
+});
+const getRedirectPromise = (redirectUrls) => new Promise(resolve => {
+    redirectListener = Linking.addEventListener('url', event => {
+        if (redirectUrls.some(url => event.url.startsWith(url))) {
+            resolve(event.url);
+        }
+    });
+});
+//# sourceMappingURL=openAuthSessionAsync.js.map

package/lib-esm/apis/openAuthSessionAsync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openAuthSessionAsync.js","sourceRoot":"","sources":["../../src/apis/openAuthSessionAsync.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAEtC,OAAO,EACN,QAAQ,EACR,OAAO,EAEP,QAAQ,GACR,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,IAAI,gBAAqD,CAAC;AAC1D,IAAI,gBAAqD,CAAC;AAE1D,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACxC,GAAW,EACX,YAAsB,EACtB,uBAAiC,EAChC,EAAE;IACH,gBAAgB;IAChB,MAAM,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACpD,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK,EAAE;QAC1B,OAAO,kBAAkB,CAAC,QAAQ,EAAE,YAAY,EAAE,uBAAuB,CAAC,CAAC;KAC3E;IAED,IAAI,QAAQ,CAAC,EAAE,KAAK,SAAS,EAAE;QAC9B,OAAO,sBAAsB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;KACtD;AACF,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,KAAK,EAC/B,GAAW,EACX,YAAsB,EACtB,0BAAmC,KAAK,EACvC,EAAE;IACH,MAAM,WAAW,GAAG,YAAY,CAAC,IAAI;IACpC,6CAA6C;IAC7C,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CACnE,CAAC;IACF,OAAO,YAAY,CAAC,oBAAoB,CACvC,GAAG,EACH,WAAW,EACX,uBAAuB,CACvB,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,KAAK,EAAE,GAAW,EAAE,YAAsB,EAAE,EAAE;IAC5E,IAAI;QACH,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACvC,OAAO,CAAC,IAAI,CAAC;gBACZ,uDAAuD;gBACvD,kBAAkB,CAAC,YAAY,CAAC;gBAChC,2DAA2D;gBAC3D,kBAAkB,EAAE;aACpB,CAAC;YACF,kBAAkB;YAClB,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC;SACtC,CAAC,CAAC;QACH,OAAO,WAAW,CAAC;KACnB;YAAS;QACT,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC3B,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC3B,gBAAgB,GAAG,SAAS,CAAC;QAC7B,gBAAgB,GAAG,SAAS,CAAC;KAC7B;AACF,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,GAAkB,EAAE,CAC9C,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;IACrB,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,YAAY,CAAC,EAAE;QACrE,8DAA8D;QAC9D,IAAI,QAAQ,CAAC,YAAY,KAAK,IAAI,EAAE;YACnC,OAAO;SACP;QAED,IAAI,YAAY,KAAK,QAAQ,EAAE;YAC9B,gBAAgB,EAAE,MAAM,EAAE,CAAC;YAC3B,gBAAgB,GAAG,SAAS,CAAC;YAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;SACd;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEJ,MAAM,kBAAkB,GAAG,CAAC,YAAsB,EAAmB,EAAE,CACtE,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;IACrB,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE;QAC1D,IAAI,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE;YACxD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACnB;IACF,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/lib-esm/index.d.ts

@@ -0,0 +1,4 @@
+declare const mergedModule: {
+    openAuthSessionAsync: (url: string, redirectUrls: string[], prefersEphemeralSession?: boolean | undefined) => Promise<string | null | undefined>;
+};
+export { mergedModule as AmplifyRTNWebBrowser };

package/lib-esm/index.js

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { openAuthSessionAsync } from './apis/openAuthSessionAsync';
+import { nativeModule } from './nativeModule';
+const mergedModule = {
+    ...nativeModule,
+    openAuthSessionAsync,
+};
+export { mergedModule as AmplifyRTNWebBrowser };
+//# sourceMappingURL=index.js.map

package/lib-esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAEtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,YAAY,GAAG;IACpB,GAAG,YAAY;IACf,oBAAoB;CACpB,CAAC;AAEF,OAAO,EAAE,YAAY,IAAI,oBAAoB,EAAE,CAAC"}

package/lib-esm/nativeModule.d.ts

@@ -0,0 +1,2 @@
+import { WebBrowserNativeModule } from './types';
+export declare const nativeModule: WebBrowserNativeModule;

package/lib-esm/nativeModule.js

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { NativeModules, Platform } from 'react-native';
+const LINKING_ERROR = `The package '@aws-amplify/rtn-web-browser' doesn't seem to be linked. Make sure: \n\n` +
+    Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+    '- You rebuilt the app after installing the package\n' +
+    '- You are not using Expo Go\n';
+export const nativeModule = NativeModules.AmplifyRTNWebBrowser
+    ? NativeModules.AmplifyRTNWebBrowser
+    : new Proxy({}, {
+        get() {
+            throw new Error(LINKING_ERROR);
+        },
+    });
+//# sourceMappingURL=nativeModule.js.map

package/lib-esm/nativeModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nativeModule.js","sourceRoot":"","sources":["../src/nativeModule.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC;AAEtC,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAGvD,MAAM,aAAa,GAClB,uFAAuF;IACvF,QAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,gCAAgC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACvE,sDAAsD;IACtD,+BAA+B,CAAC;AAEjC,MAAM,CAAC,MAAM,YAAY,GACxB,aAAa,CAAC,oBAAoB;IACjC,CAAC,CAAC,aAAa,CAAC,oBAAoB;IACpC,CAAC,CAAC,IAAI,KAAK,CACT,EAAE,EACF;QACC,GAAG;YACF,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;QAChC,CAAC;KACD,CACA,CAAC"}

package/lib-esm/types.d.ts

@@ -0,0 +1,3 @@
+export type WebBrowserNativeModule = {
+    openAuthSessionAsync: (url: string, redirectUrl?: string, prefersEphemeralSession?: boolean) => Promise<string | null>;
+};

package/lib-esm/types.js

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export {};
+//# sourceMappingURL=types.js.map

package/lib-esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+	"name": "@aws-amplify/rtn-web-browser",
+	"version": "1.0.0",
+	"description": "React Native module for aws-amplify web browser",
+	"main": "./lib/index.js",
+	"module": "./lib-esm/index.js",
+	"typings": "./lib-esm/index.d.ts",
+	"sideEffects": false,
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"test": "tslint 'src/**/*.ts'",
+		"test:android": "./android/gradlew test -p ./android",
+		"build-with-test": "npm run clean && npm test && tsc",
+		"build:cjs": "rimraf lib && tsc -m commonjs --outDir lib",
+		"build:esm": "rimraf lib-esm && tsc -m esnext --outDir lib-esm",
+		"build:cjs:watch": "rimraf lib && tsc -m commonjs --outDir lib --watch",
+		"build:esm:watch": "rimraf lib-esm && tsc -m esnext --outDir lib-esm --watch",
+		"build": "npm run clean && npm run build:esm && npm run build:cjs",
+		"clean": "rimraf lib-esm lib dist",
+		"format": "echo \"Not implemented\"",
+		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 88.21"
+	},
+	"devDependencies": {
+		"@types/react-native": "0.70.0",
+		"react-native": "0.72.3",
+		"typescript": "5.1.6"
+	},
+	"react-native": {
+		"./lib/index": "./lib-esm/index.js"
+	},
+	"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://docs.amplify.aws/",
+	"files": [
+		"Amplify*.podspec",
+		"android",
+		"ios",
+		"lib",
+		"lib-esm",
+		"src"
+	],
+	"gitHead": "d505105326d7f6214f6bd1e06eb20be3a3651377"
+}

package/src/apis/openAuthSessionAsync.ts

@@ -0,0 +1,91 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	AppState,
+	Linking,
+	NativeEventSubscription,
+	Platform,
+} from 'react-native';
+import { nativeModule } from '../nativeModule';
+
+let appStateListener: NativeEventSubscription | undefined;
+let redirectListener: NativeEventSubscription | undefined;
+
+export const openAuthSessionAsync = async (
+	url: string,
+	redirectUrls: string[],
+	prefersEphemeralSession?: boolean
+) => {
+	// enforce HTTPS
+	const httpsUrl = url.replace('http://', 'https://');
+	if (Platform.OS === 'ios') {
+		return openAuthSessionIOS(httpsUrl, redirectUrls, prefersEphemeralSession);
+	}
+
+	if (Platform.OS === 'android') {
+		return openAuthSessionAndroid(httpsUrl, redirectUrls);
+	}
+};
+
+const openAuthSessionIOS = async (
+	url: string,
+	redirectUrls: string[],
+	prefersEphemeralSession: boolean = false
+) => {
+	const redirectUrl = redirectUrls.find(
+		// take the first non-web url as the deeplink
+		item => !item.startsWith('https://') && !item.startsWith('http://')
+	);
+	return nativeModule.openAuthSessionAsync(
+		url,
+		redirectUrl,
+		prefersEphemeralSession
+	);
+};
+
+const openAuthSessionAndroid = async (url: string, redirectUrls: string[]) => {
+	try {
+		const [redirectUrl] = await Promise.all([
+			Promise.race([
+				// wait for app to redirect, resulting in a redirectUrl
+				getRedirectPromise(redirectUrls),
+				// wait for app to return some other way, resulting in null
+				getAppStatePromise(),
+			]),
+			// open chrome tab
+			nativeModule.openAuthSessionAsync(url),
+		]);
+		return redirectUrl;
+	} finally {
+		appStateListener?.remove();
+		redirectListener?.remove();
+		appStateListener = undefined;
+		redirectListener = undefined;
+	}
+};
+
+const getAppStatePromise = (): Promise<null> =>
+	new Promise(resolve => {
+		appStateListener = AppState.addEventListener('change', nextAppState => {
+			// if current state is null, the change is from initialization
+			if (AppState.currentState === null) {
+				return;
+			}
+
+			if (nextAppState === 'active') {
+				appStateListener?.remove();
+				appStateListener = undefined;
+				resolve(null);
+			}
+		});
+	});
+
+const getRedirectPromise = (redirectUrls: string[]): Promise<string> =>
+	new Promise(resolve => {
+		redirectListener = Linking.addEventListener('url', event => {
+			if (redirectUrls.some(url => event.url.startsWith(url))) {
+				resolve(event.url);
+			}
+		});
+	});

package/src/index.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { openAuthSessionAsync } from './apis/openAuthSessionAsync';
+import { nativeModule } from './nativeModule';
+
+const mergedModule = {
+	...nativeModule,
+	openAuthSessionAsync,
+};
+
+export { mergedModule as AmplifyRTNWebBrowser };

package/src/nativeModule.ts

@@ -0,0 +1,23 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { NativeModules, Platform } from 'react-native';
+import { WebBrowserNativeModule } from './types';
+
+const LINKING_ERROR =
+	`The package '@aws-amplify/rtn-web-browser' doesn't seem to be linked. Make sure: \n\n` +
+	Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+	'- You rebuilt the app after installing the package\n' +
+	'- You are not using Expo Go\n';
+
+export const nativeModule: WebBrowserNativeModule =
+	NativeModules.AmplifyRTNWebBrowser
+		? NativeModules.AmplifyRTNWebBrowser
+		: new Proxy(
+				{},
+				{
+					get() {
+						throw new Error(LINKING_ERROR);
+					},
+				}
+		  );

package/src/types.ts

@@ -0,0 +1,10 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type WebBrowserNativeModule = {
+	openAuthSessionAsync: (
+		url: string,
+		redirectUrl?: string,
+		prefersEphemeralSession?: boolean
+	) => Promise<string | null>;
+};