@pilotdev/pilot-web-sdk 26.8.0 → 26.10.0

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

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

@@ -1,87 +0,0 @@
-import { ISignatureRequest, CadesType } from "../data";
-/**
- * Interface for modifying digital signature requests.
- */
-export interface ISignatureModifier {
-    /**
-     * Creates a new signature request with the given ID.
-     *
-     * @param signatureRequestId - The ID of the signature request to create.
-     * @returns An instance of ISignatureBuilder for further configuration.
-     */
-    create(signatureRequestId: string): ISignatureBuilder;
-    /**
-     * Edits an existing signature request with the given ID.
-     *
-     * @param signatureRequest - The signature request to edit.
-     * @returns An instance of ISignatureBuilder for further configuration.
-     */
-    edit(signatureRequest: ISignatureRequest): ISignatureBuilder;
-    /**
-     * Removes an existing signature request with the given ID.
-     *
-     * @param signatureRequestId - The ID of the signature request to remove.
-     */
-    remove(signatureRequestId: string): void;
-}
-/**
- * Interface for building digital signature requests.
- */
-export interface ISignatureBuilder {
-    /**
-     * Sets the position ID for the signature.
-     *
-     * @param positionId - The ID of the person position associated with the request.
-     * @returns This instance of ISignatureBuilder for method chaining.
-     */
-    withPositionId(positionId: number): ISignatureBuilder;
-    /**
-     * Sets the role for the signature.
-     *
-     * @param role - The role associated with the signature.
-     * @returns This instance of ISignatureBuilder for method chaining.
-     */
-    withRole(role: string): ISignatureBuilder;
-    /**
-     * Sets the flag sign for the signature.
-     *
-     * @param sign - The sign associated with the signature.
-     * @returns This instance of ISignatureBuilder for method chaining.
-     */
-    withSign(sign: string): ISignatureBuilder;
-    /**
-     * Sets the request signer for the signature.
-     *
-     * @param requestSigner - The request signer associated with the signature.
-     * @returns This instance of ISignatureBuilder for method chaining.
-     */
-    withRequestSigner(requestSigner: string): ISignatureBuilder;
-    /**
-     * Sets the object ID for the signature.
-     *
-     * @param objectId - The ID of the object associated with the signature.
-     * @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/attribute-value-changed-event-args.d.ts

@@ -1,10 +0,0 @@
-import { ObjectCardContext } from "../contexts/object-card-context";
-export declare class AttributeValueChangedEventArgs {
-    private readonly _oldValue;
-    private readonly _newValue;
-    private readonly _context;
-    constructor(oldValue: unknown, newValue: unknown, context: ObjectCardContext);
-    get oldValue(): unknown;
-    get newValue(): unknown;
-    get context(): ObjectCardContext;
-}

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

@@ -1,25 +0,0 @@
-import { ObjectCardContext } from "../contexts/object-card-context";
-import { IAttribute } from "../data";
-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();
-    /**
-     * Handle show object card
-     *
-     * @param modifier - Attribute modifier
-     * @param context - Context
-     */
-    handle(modifier: IAttributeModifier, context: ObjectCardContext): void;
-    /**
-     * The method called when attribute value has changed
-     * @param sender - Changed attribute
-     * @param args - Attribute change event args
-     * @param modifier - Attribute modifier
-     */
-    onValueChanged(sender: IAttribute, args: AttributeValueChangedEventArgs, modifier: IAttributeModifier): void;
-}

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

@@ -1,20 +0,0 @@
-import { BimElementPanelContext, BimRightPanelContext, DialogContext, ObjectsViewContext, PageContext, SettingsFeatureContext } from "../contexts";
-/**
- * Class that allows to declare the view for the openspace container
- * @exposedInterface
- */
-export declare abstract class IOpenspaceView<TOpenspaceViewContext extends BimElementPanelContext | BimRightPanelContext | ObjectsViewContext | PageContext | SettingsFeatureContext | DialogContext> {
-    constructor();
-    /**
-     * The method is called to match this View to the corresponding openspace container
-     *
-     * Should be identical with corresponding container's `withViewId(id: string)`
-     * @returns {string}
-     */
-    getViewId(): string;
-    /**
-     * The method is called just before the openspace container's view is shown
-     * @param context - context
-     */
-    getView(context: TOpenspaceViewContext): HTMLElement | undefined;
-}

package/lib/page-navigation/page-navigation-section-element.builder.d.ts

