@pilotdev/pilot-web-sdk 26.14.0 → 26.16.0

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/bim-features/index.d.ts

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

package/lib/injectable/command-builder-provider.d.ts

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

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

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

package/lib/injectable/index.d.ts

@@ -1,11 +0,0 @@
-export * from './injection-source';
-export * from './objects-repository';
-export * from './render-context-provider';
-export * from './modifier-provider';
-export * from './repository-events';
-export * from './progress-service';
-export * from './theme-service';
-export * from './command-builder-provider';
-export * from './ipersonal-settings';
-export * from './dialog-service';
-export * from './bim-features';

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/modifier-provider.d.ts

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

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/injectable/theme-service.d.ts

@@ -1,6 +0,0 @@
-import { Observable } from "rxjs";
-import { Themes } from "../data/theme";
-export interface IThemeService {
-    get themes(): Themes;
-    get change(): Observable<Themes>;
-}

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/index.d.ts

@@ -1,4 +0,0 @@
-export * from './menu';
-export * from './checkable-menu.builder';
-export * from './menu-item.builder';
-export * from './menu.builder';

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;
-}

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

@@ -1,49 +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 declare abstract class IMenuBuilder {
-    constructor();
-    /**
-     * Gets the list of existing items of associated menu or subitems of an item
-     * @returns Existing menu item names
-     */
-    get itemNames(): string[];
-    /**
-     * Gets count of menu items
-     */
-    get count(): number;
-    /**
-     * Adds a new separator to the associated menu
-     * @param index The index to put the new item at
-     */
-    addSeparator(index: number): void;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * Replaces the item to the associated menu
-     * @param name Item's internal name
-     */
-    replaceItem(name: string): IMenuItemBuilder;
-    /**
-     * Removes the item with the specified name
-     * @param name Item's internal name
-     */
-    removeItem(name: string): void;
-    /**
-     * Gets the item
-     * @param name Item's internal name
-     */
-    getItem(name: string): IMenuBuilder;
-}

package/lib/menu/menu.d.ts

@@ -1,20 +0,0 @@
-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 extends ObjectsViewContext | DocumentAnnotationsListContext> {
-    /**
-     * The method is called just before the menu is shown
-     * @param builder The menu builder object of associated menu
-     * @param context Context
-     */
-    build(builder: IMenuBuilder, context: TMenuContext): void;
-    /**
-     *
-     * @param name
-     * @param context
-     */
-    onMenuItemClick(name: string, context: TMenuContext): void;
-}

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

@@ -1,9 +0,0 @@
-export interface IAttributeModifier {
-    /**
-     * Sets new value for attribute
-     *
-     * @param name - Attribute name
-     * @param value - New value
-     */
-    setValue(name: string, value: unknown): void;
-}

package/lib/modifier/index.d.ts

@@ -1,4 +0,0 @@
-export * from './attribute-modifier';
-export * from './object-builder';
-export * from './modifier';
-export * from './signature-modifier';

package/lib/modifier/modifier.d.ts

@@ -1,30 +0,0 @@
-import { Observable } from "rxjs/internal/Observable";
-import { IDataObject } from "../data";
-import { IObjectBuilder } from "./object-builder";
-/**
- * Creates, modifies and deletes objects
- */
-export interface IModifier {
-    /**
-     * Creates a new object
-     *
-     * @param id New object id
-     * @param parentId Parent id
-     * @param typeId Creating object's type id
-     * @return Fluent interface that enables you to modify created object
-     */
-    create(id: string, parentId: string, typeId: number): IObjectBuilder;
-    /**
-     * Edits existing object
-     *
-     * @param id Id of object to modify
-     * @returns Fluent interface that enables you to modify created object
-     */
-    edit(id: string): IObjectBuilder;
-    /**
-     * Applies all the changes have been made in modifier
-     *
-     * @returns Created and edited objects wrapped in cold Observable
-     */
-    apply(): Observable<IDataObject[]>;
-}

package/lib/modifier/object-builder.d.ts

