V22: Introduce pinning layer inputs (#89)

Author: pianostringquartet

Sources/StitchSchemaKit/SchemaVersions.swift

@@ -9,90 +9,91 @@ import Foundation
 import SwiftUI
 
 // MARK: - UPDATE VERSION NUMBERS HERE
-public typealias CurrentAsyncMediaValue = AsyncMediaValue_V21
-public typealias CurrentClassicAnimationCurve = ClassicAnimationCurve_V21
-public typealias CurrentCameraSettings = CameraSettings_V21
-public typealias CurrentCommentBoxData = CommentBoxData_V21
-public typealias CurrentCustomShape = CustomShape_V21
-public typealias CurrentDataType = DataType_V21
-public typealias CurrentDelayStyle = DelayStyle_V21
-public typealias CurrentDateAndTimeFormat = DateAndTimeFormat_V21
-public typealias CurrentExpansionDirection = ExpansionDirection_V21
-public typealias CurrentGroupNodeIDCoordinate = GroupNodeID_V21
-public typealias CurrentPatch = Patch_V21
-public typealias CurrentPatchNodeEntity = PatchNodeEntity_V21
-public typealias CurrentLayerDimension = LayerDimension_V21
-public typealias CurrentLayerNodeEntity = LayerNodeEntity_V21
-public typealias CurrentLayerNodeId = LayerNodeId_V21
-public typealias CurrentNodeEntity = NodeEntity_V21
-public typealias CurrentNodePortInputEntity = NodePortInputEntity_V21
-public typealias CurrentSplitterNodeEntity = SplitterNodeEntity_V21
-public typealias CurrentSplitterType = SplitterType_V21
-public typealias CurrentNodeIOCoordinate = NodeIOCoordinate_V21
-public typealias CurrentJSONCurveTo = JSONCurveTo_V21
-public typealias CurrentJSONShapeCommand = JSONShapeCommand_V21
-public typealias CurrentJSONShapeKeys = JSONShapeKeys_V21
-public typealias CurrentSidebarLayerData = SidebarLayerData_V21
-public typealias CurrentNodeKind = NodeKind_V21
-public typealias CurrentAnchoring = Anchoring_V21
-public typealias CurrentCameraDirection = CameraDirection_V21
-public typealias CurrentLayer = Layer_V21
-public typealias CurrentLayerSize = LayerSize_V21
-public typealias CurrentLayerTextDecoration = LayerTextDecoration_V21
-public typealias CurrentLayerStroke = LayerStroke_V21
-public typealias CurrentLayerTextAlignment = LayerTextAlignment_V21
-public typealias CurrentLayerTextVerticalAlignment = LayerTextVerticalAlignment_V21
-public typealias CurrentLightType = LightType_V21
-public typealias CurrentMediaKey = MediaKey_V21
-public typealias CurrentMobileHapticStyle = MobileHapticStyle_V21
-public typealias CurrentNetworkRequestType = NetworkRequestType_V21
-public typealias CurrentPathPoint = PathPoint_V21
-public typealias CurrentPlane = Plane_V21
-public typealias CurrentPoint3D = Point3D_V21
-public typealias CurrentPoint4D = Point4D_V21
-public typealias CurrentPortValueComparable = PortValueComparable_V21
-public typealias CurrentPreviewSize = PreviewSize_V21
-public typealias CurrentRGBA = RGBA_V21
-public typealias CurrentRoundedRectangleData = RoundedRectangleData_V21
-public typealias CurrentScrollDecelerationRate = ScrollDecelerationRate_V21
-public typealias CurrentScrollJumpStyle = ScrollJumpStyle_V21
-public typealias CurrentScrollMode = ScrollMode_V21
-public typealias CurrentShapeCommand = ShapeCommand_V21
-public typealias CurrentShapeCommandType = ShapeCommandType_V21
-public typealias CurrentShapeCoordinates = ShapeCoordinates_V21
-public typealias CurrentShapeAndRect = ShapeAndRect_V21
-public typealias CurrentStitchDocument = StitchDocument_V21
-public typealias CurrentStitchBlendMode = StitchBlendMode_V21
-public typealias CurrentStitchCameraOrientation = StitchCameraOrientation_V21
-public typealias CurrentStitchDeviceOrientation = StitchDeviceOrientation_V21
-public typealias CurrentStitchMapType = StitchMapType_V21
-public typealias CurrentStitchFont = StitchFont_V21
-public typealias CurrentStitchFontChoice = StitchFontChoice_V21
-public typealias CurrentStitchFontWeight = StitchFontWeight_V21
-public typealias CurrentStitchJSON = StitchJSON_V21
-public typealias CurrentStitchOrientation = StitchOrientation_V21
-public typealias CurrentStitchProgressIndicatorStyle = ProgressIndicatorStyle_V21
-public typealias CurrentTextTransform = TextTransform_V21
-public typealias CurrentTriangleData = TriangleData_V21
-public typealias CurrentPortValue = PortValue_V21
-public typealias CurrentUserVisibleType = UserVisibleType_V21
-public typealias CurrentVisualMediaFitStyle = VisualMediaFitStyle_V21
-public typealias CurrentNodeConnectionType = NodeConnectionType_V21
-public typealias CurrentLayerInputType = LayerInputType_V21
-public typealias CurrentNodeIOPortType = NodeIOPortType_V21
-public typealias CurrentStrokeLineCap = StrokeLineCap_V21
-public typealias CurrentStrokeLineJoin = StrokeLineJoin_V21
-public typealias CurrentStitchStringValue = StitchStringValue_V21
-public typealias CurrentStitchContentMode = StitchContentMode_V21
-public typealias CurrentStitchSpacing = StitchSpacing_V21
-public typealias CurrentStitchPadding = StitchPadding_V21
-public typealias CurrentSizingScenario = SizingScenario_V21
-public typealias CurrentNodeTypeEntity = NodeTypeEntity_V21
-public typealias CurrentCanvasNodeEntity = CanvasNodeEntity_V21
-public typealias CurrentLayerInputDataEntity = LayerInputDataEntity_V21
-public typealias CurrentCanvasItemId = CanvasItemId_V21
-public typealias CurrentLayerInputCoordinate = LayerInputCoordinate_V21
-public typealias CurrentLayerOutputCoordinate = LayerOutputCoordinate_V21
+public typealias CurrentAsyncMediaValue = AsyncMediaValue_V22
+public typealias CurrentClassicAnimationCurve = ClassicAnimationCurve_V22
+public typealias CurrentCameraSettings = CameraSettings_V22
+public typealias CurrentCommentBoxData = CommentBoxData_V22
+public typealias CurrentCustomShape = CustomShape_V22
+public typealias CurrentDataType = DataType_V22
+public typealias CurrentDelayStyle = DelayStyle_V22
+public typealias CurrentDateAndTimeFormat = DateAndTimeFormat_V22
+public typealias CurrentExpansionDirection = ExpansionDirection_V22
+public typealias CurrentGroupNodeIDCoordinate = GroupNodeID_V22
+public typealias CurrentPatch = Patch_V22
+public typealias CurrentPatchNodeEntity = PatchNodeEntity_V22
+public typealias CurrentLayerDimension = LayerDimension_V22
+public typealias CurrentLayerNodeEntity = LayerNodeEntity_V22
+public typealias CurrentLayerNodeId = LayerNodeId_V22
+public typealias CurrentNodeEntity = NodeEntity_V22
+public typealias CurrentNodePortInputEntity = NodePortInputEntity_V22
+public typealias CurrentSplitterNodeEntity = SplitterNodeEntity_V22
+public typealias CurrentSplitterType = SplitterType_V22
+public typealias CurrentNodeIOCoordinate = NodeIOCoordinate_V22
+public typealias CurrentJSONCurveTo = JSONCurveTo_V22
+public typealias CurrentJSONShapeCommand = JSONShapeCommand_V22
+public typealias CurrentJSONShapeKeys = JSONShapeKeys_V22
+public typealias CurrentSidebarLayerData = SidebarLayerData_V22
+public typealias CurrentNodeKind = NodeKind_V22
+public typealias CurrentAnchoring = Anchoring_V22
+public typealias CurrentCameraDirection = CameraDirection_V22
+public typealias CurrentLayer = Layer_V22
+public typealias CurrentLayerSize = LayerSize_V22
+public typealias CurrentLayerTextDecoration = LayerTextDecoration_V22
+public typealias CurrentLayerStroke = LayerStroke_V22
+public typealias CurrentLayerTextAlignment = LayerTextAlignment_V22
+public typealias CurrentLayerTextVerticalAlignment = LayerTextVerticalAlignment_V22
+public typealias CurrentLightType = LightType_V22
+public typealias CurrentMediaKey = MediaKey_V22
+public typealias CurrentMobileHapticStyle = MobileHapticStyle_V22
+public typealias CurrentNetworkRequestType = NetworkRequestType_V22
+public typealias CurrentPathPoint = PathPoint_V22
+public typealias CurrentPlane = Plane_V22
+public typealias CurrentPoint3D = Point3D_V22
+public typealias CurrentPoint4D = Point4D_V22
+public typealias CurrentPortValueComparable = PortValueComparable_V22
+public typealias CurrentPreviewSize = PreviewSize_V22
+public typealias CurrentRGBA = RGBA_V22
+public typealias CurrentRoundedRectangleData = RoundedRectangleData_V22
+public typealias CurrentScrollDecelerationRate = ScrollDecelerationRate_V22
+public typealias CurrentScrollJumpStyle = ScrollJumpStyle_V22
+public typealias CurrentScrollMode = ScrollMode_V22
+public typealias CurrentShapeCommand = ShapeCommand_V22
+public typealias CurrentShapeCommandType = ShapeCommandType_V22
+public typealias CurrentShapeCoordinates = ShapeCoordinates_V22
+public typealias CurrentShapeAndRect = ShapeAndRect_V22
+public typealias CurrentStitchDocument = StitchDocument_V22
+public typealias CurrentStitchBlendMode = StitchBlendMode_V22
+public typealias CurrentStitchCameraOrientation = StitchCameraOrientation_V22
+public typealias CurrentStitchDeviceOrientation = StitchDeviceOrientation_V22
+public typealias CurrentStitchMapType = StitchMapType_V22
+public typealias CurrentStitchFont = StitchFont_V22
+public typealias CurrentStitchFontChoice = StitchFontChoice_V22
+public typealias CurrentStitchFontWeight = StitchFontWeight_V22
+public typealias CurrentStitchJSON = StitchJSON_V22
+public typealias CurrentStitchOrientation = StitchOrientation_V22
+public typealias CurrentStitchProgressIndicatorStyle = ProgressIndicatorStyle_V22
+public typealias CurrentTextTransform = TextTransform_V22
+public typealias CurrentTriangleData = TriangleData_V22
+public typealias CurrentPortValue = PortValue_V22
+public typealias CurrentUserVisibleType = UserVisibleType_V22
+public typealias CurrentVisualMediaFitStyle = VisualMediaFitStyle_V22
+public typealias CurrentNodeConnectionType = NodeConnectionType_V22
+public typealias CurrentLayerInputType = LayerInputType_V22
+public typealias CurrentNodeIOPortType = NodeIOPortType_V22
+public typealias CurrentStrokeLineCap = StrokeLineCap_V22
+public typealias CurrentStrokeLineJoin = StrokeLineJoin_V22
+public typealias CurrentStitchStringValue = StitchStringValue_V22
+public typealias CurrentStitchContentMode = StitchContentMode_V22
+public typealias CurrentStitchSpacing = StitchSpacing_V22
+public typealias CurrentStitchPadding = StitchPadding_V22
+public typealias CurrentSizingScenario = SizingScenario_V22
+public typealias CurrentNodeTypeEntity = NodeTypeEntity_V22
+public typealias CurrentCanvasNodeEntity = CanvasNodeEntity_V22
+public typealias CurrentLayerInputDataEntity = LayerInputDataEntity_V22
+public typealias CurrentCanvasItemId = CanvasItemId_V22
+public typealias CurrentLayerInputCoordinate = LayerInputCoordinate_V22
+public typealias CurrentLayerOutputCoordinate = LayerOutputCoordinate_V22
+public typealias CurrentPinToId = PinToId_V22
 
 // MARK: - end
 
@@ -182,6 +183,7 @@ public typealias LayerInputDataEntity = CurrentLayerInputDataEntity.LayerInputDa
 public typealias CanvasItemId = CurrentCanvasItemId.CanvasItemId
 public typealias LayerInputCoordinate = CurrentLayerInputCoordinate.LayerInputCoordinate
 public typealias LayerOutputCoordinate = CurrentLayerOutputCoordinate.LayerOutputCoordinate
+public typealias PinToId = CurrentPinToId.PinToId
 
 public enum StitchSchemaVersion: Int, VersionType {
     case _V1 = 1
@@ -205,6 +207,7 @@ public enum StitchSchemaVersion: Int, VersionType {
     case _V19 = 19
     case _V20 = 20
     case _V21 = 21
+    case _V22 = 22
 }
 
 public protocol VersionType: CaseIterable, Codable, Comparable, RawRepresentable {}
@@ -270,6 +273,8 @@ extension StitchDocumentVersion {
             return StitchDocument_V20.StitchDocument.self
         case ._V21:
             return StitchDocument_V21.StitchDocument.self
+        case ._V22:
+            return StitchDocument_V22.StitchDocument.self
         }
     }
 }

