@skiff-org/skiff-crypto - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

 {
   "name": "@skiff-org/skiff-crypto",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Cryptographic related functions and helpers",
@@ -38,3 +38,2 @@ "main": "./dist/cjs/index.js",
     "esbuild-node-externals": "^1.5.0",
-    "eslint-config-skiff-eslint": "workspace:*",
     "jest": "^28.1.1",
@@ -41,0 +40,0 @@ "typescript": "^5.0.0"

README.md

@@ -5,2 +5,6 @@ # skiff-crypto
 
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
+[![npm latest package](https://img.shields.io/npm/v/@skiff-org/skiff-crypto/latest.svg)](https://www.npmjs.com/package/@skiff-org/skiff-crypto)
+[![Follow on Twitter](https://img.shields.io/twitter/follow/Skiff_hq.svg?label=follow+Skiff)](https://twitter.com/skiffprivacy)
+
 ## Features
@@ -38,12 +42,11 @@
 ```javascript
-const skiffCrypto = require('skiff-crypto');
+const skiffCrypto = require('@skiff-org/skiff-crypto');
+const plaintext = "Hello, skiff-crypto!";
 
-let plaintext = "Hello, skiff-crypto!";
-let symmetricKey = skiffCrypto.symmetric.genKey(); 
+const keypair = skiffCrypto.generatePublicPrivateKeyPair();
 
-// Encrypt with ChaCha20Poly1305
-let cipher = skiffCrypto.symmetric.encrypt(plaintext, symmetricKey);
+const encrypted = skiffCrypto.stringEncryptAsymmetric(keypair.privateKey, { key: keypair.publicKey }, plaintext);
+const decrypted = skiffCrypto.stringDecryptAsymmetric(keypair.privateKey, { key: keypair.publicKey }, encrypted);
 
-// Decrypt with ChaCha20Poly1305
-let originalText = skiffCrypto.symmetric.decrypt(cipher, symmetricKey);
+expect(decrypted).toBe(plaintext);
 ```
@@ -50,0 +53,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

242687

increased by4563.47%

Dev dependency count

12

decreased by-7.69%

Number of package files

45

increased by1400%

Lines of code

536

increased byInfinity%

Number of lines in readme file

75

increased by4.17%

Worsened metrics

Number of low quality alerts

3

increased by50%

No dependency changes