@avacuscc/sdk 0.1.0

package/packages/sdk/dist/sns-D0rtlsZp.d.mts

@@ -0,0 +1,267 @@
+type AvacusEnvironment = 'prod' | 'dev' | 'stg';
+declare const AVACUS_ENDPOINTS: Record<AvacusEnvironment, string>;
+interface BaseClientOptions {
+    baseUrl?: string;
+    env?: AvacusEnvironment;
+    headers?: Record<string, string>;
+}
+interface ResolvedClientSettings {
+    env: AvacusEnvironment;
+    baseUrl: string;
+    headers?: Record<string, string>;
+}
+declare function resolveAvacusBaseUrl(options: BaseClientOptions): string;
+declare function resolveClientSettings(options?: BaseClientOptions): ResolvedClientSettings;
+declare function isKnownAvacusBaseUrl(baseUrl: string): boolean;
+declare function resolveServiceUrl(baseUrl: string, servicePath: string): string;
+
+interface AuthState {
+    accessToken?: string;
+}
+interface RequestOptions {
+    /**
+     * When `true`, the adapter requires a previously stored JWT access token and
+     * automatically sends it as `Authorization: Bearer <token>`.
+     */
+    auth?: boolean;
+    /**
+     * Optional per-request headers merged on top of adapter default headers.
+     */
+    headers?: Record<string, string>;
+}
+declare class HttpAdapter {
+    private readonly baseUrl;
+    private readonly headers;
+    private readonly authState;
+    /**
+     * Creates a reusable HTTP transport bound to one service base URL.
+     *
+     * @param baseUrl Absolute base URL for the target service namespace.
+     * @param headers Default headers sent with every request.
+     * @param authState Shared mutable auth state so multiple adapters can reuse the same JWT.
+     */
+    constructor(baseUrl: string, headers?: Record<string, string>, authState?: AuthState);
+    /**
+     * Stores the JWT access token used by authenticated requests.
+     *
+     * @param accessToken JWT returned by the authentication flow.
+     */
+    setAccessToken(accessToken: string): void;
+    /**
+     * Removes the currently stored JWT access token from shared auth state.
+     */
+    clearAccessToken(): void;
+    /**
+     * Returns the currently stored JWT access token, if any.
+     */
+    getAccessToken(): string | undefined;
+    /**
+     * Sends an HTTP GET request to a path relative to this adapter base URL.
+     *
+     * @param path Relative endpoint path.
+     * @param options Request behavior such as auth requirement and extra headers.
+     */
+    get<T = unknown>(path: string, options?: RequestOptions): Promise<T>;
+    /**
+     * Sends an HTTP POST request with a JSON body to a path relative to this adapter base URL.
+     *
+     * @param path Relative endpoint path.
+     * @param body Serializable request payload.
+     * @param options Request behavior such as auth requirement and extra headers.
+     */
+    post<T = unknown>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    /**
+     * Builds the final request headers by combining default headers, per-request
+     * headers, and an authorization header when the request requires auth.
+     */
+    private buildHeaders;
+    /**
+     * Resolves a relative path against the adapter base URL.
+     */
+    private buildUrl;
+    /**
+     * Parses a JSON response and converts non-2xx responses into descriptive errors.
+     */
+    private parseResponse;
+}
+
+type SignMessageFn = (message: string) => Promise<string>;
+interface SnsLoginParams {
+    walletAddress: string;
+    signMessage: SignMessageFn;
+}
+interface SnsGetNonceParams {
+    walletAddress: string;
+}
+interface SnsAuthenticateParams {
+    walletAddress: string;
+    message: string;
+    signature: string;
+}
+interface SnsAuthTokenPayload {
+    wallet_address: string;
+    message: string;
+    signature: string;
+}
+interface SnsGetProfilesParams {
+    wallets?: string[];
+    userIds?: string[];
+    includeDevices?: boolean;
+}
+interface SnsAvatar {
+    id: string;
+    url: string;
+}
+interface SnsDevice {
+    id: string;
+    device_token: string;
+    app_name: string;
+    app_version: string;
+    platform: string;
+}
+interface SnsProfile {
+    id: string;
+    wallet_address: string;
+    display_name?: string;
+    description?: string;
+    unread_count?: string;
+    avatar?: SnsAvatar;
+    devices?: SnsDevice[];
+}
+interface SnsCreateUserDeviceParams {
+    deviceToken?: string;
+    appName?: string;
+    appVersion?: string;
+    platform?: string;
+}
+interface SnsCreateUserParams {
+    walletAddress: string;
+    signMessage: SignMessageFn;
+    publicKey?: string;
+    displayName?: string;
+    description?: string;
+    device?: SnsCreateUserDeviceParams;
+}
+interface SnsCreateUserWithSignatureParams {
+    walletAddress: string;
+    message: string;
+    signature: string;
+    publicKey?: string;
+    displayName?: string;
+    description?: string;
+    device?: SnsCreateUserDeviceParams;
+}
+interface SnsCreateUserPayload {
+    wallet_address: string;
+    message: string;
+    signature: string;
+    public_key?: string;
+    display_name?: string;
+    description?: string;
+    device?: {
+        device_token?: string;
+        app_name?: string;
+        app_version?: string;
+        platform?: string;
+    };
+}
+type SnsCreateUserResult = Record<string, unknown>;
+interface SnsNonceResponse {
+    nonce: string;
+}
+type SnsLoginResult = Record<string, unknown>;
+interface SnsServiceOptions {
+    baseSignedMessage?: string;
+}
+
+declare const DEFAULT_BASE_SIGNED_MESSAGE = "Hi there from Avacus Wallet! Please sign this message to prove that you can access to secure chat. To stop hackers access to your secure chat, do not sign this message outside Avacus Wallet, and here's a unique message ID they can't guess: ";
+/**
+ * Base path for all SNS endpoints. The client composes this with the resolved
+ * environment host before injecting the HTTP adapter into the service.
+ */
+declare const SNS_SERVICE_PATH = "1/secure-chat/";
+declare class SnsService {
+    private readonly http;
+    private readonly options;
+    /**
+     * Creates the SNS service using a service-scoped HTTP adapter.
+     *
+     * @param http Adapter already configured for the SNS base path.
+     * @param options Optional SNS-specific behavior.
+     */
+    constructor(http: HttpAdapter, options?: SnsServiceOptions);
+    /**
+     * Requests a one-time nonce used to construct the login signature message.
+     * This endpoint is public and does not require a JWT token.
+     *
+     * @param params Wallet identity used by the backend to mint a nonce.
+     */
+    getNonce(params: SnsGetNonceParams): Promise<SnsNonceResponse>;
+    /**
+     * Exchanges a signed message payload for an SNS auth token.
+     * This is the low-level authentication endpoint behind `login()`.
+     *
+     * @param params Payload expected by the SNS auth API.
+     */
+    requestAuthToken(params: SnsAuthTokenPayload): Promise<SnsLoginResult>;
+    /**
+     * Returns public user profiles for a batch of wallet addresses and/or user IDs.
+     * This endpoint is public and does not require authentication.
+     *
+     * @param params Query payload with wallet addresses and/or user IDs.
+     */
+    getPublicProfiles(params: SnsGetProfilesParams): Promise<SnsProfile[]>;
+    /**
+     * Creates a new SNS user account using only the inputs the application already knows:
+     * wallet address, signer callback, and optional user profile metadata.
+     * The SDK internally fetches a nonce, builds the canonical message, requests
+     * the signature, and submits the create-user payload.
+     *
+     * @param params User creation payload in SDK-friendly camelCase format.
+     */
+    createUser(params: SnsCreateUserParams): Promise<SnsCreateUserResult>;
+    /**
+     * Low-level create-user API for callers that already have a prepared message
+     * and signature and want direct control over the exact payload.
+     *
+     * @param params Signed create-user payload.
+     */
+    createUserWithSignature(params: SnsCreateUserWithSignatureParams): Promise<SnsCreateUserResult>;
+    /**
+     * Adapts camelCase SDK parameters to the snake_case payload expected by the backend.
+     *
+     * @param params Wallet address, signed message, and signature returned by the signer.
+     */
+    authenticate(params: SnsAuthenticateParams): Promise<SnsLoginResult>;
+    /**
+     * Executes the full SNS login flow:
+     * 1. fetch nonce
+     * 2. build login message
+     * 3. sign message via injected signer callback
+     * 4. exchange signature for JWT
+     * 5. persist token in shared HTTP auth state
+     *
+     * @param params Wallet address and async signing callback.
+     */
+    login(params: SnsLoginParams): Promise<SnsLoginResult>;
+    /**
+     * Builds the exact message string that the wallet must sign during login.
+     */
+    private buildLoginMessage;
+}
+/**
+ * Convenience helper mirroring `sns.login(params)` for functional-style usage.
+ */
+declare function loginWithSns(sns: SnsService, params: SnsLoginParams): Promise<SnsLoginResult>;
+
+interface SnsAuthClientOptions extends SnsServiceOptions, BaseClientOptions {
+}
+declare class SnsAuthClient extends SnsService {
+    private readonly settings;
+    private readonly usingCustomBaseUrl;
+    constructor(options?: SnsAuthClientOptions);
+    getSettings(): ResolvedClientSettings;
+    isUsingCustomBaseUrl(): boolean;
+}
+
+export { AVACUS_ENDPOINTS as A, type BaseClientOptions as B, resolveClientSettings as C, DEFAULT_BASE_SIGNED_MESSAGE as D, resolveServiceUrl as E, HttpAdapter as H, type RequestOptions as R, SnsService as S, type AuthState as a, type AvacusEnvironment as b, type ResolvedClientSettings as c, SNS_SERVICE_PATH as d, type SignMessageFn as e, SnsAuthClient as f, type SnsAuthClientOptions as g, type SnsAuthTokenPayload as h, type SnsAuthenticateParams as i, type SnsAvatar as j, type SnsCreateUserDeviceParams as k, type SnsCreateUserParams as l, type SnsCreateUserPayload as m, type SnsCreateUserResult as n, type SnsCreateUserWithSignatureParams as o, type SnsDevice as p, type SnsGetNonceParams as q, type SnsGetProfilesParams as r, type SnsLoginParams as s, type SnsLoginResult as t, type SnsNonceResponse as u, type SnsProfile as v, type SnsServiceOptions as w, isKnownAvacusBaseUrl as x, loginWithSns as y, resolveAvacusBaseUrl as z };

