Makes all request & response types and fields public#8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NeedleInAJayStack merged 2 commits into from
Jan 19, 2026
Merged

Makes all request & response types and fields public #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba57614
feat: Makes all request and response types and fields public
NeedleInAJayStack Jan 19, 2026
8d03422
test: Removes testable import
NeedleInAJayStack Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 31 additions & 30 deletions Package.resolved
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Sources/GraphQLTransportWS/Client.swift
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,7 @@ public class Client<InitPayload: Equatable & Codable> {
return
}
try await self.onComplete(completeResponse, self)
case .unknown:
default:
try await self.error(.invalidType())
}
}
Expand Down
4 changes: 2 additions & 2 deletions Sources/GraphQLTransportWS/GraphqlTransportWSError.swift
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,14 +60,14 @@ struct GraphQLTransportWSError: Error {

static func invalidRequestFormat(messageType: RequestMessageType) -> Self {
return self.init(
"Request message doesn't match '\(messageType.rawValue)' JSON format",
"Request message doesn't match '\(messageType.type.rawValue)' JSON format",
code: .invalidRequestFormat
)
}

static func invalidResponseFormat(messageType: ResponseMessageType) -> Self {
return self.init(
"Response message doesn't match '\(messageType.rawValue)' JSON format",
"Response message doesn't match '\(messageType.type.rawValue)' JSON format",
code: .invalidResponseFormat
)
}
Expand Down
122 changes: 87 additions & 35 deletions Sources/GraphQLTransportWS/Requests.swift
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,105 @@
import Foundation
import GraphQL

/// We also require that an 'authToken' field is provided in the 'payload' during the connection
/// init message. For example:
/// ```
/// {
/// "type": 'connection_init',
/// "payload": {
/// "authToken": "eyJhbGciOiJIUz..."
/// }
/// }
/// ```

/// A general request. This object's type is used to triage to other, more specific request objects.
struct Request: Equatable, JsonEncodable {
let type: RequestMessageType
public struct Request: Equatable, JsonEncodable {
public let type: RequestMessageType
}

/// A websocket `connection_init` request from the client to the server
struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
var type = RequestMessageType.connectionInit
let payload: InitPayload
public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
public let type: RequestMessageType = .connectionInit
public let payload: InitPayload

public init(payload: InitPayload) {
self.payload = payload
}

public init(from decoder: any Decoder) throws {
let container = try decoder.container(keyedBy: Self.CodingKeys.self)
if try container.decode(RequestMessageType.self, forKey: .type) != .connectionInit {
throw DecodingError.dataCorrupted(.init(
codingPath: decoder.codingPath,
debugDescription: "type must be `\(RequestMessageType.connectionInit.type)`"
))
}
payload = try container.decode(InitPayload.self, forKey: .payload)
}
}

/// A websocket `subscribe` request from the client to the server
struct SubscribeRequest: Equatable, JsonEncodable {
var type = RequestMessageType.subscribe
let payload: GraphQLRequest
let id: String
public struct SubscribeRequest: Equatable, JsonEncodable {
public let type = RequestMessageType.subscribe
public let payload: GraphQLRequest
public let id: String

public init(payload: GraphQLRequest, id: String) {
self.payload = payload
self.id = id
}

public init(from decoder: any Decoder) throws {
let container = try decoder.container(keyedBy: Self.CodingKeys.self)
if try container.decode(RequestMessageType.self, forKey: .type) != .subscribe {
throw DecodingError.dataCorrupted(.init(
codingPath: decoder.codingPath,
debugDescription: "type must be `\(RequestMessageType.subscribe.type)`"
))
}
payload = try container.decode(GraphQLRequest.self, forKey: .payload)
id = try container.decode(String.self, forKey: .id)
}
}

/// A websocket `complete` request from the client to the server
struct CompleteRequest: Equatable, JsonEncodable {
var type = RequestMessageType.complete
let id: String
public struct CompleteRequest: Equatable, JsonEncodable {
public let type = RequestMessageType.complete
public let id: String

public init(id: String) {
self.id = id
}

public init(from decoder: any Decoder) throws {
let container = try decoder.container(keyedBy: Self.CodingKeys.self)
if try container.decode(RequestMessageType.self, forKey: .type) != .complete {
throw DecodingError.dataCorrupted(.init(
codingPath: decoder.codingPath,
debugDescription: "type must be `\(RequestMessageType.complete.type)`"
))
}
id = try container.decode(String.self, forKey: .id)
}
}

/// The supported websocket request message types from the client to the server
enum RequestMessageType: String, Codable {
case connectionInit = "connection_init"
case subscribe
case complete
case unknown

init(from decoder: Decoder) throws {
guard let value = try? decoder.singleValueContainer().decode(String.self) else {
self = .unknown
return
}
self = RequestMessageType(rawValue: value) ?? .unknown
public struct RequestMessageType: Equatable, Codable, Sendable {
// This is implemented as a struct with only public static properties, backed by an internal enum
// in order to grow the list of accepted request types in a non-breaking way.

let type: RequestType

init(type: RequestType) {
self.type = type
}

public init(from decoder: any Decoder) throws {
let container = try decoder.singleValueContainer()
type = try container.decode(RequestType.self)
}

public func encode(to encoder: any Encoder) throws {
var container = encoder.singleValueContainer()
try container.encode(type)
}

public static let connectionInit: Self = .init(type: .connectionInit)
public static let subscribe: Self = .init(type: .subscribe)
public static let complete: Self = .init(type: .complete)

enum RequestType: String, Codable {
case connectionInit = "connection_init"
case subscribe
case complete
}
}
111 changes: 85 additions & 26 deletions Sources/GraphQLTransportWS/Responses.swift
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,48 +2,79 @@ import Foundation
import GraphQL

/// A general response. This object's type is used to triage to other, more specific response objects.
struct Response: Equatable, JsonEncodable {
let type: ResponseMessageType
public struct Response: Equatable, JsonEncodable {
public let type: ResponseMessageType
}

/// A websocket `connection_ack` response from the server to the client
public struct ConnectionAckResponse: Equatable, JsonEncodable {
let type: ResponseMessageType
public let type: ResponseMessageType = .connectionAck
public let payload: [String: Map]?

init(_ payload: [String: Map]? = nil) {
type = .connectionAck
public init(payload: [String: Map]? = nil) {
self.payload = payload
}

public init(from decoder: any Decoder) throws {
let container = try decoder.container(keyedBy: Self.CodingKeys.self)
if try container.decode(ResponseMessageType.self, forKey: .type) != .connectionAck {
throw DecodingError.dataCorrupted(.init(
codingPath: decoder.codingPath,
debugDescription: "type must be `\(ResponseMessageType.connectionAck.type)`"
))
}
payload = try container.decodeIfPresent([String: Map].self, forKey: .payload)
}
}

/// A websocket `next` response from the server to the client
public struct NextResponse: Equatable, JsonEncodable {
let type: ResponseMessageType
public let type: ResponseMessageType = .next
public let payload: GraphQLResult?
public let id: String

init(_ payload: GraphQLResult? = nil, id: String) {
type = .next
public init(payload: GraphQLResult?, id: String) {
self.payload = payload
self.id = id
}

public init(from decoder: any Decoder) throws {
let container = try decoder.container(keyedBy: Self.CodingKeys.self)
if try container.decode(ResponseMessageType.self, forKey: .type) != .next {
throw DecodingError.dataCorrupted(.init(
codingPath: decoder.codingPath,
debugDescription: "type must be `\(ResponseMessageType.next.type)`"
))
}
payload = try container.decodeIfPresent(GraphQLResult.self, forKey: .payload)
id = try container.decode(String.self, forKey: .id)
}
}

/// A websocket `complete` response from the server to the client
public struct CompleteResponse: Equatable, JsonEncodable {
let type: ResponseMessageType
public let type: ResponseMessageType = .complete
public let id: String

init(id: String) {
type = .complete
public init(id: String) {
self.id = id
}

public init(from decoder: any Decoder) throws {
let container = try decoder.container(keyedBy: Self.CodingKeys.self)
if try container.decode(ResponseMessageType.self, forKey: .type) != .complete {
throw DecodingError.dataCorrupted(.init(
codingPath: decoder.codingPath,
debugDescription: "type must be `\(ResponseMessageType.complete.type)`"
))
}
id = try container.decode(String.self, forKey: .id)
}
}

/// A websocket `error` response from the server to the client
public struct ErrorResponse: Equatable, JsonEncodable {
let type: ResponseMessageType
public let type: ResponseMessageType = .error
public let payload: [GraphQLError]
public let id: String

Expand All@@ -56,26 +87,54 @@ public struct ErrorResponse: Equatable, JsonEncodable {
return GraphQLError(error)
}
}
type = .error
payload = graphQLErrors
self.id = id
}

public init(from decoder: any Decoder) throws {
let container = try decoder.container(keyedBy: Self.CodingKeys.self)
if try container.decode(ResponseMessageType.self, forKey: .type) != .error {
throw DecodingError.dataCorrupted(.init(
codingPath: decoder.codingPath,
debugDescription: "type must be `\(ResponseMessageType.error.type)`"
))
}
payload = try container.decode([GraphQLError].self, forKey: .payload)
id = try container.decode(String.self, forKey: .id)
}
}

/// The supported websocket response message types from the server to the client
enum ResponseMessageType: String, Codable {
case connectionAck = "connection_ack"
case next
case error
case complete
case unknown

init(from decoder: Decoder) throws {
guard let value = try? decoder.singleValueContainer().decode(String.self) else {
self = .unknown
return
}
self = ResponseMessageType(rawValue: value) ?? .unknown
public struct ResponseMessageType: Equatable, Codable, Sendable {
// This is implemented as a struct with only public static properties, backed by an internal enum
// in order to grow the list of accepted response types in a non-breaking way.

let type: ResponseType

init(type: ResponseType) {
self.type = type
}

public init(from decoder: any Decoder) throws {
let container = try decoder.singleValueContainer()
type = try container.decode(ResponseType.self)
}

public func encode(to encoder: any Encoder) throws {
var container = encoder.singleValueContainer()
try container.encode(type)
}

public static let connectionAck: Self = .init(type: .connectionAck)
public static let next: Self = .init(type: .next)
public static let complete: Self = .init(type: .complete)
public static let error: Self = .init(type: .error)

enum ResponseType: String, Codable {
case connectionAck = "connection_ack"
case next
case complete
case error
}
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Makes all request & response types and fields public#8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

NeedleInAJayStack
merged 2 commits into

from

Jan 19, 2026
 Merged


Makes all request & response types and fields public
#8
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba57614

feat: Makes all request and response types and fields public


NeedleInAJayStack Jan 19, 2026
8d03422

test: Removes testable import


NeedleInAJayStack Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
Package.resolved

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
Sources/GraphQLTransportWS/Client.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,7 @@ public class Client<InitPayload: Equatable & Codable> {
 return
 }
 try await self.onComplete(completeResponse, self)
case .unknown:
default:
 try await self.error(.invalidType())
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
Sources/GraphQLTransportWS/GraphqlTransportWSError.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,14 +60,14 @@ struct GraphQLTransportWSError: Error {

 static func invalidRequestFormat(messageType: RequestMessageType) -> Self {
 return self.init(
 "Request message doesn't match '\(messageType.rawValue)' JSON format",
 "Request message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidRequestFormat
 )
 }

 static func invalidResponseFormat(messageType: ResponseMessageType) -> Self {
 return self.init(
 "Response message doesn't match '\(messageType.rawValue)' JSON format",
 "Response message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidResponseFormat
 )
 }
Expand Down

122 changes: 87 additions & 35 deletions
Sources/GraphQLTransportWS/Requests.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,53 +1,105 @@
import Foundation
import GraphQL

/// We also require that an 'authToken' field is provided in the 'payload' during the connection
/// init message. For example:
/// ```
/// {
/// "type": 'connection_init',
/// "payload": {
/// "authToken": "eyJhbGciOiJIUz..."
/// }
/// }
/// ```

/// A general request. This object's type is used to triage to other, more specific request objects.
struct Request: Equatable, JsonEncodable {
 let type: RequestMessageType
public struct Request: Equatable, JsonEncodable {
public let type: RequestMessageType
}

/// A websocket `connection_init` request from the client to the server
struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 var type = RequestMessageType.connectionInit
 let payload: InitPayload
public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 public let type: RequestMessageType = .connectionInit
 public let payload: InitPayload

 public init(payload: InitPayload) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .connectionInit {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.connectionInit.type)`"
 ))
 }
 payload = try container.decode(InitPayload.self, forKey: .payload)
 }
}

/// A websocket `subscribe` request from the client to the server
struct SubscribeRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.subscribe
 let payload: GraphQLRequest
 let id: String
public struct SubscribeRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.subscribe
 public let payload: GraphQLRequest
 public let id: String

 public init(payload: GraphQLRequest, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .subscribe {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.subscribe.type)`"
 ))
 }
 payload = try container.decode(GraphQLRequest.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` request from the client to the server
struct CompleteRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.complete
 let id: String
public struct CompleteRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.complete
 public let id: String

 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket request message types from the client to the server
enum RequestMessageType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = RequestMessageType(rawValue: value) ?? .unknown
public struct RequestMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted request types in a non-breaking way.

 let type: RequestType

 init(type: RequestType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(RequestType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionInit: Self = .init(type: .connectionInit)
 public static let subscribe: Self = .init(type: .subscribe)
 public static let complete: Self = .init(type: .complete)

 enum RequestType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 }
}

111 changes: 85 additions & 26 deletions
Sources/GraphQLTransportWS/Responses.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,48 +2,79 @@ import Foundation
import GraphQL

/// A general response. This object's type is used to triage to other, more specific response objects.
struct Response: Equatable, JsonEncodable {
 let type: ResponseMessageType
public struct Response: Equatable, JsonEncodable {
public let type: ResponseMessageType
}

/// A websocket `connection_ack` response from the server to the client
public struct ConnectionAckResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .connectionAck
 public let payload: [String: Map]?

 init(_ payload: [String: Map]? = nil) {
 type = .connectionAck
 public init(payload: [String: Map]? = nil) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .connectionAck {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.connectionAck.type)`"
 ))
 }
 payload = try container.decodeIfPresent([String: Map].self, forKey: .payload)
 }
}

/// A websocket `next` response from the server to the client
public struct NextResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .next
 public let payload: GraphQLResult?
 public let id: String

 init(_ payload: GraphQLResult? = nil, id: String) {
 type = .next
 public init(payload: GraphQLResult?, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .next {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.next.type)`"
 ))
 }
 payload = try container.decodeIfPresent(GraphQLResult.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` response from the server to the client
public struct CompleteResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .complete
 public let id: String

 init(id: String) {
 type = .complete
 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `error` response from the server to the client
public struct ErrorResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .error
 public let payload: [GraphQLError]
 public let id: String

Expand All@@ -56,26 +87,54 @@ public struct ErrorResponse: Equatable, JsonEncodable {
 return GraphQLError(error)
 }
 }
 type = .error
 payload = graphQLErrors
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .error {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.error.type)`"
 ))
 }
 payload = try container.decode([GraphQLError].self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket response message types from the server to the client
enum ResponseMessageType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case error
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = ResponseMessageType(rawValue: value) ?? .unknown
public struct ResponseMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted response types in a non-breaking way.

 let type: ResponseType

 init(type: ResponseType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(ResponseType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionAck: Self = .init(type: .connectionAck)
 public static let next: Self = .init(type: .next)
 public static let complete: Self = .init(type: .complete)
 public static let error: Self = .init(type: .error)

 enum ResponseType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case complete
 case error
 }
}

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Makes all request & response types and fields public#8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

NeedleInAJayStack
merged 2 commits into

from

Jan 19, 2026
 Merged


Makes all request & response types and fields public
#8
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba57614

feat: Makes all request and response types and fields public


NeedleInAJayStack Jan 19, 2026
8d03422

test: Removes testable import


NeedleInAJayStack Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
Package.resolved

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
Sources/GraphQLTransportWS/Client.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,7 @@ public class Client<InitPayload: Equatable & Codable> {
 return
 }
 try await self.onComplete(completeResponse, self)
case .unknown:
default:
 try await self.error(.invalidType())
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
Sources/GraphQLTransportWS/GraphqlTransportWSError.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,14 +60,14 @@ struct GraphQLTransportWSError: Error {

 static func invalidRequestFormat(messageType: RequestMessageType) -> Self {
 return self.init(
 "Request message doesn't match '\(messageType.rawValue)' JSON format",
 "Request message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidRequestFormat
 )
 }

 static func invalidResponseFormat(messageType: ResponseMessageType) -> Self {
 return self.init(
 "Response message doesn't match '\(messageType.rawValue)' JSON format",
 "Response message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidResponseFormat
 )
 }
Expand Down

122 changes: 87 additions & 35 deletions
Sources/GraphQLTransportWS/Requests.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,53 +1,105 @@
import Foundation
import GraphQL

/// We also require that an 'authToken' field is provided in the 'payload' during the connection
/// init message. For example:
/// ```
/// {
/// "type": 'connection_init',
/// "payload": {
/// "authToken": "eyJhbGciOiJIUz..."
/// }
/// }
/// ```

/// A general request. This object's type is used to triage to other, more specific request objects.
struct Request: Equatable, JsonEncodable {
 let type: RequestMessageType
public struct Request: Equatable, JsonEncodable {
public let type: RequestMessageType
}

/// A websocket `connection_init` request from the client to the server
struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 var type = RequestMessageType.connectionInit
 let payload: InitPayload
public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 public let type: RequestMessageType = .connectionInit
 public let payload: InitPayload

 public init(payload: InitPayload) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .connectionInit {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.connectionInit.type)`"
 ))
 }
 payload = try container.decode(InitPayload.self, forKey: .payload)
 }
}

/// A websocket `subscribe` request from the client to the server
struct SubscribeRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.subscribe
 let payload: GraphQLRequest
 let id: String
public struct SubscribeRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.subscribe
 public let payload: GraphQLRequest
 public let id: String

 public init(payload: GraphQLRequest, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .subscribe {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.subscribe.type)`"
 ))
 }
 payload = try container.decode(GraphQLRequest.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` request from the client to the server
struct CompleteRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.complete
 let id: String
public struct CompleteRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.complete
 public let id: String

 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket request message types from the client to the server
enum RequestMessageType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = RequestMessageType(rawValue: value) ?? .unknown
public struct RequestMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted request types in a non-breaking way.

 let type: RequestType

 init(type: RequestType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(RequestType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionInit: Self = .init(type: .connectionInit)
 public static let subscribe: Self = .init(type: .subscribe)
 public static let complete: Self = .init(type: .complete)

 enum RequestType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 }
}

111 changes: 85 additions & 26 deletions
Sources/GraphQLTransportWS/Responses.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,48 +2,79 @@ import Foundation
import GraphQL

/// A general response. This object's type is used to triage to other, more specific response objects.
struct Response: Equatable, JsonEncodable {
 let type: ResponseMessageType
public struct Response: Equatable, JsonEncodable {
public let type: ResponseMessageType
}

/// A websocket `connection_ack` response from the server to the client
public struct ConnectionAckResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .connectionAck
 public let payload: [String: Map]?

 init(_ payload: [String: Map]? = nil) {
 type = .connectionAck
 public init(payload: [String: Map]? = nil) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .connectionAck {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.connectionAck.type)`"
 ))
 }
 payload = try container.decodeIfPresent([String: Map].self, forKey: .payload)
 }
}

/// A websocket `next` response from the server to the client
public struct NextResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .next
 public let payload: GraphQLResult?
 public let id: String

 init(_ payload: GraphQLResult? = nil, id: String) {
 type = .next
 public init(payload: GraphQLResult?, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .next {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.next.type)`"
 ))
 }
 payload = try container.decodeIfPresent(GraphQLResult.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` response from the server to the client
public struct CompleteResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .complete
 public let id: String

 init(id: String) {
 type = .complete
 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `error` response from the server to the client
public struct ErrorResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .error
 public let payload: [GraphQLError]
 public let id: String

Expand All@@ -56,26 +87,54 @@ public struct ErrorResponse: Equatable, JsonEncodable {
 return GraphQLError(error)
 }
 }
 type = .error
 payload = graphQLErrors
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .error {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.error.type)`"
 ))
 }
 payload = try container.decode([GraphQLError].self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket response message types from the server to the client
enum ResponseMessageType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case error
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = ResponseMessageType(rawValue: value) ?? .unknown
public struct ResponseMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted response types in a non-breaking way.

 let type: ResponseType

 init(type: ResponseType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(ResponseType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionAck: Self = .init(type: .connectionAck)
 public static let next: Self = .init(type: .next)
 public static let complete: Self = .init(type: .complete)
 public static let error: Self = .init(type: .error)

 enum ResponseType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case complete
 case error
 }
}

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Makes all request & response types and fields public#8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

NeedleInAJayStack
merged 2 commits into

from

Jan 19, 2026
 Merged


Makes all request & response types and fields public
#8
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba57614

feat: Makes all request and response types and fields public


NeedleInAJayStack Jan 19, 2026
8d03422

test: Removes testable import


NeedleInAJayStack Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
Package.resolved

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
Sources/GraphQLTransportWS/Client.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,7 @@ public class Client<InitPayload: Equatable & Codable> {
 return
 }
 try await self.onComplete(completeResponse, self)
case .unknown:
default:
 try await self.error(.invalidType())
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
Sources/GraphQLTransportWS/GraphqlTransportWSError.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,14 +60,14 @@ struct GraphQLTransportWSError: Error {

 static func invalidRequestFormat(messageType: RequestMessageType) -> Self {
 return self.init(
 "Request message doesn't match '\(messageType.rawValue)' JSON format",
 "Request message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidRequestFormat
 )
 }

 static func invalidResponseFormat(messageType: ResponseMessageType) -> Self {
 return self.init(
 "Response message doesn't match '\(messageType.rawValue)' JSON format",
 "Response message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidResponseFormat
 )
 }
Expand Down

122 changes: 87 additions & 35 deletions
Sources/GraphQLTransportWS/Requests.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,53 +1,105 @@
import Foundation
import GraphQL

/// We also require that an 'authToken' field is provided in the 'payload' during the connection
/// init message. For example:
/// ```
/// {
/// "type": 'connection_init',
/// "payload": {
/// "authToken": "eyJhbGciOiJIUz..."
/// }
/// }
/// ```

/// A general request. This object's type is used to triage to other, more specific request objects.
struct Request: Equatable, JsonEncodable {
 let type: RequestMessageType
public struct Request: Equatable, JsonEncodable {
public let type: RequestMessageType
}

/// A websocket `connection_init` request from the client to the server
struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 var type = RequestMessageType.connectionInit
 let payload: InitPayload
public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 public let type: RequestMessageType = .connectionInit
 public let payload: InitPayload

 public init(payload: InitPayload) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .connectionInit {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.connectionInit.type)`"
 ))
 }
 payload = try container.decode(InitPayload.self, forKey: .payload)
 }
}

/// A websocket `subscribe` request from the client to the server
struct SubscribeRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.subscribe
 let payload: GraphQLRequest
 let id: String
public struct SubscribeRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.subscribe
 public let payload: GraphQLRequest
 public let id: String

 public init(payload: GraphQLRequest, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .subscribe {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.subscribe.type)`"
 ))
 }
 payload = try container.decode(GraphQLRequest.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` request from the client to the server
struct CompleteRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.complete
 let id: String
public struct CompleteRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.complete
 public let id: String

 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket request message types from the client to the server
enum RequestMessageType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = RequestMessageType(rawValue: value) ?? .unknown
public struct RequestMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted request types in a non-breaking way.

 let type: RequestType

 init(type: RequestType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(RequestType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionInit: Self = .init(type: .connectionInit)
 public static let subscribe: Self = .init(type: .subscribe)
 public static let complete: Self = .init(type: .complete)

 enum RequestType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 }
}

111 changes: 85 additions & 26 deletions
Sources/GraphQLTransportWS/Responses.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,48 +2,79 @@ import Foundation
import GraphQL

/// A general response. This object's type is used to triage to other, more specific response objects.
struct Response: Equatable, JsonEncodable {
 let type: ResponseMessageType
public struct Response: Equatable, JsonEncodable {
public let type: ResponseMessageType
}

/// A websocket `connection_ack` response from the server to the client
public struct ConnectionAckResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .connectionAck
 public let payload: [String: Map]?

 init(_ payload: [String: Map]? = nil) {
 type = .connectionAck
 public init(payload: [String: Map]? = nil) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .connectionAck {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.connectionAck.type)`"
 ))
 }
 payload = try container.decodeIfPresent([String: Map].self, forKey: .payload)
 }
}

