@pilotdev/pilot-web-sdk 26.10.0 → 26.12.0

package/src/lib/menu/menu.ts

@@ -1,26 +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 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 {
-    throw new Error("Method 'build(builder: IMenuBuilder, context: TMenuContext)' must be implemented.");
-  }
-  
-  /**
-   * 
-   * @param name 
-   * @param context 
-   */
-  onMenuItemClick(name: string, context: TMenuContext): void {
-    throw new Error("Method 'onMenuItemClick(name: string, context: TMenuContext)' must be implemented.");
-  }
-}

package/src/lib/modifier/attribute-modifier.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/src/lib/modifier/modifier.ts

@@ -1,31 +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/src/lib/modifier/object-builder.ts

@@ -1,143 +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
-   */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  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
-   */ 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  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/src/lib/modifier/signature-modifier.ts

@@ -1,99 +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/src/lib/object-card/attribute-value-changed-event-args.ts

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

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

@@ -1,36 +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 abstract class IObjectCardHandler {
-  constructor() {
-    if (this.constructor == IObjectCardHandler) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * Handle show object card
-   * 
-   * @param modifier - Attribute modifier
-   * @param context - Context
-   */
-  handle(modifier: IAttributeModifier, context: ObjectCardContext): void {
-    throw new Error("Method 'handle(modifier: IAttributeModifier, context: ObjectCardContext)' must be implemented.");
-  }
-
-  /**
-   * 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 {
-    throw new Error("Method 'onValueChanged(sender: IAttribute, args: AttributeValueChangedEventArgs, modifier: IAttributeModifier)' must be implemented.");
-  }
-}

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

@@ -1,32 +0,0 @@
-import { BimElementPanelContext, BimRightPanelContext, DialogContext, ObjectsViewContext, PageContext, SettingsFeatureContext } from "../contexts";
-
-/**
- * Class that allows to declare the view for the openspace container
- * @exposedInterface
- */
-export abstract class IOpenspaceView<TOpenspaceViewContext extends BimElementPanelContext | BimRightPanelContext | ObjectsViewContext | PageContext | SettingsFeatureContext | DialogContext> {
-  constructor() {
-    if (this.constructor == IOpenspaceView<TOpenspaceViewContext>) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * 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 {
-    throw new Error("Method 'getViewId()' must be implemented.");
-  }
-
-  /**
-   * The method is called just before the openspace container's view is shown
-   * @param context - context
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  getView(context: TOpenspaceViewContext): HTMLElement | undefined {
-    throw new Error("Method 'getView(context: TOpenspaceViewContext)' must be implemented.");
-  }
-}

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

@@ -1,45 +0,0 @@
-/**
- * Represents a builder for navigation window section's element
- */
-export abstract class IPageNavigationSectionElementBuilder {
-  constructor() {
-    if (this.constructor == IPageNavigationSectionElementBuilder) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * Element's title to be displayed
-   * @param title value
-   */
-  withTitle(title: string): IPageNavigationSectionElementBuilder {
-    throw new Error("Method 'withTitle(title: string)' must be implemented.");
-  }
-
-  /**
-   * Element's title to be displayed
-   * @param description value
-   */
-  withDescription(description: string): IPageNavigationSectionElementBuilder {
-    throw new Error("Method 'withDescription(description: string)' must be implemented.");
-  }
-
-  /**
-   * Element's icon
-   * @param name Icon name
-   * @param iconSvg Url of icon or base64 string
-   */
-  withIcon(name: string, iconSvg: string): IPageNavigationSectionElementBuilder {
-    throw new Error("Method 'withIcon(name: string, iconSvg: string)' must be implemented.");
-  }
-
-  /**
-   * Element's view id
-   *
-   * Is matched with corresponding IOpenspaceView's `getViewId(): string`
-   * @param value - View Id
-   */
-  withViewId(value: string): IPageNavigationSectionElementBuilder {
-    throw new Error("Method 'withViewId(value: string)' must be implemented.");
-  }
-}

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

@@ -1,53 +0,0 @@
-import { IPageNavigationSectionElementBuilder } from './page-navigation-section-element.builder';
-
-/**
- * Represents a builder for the navigation window's section
- */
-export abstract class IPageNavigationSectionBuilder {
-  constructor() {
-    if (this.constructor == IPageNavigationSectionBuilder) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * Section's title to be displayed
-   * @param title value
-   */
-  withTitle(title: string): IPageNavigationSectionBuilder {
-    throw new Error("Method 'withTitle(title: string)' must be implemented.");
-  }
-
-  /**
-   * Gets the list of existing element ids of the section
-   * @returns Existing element ids
-   */
-  get elementIds(): string[] {
-    throw new Error("Getter 'elementIds()' must be implemented.");
-  }
-
-  /**
-   * Gets count of section's elements
-   */
-  get count(): number {
-    throw new Error("Getter 'count()' must be implemented.");
-  }
-
-  /**
-   * 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 {
-    throw new Error("Method 'addElement(id: string, index: number)' must be implemented.");
-  }
-
-  /**
-   * Replaces the element of the section
-   * If element does not exist - creates it
-   * @param id Elements's internal id
-   */
-  replaceElement(id: string): IPageNavigationSectionElementBuilder {
-    throw new Error("Method 'replaceElement(id: string)' must be implemented.");
-  }
-}

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

@@ -1,45 +0,0 @@
-import { IPageNavigationSectionBuilder } from './page-navigation-section.builder';
-
-/**
- * Represents a builder for navigation window
- */
-export abstract class IPageNavigationBuilder {
-  constructor() {
-    if (this.constructor == IPageNavigationBuilder) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * Gets the list of existing section ids of the navigation window
-   * @returns Existing section ids
-   */
-  get sectionIds(): string[] {
-    throw new Error("Getter 'sectionIds()' must be implemented.");
-  }
-
-  /**
-   * Gets count of navigation window's elements
-   */
-  get count(): number {
-    throw new Error("Getter 'count()' must be implemented.");
-  }
-
-  /**
-   * 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 {
-    throw new Error("Method 'addElement(id: string, index: number)' must be implemented.");
-  }
-
-  /**
-   * Replaces the section of the  navigation window
-   * If element does not exist - creates it
-   * @param id Elements's internal id
-   */
-  replaceSection(id: string): IPageNavigationSectionBuilder {
-    throw new Error("Method 'replaceElement(id: string)' must be implemented.");
-  }
-}

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

@@ -1,17 +0,0 @@
-import { IPageNavigationBuilder } from './page-navigation.builder';
-
-/**
- * Interface that allows to add new sections and elements to navigation window
- * @exposedInterface
- */
-export abstract class IPageNavigation {
-  constructor() {
-    if (this.constructor == IPageNavigation) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  build(builder: IPageNavigationBuilder): void {
-    throw new Error("Method 'build(builder: IOpenspaceBuilder)' must be implemented.");
-  }
-}

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

@@ -1,43 +0,0 @@
-/**
- * Extension interface that enables you to register the view on settings dialog
- * @interface ISettingsFeature
- * @exposedInterface
- */
-export abstract class ISettingsFeature {
-  constructor() {
-    if (this.constructor == ISettingsFeature) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-  /**
-   * Gets the unique id of the settings item
-   * @readonly
-   * @type {string}
-   * @memberof ISettingsFeature
-   */
-  get key(): string {
-    throw new Error("Getter 'key()' must be implemented.");
-  }
-
-  /**
-   * Gets the display title of the settings item
-   * @readonly
-   * @type {string}
-   * @memberof ISettingsFeature
-   */
-  get title(): string {
-    throw new Error("Getter 'title()' must be implemented.");
-  }
-
-  /**
-   * 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 {
-    throw new Error("Getter 'editorViewId()' must be implemented.");
-  }
-}

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

@@ -1,28 +0,0 @@
-/**
- * Interface for a personal setting value provider
- * @interface ISettingValueProvider
- */
-export abstract class ISettingValueProvider {
-  constructor() {
-    if (this.constructor == ISettingValueProvider) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * Gets the current setting value.
-   * @returns {string} The current setting value.
-   */
-  getValue(): string {
-    throw new Error("Method 'getValue()' must be implemented.");
-  }
-
-  /**
-   * Sets the setting value.
-   * @param {string} value - The new setting value.
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  setValue(value: string): void {
-    throw new Error("Method 'setValue(value: string)' must be implemented.");
-  }
-}