@pilotdev/pilot-web-sdk 26.9.0 → 26.10.0

package/src/lib/personal-settings/system-settings-keys.ts

@@ -0,0 +1,101 @@
+export class SystemSettingsKeys {
+  /**
+   * Get's favorites feature key
+   */
+  public static readonly favoritesFeatureKey = "Favorites-880e609e-54f9-4463-9c5e-f2b742a944dc";
+
+  /**
+   * Get's pilot storage drive letter feature key
+   */
+  public static readonly pilotStorageDriveLetter = "PilotStorageDriveLetter-880e609e-54f9-4463-9c5e-f2b742a944dc";
+
+  /**
+   * Get's agreement roles feature key
+   */
+  public static readonly agreementRolesFeatureKey = "AgreementRoles-0a782ccd-adb3-484f-8fb2-a6c58fc5a61d";
+
+  /**
+   * Get's tasks filters feature key
+   */
+  public static readonly tasksFiltersFeatureKey = "TasksFilters-deab09c1-2276-457b-a59b-5682baec43c7";
+
+  /**
+   * Get's tasks groupings feature key
+   */
+  public static readonly tasksGroupingsFeatureKey = "TasksGroupings-B66B65E3-8B6D-4468-BF07-869B03E7D62B";
+
+  /**
+   * Get's annotation filter feature key
+   */
+  public static readonly annotationFilterFeatureKey = "AnnotationFilter-F151E782-6CEB-44AF-ADF1-AFB0A0FAB95E";
+
+  /**
+   * Get's annotation filter feature key
+   */
+  public static readonly personalAnnotationFilterFeatureKey = "PersonalAnnotationFilter-9382f499-c1b9-433f-95bb-d83195d52121";
+
+  /**
+   * Get's mounted on Pilot-Storage items feature key
+   */
+  public static readonly mountedItemsList = "MountedItems-29eff31a-8bd2-40a2-bdac-c020db132c8b";
+
+  /**
+   * Get's Pilot-Storage work folders feature key
+   */
+  public static readonly workfoldersList = "Workfolders-C4A424C8-AE20-4277-9CA5-94629CEB1B86";
+
+  /**
+   * Get's selection path of the DocumentsExplorer
+   */
+  public static readonly tabsState = "TabsState-9b9e6a36-013a-423c-9599-c6edc32a5b4f";
+
+  /**
+   * Get's auto blocking file extensions feature key
+   */
+  public static readonly autoBlockingFileExtensionsFeatureKey = "AutoBlockingFileExtensions-1bb027f4-7dd0-4aec-8c0d-cffe63bfcbb3";
+
+  /**
+   * Get's auto commiting file extensions feature key
+   */
+  public static readonly autoCommitingFileExtensionsFeatureKey = " AutoCommitingFileExtensions-2d0de5a1-f6c1-426e-b3e6-610dfb4b2666";
+
+  /**
+   * Get's auto updating files feature key
+   */
+  public static readonly autoUpdatingFilesFeatureKey = "AutoUpdatingFileExtensions-6FB5DE6C-96B2-4F84-8650-7A2EB102EAC5";
+
+  /**
+   * Get's auto publishing settings feature key
+   */
+  public static readonly autoPublishingExtensionsFeatureKey = "AutoPublishingExtensions-F6FF1869-DBC2-4253-A5AA-7B225D69E416";
+
+  /**
+   * Get's eml attributes dictionary feature key
+   */
+  public static readonly emlAttributesDictionaryKeyFeatureKey = "EmlAttributesDictionary-354AB75D-A421-4836-A343-16FEC3014A4F";
+
+  /**
+   * Get's documents autofill feature key
+   */
+  public static readonly docsAutoFillFeatureKey = "DocsAutoFillFeatureKey-d19b557b-2109-4221-8970-794372039186";
+
+  /**
+   * User-defined temp files regex masks
+   */
+  public static readonly tempFileMasksFeatureKey = "TempFileMasksFeatureKey-388BD8A4-E7C0-48DD-B235-8C05030CFCF3";
+
+  /**
+   * User-defined Export/Import settings
+   */
+  public static readonly exportImportFeatureKey = "ExportImportFeatureKey-4697EA6F-E018-4989-929D-992D1176CC3C";
+
+  /**
+   * User-defined digital signature title
+   */
+  public static readonly digitalSignatureTitleFeatureKey = "DigitalSignatureTitleFeatureKey-481EFA14-B116-434A-BAD6-F90DB883DEC9";
+
+  /**
+   * Enhanced signature service settings
+   */
+  public static readonly advancedSignatureFeatureKey = "AdvancedSignatureFeatureKey-D267127C-DCED-4DEC-B1A8-6E7A919E383D";
+}