/// A websocket `next` response from the server to the client
public struct NextResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .next
 public let payload: GraphQLResult?
 public let id: String

 init(_ payload: GraphQLResult? = nil, id: String) {
 type = .next
 public init(payload: GraphQLResult?, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .next {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.next.type)`"
 ))
 }
 payload = try container.decodeIfPresent(GraphQLResult.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` response from the server to the client
public struct CompleteResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .complete
 public let id: String

 init(id: String) {
 type = .complete
 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `error` response from the server to the client
public struct ErrorResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .error
 public let payload: [GraphQLError]
 public let id: String

Expand All@@ -56,26 +87,54 @@ public struct ErrorResponse: Equatable, JsonEncodable {
 return GraphQLError(error)
 }
 }
 type = .error
 payload = graphQLErrors
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .error {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.error.type)`"
 ))
 }
 payload = try container.decode([GraphQLError].self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket response message types from the server to the client
enum ResponseMessageType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case error
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = ResponseMessageType(rawValue: value) ?? .unknown
public struct ResponseMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted response types in a non-breaking way.

 let type: ResponseType

 init(type: ResponseType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(ResponseType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionAck: Self = .init(type: .connectionAck)
 public static let next: Self = .init(type: .next)
 public static let complete: Self = .init(type: .complete)
 public static let error: Self = .init(type: .error)

 enum ResponseType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case complete
 case error
 }
}

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Makes all request & response types and fields public#8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

NeedleInAJayStack
merged 2 commits into

from

Jan 19, 2026
 Merged


Makes all request & response types and fields public
#8
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba57614

feat: Makes all request and response types and fields public


NeedleInAJayStack Jan 19, 2026
8d03422

test: Removes testable import


NeedleInAJayStack Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
Package.resolved

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
Sources/GraphQLTransportWS/Client.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,7 @@ public class Client<InitPayload: Equatable & Codable> {
 return
 }
 try await self.onComplete(completeResponse, self)
case .unknown:
default:
 try await self.error(.invalidType())
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
Sources/GraphQLTransportWS/GraphqlTransportWSError.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,14 +60,14 @@ struct GraphQLTransportWSError: Error {

 static func invalidRequestFormat(messageType: RequestMessageType) -> Self {
 return self.init(
 "Request message doesn't match '\(messageType.rawValue)' JSON format",
 "Request message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidRequestFormat
 )
 }

 static func invalidResponseFormat(messageType: ResponseMessageType) -> Self {
 return self.init(
 "Response message doesn't match '\(messageType.rawValue)' JSON format",
 "Response message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidResponseFormat
 )
 }
Expand Down

122 changes: 87 additions & 35 deletions
Sources/GraphQLTransportWS/Requests.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,53 +1,105 @@
import Foundation
import GraphQL

/// We also require that an 'authToken' field is provided in the 'payload' during the connection
/// init message. For example:
/// ```
/// {
/// "type": 'connection_init',
/// "payload": {
/// "authToken": "eyJhbGciOiJIUz..."
/// }
/// }
/// ```

/// A general request. This object's type is used to triage to other, more specific request objects.
struct Request: Equatable, JsonEncodable {
 let type: RequestMessageType
public struct Request: Equatable, JsonEncodable {
public let type: RequestMessageType
}

/// A websocket `connection_init` request from the client to the server
struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 var type = RequestMessageType.connectionInit
 let payload: InitPayload
public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 public let type: RequestMessageType = .connectionInit
 public let payload: InitPayload

 public init(payload: InitPayload) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .connectionInit {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.connectionInit.type)`"
 ))
 }
 payload = try container.decode(InitPayload.self, forKey: .payload)
 }
}

/// A websocket `subscribe` request from the client to the server
struct SubscribeRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.subscribe
 let payload: GraphQLRequest
 let id: String
public struct SubscribeRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.subscribe
 public let payload: GraphQLRequest
 public let id: String

 public init(payload: GraphQLRequest, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .subscribe {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.subscribe.type)`"
 ))
 }
 payload = try container.decode(GraphQLRequest.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` request from the client to the server
struct CompleteRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.complete
 let id: String
public struct CompleteRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.complete
 public let id: String

 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket request message types from the client to the server
enum RequestMessageType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = RequestMessageType(rawValue: value) ?? .unknown
public struct RequestMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted request types in a non-breaking way.

 let type: RequestType

 init(type: RequestType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(RequestType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionInit: Self = .init(type: .connectionInit)
 public static let subscribe: Self = .init(type: .subscribe)
 public static let complete: Self = .init(type: .complete)

 enum RequestType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 }
}

111 changes: 85 additions & 26 deletions
Sources/GraphQLTransportWS/Responses.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,48 +2,79 @@ import Foundation
import GraphQL

/// A general response. This object's type is used to triage to other, more specific response objects.
struct Response: Equatable, JsonEncodable {
 let type: ResponseMessageType
public struct Response: Equatable, JsonEncodable {
public let type: ResponseMessageType
}

/// A websocket `connection_ack` response from the server to the client
public struct ConnectionAckResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .connectionAck
 public let payload: [String: Map]?

 init(_ payload: [String: Map]? = nil) {
 type = .connectionAck
 public init(payload: [String: Map]? = nil) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .connectionAck {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.connectionAck.type)`"
 ))
 }
 payload = try container.decodeIfPresent([String: Map].self, forKey: .payload)
 }
}

