react-native-des-machine 0.1.0 → 1.0.0

package/lib/typescript/src/index.d.ts

@@ -10,9 +10,99 @@ interface OptionsList<T extends string> {
 declare const modeOptions: OptionsList<ModeEncryptionType>[];
 declare const paddingOptions: OptionsList<PaddingEncryptionType>[];
 declare const formatOptions: OptionsList<OutputFormatType>[];
-export declare function setMachineParams(params: DesMachineParams): void;
-export declare function encrypt(text: string): string;
-export declare function decrypt(text: string): string;
-export { Mode, Padding, Format, modeOptions, paddingOptions, formatOptions };
-export type { ModeEncryptionType, PaddingEncryptionType, OutputFormatType };
+/**
+ * DES Machine class for encryption and decryption.
+ * Supports multiple instances with different configurations.
+ *
+ * @example
+ * ```typescript
+ * // Create a machine with default settings
+ * const machine = new DesMachine({ key: 'mySecretKey123' });
+ *
+ * // Encrypt and decrypt
+ * const encrypted = machine.encrypt('Hello World');
+ * const decrypted = machine.decrypt(encrypted);
+ *
+ * // Create another machine with custom IV for CBC mode
+ * const cbcMachine = new DesMachine({
+ *   key: 'anotherKey1',
+ *   iv: '12345678', // 8 characters for DES
+ *   mode: Mode.CBC,
+ *   outputFormat: Format.HEX,
+ * });
+ * ```
+ */
+declare class DesMachine {
+    private params;
+    /**
+     * Create a new DES Machine instance.
+     * @param params - Configuration parameters
+     * @throws Error if key is missing or less than 8 characters
+     * @throws Error if iv is provided but not exactly 8 characters
+     */
+    constructor(params: DesMachineParams);
+    /**
+     * Encrypt plaintext using DES algorithm.
+     * @param text - The plaintext to encrypt
+     * @returns Encrypted string in the configured output format
+     */
+    encrypt(text: string): string;
+    /**
+     * Decrypt ciphertext using DES algorithm.
+     * @param text - The encrypted string to decrypt
+     * @returns Decrypted plaintext
+     */
+    decrypt(text: string): string;
+    /**
+     * Get the current configuration parameters.
+     * @returns A copy of the current parameters (key and iv are masked)
+     */
+    getParams(): Omit<DesMachineParams, 'key' | 'iv'> & {
+        key: string;
+        iv?: string;
+    };
+    /**
+     * Update configuration parameters.
+     * @param params - New parameters to apply (key and iv cannot be changed)
+     */
+    updateParams(params: Partial<Omit<DesMachineParams, 'key' | 'iv'>>): void;
+}
+/**
+ * Create a new DES Machine instance.
+ * @param params - Configuration parameters
+ * @returns A new DesMachine instance
+ *
+ * @example
+ * ```typescript
+ * const machine = createDesMachine({ key: 'mySecretKey123' });
+ * const encrypted = machine.encrypt('Hello');
+ * ```
+ */
+declare function createDesMachine(params: DesMachineParams): DesMachine;
+/**
+ * Quick encrypt function for one-off encryption.
+ * @param params - Configuration parameters including key
+ * @param text - The plaintext to encrypt
+ * @returns Encrypted string
+ *
+ * @example
+ * ```typescript
+ * const encrypted = encrypt({ key: 'mySecretKey123' }, 'Hello World');
+ * ```
+ */
+declare function encrypt(params: DesMachineParams, text: string): string;
+/**
+ * Quick decrypt function for one-off decryption.
+ * @param params - Configuration parameters including key
+ * @param text - The encrypted string to decrypt
+ * @returns Decrypted plaintext
+ *
+ * @example
+ * ```typescript
+ * const decrypted = decrypt({ key: 'mySecretKey123' }, encryptedText);
+ * ```
+ */
+declare function decrypt(params: DesMachineParams, text: string): string;
+export { DesMachine, createDesMachine, encrypt, decrypt, Mode, Padding, Format, modeOptions, paddingOptions, formatOptions, };
+export type { DesMachineParams, ModeEncryptionType, PaddingEncryptionType, OutputFormatType, };
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAmB,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EACjB,MAAM,oBAAoB,CAAC;AAE5B,QAAA,MAAM,OAAO,EAAE,MAAM,CAAC,qBAAqB,EAAE,qBAAqB,CAKjE,CAAC;AAEF,QAAA,MAAM,IAAI,EAAE,MAAM,CAAC,kBAAkB,EAAE,kBAAkB,CAMxD,CAAC;AAEF,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,CAGtD,CAAC;AAEF,UAAU,WAAW,CAAC,CAAC,SAAS,MAAM;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;CACV;AAED,QAAA,MAAM,WAAW,EAAE,WAAW,CAAC,kBAAkB,CAAC,EAMjD,CAAC;AAEF,QAAA,MAAM,cAAc,EAAE,WAAW,CAAC,qBAAqB,CAAC,EAKvD,CAAC;AAEF,QAAA,MAAM,aAAa,EAAE,WAAW,CAAC,gBAAgB,CAAC,EAGjD,CAAC;AAQF,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAK/D;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,aAAa,EAAE,CAAC;AAC7E,YAAY,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAyB,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EACjB,MAAM,oBAAoB,CAAC;AAG5B,QAAA,MAAM,OAAO,EAAE,MAAM,CAAC,qBAAqB,EAAE,qBAAqB,CAKjE,CAAC;AAEF,QAAA,MAAM,IAAI,EAAE,MAAM,CAAC,kBAAkB,EAAE,kBAAkB,CAMxD,CAAC;AAEF,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,CAGtD,CAAC;AAGF,UAAU,WAAW,CAAC,CAAC,SAAS,MAAM;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;CACV;AAED,QAAA,MAAM,WAAW,EAAE,WAAW,CAAC,kBAAkB,CAAC,EAMjD,CAAC;AAEF,QAAA,MAAM,cAAc,EAAE,WAAW,CAAC,qBAAqB,CAAC,EAKvD,CAAC;AAEF,QAAA,MAAM,aAAa,EAAE,WAAW,CAAC,gBAAgB,CAAC,EAGjD,CAAC;AASF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,cAAM,UAAU;IACd,OAAO,CAAC,MAAM,CAAmB;IAEjC;;;;;OAKG;gBACS,MAAM,EAAE,gBAAgB;IAoBpC;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI7B;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI7B;;;OAGG;IACH,SAAS,IAAI,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,IAAI,CAAC,GAAG;QAClD,GAAG,EAAE,MAAM,CAAC;QACZ,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;IAQD;;;OAGG;IACH,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI;CAK1E;AAED;;;;;;;;;;GAUG;AACH,iBAAS,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,UAAU,CAE9D;AAED;;;;;;;;;;GAUG;AACH,iBAAS,OAAO,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAG/D;AAED;;;;;;;;;;GAUG;AACH,iBAAS,OAAO,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAG/D;AAED,OAAO,EAEL,UAAU,EACV,gBAAgB,EAEhB,OAAO,EACP,OAAO,EAEP,IAAI,EACJ,OAAO,EACP,MAAM,EAEN,WAAW,EACX,cAAc,EACd,aAAa,GACd,CAAC;AAEF,YAAY,EACV,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,GACjB,CAAC"}

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": "1.0.0",
+  "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": {
@@ -17,9 +17,7 @@
     "lib",
     "android",
     "ios",
-    "cpp",
     "*.podspec",
-    "react-native.config.js",
     "!ios/build",
     "!android/build",
     "!android/gradle",
@@ -32,7 +30,6 @@
     "!**/.*"
   ],
   "scripts": {
-    "example": "yarn workspace react-native-des-machine-example",
     "clean": "del-cli lib",
     "prepare": "bob build",
     "typecheck": "tsc",
@@ -43,7 +40,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",
@@ -86,10 +107,6 @@
     "react": "*",
     "react-native": "*"
   },
-  "workspaces": [
-    "example"
-  ],
-  "packageManager": "yarn@4.11.0",
   "react-native-builder-bob": {
     "source": "src",
     "output": "lib",
@@ -119,7 +136,6 @@
   "jest": {
     "preset": "react-native",
     "modulePathIgnorePatterns": [
-      "<rootDir>/example/node_modules",
       "<rootDir>/lib/"
     ]
   },

package/src/NativeDesMachine.ts

@@ -5,16 +5,39 @@ export type PaddingEncryptionType = 'PKCS7' | 'ISO10126' | 'ZERO' | 'NONE';
 export type OutputFormatType = 'BASE64' | 'HEX';
 
 export interface DesMachineParams {
+  /**
+   * Encryption key (minimum 8 characters)
+   */
   key: string;
+  /**
+   * Initialization Vector for non-ECB modes (exactly 8 characters)
+   * If not provided, the first 8 bytes of the key will be used as IV
+   */
+  iv?: string;
+  /**
+   * Cipher mode (default: ECB)
+   */
   mode?: ModeEncryptionType;
+  /**
+   * Padding scheme (default: PKCS7)
+   */
   padding?: PaddingEncryptionType;
+  /**
+   * Output format (default: BASE64)
+   */
   outputFormat?: OutputFormatType;
 }
 
 export interface Spec extends TurboModule {
-  setMachineParams(params: DesMachineParams): void;
-  encrypt(text: string): string;
-  decrypt(text: string): string;
+  /**
+   * Encrypt text with provided params (stateless operation)
+   */
+  encrypt(params: DesMachineParams, text: string): string;
+
+  /**
+   * Decrypt text with provided params (stateless operation)
+   */
+  decrypt(params: DesMachineParams, text: string): string;
 }
 
 export default TurboModuleRegistry.getEnforcing<Spec>('DesMachine');

package/src/index.ts

@@ -1,10 +1,11 @@
-import DesMachine, { type DesMachineParams } from './NativeDesMachine';
+import NativeDesMachine, { type DesMachineParams } from './NativeDesMachine';
 import type {
   ModeEncryptionType,
   PaddingEncryptionType,
   OutputFormatType,
 } from './NativeDesMachine';
 
+// Constants
 const Padding: Record<PaddingEncryptionType, PaddingEncryptionType> = {
   PKCS7: 'PKCS7',
   ISO10126: 'ISO10126',
@@ -25,6 +26,7 @@ const Format: Record<OutputFormatType, OutputFormatType> = {
   HEX: 'HEX',
 };
 
+// Options for UI
 interface OptionsList<T extends string> {
   label: string;
   value: T;
@@ -50,26 +52,175 @@ const formatOptions: OptionsList<OutputFormatType>[] = [
   { label: 'Hexadecimal', value: Format.HEX },
 ];
 
-const defaultParams: Partial<DesMachineParams> = {
+// Default parameters
+const defaultParams: Omit<DesMachineParams, 'key'> = {
   mode: Mode.ECB,
   padding: Padding.PKCS7,
   outputFormat: Format.BASE64,
 };
 
-export function setMachineParams(params: DesMachineParams): void {
-  DesMachine.setMachineParams({
-    ...defaultParams,
-    ...params,
-  });
+/**
+ * DES Machine class for encryption and decryption.
+ * Supports multiple instances with different configurations.
+ *
+ * @example
+ * ```typescript
+ * // Create a machine with default settings
+ * const machine = new DesMachine({ key: 'mySecretKey123' });
+ *
+ * // Encrypt and decrypt
+ * const encrypted = machine.encrypt('Hello World');
+ * const decrypted = machine.decrypt(encrypted);
+ *
+ * // Create another machine with custom IV for CBC mode
+ * const cbcMachine = new DesMachine({
+ *   key: 'anotherKey1',
+ *   iv: '12345678', // 8 characters for DES
+ *   mode: Mode.CBC,
+ *   outputFormat: Format.HEX,
+ * });
+ * ```
+ */
+class DesMachine {
+  private params: DesMachineParams;
+
+  /**
+   * Create a new DES Machine instance.
+   * @param params - Configuration parameters
+   * @throws Error if key is missing or less than 8 characters
+   * @throws Error if iv is provided but not exactly 8 characters
+   */
+  constructor(params: DesMachineParams) {
+    if (!params.key) {
+      throw new Error('DesMachine: key is required');
+    }
+    if (params.key.length < 8) {
+      throw new Error('DesMachine: key must be at least 8 characters long');
+    }
+    if (params.iv !== undefined && params.iv.length !== 8) {
+      throw new Error('DesMachine: iv must be exactly 8 characters long');
+    }
+
+    this.params = {
+      key: params.key,
+      iv: params.iv,
+      mode: params.mode ?? defaultParams.mode!,
+      padding: params.padding ?? defaultParams.padding!,
+      outputFormat: params.outputFormat ?? defaultParams.outputFormat!,
+    };
+  }
+
+  /**
+   * Encrypt plaintext using DES algorithm.
+   * @param text - The plaintext to encrypt
+   * @returns Encrypted string in the configured output format
+   */
+  encrypt(text: string): string {
+    return NativeDesMachine.encrypt(this.params, text);
+  }
+
+  /**
+   * Decrypt ciphertext using DES algorithm.
+   * @param text - The encrypted string to decrypt
+   * @returns Decrypted plaintext
+   */
+  decrypt(text: string): string {
+    return NativeDesMachine.decrypt(this.params, text);
+  }
+
+  /**
+   * Get the current configuration parameters.
+   * @returns A copy of the current parameters (key and iv are masked)
+   */
+  getParams(): Omit<DesMachineParams, 'key' | 'iv'> & {
+    key: string;
+    iv?: string;
+  } {
+    return {
+      ...this.params,
+      key: this.params.key.substring(0, 2) + '***',
+      iv: this.params.iv ? this.params.iv.substring(0, 2) + '***' : undefined,
+    };
+  }
+
+  /**
+   * Update configuration parameters.
+   * @param params - New parameters to apply (key and iv cannot be changed)
+   */
+  updateParams(params: Partial<Omit<DesMachineParams, 'key' | 'iv'>>): void {
+    if (params.mode) this.params.mode = params.mode;
+    if (params.padding) this.params.padding = params.padding;
+    if (params.outputFormat) this.params.outputFormat = params.outputFormat;
+  }
+}
+
+/**
+ * Create a new DES Machine instance.
+ * @param params - Configuration parameters
+ * @returns A new DesMachine instance
+ *
+ * @example
+ * ```typescript
+ * const machine = createDesMachine({ key: 'mySecretKey123' });
+ * const encrypted = machine.encrypt('Hello');
+ * ```
+ */
+function createDesMachine(params: DesMachineParams): DesMachine {
+  return new DesMachine(params);
 }
 
-export function encrypt(text: string): string {
-  return DesMachine.encrypt(text);
+/**
+ * Quick encrypt function for one-off encryption.
+ * @param params - Configuration parameters including key
+ * @param text - The plaintext to encrypt
+ * @returns Encrypted string
+ *
+ * @example
+ * ```typescript
+ * const encrypted = encrypt({ key: 'mySecretKey123' }, 'Hello World');
+ * ```
+ */
+function encrypt(params: DesMachineParams, text: string): string {
+  const machine = new DesMachine(params);
+  return machine.encrypt(text);
 }
 
-export function decrypt(text: string): string {
-  return DesMachine.decrypt(text);
+/**
+ * Quick decrypt function for one-off decryption.
+ * @param params - Configuration parameters including key
+ * @param text - The encrypted string to decrypt
+ * @returns Decrypted plaintext
+ *
+ * @example
+ * ```typescript
+ * const decrypted = decrypt({ key: 'mySecretKey123' }, encryptedText);
+ * ```
+ */
+function decrypt(params: DesMachineParams, text: string): string {
+  const machine = new DesMachine(params);
+  return machine.decrypt(text);
 }
 
-export { Mode, Padding, Format, modeOptions, paddingOptions, formatOptions };
-export type { ModeEncryptionType, PaddingEncryptionType, OutputFormatType };
+export {
+  // Main class
+  DesMachine,
+  createDesMachine,
+  // Quick functions
+  encrypt,
+  decrypt,
+  // Constants
+  Mode,
+  Padding,
+  Format,
+  // Options for UI
+  modeOptions,
+  paddingOptions,
+  formatOptions,
+};
+
+export type {
+  DesMachineParams,
+  ModeEncryptionType,
+  PaddingEncryptionType,
+  OutputFormatType,
+};