reform GitHub API namespaces

Author: tayloraswift

Sources/GitHubAPI/GitHub.API.swift

@@ -1,4 +1,4 @@
-extension GitHubOAuth
+extension GitHub.OAuth
 {
     @available(*, deprecated, renamed: "GitHub.API")
     public
@@ -13,10 +13,10 @@ extension GitHub
         public
         let agent:String
         public
-        let oauth:GitHubOAuth
+        let oauth:GitHub.OAuth
 
         @inlinable internal
-        init(agent:String, oauth:GitHubOAuth)
+        init(agent:String, oauth:GitHub.OAuth)
         {
             self.agent = agent
             self.oauth = oauth

Sources/GitHubAPI/GitHubApp.Credentials.swift renamed to Sources/GitHubAPI/GitHub.App.Credentials.swift

@@ -1,6 +1,6 @@
 import JSON
 
-extension GitHubApp
+extension GitHub.App
 {
     @frozen public
     struct Credentials:Equatable, Hashable, Sendable
@@ -18,7 +18,7 @@ extension GitHubApp
         }
     }
 }
-extension GitHubApp.Credentials:JSONObjectDecodable
+extension GitHub.App.Credentials:JSONObjectDecodable
 {
     public
     enum CodingKey:String, Sendable

Sources/GitHubAPI/GitHubApp.Token.swift renamed to Sources/GitHubAPI/GitHub.App.Token.swift

@@ -1,4 +1,4 @@
-extension GitHubApp
+extension GitHub.App
 {
     @frozen public
     struct Token:Equatable, Hashable, Sendable

Sources/GitHubAPI/GitHub.App.swift

@@ -0,0 +1,24 @@
+extension GitHub
+{
+    /// The essence of a GitHub App, which is a type of GitHub application.
+    @frozen public
+    struct App:GitHubApplication, Identifiable
+    {
+        /// The app id number. This is different from the client id.
+        public
+        let id:Int?
+
+        public
+        let client:String
+        public
+        let secret:String
+
+        @inlinable public
+        init(_ id:Int?, client:String, secret:String)
+        {
+            self.id = id
+            self.client = client
+            self.secret = secret
+        }
+    }
+}

Sources/GitHubAPI/GitHubOAuth.Credentials.swift renamed to Sources/GitHubAPI/GitHub.OAuth.Credentials.swift

@@ -1,6 +1,6 @@
 import JSON
 
-extension GitHubOAuth
+extension GitHub.OAuth
 {
     @frozen public
     struct Credentials
@@ -18,7 +18,7 @@ extension GitHubOAuth
         }
     }
 }
-extension GitHubOAuth.Credentials:JSONObjectDecodable
+extension GitHub.OAuth.Credentials:JSONObjectDecodable
 {
     public
     enum CodingKey:String, Sendable

Sources/GitHubAPI/GitHub.OAuth.swift

@@ -0,0 +1,31 @@
+extension GitHub
+{
+    /// The essence of a GitHub OAuth application.
+    ///
+    /// A `GitHub.OAuth` instance is just a ``client`` ID and ``secret``.
+    ///
+    /// >   Note:
+    /// This type would be named `GitHub.OAuthApp`, but then ``GitHub.App`` would have to be
+    /// named ``GitHub.AppApp``, and that would just be stupid.
+    @frozen public
+    struct OAuth:GitHubApplication
+    {
+        public
+        let client:String
+        public
+        let secret:String
+
+        @inlinable public
+        init(client:String, secret:String)
+        {
+            self.client = client
+            self.secret = secret
+        }
+    }
+}
+extension GitHub.OAuth
+{
+    /// The GitHub API.
+    @inlinable public
+    var api:GitHub.API { .init(agent: "swift-unidoc (by tayloraswift)", oauth: self) }
+}

Sources/GitHubAPI/GitHub.RateLimitError.swift

@@ -0,0 +1,15 @@
+import UnixTime
+
+extension GitHub
+{
+    public
+    typealias RateLimitError = _GitHubRateLimitError
+}
+
+/// The name of this protocol is ``GitHub.RateLimitError``.
+public
+protocol _GitHubRateLimitError:Error, Equatable, Sendable
+{
+    /// The UTC epoch second when the rate limit will reset.
+    var until:UnixInstant { get }
+}

Sources/GitHubAPI/GitHubApp.swift

@@ -1,4 +1,4 @@
-/// The essence of a GitHub application. Not to be confused with ``GitHubApp``.
+/// The essence of a GitHub application. Not to be confused with ``GitHub.App``.
 public
 protocol GitHubApplication<Credentials>:Equatable, Hashable, Sendable
 {