/// A websocket `next` response from the server to the client
public struct NextResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .next
 public let payload: GraphQLResult?
 public let id: String

 init(_ payload: GraphQLResult? = nil, id: String) {
 type = .next
 public init(payload: GraphQLResult?, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .next {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.next.type)`"
 ))
 }
 payload = try container.decodeIfPresent(GraphQLResult.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` response from the server to the client
public struct CompleteResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .complete
 public let id: String

 init(id: String) {
 type = .complete
 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `error` response from the server to the client
public struct ErrorResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .error
 public let payload: [GraphQLError]
 public let id: String

Expand All@@ -56,26 +87,54 @@ public struct ErrorResponse: Equatable, JsonEncodable {
 return GraphQLError(error)
 }
 }
 type = .error
 payload = graphQLErrors
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .error {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.error.type)`"
 ))
 }
 payload = try container.decode([GraphQLError].self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket response message types from the server to the client
enum ResponseMessageType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case error
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = ResponseMessageType(rawValue: value) ?? .unknown
public struct ResponseMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted response types in a non-breaking way.

 let type: ResponseType

 init(type: ResponseType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(ResponseType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionAck: Self = .init(type: .connectionAck)
 public static let next: Self = .init(type: .next)
 public static let complete: Self = .init(type: .complete)
 public static let error: Self = .init(type: .error)

 enum ResponseType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case complete
 case error
 }
}

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Makes all request & response types and fields public#8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

NeedleInAJayStack
merged 2 commits into

from

Jan 19, 2026
 Merged


Makes all request & response types and fields public
#8
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba57614

feat: Makes all request and response types and fields public


NeedleInAJayStack Jan 19, 2026
8d03422

test: Removes testable import


NeedleInAJayStack Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
Package.resolved

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
Sources/GraphQLTransportWS/Client.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,7 @@ public class Client<InitPayload: Equatable & Codable> {
 return
 }
 try await self.onComplete(completeResponse, self)
case .unknown:
default:
 try await self.error(.invalidType())
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
Sources/GraphQLTransportWS/GraphqlTransportWSError.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,14 +60,14 @@ struct GraphQLTransportWSError: Error {

 static func invalidRequestFormat(messageType: RequestMessageType) -> Self {
 return self.init(
 "Request message doesn't match '\(messageType.rawValue)' JSON format",
 "Request message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidRequestFormat
 )
 }

 static func invalidResponseFormat(messageType: ResponseMessageType) -> Self {
 return self.init(
 "Response message doesn't match '\(messageType.rawValue)' JSON format",
 "Response message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidResponseFormat
 )
 }
Expand Down

122 changes: 87 additions & 35 deletions
Sources/GraphQLTransportWS/Requests.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,53 +1,105 @@
import Foundation
import GraphQL

/// We also require that an 'authToken' field is provided in the 'payload' during the connection
/// init message. For example:
/// ```
/// {
/// "type": 'connection_init',
/// "payload": {
/// "authToken": "eyJhbGciOiJIUz..."
/// }
/// }
/// ```

/// A general request. This object's type is used to triage to other, more specific request objects.
struct Request: Equatable, JsonEncodable {
 let type: RequestMessageType
public struct Request: Equatable, JsonEncodable {
public let type: RequestMessageType
}

/// A websocket `connection_init` request from the client to the server
struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 var type = RequestMessageType.connectionInit
 let payload: InitPayload
public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 public let type: RequestMessageType = .connectionInit
 public let payload: InitPayload

 public init(payload: InitPayload) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .connectionInit {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.connectionInit.type)`"
 ))
 }
 payload = try container.decode(InitPayload.self, forKey: .payload)
 }
}

/// A websocket `subscribe` request from the client to the server
struct SubscribeRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.subscribe
 let payload: GraphQLRequest
 let id: String
public struct SubscribeRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.subscribe
 public let payload: GraphQLRequest
 public let id: String

 public init(payload: GraphQLRequest, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .subscribe {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.subscribe.type)`"
 ))
 }
 payload = try container.decode(GraphQLRequest.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` request from the client to the server
struct CompleteRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.complete
 let id: String
public struct CompleteRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.complete
 public let id: String

 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket request message types from the client to the server
enum RequestMessageType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = RequestMessageType(rawValue: value) ?? .unknown
public struct RequestMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted request types in a non-breaking way.

 let type: RequestType

 init(type: RequestType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(RequestType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionInit: Self = .init(type: .connectionInit)
 public static let subscribe: Self = .init(type: .subscribe)
 public static let complete: Self = .init(type: .complete)

 enum RequestType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 }
}

111 changes: 85 additions & 26 deletions
Sources/GraphQLTransportWS/Responses.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,48 +2,79 @@ import Foundation
import GraphQL

/// A general response. This object's type is used to triage to other, more specific response objects.
struct Response: Equatable, JsonEncodable {
 let type: ResponseMessageType
public struct Response: Equatable, JsonEncodable {
public let type: ResponseMessageType
}

/// A websocket `connection_ack` response from the server to the client
public struct ConnectionAckResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .connectionAck
 public let payload: [String: Map]?

 init(_ payload: [String: Map]? = nil) {
 type = .connectionAck
 public init(payload: [String: Map]? = nil) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .connectionAck {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.connectionAck.type)`"
 ))
 }
 payload = try container.decodeIfPresent([String: Map].self, forKey: .payload)
 }
}

