From e982e60a34f6472797ac9841fc64c560ec7c56cb Mon Sep 17 00:00:00 2001 From: Rishabh Jain Date: Sun, 10 May 2026 19:15:10 +0530 Subject: [PATCH] fix(*): align remaining types and publish runtime (#668) Signed-off-by: Rishabh Jain --- .github/workflows/publish.yml | 4 ++-- packages/markdown-html/src/HtmlTransformer.js | 10 +++++++--- .../markdown-html/types/lib/HtmlTransformer.d.ts | 14 ++++++++++---- .../lib/TemplateMarkTransformer.js | 3 ++- .../src/TemplateMarkTransformer.js | 6 ++++-- .../types/lib/TemplateMarkTransformer.d.ts | 8 ++++++-- 6 files changed, 31 insertions(+), 14 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 2bc6576e..5eb5f63a 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -19,10 +19,10 @@ jobs: - name: git checkout uses: actions/checkout@v4 - - name: Use Node.js 20.x + - name: Use Node.js 22.x uses: actions/setup-node@v4 with: - node-version: '20' + node-version: '22' registry-url: 'https://registry.npmjs.org' cache: 'npm' diff --git a/packages/markdown-html/src/HtmlTransformer.js b/packages/markdown-html/src/HtmlTransformer.js index aba28e44..56681de7 100644 --- a/packages/markdown-html/src/HtmlTransformer.js +++ b/packages/markdown-html/src/HtmlTransformer.js @@ -14,6 +14,10 @@ 'use strict'; +/** @typedef {import('@accordproject/markdown-common/types/model/commonmark').IDocument} IDocument */ +/** @typedef {import('@accordproject/concerto-core').Typed} Typed */ +/** @typedef {IDocument|Typed} HtmlInput */ + const ToHtmlStringVisitor = require('./ToHtmlStringVisitor'); const ToCiceroMarkVisitor = require('./ToCiceroMarkVisitor'); const CiceroMarkTransformer = require('@accordproject/markdown-cicero').CiceroMarkTransformer; @@ -34,7 +38,7 @@ class HtmlTransformer { /** * Converts a CiceroMark DOM to an html string - * @param {object} input - CiceroMark DOM object + * @param {HtmlInput} input - CiceroMark DOM object * @returns {string} the html string */ toHtml(input) { @@ -55,7 +59,7 @@ class HtmlTransformer { /** * Converts an html string to a CiceroMark DOM * @param {string} input - html string - * @returns {object} CiceroMark DOM + * @returns {IDocument} CiceroMark DOM */ toCiceroMark(input) { const visitor = new ToCiceroMarkVisitor(this.options); @@ -63,4 +67,4 @@ class HtmlTransformer { } } -module.exports = HtmlTransformer; \ No newline at end of file +module.exports = HtmlTransformer; diff --git a/packages/markdown-html/types/lib/HtmlTransformer.d.ts b/packages/markdown-html/types/lib/HtmlTransformer.d.ts index 99eabb86..e19d5f2d 100644 --- a/packages/markdown-html/types/lib/HtmlTransformer.d.ts +++ b/packages/markdown-html/types/lib/HtmlTransformer.d.ts @@ -12,14 +12,20 @@ declare class HtmlTransformer { ciceroMarkTransformer: import("@accordproject/markdown-cicero/types/lib/CiceroMarkTransformer"); /** * Converts a CiceroMark DOM to an html string - * @param {object} input - CiceroMark DOM object + * @param {HtmlInput} input - CiceroMark DOM object * @returns {string} the html string */ - toHtml(input: object): string; + toHtml(input: HtmlInput): string; /** * Converts an html string to a CiceroMark DOM * @param {string} input - html string - * @returns {object} CiceroMark DOM + * @returns {IDocument} CiceroMark DOM */ - toCiceroMark(input: string): object; + toCiceroMark(input: string): IDocument; } +declare namespace HtmlTransformer { + export { IDocument, Typed, HtmlInput }; +} +type IDocument = import("@accordproject/markdown-common/types/model/commonmark").IDocument; +type Typed = import("@accordproject/concerto-core").Typed; +type HtmlInput = IDocument | Typed; diff --git a/packages/markdown-template/lib/TemplateMarkTransformer.js b/packages/markdown-template/lib/TemplateMarkTransformer.js index db329461..5dda0419 100644 --- a/packages/markdown-template/lib/TemplateMarkTransformer.js +++ b/packages/markdown-template/lib/TemplateMarkTransformer.js @@ -14,6 +14,7 @@ 'use strict'; +/** @typedef {import('@accordproject/concerto-core').Serializer} Serializer */ var { templateMarkManager, templateToTokens, @@ -93,7 +94,7 @@ class TemplateMarkTransformer { /** * Get TemplateMark serializer - * @return {object} templatemark serializer + * @return {Serializer} templatemark serializer */ getSerializer() { return templateMarkManager.serializer; diff --git a/packages/markdown-template/src/TemplateMarkTransformer.js b/packages/markdown-template/src/TemplateMarkTransformer.js index eb6c3764..e7cbc35f 100644 --- a/packages/markdown-template/src/TemplateMarkTransformer.js +++ b/packages/markdown-template/src/TemplateMarkTransformer.js @@ -14,6 +14,8 @@ 'use strict'; +/** @typedef {import('@accordproject/concerto-core').Serializer} Serializer */ + const { templateMarkManager, templateToTokens, @@ -95,11 +97,11 @@ class TemplateMarkTransformer { /** * Get TemplateMark serializer - * @return {object} templatemark serializer + * @return {Serializer} templatemark serializer */ getSerializer() { return templateMarkManager.serializer; } } -module.exports = TemplateMarkTransformer; \ No newline at end of file +module.exports = TemplateMarkTransformer; diff --git a/packages/markdown-template/types/lib/TemplateMarkTransformer.d.ts b/packages/markdown-template/types/lib/TemplateMarkTransformer.d.ts index 5c006ff5..d2409c8c 100644 --- a/packages/markdown-template/types/lib/TemplateMarkTransformer.d.ts +++ b/packages/markdown-template/types/lib/TemplateMarkTransformer.d.ts @@ -46,7 +46,11 @@ declare class TemplateMarkTransformer { toMarkdownTemplate(input: object): string; /** * Get TemplateMark serializer - * @return {object} templatemark serializer + * @return {Serializer} templatemark serializer */ - getSerializer(): object; + getSerializer(): Serializer; } +declare namespace TemplateMarkTransformer { + export { Serializer }; +} +type Serializer = import("@accordproject/concerto-core").Serializer;