hevy-shared 1.0.960 → 1.0.962

package/src/workoutVolume.ts

@@ -0,0 +1,175 @@
+import { flatten } from 'lodash';
+import {
+  BodyMeasurement,
+  ExerciseType,
+  getClosestDataPointBeforeTargetDate,
+  Workout,
+} from '.';
+
+export const is100PercentBodyWeightExercise = (
+  exerciseTemplateId: string,
+): boolean => {
+  const exerciseTemplateIds = new Set([
+    '1B2B1E7C', // Pull Up
+    '729237D1', // Pull Up (Weighted)
+    '2C37EC5E', // Pull Up (Assisted)
+    '56808FD2', // Pull Up (Band)
+    'A91838C0', // Kipping Pull Up
+    'EE2938D1', // Sternum Pull up (Gironda)
+    '7C50F118', // Wide Pull Up
+    'C7AE420A', // Scapular Pull Ups
+    '29083183', // Chin Up
+    '023943F1', // Chin Up (Weighted)
+    'D23C609B', // Chin Up (Assisted)
+    '28BB4A95', // Triceps Dip
+    '10347BAC', // Triceps Dip (Weighted)
+    '4B4BF8C2', // Triceps Dip (Assisted)
+    '6FCD7755', // Chest Dip
+    '29472BE1', // Chest Dip (Weighted)
+    'E9E4089F', // Chest Dip (Assisted)
+    '51A0EDAA', // Ring Dips
+    '9F9C164B', // Muscle Up
+    '30F03BF0', // Front Lever Raise
+    '90B04F96', // Handstand Push Up
+  ]);
+
+  return exerciseTemplateIds.has(exerciseTemplateId);
+};
+
+interface WorkoutVolumeKgProps {
+  workout: Workout;
+  measurements: BodyMeasurement[];
+}
+
+export type BodyWeightMeasurement = BodyMeasurement &
+  Required<Pick<BodyMeasurement, 'weight_kg'>>;
+
+export const workoutVolumeKg = ({
+  workout,
+  measurements,
+}: WorkoutVolumeKgProps) => {
+  const workoutDate = new Date(workout.start_time * 1000);
+  /** We consider only measurements that include a body weight */
+  const bodyWeightMeasurements = measurements.filter(
+    (m): m is BodyWeightMeasurement => !!m.weight_kg,
+  );
+
+  /** latest logged bodyweight that is older than the workout itself */
+  const mostRecentMeasurementBeforeWorkout =
+    getClosestRelevantBodyWeightKgForDate(bodyWeightMeasurements, workoutDate);
+
+  /**
+   * there are no bodyweights logged *before* the workout, so take the oldest
+   * logged bodyweight, even though it's newer than the workout, as that's the
+   * closest approximation that we've got. if there is nothing logged at all,
+   * then we have to take 0
+   */
+  const oldestLoggedMeasurement = bodyWeightMeasurements[0]?.weight_kg ?? 0;
+
+  const bodyweightKg =
+    mostRecentMeasurementBeforeWorkout ?? oldestLoggedMeasurement;
+
+  return workoutVolumeSetsVolumeKg({
+    bodyweightKg,
+    sets: workoutToWorkoutVolumeSets(workout),
+  });
+};
+
+/**
+ * Given a date, this will return the nearest bodyweight value
+ * that was logged before it.
+ */
+export const getClosestRelevantBodyWeightKgForDate = (
+  bodyWeightMeasurements: BodyWeightMeasurement[],
+  date: Date,
+): number | undefined => {
+  return getClosestDataPointBeforeTargetDate(
+    bodyWeightMeasurements,
+    (m: BodyWeightMeasurement) => new Date(m.date),
+    date,
+  )?.weight_kg;
+};
+
+export interface WorkoutVolumeSetsVolumeKgProps {
+  bodyweightKg: number; // Pass 0 if it's not known
+  sets: WorkoutVolumeSet[];
+}
+
+export const workoutVolumeSetsVolumeKg = ({
+  bodyweightKg,
+  sets,
+}: WorkoutVolumeSetsVolumeKgProps): number => {
+  return sets.reduce((accu, s) => {
+    return accu + setVolumeKg(s, bodyweightKg);
+  }, 0);
+};
+
+export interface WorkoutVolumeSet {
+  type: ExerciseType;
+  exerciseTemplateId: string;
+  weightKg: number;
+  reps: number;
+  distanceMeters: number;
+}
+
+export const setVolumeKg = (
+  set: WorkoutVolumeSet,
+  bodyweightKg: number,
+): number => {
+  const { type, exerciseTemplateId, weightKg, reps, distanceMeters } = set;
+
+  switch (type) {
+    case 'weight_reps':
+      // eg. Bench Press (Barbell)
+      return weightKg * reps;
+    case 'reps_only':
+      if (is100PercentBodyWeightExercise(exerciseTemplateId)) {
+        // eg. Pull Up
+        return bodyweightKg * reps;
+      } else {
+        // eg. Push Up
+        return 0;
+      }
+    case 'bodyweight_reps':
+      if (is100PercentBodyWeightExercise(exerciseTemplateId)) {
+        // eg. Pull Up (Weighted)
+        return (weightKg + bodyweightKg) * reps;
+      } else {
+        // eg. Push Up (Weighted)
+        return weightKg * reps;
+      }
+    case 'bodyweight_assisted_reps':
+      if (is100PercentBodyWeightExercise(exerciseTemplateId)) {
+        // eg. Pull Up (Assisted)
+        const bodyweightAssistedRepsVolume = (bodyweightKg - weightKg) * reps;
+        return Math.max(bodyweightAssistedRepsVolume, 0);
+      } else {
+        // e.g. a custom `bodyweight_assisted_reps` exercise
+        return 0;
+      }
+    case 'short_distance_weight':
+      // eg. Farmers Walk
+      return distanceMeters * weightKg;
+    default:
+      // `duration` and `distance_duration` exercises
+      return 0;
+  }
+};
+
+const workoutToWorkoutVolumeSets = (workout: Workout) => {
+  const unflatSets = workout.exercises.map((e) => {
+    return e.sets.map((s) => {
+      return {
+        type: e.exercise_type || 'weight_reps',
+        exerciseTemplateId: e.exercise_template_id,
+        weightKg: s.weight_kg ?? 0,
+        reps: s.reps ?? 0,
+        distanceMeters: s.distance_meters ?? 0,
+      } as WorkoutVolumeSet;
+    });
+  });
+
+  const sets: WorkoutVolumeSet[] = flatten(unflatSets);
+
+  return sets;
+};

