@multiplatform.one/keycloak 6.1.0 → 6.4.0

package/types/token.d.ts

@@ -0,0 +1,129 @@
+import type { KeycloakTokenParsed } from "@multiplatform.one/keycloak-js";
+/**
+ * Wallet types supported by siwe-keycloak extension.
+ * Currently supports Ethereum wallets, with Solana and Sui planned.
+ */
+export type WalletType = "ethereum" | "solana" | "sui";
+/**
+ * Structure of wallet data within a chain type.
+ * Contains an array of wallet addresses for that chain.
+ */
+export interface WalletTypeInfo {
+    addresses: string[];
+}
+/**
+ * Map of wallet types to their wallet info.
+ * This is the structure inside token.crypto.wallets
+ */
+export interface WalletsMap {
+    [walletType: string]: WalletTypeInfo;
+}
+/**
+ * The crypto claim structure added to tokens by siwe-wallet-mapper.
+ * Contains wallet information from the siwe-keycloak extension.
+ */
+export interface CryptoClaim {
+    wallets: WalletsMap;
+}
+/**
+ * Extracts wallet addresses from a JWT token that includes the siwe-wallet-mapper claims.
+ *
+ * The siwe-keycloak extension adds a "crypto" claim with the following structure:
+ * ```json
+ * {
+ *   "crypto": {
+ *     "wallets": {
+ *       "ethereum": {
+ *         "addresses": ["0x1234...", "0x5678..."]
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param token - JWT access token or ID token string
+ * @returns Object containing wallet addresses by type, or empty object if no wallets
+ *
+ * @example
+ * ```typescript
+ * const wallets = getWalletsFromToken(accessToken);
+ * // { ethereum: { addresses: ['0x1234...'] } }
+ *
+ * const ethAddresses = wallets.ethereum?.addresses ?? [];
+ * // ['0x1234...']
+ * ```
+ */
+export declare function getWalletsFromToken(token: string): WalletsMap;
+/**
+ * Extracts all wallet addresses of a specific type from a JWT token.
+ *
+ * @param token - JWT access token or ID token string
+ * @param walletType - The wallet type to extract (e.g., "ethereum", "solana")
+ * @returns Array of wallet addresses, or empty array if none found
+ *
+ * @example
+ * ```typescript
+ * const addresses = getWalletAddresses(accessToken, 'ethereum');
+ * // ['0x1234...', '0x5678...']
+ * ```
+ */
+export declare function getWalletAddresses(token: string, walletType?: WalletType): string[];
+/**
+ * Checks if a user has any wallet addresses in their token.
+ *
+ * @param token - JWT access token or ID token string
+ * @returns true if the user has at least one wallet address
+ *
+ * @example
+ * ```typescript
+ * if (hasWallets(accessToken)) {
+ *   // User authenticated with a wallet or has registered wallets
+ * }
+ * ```
+ */
+export declare function hasWallets(token: string): boolean;
+/**
+ * Gets all wallet addresses across all chain types from a token.
+ *
+ * @param token - JWT access token or ID token string
+ * @returns Array of objects with walletType and address
+ *
+ * @example
+ * ```typescript
+ * const allWallets = getAllWalletAddresses(accessToken);
+ * // [
+ * //   { walletType: 'ethereum', address: '0x1234...' },
+ * //   { walletType: 'ethereum', address: '0x5678...' },
+ * //   { walletType: 'solana', address: 'AbCd...' }
+ * // ]
+ * ```
+ */
+export declare function getAllWalletAddresses(token: string): Array<{
+    walletType: string;
+    address: string;
+}>;
+export declare function validOrRefreshableToken(token?: string | false, refreshToken?: string | boolean): string | false | undefined;
+export declare function validOrRefreshableToken(token?: string | boolean, refreshToken?: string | boolean): string | boolean | undefined;
+export declare function isTokenExpired(token: string): boolean;
+export interface TokenParsed extends KeycloakTokenParsed {
+    jti?: string;
+    sid?: string;
+    typ?: "Bearer" | string;
+}
+/**
+ * Extended token interface that includes wallet claims from siwe-keycloak.
+ */
+export interface TokenWithWallets extends TokenParsed {
+    /**
+     * Crypto claim containing wallet addresses.
+     * Added by the siwe-wallet-mapper protocol mapper.
+     */
+    crypto?: CryptoClaim;
+}
+export interface AccessTokenParsed extends TokenWithWallets {
+    email?: string;
+    email_verified?: boolean;
+    preferred_username?: string;
+    scope?: string;
+}
+//# sourceMappingURL=token.d.ts.map

package/types/token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.d.ts","sourceRoot":"","sources":["../src/token.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAE1E;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,UAAU,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAO7D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,GAAE,UAAuB,GAAG,MAAM,EAAE,CAG/F;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAGjD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,MAAM,GACZ,KAAK,CAAC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,CAahD;AAED,wBAAgB,uBAAuB,CACrC,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,EACtB,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,GAC9B,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;AAC9B,wBAAgB,uBAAuB,CACrC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,EACxB,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,GAC9B,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAYhC,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,WAI3C;AAED,MAAM,WAAW,WAAY,SAAQ,mBAAmB;IACtD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/types/types.d.ts

@@ -0,0 +1,19 @@
+declare global {
+    interface Window {
+        ReactNativeWebView: {
+            postMessage: (body: string) => unknown;
+        };
+        webkit: {
+            messageHandlers: {
+                [key: string]: {
+                    postMessage: (body: string) => unknown;
+                };
+            };
+        };
+    }
+}
+export interface KeycloakMock {
+    email?: string;
+    username: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,kBAAkB,EAAE;YAClB,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;SACxC,CAAC;QACF,MAAM,EAAE;YACN,eAAe,EAAE;gBACf,CAAC,GAAG,EAAE,MAAM,GAAG;oBACb,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;iBACxC,CAAC;aACH,CAAC;SACH,CAAC;KACH;CACF;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB"}