Wasm implementation that works e2e with signify-ts

.gitignore

@@ -4,3 +4,4 @@
 .idea
 .vscode
 lcov.info
+.tags

Cargo.toml

@@ -14,7 +14,7 @@ argon2 = "~0.5"
 base64 = "~0.21"
 blake2 = "~0.10"
 blake3 = "~1"
-chrono = { version = "~0.4", default-features = false, features = ["clock"] }
+chrono = { version = "~0.4", default-features = false, features = ["clock", "serde", "wasmbind"] }
 ed25519-dalek = { version = "2.0.0", features = ["rand_core"] }
 indexmap = "~2"
 k256 = "~0.13"

wasm/Cargo.toml

@@ -1,16 +1,23 @@
 [package]
 name = "cesride-wasm"
 description = "Cryptographic primitives for use with Composable Event Streaming Representation (CESR)"
+license = "Apache-2.0"
 version = "0.1.0"
 authors = ['Dmitry Kuzmenko <[email protected]>']
 edition = "2021"
+repository = "[email protected]:WebOfTrust/cesride.git"
 
 [lib]
 crate-type = ["cdylib", "rlib"]
 
 [features]
 tmp_dev = []
 
+[dependencies]
+wasm-bindgen = "0.2.88"
+js-sys = '0.3'
+serde_json = "1.0"
+
 [dependencies.getrandom]
 version = '0.2'
 features = ['js']
@@ -19,7 +26,9 @@ features = ['js']
 path = '..'
 package = "cesride"
 
-[dependencies]
-wasm-bindgen = "0.2.84"
-js-sys = '0.3'
-serde_json = "1.0"
+[dev-dependencies]
+wasm-bindgen-test = "0.3.38"
+
+# wasm-opt is used instead
+#[profile.release]
+#opt_level = "s"

wasm/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 [yyyy] [name of copyright owner]
+
+   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.

wasm/README.md

@@ -4,23 +4,46 @@
 Install wasm-pack from https://rustwasm.github.io/wasm-pack/installer/ and then
 
 ```
-wasm-pack build # Will output modules best-suited to be bundled with webpack
-wasm-pack build --target=nodejs # Will output modules that can be directly consumed by NodeJS
-wasm-pack build --target=web # Will output modules that can be directly consumed in browser without bundler usage
+wasm-pack build [--target=bundler] # Will output modules best-suited to be bundled with webpack (Ecmascript modules, ESM)
+wasm-pack build --target=nodejs # Will output modules that can be directly consumed by NodeJS (CommonJS modules, CJS)
+wasm-pack build --target=web # Will output modules that can be directly consumed in browser without bundler usage (ESM module with extra scaffolding for use standalone)
 ```
 
-### Run NodeJS demo
+Passing `--dev` to the above commands will give extra debugging info and makes the compilation faster at the cost of a slightly bigger wasm module.
+
+## Demos
+
+These are examples of how to use the package in various flavors
+
+### CJS demo (--target=nodejs)
 ```
+wasm-pack build --target=nodejs # Will output modules that can be directly consumed by NodeJS (CommonJS modules, CJS)
 cd demo/node
 yarn install
 yarn start
 ```
 
-### Run demo in Browser
+### Browser demo (--target=web)
+```
+wasm-pack build --target=web # Will output modules that can be directly consumed in browser without bundler usage (ESM module with extra scaffolding for use standalone)
+cd demo/web
+python -m http.server # or another web server of choice serving index.html which should load the pkg automatically as a js module. See index.html for example of scaffolding necessary to get the wasm to load.
+```
+
+### ESM demo (--target=bundler)
 ```
+wasm-pack build # Will output modules best-suited to be bundled with webpack (Ecmascript modules, ESM)
 cd demo/web
 yarn install
 yarn serve
+# and then visit http://localhost:8080 in a browser should run the example!
 ```
 
-and then visit http://localhost:8080 in a browser should run the example!
+## Integration with signify-ts
+Currently only the CJS artifact works when integrating with signify-ts (maybe someone better with the various nonsense js import systems can figure it out).  The steps are as follows:
+1. Build cesride in the regular fashion.
+2. cd to the wasm directory and use `wasm-pack build --target=nodejs` to build your wasm package
+3. Add the `pkg/` directory as a dependency to signify-ts
+4. The cesride-wasm artifact should now be callable by tests and signify-ts.
+
+Its also nice to note that wasm-pack produces a types file in pkg/ that describes the complete interface.  Something like `cesride_wasm.d.ts`.  Useful for debugging when making changes to this crate.

wasm/demo/node/src/main.ts

@@ -3,14 +3,14 @@ import { Dater } from "cesride-wasm";
 function main() {
     const date = Dater.new_with_dts("2020-08-22T17:50:09.988921+00:00");
     console.log("<p>Date:</p>");
-    console.log("dts: " + date.dts() + "<br/>");
-    console.log("dtsb: " + date.dtsb() + "<br/>");
-    console.log("code: " + date.code() + "<br/>");
-    console.log("size: " + date.size() + "<br/>");
-    console.log("raw: " + date.raw() + "<br/>");
-    console.log("qb64: " + date.qb64() + "<br/>");
-    console.log("qb64b: " + date.qb64b() + "<br/>");
-    console.log("qb2: " + date.qb2() + "<br/>");
+    console.log("dts: " + date.dts + "<br/>");
+    console.log("dtsb: " + date.dtsb + "<br/>");
+    console.log("code: " + date.code + "<br/>");
+    console.log("size: " + date.size + "<br/>");
+    console.log("raw: " + date.raw + "<br/>");
+    console.log("qb64: " + date.qb64 + "<br/>");
+    console.log("qb64b: " + date.qb64b + "<br/>");
+    console.log("qb2: " + date.qb2 + "<br/>");
     }
 
 main()