web3bio-profile-kit 0.1.2 → 0.1.4

package/dist/types/hook.d.ts

@@ -0,0 +1,195 @@
+import type { Network } from "./network";
+import type { Platform } from "./platform";
+import type { Source } from "./source";
+/**
+ * Standard error messages used across the library
+ * @public
+ */
+export declare enum ErrorMessages {
+    /** Resource not found */
+    NOT_FOUND = "Not Found",
+    /** Resolver address is invalid */
+    INVALID_RESOLVER = "Invalid Resolver Address",
+    /** Resolved address is invalid */
+    INVALID_RESOLVED = "Invalid Resolved Address",
+    /** Resource does not exist */
+    NOT_EXIST = "Does Not Exist",
+    /** Provided identity or domain is invalid */
+    INVALID_IDENTITY = "Invalid Identity or Domain",
+    /** Provided address is invalid */
+    INVALID_ADDRESS = "Invalid Address",
+    /** An unknown error occurred */
+    UNKNOWN_ERROR = "Unknown Error Occurred",
+    /** Network-related error */
+    NETWORK_ERROR = "Network Error"
+}
+/**
+ * API endpoints for different query types
+ * @public
+ */
+export declare enum QueryEndpoint {
+    /** Name service endpoint */
+    NS = "ns",
+    /** Profile data endpoint */
+    PROFILE = "profile",
+    /** Domain information endpoint */
+    DOMAIN = "domain"
+}
+/**
+ * Represents a blockchain address record
+ * @public
+ */
+export type AddressRecord = {
+    /** The blockchain address */
+    address: string;
+    /** Network identifier */
+    network: string;
+    /** Type identifier */
+    __typename: "Address";
+};
+/**
+ * Social link information for a profile
+ * @public
+ */
+export type SocialLinksItem = {
+    /** URL to the social profile */
+    link: string | null;
+    /** Username or handle on the platform */
+    handle: string | null;
+    /** Data sources that provided this information */
+    sources: Source[];
+};
+/**
+ * Collection of social links indexed by platform
+ * @public
+ */
+export type SocialLinks = Record<string, SocialLinksItem>;
+/**
+ * Social account metrics
+ * @public
+ */
+export type SocialRecord = {
+    /** Unique identifier */
+    uid: number | null;
+    /** Number of followers */
+    follower: number;
+    /** Number of accounts being followed */
+    following: number;
+};
+/**
+ * Complete profile response from the API
+ * @public
+ */
+export interface ProfileResponse extends NSResponse {
+    /** Email address */
+    email: string | null;
+    /** Content hash */
+    contenthash: string | null;
+    /** Profile header image */
+    header: string | null;
+    /** Geographic location */
+    location: string | null;
+    /** Creation timestamp */
+    createdAt: string | null;
+    /** Profile status */
+    status: string | null;
+    /** Error message if any */
+    error?: string;
+    /** Social platform links */
+    links: SocialLinks;
+    /** Social metrics */
+    social: SocialRecord | {};
+}
+/**
+ * Name service response from the API
+ * @public
+ */
+export interface NSResponse {
+    /** Identifier string */
+    identity: string;
+    /** Associated blockchain address */
+    address: string | null;
+    /** Avatar image URL */
+    avatar: string | null;
+    /** Profile description */
+    description: string | null;
+    /** Platform identifier */
+    platform: string;
+    /** Human-readable display name */
+    displayName: string | null;
+    /** Alternative identities */
+    aliases?: string[];
+}
+/**
+ * Domain information response from the API
+ * @public
+ */
+export interface DomainResponse {
+    /** Domain identifier */
+    identity: string;
+    /** Platform type */
+    platform: Platform;
+    /** Address resolved by this domain */
+    resolvedAddress: string | null;
+    /** Owner's address */
+    ownerAddress: string | null;
+    /** Manager's address */
+    managerAddress: string | null;
+    /** Human-readable display name */
+    displayName: string | null;
+    /** Whether this is the primary domain */
+    isPrimary: boolean;
+    /** Domain status */
+    status: string;
+    /** Creation timestamp */
+    createdAt: string | null;
+    /** Last update timestamp */
+    updatedAt: string | null;
+    /** Expiration timestamp */
+    expiredAt: string | null;
+    /** Content hash */
+    contenthash: string | null;
+    /** Text records */
+    texts: Record<string, string>;
+    /** Address records by network */
+    addresses: Record<Network, string>;
+}
+/**
+ * Configuration options for queries
+ * @public
+ */
+export type QueryOptions = {
+    /** API Key for authentication */
+    apiKey?: string;
+    /** Whether the query should execute */
+    enabled?: boolean;
+};
+/**
+ * Identity string used to query profiles
+ * Can be a plain string or a platform-prefixed string
+ * @public
+ */
+export type IdentityString = string | `${Platform},${string}`;
+/**
+ * Generic query result containing data, loading state, and errors
+ * @public
+ */
+export type QueryResult<T> = {
+    /** Response data or null if not loaded/error */
+    data: T | null;
+    /** Whether the query is in progress */
+    isLoading: boolean;
+    /** Error object if the query failed */
+    error: Error | null;
+};
+/**
+ * Specialized result types for better type safety
+ * @public
+ */
+export type ProfileResult = QueryResult<ProfileResponse>;
+export type NSResult = QueryResult<NSResponse>;
+export type ProfileBatchResult = QueryResult<ProfileResponse[]>;
+export type NSBatchResult = QueryResult<NSResponse[]>;
+export type ProfileUniversalResult = QueryResult<ProfileResponse[]>;
+export type NSUniversalResult = QueryResult<NSResponse[]>;
+export type DomainResult = QueryResult<DomainResponse>;

