web-pki 2.16.1 → 2.17.0-alpha.1

package/lacuna-web-pki.d.ts

@@ -324,37 +324,36 @@ export declare class LacunaWebPKI {
 		usePreauthorizedSignatures?: boolean
 	}): Promise<SignHashBatchResponse>;
 
-	// TODO: next version
-	// /**************************************************************
-	//  * Signs a batch of hashes with signer certificate private key.
-	//  *
-	//  * @returns A promise object that can register [[fail]] and [[success]] callbacks to be called when the operation completes. The [[success]] callback for this promise receives the (Base64 encoded) signature bytes array.
-	//  *
-	//  * Usage example (JavaScript)
-	//  * ```javascript
-	//  * var hashes = [
-	//  *     { algorithm: 'SHA-256', value: 'f4OxZX/x/FO5LcGBSKHWXfwtSx+j1ncoSt3SABJtkGk=' }, // Base64 encoded SHA-256 of 'Hello World!'
-	//  *     { algorithm: 'SHA-256', value: 'f4OxZX/x/FO5LcGBSKHWXfwtSx+j1ncoSt3SABJtkGk=' },
-	//  *     { algorithm: 'SHA-256', value: 'f4OxZX/x/FO5LcGBSKHWXfwtSx+j1ncoSt3SABJtkGk=' }
-	//  * ];
-	//  *
-	//  * pki.signHashes({
-	//  *     certificateThumbprint: $('#certificateSelect').val(),
-	//  *     hashes: hashes
-	//  * }).success(function (result) {
-	//  *     // Use signatures array
-	//  *     var signatures = result.signatures;
-	//  * });
-	//  * ```
-	//  *
-	//  * JSFiddle live example: [Sign Hashes](https://jsfiddle.net/LacunaSoftware/1car2yjz)
-	//  */
-	//  signHashes(args: {
-	// 	/** The signer certificate thumbprint. Available in [[CertificateModel.thumbprint]] property returned by [[listCertificates]] method. */
-	// 	certificateThumbprint: string,
-	// 	/** The Array of [[Hash]] with the hash algorithm and value to be signed. */
-	// 	hashes: Hash[],
-	// }): Promise<SignHashesResponse>;
+	/**************************************************************
+	 * Signs a batch of hashes with signer certificate private key.
+	 *
+	 * @returns A promise object that can register [[fail]] and [[success]] callbacks to be called when the operation completes. The [[success]] callback for this promise receives the (Base64 encoded) signature bytes array.
+	 *
+	 * Usage example (JavaScript)
+	 * ```javascript
+	 * var hashes = [
+	 *     { algorithm: 'SHA-256', value: 'f4OxZX/x/FO5LcGBSKHWXfwtSx+j1ncoSt3SABJtkGk=' }, // Base64 encoded SHA-256 of 'Hello World!'
+	 *     { algorithm: 'SHA-256', value: 'f4OxZX/x/FO5LcGBSKHWXfwtSx+j1ncoSt3SABJtkGk=' },
+	 *     { algorithm: 'SHA-256', value: 'f4OxZX/x/FO5LcGBSKHWXfwtSx+j1ncoSt3SABJtkGk=' }
+	 * ];
+	 *
+	 * pki.signHashes({
+	 *     certificateThumbprint: $('#certificateSelect').val(),
+	 *     hashes: hashes
+	 * }).success(function (result) {
+	 *     // Use signatures array
+	 *     var signatures = result.signatures;
+	 * });
+	 * ```
+	 *
+	 * JSFiddle live example: [Sign Hashes](https://jsfiddle.net/LacunaSoftware/1car2yjz)
+	 */
+	 signHashes(args: {
+		/** The signer certificate thumbprint. Available in [[CertificateModel.thumbprint]] property returned by [[listCertificates]] method. */
+		certificateThumbprint: string,
+		/** The Array of [[Hash]] with the hash algorithm and value to be signed. */
+		hashes: Hash[],
+	}): Promise<SignHashesResponse>;
 
 	/**************************************************************
 	 * Executes a document signature with Rest PKI (server-side) integration. See [Rest PKI documentation](https://docs.lacunasoftware.com/articles/rest-pki/) for more informations.
@@ -539,21 +538,20 @@ export declare class LacunaWebPKI {
 		/** If `true`, will not apply the `pdfMarks` in case PDF already has a signature. If `false`, any previous signature will be removed before the marks be applied. */
 		bypassMarksIfSigned?: boolean,
 
