react-native-des-machine 0.1.0 → 0.1.1

package/README.md

@@ -1,5 +1,10 @@
 # react-native-des-machine
 
+[![npm version](https://img.shields.io/npm/v/react-native-des-machine.svg)](https://www.npmjs.com/package/react-native-des-machine)
+[![npm downloads](https://img.shields.io/npm/dm/react-native-des-machine.svg)](https://www.npmjs.com/package/react-native-des-machine)
+[![license](https://img.shields.io/npm/l/react-native-des-machine.svg)](https://github.com/NeRo8/react-native-des-machine/blob/main/LICENSE)
+[![platform](https://img.shields.io/badge/platform-iOS%20%7C%20Android-lightgrey.svg)](https://reactnative.dev/)
+
 A React Native TurboModule that provides DES (Data Encryption Standard) encryption and decryption with support for multiple cipher modes, padding schemes, and output formats.
 
 ## Features
@@ -10,6 +15,16 @@ A React Native TurboModule that provides DES (Data Encryption Standard) encrypti
 - Output formats: Base64, Hexadecimal
 - Native implementation for both iOS and Android
 - TurboModule support for improved performance
+- Pre-built options arrays for easy UI integration
+- Full TypeScript support
+
+## Compatibility
+
+| Platform     | Minimum Version |
+| ------------ | --------------- |
+| iOS          | 13.0+           |
+| Android      | API 21+ (5.0)   |
+| React Native | 0.71+           |
 
 ## Installation
 
@@ -42,14 +57,7 @@ No additional setup required. The library auto-links on Android.
 ### Basic Example
 
 ```typescript
-import {
-  setMachineParams,
-  encrypt,
-  decrypt,
-  Mode,
-  Padding,
-  Format,
-} from 'react-native-des-machine';
+import { setMachineParams, encrypt, decrypt } from 'react-native-des-machine';
 
 // Initialize the DES machine with your encryption key
 setMachineParams({
@@ -95,13 +103,41 @@ const decrypted = decrypt(encrypted);
 console.log('Decrypted:', decrypted);
 ```
 
+### Using Pre-built Options for UI
+
+The library exports pre-built option arrays that can be used directly with dropdown/picker components:
+
+```typescript
+import {
+  modeOptions,
+  paddingOptions,
+  formatOptions,
+} from 'react-native-des-machine';
+
+// modeOptions structure:
+// [
+//   { label: 'ECB (Electronic Codebook)', value: 'ECB' },
+//   { label: 'CBC (Cipher Block Chaining)', value: 'CBC' },
+//   { label: 'CFB (Cipher Feedback)', value: 'CFB' },
+//   { label: 'OFB (Output Feedback)', value: 'OFB' },
+//   { label: 'CTR (Counter)', value: 'CTR' },
+// ]
+
+// Use with React Native Picker or any dropdown component
+<Picker selectedValue={selectedMode} onValueChange={setSelectedMode}>
+  {modeOptions.map((option) => (
+    <Picker.Item key={option.value} label={option.label} value={option.value} />
+  ))}
+</Picker>;
+```
+
 ## API Reference
 
-### `setMachineParams(params: DesMachineParams): void`
+### Functions
 
-Initialize the DES machine with encryption parameters.
+#### `setMachineParams(params: DesMachineParams): void`
 
-#### Parameters
+Initialize the DES machine with encryption parameters. Must be called before `encrypt()` or `decrypt()`.
 
 | Parameter      | Type                    | Required | Default    | Description                           |
 | -------------- | ----------------------- | -------- | ---------- | ------------------------------------- |
@@ -110,7 +146,7 @@ Initialize the DES machine with encryption parameters.
 | `padding`      | `PaddingEncryptionType` | No       | `'PKCS7'`  | Padding scheme                        |
 | `outputFormat` | `OutputFormatType`      | No       | `'BASE64'` | Output encoding format                |
 
-### `encrypt(text: string): string`
+#### `encrypt(text: string): string`
 
 Encrypt plaintext using the configured DES parameters.
 
@@ -118,7 +154,7 @@ Encrypt plaintext using the configured DES parameters.
 - **Returns:** Encrypted string in the configured output format
 - **Throws:** Error if `setMachineParams()` has not been called
 
-### `decrypt(text: string): string`
+#### `decrypt(text: string): string`
 
 Decrypt ciphertext using the configured DES parameters.
 
@@ -126,9 +162,9 @@ Decrypt ciphertext using the configured DES parameters.
 - **Returns:** Decrypted plaintext string
 - **Throws:** Error if `setMachineParams()` has not been called
 
-## Constants
+### Constants
 
-### Mode
+#### Mode
 
 | Constant   | Value   | Description                   |
 | ---------- | ------- | ----------------------------- |
@@ -138,7 +174,7 @@ Decrypt ciphertext using the configured DES parameters.
 | `Mode.OFB` | `'OFB'` | Output Feedback               |
 | `Mode.CTR` | `'CTR'` | Counter                       |
 
-### Padding
+#### Padding
 
 | Constant           | Value        | Description              |
 | ------------------ | ------------ | ------------------------ |
@@ -147,18 +183,46 @@ Decrypt ciphertext using the configured DES parameters.
 | `Padding.ZERO`     | `'ZERO'`     | Zero padding             |
 | `Padding.NONE`     | `'NONE'`     | No padding               |
 
-### Format
+#### Format
 
 | Constant        | Value      | Description               |
 | --------------- | ---------- | ------------------------- |
 | `Format.BASE64` | `'BASE64'` | Base64 encoding (default) |
 | `Format.HEX`    | `'HEX'`    | Hexadecimal encoding      |
 
+### Pre-built Options Arrays
+
+These arrays are useful for building UI components like dropdowns or pickers:
+
+| Export           | Type                                   | Description                 |
+| ---------------- | -------------------------------------- | --------------------------- |
+| `modeOptions`    | `OptionsList<ModeEncryptionType>[]`    | Mode options with labels    |
+| `paddingOptions` | `OptionsList<PaddingEncryptionType>[]` | Padding options with labels |
+| `formatOptions`  | `OptionsList<OutputFormatType>[]`      | Format options with labels  |
+
+Each option has the structure: `{ label: string, value: string }`
+
 ## TypeScript Support
 
 The library includes full TypeScript definitions:
 
 ```typescript
+import {
+  // Functions
+  setMachineParams,
+  encrypt,
+  decrypt,
+  // Constants
+  Mode,
+  Padding,
+  Format,
+  // Pre-built options
+  modeOptions,
+  paddingOptions,
+  formatOptions,
+} from 'react-native-des-machine';
+
+// Types
 import type {
   DesMachineParams,
   ModeEncryptionType,
@@ -167,6 +231,23 @@ import type {
 } from 'react-native-des-machine';
 ```
 
+## Complete Exports
+
+| Export                  | Type     | Description                      |
+| ----------------------- | -------- | -------------------------------- |
+| `setMachineParams`      | Function | Initialize DES with parameters   |
+| `encrypt`               | Function | Encrypt plaintext                |
+| `decrypt`               | Function | Decrypt ciphertext               |
+| `Mode`                  | Constant | Cipher mode constants            |
+| `Padding`               | Constant | Padding scheme constants         |
+| `Format`                | Constant | Output format constants          |
+| `modeOptions`           | Array    | Pre-built mode options for UI    |
+| `paddingOptions`        | Array    | Pre-built padding options for UI |
+| `formatOptions`         | Array    | Pre-built format options for UI  |
+| `ModeEncryptionType`    | Type     | TypeScript type for modes        |
+| `PaddingEncryptionType` | Type     | TypeScript type for padding      |
+| `OutputFormatType`      | Type     | TypeScript type for formats      |
+
 ## Security Notice
 
 DES is considered cryptographically weak by modern standards due to its 56-bit key size. For production applications requiring strong encryption, consider using AES or other modern algorithms. This library is suitable for:
@@ -181,6 +262,13 @@ DES is considered cryptographically weak by modern standards due to its 56-bit k
 - [Sending a pull request](CONTRIBUTING.md#sending-a-pull-request)
 - [Code of conduct](CODE_OF_CONDUCT.md)
 
+## Support
+
+If you find this library helpful, please consider giving it a star on GitHub!
+
+- [Report a bug](https://github.com/NeRo8/react-native-des-machine/issues)
+- [Request a feature](https://github.com/NeRo8/react-native-des-machine/issues)
+
 ## License
 
 MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-des-machine",
-  "version": "0.1.0",
-  "description": "React Native module that provides simple text encryption and decryption based on the DES algorithm.",
+  "version": "0.1.1",
+  "description": "React Native DES encryption and decryption library with TurboModule support. Encrypt and decrypt text using DES algorithm with multiple cipher modes (ECB, CBC, CFB, OFB, CTR), padding schemes (PKCS7, ISO10126, Zero, None), and output formats (Base64, Hex) for iOS and Android.",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
   "exports": {
@@ -43,7 +43,31 @@
   "keywords": [
     "react-native",
     "ios",
-    "android"
+    "android",
+    "des",
+    "encryption",
+    "decryption",
+    "crypto",
+    "cryptography",
+    "cipher",
+    "encrypt",
+    "decrypt",
+    "security",
+    "turbo-module",
+    "turbomodule",
+    "native-module",
+    "des-encryption",
+    "des-decryption",
+    "ecb",
+    "cbc",
+    "pkcs7",
+    "base64",
+    "hex",
+    "react-native-encryption",
+    "react-native-crypto",
+    "react-native-security",
+    "mobile-encryption",
+    "text-encryption"
   ],
   "repository": {
     "type": "git",
@@ -89,7 +113,6 @@
   "workspaces": [
     "example"
   ],
-  "packageManager": "yarn@4.11.0",
   "react-native-builder-bob": {
     "source": "src",
     "output": "lib",