@pilotdev/pilot-web-sdk 26.8.0 → 26.10.0

package/lib/data/certificate.d.ts

@@ -1,29 +0,0 @@
-/**
- * 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

@@ -1,77 +0,0 @@
-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

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

package/lib/data/file.d.ts

@@ -1,30 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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

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

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

@@ -1,9 +0,0 @@
-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

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

package/lib/data/theme.d.ts

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

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

@@ -1,10 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,82 +0,0 @@
-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

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

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

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

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

@@ -1,39 +0,0 @@
-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/lib/injectable/injection-source.d.ts

@@ -1,26 +0,0 @@
-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

@@ -1,48 +0,0 @@
-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/lib/injectable/objects-repository.d.ts

@@ -1,87 +0,0 @@
-import { Observable } from "rxjs";
-import { AccessLevel, IAccessRecord } from "../data/access";
-import { IDataObject, IPerson, IType, IOrganisationUnit } from "../data";
-import { IUserStateMachine } from "../data/user-state-machine";
-/**
- * Represents the repository that provides access to objects, types, organisation units and people
- */
-export interface IObjectsRepository {
-    /**
-     * Get objects with specified ids
-     *
-     * @param ids Ids of objects to subsribe
-     * @returns
-     */
-    getObjects(ids: string[]): Observable<IDataObject[]>;
-    /**
-     * Get object's access for the person
-     *
-     * @param objectId Object id
-     * @param personId Person Id
-     * @returns Cold Observable
-     */
-    getCurrentAccess(objectId: string, personId: number): Observable<AccessLevel>;
-    /**
-     * Get access records for the object
-     *
-     * @param objectId Object id
-     * @param positions Person position ids
-     * @returns Cold Observable
-     */
-    getAccessRecords(objectId: string, positions: number[]): Observable<IAccessRecord[]>;
-    /**
-     * Gets the person with specified id
-     *
-     * @param id Person id
-     * @returns Person
-     */
-    getPerson(id: number): IPerson;
-    /**
-     * Gets the current person
-     *
-     * @returns Person
-     */
-    getCurrentPerson(): IPerson;
-    /**
-     * Gets all the people registred in database
-     *
-     * @returns Person[]
-     */
-    getPeople(): IPerson[];
-    /**
-     * Gets type by identifier
-     *
-     * @returns Type
-     */
-    getType(id: number): IType;
-    /**
-     * Gets type by name
-     *
-     * @returns Type
-     */
-    getTypeByName(name: string): IType;
-    /**
-     * Gets all the types registered in database
-     *
-     * @returns Type[]
-     */
-    getTypes(): IType[];
-    /**
-     * Gets organisation unit by identifier
-     *
-     * @returns OrganisationUnit
-     */
-    getOrganisationUnit(id: number): IOrganisationUnit;
-    /**
-     * Get all the organisation units registered in database
-     *
-     * @returns OrganisationUnit
-     */
-    getOrganisationUnits(): IOrganisationUnit[];
-    /**
-     * Get all the user state machines registered in database
-     *
-     * @returns IUserStateMachine
-     */
-    getUserStateMachines(): Map<string, IUserStateMachine>;
-}

package/lib/injectable/progress-service.d.ts

@@ -1,18 +0,0 @@
-import { Observable } from "rxjs";
-/**
- *
- */
-export interface IProgressService {
-    get percentage(): Observable<number>;
-    get isOpen(): boolean;
-    open(mode: ProgressBarMode): void;
-    update(percentage: number): void;
-    reset(): void;
-    close(): void;
-}
-export declare enum ProgressBarMode {
-    Determinate = 0,
-    Indeterminate = 1,
-    Buffer = 2,
-    Query = 3
-}

package/lib/injectable/render-context-provider.d.ts

@@ -1,10 +0,0 @@
-import { RenderContext } from "../contexts/render-context";
-/**
- * Provides render context
- */
-export interface IRenderContextProvider {
-    /**
-     *
-     */
-    getRenderContext(): RenderContext;
-}

package/lib/injectable/repository-events.d.ts

@@ -1,31 +0,0 @@
-import { Observable } from "rxjs";
-import { IDataObject, IPerson, IType, IOrganisationUnit } from "../data";
-/**
- * Notifies on change events
- */
-export interface IRepositoryEvents {
-    /**
-     * Subsribes to changes in objects with specified identifiers
-     *
-     * @returns Hot observable
-     */
-    subscribeObjects(ids: string[]): Observable<IDataObject>;
-    /**
-     * Subsribes to changes in people
-     *
-     * @returns Hot observable
-     */
-    subscribePeople(): Observable<IPerson>;
-    /**
-     * Subsribes to changes in types
-     *
-     * @returns Hot observable
-     */
-    subscribeTypes(): Observable<IType>;
-    /**
-     * Subsribes to changes in organisation units
-     *
-     * @returns Hot observable
-     */
-    subscribeOrganisationUnits(): Observable<IOrganisationUnit>;
-}

package/lib/menu/checkable-menu.builder.d.ts

@@ -1,11 +0,0 @@
-import { IMenuItemBuilder } from "./menu-item.builder";
-/**
- *
- */
-export declare abstract class ICheckableMenuItemBuilder extends IMenuItemBuilder {
-    /**
-     *
-     * @param value
-     */
-    withIsChecked(value: boolean): ICheckableMenuItemBuilder;
-}

package/lib/menu/menu-item.builder.d.ts

@@ -1,27 +0,0 @@
-import { IMenuBuilder } from "./menu.builder";
-/**
- * Represents a menu item and enables to set parametres to it
- */
-export declare abstract class IMenuItemBuilder {
-    constructor();
-    /**
-     * Item's name to be displayed
-     * @param header value
-     */
-    withHeader(header: string): IMenuItemBuilder;
-    /**
-     * Item's icon
-     * @param name Icon name
-     * @param iconSvg Url of icon or base64 string
-     */
-    withIcon(name: string, iconSvg: string): IMenuItemBuilder;
-    /**
-     * Enabled the item
-     * @param value value
-     */
-    withIsEnabled(value: boolean): IMenuItemBuilder;
-    /**
-     * Item's submenu
-     */
-    withSubmenu(): IMenuBuilder;
-}