@pilotdev/pilot-web-sdk 24.4.0 → 24.9.0

package/src/lib/data/object-builder.ts

@@ -1,111 +0,0 @@
-import { AttributeType } from "./attribute";
-import { IAnnotationContainer } from "./annotations";
-import { IAccessRecord } from "./access";
-import { IRelation } from "./relation";
-
-/**
- * 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;
-  /**
-  * 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;
-}

package/src/lib/data/organisation-unit.ts

@@ -1,20 +0,0 @@
-
-export interface IOrganizationUnit {
-  get id(): number;
-  get title(): string;
-  get kind(): OrgUnitKind;
-  get children(): number[];
-  get isDeleted(): boolean;
-  get isBoss(): boolean;
-  get version(): number;
-  get person(): number;
-  get vicePersons(): number[];
-  get isCanceled(): boolean;
-  get groupPersons(): number[];
-}
-
-export enum OrgUnitKind {
-  Department = 0,
-  Position = 1,
-  Group = 2
-}

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,10 +0,0 @@
-import { getErrorString } from "@microsoft/signalr/dist/esm/Utils";
-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/subscriptionType.ts

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

package/src/lib/idata.plugin.ts

@@ -1,2 +0,0 @@
-
-export interface IDataPlugin {}

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

@@ -1,74 +0,0 @@
-import { Observable } from "rxjs";
-import { AccessLevel } from "../data/access";
-import { IDataObject, IPerson, IType, IOrganizationUnit } from "../data";
-
-/**
- * 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>
-  /**
-   * 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): IOrganizationUnit;
-  /**
-   * Get all the organisation units registered in database
-   * 
-   * @returns OrganisationUnit
-   */  
-  getOrganisationUnits(): IOrganizationUnit[];
-}
-    

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, IOrganizationUnit } 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<IOrganizationUnit>
-}

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.");
-  }
-}

package/src/lib/menu/menu.ts

@@ -1,24 +0,0 @@
-import { IMenuBuilder } from "./menu.builder";
-
-/**
- * Interface that allows to add new items to the menu and context menus
- */
-export abstract class IMenu<TMenuContext> {
-  /**
-   * 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/toolbar/toolbar-item-submenu.handler.ts

@@ -1,12 +0,0 @@
-import { IToolbarBuilder } from "./toolbar.builder";
-
-export abstract class IToolbarItemSubmenuHandler {
-   /**
-   * Build a submenu
-   * @param builder - toolbar builder
-   * @returns
-   */
-    onSubmenuRequested(builder: IToolbarBuilder): void {
-      throw new Error("Method 'onSubmenuRequested(builder: IToolbarBuilder)' must be implemented.");
-  }
-}

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

