web3bio-profile-kit 0.1.2 → 0.1.3

package/README.md

@@ -41,7 +41,7 @@ VITE_WEB3BIO_API_KEY=your_api_key
 #### Platform-Specific Profile Queries
 
 ```jsx
-import { useProfile } from 'web3bio-profile-kit';
+import { useProfile } from "web3bio-profile-kit";
 
 function ProfileComponent() {
   // Query with explicit platform format
@@ -69,7 +69,7 @@ function ProfileComponent() {
 #### Universal Profile Queries
 
 ```jsx
-import { useUniversalProfile } from 'web3bio-profile-kit';
+import { useUniversalProfile } from "web3bio-profile-kit";
 
 function UniversalProfileComponent() {
   // Query by any identity format - ENS domain, Farcaster handle, etc.
@@ -97,7 +97,7 @@ function UniversalProfileComponent() {
 #### Platform-Specific Name Service Queries
 
 ```jsx
-import { useNS } from 'web3bio-profile-kit';
+import { useNS } from "web3bio-profile-kit";
 
 function NameServiceComponent() {
   const { data, isLoading } = useNS("ens,vitalik.eth");
@@ -116,7 +116,7 @@ function NameServiceComponent() {
 #### Universal Name Service Queries
 
 ```jsx
-import { useUniversalNS } from 'web3bio-profile-kit';
+import { useUniversalNS } from "web3bio-profile-kit";
 
 function UniversalNameServiceComponent() {
   // Works with any identity format
@@ -136,7 +136,7 @@ function UniversalNameServiceComponent() {
 ### Query Domain Data
 
 ```jsx
-import { useDomain } from 'web3bio-profile-kit';
+import { useDomain } from "web3bio-profile-kit";
 
 function DomainComponent() {
   const { data, isLoading } = useDomain("vitalik.eth");
@@ -156,7 +156,7 @@ function DomainComponent() {
 ### Batch Profile Query
 
 ```jsx
-import { useBatchProfile } from 'web3bio-profile-kit';
+import { useBatchProfile } from "web3bio-profile-kit";
 
 function BatchProfileComponent() {
   const { data, isLoading } = useBatchProfile([
@@ -234,6 +234,14 @@ Fetches basic universal name service data across multiple platforms.
 
 Fetches detailed domain information including resolution data.
 
+#### `useBatchProfile(identity, options?)`
+
+Fetches comprehensive profile data for multiple identities in a single request.
+
+#### `useBatchNS(identity, options?)`
+
+Fetches basic name service data for multiple identities in a single request.
+
 ### Arguments
 
 | Parameter | Type | Description |

package/dist/index.d.ts

@@ -1,46 +1,222 @@
+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",
-    farcaster = "farcaster",
+    dotbit = "dotbit",
     lens = "lens",
+    box = "box",
     ethereum = "ethereum",
     twitter = "twitter",
-    github = "github",
+    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",
-    nextid = "nextid",
-    dotbit = "dotbit"
+    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"
+    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>;
-interface ProfileResponse {
-    identity: string;
-    address: string | null;
-    avatar: string | null;
-    description: string | null;
-    platform: string;
-    displayName: string | null;
+type SocialRecord = {
+    uid: number | null;
+    follower: number;
+    following: number;
+};
+interface ProfileResponse extends NSResponse {
     email: string | null;
     contenthash: string | null;
     header: string | null;
@@ -49,12 +225,7 @@ interface ProfileResponse {
     status: string | null;
     error?: string;
     links: SocialLinks;
-    aliases?: string[];
-    social: {
-        uid: number | null;
-        follower: number;
-        following: number;
-    } | {};
+    social: SocialRecord | {};
 }
 interface NSResponse {
     identity: string;
@@ -79,7 +250,7 @@ interface DomainResponse {
     expiredAt: string | null;
     contenthash: string | null;
     texts: Record<string, string>;
-    addresses: Record<string, string>;
+    addresses: Record<Network, string>;
 }
 type QueryOptions = {
     /** API Key for authentication */
@@ -244,4 +415,27 @@ declare const REGEX: {
     NEXT_ID: RegExp;
 };
 
-export { API_ENDPOINT, DomainResponse, DomainResult, ErrorMessages, IdentityString, NSBatchResult, NSResponse, NSResult, NSUniversalResult, PlatformType, ProfileBatchResult, ProfileResponse, ProfileResult, ProfileUniversalResult, QueryEndpoint, QueryOptions, QueryResult, REGEX, SocialLinks, SocialLinksItem, SourceType, useBatchNS, useBatchProfile, useDomain, useNS, useProfile, useUniversalNS, useUniversalProfile };
+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 };