Add stage API

cherylEnkidu · cherylEnkidu · commit 84691ab97607 · 2025-02-27T15:47:19.000-05:00
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/AccumulatorExpr.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/AccumulatorExpr.swift
@@ -0,0 +1,15 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public protocol AccumulatorExpr: Sendable {}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/AccumulatorWithAlias.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/AccumulatorWithAlias.swift
@@ -0,0 +1,17 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public struct AccumulatorWithAlias {
+  init(_ expr: some AccumulatorExpr, _ alias: String) {}
+}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/Add.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/Add.swift
@@ -0,0 +1,15 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public struct Add {}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/AggregateOption.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/AggregateOption.swift
@@ -0,0 +1,23 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public struct AggregateOption {
+  public let accumulators: [AccumulatorWithAlias]
+  public let groups: [SelectableOrFieldName]?
+
+  public init(accumulators: [AccumulatorWithAlias], groups: [SelectableOrFieldName]? = nil) {
+    self.accumulators = accumulators
+    self.groups = groups
+  }
+}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/BooleanExpr.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/BooleanExpr.swift
@@ -0,0 +1,15 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public struct BooleanExpr: FunctionExpr, Sendable {}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/Constant.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/Constant.swift
@@ -0,0 +1,15 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public struct Constant: Expr, Sendable {}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/Count.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/Count.swift
@@ -0,0 +1,13 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/Eq.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/Eq.swift
@@ -0,0 +1,15 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public struct Eq {}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/Expr.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/Expr.swift
@@ -0,0 +1,35 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public protocol Expr: Sendable, Equatable {
+  func alias(_ alias: String) -> ExprWithAlias
+
+  func eq(_ expr: BooleanExpr)
+
+  func add(_ expr: some FunctionExpr)
+
+  func add(_ expr: Constant)
+}
+
+public extension Expr {
+  func alias(_ alias: String) -> ExprWithAlias {
+    return ExprWithAlias(self, alias)
+  }
+
+  func eq(_ expr: some Expr) {}
+
+  func add(_ expr: some Expr) {}
+
+  func add(_ expr: Constant) {}
+}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/ExprWithAlias.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/ExprWithAlias.swift
@@ -0,0 +1,17 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public struct ExprWithAlias {
+  init(_ expr: some Expr, _ alias: String) {}
+}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/Field.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/Field.swift
@@ -0,0 +1,18 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public struct Field: Expr, Sendable {
+  public var alias: String
+  public let fieldName: String
+}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/FindNearestOptions.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/FindNearestOptions.swift
@@ -0,0 +1,63 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#if SWIFT_PACKAGE
+  @_exported import FirebaseFirestoreInternalWrapper
+#else
+  @_exported import FirebaseFirestoreInternal
+#endif // SWIFT_PACKAGE
+
+import Foundation
+
+public struct FindNearestOptions {
+  let field: Field
+  let vectorValue: [VectorValue]
+  let distanceMeasure: DistanceMeasure
+  let limit: Int?
+  let distanceField: String?
+}
+
+public struct DistanceMeasure: Sendable, Equatable, Hashable {
+  enum Kind: String {
+    case euclidean
+    case cosine
+    case dotProduct = "dot_product"
+  }
+
+  public static var euclidean: DistanceMeasure {
+    return self.init(kind: .euclidean)
+  }
+
+  public static var cosine: DistanceMeasure {
+    return self.init(kind: .cosine)
+  }
+
+  public static var dotProduct: DistanceMeasure {
+    return self.init(kind: .dotProduct)
+  }
+
+  /// Returns the raw string representation of the `DistanceMeasure` value.
+  public let rawValue: String
+
+  init(kind: Kind) {
+    rawValue = kind.rawValue
+  }
+
+  public init(rawValue: String) {
+    if Kind(rawValue: rawValue) == nil {
+      // impl
+    }
+    self.rawValue = rawValue
+  }
+}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/FunctionExpr.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/FunctionExpr.swift
@@ -0,0 +1,15 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public protocol FunctionExpr: Expr, Sendable {}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/LogicalMin.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/LogicalMin.swift
@@ -0,0 +1,15 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+public struct LogicalMin: FunctionExpr, Sendable, Equatable {}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/Min.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/Min.swift
@@ -0,0 +1,13 @@
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/Ordering.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/Ordering.swift
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+public struct Ordering {
+  let direction: Direction
+}
+
+public struct Direction: Sendable, Equatable, Hashable {
+  enum Kind: String {
+    case ascending
+    case descending
+  }
+
+  public static var ascending: Direction {
+    return self.init(kind: .ascending)
+  }
+
+  public static var descending: Direction {
+    return self.init(kind: .descending)
+  }
+
+  public let rawValue: String
+
+  init(kind: Kind) {
+    rawValue = kind.rawValue
+  }
+
+  public init(rawValue: String) {
+    if Kind(rawValue: rawValue) == nil {
+      // impl
+    }
+    self.rawValue = rawValue
+  }
+}
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/Pipeline.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/Pipeline.swift
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/PipelineResult.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/PipelineResult.swift
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/PipelineType.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/PipelineType.swift
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/RealtimePipeline.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/RealtimePipeline.swift
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/SampleOptions.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/SampleOptions.swift
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/SelectableOrFieldName.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/SelectableOrFieldName.swift
diff --git a/Firestore/Swift/Source/SwiftAPI/Pipeline/Sum.swift b/Firestore/Swift/Source/SwiftAPI/Pipeline/Sum.swift
