shrink public API surface in laika.rewrite.*

core/shared/src/main/scala/laika/rewrite/DefaultTemplatePath.scala

@@ -27,7 +27,7 @@ object DefaultTemplatePath {
 
   private val base: Path = Root / "default"
 
-  def forSuffix(suffix: String): Path = base.withSuffix(s"template.$suffix")
+  private[laika] def forSuffix(suffix: String): Path = base.withSuffix(s"template.$suffix")
 
   def forHTML: Path = forSuffix("html")
   def forEPUB: Path = forSuffix("epub.xhtml")

core/shared/src/main/scala/laika/rewrite/ReferenceResolver.scala

@@ -39,10 +39,9 @@ case class ReferenceResolver(config: Config) {
 
 }
 
-/** Companion for constructing ReferenceResolvers for a particular
-  *  target Document.
+/** Companion for constructing ReferenceResolvers for a particular target Document.
   */
-object ReferenceResolver {
+private[laika] object ReferenceResolver {
 
   object CursorKeys {
 

core/shared/src/main/scala/laika/rewrite/link/DocumentTargets.scala

@@ -25,7 +25,7 @@ import scala.annotation.tailrec
   *
   *  @author Jens Halm
   */
-case class DocumentTargets(document: Document, slugBuilder: String => String) {
+private[link] class DocumentTargets(document: Document, slugBuilder: String => String) {
 
   /** Generates symbol identifiers.
     * Contains a predefined list of ten symbols to generate.

core/shared/src/main/scala/laika/rewrite/link/IconRegistry.scala

@@ -5,7 +5,7 @@ import laika.config.{ ConfigEncoder, DefaultKey, LaikaKeys }
 
 /** Registers Icon AST elements for use with the `@:icon` directive and the `IconReference` AST element.
   */
-case class IconRegistry(icons: Map[String, Icon])
+case class IconRegistry private (icons: Map[String, Icon])
 
 object IconRegistry {
 

core/shared/src/main/scala/laika/rewrite/link/LinkResolver.scala

@@ -41,7 +41,7 @@ import scala.annotation.tailrec
   *
   *  @author Jens Halm
   */
-class LinkResolver(root: DocumentTreeRoot, slugBuilder: String => String)
+private[laika] class LinkResolver(root: DocumentTreeRoot, slugBuilder: String => String)
     extends RewriteRulesBuilder {
 
   val targets = new TreeTargets(root, slugBuilder)

core/shared/src/main/scala/laika/rewrite/link/Selector.scala

@@ -23,7 +23,7 @@ import laika.ast.Path
   *  from both, the ids rendered in the final document
   *  and the ids used for display.
   */
-sealed trait Selector {
+private[link] sealed trait Selector {
 
   /** Indicates whether this selector is applicable
     * beyond the boundaries of a single document.
@@ -43,45 +43,45 @@ sealed trait Selector {
 
 /** A selector that can be used for a sequence of targets.
   */
-sealed trait SequenceSelector extends Selector {
+private[link] sealed trait SequenceSelector extends Selector {
   val global = false
   val unique = false
 }
 
 /** A selector that can is a globally unique identifier.
   */
-sealed trait UniqueSelector extends Selector {
+private[link] sealed trait UniqueSelector extends Selector {
   val global = true
   val unique = true
   def description: String
 }
 
 /** A selector for a rendered target in a document.
   */
-case class TargetIdSelector(id: String) extends UniqueSelector {
+private[link] case class TargetIdSelector(id: String) extends UniqueSelector {
   val description = s"link target with id '$id'"
 }
 
 /** A selector for a definition for an internal or external link.
   */
-case class LinkDefinitionSelector(id: String) extends UniqueSelector {
+private[link] case class LinkDefinitionSelector(id: String) extends UniqueSelector {
   val description = s"link definition with id '$id'"
 }
 
 /** A selector based on a path, optionally including a fragment component.
   */
-case class PathSelector(path: Path) extends UniqueSelector {
+private[link] case class PathSelector(path: Path) extends UniqueSelector {
   val description = s"link target with path '$path'"
 }
 
 /** An anonymous selector (usually matched by position).
   */
-case object AnonymousSelector extends SequenceSelector
+private[link] case object AnonymousSelector extends SequenceSelector
 
 /** An auto-number selector (usually matched by position).
   */
-case object AutonumberSelector extends SequenceSelector
+private[link] case object AutonumberSelector extends SequenceSelector
 
 /** An auto-symbol selector (usually matched by position).
   */
-case object AutosymbolSelector extends SequenceSelector
+private[link] case object AutosymbolSelector extends SequenceSelector

core/shared/src/main/scala/laika/rewrite/link/TargetResolver.scala

@@ -23,15 +23,15 @@ import laika.rewrite.nav.TargetFormats
 /** Represents the source of a link, its document path
   * and the actual inline span that is representing the link.
   */
-case class LinkSource(span: Span, path: Path)
+private[link] case class LinkSource(span: Span, path: Path)
 
 /** Represents a resolver for a target that has its final identifier generated
   * (if necessary) and can be used to resolve matching reference nodes.
   *
   * @param selector the selector to use to identify reference nodes matching this target
   * @param precedence the precedence in comparison to other resolvers with the same selector
   */
-abstract sealed class TargetResolver(
+private[link] abstract sealed class TargetResolver(
     val selector: Selector,
     val targetFormats: TargetFormats = TargetFormats.All,
     val precedence: Int = 0
@@ -53,7 +53,7 @@ abstract sealed class TargetResolver(
 
 }
 
-object ReferenceResolver {
+private[link] object ReferenceResolver {
   def lift(f: PartialFunction[LinkSource, Span]): LinkSource => Option[Span] = f.lift
 
   def internalLink(target: Path): LinkSource => Option[Span] = lift {
@@ -78,14 +78,13 @@ object ReferenceResolver {
 
 }
 
-object TargetReplacer {
+private[link] object TargetReplacer {
   def lift(f: PartialFunction[Block, Block]): Block => Option[Block] = f.lift
   def addId(id: String): Block => Option[Block] = block => Some(block.withId(id))
-  val removeId: Block => Option[Block]          = block => Some(block.withoutId)
   val removeTarget: Block => Option[Block]      = Function.const(None)
 }
 
-object TargetResolver {
+private[link] object TargetResolver {
 
   def create(
       selector: Selector,
@@ -201,7 +200,7 @@ object TargetResolver {
 /** Represents a resolver for a sequence of targets where matching reference nodes get determined by position.
   * The `resolveReference` and `resolveTarget` methods can be invoked as many times as this sequence contains elements.
   */
-case class TargetSequenceResolver(targets: Seq[TargetResolver], sel: Selector)
+private[link] case class TargetSequenceResolver(targets: Seq[TargetResolver], sel: Selector)
     extends TargetResolver(sel) {
   private val refIt    = targets.iterator
   private val targetIt = targets.iterator
@@ -216,7 +215,7 @@ case class TargetSequenceResolver(targets: Seq[TargetResolver], sel: Selector)
 
 }
 
-case class LinkAliasResolver(
+private[link] case class LinkAliasResolver(
     sourceSelector: TargetIdSelector,
     targetSelector: TargetIdSelector,
     referenceResolver: LinkSource => Option[Span],
@@ -241,7 +240,7 @@ case class LinkAliasResolver(
 
 }
 
-object LinkAliasResolver {
+private[link] object LinkAliasResolver {
 
   def unresolved(
       sourceSelector: TargetIdSelector,

core/shared/src/main/scala/laika/rewrite/link/TreeTargets.scala

@@ -24,7 +24,7 @@ import laika.ast.{ DocumentTreeRoot, Path, StaticDocument }
   *
   * @author Jens Halm
   */
-class TreeTargets(root: DocumentTreeRoot, slugBuilder: String => String) {
+private[link] class TreeTargets(root: DocumentTreeRoot, slugBuilder: String => String) {
 
   private val targetMap: Map[(Path, Selector), TargetResolver] = {
 
@@ -42,7 +42,7 @@ class TreeTargets(root: DocumentTreeRoot, slugBuilder: String => String) {
       } yield ((path, target.selector), target)
 
     val targets                           = root.allDocuments.flatMap { doc =>
-      val targets = DocumentTargets(doc, slugBuilder).targets
+      val targets = new DocumentTargets(doc, slugBuilder).targets
       val global  =
         if (doc.path == Root) Nil
         else mapToKeys(allPaths(doc.path.parent), targets.filter(_.selector.global))

core/shared/src/main/scala/laika/rewrite/nav/AutonumberConfig.scala

@@ -34,11 +34,9 @@ case class AutonumberConfig(
     maxDepth: Int = Int.MaxValue
 )
 
-case class ConfigurationException(msg: String) extends RuntimeException(msg)
+private[nav] sealed trait Scope
 
-sealed trait Scope
-
-object Scope {
+private[nav] object Scope {
   case object Documents extends Scope
   case object Sections  extends Scope
   case object All       extends Scope

core/shared/src/main/scala/laika/rewrite/nav/CoverImage.scala

@@ -53,7 +53,7 @@ object CoverImage {
 
 }
 
-case class CoverImages(default: Option[Path], classified: Map[String, Path]) {
+private[nav] case class CoverImages(default: Option[Path], classified: Map[String, Path]) {
 
   def getImageFor(classifier: String): Option[Path] = classified.get(classifier).orElse(default)
 
@@ -63,7 +63,7 @@ case class CoverImages(default: Option[Path], classified: Map[String, Path]) {
 
 }
 
-object CoverImages {
+private[nav] object CoverImages {
 
   def forPDF(config: Config): ConfigResult[CoverImages] =
     extract(config, LaikaKeys.root.child("pdf"), LaikaKeys.root)

core/shared/src/main/scala/laika/rewrite/nav/NavigationOrder.scala

@@ -20,14 +20,13 @@ import laika.config.{ Config, LaikaKeys }
 import laika.ast._
 import laika.config.Config.ConfigResult
 
-/** Responsible for applying the navigation order to the
-  *  contents of a document tree, either based on user-specified
-  *  configuration or by the alphabetical order of the names of
-  *  the documents and subtrees.
+/** Responsible for applying the navigation order to the contents of a document tree,
+  * either based on user-specified configuration
+  * or by the alphabetical order of the names of the documents and subtrees.
   *
-  *  @author Jens Halm
+  * @author Jens Halm
   */
-object NavigationOrder {
+private[laika] object NavigationOrder {
 
   def applyTo(
       content: Seq[Cursor],

core/shared/src/main/scala/laika/rewrite/nav/SectionBuilder.scala

@@ -29,7 +29,7 @@ import scala.collection.mutable.ListBuffer
   *
   * @author Jens Halm
   */
-object SectionBuilder extends RewriteRulesBuilder {
+private[laika] object SectionBuilder extends RewriteRulesBuilder {
 
   private class DefaultRule(
       autonumberConfig: AutonumberConfig,

core/shared/src/main/scala/laika/rewrite/nav/TitleDocumentConfig.scala

@@ -23,7 +23,7 @@ import laika.config.{ Config, LaikaKeys }
   *
   * @author Jens Halm
   */
-object TitleDocumentConfig {
+private[laika] object TitleDocumentConfig {
 
   val defaultInputName: String  = "README"
   val defaultOutputName: String = "index"