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

package/README.md

@@ -0,0 +1,5 @@
+# Installation
+> `npm install @pilotdev/pilot-web-sdk`
+
+# Summary
+This package contains everything you need to develop extension modules for the web version of ASCON Pilot-BIM.

package/ng-package.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../dist/pilot-web-sdk",
+  "lib": {
+    "entryFile": "src/public-api.ts"
+  }
+}

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@pilotdev/pilot-web-sdk",
+  "version": "23.0.0-alpha.1",
+  "peerDependencies": {
+    "@angular/common": "15.2.8",
+    "@angular/core": "15.2.8",
+    "rxjs": "7.8.1"
+  },
+  "dependencies": {
+    "tslib": "2.3.0"
+  },
+  "sideEffects": false
+}

package/src/lib/context.ts

@@ -0,0 +1,25 @@
+/**
+ * Contex for objects view
+ */
+export class ObjectsViewContext {
+  
+  constructor(selectedObjects: any[], isContext: boolean, shortcuts?: any[]) {
+    this.selectedObjects = selectedObjects;
+    this.isContext = isContext;
+    this.shortcuts = shortcuts;
+  }
+
+  /**
+   * 
+   */
+  readonly selectedObjects: any[]; // IDataObject[]
+
+  /**
+   * 
+   */
+  readonly isContext: boolean;
+  /**
+   * 
+   */
+  readonly shortcuts: any[]; // IDataObject[]
+}

package/src/lib/idata.plugin.ts

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

package/src/lib/injectable/index.ts

@@ -0,0 +1 @@
+export * from './objects.repository';

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

@@ -0,0 +1,7 @@
+import { Observable } from "rxjs";
+
+export interface IObjectsRepository {
+  subscribeObjects(ids: string[]): Observable<any>;
+  getPerson(id: number): any;
+}
+    

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

@@ -0,0 +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.");
+  }
+}

package/src/lib/menu/index.ts

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

@@ -0,0 +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.");
+  }
+}

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

@@ -0,0 +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.");
+  }
+}

package/src/lib/menu/menu.ts

@@ -0,0 +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.");
+  }
+}

package/src/lib/toolbar/index.ts

@@ -0,0 +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.builder';

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

@@ -0,0 +1,4 @@
+
+export abstract class IToolbarItemSubmenuHandler {
+  
+}

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

@@ -0,0 +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.");
+  }
+}

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

@@ -0,0 +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.");
+  }
+}

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

@@ -0,0 +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.");
+  }
+}

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

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

@@ -0,0 +1,31 @@
+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.");
+  }
+}

package/src/public-api.ts

@@ -0,0 +1,8 @@
+/*
+ * Public API Surface of pilot-web-sdk
+ */
+export * from './lib/context';
+export * from './lib/idata.plugin';
+export * from './lib/injectable/index';
+export * from './lib/toolbar/index';
+export * from './lib/menu/index';

package/tsconfig.lib.json

@@ -0,0 +1,14 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../out-tsc/lib",
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "types": []
+  },
+  "exclude": [
+    "**/*.spec.ts"
+  ]
+}

package/tsconfig.lib.prod.json

@@ -0,0 +1,10 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+  "extends": "./tsconfig.lib.json",
+  "compilerOptions": {
+    "declarationMap": false
+  },
+  "angularCompilerOptions": {
+    "compilationMode": "partial"
+  }
+}