@wireapp/core-crypto 1.0.0-rc.14 → 1.0.0-rc.16

package/README.md

@@ -76,6 +76,7 @@ rustup target add x86_64-unknown-linux-gnu
 * Install [wasm-pack](https://rustwasm.github.io/wasm-pack/)
 * Install the wasm32-unknown-unknown toolchain `rustup target add wasm32-unknown-unknown`
 * Install node.js (recommended way is via [Volta](https://volta.sh/))
+* Install Bun (follow the instructions on [Bun's website](https://bun.sh/))
 
 ### Bindings
 
@@ -93,7 +94,7 @@ cargo make "copy-android-resources"
 # builds iOS framework
 cargo make "create-swift-package"
 
-# builds wasm binary
+# builds wasm binary & TS bindings
 cargo make wasm
 ```
 
@@ -125,3 +126,4 @@ cd kotlin
 ### JS / WASM
 
 Given that you are logged in NPM and can publish to `@wireapp/core-crypto`, you can just `npm publish` to push a new version
+But this is not needed as releases are auto-published to the `@wireapp` organization

package/package.json

@@ -1,20 +1,12 @@
 {
   "name": "@wireapp/core-crypto",
-  "version": "1.0.0-rc.14",
+  "version": "1.0.0-rc.16",
   "description": "CoreCrypto bindings for the Web",
   "type": "module",
   "module": "platforms/web/corecrypto.js",
   "types": "platforms/web/corecrypto.d.ts",
   "scripts": {
-    "prepare": "npm run build",
-    "build": "npm run clean && rollup -c crypto-ffi/bindings/js/rollup.config.js",
-    "build:test": "npm run clean && rollup -c crypto-ffi/bindings/js/rollup.config.test.js",
-    "clean": "rm -f ./platforms/web/*.{js,ts,wasm,html} && rm -rf ./platforms/web/assets",
-    "package": "npm run build && npm pack",
-    "test:raw": "jest -c crypto-ffi/bindings/js/jest.config.js --runInBand",
-    "test": "npm run build:test && npm run test:raw",
-    "test:cov": "npm run build:test && jest -c crypto-ffi/bindings/js/jest.config.js --coverage --runInBand",
-    "test:http-server": "http-server platforms/web -g -p 3000"
+    "clean": "rm -f ./platforms/web/*.{js,ts,wasm,html} && rm -rf ./platforms/web/assets"
   },
   "publishConfig": {
     "access": "public"
@@ -40,26 +32,15 @@
     "url": "https://github.com/wireapp/core-crypto/issues"
   },
   "devDependencies": {
-    "@rollup/plugin-html": "^1.0.2",
-    "@types/jest": "^29.4.0",
-    "@types/jest-dev-server": "^5.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.50.0",
-    "@typescript-eslint/parser": "^5.50.0",
-    "@wasm-tool/rollup-plugin-rust": "^2.3.3",
-    "dts-bundle-generator": "^7.2.0",
-    "eslint": "^8.33.0",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "http-server": "^14.1.1",
-    "jest": "^29.4.1",
-    "jest-dev-server": "^6.2.0",
-    "prettier": "^2.8.3",
-    "puppeteer": "^19.6.2",
-    "rollup": "^3.12.0",
-    "rollup-jest": "^3.1.0",
-    "rollup-plugin-ts": "^3.2.0",
-    "ts-jest": "^29.0.5",
-    "ts-loader": "^9.4.2",
-    "typescript": "^4.9.5"
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
+    "bun-plugin-dts": "^0.2.1",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "prettier": "^3.0.3",
+    "puppeteer": "^21.3.8",
+    "ts-loader": "^9.5.0",
+    "typescript": "^5.2.2"
   }
 }

package/platforms/web/corecrypto.d.ts

@@ -1,4 +1,8 @@
-declare class AcmeChallenge {
+/**
+* For creating a challenge.
+* @see https://www.rfc-editor.org/rfc/rfc8555.html#section-7.5.1
+*/
+export class AcmeChallenge {
 	free(): void;
 	/**
 	* Contains raw JSON data of this challenge. This is parsed by the underlying Rust library hence should not be accessed
@@ -14,7 +18,11 @@ declare class AcmeChallenge {
 	*/
 	readonly url: string;
 }
-declare class AcmeDirectory {
+/**
+* Holds URLs of all the standard ACME endpoint supported on an ACME server.
+* @see https://www.rfc-editor.org/rfc/rfc8555.html#section-7.1.1
+*/
+export class AcmeDirectory {
 	free(): void;
 	/**
 	* URL for creating a new account.
@@ -33,7 +41,11 @@ declare class AcmeDirectory {
 	*/
 	readonly revokeCert: string;
 }
-declare class NewAcmeAuthz {
+/**
+* Result of an authorization creation.
+* @see https://www.rfc-editor.org/rfc/rfc8555.html#section-7.5
+*/
+export class NewAcmeAuthz {
 	free(): void;
 	/**
 	* DNS entry associated with those challenge
@@ -48,7 +60,11 @@ declare class NewAcmeAuthz {
 	*/
 	readonly wireOidcChallenge: AcmeChallenge | undefined;
 }
-declare class NewAcmeOrder {
+/**
+* Result of an order creation.
+* @see https://www.rfc-editor.org/rfc/rfc8555.html#section-7.4
+*/
+export class NewAcmeOrder {
 	free(): void;
 	/**
 	*/