Skip to content

Latest commit

 

History

History
298 lines (170 loc) · 8.02 KB

CHANGELOG.md

File metadata and controls

298 lines (170 loc) · 8.02 KB

Change Log

3.0.0 - 2022-07-04

Added

2.1.0 - 2021-07-29

Added

  • Add skipEmptyTag option (#45).

2.0.0 - 2021-03-19

Added

  • Support for simple conditions (docs).
  • Support for custom data resolvers - enables advanced syntax support (docs).

Changed

  • BREAKING - Container closing tag name is ignored and no longer throws when the closing tag has different name than the opening one (docs).

1.0.1 - 2020-09-25

Changed

  • Update dependencies (jszip, xmldom).

1.0.0 - 2020-08-09

Stable release - from now on breaking changes to the public API (the public interface of TemplateHandler) will introduce a new major release.

Fixed

  • Initial content types parsing.
  • Bug in paragraph loops (#36).

0.12.0 - 2020-08-01

Added

  • Headers and footers support.

0.11.1 - 2020-03-29

Fixed

  • Consistent handling of RawXmlContent when the xml prop is null.

0.11.0 - 2020-03-29

Added

  • Support for RawXmlContent.replaceParagraph.

0.10.4 - 2020-03-02

Added

  • Expose "Community Extensions" on npm (readme changes).

0.10.3 - 2020-02-16

Fixed

  • Parsing of tags with custom delimiters.

0.10.2 - 2020-02-16

Fixed

  • Parsing of tags with custom delimiters.

0.10.1 - 2020-02-12

Fixed

  • Export extensions types.

0.10.0 - 2020-02-10

Added

  • Expose Docx.rawZipFile property.

0.9.0 - 2020-02-10

Added

  • Extensions API (#24).

0.8.3 - 2019-12-27

Added

  • Allow overriding container tag logic using explicit content type.

0.8.2 - 2019-11-30

Changed

  • ScopeData.getScopeData is now generic (#17).
  • The data argument of TemplateHandler.process is now strongly typed.
  • Bundle with Rollup instead of Webpack.
  • Auto generate typings.

0.8.1 - 2019-11-02

Fixed

  • Fix typings.

0.8.0 - 2019-10-20

Changed

  • BREAKING: Delimiters can not contain leading or trailing whitespace.
  • Loosen up TemplateHandlerOptions typings.

Fixed

  • Loop tag names trimming.
  • Custom loop delimiters support.
  • Zip export and typings.

0.7.3 - 2019-10-11

Added

0.7.2 - 2019-10-10

Fixed

  • Re-fix "Binary type 'Buffer' is not supported" on Node.

0.7.1 - 2019-10-03

Fixed

  • Link plugin in cases where the link tag is not the only node in it's run.

0.7.0 - 2019-10-02

Added

  • Link plugin.
  • TemplateHandler.version property.

0.6.0 - 2019-09-29

This version removes the notion of a "tag type" and uses instead the notion of "content type". Instead of inferring the type from the tag prefix the type is now explicitly declared in the supplied JSON data.

Example:

Before:

tag: "{@newPage}"  
data: {  
    newPage: "<w:br w:type="page"/>"
}

After:

tag: "{newPage}"
data: {
    newPage: {
        _type: "rawXml",
        xml: "<w:br w:type="page"/>"
    }
}

The only exceptions are the "loop" content type which still uses the "#" opening prefix and "/" closing prefix, and the "text" content type which is the default and does not requires explicitly stating it.

Added

  • Image plugin.
  • Support multi-character delimiters.
  • Template plugins can be async.
  • Improved the docs (readme).

Changed

  • BREAKING: RawXmlPlugin requires data of the form { _type: 'rawXml', xml: string }.

Removed

  • BREAKING: Remove the Tag.type property.

Fixed

  • Parsing error in some cases where multiple tags are declared in the same run.

0.5.2 - 2019-09-11

Fixed

  • "Binary type 'Buffer' is not supported." on Node 12.

0.5.1 - 2019-06-05

Fixed

  • Handle non-textual values (numbers, booleans...) in TextPlugin.

0.5.0 - 2019-05-07

Added

  • Loop over lists and table rows.
    Notice: The loop logic for tables is a bit different than the logic of the existing paragraph loop. Instead of repeating the content in between the opening and closing tags it repeats entire rows (including content in the row that appears before the opening or after the closing tag). The same goes for lists - the entire bullet is repeated.
  • Throw MalformedFileError when fails to open template file as zip.
  • Continuous integration with CircleCI.

Changed

  • Change dev stack to Babel, Jest and ESLint.

0.4.0 - 2018-12-13

Added

  • Easily find out what tags are present in a given template (TemplateHandler.parseTags).

0.3.4 - 2018-12-09

Added

  • Full browser example in readme file.

0.3.3 - 2018-07-17

Added

  • Package keywords for npm visibility.

0.3.2 - 2018-06-22

Fixed

  • Fix serialization of text nodes with empty values.

0.3.1 - 2018-06-13

Added

  • Add readme badges

0.3.0 - 2018-06-13

Added

  • Preserve leading and trailing whitespace
  • More info on missing delimiter errors

0.2.1 - 2018-06-12

Fixed

  • Various bug fixes

0.2.0 - 2018-06-12

Added

  • Typings file

0.1.0 - 2018-06-12

  • First version

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Types of changes

  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
  • Removed for now removed features.
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.