@textrp/briij-js-sdk 43.0.0 → 43.1.1

package/src/@types/event.ts

@@ -65,6 +65,7 @@ import { type LocalNotificationSettings } from "./local_notifications.ts";
 import { type IPushRules } from "./PushRules.ts";
 import { type SecretInfo, type SecretStorageKeyDescription } from "../secret-storage.ts";
 import { type POLICIES_ACCOUNT_EVENT_TYPE } from "../models/invites-ignorer-types.ts";
+import { type WalletE2eeRecoveryEnvelope, type WalletIdentityAccountData } from "./auth.ts";
 
 export enum EventType {
     // Room state events
@@ -455,38 +456,8 @@ export interface AccountDataEvents extends SecretStorageAccountDataEvents {
     [POLICIES_ACCOUNT_EVENT_TYPE.altName]: { [key: string]: any };
 
     [EventType.InvitePermissionConfig]: { default_action?: string };
-    "org.textrp.wallet.e2ee_recovery.v1": {
-        envelope_version: number;
-        chain_id: string;
-        account_id: string;
-        created_at_ms: number;
-        key_id: string;
-        wallet_wrap: {
-            alg: string;
-            kdf: string;
-            salt: string;
-            nonce: string;
-            ciphertext: string;
-            aad?: string;
-            params?: Record<string, unknown>;
-        };
-        password_wrap: {
-            alg: string;
-            kdf: string;
-            salt: string;
-            nonce: string;
-            ciphertext: string;
-            aad?: string;
-            params?: Record<string, unknown>;
-        };
-    };
-    "org.textrp.wallet.identity": {
-        chain_id: string;
-        account_id: string;
-        public_key: string | null;
-        network?: string | null;
-        key_type?: string | null;
-    };
+    "org.textrp.wallet.e2ee_recovery.v1": WalletE2eeRecoveryEnvelope;
+    "org.textrp.wallet.identity": WalletIdentityAccountData;
 }
 
 /**

package/src/@types/synapse.ts

@@ -37,4 +37,81 @@ export interface ISynapseAdminWhoisResponse {
 export interface ISynapseAdminDeactivateResponse {
     id_server_unbind_result: IdServerUnbindResult;
 }
+
+export interface IBriijPremiumFeature {
+    feature_id: number;
+    feature_key: string;
+    name: string;
+    description: string | null;
+    mcredits_cost: number;
+    category: string | null;
+    is_active: boolean;
+    created_ts: number;
+}
+
+export interface IBriijMcreditsFeature {
+    feature_key: string;
+    name: string;
+    description: string | null;
+    mcredits_cost: number;
+    category: string | null;
+    is_active: boolean;
+}
+
+export interface IBriijMcreditsFeaturesResponse {
+    features: IBriijMcreditsFeature[];
+}
+
+export interface IBriijMcreditsBalanceResponse {
+    balance: number;
+}
+
+export interface IBriijMcreditsSpendResponse {
+    feature_key: string;
+    balance: number;
+}
+
+export interface IBriijLegacyMyAddressUserCredit {
+    balance?: string;
+}
+
+export interface IBriijLegacyMyAddressUser {
+    address?: string;
+    discount?: Record<string, unknown>;
+    subscriptions?: unknown[];
+    credit?: IBriijLegacyMyAddressUserCredit;
+}
+
+export interface IBriijLegacyMyAddressResponse {
+    user: IBriijLegacyMyAddressUser;
+    address: string;
+}
+
+export interface IBriijLegacyEnabledFeature {
+    feature: string;
+    [key: string]: unknown;
+}
+
+export interface IBriijLegacyEnabledFeaturesResponse {
+    nfts?: IBriijLegacyEnabledFeature[];
+    [key: string]: unknown;
+}
+
+export interface IBriijAdminPremiumFeaturesResponse {
+    premium_features: IBriijPremiumFeature[];
+}
+
+export interface IBriijAdminCreatePremiumFeatureRequest {
+    feature_key: string;
+    name: string;
+    description?: string | null;
+    mcredits_cost: number;
+    category?: string | null;
+}
+
+export interface IBriijAdminUpdatePremiumFeatureRequest {
+    mcredits_cost?: number;
+    description?: string | null;
+    is_active?: boolean;
+}
 /* eslint-enable camelcase */

package/src/briij.ts

@@ -74,6 +74,7 @@ export * from "./@types/topic.ts";
 export * from "./@types/location.ts";
 export * from "./@types/threepids.ts";
 export * from "./@types/auth.ts";
+export * from "./@types/synapse.ts";
 export * from "./@types/polls.ts";
 export type * from "./@types/local_notifications.ts";
 export type * from "./@types/registration.ts";

package/src/client.ts

@@ -170,7 +170,19 @@ import {
     type IStateEventWithRoomId,
     SearchOrderBy,
 } from "./@types/search.ts";
-import { type ISynapseAdminDeactivateResponse, type ISynapseAdminWhoisResponse } from "./@types/synapse.ts";
+import {
+    type IBriijAdminCreatePremiumFeatureRequest,
+    type IBriijAdminPremiumFeaturesResponse,
+    type IBriijAdminUpdatePremiumFeatureRequest,
+    type IBriijLegacyEnabledFeaturesResponse,
+    type IBriijLegacyMyAddressResponse,
+    type IBriijMcreditsBalanceResponse,
+    type IBriijMcreditsFeaturesResponse,
+    type IBriijMcreditsSpendResponse,
+    type IBriijPremiumFeature,
+    type ISynapseAdminDeactivateResponse,
+    type ISynapseAdminWhoisResponse,
+} from "./@types/synapse.ts";
 import { type IHierarchyRoom } from "./@types/spaces.ts";
 import {
     type IPusher,
@@ -255,13 +267,14 @@ import {
     type OidcClientConfig,
     validateAuthMetadataAndKeys,
 } from "./oidc/index.ts";
-import { configureXrplIdentityMinting, mintSoulboundIdentityNFT } from "./xrpl/identity.ts";
 import {
-    XRPL_VERIFIED_EVENT,
-    XRPL_VERIFY_ACCEPT_EVENT,
-    XRPL_VERIFY_REQUEST_EVENT,
-} from "./xrpl/verification.ts";
-import { configureXrplTrust } from "./xrpl/trust.ts";
+    getConfiguredXrplIdentityMintingConfig,
+    mintSoulboundIdentityNFT,
+    type XamanWalletAdapter,
+    type XrplIdentityMintingConfig,
+} from "./xrpl/identity.ts";
+import { XRPL_VERIFIED_EVENT, XRPL_VERIFY_ACCEPT_EVENT, XRPL_VERIFY_REQUEST_EVENT } from "./xrpl/verification.ts";
+import { type XrplTrustConfig } from "./xrpl/trust.ts";
 import { type EmptyObject } from "./@types/common.ts";
 import { UnsupportedDelayedEventsEndpointError, UnsupportedStickyEventsEndpointError } from "./errors.ts";
 import { type Transport } from "./matrixrtc/index.ts";
@@ -289,6 +302,13 @@ export interface IKeysUploadResponse {
 export interface ICreateClientOpts {
     baseUrl: string;
 
+    /**
+     * Optional override for Briij legacy endpoints mounted at the homeserver root
+     * (for example `/my-address` and `/my-features/...`).
+     * Use this when `baseUrl` points to a local proxy origin.
+     */
+    legacyApiBaseUrl?: string;
+
     idBaseUrl?: string;
 
     /**
@@ -478,6 +498,17 @@ export interface ICreateClientOpts {
      * Defaults to the built-in global logger; see {@link DebugLogger} for an alternative.
      */
     logger?: Logger;
+
+    /**
+     * Optional per-client XRPL trust configuration.
+     */
+    xrplTrust?: Partial<XrplTrustConfig>;
+
+    /**
+     * Optional per-client XRPL identity minting configuration.
+     */
+    xrplIdentityMinting?: Partial<Omit<XrplIdentityMintingConfig, "homeserverBaseUrl" | "accessToken">>;
+    xamanWallet?: XamanWalletAdapter;
 }
 
 export interface IBriijClientCreateOpts extends ICreateClientOpts {
@@ -1269,6 +1300,7 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
     public iceCandidatePoolSize = 0; // XXX: Intended private, used in code.
     public idBaseUrl?: string;
     public baseUrl: string;
+    private legacyApiBaseUrl?: string;
     public readonly isVoipWithNoMediaAllowed;
     public disableVoip: boolean;
 
@@ -1298,6 +1330,9 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
     protected clientOpts?: IStoredClientOpts;
     protected clientWellKnownIntervalID?: ReturnType<typeof setInterval>;
     protected canResetTimelineCallback?: ResetTimelineCallback;
+    private xrplTrustConfig?: XrplTrustConfig;
+    private xrplIdentityMintingConfig: Partial<Omit<XrplIdentityMintingConfig, "homeserverBaseUrl" | "accessToken">> =
+        {};
 
     public canSupport = new Map<Feature, ServerSupport>();
 
@@ -1348,6 +1383,7 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
         opts.idBaseUrl = utils.ensureNoTrailingSlash(opts.idBaseUrl);
 
         this.baseUrl = opts.baseUrl;
+        this.legacyApiBaseUrl = utils.ensureNoTrailingSlash(opts.legacyApiBaseUrl);
         this.idBaseUrl = opts.idBaseUrl;
         this.identityServer = opts.identityServer;
 
@@ -1358,6 +1394,17 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
 
         const userId = opts.userId || null;
         this.credentials = { userId };
+        if (opts.xrplTrust) {
+            this.xrplTrustConfig = {
+                homeserverBaseUrl: opts.xrplTrust.homeserverBaseUrl ?? this.baseUrl,
+                accessToken: opts.xrplTrust.accessToken ?? opts.accessToken ?? "",
+                trustPath: opts.xrplTrust.trustPath,
+            };
+        }
+        this.xrplIdentityMintingConfig = {
+            ...(opts.xrplIdentityMinting ?? {}),
+            ...(opts.xamanWallet ? { xamanWallet: opts.xamanWallet } : {}),
+        };
 
         this.http = new BriijHttpApi(this as ConstructorParameters<typeof BriijHttpApi>[0], {
             fetchFn: opts.fetchFn,
@@ -6063,6 +6110,41 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
         return this.fallbackICEServerAllowed;
     }
 
+    /**
+     * Some briij deployments mount admin resources under `/_briij/admin` while
+     * Synapse defaults to `/_synapse/admin`. Try both prefixes to stay compatible.
+     */
+    private async authedRequestWithAdminPrefixes<T>(
+        method: Method,
+        adminSubPath: string,
+        queryParams?: QueryDict,
+        body?: Body,
+    ): Promise<T> {
+        const normalizedSubPath = adminSubPath.replace(/^\/+/, "");
+        const adminPrefixes = ["/_synapse/admin", "/_briij/admin"];
+        let lastError: unknown;
+
+        for (const adminPrefix of adminPrefixes) {
+            try {
+                return await this.http.authedRequest<T>(
+                    method,
+                    `${adminPrefix}/${normalizedSubPath}`,
+                    queryParams,
+                    body,
+                    { prefix: "" },
+                );
+            } catch (error) {
+                if (error instanceof BriijError && error.httpStatus === 404) {
+                    lastError = error;
+                    continue;
+                }
+                throw error;
+            }
+        }
+
+        throw lastError ?? new Error("Admin API endpoint not found");
+    }
+
     /**
      * Determines if the current user is an administrator of the Synapse homeserver.
      * Returns false if untrue or the homeserver does not appear to be a Synapse
@@ -6070,11 +6152,20 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
      * as a result.</strong>
      * @returns true if the user appears to be a Synapse administrator.
      */
-    public isSynapseAdministrator(): Promise<boolean> {
-        const path = utils.encodeUri("/_synapse/admin/v1/users/$userId/admin", { $userId: this.getUserId()! });
-        return this.http
-            .authedRequest<{ admin: boolean }>(Method.Get, path, undefined, undefined, { prefix: "" })
-            .then((r) => r.admin); // pull out the specific boolean we want
+    public async isSynapseAdministrator(): Promise<boolean> {
+        const adminSubPath = utils.encodeUri("v1/users/$userId/admin", { $userId: this.getUserId()! });
+        try {
+            const response = await this.authedRequestWithAdminPrefixes<{ admin: boolean }>(Method.Get, adminSubPath);
+            return response.admin;
+        } catch (error) {
+            if (error instanceof BriijError && error.httpStatus === 404) {
+                return false;
+            }
+            if (error instanceof Error && /Admin API endpoint not found/i.test(error.message)) {
+                return false;
+            }
+            throw error;
+        }
     }
 
     /**
@@ -6085,8 +6176,8 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
      * @returns the whois response - see Synapse docs for information.
      */
     public whoisSynapseUser(userId: string): Promise<ISynapseAdminWhoisResponse> {
-        const path = utils.encodeUri("/_synapse/admin/v1/whois/$userId", { $userId: userId });
-        return this.http.authedRequest(Method.Get, path, undefined, undefined, { prefix: "" });
+        const adminSubPath = utils.encodeUri("v1/whois/$userId", { $userId: userId });
+        return this.authedRequestWithAdminPrefixes(Method.Get, adminSubPath);
     }
 
     /**
@@ -6096,8 +6187,128 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
      * @returns the deactivate response - see Synapse docs for information.
      */
     public deactivateSynapseUser(userId: string): Promise<ISynapseAdminDeactivateResponse> {
-        const path = utils.encodeUri("/_synapse/admin/v1/deactivate/$userId", { $userId: userId });
-        return this.http.authedRequest(Method.Post, path, undefined, undefined, { prefix: "" });
+        const adminSubPath = utils.encodeUri("v1/deactivate/$userId", { $userId: userId });
+        return this.authedRequestWithAdminPrefixes(Method.Post, adminSubPath);
+    }
+
+    /**
+     * Lists active mCredits features for the authenticated user.
+     */
+    public getBriijMcreditsFeatures(): Promise<IBriijMcreditsFeaturesResponse> {
+        return this.http.authedRequest(Method.Get, "/mcredits/features", undefined, undefined, {
+            prefix: ClientPrefix.V3,
+        });
+    }
+
+    /**
+     * Retrieves the authenticated user's mCredits balance.
+     */
+    public getBriijMcreditsBalance(): Promise<IBriijMcreditsBalanceResponse> {
+        return this.http.authedRequest(Method.Get, "/mcredits/balance", undefined, undefined, {
+            prefix: ClientPrefix.V3,
+        });
+    }
+
+    /**
+     * Spends mCredits for a premium feature.
+     * @param featureKey - The premium feature identifier to spend against.
+     */
+    public spendBriijMcredits(featureKey: string): Promise<IBriijMcreditsSpendResponse> {
+        return this.http.authedRequest(
+            Method.Post,
+            "/mcredits/spend",
+            undefined,
+            { feature_key: featureKey },
+            {
+                prefix: ClientPrefix.V3,
+            },
+        );
+    }
+
+    /**
+     * Calls Briij's legacy-compatible endpoint to resolve a Matrix user to wallet/mcredit payload.
+     * @param matrixUserId - Matrix user ID used by legacy clients.
+     */
+    public getBriijLegacyMyAddress(matrixUserId: string): Promise<IBriijLegacyMyAddressResponse> {
+        return this.http.authedRequest(
+            Method.Post,
+            "/my-address",
+            undefined,
+            { address: matrixUserId },
+            { prefix: "", baseUrl: this.getLegacyApiBaseUrl() },
+        );
+    }
+
+    /**
+     * Calls Briij's legacy-compatible enabled-features endpoint.
+     * @param walletAddress - XRPL wallet address.
+     * @param network - Legacy network segment; defaults to `main`.
+     */
+    public getBriijLegacyEnabledFeatures(
+        walletAddress: string,
+        network = "main",
+    ): Promise<IBriijLegacyEnabledFeaturesResponse> {
+        const path = utils.encodeUri("/my-features/$walletAddress/$network/enabled", {
+            $walletAddress: walletAddress,
+            $network: network,
+        });
+        return this.http.authedRequest(Method.Get, path, undefined, undefined, {
+            prefix: "",
+            baseUrl: this.getLegacyApiBaseUrl(),
+        });
+    }
+
+    private getLegacyApiBaseUrl(): string {
+        return (
+            this.legacyApiBaseUrl ??
+            utils.ensureNoTrailingSlash(this.xrplTrustConfig?.homeserverBaseUrl) ??
+            this.baseUrl
+        );
+    }
+
+    /**
+     * Lists mCredits premium features from Synapse admin APIs.
+     */
+    public async getBriijAdminPremiumFeatures(): Promise<IBriijPremiumFeature[]> {
+        const response = await this.authedRequestWithAdminPrefixes<IBriijAdminPremiumFeaturesResponse>(
+            Method.Get,
+            "v2/briij/premium_features",
+        );
+        return response.premium_features;
+    }
+
+    /**
+     * Creates an mCredits premium feature via Synapse admin APIs.
+     * @param body - Feature fields to create.
+     */
+    public createBriijAdminPremiumFeature(body: IBriijAdminCreatePremiumFeatureRequest): Promise<IBriijPremiumFeature> {
+        return this.authedRequestWithAdminPrefixes(Method.Post, "v2/briij/premium_features", undefined, body);
+    }
+
+    /**
+     * Updates an mCredits premium feature via Synapse admin APIs.
+     * @param featureKey - The premium feature key to update.
+     * @param body - Updatable feature fields.
+     */
+    public updateBriijAdminPremiumFeature(
+        featureKey: string,
+        body: IBriijAdminUpdatePremiumFeatureRequest,
+    ): Promise<IBriijPremiumFeature> {
+        const adminSubPath = utils.encodeUri("v2/briij/premium_features/$featureKey", {
+            $featureKey: featureKey,
+        });
+        return this.authedRequestWithAdminPrefixes(Method.Put, adminSubPath, undefined, body);
+    }
+
+    /**
+     * Soft-deactivates an mCredits premium feature via Synapse admin APIs.
+     * @param featureKey - The premium feature key to deactivate.
+     */
+    public deactivateBriijAdminPremiumFeature(featureKey: string): Promise<IBriijPremiumFeature> {
+        const adminSubPath = utils.encodeUri("v2/briij/premium_features/$featureKey", {
+            $featureKey: featureKey,
+        });
+        return this.authedRequestWithAdminPrefixes(Method.Delete, adminSubPath);
     }
 
     protected async fetchClientWellKnown(): Promise<void> {
@@ -6687,32 +6898,44 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
             type: loginType,
         });
 
-        if (response.access_token && response.user_id) {
-            this.http.opts.accessToken = response.access_token;
-            this.credentials = {
-                userId: response.user_id,
-            };
-            configureXrplTrust({
-                homeserverBaseUrl: this.baseUrl,
-                accessToken: response.access_token,
-            });
+        await this.applyLoginResponse(response, loginType);
+
+        return response;
+    }
+
+    private async applyLoginResponse(response: LoginResponse, loginType?: LoginRequest["type"]): Promise<void> {
+        if (!response.access_token || !response.user_id) {
+            return;
         }
 
+        this.http.opts.accessToken = response.access_token;
+        this.credentials = {
+            userId: response.user_id,
+        };
+        this.deviceId = response.device_id ?? this.deviceId;
+        this.xrplTrustConfig = {
+            homeserverBaseUrl: this.baseUrl,
+            accessToken: response.access_token,
+            trustPath: this.xrplTrustConfig?.trustPath,
+        };
+
         // After Xaman-backed SSO login, mint once and persist identity metadata in account_data.
-        if (loginType === "m.login.token" && response.access_token && response.user_id) {
-            configureXrplIdentityMinting({
-                homeserverBaseUrl: this.baseUrl,
-                accessToken: response.access_token,
-            });
+        if (loginType === "m.login.token") {
+            const fallbackMintingConfig = getConfiguredXrplIdentityMintingConfig();
+            const xamanWallet = this.xrplIdentityMintingConfig.xamanWallet ?? fallbackMintingConfig.xamanWallet;
 
             try {
-                await mintSoulboundIdentityNFT(response.user_id);
+                await mintSoulboundIdentityNFT(response.user_id, {
+                    ...fallbackMintingConfig,
+                    ...this.xrplIdentityMintingConfig,
+                    homeserverBaseUrl: this.baseUrl,
+                    accessToken: response.access_token,
+                    xamanWallet,
+                });
             } catch (error) {
                 logger.warn("XRPL identity NFT minting skipped/failed", error);
             }
         }
-
-        return response;
     }
 
     /**
@@ -6781,8 +7004,8 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
      *
      * @param envelope - Wallet recovery envelope payload.
      */
-    public setWalletRecoveryEnvelope(envelope: WalletE2eeRecoveryEnvelope): Promise<EmptyObject> {
-        return this.setAccountDataRaw(WALLET_E2EE_RECOVERY_ACCOUNT_DATA_TYPE, envelope);
+    public async setWalletRecoveryEnvelope(envelope: WalletE2eeRecoveryEnvelope): Promise<EmptyObject> {
+        return await this.setAccountData(WALLET_E2EE_RECOVERY_ACCOUNT_DATA_TYPE, envelope);
     }
 
     /**
@@ -6831,7 +7054,7 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
             throw new Error("XRPL challenge payload is missing session; call getXrplAuthChallenge first");
         }
 
-        return this.completeXrplAuth({
+        const response = await this.completeXrplAuth({
             user,
             identifier: {
                 type: "m.id.user",
@@ -6843,6 +7066,8 @@ export class BriijClient extends TypedEventEmitter<EmittedEvents, ClientEventHan
             public_key: parsedChallenge?.public_key,
             network,
         });
+        await this.applyLoginResponse(response, XRPL_WALLET_LOGIN_TYPE);
+        return response;
     }
 
     /**