feat: update to latest spec and add wrapper functions for RecoveryPhrase operations (#156)

Author: thorbenziemek

etc/client.api.md

@@ -532,6 +532,10 @@ export class AuthorizedApiContext {
     // (undocumented)
     createDemoAccount(demoAccountSettings?: DemoAccountSettings): Promise<openApiClient.CreatedResponseBody>;
     // (undocumented)
+    createRecoveryPhrase(opts: {
+        name: string;
+    }): Promise<openApiClient.CreateRecoveryPhraseResult>;
+    // (undocumented)
     createSessionTanChallenge(req: openApiClient.CreateSessionTanChallengeRequest): Promise<openApiClient.Challenge>;
     // (undocumented)
     createTrade(req: CreateTradeRequest, viaCryptoService?: boolean): Promise<openApiClient.CreateTradeResponse>;
@@ -552,6 +556,8 @@ export class AuthorizedApiContext {
     // (undocumented)
     deletePortfolio(portfolioId: string): Promise<openApiClient.OkResponseBody>;
     // (undocumented)
+    deleteRecoveryPhrase(recoveryPhraseId: string): Promise<void>;
+    // (undocumented)
     deleteTradeDraft(params: openApiClient.DeleteTradeDraftRequest): Promise<void>;
     // (undocumented)
     destroy(): void;
@@ -616,6 +622,8 @@ export class AuthorizedApiContext {
     // (undocumented)
     getQuote(p: GetQuoteRequest): Promise<openApiClient.GetQuoteResponse>;
     // (undocumented)
+    getRecoveryPhrases(): Promise<openApiClient.GetRecoveryPhrasesResponse>;
+    // (undocumented)
     getSecurityDetailedInfo(token: string): Promise<openApiClient.GenericTable>;
     // (undocumented)
     getSecurityQuotes(opts: {
@@ -787,6 +795,8 @@ function BrokerEnvironmentToJSONRecursive(value?: BrokerEnvironment | null, igno
 // @public (undocumented)
 export class Brokerize {
     constructor(cfg: BrokerizeConfig);
+    // (undocumented)
+    checkRecoveryPhrase(recoveryPhrase: string): Promise<openApiClient.CheckRecoveryPhrase200Response>;
     createAuth(authCtxCfg: AuthContextConfiguration, tokenRefreshCallback?: TokenRefreshCallback): Auth;
     createAuthorizedContext(authCtxCfg: AuthContextConfiguration, tokenRefreshCallback?: TokenRefreshCallback, customWebSocketClient?: BrokerizeWebSocketClient): AuthorizedApiContext;
     createCustomWebSocketClient({ url, auth, }: {
@@ -798,6 +808,8 @@ export class Brokerize {
     // (undocumented)
     getCognitoConfig(): CognitoPoolConfig | undefined;
     // (undocumented)
+    obtainTokenByRecoveryPhrase(recoveryPhrase: string): Promise<AuthContextConfiguration>;
+    // (undocumented)
     refreshGuestUser(refreshToken: string): Promise<GuestAuthContextConfiguration>;
 }
 
@@ -1355,6 +1367,7 @@ function ChangeOrderResponseToJSONRecursive(value?: ChangeOrderResponse | null,
 // @public
 interface CheckRecoveryPhrase200Response {
     expiresAt: Date;
+    userId: string;
 }
 
 // @public (undocumented)
@@ -4491,7 +4504,10 @@ declare namespace Models {
         TradeStatistics,
         GetPortfolioCalendarResponse,
         PortfolioCalendarDateRange,
-        PortfolioCalendarItem
+        PortfolioCalendarItem,
+        GetRecoveryPhrasesResponse,
+        CreateRecoveryPhraseResult,
+        CheckRecoveryPhrase200Response
     }
 }
 export { Models }

openapi.json

@@ -628,6 +628,28 @@ export class AuthorizedApiContext {
     );
   }
 
+  async getRecoveryPhrases() {
+    return this._userApi.getRecoveryPhrases(await this._initRequestInit());
+  }
+
+  async createRecoveryPhrase(opts: { name: string }) {
+    return this._userApi.createRecoveryPhrase(
+      {
+        createRecoveryPhraseParams: { name: opts.name },
+      },
+      await this._initRequestInit()
+    );
+  }
+
+  async deleteRecoveryPhrase(recoveryPhraseId: string) {
+    return this._userApi.deleteRecoveryPhrase(
+      {
+        recoveryPhraseId,
+      },
+      await this._initRequestInit()
+    );
+  }
+
   /**
    * Subscribe to security quotes. Note that this currently uses polling to load the quotes from the
    * API. This will be replaced with a websocket-based solution in the future, but we can keep this

src/authorizedApiContext.ts

@@ -85,7 +85,22 @@ export class Brokerize {
     }
 
     this._cfg = cfg;
-    this._userApi = new openApiClient.UserApi(createConfiguration(cfg));
+
+    const postMiddleware = async (
+      r: openApiClient.ResponseContext
+    ): Promise<void> => {
+      const statusCode = r.response.status;
+      if (statusCode >= 400) {
+        const decJson =
+          (await r.response.json()) as openApiClient.ErrorResponse;
+        const err = new BrokerizeError(statusCode, decJson);
+        throw err;
+      }
+    };
+
+    this._userApi = new openApiClient.UserApi(
+      createConfiguration(cfg)
+    ).withPostMiddleware(postMiddleware);
   }
 
   async refreshGuestUser(
@@ -203,6 +218,46 @@ export class Brokerize {
     });
   }
 
+  checkRecoveryPhrase(recoveryPhrase: string) {
+    return this._userApi.checkRecoveryPhrase(
+      {
+        obtainTokenByRecoveryPhraseParams: { recoveryPhrase },
+      },
+      {
+        headers: {
+          "x-brkrz-client-id": this._cfg.clientId,
+          "Content-Type": "application/json",
+        },
+      }
+    );
+  }
+
+  async obtainTokenByRecoveryPhrase(
+    recoveryPhrase: string
+  ): Promise<AuthContextConfiguration> {
+    const tokResult = await this._userApi.obtainTokenByRecoveryPhrase(
+      {
+        obtainTokenByRecoveryPhraseParams: { recoveryPhrase },
+      },
+      {
+        headers: {
+          "x-brkrz-client-id": this._cfg.clientId,
+          "Content-Type": "application/json",
+        },
+      }
+    );
+
+    const updatedAt = Date.now();
+    return {
+      type: "guest",
+      idToken: "", // deprecated
+      tokens: {
+        updatedAt,
+        response: tokResult as openApiClient.CreateGuestUserResponse,
+      },
+    };
+  }
+
   /**
    * Create a customized WebSocket client. You can override the WebSocket connection URL and the Auth implementation
    * for a custom token retrieval behavior.

src/index.ts

@@ -168,3 +168,6 @@ export { TradeStatistics } from "./swagger/models/TradeStatistics";
 export { GetPortfolioCalendarResponse } from "./swagger/models/GetPortfolioCalendarResponse";
 export { PortfolioCalendarDateRange } from "./swagger/models/PortfolioCalendarDateRange";
 export { PortfolioCalendarItem } from "./swagger/models/PortfolioCalendarItem";
+export { GetRecoveryPhrasesResponse } from "./swagger/models/GetRecoveryPhrasesResponse";
+export { CreateRecoveryPhraseResult } from "./swagger/models/CreateRecoveryPhraseResult";
+export { CheckRecoveryPhrase200Response } from "./swagger/models/CheckRecoveryPhrase200Response";