@@ -1,29 +0,0 @@
-/**
- * Represents a builder for navigation window section's element
- */
-export declare abstract class IPageNavigationSectionElementBuilder {
-    constructor();
-    /**
-     * Element's title to be displayed
-     * @param title value
-     */
-    withTitle(title: string): IPageNavigationSectionElementBuilder;
-    /**
-     * Element's title to be displayed
-     * @param description value
-     */
-    withDescription(description: string): IPageNavigationSectionElementBuilder;
-    /**
-     * Element's icon
-     * @param name Icon name
-     * @param iconSvg Url of icon or base64 string
-     */
-    withIcon(name: string, iconSvg: string): IPageNavigationSectionElementBuilder;
-    /**
-     * Element's view id
-     *
-     * Is matched with corresponding IOpenspaceView's `getViewId(): string`
-     * @param value - View Id
-     */
-    withViewId(value: string): IPageNavigationSectionElementBuilder;
-}

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

@@ -1,33 +0,0 @@
-import { IPageNavigationSectionElementBuilder } from './page-navigation-section-element.builder';
-/**
- * Represents a builder for the navigation window's section
- */
-export declare abstract class IPageNavigationSectionBuilder {
-    constructor();
-    /**
-     * Section's title to be displayed
-     * @param title value
-     */
-    withTitle(title: string): IPageNavigationSectionBuilder;
-    /**
-     * Gets the list of existing element ids of the section
-     * @returns Existing element ids
-     */
-    get elementIds(): string[];
-    /**
-     * Gets count of section's elements
-     */
-    get count(): number;
-    /**
-     * Adds a new element to the section
-     * @param id Element's internal id
-     * @param index The index to put the new element at
-     */
-    addElement(id: string, index: number): IPageNavigationSectionElementBuilder;
-    /**
-     * Replaces the element of the section
-     * If element does not exist - creates it
-     * @param id Elements's internal id
-     */
-    replaceElement(id: string): IPageNavigationSectionElementBuilder;
-}

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

@@ -1,28 +0,0 @@
-import { IPageNavigationSectionBuilder } from './page-navigation-section.builder';
-/**
- * Represents a builder for navigation window
- */
-export declare abstract class IPageNavigationBuilder {
-    constructor();
-    /**
-     * Gets the list of existing section ids of the navigation window
-     * @returns Existing section ids
-     */
-    get sectionIds(): string[];
-    /**
-     * Gets count of navigation window's elements
-     */
-    get count(): number;
-    /**
-     * Adds a new section to the navigation window
-     * @param id Sections's internal id
-     * @param index The index to put the new section at
-     */
-    addSection(id: string, index: number): IPageNavigationSectionBuilder;
-    /**
-     * Replaces the section of the  navigation window
-     * If element does not exist - creates it
-     * @param id Elements's internal id
-     */
-    replaceSection(id: string): IPageNavigationSectionBuilder;
-}

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

@@ -1,9 +0,0 @@
-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();
-    build(builder: IPageNavigationBuilder): void;
-}

package/lib/personal-settings/isettings-feature.d.ts

@@ -1,31 +0,0 @@
-/**
- * Extension interface that enables you to register the view on settings dialog
- * @interface ISettingsFeature
- * @exposedInterface
- */
-export declare abstract class ISettingsFeature {
-    constructor();
-    /**
-     * Gets the unique id of the settings item
-     * @readonly
-     * @type {string}
-     * @memberof ISettingsFeature
-     */
-    get key(): string;
-    /**
-     * Gets the display title of the settings item
-     * @readonly
-     * @type {string}
-     * @memberof ISettingsFeature
-     */
-    get title(): string;
-    /**
-     * Gets the value editor view id for the settings feature item
-     *
-     * Is matched with corresponding IOpenspaceView's `getViewId(): string`
-     * @readonly
-     * @type {string}
-     * @memberof ISettingsFeature
-     */
-    get editorViewId(): string;
-}

package/lib/personal-settings/isettings-value-provider.d.ts

@@ -1,17 +0,0 @@
-/**
- * Interface for a personal setting value provider
- * @interface ISettingValueProvider
- */
-export declare abstract class ISettingValueProvider {
-    constructor();
-    /**
-     * Gets the current setting value.
-     * @returns {string} The current setting value.
-     */
-    getValue(): string;
-    /**
-     * Sets the setting value.
-     * @param {string} value - The new setting value.
-     */
-    setValue(value: string): void;
-}

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