package/src/lib/tabs/tab-item.builder.ts

@@ -0,0 +1,37 @@
+/**
+ * Enables to set parameters to the tab-group's item
+ */
+export abstract class ITabItemBuilder {
+  constructor() {
+    if (this.constructor == ITabItemBuilder) {
+      throw new Error("Abstract classes can't be instantiated.");
+    }
+  }
+
+  /**
+   * Item's title to be displayed
+   * @param title value
+   */
+  withTitle(title: string): ITabItemBuilder {
+    throw new Error("Method 'withTitle(title: string)' must be implemented.");
+  }
+
+  /**
+   * Item's icon
+   * @param name Icon name
+   * @param iconSvg Url of icon or base64 string
+   */
+  withIcon(name: string, iconSvg: string): ITabItemBuilder {
+    throw new Error("Method 'withIcon(name: string, iconSvg: string)' must be implemented.");
+  }
+
+  /**
+   * Item's view id
+   *
+   * Is matched with corresponding IOpenspaceView's `getViewId(): string`
+   * @param value - View Id
+   */
+  withViewId(value: string): ITabItemBuilder {
+    throw new Error("Method 'withViewId(value: string)' must be implemented.");
+  }
+}

package/src/lib/tabs/tabs.builder.ts

@@ -0,0 +1,45 @@
+import { ITabItemBuilder } from './tab-item.builder';
+
+/**
+ * Represents a builder for tab groups
+ */
+export abstract class ITabsBuilder {
+  constructor() {
+    if (this.constructor == ITabsBuilder) {
+      throw new Error("Abstract classes can't be instantiated.");
+    }
+  }
+
+  /**
+   * Gets the list of existing items of a tab group
+   * @returns Existing menu item names
+   */
+  get itemNames(): string[] {
+    throw new Error("Getter 'itemNames()' must be implemented.");
+  }
+
+  /**
+   * Gets count of tab group items
+   */
+  get count(): number {
+    throw new Error("Getter 'count()' must be implemented.");
+  }
+
+  /**
+   * Adds a new item to the associated tab group
+   * @param id Item's internal id
+   * @param index The index to put the new item at
+   */
+  addItem(id: string, index: number): ITabItemBuilder {
+    throw new Error("Method 'addItem(id: string, index: number)' must be implemented.");
+  }
+
+  /**
+   * Replaces the item for the tab group.
+   * If Item does not exist - creates it.
+   * @param id Item's internal id
+   */
+  replaceItem(id: string): ITabItemBuilder {
+    throw new Error("Method 'replaceItem(id: string)' must be implemented.");
+  }
+}

package/src/lib/tabs/tabs.ts

@@ -0,0 +1,17 @@
+import { BimElementPanelContext, BimRightPanelContext, ObjectsViewContext } from "../contexts";
+import { ITabsBuilder } from "./tabs.builder";
+
+/**
+ * Interface that allows to add new items to the tabs
+ * @exposedInterface
+ */
+export abstract class ITabs<TTabsContext extends BimElementPanelContext | BimRightPanelContext | ObjectsViewContext> {
+  /**
+   * The method is called just before the tabs are shown
+   * @param builder The tab group builder object of associated tab group
+   * @param context Context
+   */
+  build(builder: ITabsBuilder, context: TTabsContext): void {
+    throw new Error("Method 'build(builder: IMenuBuilder, context: TTabsContext)' must be implemented.");
+  }
+}

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

@@ -1,6 +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';
+export * from './toolbar.builder';

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

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

