hevy-shared 1.0.918 → 1.0.920

package/built/API/APIClient.d.ts

@@ -1,5 +1,5 @@
 import { ClientAuthToken, DeepReadonly } from '..';
-import { RequestConfig, HTTPResponse, HTTPClient, HTTPErrorHandler } from './types';
+import { RequestConfig, HTTPResponse, HTTPClient, HTTPResponseHandler, HTTPErrorHandler } from './types';
 interface HevyAPIClientConfig<UserContext> {
     /**
      * How long before predicted token expiry to request a new token. We request
@@ -90,6 +90,7 @@ export declare class HevyAPIClient<UserContext = never> {
     private static readonly DEFAULT_TOKEN_REFRESH_THROTTLE_MS;
     private static readonly DEFAULT_REFRESH_AUTH_TOKEN_API_ENDPOINT;
     private readonly _config;
+    private _responseHandlers;
     private _errorHandlers;
     private _authTokenFactory;
     private _legacyAuthToken;
@@ -123,6 +124,22 @@ export declare class HevyAPIClient<UserContext = never> {
     clearAuthToken(): Promise<void>;
     get isAuthenticated(): boolean;
     markSessionDeleted(): void;
+    /**
+     * Adds a callback to be executed whenever a request has finished processing.
+     * This means either that the request has received a response, or that there
+     * was an error. In the case of an error, it may be either an HTTP error from
+     * the server, or some other type of error, such as a network error.
+     *
+     * This is a lower level API than {@link attachErrorHandler} - prefer using
+     * that one instead of this one if it's enough to suit your needs.
+     */
+    attachResponseHandler(onResponse: HTTPResponseHandler): void;
+    removeResponseHandlers(): void;
+    /**
+     * Adds a callback to be executed on receiving an HTTP error from the server.
+     * This callback will not be executed for any other type of error, such as a
+     * network error. For that and more, use {@link attachResponseHandler}.
+     */
     attachErrorHandler(onError: HTTPErrorHandler<{
         willRetry: boolean;
         isTokenRefreshedAfterRequest: boolean;

package/built/API/APIClient.js

@@ -20,6 +20,7 @@ const __1 = require("..");
 const types_1 = require("./types");
 class HevyAPIClient {
     constructor(httpClient, config) {
+        this._responseHandlers = [];
         this._errorHandlers = [];
         this._authTokenFactory = {
             type: 'value',
@@ -145,9 +146,11 @@ class HevyAPIClient {
                         response,
                     });
                 }
+                this._responseHandlers.forEach((cb) => cb({ isSuccess: true, value: response }, request));
                 return response;
             }
             catch (e) {
+                this._responseHandlers.forEach((cb) => cb({ isSuccess: false, error: e }, request));
                 if (!(0, types_1.isHTTPError)(e))
                     throw e;
                 const { response } = e;
@@ -238,6 +241,26 @@ class HevyAPIClient {
     markSessionDeleted() {
         this._lastSessionDelete = new Date();
     }
+    /**
+     * Adds a callback to be executed whenever a request has finished processing.
+     * This means either that the request has received a response, or that there
+     * was an error. In the case of an error, it may be either an HTTP error from
+     * the server, or some other type of error, such as a network error.
+     *
+     * This is a lower level API than {@link attachErrorHandler} - prefer using
+     * that one instead of this one if it's enough to suit your needs.
+     */
+    attachResponseHandler(onResponse) {
+        this._responseHandlers.push(onResponse);
+    }
+    removeResponseHandlers() {
+        this._responseHandlers.length = 0;
+    }
+    /**
+     * Adds a callback to be executed on receiving an HTTP error from the server.
+     * This callback will not be executed for any other type of error, such as a
+     * network error. For that and more, use {@link attachResponseHandler}.
+     */
     attachErrorHandler(onError) {
         this._errorHandlers.push(onError);
     }

package/built/API/types.d.ts

@@ -1,3 +1,4 @@
+import { Result } from '..';
 export interface HTTPClient {
     get<T>(url: string, config?: RequestConfig): Promise<HTTPResponse<T>>;
     delete<T>(url: string, config?: RequestConfig): Promise<HTTPResponse<T>>;
@@ -22,6 +23,7 @@ export interface HTTPRequestFactory<T = unknown> {
     headers: Record<string, string>;
     try(): Promise<HTTPResponse<T>>;
 }
+export type HTTPResponseHandler<T = unknown, R = unknown> = (response: Result<HTTPResponse<T>>, request: HTTPRequestFactory<R>) => void;
 export type HTTPErrorHandler<E, T = unknown, R = unknown> = (response: HTTPResponse<T>, request: HTTPRequestFactory<R>, extraData: E) => void;
 export interface HTTPResponse<T = unknown> {
     status: number;

package/built/adminPermissions.d.ts

@@ -1,4 +1,4 @@
 import { Lookup } from './typeUtils';
-export declare const AdminPermissions: readonly ["become_user", "ip_blacklists", "featured_users", "feature_flags", "hevy_trainer", "user_account_management", "import_strong_csv", "community_management", "user_app_logs"];
+export declare const AdminPermissions: readonly ["become_user", "ip_blacklists", "featured_users", "feature_flags", "hevy_trainer", "user_account_management", "import_strong_csv", "community_management", "user_app_logs", "backend_maintenance"];
 export type AdminPermission = Lookup<typeof AdminPermissions>;
 export declare const isAdminPermission: (permission?: any) => permission is AdminPermission;

package/built/adminPermissions.js

@@ -11,6 +11,7 @@ exports.AdminPermissions = [
     'import_strong_csv',
     'community_management',
     'user_app_logs',
+    'backend_maintenance',
 ];
 const isAdminPermission = (permission) => {
     if (!permission || typeof permission !== 'string') {

package/built/index.d.ts

@@ -246,8 +246,7 @@ export interface UsernameAvailabilityResponse {
     isAvailable: boolean;
     suggestions: string[];
 }
-export interface CoachLoginResult {
-    auth_token: string;
+export interface CoachLoginResult extends ClientAuthTokenResponse {
     is_first_login_to_coach_platform: boolean;
 }
 export interface CoachSocialLoginResult extends SocialLoginResult {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hevy-shared",
-  "version": "1.0.918",
+  "version": "1.0.920",
   "description": "",
   "main": "built/index.js",
   "types": "built/index.d.ts",