web3bio-profile-kit 0.1.2 → 0.1.4

package/dist/index.js

@@ -1,425 +1,18 @@
-'use strict';
-
-var react = require('react');
-
-const API_ENDPOINT = "https://api.web3.bio";
-exports.ErrorMessages = void 0;
-(function (ErrorMessages) {
-    ErrorMessages["NOT_FOUND"] = "Not Found";
-    ErrorMessages["INVALID_RESOLVER"] = "Invalid Resolver Address";
-    ErrorMessages["INVALID_RESOLVED"] = "Invalid Resolved Address";
-    ErrorMessages["NOT_EXIST"] = "Does Not Exist";
-    ErrorMessages["INVALID_IDENTITY"] = "Invalid Identity or Domain";
-    ErrorMessages["INVALID_ADDRESS"] = "Invalid Address";
-    ErrorMessages["UNKNOWN_ERROR"] = "Unknown Error Occurred";
-    ErrorMessages["NETWORK_ERROR"] = "Network Error";
-})(exports.ErrorMessages || (exports.ErrorMessages = {}));
-exports.QueryEndpoint = void 0;
-(function (QueryEndpoint) {
-    QueryEndpoint["NS"] = "ns";
-    QueryEndpoint["PROFILE"] = "profile";
-    QueryEndpoint["DOMAIN"] = "domain";
-})(exports.QueryEndpoint || (exports.QueryEndpoint = {}));
-// Regular expressions for identity detection
-const REGEX = {
-    ENS: /^.+\.(eth|xyz|bio|app|luxe|kred|art|ceo|club|box)$/i,
-    BASENAMES: /^.+\.base(\.eth)?$/i,
-    LINEA: /^.+\.linea(\.eth)?$/i,
-    FARCASTER: /^(?:[A-Za-z0-9_-]{1,61}(?:(?:\.eth)?(?:\.farcaster|\.fcast\.id|\.farcaster\.eth)?)?|farcaster,#\d+)$/i,
-    LENS: /^(?:.+\.lens)$/i,
-    CLUSTER: /^[\w-]+\/[\w-]+$/,
-    SPACE_ID: /^.+\.(bnb|arb)$/i,
-    GENOME: /^.+\.gno$/i,
-    UNSTOPPABLE_DOMAINS: /^.+\.(crypto|888|nft|blockchain|bitcoin|dao|x|klever|hi|zil|kresus|polygon|wallet|binanceus|anime|go|manga|eth)$/i,
-    CROSSBELL: /^.+\.csb$/i,
-    DOTBIT: /^.+\.bit$/i,
-    SNS: /^.+\.sol$/i,
-    ETH_ADDRESS: /^0x[a-fA-F0-9]{40}$/i,
-    BTC_ADDRESS: /\b([13][a-km-zA-HJ-NP-Z1-9]{25,34}|bc1[qp][a-z0-9]{11,71})\b/,
-    SOLANA_ADDRESS: /^[1-9A-HJ-NP-Za-km-z]{32,44}$/,
-    LOWERCASE_EXEMPT: /\b(?:(?:[13][a-km-zA-HJ-NP-Z1-9]{25,34}|bc1[qp][a-z0-9]{11,71})|(?:[1-9A-HJ-NP-Za-km-z]{32,44}))\b/,
-    TWITTER: /^[A-Za-z0-9_]{1,15}(?:\.twitter)?$/i,
-    NEXT_ID: /^0x[a-f0-9]{66}(?:\.nextid)?$/i,
-};
-
-exports.PlatformType = void 0;
-(function (PlatformType) {
-    PlatformType["ens"] = "ens";
-    PlatformType["farcaster"] = "farcaster";
-    PlatformType["lens"] = "lens";
-    PlatformType["ethereum"] = "ethereum";
-    PlatformType["twitter"] = "twitter";
-    PlatformType["github"] = "github";
-    PlatformType["bitcoin"] = "bitcoin";
-    PlatformType["unstoppableDomains"] = "unstoppabledomains";
-    PlatformType["basenames"] = "basenames";
-    PlatformType["linea"] = "linea";
-    PlatformType["space_id"] = "space_id";
-    PlatformType["solana"] = "solana";
-    PlatformType["sns"] = "sns";
-    PlatformType["nextid"] = "nextid";
-    PlatformType["dotbit"] = "dotbit";
-})(exports.PlatformType || (exports.PlatformType = {}));
-exports.SourceType = void 0;
-(function (SourceType) {
-    SourceType["ethereum"] = "ethereum";
-    SourceType["ens"] = "ens";
-    SourceType["twitter"] = "twitter";
-    SourceType["nextid"] = "nextid";
-    SourceType["dotbit"] = "dotbit";
-    SourceType["unstoppabledomains"] = "unstoppabledomains";
-    SourceType["lens"] = "lens";
-    SourceType["farcaster"] = "farcaster";
-    SourceType["space_id"] = "space_id";
-    SourceType["solana"] = "solana";
-    SourceType["sns"] = "sns";
-})(exports.SourceType || (exports.SourceType = {}));
-
-/**
- * Resolves an identity string to a platform and identifier
- * @param input The identity to resolve
- * @returns A formatted identity string or null if invalid
- */
-const resolveIdentity = (input) => {
-    if (!input)
-        return null;
-    const parts = input.split(",");
-    let platform;
-    let identity;
-    if (parts.length === 2) {
-        // Format is already "platform,identity"
-        platform = parts[0];
-        identity = prettify(parts[1]);
-    }
-    else if (parts.length === 1) {
-        // Auto-detect platform from the identity string
-        platform = detectPlatform(input);
-        identity = prettify(input);
-    }
-    else {
-        return null;
-    }
-    if (!isSupportedPlatform(platform) || !identity)
-        return null;
-    // Normalize case except for case-sensitive identities
-    const normalizedIdentity = REGEX.LOWERCASE_EXEMPT.test(identity)
-        ? identity
-        : identity.toLowerCase();
-    return `${platform},${normalizedIdentity}`;
-};
-/**
- * Clean up and standardize identity format
- */
-const prettify = (input) => {
-    if (!input)
-        return "";
-    if (input.endsWith(".twitter"))
-        return input.replace(".twitter", "");
-    if (input.endsWith(".nextid"))
-        return input.replace(".nextid", "");
-    if (input.startsWith("farcaster,#"))
-        return input.replace(/^(farcaster),/, "");
-    if (input.endsWith(".farcaster") ||
-        input.endsWith(".fcast.id") ||
-        input.endsWith(".farcaster.eth")) {
-        return input.replace(/(\.farcaster|\.fcast\.id|\.farcaster\.eth)$/, "");
-    }
-    if (input.endsWith(".base") || input.endsWith(".linea")) {
-        return input.split(".")[0] + "." + input.split(".").pop() + ".eth";
-    }
-    return input;
-};
-/**
- * Check if the platform is supported for API queries
- */
-const isSupportedPlatform = (platform) => {
-    if (!platform)
-        return false;
-    return Object.values(exports.PlatformType).includes(platform);
-};
-/**
- * Detect platform from identity string based on regex patterns
- */
-const detectPlatform = (term) => {
-    if (term.endsWith(".farcaster.eth"))
-        return exports.PlatformType.farcaster;
-    const platformMap = [
-        [REGEX.BASENAMES, exports.PlatformType.basenames],
-        [REGEX.LINEA, exports.PlatformType.linea],
-        [REGEX.ENS, exports.PlatformType.ens],
-        [REGEX.ETH_ADDRESS, exports.PlatformType.ethereum],
-        [REGEX.LENS, exports.PlatformType.lens],
-        [REGEX.UNSTOPPABLE_DOMAINS, exports.PlatformType.unstoppableDomains],
-        [REGEX.SPACE_ID, exports.PlatformType.space_id],
-        [REGEX.DOTBIT, exports.PlatformType.dotbit],
-        [REGEX.SNS, exports.PlatformType.sns],
-        [REGEX.BTC_ADDRESS, exports.PlatformType.bitcoin],
-        [REGEX.SOLANA_ADDRESS, exports.PlatformType.solana],
-        [REGEX.FARCASTER, exports.PlatformType.farcaster],
-        [REGEX.TWITTER, exports.PlatformType.twitter],
-        [REGEX.NEXT_ID, exports.PlatformType.nextid],
-    ];
-    for (const [regex, platformType] of platformMap) {
-        if (regex.test(term)) {
-            return platformType;
-        }
-    }
-    // Default fallback
-    return term.includes(".") ? exports.PlatformType.ens : exports.PlatformType.farcaster;
-};
-/**
- * Get API key from various environment sources or user provided value
- */
-const getApiKey = (userProvidedKey) => {
-    return (userProvidedKey ||
-        process.env.WEB3BIO_API_KEY ||
-        process.env.REACT_APP_WEB3BIO_API_KEY ||
-        process.env.NEXT_PUBLIC_WEB3BIO_API_KEY ||
-        process.env.VITE_WEB3BIO_API_KEY);
-};
-
-/**
- * Constructs the API URL based on query parameters
- */
-const buildApiUrl = (identity, endpoint, universal) => {
-    // Handle batch requests
-    if (Array.isArray(identity)) {
-        return `${API_ENDPOINT}/${endpoint}/batch/${encodeURIComponent(JSON.stringify(identity))}`;
-    }
-    // Handle universal queries
-    if (universal) {
-        return `${API_ENDPOINT}/${endpoint}/${identity}`;
-    }
-    // Handle platform-specific queries
-    const resolvedId = resolveIdentity(identity);
-    if (!resolvedId)
-        return null;
-    // Domain endpoint uses resolved ID directly
-    if (endpoint === exports.QueryEndpoint.DOMAIN) {
-        return `${API_ENDPOINT}/${endpoint}/${resolvedId}`;
-    }
-    // Other endpoints need platform/handle split
-    const [platform, handle] = resolvedId.split(",");
-    return `${API_ENDPOINT}/${endpoint}/${platform}/${handle}`;
-};
-// Generate a stable cache key for this request
-const getCacheKey = (identity, endpoint, universal) => {
-    return JSON.stringify({
-        identity,
-        endpoint,
-        universal,
-    });
-};
-// Create a cache to store results across component instances and re-renders
-const globalRequestCache = new Map();
-/**
- * Core hook for querying Web3.bio Profile API
- */
-function useBaseQuery(identity, endpoint, universal = false, options = {}) {
-    const { apiKey: userApiKey, enabled = true } = options;
-    const apiKey = getApiKey(userApiKey);
-    const [data, setData] = react.useState(() => {
-        // Initialize state from cache if available
-        const cacheKey = getCacheKey(identity, endpoint, universal);
-        return globalRequestCache.get(cacheKey) || null;
-    });
-    const [isLoading, setIsLoading] = react.useState(false);
-    const [error, setError] = react.useState(null);
-    // Use ref to track in-flight requests and prevent race conditions
-    const requestIdRef = react.useRef(0);
-    const prevParamsRef = react.useRef("");
-    // Current request parameters as a string for comparison
-    const currentParams = JSON.stringify({
-        identity,
-        endpoint,
-        universal,
-    });
-    react.useEffect(() => {
-        // Don't run the query if disabled or no identity
-        if (!enabled || !identity)
-            return;
-        // Skip if parameters haven't changed
-        if (currentParams === prevParamsRef.current && data !== null) {
-            return;
-        }
-        // Update previous parameters
-        prevParamsRef.current = currentParams;
-        // Generate cache key
-        const cacheKey = getCacheKey(identity, endpoint, universal);
-        // Check if we already have cached data
-        const cachedData = globalRequestCache.get(cacheKey);
-        if (cachedData) {
-            setData(cachedData);
-            return;
-        }
-        // Increment request ID to track the latest request
-        const requestId = ++requestIdRef.current;
-        setIsLoading(true);
-        setError(null);
-        const fetchData = async () => {
-            try {
-                const url = buildApiUrl(identity, endpoint, universal);
-                if (!url) {
-                    throw new Error(exports.ErrorMessages.INVALID_IDENTITY);
-                }
-                const headers = apiKey ? { "x-api-key": apiKey } : {};
-                const fetchOptions = {
-                    method: "GET",
-                    headers,
-                };
-                const response = await fetch(url, fetchOptions);
-                if (!response.ok) {
-                    throw new Error(`API error: ${response.status}`);
-                }
-                const responseData = await response.json();
-                if (responseData === null || responseData === void 0 ? void 0 : responseData.error) {
-                    throw new Error(responseData.error);
-                }
-                if (requestId === requestIdRef.current) {
-                    globalRequestCache.set(cacheKey, responseData);
-                    setData(responseData);
-                    setIsLoading(false);
-                }
-            }
-            catch (err) {
-                if (requestId === requestIdRef.current) {
-                    setError(err instanceof Error ? err : new Error(String(err)));
-                    setIsLoading(false);
-                }
-            }
-        };
-        fetchData();
-    }, [currentParams, enabled]);
-    return { data, isLoading, error };
-}
-
-/**
- * Hook to query Web3.bio profile data by identity
- *
- * @param identity - Identity string
- * @param options - Optional configuration options
- * @returns Object containing profile data, loading state, and any errors
- *
- * @example
- * // Query by ENS name
- * const { data, isLoading, error } = useProfile("vitalik.eth");
- *
- * // Query with platform specification
- * const { data } = useProfile("farcaster,dwr");
- */
-function useProfile(identity, options = {}) {
-    return useBaseQuery(identity, exports.QueryEndpoint.PROFILE, false, options);
-}
-
-/**
- * Hook to query Web3.bio name service (NS) data by identity
- *
- * @param identity - Identity string
- * @param options - Optional configuration options
- * @returns Object containing NS data, loading state, and any errors
- *
- * @example
- * // Query by ENS name
- * const { data, isLoading, error } = useNS("vitalik.eth");
- *
- * // Query by Ethereum address
- * const { data } = useNS("0x123...");
- */
-function useNS(identity, options = {}) {
-    return useBaseQuery(identity, exports.QueryEndpoint.NS, false, options);
-}
-
-/**
- * Hook to query Web3.bio profile data using universal identity lookup
- *
- * @param identity - Identity string
- * @param options - Optional configuration options
- * @returns Object containing profile data, loading state, and any errors
- *
- * @example
- * // Query by ENS name with universal lookup
- * const { data, isLoading, error } = useUniversalProfile("vitalik.eth");
- *
- * // Query by any identity type with universal lookup
- * const { data } = useUniversalProfile("dwr.farcaster");
- */
-function useUniversalProfile(identity, options = {}) {
-    return useBaseQuery(identity, exports.QueryEndpoint.PROFILE, true, options);
-}
-
-/**
- * Hook to query Web3.bio name service (NS) data using universal identity lookup
- *
- * @param identity - Identity string
- * @param options - Optional configuration options
- * @returns Object containing NS data, loading state, and any errors
- *
- * @example
- * // Query by ENS name with universal lookup
- * const { data, isLoading, error } = useUniversalNS("vitalik.eth");
- *
- * // Query by any identity type with universal lookup
- * const { data } = useUniversalNS("dwr.farcaster");
- */
-function useUniversalNS(identity, options = {}) {
-    return useBaseQuery(identity, exports.QueryEndpoint.NS, true, options);
-}
-
-/**
- * Hook to query Web3.bio profile data using batch identity lookup
- *
- * @param identity - array of Identity string
- * @param options - Optional configuration options
- * @returns Object containing profile data, loading state, and any errors
- *
- * @example
- * // Query by any identity type with batch lookup
- * const { data } = useBatchProfile(["dwr.farcaster","ens,vitalik.eth","sujiyan.eth","stani.lens"]);
- */
-function useBatchProfile(identity, options = {}) {
-    return useBaseQuery(identity, exports.QueryEndpoint.PROFILE, false, options);
-}
-
-/**
- * Hook to query Web3.bio profile data using batch(NS) identity lookup
- *
- * @param identity - array of Identity string
- * @param options - Optional configuration options
- * @returns Object containing profile data, loading state, and any errors
- *
- * @example
- * // Query by any identity type with batch lookup
- * const { data } = useBatchNS(["dwr.farcaster","ens,vitalik.eth","sujiyan.eth","stani.lens"]);
- */
-function useBatchNS(identity, options = {}) {
-    return useBaseQuery(identity, exports.QueryEndpoint.NS, false, options);
-}
-
-/**
- * Hook to query Web3.bio domain data by identity
- *
- * @param identity - Identity string
- * @param options - Optional configuration options
- * @returns Object containing domain data, loading state, and any errors
- *
- * @example
- * // Query by ENS name
- * const { data, isLoading, error } = useDomain("vitalik.eth");
- *
- * // Query by domain name with platform
- * const { data } = useDomain("ens,vitalik.eth");
- */
-function useDomain(identity, options = {}) {
-    return useBaseQuery(identity, exports.QueryEndpoint.DOMAIN, false, options);
-}
-
-exports.API_ENDPOINT = API_ENDPOINT;
-exports.REGEX = REGEX;
-exports.useBatchNS = useBatchNS;
-exports.useBatchProfile = useBatchProfile;
-exports.useDomain = useDomain;
-exports.useNS = useNS;
-exports.useProfile = useProfile;
-exports.useUniversalNS = useUniversalNS;
-exports.useUniversalProfile = useUniversalProfile;
-//# sourceMappingURL=index.js.map
+export { useProfile } from './hooks/useProfile.js';
+export { useNS } from './hooks/useNS.js';
+export { useUniversalProfile } from './hooks/useUniversalProfile.js';
+export { useUniversalNS } from './hooks/useUniversalNS.js';
+export { useBatchProfile } from './hooks/useBatchProfile.js';
+export { useBatchNS } from './hooks/useBatchNS.js';
+export { useDomain } from './hooks/useDomain.js';
+export { useBaseQuery } from './hooks/useBaseQuery.js';
+export { CoinType } from './types/cointype.js';
+export { REGEX } from './utils/regex.js';
+export { API_ENDPOINT, detectPlatform, getApiKey, isSupportedPlatform, prettify, resolveIdentity } from './utils/helpers.js';
+export { NETWORK_DATA } from './utils/network.js';
+export { DEFAULT_PLATFORM, PLATFORM_DATA, getPlatformData } from './utils/platform.js';
+export { SOURCE_DATA } from './utils/source.js';
+export { Platform, PlatformSystem } from './types/platform.js';
+export { Network } from './types/network.js';
+export { ErrorMessages, QueryEndpoint } from './types/hook.js';
+export { Source } from './types/source.js';

package/dist/types/cointype.cjs

@@ -0,0 +1,29 @@
+'use strict';
+
+/**
+ * Coin types based on SLIP-0044 standard
+ * @see https://github.com/satoshilabs/slips/blob/master/slip-0044.md
+ */
+exports.CoinType = void 0;
+(function (CoinType) {
+    CoinType[CoinType["BTC"] = 0] = "BTC";
+    CoinType[CoinType["LTC"] = 2] = "LTC";
+    CoinType[CoinType["DOGE"] = 3] = "DOGE";
+    CoinType[CoinType["DASH"] = 5] = "DASH";
+    CoinType[CoinType["MONACOIN"] = 22] = "MONACOIN";
+    CoinType[CoinType["ETH"] = 60] = "ETH";
+    CoinType[CoinType["ETC"] = 61] = "ETC";
+    CoinType[CoinType["XRP"] = 145] = "XRP";
+    CoinType[CoinType["ATOM"] = 118] = "ATOM";
+    CoinType[CoinType["ROOTSTOCK"] = 137] = "ROOTSTOCK";
+    CoinType[CoinType["RIPPLE"] = 144] = "RIPPLE";
+    CoinType[CoinType["BCH"] = 145] = "BCH";
+    CoinType[CoinType["BNB"] = 714] = "BNB";
+    CoinType[CoinType["XLM"] = 148] = "XLM";
+    CoinType[CoinType["RSK"] = 137] = "RSK";
+    CoinType[CoinType["EOS"] = 194] = "EOS";
+    CoinType[CoinType["XEM"] = 43] = "XEM";
+    CoinType[CoinType["TRX"] = 195] = "TRX";
+    CoinType[CoinType["XDAI"] = 700] = "XDAI";
+    CoinType[CoinType["MATIC"] = 2147483785] = "MATIC";
+})(exports.CoinType || (exports.CoinType = {}));

package/dist/types/cointype.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Coin types based on SLIP-0044 standard
+ * @see https://github.com/satoshilabs/slips/blob/master/slip-0044.md
+ */
+export declare enum CoinType {
+    BTC = 0,
+    LTC = 2,
+    DOGE = 3,
+    DASH = 5,
+    MONACOIN = 22,
+    ETH = 60,
+    ETC = 61,
+    XRP = 145,
+    ATOM = 118,
+    ROOTSTOCK = 137,
+    RIPPLE = 144,
+    BCH = 145,
+    BNB = 714,
+    XLM = 148,
+    RSK = 137,
+    EOS = 194,
+    XEM = 43,
+    TRX = 195,
+    XDAI = 700,
+    MATIC = 2147483785
+}

package/dist/types/cointype.js

@@ -0,0 +1,29 @@
+/**
+ * Coin types based on SLIP-0044 standard
+ * @see https://github.com/satoshilabs/slips/blob/master/slip-0044.md
+ */
+var CoinType;
+(function (CoinType) {
+    CoinType[CoinType["BTC"] = 0] = "BTC";
+    CoinType[CoinType["LTC"] = 2] = "LTC";
+    CoinType[CoinType["DOGE"] = 3] = "DOGE";
+    CoinType[CoinType["DASH"] = 5] = "DASH";
+    CoinType[CoinType["MONACOIN"] = 22] = "MONACOIN";
+    CoinType[CoinType["ETH"] = 60] = "ETH";
+    CoinType[CoinType["ETC"] = 61] = "ETC";
+    CoinType[CoinType["XRP"] = 145] = "XRP";
+    CoinType[CoinType["ATOM"] = 118] = "ATOM";
+    CoinType[CoinType["ROOTSTOCK"] = 137] = "ROOTSTOCK";
+    CoinType[CoinType["RIPPLE"] = 144] = "RIPPLE";
+    CoinType[CoinType["BCH"] = 145] = "BCH";
+    CoinType[CoinType["BNB"] = 714] = "BNB";
+    CoinType[CoinType["XLM"] = 148] = "XLM";
+    CoinType[CoinType["RSK"] = 137] = "RSK";
+    CoinType[CoinType["EOS"] = 194] = "EOS";
+    CoinType[CoinType["XEM"] = 43] = "XEM";
+    CoinType[CoinType["TRX"] = 195] = "TRX";
+    CoinType[CoinType["XDAI"] = 700] = "XDAI";
+    CoinType[CoinType["MATIC"] = 2147483785] = "MATIC";
+})(CoinType || (CoinType = {}));
+
+export { CoinType };

package/dist/types/hook.cjs

@@ -0,0 +1,38 @@
+'use strict';
+
+/**
+ * Standard error messages used across the library
+ * @public
+ */
+exports.ErrorMessages = void 0;
+(function (ErrorMessages) {
+    /** Resource not found */
+    ErrorMessages["NOT_FOUND"] = "Not Found";
+    /** Resolver address is invalid */
+    ErrorMessages["INVALID_RESOLVER"] = "Invalid Resolver Address";
+    /** Resolved address is invalid */
+    ErrorMessages["INVALID_RESOLVED"] = "Invalid Resolved Address";
+    /** Resource does not exist */
+    ErrorMessages["NOT_EXIST"] = "Does Not Exist";
+    /** Provided identity or domain is invalid */
+    ErrorMessages["INVALID_IDENTITY"] = "Invalid Identity or Domain";
+    /** Provided address is invalid */
+    ErrorMessages["INVALID_ADDRESS"] = "Invalid Address";
+    /** An unknown error occurred */
+    ErrorMessages["UNKNOWN_ERROR"] = "Unknown Error Occurred";
+    /** Network-related error */
+    ErrorMessages["NETWORK_ERROR"] = "Network Error";
+})(exports.ErrorMessages || (exports.ErrorMessages = {}));
+/**
+ * API endpoints for different query types
+ * @public
+ */
+exports.QueryEndpoint = void 0;
+(function (QueryEndpoint) {
+    /** Name service endpoint */
+    QueryEndpoint["NS"] = "ns";
+    /** Profile data endpoint */
+    QueryEndpoint["PROFILE"] = "profile";
+    /** Domain information endpoint */
+    QueryEndpoint["DOMAIN"] = "domain";
+})(exports.QueryEndpoint || (exports.QueryEndpoint = {}));