@pilotdev/pilot-web-sdk 26.10.0 → 26.11.0

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

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

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

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

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

@@ -0,0 +1,31 @@
+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/injectable/theme-service.ts → lib/injectable/theme-service.d.ts}

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

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

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

package/{src/lib/menu/index.ts → lib/menu/index.d.ts}

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

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

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

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

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

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

package/{src/lib/modifier/index.ts → lib/modifier/index.d.ts}

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

package/lib/modifier/modifier.d.ts

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

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

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

@@ -0,0 +1,10 @@
+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/{src/lib/object-card/index.ts → lib/object-card/index.d.ts}

@@ -1,2 +1,2 @@
-export * from './attribute-value-changed-event-args';
-export * from './object-card-handler';
+export * from './attribute-value-changed-event-args';
+export * from './object-card-handler';

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

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

@@ -0,0 +1,20 @@
+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/{src/lib/page-navigation/index.ts → lib/page-navigation/index.d.ts}

@@ -1,4 +1,4 @@
-export * from './page-navigation-section-element.builder';
-export * from './page-navigation-section.builder';
-export * from './page-navigation.builder';
-export * from './page-navigation';
+export * from './page-navigation-section-element.builder';
+export * from './page-navigation-section.builder';
+export * from './page-navigation.builder';
+export * from './page-navigation';

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

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