UNPKG

12.5 kBMarkdownView Raw
1# Changelog
2
3## Pending
4## 3.0.3 (2022-03-02)
5- STRF-9658 logger accepts strings instead of objects [#270](https://github.com/bigcommerce/paper/pull/270)
6
7# 3.0.2 (2022-02-23)
8- Bumps paper-handlebars to 4.5.3 [#269](https://github.com/bigcommerce/paper/pull/269)
9
10## 3.0.1 (2022-02-17)
11- Bumps paper-handlebars to 4.5.2 [#266](https://github.com/bigcommerce/paper/pull/266)
12## 3.0.0 (2022-02-08)
13* Deprecating 2x branch as it's not used and maintained anymore
14
15
16## 3.0.0-rc.54 (2022-01-31)
17* Revert some unused code that should have been removed as part of previous reversions [#260](https://github.com/bigcommerce/paper/pull/260)
18* Cleanup filterByKey [#261](https://github.com/bigcommerce/paper/pull/261)
19* Improve performance of Translator constructor through internal refactor of Transformer [#262](https://github.com/bigcommerce/paper/pull/262)
20
21## 3.0.0-rc.53 (2021-12-20)
22- STRF-9553 Fallback languages in the chain [#258](https://github.com/bigcommerce/paper/pull/258)
23
24## 3.0.0-rc.52 (2021-12-8)
25- Bumps paper-handlebars to 4.5.1 [#255](https://github.com/bigcommerce/paper/pull/255)
26
27## 3.0.0-rc.51 (2021-10-22)
28- Bumps paper-handlebars to 4.5.0 [#255](https://github.com/bigcommerce/paper/pull/255)
29
30## 3.0.0-rc.50 (2021-10-04)
31- Reverted messageformat library to 0.2.2 [#253](https://github.com/bigcommerce/paper/pull/253)
32-
33## 3.0.0-rc.49 (2021-09-16)
34- Bumps paper-handlebars to 4.4.9 [#252](https://github.com/bigcommerce/paper/pull/252)
35
36## 3.0.0-rc.48 (2021-07-20)
37- Upgrade deprecated messageformat library to @messageformat/core [#246](https://github.com/bigcommerce/paper/pull/246)
38
39## 3.0.0-rc.47 (2021-07-20)
40- Bump paper-handlebars to latest version, includes changes to support region translations [#245](https://github.com/bigcommerce/paper/pull/245)
41
42## 3.0.0-rc.46 (2021-06-17)
43- Do not break render operation if some translation key is not possible to precompile because of wrongly formatted value [#243](https://github.com/bigcommerce/paper/pull/243)
44
45## 3.0.0-rc.45 (2021-06-10)
46- Introduced disablePluralKeyChecks option for disabling plural keys
47[checks](http://messageformat.github.io/messageformat/v2/MessageFormat#disablePluralKeyChecks__anchor) on messageformat library [#241](https://github.com/bigcommerce/paper/pull/241)
48
49## 3.0.0-rc.44 (2021-05-18)
50- Bump messageformat library to latest version [#239](https://github.com/bigcommerce/paper/pull/239)
51
52## 3.0.0-rc.43 (2021-05-18)
53- Created an endpoint for precaching lang helper function [#235](https://github.com/bigcommerce/paper/pull/235)
54
55## 3.0.0-rc.42 (2021-05-11)
56- Improved filtering language object by key for langJSON helper, that was struggling with perfomance on GraalVM [#236](https://github.com/bigcommerce/paper/pull/236)
57
58## 3.0.0-rc.41 (2021-05-07)
59- Improved filtering language object by key for langJSON helper, that was struggling with perfomance on GraalVM [#234](https://github.com/bigcommerce/paper/pull/234)
60
61## 3.0.0-rc.40 (2021-03-30)
62- paper.loadTranslations now supports additional parameter to omit transforming translations [#231](https://github.com/bigcommerce/paper/pull/231)
63
64## 3.0.0-rc.39 (2021-03-15)
65- Bumps paper-handlebars to 4.4.7 [#230](https://github.com/bigcommerce/paper/pull/230)
66
67## 3.0.0-rc.38 (2021-03-15)
68- Added public interface for handlebars to add templates and preprocess them [#228](https://github.com/bigcommerce/paper/pull/228)
69- Bumps paper-handlebars to 4.4.6 [#229](https://github.com/bigcommerce/paper/pull/229)
70
71## 3.0.0-rc.37 (2021-02-12)
72- Bumps paper-handlebars to 4.4.4 [#226](https://github.com/bigcommerce/paper/pull/226)
73
74## 3.0.0-rc.36 (2020-12-15)
75- Bumps paper-handlebars to 4.4.3 [#223](https://github.com/bigcommerce/paper/pull/223)
76
77## 3.0.0-rc.35 (2020-11-17)
78- Bumps paper-handlebars to 4.4.2 [#219](https://github.com/bigcommerce/paper/pull/219)
79
80## 3.0.0-rc.34 (2020-11-16)
81- Rollback paper-handlebars to 4.4.1 [#216](https://github.com/bigcommerce/paper/pull/216)
82
83## 3.0.0-rc.33 (2020-09-21)
84- Bumps paper-handlebars to 4.5.0-rc.2 [#214](https://github.com/bigcommerce/paper/pull/214)
85
86## 3.0.0-rc.32 (2020-09-04)
87- Refactor Translator and drop unneeded dependency. Bumps paper-handlebars to 4.5.0-rc.1 [#208](https://github.com/bigcommerce/paper/pull/208)
88
89## 3.0.0-rc.31 (2020-08-28)
90- Bump paper-handlebars version to 4.4.1 [#204](https://github.com/bigcommerce/paper/pull/204)
91
92## 3.0.0-rc.30 (2020-08-25)
93- Bump paper-handlebars version to 4.4.0 [#202](https://github.com/bigcommerce/paper/pull/202)
94
95## 3.0.0-rc.29 (2020-06-05)
96- Bump paper-handlebars version to 4.3.2 [#199](https://github.com/bigcommerce/paper/pull/199)
97
98## 3.0.0-rc.28 (2020-02-21)
99- Bump paper-handlebars version to 4.3.1 [#195](https://github.com/bigcommerce/paper/pull/195)
100
101## 3.0.0-rc.27 (2020-01-29)
102- Bump paper-handlebars version to 4.3.0 [#193](https://github.com/bigcommerce/paper/pull/193)
103
104## 3.0.0-rc.26 (2019-10-16)
105- Fix Stencil language translation in Safari [#186](https://github.com/bigcommerce/paper/pull/186)
106
107## 3.0.0-rc.25 (2019-10-15)
108- Bump paper-handlebars version to 4.2.3 [#183](https://github.com/bigcommerce/paper/pull/183)
109- Refactor logging. You can now pass an optional console-like logger object which will be used for internal logging as well as Handlebars logging. [#183](https://github.com/bigcommerce/paper/pull/183)
110
111## 3.0.0-rc.24 (2019-10-09)
112- Bump paper version [#182](https://github.com/bigcommerce/paper/pull/182)
113- Fix renderTheme function so that it may work with Stencil CLI [#181](https://github.com/bigcommerce/paper/pull/181)
114
115## 3.0.0-rc.22 (2019-10-02)
116- Bump paper-handlebars version [#180](https://github.com/bigcommerce/paper/pull/180)
117- Bump paper-handlebars version to 4.2.2 [#179](https://github.com/bigcommerce/paper/pull/179)
118
119## 3.0.0-rc.20 (2019-08-06)
120- Bump paper-handlebars to 4.2.1 [#177](https://github.com/bigcommerce/paper/pull/177)
121
122## 3.0.0-rc.19 (2019-07-31)
123- Bump paper-handlebars to 4.2.0 [#175](https://github.com/bigcommerce/paper/pull/175)
124
125## 3.0.0-rc.18 (2019-07-29)
126- Bump paper-handlebars to 4.1.2 [#172](https://github.com/bigcommerce/paper/pull/172)
127
128## 3.0.0-rc.17 (2019-07-12)
129- Bump paper-handlebars to 4.1.1 [#171](https://github.com/bigcommerce/paper/pull/171)
130
131## 3.0.0-rc.16 (2019-07-10)
132- Bump paper-handlebars to 4.1.0 [#166](https://github.com/bigcommerce/paper/pull/166)
133
134## 3.0.0-rc.15 (2019-06-30)
135- Bump paper-handlebars to 4.0.9 [#165](https://github.com/bigcommerce/paper/pull/165)
136
137## 3.0.0-rc.14 (2019-06-30)
138- Bump paper-handlebars to 4.0.8 [#163](https://github.com/bigcommerce/paper/pull/163) to update Handlebars
139
140## 3.0.0-rc.13 (2019-05-24)
141- Bump paper-handlebars to 4.0.6 [#157](https://github.com/bigcommerce/paper/pull/157) to add display support for Google fonts
142
143## 3.0.0-rc.12 (2019-03-29)
144- Added an option to pass in logger and override the default logger of the app [#153](https://github.com/bigcommerce/paper/pull/153)
145
146## 3.0.0-rc.11 (2019-02-14)
147- Bump paper-handlebars to 4.0.4 [#150](https://github.com/bigcommerce/paper/pull/150) to fix
148 regex performance to match precompiled templates.
149
150## 3.0.0-rc.10 (2019-02-04)
151- Bump paper-handlebars to 4.0.4 [#149](https://github.com/bigcommerce/paper/pull/149) to fix
152 cdn url.
153
154## 3.0.0-rc.9 (2018-12-18)
155- Bump paper-handlebars to 4.0.3 [#143](https://github.com/bigcommerce/paper/pull/143) to fix
156 resourceHints to always use https for font providers.
157
158## 3.0.0-rc.8 (2018-12-7)
159- Bump paper-handlebars to 4.0.2 [#142](https://github.com/bigcommerce/paper/pull/142) to fix
160 `region` helper, should render regardless of empty content.
161
162## 3.0.0-rc.7 (2018-10-30)
163- Bump paper-handlebars to 4.0.1 [#140](https://github.com/bigcommerce/paper/pull/140) to fix
164 `cdnify` and avoid double slash in the generated url.
165
166## 3.0.0-rc.6 (2018-10-04)
167Breaking change:
168- Use paper-handlebars 4.0.0, which uses Promises for `render` and `renderString`.
169- Change `loadTheme`, `loadTemplates`, `loadTranslations`, `render`, `renderString`,
170 and `renderTheme` to be based on Promises rather than callbacks.
171
172## 3.0.0-rc.5 (2018-08-23)
173- Bump paper-handlebars to 3.0.3 [#136](https://github.com/bigcommerce/paper/pull/136) which adds support for
174 `gtnum` operator in `if` helper.
175
176## 3.0.0-rc.4 (2018-05-31)
177- Bump paper-handlebars to 3.0.2 [#135](https://github.com/bigcommerce/paper/pull/135) which adds the
178 `resourceHints` helper.
179
180## 3.0.0-rc.3 (2018-01-31)
181- Bump paper-handlebars to 3.0.1 [#132](https://github.com/bigcommerce/paper/pull/132) which has fixes for
182 cdn and stylesheet helpers.
183
184## 3.0.0-rc.2 (2018-01-31)
185- Remove access to siteSettings and themeSettings, use accessors instead [#131](https://github.com/bigcommerce/paper/pull/131)
186
187## 3.0.0-rc.1 (2018-01-24)
188- Major refactor, moving rendering functionality into paper-handlebars [#130](https://github.com/bigcommerce/paper/pull/130) to
189allow for alternate template engines.
190
191v3.0 Contains several breaking changes:
192- Removed the direct access of `contentServiceContext` for setting page content. From now on, use `setContent()`
193 and `getContent()`.
194- Removed direct access of `siteSettings` and `themeSettings`. From now on, use `getSiteSettings()`, `setSiteSettings()`,
195 `getThemeSettings()`, and `setThemeSettings()` if you need to get/set these values after calling the constructor.
196- Removed `getTemplateProcessor()`. This is an internal concern of `paper-handlebars` and is used by `loadTemplates`.
197- Removed `loadTemplatesSync()`. This was only used by helper tests and is no longer needed.
198- Removed `handlebars` instance variable. Hopefully nobody is accessing that directly. Any helpers that were accessing
199 it have been updated in `paper-handlebars` to use the global context they are given rather than accessing Paper
200 directly at all.
201- The `translator` attribute has been moved to `paper-handlebars` and is no longer accessible directly on Paper.
202- The `decorators` attribute has been moved to `paper-handlebars` and is no longer accessible directly on Paper.
203- The `settings` attribute has been renamed to `siteSettings`. This should only be accessed by `paper-handlebars`.
204- The `cdnify()` function has been moved into a helper library in `paper-handlebars`.
205- The `inject` attribute has been removed. This is storage used by two of the helpers, and the implementation has
206 moved to `paper-handlebars`.
207
208## 2.0.9 (2018-08-14)
209- Add `gtnum` support to `if` helper [#138](https://github.com/bigcommerce/paper/pull/138)
210
211## 2.0.8 (2018-05-09)
212- Add resourceHints helper [#133](https://github.com/bigcommerce/paper/pull/133)
213
214## 2.0.7 (2017-10-17)
215- Always render region wrapper even if no content is present [#128](https://github.com/bigcommerce/paper/pull/128)
216
217## 2.0.6 (2017-09-20)
218- Fix a bug in the `replace` helper [#127](https://github.com/bigcommerce/paper/pull/127)
219
220## 2.0.5 (2017-09-15)
221- Added support to use operators in the `unless` helper [#126](https://github.com/bigcommerce/paper/pull/126)
222- Fix a bug in the `replace` helper [#125](https://github.com/bigcommerce/paper/pull/125)
223
224## 2.0.4 (2017-08-21)
225- Lodash deprecated method replaced [#121](https://github.com/bigcommerce/paper/pull/121)
226- Added a test to `first` helper [#120](https://github.com/bigcommerce/paper/pull/120)
227
228## 2.0.3 (2017-06-21)
229- Add `region` helper to render content blocks [#118](https://github.com/bigcommerce/paper/pull/118)
230
231## 2.0.2 (2017-04-20)
232- Bug fix in the `stylesheet` helper [#116](https://github.com/bigcommerce/paper/pull/116)
233
234## 2.0.1 (2017-04-12)
235- Adds the `{{thumbnailImage}}` helper and removes the non-existent `{{thumbnail}}` helper [#114](https://github.com/bigcommerce/paper/pull/114)
236
237## 2.0.0 (2017-04-11)
238- Remove configId from cdn/assets urls for preventing busting the cached assets when configId changes [#112](https://github.com/bigcommerce/paper/pull/112)
239- Update docs to describe the interface required by paper for assembler and callbacks [#111](https://github.com/bigcommerce/paper/pull/111)
240- Adds and exposes the helpers we've selected from the handlebars-helpers library [#110](https://github.com/bigcommerce/paper/pull/110)
241
242## 1.2.0 (2017-02-23)
243- Add a helper that can truncate text. [#106](https://github.com/bigcommerce/paper/pull/106), [#108](https://github.com/bigcommerce/paper/pull/108)
244- Add a helper that can render language strings as a JSON object. [#103](https://github.com/bigcommerce/paper/pull/103)
245- Fix an issue where language strings may not be formatted properly (i.e.: pluralization and gender) when they are cascaded. [#103](https://github.com/bigcommerce/paper/pull/103)