{"id":18101,"library":"amazon-cognito-auth-js-promises","title":"Amazon Cognito Auth JS Promises","description":"Wrapper around amazon-cognito-auth-js providing Promise-based APIs for Cognito User Pools authentication in browser apps. Version 1.1.5 (last release Feb 2020) is stable but unmaintained. It supports sign-up, sign-in, sign-out, and token management via OAuth2 flows. Compared to the newer @aws-amplify/auth or amazon-cognito-identity-js, this package offers a lighter, promise-based interface but lacks ongoing updates and TypeScript types. Requires a User Pool App Client ID, App Web Domain, and scope array configured in AWS Console.","status":"deprecated","version":"1.1.5","language":"javascript","source_language":"en","source_url":"https://github.com/chamathsilva/amazon-cognito-auth-js","tags":["javascript","amazon","aws","cognito","auth","Promise"],"install":[{"cmd":"npm install amazon-cognito-auth-js-promises","lang":"bash","label":"npm"},{"cmd":"yarn add amazon-cognito-auth-js-promises","lang":"bash","label":"yarn"},{"cmd":"pnpm add amazon-cognito-auth-js-promises","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"This package wraps the Cognito Auth SDK; it is a direct dependency.","package":"amazon-cognito-auth-js","optional":false}],"imports":[{"note":"ES module import is preferred; CommonJS require works but must access .CognitoAuth.","wrong":"const CognitoAuth = require('amazon-cognito-auth-js-promises').CognitoAuth","symbol":"CognitoAuth","correct":"import { CognitoAuth } from 'amazon-cognito-auth-js-promises'"},{"note":"Direct require returns the module object, not CognitoAuth class.","wrong":"const CognitoAuth = require('amazon-cognito-auth-js-promises')","symbol":"CognitoAuth","correct":"const { CognitoAuth } = require('amazon-cognito-auth-js-promises')"},{"note":"Default import is an object containing all exports; not recommended.","wrong":"import { default } from 'amazon-cognito-auth-js-promises'","symbol":"default","correct":"import AmazonCognitoIdentity from 'amazon-cognito-auth-js-promises'"}],"quickstart":{"code":"import { CognitoAuth } from 'amazon-cognito-auth-js-promises';\n\nconst auth = new CognitoAuth({\n  ClientId: process.env.COGNITO_CLIENT_ID ?? '',\n  AppWebDomain: process.env.COGNITO_DOMAIN ?? '',\n  TokenScopesArray: ['openid', 'email', 'profile'],\n  RedirectUriSignIn: process.env.COGNITO_REDIRECT_SIGN_IN ?? '',\n  RedirectUriSignOut: process.env.COGNITO_REDIRECT_SIGN_OUT ?? '',\n  IdentityProvider: '',\n  UserPoolId: process.env.COGNITO_USER_POOL_ID ?? '',\n  AdvancedSecurityDataCollectionFlag: true,\n});\n\nauth.getSession()\n  .then(session => console.log(session))\n  .catch(err => console.error(err));","lang":"javascript","description":"Creates a CognitoAuth instance with environment variables and initiates a login session using promises."},"warnings":[{"fix":"Replace with @aws-amplify/auth: npm install @aws-amplify/auth","message":"Package is not actively maintained; no updates since February 2020. Consider migrating to @aws-amplify/auth or amazon-cognito-identity-js.","severity":"deprecated","affected_versions":">=0.0.0"},{"fix":"Add 'openid' to TokenScopesArray.","message":"Token scopes must include 'openid' for ID token to be returned. Missing 'openid' may cause silent failures.","severity":"gotcha","affected_versions":">=0.0.0"},{"fix":"Use the promise-based method names as documented; avoid the old 'Async' suffix.","message":"In v1.1.0, the promise methods were renamed (e.g., getSession vs getSessionAsync) – check the changelog if upgrading from earlier versions.","severity":"breaking","affected_versions":">=1.1.0"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"npm install amazon-cognito-auth-js","cause":"Missing peer dependency amazon-cognito-auth-js.","error":"Cannot find module 'amazon-cognito-auth-js'"},{"fix":"const { CognitoAuth } = require('amazon-cognito-auth-js-promises'); then const auth = new CognitoAuth(...);","cause":"Using CommonJS require without accessing .CognitoAuth property.","error":"TypeError: auth.getSession is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}