@pilotdev/pilot-web-sdk 26.10.0 → 26.12.0

package/lib/data/bim-features/bim-search-set.d.ts

@@ -0,0 +1,13 @@
+import { IDataObject } from "../data-object";
+export interface IBimSearchSetData {
+    get id(): string;
+    get title(): string;
+    get query(): string;
+    get source(): IDataObject;
+    get isFolder(): boolean;
+    get isDeleted(): boolean;
+}
+export interface IBimModelSearchResult {
+    get globalIdReadable(): string;
+    get modelPartId(): string;
+}

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

@@ -0,0 +1,11 @@
+export declare enum CadesType {
+    Unknown = 0,
+    NotCades = 1,
+    CadesBes = 2,
+    CadesEpes = 3,
+    CadesT = 4,
+    CadesC = 5,
+    CadesXLongType1 = 6,
+    CadesXLongType2 = 7,
+    CadesA = 8
+}

package/lib/data/certificate.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Represents a certificate with validity dates, issuer, and subject information.
+ */
+export interface ICertificate {
+    /**
+     * the thumbprint of the certificate.
+     */
+    get thumbprint(): string;
+    /**
+     * Validity end date of the certificate.
+     */
+    get validToDate(): string;
+    /**
+     * Validity start date of the certificate.
+     */
+    get validFromDate(): string;
+    /**
+     * Issuer of the certificate.
+     */
+    get issuer(): string;
+    /**
+     * Subject of the certificate.
+     */
+    get subject(): string;
+    /**
+     * The signature algorithm used in the certificate.
+     */
+    get publicKeyOid(): string;
+}

package/lib/data/data-object.d.ts

@@ -0,0 +1,77 @@
+import { AccessLevel, IAccessRecord } from "./access";
+import { IAttribute } from "./attribute";
+import { IFileSnapshot } from "./files-snapshot";
+import { IPerson } from "./person";
+import { IRelation } from "./relation";
+export declare enum RelationType {
+    SourceFiles = 1,
+    TaskInitiatorAttachments = 2,
+    TaskExecutorAttachments = 3,
+    MessageAttachments = 4,
+    Custom = 5,
+    TaskAttachments = 6
+}
+export declare enum ObjectState {
+    Alive = 0,
+    InRecycleBin = 1,
+    DeletedPermanently = 2,
+    Frozen = 3,
+    LockRequested = 4,
+    LockAccepted = 5
+}
+export interface IDataObject {
+    get id(): string;
+    get parentId(): string;
+    get title(): string;
+    get type(): IType;
+    get attributes(): {
+        [key: string]: any;
+    };
+    get children(): IChild[];
+    get creator(): IPerson;
+    get modifiedBy(): IPerson;
+    get created(): string;
+    get modifiedDate(): string;
+    get actualFileSnapshot(): IFileSnapshot;
+    get previousFileSnapshots(): IFileSnapshot[];
+    get context(): string[];
+    get relations(): IRelation[];
+    get access(): IAccessRecord[];
+    get accessLevel(): AccessLevel;
+    get allowedSubtypes(): number[];
+    get stateInfo(): IStateInfo;
+    get secretInfo(): ISecretInfo;
+    get historyItems(): string[];
+    get subscribers(): number[];
+}
+export interface IType {
+    get id(): number;
+    get title(): string;
+    get name(): string;
+    get icon(): string;
+    get sort(): number;
+    get hasFiles(): boolean;
+    get children(): number[];
+    get attributes(): IAttribute[];
+    get isDeleted(): boolean;
+    get kind(): number;
+    get isMountable(): boolean;
+    get isService(): boolean;
+    get isProject(): boolean;
+    get configuration(): string;
+}
+export interface IChild {
+    get objectId(): string;
+    get typeId(): number;
+}
+export interface ISecretInfo {
+    get isSecret(): boolean;
+    get secretParentId(): string;
+    get secretChangedBy(): number;
+}
+export interface IStateInfo {
+    get state(): ObjectState;
+    get date(): string;
+    get personId(): number;
+    get positionId(): number;
+}

package/lib/data/expected-error.d.ts

@@ -0,0 +1,5 @@
+export declare class ExpectedError extends Error {
+    isSilent: boolean;
+    isExpected: boolean;
+    constructor(message: string, isSilent?: boolean);
+}

package/lib/data/file.d.ts

