@pilotdev/pilot-web-sdk 25.4.0 → 25.6.0

package/lib/data/signature-custom-state.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Sets for signature the custom icon and title to the tooltip
+ * @interface ISignatureCustomState
+ *
+ * @property { string } icon - base64 string
+ * @property { string } iconName - unique icon name with prefix of the plugin name `${unique_prefix}-${icon_name}`
+ * @property { string } title - tooltip title
+ * @property { string } description - tooltip description
+ *
+ * @example
+ * const customState: ISignatureCustomState = {
+ *   icon: 'data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjEiIHZpZXdCb3g9IjAgMCAxNiAxNiIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4NCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI+DQogIC5zdC1yZWR7ZmlsbDogI2ZmYjgyOTt9DQogIC5zdC13aGl0ZXtmaWxsOiNmZmZmZmY7fQ0KPC9zdHlsZT4NCjxjaXJjbGUgY2xhc3M9InN0LXJlZCIgY3g9IjgiIGN5PSI4IiByPSI3Ii8+DQo8cGF0aCBjbGFzcz0ic3Qtd2hpdGUiIGQ9Im01LjcwNyA0LjI5My0xLjQxNDEgMS40MTQxIDIuMjkzIDIuMjkzLTIuMjkzIDIuMjkzIDEuNDE0MSAxLjQxNDEgMi4yOTMtMi4yOTMgMi4yOTMgMi4yOTMgMS40MTQxLTEuNDE0MS0yLjI5My0yLjI5MyAyLjI5My0yLjI5My0xLjQxNDEtMS40MTQxLTIuMjkzIDIuMjkzLTIuMjkzLTIuMjkzeiIvPg0KPC9zdmc+DQo=',
+ *   iconName: 'cryptoprovider_custom-error',
+ *   title: 'Custom state error',
+ *   description: 'Custom state error was thrown',
+ * };
+ */
+export interface ISignatureCustomState {
+    icon: string;
+    iconName: string;
+    title: string;
+    description: string;
+}

package/lib/data/signature-verification-result.d.ts

@@ -1,5 +1,18 @@
 import { SignatureVerificationStatus } from "./signature-verification-status";
