web3bio-profile-kit 0.1.3 → 0.1.4

package/dist/hooks/useUniversalProfile.cjs

@@ -0,0 +1,28 @@
+'use strict';
+
+require('../types/platform.cjs');
+require('../types/network.cjs');
+var hook = require('../types/hook.cjs');
+require('../types/source.cjs');
+require('../types/cointype.cjs');
+var useBaseQuery = require('./useBaseQuery.cjs');
+
+/**
+ * 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.useBaseQuery(identity, hook.QueryEndpoint.PROFILE, true, options);
+}
+
+exports.useUniversalProfile = useUniversalProfile;

package/dist/{types/hooks → hooks}/useUniversalProfile.d.ts

@@ -1,4 +1,4 @@
-import type { IdentityString, ProfileUniversalResult, QueryOptions } from "../utils/types";
+import { type IdentityString, type ProfileUniversalResult, type QueryOptions } from "../types";
 /**
  * Hook to query Web3.bio profile data using universal identity lookup
  *

package/dist/hooks/useUniversalProfile.js

@@ -0,0 +1,26 @@
+import '../types/platform.js';
+import '../types/network.js';
+import { QueryEndpoint } from '../types/hook.js';
+import '../types/source.js';
+import '../types/cointype.js';
+import { useBaseQuery } from './useBaseQuery.js';
+
+/**
+ * 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, QueryEndpoint.PROFILE, true, options);
+}
+
+export { useUniversalProfile };

package/dist/index.cjs

@@ -0,0 +1,71 @@
+'use strict';
+
+var useProfile = require('./hooks/useProfile.cjs');
+var useNS = require('./hooks/useNS.cjs');
+var useUniversalProfile = require('./hooks/useUniversalProfile.cjs');
+var useUniversalNS = require('./hooks/useUniversalNS.cjs');
+var useBatchProfile = require('./hooks/useBatchProfile.cjs');
+var useBatchNS = require('./hooks/useBatchNS.cjs');
+var useDomain = require('./hooks/useDomain.cjs');
+var useBaseQuery = require('./hooks/useBaseQuery.cjs');
+var cointype = require('./types/cointype.cjs');
+var regex = require('./utils/regex.cjs');
+var helpers = require('./utils/helpers.cjs');
+var network = require('./utils/network.cjs');
+var platform = require('./utils/platform.cjs');
+var source = require('./utils/source.cjs');
+var platform$1 = require('./types/platform.cjs');
+var network$1 = require('./types/network.cjs');
+var hook = require('./types/hook.cjs');
+var source$1 = require('./types/source.cjs');
+
+
+
+exports.useProfile = useProfile.useProfile;
+exports.useNS = useNS.useNS;
+exports.useUniversalProfile = useUniversalProfile.useUniversalProfile;
+exports.useUniversalNS = useUniversalNS.useUniversalNS;
+exports.useBatchProfile = useBatchProfile.useBatchProfile;
+exports.useBatchNS = useBatchNS.useBatchNS;
+exports.useDomain = useDomain.useDomain;
+exports.useBaseQuery = useBaseQuery.useBaseQuery;
+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;
+Object.defineProperty(exports, 'Platform', {
+	enumerable: true,
+	get: function () { return platform$1.Platform; }
+});
+Object.defineProperty(exports, 'PlatformSystem', {
+	enumerable: true,
+	get: function () { return platform$1.PlatformSystem; }
+});
+Object.defineProperty(exports, 'Network', {
+	enumerable: true,
+	get: function () { return network$1.Network; }
+});
+Object.defineProperty(exports, 'ErrorMessages', {
+	enumerable: true,
+	get: function () { return hook.ErrorMessages; }
+});
+Object.defineProperty(exports, 'QueryEndpoint', {
+	enumerable: true,
+	get: function () { return hook.QueryEndpoint; }
+});
+Object.defineProperty(exports, 'Source', {
+	enumerable: true,
+	get: function () { return source$1.Source; }
+});

package/dist/index.d.ts

@@ -1,441 +1,3 @@
-declare enum Network {
-    aptos = "aptos",
-    arbitrum = "arbitrum",
-    arbitrum_nova = "arbitrum_nova",
-    arbitrum_one = "arbitrum_one",
-    apechain = "apechain",
-    arweave = "arweave",
-    avalanche = "avalanche",
-    base = "base",
-    bitcoin = "bitcoin",
-    binanceSmartChain = "binance-smart-chain",
-    bsc = "bsc",
-    conflux = "conflux",
-    crossbell = "crossbell",
-    erc1577 = "erc1577",
-    ethereum = "ethereum",
-    fantom = "fantom",
-    farcaster = "farcaster",
-    flow = "flow",
-    gnosis = "gnosis",
-    lens = "lens",
-    linea = "linea",
-    mastodon = "mastodon",
-    optimism = "optimism",
-    polygon = "polygon",
-    scroll = "scroll",
-    snapshot = "snapshot",
-    solana = "solana",
-    vsl = "vsl",
-    xLayer = "x-layer",
-    zksync_era = "zksync_era",
-    zora = "zora",
-    unichain = "unichain"
-}
-interface NetworkMetaData {
-    assetPrefix?: string;
-    bgColor: string;
-    chainId?: number;
-    icon: string;
-    key: string;
-    label: string;
-    primaryColor: string;
-    scanLabel?: string;
-    scanPrefix: string;
-    scanPrefixTx?: string;
-    short?: string;
-}
-declare const NETWORK_DATA: {
-    [key in Network]: NetworkMetaData;
-};
-
-declare enum PlatformType {
-    ens = "ens",
-    dotbit = "dotbit",
-    lens = "lens",
-    box = "box",
-    ethereum = "ethereum",
-    twitter = "twitter",
-    nextid = "nextid",
-    bitcoin = "bitcoin",
-    keybase = "keybase",
-    reddit = "reddit",
-    github = "github",
-    unstoppableDomains = "unstoppabledomains",
-    basenames = "basenames",
-    linea = "linea",
-    ckb = "ckb",
-    farcaster = "farcaster",
-    space_id = "space_id",
-    telegram = "telegram",
-    instagram = "instagram",
-    cyberconnect = "cyberconnect",
-    opensea = "opensea",
-    discord = "discord",
-    calendly = "calendly",
-    url = "url",
-    website = "website",
-    linkedin = "linkedin",
-    dns = "dns",
-    tron = "tron",
-    hey = "hey",
-    facebook = "facebook",
-    threads = "threads",
-    whatsapp = "whatsapp",
-    weibo = "weibo",
-    youtube = "youtube",
-    tiktok = "tiktok",
-    bilibili = "bilibili",
-    medium = "medium",
-    mirror = "mirror",
-    zerion = "zerion",
-    aave = "aave",
-    rainbow = "rainbow",
-    bluesky = "bluesky",
-    nostr = "nostr",
-    poap = "poap",
-    uniswap = "uniswap",
-    degenscore = "degenscore",
-    firefly = "firefly",
-    solana = "solana",
-    sns = "sns",
-    mstdnjp = "mstdnjp",
-    lobsters = "lobsters",
-    hackernews = "hackernews",
-    crossbell = "crossbell",
-    minds = "minds",
-    paragraph = "paragraph",
-    genome = "genome",
-    gnosis = "gnosis",
-    webacy = "webacy",
-    clusters = "clusters",
-    guild = "guild",
-    ton = "ton",
-    snapshot = "snapshot",
-    coingecko = "coingecko",
-    gitcoin = "gitcoin",
-    humanpassport = "humanpassport",
-    talent = "talentprotocol",
-    doge = "doge",
-    bsc = "bsc",
-    aptos = "aptos",
-    near = "near",
-    stacks = "stacks",
-    cosmos = "cosmos",
-    zeta = "zeta",
-    mode = "mode",
-    arbitrum = "arbitrum",
-    scroll = "scroll",
-    taiko = "taiko",
-    mint = "mint",
-    zkfair = "zkfair",
-    manta = "manta",
-    lightlink = "lightlink",
-    merlin = "merlin",
-    alienx = "alienx",
-    edgeless = "edgeless",
-    tomo = "tomo",
-    ailayer = "ailayer",
-    philand = "philand",
-    efp = "efp",
-    gravity = "gravity"
-}
-type SocialPlatform = {
-    color?: string;
-    icon?: string;
-    label: string;
-    description?: string;
-    urlPrefix?: string;
-    ensText?: string[];
-    registerlink?: string;
-    editUrlPrefix?: string;
-    system: PlatformSystem;
-};
-declare enum PlatformSystem {
-    web2 = 0,
-    web3 = 1
-}
-declare const DEFAULT_PLATFORM: Readonly<SocialPlatform>;
-declare const PLATFORM_DATA: ReadonlyMap<PlatformType, Readonly<SocialPlatform>>;
-
-declare enum SourceType {
-    ethereum = "ethereum",
-    ens = "ens",
-    twitter = "twitter",
-    keybase = "keybase",
-    nextid = "nextid",
-    rss3 = "rss3",
-    dotbit = "dotbit",
-    unstoppabledomains = "unstoppabledomains",
-    lens = "lens",
-    farcaster = "farcaster",
-    space_id = "space_id",
-    crossbell = "crossbell",
-    clusters = "clusters",
-    solana = "solana",
-    sns = "sns",
-    opensea = "opensea",
-    firefly = "firefly",
-    basenames = "basenames",
-    dentity = "dentity",
-    nftd = "nftd",
-    mirror = "mirror",
-    paragraph = "paragraph",
-    foundation = "foundation",
-    rarible = "rarible",
-    soundxyz = "soundxyz",
-    gravity = "gravity",
-    linea = "linea",
-    gmgn = "gmgn",
-    nostr = "nostr",
-    talentprotocol = "talentprotocol",
-    crowdsourcing = "crowdsourcing",
-    particle = "particle",
-    tally = "tally",
-    icebreaker = "icebreaker"
-}
-interface SourceInfo {
-    name: string;
-    description: string;
-}
-declare const SOURCE_DATA: Readonly<Record<SourceType, SourceInfo>>;
-
-type AddressRecord = {
-    address: string;
-    network: string;
-    __typename: "Address";
-};
-type SocialLinksItem = {
-    link: string | null;
-    handle: string | null;
-    sources: SourceType[];
-};
-type SocialLinks = Record<string, SocialLinksItem>;
-type SocialRecord = {
-    uid: number | null;
-    follower: number;
-    following: number;
-};
-interface ProfileResponse extends NSResponse {
-    email: string | null;
-    contenthash: string | null;
-    header: string | null;
-    location: string | null;
-    createdAt: string | null;
-    status: string | null;
-    error?: string;
-    links: SocialLinks;
-    social: SocialRecord | {};
-}
-interface NSResponse {
-    identity: string;
-    address: string | null;
-    avatar: string | null;
-    description: string | null;
-    platform: string;
-    displayName: string | null;
-    aliases?: string[];
-}
-interface DomainResponse {
-    identity: string;
-    platform: PlatformType;
-    resolvedAddress: string | null;
-    ownerAddress: string | null;
-    managerAddress: string | null;
-    displayName: string | null;
-    isPrimary: boolean;
-    status: string;
-    createdAt: string | null;
-    updatedAt: string | null;
-    expiredAt: string | null;
-    contenthash: string | null;
-    texts: Record<string, string>;
-    addresses: Record<Network, string>;
-}
-type QueryOptions = {
-    /** API Key for authentication */
-    apiKey?: string;
-    /** Whether the query should execute */
-    enabled?: boolean;
-};
-type IdentityString = string | `${PlatformType},${string}`;
-type QueryResult<T> = {
-    data: T | null;
-    isLoading: boolean;
-    error: Error | null;
-};
-type ProfileResult = QueryResult<ProfileResponse>;
-type NSResult = QueryResult<NSResponse>;
-type ProfileBatchResult = QueryResult<ProfileResponse[]>;
-type NSBatchResult = QueryResult<NSResponse[]>;
-type ProfileUniversalResult = QueryResult<ProfileResponse[]>;
-type NSUniversalResult = QueryResult<NSResponse[]>;
-type DomainResult = QueryResult<DomainResponse>;
-
-/**
- * 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");
- */
-declare function useProfile(identity: IdentityString, options?: QueryOptions): ProfileResult;
-
-/**
- * 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...");
- */
-declare function useNS(identity: IdentityString, options?: QueryOptions): NSResult;
-
-/**
- * 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");
- */
-declare function useUniversalProfile(identity: IdentityString, options?: QueryOptions): ProfileUniversalResult;
-
-/**
- * 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");
- */
-declare function useUniversalNS(identity: IdentityString, options?: QueryOptions): NSUniversalResult;
-
-/**
- * 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"]);
- */
-declare function useBatchProfile(identity: IdentityString[], options?: QueryOptions): ProfileBatchResult;
-
-/**
- * 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"]);
- */
-declare function useBatchNS(identity: IdentityString[], options?: QueryOptions): NSBatchResult;
-
-/**
- * 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");
- */
-declare function useDomain(identity: IdentityString, options?: QueryOptions): DomainResult;
-
-declare const API_ENDPOINT = "https://api.web3.bio";
-declare enum ErrorMessages {
-    NOT_FOUND = "Not Found",
-    INVALID_RESOLVER = "Invalid Resolver Address",
-    INVALID_RESOLVED = "Invalid Resolved Address",
-    NOT_EXIST = "Does Not Exist",
-    INVALID_IDENTITY = "Invalid Identity or Domain",
-    INVALID_ADDRESS = "Invalid Address",
-    UNKNOWN_ERROR = "Unknown Error Occurred",
-    NETWORK_ERROR = "Network Error"
-}
-declare enum QueryEndpoint {
-    NS = "ns",
-    PROFILE = "profile",
-    DOMAIN = "domain"
-}
-declare const REGEX: {
-    ENS: RegExp;
-    BASENAMES: RegExp;
-    LINEA: RegExp;
-    FARCASTER: RegExp;
-    LENS: RegExp;
-    CLUSTER: RegExp;
-    SPACE_ID: RegExp;
-    GENOME: RegExp;
-    UNSTOPPABLE_DOMAINS: RegExp;
-    CROSSBELL: RegExp;
-    DOTBIT: RegExp;
-    SNS: RegExp;
-    ETH_ADDRESS: RegExp;
-    BTC_ADDRESS: RegExp;
-    SOLANA_ADDRESS: RegExp;
-    LOWERCASE_EXEMPT: RegExp;
-    TWITTER: RegExp;
-    NEXT_ID: RegExp;
-};
-
-declare const CoinType: {
-    btc: number;
-    ltc: number;
-    doge: number;
-    dash: number;
-    monacoin: number;
-    eth: number;
-    etc: number;
-    xrp: number;
-    atom: number;
-    rootstock: number;
-    ripple: number;
-    bch: number;
-    bnb: number;
-    xlm: number;
-    rsk: number;
-    eos: number;
-    xem: number;
-    trx: number;
-    xdai: number;
-    matic: number;
-};
-
-export { API_ENDPOINT, AddressRecord, CoinType, DEFAULT_PLATFORM, DomainResponse, DomainResult, ErrorMessages, IdentityString, NETWORK_DATA, NSBatchResult, NSResponse, NSResult, NSUniversalResult, Network, NetworkMetaData, PLATFORM_DATA, PlatformSystem, PlatformType, ProfileBatchResult, ProfileResponse, ProfileResult, ProfileUniversalResult, QueryEndpoint, QueryOptions, QueryResult, REGEX, SOURCE_DATA, SocialLinks, SocialLinksItem, SocialPlatform, SocialRecord, SourceInfo, SourceType, useBatchNS, useBatchProfile, useDomain, useNS, useProfile, useUniversalNS, useUniversalProfile };
+export * from "./hooks";
+export * from "./utils";
+export * from "./types";