@authorizerdev/authorizer-js 1.1.5 → 1.2.0-beta.0

package/README.md

@@ -18,17 +18,17 @@ All the above versions require `Authorizer` instance to be instantiated and used
 
 ```js
 const authRef = new Authorizer({
-	authorizerURL: 'https://app.herokuapp.com',
-	redirectURL: window.location.origin,
-});
+  authorizerURL: 'https://app.herokuapp.com',
+  redirectURL: window.location.origin,
+})
 ```
 
-## UMD
+## IIFE
 
 - Step 1: Load Javascript using CDN
 
 ```html
-<script src="https://unpkg.com/@authorizerdev/authorizer-js/lib/authorizer.min.js"></script>
+<script src="https://unpkg.com/@authorizerdev/authorizer-js/dist/index.global.js"></script>
 ```
 
 - Step 2: Use the library to instantiate `Authorizer` instance and access [various methods](/authorizer-js/functions)
@@ -80,18 +80,18 @@ yarn add @authorizerdev/authoirzer-js
 - Step 2: Import and initialize the authorizer instance
 
 ```js
-const { Authorizer } = require('@authorizerdev/authoirzer-js');
+const { Authorizer } = require('@authorizerdev/authoirzer-js')
 
 const authRef = new Authorizer({
-	authorizerURL: 'https://app.heroku.com',
-	redirectURL: 'http://app.heroku.com/app',
-});
+  authorizerURL: 'https://app.heroku.com',
+  redirectURL: 'http://app.heroku.com/app',
+})
 
 async function main() {
-	await authRef.login({
-		email: 'foo@bar.com',
-		password: 'test',
-	});
+  await authRef.login({
+    email: 'foo@bar.com',
+    password: 'test',
+  })
 }
 ```
 
@@ -108,18 +108,18 @@ yarn add @authorizerdev/authorizer-js
 - Step 2: Import and initialize the authorizer instance
 
 ```js
-import { Authorizer } from '@authorizerdev/authorizer-js';
+import { Authorizer } from '@authorizerdev/authorizer-js'
 
 const authRef = new Authorizer({
-	authorizerURL: 'https://app.heroku.com',
-	redirectURL: 'http://app.heroku.com/app',
-});
+  authorizerURL: 'https://app.heroku.com',
+  redirectURL: 'http://app.heroku.com/app',
+})
 
 async function main() {
-	await authRef.login({
-		email: 'foo@bar.com',
-		password: 'test',
-	});
+  await authRef.login({
+    email: 'foo@bar.com',
+    password: 'test',
+  })
 }
 ```
 
