format code

Author: cherylEnkidu

Firestore/Swift/Source/ExpressionImplementation.swift

@@ -129,7 +129,10 @@ extension Expression {
   /// - Parameter otherBits: The integer literal operand.
   /// - Returns: A new "FunctionExpression" representing the bitwise XOR operation.
   func bitXor(_ otherBits: Int) -> FunctionExpression {
-    return FunctionExpression(functionName: "bit_xor", args: [self, Helper.sendableToExpr(otherBits)])
+    return FunctionExpression(
+      functionName: "bit_xor",
+      args: [self, Helper.sendableToExpr(otherBits)]
+    )
   }
 
   /// Creates an expression applying bitwise XOR between this expression and a UInt8 literal.
@@ -226,7 +229,10 @@ extension Expression {
   /// - Parameter y: The number of bits (Int literal) to shift by.
   /// - Returns: A new "FunctionExpression" representing the bitwise right shift operation.
   func bitRightShift(_ y: Int) -> FunctionExpression {
-    return FunctionExpression(functionName: "bit_right_shift", args: [self, Helper.sendableToExpr(y)])
+    return FunctionExpression(
+      functionName: "bit_right_shift",
+      args: [self, Helper.sendableToExpr(y)]
+    )
   }
 
   /// Creates an expression applying bitwise right shift to this expression by a number of bits
@@ -272,7 +278,10 @@ extension Expression {
   /// - Parameter vector: The other vector as a `VectorValue` to compare against.
   /// - Returns: A new `FunctionExpression` representing the Manhattan distance.
   func manhattanDistance(_ vector: VectorValue) -> FunctionExpression {
-    return FunctionExpression(functionName: "manhattan_distance", args: [self, Helper.sendableToExpr(vector)])
+    return FunctionExpression(
+      functionName: "manhattan_distance",
+      args: [self, Helper.sendableToExpr(vector)]
+    )
   }
 
   /// Calculates the Manhattan (L1) distance between this vector expression and another vector
@@ -287,7 +296,10 @@ extension Expression {
   /// - Parameter vector: The other vector as `[Double]` to compare against.
   /// - Returns: A new `FunctionExpression` representing the Manhattan distance.
   func manhattanDistance(_ vector: [Double]) -> FunctionExpression {
-    return FunctionExpression(functionName: "manhattan_distance", args: [self, Helper.sendableToExpr(vector)])
+    return FunctionExpression(
+      functionName: "manhattan_distance",
+      args: [self, Helper.sendableToExpr(vector)]
+    )
   }
 
   /// Creates an expression that replaces the first occurrence of a literal substring within this
@@ -477,7 +489,10 @@ public extension Expression {
   }
 
   func arrayContains(_ element: Sendable) -> BooleanExpression {
-    return BooleanExpression(functionName: "array_contains", args: [self, Helper.sendableToExpr(element)])
+    return BooleanExpression(
+      functionName: "array_contains",
+      args: [self, Helper.sendableToExpr(element)]
+    )
   }
 
   func arrayContainsAll(_ values: [Expression]) -> BooleanExpression {
@@ -509,7 +524,10 @@ public extension Expression {
   }
 
   func arrayGet(_ offset: Int) -> FunctionExpression {
-    return FunctionExpression(functionName: "array_get", args: [self, Helper.sendableToExpr(offset)])
+    return FunctionExpression(
+      functionName: "array_get",
+      args: [self, Helper.sendableToExpr(offset)]
+    )
   }
 
   func arrayGet(_ offsetExpression: Expression) -> FunctionExpression {
@@ -648,31 +666,43 @@ public extension Expression {
   }
 
   func regexContains(_ pattern: String) -> BooleanExpression {
-    return BooleanExpression(functionName: "regex_contains", args: [self, Helper.sendableToExpr(pattern)])
+    return BooleanExpression(
+      functionName: "regex_contains",
+      args: [self, Helper.sendableToExpr(pattern)]
+    )
   }
 
   func regexContains(_ pattern: Expression) -> BooleanExpression {
     return BooleanExpression(functionName: "regex_contains", args: [self, pattern])
   }
 
   func regexMatch(_ pattern: String) -> BooleanExpression {
-    return BooleanExpression(functionName: "regex_match", args: [self, Helper.sendableToExpr(pattern)])
+    return BooleanExpression(
+      functionName: "regex_match",
+      args: [self, Helper.sendableToExpr(pattern)]
+    )
   }
 
   func regexMatch(_ pattern: Expression) -> BooleanExpression {
     return BooleanExpression(functionName: "regex_match", args: [self, pattern])
   }
 
   func stringContains(_ substring: String) -> BooleanExpression {
-    return BooleanExpression(functionName: "string_contains", args: [self, Helper.sendableToExpr(substring)])
+    return BooleanExpression(
+      functionName: "string_contains",
+      args: [self, Helper.sendableToExpr(substring)]
+    )
   }
 
   func stringContains(_ expression: Expression) -> BooleanExpression {
     return BooleanExpression(functionName: "string_contains", args: [self, expression])
   }
 
   func startsWith(_ prefix: String) -> BooleanExpression {
-    return BooleanExpression(functionName: "starts_with", args: [self, Helper.sendableToExpr(prefix)])
+    return BooleanExpression(
+      functionName: "starts_with",
+      args: [self, Helper.sendableToExpr(prefix)]
+    )
   }
 
   func startsWith(_ prefix: Expression) -> BooleanExpression {
@@ -723,7 +753,10 @@ public extension Expression {
   func substring(position: Int, length: Int? = nil) -> FunctionExpression {
     let positionExpr = Helper.sendableToExpr(position)
     if let length = length {
-      return FunctionExpression(functionName: "substring", args: [self, positionExpr, Helper.sendableToExpr(length)])
+      return FunctionExpression(
+        functionName: "substring",
+        args: [self, positionExpr, Helper.sendableToExpr(length)]
+      )
     } else {
       return FunctionExpression(functionName: "substring", args: [self, positionExpr])
     }
@@ -817,35 +850,53 @@ public extension Expression {
   }
 
   func cosineDistance(_ vector: VectorValue) -> FunctionExpression {
-    return FunctionExpression(functionName: "cosine_distance", args: [self, Helper.sendableToExpr(vector)])
+    return FunctionExpression(
+      functionName: "cosine_distance",
+      args: [self, Helper.sendableToExpr(vector)]
+    )
   }
 
   func cosineDistance(_ vector: [Double]) -> FunctionExpression {
-    return FunctionExpression(functionName: "cosine_distance", args: [self, Helper.sendableToExpr(vector)])
+    return FunctionExpression(
+      functionName: "cosine_distance",
+      args: [self, Helper.sendableToExpr(vector)]
+    )
   }
 
   func dotProduct(_ expression: Expression) -> FunctionExpression {
     return FunctionExpression(functionName: "dot_product", args: [self, expression])
   }
 
   func dotProduct(_ vector: VectorValue) -> FunctionExpression {
-    return FunctionExpression(functionName: "dot_product", args: [self, Helper.sendableToExpr(vector)])
+    return FunctionExpression(
+      functionName: "dot_product",
+      args: [self, Helper.sendableToExpr(vector)]
+    )
   }
 
   func dotProduct(_ vector: [Double]) -> FunctionExpression {
-    return FunctionExpression(functionName: "dot_product", args: [self, Helper.sendableToExpr(vector)])
+    return FunctionExpression(
+      functionName: "dot_product",
+      args: [self, Helper.sendableToExpr(vector)]
+    )
   }
 
   func euclideanDistance(_ expression: Expression) -> FunctionExpression {
     return FunctionExpression(functionName: "euclidean_distance", args: [self, expression])
   }
 
   func euclideanDistance(_ vector: VectorValue) -> FunctionExpression {
-    return FunctionExpression(functionName: "euclidean_distance", args: [self, Helper.sendableToExpr(vector)])
+    return FunctionExpression(
+      functionName: "euclidean_distance",
+      args: [self, Helper.sendableToExpr(vector)]
+    )
   }
 
   func euclideanDistance(_ vector: [Double]) -> FunctionExpression {
-    return FunctionExpression(functionName: "euclidean_distance", args: [self, Helper.sendableToExpr(vector)])
+    return FunctionExpression(
+      functionName: "euclidean_distance",
+      args: [self, Helper.sendableToExpr(vector)]
+    )
   }
 
   // MARK: Timestamp operations
@@ -909,11 +960,17 @@ public extension Expression {
   }
 
   func ifError(_ catchValue: Sendable) -> FunctionExpression {
-    return FunctionExpression(functionName: "if_error", args: [self, Helper.sendableToExpr(catchValue)])
+    return FunctionExpression(
+      functionName: "if_error",
+      args: [self, Helper.sendableToExpr(catchValue)]
+    )
   }
 
   func ifAbsent(_ defaultValue: Sendable) -> FunctionExpression {
-    return FunctionExpression(functionName: "if_absent", args: [self, Helper.sendableToExpr(defaultValue)])
+    return FunctionExpression(
+      functionName: "if_absent",
+      args: [self, Helper.sendableToExpr(defaultValue)]
+    )
   }
 
   // MARK: Sorting

Firestore/Swift/Source/SwiftAPI/Firestore+Pipeline.swift

@@ -22,9 +22,11 @@
 import Foundation
 
 @objc public extension Firestore {
-  /// Creates a `PipelineSource` that can be used to build and execute a pipeline of operations on the Firestore database.
+  /// Creates a `PipelineSource` that can be used to build and execute a pipeline of operations on
+  /// the Firestore database.
   ///
-  /// A pipeline is a sequence of stages that are executed in order. Each stage can perform an operation on the data, such as filtering, sorting, or transforming it.
+  /// A pipeline is a sequence of stages that are executed in order. Each stage can perform an
+  /// operation on the data, such as filtering, sorting, or transforming it.
   ///
   /// Example usage:
   /// ```swift

Firestore/Swift/Source/SwiftAPI/Pipeline/Aggregates/AliasedAggregate.swift

@@ -15,6 +15,6 @@
 /// An `AggregateFunction` that has been given an alias.
 public struct AliasedAggregate {
   let aggregate: AggregateFunction
-  
+
   let alias: String
 }

Firestore/Swift/Source/SwiftAPI/Pipeline/Expressions/Expression.swift

@@ -455,7 +455,8 @@ public protocol Expression: Sendable {
   /// Field("tags").arrayGet(Field("favoriteTagIndex"))
   /// ```
   ///
-  /// - Parameter offsetExpression: An `Expression` (evaluating to an Int) representing the offset of the
+  /// - Parameter offsetExpression: An `Expression` (evaluating to an Int) representing the offset
+  /// of the
   /// element to return.
   /// - Returns: A new `FunctionExpression` representing the "arrayGet" operation.
   func arrayGet(_ offsetExpression: Expression) -> FunctionExpression
@@ -1014,8 +1015,8 @@ public protocol Expression: Sendable {
   ///
   /// - Parameter position: An `Expression` (evaluating to an Int) for the index of the first
   /// character.
-  /// - Parameter length: Optional `Expression` (evaluating to an Int) for the length of the substring. If
-  /// `nil`, goes to the end.
+  /// - Parameter length: Optional `Expression` (evaluating to an Int) for the length of the
+  /// substring. If `nil`, goes to the end.
   /// - Returns: A new `FunctionExpression` representing the substring.
   func substring(position: Expression, length: Expression?) -> FunctionExpression
 
@@ -1055,8 +1056,8 @@ public protocol Expression: Sendable {
   /// Field("settings").mapRemove(Field("keyToRemove"))
   /// ```
   ///
-  /// - Parameter keyExpression: An `Expression` (evaluating to a string) representing the key to remove from
-  /// the map.
+  /// - Parameter keyExpression: An `Expression` (evaluating to a string) representing the key to
+  /// remove from the map.
   /// - Returns: A new `FunctionExpression` representing the "map_remove" operation.
   func mapRemove(_ keyExpression: Expression) -> FunctionExpression
 
@@ -1477,15 +1478,16 @@ public protocol Expression: Sendable {
   /// root itself.
   func collectionId() -> FunctionExpression
 
-  /// Creates an expression that returns the result of `catchExpression` if this expression produces an
-  /// error during evaluation, otherwise returns the result of this expression.
+  /// Creates an expression that returns the result of `catchExpression` if this expression produces
+  /// an error during evaluation, otherwise returns the result of this expression.
   ///
   /// ```swift
   /// // Try dividing "a" by "b", return field "fallbackValue" on error (e.g., division by zero)
   /// Field("a").divide(Field("b")).ifError(Field("fallbackValue"))
   /// ```
   ///
-  /// - Parameter catchExpression: The `Expression` to evaluate and return if this expression errors.
+  /// - Parameter catchExpression: The `Expression` to evaluate and return if this expression
+  /// errors.
   /// - Returns: A new "FunctionExpression" representing the "ifError" operation.
   func ifError(_ catchExpression: Expression) -> FunctionExpression
 

Firestore/Swift/Source/SwiftAPI/Pipeline/Expressions/FunctionExpressions/BooleanExpression.swift

@@ -52,7 +52,7 @@ public class BooleanExpression: FunctionExpression, @unchecked Sendable {
   /// ```
   ///
   /// - Returns: An `AggregateFunction` that performs the conditional count.
-  func countIf() -> AggregateFunction {
+  public func countIf() -> AggregateFunction {
     return AggregateFunction(functionName: "count_if", args: [self])
   }
 
@@ -106,7 +106,7 @@ public class BooleanExpression: FunctionExpression, @unchecked Sendable {
   public static func && (lhs: BooleanExpression,
                          rhs: @autoclosure () throws -> BooleanExpression) rethrows
     -> BooleanExpression {
-      try BooleanExpression(functionName: "and", args: [lhs, rhs()])
+    try BooleanExpression(functionName: "and", args: [lhs, rhs()])
   }
 
   /// Combines two boolean expressions with a logical OR (`||`).
@@ -130,7 +130,7 @@ public class BooleanExpression: FunctionExpression, @unchecked Sendable {
   public static func || (lhs: BooleanExpression,
                          rhs: @autoclosure () throws -> BooleanExpression) rethrows
     -> BooleanExpression {
-      try BooleanExpression(functionName: "or", args: [lhs, rhs()])
+    try BooleanExpression(functionName: "or", args: [lhs, rhs()])
   }
 
   /// Combines two boolean expressions with a logical XOR (`^`).
@@ -154,7 +154,7 @@ public class BooleanExpression: FunctionExpression, @unchecked Sendable {
   public static func ^ (lhs: BooleanExpression,
                         rhs: @autoclosure () throws -> BooleanExpression) rethrows
     -> BooleanExpression {
-      try BooleanExpression(functionName: "xor", args: [lhs, rhs()])
+    try BooleanExpression(functionName: "xor", args: [lhs, rhs()])
   }
 
   /// Negates a boolean expression with a logical NOT (`!`).

Firestore/Swift/Source/SwiftAPI/Pipeline/Expressions/FunctionExpressions/FunctionExpression.swift

@@ -14,9 +14,11 @@
 
 /// Represents a function call in a pipeline.
 ///
-/// A `FunctionExpression` is an expression that represents a function call with a given name and arguments.
+/// A `FunctionExpression` is an expression that represents a function call with a given name and
+/// arguments.
 ///
-/// `FunctionExpression`s are typically used to perform operations on data in a pipeline, such as mathematical calculations, string manipulations, or array operations.
+/// `FunctionExpression`s are typically used to perform operations on data in a pipeline, such as
+/// mathematical calculations, string manipulations, or array operations.
 public class FunctionExpression: Expression, BridgeWrapper, @unchecked Sendable {
   let bridge: ExprBridge
 

Firestore/Swift/Source/SwiftAPI/Pipeline/Expressions/FunctionExpressions/RandomExpression.swift

@@ -26,7 +26,7 @@
 ///   .collection("users")
 ///   .where(RandomExpression().lessThan(0.1))
 /// ```
-internal class RandomExpression: FunctionExpression, @unchecked Sendable {
+class RandomExpression: FunctionExpression, @unchecked Sendable {
   /// Creates a new `RandomExpression` that generates a random number.
   init() {
     super.init(functionName: "rand", args: [])

Firestore/Swift/Source/SwiftAPI/Pipeline/Ordering.swift

@@ -20,7 +20,7 @@ public struct Ordering: @unchecked Sendable {
   public let expression: Expression
   /// The direction to order in.
   public let direction: Direction
-  
+
   let bridge: OrderingBridge
 
   init(expression: Expression, direction: Direction) {

Firestore/Swift/Source/SwiftAPI/Pipeline/Pipeline.swift

@@ -24,8 +24,8 @@ import Foundation
 ///
 /// A pipeline takes data sources, such as Firestore collections or collection groups, and applies
 /// a series of stages that are chained together. Each stage takes the output from the previous
-/// stage (or the data source) and produces an output for the next stage (or as the final output of the
-/// pipeline).
+/// stage (or the data source) and produces an output for the next stage (or as the final output of
+/// the pipeline).
 ///
 /// Expressions can be used within each stage to filter and transform data through the stage.
 ///

Firestore/Swift/Source/SwiftAPI/Pipeline/PipelineSource.swift

@@ -12,7 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-/// A `PipelineSource` is the entry point for building a Firestore pipeline. It allows you to specify the source of the data for the pipeline, which can be a collection, a collection group, a list of documents, or the entire database.
+/// A `PipelineSource` is the entry point for building a Firestore pipeline. It allows you to
+/// specify the source of the data for the pipeline, which can be a collection, a collection group,
+/// a list of documents, or the entire database.
 @available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
 public struct PipelineSource: @unchecked Sendable {
   let db: Firestore
@@ -76,7 +78,8 @@ public struct PipelineSource: @unchecked Sendable {
 
   /// Creates a `Pipeline` from an existing `Query`.
   ///
-  /// This allows you to convert a standard Firestore query into a pipeline, which can then be further modified with additional pipeline stages.
+  /// This allows you to convert a standard Firestore query into a pipeline, which can then be
+  /// further modified with additional pipeline stages.
   ///
   /// - Parameter query: The `Query` to convert into a pipeline.
   /// - Returns: A `Pipeline` that is equivalent to the given query.