@ray-js/wechat-rsa 0.1.6 → 0.1.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/wechat-rsa",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"

package/src/JSEncrypt.d.ts

@@ -4,51 +4,14 @@ export interface IJSEncryptOptions {
     default_public_exponent?: string;
     log?: boolean;
 }
-/**
- *
- * @param {Object} [options = {}] - An object to customize JSEncrypt behaviour
- * possible parameters are:
- * - default_key_size        {number}  default: 1024 the key size in bit
- * - default_public_exponent {string}  default: '010001' the hexadecimal representation of the public exponent
- * - log                     {boolean} default: false whether log warn/error or not
- * @constructor
- */
 export declare class JSEncrypt {
     constructor(options?: IJSEncryptOptions);
     private default_key_size;
     private default_public_exponent;
     private log;
     private key;
-    /**
-     * Method to set the rsa key parameter (one method is enough to set both the public
-     * and the private key, since the private key contains the public key paramenters)
-     * Log a warning if logs are enabled
-     * @param {Object|string} key the pem encoded string or an object (with or without header/footer)
-     * @public
-     */
     setKey(key: string): void;
-    /**
-     * Proxy method for setKey, for api compatibility
-     * @see setKey
-     * @public
-     */
     setPublicKey(pubkey: string): void;
-    /**
-     * Proxy method for RSAKey object's encrypt, encrypt the string using the public
-     * components of the rsa key object. Note that if the object was not set will be created
-     * on the fly (by the getKey method) using the parameters passed in the JSEncrypt constructor
-     * @param {string} str the string to encrypt
-     * @return {string} the encrypted string encoded in base64
-     * @public
-     */
     encrypt(str: string): string;
-    /**
-     * Getter for the current JSEncryptRSAKey object. If it doesn't exists a new object
-     * will be created and returned
-     * @param {callback} [cb] the callback to be called if we want the key to be generated
-     * in an async fashion
-     * @returns {JSEncryptRSAKey} the JSEncryptRSAKey object
-     * @public
-     */
     getKey(cb?: () => void): JSEncryptRSAKey;
 }

package/src/JSEncryptRSAKey.d.ts

@@ -1,59 +1,7 @@
 import { RSAKey } from './lib/jsbn/rsa';
-/**
- * Create a new JSEncryptRSAKey that extends Tom Wu's RSA key object.
- * This object is just a decorator for parsing the key parameter
- * @param {string|Object} key - The key in string format, or an object containing
- * the parameters needed to build a RSAKey object.
- * @constructor
- */
 export declare class JSEncryptRSAKey extends RSAKey {
     constructor(key?: string | JSEncryptRSAKey);
-    /**
-     * Method to parse a pem encoded string containing both a public or private key.
-     * The method will translate the pem encoded string in a der encoded string and
-     * will parse private key and public key parameters. This method accepts public key
-     * in the rsaencryption pkcs #1 format (oid: 1.2.840.113549.1.1.1).
-     *
-     * @todo Check how many rsa formats use the same format of pkcs #1.
-     *
-     * The format is defined as:
-     * PublicKeyInfo ::= SEQUENCE {
-     *   algorithm       AlgorithmIdentifier,
-     *   PublicKey       BIT STRING
-     * }
-     * Where AlgorithmIdentifier is:
-     * AlgorithmIdentifier ::= SEQUENCE {
-     *   algorithm       OBJECT IDENTIFIER,     the OID of the enc algorithm
-     *   parameters      ANY DEFINED BY algorithm OPTIONAL (NULL for PKCS #1)
-     * }
-     * and PublicKey is a SEQUENCE encapsulated in a BIT STRING
-     * RSAPublicKey ::= SEQUENCE {
-     *   modulus           INTEGER,  -- n
-     *   publicExponent    INTEGER   -- e
-     * }
-     * it's possible to examine the structure of the keys obtained from openssl using
-     * an asn.1 dumper as the one used here to parse the components: http://lapo.it/asn1js/
-     * @argument {string} pem the pem encoded string, can include the BEGIN/END header/footer
-     * @private
-     */
     parseKey(pem: string): boolean;
-    /**
-     * Check if the object contains the necessary parameters to populate the rsa modulus
-     * and public exponent parameters.
-     * @param {Object} [obj={}] - An object that may contain the two public key
-     * parameters
-     * @returns {boolean} true if the object contains both the modulus and the public exponent
-     * properties (n and e)
-     * @todo check for types of n and e. N should be a parseable bigInt object, E should
-     * be a parseable integer number
-     * @private
-     */
     static hasPublicKeyProperty(obj: object): boolean;
-    /**
-     * Parse the properties of obj in the current rsa object. Obj should AT LEAST
-     * include the modulus and public exponent (n, e) parameters.
-     * @param {Object} obj - the object containing rsa parameters
-     * @private
-     */
     parsePropertiesFrom(obj: any): void;
 }

package/src/lib/asn1js/asn1.d.ts

@@ -33,11 +33,6 @@ export declare class ASN1 {
     posEnd(): number;
     toHexString(): string;
     static decodeLength(stream: Stream): number | null;
-    /**
-     * Retrieve the hexadecimal value (as a string) of the current ASN.1 element
-     * @returns {string}
-     * @public
-     */
     getHexStringValue(): string;
     static decode(str: Stream | number[]): ASN1;
 }