-		// TODO: next version
-		// /** A signing reason */
-		// reason?: string,
+		/** A signing reason */
+		reason?: string,
 
-		// /** The signing location or address */
-		// location?: string,
+		/** The signing location or address */
+		location?: string,
 
-		// /** The signer name */
-		// signerName?: string,
+		/** The signer name */
+		signerName?: string,
 
-		// /** A custom signature field name. Signature field name must be unique for the PDF */
-		// customSignatureFieldName?: string,
+		/** A custom signature field name. Signature field name must be unique for the PDF */
+		customSignatureFieldName?: string,
 
-		// /** Any metadata to be added to the PDF */
-		// metadata?: { [key: string]: string; },
+		/** Any metadata to be added to the PDF */
+		metadata?: { [key: string]: string; },
 
 		/** The PDF signature policy. */
 		policy: LacunaWebPKI.PadesPolicies,
@@ -598,9 +596,8 @@ export declare class LacunaWebPKI {
 		/** If you already have a CAdES file and a co-signature is intended, pass this argument instead of `fileId` or `content`. Optionally, you can use the `fileId` for CAdES signature file and enable the `autoDetectCosign`. */
 		cmsToCosignFileId?: string,
 
-		// TODO: next version
-		// /** If you already have a CAdES file and a co-signature is intended, pass this argument instead of `fileId` or `content`. Optionally, you can use the `fileId` for CAdES signature file and enable the `autoDetectCosign`. */
-		// cmsToCosignContent?: string,
+		/** If you already have a CAdES file and a co-signature is intended, pass this argument instead of `fileId` or `content`. Optionally, you can use the `fileId` for CAdES signature file and enable the `autoDetectCosign`. */
+		cmsToCosignContent?: string,
 
 		/** Whether or not to auto-detect a co-signature intention if the `fileId` passed is a CAdES signature file.  */
 		autoDetectCosign?: boolean,
@@ -608,9 +605,8 @@ export declare class LacunaWebPKI {
 		/** Whether or not to include the encapsulated content (the original document) in the resulting CAdES signature file. */
 		includeEncapsulatedContent?: boolean,
 
-		// TODO: next version
-		// /** A signing description or reason */
-		// signingDescription?: string,
+		/** A signing description or reason */
+		signingDescription?: string,
 
 		/** The CAdES signature policy. */
 		policy: LacunaWebPKI.CadesPolicies,
@@ -646,9 +642,8 @@ export declare class LacunaWebPKI {
 		/** A XML content (UTF-8 string or Base64 encoded bytes) to sign can be passed optionally to `filedId`. */
 		content?: string,
 
-		// TODO: next version
-		// /** A signing description or reason */
-		// signingDescription?: string,
+		/** A signing description or reason */
+		signingDescription?: string,
 
 		/** The XML signature policy. */
 		policy: LacunaWebPKI.XmlPolicies,
@@ -705,9 +700,8 @@ export declare class LacunaWebPKI {
 		/** A XML content (UTF-8 string or Base64 encoded) to sign can be passed optionally to `filedId`.  */
 		content?: string,
 
-		// TODO: next version
-		// /** A signing description or reason */
-		// signingDescription?: string,
+		/** A signing description or reason */
+		signingDescription?: string,
 
 		/** The XML signature policy. */
 		policy: LacunaWebPKI.XmlPolicies,
@@ -769,11 +763,11 @@ export declare class LacunaWebPKI {
 		/** The original file. Only applies if the passed `signatureFileId` or `signatureContent` does not have the encapsulated content. */
 		originalFileId?: string,
 		
-		// TODO: next version
-		// /** The original file content (Base64 encoded bytes). Only applies if the passed `signatureFileId` or `signatureContent` does not have the encapsulated content. */
-		// originalContent?: string,
-		// /** Set to return the encapsulated content */
-		// returnEncapsulatedContent?: boolean,
+		/** The original file content (Base64 encoded bytes). Only applies if the passed `signatureFileId` or `signatureContent` does not have the encapsulated content. */
+		originalContent?: string,
+
+		/** Set to return the encapsulated content */
+		returnEncapsulatedContent?: boolean,
 
 		/** Whether or not to validate the CAdES sinatures. */
 		validate: boolean,
@@ -868,10 +862,8 @@ export declare class LacunaWebPKI {
 		keyLabel?: string,
 		/** The RSA keys size to be genarated. Be sure that the selected device supports the requested key size on [[TokenModel.mechanisms]]. */
 		keySize: number,
-		
-		// TODO: next version
-		// /** Whether or not to auto enable the used PKCS#11 module after command success. The **default** is `true` */
-		// enableUsedPkcs11Module?: boolean
+		/** Whether or not to auto enable the used PKCS#11 module after command success. The **default** is `true` */
+		enableUsedPkcs11Module?: boolean
 
 	}): Promise<GenerateTokenKeyPairResponse>;
 
@@ -911,11 +903,8 @@ export declare class LacunaWebPKI {
 		certificateContent: string,
 		/** A label for the imported certificate object in the token. If not set, the same key Id is used. */
 		certificateLabel?: string,
-		
-		// TODO: next version
-		// /** Whether or not to auto enable the used PKCS#11 module after command success. The **default** is `true` */
-		// enableUsedPkcs11Module?: boolean
-
+		/** Whether or not to auto enable the used PKCS#11 module after command success. The **default** is `true` */
+		enableUsedPkcs11Module?: boolean
 	}): Promise<ImportTokenCertificateResponse>;
 
 	/**************************************************************
@@ -1052,7 +1041,8 @@ export namespace LacunaWebPKI {
 		v1_6_1 = '1.6.1',
 		v1_7_0 = '1.7.0',
 		v1_7_2 = '1.7.2',
-		v1_8_0 = '1.8.0'
+		v1_8_0 = '1.8.0',
+		v1_9_0 = '1.9.0',
 	}
 
 	/**************************************************************
@@ -1746,40 +1736,35 @@ export interface SignerModel {
 
 export interface CadesSignerModel extends SignerModel {
 	messageDigest: DigestModel,
-	// TODO: next version
-	// signingDescription?: string,
+	signingDescription?: string,
 }
 
 export interface PadesSignerModel extends SignerModel {
 	messageDigest: DigestModel,
 	isDocumentTimestamp: boolean,
 	signatureFieldName: string,
-	// TODO: next version
-	// reason?: string,
-	// location?: string,
+	reason?: string,
+	location?: string,
 }
 
 export interface XmlSignerModel extends SignerModel {
 	signatureElementId : string,
 	type : LacunaWebPKI.XmlSignedEntityTypes,
 	signedElement : XmlElementModel,
-	// TODO: next version
-	// dataObjectFormat?: DataObjectFormatModel,
+	dataObjectFormat?: DataObjectFormatModel,
 }
 
 export interface CadesSignatureModel {
 	encapsulatedContentType: LacunaWebPKI.CmsContentTypes,
 	hasEncapsulatedContent: boolean,
-	// TODO: next version
-	// encapsulatedContent?: string,
+	encapsulatedContent?: string,
 	signers: CadesSignerModel[]
 }
 
 export interface PadesSignatureModel {
-	// TODO: next version
-	// pagesCount: number,
-	// pdfAStandard?: LacunaWebPKI.PdfAStandards,
-	// metadata?: { [key: string]: string; },
+	pagesCount: number,
+	pdfAStandard?: LacunaWebPKI.PdfAStandards,
+	metadata?: { [key: string]: string; },
 	signers: PadesSignerModel[]
 }
 

package/lacuna-web-pki.js

@@ -130,7 +130,7 @@ LacunaWebPKI = function (license) {
 	$._edgeExtensionId = 'nedeegdmhlnmboboahchfpkmdnnemapd';
 	$._edgeLegacyProductId = 'd2798a85-9698-425a-add7-3db79a39ca8a';
 	$._chromeExtensionFirstVersionWithSelfUpdate = '2.0.20';
-	$._jslibVersion = '2.16.1';
+	$._jslibVersion = '2.17.0-alpha.1';
 	$._mobileSupported = 'true' === 'true';
 	$._buildChannel = 'stable';
 
@@ -192,6 +192,7 @@ LacunaWebPKI = function (license) {
 		v1_7_2: '1.7.2',
 		v1_8_0: '1.8.0',
 		v1_8_1: '1.8.1',
+		v1_9_0: '1.9.0',
 		latest: 'latest'
 	};
 
@@ -220,6 +221,7 @@ LacunaWebPKI = function (license) {
 	$._apiMap.nativeWin[$.apiVersions.v1_7_2] = '2.11.0';
 	$._apiMap.nativeWin[$.apiVersions.v1_8_0] = '2.12.0';
 	$._apiMap.nativeWin[$.apiVersions.v1_8_1] = '2.12.1';
+	$._apiMap.nativeWin[$.apiVersions.v1_9_0] = '2.12.1';
 
     // IE
     $._apiMap.ieAddon[$.apiVersions.v1_0] = '2.0.4';
@@ -237,6 +239,7 @@ LacunaWebPKI = function (license) {
 	$._apiMap.ieAddon[$.apiVersions.v1_7_2] = '2.8.0';
 	$._apiMap.ieAddon[$.apiVersions.v1_8_0] = '2.9.0';
 	$._apiMap.ieAddon[$.apiVersions.v1_8_1] = '2.9.1';
+	$._apiMap.ieAddon[$.apiVersions.v1_9_0] = '2.9.1';
 
     // Linux
     $._apiMap.nativeLinux[$.apiVersions.v1_0] = '2.0.0';
@@ -254,6 +257,7 @@ LacunaWebPKI = function (license) {
 	$._apiMap.nativeLinux[$.apiVersions.v1_7_2] = '2.12.1';
 	$._apiMap.nativeLinux[$.apiVersions.v1_8_0] = '2.13.0';
 	$._apiMap.nativeLinux[$.apiVersions.v1_8_1] = '2.13.1';
+	$._apiMap.nativeLinux[$.apiVersions.v1_9_0] = '2.13.1';
 
     // Mac
     $._apiMap.nativeMac[$.apiVersions.v1_0] = '2.3.0';
@@ -271,6 +275,7 @@ LacunaWebPKI = function (license) {
 	$._apiMap.nativeMac[$.apiVersions.v1_7_2] = '2.12.1';
 	$._apiMap.nativeMac[$.apiVersions.v1_8_0] = '2.13.0';
 	$._apiMap.nativeMac[$.apiVersions.v1_8_1] = '2.13.1';
+	$._apiMap.nativeMac[$.apiVersions.v1_9_0] = '2.13.1';
 
     // WebExtension
     $._apiMap.extension[$.apiVersions.v1_0] = '2.3.2';
@@ -288,6 +293,7 @@ LacunaWebPKI = function (license) {
 	$._apiMap.extension[$.apiVersions.v1_7_2] = '2.16.0';
 	$._apiMap.extension[$.apiVersions.v1_8_0] = '2.16.0';
 	$._apiMap.extension[$.apiVersions.v1_8_1] = '2.16.0';
+	$._apiMap.extension[$.apiVersions.v1_9_0] = '2.17.0';
 
 	// Mobile
     $._apiMap.mobile[$.apiVersions.v1_0] = '1.1.0';
@@ -305,6 +311,7 @@ LacunaWebPKI = function (license) {
 	$._apiMap.mobile[$.apiVersions.v1_7_2] = '3.0.0';
 	$._apiMap.mobile[$.apiVersions.v1_8_0] = '3.2.0';
 	$._apiMap.mobile[$.apiVersions.v1_8_1] = '3.2.0';
+	$._apiMap.mobile[$.apiVersions.v1_9_0] = '3.2.0';
 
     // All latest
     $._apiMap.nativeWin  [$.apiVersions.latest] = $._chromeNativeWinRequiredVersion;
@@ -1129,16 +1136,15 @@ LacunaWebPKI = function (license) {
 		return context.promise;
 	};
 
-	// TODO: next version
-	// $.signHashes = function (args) {
-	// 	var context = this._createContext(args);
-	// 	var request = {
-	// 		certificateThumbprint: args.certificateThumbprint,
-	// 		hashes: args.hashes
-	// 	};
-	// 	$._requestHandler.sendCommand(context, 'signHashes', request);
-	// 	return context.promise;
-	// };
+	$.signHashes = function (args) {
+		var context = this._createContext(args);
+		var request = {
+			certificateThumbprint: args.certificateThumbprint,
+			hashes: args.hashes
+		};
+		$._requestHandler.sendCommand(context, 'signHashes', request);
+		return context.promise;
+	};
 
 	$.preauthorizeSignatures = function (args) {
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "web-pki",
-  "version": "2.16.1",
+  "version": "2.17.0-alpha.1",
   "description": "The Lacuna Web PKI component enables web applications to interact with digital certificates through javascript, without the need of Java.",
   "main": "lacuna-web-pki.js",
   "types": "lacuna-web-pki.d.ts",