feat: Add Hub publisher (#260)

.mockery.yaml

@@ -47,6 +47,14 @@ packages:
     config:
     interfaces:
       Client:
+  github.com/blackstork-io/fabric/internal/microsoft/client:
+    config:
+    interfaces:
+      Client:
+  github.com/blackstork-io/fabric/internal/builtin/hubapi:
+    config:
+    interfaces:
+      Client:
   github.com/blackstork-io/fabric/internal/microsoft:
     config:
     interfaces:

docs/plugins/builtin/publishers/hub.md

@@ -0,0 +1,69 @@
+---
+title: "`hub` publisher"
+plugin:
+  name: blackstork/builtin
+  description: "Publish documents to Blackstork Hub."
+  tags: []
+  version: "v0.4.2"
+  source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/builtin/"
+resource:
+  type: publisher
+type: docs
+---
+
+{{< breadcrumbs 2 >}}
+
+{{< plugin-resource-header "blackstork/builtin" "builtin" "v0.4.2" "hub" "publisher" >}}
+
+The publisher is built-in, which means it's a part of `fabric` binary. It's available out-of-the-box, no installation required.
+
+#### Formats
+
+The publisher supports the following document formats:
+
+- `unknown`
+
+To set the output format, specify it inside `publish` block with `format` argument.
+
+
+#### Configuration
+
+The publisher supports the following configuration arguments:
+
+```hcl
+config publish hub {
+  # API url.
+  #
+  # Required string.
+  # Must be non-empty
+  # For example:
+  api_url = "some string"
+
+  # API url.
+  #
+  # Required string.
+  # Must be non-empty
+  # For example:
+  api_token = "some string"
+}
+
+```
+
+#### Usage
+
+The publisher supports the following execution arguments:
+
+```hcl
+# In addition to the arguments listed, `publish` block accepts `format` argument.
+
+publish hub {
+  # Hub Document title override. By default uses title configured in the document.
+  #
+  # Optional string.
+  # Must be non-empty
+  # Default value:
+  title = null
+}
+
+```
+

docs/plugins/plugins.json

@@ -73,6 +73,17 @@
           "url"
         ]
       },
+      {
+        "name": "hub",
+        "type": "publisher",
+        "config_params": [
+          "api_token",
+          "api_url"
+        ],
+        "arguments": [
+          "title"
+        ]
+      },
       {
         "name": "image",
         "type": "content-provider",

engine/engine.go

@@ -81,6 +81,10 @@ func (e *Engine) FileMap() map[string]*hcl.File {
 	return e.fileMap
 }
 
+func (e *Engine) ParsedBlocks() *parser.DefinedBlocks {
+	return e.blocks
+}
+
 func (e *Engine) Install(ctx context.Context, upgrade bool) (diags diagnostics.Diag) {
 	ctx, span := e.tracer.Start(ctx, "Engine.Install", trace.WithAttributes(
 		attribute.Bool("upgrade", upgrade),

examples/templates/hub/example.fabric

@@ -0,0 +1,72 @@
+document "example" {
+
+  title = "Example Report, {{ now | date \"Jan 02\" }}"
+
+  publish hub {
+    config {
+      api_url   = env.HUB_API_URL
+      api_token = env.HUB_API_TOKEN
+    }
+  }
+
+  content title {
+    value = "TOC"
+  }
+
+  content toc {}
+
+  content title {
+    value = "Subtitle 0"
+  }
+
+  section {
+    title = "Section #1"
+
+    content title {
+      value = "Section TOC"
+    }
+
+    content toc {
+      start_level = 1
+      end_level = 4
+      ordered = true
+    }
+
+    content text {
+      value = "Text value 1"
+    }
+
+    content title {
+      value = "Subtitle 1"
+    }
+
+    content text {
+      value = "Text value 2"
+    }
+
+    section {
+      title = "Subsection 1"
+
+      content text {
+        value = "Text value 3"
+      }
+    }
+
+    content title {
+      value = "Subtitle 2"
+    }
+  }
+
+  section {
+    title = "Section 2"
+
+    section {
+      title = "Subsection 2"
+
+      content text {
+        value = "Text value 4"
+      }
+    }
+  }
+}
+

internal/builtin/content_helpers.go

@@ -1,6 +1,13 @@
 package builtin
 
 import (
+	"bytes"
+	"fmt"
+	"strings"
+	"text/template"
+
+	"github.com/Masterminds/sprig/v3"
+
 	"github.com/blackstork-io/fabric/plugin"
 	"github.com/blackstork-io/fabric/plugin/plugindata"
 )
@@ -78,3 +85,36 @@ func findDepth(parent *plugin.ContentSection, id uint32, depth int) int {
 	}
 	return -1
 }
+
+func firstTitle(el plugin.Content) (string, bool) {
+	switch el := el.(type) {
+	case *plugin.ContentSection:
+		for _, c := range el.Children {
+			if title, ok := firstTitle(c); ok {
+				return title, true
+			}
+		}
+	case *plugin.ContentElement:
+		meta := el.Meta()
+		if meta.Plugin == "blackstork/builtin" && meta.Provider == "title" {
+			return string(bytes.TrimSpace(
+				bytes.TrimPrefix(el.AsMarkdownSrc(), []byte("#")),
+			)), true
+		}
+	}
+	return "", false
+}
+
+func templateString(str string, datactx plugindata.Map) (string, error) {
+	tmpl, err := template.New("pattern").Funcs(sprig.FuncMap()).Parse(str)
+	if err != nil {
+		return "", fmt.Errorf("failed to parse a text template: %w", err)
+	}
+
+	var buf bytes.Buffer
+	err = tmpl.Execute(&buf, datactx.Any())
+	if err != nil {
+		return "", fmt.Errorf("failed to execute a text template: %w", err)
+	}
+	return strings.TrimSpace(buf.String()), nil
+}