@keetanetwork/anchor 0.0.39 → 0.0.41

package/services/username/client.d.ts

@@ -0,0 +1,145 @@
+import { lib as KeetaNetLib } from '@keetanetwork/keetanet-client';
+import { getDefaultResolver } from '../../config.js';
+import type { UserClient as KeetaNetUserClient } from '@keetanetwork/keetanet-client';
+import type { Logger } from '../../lib/log/index.ts';
+import Resolver from '../../lib/resolver.js';
+import type { ServiceMetadata, ServiceMetadataAuthenticationType, SharedLookupCriteria } from '../../lib/resolver.ts';
+import type { BrandedString } from '../../lib/utils/brand.ts';
+import type { TransferUsernameOwnershipSignablePayload, KeetaUsernameAnchorUsernameWithAccount, KeetaUsernameAnchorSearchRequestParameters } from './common.js';
+import { type KeetaNetAccount, type GloballyIdentifiableUsername } from './common.js';
+import type { HTTPSignedField } from '../../lib/http-server/common.js';
+export type KeetaUsernameAnchorClientConfig = {
+    id?: string;
+    logger?: Logger | undefined;
+    resolver?: Resolver;
+    signer?: InstanceType<typeof KeetaNetLib.Account>;
+    account?: InstanceType<typeof KeetaNetLib.Account>;
+} & Omit<NonNullable<Parameters<typeof getDefaultResolver>[1]>, 'client'>;
+type ProviderID = BrandedString<'UsernameProviderID'>;
+type KeetaUsernameAnchorOperations = {
+    [operation in keyof NonNullable<ServiceMetadata['services']['username']>[string]['operations']]?: {
+        url: (params?: {
+            [key: string]: string;
+        }) => URL;
+        options: {
+            authentication: ServiceMetadataAuthenticationType;
+        };
+    };
+};
+type KeetaUsernameServiceInfo = {
+    operations: {
+        [operation in keyof KeetaUsernameAnchorOperations]: Promise<KeetaUsernameAnchorOperations[operation]>;
+    };
+    usernamePattern?: string;
+};
+type ClaimUsernameOptions = {
+    account?: KeetaNetAccount | undefined;
+    transfer?: {
+        from: KeetaNetAccount | string;
+        signed?: HTTPSignedField;
+    };
+};
+interface KeetaUsernameAnchorBaseConfig {
+    client: KeetaNetUserClient;
+    logger?: Logger | undefined;
+    account?: InstanceType<typeof KeetaNetLib.Account> | undefined;
+    signer?: InstanceType<typeof KeetaNetLib.Account> | undefined;
+}
+declare class KeetaUsernameAnchorBase {
+    protected readonly client: KeetaNetUserClient;
+    protected readonly logger?: Logger | undefined;
+    protected readonly account?: InstanceType<typeof KeetaNetLib.Account> | undefined;
+    protected readonly signer?: InstanceType<typeof KeetaNetLib.Account> | undefined;
+    constructor(config: KeetaUsernameAnchorBaseConfig);
+}
+export interface KeetaUsernameAnchorUsernameWithAccountAndProvider extends KeetaUsernameAnchorUsernameWithAccount {
+    providerID: ProviderID;
+    globallyIdentifiableUsername: GloballyIdentifiableUsername;
+}
+declare class KeetaUsernameAnchorProvider extends KeetaUsernameAnchorBase {
+    #private;
+    readonly serviceInfo: KeetaUsernameServiceInfo;
+    readonly providerID: ProviderID;
+    private readonly parent;
+    constructor(serviceInfo: KeetaUsernameServiceInfo, providerID: ProviderID, parent: KeetaUsernameAnchorClient);
+    get usernamePattern(): string | undefined;
+    /**
+     * Check if a username is valid according to the provider's username pattern if set and default validation.
+     * @param username The username to check
+     * @returns True if the username is valid, false otherwise
+     */
+    isUsernameValid(username: string): boolean;
+    /**
+     * Resolve a username for a specific provider
+     * @param input The value to lookup, can be a username, PublicKeyString, or an account
+     * @returns The resolved account and username, or null if not found
+     */
+    resolve(input: string | KeetaNetAccount): Promise<KeetaUsernameAnchorUsernameWithAccountAndProvider | null>;
+    /**
+     * Claim a username for a specific provider
+     * @param usernameInput The username to claim
+     * @param options The account to claim for, and options related to transfer if applicable
+     * @returns True if the claim was successful, false otherwise
+     */
+    claimUsername(usernameInput: string, options?: ClaimUsernameOptions): Promise<boolean>;
+    /**
+     * Release a username for a specific provider
+     * @param options The account to claim for, and options related to transfer if applicable
+     * @returns True if the claim was successful, false otherwise
+     */
+    releaseUsername(input?: {
+        account?: KeetaNetAccount;
+    }): Promise<boolean>;
+    /**
+     * Release a username for a specific provider
+     * @param options The account to claim for, and options related to transfer if applicable
+     * @returns True if the claim was successful, false otherwise
+     */
+    search(parameters: KeetaUsernameAnchorSearchRequestParameters): Promise<{
+        results: KeetaUsernameAnchorUsernameWithAccountAndProvider[];
+    }>;
+}
+declare class KeetaUsernameAnchorClient extends KeetaUsernameAnchorBase {
+    #private;
+    readonly resolver: Resolver;
+    readonly id: string;
+    constructor(client: KeetaNetUserClient, config?: KeetaUsernameAnchorClientConfig);
+    getProvider(providerID: string, shared?: SharedLookupCriteria): Promise<KeetaUsernameAnchorProvider | null>;
+    /**
+     * Resolve a globally identifiable username via the appropriate provider.
+     * @param username The globally identifiable username to resolve
+     * @param shared Shared resolver lookup criteria
+     * @returns The resolution result, or null if not found
+     */
+    resolve(username: GloballyIdentifiableUsername, shared?: SharedLookupCriteria): ReturnType<KeetaUsernameAnchorProvider['resolve']>;
+    /**
+     * Resolve against all username providers for the given input.
+     * @param input The value to search for, either a globally identifiable username, a username, or an account
+     * @param shared Shared lookup criteria
+     * @returns A mapping of provider IDs to their resolution results, or null if no providers found a match
+     */
+    resolveMulti(input: string | KeetaNetAccount | GloballyIdentifiableUsername, shared?: SharedLookupCriteria): Promise<({
+        [providerId: ProviderID]: Awaited<ReturnType<KeetaUsernameAnchorProvider['resolve']>>;
+    }) | null>;
+    /**
+     * Resolve against all username providers for the given input.
+     * @param input The value to search for, either a globally identifiable username, a username, or an account
+     * @param shared Shared lookup criteria
+     * @returns A mapping of provider IDs to their resolution results, or null if no providers found a match
+     */
+    search(parameters: KeetaUsernameAnchorSearchRequestParameters, responseType: 'separate', shared?: SharedLookupCriteria): Promise<({
+        [providerId: ProviderID]: Awaited<ReturnType<KeetaUsernameAnchorProvider['search']>>;
+    }) | null>;
+    search(parameters: KeetaUsernameAnchorSearchRequestParameters, responseType?: 'joined', shared?: SharedLookupCriteria): Promise<Awaited<ReturnType<KeetaUsernameAnchorProvider['search']>> | null>;
+    /**
+     * Claim a globally identifiable username from the appropriate provider.
+     * @param input The globally identifiable username to claim
+     * @param options Claim options
+     * @returns True if the claim was successful, false otherwise
+     */
+    claimUsername(input: GloballyIdentifiableUsername, options?: ClaimUsernameOptions, shared?: SharedLookupCriteria): ReturnType<KeetaUsernameAnchorProvider['claimUsername']>;
+    signUsernameTransfer(request: Omit<TransferUsernameOwnershipSignablePayload, 'from'>, from?: KeetaNetAccount): Promise<HTTPSignedField>;
+}
+export default KeetaUsernameAnchorClient;
+export { KeetaUsernameAnchorProvider };
+//# sourceMappingURL=client.d.ts.map

