@pilotdev/pilot-web-sdk 23.0.0-alpha.1 → 24.4.0

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

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

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

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

@@ -0,0 +1,33 @@
+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 +1,15 @@
-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.");
-  }
+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/index.ts

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

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

@@ -1,45 +1,45 @@
-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.");
-  }
+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 +1,79 @@
-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.");
-  }
+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 +1,24 @@
-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.");
-  }
+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/index.ts

@@ -1,7 +1,7 @@
-
-export * from './toolbar';
-export * from './toolbar-item.builder';
-export * from './toolbar-item-submenu.handler';
-export * from './toolbar-menu-item.builder';
-export * from './toolbar-toggle-item.builder';
+
+export * from './toolbar';
+export * from './toolbar-item.builder';
+export * from './toolbar-item-submenu.handler';
+export * from './toolbar-menu-item.builder';
+export * from './toolbar-toggle-item.builder';
 export * from './toolbar.builder';

package/src/lib/toolbar/toolbar-item-submenu.handler.ts

@@ -1,4 +1,12 @@
-
-export abstract class IToolbarItemSubmenuHandler {
-  
+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 +1,45 @@
-/**
- * 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.");
-  }
+/**
+ * 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 +1,16 @@
-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.");
-  }
+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 +1,15 @@
-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.");
-  }
+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.");
+  }
 }