package/packages/sdk/dist/sns-D0rtlsZp.d.ts

@@ -0,0 +1,267 @@
+type AvacusEnvironment = 'prod' | 'dev' | 'stg';
+declare const AVACUS_ENDPOINTS: Record<AvacusEnvironment, string>;
+interface BaseClientOptions {
+    baseUrl?: string;
+    env?: AvacusEnvironment;
+    headers?: Record<string, string>;
+}
+interface ResolvedClientSettings {
+    env: AvacusEnvironment;
+    baseUrl: string;
+    headers?: Record<string, string>;
+}
+declare function resolveAvacusBaseUrl(options: BaseClientOptions): string;
+declare function resolveClientSettings(options?: BaseClientOptions): ResolvedClientSettings;
+declare function isKnownAvacusBaseUrl(baseUrl: string): boolean;
+declare function resolveServiceUrl(baseUrl: string, servicePath: string): string;
+
+interface AuthState {
+    accessToken?: string;
+}
+interface RequestOptions {
+    /**
+     * When `true`, the adapter requires a previously stored JWT access token and
+     * automatically sends it as `Authorization: Bearer <token>`.
+     */
+    auth?: boolean;
+    /**
+     * Optional per-request headers merged on top of adapter default headers.
+     */
+    headers?: Record<string, string>;
+}
+declare class HttpAdapter {
+    private readonly baseUrl;
+    private readonly headers;
+    private readonly authState;
+    /**
+     * Creates a reusable HTTP transport bound to one service base URL.
+     *
+     * @param baseUrl Absolute base URL for the target service namespace.
+     * @param headers Default headers sent with every request.
+     * @param authState Shared mutable auth state so multiple adapters can reuse the same JWT.
+     */
+    constructor(baseUrl: string, headers?: Record<string, string>, authState?: AuthState);
+    /**
+     * Stores the JWT access token used by authenticated requests.
+     *
+     * @param accessToken JWT returned by the authentication flow.
+     */
+    setAccessToken(accessToken: string): void;
+    /**
+     * Removes the currently stored JWT access token from shared auth state.
+     */
+    clearAccessToken(): void;
+    /**
+     * Returns the currently stored JWT access token, if any.
+     */
+    getAccessToken(): string | undefined;
+    /**
+     * Sends an HTTP GET request to a path relative to this adapter base URL.
+     *
+     * @param path Relative endpoint path.
+     * @param options Request behavior such as auth requirement and extra headers.
+     */
+    get<T = unknown>(path: string, options?: RequestOptions): Promise<T>;
+    /**
+     * Sends an HTTP POST request with a JSON body to a path relative to this adapter base URL.
+     *
+     * @param path Relative endpoint path.
+     * @param body Serializable request payload.
+     * @param options Request behavior such as auth requirement and extra headers.
+     */
+    post<T = unknown>(path: string, body?: unknown, options?: RequestOptions): Promise<T>;
+    /**
+     * Builds the final request headers by combining default headers, per-request
+     * headers, and an authorization header when the request requires auth.
+     */
+    private buildHeaders;
+    /**
+     * Resolves a relative path against the adapter base URL.
+     */
+    private buildUrl;
+    /**
+     * Parses a JSON response and converts non-2xx responses into descriptive errors.
+     */
+    private parseResponse;
+}
+
+type SignMessageFn = (message: string) => Promise<string>;
+interface SnsLoginParams {
+    walletAddress: string;
+    signMessage: SignMessageFn;
+}
+interface SnsGetNonceParams {
+    walletAddress: string;
+}
+interface SnsAuthenticateParams {
+    walletAddress: string;
+    message: string;
+    signature: string;
+}
+interface SnsAuthTokenPayload {
+    wallet_address: string;
+    message: string;
+    signature: string;
+}
+interface SnsGetProfilesParams {
+    wallets?: string[];
+    userIds?: string[];
+    includeDevices?: boolean;
+}
+interface SnsAvatar {
+    id: string;
+    url: string;
+}
+interface SnsDevice {
+    id: string;
+    device_token: string;
+    app_name: string;
+    app_version: string;
+    platform: string;
+}
+interface SnsProfile {
+    id: string;
+    wallet_address: string;
+    display_name?: string;
+    description?: string;
+    unread_count?: string;
+    avatar?: SnsAvatar;
+    devices?: SnsDevice[];
+}
+interface SnsCreateUserDeviceParams {
+    deviceToken?: string;
+    appName?: string;
+    appVersion?: string;
+    platform?: string;
+}
+interface SnsCreateUserParams {
+    walletAddress: string;
+    signMessage: SignMessageFn;
+    publicKey?: string;
+    displayName?: string;
+    description?: string;
+    device?: SnsCreateUserDeviceParams;
+}
+interface SnsCreateUserWithSignatureParams {
+    walletAddress: string;
+    message: string;
+    signature: string;
+    publicKey?: string;
+    displayName?: string;
+    description?: string;
+    device?: SnsCreateUserDeviceParams;
+}
+interface SnsCreateUserPayload {
+    wallet_address: string;
+    message: string;
+    signature: string;
+    public_key?: string;
+    display_name?: string;
+    description?: string;
+    device?: {
+        device_token?: string;
+        app_name?: string;
+        app_version?: string;
+        platform?: string;
+    };
+}
+type SnsCreateUserResult = Record<string, unknown>;
+interface SnsNonceResponse {
+    nonce: string;
+}
+type SnsLoginResult = Record<string, unknown>;
+interface SnsServiceOptions {
+    baseSignedMessage?: string;
+}
+
+declare const DEFAULT_BASE_SIGNED_MESSAGE = "Hi there from Avacus Wallet! Please sign this message to prove that you can access to secure chat. To stop hackers access to your secure chat, do not sign this message outside Avacus Wallet, and here's a unique message ID they can't guess: ";
+/**
+ * Base path for all SNS endpoints. The client composes this with the resolved
+ * environment host before injecting the HTTP adapter into the service.
+ */
+declare const SNS_SERVICE_PATH = "1/secure-chat/";
+declare class SnsService {
+    private readonly http;
+    private readonly options;
+    /**
+     * Creates the SNS service using a service-scoped HTTP adapter.
+     *
+     * @param http Adapter already configured for the SNS base path.
+     * @param options Optional SNS-specific behavior.
+     */
+    constructor(http: HttpAdapter, options?: SnsServiceOptions);
+    /**
+     * Requests a one-time nonce used to construct the login signature message.
+     * This endpoint is public and does not require a JWT token.
+     *
+     * @param params Wallet identity used by the backend to mint a nonce.
+     */
+    getNonce(params: SnsGetNonceParams): Promise<SnsNonceResponse>;
+    /**
+     * Exchanges a signed message payload for an SNS auth token.
+     * This is the low-level authentication endpoint behind `login()`.
+     *
+     * @param params Payload expected by the SNS auth API.
+     */
+    requestAuthToken(params: SnsAuthTokenPayload): Promise<SnsLoginResult>;
+    /**
+     * Returns public user profiles for a batch of wallet addresses and/or user IDs.
+     * This endpoint is public and does not require authentication.
+     *
+     * @param params Query payload with wallet addresses and/or user IDs.
+     */
+    getPublicProfiles(params: SnsGetProfilesParams): Promise<SnsProfile[]>;
+    /**
+     * Creates a new SNS user account using only the inputs the application already knows:
+     * wallet address, signer callback, and optional user profile metadata.
+     * The SDK internally fetches a nonce, builds the canonical message, requests
+     * the signature, and submits the create-user payload.
+     *
+     * @param params User creation payload in SDK-friendly camelCase format.
+     */
+    createUser(params: SnsCreateUserParams): Promise<SnsCreateUserResult>;
+    /**
+     * Low-level create-user API for callers that already have a prepared message
+     * and signature and want direct control over the exact payload.
+     *
+     * @param params Signed create-user payload.
+     */
+    createUserWithSignature(params: SnsCreateUserWithSignatureParams): Promise<SnsCreateUserResult>;
+    /**
+     * Adapts camelCase SDK parameters to the snake_case payload expected by the backend.
+     *
+     * @param params Wallet address, signed message, and signature returned by the signer.
+     */
+    authenticate(params: SnsAuthenticateParams): Promise<SnsLoginResult>;
+    /**
+     * Executes the full SNS login flow:
+     * 1. fetch nonce
+     * 2. build login message
+     * 3. sign message via injected signer callback
+     * 4. exchange signature for JWT
+     * 5. persist token in shared HTTP auth state
+     *
+     * @param params Wallet address and async signing callback.
+     */
+    login(params: SnsLoginParams): Promise<SnsLoginResult>;
+    /**
+     * Builds the exact message string that the wallet must sign during login.
+     */
+    private buildLoginMessage;
+}
+/**
+ * Convenience helper mirroring `sns.login(params)` for functional-style usage.
+ */
+declare function loginWithSns(sns: SnsService, params: SnsLoginParams): Promise<SnsLoginResult>;
+
+interface SnsAuthClientOptions extends SnsServiceOptions, BaseClientOptions {
+}
+declare class SnsAuthClient extends SnsService {
+    private readonly settings;
+    private readonly usingCustomBaseUrl;
+    constructor(options?: SnsAuthClientOptions);
+    getSettings(): ResolvedClientSettings;
+    isUsingCustomBaseUrl(): boolean;
+}
+
+export { AVACUS_ENDPOINTS as A, type BaseClientOptions as B, resolveClientSettings as C, DEFAULT_BASE_SIGNED_MESSAGE as D, resolveServiceUrl as E, HttpAdapter as H, type RequestOptions as R, SnsService as S, type AuthState as a, type AvacusEnvironment as b, type ResolvedClientSettings as c, SNS_SERVICE_PATH as d, type SignMessageFn as e, SnsAuthClient as f, type SnsAuthClientOptions as g, type SnsAuthTokenPayload as h, type SnsAuthenticateParams as i, type SnsAvatar as j, type SnsCreateUserDeviceParams as k, type SnsCreateUserParams as l, type SnsCreateUserPayload as m, type SnsCreateUserResult as n, type SnsCreateUserWithSignatureParams as o, type SnsDevice as p, type SnsGetNonceParams as q, type SnsGetProfilesParams as r, type SnsLoginParams as s, type SnsLoginResult as t, type SnsNonceResponse as u, type SnsProfile as v, type SnsServiceOptions as w, isKnownAvacusBaseUrl as x, loginWithSns as y, resolveAvacusBaseUrl as z };

