refactor: Formats package

Author: NeedleInAJayStack

Package.swift

@@ -1,15 +1,14 @@
 public protocol API {
-    
     /// Closes the current authentication session.
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#close
-    func close() async throws -> Void
-    
+    func close() async throws
+
     /// Queries basic information about the server
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#about
     func about() async throws -> Grid
-    
+
     /// Queries def dicts from the current namespace
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#defs
@@ -19,7 +18,7 @@ public protocol API {
     ///   - limit: The maximum number of defs to return in response
     /// - Returns: A grid with the dict representation of each def
     func defs(filter: String?, limit: Number?) async throws -> Grid
-    
+
     /// Queries lib defs from current namspace
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#libs
@@ -29,7 +28,7 @@ public protocol API {
     ///   - limit: The maximum number of defs to return in response
     /// - Returns: A grid with the dict representation of each def
     func libs(filter: String?, limit: Number?) async throws -> Grid
-    
+
     /// Queries op defs from current namspace
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#ops
@@ -39,7 +38,7 @@ public protocol API {
     ///   - limit: The maximum number of defs to return in response
     /// - Returns: A grid with the dict representation of each def
     func ops(filter: String?, limit: Number?) async throws -> Grid
-    
+
     /// Queries filetype defs from current namspace
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#filetypes
@@ -49,15 +48,15 @@ public protocol API {
     ///   - limit: The maximum number of defs to return in response
     /// - Returns: A grid with the dict representation of each def
     func filetypes(filter: String?, limit: Number?) async throws -> Grid
-    
+
     /// Read a set of entity records by their unique identifier
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#read
     ///
     /// - Parameter ids: Ref identifiers
     /// - Returns: A grid with a row for each entity read
     func read(ids: [Ref]) async throws -> Grid
-    
+
     /// Read a set of entity records using a filter
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#read
@@ -67,15 +66,15 @@ public protocol API {
     ///   - limit: The maximum number of entities to return in response
     /// - Returns: A grid with a row for each entity read
     func read(filter: String, limit: Number?) async throws -> Grid
-    
+
     /// Navigate a project for learning and discovery
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#nav
     ///
     /// - Parameter navId: The ID of the entity to navigate from. If null, the navigation root is used.
     /// - Returns: A grid of navigation children for the navId specified by the request
     func nav(navId: Ref?) async throws -> Grid
-    
+
     /// Reads time-series data from historized point
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#hisRead
@@ -85,7 +84,7 @@ public protocol API {
     ///   - range: A date-time range
     /// - Returns: A grid whose rows represent timetamp/value pairs with a DateTime ts column and a val column for each scalar value
     func hisRead(id: Ref, range: HisReadRange) async throws -> Grid
-    
+
     /// Posts new time-series data to a historized point
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#hisWrite
@@ -95,7 +94,7 @@ public protocol API {
     ///   - items: New timestamp/value samples to write
     /// - Returns: An empty grid
     func hisWrite(id: Ref, items: [HisItem]) async throws -> Grid
-    
+
     /// Write to a given level of a writable point's priority array
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#pointWrite
@@ -108,15 +107,15 @@ public protocol API {
     ///   - duration: Number with duration unit if setting level 8
     /// - Returns: An empty grid
     func pointWrite(id: Ref, level: Number, val: any Val, who: String?, duration: Number?) async throws -> Grid
-    
+
     /// Read the current status of a writable point's priority array
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#pointWrite
     ///
     /// - Parameter id: Identifier of writable point
     /// - Returns: A grid with current priority array state
     func pointWriteStatus(id: Ref) async throws -> Grid
-    
+
     /// Used to create new watches.
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#watchSub
@@ -128,7 +127,7 @@ public protocol API {
     /// - Returns: A grid where rows correspond to the current entity state of the requested identifiers.  Grid metadata contains
     /// `watchId` and `lease`.
     func watchSubCreate(watchDis: String, lease: Number?, ids: [Ref]) async throws -> Grid
-    
+
     /// Used to add entities to an existing watch.
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#watchSub
@@ -140,7 +139,7 @@ public protocol API {
     /// - Returns: A grid where rows correspond to the current entity state of the requested identifiers.  Grid metadata contains
     /// `watchId` and `lease`.
     func watchSubAdd(watchId: String, lease: Number?, ids: [Ref]) async throws -> Grid
-    
+
     /// Used remove entities from a watch
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#watchUnsub
@@ -150,7 +149,7 @@ public protocol API {
     ///   - ids: Ref values for each entity to unsubscribe. If empty the entire watch is closed.
     /// - Returns: An empty grid
     func watchUnsubRemove(watchId: String, ids: [Ref]) async throws -> Grid
-    
+
     /// Used to close a watch entirely
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#watchUnsub
@@ -159,7 +158,7 @@ public protocol API {
     ///   - watchId: Watch identifier
     /// - Returns: An empty grid
     func watchUnsubDelete(watchId: String) async throws -> Grid
-    
+
     /// Used to poll a watch for changes to the subscribed entity records
     ///
     /// https://project-haystack.org/doc/docHaystack/Ops#watchPoll
@@ -169,15 +168,15 @@ public protocol API {
     ///   - refresh: Whether a full refresh should occur
     /// - Returns: A grid where each row correspondes to a watched entity
     func watchPoll(watchId: String, refresh: Bool) async throws -> Grid
-    
+
     /// https://project-haystack.org/doc/docHaystack/Ops#invokeAction
     /// - Parameters:
     ///   - id: Identifier of target rec
     ///   - action: The name of the action func
     ///   - args: The arguments to the action
     /// - Returns: A grid of undefined shape
     func invokeAction(id: Ref, action: String, args: [String: any Val]) async throws -> Grid
-    
+
     /// Evaluate an Axon expression
     ///
     /// https://haxall.io/doc/lib-hx/op~eval

Sources/Haystack/API/API.swift

@@ -2,12 +2,12 @@
 public struct HisItem {
     public let ts: DateTime
     public let val: any Val
-    
+
     public init(ts: DateTime, val: any Val) {
         self.ts = ts
         self.val = val
     }
-    
+
     public func toDict() -> Dict {
         return ["ts": ts, "val": val]
     }

Sources/Haystack/API/HisItem.swift

@@ -38,7 +38,7 @@ public enum HisReadRange {
             return to.endOfDay(timezone: nil)
         case let .dateTimeRange(_, to):
             return to.date
-        case .after(_):
+        case .after:
             return nil
         }
     }

Sources/Haystack/API/HisReadRange.swift

@@ -5,7 +5,7 @@ import Foundation
 /// [Docs](https://project-haystack.org/doc/docHaystack/Kinds#bool)
 extension Bool: Val {
     public static var valType: ValType { .Bool }
-    
+
     /// Converts to Zinc formatted string.
     /// See [Zinc Literals](https://project-haystack.org/doc/docHaystack/Zinc#literals)
     public func toZinc() -> String {

Sources/Haystack/Bool.swift

@@ -7,18 +7,18 @@ import Foundation
 /// [Docs](https://project-haystack.org/doc/docHaystack/Kinds#coord)
 public struct Coord: Val {
     public static var valType: ValType { .Coord }
-    
+
     public let latitude: Double
     public let longitude: Double
-    
+
     public init(latitude: Double, longitude: Double) throws {
-        guard -90 <= latitude, latitude <= 90, -180 <= longitude, longitude <= 180 else {
+        guard latitude >= -90, latitude <= 90, longitude >= -180, longitude <= 180 else {
             throw CoordError.invalidCoordinates(lat: latitude, lng: longitude)
         }
         self.latitude = latitude
         self.longitude = longitude
     }
-    
+
     /// Converts to Zinc formatted string.
     /// See [Zinc Literals](https://project-haystack.org/doc/docHaystack/Zinc#literals)
     public func toZinc() -> String {
@@ -29,13 +29,13 @@ public struct Coord: Val {
 // Coord + Codable
 extension Coord: Codable {
     static let kindValue = "coord"
-    
+
     enum CodingKeys: CodingKey {
         case _kind
         case lat
         case lng
     }
-    
+
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#coord)
     public init(from decoder: Decoder) throws {
@@ -49,7 +49,7 @@ extension Coord: Codable {
                     )
                 )
             }
-            
+
             try self.init(
                 latitude: container.decode(Double.self, forKey: .lat),
                 longitude: container.decode(Double.self, forKey: .lng)
@@ -64,7 +64,7 @@ extension Coord: Codable {
             )
         }
     }
-    
+
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#coord)
     public func encode(to encoder: Encoder) throws {

Sources/Haystack/Coord.swift

@@ -5,11 +5,11 @@ import Foundation
 /// [Docs](https://project-haystack.org/doc/docHaystack/Kinds#date)
 public struct Date: Val {
     public static var valType: ValType { .Date }
-    
+
     public let year: Int
     public let month: Int
     public let day: Int
-    
+
     public init(
         year: Int,
         month: Int,
@@ -23,12 +23,12 @@ public struct Date: Val {
         guard components.isValidDate(in: calendar) else {
             throw ValError.invalidDateDefinition
         }
-        
+
         self.year = year
         self.month = month
         self.day = day
     }
-    
+
     public init(_ isoString: String) throws {
         let dashSplit = isoString.split(separator: "-")
         guard
@@ -39,14 +39,14 @@ public struct Date: Val {
         else {
             throw ValError.invalidDateFormat(isoString)
         }
-        
+
         try self.init(
             year: year,
             month: month,
             day: day
         )
     }
-    
+
     public func startOfDay(timezone: TimeZone?) -> Foundation.Date {
         return DateComponents(
             calendar: .current,
@@ -56,17 +56,17 @@ public struct Date: Val {
             day: day
         ).date!
     }
-    
+
     public func endOfDay(timezone: TimeZone?) -> Foundation.Date {
         return Calendar.current.date(byAdding: .day, value: 1, to: startOfDay(timezone: timezone))!
     }
-    
+
     /// Converts to Zinc formatted string.
     /// See [Zinc Literals](https://project-haystack.org/doc/docHaystack/Zinc#literals)
     public func toZinc() -> String {
         return isoString
     }
-    
+
     var isoString: String {
         let yearStr = String(format: "%04d", arguments: [year])
         let monthStr = String(format: "%02d", arguments: [month])
@@ -78,12 +78,12 @@ public struct Date: Val {
 // Date + Codable
 extension Date {
     static let kindValue = "date"
-    
+
     enum CodingKeys: CodingKey {
         case _kind
         case val
     }
-    
+
     /// Read from decodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#date)
     public init(from decoder: Decoder) throws {
@@ -97,7 +97,7 @@ extension Date {
                     )
                 )
             }
-            
+
             let isoString = try container.decode(String.self, forKey: .val)
             do {
                 try self.init(isoString)
@@ -120,7 +120,7 @@ extension Date {
             )
         }
     }
-    
+
     /// Write to encodable data
     /// See [JSON format](https://project-haystack.org/doc/docHaystack/Json#date)
     public func encode(to encoder: Encoder) throws {