@imtbl/auth 2.10.7-alpha.2

package/src/types.ts

@@ -0,0 +1,128 @@
+/**
+ * Direct login method identifier
+ * Known providers: 'google', 'apple', 'facebook'
+ * Additional providers may be supported server-side
+ */
+export type DirectLoginMethod = string;
+
+export type UserProfile = {
+  email?: string;
+  nickname?: string;
+  sub: string;
+};
+
+export enum RollupType {
+  IMX = 'imx',
+  ZKEVM = 'zkEvm',
+}
+
+export type User = {
+  idToken?: string;
+  accessToken: string;
+  refreshToken?: string;
+  profile: UserProfile;
+  expired?: boolean;
+  [RollupType.IMX]?: {
+    ethAddress: string;
+    starkAddress: string;
+    userAdminAddress: string;
+  };
+  [RollupType.ZKEVM]?: {
+    ethAddress: string;
+    userAdminAddress: string;
+  };
+};
+
+export type PassportMetadata = {
+  imx_eth_address: string;
+  imx_stark_address: string;
+  imx_user_admin_address: string;
+  zkevm_eth_address: string;
+  zkevm_user_admin_address: string;
+};
+
+export interface OidcConfiguration {
+  clientId: string;
+  logoutRedirectUri?: string;
+  logoutMode?: 'redirect' | 'silent';
+  redirectUri: string;
+  popupRedirectUri?: string;
+  scope?: string;
+  audience?: string;
+}
+
+export interface PopupOverlayOptions {
+  disableGenericPopupOverlay?: boolean;
+  disableBlockedPopupOverlay?: boolean;
+  disableHeadlessLoginPromptOverlay?: boolean;
+}
+
+export interface AuthModuleConfiguration extends OidcConfiguration {
+  /**
+   * Authentication domain (e.g., 'https://auth.immutable.com')
+   */
+  authenticationDomain?: string;
+
+  /**
+   * Passport domain for confirmation screens (e.g., 'https://passport.immutable.com')
+   */
+  passportDomain?: string;
+
+  /**
+   * This flag indicates that Auth is being used in a cross-sdk bridge scenario
+   * and not directly on the web.
+   */
+  crossSdkBridgeEnabled?: boolean;
+
+  /**
+   * Options for customizing popup overlays
+   */
+  popupOverlayOptions?: PopupOverlayOptions;
+}
+
+type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };
+
+export type UserImx = WithRequired<User, RollupType.IMX>;
+export type UserZkEvm = WithRequired<User, RollupType.ZKEVM>;
+
+export const isUserZkEvm = (user: User): user is UserZkEvm => !!user[RollupType.ZKEVM];
+export const isUserImx = (user: User): user is UserImx => !!user[RollupType.IMX];
+
+export type DeviceTokenResponse = {
+  access_token: string;
+  refresh_token?: string;
+  id_token: string;
+  token_type: string;
+  expires_in: number;
+};
+
+export type TokenPayload = {
+  exp?: number;
+};
+
+export type IdTokenPayload = {
+  passport?: PassportMetadata;
+  email: string;
+  nickname: string;
+  aud: string;
+  sub: string;
+  exp: number;
+  iss: string;
+  iat: number;
+};
+
+export type PKCEData = {
+  state: string;
+  verifier: string;
+};
+
+export enum MarketingConsentStatus {
+  OptedIn = 'opted_in',
+  Unsubscribed = 'unsubscribed',
+}
+
+export type DirectLoginOptions = {
+  directLoginMethod: DirectLoginMethod;
+  marketingConsentStatus?: MarketingConsentStatus;
+  email?: string;
+};

package/src/utils/logger.ts

@@ -0,0 +1,15 @@
+const warn = (...args: any[]) => {
+  if (typeof process === 'undefined') {
+    return;
+  }
+
+  const shouldLog: boolean = process?.env?.JEST_WORKER_ID === undefined;
+  if (shouldLog) {
+    // eslint-disable-next-line no-console
+    console.warn(...args);
+  }
+};
+
+export default {
+  warn,
+};

package/src/utils/token.ts

@@ -0,0 +1,35 @@
+import jwt_decode from 'jwt-decode';
+import {
+  User as OidcUser,
+} from 'oidc-client-ts';
+import { IdTokenPayload, TokenPayload } from '../types';
+
+function isTokenExpiredOrExpiring(token: string): boolean {
+  try {
+    // try to decode the token as access token payload or id token payload
+    const decodedToken = jwt_decode<TokenPayload | IdTokenPayload>(token);
+    const now = Math.floor(Date.now() / 1000);
+
+    // Tokens without expiration claims are invalid (security vulnerability)
+    if (!decodedToken.exp) {
+      return true;
+    }
+
+    // Check if token is expired or expiring in 30 seconds or less
+    return decodedToken.exp <= now + 30;
+  } catch (error) {
+    // If we can't decode the token, assume it's invalid
+    return true;
+  }
+}
+
+export function isAccessTokenExpiredOrExpiring(oidcUser: OidcUser): boolean {
+  const { id_token: idToken, access_token: accessToken } = oidcUser;
+
+  if (!accessToken || !idToken) {
+    return true;
+  }
+
+  // Check if either token is expired or expiring
+  return isTokenExpiredOrExpiring(accessToken) || isTokenExpiredOrExpiring(idToken);
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDirs": ["src"],
+    "customConditions": ["development"],
+    "types": ["node"]
+  },
+  "include": ["src", "src/types.ts"],
+  "exclude": [
+    "node_modules",
+    "dist",
+  ]
+}
+