hevy-shared 1.0.942 → 1.0.943

package/built/API/APIClient.d.ts

@@ -1,5 +1,5 @@
 import { ClientAuthToken, DeepReadonly } from '..';
-import { RequestConfig, HTTPResponse, HTTPClient, HTTPResponseHandler, HTTPErrorHandler } from './types';
+import { RequestConfig, HTTPResponse, HTTPClient, HTTPRequestCompletionCallback, HTTPErrorHandler } from './types';
 interface HevyAPIClientConfig<UserContext> {
     /**
      * How long before predicted token expiry to request a new token. We request
@@ -90,7 +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 _requestCompletionCallbacks;
     private _errorHandlers;
     private _authTokenFactory;
     private _legacyAuthToken;
@@ -133,12 +133,12 @@ export declare class HevyAPIClient<UserContext = never> {
      * 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;
+    attachRequestCompletionCallback(onResult: HTTPRequestCompletionCallback): void;
+    removeRequestCompletionCallbacks(): 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}.
+     * network error. For that and more, use {@link attachRequestCompletionCallback}.
      */
     attachErrorHandler(onError: HTTPErrorHandler<{
         willRetry: boolean;

package/built/API/APIClient.js

@@ -20,7 +20,7 @@ const __1 = require("..");
 const types_1 = require("./types");
 class HevyAPIClient {
     constructor(httpClient, config) {
-        this._responseHandlers = [];
+        this._requestCompletionCallbacks = [];
         this._errorHandlers = [];
         this._authTokenFactory = {
             type: 'value',
@@ -146,11 +146,11 @@ class HevyAPIClient {
                         response,
                     });
                 }
-                this._responseHandlers.forEach((cb) => cb({ isSuccess: true, value: response }, request));
+                this._requestCompletionCallbacks.forEach((cb) => cb({ isSuccess: true, value: response }, request));
                 return response;
             }
             catch (e) {
-                this._responseHandlers.forEach((cb) => cb({ isSuccess: false, error: e }, request));
+                this._requestCompletionCallbacks.forEach((cb) => cb({ isSuccess: false, error: e }, request));
                 if (!(0, types_1.isHTTPError)(e))
                     throw e;
                 const { response } = e;
@@ -250,16 +250,16 @@ class HevyAPIClient {
      * 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);
+    attachRequestCompletionCallback(onResult) {
+        this._requestCompletionCallbacks.push(onResult);
     }
-    removeResponseHandlers() {
-        this._responseHandlers.length = 0;
+    removeRequestCompletionCallbacks() {
+        this._requestCompletionCallbacks.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}.
+     * network error. For that and more, use {@link attachRequestCompletionCallback}.
      */
     attachErrorHandler(onError) {
         this._errorHandlers.push(onError);

package/built/API/types.d.ts

@@ -23,7 +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 HTTPRequestCompletionCallback<T = unknown, R = unknown> = (result: 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/package.json

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