package/dist/types/hook.js

@@ -0,0 +1,38 @@
+/**
+ * Standard error messages used across the library
+ * @public
+ */
+var ErrorMessages;
+(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";
+})(ErrorMessages || (ErrorMessages = {}));
+/**
+ * API endpoints for different query types
+ * @public
+ */
+var QueryEndpoint;
+(function (QueryEndpoint) {
+    /** Name service endpoint */
+    QueryEndpoint["NS"] = "ns";
+    /** Profile data endpoint */
+    QueryEndpoint["PROFILE"] = "profile";
+    /** Domain information endpoint */
+    QueryEndpoint["DOMAIN"] = "domain";
+})(QueryEndpoint || (QueryEndpoint = {}));
+
+export { ErrorMessages, QueryEndpoint };

package/dist/types/index.cjs

@@ -0,0 +1,38 @@
+'use strict';
+
+var platform = require('./platform.cjs');
+var network = require('./network.cjs');
+var hook = require('./hook.cjs');
+var source = require('./source.cjs');
+var cointype = require('./cointype.cjs');
+
+
+
+Object.defineProperty(exports, 'Platform', {
+	enumerable: true,
+	get: function () { return platform.Platform; }
+});
+Object.defineProperty(exports, 'PlatformSystem', {
+	enumerable: true,
+	get: function () { return platform.PlatformSystem; }
+});
+Object.defineProperty(exports, 'Network', {
+	enumerable: true,
+	get: function () { return network.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.Source; }
+});
+Object.defineProperty(exports, 'CoinType', {
+	enumerable: true,
+	get: function () { return cointype.CoinType; }
+});

package/dist/types/index.d.ts

@@ -1,3 +1,5 @@
-export { useProfile, useNS, useDomain, useUniversalProfile, useUniversalNS, useBatchProfile, useBatchNS, } from "./hooks";
-export * from "./utils/types";
-export * from "./utils/constants";
+export * from "./platform";
+export * from "./network";
+export * from "./hook";
+export * from "./source";
+export * from "./cointype";

package/dist/types/index.js

@@ -0,0 +1,5 @@
+export { Platform, PlatformSystem } from './platform.js';
+export { Network } from './network.js';
+export { ErrorMessages, QueryEndpoint } from './hook.js';
+export { Source } from './source.js';
+export { CoinType } from './cointype.js';

package/dist/types/network.cjs

@@ -0,0 +1,41 @@
+'use strict';
+
+/**
+ * Supported blockchain networks and protocols
+ * @public
+ */
+exports.Network = void 0;
+(function (Network) {
+    Network["aptos"] = "aptos";
+    Network["arbitrum"] = "arbitrum";
+    Network["arbitrum_nova"] = "arbitrum_nova";
+    Network["arbitrum_one"] = "arbitrum_one";
+    Network["apechain"] = "apechain";
+    Network["arweave"] = "arweave";
+    Network["avalanche"] = "avalanche";
+    Network["base"] = "base";
+    Network["bitcoin"] = "bitcoin";
+    Network["binanceSmartChain"] = "binance-smart-chain";
+    Network["bsc"] = "bsc";
+    Network["conflux"] = "conflux";
+    Network["crossbell"] = "crossbell";
+    Network["erc1577"] = "erc1577";
+    Network["ethereum"] = "ethereum";
+    Network["fantom"] = "fantom";
+    Network["farcaster"] = "farcaster";
+    Network["flow"] = "flow";
+    Network["gnosis"] = "gnosis";
+    Network["lens"] = "lens";
+    Network["linea"] = "linea";
+    Network["mastodon"] = "mastodon";
+    Network["optimism"] = "optimism";
+    Network["polygon"] = "polygon";
+    Network["scroll"] = "scroll";
+    Network["snapshot"] = "snapshot";
+    Network["solana"] = "solana";
+    Network["vsl"] = "vsl";
+    Network["xLayer"] = "x-layer";
+    Network["zksync_era"] = "zksync_era";
+    Network["zora"] = "zora";
+    Network["unichain"] = "unichain";
+})(exports.Network || (exports.Network = {}));