@@ -1,82 +0,0 @@
-export declare class SystemSettingsKeys {
-    /**
-     * Get's favorites feature key
-     */
-    static readonly favoritesFeatureKey = "Favorites-880e609e-54f9-4463-9c5e-f2b742a944dc";
-    /**
-     * Get's pilot storage drive letter feature key
-     */
-    static readonly pilotStorageDriveLetter = "PilotStorageDriveLetter-880e609e-54f9-4463-9c5e-f2b742a944dc";
-    /**
-     * Get's agreement roles feature key
-     */
-    static readonly agreementRolesFeatureKey = "AgreementRoles-0a782ccd-adb3-484f-8fb2-a6c58fc5a61d";
-    /**
-     * Get's tasks filters feature key
-     */
-    static readonly tasksFiltersFeatureKey = "TasksFilters-deab09c1-2276-457b-a59b-5682baec43c7";
-    /**
-     * Get's tasks groupings feature key
-     */
-    static readonly tasksGroupingsFeatureKey = "TasksGroupings-B66B65E3-8B6D-4468-BF07-869B03E7D62B";
-    /**
-     * Get's annotation filter feature key
-     */
-    static readonly annotationFilterFeatureKey = "AnnotationFilter-F151E782-6CEB-44AF-ADF1-AFB0A0FAB95E";
-    /**
-     * Get's annotation filter feature key
-     */
-    static readonly personalAnnotationFilterFeatureKey = "PersonalAnnotationFilter-9382f499-c1b9-433f-95bb-d83195d52121";
-    /**
-     * Get's mounted on Pilot-Storage items feature key
-     */
-    static readonly mountedItemsList = "MountedItems-29eff31a-8bd2-40a2-bdac-c020db132c8b";
-    /**
-     * Get's Pilot-Storage work folders feature key
-     */
-    static readonly workfoldersList = "Workfolders-C4A424C8-AE20-4277-9CA5-94629CEB1B86";
-    /**
-     * Get's selection path of the DocumentsExplorer
-     */
-    static readonly tabsState = "TabsState-9b9e6a36-013a-423c-9599-c6edc32a5b4f";
-    /**
-     * Get's auto blocking file extensions feature key
-     */
-    static readonly autoBlockingFileExtensionsFeatureKey = "AutoBlockingFileExtensions-1bb027f4-7dd0-4aec-8c0d-cffe63bfcbb3";
-    /**
-     * Get's auto commiting file extensions feature key
-     */
-    static readonly autoCommitingFileExtensionsFeatureKey = " AutoCommitingFileExtensions-2d0de5a1-f6c1-426e-b3e6-610dfb4b2666";
-    /**
-     * Get's auto updating files feature key
-     */
-    static readonly autoUpdatingFilesFeatureKey = "AutoUpdatingFileExtensions-6FB5DE6C-96B2-4F84-8650-7A2EB102EAC5";
-    /**
-     * Get's auto publishing settings feature key
-     */
-    static readonly autoPublishingExtensionsFeatureKey = "AutoPublishingExtensions-F6FF1869-DBC2-4253-A5AA-7B225D69E416";
-    /**
-     * Get's eml attributes dictionary feature key
-     */
-    static readonly emlAttributesDictionaryKeyFeatureKey = "EmlAttributesDictionary-354AB75D-A421-4836-A343-16FEC3014A4F";
-    /**
-     * Get's documents autofill feature key
-     */
-    static readonly docsAutoFillFeatureKey = "DocsAutoFillFeatureKey-d19b557b-2109-4221-8970-794372039186";
-    /**
-     * User-defined temp files regex masks
-     */
-    static readonly tempFileMasksFeatureKey = "TempFileMasksFeatureKey-388BD8A4-E7C0-48DD-B235-8C05030CFCF3";
-    /**
-     * User-defined Export/Import settings
-     */
-    static readonly exportImportFeatureKey = "ExportImportFeatureKey-4697EA6F-E018-4989-929D-992D1176CC3C";
-    /**
-     * User-defined digital signature title
-     */
-    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/tab-item.builder.d.ts

@@ -1,24 +0,0 @@
-/**
- * Enables to set parameters to the tab-group's item
- */
-export declare abstract class ITabItemBuilder {
-    constructor();
-    /**
-     * Item's title to be displayed
-     * @param title value
-     */
-    withTitle(title: string): ITabItemBuilder;
-    /**
-     * Item's icon
-     * @param name Icon name
-     * @param iconSvg Url of icon or base64 string
-     */
-    withIcon(name: string, iconSvg: string): ITabItemBuilder;
-    /**
-     * Item's view id
-     *
-     * Is matched with corresponding IOpenspaceView's `getViewId(): string`
-     * @param value - View Id
-     */
-    withViewId(value: string): ITabItemBuilder;
-}