web3bio-profile-kit 0.1.3 → 0.1.4

package/dist/types/{utils/platform.d.ts → platform.d.ts}

@@ -1,4 +1,9 @@
-export declare enum PlatformType {
+/**
+ * Supported platform types for identity and social profiles
+ * Includes blockchain networks, name services, and social platforms
+ * @public
+ */
+export declare enum Platform {
     ens = "ens",
     dotbit = "dotbit",
     lens = "lens",
@@ -89,7 +94,12 @@ export declare enum PlatformType {
     efp = "efp",
     gravity = "gravity"
 }
-export type SocialPlatform = {
+/**
+ * Platform metadata structure
+ * Contains display and functional information about a platform
+ * @public
+ */
+export interface PlatformType {
     color?: string;
     icon?: string;
     label: string;
@@ -99,10 +109,14 @@ export type SocialPlatform = {
     registerlink?: string;
     editUrlPrefix?: string;
     system: PlatformSystem;
-};
+}
+/**
+ * Platform system classification
+ * @public
+ */
 export declare enum PlatformSystem {
+    /** Traditional web platforms */
     web2 = 0,
+    /** Blockchain/decentralized platforms */
     web3 = 1
 }
-export declare const DEFAULT_PLATFORM: Readonly<SocialPlatform>;
-export declare const PLATFORM_DATA: ReadonlyMap<PlatformType, Readonly<SocialPlatform>>;

package/dist/types/platform.js

@@ -0,0 +1,110 @@
+/**
+ * Supported platform types for identity and social profiles
+ * Includes blockchain networks, name services, and social platforms
+ * @public
+ */
+var Platform;
+(function (Platform) {
+    Platform["ens"] = "ens";
+    Platform["dotbit"] = "dotbit";
+    Platform["lens"] = "lens";
+    Platform["box"] = "box";
+    Platform["ethereum"] = "ethereum";
+    Platform["twitter"] = "twitter";
+    Platform["nextid"] = "nextid";
+    Platform["bitcoin"] = "bitcoin";
+    Platform["keybase"] = "keybase";
+    Platform["reddit"] = "reddit";
+    Platform["github"] = "github";
+    Platform["unstoppableDomains"] = "unstoppabledomains";
+    Platform["basenames"] = "basenames";
+    Platform["linea"] = "linea";
+    Platform["ckb"] = "ckb";
+    Platform["farcaster"] = "farcaster";
+    Platform["space_id"] = "space_id";
+    Platform["telegram"] = "telegram";
+    Platform["instagram"] = "instagram";
+    Platform["cyberconnect"] = "cyberconnect";
+    Platform["opensea"] = "opensea";
+    Platform["discord"] = "discord";
+    Platform["calendly"] = "calendly";
+    Platform["url"] = "url";
+    Platform["website"] = "website";
+    Platform["linkedin"] = "linkedin";
+    Platform["dns"] = "dns";
+    Platform["tron"] = "tron";
+    Platform["hey"] = "hey";
+    Platform["facebook"] = "facebook";
+    Platform["threads"] = "threads";
+    Platform["whatsapp"] = "whatsapp";
+    Platform["weibo"] = "weibo";
+    Platform["youtube"] = "youtube";
+    Platform["tiktok"] = "tiktok";
+    Platform["bilibili"] = "bilibili";
+    Platform["medium"] = "medium";
+    Platform["mirror"] = "mirror";
+    Platform["zerion"] = "zerion";
+    Platform["aave"] = "aave";
+    Platform["rainbow"] = "rainbow";
+    Platform["bluesky"] = "bluesky";
+    Platform["nostr"] = "nostr";
+    Platform["poap"] = "poap";
+    Platform["uniswap"] = "uniswap";
+    Platform["degenscore"] = "degenscore";
+    Platform["firefly"] = "firefly";
+    Platform["solana"] = "solana";
+    Platform["sns"] = "sns";
+    Platform["mstdnjp"] = "mstdnjp";
+    Platform["lobsters"] = "lobsters";
+    Platform["hackernews"] = "hackernews";
+    Platform["crossbell"] = "crossbell";
+    Platform["minds"] = "minds";
+    Platform["paragraph"] = "paragraph";
+    Platform["genome"] = "genome";
+    Platform["gnosis"] = "gnosis";
+    Platform["webacy"] = "webacy";
+    Platform["clusters"] = "clusters";
+    Platform["guild"] = "guild";
+    Platform["ton"] = "ton";
+    Platform["snapshot"] = "snapshot";
+    Platform["coingecko"] = "coingecko";
+    Platform["gitcoin"] = "gitcoin";
+    Platform["humanpassport"] = "humanpassport";
+    Platform["talent"] = "talentprotocol";
+    Platform["doge"] = "doge";
+    Platform["bsc"] = "bsc";
+    Platform["aptos"] = "aptos";
+    Platform["near"] = "near";
+    Platform["stacks"] = "stacks";
+    Platform["cosmos"] = "cosmos";
+    Platform["zeta"] = "zeta";
+    Platform["mode"] = "mode";
+    Platform["arbitrum"] = "arbitrum";
+    Platform["scroll"] = "scroll";
+    Platform["taiko"] = "taiko";
+    Platform["mint"] = "mint";
+    Platform["zkfair"] = "zkfair";
+    Platform["manta"] = "manta";
+    Platform["lightlink"] = "lightlink";
+    Platform["merlin"] = "merlin";
+    Platform["alienx"] = "alienx";
+    Platform["edgeless"] = "edgeless";
+    Platform["tomo"] = "tomo";
+    Platform["ailayer"] = "ailayer";
+    Platform["philand"] = "philand";
+    Platform["efp"] = "efp";
+    Platform["gravity"] = "gravity";
+})(Platform || (Platform = {}));
+/**
+ * Platform system classification
+ * @public
+ */
+var PlatformSystem;
+(function (PlatformSystem) {
+    /** Traditional web platforms */
+    PlatformSystem[PlatformSystem["web2"] = 0] = "web2";
+    /** Blockchain/decentralized platforms */
+    PlatformSystem[PlatformSystem["web3"] = 1] = "web3";
+})(PlatformSystem || (PlatformSystem = {}));
+
+export { Platform, PlatformSystem };

package/dist/types/source.cjs

@@ -0,0 +1,44 @@
+'use strict';
+
+/**
+ * Supported data source types for profile information
+ * Includes blockchain networks, name services, social platforms, and aggregators
+ * @public
+ */
+exports.Source = void 0;
+(function (Source) {
+    Source["ethereum"] = "ethereum";
+    Source["ens"] = "ens";
+    Source["twitter"] = "twitter";
+    Source["keybase"] = "keybase";
+    Source["nextid"] = "nextid";
+    Source["rss3"] = "rss3";
+    Source["dotbit"] = "dotbit";
+    Source["unstoppabledomains"] = "unstoppabledomains";
+    Source["lens"] = "lens";
+    Source["farcaster"] = "farcaster";
+    Source["space_id"] = "space_id";
+    Source["crossbell"] = "crossbell";
+    Source["clusters"] = "clusters";
+    Source["solana"] = "solana";
+    Source["sns"] = "sns";
+    Source["opensea"] = "opensea";
+    Source["firefly"] = "firefly";
+    Source["basenames"] = "basenames";
+    Source["dentity"] = "dentity";
+    Source["nftd"] = "nftd";
+    Source["mirror"] = "mirror";
+    Source["paragraph"] = "paragraph";
+    Source["foundation"] = "foundation";
+    Source["rarible"] = "rarible";
+    Source["soundxyz"] = "soundxyz";
+    Source["gravity"] = "gravity";
+    Source["linea"] = "linea";
+    Source["gmgn"] = "gmgn";
+    Source["nostr"] = "nostr";
+    Source["talentprotocol"] = "talentprotocol";
+    Source["crowdsourcing"] = "crowdsourcing";
+    Source["particle"] = "particle";
+    Source["tally"] = "tally";
+    Source["icebreaker"] = "icebreaker";
+})(exports.Source || (exports.Source = {}));

package/dist/types/{utils/source.d.ts → source.d.ts}

@@ -1,4 +1,9 @@
-export declare enum SourceType {
+/**
+ * Supported data source types for profile information
+ * Includes blockchain networks, name services, social platforms, and aggregators
+ * @public
+ */
+export declare enum Source {
     ethereum = "ethereum",
     ens = "ens",
     twitter = "twitter",
@@ -34,8 +39,11 @@ export declare enum SourceType {
     tally = "tally",
     icebreaker = "icebreaker"
 }
-export interface SourceInfo {
+/**
+ * Metadata about a data source
+ * @public
+ */
+export interface SourceType {
     name: string;
     description: string;
 }
-export declare const SOURCE_DATA: Readonly<Record<SourceType, SourceInfo>>;

package/dist/types/source.js

@@ -0,0 +1,44 @@
+/**
+ * Supported data source types for profile information
+ * Includes blockchain networks, name services, social platforms, and aggregators
+ * @public
+ */
+var Source;
+(function (Source) {
+    Source["ethereum"] = "ethereum";
+    Source["ens"] = "ens";
+    Source["twitter"] = "twitter";
+    Source["keybase"] = "keybase";
+    Source["nextid"] = "nextid";
+    Source["rss3"] = "rss3";
+    Source["dotbit"] = "dotbit";
+    Source["unstoppabledomains"] = "unstoppabledomains";
+    Source["lens"] = "lens";
+    Source["farcaster"] = "farcaster";
+    Source["space_id"] = "space_id";
+    Source["crossbell"] = "crossbell";
+    Source["clusters"] = "clusters";
+    Source["solana"] = "solana";
+    Source["sns"] = "sns";
+    Source["opensea"] = "opensea";
+    Source["firefly"] = "firefly";
+    Source["basenames"] = "basenames";
+    Source["dentity"] = "dentity";
+    Source["nftd"] = "nftd";
+    Source["mirror"] = "mirror";
+    Source["paragraph"] = "paragraph";
+    Source["foundation"] = "foundation";
+    Source["rarible"] = "rarible";
+    Source["soundxyz"] = "soundxyz";
+    Source["gravity"] = "gravity";
+    Source["linea"] = "linea";
+    Source["gmgn"] = "gmgn";
+    Source["nostr"] = "nostr";
+    Source["talentprotocol"] = "talentprotocol";
+    Source["crowdsourcing"] = "crowdsourcing";
+    Source["particle"] = "particle";
+    Source["tally"] = "tally";
+    Source["icebreaker"] = "icebreaker";
+})(Source || (Source = {}));
+
+export { Source };

package/dist/utils/helpers.cjs

@@ -0,0 +1,119 @@
+'use strict';
+
+var platform = require('../types/platform.cjs');
+require('../types/network.cjs');
+require('../types/hook.cjs');
+require('../types/source.cjs');
+require('../types/cointype.cjs');
+var regex = require('./regex.cjs');
+
+const API_ENDPOINT = "https://api.web3.bio";
+/**
+ * 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.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$1) => {
+    if (!platform$1)
+        return false;
+    return Object.values(platform.Platform).includes(platform$1);
+};
+/**
+ * Detect platform from identity string based on regex patterns
+ */
+const detectPlatform = (term) => {
+    if (term.endsWith(".farcaster.eth"))
+        return platform.Platform.farcaster;
+    const platformMap = [
+        [regex.REGEX.BASENAMES, platform.Platform.basenames],
+        [regex.REGEX.LINEA, platform.Platform.linea],
+        [regex.REGEX.ENS, platform.Platform.ens],
+        [regex.REGEX.ETH_ADDRESS, platform.Platform.ethereum],
+        [regex.REGEX.LENS, platform.Platform.lens],
+        [regex.REGEX.UNSTOPPABLE_DOMAINS, platform.Platform.unstoppableDomains],
+        [regex.REGEX.SPACE_ID, platform.Platform.space_id],
+        [regex.REGEX.DOTBIT, platform.Platform.dotbit],
+        [regex.REGEX.SNS, platform.Platform.sns],
+        [regex.REGEX.BTC_ADDRESS, platform.Platform.bitcoin],
+        [regex.REGEX.SOLANA_ADDRESS, platform.Platform.solana],
+        [regex.REGEX.FARCASTER, platform.Platform.farcaster],
+        [regex.REGEX.TWITTER, platform.Platform.twitter],
+        [regex.REGEX.NEXT_ID, platform.Platform.nextid],
+    ];
+    for (const [regex, Platform] of platformMap) {
+        if (regex.test(term)) {
+            return Platform;
+        }
+    }
+    // Default fallback
+    return term.includes(".") ? platform.Platform.ens : platform.Platform.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);
+};
+
+exports.API_ENDPOINT = API_ENDPOINT;
+exports.detectPlatform = detectPlatform;
+exports.getApiKey = getApiKey;
+exports.isSupportedPlatform = isSupportedPlatform;
+exports.prettify = prettify;
+exports.resolveIdentity = resolveIdentity;

package/dist/{types/utils → utils}/helpers.d.ts

@@ -1,4 +1,5 @@
-import { PlatformType } from "./platform";
+import { Platform } from "../types";
+export declare const API_ENDPOINT = "https://api.web3.bio";
 /**
  * Resolves an identity string to a platform and identifier
  * @param input The identity to resolve
@@ -12,11 +13,11 @@ export declare const prettify: (input: string) => string;
 /**
  * Check if the platform is supported for API queries
  */
-export declare const isSupportedPlatform: (platform?: PlatformType | null) => boolean;
+export declare const isSupportedPlatform: (platform?: Platform | null) => boolean;
 /**
  * Detect platform from identity string based on regex patterns
  */
-export declare const detectPlatform: (term: string) => PlatformType;
+export declare const detectPlatform: (term: string) => Platform;
 /**
  * Get API key from various environment sources or user provided value
  */

package/dist/utils/helpers.js

@@ -0,0 +1,112 @@
+import { Platform } from '../types/platform.js';
+import '../types/network.js';
+import '../types/hook.js';
+import '../types/source.js';
+import '../types/cointype.js';
+import { REGEX } from './regex.js';
+
+const API_ENDPOINT = "https://api.web3.bio";
+/**
+ * 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(Platform).includes(platform);
+};
+/**
+ * Detect platform from identity string based on regex patterns
+ */
+const detectPlatform = (term) => {
+    if (term.endsWith(".farcaster.eth"))
+        return Platform.farcaster;
+    const platformMap = [
+        [REGEX.BASENAMES, Platform.basenames],
+        [REGEX.LINEA, Platform.linea],
+        [REGEX.ENS, Platform.ens],
+        [REGEX.ETH_ADDRESS, Platform.ethereum],
+        [REGEX.LENS, Platform.lens],
+        [REGEX.UNSTOPPABLE_DOMAINS, Platform.unstoppableDomains],
+        [REGEX.SPACE_ID, Platform.space_id],
+        [REGEX.DOTBIT, Platform.dotbit],
+        [REGEX.SNS, Platform.sns],
+        [REGEX.BTC_ADDRESS, Platform.bitcoin],
+        [REGEX.SOLANA_ADDRESS, Platform.solana],
+        [REGEX.FARCASTER, Platform.farcaster],
+        [REGEX.TWITTER, Platform.twitter],
+        [REGEX.NEXT_ID, Platform.nextid],
+    ];
+    for (const [regex, Platform] of platformMap) {
+        if (regex.test(term)) {
+            return Platform;
+        }
+    }
+    // Default fallback
+    return term.includes(".") ? Platform.ens : Platform.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);
+};
+
+export { API_ENDPOINT, detectPlatform, getApiKey, isSupportedPlatform, prettify, resolveIdentity };

package/dist/utils/index.cjs

@@ -0,0 +1,27 @@
+'use strict';
+
+var cointype = require('../types/cointype.cjs');
+var regex = require('./regex.cjs');
+var helpers = require('./helpers.cjs');
+var network = require('./network.cjs');
+var platform = require('./platform.cjs');
+var source = require('./source.cjs');
+
+
+
+Object.defineProperty(exports, 'CoinType', {
+	enumerable: true,
+	get: function () { return cointype.CoinType; }
+});
+exports.REGEX = regex.REGEX;
+exports.API_ENDPOINT = helpers.API_ENDPOINT;
+exports.detectPlatform = helpers.detectPlatform;
+exports.getApiKey = helpers.getApiKey;
+exports.isSupportedPlatform = helpers.isSupportedPlatform;
+exports.prettify = helpers.prettify;
+exports.resolveIdentity = helpers.resolveIdentity;
+exports.NETWORK_DATA = network.NETWORK_DATA;
+exports.DEFAULT_PLATFORM = platform.DEFAULT_PLATFORM;
+exports.PLATFORM_DATA = platform.PLATFORM_DATA;
+exports.getPlatformData = platform.getPlatformData;
+exports.SOURCE_DATA = source.SOURCE_DATA;

package/dist/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from "../types/cointype";
+export * from "./regex";
+export * from "./helpers";
+export * from "./network";
+export * from "./platform";
+export * from "./source";

package/dist/utils/index.js

@@ -0,0 +1,6 @@
+export { CoinType } from '../types/cointype.js';
+export { REGEX } from './regex.js';
+export { API_ENDPOINT, detectPlatform, getApiKey, isSupportedPlatform, prettify, resolveIdentity } from './helpers.js';
+export { NETWORK_DATA } from './network.js';
+export { DEFAULT_PLATFORM, PLATFORM_DATA, getPlatformData } from './platform.js';
+export { SOURCE_DATA } from './source.js';