protons-runtime

Shared code to make your bundle smaller when running protons in your app

About

This module contains serialization/deserialization code used when encoding/decoding protobufs.

It should be declared as a dependency of your project:

npm i protons-runtime

Install

$ npm i protons-runtime

Contains shared code to reduce code duplication between modules transpiled by protons.

API Docs

• https://ipfs.github.io/protons/modules/protons_runtime.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

3.1.1 (2024-08-08)

Bug Fixes

• add publish script (68e1092)

3.1.0 (2024-08-07)

Features

• add error names (#140) (2a3b047)

3.0.1 (2024-08-07)

Dependencies

• bump @bufbuild/protobuf from 1.10.0 to 2.0.0 (#139) (bbe93a2)

3.0.0 (2024-08-07)

⚠ BREAKING CHANGES

• singular fields should be optional to write (#83)
• ts definitions will need to be generated from .proto files - singular message fields have become optional as message fields are always optional in proto3
• the exported types of protons-runtime have changed and protobuf encoders/decoders will need to be regenerated
• Uses Uint8ArrayList v2
• This module is now ESM only

Features

• add custom protons options for limiting list/map sizes (#120) (a5ba36b), closes #113
• add strict option to CLI (#119) (8c039c5)
• add support for maps (#75) (e8dfc0a)
• allow limiting nested repeating fields (#129) (a81f997)
• define default types during decode (#62) (6453809), closes #43
• runtime size limits for arrays and maps (#128) (a737d05)
• support jstype custom options (#117) (ba35475), closes #112
• support no-copy serialization (#54) (caa0d71)
• transpile to ts (#17) (74d3b7a)

Bug Fixes

• add uint8arraylist peer dep (#61) (eb16e86), closes #59
• adhere more closely to the language guide for proto3 default values (#66) (406d775), closes #43
• encode enum values (#30) (676c01d)
• improve uint64 perf (#122) (3234bb6)
• increase encoding/decoding performance (#58) (9987b97)
• only import reader/writer to decrease bundle size (#69) (8eea129)
• port protobuf reader/writer to ts (#60) (d101804)
• remove redundant defs and declare codec return type (#28) (c3ea5ec)
• remove writing default values (#88) (078c62f)
• single instance codec (#55) (66d9387), closes #51
• singular fields should be optional to write (#83) (229afbc), closes #42
• sort imports (#84) (6f796f1)
• support empty messages (#78) (8a02910)
• throw when .proto is empty (#81) (ed392cb)
• throw when unsupported fields are detected (#80) (8108875), closes #34
• tidy up formatting of generated code (#57) (387c9e9)
• treat nested enums as enums and not messages (#87) (3af689b)
• update aegir, make codec creation dynamic (#26) (ecc46cc)
• update project config (3199131)
• update sibling dep versions (a77d027)
• use CLI flag --output (#46) (58dc0ba)
• use uint8-varint, byte-accesor and longbits modules (#56) (66d72f5)
• use uint8arrays alloc for new buffers (#123) (d1bfc94)
• write string into output buffer as uint8array (#118) (03ab706)

Trivial Changes

• add or force update .github/workflows/js-test-and-release.yml (#111) (9898b47)
• add protobuf-ts to benchmarks (#68) (559191d)
• benchmark Protobuf-ES (#89) (47a4dcb)
• delete templates [skip ci] (#110) (196ca52)
• fix generated code (b6a9c18)
• move bad fixtures to separate directory (#82) (76aa198)
• release: 1.0.0 [skip ci] (5aa82f7), closes #17
• release: 1.0.1 [skip ci] (398f066), closes #26
• release: 1.0.2 [skip ci] (193dbfe), closes #27
• release: 1.0.3 [skip ci] (6a078c0), closes #28
• release: 1.0.4 [skip ci] (ab0d4ac), closes #30
• release: 2.0.0 [skip ci] (3fec56a), closes #54
• release: 2.0.1 [skip ci] (b2d78dd)
• release: 2.0.2 [skip ci] (8bf01d0), closes #56
• release: 3.0.0 [skip ci] (fd1622d), closes #58
• release: 3.0.0 [skip ci] (6fd81c1), closes #17 #19
• release: 3.0.1 [skip ci] (25e46dd), closes #59
• release: 3.0.1 [skip ci] (64fe094), closes #22 #21
• release: 3.0.2 [skip ci] (f85d3fb), closes #26 #27
• release: 3.0.3 [skip ci] (d85a9f4), closes #28
• release: 3.0.4 [skip ci] (9915f7c), closes #30
• release: 3.0.5 [skip ci] (9b973ee), closes #46
• release: 3.1.0 [skip ci] (d1b93c8), closes #43
• release: 4.0.0 [skip ci] (7a02ec4), closes #43
• release: 4.0.0 [skip ci] (6ec6ef9), closes #54
• release: 4.0.1 [skip ci] (4f92c90), closes #69
• release: 4.0.1 [skip ci] (8991c51), closes #56
• release: 4.0.2 [skip ci] (3317a6a), closes #76
• release: 4.0.2 [skip ci] (411c017), closes #51
• release: 4.0.3 [skip ci] (dab81db), closes #57
• release: 5.0.0 [skip ci] (63827d9), closes #83 #42 #84
• release: 5.0.0 [skip ci] (98a66fb), closes #58
• release: 5.0.1 [skip ci] (bd29083), closes #104
• release: 5.0.2 [skip ci] (877d54e), closes #108
• release: 5.0.3 [skip ci] (f29febd), closes #116
• release: 5.0.4 [skip ci] (17b7a90), closes #60
• release: 5.0.5 [skip ci] (2f71170), closes #118
• release: 5.1.0 [skip ci] (17aaad9), closes #112
• release: 5.1.0 [skip ci] (97dca54), closes #43
• release: 5.2.0 [skip ci] (dfdee5a), closes #113
• release: 5.2.1 [skip ci] (ddf1331), closes #126
• release: 5.2.2 [skip ci] (0c4f28e), closes #127
• release: 5.3.0 [skip ci] (665cd1a), closes #128 #122
• release: 5.4.0 [skip ci] (3501b09), closes #129
• release: 6.0.0 [skip ci] (dc0de7d), closes #43
• release: 6.0.1 [skip ci] (d5625d2), closes #67 #71
• release: 6.0.2 [skip ci] (26c569d), closes #76
• release: 6.1.0 [skip ci] (51746ec), closes #75
• release: 6.1.1 [skip ci] (3ac2c56), closes #78
• release: 6.1.2 [skip ci] (a34a908), closes #34
• release: 6.1.3 [skip ci] (311b622), closes #81
• release: 7.0.0 [skip ci] (62b2053), closes #83 #42 #84 #82
• release: 7.0.1 [skip ci] (198e9a7), closes #87
• release: 7.0.2 [skip ci] (c7b136e), closes #88
• release: 7.0.3 [skip ci] (63eea21), closes #104
• release: 7.0.4 [skip ci] (655a2f7), closes #97
• release: 7.0.5 [skip ci] (5f77393), closes #108
• release: 7.0.6 [skip ci] (d8c4e6b), closes #116
• release: 7.0.7 [skip ci] (1d6e843), closes #60
• release: 7.1.0 [skip ci] (d5bf315), closes #119
• release: 7.2.0 [skip ci] (47359ee), closes #112
• release: 7.2.1 [skip ci] (cbfe768)
• release: 7.3.0 [skip ci] (23073eb), closes #113
• release: 7.3.1 [skip ci] (d850acf), closes #123
• release: 7.3.2 [skip ci] (a6014c6), closes #125
• release: 7.3.3 [skip ci] (aa3829c), closes #126
• release: 7.3.4 [skip ci] (9f03e47), closes #127
• release: 7.4.0 [skip ci] (d56d627), closes #128
• release: 7.5.0 [skip ci] (3560e6e), closes #129
• remove long dep (#22) (8795507)
• remove old example (#20) (00ccc6a)
• remove redundant dep (a53620a)
• Update .github/workflows/stale.yml [skip ci] (01e2b69)
• Update .github/workflows/stale.yml [skip ci] (e86d817)
• Update .github/workflows/stale.yml [skip ci] (8102b91)
• Update .github/workflows/stale.yml [skip ci] (d4f2a98)
• Update .github/workflows/stale.yml [skip ci] (aa0601c)
• update project config (c54b7ac)
• update protons-runtime dep (#19) (e119076)
• update publish config (942e050)
• update sibling dependencies [skip ci] (a74ff6a)
• update sibling dependencies [skip ci] (c9291e0)
• update sibling dependencies [skip ci] (c476d9d)
• update sibling deps (7568283)

Documentation

• update readme (#27) (0ccb1a3)
• update readme to remove breaking character (#21) (023c29b)

Dependencies

• bump @bufbuild/protoc-gen-es from 1.10.0 to 2.0.0 (#138) (66d178f)
• bump aegir from 38.1.8 to 39.0.13 (#104) (912e0e6)
• bump aegir from 39.0.13 to 40.0.8 (#108) (8b54c80)
• bump aegir from 40.0.13 to 41.0.4 (#116) (b95e988)
• bump aegir from 41.3.5 to 42.0.1 (#127) (02eafe9)
• bump aegir from 42.2.11 to 44.1.0 (#137) (63f5784)
• bump lerna from 5.6.2 to 6.0.0 (#70) (17fc762)
• bump meow from 10.1.5 to 11.0.0 (#67) (d489fd3)
• bump meow from 11.0.0 to 12.0.1 (#97) (33250df)
• bump meow from 12.1.1 to 13.0.0 (#125) (2b356b8)
• bump uint8arrays from 3.1.1 to 4.0.2 (#71) (b537e92)
• bump uint8arrays from 4.0.10 to 5.0.1 (#126) (1e5a0b0)
• dev: bump lerna from 4.0.0 to 5.3.0 (#53) (eebccc3)
• remove lerna, update aegir (#76) (83a24f2)
• update sibling dependencies (188704d)
• update sibling dependencies (068e25a)
• update sibling dependencies (b1316fa)
• update sibling dependencies (a7d567d)

Tests

• regenerate custom options (768573b)