/// A websocket `next` response from the server to the client
public struct NextResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .next
 public let payload: GraphQLResult?
 public let id: String

 init(_ payload: GraphQLResult? = nil, id: String) {
 type = .next
 public init(payload: GraphQLResult?, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .next {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.next.type)`"
 ))
 }
 payload = try container.decodeIfPresent(GraphQLResult.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` response from the server to the client
public struct CompleteResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .complete
 public let id: String

 init(id: String) {
 type = .complete
 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `error` response from the server to the client
public struct ErrorResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .error
 public let payload: [GraphQLError]
 public let id: String

Expand All@@ -56,26 +87,54 @@ public struct ErrorResponse: Equatable, JsonEncodable {
 return GraphQLError(error)
 }
 }
 type = .error
 payload = graphQLErrors
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .error {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.error.type)`"
 ))
 }
 payload = try container.decode([GraphQLError].self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket response message types from the server to the client
enum ResponseMessageType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case error
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = ResponseMessageType(rawValue: value) ?? .unknown
public struct ResponseMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted response types in a non-breaking way.

 let type: ResponseType

 init(type: ResponseType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(ResponseType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionAck: Self = .init(type: .connectionAck)
 public static let next: Self = .init(type: .next)
 public static let complete: Self = .init(type: .complete)
 public static let error: Self = .init(type: .error)

 enum ResponseType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case complete
 case error
 }
}

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Makes all request & response types and fields public#8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

NeedleInAJayStack
merged 2 commits into

from

Jan 19, 2026
 Merged


Makes all request & response types and fields public
#8
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba57614

feat: Makes all request and response types and fields public


NeedleInAJayStack Jan 19, 2026
8d03422

test: Removes testable import


NeedleInAJayStack Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
Package.resolved

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
Sources/GraphQLTransportWS/Client.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,7 @@ public class Client<InitPayload: Equatable & Codable> {
 return
 }
 try await self.onComplete(completeResponse, self)
case .unknown:
default:
 try await self.error(.invalidType())
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
Sources/GraphQLTransportWS/GraphqlTransportWSError.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,14 +60,14 @@ struct GraphQLTransportWSError: Error {

 static func invalidRequestFormat(messageType: RequestMessageType) -> Self {
 return self.init(
 "Request message doesn't match '\(messageType.rawValue)' JSON format",
 "Request message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidRequestFormat
 )
 }

 static func invalidResponseFormat(messageType: ResponseMessageType) -> Self {
 return self.init(
 "Response message doesn't match '\(messageType.rawValue)' JSON format",
 "Response message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidResponseFormat
 )
 }
Expand Down

122 changes: 87 additions & 35 deletions
Sources/GraphQLTransportWS/Requests.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,53 +1,105 @@
import Foundation
import GraphQL

/// We also require that an 'authToken' field is provided in the 'payload' during the connection
/// init message. For example:
/// ```
/// {
/// "type": 'connection_init',
/// "payload": {
/// "authToken": "eyJhbGciOiJIUz..."
/// }
/// }
/// ```

/// A general request. This object's type is used to triage to other, more specific request objects.
struct Request: Equatable, JsonEncodable {
 let type: RequestMessageType
public struct Request: Equatable, JsonEncodable {
public let type: RequestMessageType
}

/// A websocket `connection_init` request from the client to the server
struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 var type = RequestMessageType.connectionInit
 let payload: InitPayload
public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 public let type: RequestMessageType = .connectionInit
 public let payload: InitPayload

 public init(payload: InitPayload) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .connectionInit {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.connectionInit.type)`"
 ))
 }
 payload = try container.decode(InitPayload.self, forKey: .payload)
 }
}

/// A websocket `subscribe` request from the client to the server
struct SubscribeRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.subscribe
 let payload: GraphQLRequest
 let id: String
public struct SubscribeRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.subscribe
 public let payload: GraphQLRequest
 public let id: String

 public init(payload: GraphQLRequest, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .subscribe {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.subscribe.type)`"
 ))
 }
 payload = try container.decode(GraphQLRequest.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` request from the client to the server
struct CompleteRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.complete
 let id: String
public struct CompleteRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.complete
 public let id: String

 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket request message types from the client to the server
enum RequestMessageType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = RequestMessageType(rawValue: value) ?? .unknown
public struct RequestMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted request types in a non-breaking way.

 let type: RequestType

 init(type: RequestType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(RequestType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionInit: Self = .init(type: .connectionInit)
 public static let subscribe: Self = .init(type: .subscribe)
 public static let complete: Self = .init(type: .complete)

 enum RequestType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 }
}

111 changes: 85 additions & 26 deletions
Sources/GraphQLTransportWS/Responses.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,48 +2,79 @@ import Foundation
import GraphQL

/// A general response. This object's type is used to triage to other, more specific response objects.
struct Response: Equatable, JsonEncodable {
 let type: ResponseMessageType
public struct Response: Equatable, JsonEncodable {
public let type: ResponseMessageType
}

/// A websocket `connection_ack` response from the server to the client
public struct ConnectionAckResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .connectionAck
 public let payload: [String: Map]?

 init(_ payload: [String: Map]? = nil) {
 type = .connectionAck
 public init(payload: [String: Map]? = nil) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .connectionAck {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.connectionAck.type)`"
 ))
 }
 payload = try container.decodeIfPresent([String: Map].self, forKey: .payload)
 }
}

