Merge pull request #30 from willtempleton/update/v0-25

Updates for Typesense v0.25

Author: jasonbosco

Sources/Typesense/Analytics.swift

@@ -0,0 +1,24 @@
+import Foundation
+
+public struct Analytics {
+    static let resourcePath: String = "/analytics"
+    
+    private var analyticsRules: AnalyticsRules
+    var apiCall: ApiCall
+
+    init(config: Configuration) {
+        self.apiCall = ApiCall(config: config)
+        self.analyticsRules = AnalyticsRules(apiCall: apiCall)
+    }
+    
+    func rule(id: String) -> AnalyticsRule {
+        return AnalyticsRule(name: id, apiCall: self.apiCall)
+    }
+    
+    func rules() -> AnalyticsRules {
+        return AnalyticsRules(apiCall: self.apiCall)
+    }
+}
+
+
+

Sources/Typesense/AnalyticsRule.swift

@@ -0,0 +1,38 @@
+import Foundation
+
+public struct AnalyticsRule {
+    var name: String
+    private var apiCall: ApiCall
+    init(name: String, apiCall: ApiCall) {
+        self.name = name
+        self.apiCall = apiCall
+    }
+    
+    public func retrieve() async throws -> (AnalyticsRuleSchema?, URLResponse?) {
+        let (data, response) = try await self.apiCall.get(endPoint: endpointPath())
+        if let result = data {
+            if let notFound = try? decoder.decode(ApiResponse.self, from: result) {
+                throw ResponseError.analyticsRuleDoesNotExist(desc: notFound.message)
+            }
+            let fetchedRule = try decoder.decode(AnalyticsRuleSchema.self, from: result)
+            return (fetchedRule, response)
+        }
+        return (nil, response)
+    }
+    
+    public func delete() async throws -> (AnalyticsRuleSchema?, URLResponse?) {
+        let (data, response) = try await self.apiCall.delete(endPoint: endpointPath())
+        if let result = data {
+            if let notFound = try? decoder.decode(ApiResponse.self, from: result) {
+                throw ResponseError.analyticsRuleDoesNotExist(desc: notFound.message)
+            }
+            let deletedRule = try decoder.decode(AnalyticsRuleSchema.self, from: result)
+            return (deletedRule, response)
+        }
+        return (nil, response)
+    }
+    
+    private func endpointPath() -> String {
+        return "\(AnalyticsRules.resourcePath)/\(name)"
+    }
+}

Sources/Typesense/AnalyticsRules.swift

@@ -0,0 +1,39 @@
+import Foundation
+
+public struct AnalyticsRules {
+    private var apiCall: ApiCall
+    static var resourcePath: String = "\(Analytics.resourcePath)/rules"
+    
+    init(apiCall: ApiCall) {
+        self.apiCall = apiCall
+    }
+    
+    func upsert(params: AnalyticsRuleSchema) async throws -> (AnalyticsRuleSchema?, URLResponse?) {
+        let ruleData = try encoder.encode(params)
+        let (data, response) = try await self.apiCall.put(endPoint: endpointPath(params.name), body: ruleData)
+        if let result = data {
+            let ruleResult = try decoder.decode(AnalyticsRuleSchema.self, from: result)
+            return (ruleResult, response)
+        }
+
+        return (nil, response)
+    }
+    
+    func retrieveAll() async throws -> (AnalyticsRulesRetrieveSchema?, URLResponse?) {
+        let (data, response) = try await self.apiCall.get(endPoint: endpointPath())
+        if let result = data {
+            let rules = try decoder.decode(AnalyticsRulesRetrieveSchema.self, from: result)
+            return (rules, response)
+        }
+        
+        return (nil, response)
+    }
+    
+    private func endpointPath(_ operation: String? = nil) -> String {
+        if let operation = operation {
+            return "\(AnalyticsRules.resourcePath)/\(operation)"
+        } else {
+            return AnalyticsRules.resourcePath
+        }
+    }
+}

Sources/Typesense/Client.swift

@@ -31,4 +31,8 @@ public struct Client {
     public func multiSearch() -> MultiSearch {
         return MultiSearch(config: self.configuration)
     }
+    
+    public func analytics() -> Analytics {
+        return Analytics(config: self.configuration)
+    }
 }

