Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand Down
10 changes: 7 additions & 3 deletions packages/markdown-html/src/HtmlTransformer.js
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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) {
Expand All @@ -55,12 +59,12 @@ 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);
return visitor.toCiceroMark(input);
}
}

module.exports = HtmlTransformer;
module.exports = HtmlTransformer;
14 changes: 10 additions & 4 deletions packages/markdown-html/types/lib/HtmlTransformer.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
3 changes: 2 additions & 1 deletion packages/markdown-template/lib/TemplateMarkTransformer.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

'use strict';

/** @typedef {import('@accordproject/concerto-core').Serializer} Serializer */
var {
templateMarkManager,
templateToTokens,
Expand Down Expand Up @@ -93,7 +94,7 @@ class TemplateMarkTransformer {

/**
* Get TemplateMark serializer
* @return {object} templatemark serializer
* @return {Serializer} templatemark serializer
*/
getSerializer() {
return templateMarkManager.serializer;
Expand Down
6 changes: 4 additions & 2 deletions packages/markdown-template/src/TemplateMarkTransformer.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@

'use strict';

/** @typedef {import('@accordproject/concerto-core').Serializer} Serializer */

const {
templateMarkManager,
templateToTokens,
Expand Down Expand Up @@ -95,11 +97,11 @@ class TemplateMarkTransformer {

/**
* Get TemplateMark serializer
* @return {object} templatemark serializer
* @return {Serializer} templatemark serializer
*/
getSerializer() {
return templateMarkManager.serializer;
}
}

module.exports = TemplateMarkTransformer;
module.exports = TemplateMarkTransformer;
Original file line number Diff line number Diff line change
Expand Up @@ -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;