/// A websocket `next` response from the server to the client
public struct NextResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .next
 public let payload: GraphQLResult?
 public let id: String

 init(_ payload: GraphQLResult? = nil, id: String) {
 type = .next
 public init(payload: GraphQLResult?, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .next {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.next.type)`"
 ))
 }
 payload = try container.decodeIfPresent(GraphQLResult.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` response from the server to the client
public struct CompleteResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .complete
 public let id: String

 init(id: String) {
 type = .complete
 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `error` response from the server to the client
public struct ErrorResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .error
 public let payload: [GraphQLError]
 public let id: String

Expand All@@ -56,26 +87,54 @@ public struct ErrorResponse: Equatable, JsonEncodable {
 return GraphQLError(error)
 }
 }
 type = .error
 payload = graphQLErrors
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .error {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.error.type)`"
 ))
 }
 payload = try container.decode([GraphQLError].self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket response message types from the server to the client
enum ResponseMessageType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case error
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = ResponseMessageType(rawValue: value) ?? .unknown
public struct ResponseMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted response types in a non-breaking way.

 let type: ResponseType

 init(type: ResponseType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(ResponseType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionAck: Self = .init(type: .connectionAck)
 public static let next: Self = .init(type: .next)
 public static let complete: Self = .init(type: .complete)
 public static let error: Self = .init(type: .error)

 enum ResponseType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case complete
 case error
 }
}

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Makes all request & response types and fields public#8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

NeedleInAJayStack
merged 2 commits into

from

Jan 19, 2026
 Merged


Makes all request & response types and fields public
#8
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
ba57614

feat: Makes all request and response types and fields public


NeedleInAJayStack Jan 19, 2026
8d03422

test: Removes testable import


NeedleInAJayStack Jan 19, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


61 changes: 31 additions & 30 deletions
Package.resolved

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


2 changes: 1 addition & 1 deletion
Sources/GraphQLTransportWS/Client.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,7 @@ public class Client<InitPayload: Equatable & Codable> {
 return
 }
 try await self.onComplete(completeResponse, self)
case .unknown:
default:
 try await self.error(.invalidType())
 }
 }
Expand Down

4 changes: 2 additions & 2 deletions
Sources/GraphQLTransportWS/GraphqlTransportWSError.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,14 +60,14 @@ struct GraphQLTransportWSError: Error {

 static func invalidRequestFormat(messageType: RequestMessageType) -> Self {
 return self.init(
 "Request message doesn't match '\(messageType.rawValue)' JSON format",
 "Request message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidRequestFormat
 )
 }

 static func invalidResponseFormat(messageType: ResponseMessageType) -> Self {
 return self.init(
 "Response message doesn't match '\(messageType.rawValue)' JSON format",
 "Response message doesn't match '\(messageType.type.rawValue)' JSON format",
 code: .invalidResponseFormat
 )
 }
Expand Down

122 changes: 87 additions & 35 deletions
Sources/GraphQLTransportWS/Requests.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,53 +1,105 @@
import Foundation
import GraphQL

/// We also require that an 'authToken' field is provided in the 'payload' during the connection
/// init message. For example:
/// ```
/// {
/// "type": 'connection_init',
/// "payload": {
/// "authToken": "eyJhbGciOiJIUz..."
/// }
/// }
/// ```

/// A general request. This object's type is used to triage to other, more specific request objects.
struct Request: Equatable, JsonEncodable {
 let type: RequestMessageType
public struct Request: Equatable, JsonEncodable {
public let type: RequestMessageType
}

/// A websocket `connection_init` request from the client to the server
struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 var type = RequestMessageType.connectionInit
 let payload: InitPayload
public struct ConnectionInitRequest<InitPayload: Codable & Equatable>: Equatable, JsonEncodable {
 public let type: RequestMessageType = .connectionInit
 public let payload: InitPayload

 public init(payload: InitPayload) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .connectionInit {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.connectionInit.type)`"
 ))
 }
 payload = try container.decode(InitPayload.self, forKey: .payload)
 }
}

/// A websocket `subscribe` request from the client to the server
struct SubscribeRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.subscribe
 let payload: GraphQLRequest
 let id: String
public struct SubscribeRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.subscribe
 public let payload: GraphQLRequest
 public let id: String

 public init(payload: GraphQLRequest, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .subscribe {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.subscribe.type)`"
 ))
 }
 payload = try container.decode(GraphQLRequest.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` request from the client to the server
struct CompleteRequest: Equatable, JsonEncodable {
 var type = RequestMessageType.complete
 let id: String
public struct CompleteRequest: Equatable, JsonEncodable {
 public let type = RequestMessageType.complete
 public let id: String

 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(RequestMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(RequestMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket request message types from the client to the server
enum RequestMessageType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = RequestMessageType(rawValue: value) ?? .unknown
public struct RequestMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted request types in a non-breaking way.

 let type: RequestType

 init(type: RequestType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(RequestType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionInit: Self = .init(type: .connectionInit)
 public static let subscribe: Self = .init(type: .subscribe)
 public static let complete: Self = .init(type: .complete)

 enum RequestType: String, Codable {
 case connectionInit = "connection_init"
 case subscribe
 case complete
 }
}

111 changes: 85 additions & 26 deletions
Sources/GraphQLTransportWS/Responses.swift

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,48 +2,79 @@ import Foundation
import GraphQL

/// A general response. This object's type is used to triage to other, more specific response objects.
struct Response: Equatable, JsonEncodable {
 let type: ResponseMessageType
public struct Response: Equatable, JsonEncodable {
public let type: ResponseMessageType
}

/// A websocket `connection_ack` response from the server to the client
public struct ConnectionAckResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .connectionAck
 public let payload: [String: Map]?

 init(_ payload: [String: Map]? = nil) {
 type = .connectionAck
 public init(payload: [String: Map]? = nil) {
 self.payload = payload
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .connectionAck {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.connectionAck.type)`"
 ))
 }
 payload = try container.decodeIfPresent([String: Map].self, forKey: .payload)
 }
}

