web3bio-profile-kit 0.1.2 → 0.1.4

package/dist/hooks/useUniversalNS.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 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.useBaseQuery(identity, hook.QueryEndpoint.NS, true, options);
+}
+
+exports.useUniversalNS = useUniversalNS;

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

@@ -1,4 +1,4 @@
-import type { QueryOptions, IdentityString, NSUniversalResult } from "../utils/types";
+import { type QueryOptions, type IdentityString, type NSUniversalResult } from "../types";
 /**
  * Hook to query Web3.bio name service (NS) data using universal identity lookup
  *

package/dist/hooks/useUniversalNS.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 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, QueryEndpoint.NS, true, options);
+}
+
+export { useUniversalNS };

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,247 +1,3 @@
-declare enum PlatformType {
-    ens = "ens",
-    farcaster = "farcaster",
-    lens = "lens",
-    ethereum = "ethereum",
-    twitter = "twitter",
-    github = "github",
-    bitcoin = "bitcoin",
-    unstoppableDomains = "unstoppabledomains",
-    basenames = "basenames",
-    linea = "linea",
-    space_id = "space_id",
-    solana = "solana",
-    sns = "sns",
-    nextid = "nextid",
-    dotbit = "dotbit"
-}
-declare enum SourceType {
-    ethereum = "ethereum",
-    ens = "ens",
-    twitter = "twitter",
-    nextid = "nextid",
-    dotbit = "dotbit",
-    unstoppabledomains = "unstoppabledomains",
-    lens = "lens",
-    farcaster = "farcaster",
-    space_id = "space_id",
-    solana = "solana",
-    sns = "sns"
-}
-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;
-    email: string | null;
-    contenthash: string | null;
-    header: string | null;
-    location: string | null;
-    createdAt: string | null;
-    status: string | null;
-    error?: string;
-    links: SocialLinks;
-    aliases?: string[];
-    social: {
-        uid: number | null;
-        follower: number;
-        following: number;
-    } | {};
-}
-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<string, 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;
-};
-
-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 };
+export * from "./hooks";
+export * from "./utils";
+export * from "./types";