package/packages/sdk/dist/sns.d.mts

@@ -0,0 +1 @@
+export { A as AVACUS_ENDPOINTS, a as AuthState, b as AvacusEnvironment, D as DEFAULT_BASE_SIGNED_MESSAGE, H as HttpAdapter, R as RequestOptions, c as ResolvedClientSettings, e as SignMessageFn, f as SnsAuthClient, g as SnsAuthClientOptions, h as SnsAuthTokenPayload, i as SnsAuthenticateParams, j as SnsAvatar, k as SnsCreateUserDeviceParams, l as SnsCreateUserParams, m as SnsCreateUserPayload, n as SnsCreateUserResult, o as SnsCreateUserWithSignatureParams, p as SnsDevice, q as SnsGetNonceParams, r as SnsGetProfilesParams, s as SnsLoginParams, t as SnsLoginResult, u as SnsNonceResponse, v as SnsProfile, S as SnsService, w as SnsServiceOptions, y as loginWithSns } from './sns-D0rtlsZp.mjs';

package/packages/sdk/dist/sns.d.ts

@@ -0,0 +1 @@
+export { A as AVACUS_ENDPOINTS, a as AuthState, b as AvacusEnvironment, D as DEFAULT_BASE_SIGNED_MESSAGE, H as HttpAdapter, R as RequestOptions, c as ResolvedClientSettings, e as SignMessageFn, f as SnsAuthClient, g as SnsAuthClientOptions, h as SnsAuthTokenPayload, i as SnsAuthenticateParams, j as SnsAvatar, k as SnsCreateUserDeviceParams, l as SnsCreateUserParams, m as SnsCreateUserPayload, n as SnsCreateUserResult, o as SnsCreateUserWithSignatureParams, p as SnsDevice, q as SnsGetNonceParams, r as SnsGetProfilesParams, s as SnsLoginParams, t as SnsLoginResult, u as SnsNonceResponse, v as SnsProfile, S as SnsService, w as SnsServiceOptions, y as loginWithSns } from './sns-D0rtlsZp.js';