package/dist/types/network.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Supported blockchain networks and protocols
+ * @public
+ */
+export 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"
+}
+/**
+ * Network metadata interface containing display and functional information
+ * @public
+ */
+export interface NetworkType {
+    assetPrefix?: string;
+    bgColor: string;
+    chainId?: number;
+    icon: string;
+    key: string;
+    label: string;
+    primaryColor: string;
+    scanLabel?: string;
+    scanPrefix: string;
+    scanPrefixTx?: string;
+    short?: string;
+}

package/dist/types/network.js

@@ -0,0 +1,41 @@
+/**
+ * Supported blockchain networks and protocols
+ * @public
+ */
+var Network;
+(function (Network) {
+    Network["aptos"] = "aptos";
+    Network["arbitrum"] = "arbitrum";
+    Network["arbitrum_nova"] = "arbitrum_nova";
+    Network["arbitrum_one"] = "arbitrum_one";
+    Network["apechain"] = "apechain";
+    Network["arweave"] = "arweave";
+    Network["avalanche"] = "avalanche";
+    Network["base"] = "base";
+    Network["bitcoin"] = "bitcoin";
+    Network["binanceSmartChain"] = "binance-smart-chain";
+    Network["bsc"] = "bsc";
+    Network["conflux"] = "conflux";
+    Network["crossbell"] = "crossbell";
+    Network["erc1577"] = "erc1577";
+    Network["ethereum"] = "ethereum";
+    Network["fantom"] = "fantom";
+    Network["farcaster"] = "farcaster";
+    Network["flow"] = "flow";
+    Network["gnosis"] = "gnosis";
+    Network["lens"] = "lens";
+    Network["linea"] = "linea";
+    Network["mastodon"] = "mastodon";
+    Network["optimism"] = "optimism";
+    Network["polygon"] = "polygon";
+    Network["scroll"] = "scroll";
+    Network["snapshot"] = "snapshot";
+    Network["solana"] = "solana";
+    Network["vsl"] = "vsl";
+    Network["xLayer"] = "x-layer";
+    Network["zksync_era"] = "zksync_era";
+    Network["zora"] = "zora";
+    Network["unichain"] = "unichain";
+})(Network || (Network = {}));
+
+export { Network };

package/dist/types/platform.cjs

@@ -0,0 +1,110 @@
+'use strict';
+
+/**
+ * Supported platform types for identity and social profiles
+ * Includes blockchain networks, name services, and social platforms
+ * @public
+ */
+exports.Platform = void 0;
+(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";
+})(exports.Platform || (exports.Platform = {}));
+/**
+ * Platform system classification
+ * @public
+ */
+exports.PlatformSystem = void 0;
+(function (PlatformSystem) {
+    /** Traditional web platforms */
+    PlatformSystem[PlatformSystem["web2"] = 0] = "web2";
+    /** Blockchain/decentralized platforms */
+    PlatformSystem[PlatformSystem["web3"] = 1] = "web3";
+})(exports.PlatformSystem || (exports.PlatformSystem = {}));

package/dist/types/platform.d.ts

@@ -0,0 +1,122 @@
+/**
+ * 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",
+    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"
+}
+/**
+ * Platform metadata structure
+ * Contains display and functional information about a platform
+ * @public
+ */
+export interface PlatformType {
+    color?: string;
+    icon?: string;
+    label: string;
+    description?: string;
+    urlPrefix?: string;
+    ensText?: string[];
+    registerlink?: string;
+    editUrlPrefix?: string;
+    system: PlatformSystem;
+}
+/**
+ * Platform system classification
+ * @public
+ */
+export declare enum PlatformSystem {
+    /** Traditional web platforms */
+    web2 = 0,
+    /** Blockchain/decentralized platforms */
+    web3 = 1
+}