Release 0.51.0 (apollographql#2086)

calvincestari · jamesonwilliams · commit 2e32b3a145f1 · 2024-11-16T17:29:07.000-06:00
* Update version number * Update changelog * Update SourceDocsLib dependecy * Update generated documentation * Update changelog with cache key caveat * Update changelog for merging of apollographql#2147 * Update changelog for apollographql#2177 and apollographql#2168 * Update documentation
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change log
 
+## v0.51.0
+- **Allow periods in arguments to be ignored when parsing cacheKeys**: If your query arguments include periods they will no longer cause broken cache keys. This means the cached data for those queries can be correctly found and returned. The caveat with this change though is that if you use a persisted cache, after the upgrade you could see cache misses and the data would be refetched. [#2057](https://github.com/apollographql/apollo-ios/pull/2057) - _Thanks to [Hesham Salman](https://github.com/Iron-Ham) for the contribution._
+- **Fixed - [`Sendable` class `JavaScriptError` cannot inherit from another class other than `NSObject`](https://github.com/apollographql/apollo-ios/issues/2146):** Xcode 13.3 introduced some additional requirements for `Error` types and `JavaScriptError` did not conform causing compile errors in `ApolloCodegenLib`. This change disables `Sendable` type checking for `JavaScriptError` while maintaining type-safety across concurrency boundaries. [#2147](https://github.com/apollographql/apollo-ios/pull/2147) - _Thank you to [Tiziano Coroneo](https://github.com/TizianoCoroneo) for the contribution._
+- **Fixed - [Watcher using a policy that shouldn't hit the network, can still hit the network](https://github.com/apollographql/apollo-ios/issues/2170):** If the cache policy given to the `watch(query:cachePolicy:)` method of `ApolloClient` was `.returnCacheDataDontFetch` it could still trigger a remote fetch of the query. - _Thank you to [Peter Potrebic](https://github.com/potrebic) for raising the issue._
+- **BREAKING CHANGE - [`graphql-ws` Protocol Support](https://github.com/apollographql/apollo-ios/issues/1622):** We've added official support for the [graphql-ws](https://github.com/enisdenjo/graphql-ws) library and its [`graphql-transport-ws`](https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md) protocol. This is a breaking change because the `WebSocket` initializers now require you to specify which protocol to use.
+
 ## v0.50.0
 - **Dropped SPM support for Swift 5.2**: The minimum version of the Swift tools and language compatibilty required to process the SPM manifest is Swift 5.3. This means a minimum of Xcode version 12 is required for Swift Package Manager support. [#1992](https://github.com/apollographql/apollo-ios/pull/1992)
 - **Removed unnecessary assertion failure**: The completion handler on `returnResultAsyncIfNeeded` is defined as optional but if not included would cause debug builds to crash with an `assertionFailure` in the case of a `failure` of the `Result`. [#2005](https://github.com/apollographql/apollo-ios/pull/2005) - _Thank you to [Richard Topchii](https://github.com/richardtop) for raising this issue!_
diff --git a/Configuration/Shared/Project-Version.xcconfig b/Configuration/Shared/Project-Version.xcconfig
@@ -1 +1 @@
-CURRENT_PROJECT_VERSION = 0.50.0
+CURRENT_PROJECT_VERSION = 0.51.0
diff --git a/SwiftScripts/Package.resolved b/SwiftScripts/Package.resolved
diff --git a/SwiftScripts/Package.swift b/SwiftScripts/Package.swift
@@ -6,12 +6,12 @@ import PackageDescription
 let package = Package(
     name: "Codegen",
     platforms: [
-        .macOS(.v10_14)
+        .macOS(.v10_15)
     ],
     dependencies: [
         .package(name: "Apollo", path: ".."),
-        .package(url: "https://github.com/apple/swift-argument-parser.git", from: "0.3.0"),
-        .package(url: "https://github.com/eneko/SourceDocs.git", .upToNextMinor(from: "1.2.0"))
+        .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMinor(from: "1.0.2")),
+        .package(url: "https://github.com/eneko/SourceDocs.git", .upToNextMinor(from: "2.0.0"))
     ],
     targets: [
         .target(name: "Codegen",
diff --git a/docs/source/api/Apollo/enums/CachePolicy.md b/docs/source/api/Apollo/enums/CachePolicy.md
@@ -48,3 +48,12 @@ case returnCacheDataAndFetch
 ```
 
 Return data from the cache if available, and always fetch results from the server.
+
+## Properties
+### `default`
+
+```swift
+public static var `default`: CachePolicy = .returnCacheDataElseFetch
+```
+
+The current default cache policy.
diff --git a/docs/source/api/Apollo/extensions/NetworkTransport.md b/docs/source/api/Apollo/extensions/NetworkTransport.md
@@ -6,12 +6,44 @@ public extension NetworkTransport
 ```
 
 ## Properties
+### `headerFieldNameApolloClientName`
+
+```swift
+static var headerFieldNameApolloClientName: String
+```
+
+The field name for the Apollo Client Name header
+
+### `headerFieldNameApolloClientVersion`
+
+```swift
+static var headerFieldNameApolloClientVersion: String
+```
+
+The field name for the Apollo Client Version header
+
+### `defaultClientName`
+
+```swift
+static var defaultClientName: String
+```
+
+The default client name to use when setting up the `clientName` property
+
 ### `clientName`
 
 ```swift
 var clientName: String
 ```
 
+### `defaultClientVersion`
+
+```swift
+static var defaultClientVersion: String
+```
+
+The default client version to use when setting up the `clientVersion` property.
+
 ### `clientVersion`
 
 ```swift
diff --git a/docs/source/api/Apollo/protocols/GraphQLFragment.md b/docs/source/api/Apollo/protocols/GraphQLFragment.md
@@ -5,3 +5,16 @@
 ```swift
 public protocol GraphQLFragment: GraphQLSelectionSet
 ```
+
+## Properties
+### `fragmentDefinition`
+
+```swift
+static var fragmentDefinition: String
+```
+
+### `possibleTypes`
+
+```swift
+static var possibleTypes: [String]
+```
diff --git a/docs/source/api/Apollo/protocols/GraphQLSelectionSet.md b/docs/source/api/Apollo/protocols/GraphQLSelectionSet.md
@@ -7,6 +7,12 @@ public protocol GraphQLSelectionSet
 ```
 
 ## Properties
+### `selections`
+
+```swift
+static var selections: [GraphQLSelection]
+```
+
 ### `resultMap`
 
 ```swift
diff --git a/docs/source/api/Apollo/structs/GraphQLFile.md b/docs/source/api/Apollo/structs/GraphQLFile.md
@@ -45,6 +45,14 @@ public let fileURL: URL?
 public let contentLength: UInt64
 ```
 
+### `octetStreamMimeType`
+
+```swift
+public static let octetStreamMimeType = "application/octet-stream"
+```
+
+A convenience constant for declaring your mimetype is octet-stream.
+
 ## Methods
 ### `init(fieldName:originalName:mimeType:data:)`
 
diff --git a/docs/source/api/ApolloAPI/enums/GraphQLEnum.md b/docs/source/api/ApolloAPI/enums/GraphQLEnum.md
@@ -46,6 +46,15 @@ The underlying enum case. If the value is `__unknown`, this will be `nil`.
 public var rawValue: String
 ```
 
+### `allCases`
+
+```swift
+public static var allCases: [GraphQLEnum<T>]
+```
+
+A collection of all known values of the wrapped enum.
+This collection does not include the `__unknown` case.
+
 ## Methods
 ### `init(_:)`
 
diff --git a/docs/source/api/ApolloAPI/protocols/AnySelectionSet.md b/docs/source/api/ApolloAPI/protocols/AnySelectionSet.md
@@ -5,3 +5,10 @@
 ```swift
 public protocol AnySelectionSet: ResponseObject
 ```
+
+## Properties
+### `selections`
+
+```swift
+static var selections: [Selection]
+```
diff --git a/docs/source/api/ApolloAPI/protocols/SchemaObjectType.md b/docs/source/api/ApolloAPI/protocols/SchemaObjectType.md
@@ -7,6 +7,12 @@ public protocol SchemaObjectType: SchemaTypeEnum
 ```
 
 ## Properties
+### `unknownCase`
+
+```swift
+static var unknownCase: Self
+```
+
 ### `implementedInterfaces`
 
 ```swift
diff --git a/docs/source/api/ApolloAPI/protocols/SelectionSet.md b/docs/source/api/ApolloAPI/protocols/SelectionSet.md
@@ -5,3 +5,14 @@
 ```swift
 public protocol SelectionSet: ResponseObject, Equatable
 ```
+
+## Properties
+### `__parentType`
+
+```swift
+static var __parentType: SelectionSetType<Schema>
+```
+
+The GraphQL type for the `SelectionSet`.
+
+This may be a concrete type (`ConcreteType`) or an abstract type (`Interface`).
diff --git a/docs/source/api/ApolloCodegenLib/classes/JavaScriptError.md b/docs/source/api/ApolloCodegenLib/classes/JavaScriptError.md
@@ -3,8 +3,8 @@
 # `JavaScriptError`
 
 ```swift
-public class JavaScriptError: JavaScriptObject, Error
+public class JavaScriptError: JavaScriptObject, Error, @unchecked Sendable
 ```
 
-An errror thrown during JavaScript execution.
+An error thrown during JavaScript execution.
 See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
diff --git a/docs/source/api/ApolloCodegenLib/enums/ApolloCodegenOptions.CodeGenerationEngine.md b/docs/source/api/ApolloCodegenLib/enums/ApolloCodegenOptions.CodeGenerationEngine.md
@@ -16,3 +16,12 @@ case typescript
 ```
 
 The default, tried and true code generation engine
+
+## Properties
+### `default`
+
+```swift
+public static var `default`: CodeGenerationEngine
+```
+
+The current default for the code generation engine.
diff --git a/docs/source/api/ApolloCodegenLib/structs/ApolloCodegenOptions.md b/docs/source/api/ApolloCodegenLib/structs/ApolloCodegenOptions.md
@@ -41,7 +41,7 @@ Designated initializer.
  - outputFormat: The `OutputFormat` enum option to use to output generated code.
  - customScalarFormat: How to handle properties using a custom scalar from the schema.
  - suppressSwiftMultilineStringLiterals: Don't use multi-line string literals when generating code. Defaults to false.
- - urlToSchemaFile: The URL to your schema file.
+ - urlToSchemaFile: The URL to your schema file. Accepted file types are `.json` for JSON files, or either `.graphqls` or `.sdl` for Schema Definition Language files.
  - downloadTimeout: The maximum time to wait before indicating that the download timed out, in seconds. Defaults to 30 seconds.
 
 ### `init(targetRootURL:codegenEngine:downloadTimeout:)`
diff --git a/docs/source/api/ApolloCodegenLib/structs/CodegenLogger.md b/docs/source/api/ApolloCodegenLib/structs/CodegenLogger.md
@@ -8,6 +8,16 @@ public struct CodegenLogger
 
 Helper to get logs printing to stdout so they can be read from the command line.
 
+## Properties
+### `level`
+
+```swift
+public static var level = LogLevel.debug
+```
+
+The `LogLevel` at which to print logs. Higher raw values than this will
+be ignored. Defaults to `debug`.
+
 ## Methods
 ### `log(_:logLevel:file:line:)`
 
diff --git a/docs/source/api/ApolloSQLite/README.md b/docs/source/api/ApolloSQLite/README.md
@@ -19,6 +19,7 @@
 
 ## Extensions
 
+-   [SQLiteDatabase](extensions/SQLiteDatabase/)
 -   [SQLiteNormalizedCache](extensions/SQLiteNormalizedCache/)
 
 This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs)
diff --git a/docs/source/api/ApolloSQLite/extensions/SQLiteDatabase.md b/docs/source/api/ApolloSQLite/extensions/SQLiteDatabase.md
@@ -0,0 +1,31 @@
+**EXTENSION**
+
+# `SQLiteDatabase`
+```swift
+public extension SQLiteDatabase
+```
+
+## Properties
+### `tableName`
+
+```swift
+static var tableName: String
+```
+
+### `idColumnName`
+
+```swift
+static var idColumnName: String
+```
+
+### `keyColumnName`
+
+```swift
+static var keyColumnName: String
+```
+
+### `recordColumName`
+
+```swift
+static var recordColumName: String
+```
diff --git a/docs/source/api/ApolloUtils/extensions/ApolloCompatible.md b/docs/source/api/ApolloUtils/extensions/ApolloCompatible.md
@@ -11,3 +11,9 @@ extension ApolloCompatible
 ```swift
 public var apollo: ApolloExtension<Self>
 ```
+
+### `apollo`
+
+```swift
+public static var apollo: ApolloExtension<Self>.Type
+```
diff --git a/docs/source/api/ApolloUtils/protocols/ApolloCompatible.md b/docs/source/api/ApolloUtils/protocols/ApolloCompatible.md
@@ -19,3 +19,11 @@ var apollo: ApolloExtension<Base>
 ```
 
 The `ApolloExtension` object for an instance
+
+### `apollo`
+
+```swift
+static var apollo: ApolloExtension<Base>.Type
+```
+
+The `ApolloExtension` object for a type
diff --git a/docs/source/api/ApolloWebSocket/README.md b/docs/source/api/ApolloWebSocket/README.md
@@ -29,6 +29,7 @@
 
 -   [WSError.ErrorType](enums/WSError.ErrorType/)
 -   [WebSocket.OpCode](enums/WebSocket.OpCode/)
+-   [WebSocket.WSProtocol](enums/WebSocket.WSProtocol/)
 -   [WebSocketError.ErrorKind](enums/WebSocketError.ErrorKind/)
 
 ## Extensions
diff --git a/docs/source/api/ApolloWebSocket/classes/WebSocket.md b/docs/source/api/ApolloWebSocket/classes/WebSocket.md
diff --git a/docs/source/api/ApolloWebSocket/enums/WebSocket.WSProtocol.md b/docs/source/api/ApolloWebSocket/enums/WebSocket.WSProtocol.md

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-CURRENT_PROJECT_VERSION = 0.50.0`
	`1`	`+CURRENT_PROJECT_VERSION = 0.51.0`