Rename documentation bundle to documentation inputs

Author: d-ronnqvist

Sources/SwiftDocC/Converter/DocumentationContextConverter.swift

@@ -20,8 +20,8 @@ public class DocumentationContextConverter {
     /// The context the converter uses to resolve references it finds in the documentation node's content.
     let context: DocumentationContext
 
-    /// The bundle that contains the content from which the documentation node originated.
-    let bundle: DocumentationBundle
+    /// The input files that contains the content from which the documentation node originated.
+    let inputs: DocumentationContext.Inputs
 
     /// A context that contains common pre-rendered pieces of content.
     let renderContext: RenderContext
@@ -48,7 +48,7 @@ public class DocumentationContextConverter {
     /// The converter uses bundle and context to resolve references to other documentation and describe the documentation hierarchy.
     ///
     /// - Parameters:
-    ///   - bundle: The bundle that contains the content from which the documentation node originated.
+    ///   - inputs: The inputs files that the documentation node originated from.
     ///   - context: The context that the converter uses to to resolve references it finds in the documentation node's content.
     ///   - renderContext: A context that contains common pre-rendered pieces of content.
     ///   - emitSymbolSourceFileURIs: Whether the documentation converter should include
@@ -61,15 +61,15 @@ public class DocumentationContextConverter {
     ///   - sourceRepository: The source repository where the documentation's sources are hosted.
     ///   - symbolIdentifiersWithExpandedDocumentation: A list of symbol IDs that have version of their documentation page with more content that a renderer can link to.
     public init(
-        bundle: DocumentationBundle,
+        inputs: DocumentationContext.Inputs,
         context: DocumentationContext,
         renderContext: RenderContext,
         emitSymbolSourceFileURIs: Bool = false,
         emitSymbolAccessLevels: Bool = false,
         sourceRepository: SourceRepository? = nil,
         symbolIdentifiersWithExpandedDocumentation: [String]? = nil
     ) {
-        self.bundle = bundle
+        self.inputs = inputs
         self.context = context
         self.renderContext = renderContext
         self.shouldEmitSymbolSourceFileURIs = emitSymbolSourceFileURIs
@@ -78,6 +78,27 @@ public class DocumentationContextConverter {
         self.symbolIdentifiersWithExpandedDocumentation = symbolIdentifiersWithExpandedDocumentation
     }
 
+    @available(*, deprecated, renamed: "init(inputs:context:renderContext:emitSymbolSourceFileURIs:emitSymbolAccessLevels:sourceRepository:symbolIdentifiersWithExpandedDocumentation:)", message: "Use 'init(inputs:context:renderContext:emitSymbolSourceFileURIs:emitSymbolAccessLevels:sourceRepository:symbolIdentifiersWithExpandedDocumentation:)' instead. This deprecated API will be removed after 6.3 is released")
+    public convenience init(
+        bundle: DocumentationBundle,
+        context: DocumentationContext,
+        renderContext: RenderContext,
+        emitSymbolSourceFileURIs: Bool = false,
+        emitSymbolAccessLevels: Bool = false,
+        sourceRepository: SourceRepository? = nil,
+        symbolIdentifiersWithExpandedDocumentation: [String]? = nil
+    ) {
+        self.init(
+            inputs: bundle,
+            context: context,
+            renderContext: renderContext,
+            emitSymbolSourceFileURIs: emitSymbolSourceFileURIs,
+            emitSymbolAccessLevels: emitSymbolAccessLevels,
+            sourceRepository: sourceRepository,
+            symbolIdentifiersWithExpandedDocumentation: symbolIdentifiersWithExpandedDocumentation
+        )
+    }
+    
     /// Converts a documentation node to a render node.
     ///
     /// Convert a documentation node into a render node to get a self-contained, persist-able representation of a given topic's data, so you can write it to disk, send it over a network, or otherwise process it.
@@ -91,7 +112,7 @@ public class DocumentationContextConverter {
 
         var translator = RenderNodeTranslator(
             context: context,
-            bundle: bundle,
+            inputs: inputs,
             identifier: node.reference,
             renderContext: renderContext,
             emitSymbolSourceFileURIs: shouldEmitSymbolSourceFileURIs,

Sources/SwiftDocC/Converter/DocumentationNodeConverter.swift

@@ -15,29 +15,34 @@ public struct DocumentationNodeConverter {
     /// The context the converter uses to resolve references it finds in the documentation node's content.
     let context: DocumentationContext
 
-    /// The bundle that contains the content from which the documentation node originated.
-    let bundle: DocumentationBundle
+    /// The input files that contains the content from which the documentation node originated.
+    let inputs: DocumentationContext.Inputs
 
     /// Creates a new node converter for the given bundle and context.
     ///
     /// The converter uses bundle and context to resolve references to other documentation and describe the documentation hierarchy.
     ///
     /// - Parameters:
-    ///   - bundle: The bundle that contains the content from which the documentation node originated.
+    ///   - inputs: The input files that contains the content from which the documentation node originated.
     ///   - context: The context that the converter uses to to resolve references it finds in the documentation node's content.
-    public init(bundle: DocumentationBundle, context: DocumentationContext) {
-        self.bundle = bundle
+    public init(inputs: DocumentationContext.Inputs, context: DocumentationContext) {
+        self.inputs = inputs
         self.context = context
     }
 
+    @available(*, deprecated, renamed: "init(inputs:context:)", message: "Use 'init(inputs:context:)' instead. This deprecated API will be removed after 6.3 is released")
+    public init(bundle: DocumentationBundle, context: DocumentationContext) {
+        self.init(inputs: bundle, context: context)
+    }
+    
     /// Converts a documentation node to a render node.
     ///
     /// Convert a documentation node into a render node to get a self-contained, persistable representation of a given topic's data, so you can write it to disk, send it over a network, or otherwise process it.
     /// - Parameters:
     ///   - node: The documentation node to convert.
     /// - Returns: The render node representation of the documentation node.
     public func convert(_ node: DocumentationNode) -> RenderNode {
-        var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: node.reference)
+        var translator = RenderNodeTranslator(context: context, inputs: inputs, identifier: node.reference)
         return translator.visit(node.semantic) as! RenderNode
     }
 }

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

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
+ Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -12,7 +12,7 @@ import Foundation
 
 extension ConvertService {
     /// Creates a bundle and an associated in-memory data provider from the information of a given convert request
-    static func makeBundleAndInMemoryDataProvider(_ request: ConvertRequest) -> (bundle: DocumentationBundle, provider: InMemoryDataProvider) {
+    static func makeBundleAndInMemoryDataProvider(_ request: ConvertRequest) -> (inputs: DocumentationContext.Inputs, provider: InMemoryDataProvider) {
         var files: [URL: Data] = [:]
         files.reserveCapacity(
               request.symbolGraphs.count
@@ -21,10 +21,10 @@ extension ConvertService {
             + request.miscResourceURLs.count
         )
         for markupFile in request.markupFiles {
-            files[makeURL().appendingPathExtension(DocumentationBundleFileTypes.referenceFileExtension)] = markupFile
+            files[makeURL().appendingPathExtension(DocumentationInputFileTypes.referenceFileExtension)] = markupFile
         }
         for tutorialFile in request.tutorialFiles {
-            files[makeURL().appendingPathExtension(DocumentationBundleFileTypes.tutorialFileExtension)] = tutorialFile
+            files[makeURL().appendingPathExtension(DocumentationInputFileTypes.tutorialFileExtension)] = tutorialFile
         }
         let markupFileURL = Array(files.keys)
 
@@ -37,7 +37,7 @@ extension ConvertService {
         }
 
         return (
-            DocumentationBundle(
+            DocumentationContext.Inputs(
                 info: request.bundleInfo,
                 symbolGraphURLs: symbolGraphURLs,
                 markupURLs: markupFileURL,

Sources/SwiftDocC/DocumentationService/Convert/ConvertService.swift

@@ -137,7 +137,7 @@ public struct ConvertService: DocumentationService {
                 configuration.externalDocumentationConfiguration.globalSymbolResolver = resolver
             }
 
-            let bundle: DocumentationBundle
+            let inputs: DocumentationContext.Inputs
             let dataProvider: any DataProvider
 
             let inputProvider = DocumentationContext.InputsProvider()
@@ -149,16 +149,16 @@ public struct ConvertService: DocumentationService {
                     additionalSymbolGraphFiles: []
                 )
 
-                bundle = try inputProvider.makeInputs(contentOf: catalogURL, options: bundleDiscoveryOptions)
+                inputs = try inputProvider.makeInputs(contentOf: catalogURL, options: bundleDiscoveryOptions)
                 dataProvider = FileManager.default
             } else {
-                (bundle, dataProvider) = Self.makeBundleAndInMemoryDataProvider(request)
+                (inputs, dataProvider) = Self.makeBundleAndInMemoryDataProvider(request)
             }
 
-            let context = try await DocumentationContext(bundle: bundle, dataProvider: dataProvider, configuration: configuration)
+            let context = try await DocumentationContext(inputs: inputs, dataProvider: dataProvider, configuration: configuration)
 
             // Precompute the render context
-            let renderContext = RenderContext(documentationContext: context, bundle: bundle)
+            let renderContext = RenderContext(documentationContext: context, inputs: inputs)
 
             let symbolIdentifiersMeetingRequirementsForExpandedDocumentation: [String]? = request.symbolIdentifiersWithExpandedDocumentation?.compactMap { identifier, expandedDocsRequirement in
                 guard let documentationNode = context.documentationCache[identifier] else {
@@ -168,7 +168,7 @@ public struct ConvertService: DocumentationService {
                 return documentationNode.meetsExpandedDocumentationRequirements(expandedDocsRequirement) ? identifier : nil
             }
             let converter = DocumentationContextConverter(
-                bundle: bundle,
+                inputs: inputs,
                 context: context,
                 renderContext: renderContext,
                 emitSymbolSourceFileURIs: request.emitSymbolSourceFileURIs,
@@ -243,12 +243,12 @@ public struct ConvertService: DocumentationService {
             .compactMap { (value, isDocumentationExtensionContent) -> (ResolvedTopicReference, RenderReferenceStore.TopicContent)? in
                 let (topicReference, article) = value
 
-                let bundle = context.bundle
-                guard bundle.id == topicReference.bundleID else { return nil }
-                let renderer = DocumentationContentRenderer(documentationContext: context, bundle: bundle)
+                let inputs = context.inputs
+                guard inputs.id == topicReference.bundleID else { return nil }
+                let renderer = DocumentationContentRenderer(documentationContext: context, inputs: inputs)
 
                 let documentationNodeKind: DocumentationNode.Kind = isDocumentationExtensionContent ? .unknownSymbol : .article
-                let overridingDocumentationNode = DocumentationContext.documentationNodeAndTitle(for: article, kind: documentationNodeKind, in: bundle)?.node
+                let overridingDocumentationNode = DocumentationContext.documentationNodeAndTitle(for: article, kind: documentationNodeKind, in: inputs)?.node
                 var dependencies = RenderReferenceDependencies()
                 let renderReference = renderer.renderReference(for: topicReference, with: overridingDocumentationNode, dependencies: &dependencies)
 

Sources/SwiftDocC/DocumentationService/Convert/Fallback Link Resolution/ConvertServiceFallbackResolver.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2024 Apple Inc. and the Swift project authors
+ Copyright (c) 2024-2025 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -26,7 +26,7 @@ protocol ConvertServiceFallbackResolver {
     /// The bundle identifier for the fallback resolver.
     ///
     /// The fallback resolver will only resolve links with this bundle identifier.
-    var bundleID: DocumentationBundle.Identifier { get }
+    var bundleID: DocumentationContext.Inputs.Identifier { get }
 
     // MARK: References
 

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

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
+ Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -17,7 +17,7 @@ public struct ConvertRequest: Codable {
     ///
     /// ## See Also
     /// - ``DocumentationBundle/Info``
-    public var bundleInfo: DocumentationBundle.Info
+    public var bundleInfo: DocumentationContext.Inputs.Info
 
     /// Feature flags to enable when performing this convert request.
     public var featureFlags: FeatureFlags
@@ -116,7 +116,7 @@ public struct ConvertRequest: Codable {
     ///   - symbolIdentifiersWithExpandedDocumentation: A dictionary of identifiers to requirements for these symbols to have expanded
     ///   documentation available.
     public init(
-        bundleInfo: DocumentationBundle.Info,
+        bundleInfo: DocumentationContext.Inputs.Info,
         featureFlags: FeatureFlags = FeatureFlags(),
         externalIDsToConvert: [String]?,
         documentPathsToConvert: [String]? = nil,

Sources/SwiftDocC/Infrastructure/Bundle Assets/DataAssetManager.swift

@@ -348,10 +348,10 @@ public struct AssetReference: Hashable, Codable {
     public var assetName: String
 
     /// The identifier of the bundle the asset is apart of.
-    public let bundleID: DocumentationBundle.Identifier
+    public let bundleID: DocumentationContext.Inputs.Identifier
 
     /// Creates a reference from a given asset name and the bundle it is apart of.
-    public init(assetName: String, bundleID: DocumentationBundle.Identifier) {
+    public init(assetName: String, bundleID: DocumentationContext.Inputs.Identifier) {
         self.assetName = assetName
         self.bundleID = bundleID
     }

Sources/SwiftDocC/Infrastructure/Context/DocumentationContext+Configuration.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2024 Apple Inc. and the Swift project authors
+ Copyright (c) 2024-2025 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -76,7 +76,7 @@ extension DocumentationContext {
         /// A collection of configuration related to external sources of documentation.
         public struct ExternalDocumentationConfiguration {
             /// The lookup of external documentation sources by their bundle identifiers.
-            public var sources: [DocumentationBundle.Identifier: any ExternalDocumentationSource] = [:]
+            public var sources: [DocumentationContext.Inputs.Identifier: any ExternalDocumentationSource] = [:]
             /// A type that resolves all symbols that are referenced in symbol graph files but can't be found in any of the locally available symbol graph files.
             public var globalSymbolResolver: (any GlobalExternalSymbolResolver)?
             /// A list of URLs to documentation archives that the local documentation depends on.