@@ -0,0 +1,30 @@
+import { CadesType } from "./cades-type";
+export interface IFile {
+    get body(): IFileBody;
+    get name(): string;
+    get creatorId(): number;
+    get signatureRequests(): ISignatureRequest[];
+}
+export interface IFileBody {
+    get id(): string;
+    get size(): number;
+    get md5Hex(): string;
+    get modified(): string;
+    get created(): string;
+    get accessed(): string;
+}
+export interface ISignatureRequest {
+    get id(): string;
+    /**
+     * @deprecated
+     */
+    readonly databaseId?: string | undefined;
+    get positionId(): number;
+    get role(): string | undefined;
+    get signs(): string[] | undefined;
+    get requestedSigner(): string | undefined;
+    get objectId(): string | undefined;
+    get publicKeyOid(): string | undefined;
+    get lastSignCadesType(): CadesType;
+    get isAdvancementRequired(): boolean;
+}

package/lib/data/files-snapshot.d.ts

@@ -0,0 +1,8 @@
+import { IFile } from "./file";
+export interface IFileSnapshot {
+    get created(): string;
+    get creatorId(): number;
+    get reason(): string;
+    get files(): IFile[];
+    get hasAnnotations(): boolean;
+}

package/lib/data/organisation-unit.d.ts

@@ -0,0 +1,20 @@
+export interface IOrganisationUnit {
+    get id(): number;
+    get title(): string;
+    get kind(): OrgUnitKind;
+    get children(): number[];
+    get parentId(): number;
+    get isDeleted(): boolean;
+    get isBoss(): boolean;
+    get version(): number;
+    get person(): number;
+    get vicePersons(): number[];
+    get isCanceled(): boolean;
+    get groupPersons(): number[];
+    get permanentVicePersons(): number[];
+}
+export declare enum OrgUnitKind {
+    Department = 0,
+    Position = 1,
+    Group = 2
+}

package/lib/data/person.d.ts

@@ -0,0 +1,17 @@
+export interface IPerson {
+    get id(): number;
+    get login(): string;
+    get isInactive(): boolean;
+    get displayName(): string;
+    get positions(): number[];
+    get groups(): number[];
+    get bossOf(): number[];
+    get allOrgUnits(): number[];
+    get comment(): string;
+    get email(): string;
+    get sid(): string;
+    get uidDn(): string;
+    get isDeleted(): boolean;
+    get isAdmin(): boolean;
+    get version(): number;
+}

package/lib/data/relation.d.ts

@@ -0,0 +1,8 @@
+import { RelationType } from "./data-object";
+export interface IRelation {
+    get id(): string;
+    get targetId(): string;
+    get type(): RelationType;
+    get name(): string;
+    get versionId(): string;
+}

package/{src/lib/data/signature-custom-state.ts → lib/data/signature-custom-state.d.ts}

@@ -16,8 +16,8 @@
  * };
  */
 export interface ISignatureCustomState {
-  icon: string;
-  iconName: string;
-  title: string;
-  description: string;
+    icon: string;
+    iconName: string;
+    title: string;
+    description: string;
 }

package/{src/lib/data/signature-verification-result.ts → lib/data/signature-verification-result.d.ts}

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

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

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

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

@@ -0,0 +1,4 @@
+export declare enum SubscriptionType {
+    Shallow = 0,
+    Deep = 1
+}

package/lib/data/theme.d.ts

@@ -0,0 +1,7 @@
+export declare enum Theme {
+    Light = 0,
+    Dark = 1
+}
+export interface Themes {
+    get theme(): Theme;
+}

package/lib/data/user-state-machine.d.ts

@@ -0,0 +1,10 @@
+export interface IUserStateMachine {
+    get id(): string;
+    get title(): string;
+    get stateTransitions(): Map<string, ITransition[]>;
+}
+export interface ITransition {
+    get stateTo(): string;
+    get displayName(): string;
+    get availableForPositionsSource(): string[];
+}

package/lib/data/user-state.d.ts

@@ -0,0 +1,20 @@
+export interface IUserState {
+    get id(): string;
+    get name(): string;
+    get title(): string;
+    get icon(): string;
+    get color(): UserStateColors;
+    get isDeleted(): boolean;
+    get isCompletionState(): boolean;
+    get isSystemState(): boolean;
+}
+export declare enum UserStateColors {
+    None = 0,
+    Color1 = 1,
+    Color2 = 2,
+    Color3 = 3,
+    Color4 = 4,
+    Color5 = 5,
+    Color6 = 6,
+    Color7 = 7
+}

package/lib/icrypto-provider.d.ts

