@opensecret/react 0.3.0 → 0.3.2

package/README.md

@@ -79,6 +79,7 @@ The `useOpenSecret` hook provides access to the OpenSecret API. It returns an ob
 #### Account Management Methods
 - `refetchUser(): Promise<void>`: Refreshes the user's authentication state.
 - `changePassword(currentPassword: string, newPassword: string): Promise<void>`: Changes the user's password.
+- `generateThirdPartyToken(audience: string): Promise<{ token: string }>`: Generates a JWT token for use with pre-authorized third-party services (e.g. "https://api.devservice.com"). Developers must register this URL in advance (coming soon).
 
 #### Cryptographic Methods
 - `getPrivateKey(): Promise<PrivateKeyResponse>`: Retrieves the user's private key mnemonic phrase. This is used for cryptographic operations and should be kept secure.
@@ -143,7 +144,9 @@ To build the library, run the following command:
 bun run build
 ```
 
-To pack the library, run the following command:
+Currently this build step requires `npx` because of [a Bun incompatibility with `vite-plugin-dts`](https://github.com/OpenSecretCloud/OpenSecret-SDK/issues/16).
+
+To pack the library (for publishing) run the following command:
 
 ```bash
 bun run pack

package/dist/index.d.ts

@@ -31,6 +31,7 @@ declare namespace api {
         signMessage,
         fetchPublicKey,
         convertGuestToEmailAccount,
+        generateThirdPartyToken,
         LoginResponse,
         UserResponse,
         KVListItem,
@@ -38,7 +39,9 @@ declare namespace api {
         GoogleAuthResponse,
         PrivateKeyResponse,
         SignMessageResponse,
-        PublicKeyResponse
+        PublicKeyResponse,
+        ThirdPartyTokenRequest,
+        ThirdPartyTokenResponse
     }
 }
 
@@ -121,6 +124,8 @@ declare function fetchUser(): Promise<UserResponse>;
 
 export declare function generateSecureSecret(): string;
 
+declare function generateThirdPartyToken(audience: string): Promise<ThirdPartyTokenResponse>;
+
 declare function getAttestation(forceRefresh?: boolean): Promise<Attestation>;
 
 export declare type GithubAuthResponse = {
@@ -406,6 +411,22 @@ export declare type OpenSecretContextType = {
      * 3. Parses it for viewing
      */
     getAttestationDocument: () => Promise<ParsedAttestationView>;
+    /**
+     * Generates a JWT token for use with authorized third-party services
+     * @param audience - The URL of the authorized service (e.g. "https://billing.opensecret.cloud")
+     * @returns A promise resolving to the token response
+     * @throws {Error} If:
+     * - The user is not authenticated
+     * - The audience URL is invalid
+     * - The audience URL is not authorized
+     *
+     * @description
+     * - Generates a signed JWT token for use with specific authorized third-party services
+     * - The audience must be an pre-authorized URL registered by the developer (e.g. api.devservice.com)
+     * - Requires an active authentication session
+     * - Token can be used to authenticate with the specified service
+     */
+    generateThirdPartyToken: (audience: string) => Promise<ThirdPartyTokenResponse>;
 };
 
 /**
@@ -497,6 +518,14 @@ declare type SignMessageResponse = {
     message_hash: string;
 };
 
+declare type ThirdPartyTokenRequest = {
+    audience: string;
+};
+
+declare type ThirdPartyTokenResponse = {
+    token: string;
+};
+
 export declare function useOpenSecret(): OpenSecretContextType;
 
 export declare type UserResponse = {