This commit is contained in:
Alexander Cerutti
2021-10-31 22:04:51 +01:00
parent 1d6fc00c56
commit 267d8a6e8c
3 changed files with 398 additions and 392 deletions

View File

@@ -1,390 +1,396 @@
# Changelog # Changelog
Since every new minor, major or patch version is pushed in the repository with the npm autogenerated commit for version update, a history become needed. Since every new minor, major or patch version is pushed in the repository with the npm autogenerated commit for version update, a history become needed.
The lists won't include the npm autogenerated commit. The lists won't include the npm autogenerated commit.
## 2.0.8 - 25/08/21 ## 3.0.0 / 3.0.1 - 31/10/21
Added support for optional NFC key `requiresAuthentication`; Passkit-generator has been completely refactored and re-conceptualized. Follow [Migration Guide v2 to v3](https://github.com/alexandercerutti/passkit-generator/wiki/Migrating-from-v2-to-v3) to see the differences between the two versions
Added support for semantics as a global overridable property;
Renamed files to conform to Apple naming in documentation; ---
Added documentation links in files;
## 2.0.8 - 25/08/21
## 2.0.7 - 21/06/21
Added support for optional NFC key `requiresAuthentication`;
Fixed wrong Schemas keys (ignore*s*TimeZone and dataDetectorType*s*); Added support for semantics as a global overridable property;
Added more SemanticsTagTypes Renamed files to conform to Apple naming in documentation;
Refactored Error system; Added documentation links in files;
Refactored Schemas;
Updated Dependencies; ## 2.0.7 - 21/06/21
Removed unnecessary ways to perfom ways in refactoring;
Fixed wrong Schemas keys (ignore*s*TimeZone and dataDetectorType*s*);
## 2.0.6 - 09/02/21 Added more SemanticsTagTypes
Refactored Error system;
Improved building phase; Refactored Schemas;
Improved tests; Updated Dependencies;
Updated dependencies (like node-forge and node-fetch, which had critical vulnerability); Removed unnecessary ways to perfom ways in refactoring;
Added prettier for formatting;
Generic improvements to code; ## 2.0.6 - 09/02/21
Removed moment.js for an internal generation of the date (without timezone support);
Improved building phase;
## 2.0.5 - 06/09/20 Improved tests;
Updated dependencies (like node-forge and node-fetch, which had critical vulnerability);
Replaced deprecated dependencies @hapi/joi with Sideway's joi; Added prettier for formatting;
Generic dependencies update; Generic improvements to code;
Generic code improvements (vscode-autofixes included); Removed moment.js for an internal generation of the date (without timezone support);
Bumped minimum Node.JS supported version to 10 (moved from `util.promisify` approach to `fs.promises`);
## 2.0.5 - 06/09/20
## 2.0.4 - 14/12/19
Replaced deprecated dependencies @hapi/joi with Sideway's joi;
Typescript strict configuration fixes; Generic dependencies update;
Improved specifications; Generic code improvements (vscode-autofixes included);
Bumped minimum Node.JS supported version to 10 (moved from `util.promisify` approach to `fs.promises`);
## 2.0.3 - 06/12/19
## 2.0.4 - 14/12/19
Dependencies Updates;
More improvements; Typescript strict configuration fixes;
Improved specifications;
## 2.0.2
## 2.0.3 - 06/12/19
Unlocked some other prohibited (until now) fields that were not editable due to design choice ( organizationName, passTypeIdentifier, teamIdentifier, appLaunchURL, associatedStoreIdentifiers);
Small improvements; Dependencies Updates;
More improvements;
---
## 2.0.2
## 2.0.1
Unlocked some other prohibited (until now) fields that were not editable due to design choice ( organizationName, passTypeIdentifier, teamIdentifier, appLaunchURL, associatedStoreIdentifiers);
Typescript version update; Small improvements;
Update to webServiceURL schema regex and allowed all characters for authenticationToken;
---
---
## 2.0.1
## 2.0.0
Typescript version update;
This version brings lot of improvements and breaking changes. Update to webServiceURL schema regex and allowed all characters for authenticationToken;
Please refer to the [Migration Guide](https://github.com/alexandercerutti/passkit-generator/wiki/Migrating-from-v1-to-v2) for the most important changes.
---
---
## 2.0.0
## 1.6.8
This version brings lot of improvements and breaking changes.
[ [#74903938b](/commit/74903938be565fbd8bdb4e99aae2129caf5f1dc6) ] Please refer to the [Migration Guide](https://github.com/alexandercerutti/passkit-generator/wiki/Migrating-from-v1-to-v2) for the most important changes.
Added optional row attribute for auxiliaryFields ---
--- ## 1.6.8
## 1.6.6 [ [#74903938b](/commit/74903938be565fbd8bdb4e99aae2129caf5f1dc6) ]
[ [#f37f978e2](/commit/f37f978e2c614d3eb9df001bd059a056ff1b6952) ] Added optional row attribute for auxiliaryFields
Fixed problem with fieldsArray: fields were being added even if the keys check was failing ---
--- ## 1.6.6
## 1.6.5 [ [#f37f978e2](/commit/f37f978e2c614d3eb9df001bd059a056ff1b6952) ]
[ [#f29203149](/commit/f2920314947e8e45f00bcfb83be676261950d37a) ] Fixed problem with fieldsArray: fields were being added even if the keys check was failing
Added support for logoText in supportedOptions (issues #21, #28) ---
[ [#6451a3c37](/commit/6451a3c37866cbdd88b275a4bc3fdff46c3bd3c7) ] ## 1.6.5
Fixed nfc methods which was accepting and registering an array instead of an object [ [#f29203149](/commit/f2920314947e8e45f00bcfb83be676261950d37a) ]
[ [#4ce889d65](/commit/4ce889d6558678f01a993dcbd3e60b568e787638) ] Added support for logoText in supportedOptions (issues #21, #28)
Adding support for native Dates (#32) [ [#6451a3c37](/commit/6451a3c37866cbdd88b275a4bc3fdff46c3bd3c7) ]
[ [#0e46d855e](/commit/0e46d855e43c2fd736aee0e43c5c993fbc41a0b9) ] Fixed nfc methods which was accepting and registering an array instead of an object
Fixing passes parallel generation (#31) [ [#4ce889d65](/commit/4ce889d6558678f01a993dcbd3e60b568e787638) ]
--- Adding support for native Dates (#32)
## 1.6.4 [ [#0e46d855e](/commit/0e46d855e43c2fd736aee0e43c5c993fbc41a0b9) ]
[ [#903192522](/commit/903192522c2646c42a020b5c554ca263315094fc) ] Fixing passes parallel generation (#31)
Added windows path slash parsing ---
--- ## 1.6.4
## 1.6.1 --> 1.6.3 [ [#903192522](/commit/903192522c2646c42a020b5c554ca263315094fc) ]
[ Subsequent commits ] Added windows path slash parsing
Fixes to problems in 1.6.1 ---
[ [#baf096c38](/commit/baf096c38067aae0ec459487db865851531f97b2) ] ## 1.6.1 --> 1.6.3
Moved some utility functions to a separate file [ Subsequent commits ]
[ [#37a9a051c](/commit/37a9a051c6c54216c7937520e7a144c83caa0bdb) ] Fixes to problems in 1.6.1
Removed rgbValues as a variable for a direct approact [ [#baf096c38](/commit/baf096c38067aae0ec459487db865851531f97b2) ]
[ [#3de654759](/commit/3de6547591fc69464b235e55381343a60adaba09) ] Moved some utility functions to a separate file
Renamed _validateType in _hasValidType [ [#37a9a051c](/commit/37a9a051c6c54216c7937520e7a144c83caa0bdb) ]
[ [#17e64a08a](/commit/17e64a08aec63026b738af5d779185aad2433bb7) ] Removed rgbValues as a variable for a direct approact
Fixed barcode legacy bug [ [#3de654759](/commit/3de6547591fc69464b235e55381343a60adaba09) ]
[ [#3338ff7b8](/commit/3338ff7b8fe57d9496f2e50306a5c44ea2a78b3a) ] Renamed _validateType in _hasValidType
Added NO_PASS_TYPE as message [ [#17e64a08a](/commit/17e64a08aec63026b738af5d779185aad2433bb7) ]
[ [#bd8643b20](/commit/bd8643b2089fd637c86ab47162cfceff45f18a48) ] Fixed barcode legacy bug
Moved passExtractor function to class scope instead of generate()'s [ [#3338ff7b8](/commit/3338ff7b8fe57d9496f2e50306a5c44ea2a78b3a) ]
[ [#18893ac74](/commit/18893ac7421518d2cf1d404060ccda7ceea145c5) ] Added NO_PASS_TYPE as message
Moved to async/await approach for generate() [ [#bd8643b20](/commit/bd8643b2089fd637c86ab47162cfceff45f18a48) ]
--- Moved passExtractor function to class scope instead of generate()'s
## 1.6.0 [ [#18893ac74](/commit/18893ac7421518d2cf1d404060ccda7ceea145c5) ]
[ [#c559a7f1c](/commit/c559a7f1ceb69f9af07234377a38fbc3eb40a1ba) ] Moved to async/await approach for generate()
Improved unique fields management; ---
Changed debug message for discarded fields;
Renamed uniqueKeys to fieldsKeys ## 1.6.0
[ [#f7d082352](/commit/f7d082352872218fd99c0cf2991145ec28395f04) ] [ [#c559a7f1c](/commit/c559a7f1ceb69f9af07234377a38fbc3eb40a1ba) ]
Added BRC_BW_FORMAT_UNSUPPORTED to not let PKBarcodeFormatCode128 to be used as backward barcode format Improved unique fields management;
Changed debug message for discarded fields;
[ [#43e687b2f](/commit/43e687b2f42b687222d61abdcc78b8b88011d6c1) ] Renamed uniqueKeys to fieldsKeys
Added support for row field in auxiliaryFields [ [#f7d082352](/commit/f7d082352872218fd99c0cf2991145ec28395f04) ]
[ [#40f72ac43](/commit/40f72ac434e4eaf2c9e2dbc8bf7d135c97df0f4c) ] Added BRC_BW_FORMAT_UNSUPPORTED to not let PKBarcodeFormatCode128 to be used as backward barcode format
Added support to semantics keys to fields in schema [ [#43e687b2f](/commit/43e687b2f42b687222d61abdcc78b8b88011d6c1) ]
--- Added support for row field in auxiliaryFields
## 1.5.9 [ [#40f72ac43](/commit/40f72ac434e4eaf2c9e2dbc8bf7d135c97df0f4c) ]
[ [#7bad48107](/commit/7bad48107015aa8339037bc1069fd41a3efbf2d2) ] Added support to semantics keys to fields in schema
Removed check for changeMessage as per issue topic #15 ---
[ [#fd5efded1](/commit/fd5efded1124b0f7de6c1e69d6a1a28e1bb7bf2b) ] ## 1.5.9
Added pass.strings file concatenation with translations if it already exists [ [#7bad48107](/commit/7bad48107015aa8339037bc1069fd41a3efbf2d2) ]
in specific folder;
Removed check for changeMessage as per issue topic #15
[ [#d992b392c](/commit/d992b392c585dffcb32eb0720dfa4b103cfb926c) ]
[ [#fd5efded1](/commit/fd5efded1124b0f7de6c1e69d6a1a28e1bb7bf2b) ]
Small changes to messages;
Added pass.strings file concatenation with translations if it already exists
--- in specific folder;
## 1.5.8 [ [#d992b392c](/commit/d992b392c585dffcb32eb0720dfa4b103cfb926c) ]
[ [#654e2b5dc](/commit/654e2b5dce7b4297795d6ba93b8eb23fee8e5795) ] Small changes to messages;
Now checking both static list and remote list before raising the error for missing files ---
(thank you, Artsiom Aliakseyenka);
## 1.5.8
[ [#a62d8f35e](/commit/a62d8f35ea00021562ff4855dbb2e6a00001534a) ]
[ [#654e2b5dc](/commit/654e2b5dce7b4297795d6ba93b8eb23fee8e5795) ]
Renamed __barcodeAutogen to barcodesFromUncompleteData and moved it outside of Pass class;
Now checking both static list and remote list before raising the error for missing files
Renamed __barcodeAutocomplete to Symbol/barcodesFillMissing; (thank you, Artsiom Aliakseyenka);
Renamed __barcodeChooseBackward to Symbol/barcodesSetBackward; [ [#a62d8f35e](/commit/a62d8f35ea00021562ff4855dbb2e6a00001534a) ]
Removed context binding when passing above methods with alises after using .barcode(); Renamed __barcodeAutogen to barcodesFromUncompleteData and moved it outside of Pass class;
[ [#d5d4d9617](/commit/d5d4d9617f50bd5a709a260d4c1312fee69359d2) ] Renamed __barcodeAutocomplete to Symbol/barcodesFillMissing;
Edited BRC_ATC_MISSING_DATA message Renamed __barcodeChooseBackward to Symbol/barcodesSetBackward;
--- Removed context binding when passing above methods with alises after using .barcode();
## 1.5.7 [ [#d5d4d9617](/commit/d5d4d9617f50bd5a709a260d4c1312fee69359d2) ]
[ [#c0994b80b](/commit/c0994b80be62023872de0251b45d19a66145f9ef) ] Edited BRC_ATC_MISSING_DATA message
Moved tests to spec folder with jasmine configuration ---
[ [#33ca24d28](/commit/33ca24d28d09caad6c5eb0cde949b13a9053faf3) ] ## 1.5.7
Fixed barcodes validation problem [ [#c0994b80b](/commit/c0994b80be62023872de0251b45d19a66145f9ef) ]
[ [#7c2540a93](/commit/7c2540a93d46e0ba71400b2eb5e0fceee9dd6445) ] Moved tests to spec folder with jasmine configuration
Re-engineered FieldContainer (now FieldsArray) to extend successfully array with its methods. [ [#33ca24d28](/commit/33ca24d28d09caad6c5eb0cde949b13a9053faf3) ]
--- Fixed barcodes validation problem
## 1.5.6 [ [#7c2540a93](/commit/7c2540a93d46e0ba71400b2eb5e0fceee9dd6445) ]
[ [#5e917d6db](/commit/5e917d6dbbf4445480bb4a5cd782745f7f391194) ] Re-engineered FieldContainer (now FieldsArray) to extend successfully array with its methods.
Updated documentation ---
[ [#bf2b8f655](/commit/bf2b8f655e35e0d9d1a7d6e837c9a234fd663a41) ] ## 1.5.6
Added content-certificates support; [ [#5e917d6db](/commit/5e917d6dbbf4445480bb4a5cd782745f7f391194) ]
Fixed problem with supported options
Updated documentation
[ [#a9f71f113](/commit/a9f71f113d1093532c6899e05abcdf540be3ac17) ]
[ [#bf2b8f655](/commit/bf2b8f655e35e0d9d1a7d6e837c9a234fd663a41) ]
Added description to be available for override (thank you, Artsiom Aliakseyenka);
Added content-certificates support;
--- Fixed problem with supported options
## 1.5.5 [ [#a9f71f113](/commit/a9f71f113d1093532c6899e05abcdf540be3ac17) ]
[ [#14582ba9d](/commit/14582ba9d0fc15fcbdb350b96120b1f85846fa58) ] Added description to be available for override (thank you, Artsiom Aliakseyenka);
Schema: changed webServiceURL Regex and authenticationToken binding to this one ---
[ [#02a932ce7](/commit/02a932ce7a9eac0b444ba0367f861bdbb701c880) ] ## 1.5.5
Schema: removed filter function for getValidated to return empty object in case of error; [ [#14582ba9d](/commit/14582ba9d0fc15fcbdb350b96120b1f85846fa58) ]
Added OVV_KEYS_BADFORMAT message to throw in case of error; Schema: changed webServiceURL Regex and authenticationToken binding to this one
--- [ [#02a932ce7](/commit/02a932ce7a9eac0b444ba0367f861bdbb701c880) ]
## 1.5.4 Schema: removed filter function for getValidated to return empty object in case of error;
[ [#71cb678cf](/commit/71cb678cfa7b9934f4f441acd013de0f2b40ca9f) ] Added OVV_KEYS_BADFORMAT message to throw in case of error;
Added .npmignore to exclude examples upload ---
[ [#1d1f9f9c9](/commit/1d1f9f9c9082d49a5252c4fe8f98e8c8a0a61930) ] ## 1.5.4
Replaced findIndex for find to get directly the pass type. [ [#71cb678cf](/commit/71cb678cfa7b9934f4f441acd013de0f2b40ca9f) ]
[ [#b32c2efcd](/commit/b32c2efcd096a29b374cc1c2ff0f8506023c7d5c) ] Added .npmignore to exclude examples upload
Added function assignLength to wrap new objects with length property. [ [#1d1f9f9c9](/commit/1d1f9f9c9082d49a5252c4fe8f98e8c8a0a61930) ]
[ [#e4b3436b4](/commit/e4b3436b468b196649097e2f4c43b7f44ae1b073) ] Replaced findIndex for find to get directly the pass type.
Converted schemas arrow functions to functions and added descriptive comments. [ [#b32c2efcd](/commit/b32c2efcd096a29b374cc1c2ff0f8506023c7d5c) ]
[ [#5e4d3b8ca](/commit/5e4d3b8ca1366fd4b30eeb674665a5ee149be087) ] Added function assignLength to wrap new objects with length property.
Added noop function instead creating new empty functions. [ [#e4b3436b4](/commit/e4b3436b468b196649097e2f4c43b7f44ae1b073) ]
--- Converted schemas arrow functions to functions and added descriptive comments.
## 1.5.3 [ [#5e4d3b8ca](/commit/5e4d3b8ca1366fd4b30eeb674665a5ee149be087) ]
[ [#56da2a390](/commit/56da2a3908c0d54a73288ca13f223a909d997998) ] Added noop function instead creating new empty functions.
Bugfix: when overrides is not passed as option, the pass does not get generated. ---
--- ## 1.5.3
## 1.5.2 [ [#56da2a390](/commit/56da2a3908c0d54a73288ca13f223a909d997998) ]
[ [#47ff693b6](/commit/47ff693b662d495fa1012d8a7c90880fb50e056b) ] Bugfix: when overrides is not passed as option, the pass does not get generated.
Added schema support for sharingProhibited (not documented in ppfr) ---
--- ## 1.5.2
## 1.5.1 [ [#47ff693b6](/commit/47ff693b662d495fa1012d8a7c90880fb50e056b) ]
[ [#572605ef4](/commit/572605ef471c28c3e19e84f0a050af0949301f1a) ] Added schema support for sharingProhibited (not documented in ppfr)
Updated declaration file ---
[ [#9a9d883d3](/commit/9a9d883d3fb00716790ba785bbda1ffc5f7563ce) ] ## 1.5.1
Fixed problem in error message resolving on multiple %s; [ [#572605ef4](/commit/572605ef471c28c3e19e84f0a050af0949301f1a) ]
Added debug messages in messages.js; Updated declaration file
Added more comments; [ [#9a9d883d3](/commit/9a9d883d3fb00716790ba785bbda1ffc5f7563ce) ]
Moved literal debug messages to messages.js; Fixed problem in error message resolving on multiple %s;
Edited formatMessage (was formatError) to check also among debugMessages Added debug messages in messages.js;
[ [#27339bfda](/commit/27339bfdac3f973b10e111a9604fd32db5c074fc) ] - Minor improvements Added more comments;
--- Moved literal debug messages to messages.js;
## 1.5.0 Edited formatMessage (was formatError) to check also among debugMessages
[ [#cf5c99b16](/commit/cf5c99b16a62613e6225fbf0d5587aa8bb58616b) ] [ [#27339bfda](/commit/27339bfdac3f973b10e111a9604fd32db5c074fc) ] - Minor improvements
Moved _parseCertificates outside of pass and renamed it in readCertificates; ---
Changed readCertificates to return object containing name:parsed-pem; ## 1.5.0
Added readCertificates and this.Certificates merging before model reading; [ [#cf5c99b16](/commit/cf5c99b16a62613e6225fbf0d5587aa8bb58616b) ]
--- Moved _parseCertificates outside of pass and renamed it in readCertificates;
## 1.4.2 Changed readCertificates to return object containing name:parsed-pem;
[ [#92fc5f826](/commit/92fc5f8264e14f89bfff039dc7985493b74d5c7b) ] Added readCertificates and this.Certificates merging before model reading;
Minor changes to READMEs and core. ---
[ [#96e2b628f](/commit/96e2b628fe0204a188d7dbb32bf125a987100caf) ] ## 1.4.2
Updated documentation [ [#92fc5f826](/commit/92fc5f8264e14f89bfff039dc7985493b74d5c7b) ]
--- Minor changes to READMEs and core.
## 1.4.1 [ [#96e2b628f](/commit/96e2b628fe0204a188d7dbb32bf125a987100caf) ]
[ [#4b65e76be](/commit/4b65e76be76c6e6a33a53f16c5447396fb307c2c), Updated documentation
[#2a71d0778](/commit/2a71d07788e286da993b601791dba8778152fd6d) ]
---
[PR MERGE] Fix model initialization validation
## 1.4.1
[ [#96e2b628f](/commit/153108ad446ef4d8827207a3dcbb27108c0e4d7a) ]
[ [#4b65e76be](/commit/4b65e76be76c6e6a33a53f16c5447396fb307c2c),
Improved README [#2a71d0778](/commit/2a71d07788e286da993b601791dba8778152fd6d) ]
[ [#96e2b628f](/commit/ab6dd4ff68309d5b678eef36182272576790e12b) ] [PR MERGE] Fix model initialization validation
Added logo in assets and README [ [#96e2b628f](/commit/153108ad446ef4d8827207a3dcbb27108c0e4d7a) ]
[ [#96e2b628f](/commit/b305633ed382043567fef6ac4f771febf401d001) ] Improved README
Added updates for OpenSSL for Windows in termal steps for cers generation [ [#96e2b628f](/commit/ab6dd4ff68309d5b678eef36182272576790e12b) ]
[ [#9055390bb](/commit/9055390bb32bce571857d6e348e34696fa9c3738) ] Added logo in assets and README
Updated dependencies minimum version [ [#96e2b628f](/commit/b305633ed382043567fef6ac4f771febf401d001) ]
--- Added updates for OpenSSL for Windows in termal steps for cers generation
## 1.4.0 [ [#9055390bb](/commit/9055390bb32bce571857d6e348e34696fa9c3738) ]
[ [#1ca53adc4](/commit/1ca53adc4debeb67d9a65797ffabd90841de8c21) ] Updated dependencies minimum version
Added working example for load ---
[ [#4b2aa68ff](/commit/4b2aa68ffba1dec2a55126e4d2067f7150b8188c) ] ## 1.4.0
Added .load type definition [ [#1ca53adc4](/commit/1ca53adc4debeb67d9a65797ffabd90841de8c21) ]
[ [#8398e077b](/commit/8398e077b1988512af57852e2c7a881a9f2abedf) ] Added working example for load
Fix typos for non-mac guide [ [#4b2aa68ff](/commit/4b2aa68ffba1dec2a55126e4d2067f7150b8188c) ]
[ [#2e344e436](/commit/2e344e4367a395a66796a83e21657eec492373d1) ] Added .load type definition
Added .load to documentation; [ [#8398e077b](/commit/8398e077b1988512af57852e2c7a881a9f2abedf) ]
Removed express from dev dependencies;
Fix typos for non-mac guide
[ [#b68dfe0d8](/commit/b68dfe0d8025a68b137cfc37c8b9f34a404c05e7) ]
[ [#2e344e436](/commit/2e344e4367a395a66796a83e21657eec492373d1) ]
Added .load function to fetch pictures from the web and implemented fetching function inside logic flow
Added .load to documentation;
Removed express from dev dependencies;
[ [#b68dfe0d8](/commit/b68dfe0d8025a68b137cfc37c8b9f34a404c05e7) ]
Added .load function to fetch pictures from the web and implemented fetching function inside logic flow

2
package-lock.json generated
View File

@@ -1,6 +1,6 @@
{ {
"name": "passkit-generator", "name": "passkit-generator",
"version": "3.0.0", "version": "3.0.1",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {

View File

@@ -1,6 +1,6 @@
{ {
"name": "passkit-generator", "name": "passkit-generator",
"version": "3.0.0", "version": "3.0.1",
"description": "The easiest way to generate custom Apple Wallet passes in Node.js", "description": "The easiest way to generate custom Apple Wallet passes in Node.js",
"main": "lib/index.js", "main": "lib/index.js",
"scripts": { "scripts": {