@@ -0,0 +1,82 @@
+import { Observable } from 'rxjs';
+import { IFile, IImportedSignatureVerificationResult, ISignatureRequest, ISignatureVerificationResult } from './data';
+import { ICertificate } from './data/certificate';
+/**
+ * Represents a cryptographic provider interface for signing, verifying, and retrieving certificates.
+ * @exposedInterface
+ */
+export declare abstract class ICryptoProvider {
+    constructor();
+    /**
+     * Signs a file with a digital signature using the provided certificate.
+     *
+     * @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(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 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);
+        verify(fileData, signatureData, signatureRequest).subscribe(result => {
+          if (result.verificationStatus === F.Valid) {
+            console.log("Signature is valid");
+          } else {
+            console.log(`Signature is invalid: ${result.error}`);
+          }
+        });
+     */
+    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.
+     *
+     * @returns An observable that resolves to an array of ICertificate objects.
+     */
+    getCertificates(): Observable<ICertificate[]>;
+    /** Determines whether the cryptoprovider can process the specified algorithm(s).
+     *
+     * @param publicKeyOid public key's oid used to create digital signature.
+     * @returns {boolean} True if the cryptoprovider can process the algorithm(s), false otherwise.
+     *
+     * @example
+     *  // When the client tries to determine if this provider can process algorithm
+     *  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

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

package/lib/injectable/bim-features/bim-compare-diff-service.d.ts

@@ -0,0 +1,4 @@
+import { CompareResultType, IDisplayParam } from "../../data/bim-features/bim-compare-diff";
+export interface IBimCompareDiffService {
+    updateDiffDisplayParams(type: CompareResultType, func: (old: IDisplayParam) => IDisplayParam): void;
+}

package/{src/lib/injectable/bim-features/bim-features.ts → lib/injectable/bim-features/bim-features.d.ts}

@@ -1,8 +1,6 @@
-import { IBimCompareDiffService } from "./bim-compare-diff-service";
-import { IBimSearchSetService } from "./bim-search-set-service";
-
-export interface IBimFeatures {
-  get searchSetService(): IBimSearchSetService;
-
-  get compareDisplayParamsService(): IBimCompareDiffService;
-}
+import { IBimCompareDiffService } from "./bim-compare-diff-service";
+import { IBimSearchSetService } from "./bim-search-set-service";
+export interface IBimFeatures {
+    get searchSetService(): IBimSearchSetService;
+    get compareDisplayParamsService(): IBimCompareDiffService;
+}

package/lib/injectable/bim-features/bim-search-set-service.d.ts

@@ -0,0 +1,39 @@
+import { Observable } from "rxjs";
+import { IBimModelSearchResult, IBimSearchSetData } from "../../data";
+export interface IBimSearchSetService {
+    /**
+     * Get the first-level search sets located directly under the hidden root folder of a model.
+     * Does not traverse into subfolders; returns only immediate children.
+     * @param {string} id Model identifier whose root search-set folder is queried.
+     * @returns {Observable<IBimSearchSetData[]>} Emits the list of search sets at level 1, then completes.
+     */
+    getFromModel(id: string): Observable<IBimSearchSetData[]>;
+    /**
+     * Get all search sets from the hidden root folder of a model recursively.
+     * Traverses all nested folders and aggregates every search set found.
+     * @param {string} id Model identifier whose search sets are retrieved recursively.
+     * @returns {Observable<IBimSearchSetData[]>} Emits the flattened list of all search sets from all levels, then completes.
+     */
+    getRecursivelyFromModel(id: string): Observable<IBimSearchSetData[]>;
+    /**
+     * Get search sets directly contained in a specific search-set folder by its ID.
+     * Does not include items from child folders.
+     * @param {string} id Search-set folder identifier to read from.
+     * @returns {Observable<IBimSearchSetData[]>} Emits the list of immediate search sets in the folder, then completes.
+     */
+    getFromFolder(id: string): Observable<IBimSearchSetData[]>;
+    /**
+     * Execute a stored search set against specified model parts.
+     * @param {string} id Identifier of the search set to execute.
+     * @param {string[]} modelPartIds Identifiers of model parts to include in the search scope.
+     * @returns {Observable<IBimModelSearchResult[]>} Emits matched items for the executed search set, then completes.
+     */
+    executeSearchSet(id: string, modelPartIds: string[]): Observable<IBimModelSearchResult[]>;
+    /**
+     * Execute an ad-hoc string-based query against specified model parts.
+     * @param {string} query Query expression.
+     * @param {string[]} modelPartIds Identifiers of model parts to include in the search scope.
+     * @returns {Observable<IBimModelSearchResult[]>} Emits matched items for the query, then completes.
+     */
+    executeStringQuery(query: string, modelPartIds: string[]): Observable<IBimModelSearchResult[]>;
+}

package/{src/lib/injectable/bim-features/index.ts → lib/injectable/bim-features/index.d.ts}

@@ -1,3 +1,3 @@
-export * from './bim-features';
-export * from './bim-search-set-service';
-export * from './bim-compare-diff-service';
+export * from './bim-features';
+export * from './bim-search-set-service';
+export * from './bim-compare-diff-service';

package/{src/lib/injectable/command-builder-provider.ts → lib/injectable/command-builder-provider.d.ts}

@@ -1,11 +1,10 @@
 import { ICommandBuilder } from "../commands/command-builder";
