diff --git a/CHANGELOG.md b/CHANGELOG.md index dc7ee6c3c..3600f9f59 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) +## [0.38.0] - 2024-02-29 + +## Breaking Changes + +- Previously, when calling `redirectToAuth` with the `redirectBack` option, url fragments(hash) were stripped when redirecting back to the previous page after authentication. This issue has been fixed, and url fragments are preserved along with the query params. For users who employed the workaround of overriding the `windowHandler.location.getSearch` function to include fragments, it is essential to remove that override before upgrading to this version. + ## [0.37.1] - 2024-02-26 - Fixes types argument in override functions to make `builder` non optional. diff --git a/examples/with-hash-router/.gitignore b/examples/with-hash-router/.gitignore new file mode 100644 index 000000000..25c8fdbab --- /dev/null +++ b/examples/with-hash-router/.gitignore @@ -0,0 +1,2 @@ +node_modules +package-lock.json \ No newline at end of file diff --git a/examples/with-hash-router/README.md b/examples/with-hash-router/README.md new file mode 100644 index 000000000..2134e5a72 --- /dev/null +++ b/examples/with-hash-router/README.md @@ -0,0 +1,28 @@ +![SuperTokens banner](https://raw.githubusercontent.com/supertokens/supertokens-logo/master/images/Artboard%20%E2%80%93%2027%402x.png) + +# SuperTokens Demo app - with-hash-router + +This demo app shows you how to use SuperTokens with a frontend router that uses hash routing. This example in particular uses [react-router-dom](https://reactrouter.com/web/guides/quick-start) with hash router. + +The main idea is that we provide a custom `windowHandler` on the frontend's supertokens.init which will provide functions for getting the pathname, search and hash from the url. + +You can find the implementation of this custom handler in `/frontend/src/windowHandler.ts`. The function `getWindowHandler` that is exposed by this file is used in `supertokens.init` in `/frontend/src/config.ts`. + +You can start the demo app by running: + +```bash +git clone https://github.com/supertokens/supertokens-auth-react +cd supertokens-auth-react/examples/with-hash-router + +npm install + +npm run start +``` + +## Author + +Created with :heart: by the folks at supertokens.com. + +## License + +This project is licensed under the Apache 2.0 license. diff --git a/examples/with-hash-router/backend/config.ts b/examples/with-hash-router/backend/config.ts new file mode 100644 index 000000000..6e33f6b09 --- /dev/null +++ b/examples/with-hash-router/backend/config.ts @@ -0,0 +1,39 @@ +import EmailPassword from "supertokens-node/recipe/emailpassword"; +import Session from "supertokens-node/recipe/session"; +import { TypeInput } from "supertokens-node/types"; +import Dashboard from "supertokens-node/recipe/dashboard"; +import EmailVerification from "supertokens-node/recipe/emailverification"; + +export function getApiDomain() { + const apiPort = process.env.REACT_APP_API_PORT || 3001; + const apiUrl = process.env.REACT_APP_API_URL || `http://localhost:${apiPort}`; + return apiUrl; +} + +export function getWebsiteDomain() { + const websitePort = process.env.REACT_APP_WEBSITE_PORT || 3000; + const websiteUrl = process.env.REACT_APP_WEBSITE_URL || `http://localhost:${websitePort}`; + return websiteUrl; +} + +export const SuperTokensConfig: TypeInput = { + supertokens: { + // this is the location of the SuperTokens core. + connectionURI: "https://try.supertokens.com", + }, + appInfo: { + appName: "SuperTokens Demo App", + apiDomain: getApiDomain(), + websiteDomain: getWebsiteDomain(), + }, + // recipeList contains all the modules that you want to + // use from SuperTokens. See the full list here: https://supertokens.com/docs/guides + recipeList: [ + EmailPassword.init(), + Session.init(), + Dashboard.init(), + EmailVerification.init({ + mode: "REQUIRED", + }), + ], +}; diff --git a/examples/with-hash-router/backend/index.ts b/examples/with-hash-router/backend/index.ts new file mode 100644 index 000000000..67c228198 --- /dev/null +++ b/examples/with-hash-router/backend/index.ts @@ -0,0 +1,38 @@ +import express from "express"; +import cors from "cors"; +import supertokens from "supertokens-node"; +import { verifySession } from "supertokens-node/recipe/session/framework/express"; +import { middleware, errorHandler, SessionRequest } from "supertokens-node/framework/express"; +import { getWebsiteDomain, SuperTokensConfig } from "./config"; + +supertokens.init(SuperTokensConfig); + +const app = express(); + +app.use( + cors({ + origin: getWebsiteDomain(), + allowedHeaders: ["content-type", ...supertokens.getAllCORSHeaders()], + methods: ["GET", "PUT", "POST", "DELETE"], + credentials: true, + }) +); + +// This exposes all the APIs from SuperTokens to the client. +app.use(middleware()); + +// An example API that requires session verification +app.get("/sessioninfo", verifySession(), async (req: SessionRequest, res) => { + let session = req.session; + res.send({ + sessionHandle: session!.getHandle(), + userId: session!.getUserId(), + accessTokenPayload: session!.getAccessTokenPayload(), + }); +}); + +// In case of session related errors, this error handler +// returns 401 to the client. +app.use(errorHandler()); + +app.listen(3001, () => console.log(`API Server listening on port 3001`)); diff --git a/examples/with-hash-router/backend/package.json b/examples/with-hash-router/backend/package.json new file mode 100644 index 000000000..92e6e33f5 --- /dev/null +++ b/examples/with-hash-router/backend/package.json @@ -0,0 +1,20 @@ +{ + "name": "supertokens-node", + "version": "0.0.1", + "private": true, + "description": "", + "main": "index.js", + "scripts": { + "start": "npx ts-node-dev --project ./tsconfig.json ./index.ts" + }, + "dependencies": {}, + "devDependencies": { + "@types/cors": "^2.8.12", + "@types/morgan": "^1.9.3", + "@types/node": "^16.11.38", + "nodemon": "^2.0.16" + }, + "keywords": [], + "author": "", + "license": "ISC" +} diff --git a/examples/with-hash-router/backend/tsconfig.json b/examples/with-hash-router/backend/tsconfig.json new file mode 100644 index 000000000..8a91acaae --- /dev/null +++ b/examples/with-hash-router/backend/tsconfig.json @@ -0,0 +1,62 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */, + "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */, + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ + // "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + // "outDir": "./", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + /* Strict Type-Checking Options */ + "strict": true /* Enable all strict type-checking options. */, + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */, + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + /* Advanced Options */ + "skipLibCheck": true /* Skip type checking of declaration files. */, + "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */ + } +} diff --git a/examples/with-hash-router/frontend/.env b/examples/with-hash-router/frontend/.env new file mode 100644 index 000000000..7d910f148 --- /dev/null +++ b/examples/with-hash-router/frontend/.env @@ -0,0 +1 @@ +SKIP_PREFLIGHT_CHECK=true \ No newline at end of file diff --git a/examples/with-hash-router/frontend/.gitignore b/examples/with-hash-router/frontend/.gitignore new file mode 100644 index 000000000..4d29575de --- /dev/null +++ b/examples/with-hash-router/frontend/.gitignore @@ -0,0 +1,23 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# production +/build + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* diff --git a/examples/with-hash-router/frontend/LICENSE.md b/examples/with-hash-router/frontend/LICENSE.md new file mode 100644 index 000000000..588f27e68 --- /dev/null +++ b/examples/with-hash-router/frontend/LICENSE.md @@ -0,0 +1,192 @@ +Copyright (c) 2020, VRAI Labs and/or its affiliates. All rights reserved. + +This software is licensed under the Apache License, Version 2.0 (the +"License") as published by the Apache Software Foundation. + +You may not use this software except in compliance with the License. A copy +of the License is available below the line. + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +License for the specific language governing permissions and limitations +under the License. + +--- + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/examples/with-hash-router/frontend/package.json b/examples/with-hash-router/frontend/package.json new file mode 100644 index 000000000..5240dd65c --- /dev/null +++ b/examples/with-hash-router/frontend/package.json @@ -0,0 +1,30 @@ +{ + "name": "supertokens-react", + "version": "0.1.0", + "private": true, + "dependencies": {}, + "scripts": { + "start": "react-scripts start", + "build": "react-scripts build", + "test": "react-scripts test", + "eject": "react-scripts eject" + }, + "eslintConfig": { + "extends": [ + "react-app", + "react-app/jest" + ] + }, + "browserslist": { + "production": [ + ">0.2%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 1 chrome version", + "last 1 firefox version", + "last 1 safari version" + ] + } +} diff --git a/examples/with-hash-router/frontend/public/favicon.ico b/examples/with-hash-router/frontend/public/favicon.ico new file mode 100644 index 000000000..a11777cc4 Binary files /dev/null and b/examples/with-hash-router/frontend/public/favicon.ico differ diff --git a/examples/with-hash-router/frontend/public/index.html b/examples/with-hash-router/frontend/public/index.html new file mode 100644 index 000000000..6f1f7cb51 --- /dev/null +++ b/examples/with-hash-router/frontend/public/index.html @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + React App + + + +
+ + diff --git a/examples/with-hash-router/frontend/public/manifest.json b/examples/with-hash-router/frontend/public/manifest.json new file mode 100644 index 000000000..f01493ff0 --- /dev/null +++ b/examples/with-hash-router/frontend/public/manifest.json @@ -0,0 +1,25 @@ +{ + "short_name": "React App", + "name": "Create React App Sample", + "icons": [ + { + "src": "favicon.ico", + "sizes": "64x64 32x32 24x24 16x16", + "type": "image/x-icon" + }, + { + "src": "logo192.png", + "type": "image/png", + "sizes": "192x192" + }, + { + "src": "logo512.png", + "type": "image/png", + "sizes": "512x512" + } + ], + "start_url": ".", + "display": "standalone", + "theme_color": "#000000", + "background_color": "#ffffff" +} diff --git a/examples/with-hash-router/frontend/public/robots.txt b/examples/with-hash-router/frontend/public/robots.txt new file mode 100644 index 000000000..e9e57dc4d --- /dev/null +++ b/examples/with-hash-router/frontend/public/robots.txt @@ -0,0 +1,3 @@ +# https://www.robotstxt.org/robotstxt.html +User-agent: * +Disallow: diff --git a/examples/with-hash-router/frontend/src/App.css b/examples/with-hash-router/frontend/src/App.css new file mode 100644 index 000000000..8a98a2341 --- /dev/null +++ b/examples/with-hash-router/frontend/src/App.css @@ -0,0 +1,27 @@ +.App { + display: flex; + flex-direction: column; + width: 100vw; + height: 100vh; + font-family: Rubik; +} + +.fill { + display: flex; + flex-direction: column; + justify-content: center; + flex: 1; +} + +.sessionButton { + padding-left: 13px; + padding-right: 13px; + padding-top: 8px; + padding-bottom: 8px; + background-color: black; + border-radius: 10px; + cursor: pointer; + color: white; + font-weight: bold; + font-size: 17px; +} diff --git a/examples/with-hash-router/frontend/src/App.tsx b/examples/with-hash-router/frontend/src/App.tsx new file mode 100644 index 000000000..734dd8e12 --- /dev/null +++ b/examples/with-hash-router/frontend/src/App.tsx @@ -0,0 +1,40 @@ +import "./App.css"; +import SuperTokens, { SuperTokensWrapper } from "supertokens-auth-react"; +import { getSuperTokensRoutesForReactRouterDom } from "supertokens-auth-react/ui"; +import { SessionAuth } from "supertokens-auth-react/recipe/session"; +import { Routes, HashRouter as Router, Route } from "react-router-dom"; +import Home from "./Home"; +import { PreBuiltUIList, SuperTokensConfig } from "./config"; + +SuperTokens.init(SuperTokensConfig); + +function App() { + return ( + +
+ +
+ + {/* This shows the login UI on "/auth" route */} + {getSuperTokensRoutesForReactRouterDom(require("react-router-dom"), PreBuiltUIList)} + + only if the user is logged in. + Else it redirects the user to "/auth" */ + + + + } + /> + +
+ +
+ + ); +} + +export default App; diff --git a/examples/with-hash-router/frontend/src/Home/CallAPIView.tsx b/examples/with-hash-router/frontend/src/Home/CallAPIView.tsx new file mode 100644 index 000000000..6a9d510d4 --- /dev/null +++ b/examples/with-hash-router/frontend/src/Home/CallAPIView.tsx @@ -0,0 +1,15 @@ +import axios from "axios"; +import { getApiDomain } from "../config"; + +export default function CallAPIView() { + async function callAPIClicked() { + let response = await axios.get(getApiDomain() + "/sessioninfo"); + window.alert("Session Information:\n" + JSON.stringify(response.data, null, 2)); + } + + return ( +
+ Call API +
+ ); +} diff --git a/examples/with-hash-router/frontend/src/Home/Home.css b/examples/with-hash-router/frontend/src/Home/Home.css new file mode 100644 index 000000000..1a01e729a --- /dev/null +++ b/examples/with-hash-router/frontend/src/Home/Home.css @@ -0,0 +1,189 @@ +@font-face { + font-family: Menlo; + src: url("../assets/fonts/MenloRegular.ttf"); +} + +.app-container { + font-family: Rubik, sans-serif; +} + +.app-container * { + box-sizing: border-box; +} + +.bold-400 { + font-variation-settings: "wght" 400; +} + +.bold-500 { + font-variation-settings: "wght" 500; +} + +.bold-600 { + font-variation-settings: "wght" 600; +} + +#home-container { + align-items: center; + min-height: 100vh; + background: url("../assets/images/background.png"); + background-size: cover; +} + +.bold-700 { + font-variation-settings: "wght" 700; +} + +.app-container .main-container { + box-shadow: 0px 0px 60px 0px rgba(0, 0, 0, 0.16); + width: min(635px, calc(100% - 24px)); + border-radius: 16px; + margin-block-end: 159px; + background-color: #ffffff; +} + +.main-container .success-title { + line-height: 1; + padding-block: 26px; + background-color: #e7ffed; + text-align: center; + color: #3eb655; + display: flex; + justify-content: center; + align-items: flex-end; + font-size: 20px; +} + +.success-title img.success-icon { + margin-right: 8px; +} + +.main-container .inner-content { + padding-block: 48px; + text-align: center; + display: flex; + flex-direction: column; + align-items: center; +} + +.inner-content #user-id { + position: relative; + padding: 14px 17px; + border-image-slice: 1; + width: min(430px, calc(100% - 30px)); + margin-inline: auto; + margin-block: 11px 23px; + border-radius: 9px; + line-height: 1; + font-family: Menlo, serif; + cursor: text; +} + +.inner-content #user-id:before { + content: ""; + position: absolute; + inset: 0; + border-radius: 9px; + padding: 2px; + background: linear-gradient(90.31deg, #ff9933 0.11%, #ff3f33 99.82%); + -webkit-mask: linear-gradient(#fff 0 0) content-box, linear-gradient(#fff 0 0); + -webkit-mask-composite: xor; + mask-composite: exclude; +} + +.main-container > .top-band, +.main-container > .bottom-band { + border-radius: inherit; +} + +.main-container .top-band { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; +} + +.main-container .bottom-band { + border-top-left-radius: 0; + border-top-right-radius: 0; +} + +.main-container .sessionButton { + box-sizing: border-box; + background: #ff9933; + border: 1px solid #ff8a15; + box-shadow: 0px 3px 6px rgba(255, 153, 51, 0.16); + border-radius: 6px; + font-size: 16px; +} + +.bottom-cta-container { + display: flex; + justify-content: flex-end; + padding-inline: 21px; + background-color: #212d4f; +} + +.bottom-cta-container .view-code { + padding-block: 11px; + color: #bac9f5; + cursor: pointer; + font-size: 14px; +} + +.bottom-links-container { + display: grid; + grid-template-columns: repeat(4, auto); + margin-bottom: 22px; +} + +.bottom-links-container .link { + display: flex; + align-items: center; + margin-inline-end: 68px; + cursor: pointer; +} + +.bottom-links-container .link:last-child { + margin-right: 0; +} + +.truncate { + text-overflow: ellipsis; + overflow: hidden; + white-space: nowrap; +} + +.separator-line { + max-width: 100%; +} + +.link .link-icon { + width: 15px; + margin-right: 5px; +} + +@media screen and (max-width: 768px) { + .bottom-links-container { + grid-template-columns: repeat(2, 1fr); + column-gap: 64px; + row-gap: 34px; + } + + .bottom-links-container .link { + margin-inline-end: 0; + } + + .separator-line { + max-width: 200px; + } +} + +@media screen and (max-width: 480px) { + #home-container { + justify-content: start; + padding-block-start: 25px; + } + + .app-container .main-container { + margin-block-end: 90px; + } +} diff --git a/examples/with-hash-router/frontend/src/Home/SuccessView.tsx b/examples/with-hash-router/frontend/src/Home/SuccessView.tsx new file mode 100644 index 000000000..bea4566ef --- /dev/null +++ b/examples/with-hash-router/frontend/src/Home/SuccessView.tsx @@ -0,0 +1,72 @@ +import { useNavigate } from "react-router-dom"; +import { signOut } from "supertokens-auth-react/recipe/session"; +import { recipeDetails } from "../config"; +import CallAPIView from "./CallAPIView"; +import { BlogsIcon, CelebrateIcon, GuideIcon, SeparatorLine, SignOutIcon } from "../assets/images"; + +interface ILink { + name: string; + onClick: () => void; + icon: string; +} + +export default function SuccessView(props: { userId: string }) { + let userId = props.userId; + + const navigate = useNavigate(); + + async function logoutClicked() { + await signOut(); + navigate("/auth"); + } + + function openLink(url: string) { + window.open(url, "_blank"); + } + + const links: ILink[] = [ + { + name: "Blogs", + onClick: () => openLink("https://supertokens.com/blog"), + icon: BlogsIcon, + }, + { + name: "Documentation", + onClick: () => openLink(recipeDetails.docsLink), + icon: GuideIcon, + }, + { + name: "Sign Out", + onClick: logoutClicked, + icon: SignOutIcon, + }, + ]; + + return ( + <> +
+
+ Login successful Login successful +
+
+
Your userID is:
+
+ {userId} +
+ +
+
+
+ {links.map((link) => ( +
+ {link.name} +
+ {link.name} +
+
+ ))} +
+ separator + + ); +} diff --git a/examples/with-hash-router/frontend/src/Home/index.tsx b/examples/with-hash-router/frontend/src/Home/index.tsx new file mode 100644 index 000000000..0c3f288e8 --- /dev/null +++ b/examples/with-hash-router/frontend/src/Home/index.tsx @@ -0,0 +1,17 @@ +import SuccessView from "./SuccessView"; +import { useSessionContext } from "supertokens-auth-react/recipe/session"; +import "./Home.css"; + +export default function Home() { + const sessionContext = useSessionContext(); + + if (sessionContext.loading === true) { + return null; + } + + return ( +
+ +
+ ); +} diff --git a/examples/with-hash-router/frontend/src/assets/fonts/MenloRegular.ttf b/examples/with-hash-router/frontend/src/assets/fonts/MenloRegular.ttf new file mode 100644 index 000000000..033dc6d21 Binary files /dev/null and b/examples/with-hash-router/frontend/src/assets/fonts/MenloRegular.ttf differ diff --git a/examples/with-hash-router/frontend/src/assets/images/arrow-right-icon.svg b/examples/with-hash-router/frontend/src/assets/images/arrow-right-icon.svg new file mode 100644 index 000000000..95aa1fec6 --- /dev/null +++ b/examples/with-hash-router/frontend/src/assets/images/arrow-right-icon.svg @@ -0,0 +1,3 @@ + + + diff --git a/examples/with-hash-router/frontend/src/assets/images/background.png b/examples/with-hash-router/frontend/src/assets/images/background.png new file mode 100644 index 000000000..2147c15c2 Binary files /dev/null and b/examples/with-hash-router/frontend/src/assets/images/background.png differ diff --git a/examples/with-hash-router/frontend/src/assets/images/blogs-icon.svg b/examples/with-hash-router/frontend/src/assets/images/blogs-icon.svg new file mode 100644 index 000000000..a2fc9dd62 --- /dev/null +++ b/examples/with-hash-router/frontend/src/assets/images/blogs-icon.svg @@ -0,0 +1,3 @@ + + + diff --git a/examples/with-hash-router/frontend/src/assets/images/celebrate-icon.svg b/examples/with-hash-router/frontend/src/assets/images/celebrate-icon.svg new file mode 100644 index 000000000..3b40b1efa --- /dev/null +++ b/examples/with-hash-router/frontend/src/assets/images/celebrate-icon.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/examples/with-hash-router/frontend/src/assets/images/guide-icon.svg b/examples/with-hash-router/frontend/src/assets/images/guide-icon.svg new file mode 100644 index 000000000..bd85af72b --- /dev/null +++ b/examples/with-hash-router/frontend/src/assets/images/guide-icon.svg @@ -0,0 +1,3 @@ + + + diff --git a/examples/with-hash-router/frontend/src/assets/images/index.ts b/examples/with-hash-router/frontend/src/assets/images/index.ts new file mode 100644 index 000000000..7adf036c4 --- /dev/null +++ b/examples/with-hash-router/frontend/src/assets/images/index.ts @@ -0,0 +1,8 @@ +import SeparatorLine from "./separator-line.svg"; +import ArrowRight from "./arrow-right-icon.svg"; +import SignOutIcon from "./sign-out-icon.svg"; +import GuideIcon from "./guide-icon.svg"; +import BlogsIcon from "./blogs-icon.svg"; +import CelebrateIcon from "./celebrate-icon.svg"; + +export { SeparatorLine, ArrowRight, SignOutIcon, GuideIcon, BlogsIcon, CelebrateIcon }; diff --git a/examples/with-hash-router/frontend/src/assets/images/separator-line.svg b/examples/with-hash-router/frontend/src/assets/images/separator-line.svg new file mode 100644 index 000000000..7127a00dc --- /dev/null +++ b/examples/with-hash-router/frontend/src/assets/images/separator-line.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/examples/with-hash-router/frontend/src/assets/images/sign-out-icon.svg b/examples/with-hash-router/frontend/src/assets/images/sign-out-icon.svg new file mode 100644 index 000000000..6cc4f85fd --- /dev/null +++ b/examples/with-hash-router/frontend/src/assets/images/sign-out-icon.svg @@ -0,0 +1,3 @@ + + + diff --git a/examples/with-hash-router/frontend/src/config.tsx b/examples/with-hash-router/frontend/src/config.tsx new file mode 100644 index 000000000..28bd5c4f4 --- /dev/null +++ b/examples/with-hash-router/frontend/src/config.tsx @@ -0,0 +1,42 @@ +import EmailPassword from "supertokens-auth-react/recipe/emailpassword"; +import { EmailPasswordPreBuiltUI } from "supertokens-auth-react/recipe/emailpassword/prebuiltui"; +import Session from "supertokens-auth-react/recipe/session"; +import getWindowHandler from "./windowHandler"; +import EmailVerification from "supertokens-auth-react/recipe/emailverification"; +import { EmailVerificationPreBuiltUI } from "supertokens-auth-react/recipe/emailverification/prebuiltui"; + +export function getApiDomain() { + const apiPort = process.env.REACT_APP_API_PORT || 3001; + const apiUrl = process.env.REACT_APP_API_URL || `http://localhost:${apiPort}`; + return apiUrl; +} + +export function getWebsiteDomain() { + const websitePort = process.env.REACT_APP_WEBSITE_PORT || 3000; + const websiteUrl = process.env.REACT_APP_WEBSITE_URL || `http://localhost:${websitePort}`; + return websiteUrl; +} + +export const SuperTokensConfig = { + windowHandler: getWindowHandler, + appInfo: { + appName: "SuperTokens Demo App", + apiDomain: getApiDomain(), + websiteDomain: getWebsiteDomain(), + }, + // recipeList contains all the modules that you want to + // use from SuperTokens. See the full list here: https://supertokens.com/docs/guides + recipeList: [ + EmailPassword.init(), + Session.init(), + EmailVerification.init({ + mode: "REQUIRED", + }), + ], +}; + +export const recipeDetails = { + docsLink: "https://supertokens.com/docs/emailpassword/introduction", +}; + +export const PreBuiltUIList = [EmailPasswordPreBuiltUI, EmailVerificationPreBuiltUI]; diff --git a/examples/with-hash-router/frontend/src/index.css b/examples/with-hash-router/frontend/src/index.css new file mode 100644 index 000000000..04146b5e7 --- /dev/null +++ b/examples/with-hash-router/frontend/src/index.css @@ -0,0 +1,11 @@ +body { + margin: 0; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", + "Droid Sans", "Helvetica Neue", sans-serif; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +code { + font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace; +} diff --git a/examples/with-hash-router/frontend/src/index.tsx b/examples/with-hash-router/frontend/src/index.tsx new file mode 100644 index 000000000..399c737cd --- /dev/null +++ b/examples/with-hash-router/frontend/src/index.tsx @@ -0,0 +1,11 @@ +import React from "react"; +import ReactDOM from "react-dom/client"; +import "./index.css"; +import App from "./App"; + +const root = ReactDOM.createRoot(document.getElementById("root") as HTMLElement); +root.render( + + + +); diff --git a/examples/with-hash-router/frontend/src/react-app-env.d.ts b/examples/with-hash-router/frontend/src/react-app-env.d.ts new file mode 100644 index 000000000..6431bc5fc --- /dev/null +++ b/examples/with-hash-router/frontend/src/react-app-env.d.ts @@ -0,0 +1 @@ +/// diff --git a/examples/with-hash-router/frontend/src/windowHandler.ts b/examples/with-hash-router/frontend/src/windowHandler.ts new file mode 100644 index 000000000..05f6f1059 --- /dev/null +++ b/examples/with-hash-router/frontend/src/windowHandler.ts @@ -0,0 +1,26 @@ +import { WindowHandlerInterface } from "supertokens-website/utils/windowHandler/types"; + +const getLocationInfoFromURLHash = () => { + const { hash, origin } = window.location; + + const url = new URL(`${origin}${hash.substring(1)}`); + return { search: url.search, pathname: url.pathname, hash: url.hash }; +}; + +export default function getWindowHandler(original: WindowHandlerInterface): WindowHandlerInterface { + return { + ...original, + location: { + ...original.location, + getSearch() { + return getLocationInfoFromURLHash().search; + }, + getPathName() { + return getLocationInfoFromURLHash().pathname; + }, + getHash() { + return getLocationInfoFromURLHash().hash; + }, + }, + }; +} diff --git a/examples/with-hash-router/frontend/tsconfig.json b/examples/with-hash-router/frontend/tsconfig.json new file mode 100644 index 000000000..c0555cbc6 --- /dev/null +++ b/examples/with-hash-router/frontend/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "target": "es5", + "lib": ["dom", "dom.iterable", "esnext"], + "allowJs": true, + "skipLibCheck": true, + "esModuleInterop": true, + "allowSyntheticDefaultImports": true, + "strict": true, + "forceConsistentCasingInFileNames": true, + "noFallthroughCasesInSwitch": true, + "module": "esnext", + "moduleResolution": "node", + "resolveJsonModule": true, + "isolatedModules": true, + "noEmit": true, + "jsx": "react-jsx" + }, + "include": ["src"] +} diff --git a/examples/with-hash-router/package.json b/examples/with-hash-router/package.json new file mode 100644 index 000000000..b15d3e651 --- /dev/null +++ b/examples/with-hash-router/package.json @@ -0,0 +1,44 @@ +{ + "name": "with-hash-router", + "version": "0.0.1", + "description": "", + "main": "index.js", + "scripts": { + "start:frontend": "cd frontend && npm run start", + "start:frontend-live-demo-app": "cd frontend && npx serve -s build", + "start:backend": "cd backend && npm run start", + "start:backend-live-demo-app": "cd backend && ./startLiveDemoApp.sh", + "start": "npm-run-all --parallel start:frontend start:backend", + "start-live-demo-app": "npx npm-run-all --parallel start:frontend-live-demo-app start:backend-live-demo-app" + }, + "keywords": [], + "author": "", + "license": "ISC", + "dependencies": { + "@testing-library/jest-dom": "^5.16.5", + "@testing-library/react": "^13.4.0", + "@testing-library/user-event": "^13.5.0", + "@types/jest": "^27.5.2", + "@types/node": "^16.11.56", + "@types/react": "^18.0.18", + "@types/react-dom": "^18.0.6", + "axios": "^0.21.0", + "cors": "^2.8.5", + "express": "^4.18.1", + "helmet": "^5.1.0", + "morgan": "^1.10.0", + "npm-run-all": "^4.1.5", + "react": "^18.2.0", + "react-dom": "^18.2.0", + "react-router-dom": "^6.2.1", + "react-scripts": "5.0.1", + "supertokens-auth-react": "latest", + "supertokens-node": "latest", + "ts-node-dev": "^2.0.0", + "typescript": "^4.8.2", + "web-vitals": "^2.1.4" + }, + "devDependencies": { + "@types/cors": "^2.8.13" + } +} diff --git a/examples/with-hash-router/test/basic.test.js b/examples/with-hash-router/test/basic.test.js new file mode 100644 index 000000000..e847df1cd --- /dev/null +++ b/examples/with-hash-router/test/basic.test.js @@ -0,0 +1,116 @@ +/* Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved. + * + * This software is licensed under the Apache License, Version 2.0 (the + * "License") as published by the Apache Software Foundation. + * + * You may not use this file except in compliance with the License. You may + * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + */ + +/* + * Imports + */ + +const assert = require("assert"); +const puppeteer = require("puppeteer"); +const { + getTestEmail, + setInputValues, + submitForm, + toggleSignInSignUp, + waitForSTElement, +} = require("../../../test/exampleTestHelpers"); + +const SuperTokensNode = require("supertokens-node"); +const Session = require("supertokens-node/recipe/session"); +const EmailVerification = require("supertokens-node/recipe/emailverification"); +const EmailPassword = require("supertokens-node/recipe/emailpassword"); + +// Run the tests in a DOM environment. +require("jsdom-global")(); + +const apiDomain = "http://localhost:3001"; +const websiteDomain = "http://localhost:3000"; +SuperTokensNode.init({ + supertokens: { + // We are running these tests without running a local ST instance + connectionURI: "https://try.supertokens.com", + }, + appInfo: { + // These largely shouldn't matter except for creating links which we can change anyway + apiDomain: apiDomain, + websiteDomain: websiteDomain, + appName: "testNode", + }, + recipeList: [EmailVerification.init({ mode: "OPTIONAL" }), EmailPassword.init(), Session.init()], +}); + +describe("SuperTokens Example Basic tests", function () { + let browser; + let page; + const email = getTestEmail(); + const testPW = "Str0ngP@ssw0rd"; + + before(async function () { + browser = await puppeteer.launch({ + args: ["--no-sandbox", "--disable-setuid-sandbox"], + headless: true, + }); + page = await browser.newPage(); + }); + + after(async function () { + await browser.close(); + }); + + describe("Email Password test", function () { + it("Successful signup with credentials", async function () { + await Promise.all([page.goto(websiteDomain), page.waitForNavigation({ waitUntil: "networkidle0" })]); + + // redirected to /auth + await toggleSignInSignUp(page); + await setInputValues(page, [ + { name: "email", value: email }, + { name: "password", value: testPW }, + ]); + await submitForm(page); + + // Redirected to email verification screen + await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']"); + const userId = await page.evaluate(() => window.__supertokensSessionRecipe.getUserId()); + + // Attempt reloading Home + await Promise.all([page.goto(websiteDomain), page.waitForNavigation({ waitUntil: "networkidle0" })]); + await waitForSTElement(page, "[data-supertokens~='sendVerifyEmailIcon']"); + + // Create a new token and use it (we don't have access to the originally sent one) + const tokenInfo = await EmailVerification.createEmailVerificationToken( + "public", + SuperTokensNode.convertToRecipeUserId(userId), + email + ); + await page.goto(`${websiteDomain}/#/auth/verify-email?token=${tokenInfo.token}`); + await submitForm(page); + + const callApiBtn = await page.waitForSelector(".sessionButton"); + let setAlertContent; + let alertContent = new Promise((res) => (setAlertContent = res)); + page.on("dialog", async (dialog) => { + setAlertContent(dialog.message()); + await dialog.dismiss(); + }); + await callApiBtn.click(); + + const alertText = await alertContent; + assert(alertText.startsWith("Session Information:")); + const sessionInfo = JSON.parse(alertText.replace(/^Session Information:/, "")); + assert.strictEqual(sessionInfo.userId, userId); + }); + }); +}); diff --git a/lib/build/genericComponentOverrideContext.js b/lib/build/genericComponentOverrideContext.js index 757ec0080..2d292e52d 100644 --- a/lib/build/genericComponentOverrideContext.js +++ b/lib/build/genericComponentOverrideContext.js @@ -265,7 +265,7 @@ var SSR_ERROR = * License for the specific language governing permissions and limitations * under the License. */ -var package_version = "0.37.1"; +var package_version = "0.38.0"; /* Copyright (c) 2021, VRAI Labs and/or its affiliates. All rights reserved. * @@ -348,25 +348,33 @@ function getURLHash() { return windowHandler.WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getHash().substr(1); } function getRedirectToPathFromURL() { - var param = getQueryParams("redirectToPath"); - if (param === null) { + var redirectToPath = getQueryParams("redirectToPath"); + if (redirectToPath === null) { return undefined; } else { - // Prevent Open redirects by normalising path. try { - var normalisedURLPath = new NormalisedURLPath__default.default(param).getAsStringDangerous(); - var pathQueryParams = param.split("?")[1] !== undefined ? "?".concat(param.split("?")[1]) : ""; - var pathWithQueryParams = normalisedURLPath + pathQueryParams; - // Ensure a leading "/" if `normalisedUrlPath` is empty but `pathWithQueryParams` is not to ensure proper redirection. + var url = void 0; + try { + url = new URL(redirectToPath); + } catch (error) { + var fakeDomain = redirectToPath.startsWith("/") ? "http://localhost" : "http://localhost/"; + url = new URL("".concat(fakeDomain).concat(redirectToPath)); + } + // Prevent Open redirects by normalising path. + var normalisedURLPath = new NormalisedURLPath__default.default(redirectToPath).getAsStringDangerous(); + var pathQueryParams = url.search || ""; // url.search contains the leading ? + var pathHash = url.hash || ""; // url.hash contains the leading # + var pathWithQueryParamsAndHash = normalisedURLPath + pathQueryParams + pathHash; + // Ensure a leading "/" if `normalisedUrlPath` is empty but `pathWithQueryParamsAndHash` is not to ensure proper redirection. // Example: "?test=1" will not redirect the user to `/?test=1` if we don't add a leading "/". if ( normalisedURLPath.length === 0 && - pathWithQueryParams.length > 0 && - !pathWithQueryParams.startsWith("/") + pathWithQueryParamsAndHash.length > 0 && + !pathWithQueryParamsAndHash.startsWith("/") ) { - return "/" + pathWithQueryParams; + return "/" + pathWithQueryParamsAndHash; } - return pathWithQueryParams; + return pathWithQueryParamsAndHash; } catch (_a) { return undefined; } @@ -484,11 +492,12 @@ function getCurrentNormalisedUrlPath() { windowHandler.WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getPathName() ); } -function getCurrentNormalisedUrlPathWithQueryParams() { +function getCurrentNormalisedUrlPathWithQueryParamsAndFragments() { var normalisedUrlPath = getCurrentNormalisedUrlPath().getAsStringDangerous(); return ( normalisedUrlPath + - windowHandler.WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getSearch() + windowHandler.WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getSearch() + + windowHandler.WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getHash() ); } function appendQueryParamsToURL(stringUrl, queryParams) { @@ -504,7 +513,7 @@ function appendQueryParamsToURL(stringUrl, queryParams) { }); return url_1.href; } catch (e) { - var fakeDomain = stringUrl.startsWith("/") ? "http:localhost" : "http://localhost/"; + var fakeDomain = stringUrl.startsWith("/") ? "http://localhost" : "http://localhost/"; var url_2 = new URL("".concat(fakeDomain).concat(stringUrl)); Object.entries(queryParams).forEach(function (_a) { var key = _a[0], @@ -1186,7 +1195,7 @@ var SuperTokens = /** @class */ (function () { queryParams.show = options.show; } if (options.redirectBack === true) { - queryParams.redirectToPath = getCurrentNormalisedUrlPathWithQueryParams(); + queryParams.redirectToPath = getCurrentNormalisedUrlPathWithQueryParamsAndFragments(); } return [ 4 /*yield*/, diff --git a/lib/build/utils.d.ts b/lib/build/utils.d.ts index 8810c2549..8f2b07218 100644 --- a/lib/build/utils.d.ts +++ b/lib/build/utils.d.ts @@ -22,7 +22,7 @@ export declare function validateForm( configFormFields: NormalisedFormField[] ): Promise; export declare function getCurrentNormalisedUrlPath(): NormalisedURLPath; -export declare function getCurrentNormalisedUrlPathWithQueryParams(): string; +export declare function getCurrentNormalisedUrlPathWithQueryParamsAndFragments(): string; export declare function appendQueryParamsToURL(stringUrl: string, queryParams?: Record): string; export declare function appendTrailingSlashToURL(stringUrl: string): string; export declare function matchRecipeIdUsingQueryParams(recipeId: string): () => boolean; diff --git a/lib/build/version.d.ts b/lib/build/version.d.ts index c0f906ffd..7a159af01 100644 --- a/lib/build/version.d.ts +++ b/lib/build/version.d.ts @@ -1 +1 @@ -export declare const package_version = "0.37.1"; +export declare const package_version = "0.38.0"; diff --git a/lib/ts/superTokens.tsx b/lib/ts/superTokens.tsx index a991488e0..4a994676e 100644 --- a/lib/ts/superTokens.tsx +++ b/lib/ts/superTokens.tsx @@ -28,7 +28,7 @@ import { saveCurrentLanguage, TranslationController } from "./translation/transl import { appendQueryParamsToURL, appendTrailingSlashToURL, - getCurrentNormalisedUrlPathWithQueryParams, + getCurrentNormalisedUrlPathWithQueryParamsAndFragments, getDefaultCookieScope, getOriginOfPage, isTest, @@ -193,7 +193,7 @@ export default class SuperTokens { queryParams.show = options.show; } if (options.redirectBack === true) { - queryParams.redirectToPath = getCurrentNormalisedUrlPathWithQueryParams(); + queryParams.redirectToPath = getCurrentNormalisedUrlPathWithQueryParamsAndFragments(); } let redirectUrl = await this.getRedirectUrl( diff --git a/lib/ts/utils.ts b/lib/ts/utils.ts index 71de1a53a..8928c857c 100644 --- a/lib/ts/utils.ts +++ b/lib/ts/utils.ts @@ -72,26 +72,35 @@ export function getURLHash(): string { } export function getRedirectToPathFromURL(): string | undefined { - const param = getQueryParams("redirectToPath"); - if (param === null) { + const redirectToPath = getQueryParams("redirectToPath"); + if (redirectToPath === null) { return undefined; } else { - // Prevent Open redirects by normalising path. try { - const normalisedURLPath = new NormalisedURLPath(param).getAsStringDangerous(); - const pathQueryParams = param.split("?")[1] !== undefined ? `?${param.split("?")[1]}` : ""; - const pathWithQueryParams = normalisedURLPath + pathQueryParams; + let url: URL; + try { + url = new URL(redirectToPath); + } catch (error) { + const fakeDomain = redirectToPath.startsWith("/") ? "http://localhost" : "http://localhost/"; + url = new URL(`${fakeDomain}${redirectToPath}`); + } - // Ensure a leading "/" if `normalisedUrlPath` is empty but `pathWithQueryParams` is not to ensure proper redirection. + // Prevent Open redirects by normalising path. + const normalisedURLPath = new NormalisedURLPath(redirectToPath).getAsStringDangerous(); + const pathQueryParams = url.search || ""; // url.search contains the leading ? + const pathHash = url.hash || ""; // url.hash contains the leading # + const pathWithQueryParamsAndHash = normalisedURLPath + pathQueryParams + pathHash; + + // Ensure a leading "/" if `normalisedUrlPath` is empty but `pathWithQueryParamsAndHash` is not to ensure proper redirection. // Example: "?test=1" will not redirect the user to `/?test=1` if we don't add a leading "/". if ( normalisedURLPath.length === 0 && - pathWithQueryParams.length > 0 && - !pathWithQueryParams.startsWith("/") + pathWithQueryParamsAndHash.length > 0 && + !pathWithQueryParamsAndHash.startsWith("/") ) { - return "/" + pathWithQueryParams; + return "/" + pathWithQueryParamsAndHash; } - return pathWithQueryParams; + return pathWithQueryParamsAndHash; } catch { return undefined; } @@ -200,9 +209,13 @@ export function getCurrentNormalisedUrlPath(): NormalisedURLPath { return new NormalisedURLPath(WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getPathName()); } -export function getCurrentNormalisedUrlPathWithQueryParams(): string { +export function getCurrentNormalisedUrlPathWithQueryParamsAndFragments(): string { const normalisedUrlPath = getCurrentNormalisedUrlPath().getAsStringDangerous(); - return normalisedUrlPath + WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getSearch(); + return ( + normalisedUrlPath + + WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getSearch() + + WindowHandlerReference.getReferenceOrThrow().windowHandler.location.getHash() + ); } export function appendQueryParamsToURL(stringUrl: string, queryParams?: Record): string { @@ -217,7 +230,7 @@ export function appendQueryParamsToURL(stringUrl: string, queryParams?: Record { url.searchParams.set(key, value); diff --git a/lib/ts/version.ts b/lib/ts/version.ts index cb781217f..ad585aa89 100644 --- a/lib/ts/version.ts +++ b/lib/ts/version.ts @@ -12,4 +12,4 @@ * License for the specific language governing permissions and limitations * under the License. */ -export const package_version = "0.37.1"; +export const package_version = "0.38.0"; diff --git a/package-lock.json b/package-lock.json index 4bf0832a8..bbf11a832 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "supertokens-auth-react", - "version": "0.37.1", + "version": "0.38.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "supertokens-auth-react", - "version": "0.37.1", + "version": "0.38.0", "license": "Apache-2.0", "dependencies": { "intl-tel-input": "^17.0.19", diff --git a/package.json b/package.json index b261818d1..51b359a5a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "supertokens-auth-react", - "version": "0.37.1", + "version": "0.38.0", "description": "ReactJS SDK that provides login functionality with SuperTokens.", "main": "./index.js", "engines": { diff --git a/test/end-to-end/emailverification.test.js b/test/end-to-end/emailverification.test.js index c50489607..19f90eda6 100644 --- a/test/end-to-end/emailverification.test.js +++ b/test/end-to-end/emailverification.test.js @@ -313,6 +313,67 @@ describe("SuperTokens Email Verification", function () { assert.deepStrictEqual(urlWithQP, "/?foo=bar"); }); + it("Should redirect to verify email screen on successful sign up when mode is REQUIRED and email is not verified and then post verification should redirect with original redirectPath (query params + fragment) and newUser", async function () { + await Promise.all([ + page.goto( + `${TEST_CLIENT_BASE_URL}/auth?redirectToPath=${encodeURIComponent( + "/redirect-here?foo=bar#cell=4,1-6,2" + )}` + ), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + await toggleSignInSignUp(page); + const { fieldValues, postValues } = getDefaultSignUpFieldValues({ email: getTestEmail() }); + await signUp(page, fieldValues, postValues, "emailpassword"); + + let pathname = await page.evaluate(() => window.location.pathname); + assert.deepStrictEqual(pathname, "/auth/verify-email"); + + // we wait for email to be created + await new Promise((r) => setTimeout(r, 1000)); + + // we fetch the email verification link and go to that + const latestURLWithToken = await getLatestURLWithToken(); + await Promise.all([page.waitForNavigation({ waitUntil: "networkidle0" }), page.goto(latestURLWithToken)]); + + // click on the continue button + await Promise.all([submitForm(page), page.waitForNavigation({ waitUntil: "networkidle0" })]); + + const urlWithQP = await page.evaluate( + () => window.location.pathname + window.location.search + window.location.hash + ); + assert.deepStrictEqual(urlWithQP, "/redirect-here?foo=bar#cell=4,1-6,2"); + }); + + it("Should redirect to verify email screen on successful sign up when mode is REQUIRED and email is not verified and then post verification should redirect with original redirectPath (only fragment) and newUser", async function () { + await Promise.all([ + page.goto(`${TEST_CLIENT_BASE_URL}/auth?redirectToPath=${encodeURIComponent("#cell=4,1-6,2")}`), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + await toggleSignInSignUp(page); + const { fieldValues, postValues } = getDefaultSignUpFieldValues({ email: getTestEmail() }); + await signUp(page, fieldValues, postValues, "emailpassword"); + + let pathname = await page.evaluate(() => window.location.pathname); + assert.deepStrictEqual(pathname, "/auth/verify-email"); + + // we wait for email to be created + await new Promise((r) => setTimeout(r, 1000)); + + // we fetch the email verification link and go to that + const latestURLWithToken = await getLatestURLWithToken(); + await Promise.all([page.waitForNavigation({ waitUntil: "networkidle0" }), page.goto(latestURLWithToken)]); + + // click on the continue button + await Promise.all([submitForm(page), page.waitForNavigation({ waitUntil: "networkidle0" })]); + + // check that we are in /#cell=4,1-6,2 + const urlWithQP = await page.evaluate( + () => window.location.pathname + window.location.search + window.location.hash + ); + assert.deepStrictEqual(urlWithQP, "/#cell=4,1-6,2"); + }); + it("Should redirect to verify email screen on successful sign in when mode is REQUIRED and email is not verified", async function () { await Promise.all([ page.goto(`${TEST_CLIENT_BASE_URL}/auth?mode=REQUIRED`), diff --git a/test/end-to-end/passwordless.test.js b/test/end-to-end/passwordless.test.js index 153fcab23..6eb711fb0 100644 --- a/test/end-to-end/passwordless.test.js +++ b/test/end-to-end/passwordless.test.js @@ -805,6 +805,58 @@ export function getPasswordlessTestCases({ authRecipe, logId, generalErrorRecipe assert.deepStrictEqual(pathname + search, "/?foo=bar"); }); + it("Successful signin w/ redirectPath (query params + fragment)", async function () { + await Promise.all([ + page.goto( + `${TEST_CLIENT_BASE_URL}/auth?mode=REQUIRED&redirectToPath=${encodeURIComponent( + "/redirect-here?foo=bar#cell=4,1-6,2" + )}` + ), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + + await setInputValues(page, [{ name: inputName, value: contactInfo }]); + await submitForm(page); + + await waitForSTElement(page, "[data-supertokens~=input][name=userInputCode]"); + + const loginAttemptInfo = JSON.parse( + await page.evaluate(() => localStorage.getItem("supertokens-passwordless-loginAttemptInfo")) + ); + const device = await getPasswordlessDevice(loginAttemptInfo); + await setInputValues(page, [{ name: "userInputCode", value: device.codes[0].userInputCode }]); + await submitForm(page); + + await page.waitForNavigation({ waitUntil: "networkidle0" }); + + const { pathname, search, hash } = await page.evaluate(() => window.location); + assert.deepStrictEqual(pathname + search + hash, "/redirect-here?foo=bar#cell=4,1-6,2"); + }); + + it("Successful signin w/ redirectPath (only fragment)", async function () { + await Promise.all([ + page.goto(`${TEST_CLIENT_BASE_URL}/auth?redirectToPath=${encodeURIComponent("#cell=4,1-6,2")}`), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + + await setInputValues(page, [{ name: inputName, value: contactInfo }]); + await submitForm(page); + + await waitForSTElement(page, "[data-supertokens~=input][name=userInputCode]"); + + const loginAttemptInfo = JSON.parse( + await page.evaluate(() => localStorage.getItem("supertokens-passwordless-loginAttemptInfo")) + ); + const device = await getPasswordlessDevice(loginAttemptInfo); + await setInputValues(page, [{ name: "userInputCode", value: device.codes[0].userInputCode }]); + await submitForm(page); + + await page.waitForNavigation({ waitUntil: "networkidle0" }); + + const { pathname, search, hash } = await page.evaluate(() => window.location); + assert.deepStrictEqual(pathname + search + hash, "/#cell=4,1-6,2"); + }); + it("Submitting empty id", async function () { await Promise.all([ page.goto(`${TEST_CLIENT_BASE_URL}/auth`), @@ -1317,6 +1369,29 @@ export function getPasswordlessTestCases({ authRecipe, logId, generalErrorRecipe ]); }); + it("Successful signin w/ stored redirectToPath (only fragment) and email verification", async function () { + await Promise.all([ + page.goto(`${TEST_CLIENT_BASE_URL}/auth?redirectToPath=${encodeURIComponent("#cell=4,1-6,2")}`), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + await setInputValues(page, [{ name: inputName, value: contactInfo }]); + await submitForm(page); + + await waitForSTElement(page, "[data-supertokens~=sendCodeIcon]"); + + const loginAttemptInfo = JSON.parse( + await page.evaluate(() => localStorage.getItem("supertokens-passwordless-loginAttemptInfo")) + ); + const device = await getPasswordlessDevice(loginAttemptInfo); + await page.goto(device.codes[0].urlWithLinkCode); + await page.waitForNavigation({ waitUntil: "networkidle0" }); + + const urlWithHash = await page.evaluate( + () => window.location.pathname + window.location.search + window.location.hash + ); + assert.deepStrictEqual(urlWithHash, "/#cell=4,1-6,2"); + }); + it("create code general error", async function () { const _isGeneralErrorSupported = await isGeneralErrorSupported(); if (!_isGeneralErrorSupported) { diff --git a/test/end-to-end/signin.test.js b/test/end-to-end/signin.test.js index b37f5f32a..cd1698984 100644 --- a/test/end-to-end/signin.test.js +++ b/test/end-to-end/signin.test.js @@ -589,6 +589,52 @@ describe("SuperTokens SignIn", function () { assert.deepStrictEqual(pathname + search, "/?foo=bar"); }); + it("Successful emailPassword Sign In with redirectToPath (query params + fragment)", async function () { + await Promise.all([ + page.goto( + `${TEST_CLIENT_BASE_URL}/auth?redirectToPath=${encodeURIComponent( + "/redirect-here?foo=bar#cell=4,1-6,2" + )}` + ), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + + // Set correct values. + await setInputValues(page, [ + { name: "email", value: "john.doe@supertokens.io" }, + { name: "password", value: "Str0ngP@ssw0rd" }, + ]); + + // Submit. + await Promise.all([ + submitFormReturnRequestAndResponse(page, SIGN_IN_API), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + const { pathname, search, hash } = await page.evaluate(() => window.location); + assert.deepStrictEqual(pathname + search + hash, "/redirect-here?foo=bar#cell=4,1-6,2"); + }); + + it("Successful emailPassword Sign In with redirectToPath (only fragment)", async function () { + await Promise.all([ + page.goto(`${TEST_CLIENT_BASE_URL}/auth?redirectToPath=${encodeURIComponent("#cell=4,1-6,2")}`), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + + // Set correct values. + await setInputValues(page, [ + { name: "email", value: "john.doe@supertokens.io" }, + { name: "password", value: "Str0ngP@ssw0rd" }, + ]); + + // Submit. + await Promise.all([ + submitFormReturnRequestAndResponse(page, SIGN_IN_API), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + const { pathname, search, hash } = await page.evaluate(() => window.location); + assert.deepStrictEqual(pathname + search + hash, "/#cell=4,1-6,2"); + }); + describe("Successful Sign In with redirect to, with EmailPasswordAuth", async function () { it("First sign in", async function () { consoleLogs = await clearBrowserCookiesWithoutAffectingConsole(page, consoleLogs); diff --git a/test/end-to-end/signup.test.js b/test/end-to-end/signup.test.js index ddfd233f9..5a60ce3fb 100644 --- a/test/end-to-end/signup.test.js +++ b/test/end-to-end/signup.test.js @@ -142,11 +142,11 @@ describe("SuperTokens SignUp", function () { const url = new URL(hrefAfterRedirectToAuth); const redirectToPath = url.searchParams.get("redirectToPath"); - assert.equal(pathAfterRedirectToAuth, "/auth/"); + assert.strictEqual(pathAfterRedirectToAuth, "/auth/"); // Only the EmailPassword recipe has this header on the sign in page assert.deepStrictEqual(text, "Sign In"); // Test that redirecToPath contains query params - assert.equal(redirectToPath, "?authRecipe=both"); + assert.strictEqual(redirectToPath, "?authRecipe=both"); }); it("should redirect to sign in w/ first auth recipe without setting redirectToPath", async function () { @@ -164,11 +164,57 @@ describe("SuperTokens SignUp", function () { const url = new URL(hrefAfterRedirectToAuth); const redirectToPath = url.searchParams.get("redirectToPath"); - assert.equal(pathAfterRedirectToAuth, "/auth/"); + assert.strictEqual(pathAfterRedirectToAuth, "/auth/"); // Only the EmailPassword recipe has this header on the sign in page assert.deepStrictEqual(text, "Sign In"); // Test that redirecToPath is null - assert.equal(redirectToPath, null); + assert.strictEqual(redirectToPath, null); + }); + + it("should redirect to sign in w/ first auth recipe and set redirectToPath (query params + fragment)", async function () { + await Promise.all([ + page.goto(`${TEST_CLIENT_BASE_URL}?authRecipe=both#cell=4,1-6,2`), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + await page.evaluate(() => window.SuperTokens.redirectToAuth({ redirectBack: true })); + await page.waitForNavigation({ waitUntil: "networkidle0" }); + let text = await getAuthPageHeaderText(page); + let { pathname: pathAfterRedirectToAuth, href: hrefAfterRedirectToAuth } = await page.evaluate( + () => window.location + ); + + const url = new URL(hrefAfterRedirectToAuth); + const redirectToPath = url.searchParams.get("redirectToPath"); + + assert.strictEqual(pathAfterRedirectToAuth, "/auth/"); + // Only the EmailPassword recipe has this header on the sign in page + assert.deepStrictEqual(text, "Sign In"); + // Test that redirecToPath contains query params and the fragment + assert.strictEqual(redirectToPath, "?authRecipe=both#cell=4,1-6,2"); + }); + + it("should redirect to sign in w/ first auth recipe and set redirectToPath (only fragment)", async function () { + // Sets the authRecipe to both in localStorage + await page.goto(`${TEST_CLIENT_BASE_URL}?authRecipe=both`); + await Promise.all([ + page.goto(`${TEST_CLIENT_BASE_URL}#cell=4,1-6,2`), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + await page.evaluate(() => window.SuperTokens.redirectToAuth({ redirectBack: true })); + await page.waitForNavigation({ waitUntil: "networkidle0" }); + let text = await getAuthPageHeaderText(page); + let { pathname: pathAfterRedirectToAuth, href: hrefAfterRedirectToAuth } = await page.evaluate( + () => window.location + ); + + const url = new URL(hrefAfterRedirectToAuth); + const redirectToPath = url.searchParams.get("redirectToPath"); + + assert.strictEqual(pathAfterRedirectToAuth, "/auth/"); + // Only the EmailPassword recipe has this header on the sign in page + assert.deepStrictEqual(text, "Sign In"); + // Test that redirecToPath contains url fragment + assert.strictEqual(redirectToPath, "#cell=4,1-6,2"); }); }); diff --git a/test/end-to-end/thirdparty.test.js b/test/end-to-end/thirdparty.test.js index 68f7c1b38..5f6dd70bd 100644 --- a/test/end-to-end/thirdparty.test.js +++ b/test/end-to-end/thirdparty.test.js @@ -166,6 +166,40 @@ export function getThirdPartyTestCases({ authRecipe, rid, logId, signInUpPageLoa assert.deepStrictEqual(pathname + search, "/?foo=bar"); }); + it("Successful sign in with Auth0 with redirectToPath (query params + fragment)", async function () { + await Promise.all([ + page.goto( + `${TEST_CLIENT_BASE_URL}/auth?redirectToPath=${encodeURIComponent( + "/redirect-here?foo=bar#cell=4,1-6,2" + )}` + ), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + await assertProviders(page); + await clickOnProviderButton(page, "Auth0"); + await Promise.all([ + loginWithAuth0(page), + page.waitForResponse((response) => response.url() === SIGN_IN_UP_API && response.status() === 200), + ]); + const { pathname, search, hash } = await page.evaluate(() => window.location); + assert.deepStrictEqual(pathname + search + hash, "/redirect-here?foo=bar#cell=4,1-6,2"); + }); + + it("Successful sign in with Auth0 with redirectToPath (only fragment)", async function () { + await Promise.all([ + page.goto(`${TEST_CLIENT_BASE_URL}/auth?redirectToPath=${encodeURIComponent("#cell=4,1-6,2")}`), + page.waitForNavigation({ waitUntil: "networkidle0" }), + ]); + await assertProviders(page); + await clickOnProviderButton(page, "Auth0"); + await Promise.all([ + loginWithAuth0(page), + page.waitForResponse((response) => response.url() === SIGN_IN_UP_API && response.status() === 200), + ]); + const { pathname, search, hash } = await page.evaluate(() => window.location); + assert.deepStrictEqual(pathname + search + hash, "/#cell=4,1-6,2"); + }); + it("Successful signin with Auth0 and email verification", async function () { await Promise.all([ page.goto(`${TEST_CLIENT_BASE_URL}/auth?mode=REQUIRED`),