confluence-md-sync 0.10.0 → 0.11.0

package/dist/export/to-markdown.js

@@ -140,6 +140,14 @@ class Converter {
                 if (meaningful.length === 1 && meaningful[0].kind === 'el' && meaningful[0].name === 'ac:structured-macro') {
                     return this.macroToMd(meaningful[0]);
                 }
+                if (meaningful.length > 1 && meaningful.every(n => n.kind === 'el' && n.name === 'ac:structured-macro')) {
+                    const native = meaningful.map(n => this.tryNativeMd(n, getAttr(n, 'ac:name') ?? ''));
+                    if (native.every(s => s?.startsWith('{{') && !s.includes('\n'))) {
+                        this.stats.native += native.length;
+                        this.stats.normalized++; // A paragraph around block macros is redundant in Confluence.
+                        return native.join(' ');
+                    }
+                }
                 return this.paragraphMd(el.children);
             }
             if (el.name === 'hr')
@@ -1238,6 +1246,16 @@ class Converter {
             throw new Unrepresentable();
         const ref = kids[0];
         const filename = getAttr(ref, 'ri:filename') ?? '';
+        const architecture = /^(.*\.dsl)\.((?:[0-9a-f]{2})+)\.png$/.exec(filename);
+        if (architecture && ref.name === 'ri:attachment' && !/[{}|\n/\\]/.test(architecture[1])) {
+            const view = new TextDecoder('utf-8').decode(Uint8Array.from(architecture[2].match(/../g), b => parseInt(b, 16)));
+            if (view && !/[{}|\n\uFFFD]/.test(view)) {
+                this.files.add(architecture[1]);
+                this.files.add(architecture[1].replace(/\.dsl$/, '.json'));
+                this.images.add(filename);
+                return `{{structurizr:${architecture[1]}|view=${view}}}`;
+            }
+        }
         const stem = filename.replace(/\.png$/i, '');
         const drawioName = getAttr(el, 'ac:alt')?.match(/^drawio:(.+)$/)?.[1]
             ?? (stem !== filename && (this.drawioNames.has(stem) || /\.drawio$/i.test(stem)) ? stem : undefined);

package/dist/macros/index.d.ts

@@ -6,6 +6,7 @@ export { coreMacrosPlugin, extractPlainText } from './plugins/core.js';
 export { tableFilterPlugin, TABLE_FILTER_DEFAULTS } from './plugins/table-filter.js';
 export { csvTablePlugin, CSV_TABLE_DEFAULTS } from './plugins/csv-table.js';
 export { portfolioForJiraPlanPlugin } from './plugins/portfolio-for-jira-plan.js';
+export { structurizrPlugin } from './plugins/structurizr.js';
 export { drawioPlugin } from './plugins/drawio.js';
 export { searchPlugin } from './plugins/search.js';
 import { MacroRegistry } from './registry.js';
@@ -51,5 +52,6 @@ export declare const macros: {
     csvTable: typeof csvTable;
     portfolioForJiraPlan: typeof portfolioForJiraPlan;
     drawio: (name: string, opts?: Record<string, string | undefined>) => import("../index.js").Markdown;
+    structurizr: (name: string, view: string) => import("../index.js").Markdown;
     search: (query: string, options?: Record<string, string | undefined>) => import("../index.js").Markdown;
 };

package/dist/macros/index.js

@@ -6,6 +6,7 @@ export { coreMacrosPlugin, extractPlainText } from './plugins/core.js';
 export { tableFilterPlugin, TABLE_FILTER_DEFAULTS } from './plugins/table-filter.js';
 export { csvTablePlugin, CSV_TABLE_DEFAULTS } from './plugins/csv-table.js';
 export { portfolioForJiraPlanPlugin } from './plugins/portfolio-for-jira-plan.js';
+export { structurizrPlugin } from './plugins/structurizr.js';
 export { drawioPlugin } from './plugins/drawio.js';
 export { searchPlugin } from './plugins/search.js';
 import { MacroRegistry } from './registry.js';
@@ -17,6 +18,7 @@ import { anchor, children, codeBlock, excerpt, excerptInclude, expand, includePa
 import { tableExcerpt, tableExcerptInclude, tableFilter, tableJoiner } from './plugins/table-filter.js';
 import { csvTable } from './plugins/csv-table.js';
 import { portfolioForJiraPlan } from './plugins/portfolio-for-jira-plan.js';
+import { structurizr, structurizrPlugin } from './plugins/structurizr.js';
 import { drawio, drawioPlugin } from './plugins/drawio.js';
 import { search, searchPlugin } from './plugins/search.js';
 /** Creates a registry pre-loaded with all built-in plugins. */
@@ -27,6 +29,7 @@ export function createDefaultRegistry() {
         .use(csvTablePlugin)
         .use(portfolioForJiraPlanPlugin)
         .use(drawioPlugin)
+        .use(structurizrPlugin)
         .use(searchPlugin);
 }
 /**
@@ -67,5 +70,6 @@ export const macros = {
     csvTable,
     portfolioForJiraPlan,
     drawio,
+    structurizr,
     search,
 };

package/dist/macros/plugins/structurizr.d.ts

@@ -0,0 +1,5 @@
+import { type MacroPlugin } from '../types.js';
+export declare function structurizrPreview(name: string, view: string): string;
+/** Confluence needs no third-party plugin: the view is a PNG, sources remain attachments. */
+export declare const structurizrPlugin: MacroPlugin;
+export declare const structurizr: (name: string, view: string) => import("../../index.js").Markdown;

package/dist/macros/plugins/structurizr.js

@@ -0,0 +1,17 @@
+import { macro } from '../builder.js';
+import { paramMap } from '../types.js';
+import { escapeXmlAttr } from '../xml.js';
+export function structurizrPreview(name, view) {
+    if (typeof name !== 'string' || !/\.dsl$/i.test(name) || /[/\\{}|]/.test(name) || !view || view.length > 120 || /[{}|\n\r]/.test(view))
+        throw new Error('structurizr: a .dsl attachment and view key are required');
+    return `${name}.${Array.from(new TextEncoder().encode(view), b => b.toString(16).padStart(2, '0')).join('')}.png`;
+}
+/** Confluence needs no third-party plugin: the view is a PNG, sources remain attachments. */
+export const structurizrPlugin = {
+    name: 'structurizr',
+    macros: [{ name: 'structurizr', render(ctx) {
+                const { name, view } = paramMap(ctx.params);
+                return `<ac:image ac:alt="${escapeXmlAttr(`Structurizr · ${view}`)}"><ri:attachment ri:filename="${escapeXmlAttr(structurizrPreview(name, view))}" /></ac:image>`;
+            } }],
+};
+export const structurizr = (name, view) => macro('structurizr').param('name', name).param('view', view).toMarkdown();

package/dist/markdown/native.js

@@ -47,6 +47,7 @@ export const NATIVE_DIRECTIVES = {
 export const NATIVE_PLACEHOLDERS = {
     search: 'search',
     drawio: 'drawio',
+    structurizr: 'structurizr',
     toc: 'toc',
     children: 'children',
     jira: 'jira',
@@ -59,6 +60,7 @@ export const NATIVE_PLACEHOLDERS = {
 export function nativeMacroList() {
     return [
         { macro: 'search', syntax: '{{search:query=…|spacekey=…|type=page|maxLimit=10}}' },
+        { macro: 'structurizr', syntax: '{{structurizr:workspace.dsl|view=containers}}' },
         { macro: 'drawio', syntax: '{{drawio:diagram.drawio|format=macro}} | {{drawio:diagram.drawio|format=image}}' },
         { macro: 'info', syntax: '> [!INFO] Заголовок?' },
         { macro: 'note', syntax: '> [!NOTE] Заголовок?' },
@@ -79,7 +81,7 @@ export function nativeMacroList() {
 const ADMONITION_FIRST_RE = /^>\s*\[!([A-Za-z]+)\]\s*(.*)$/;
 const DIRECTIVE_OPEN_RE = /^:::\s+([a-z-]+)(?:\s+(.*?))?\s*$/;
 const DIRECTIVE_CLOSE_RE = /^:::\s*$/;
-const PLACEHOLDER_INLINE_RE = /\{\{(search|drawio|toc|children|jira|status|anchor|properties-report|portfolio-for-jira-plan)(?::((?:"(?:\\.|[^"\\])*"|[^{}"]|\{[^{])*?))?\}\}/g;
+const PLACEHOLDER_INLINE_RE = /\{\{(search|drawio|structurizr|toc|children|jira|status|anchor|properties-report|portfolio-for-jira-plan)(?::((?:"(?:\\.|[^"\\])*"|[^{}"]|\{[^{])*?))?\}\}/g;
 const FENCE_RE = /^\s*(`{3,}|~{3,})/;
 /** Компактная пара маркеров без тела — для строчного контекста. */
 function inlineMarker(macroName, params) {
@@ -122,6 +124,8 @@ function placeholderParams(kind, raw) {
     if (raw === undefined || raw.trim() === '')
         return [];
     const { head, attrs } = splitAttrs(raw);
+    if (kind === 'structurizr')
+        return [{ name: 'name', value: head }, ...attrs];
     if (kind === 'drawio')
         return [{ name: 'diagramName', value: head }, ...attrs];
     const params = [];

package/dist/markdown/structurizr.d.ts

@@ -0,0 +1,5 @@
+export declare function structurizrReferences(markdown: string): {
+    name: string;
+    json: string;
+    preview: string;
+}[];

package/dist/markdown/structurizr.js

@@ -0,0 +1,16 @@
+import MarkdownIt from 'markdown-it';
+import { parsePlaceholder } from './render.js';
+import { structurizrPreview } from '../macros/plugins/structurizr.js';
+export function structurizrReferences(markdown) {
+    const refs = [];
+    for (const token of new MarkdownIt().parse(markdown, {}))
+        for (const child of token.children ?? []) {
+            if (child.type !== 'text')
+                continue;
+            for (const match of child.content.matchAll(/\{\{structurizr:([^}]+)\}\}/g)) {
+                const { name, attrs } = parsePlaceholder(match[1]);
+                refs.push({ name, json: name.replace(/\.dsl$/, '.json'), preview: structurizrPreview(name, Object.fromEntries(attrs).view) });
+            }
+        }
+    return refs;
+}

package/dist/markdown/validate.js

@@ -1,5 +1,6 @@
 import { basename } from 'node:path';
 import { extractPlaceholders } from './render.js';
+import { structurizrReferences } from './structurizr.js';
 import { drawioReferences } from './drawio.js';
 export class MarkdownValidationError extends Error {
     constructor(message) {
@@ -13,6 +14,10 @@ export function validateMarkdown(opts) {
         files.push(diagram.name);
         images.push(diagram.preview);
     }
+    for (const diagram of structurizrReferences(opts.markdown)) {
+        files.push(diagram.name, diagram.json);
+        images.push(diagram.preview);
+    }
     const tables = extractTablePlaceholders(opts.markdown);
     const providedImages = new Set(opts.imagePaths.map((p) => basename(p)));
     const providedFiles = new Set(opts.filePaths.map((p) => basename(p)));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "confluence-md-sync",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "Publish Markdown to Confluence (Data Center & Cloud): idempotent page sync, attachment dedup, tables and a pluggable macro system",
   "keywords": [
     "confluence",