TypeScript definition for library?

[davidquon]

Wanted to see if there was any chance in creating a TypeScript definition for users of jsencrypt. https://github.com/typings/registry#ask-the-author https://github.com/typings/typings/issues/322

Thanks for the work and support on the library.

[qisbic]

I would also like this too.. how does one get this to work in typescript? I have tried multiple ways without success..

including.. import * as Encrypt from ('jsencrypt'); or var Encrypt = require("jsencrypt");

does not work.

[guptasanchit90]

Steps to use this library in typescript

• Add "noImplicitAny": false in tsconfig.ts under compilerOptions
• Import import { JSEncrypt } from 'jsencrypt'
• Create new instance const jSEncrypt = new JSEncrypt();

[JalilArfaoui]

What if we want to use "noImplicitAny": true for the rest of the project ?

[juanstiza]

I added this to our typings.d.ts

declare module 'jsencrypt' {
  export class JSEncrypt {
    constructor();
    setPublicKey(pk: string): void;
    encrypt(key: string): string;
  }
}

and then imported using:

import { JSEncrypt } from 'jsencrypt';
const jse = new JSEncrypt();
jse.setPublicKey(bla);

[kaiopen]

Actually the declaration file *.d.ts has already been done in version 3.0.0-rc.1. You can find and download it in this repository. And copy/move it to node_modules/jsencrypt in your project.

By the way. when instantiating a JSEncrypt, there is an argument wanted.

const encrypt = new JSEncrypt({});

It would be great if you can update in npm. @travist

[bobrosoft]

Complete version of declaration for your custom-typings.d.ts:

declare module 'jsencrypt' {
  export interface IJSEncryptOptions {
    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
  }
  
  export class JSEncrypt {
    constructor(options?: IJSEncryptOptions);

    /**
     * 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
     */
    public setKey(key: string): void;

    /**
     * Returns the pem encoded representation of the private key
     * If the key doesn't exists a new key will be created
     * @returns {string} pem encoded representation of the private key WITH header and footer
     * @public
     */
    public getPrivateKey(): string;

    /**
     * Returns the pem encoded representation of the private key
     * If the key doesn't exists a new key will be created
     * @returns {string} pem encoded representation of the private key WITHOUT header and footer
     * @public
     */
    public getPrivateKeyB64(): string;

    /**
     * Proxy method for setKey, for api compatibility
     * @see setKey
     * @public
     */
    public setPrivateKey(privkey: string): void;

    /**
     * Returns the pem encoded representation of the public key
     * If the key doesn't exists a new key will be created
     * @returns {string} pem encoded representation of the public key WITH header and footer
     * @public
     */
    public getPublicKey(): string;

    /**
     * Returns the pem encoded representation of the public key
     * If the key doesn't exists a new key will be created
     * @returns {string} pem encoded representation of the public key WITHOUT header and footer
     * @public
     */
    public getPublicKeyB64(): string;

    /**
     * Proxy method for setKey, for api compatibility
     * @see setKey
     * @public
     */
    public setPublicKey(pubkey: string);

    /**
     * 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
     */
    public encrypt(key: string): string;

    /**
     * Proxy method for RSAKey object's decrypt, decrypt the string using the private
     * 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 base64 encoded crypted string to decrypt
     * @return {string} the decrypted string
     * @public
     */
    public decrypt(str: string): string;

    /**
     * Proxy method for RSAKey object's sign.
     * @param {string} str the string to sign
     * @param {function} digestMethod hash method
     * @param {string} digestName the name of the hash algorithm
     * @return {string} the signature encoded in base64
     * @public
     */
    public sign(str: string, digestMethod: (str: string) => string, digestName: string): string | false;

    /**
     * Proxy method for RSAKey object's verify.
     * @param {string} str the string to verify
     * @param {string} signature the signature encoded in base64 to compare the string to
     * @param {function} digestMethod hash method
     * @return {boolean} whether the data and signature match
     * @public
     */
    public verify(str: string, signature: string, digestMethod: (str: string) => string): boolean;

    /**
     * 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
     */
    public getKey(cb?: () => void): any;
  }
}

[victorfeijo]

You can also install the library directly from the github repository, it will include the declarations folder:

yarn add travist/jsencrypt#v3.0.0-rc.1

Only downside is that you are going to download the whole repository with stuff that you don't need, for example the demo folder.