pixotope-documentalist 1.2.4 → 1.2.6

package/README.md

@@ -1,179 +1,197 @@
-# pixotope-documentalist
-
-Parses JSDoc-style API documentation comments from source files (TypeScript, JavaScript, Python, Rust) and publishes them as formatted pages to Confluence.
-
-## Installation
-
-```bash
-npm install pixotope-documentalist
-```
-
-Or run directly with npx:
-
-```bash
-npx pixotope-documentalist publish --config ./config.yml
-```
-
-## Quick Start
-
-1. Add doc comments to your source files
-2. Create a `config.yml` pointing to your sources and Confluence pages
-3. Set environment variables for Confluence auth
-4. Run `npx pixotope-documentalist publish`
-
-## Comment Format
-
-### TypeScript / JavaScript
-
-Use JSDoc-style block comments with `@api` as the entry tag:
-
-```typescript
-/**
- * @api CopyShowFileToLocal
- * @group Shows
- * @kind call
- * @description Copies a show file from the server to this machine.
- * @param {string} ShowName - Name of the show to copy.
- * @param {boolean} [Overwrite=false] - Whether to overwrite existing file.
- * @returns {boolean} Success - Whether the copy succeeded.
- * @example Copy a show
- * >>> {"Type":"Call","Target":"Machine1-Daemon","Method":"CopyShowFileToLocal"}
- * >>> {"Params":{"ShowName":"Show1"}}
- * <<< {"Type":"CallResult","Method":"CopyShowFileToLocal"}
- * <<< {"Result":{"Success":true}}
- * @warning This may take a while for large files.
- * @since 23.3.0
- */
-export const copyShowFileToDisk = async (...) => { ... };
-```
-
-### Python
-
-Use `#` comment blocks:
-
-```python
-# @api DiscoverDevices
-# @group Network
-# @kind call
-# @description Discovers available devices on the local network.
-# @param {string} Subnet - The subnet to scan.
-# @param {integer} Timeout - Scan timeout in milliseconds.
-# @returns {boolean} Success - Whether the scan completed.
-def discover_devices(subnet: str, timeout: int) -> dict:
-    pass
-```
-
-### Rust
-
-Use `///` triple-slash doc comments (consecutive lines form one block):
-
-```rust
-/// @api DiscoverDevices
-/// @group Network
-/// @kind call
-/// @description Discovers available devices on the local network.
-/// @param {string} Subnet - The subnet to scan.
-/// @param {integer} Timeout - Scan timeout in milliseconds.
-/// @returns {boolean} Success - Whether the scan completed.
-pub fn discover_devices(subnet: &str, timeout: u64) {
-    // ...
-}
-```
-
-## Tag Reference
-
-| Tag | Required | Description |
-|-----|----------|-------------|
-| `@api` | Yes | Endpoint name (displayed as title) |
-| `@group` | No | Section grouping header |
-| `@kind` | No | `call` (default), `get`, `set`, `state` (supports both Get and Set) |
-| `@description` | No | Multi-line description (continues until next tag) |
-| `@param` | No | `{type} Name - Description`. `[Name]` = optional, `[Name=default]` = with default |
-| `@returns` | No | `{type} Name - Description` |
-| `@example` | No | Title on first line, `>>>` for request messages, `<<<` for response messages |
-| `@warning` | No | Warning/note text |
-| `@since` | No | Version when this was introduced |
-| `@deprecated` | No | Deprecation notice |
-| `@internal` | No | Flag to exclude from published docs |
-| `@value` | No | For state docs: `{type} Name - Description` |
-
-## Configuration
-
-Create a `config.yml` in your project:
-
-```yaml
-confluence:
-  base_url: "https://your-domain.atlassian.net/wiki/rest/api/content"
-
-source_root: "."
-
-documents:
-  - id: daemon_calls
-    title: "Daemon API - Calls"
-    confluence_id:
-      master: "1234567890"
-      release: "0987654321"
-    sources:
-      - path: "packages/Daemon/src/endpoints/calls.ts"   # single file
-
-  - id: daemon_all
-    title: "Daemon API - All"
-    confluence_id:
-      master: "3333333333"
-      release: "4444444444"
-    sources:
-      - path: "packages/Daemon/src/endpoints/"           # entire folder (recursive)
-```
-
-- `source_root`: base path for resolving relative source paths (relative to config file location)
-- `confluence_id.master`: page ID for master/development docs
-- `confluence_id.release`: page ID for release docs
-- `sources[].path`: can point to a **single file** or a **folder**. When a folder is given, all supported files inside are scanned recursively. `node_modules` and hidden directories are skipped. Supported extensions: `.ts`, `.tsx`, `.js`, `.jsx`, `.py`, `.rs`, `.h`, `.cpp`, `.hpp`.
-
-## CLI Commands
-
-```bash
-# Parse source files and output JSON (for debugging)
-npx pixotope-documentalist parse --config ./config.yml --verbose
-
-# Parse + render to HTML files locally (no API calls)
-npx pixotope-documentalist preview --config ./config.yml
-
-# Parse + render + upload to Confluence
-npx pixotope-documentalist publish --config ./config.yml --target master
-
-# Show what would change without publishing
-npx pixotope-documentalist diff --config ./config.yml --target master
-```
-
-### Options
-
-| Option | Description | Default |
-|--------|-------------|---------|
-| `-c, --config <path>` | Path to config.yml | `config.yml` |
-| `-d, --document <id>` | Process only this document | all documents |
-| `-t, --target <env>` | `master` or `release` | `master` |
-| `--version-stamp <ver>` | Version stamp | `local` |
-| `-v, --verbose` | Verbose logging | off |
-
-## Environment Variables
-
-| Variable | Purpose |
-|----------|---------|
-| `CONFLUENCE_USER` | Confluence account email |
-| `CONFLUENCE_TOKEN` | Confluence API token ([generate here](https://id.atlassian.com/manage-profile/security/api-tokens)) |
-
-Create a `.env` file (git-ignored) for local use:
-
-```
-CONFLUENCE_USER=your.email@pixotope.com
-CONFLUENCE_TOKEN=your_api_token
-```
-
-## Supported File Types
-
-- `.ts`, `.tsx` (TypeScript)
-- `.js`, `.jsx` (JavaScript)
-- `.py` (Python)
-- `.rs` (Rust)
-- `.h`, `.cpp`, `.hpp` (C++)
+# pixotope-documentalist
+
+Parses JSDoc-style API documentation comments from source files (TypeScript, JavaScript, Python, Rust) and publishes them as formatted pages to Confluence.
+
+## Installation
+
+```bash
+npm install pixotope-documentalist
+```
+
+Or run directly with npx:
+
+```bash
+npx pixotope-documentalist publish --config ./config.yml
+```
+
+## Quick Start
+
+1. Add doc comments to your source files
+2. Create a `config.yml` pointing to your sources and Confluence pages
+3. Set environment variables for Confluence auth
+4. Run `npx pixotope-documentalist publish`
+
+## Comment Format
+
+### TypeScript / JavaScript
+
+Use JSDoc-style block comments with `@api` as the entry tag:
+
+```typescript
+/**
+ * @api CopyShowFileToLocal
+ * @group Shows
+ * @kind call
+ * @description Copies a show file from the server to this machine.
+ * @param {string} ShowName - Name of the show to copy.
+ * @param {boolean} [Overwrite=false] - Whether to overwrite existing file.
+ * @returns {boolean} Success - Whether the copy succeeded.
+ * @example Copy a show
+ * >>> {"Type":"Call","Target":"Machine1-Daemon","Method":"CopyShowFileToLocal"}
+ * >>> {"Params":{"ShowName":"Show1"}}
+ * <<< {"Type":"CallResult","Method":"CopyShowFileToLocal"}
+ * <<< {"Result":{"Success":true}}
+ * @warning This may take a while for large files.
+ * @since 23.3.0
+ */
+export const copyShowFileToDisk = async (...) => { ... };
+```
+
+### Python
+
+Use `#` comment blocks:
+
+```python
+# @api DiscoverDevices
+# @group Network
+# @kind call
+# @description Discovers available devices on the local network.
+# @param {string} Subnet - The subnet to scan.
+# @param {integer} Timeout - Scan timeout in milliseconds.
+# @returns {boolean} Success - Whether the scan completed.
+def discover_devices(subnet: str, timeout: int) -> dict:
+    pass
+```
+
+### Rust
+
+Use `///` triple-slash doc comments (consecutive lines form one block):
+
+```rust
+/// @api DiscoverDevices
+/// @group Network
+/// @kind call
+/// @description Discovers available devices on the local network.
+/// @param {string} Subnet - The subnet to scan.
+/// @param {integer} Timeout - Scan timeout in milliseconds.
+/// @returns {boolean} Success - Whether the scan completed.
+pub fn discover_devices(subnet: &str, timeout: u64) {
+    // ...
+}
+```
+
+## Tag Reference
+
+| Tag | Required | Description |
+|-----|----------|-------------|
+| `@api` | Yes | Endpoint name (displayed as title) |
+| `@group` | No | Section grouping header |
+| `@kind` | No | `call` (default), `get`, `set`, `state` (supports both Get and Set) |
+| `@description` | No | Multi-line description (continues until next tag) |
+| `@param` | No | `{type} Name - Description`. `[Name]` = optional, `[Name=default]` = with default |
+| `@returns` | No | `{type} Name - Description` |
+| `@example` | No | Title on first line, `>>>` for request messages, `<<<` for response messages |
+| `@warning` | No | Warning/note text |
+| `@since` | No | Version when this was introduced |
+| `@deprecated` | No | Deprecation notice |
+| `@internal` | No | Flag to exclude from published docs |
+| `@value` | No | For state docs: `{type} Name - Description` |
+
+## Configuration
+
+Create a `config.yml` in your project:
+
+```yaml
+confluence:
+  base_url: "https://your-domain.atlassian.net/wiki/rest/api/content"
+
+source_root: "."
+
+documents:
+  - id: daemon_calls
+    title: "Daemon API - Calls"
+    description: "Covers all call-type RPC endpoints."   # optional — plain string or path to a .md file
+    confluence_id:
+      master: "1234567890"
+      release: "0987654321"
+    sources:
+      - path: "packages/Daemon/src/endpoints/calls.ts"   # single file
+
+  - id: daemon_all
+    title: "Daemon API - All"
+    description: "docs/daemon_overview.md"               # optional — reads and renders the .md file
+    confluence_id:
+      master: "3333333333"
+      release: "4444444444"
+    sources:
+      - path: "packages/Daemon/src/endpoints/"           # entire folder (recursive)
+```
+
+- `source_root`: base path for resolving relative source paths (relative to config file location)
+- `confluence_id.master`: page ID for master/development docs
+- `confluence_id.release`: page ID for release docs
+- `description` *(optional)*: text rendered at the top of the Confluence page body, beneath the page title. Accepts either a plain string or a path to a `.md` file (resolved relative to the config file). Markdown is rendered to HTML.
+- `sources[].path`: can point to a **single file** or a **folder**. When a folder is given, all supported files inside are scanned recursively. `node_modules` and hidden directories are skipped. Supported extensions: `.ts`, `.tsx`, `.js`, `.jsx`, `.py`, `.rs`, `.h`, `.cpp`, `.hpp`.
+
+## CLI Commands
+
+```bash
+# Parse source files and output JSON (for debugging)
+npx pixotope-documentalist parse -c ./config.yml --verbose
+
+# Parse + render to HTML files locally (no API calls)
+npx pixotope-documentalist preview -c ./config.yml
+
+# Parse + render + upload to Confluence (skips if content unchanged)
+npx pixotope-documentalist publish -c ./config.yml -t master
+
+# Parse + render + force-upload to Confluence (always writes, skips diff check)
+npx pixotope-documentalist update -c ./config.yml -t release
+
+# Show what would change without publishing
+npx pixotope-documentalist diff -c ./config.yml -t master
+```
+
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| `parse` | Parse sources → JSON (debug output in `output/collected/`) |
+| `preview` | Parse + render → HTML files (in `output/formatted/`) |
+| `publish` | Parse + render + upload to Confluence. Skips if content is unchanged. |
+| `update` | Parse + render + force-upload to Confluence. Always writes, no diff check. |
+| `diff` | Show what would change without publishing |
+
+### Options
+
+All options support both short (`-c`) and long (`--config`) forms.
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `-c, --config <path>` | Path to config.yml | `config.yml` |
+| `-d, --document <id>` | Process only this document | all documents |
+| `-t, --target <env>` | `master` or `release` | `master` |
+| `--version-stamp <ver>` | Version stamp | `local` |
+| `-v, --verbose` | Verbose logging | off |
+
+## Environment Variables
+
+| Variable | Purpose |
+|----------|---------|
+| `CONFLUENCE_USER` | Confluence account email |
+| `CONFLUENCE_TOKEN` | Confluence API token ([generate here](https://id.atlassian.com/manage-profile/security/api-tokens)) |
+
+Create a `.env` file (git-ignored) for local use:
+
+```
+CONFLUENCE_USER=your.email@pixotope.com
+CONFLUENCE_TOKEN=your_api_token
+```
+
+## Supported File Types
+
+- `.ts`, `.tsx` (TypeScript)
+- `.js`, `.jsx` (JavaScript)
+- `.py` (Python)
+- `.rs` (Rust)
+- `.h`, `.cpp`, `.hpp` (C++)

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CA6CrD;AAED,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAChB,MAAM,CAGR"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAiErD;AAED,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAChB,MAAM,CAGR"}

package/dist/config.js

@@ -36,16 +36,37 @@ function loadConfig(configPath) {
             if (!doc.sources || !Array.isArray(doc.sources)) {
                 throw new Error(`Document "${doc.id}" missing required field: sources (array)`);
             }
+            let description;
+            if (doc.description) {
+                const rawDesc = String(doc.description);
+                if (rawDesc.endsWith(".md")) {
+                    const mdPath = path_1.default.resolve(path_1.default.dirname(absolutePath), rawDesc);
+                    if (fs_1.default.existsSync(mdPath)) {
+                        description = fs_1.default.readFileSync(mdPath, "utf-8");
+                    }
+                    else {
+                        description = rawDesc;
+                    }
+                }
+                else {
+                    description = rawDesc;
+                }
+            }
             return {
                 id: doc.id,
                 title: doc.title,
+                description,
                 confluenceId: {
                     master: String(doc.confluence_id.master || ""),
                     release: String(doc.confluence_id.release || ""),
                 },
-                sources: doc.sources.map((s) => ({
-                    path: typeof s === "string" ? s : s.path,
-                })),
+                sources: doc.sources.map((s) => {
+                    const srcPath = typeof s === "string" ? s : s.path;
+                    const srcMode = typeof s === "object" && s.mode === "interfaces" ? "interfaces"
+                        : typeof s === "object" && s.mode === "comments" ? "comments"
+                            : undefined;
+                    return { path: srcPath, mode: srcMode };
+                }),
             };
         }),
     };

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;;;AAKA,gCA6CC;AAED,8CAOC;AA3DD,4CAAoB;AACpB,gDAAwB;AACxB,gDAAwB;AAGxB,SAAgB,UAAU,CAAC,UAAkB;IAC3C,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAE9C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,0BAA0B,YAAY,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACvD,MAAM,GAAG,GAAG,cAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEhC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACxE,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,MAAM,GAAW;QACrB,UAAU,EAAE;YACV,QAAQ,EAAE,GAAG,CAAC,UAAU,CAAC,QAAQ;SAClC;QACD,WAAW,EAAE,GAAG,CAAC,WAAW,IAAI,GAAG;QACnC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE;YACxC,IAAI,CAAC,GAAG,CAAC,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACpE,IAAI,CAAC,GAAG,CAAC,KAAK;gBAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;YAC1E,IAAI,CAAC,GAAG,CAAC,aAAa;gBAAE,MAAM,IAAI,KAAK,CAAC,aAAa,GAAG,CAAC,EAAE,yCAAyC,CAAC,CAAC;YACtG,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBAChD,MAAM,IAAI,KAAK,CAAC,aAAa,GAAG,CAAC,EAAE,2CAA2C,CAAC,CAAC;YAClF,CAAC;YAED,OAAO;gBACL,EAAE,EAAE,GAAG,CAAC,EAAE;gBACV,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,YAAY,EAAE;oBACZ,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,IAAI,EAAE,CAAC;oBAC9C,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,IAAI,EAAE,CAAC;iBACjD;gBACD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC;oBACpC,IAAI,EAAE,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;iBACzC,CAAC,CAAC;aACJ,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,iBAAiB,CAC/B,UAAkB,EAClB,UAAkB,EAClB,SAAiB;IAEjB,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACzD,OAAO,cAAI,CAAC,OAAO,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AAChD,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;;;AAKA,gCAiEC;AAED,8CAOC;AA/ED,4CAAoB;AACpB,gDAAwB;AACxB,gDAAwB;AAGxB,SAAgB,UAAU,CAAC,UAAkB;IAC3C,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAE9C,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,0BAA0B,YAAY,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACvD,MAAM,GAAG,GAAG,cAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAEhC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACxE,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,MAAM,GAAW;QACrB,UAAU,EAAE;YACV,QAAQ,EAAE,GAAG,CAAC,UAAU,CAAC,QAAQ;SAClC;QACD,WAAW,EAAE,GAAG,CAAC,WAAW,IAAI,GAAG;QACnC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE;YACxC,IAAI,CAAC,GAAG,CAAC,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACpE,IAAI,CAAC,GAAG,CAAC,KAAK;gBAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;YAC1E,IAAI,CAAC,GAAG,CAAC,aAAa;gBAAE,MAAM,IAAI,KAAK,CAAC,aAAa,GAAG,CAAC,EAAE,yCAAyC,CAAC,CAAC;YACtG,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBAChD,MAAM,IAAI,KAAK,CAAC,aAAa,GAAG,CAAC,EAAE,2CAA2C,CAAC,CAAC;YAClF,CAAC;YAED,IAAI,WAA+B,CAAC;YACpC,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;gBACpB,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;gBACxC,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC5B,MAAM,MAAM,GAAG,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC;oBACjE,IAAI,YAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC1B,WAAW,GAAG,YAAE,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;oBACjD,CAAC;yBAAM,CAAC;wBACN,WAAW,GAAG,OAAO,CAAC;oBACxB,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,WAAW,GAAG,OAAO,CAAC;gBACxB,CAAC;YACH,CAAC;YAED,OAAO;gBACL,EAAE,EAAE,GAAG,CAAC,EAAE;gBACV,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,WAAW;gBACX,YAAY,EAAE;oBACZ,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,IAAI,EAAE,CAAC;oBAC9C,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,IAAI,EAAE,CAAC;iBACjD;gBACD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE;oBAClC,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;oBACnD,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,YAAqB;wBACtF,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,UAAmB;4BACtE,CAAC,CAAC,SAAS,CAAC;oBACd,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;gBAC1C,CAAC,CAAC;aACH,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,iBAAiB,CAC/B,UAAkB,EAClB,UAAkB,EAClB,SAAiB;IAEjB,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACzD,OAAO,cAAI,CAAC,OAAO,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AAChD,CAAC"}

package/dist/index.js

@@ -60,6 +60,18 @@ program
     const options = makeOptions(cmd);
     await (0, pipeline_1.runPublish)(options);
 });
