cas-typescript-sdk 1.0.45 → 1.0.46

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +21 -11
  2. package/index.node +0 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,23 +1,33 @@
1
- # cas-typescript-sdk
1
+ # CAS TypeScript SDK
2
2
 
3
- [![image](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/7bXXCQj45q)
3
+ [![image](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/UAGqKfmvUS)
4
4
 
5
- Ever wanted all of your most useful cryptographic operations in one module and not had to surf documentation for various packages?
6
- CAS is here to provide a unified development experience as an abstract layer to the RustCrypto and Dalek-Cryptography suite of algorithms.
7
- The official NPM page can be found [here](https://www.npmjs.com/package/cas-typescript-sdk).
5
+ ## Overview
8
6
 
9
- **Note: All work is experimental and we understand some benchmarks might not be the most optimal.**
7
+ CAS TypeScript SDK is a comprehensive cryptographic toolkit for Node.js, designed to provide developers with a unified, high-level interface to industry-standard cryptographic algorithms. This library acts as an abstraction layer over the powerful RustCrypto and Dalek-Cryptography suites, enabling secure and efficient cryptographic operations through a simple TypeScript API.
10
8
 
11
- ## Consuming Library Documentation
12
- This Node.js NPM module is dependent on our Rust layer [cas-lib](https://github.com/Cryptographic-API-Services/cas-lib) that contains methods to run industry-standard cryptographic operations.
9
+ - **Official NPM Package:** [cas-typescript-sdk](https://www.npmjs.com/package/cas-typescript-sdk)
13
10
 
14
- We utilize some smart people's existing work and we believe their documentation should be reviewed when possible.
11
+ ## Features
12
+ - Modern cryptographic primitives: symmetric encryption, asymmetric encryption, digital signatures, hashing, password hashing, key exchange, and more
13
+ - Seamless integration with [cas-lib](https://github.com/Cryptographic-API-Services/cas-lib) Rust FFI layer for optimal performance
14
+ - TypeScript-first API for type safety and developer productivity
15
+ - Unified interface: no need to manage multiple cryptography packages or surf disparate documentation
16
+ - Built on trusted, open-source cryptography libraries
17
+
18
+ ## Documentation & References
19
+ We build on the work of leading cryptography projects. For in-depth algorithm details and implementation notes, please refer to:
15
20
  - [Spin Research](https://github.com/SpinResearch)
16
21
  - [Dalek-Cryptography](https://github.com/dalek-cryptography)
17
22
  - [Rust Crypto](https://github.com/RustCrypto)
18
23
 
19
- ## [Examples](./docs/EXAMPLES.md)
24
+ ## Usage Examples
25
+ See practical usage and code samples in our [Examples](./docs/EXAMPLES.md).
20
26
 
21
27
  ## Disclaimer
22
- Many of the cryptographic crates that are utilized in our core FFI [layer](./src) have never had a security audit performed. Utilize this SDK at your own risk.
28
+ This SDK leverages several cryptographic crates via our core FFI [layer](./src). Please note that many of these crates have not undergone formal security audits. Use this library at your own risk and always review the underlying cryptographic implementations for your security requirements.
29
+
30
+ ---
31
+ For questions, support, or to contribute, join our Discord or visit the [GitHub repository](https://github.com/Cryptographic-API-Services/cas-typescript-sdk).
32
+
23
33
 
package/index.node CHANGED
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cas-typescript-sdk",
3
- "version": "1.0.45",
3
+ "version": "1.0.46",
4
4
  "description": "",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",