@yeying-community/web3-bs 1.0.16 → 1.0.17

package/README.md

@@ -26,6 +26,7 @@ npm install @yeying-community/web3-bs
 - `getChainId` / `getBalance`
 - `onAccountsChanged` / `onChainChanged`
 - `classifyWalletError` / `isUserRejectedWalletAction` / `isWalletReconnectError`
+- `connectAndGetWalletProfile` / `requestWalletProfilePermission` / `getWalletProfile`
 
 `requestAccounts` 默认会复用同一 provider 上尚未完成的连接请求，避免用户重复点击时触发多个钱包授权弹窗。
 当钱包已经存在待确认的连接、签名或解锁窗口时，可调用 `focusPendingApproval` 将该窗口重新拉到前台，而不是再发起一次新的请求。

package/dist/auth/index.d.ts

@@ -4,3 +4,4 @@ export * from './siwe';
 export * from './ucan';
 export * from './central';
 export * from './encrypt';
+export * from './profile';

package/dist/auth/profile.d.ts

@@ -0,0 +1,34 @@
+import type { Eip1193Provider } from './types';
+export type WalletProfileField = 'username' | 'email';
+export type WalletProfile = Partial<Record<WalletProfileField, string>>;
+export type WalletProfilePermission = {
+    parentCapability: 'yeying_profile';
+    caveats?: Array<{
+        type?: string;
+        value?: WalletProfileField[] | {
+            fields?: WalletProfileField[];
+            [key: string]: unknown;
+        };
+        [key: string]: unknown;
+    }>;
+    date?: number;
+    [key: string]: unknown;
+};
+export type WalletProfileResult = {
+    address: string;
+    chainId: string | null;
+    profile: WalletProfile;
+};
+export type WalletProfileOptions = {
+    provider?: Eip1193Provider;
+    fields: WalletProfileField[];
+};
+export type ConnectWalletProfileOptions = WalletProfileOptions & {
+    requestPermission?: boolean;
+};
+export declare function getGrantedProfileFields(permission: WalletProfilePermission | null): WalletProfileField[];
+export declare function getWalletProfilePermission(provider?: Eip1193Provider): Promise<WalletProfilePermission | null>;
+export declare function requestWalletProfilePermission(options: WalletProfileOptions): Promise<WalletProfilePermission>;
+export declare function getWalletProfile(options: WalletProfileOptions): Promise<WalletProfileResult>;
+export declare function revokeWalletProfilePermission(provider?: Eip1193Provider): Promise<void>;
+export declare function connectAndGetWalletProfile(options: ConnectWalletProfileOptions): Promise<WalletProfileResult>;

package/dist/web3-bs.esm.js

@@ -2151,6 +2151,111 @@ async function getSupportedCipherSuites(options = {}) {
     }
 }
 
+const SUPPORTED_FIELDS = new Set(['username', 'email']);
+function normalizeFields(fields) {
+    if (!Array.isArray(fields) || fields.length === 0) {
+        throw new Error('Profile fields must contain username and/or email');
+    }
+    const normalized = Array.from(new Set(fields.map(field => String(field))));
+    if (normalized.some(field => !SUPPORTED_FIELDS.has(field))) {
+        throw new Error('Unsupported wallet profile field');
+    }
+    return normalized;
+}
+function parsePermission(value) {
+    if (!value || typeof value !== 'object')
+        return null;
+    const permission = value;
+    return permission.parentCapability === 'yeying_profile' ? permission : null;
+}
+function getGrantedProfileFields(permission) {
+    if (!permission || !Array.isArray(permission.caveats))
+        return [];
+    const fields = permission.caveats.flatMap(caveat => {
+        if (Array.isArray(caveat?.value))
+            return caveat.value;
+        return Array.isArray(caveat?.value?.fields) ? caveat.value.fields : [];
+    });
+    return Array.from(new Set(fields.filter(field => SUPPORTED_FIELDS.has(field))));
+}
+async function getWalletProfilePermission(provider) {
+    const target = provider || (await requireProvider());
+    const permissions = await target.request({ method: 'wallet_getPermissions' });
+    if (!Array.isArray(permissions))
+        return null;
+    return permissions.map(parsePermission).find(Boolean) || null;
+}
+async function requestWalletProfilePermission(options) {
+    const fields = normalizeFields(options.fields);
+    const provider = options.provider || (await requireProvider());
+    const result = await provider.request({
+        method: 'wallet_requestPermissions',
+        params: [{ yeying_profile: { fields } }],
+    });
+    if (!Array.isArray(result)) {
+        throw new Error('Wallet returned an invalid profile permission response');
+    }
+    const permission = result.map(parsePermission).find(Boolean);
+    if (!permission)
+        throw new Error('Wallet did not grant profile permission');
+    const granted = new Set(getGrantedProfileFields(permission));
+    if (fields.some(field => !granted.has(field))) {
+        throw new Error('Wallet did not grant all requested profile fields');
+    }
+    return permission;
+}
+async function getWalletProfile(options) {
+    const fields = normalizeFields(options.fields);
+    const provider = options.provider || (await requireProvider());
+    const result = await provider.request({
+        method: 'yeying_getProfile',
+        params: [{ fields }],
+    });
+    if (!result || typeof result !== 'object') {
+        throw new Error('Wallet returned an invalid profile response');
+    }
+    const value = result;
+    const profileSource = value.profile;
+    if (typeof value.address !== 'string' || !profileSource || typeof profileSource !== 'object') {
+        throw new Error('Wallet returned an invalid profile response');
+    }
+    const profile = {};
+    for (const field of fields) {
+        const fieldValue = profileSource[field];
+        if (typeof fieldValue === 'string')
+            profile[field] = fieldValue;
+    }
+    return {
+        address: value.address,
+        chainId: typeof value.chainId === 'string' ? value.chainId : null,
+        profile,
+    };
+}
+async function revokeWalletProfilePermission(provider) {
+    const target = provider || (await requireProvider());
+    await target.request({
+        method: 'wallet_revokePermissions',
+        params: [{ yeying_profile: {} }],
+    });
+}
+async function connectAndGetWalletProfile(options) {
+    const fields = normalizeFields(options.fields);
+    const provider = options.provider || (await requireProvider());
+    const accounts = await provider.request({ method: 'eth_requestAccounts' });
+    if (!Array.isArray(accounts) || typeof accounts[0] !== 'string') {
+        throw new Error('Wallet did not return an account');
+    }
+    if (options.requestPermission !== false) {
+        const permission = await getWalletProfilePermission(provider);
+        const granted = new Set(getGrantedProfileFields(permission));
+        const missing = fields.filter(field => !granted.has(field));
+        if (missing.length > 0) {
+            await requestWalletProfilePermission({ provider, fields: missing });
+        }
+    }
+    return getWalletProfile({ provider, fields });
+}
+
 function normalizeBaseUrl(baseUrl) {
     return baseUrl.replace(/\/+$/, '');
 }