-
 /**
- * 
+ *
  */
 export interface ICommandBuilderProvider {
-  /**
-   * 
-   */
-  newCommandBuilder(): ICommandBuilder;
-}
+    /**
+     *
+     */
+    newCommandBuilder(): ICommandBuilder;
+}

package/{src/lib/injectable/dialog-service.ts → lib/injectable/dialog-service.d.ts}

@@ -1,6 +1,5 @@
 import { Observable } from "rxjs";
 import { DialogContext } from "../contexts";
-
 export interface IDialogService {
-  openDialogWithExit(viewId: string, context: DialogContext, title: string): Observable<unknown>;
+    openDialogWithExit(viewId: string, context: DialogContext, title: string): Observable<unknown>;
 }

package/lib/injectable/injection-source.d.ts

@@ -0,0 +1,26 @@
+import { IModifierProvider, IObjectsRepository, IProgressService, IRenderContextProvider, IRepositoryEvents, IThemeService, IPersonalSettings, IDialogService } from '../injectable';
+import { IBimFeatures } from './bim-features';
+import { ICommandBuilderProvider } from './command-builder-provider';
+export declare class InjectionSource {
+    private _modifierProvider;
+    private _objectsRepository;
+    private _renderContextProvider;
+    private _repositoryEvents;
+    private _progressService;
+    private _themeService;
+    private _commandBuilderProvider;
+    private _personalSettings;
+    private _dialogService;
+    private _bimFeatures;
+    constructor(_modifierProvider: IModifierProvider, _objectsRepository: IObjectsRepository, _renderContextProvider: IRenderContextProvider, _repositoryEvents: IRepositoryEvents, _progressService: IProgressService, _themeService: IThemeService, _commandBuilderProvider: ICommandBuilderProvider, _personalSettings: IPersonalSettings, _dialogService: IDialogService, _bimFeatures: IBimFeatures);
+    get modifierProvider(): IModifierProvider;
+    get objectsRepository(): IObjectsRepository;
+    get renderContextProvider(): IRenderContextProvider;
+    get repositoryEvents(): IRepositoryEvents;
+    get progressService(): IProgressService;
+    get themeService(): IThemeService;
+    get personalSettings(): IPersonalSettings;
+    get commandBuilderProvider(): ICommandBuilderProvider;
+    get dialogService(): IDialogService;
+    get bimFeatures(): IBimFeatures;
+}

package/lib/injectable/ipersonal-settings.d.ts

@@ -0,0 +1,48 @@
+import { Observable } from "rxjs";
+/**
+ * Interface for personal settings
+ * @interface IPersonalSettings
+ */
+export interface IPersonalSettings {
+    /**
+     * Retrieves the personal setting value for a given key
+     * @method getPersonalSettingValue
+     * @param {string} key - The key of the setting to retrieve
+     * @returns {Observable<string | undefined>} An observable containing the setting value or undefined
+     * @memberof IPersonalSettings
+     */
+    getPersonalSettingValue(key: string): Observable<string | undefined>;
+    /**
+     * Subscribes to the personal setting value changes for a given key
+     * @method subscribePersonalSettingValueChange
+     * @param {string} key - The key of the setting to retrieve
+     * @returns {Observable<string | undefined>} An observable containing the setting value or undefined
+     * @memberof IPersonalSettings
+     */
+    subscribePersonalSettingValueChange(key: string): Observable<string | undefined>;
+    /**
+     * Retrieves the common setting value for a given key
+     * @method getCommonSettingValue
+     * @param {string} key - The key of the setting to retrieve
+     * @returns {Observable<string[]>} An observable containing the array of common setting values
+     * @memberof IPersonalSettings
+      */
+    getCommonSettingValue(key: string): Observable<string[]>;
+    /**
+     * Subscribes to the common setting value changes for a given key
+     * @method subscribeCommonSettingValueChange
+     * @param {string} key - The key of the setting to retrieve
+     * @returns {Observable<string[]>} An observable containing the setting value or undefined
+     * @memberof IPersonalSettings
+     */
+    subscribeCommonSettingValueChange(key: string): Observable<string[]>;
+    /**
+     * Changes the value of a setting
+     * @method changeSettingValue
+     * @param {string} key - The key of the setting to change
+     * @param {string} value - The new value of the setting
+     * @returns {Observable<void>}
+     * @memberof IPersonalSettings
+     */
+    changeSettingValue(key: string, value: string): Observable<void>;
+}

package/{src/lib/injectable/modifier-provider.ts → lib/injectable/modifier-provider.d.ts}

@@ -1,11 +1,10 @@
 import { IModifier } from "../modifier/modifier";
-
 /**
  * Provides modifier
  */
 export interface IModifierProvider {
-  /**
-   * 
-   */
-  newModifier(): IModifier;
-}
+    /**
+     *
+     */
+    newModifier(): IModifier;
+}