UNPKG

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