@@ -135,3 +135,7 @@ async function main() {
 - Install dependencies using `pnpm install`
 - Run `pnpm build` to build the library
 - Run `pnpm test` to run the tests
+
+
+### Release
+- Run `pnpm release` to release a new version of the library

package/{lib/cjs/types.d.ts → dist/index.d.ts}

@@ -1,10 +1,10 @@
-export type ConfigType = {
+interface ConfigType {
     authorizerURL: string;
     redirectURL: string;
     clientID: string;
     extraHeaders?: Record<string, string>;
-};
-export type User = {
+}
+interface User {
     id: string;
     email: string;
     preferred_username: string;
@@ -23,8 +23,8 @@ export type User = {
     created_at: number;
     updated_at: number;
     is_multi_factor_auth_enabled?: boolean;
-};
-export type AuthToken = {
+}
+interface AuthToken {
     message?: string;
     access_token: string;
     expires_in: number;
@@ -32,19 +32,19 @@ export type AuthToken = {
     refresh_token?: string;
     user?: User;
     should_show_otp_screen?: boolean;
-};
-export type Response = {
+}
+interface Response {
     message: string;
-};
-export type Headers = Record<string, string>;
-export type LoginInput = {
+}
+type Headers = Record<string, string>;
+interface LoginInput {
     email: string;
     password: string;
     roles?: string[];
     scope?: string[];
     state?: string;
-};
-export type SignupInput = {
+}
+interface SignupInput {
     email: string;
     password: string;
     confirm_password: string;
@@ -61,32 +61,32 @@ export type SignupInput = {
     redirect_uri?: string;
     is_multi_factor_auth_enabled?: boolean;
     state?: string;
-};
-export type MagicLinkLoginInput = {
+}
+interface MagicLinkLoginInput {
     email: string;
     roles?: string[];
     scopes?: string[];
     state?: string;
     redirect_uri?: string;
-};
-export type VerifyEmailInput = {
+}
+interface VerifyEmailInput {
     token: string;
     state?: string;
-};
-export type VerifyOtpInput = {
+}
+interface VerifyOtpInput {
     email: string;
     otp: string;
     state?: string;
-};
-export type ResendOtpInput = {
+}
+interface ResendOtpInput {
     email: string;
-};
-export type GraphqlQueryInput = {
+}
+interface GraphqlQueryInput {
     query: string;
     variables?: Record<string, any>;
     headers?: Headers;
-};
-export type MetaData = {
+}
+interface MetaData {
     version: string;
     client_id: string;
     is_google_login_enabled: boolean;
@@ -101,8 +101,8 @@ export type MetaData = {
     is_magic_link_login_enabled: boolean;
     is_sign_up_enabled: boolean;
     is_strong_password_enabled: boolean;
-};
-export type UpdateProfileInput = {
+}
+interface UpdateProfileInput {
     old_password?: string;
     new_password?: string;
     confirm_new_password?: string;
@@ -116,70 +116,100 @@ export type UpdateProfileInput = {
     phone_number?: string;
     picture?: string;
     is_multi_factor_auth_enabled?: boolean;
-};
-export type ForgotPasswordInput = {
+}
+interface ForgotPasswordInput {
     email: string;
     state?: string;
     redirect_uri?: string;
-};
-export type ResetPasswordInput = {
+}
+interface ResetPasswordInput {
     token: string;
     password: string;
     confirm_password: string;
-};
-export type SessionQueryInput = {
+}
+interface SessionQueryInput {
     roles?: string[];
-};
-export type IsValidJWTQueryInput = {
+}
+interface IsValidJWTQueryInput {
     jwt: string;
     roles?: string[];
-};
-export type ValidJWTResponse = {
+}
+interface ValidJWTResponse {
     valid: string;
     message: string;
-};
-export declare enum OAuthProviders {
+}
+declare enum OAuthProviders {
     Apple = "apple",
     Github = "github",
     Google = "google",
     Facebook = "facebook",
     LinkedIn = "linkedin"
 }
-export declare enum ResponseTypes {
+declare enum ResponseTypes {
     Code = "code",
     Token = "token"
 }
-export type AuthorizeInput = {
+interface AuthorizeInput {
     response_type: ResponseTypes;
     use_refresh_token?: boolean;
     response_mode?: string;
-};
-export type AuthorizeResponse = {
+}
+interface AuthorizeResponse {
     state: string;
     code?: string;
     error?: string;
     error_description?: string;
-};
-export type RevokeTokenInput = {
+}
+interface RevokeTokenInput {
     refresh_token: string;
-};
-export type GetTokenInput = {
+}
+interface GetTokenInput {
     code?: string;
     grant_type?: string;
     refresh_token?: string;
-};
-export type GetTokenResponse = {
+}
+interface GetTokenResponse {
     access_token: string;
     expires_in: number;
     id_token: string;
     refresh_token?: string;
-};
-export type ValidateJWTTokenInput = {
+}
+interface ValidateJWTTokenInput {
     token_type: 'access_token' | 'id_token' | 'refresh_token';
     token: string;
     roles?: string[];
-};
-export type ValidateJWTTokenResponse = {
+}
+interface ValidateJWTTokenResponse {
     is_valid: boolean;
     claims: Record<string, any>;
-};
+}
+
+declare class Authorizer {
+    config: ConfigType;
+    codeVerifier: string;
+    constructor(config: ConfigType);
+    authorize: (data: AuthorizeInput) => Promise<GetTokenResponse | AuthorizeResponse | undefined>;
+    browserLogin: () => Promise<AuthToken | void>;
+    forgotPassword: (data: ForgotPasswordInput) => Promise<Response | void>;
+    getMetaData: () => Promise<MetaData | void>;
+    getProfile: (headers?: Headers) => Promise<User | void>;
+    getSession: (headers?: Headers, params?: SessionQueryInput) => Promise<AuthToken>;
+    getToken: (data: GetTokenInput) => Promise<GetTokenResponse>;
+    graphqlQuery: (data: GraphqlQueryInput) => Promise<any>;
+    login: (data: LoginInput) => Promise<AuthToken | void>;
+    logout: (headers?: Headers) => Promise<Response | void>;
+    magicLinkLogin: (data: MagicLinkLoginInput) => Promise<Response>;
+    oauthLogin: (oauthProvider: string, roles?: string[], redirect_uri?: string, state?: string) => Promise<void>;
+    resendOtp: (data: ResendOtpInput) => Promise<Response | void>;
+    resetPassword: (data: ResetPasswordInput) => Promise<Response | void>;
+    revokeToken: (data: {
+        refresh_token: string;
+    }) => Promise<any>;
+    signup: (data: SignupInput) => Promise<AuthToken | void>;
+    updateProfile: (data: UpdateProfileInput, headers?: Headers) => Promise<Response | void>;
+    validateJWTToken: (params?: ValidateJWTTokenInput) => Promise<ValidateJWTTokenResponse>;
+    verifyEmail: (data: VerifyEmailInput) => Promise<AuthToken | void>;
+    verifyOtp: (data: VerifyOtpInput) => Promise<AuthToken | void>;
+}
+
+export { AuthToken, AuthorizeInput, AuthorizeResponse, Authorizer, ConfigType, ForgotPasswordInput, GetTokenInput, GetTokenResponse, GraphqlQueryInput, Headers, IsValidJWTQueryInput, LoginInput, MagicLinkLoginInput, MetaData, OAuthProviders, ResendOtpInput, ResetPasswordInput, Response, ResponseTypes, RevokeTokenInput, SessionQueryInput, SignupInput, UpdateProfileInput, User, ValidJWTResponse, ValidateJWTTokenInput, ValidateJWTTokenResponse, VerifyEmailInput, VerifyOtpInput };