package/tsconfig.json

@@ -0,0 +1,70 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "ES2016",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./built",                      /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  },
+  "exclude": [
+    "node_modules",
+    "built"
+  ]
+}

package/built/API/APIClient.d.ts

@@ -1,157 +0,0 @@
-import { ClientAuthToken, DeepReadonly } from '..';
-import { RequestConfig, HTTPResponse, HTTPClient, HTTPRequestCompletionCallback, HTTPErrorHandler } from './types';
-interface HevyAPIClientConfig<UserContext> {
-    /**
-     * How long before predicted token expiry to request a new token. We request
-     * new tokens a little bit before they expire, so that we don't have to wait
-     * for the backend to send us a 401 first. We do it pre-emptively so that we
-     * wouldn't need to wait for requests to fail first, and then retry them.
-     *
-     * Optional.
-     *
-     * @default {1 minute}
-     */
-    readonly tokenExpirySafetyThresholdMs?: number;
-    /**
-     * How long we expect the access token to be valid for. Used to override the
-     * expiry time sent by the backend in case the client clock is in the future
-     * and the client thinks that the token will expire sooner than it actually
-     * will. Even if this assumption ever stops being correct, the client will be
-     * able to self-correct by receiving an `AccessTokenExpired` 401 response.
-     *
-     * Optional.
-     *
-     * @default {15 minutes}
-     */
-    readonly accessTokenMinimumValidAgeMs?: number;
-    /**
-     * Minimum time between successive calls to the `auth/refresh_token` endpoint
-     * in case it doesn't return an error. Also used to deal with potential clock
-     * issues on the client side, or some unforeseen issue on the backend, as the
-     * last line of defence. No matter what may happen, we absolutely never ever
-     * want to end up accidentally spamming this endpoint because it could have a
-     * cascading clusterfuck effect on all the other requests.
-     *
-     * Optional.
-     *
-     * @default {20 seconds}
-     */
-    readonly tokenRefreshThrottleMs?: number;
-    /**
-     * The API endpoint used to refresh the auth tokens using a refresh token.
-     * The URL is relative to the backend base URL.
-     *
-     * Optional.
-     *
-     * @default {POST /auth/refresh_token}
-     */
-    readonly refreshAuthTokenApiEndpoint?: {
-        readonly method: 'post';
-        readonly url: string;
-    };
-    /**
-     * Callback to use when receiving a new auth token. Used to send it to the
-     * consumer of the class to save the new token to its local storage.
-     *
-     * Required.
-     */
-    onNewAuthToken(newAuthToken: ClientAuthToken, userContext: UserContext): void;
-    /**
-     * Defines an arbitrary object to be passed back to the `onNewAuthToken`. The
-     * value is computed at the time when the request is made. Useful for passing
-     * back state that may have gotten changed during the time while the request
-     * was being processed, such as holding onto a userId across a logout action.
-     *
-     * Optional.
-     */
-    getUserContext?(): UserContext;
-    /**
-     * Callback to use when receiving an HTTP error response from the backend, to
-     * determine whether it is a response indicating that the token has expired.
-     *
-     * Optional.
-     *
-     * @default ...
-     */
-    isAccessTokenExpiredResponse?(response: HTTPResponse<unknown>): boolean;
-    /**
-     * Callback to use when receiving an HTTP error response from the backend, to
-     * determine whether it is a response indicating that the token is invalid.
-     *
-     * Optional.
-     *
-     * @default ...
-     */
-    isAccessTokenInvalidResponse?(response: HTTPResponse<unknown>): boolean;
-}
-export declare class HevyAPIClient<UserContext = never> {
-    private static readonly DEFAULT_TOKEN_EXPIRY_SAFETY_THRESHOLD_MS;
-    private static readonly DEFAULT_ACCESS_TOKEN_MINIMUM_VALID_AGE_MS;
-    private static readonly DEFAULT_TOKEN_REFRESH_THROTTLE_MS;
-    private static readonly DEFAULT_REFRESH_AUTH_TOKEN_API_ENDPOINT;
-    private readonly _config;
-    private _requestCompletionCallbacks;
-    private _errorHandlers;
-    private _authTokenFactory;
-    private _legacyAuthToken;
-    private _httpClient;
-    private _lastTokenRefresh;
-    private _lastSessionDelete;
-    constructor(httpClient: HTTPClient, config: HevyAPIClientConfig<UserContext>);
-    private get _authToken();
-    private get _authHeaders();
-    private _addHeaders;
-    private refreshExpiredAuthToken;
-    private forceRefreshAuthToken;
-    private waitForTokenRefresh;
-    private get _isTokenRecentlyRefreshed();
-    private _refreshAuthToken;
-    private _handleResponse;
-    isAccessTokenExpiredResponse(response: HTTPResponse<unknown>): boolean;
-    isAccessTokenInvalidResponse(response: HTTPResponse<unknown>): boolean;
-    get refreshAuthTokenApiEndpoint(): {
-        readonly method: "post";
-        readonly url: string;
-    };
-    setAuthToken(newAuthToken: {
-        authToken: DeepReadonly<ClientAuthToken> | null;
-        legacyAuthToken: string | null;
-    }): Promise<void>;
-    setAuthToken(newAuthToken: {
-        getAuthToken: () => ClientAuthToken | null;
-        legacyAuthToken: string | null;
-    }): Promise<void>;
-    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.
-     */
-    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 attachRequestCompletionCallback}.
-     */
-    attachErrorHandler(onError: HTTPErrorHandler<{
-        willRetry: boolean;
-        isTokenRefreshedAfterRequest: boolean;
-        isPreviousSession: boolean;
-    }>): void;
-    removeErrorHandlers(): void;
-    get<T = never>(url: string, config?: RequestConfig): Promise<HTTPResponse<T>>;
-    delete<T = never>(url: string, config?: RequestConfig): Promise<HTTPResponse<T>>;
-    head<T = never>(url: string, config?: RequestConfig): Promise<HTTPResponse<T>>;
-    options<T = never>(url: string, config?: RequestConfig): Promise<HTTPResponse<T>>;
-    post<T = never, R = unknown>(url: string, data?: R, config?: RequestConfig): Promise<HTTPResponse<T>>;
-    put<T = never, R = unknown>(url: string, data?: R, config?: RequestConfig): Promise<HTTPResponse<T>>;
-    patch<T = never, R = unknown>(url: string, data?: R, config?: RequestConfig): Promise<HTTPResponse<T>>;
-}
-export {};