@@ -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,33 @@
+import { DocumentAnnotationsListContext, ObjectsViewContext } from "../contexts";
+import { IToolbarBuilder } from "./toolbar.builder";
+
+/**
+ * Interface that allows to add new items to the toolbar
+ * @exposedInterface
+ */
+export abstract class IToolbar<TToolbarContext extends ObjectsViewContext | DocumentAnnotationsListContext> {
+
+  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/lib/tools/attribute-permission.info.ts

@@ -0,0 +1,54 @@
+import { IDataObject } from "../data";
+import { objectToMap } from "./utils";
+
+export class AttributePermissionInfo {
+  private ATTRIBUTE_NAME_MARKER = '&';
+  
+  orgUnits: number[];
+  orgUnitAttributes: string[];
+
+  constructor(editableForPositionsSource: string[]) {
+    this.orgUnits = new Array<number>();
+    this.orgUnitAttributes = new Array<string>();
+
+    if (!editableForPositionsSource)
+      return;
+
+    editableForPositionsSource.forEach(str => {
+      if (str.length > 0 && str[0] === this.ATTRIBUTE_NAME_MARKER) {
+        this.orgUnitAttributes.push(str.substring(1));
+      }
+      else {
+        const num = Number(str);
+        if (!isNaN(num)) 
+          this.orgUnits.push(num);
+      }
+    });
+  }
+
+  extractAllOrgUnits(obj: IDataObject): number[] {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const attrMap = objectToMap<any>(obj.attributes);
+    return this.extractAllOrgUnitsByAttributes(attrMap);
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  extractAllOrgUnitsByAttributes(attributes: Map<string, any>) : number[] {
+    const result = new Array<number>();
+    if (!this.orgUnitAttributes || !attributes  )
+      return result;
+
+    this.orgUnitAttributes.forEach(permissionAttributeName => {
+      if (attributes.has(permissionAttributeName)){
+        const value = attributes.get(permissionAttributeName);
+        if (value && Array.isArray(value)){
+          value.forEach(intValue => {
+            result.push(intValue);
+          });
+        }
+      }
+    });
+
+    return result;
+  }
+}

package/src/lib/tools/guid.ts

@@ -0,0 +1,63 @@
+const byteToHex = Array();
+for (let i = 0; i < 256; ++i) {
+  byteToHex.push((i + 0x100).toString(16).slice(1));
+}
+
+export class Guid {
+  private static readonly regex = "(?:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})";
+
+  static readonly EMPTY = "00000000-0000-0000-0000-000000000000";
+
+  static newGuid(): string {
+
+    if (window.isSecureContext) {
+      // If crypto.getRandomValues is available try to use it.
+      return window.crypto.randomUUID();
+    }
+
+    // Fall back to Math.random if a higher quality random number generator is not available.
+    const uuid = new Array(16);
+    var d = new Date().getTime();
+    for (var i = 0; i < 16; i++) {
+      var r = ((d + Math.random() * 256) % 256) | 0;
+      d = Math.trunc(d / 256);
+      uuid[i] = r;
+    }
+   
+    // Makes uuid compliant to RFC-4122
+    uuid[6] = (uuid[6] & 0x0F) | 0x40; // uuid version
+    uuid[8] = (uuid[8] & 0x3F) | 0x80; // uuid variant
+    
+    return this.stringify(uuid);
+  }
+
+  static isGuid(str: string) {
+    const regex = new RegExp(this.regex);
+    return regex.test(str) && str.length === 36;
+  }
+
+  private static stringify(arr: Array<number>) {
+    return (
+      byteToHex[arr[0]] +
+      byteToHex[arr[1]] +
+      byteToHex[arr[2]] +
+      byteToHex[arr[3]] +
+      '-' +
+      byteToHex[arr[4]] +
+      byteToHex[arr[5]] +
+      '-' +
+      byteToHex[arr[6]] +
+      byteToHex[arr[7]] +
+      '-' +
+      byteToHex[arr[8]] +
+      byteToHex[arr[9]] +
+      '-' +
+      byteToHex[arr[10]] +
+      byteToHex[arr[11]] +
+      byteToHex[arr[12]] +
+      byteToHex[arr[13]] +
+      byteToHex[arr[14]] +
+      byteToHex[arr[15]]
+    ).toLowerCase();
+  }
+}

package/src/lib/tools/index.ts

@@ -0,0 +1,3 @@
+export * from './attribute-permission.info';
+export * from './utils'
+export * from './guid'

package/src/lib/tools/utils.ts

@@ -0,0 +1,8 @@
+
+export function objectToMap<T>(objectMap: { [key: string]: any; }): Map<string, T> {
+  const map = new Map<string, T>();
+  Object.keys(objectMap).forEach(key => {
+    map.set(key, objectMap[key]);
+  });
+  return map;
+}

package/{public-api.d.ts → src/public-api.ts}

@@ -1,3 +1,6 @@
+/*
+ * Public API Surface of pilot-web-sdk
+ */
 export * from './lib/base/index';
 export * from './lib/idata.plugin';
 export * from './lib/icrypto-provider';