package/services/username/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/services/username/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,IAAI,WAAW,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EACX,UAAU,IAAI,kBAAkB,EAChC,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,QAAQ,MAAM,uBAAuB,CAAC;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,iCAAiC,EAAkD,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAEtK,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAG9D,OAAO,KAAK,EACX,wCAAwC,EAExC,sCAAsC,EACtC,0CAA0C,EAE1C,MAAM,aAAa,CAAC;AACrB,OAAO,EAMN,KAAK,eAAe,EACpB,KAAK,4BAA4B,EASjC,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAa,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAGlF,MAAM,MAAM,+BAA+B,GAAG;IAC7C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;IAClD,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;CACnD,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;AAE1E,KAAK,UAAU,GAAG,aAAa,CAAC,oBAAoB,CAAC,CAAC;AAWtD,KAAK,6BAA6B,GAAG;KACnC,SAAS,IAAI,MAAM,WAAW,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE;QACjG,GAAG,EAAE,CAAC,MAAM,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;SAAE,KAAK,GAAG,CAAC;QAClD,OAAO,EAAE;YACR,cAAc,EAAE,iCAAiC,CAAC;SAClD,CAAC;KACF;CACD,CAAC;AAEF,KAAK,wBAAwB,GAAG;IAC/B,UAAU,EAAE;SACV,SAAS,IAAI,MAAM,6BAA6B,GAAG,OAAO,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC;KACrG,CAAC;IACF,eAAe,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAOF,KAAK,oBAAoB,GAAG;IAC3B,OAAO,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,EAAE;QACV,IAAI,EAAE,eAAe,GAAG,MAAM,CAAC;QAC/B,MAAM,CAAC,EAAE,eAAe,CAAC;KACzB,CAAC;CACF,CAAC;AAkGF,UAAU,6BAA6B;IACtC,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAC/D,MAAM,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;CAC9D;AAED,cAAM,uBAAuB;IAC5B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;IAC9C,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IAClF,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;gBAErE,MAAM,EAAE,6BAA6B;CAMjD;AAED,MAAM,WAAW,iDAAkD,SAAQ,sCAAsC;IAChH,UAAU,EAAE,UAAU,CAAC;IACvB,4BAA4B,EAAE,4BAA4B,CAAC;CAC3D;AAED,cAAM,2BAA4B,SAAQ,uBAAuB;;IAChE,QAAQ,CAAC,WAAW,EAAE,wBAAwB,CAAC;IAC/C,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAEhC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4B;gBAEvC,WAAW,EAAE,wBAAwB,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,yBAAyB;IAgB5G,IAAI,eAAe,IAAI,MAAM,GAAG,SAAS,CAExC;IAED;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAgE1C;;;;OAIG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,GAAG,OAAO,CAAC,iDAAiD,GAAG,IAAI,CAAC;IAuDjH;;;;;OAKG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IA0F5F;;;;OAIG;IACG,eAAe,CAAC,KAAK,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,eAAe,CAAC;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IA4C/E;;;;OAIG;IACG,MAAM,CAAC,UAAU,EAAE,0CAA0C,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,iDAAiD,EAAE,CAAC;KAAE,CAAC;CAyChJ;AAED,cAAM,yBAA0B,SAAQ,uBAAuB;;IAC9D,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;gBAER,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAE,+BAAoC;IAuB9E,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,2BAA2B,GAAG,IAAI,CAAC;IAkBjH;;;;;OAKG;IACG,OAAO,CAAC,QAAQ,EAAE,4BAA4B,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,UAAU,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC;IAOxI;;;;;OAKG;IAEG,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,GAAG,4BAA4B,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,CAAC;QAC3H,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;KACtF,CAAC,GAAG,IAAI,CAAC;IA4CV;;;;;OAKG;IAEG,MAAM,CAAC,UAAU,EAAE,0CAA0C,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,CAAC;QAAE,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;KAAE,CAAC,GAAG,IAAI,CAAC;IACpO,MAAM,CAAC,UAAU,EAAE,0CAA0C,EAAE,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAqCxM;;;;;OAKG;IACG,aAAa,CAAC,KAAK,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,oBAAoB,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,UAAU,CAAC,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAM3K,oBAAoB,CAAC,OAAO,EAAE,IAAI,CAAC,wCAAwC,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;CA4B7I;AAED,eAAe,yBAAyB,CAAC;AACzC,OAAO,EAAE,2BAA2B,EAAE,CAAC"}