+program
+    .command("update")
+    .description("Parse + render + force-upload to Confluence (skips diff check)")
+    .option("-c, --config <path>", "Path to config.yml", "config.yml")
+    .option("-d, --document <id>", "Process only this document")
+    .option("-t, --target <env>", "master or release", "master")
+    .option("--version-stamp <ver>", "Version stamp", "local")
+    .option("-v, --verbose", "Verbose logging")
+    .action(async (cmd) => {
+    const options = makeOptions(cmd);
+    await (0, pipeline_1.runUpdate)(options);
+});
 program
     .command("diff")
     .description("Show what would change without publishing")

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAEA,yCAAoC;AACpC,gDAAwB;AACxB,oDAA4B;AAC5B,qCAAsC;AACtC,yCAAwF;AAExF,0BAA0B;AAC1B,gBAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,wBAAwB,CAAC;KAC9B,WAAW,CAAC,qEAAqE,CAAC;KAClF,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,SAAS,WAAW,CAAC,GAAQ;IAC3B,MAAM,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,YAAY,CAAC,CAAC;IAC5D,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3C,OAAO;QACL,MAAM,EAAE,IAAA,mBAAU,EAAC,UAAU,CAAC;QAC9B,SAAS;QACT,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,QAAQ;QAC9B,OAAO,EAAE,GAAG,CAAC,YAAY,IAAI,OAAO;QACpC,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,KAAK;KAC9B,CAAC;AACJ,CAAC;AAED,OAAO;KACJ,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,iDAAiD,CAAC;KAC9D,MAAM,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,YAAY,CAAC;KACjE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;IACd,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,IAAA,mBAAQ,EAAC,OAAO,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,SAAS,CAAC;KAClB,WAAW,CAAC,6CAA6C,CAAC;KAC1D,MAAM,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,YAAY,CAAC;KACjE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;IACd,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,IAAA,qBAAU,EAAC,OAAO,CAAC,CAAC;AACtB,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,SAAS,CAAC;KAClB,WAAW,CAAC,uCAAuC,CAAC;KACpD,MAAM,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,YAAY,CAAC;KACjE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,CAAC;KAC3D,MAAM,CAAC,uBAAuB,EAAE,eAAe,EAAE,OAAO,CAAC;KACzD,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IACpB,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,IAAA,qBAAU,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,WAAW,CAAC,2CAA2C,CAAC;KACxD,MAAM,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,YAAY,CAAC;KACjE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,CAAC;KAC3D,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IACpB,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,IAAA,kBAAO,EAAC,OAAO,CAAC,CAAC;AACzB,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAEA,yCAAoC;AACpC,gDAAwB;AACxB,oDAA4B;AAC5B,qCAAsC;AACtC,yCAAmG;AAEnG,0BAA0B;AAC1B,gBAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,wBAAwB,CAAC;KAC9B,WAAW,CAAC,qEAAqE,CAAC;KAClF,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,SAAS,WAAW,CAAC,GAAQ;IAC3B,MAAM,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,YAAY,CAAC,CAAC;IAC5D,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3C,OAAO;QACL,MAAM,EAAE,IAAA,mBAAU,EAAC,UAAU,CAAC;QAC9B,SAAS;QACT,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,QAAQ;QAC9B,OAAO,EAAE,GAAG,CAAC,YAAY,IAAI,OAAO;QACpC,OAAO,EAAE,GAAG,CAAC,OAAO,IAAI,KAAK;KAC9B,CAAC;AACJ,CAAC;AAED,OAAO;KACJ,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,iDAAiD,CAAC;KAC9D,MAAM,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,YAAY,CAAC;KACjE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;IACd,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,IAAA,mBAAQ,EAAC,OAAO,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,SAAS,CAAC;KAClB,WAAW,CAAC,6CAA6C,CAAC;KAC1D,MAAM,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,YAAY,CAAC;KACjE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;IACd,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,IAAA,qBAAU,EAAC,OAAO,CAAC,CAAC;AACtB,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,SAAS,CAAC;KAClB,WAAW,CAAC,uCAAuC,CAAC;KACpD,MAAM,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,YAAY,CAAC;KACjE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,CAAC;KAC3D,MAAM,CAAC,uBAAuB,EAAE,eAAe,EAAE,OAAO,CAAC;KACzD,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IACpB,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,IAAA,qBAAU,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,QAAQ,CAAC;KACjB,WAAW,CAAC,gEAAgE,CAAC;KAC7E,MAAM,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,YAAY,CAAC;KACjE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,CAAC;KAC3D,MAAM,CAAC,uBAAuB,EAAE,eAAe,EAAE,OAAO,CAAC;KACzD,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IACpB,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,IAAA,oBAAS,EAAC,OAAO,CAAC,CAAC;AAC3B,CAAC,CAAC,CAAC;AAEL,OAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,WAAW,CAAC,2CAA2C,CAAC;KACxD,MAAM,CAAC,qBAAqB,EAAE,oBAAoB,EAAE,YAAY,CAAC;KACjE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,CAAC;KAC3D,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC;KAC1C,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;IACpB,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,IAAA,kBAAO,EAAC,OAAO,CAAC,CAAC;AACzB,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/models/index.d.ts