Sources/StitchSchemaKit/V16/NodePort/NodeIOPortType_V16.swift

@@ -10,7 +10,7 @@ import Foundation
 public enum NodeIOPortType_V16: StitchSchemaVersionable {
     // MARK: - ensure versions are correct
     static var version: StitchSchemaVersion = StitchSchemaVersion._V16
-    public typealias PreviousInstance = Self.NodeIOPortType
+    public typealias PreviousInstance = NodeIOPortType_V15.NodeIOPortType
     public typealias LayerInputType = LayerInputType_V16.LayerInputType
     // MARK: - endif
 

Sources/StitchSchemaKit/V17/NodePort/NodeIOPortType_V17.swift

@@ -10,7 +10,7 @@ import Foundation
 public enum NodeIOPortType_V17: StitchSchemaVersionable {
     // MARK: - ensure versions are correct
     static var version: StitchSchemaVersion = StitchSchemaVersion._V17
-    public typealias PreviousInstance = Self.NodeIOPortType
+    public typealias PreviousInstance = NodeIOPortType_V16.NodeIOPortType
     public typealias LayerInputType = LayerInputType_V17.LayerInputType
     // MARK: - endif
 

Sources/StitchSchemaKit/V18/NodePort/NodeIOPortType_V18.swift

@@ -10,7 +10,7 @@ import Foundation
 public enum NodeIOPortType_V18: StitchSchemaVersionable {
     // MARK: - ensure versions are correct
     static var version: StitchSchemaVersion = StitchSchemaVersion._V18
-    public typealias PreviousInstance = Self.NodeIOPortType
+    public typealias PreviousInstance = NodeIOPortType_V17.NodeIOPortType
     public typealias LayerInputType = LayerInputType_V18.LayerInputType
     // MARK: - endif
 

Sources/StitchSchemaKit/V19/NodePort/NodeIOPortType_V19.swift

@@ -10,7 +10,7 @@ import Foundation
 public enum NodeIOPortType_V19: StitchSchemaVersionable {
     // MARK: - ensure versions are correct
     static var version: StitchSchemaVersion = StitchSchemaVersion._V19
-    public typealias PreviousInstance = Self.NodeIOPortType
+    public typealias PreviousInstance = NodeIOPortType_V18.NodeIOPortType
     public typealias LayerInputType = LayerInputType_V19.LayerInputType
     // MARK: - endif
 

Sources/StitchSchemaKit/V20/Node/Group/GroupNodeID_V20.swift

@@ -10,7 +10,7 @@ import Foundation
 public enum GroupNodeID_V20: StitchSchemaVersionable {
     // MARK: - ensure versions are correct
     static var version: StitchSchemaVersion = StitchSchemaVersion._V20
-    public typealias PreviousInstance = Self.GroupNodeId
+    public typealias PreviousInstance = GroupNodeID_V19.GroupNodeId
     // MARK: - endif
 
     public struct GroupNodeId: Equatable, Hashable, Identifiable {

Sources/StitchSchemaKit/V21/Node/NodeEntity_V21.swift

@@ -35,9 +35,11 @@ extension NodeEntity_V21.NodeEntity: StitchVersionedCodable {
     public init(previousInstance: NodeEntity_V21.PreviousInstance) {
         self.id = previousInstance.id
         self.title = previousInstance.title
+        
         let migratedPatchNodeEntity = PatchNodeEntity_V21.PatchNodeEntity(previousInstance: previousInstance.patchNodeEntity)
         let migratedLayerNodeEntity = LayerNodeEntity_V21.LayerNodeEntity(previousInstance: previousInstance.layerNodeEntity)
 
+        
         let canvasNodeEntity = CanvasNodeEntity_V21
             .CanvasNodeEntity(position: previousInstance.position,
                               zIndex: previousInstance.zIndex,

Sources/StitchSchemaKit/V21/Node/NodeTypeEntity_V21.swift

@@ -12,15 +12,12 @@ public enum NodeTypeEntity_V21: StitchSchemaVersionable {
     // MARK: - ensure versions are correct
     static var version = StitchSchemaVersion._V21
     public typealias PreviousInstance = Self.NodeTypeEntity
-    public typealias PatchNodeEnity = PatchNodeEntity_V21.PatchNodeEntity
-    public typealias LayerNodeEntity = LayerNodeEntity_V21.LayerNodeEntity
-    public typealias CanvasNodeEntity = CanvasNodeEntity_V21.CanvasNodeEntity
     // MARK: - end
 
     public enum NodeTypeEntity: Equatable {
-        case patch(PatchNodeEntity)
-        case layer(LayerNodeEntity)
-        case group(CanvasNodeEntity)
+        case patch(PatchNodeEntity_V21.PatchNodeEntity)
+        case layer(LayerNodeEntity_V21.LayerNodeEntity)
+        case group(CanvasNodeEntity_V21.CanvasNodeEntity)
     }
 }
 

Sources/StitchSchemaKit/V21/Node/Patch/PatchNodeEntity_V21.swift

@@ -22,15 +22,15 @@ public enum PatchNodeEntity_V21: StitchSchemaVersionable {
         public let id: UUID
         public let patch: Patch
         public var inputs: NodePortInputEntitySchemas
-        public var canvasEntity: CanvasNodeEntity
+        public var canvasEntity: CanvasNodeEntity_V21.CanvasNodeEntity
         public let userVisibleType: UserVisibleType?
         public let splitterNode: SplitterNodeEntitySchema?
         public let mathExpression: String? // only for Math Expression
 
         public init(id: UUID,
                     patch: Patch,
                     inputs: NodePortInputEntitySchemas,
-                    canvasEntity: CanvasNodeEntity,
+                    canvasEntity: CanvasNodeEntity_V21.CanvasNodeEntity,
                     userVisibleType: UserVisibleType?,
                     splitterNode: SplitterNodeEntitySchema?,
                     mathExpression: String?) {

Sources/StitchSchemaKit/V22/CommentBoxData_V22.swift

@@ -0,0 +1,72 @@
+//
+//  CommentBoxData_V22.swift
+//
+//
+//  Created by Nicholas Arner on 1/27/24.
+//
+
+import Foundation
+import SwiftUI
+
+public enum CommentBoxData_V22: StitchSchemaVersionable {
+    // MARK: - ensure versions are correct
+    static var version: StitchSchemaVersion = StitchSchemaVersion._V22
+    public typealias PreviousInstance = CommentBoxData_V21.CommentBoxData
+    public typealias CanvasItemId = CanvasItemId_V22.CanvasItemId
+    // MARK: - endif
+ 
+    public struct CommentBoxData: Equatable, 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_V22.CommentBoxData: StitchVersionedCodable {
+    public init(previousInstance: CommentBoxData_V22.PreviousInstance) {
+        self.init(id: previousInstance.id,
+                  groupId: previousInstance.groupId,
+                  title: previousInstance.title,
+                  color: previousInstance.color,
+
+                  // MARK: just needed for V22, should point to property in future versions
+                  nodes: .init(),
+
+                  position: previousInstance.position,
+                  size: previousInstance.size,
+                  zIndex: previousInstance.zIndex)
+    }
+}