feat: catalyst compression - brotli/zstd (#626)

* chore: update package versions to official ones

* feat: add catalyst_compression package

* docs: add algorithm sources

* feat: validate if compression is supported for given bytes

* docs: improve error messages

* fix: add missing dependency

* docs: fix markdown

* chore: add changelogs

catalyst_voices/pubspec.yaml

@@ -10,12 +10,9 @@ environment:
 dependencies:
   animated_text_kit: ^4.2.2
   animations: ^2.0.11
-  catalyst_cardano:
-    path: ../catalyst_voices_packages/catalyst_cardano/catalyst_cardano
-  catalyst_cardano_serialization:
-    path: ../catalyst_voices_packages/catalyst_cardano_serialization
-  catalyst_cardano_web:
-    path: ../catalyst_voices_packages/catalyst_cardano/catalyst_cardano_web
+  catalyst_cardano: ^0.1.2
+  catalyst_cardano_serialization: ^0.1.2
+  catalyst_cardano_web: ^0.1.2
   catalyst_voices_assets:
     path: ./packages/catalyst_voices_assets
   catalyst_voices_blocs:

catalyst_voices_packages/catalyst_cardano/catalyst_cardano/example/pubspec.yaml

@@ -9,12 +9,9 @@ environment:
   flutter: ">=3.22.1"
 
 dependencies:
-  catalyst_cardano:
-    path: "../"
-  catalyst_cardano_serialization:
-    path: "../"
-  catalyst_cardano_web:
-    path: "../../catalyst_cardano_web"
+  catalyst_cardano: ^0.1.2
+  catalyst_cardano_serialization: ^0.1.2
+  catalyst_cardano_web: ^0.1.2
   cbor: ^6.2.0
   convert: ^3.1.1
   cupertino_icons: ^1.0.6

catalyst_voices_packages/catalyst_compression/catalyst_compression/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+* Initial release.

catalyst_voices_packages/catalyst_compression/catalyst_compression/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright (c) 2023 Input Output (IOG).
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

catalyst_voices_packages/catalyst_compression/catalyst_compression/README.md

@@ -0,0 +1,131 @@
+# Content
+
+* [Content](#content)
+  * [Features](#features)
+  * [Requirements](#requirements)
+  * [Install](#install)
+  * [Web setup](#web-setup)
+  * [Example](#example)
+  * [Limitations](#limitations)
+  * [Support](#support)
+  * [License](#license)
+
+## Features
+
+This package exposes a JS wrapper around Brotli and zstd compression/decompression algorithms.
+
+* [brotli-wasm](https://www.npmjs.com/package/brotli-wasm)
+* [zstd-js](https://www.npmjs.com/package/@oneidentity/zstd-js)
+
+## Requirements
+
+* Dart: 3.3.4+
+* Flutter: 3.22.1+
+
+## Install
+
+```yaml
+dependencies:
+    catalyst_compression: any # or the latest version on Pub
+    catalyst_compression_web: any # or the latest version on Pub
+```
+
+## Web setup
+
+Add the following line at the end of `<head>` section in web/index.html:
+
+```html
+<script type="module" src="/assets/packages/catalyst_compression_web/assets/js/catalyst_compression.js"></script>
+```
+
+## Example
+
+```dart
+import 'package:catalyst_compression/catalyst_compression.dart';
+import 'package:convert/convert.dart';
+import 'package:flutter/foundation.dart';
+
+final derCertHex = '''
+308202343082019DA00302010202145A
+FC371DAF301793CF0B1835A118C2F903
+63D5D9300D06092A864886F70D01010B
+05003045310B30090603550406130241
+553113301106035504080C0A536F6D65
+2D53746174653121301F060355040A0C
+18496E7465726E657420576964676974
+7320507479204C7464301E170D323430
+3731313038353733365A170D32353037
+31313038353733365A3045310B300906
+03550406130241553113301106035504
+080C0A536F6D652D5374617465312130
+1F060355040A0C18496E7465726E6574
+205769646769747320507479204C7464
+30819F300D06092A864886F70D010101
+050003818D0030818902818100CD28E2
+0B157CA70C85433C1689B1D5890EC479
+BDD1FFDCC5647AE12BE9BADF4AF20764
+CD24BD64130831A57506DFBBDD3E924C
+96B259C6CCEDF24D6A25618F0819643C
+739F145B733C3C94333E5937B499ADA9
+A4FFC127457C7CB557F2F5623DCADEA1
+E06F09129DB9584B0AEE949244B3252B
+52AFDE5D385C65E563A6EFB07F020301
+0001A321301F301D0603551D0E041604
+1492EB169818B833588321957A846077
+AA239CF3A0300D06092A864886F70D01
+010B0500038181002E5F73333CE667E4
+172B252416EAA1D2E9681F59943724B4
+F366A8B930443CA6B69B12DD9DEBEE9C
+8A6307695EE1884DA4B00136195D1D82
+23D1C253FF408EDFC8ED03AF1819244C
+35D3843855FB9AF86E84FB7636FA3F4A
+0FC396F6FB6FD16D3BCEBDE68A8BD81B
+E61E8EE7D77E9F7F9804E03EBC31B458
+1313C955A667658B
+'''
+    .replaceAll('\n', '');
+
+void main() {
+  final rawBytes = hex.decode(derCertHex);
+
+  // brotli
+  final brotli = CatalystCompression.instance.brotli;
+  final brotliCompressed = brotli.compress(rawBytes);
+  final brotliDecompressed = brotli.decompress(brotliCompressed);
+
+  assert(
+    listEquals(rawBytes, brotliDecompressed),
+    'Original and decompressed bytes must be the same!',
+  );
+
+  // zstd
+  final zstd = CatalystCompression.instance.zstd;
+  final zstdCompressed = zstd.compress(rawBytes);
+  final zstdDecompressed = zstd.decompress(zstdCompressed);
+
+  assert(
+    listEquals(rawBytes, zstdDecompressed),
+    'Original and decompressed bytes must be the same!',
+  );
+}
+```
+
+## Limitations
+
+This package supports only web platform at the moment but it's intended that other platforms are supported in the future.
+
+## Support
+
+Post issues and feature requests on the GitHub [issue tracker](https://github.com/input-output-hk/catalyst-voices/issues).
+Please read our [CONTRIBUTING](https://github.com/input-output-hk/catalyst-voices/blob/main/CONTRIBUTING.md)
+for guidelines on how to contribute.
+
+## License
+
+Licensed under either of [Apache License, Version 2.0](https://github.com/input-output-hk/catalyst-voices/blob/main/LICENSE-APACHE)
+or [MIT license](https://github.com/input-output-hk/catalyst-voices/blob/main/LICENSE-MIT)
+at your option.
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
+be dual licensed as above, without any additional terms or conditions.

catalyst_voices_packages/catalyst_compression/catalyst_compression/analysis_options.yaml

@@ -0,0 +1,4 @@
+include: package:catalyst_analysis/analysis_options.1.0.0.yaml
+
+analyzer:
+  exclude: [build/**, lib/*.g.dart, lib/generated/**]