@@ -1,140 +0,0 @@
-import { AttributeType } from "../data/attribute";
-import { IAnnotationContainer, IMarkup } from "../data/annotations";
-import { IAccessRecord } from "../data/access";
-import { IRelation } from "../data/relation";
-import { ISignatureModifier } from "./signature-modifier";
-/**
- * Fluent interface that enables you to modify the associated object
- */
-export interface IObjectBuilder {
-    /**
-     * Sets the string attribute value
-     *
-     * @param name  Attribute name
-     * @param value  Attribute value
-     * @returns Self
-     */
-    setAttribute(name: string, value: any, type: AttributeType): IObjectBuilder;
-    /**
-     * Adds access record to an object
-     *
-     * @param record  Access record
-     * @returns Self
-     */
-    setAccess(record: IAccessRecord): IObjectBuilder;
-    /**
-     * Removes access record
-     *
-     * @param record  Access record
-     * @returns Self
-     */
-    removeAccess(record: IAccessRecord): IObjectBuilder;
-    /**
-     * Adds a relation
-     *
-     * @param relation  Relation
-     * @returns Self
-     */
-    addRelation(relation: IRelation): IObjectBuilder;
-    /**
-     * Removes relation
-     *
-     * @param relationId  Relation id
-     * @returns Self
-     */
-    removeRelation(relationId: string): IObjectBuilder;
-    /**
-     * Sets new type. It is recommended to use this method only for recovering permanently deleted objects. In other cases, this can lead to system malfunction.
-     *
-     * @param typeId  Type id
-     * @returns Self
-     */
-    setTypeId(typeId: number): IObjectBuilder;
-    /**
-     * Sets new parent
-     *
-     * @param parentId  Parent id
-     * @returns Self
-     */
-    setParentId(parentId: string): IObjectBuilder;
-    /**
-     * Adds file snapshot
-     *
-     * @param reason  Reason
-     * @returns Self
-     */
-    createSnapshot(reason: string): IObjectBuilder;
-    /**
-     * Makes file snapshot actual
-     *
-     * @param version  Version of file snapshot to make actual
-     * @param reason  Reason
-     * @returns Self
-     */
-    createSnapshotFrom(version: string, reason: string): IObjectBuilder;
-    /**
-     * Adds a new file to the associated object
-     *
-     * @param file File identificator
-     * @param file File interface
-     * @param creationTime File creation time
-     * @param lastAccessTime File last access time
-     * @param lastWriteTime File last write time
-     * @returns Fluent interface that enables you to modify the associated object
-     */
-    addFile(fileId: string, file: File, creationTime: Date, lastAccessTime: Date, lastWriteTime: Date): IObjectBuilder;
-    /**
-     * Removes file from actual file snapshot by identifier
-     * @param fileId file identificator
-     * @returns Fluent interface that enables you to modify the associated object
-     */
-    removeFile(fileId: string): IObjectBuilder;
-    /**
-    * Sets permanently deleted flag
-    *
-    * @param isDeleted  Value
-    * @returns Self
-    */
-    setIsDeleted(isDeleted: boolean): IObjectBuilder;
-    /**
-     * Set flag in recycle bin
-     *
-     * @param isInRecycleBin  Value
-     * @returns Self
-     */
-    setIsInRecycleBin(isInRecycleBin: boolean): IObjectBuilder;
-    /**
-     * Sets frozen flag
-     *
-     * @param isFreezed Value
-     * @returns Self
-     */
-    setIsFreezed(isFreezed: boolean): IObjectBuilder;
-    /**
-     * Sets object's secret info
-     *
-     * @param isSecret Value
-     * @returns Self
-     */
-    setIsSecret(isSecret: boolean): IObjectBuilder;
-    /**
-     * Adds or changes a annotation
-     *
-     * @param container Annotation container
-     * @param attrbutes Annotation attributes
-     * @returns Self
-     */
-    addAnnotationContainer(container: IAnnotationContainer, attrbutes: any): IObjectBuilder;
-    /**
-     *
-     * @param markups
-     */
-    addMarkups(markups: IMarkup[]): IObjectBuilder;
-    /**
-     * Sets new signature requests to the selected file
-     *
-     * @param fileId file id
-     * @returns Fluent interface that enables you to modify the signatures of the filtered files
-     */
-    setSignatures(fileId: string): ISignatureModifier;
-}