@pilotdev/pilot-web-sdk 26.10.0 → 26.11.0

package/src/lib/data/person.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/src/lib/data/relation.ts

@@ -1,9 +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/src/lib/data/signature-verification-status.ts

@@ -1,10 +0,0 @@
-export enum SignatureVerificationStatus
-{
-  Unknown,
-  Valid,
-  ValidWithWarnings,
-  CannotBeChecked,
-  Duplicate,
-  Invalid,
-  Error,
-}

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

@@ -1,5 +0,0 @@
-
-export enum SubscriptionType {
-  Shallow,
-  Deep
-}

package/src/lib/data/theme.ts

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

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

@@ -1,11 +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/src/lib/data/user-state.ts

@@ -1,21 +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 enum UserStateColors {
-  None = 0,
-  Color1 = 1,
-  Color2 = 2,
-  Color3 = 3,
-  Color4 = 4,
-  Color5 = 5,
-  Color6 = 6,
-  Color7 = 7
-}

package/src/lib/icrypto-provider.ts

@@ -1,106 +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 abstract class ICryptoProvider {
-
-  constructor() {
-    if (this.constructor == ICryptoProvider) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * 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>{
-    throw new Error("Method 'sign(document: IDataObject, file: ArrayBuffer, certificate: ICertificate, signatureRequestIds: string[])' must be implemented.");
-  }
-
-  /**
-   * 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> {
-    throw new Error("Method 'verify(file: ArrayBuffer, sign: ArrayBuffer, signatureType: SignatureType)' must be implemented.");
-  }
-
-  /**
-   * 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> {
-    throw new Error("Method 'verifyImportedSignature(file: ArrayBuffer, sign: ArrayBuffer)' must be implemented.");
-  }
-
-  /**
-   * Retrieves a list of digital certificates.
-   *
-   * @returns An observable that resolves to an array of ICertificate objects.
-   */
-  getCertificates(): Observable<ICertificate[]> {
-    throw new Error("Method 'getCertificates()' must be implemented.");
-  }
-
-  /** 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 {
-    throw new Error("Method 'canProcessAlgorithms(publicKeyOid: string)' must be implemented.");
-  }
-
-   /** 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 {
-    throw new Error("Method 'canProcessSignature(signatureFile: ArrayBuffer)' must be implemented.");
-  }
-}

package/src/lib/idata.plugin.ts

@@ -1,10 +0,0 @@
-/**
- * @exposedInterface
- */
-export abstract class IDataPlugin {
-  constructor() {
-    if (this.constructor == IDataPlugin) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-}

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

@@ -1,5 +0,0 @@
-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-search-set-service.ts

@@ -1,44 +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/src/lib/injectable/injection-source.ts

@@ -1,66 +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 class InjectionSource {
-  constructor(
-    private _modifierProvider: IModifierProvider,
-    private _objectsRepository: IObjectsRepository,
-    private _renderContextProvider: IRenderContextProvider,
-    private _repositoryEvents: IRepositoryEvents,
-    private _progressService: IProgressService,
-    private _themeService: IThemeService,
-    private _commandBuilderProvider: ICommandBuilderProvider,
-    private _personalSettings: IPersonalSettings,
-    private _dialogService: IDialogService,
-    private _bimFeatures: IBimFeatures
-  ) {}
-
-  get modifierProvider(): IModifierProvider {
-    return this._modifierProvider;
-  }
-
-  get objectsRepository(): IObjectsRepository {
-    return this._objectsRepository;
-  }
-
-  get renderContextProvider(): IRenderContextProvider {
-    return this._renderContextProvider;
-  }
-
-  get repositoryEvents(): IRepositoryEvents {
-    return this._repositoryEvents;
-  }
-
-  get progressService(): IProgressService {
-    return this._progressService;
-  }
-
-  get themeService(): IThemeService {
-    return this._themeService;
-  }
-
-  get personalSettings(): IPersonalSettings {
-    return this._personalSettings;
-  }
-
-  get commandBuilderProvider(): ICommandBuilderProvider {
-    return this._commandBuilderProvider;
-  }
-
-  get dialogService(): IDialogService {
-    return this._dialogService;
-  }
-
-  get bimFeatures(): IBimFeatures {
-    return this._bimFeatures;
-  }
-}

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

@@ -1,53 +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/src/lib/injectable/objects-repository.ts

@@ -1,88 +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/src/lib/injectable/progress-service.ts

@@ -1,20 +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 enum ProgressBarMode {
-  Determinate,
-  Indeterminate,
-  Buffer,
-  Query
-}

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

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

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

@@ -1,33 +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/src/lib/menu/checkable-menu.builder.ts

@@ -1,15 +0,0 @@
-import { IMenuItemBuilder } from "./menu-item.builder";
-
-/**
- * 
- */
-export abstract class ICheckableMenuItemBuilder extends IMenuItemBuilder {
-  
-  /**
-   * 
-   * @param value 
-   */
-  withIsChecked(value: boolean): ICheckableMenuItemBuilder {
-    throw new Error("Method 'withIsChecked(value: boolean)' must be implemented.");
-  }
-}

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

@@ -1,45 +0,0 @@
-import { IMenuBuilder } from "./menu.builder";
-
-/**
- * Represents a menu item and enables to set parametres to it
- */
-export abstract class IMenuItemBuilder {
-
-  constructor() {
-    if (this.constructor == IMenuItemBuilder) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * Item's name to be displayed
-   * @param header value
-   */
-  withHeader(header: string): IMenuItemBuilder {
-    throw new Error("Method 'withHeader(header: string)' must be implemented.");
-  }
-
-  /**
-   * Item's icon
-   * @param name Icon name
-   * @param iconSvg Url of icon or base64 string
-   */
-  withIcon(name: string, iconSvg: string): IMenuItemBuilder {
-    throw new Error("Method 'withIcon(name: string, iconSvg: string)' must be implemented.");
-  }
-
-  /**
-   * Enabled the item
-   * @param value value
-   */
-  withIsEnabled(value: boolean): IMenuItemBuilder {
-    throw new Error("Method 'withIsEnabled(value: boolean)' must be implemented.");
-  }
-  
-  /**
-   * Item's submenu
-   */
-  withSubmenu(): IMenuBuilder {
-    throw new Error("Method 'withSubmenu()' must be implemented.");
-  }
-}

package/src/lib/menu/menu.builder.ts

@@ -1,79 +0,0 @@
-import { ICheckableMenuItemBuilder } from "./checkable-menu.builder";
-import { IMenuItemBuilder } from "./menu-item.builder";
-
-/**
- * Represents a menu and enables to add new items to it
- */
-export abstract class IMenuBuilder {
-
-  constructor() {
-    if (this.constructor == IMenuBuilder) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * Gets the list of existing items of associated menu or subitems of an item
-   * @returns Existing menu item names
-   */
-  get itemNames(): string[] {
-    throw new Error("Getter 'itemNames()' must be implemented.");
-  }
-
-  /**
-   * Gets count of menu items
-   */
-  get count(): number { 
-    throw new Error("Getter 'count()' must be implemented.");
-  }
-
-  /**
-   * Adds a new separator to the associated menu
-   * @param index The index to put the new item at
-   */
-  addSeparator(index: number): void {
-    throw new Error("Method 'addSeparator(index: number)' must be implemented.");
-  }
-
-  /**
-   * Adds a new item to the associated menu
-   * @param name Item's internal name
-   * @param index The index to put the new item at
-   */
-  addItem(name: string, index: number): IMenuItemBuilder {
-    throw new Error("Method 'addItem(name: string, index: number)' must be implemented.");
-  }
-
-  /**
-   * Adds a new checkable item to the associated menu
-   * @param name Item's internal name
-   * @param index The index to put the new item at
-   */
-  addCheckableItem(name: string, index: number): ICheckableMenuItemBuilder {
-    throw new Error("Method 'addCheckableItem(name: string, index: number)' must be implemented.");
-  }
-
-  /**
-   * Replaces the item to the associated menu
-   * @param name Item's internal name
-   */
-  replaceItem(name: string): IMenuItemBuilder {
-    throw new Error("Method 'replaceItem(name: string)' must be implemented.");
-  }
-
-  /**
-   * Removes the item with the specified name
-   * @param name Item's internal name
-   */
-  removeItem(name: string): void {
-    throw new Error("Method 'removeItem(name: string)' must be implemented.");
-  }
-
-  /**
-   * Gets the item
-   * @param name Item's internal name
-   */
-  getItem(name: string): IMenuBuilder {
-    throw new Error("Method 'getItem(name: string)' must be implemented.");
-  }
-}