@@ -1,45 +0,0 @@
-/**
- * Represents a toolbar button and enables to set parametres to it
- */
-export abstract class IToolbarButtonItemBuilder {
-  
-  constructor() {
-    if (this.constructor == IToolbarButtonItemBuilder) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * Item's name to be displayed
-   * @param header - value
-   * @returns instance of IToolbarButtonItemBuilder
-   */
-  withHeader(header: string): IToolbarButtonItemBuilder {
-    throw new Error("Method 'withHeader(header: string)' must be implemented.");
-  }
-
-  /**
-   * Item's icon in SVG format
-   * @param name - icon name
-   * @param svg - url icon or base64 string
-   */
-  withIcon(name: string, svg: string): IToolbarButtonItemBuilder {
-    throw new Error("Method 'withIcon(name: string, svg: string)' must be implemented.");
-  }
-
-  /**
-   * Enabled the item
-   * @param value - value
-   */
-  withIsEnabled(value: boolean): IToolbarButtonItemBuilder {
-    throw new Error("Method 'withIsEnabled(value: boolean)' must be implemented.");
-  }
-
-  /**
-   * Item's hint
-   * @param hint - value
-   */
-  withHint(hint:  string): IToolbarButtonItemBuilder {
-    throw new Error("Method 'withHint(hint:  string)' must be implemented.");
-  }
-}

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

@@ -1,16 +0,0 @@
-import { IToolbarButtonItemBuilder } from "./toolbar-item.builder";
-import { IToolbarItemSubmenuHandler } from "./toolbar-item-submenu.handler";
-
-/**
- * Represents a toolbar menu button and enables to set parametres to it
- */
-export abstract class IToolbarMenuButtonItemBuilder extends IToolbarButtonItemBuilder {
-  /**
-   * Build a dropdown menu
-   * @param itemSubmenuHandler - toolbar submenu handler
-   * @returns The toolbar button menu builder
-   */
-  withMenu(itemSubmenuHandler: IToolbarItemSubmenuHandler): IToolbarMenuButtonItemBuilder {
-    throw new Error("Method 'withMenu(itemSubmenuHandler: IToolbarItemSubmenuHandler)' must be implemented.");
-  }
-}

package/src/lib/toolbar/toolbar-toggle-item.builder.ts

@@ -1,15 +0,0 @@
-import { IToolbarButtonItemBuilder } from "./toolbar-item.builder";
-
-/**
- * Represents a toolbar toggle button and enables to set parametres to it
- */
-export abstract class IToolbarToggleButtonItemBuilder extends IToolbarButtonItemBuilder {
-  
-  /**
-   * 
-   * @param value 
-   */
-  withIsChecked(value: boolean): IToolbarToggleButtonItemBuilder {
-    throw new Error("Method 'withIsChecked(value: boolean)' must be implemented.");
-  }
-}

package/src/lib/toolbar/toolbar.builder.ts

@@ -1,104 +0,0 @@
-import { IToolbarButtonItemBuilder } from "./toolbar-item.builder";
-import { IToolbarItemSubmenuHandler } from "./toolbar-item-submenu.handler";
-import { IToolbarMenuButtonItemBuilder } from "./toolbar-menu-item.builder";
-import { IToolbarToggleButtonItemBuilder } from "./toolbar-toggle-item.builder";
-
-export abstract class IToolbarBuilder {
-
-  constructor() {
-    if (this.constructor == IToolbarBuilder) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * Adds a new separator to the associated toolbar
-   * @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 button to the associated toolbar
-   * @param name - Internal item's name
-   * @param index - The index to put the new item at
-   */
-  addButtonItem(name: string, index: number): IToolbarButtonItemBuilder {
-    throw new Error("Method 'addButtonItem(name: string, index: number)' must be implemented.");
-  }
-
-  /**
-   * Adds a new menu button to the associated toolbar
-   * @param name - Internal item's name
-   * @param index - The index to put the new item at
-   */
-  addMenuButtonItem(name: string, index: number): IToolbarMenuButtonItemBuilder {
-    throw new Error("Method 'addMenuButtonItem(name: string, index: number)' must be implemented.");
-  }
-
-  /**
-   * Adds a new toggle button to the associated toolbar
-   * @param name -  Internal item's name
-   * @param index - The index to put the new item at
-   */
-  addToggleButtonItem(name: string, index: number): IToolbarToggleButtonItemBuilder {
-    throw new Error("Method 'addToggleButtonItem(name: string, index: number)' must be implemented.");
-  }
-
-  /**
-   * Replaces the item from the associated toolbar on button
-   * @param name - The name of toolbar button to replace
-   */
-  replaceButtonItem(name: string): IToolbarButtonItemBuilder {
-    throw new Error("Method 'replaceButtonItem(name: string)' must be implemented.");
-  }
-
-  /**
-   * Replace the item from the associated toolbar on menu button
-   * @param name - The name of toolbar menu button to replace 
-   */
-  replaceMenuButtonItem(name: string): IToolbarMenuButtonItemBuilder {
-    throw new Error("Method 'replaceMenuButtonItem(name: string)' must be implemented.");
-  }
-
-  /**
-   * Enables to set parametres to menu button item submenu
-   * @param name - Item's internal name
-   * @param itemSubmenuHandler - The toolbar button menu builder
-   */
-  handleMenuButtonItemSubmenu(name: string, itemSubmenuHandler: IToolbarItemSubmenuHandler): void {
-    throw new Error("Method 'handleMenuButtonItemSubmenu(name: string, itemSubmenuHandler: IToolbarItemSubmenuHandler)' must be implemented.");
-  }
-
-  /**
-   * Replaces the item from the associated toolbar on toggle button
-   * @param name - The name of toolbar toggle button to replace
-   */
-  replaceToggleButtonItem(name: string): IToolbarToggleButtonItemBuilder {
-    throw new Error("Method 'replaceToggleButtonItem(name: string)' must be implemented.");
-  }
-
-  /** 
-   * Gets the list of existing item names of associated toolbar 
-   * @returns - Existing toolbar item names 
-   */
-  get itemNames(): string[] {
-    throw new Error("Getter 'itemNames()' must be implemented.");
-  }
-
-  /**
-   * Gets count of toolbar items
-   */
-  get count(): number {
-    throw new Error("Getter 'count()' must be implemented.");
-  }
-
-  /**
-   * Removes specified item
-   * @param itemName - Item's internal name
-   */
-  removeItem(itemName: string): void {
-    throw new Error("Method 'removeItem(name: string)' must be implemented.");
-  }
-}

package/src/lib/toolbar/toolbar.ts

@@ -1,31 +0,0 @@
-import { IToolbarBuilder } from "./toolbar.builder";
-
-/**
- * Interface that allows to add new items to the toolbar
- */
-export abstract class IToolbar<TToolbarContext> {
-
-  constructor() {
-    if (this.constructor == IToolbar<TToolbarContext>) {
-      throw new Error("Abstract classes can't be instantiated.");
-    }
-  }
-
-  /**
-   * The method is called just before the toolbar is created
-   * @param builder - the toolbar builder object of associated toolbar
-   * @param context - context
-   */
-  build(builder: IToolbarBuilder, context: TToolbarContext): void {
-    throw new Error("Method 'build(builder: IToolbarBuilder, context: TToolbarContext)' must be implemented.");
-  }
-
-  /**
-   * 
-   * @param name 
-   * @param context 
-   */
-  onToolbarItemClick(name: string, context: TToolbarContext): void {
-    throw new Error("Method 'onToolbarItemClick(name: string, context: TToolbarContext)' must be implemented.");
-  }
-}