Sources/Typesense/Documents.swift

@@ -62,8 +62,8 @@ public struct Documents {
             searchQueryParams.append(URLQueryItem(name: "query_by_weights", value: queryByWeights))
         }
 
-        if let maxHits = searchParameters.maxHits {
-            searchQueryParams.append(URLQueryItem(name: "max_hits", value: maxHits))
+        if let textMatchType = searchParameters.textMatchType {
+            searchQueryParams.append(URLQueryItem(name: "text_match_type", value: textMatchType))
         }
 
         if let _prefix = searchParameters._prefix {
@@ -72,10 +72,21 @@ public struct Documents {
                 fullString.append(String(item))
                 fullString.append(",")
             }
-            
             searchQueryParams.append(URLQueryItem(name: "prefix", value: String(fullString.dropLast())))
         }
 
+        if let _infix = searchParameters._infix {
+            searchQueryParams.append(URLQueryItem(name: "infix", value: _infix))
+        }
+        
+        if let maxExtraPrefix = searchParameters.maxExtraPrefix {
+            searchQueryParams.append(URLQueryItem(name: "max_extra_prefix", value: String(maxExtraPrefix)))
+        }
+        
+        if let maxExtraSuffix = searchParameters.maxExtraSuffix {
+            searchQueryParams.append(URLQueryItem(name: "max_extra_suffix", value: String(maxExtraSuffix)))
+        }
+        
         if let filterBy = searchParameters.filterBy {
             searchQueryParams.append(URLQueryItem(name: "filter_by", value: filterBy))
         }
@@ -108,6 +119,14 @@ public struct Documents {
             searchQueryParams.append(URLQueryItem(name: "per_page", value: String(perPage)))
         }
 
+        if let limit = searchParameters.limit {
+            searchQueryParams.append(URLQueryItem(name: "limit", value: String(limit)))
+        }
+        
+        if let offset = searchParameters.offset {
+            searchQueryParams.append(URLQueryItem(name: "offset", value: String(offset)))
+        }
+        
         if let groupBy = searchParameters.groupBy {
             searchQueryParams.append(URLQueryItem(name: "group_by", value: groupBy))
         }
@@ -140,6 +159,10 @@ public struct Documents {
             searchQueryParams.append(URLQueryItem(name: "highlight_end_tag", value: highlightEndTag))
         }
 
+        if let enableHighlightV1 = searchParameters.enableHighlightV1 {
+            searchQueryParams.append(URLQueryItem(name: "enable_highlight_v1", value: String(enableHighlightV1)))
+        }
+        
         if let snippetThreshold = searchParameters.snippetThreshold {
             searchQueryParams.append(URLQueryItem(name: "snippet_threshold", value: String(snippetThreshold)))
         }
@@ -164,10 +187,18 @@ public struct Documents {
             searchQueryParams.append(URLQueryItem(name: "highlight_fields", value: highlightFields))
         }
 
+        if let splitJoinTokens = searchParameters.splitJoinTokens {
+            searchQueryParams.append(URLQueryItem(name: "split_join_tokens", value: splitJoinTokens))
+        }
+        
         if let preSegmentedQuery = searchParameters.preSegmentedQuery {
             searchQueryParams.append(URLQueryItem(name: "pre_segmented_query", value: String(preSegmentedQuery)))
         }
 
+        if let preset = searchParameters.preset {
+            searchQueryParams.append(URLQueryItem(name: "preset", value: preset))
+        }
+        
         if let enableOverrides = searchParameters.enableOverrides {
             searchQueryParams.append(URLQueryItem(name: "enable_overrides", value: String(enableOverrides)))
         }
@@ -176,6 +207,14 @@ public struct Documents {
             searchQueryParams.append(URLQueryItem(name: "prioritize_exact_match", value: String(prioritizeExactMatch)))
         }
 
+        if let maxCandidates = searchParameters.maxCandidates {
+            searchQueryParams.append(URLQueryItem(name: "max_candidates", value: String(maxCandidates)))
+        }
+        
+        if let prioritizeTokenPosition = searchParameters.prioritizeTokenPosition {
+            searchQueryParams.append(URLQueryItem(name: "prioritize_token_position", value: String(prioritizeTokenPosition)))
+        }
+        
         if let exhaustiveSearch = searchParameters.exhaustiveSearch {
             searchQueryParams.append(URLQueryItem(name: "exhaustive_search", value: String(exhaustiveSearch)))
         }
@@ -200,6 +239,17 @@ public struct Documents {
             searchQueryParams.append(URLQueryItem(name: "min_len2type", value: String(minLen2typo)))
         }
 
+        if let vectorQuery = searchParameters.vectorQuery {
+            searchQueryParams.append(URLQueryItem(name: "vector_query", value: vectorQuery))
+        }
+        
+        if let remoteEmbeddingTimeoutMS = searchParameters.remoteEmbeddingTimeoutMs {
+            searchQueryParams.append(URLQueryItem(name: "remote_embedding_timeout_ms", value: String(remoteEmbeddingTimeoutMS)))
+        }
+        
+        if let remoteEmbeddingNumTries = searchParameters.remoteEmbeddingNumTries {
+            searchQueryParams.append(URLQueryItem(name: "remote_embedding_num_tries", value: String(remoteEmbeddingNumTries)))
+        }
 
         let (data, response) = try await apiCall.get(endPoint: "\(RESOURCEPATH)/search", queryParameters: searchQueryParams)
 

Sources/Typesense/Errors.swift

@@ -21,4 +21,5 @@ public enum ResponseError: Error {
     case invalidCollection(desc: String)
     case apiKeyNotFound(desc: String)
     case aliasNotFound(desc: String)
+    case analyticsRuleDoesNotExist(desc: String)
 }

Sources/Typesense/Models/AnalyticsRuleParameters.swift

@@ -0,0 +1,25 @@
+//
+// AnalyticsRuleParameters.swift
+//
+// Generated by swagger-codegen
+// https://github.com/swagger-api/swagger-codegen
+//
+
+import Foundation
+
+
+
+public struct AnalyticsRuleParameters: Codable {
+
+    public var source: AnalyticsRuleParametersSource
+    public var destination: AnalyticsRuleParametersDestination
+    public var limit: Int
+
+    public init(source: AnalyticsRuleParametersSource, destination: AnalyticsRuleParametersDestination, limit: Int) {
+        self.source = source
+        self.destination = destination
+        self.limit = limit
+    }
+
+
+}

Sources/Typesense/Models/AnalyticsRuleParametersDestination.swift

@@ -0,0 +1,21 @@
+//
+// AnalyticsRuleParametersDestination.swift
+//
+// Generated by swagger-codegen
+// https://github.com/swagger-api/swagger-codegen
+//
+
+import Foundation
+
+
+
+public struct AnalyticsRuleParametersDestination: Codable {
+
+    public var collection: String?
+
+    public init(collection: String? = nil) {
+        self.collection = collection
+    }
+
+
+}

Sources/Typesense/Models/AnalyticsRuleParametersSource.swift

@@ -0,0 +1,21 @@
+//
+// AnalyticsRuleParametersSource.swift
+//
+// Generated by swagger-codegen
+// https://github.com/swagger-api/swagger-codegen
+//
+
+import Foundation
+
+
+
+public struct AnalyticsRuleParametersSource: Codable {
+
+    public var collections: [String]?
+
+    public init(collections: [String]? = nil) {
+        self.collections = collections
+    }
+
+
+}

Sources/Typesense/Models/AnalyticsRuleSchema.swift

@@ -0,0 +1,25 @@
+//
+// AnalyticsRuleSchema.swift
+//
+// Generated by swagger-codegen
+// https://github.com/swagger-api/swagger-codegen
+//
+
+import Foundation
+
+
+
+public struct AnalyticsRuleSchema: Codable {
+
+    public var name: String
+    public var type: String?
+    public var params: AnalyticsRuleParameters?
+
+    public init(name: String, type: String, params: AnalyticsRuleParameters) {
+        self.name = name
+        self.type = type
+        self.params = params
+    }
+
+
+}