@@ -40,15 +40,18 @@ export interface Document {
     confluenceId: string;
     groups: Group[];
 }
+export type SourceMode = "comments" | "interfaces";
 export interface DocumentConfig {
     id: string;
     title: string;
+    description?: string;
     confluenceId: {
         master: string;
         release: string;
     };
     sources: {
         path: string;
+        mode?: SourceMode;
     }[];
 }
 export interface Config {

package/dist/models/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,OAAO,EAAE,KAAK,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,KAAK,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,KAAK;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE;QACV,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,QAAQ,CAAC,MAAM,CAAU,GAAG,QAAQ,CAWtF;AAED,wBAAgB,WAAW,CAAC,MAAM,GAAE,MAAW,GAAG,KAAK,CAOtD;AAED,wBAAgB,cAAc,CAAC,KAAK,GAAE,MAAW,GAAG,QAAQ,CAO3D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,OAAO,EAAE,KAAK,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,KAAK,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,KAAK;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,YAAY,CAAC;AAEnD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE;QACZ,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,UAAU,CAAA;KAAE,EAAE,CAAC;CAChD;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE;QACV,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,QAAQ,CAAC,MAAM,CAAU,GAAG,QAAQ,CAWtF;AAED,wBAAgB,WAAW,CAAC,MAAM,GAAE,MAAW,GAAG,KAAK,CAOtD;AAED,wBAAgB,cAAc,CAAC,KAAK,GAAE,MAAW,GAAG,QAAQ,CAO3D"}

package/dist/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;AAkEA,wCAWC;AAED,kCAOC;AAED,wCAOC;AA7BD,SAAgB,cAAc,CAAC,IAAY,EAAE,OAAyB,MAAM;IAC1E,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,WAAW,EAAE,EAAE;QACf,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,KAAK;KAChB,CAAC;AACJ,CAAC;AAED,SAAgB,WAAW,CAAC,SAAiB,EAAE;IAC7C,OAAO;QACL,MAAM;QACN,WAAW,EAAE,EAAE;QACf,SAAS,EAAE,EAAE;QACb,MAAM,EAAE,EAAE;KACX,CAAC;AACJ,CAAC;AAED,SAAgB,cAAc,CAAC,QAAgB,EAAE;IAC/C,OAAO;QACL,KAAK;QACL,OAAO,EAAE,EAAE;QACX,YAAY,EAAE,EAAE;QAChB,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC;KACxB,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":";;AAqEA,wCAWC;AAED,kCAOC;AAED,wCAOC;AA7BD,SAAgB,cAAc,CAAC,IAAY,EAAE,OAAyB,MAAM;IAC1E,OAAO;QACL,IAAI;QACJ,IAAI;QACJ,WAAW,EAAE,EAAE;QACf,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,KAAK;KAChB,CAAC;AACJ,CAAC;AAED,SAAgB,WAAW,CAAC,SAAiB,EAAE;IAC7C,OAAO;QACL,MAAM;QACN,WAAW,EAAE,EAAE;QACf,SAAS,EAAE,EAAE;QACb,MAAM,EAAE,EAAE;KACX,CAAC;AACJ,CAAC;AAED,SAAgB,cAAc,CAAC,QAAgB,EAAE;IAC/C,OAAO;QACL,KAAK;QACL,OAAO,EAAE,EAAE;QACX,YAAY,EAAE,EAAE;QAChB,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC;KACxB,CAAC;AACJ,CAAC"}

package/dist/parser/fileScanner.d.ts

@@ -1,2 +1,12 @@
 export declare function scanPath(filePath: string): string[];
+/**
+ * Detect whether a file should be parsed as TypeScript interfaces or as
+ * JSDoc-style comment blocks.
+ *
+ * A file is treated as "interfaces" mode when it contains a `@kind interface`
+ * directive in any comment style (///, //, #, *).
+ *
+ * Otherwise the file is treated as "comments" mode (the default).
+ */
+export declare function detectFileMode(filePath: string): "comments" | "interfaces";
 //# sourceMappingURL=fileScanner.d.ts.map

package/dist/parser/fileScanner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fileScanner.d.ts","sourceRoot":"","sources":["../../src/parser/fileScanner.ts"],"names":[],"mappings":"AAeA,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAkBnD"}
+{"version":3,"file":"fileScanner.d.ts","sourceRoot":"","sources":["../../src/parser/fileScanner.ts"],"names":[],"mappings":"AAeA,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAkBnD;AA+CD;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,CAI1E"}

package/dist/parser/fileScanner.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.scanPath = scanPath;
+exports.detectFileMode = detectFileMode;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const SUPPORTED_EXTENSIONS = new Set([
@@ -71,4 +72,19 @@ function scanDirectory(dirPath) {
 function isSupportedFile(filePath) {
     return SUPPORTED_EXTENSIONS.has(path_1.default.extname(filePath).toLowerCase());
 }
+/**
+ * Detect whether a file should be parsed as TypeScript interfaces or as
+ * JSDoc-style comment blocks.
+ *
+ * A file is treated as "interfaces" mode when it contains a `@kind interface`
+ * directive in any comment style (///, //, #, *).
+ *
+ * Otherwise the file is treated as "comments" mode (the default).
+ */
+function detectFileMode(filePath) {
+    const content = fs_1.default.readFileSync(filePath, "utf-8");
+    if (/(?:\/\/\/?|#|\*)\s*@kind\s+interface\b/m.test(content))
+        return "interfaces";
+    return "comments";
+}
 //# sourceMappingURL=fileScanner.js.map

package/dist/parser/fileScanner.js.map

@@ -1 +1 @@
-{"version":3,"file":"fileScanner.js","sourceRoot":"","sources":["../../src/parser/fileScanner.ts"],"names":[],"mappings":";;;;;AAeA,4BAkBC;AAjCD,4CAAoB;AACpB,gDAAwB;AAExB,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC;IACnC,KAAK;IACL,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,IAAI;IACJ,MAAM;IACN,MAAM;CACP,CAAC,CAAC;AAEH,SAAgB,QAAQ,CAAC,QAAgB;IACvC,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAExC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,mBAAmB,QAAQ,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,IAAI,GAAG,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEnC,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QAClB,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,IAAI,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,OAAO,IAAI,KAAK,UAAU,CAAC;AAC7B,CAAC;AAED,SAAS,aAAa,CAAC,OAAe;IACpC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,OAAO,GAAG,YAAE,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjE,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,MAAM,IAAI,GAAgB,EAAE,CAAC;IAE7B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,SAAS;YAC1E,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnB,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,eAAe,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC7E,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAED,iFAAiF;IACjF,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAClB,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,IAAI,IAAI,CAAC,IAAI;YAAE,OAAO,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,IAAI,IAAI,IAAI;YAAE,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,eAAe,CAAC,QAAgB;IACvC,OAAO,oBAAoB,CAAC,GAAG,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AACxE,CAAC"}
+{"version":3,"file":"fileScanner.js","sourceRoot":"","sources":["../../src/parser/fileScanner.ts"],"names":[],"mappings":";;;;;AAeA,4BAkBC;AAwDD,wCAIC;AA7FD,4CAAoB;AACpB,gDAAwB;AAExB,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC;IACnC,KAAK;IACL,MAAM;IACN,KAAK;IACL,MAAM;IACN,KAAK;IACL,KAAK;IACL,IAAI;IACJ,MAAM;IACN,MAAM;CACP,CAAC,CAAC;AAEH,SAAgB,QAAQ,CAAC,QAAgB;IACvC,MAAM,QAAQ,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAExC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,mBAAmB,QAAQ,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,IAAI,GAAG,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEnC,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QAClB,OAAO,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvB,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,IAAI,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,OAAO,IAAI,KAAK,UAAU,CAAC;AAC7B,CAAC;AAED,SAAS,aAAa,CAAC,OAAe;IACpC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,OAAO,GAAG,YAAE,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjE,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,MAAM,IAAI,GAAgB,EAAE,CAAC;IAE7B,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,SAAS;YAC1E,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnB,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,eAAe,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC7E,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAED,iFAAiF;IACjF,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAClB,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,IAAI,IAAI,CAAC,IAAI;YAAE,OAAO,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,IAAI,IAAI,IAAI;YAAE,OAAO,CAAC,CAAC;QAC5B,OAAO,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,eAAe,CAAC,QAAgB;IACvC,OAAO,oBAAoB,CAAC,GAAG,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAAC,QAAgB;IAC7C,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnD,IAAI,yCAAyC,CAAC,IAAI,CAAC,OAAO,CAAC;QAAE,OAAO,YAAY,CAAC;IACjF,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/parser/index.d.ts

@@ -1,4 +1,5 @@
-export { scanPath } from "./fileScanner";
+export { scanPath, detectFileMode } from "./fileScanner";
 export { extractDocBlocks, RawDocBlock } from "./commentExtractor";
 export { blocksToDocument } from "./tagParser";
+export { parseInterfacesFromFile } from "./interfaceParser";
 //# sourceMappingURL=index.d.ts.map

package/dist/parser/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/parser/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/parser/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/parser/index.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.blocksToDocument = exports.extractDocBlocks = exports.scanPath = void 0;
+exports.parseInterfacesFromFile = exports.blocksToDocument = exports.extractDocBlocks = exports.detectFileMode = exports.scanPath = void 0;
 var fileScanner_1 = require("./fileScanner");
 Object.defineProperty(exports, "scanPath", { enumerable: true, get: function () { return fileScanner_1.scanPath; } });
+Object.defineProperty(exports, "detectFileMode", { enumerable: true, get: function () { return fileScanner_1.detectFileMode; } });
 var commentExtractor_1 = require("./commentExtractor");
 Object.defineProperty(exports, "extractDocBlocks", { enumerable: true, get: function () { return commentExtractor_1.extractDocBlocks; } });
 var tagParser_1 = require("./tagParser");
 Object.defineProperty(exports, "blocksToDocument", { enumerable: true, get: function () { return tagParser_1.blocksToDocument; } });
+var interfaceParser_1 = require("./interfaceParser");
+Object.defineProperty(exports, "parseInterfacesFromFile", { enumerable: true, get: function () { return interfaceParser_1.parseInterfacesFromFile; } });
 //# sourceMappingURL=index.js.map

package/dist/parser/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/parser/index.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAAhC,uGAAA,QAAQ,OAAA;AACjB,uDAAmE;AAA1D,oHAAA,gBAAgB,OAAA;AACzB,yCAA+C;AAAtC,6GAAA,gBAAgB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/parser/index.ts"],"names":[],"mappings":";;;AAAA,6CAAyD;AAAhD,uGAAA,QAAQ,OAAA;AAAE,6GAAA,cAAc,OAAA;AACjC,uDAAmE;AAA1D,oHAAA,gBAAgB,OAAA;AACzB,yCAA+C;AAAtC,6GAAA,gBAAgB,OAAA;AACzB,qDAA4D;AAAnD,0HAAA,uBAAuB,OAAA"}

package/dist/parser/interfaceParser.d.ts

@@ -0,0 +1,20 @@
+import { Group } from "../models";
+/**
+ * Parse TypeScript interfaces and types from a file, using the TS compiler API.
+ *
+ * Auto mode (default when no @ScrapeJS annotations are present):
+ *   All interfaces are indexed. Types referenced by other types are treated as
+ *   helpers; unreferenced interfaces become root value trees automatically.
+ *   Auto-SkipType: if a root interface wraps a single child with the same name,
+ *   that child is promoted as the tree root.
+ *
+ * Legacy mode (activated when any @ScrapeJS annotation is detected):
+ *   /// @ScrapeJS: DefineValueType       -- register interface/type in the type registry
+ *   /// @ScrapeJS: ValueTree [SkipType]  -- root value tree for documentation output
+ *   /// @DefineValueTypeMapping: Name - baseType  -- map a type alias to a display type
+ *
+ * Both modes support:
+ *   /// @Group: GroupName                -- set the output group
+ */
+export declare function parseInterfacesFromFile(filePath: string): Group[];
+//# sourceMappingURL=interfaceParser.d.ts.map

package/dist/parser/interfaceParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaceParser.d.ts","sourceRoot":"","sources":["../../src/parser/interfaceParser.ts"],"names":[],"mappings":"AAEA,OAAO,EAAS,KAAK,EAAe,MAAM,WAAW,CAAC;AAWtD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,EAAE,CA2GjE"}