Rename some additional "bundle" API

Author: d-ronnqvist

Sources/SwiftDocC/DocumentationService/Convert/ConvertService+DataProvider.swift

@@ -38,7 +38,7 @@ extension ConvertService {
 
         return (
             DocumentationContext.Inputs(
-                info: request.bundleInfo,
+                info: request.info,
                 symbolGraphURLs: symbolGraphURLs,
                 markupURLs: markupFileURL,
                 miscResourceURLs: request.miscResourceURLs

Sources/SwiftDocC/DocumentationService/Convert/ConvertService.swift

@@ -128,7 +128,7 @@ public struct ConvertService: DocumentationService {
 
             if let linkResolvingServer {
                 let resolver = try OutOfProcessReferenceResolver(
-                    bundleID: request.bundleInfo.id,
+                    bundleID: request.info.id,
                     server: linkResolvingServer,
                     convertRequestIdentifier: messageIdentifier
                 )
@@ -141,11 +141,11 @@ public struct ConvertService: DocumentationService {
             let dataProvider: any DataProvider
 
             let inputProvider = DocumentationContext.InputsProvider()
-            if let bundleLocation = request.bundleLocation,
-               let catalogURL = try inputProvider.findCatalog(startingPoint: bundleLocation, allowArbitraryCatalogDirectories: allowArbitraryCatalogDirectories)
+            if let catalogLocation = request.catalogLocation,
+               let catalogURL = try inputProvider.findCatalog(startingPoint: catalogLocation, allowArbitraryCatalogDirectories: allowArbitraryCatalogDirectories)
             {
                 let bundleDiscoveryOptions = try CatalogDiscoveryOptions(
-                    fallbackInfo: request.bundleInfo,
+                    fallbackInfo: request.info,
                     additionalSymbolGraphFiles: []
                 )
 

Sources/SwiftDocC/DocumentationService/Models/Services/Convert/ConvertRequest.swift

@@ -16,8 +16,14 @@ public struct ConvertRequest: Codable {
     /// Information about the documentation catalog to convert.
     ///
     /// ## See Also
-    public var bundleInfo: DocumentationContext.Inputs.Info
     /// - ``DocumentationContext/Inputs/Info``
+    public var info: DocumentationContext.Inputs.Info
+    
+    @available(*, deprecated, renamed: "info", message: "Use 'info' instead. This deprecated API will be removed after 6.3 is released.")
+    public var bundleInfo: URL? {
+        get { catalogLocation }
+        set { catalogLocation = newValue }
+    }
 
     /// Feature flags to enable when performing this convert request.
     public var featureFlags: FeatureFlags
@@ -55,7 +61,13 @@ public struct ConvertRequest: Codable {
     public var includeRenderReferenceStore: Bool?
 
     /// The file location of the catalog to convert, if any.
-    public var bundleLocation: URL?
+    public var catalogLocation: URL?
+    
+    @available(*, deprecated, renamed: "catalogLocation", message: "Use 'catalogLocation' instead. This deprecated API will be removed after 6.3 is released.")
+    public var bundleLocation: URL? {
+        get { catalogLocation }
+        set { catalogLocation = newValue }
+    }
 
     /// The symbols graph data included in the documentation catalog to convert.
     ///
@@ -97,13 +109,13 @@ public struct ConvertRequest: Codable {
 
     /// Creates a request to convert in-memory documentation.
     /// - Parameters:
-    ///   - bundleInfo: Information about the catalog to convert.
+    ///   - info: Information about the catalog to convert.
     ///   - featureFlags: Feature flags to enable when performing this convert request.
     ///   - externalIDsToConvert: The external IDs of the symbols to convert.
     ///   - documentPathsToConvert: The paths of the documentation nodes to convert.
     ///   - includeRenderReferenceStore: Whether the conversion's render reference store should be included in the
     ///   response.
-    ///   - bundleLocation: The file location of the documentation catalog to convert, if any.
+    ///   - catalogLocation: The file location of the documentation catalog to convert, if any.
     ///   - symbolGraphs: The symbols graph data included in the documentation catalog to convert.
     ///   - overridingDocumentationComments: The mapping of external symbol identifiers to lines of a
     ///   documentation comment that overrides the value in the symbol graph.
@@ -116,12 +128,12 @@ public struct ConvertRequest: Codable {
     ///   - symbolIdentifiersWithExpandedDocumentation: A dictionary of identifiers to requirements for these symbols to have expanded
     ///   documentation available.
     public init(
-        bundleInfo: DocumentationContext.Inputs.Info,
+        info: DocumentationContext.Inputs.Info,
         featureFlags: FeatureFlags = FeatureFlags(),
         externalIDsToConvert: [String]?,
         documentPathsToConvert: [String]? = nil,
         includeRenderReferenceStore: Bool? = nil,
-        bundleLocation: URL? = nil,
+        catalogLocation: URL? = nil,
         symbolGraphs: [Data],
         overridingDocumentationComments: [String: [Line]]? = nil,
         knownDisambiguatedSymbolPathComponents: [String: [String]]? = nil,
@@ -134,7 +146,7 @@ public struct ConvertRequest: Codable {
         self.externalIDsToConvert = externalIDsToConvert
         self.documentPathsToConvert = documentPathsToConvert
         self.includeRenderReferenceStore = includeRenderReferenceStore
-        self.bundleLocation = bundleLocation
+        self.catalogLocation = catalogLocation
         self.symbolGraphs = symbolGraphs
         self.overridingDocumentationComments = overridingDocumentationComments
         self.knownDisambiguatedSymbolPathComponents = knownDisambiguatedSymbolPathComponents
@@ -148,10 +160,45 @@ public struct ConvertRequest: Codable {
         self.markupFiles = markupFiles
         self.tutorialFiles = tutorialFiles
         self.miscResourceURLs = miscResourceURLs
-        self.bundleInfo = bundleInfo
+        self.info = info
         self.featureFlags = featureFlags
         self.symbolIdentifiersWithExpandedDocumentation = symbolIdentifiersWithExpandedDocumentation
     }
+    
+    @available(*, deprecated, renamed: "init(info:featureFlags:externalIDsToConvert:documentPathsToConvert:includeRenderReferenceStore:catalogLocation:symbolGraphs:overridingDocumentationComments:knownDisambiguatedSymbolPathComponents:emitSymbolSourceFileURIs:markupFiles:tutorialFiles:miscResourceURLs:symbolIdentifiersWithExpandedDocumentation:)", message: "Use 'init(info:featureFlags:externalIDsToConvert:documentPathsToConvert:includeRenderReferenceStore:catalogLocation:symbolGraphs:overridingDocumentationComments:knownDisambiguatedSymbolPathComponents:emitSymbolSourceFileURIs:markupFiles:tutorialFiles:miscResourceURLs:symbolIdentifiersWithExpandedDocumentation:)' instead. This deprecated API will be removed after 6.3 is released.")
+    public init(
+        bundleInfo: DocumentationContext.Inputs.Info,
+        featureFlags: FeatureFlags = FeatureFlags(),
+        externalIDsToConvert: [String]?,
+        documentPathsToConvert: [String]? = nil,
+        includeRenderReferenceStore: Bool? = nil,
+        bundleLocation: URL? = nil,
+        symbolGraphs: [Data],
+        overridingDocumentationComments: [String: [Line]]? = nil,
+        knownDisambiguatedSymbolPathComponents: [String: [String]]? = nil,
+        emitSymbolSourceFileURIs: Bool = true,
+        markupFiles: [Data],
+        tutorialFiles: [Data] = [],
+        miscResourceURLs: [URL],
+        symbolIdentifiersWithExpandedDocumentation: [String: ExpandedDocumentationRequirements]? = nil
+    ) {
+        self.init(
+            info: bundleInfo,
+            featureFlags: featureFlags,
+            externalIDsToConvert: externalIDsToConvert,
+            documentPathsToConvert: documentPathsToConvert,
+            includeRenderReferenceStore: includeRenderReferenceStore,
+            catalogLocation: bundleLocation,
+            symbolGraphs: symbolGraphs,
+            overridingDocumentationComments: overridingDocumentationComments,
+            knownDisambiguatedSymbolPathComponents: knownDisambiguatedSymbolPathComponents,
+            emitSymbolSourceFileURIs: emitSymbolSourceFileURIs,
+            markupFiles: markupFiles,
+            tutorialFiles: tutorialFiles,
+            miscResourceURLs: miscResourceURLs,
+            symbolIdentifiersWithExpandedDocumentation: symbolIdentifiersWithExpandedDocumentation
+        )
+    }
 }
 
 extension ConvertRequest {

Sources/SwiftDocC/Infrastructure/DocumentationContext.swift

@@ -2003,7 +2003,7 @@ public class DocumentationContext {
                 hierarchyBasedResolver = signposter.withIntervalSignpost("Build PathHierarchy", id: signposter.makeSignpostID()) {
                     PathHierarchyBasedLinkResolver(pathHierarchy: PathHierarchy(
                         symbolGraphLoader: symbolGraphLoader,
-                        bundleName: urlReadablePath(inputs.displayName),
+                        catalogName: urlReadablePath(inputs.displayName),
                         knownDisambiguatedPathComponents: configuration.convertServiceConfiguration.knownDisambiguatedSymbolPathComponents
                     ))
                 }

Sources/SwiftDocC/Infrastructure/External Data/ExternalMetadata.swift

@@ -77,7 +77,13 @@ public struct ExternalMetadata {
     public var inheritDocs = false
 
     /// If `true`, there is no source catalog on disk and the inputs were passed via command line parameters.
-    public var isGeneratedBundle = false
+    public var isGeneratedCatalog = false
+    
+    @available(*, deprecated, renamed: "isGeneratedCatalog", message: "Use 'isGeneratedCatalog' instead. This deprecated API will be removed after 6.3 is released.")
+    public var isGeneratedBundle: Bool {
+        get { isGeneratedCatalog }
+        set { isGeneratedCatalog = newValue }
+    }
 
     /// The granularity of diagnostics to emit via the engine.
     public var diagnosticLevel: DiagnosticSeverity = .warning

Sources/SwiftDocC/Infrastructure/Input Discovery/DocumentationInputsProvider.swift

@@ -149,7 +149,7 @@ extension DocumentationContext.InputsProvider {
 
         let info = try DocumentationContext.Inputs.Info(
             from: infoPlistData,
-            bundleDiscoveryOptions: options,
+            catalogDiscoveryOptions: options,
             derivedDisplayName: url.deletingPathExtension().lastPathComponent
         )
 
@@ -215,7 +215,7 @@ extension DocumentationContext.InputsProvider {
         }
         let derivedDisplayName = moduleNames.count == 1 ? moduleNames.first : nil
 
-        let info = try DocumentationContext.Inputs.Info(bundleDiscoveryOptions: options, derivedDisplayName: derivedDisplayName)
+        let info = try DocumentationContext.Inputs.Info(catalogDiscoveryOptions: options, derivedDisplayName: derivedDisplayName)
 
         let topLevelPages: [URL]
         let provider: any DataProvider

Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy.swift

@@ -54,12 +54,12 @@ struct PathHierarchy {
     ///
     /// - Parameters:
     ///   - loader: The symbol graph loader that provides all symbols.
-    ///   - bundleName: The name of the documentation bundle, used as a container for articles and tutorials.
+    ///   - catalogName: The name of the documentation catalog, used as a container for articles and tutorials.
     ///   - moduleKindDisplayName: The display name for the "module" kind of symbol.
     ///   - knownDisambiguatedPathComponents: A list of path components with known required disambiguations.
     init(
         symbolGraphLoader loader: SymbolGraphLoader,
-        bundleName: String,
+        catalogName: String,
         moduleKindDisplayName: String = "Framework",
         knownDisambiguatedPathComponents: [String: [String]]? = nil
     ) {
@@ -420,8 +420,8 @@ struct PathHierarchy {
             lookup[id] = node
             return node
         }
-        self.articlesContainer = roots[bundleName] ?? newNode(bundleName)
-        self.tutorialContainer = newNode(bundleName)
+        self.articlesContainer = roots[catalogName] ?? newNode(catalogName)
+        self.tutorialContainer = newNode(catalogName)
         self.tutorialOverviewContainer = newNode("tutorials")
 
         assert(

Sources/SwiftDocC/Infrastructure/Workspace/DocumentationBundle+Info.swift

@@ -103,7 +103,7 @@ extension DocumentationContext.Inputs {
         /// Creates documentation information from the given Info.plist data, falling back to the values in the given discovery options if necessary.
         init(
             from infoPlist: Data? = nil,
-            bundleDiscoveryOptions options: CatalogDiscoveryOptions? = nil,
+            catalogDiscoveryOptions options: CatalogDiscoveryOptions? = nil,
             derivedDisplayName: String? = nil
         ) throws {
             if let infoPlist {
@@ -129,26 +129,26 @@ extension DocumentationContext.Inputs {
             } else {
                 try self.init(
                     with: nil,
-                    bundleDiscoveryOptions: options,
+                    catalogDiscoveryOptions: options,
                     derivedDisplayName: derivedDisplayName
                 )
             }
         }
 
         public init(from decoder: any Decoder) throws {
-            let bundleDiscoveryOptions = decoder.userInfo[.bundleDiscoveryOptions] as? CatalogDiscoveryOptions
+            let catalogDiscoveryOptions = decoder.userInfo[.bundleDiscoveryOptions] as? CatalogDiscoveryOptions
             let derivedDisplayName = decoder.userInfo[.derivedDisplayName] as? String
 
             try self.init(
                 with: decoder.container(keyedBy: CodingKeys.self),
-                bundleDiscoveryOptions: bundleDiscoveryOptions,
+                catalogDiscoveryOptions: catalogDiscoveryOptions,
                 derivedDisplayName: derivedDisplayName
             )
         }
 
         private init(
             with values: KeyedDecodingContainer<DocumentationContext.Inputs.Info.CodingKeys>?,
-            bundleDiscoveryOptions: CatalogDiscoveryOptions?,
+            catalogDiscoveryOptions: CatalogDiscoveryOptions?,
             derivedDisplayName: String?
         ) throws {
             // Here we define two helper functions that simplify
@@ -163,7 +163,7 @@ extension DocumentationContext.Inputs {
                 with key: CodingKeys
             ) throws -> T? where T : Decodable {
                 try values?.decodeIfPresent(T.self, forKey: key)
-                    ?? bundleDiscoveryOptions?.infoPlistFallbacks.decodeIfPresent(T.self, forKey: key.rawValue)
+                    ?? catalogDiscoveryOptions?.infoPlistFallbacks.decodeIfPresent(T.self, forKey: key.rawValue)
             }
 
             /// Helper function that decodes a value of the given type for the given key
@@ -172,9 +172,9 @@ extension DocumentationContext.Inputs {
                 _ expectedType: T.Type,
                 with key: CodingKeys
             ) throws -> T where T : Decodable {
-                if let bundleDiscoveryOptions {
+                if let catalogDiscoveryOptions {
                     return try values?.decodeIfPresent(T.self, forKey: key)
-                    ?? bundleDiscoveryOptions.infoPlistFallbacks.decode(T.self, forKey: key.rawValue)
+                    ?? catalogDiscoveryOptions.infoPlistFallbacks.decode(T.self, forKey: key.rawValue)
                 } else if let values {
                     return try values.decode(T.self, forKey: key)
                 } else {
@@ -189,7 +189,7 @@ extension DocumentationContext.Inputs {
             // **all** missing required keys, instead of just the first one hit.
 
             var givenKeys = Set(values?.allKeys ?? []).union(
-                bundleDiscoveryOptions?.infoPlistFallbacks.keys.compactMap {
+                catalogDiscoveryOptions?.infoPlistFallbacks.keys.compactMap {
                     CodingKeys(stringValue: $0)
                 } ?? []
             )