Repository navigation
feat(workouts): add WorkoutBuilder hybrid object - #400
Open
EvgeniiaVak wants to merge 1 commit into
Open
EvgeniiaVak wants to merge 1 commit into
EvgeniiaVak wants to merge 1 commit into
Conversation
Add createWorkoutBuilder, a 1:1 wrapper over HKWorkoutBuilder, to save workouts with events (pause/resume, laps, segments) and, on iOS 16+, workout activities. Core gains an Objective-C HKWorkoutEvent factory so invalid events reject instead of crashing. Closes kingstinct#269 Closes kingstinct#110
🦋 Changeset detectedLatest commit: 6ca3efe The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
createWorkoutBuilder, which returns aWorkoutBuilderhybrid object wrappingHKWorkoutBuilderone-to-one, as discussed in #269. It saves workouts with events (pause/resume, laps, segments) and, on iOS 16+, workout activities.saveWorkoutSampleand the other existing APIs are unchanged.Closes #269
Closes #110
API
createWorkoutBuilder(configuration)onWorkoutsModule. The builder has one method perHKWorkoutBuildercall:beginCollection,add,addMetadata,addWorkoutEvents,addWorkoutActivity(resolves with the activity UUID),updateActivityEndDate,updateActivityMetadata,endCollection,finishWorkout(resolves with aWorkoutProxy, orundefinedwhen HealthKit returns none),discardWorkoutandelapsedTime. The builder's state is exposed as readonly properties.Notes
HKWorkoutEventraises an Objective-C exception for invalid input (e.g. a pause with a duration). Core gainscreateWorkoutEventSafe, which creates the event in Objective-C, so the promise rejects instead of the app crashing.finishWorkoutordiscardWorkoutreject instead of hanging. HealthKit never calls their completion.Testing