-export interface ISignatureVerificationResult {
+import { ISignatureCustomState } from "./signature-custom-state";
+import { CadesType } from "./cades-type";
+export interface ISignatureVerificationResultBase {
     verificationStatus: SignatureVerificationStatus;
     error?: string;
+    signerName?: string;
+}
+export interface ISignatureVerificationResult extends ISignatureVerificationResultBase {
+    issuerName?: string;
+    signDate?: string;
+    customState?: ISignatureCustomState;
+    signerNameForeground?: string;
+}
+export interface IImportedSignatureVerificationResult extends ISignatureVerificationResultBase {
+    publicKeyOid: string;
+    cadesType: CadesType;
 }

package/lib/data/signature-verification-status.d.ts

@@ -3,6 +3,7 @@ export declare enum SignatureVerificationStatus {
     Valid = 1,
     ValidWithWarnings = 2,
     CannotBeChecked = 3,
-    Invalid = 4,
-    Error = 5
+    Duplicate = 4,
+    Invalid = 5,
+    Error = 6
 }

package/lib/icrypto-provider.d.ts

@@ -1,34 +1,34 @@
 import { Observable } from 'rxjs';
-import { IDataObject, ISignatureVerificationResult } from './data';
+import { IFile, IImportedSignatureVerificationResult, ISignatureRequest, ISignatureVerificationResult } from './data';
 import { ICertificate } from './data/certificate';
-import { SignatureType } from './data/signature-type';
 /**
  * Represents a cryptographic provider interface for signing, verifying, and retrieving certificates.
  */
-export interface ICryptoProvider {
+export declare abstract class ICryptoProvider {
+    constructor();
     /**
      * Signs a file with a digital signature using the provided certificate.
      *
-     * @param document The document for additional information, represented as an IDataObject.
-     * @param file The file to be signed, represented as an ArrayBuffer.
+     * @param documentId The documentId, represented as string.
+     * @param actualFile The actualFile for additional information, represented as an IFile.
+     * @param arrayBuffer The file to be signed, represented as an ArrayBuffer.
      * @param certificate The digital certificate to use for signing, represented as an ArrayBuffer.
      * @param signatureRequestIds An array of IDs for the signature requests.
      * @returns An observable that resolves to the digital signature as a string.
      */
-    sign(document: IDataObject, file: ArrayBuffer, certificate: ICertificate, signatureRequestIds: string[]): Observable<string>;
+    sign(documentId: string, actualFile: IFile, arrayBuffer: ArrayBuffer, certificate: ICertificate, signatureRequestIds: string[]): Observable<string>;
     /**
      * Verifies the digital signature of a file.
      *
      * @param file - The file data to be verified. This should be the raw binary data of the file.
      * @param sign - The digital signature to be verified against the file. This should be the raw binary data of the signature.
-     * @param signatureType - The signature's type.
+     * @param signatureRequest - Description of signature's request.
      * @returns - An observable that emits the result of the verification process. The result will indicate whether the signature is valid, and may include additional information such as error messages.
      *
      * @example
         const fileData = new ArrayBuffer(1024);
         const signatureData = new ArrayBuffer(256);
-        const signatureType = SignatureType.CadesBes;
-        verify(fileData, signatureData, signatureType).subscribe(result => {
+        verify(fileData, signatureData, signatureRequest).subscribe(result => {
           if (result.verificationStatus === F.Valid) {
             console.log("Signature is valid");
           } else {
@@ -36,7 +36,26 @@ export interface ICryptoProvider {
           }
         });
      */
-    verify(file: ArrayBuffer, sign: ArrayBuffer, signatureType: SignatureType): Observable<ISignatureVerificationResult>;
+    verify(file: ArrayBuffer, sign: ArrayBuffer, signatureRequest: ISignatureRequest): Observable<ISignatureVerificationResult>;
+    /**
+     * Verifies the digital signature that being imported.
+     *
+     * @param file - The file data to be verified. This should be the raw binary data of the file.
+     * @param sign - The digital signature to be verified against the file. This should be the raw binary data of the signature.
+     * @returns - An observable that emits the result of the verification process. The result will indicate whether the signature is valid, and may include additional information such as error messages.
+     *
+     * @example
+        const fileData = new ArrayBuffer(1024);
+        const signatureData = new ArrayBuffer(256);
+        verifyImportedSignature(fileData, signatureData).subscribe(result => {
+          if (result.verificationStatus === F.Valid) {
+            console.log("Signature is valid");
+          } else {
+            console.log(`Signature is invalid: ${result.error}`);
+          }
+        });
+     */
+    verifyImportedSignature(file: ArrayBuffer, sign: ArrayBuffer): Observable<IImportedSignatureVerificationResult>;
     /**
      * Retrieves a list of digital certificates.
      *
@@ -53,4 +72,10 @@ export interface ICryptoProvider {
      *  const can = canProcessAlgorithms("1.2.840.113549.1.1.1");
      */
     canProcessAlgorithms(publicKeyOid: string): boolean;
+    /** Determines whether the cryptoprovider can process signature. The method is needed when the signature is being imported and the signature algorithm is unknown.
+    *
+    * @param signatureFile signature file.
+    * @returns {boolean} True if the cryptoprovider can process the signature, false otherwise.
+    */
+    canProcessSignature(signatureFile: ArrayBuffer): boolean;
 }

package/lib/idata.plugin.d.ts

@@ -1,2 +1,6 @@
-export interface IDataPlugin {
+/**
+ * @exposedInterface
+ */
+export declare abstract class IDataPlugin {
+    constructor();
 }

package/lib/menu/menu.d.ts

@@ -1,8 +1,10 @@
+import { DocumentAnnotationsListContext, ObjectsViewContext } from "../contexts";
 import { IMenuBuilder } from "./menu.builder";
 /**
  * Interface that allows to add new items to the menu and context menus
+ * @exposedInterface
  */
-export declare abstract class IMenu<TMenuContext> {
+export declare abstract class IMenu<TMenuContext extends ObjectsViewContext | DocumentAnnotationsListContext> {
     /**
      * The method is called just before the menu is shown
      * @param builder The menu builder object of associated menu

package/lib/modifier/signature-modifier.d.ts

@@ -1,4 +1,4 @@
-import { ISignatureRequest } from "../data";
+import { ISignatureRequest, CadesType } from "../data";
 /**
  * Interface for modifying digital signature requests.
  */
@@ -63,4 +63,25 @@ export interface ISignatureBuilder {
      * @returns This instance of ISignatureBuilder for method chaining.
      */
     withObjectId(objectId: string): ISignatureBuilder;
+    /**
+     * Set certificate's public key oid for the signature.
+     *
+     * @param publicKeyOid - certificate's public key oid.
+     * @returns This instance of ISignatureBuilder for method chaining.
+     */
+    withPublicKeyOid(publicKeyOid: string): ISignatureBuilder;
+    /**
+     * Set cades type of last signature.
+     *
+     * @param cadesType - cades type.
+     * @returns This instance of ISignatureBuilder for method chaining.
+     */
+    withLastSignCadesType(cadesType: CadesType): ISignatureBuilder;
+    /**
+     * Set requirement property for advancement of the signature.
+     *
+     * @param needAdvancement - signature needs advancement.
+     * @returns This instance of ISignatureBuilder for method chaining.
+     */
+    withIsAdvancementRequired(needAdvancement: boolean): ISignatureBuilder;
 }

package/lib/object-card/object-card-handler.d.ts

@@ -4,6 +4,7 @@ import { IAttributeModifier } from "../modifier/attribute-modifier";
 import { AttributeValueChangedEventArgs } from "./attribute-value-changed-event-args";
 /**
  * Enables support for handling changing object attributes in object card
+ * @exposedInterface
  */
 export declare abstract class IObjectCardHandler {
     constructor();

package/lib/openspace/openspace-view.d.ts

@@ -1,7 +1,9 @@
+import { ObjectsViewContext, PageContext } from "../contexts";
 /**
  * Class that allows to declare the view for the openspace container
+ * @exposedInterface
  */
-export declare abstract class IOpenspaceView<TOpenspaceViewContext> {
+export declare abstract class IOpenspaceView<TOpenspaceViewContext extends ObjectsViewContext | PageContext> {
     constructor();
     /**
      * The method is called to match this View to the corresponding openspace container

package/lib/page-navigation/page-navigation.d.ts

@@ -1,6 +1,7 @@
 import { IPageNavigationBuilder } from './page-navigation.builder';
 /**
  * Interface that allows to add new sections and elements to navigation window
+ * @exposedInterface
  */
 export declare abstract class IPageNavigation {
     constructor();

package/lib/personal-settings/system-settings-keys.d.ts

@@ -70,5 +70,9 @@ export declare class SystemSettingsKeys {
     /**
      * User-defined digital signature title
      */
-    static readonly digitalSinatureTitleFeatureKey = "DigitalSinatureTitleFeatureKey-481EFA14-B116-434A-BAD6-F90DB883DEC9";
+    static readonly digitalSignatureTitleFeatureKey = "DigitalSignatureTitleFeatureKey-481EFA14-B116-434A-BAD6-F90DB883DEC9";
+    /**
+     * Enhanced signature service settings
+     */
+    static readonly advancedSignatureFeatureKey = "AdvancedSignatureFeatureKey-D267127C-DCED-4DEC-B1A8-6E7A919E383D";
 }

package/lib/tabs/tabs.d.ts

@@ -1,8 +1,10 @@
+import { ObjectsViewContext } from "../contexts";
 import { ITabsBuilder } from "./tabs.builder";
 /**
  * Interface that allows to add new items to the tabs
+ * @exposedInterface
  */
-export declare abstract class ITabs<TTabsContext> {
+export declare abstract class ITabs<TTabsContext extends ObjectsViewContext> {
     /**
      * The method is called just before the tabs are shown
      * @param builder The tab group builder object of associated tab group

package/lib/toolbar/toolbar.d.ts

@@ -1,8 +1,10 @@
+import { DocumentAnnotationsListContext, ObjectsViewContext } from "../contexts";
 import { IToolbarBuilder } from "./toolbar.builder";
 /**
  * Interface that allows to add new items to the toolbar
+ * @exposedInterface
  */
-export declare abstract class IToolbar<TToolbarContext> {
+export declare abstract class IToolbar<TToolbarContext extends ObjectsViewContext | DocumentAnnotationsListContext> {
     constructor();
     /**
      * The method is called just before the toolbar is created

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pilotdev/pilot-web-sdk",
-  "version": "25.4.0",
+  "version": "25.6.0",
   "peerDependencies": {
     "@angular/common": "17.3.12",
     "@angular/core": "17.3.12",

package/esm2022/lib/data/signature-type.mjs

@@ -1,9 +0,0 @@
-export var SignatureType;
-(function (SignatureType) {
-    SignatureType[SignatureType["CadesBes"] = 0] = "CadesBes";
-    SignatureType[SignatureType["CadesT"] = 1] = "CadesT";
-    SignatureType[SignatureType["CadesC"] = 2] = "CadesC";
-    SignatureType[SignatureType["CadesXLong"] = 3] = "CadesXLong";
-    SignatureType[SignatureType["CadesXLongType1"] = 4] = "CadesXLongType1";
-})(SignatureType || (SignatureType = {}));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2lnbmF0dXJlLXR5cGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9wcm9qZWN0cy9waWxvdC13ZWItc2RrL3NyYy9saWIvZGF0YS9zaWduYXR1cmUtdHlwZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLENBQU4sSUFBWSxhQU1YO0FBTkQsV0FBWSxhQUFhO0lBQ3ZCLHlEQUFZLENBQUE7SUFDWixxREFBVSxDQUFBO0lBQ1YscURBQVUsQ0FBQTtJQUNWLDZEQUFjLENBQUE7SUFDZCx1RUFBbUIsQ0FBQTtBQUNyQixDQUFDLEVBTlcsYUFBYSxLQUFiLGFBQWEsUUFNeEIiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgZW51bSBTaWduYXR1cmVUeXBlIHtcbiAgQ2FkZXNCZXMgPSAwLFxuICBDYWRlc1QgPSAxLFxuICBDYWRlc0MgPSAyLFxuICBDYWRlc1hMb25nID0gMyxcbiAgQ2FkZXNYTG9uZ1R5cGUxID0gNFxufVxuIl19

package/lib/data/signature-type.d.ts

@@ -1,7 +0,0 @@
-export declare enum SignatureType {
-    CadesBes = 0,
-    CadesT = 1,
-    CadesC = 2,
-    CadesXLong = 3,
-    CadesXLongType1 = 4
-}