fix!: Remove unecessary exports, utilize core types instead of SynchroCharts #600
Conversation
This file contains 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
|
What is the breaking change? |
diehbria
force-pushed
the
remove-exports-2
branch
from
669411b
to
7eb2962
Compare
Added to PR overview, will update commit message with a bit more detail for |
|
LGTM. No blockers to merge. |
tracy-french
previously approved these changes
Feb 21, 2023
| @@ -26,5 +25,5 @@ export const round = (num: number): number => { | |||
| /** | |||
| * Checks if value can be used as a number | |||
| */ | |||
| export const isNumeric = (value: ThresholdDataTypes): boolean => | |||
| export const isNumeric = (value: Primitive): boolean => | |||
There was a problem hiding this comment.
Is there any reason why these predicates are not written as type predicates?
Comment on lines
-180
to
+149
| expect(isMinimalStaticViewport(viewport as unknown as MinimalLiveViewport)).toBeFalse(); | ||
| expect(isHistoricalViewport({ start: new Date() } as unknown as DurationViewport)).toBeFalse(); | ||
| }); | ||
|
|
||
| it('returns false when the start date is missing', () => { | ||
| const viewport: Omit<MinimalStaticViewport, 'start'> = { | ||
| yMin: 0, | ||
| yMax: 10, | ||
| end: new Date(), | ||
| }; | ||
|
|
||
| expect(isMinimalStaticViewport(viewport as unknown as MinimalLiveViewport)).toBeFalse(); | ||
| expect(isHistoricalViewport({ end: new Date() } as unknown as DurationViewport)).toBeFalse(); |
There was a problem hiding this comment.
Why are these object literals cast as unknown? Looks like a hack?
There was a problem hiding this comment.
this is necessary because i'm passing invalid inputs into the utility function that don't adhere to the typescript types but open to other suggestions
diehbria
force-pushed
the
remove-exports-2
branch
from
7eb2962
to
70fe73c
Compare
…oChart types BREAKING CHANGES: * Removed optional types yMin and yMax from Viewport type exported from @iot-app-kit/core * Updated TimeSeriesDataModule to utilize Viewport from @iot-app-kit/core instead of MinimalViewPortConfig from ‘@synchro-charts/core’ * Updated TimeSeriesDataRequest type to refer to Viewport from @iot-app-kit/core instead of @synchro-charts/core * Removed exported mock widget properties from @iot-app-kit/core * Updated viewportManager to utilize Viewport from @iot-app-kit/core instead of @synchro-charts/core * Export the data types as DATA_TYPE constant from @iot-app-kit/core, instead of as a DataType enum.
diehbria
force-pushed
the
remove-exports-2
branch
from
70fe73c
to
65c6942
Compare
tracy-french
approved these changes
Feb 22, 2023
Closed
tjuranek
pushed a commit
that referenced
this pull request
Feb 22, 2023
…oChart types (#600) BREAKING CHANGES: * Removed optional types yMin and yMax from Viewport type exported from @iot-app-kit/core * Updated TimeSeriesDataModule to utilize Viewport from @iot-app-kit/core instead of MinimalViewPortConfig from ‘@synchro-charts/core’ * Updated TimeSeriesDataRequest type to refer to Viewport from @iot-app-kit/core instead of @synchro-charts/core * Removed exported mock widget properties from @iot-app-kit/core * Updated viewportManager to utilize Viewport from @iot-app-kit/core instead of @synchro-charts/core * Export the data types as DATA_TYPE constant from @iot-app-kit/core, instead of as a DataType enum.
This was referenced Mar 4, 2023
Closed
Merged
Closed
Closed
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.
Overview
This pull request cleans up the IoT App Kit APIs, untangling it from Synchro Charts. There is more work required to fully untangle IoT App Kit from Synchro Charts - but this PR takes major strides towards that direction.
Breaking Changes
yMinandyMaxfromViewporttype exported from@iot-app-kit/coreTimeSeriesDataModuleto utilizeViewportfrom@iot-app-kit/coreinstead ofMinimalViewPortConfigfrom ‘@synchro-charts/core’TimeSeriesDataRequesttype to refer toViewportfrom@iot-app-kit/coreinstead of@synchro-charts/coreviewportManagerto utilizeViewportfrom @iot-app-kit/core instead of @synchro-charts/coreDATA_TYPEconstant from @iot-app-kit/core, instead of as aDataTypeenum.Notable, non-breaking changes
DurationViewportandHistoricalViewportfrom @iot-app-kit/corePrimitive,DataStreamid,Timestamp,StreamAssociation, andDataPointfrom @iot-app-kit/coreLegal
This project is available under the Apache 2.0 License.