/// A websocket `next` response from the server to the client
public struct NextResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .next
 public let payload: GraphQLResult?
 public let id: String

 init(_ payload: GraphQLResult? = nil, id: String) {
 type = .next
 public init(payload: GraphQLResult?, id: String) {
 self.payload = payload
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .next {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.next.type)`"
 ))
 }
 payload = try container.decodeIfPresent(GraphQLResult.self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `complete` response from the server to the client
public struct CompleteResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .complete
 public let id: String

 init(id: String) {
 type = .complete
 public init(id: String) {
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .complete {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.complete.type)`"
 ))
 }
 id = try container.decode(String.self, forKey: .id)
 }
}

/// A websocket `error` response from the server to the client
public struct ErrorResponse: Equatable, JsonEncodable {
 let type: ResponseMessageType
public let type: ResponseMessageType = .error
 public let payload: [GraphQLError]
 public let id: String

Expand All@@ -56,26 +87,54 @@ public struct ErrorResponse: Equatable, JsonEncodable {
 return GraphQLError(error)
 }
 }
 type = .error
 payload = graphQLErrors
 self.id = id
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.container(keyedBy: Self.CodingKeys.self)
 if try container.decode(ResponseMessageType.self, forKey: .type) != .error {
 throw DecodingError.dataCorrupted(.init(
 codingPath: decoder.codingPath,
 debugDescription: "type must be `\(ResponseMessageType.error.type)`"
 ))
 }
 payload = try container.decode([GraphQLError].self, forKey: .payload)
 id = try container.decode(String.self, forKey: .id)
 }
}

/// The supported websocket response message types from the server to the client
enum ResponseMessageType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case error
 case complete
 case unknown

 init(from decoder: Decoder) throws {
 guard let value = try? decoder.singleValueContainer().decode(String.self) else {
 self = .unknown
 return
 }
 self = ResponseMessageType(rawValue: value) ?? .unknown
public struct ResponseMessageType: Equatable, Codable, Sendable {
 // This is implemented as a struct with only public static properties, backed by an internal enum
 // in order to grow the list of accepted response types in a non-breaking way.

 let type: ResponseType

 init(type: ResponseType) {
 self.type = type
 }

 public init(from decoder: any Decoder) throws {
 let container = try decoder.singleValueContainer()
 type = try container.decode(ResponseType.self)
 }

 public func encode(to encoder: any Encoder) throws {
 var container = encoder.singleValueContainer()
 try container.encode(type)
 }

 public static let connectionAck: Self = .init(type: .connectionAck)
 public static let next: Self = .init(type: .next)
 public static let complete: Self = .init(type: .complete)
 public static let error: Self = .init(type: .error)

 enum ResponseType: String, Codable {
 case connectionAck = "connection_ack"
 case next
 case complete
 case error
 }
}

Expand Down
Loading