@@ -2696,5 +2801,5 @@ async function initDappSession(options) {
     return result;
 }
 
-export { CipherError, DEFAULT_UCAN_SESSION_TTL_MS, DEFAULT_UCAN_TOKEN_SKEW_MS, DEFAULT_UCAN_TOKEN_TTL_MS, WebDavClient, authCentralUcanFetch, authFetch, authUcanFetch, base64ToBytes, bytesToBase64, classifyUcanAuthError, classifyWalletError, clearAccessToken, clearCentralSessionToken, clearUcanSession, createAndIssueCentralUcan, createCentralSession, createDelegationUcan, createInvocationUcan, createRootUcan, createUcanSession, createWebDavClient, decodeUcanPayload, decrypt, deriveAppIdFromHost, deriveAppIdFromLocation, encrypt, focusPendingApproval, getAccessToken, getAccounts, getBalance, getCapabilityAction, getCapabilityResource, getCentralIssuerInfo, getCentralSessionToken, getChainId, getOrCreateInvocationUcan, getOrCreateUcanRoot, getPreferredAccount, getProvider, getStoredUcanRoot, getSupportedCipherSuites, getUcanSession, getUcanTokenTiming, getWalletErrorCode, getWalletErrorMessage, initDappSession, initWebDavStorage, isUcanTokenFresh, isUserRejectedWalletAction, isWalletReconnectError, isYeYingProvider, issueCentralUcan, loginWithChallenge, logout, normalizeAppHostnameForAppId, normalizeUcanCapabilities, normalizeUcanCapability, normalizeUcanExpiry, onAccountsChanged, onChainChanged, parseUcanAccountFromIssuer, refreshAccessToken, requestAccounts, requireProvider, resolveUcanAuthorization, resolveWalletAccount, setAccessToken, setCentralSessionToken, signMessage, storeUcanRoot, watchAccounts, watchProvider };
+export { CipherError, DEFAULT_UCAN_SESSION_TTL_MS, DEFAULT_UCAN_TOKEN_SKEW_MS, DEFAULT_UCAN_TOKEN_TTL_MS, WebDavClient, authCentralUcanFetch, authFetch, authUcanFetch, base64ToBytes, bytesToBase64, classifyUcanAuthError, classifyWalletError, clearAccessToken, clearCentralSessionToken, clearUcanSession, connectAndGetWalletProfile, createAndIssueCentralUcan, createCentralSession, createDelegationUcan, createInvocationUcan, createRootUcan, createUcanSession, createWebDavClient, decodeUcanPayload, decrypt, deriveAppIdFromHost, deriveAppIdFromLocation, encrypt, focusPendingApproval, getAccessToken, getAccounts, getBalance, getCapabilityAction, getCapabilityResource, getCentralIssuerInfo, getCentralSessionToken, getChainId, getGrantedProfileFields, getOrCreateInvocationUcan, getOrCreateUcanRoot, getPreferredAccount, getProvider, getStoredUcanRoot, getSupportedCipherSuites, getUcanSession, getUcanTokenTiming, getWalletErrorCode, getWalletErrorMessage, getWalletProfile, getWalletProfilePermission, initDappSession, initWebDavStorage, isUcanTokenFresh, isUserRejectedWalletAction, isWalletReconnectError, isYeYingProvider, issueCentralUcan, loginWithChallenge, logout, normalizeAppHostnameForAppId, normalizeUcanCapabilities, normalizeUcanCapability, normalizeUcanExpiry, onAccountsChanged, onChainChanged, parseUcanAccountFromIssuer, refreshAccessToken, requestAccounts, requestWalletProfilePermission, requireProvider, resolveUcanAuthorization, resolveWalletAccount, revokeWalletProfilePermission, setAccessToken, setCentralSessionToken, signMessage, storeUcanRoot, watchAccounts, watchProvider };
 //# sourceMappingURL=web3-bs.esm.js.map