V28: Introduce scroll inputs for LayerGroup (#114)

Author: pianostringquartet

Sources/StitchSchemaKit/SchemaVersions.swift

@@ -9,105 +9,105 @@ import Foundation
 import SwiftUI
 
 // MARK: - UPDATE VERSION NUMBERS HERE
-public typealias CurrentAsyncMediaValue = AsyncMediaValue_V27
-public typealias CurrentClassicAnimationCurve = ClassicAnimationCurve_V27
-public typealias CurrentCameraSettings = CameraSettings_V27
-public typealias CurrentCommentBoxData = CommentBoxData_V27
-public typealias CurrentCustomShape = CustomShape_V27
-public typealias CurrentDataType = DataType_V27
-public typealias CurrentDelayStyle = DelayStyle_V27
-public typealias CurrentDateAndTimeFormat = DateAndTimeFormat_V27
-public typealias CurrentExpansionDirection = ExpansionDirection_V27
-public typealias CurrentGroupNodeIDCoordinate = GroupNodeID_V27
-public typealias CurrentPatch = Patch_V27
-public typealias CurrentPatchNodeEntity = PatchNodeEntity_V27
-public typealias CurrentLayerDimension = LayerDimension_V27
-public typealias CurrentLayerNodeEntity = LayerNodeEntity_V27
-public typealias CurrentLayerNodeId = LayerNodeId_V27
-public typealias CurrentNodeEntity = NodeEntity_V27
-public typealias CurrentNodePortInputEntity = NodePortInputEntity_V27
-public typealias CurrentSplitterNodeEntity = SplitterNodeEntity_V27
-public typealias CurrentSplitterType = SplitterType_V27
-public typealias CurrentNodeIOCoordinate = NodeIOCoordinate_V27
-public typealias CurrentJSONCurveTo = JSONCurveTo_V27
-public typealias CurrentJSONShapeCommand = JSONShapeCommand_V27
-public typealias CurrentJSONShapeKeys = JSONShapeKeys_V27
-public typealias CurrentSidebarLayerData = SidebarLayerData_V27
-public typealias CurrentNodeKind = NodeKind_V27
-public typealias CurrentAnchoring = Anchoring_V27
-public typealias CurrentCameraDirection = CameraDirection_V27
-public typealias CurrentLayer = Layer_V27
-public typealias CurrentLayerSize = LayerSize_V27
-public typealias CurrentLayerTextDecoration = LayerTextDecoration_V27
-public typealias CurrentLayerStroke = LayerStroke_V27
-public typealias CurrentLayerTextAlignment = LayerTextAlignment_V27
-public typealias CurrentLayerTextVerticalAlignment = LayerTextVerticalAlignment_V27
-public typealias CurrentLightType = LightType_V27
-public typealias CurrentMediaKey = MediaKey_V27
-public typealias CurrentMobileHapticStyle = MobileHapticStyle_V27
-public typealias CurrentNetworkRequestType = NetworkRequestType_V27
-public typealias CurrentPathPoint = PathPoint_V27
-public typealias CurrentPlane = Plane_V27
-public typealias CurrentPoint3D = Point3D_V27
-public typealias CurrentPoint4D = Point4D_V27
-public typealias CurrentPortValueComparable = PortValueComparable_V27
-public typealias CurrentPreviewSize = PreviewSize_V27
-public typealias CurrentRGBA = RGBA_V27
-public typealias CurrentRoundedRectangleData = RoundedRectangleData_V27
-public typealias CurrentScrollDecelerationRate = ScrollDecelerationRate_V27
-public typealias CurrentScrollJumpStyle = ScrollJumpStyle_V27
-public typealias CurrentScrollMode = ScrollMode_V27
-public typealias CurrentShapeCommand = ShapeCommand_V27
-public typealias CurrentShapeCommandType = ShapeCommandType_V27
-public typealias CurrentShapeCoordinates = ShapeCoordinates_V27
-public typealias CurrentShapeAndRect = ShapeAndRect_V27
-public typealias CurrentStitchDocument = StitchDocument_V27
-public typealias CurrentStitchBlendMode = StitchBlendMode_V27
-public typealias CurrentStitchCameraOrientation = StitchCameraOrientation_V27
-public typealias CurrentStitchDeviceOrientation = StitchDeviceOrientation_V27
-public typealias CurrentStitchMapType = StitchMapType_V27
-public typealias CurrentStitchFont = StitchFont_V27
-public typealias CurrentStitchFontChoice = StitchFontChoice_V27
-public typealias CurrentStitchFontWeight = StitchFontWeight_V27
-public typealias CurrentStitchJSON = StitchJSON_V27
-public typealias CurrentStitchOrientation = StitchOrientation_V27
-public typealias CurrentStitchProgressIndicatorStyle = ProgressIndicatorStyle_V27
-public typealias CurrentTextTransform = TextTransform_V27
-public typealias CurrentTriangleData = TriangleData_V27
-public typealias CurrentPortValue = PortValue_V27
-public typealias CurrentUserVisibleType = UserVisibleType_V27
-public typealias CurrentVisualMediaFitStyle = VisualMediaFitStyle_V27
-public typealias CurrentNodeConnectionType = NodeConnectionType_V27
-public typealias CurrentLayerInputType = LayerInputType_V27
-public typealias CurrentNodeIOPortType = NodeIOPortType_V27
-public typealias CurrentStrokeLineCap = StrokeLineCap_V27
-public typealias CurrentStrokeLineJoin = StrokeLineJoin_V27
-public typealias CurrentStitchStringValue = StitchStringValue_V27
-public typealias CurrentStitchContentMode = StitchContentMode_V27
-public typealias CurrentStitchSpacing = StitchSpacing_V27
-public typealias CurrentStitchPadding = StitchPadding_V27
-public typealias CurrentSizingScenario = SizingScenario_V27
-public typealias CurrentNodeTypeEntity = NodeTypeEntity_V27
-public typealias CurrentCanvasNodeEntity = CanvasNodeEntity_V27
-public typealias CurrentLayerInputDataEntity = LayerInputDataEntity_V27
-public typealias CurrentCanvasItemId = CanvasItemId_V27
-public typealias CurrentLayerInputCoordinate = LayerInputCoordinate_V27
-public typealias CurrentLayerOutputCoordinate = LayerOutputCoordinate_V27
-public typealias CurrentPinToId = PinToId_V27
-public typealias CurrentLayerInputEntity = LayerInputEntity_V27
-public typealias CurrentLayerInputPort = LayerInputPort_V27
-public typealias CurrentLayerInputKeyPathType = LayerInputKeyPathType_V27
-public typealias CurrentUnpackedPortType = UnpackedPortType_V27
-public typealias CurrentStitchTransform = StitchTransform_V27
-public typealias CurrentStitchComponent = StitchComponent_V27
-public typealias CurrentComponentEntity = ComponentEntity_V27
-public typealias CurrentGraphEntity = GraphEntity_V27
-public typealias CurrentGraphSaveLocation = GraphSaveLocation_V27
-public typealias CurrentGraphDocumentPath = GraphDocumentPath_V27
-public typealias CurrentStitchSystemType = StitchSystemType_V27
-public typealias CurrentStitchSystem = StitchSystem_V27
-public typealias CurrentDeviceAppearance = DeviceAppearance_V27
-public typealias CurrentMaterialThickness = MaterialThickness_V27
+public typealias CurrentAsyncMediaValue = AsyncMediaValue_V28
+public typealias CurrentClassicAnimationCurve = ClassicAnimationCurve_V28
+public typealias CurrentCameraSettings = CameraSettings_V28
+public typealias CurrentCommentBoxData = CommentBoxData_V28
+public typealias CurrentCustomShape = CustomShape_V28
+public typealias CurrentDataType = DataType_V28
+public typealias CurrentDelayStyle = DelayStyle_V28
+public typealias CurrentDateAndTimeFormat = DateAndTimeFormat_V28
+public typealias CurrentExpansionDirection = ExpansionDirection_V28
+public typealias CurrentGroupNodeIDCoordinate = GroupNodeID_V28
+public typealias CurrentPatch = Patch_V28
+public typealias CurrentPatchNodeEntity = PatchNodeEntity_V28
+public typealias CurrentLayerDimension = LayerDimension_V28
+public typealias CurrentLayerNodeEntity = LayerNodeEntity_V28
+public typealias CurrentLayerNodeId = LayerNodeId_V28
+public typealias CurrentNodeEntity = NodeEntity_V28
+public typealias CurrentNodePortInputEntity = NodePortInputEntity_V28
+public typealias CurrentSplitterNodeEntity = SplitterNodeEntity_V28
+public typealias CurrentSplitterType = SplitterType_V28
+public typealias CurrentNodeIOCoordinate = NodeIOCoordinate_V28
+public typealias CurrentJSONCurveTo = JSONCurveTo_V28
+public typealias CurrentJSONShapeCommand = JSONShapeCommand_V28
+public typealias CurrentJSONShapeKeys = JSONShapeKeys_V28
+public typealias CurrentSidebarLayerData = SidebarLayerData_V28
+public typealias CurrentNodeKind = NodeKind_V28
+public typealias CurrentAnchoring = Anchoring_V28
+public typealias CurrentCameraDirection = CameraDirection_V28
+public typealias CurrentLayer = Layer_V28
+public typealias CurrentLayerSize = LayerSize_V28
+public typealias CurrentLayerTextDecoration = LayerTextDecoration_V28
+public typealias CurrentLayerStroke = LayerStroke_V28
+public typealias CurrentLayerTextAlignment = LayerTextAlignment_V28
+public typealias CurrentLayerTextVerticalAlignment = LayerTextVerticalAlignment_V28
+public typealias CurrentLightType = LightType_V28
+public typealias CurrentMediaKey = MediaKey_V28
+public typealias CurrentMobileHapticStyle = MobileHapticStyle_V28
+public typealias CurrentNetworkRequestType = NetworkRequestType_V28
+public typealias CurrentPathPoint = PathPoint_V28
+public typealias CurrentPlane = Plane_V28
+public typealias CurrentPoint3D = Point3D_V28
+public typealias CurrentPoint4D = Point4D_V28
+public typealias CurrentPortValueComparable = PortValueComparable_V28
+public typealias CurrentPreviewSize = PreviewSize_V28
+public typealias CurrentRGBA = RGBA_V28
+public typealias CurrentRoundedRectangleData = RoundedRectangleData_V28
+public typealias CurrentScrollDecelerationRate = ScrollDecelerationRate_V28
+public typealias CurrentScrollJumpStyle = ScrollJumpStyle_V28
+public typealias CurrentScrollMode = ScrollMode_V28
+public typealias CurrentShapeCommand = ShapeCommand_V28
+public typealias CurrentShapeCommandType = ShapeCommandType_V28
+public typealias CurrentShapeCoordinates = ShapeCoordinates_V28
+public typealias CurrentShapeAndRect = ShapeAndRect_V28
+public typealias CurrentStitchDocument = StitchDocument_V28
+public typealias CurrentStitchBlendMode = StitchBlendMode_V28
+public typealias CurrentStitchCameraOrientation = StitchCameraOrientation_V28
+public typealias CurrentStitchDeviceOrientation = StitchDeviceOrientation_V28
+public typealias CurrentStitchMapType = StitchMapType_V28
+public typealias CurrentStitchFont = StitchFont_V28
+public typealias CurrentStitchFontChoice = StitchFontChoice_V28
+public typealias CurrentStitchFontWeight = StitchFontWeight_V28
+public typealias CurrentStitchJSON = StitchJSON_V28
+public typealias CurrentStitchOrientation = StitchOrientation_V28
+public typealias CurrentStitchProgressIndicatorStyle = ProgressIndicatorStyle_V28
+public typealias CurrentTextTransform = TextTransform_V28
+public typealias CurrentTriangleData = TriangleData_V28
+public typealias CurrentPortValue = PortValue_V28
+public typealias CurrentUserVisibleType = UserVisibleType_V28
+public typealias CurrentVisualMediaFitStyle = VisualMediaFitStyle_V28
+public typealias CurrentNodeConnectionType = NodeConnectionType_V28
+public typealias CurrentLayerInputType = LayerInputType_V28
+public typealias CurrentNodeIOPortType = NodeIOPortType_V28
+public typealias CurrentStrokeLineCap = StrokeLineCap_V28
+public typealias CurrentStrokeLineJoin = StrokeLineJoin_V28
+public typealias CurrentStitchStringValue = StitchStringValue_V28
+public typealias CurrentStitchContentMode = StitchContentMode_V28
+public typealias CurrentStitchSpacing = StitchSpacing_V28
+public typealias CurrentStitchPadding = StitchPadding_V28
+public typealias CurrentSizingScenario = SizingScenario_V28
+public typealias CurrentNodeTypeEntity = NodeTypeEntity_V28
+public typealias CurrentCanvasNodeEntity = CanvasNodeEntity_V28
+public typealias CurrentLayerInputDataEntity = LayerInputDataEntity_V28
+public typealias CurrentCanvasItemId = CanvasItemId_V28
+public typealias CurrentLayerInputCoordinate = LayerInputCoordinate_V28
+public typealias CurrentLayerOutputCoordinate = LayerOutputCoordinate_V28
+public typealias CurrentPinToId = PinToId_V28
+public typealias CurrentLayerInputEntity = LayerInputEntity_V28
+public typealias CurrentLayerInputPort = LayerInputPort_V28
+public typealias CurrentLayerInputKeyPathType = LayerInputKeyPathType_V28
+public typealias CurrentUnpackedPortType = UnpackedPortType_V28
+public typealias CurrentStitchTransform = StitchTransform_V28
+public typealias CurrentStitchComponent = StitchComponent_V28
+public typealias CurrentComponentEntity = ComponentEntity_V28
+public typealias CurrentGraphEntity = GraphEntity_V28
+public typealias CurrentGraphSaveLocation = GraphSaveLocation_V28
+public typealias CurrentGraphDocumentPath = GraphDocumentPath_V28
+public typealias CurrentStitchSystemType = StitchSystemType_V28
+public typealias CurrentStitchSystem = StitchSystem_V28
+public typealias CurrentDeviceAppearance = DeviceAppearance_V28
+public typealias CurrentMaterialThickness = MaterialThickness_V28
 
 // MARK: - end
 
@@ -139,4 +139,5 @@ public enum StitchSchemaVersion: Int, VersionType {
     case _V25 = 25
     case _V26 = 26
     case _V27 = 27
+    case _V28 = 28
 }

Sources/StitchSchemaKit/V1/NodePort/PortValue_V1.swift

@@ -62,7 +62,7 @@ public enum PortValue_V1: StitchSchemaVersionable {
         case networkRequestType(NetworkRequestType)
         case color(Color)
         case size(LayerSize)
-        case position(CGSize) // TODO: use `CGPoint` instead of `CGSize`
+        case position(CGSize)
         case point3D(Point3D)
         case point4D(Point4D)
         case pulse(TimeInterval) // TimeInterval = last time this input/output pulsed

Sources/StitchSchemaKit/V27/PortValueTypes/SidebarLayerData_V27.swift

@@ -45,7 +45,6 @@ extension SidebarLayerData_V27.SidebarLayerData: StitchVersionedCodable {
         let migratedChildren: [Self] = .init(previousElements: prevChildren)
         self.init(id: previousInstance.id,
                   children: migratedChildren,
-                  
                   // TODO: use previousInstance data after version 27
                   isExpandedInSidebar: true)
     }

Sources/StitchSchemaKit/V28/CommentBoxData_V28.swift

@@ -0,0 +1,72 @@
+//
+//  CommentBoxData_V28.swift
+//
+//
+//  Created by Nicholas Arner on 1/27/24.
+//
+
+import Foundation
+import SwiftUI
+
+public enum CommentBoxData_V28: StitchSchemaVersionable {
+    // MARK: - ensure versions are correct
+    public static let version: StitchSchemaVersion = StitchSchemaVersion._V28
+    public typealias PreviousInstance = CommentBoxData_V27.CommentBoxData
+    public typealias CanvasItemId = CanvasItemId_V28.CanvasItemId
+    // MARK: - endif
+ 
+    public struct CommentBoxData: Hashable {
+        public var id: UUID
+        
+        /*
+         "Which traversal level (group node) does this comment box belong to?"
+         
+         nil = top level
+         
+         TODO: implement this properly, but wait until after SwiftData since e.g. VisibleNodesViewModel etc. may be changing.
+         
+         For now we just make all comment boxes top-level.
+         */
+        public var groupId: UUID?
+        public var title: String = "Comment"
+        public var color: Color
+        public var nodes: Set<CanvasItemId>
+        public var position: CGPoint
+        public var size: CGSize
+        public var zIndex: Double // = .zero
+        
+        public init(id: CommentBoxId = .init(),
+                    groupId: UUID? = nil,
+                    title: String = "Comment",
+                    color: Color,
+                    nodes: Set<CanvasItemId> = .init(),
+                    position: CGPoint = .zero,
+                    size: CGSize,
+                    zIndex: Double) {
+            self.id = id
+            self.groupId = groupId
+            self.title = title
+            self.color = color
+            self.nodes = nodes
+            self.position = position
+            self.size = size
+            self.zIndex = zIndex
+        }
+    }
+}
+
+extension CommentBoxData_V28.CommentBoxData: StitchVersionedCodable {
+    public init(previousInstance: CommentBoxData_V28.PreviousInstance) {
+        self.init(id: previousInstance.id,
+                  groupId: previousInstance.groupId,
+                  title: previousInstance.title,
+                  color: previousInstance.color,
+
+                  // MARK: just needed for V23, should point to property in future versions
+                  nodes: .init(),
+
+                  position: previousInstance.position,
+                  size: previousInstance.size,
+                  zIndex: previousInstance.zIndex)
+    }
+}

Sources/StitchSchemaKit/V28/Document/StitchComponent_V28.swift

@@ -0,0 +1,38 @@
+//
+//  File.swift
+//  
+//
+//  Created by Elliot Boschwitz on 8/17/24.
+//
+
+import Foundation
+
+public enum StitchComponent_V28: StitchSchemaVersionable {
+
+    // MARK: - ensure versions are correct
+    public static let version = StitchSchemaVersion._V28
+    public typealias PreviousInstance = StitchComponent_V27.StitchComponent
+    public typealias GraphEntity = GraphEntity_V28.GraphEntity
+    public typealias GraphSaveLocation = GraphSaveLocation_V28.GraphSaveLocation
+    public typealias SidebarLayerList = [SidebarLayerData_V28.SidebarLayerData]
+    // MARK: - end
+
+    public struct StitchComponent: StitchVersionedCodable, Hashable, Sendable {
+        // Share location, saved here due to static helpers for sharing
+        public var saveLocation: GraphSaveLocation
+        public var graph: GraphEntity
+        
+        public init(saveLocation: GraphSaveLocation,
+                    graph: GraphEntity) {
+            self.saveLocation = saveLocation
+            self.graph = graph
+        }
+    }
+}
+
+extension StitchComponent_V28.StitchComponent {
+    public init(previousInstance: StitchComponent_V28.PreviousInstance) {
+        self = .init(saveLocation: .init(previousInstance: previousInstance.saveLocation),
+                     graph: .init(previousInstance: previousInstance.graph))
+    }
+}