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

package/.eslintrc.json

@@ -0,0 +1,31 @@
+{
+  "extends": "../../.eslintrc.json",
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts"],
+      "rules": {
+        "@angular-eslint/directive-selector": [
+          "error",
+          {
+            "type": "attribute",
+            "prefix": "lib",
+            "style": "camelCase"
+          }
+        ],
+        "@angular-eslint/component-selector": [
+          "error",
+          {
+            "type": "element",
+            "prefix": "lib",
+            "style": "kebab-case"
+          }
+        ]
+      }
+    },
+    {
+      "files": ["*.html"],
+      "rules": {}
+    }
+  ]
+}

package/README.md

@@ -1,5 +1,24 @@
-# 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.
+# PilotWebSdk
+
+This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 15.1.0.
+
+## Code scaffolding
+
+Run `ng generate component component-name --project pilot-web-sdk` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project pilot-web-sdk`.
+> Note: Don't forget to add `--project pilot-web-sdk` or else it will be added to the default project in your `angular.json` file. 
+
+## Build
+
+Run `ng build pilot-web-sdk` to build the project. The build artifacts will be stored in the `dist/` directory.
+
+## Publishing
+
+After building your library with `ng build pilot-web-sdk`, go to the dist folder `cd dist/pilot-web-sdk` and run `npm publish`.
+
+## Running unit tests
+
+Run `ng test pilot-web-sdk` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+## Further help
+
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.

package/ng-package.json

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

package/package.json

@@ -1,13 +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
-}
+{
+  "name": "@pilotdev/pilot-web-sdk",
+  "version": "24.4.0",
+  "peerDependencies": {
+    "@angular/common": "^15.1.4",
+    "@angular/core": "^15.1.4",
+    "rxjs": "7.8.1"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false
+}

package/src/lib/contexts/context.ts

@@ -0,0 +1,38 @@
+import { IDataObject } from "../data";
+
+
+/**
+ * Contex for objects view
+ */
+export class ObjectsViewContext {
+  private readonly _selectedObjects: IDataObject[];
+  private readonly _shortcuts: IDataObject[]; 
+  private readonly _context: IDataObject;
+  
+  constructor(selectedObjects: IDataObject[], context: IDataObject, shortcuts?: IDataObject[]) {
+    this._selectedObjects = selectedObjects;
+    this._context = context;
+    this._shortcuts = shortcuts ?? [];
+  }
+
+  /**
+   * 
+   */
+  public get selectedObjects(): IDataObject[] {
+    return this._selectedObjects;
+  }
+
+  /**
+   * 
+   */
+  public get contextObject(): IDataObject {
+    return this._context;
+  }
+
+  /**
+   * 
+   */
+  public get shortcuts(): IDataObject[] {
+    return this._shortcuts;
+  }
+}

package/src/lib/contexts/document-annotations-list-context.ts

@@ -0,0 +1,21 @@
+import { IAnnotationContainerObject } from "../data";
+
+
+/**
+ * Context for document annotations list
+ */
+export class DocumentAnnotationsListContext {
+  private readonly _selectedAnnotations: IAnnotationContainerObject[]; 
+  
+  constructor(selectedAnnotations: IAnnotationContainerObject[]) {
+    this._selectedAnnotations = selectedAnnotations;
+  }
+
+  /**
+   * 
+   */
+  public get selectedAnnotations(): IAnnotationContainerObject[] {
+    return this._selectedAnnotations;
+  }
+
+}

package/src/lib/contexts/index.ts

@@ -0,0 +1,3 @@
+export * from './context';
+export * from './document-annotations-list-context';
+export * from './render-context';

package/src/lib/contexts/render-context.ts

@@ -0,0 +1,28 @@
+import { IDataObject } from "../data";
+
+/**
+ * Context for xps render
+ */
+export class RenderContext {
+  private readonly _dataObject: IDataObject;
+  private readonly _selectedVersion: string;
+  
+  constructor(dataObject: IDataObject, selectedVersion: string) {
+    this._dataObject = dataObject;
+    this._selectedVersion = selectedVersion;
+  }
+
+   /**
+    * Target object
+    */
+  public get dataObject(): IDataObject {
+    return this._dataObject;
+  }
+
+   /**
+    * Selected version time
+    */
+  public get selectedVersion(): string {
+    return this._selectedVersion;
+  }
+}

package/src/lib/data/access.ts

@@ -0,0 +1,40 @@
+export enum AccessLevel {
+  None = 0,
+  Create = 1 << 0,
+  Edit = 1 << 1,
+  View = 1 << 2,
+  Freeze = 1 << 3,
+  Agreement = 1 << 4,
+  Share = 1 << 5,
+
+  ViewCreate = View | Create,
+  ViewEdit = View | Create | Edit,
+  ViewEditAgrement = ViewEdit | Agreement,
+  Full = View | Create | Edit | Freeze | Agreement | Share
+}
+
+export enum AccessType {
+  Allow,
+  Deny
+}
+
+export enum AccessInheritance {
+  None,
+  InheritUntilSecret,
+  InheritWholeSubtree
+}
+
+export interface IAccessRecord {
+  get orgUnitId(): number;
+  get access(): IAccess;
+  get recordOwnerPosition(): number;
+  get inheritanceSource(): string;
+}
+
+export interface IAccess {
+  get type(): AccessType;
+  get accessLevel(): AccessLevel;
+  get validThrough(): string;
+  get inheritance(): AccessInheritance;
+  get typeIds(): number[];
+}

package/src/lib/data/annotations.ts

@@ -0,0 +1,20 @@
+import { IDataObject } from "./data-object";
+
+
+export interface IAnnotationContainerObject {
+  get container(): IAnnotationContainer;
+  get source(): IDataObject;
+  get attributes(): any;
+}
+
+
+export interface IAnnotationContainer {
+  get annotationId(): string;
+  get version(): string;
+  get positionX(): number;
+  get positionY(): number;
+  get pageNumber(): number;
+  get data(): string;
+  get kind(): string;
+}
+

package/src/lib/data/attribute.ts

@@ -0,0 +1,33 @@
+
+export interface IAttribute {
+  get name(): string;
+  get title(): string;
+  get obligatory(): boolean;
+  get type(): AttributeType;
+  get displayHeight(): number;
+  get showInTree(): boolean;
+  get displaySortOrder(): number;
+  get isService(): boolean;
+  get configuration(): string;
+  get joinWithPrevious(): boolean;
+  get isUnique(): boolean;
+  get groupTitle(): string;
+  get editableForPositionsSource(): string[];
+}
+
+
+export enum AttributeType {
+  Integer = 0,
+  Double = 1,
+  DateTime = 2,
+  String = 3,
+  Decimal = 4,
+  Numerator = 5,
+  Array = 6,
+  UserState = 7,
+  OrgUnit = 8,
+  ElementBook = 9,
+  Guid = 10,
+  IntegerArray = 11,
+  Unknown = 99
+}

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

@@ -0,0 +1,78 @@
+import { AccessLevel, IAccessRecord } from "./access";
+import { IAttribute } from "./attribute";
+import { IFileSnapshot } from "./files-snapshot";
+import { IPerson } from "./person";
+import { IRelation } from "./relation";
+
+
+export enum RelationType {
+  SourceFiles = 1,
+  TaskInitiatorAttachments = 2,
+  TaskExecutorAttachments = 3,
+  MessageAttachments = 4,
+  Custom = 5,
+  TaskAttachments = 6,
+}
+
+export enum ObjectState {
+  Alive,
+  InRecycleBin,
+  DeletedPermanently,
+  Frozen,
+  LockRequested,
+  LockAccepted
+}
+
+export interface IDataObject {
+  get id(): string;
+  get parentId(): string;
+  get title(): string;
+  get type(): IType;
+  get attributes(): { [key: string]: any; };
+  get children(): IChild[];
+  get creator(): IPerson;
+  get created(): string;
+  get actualFileSnapshot(): IFileSnapshot;
+  get previousFileSnapshots(): IFileSnapshot[];
+  get context(): string[];
+  get relations(): IRelation[];
+  get access(): IAccessRecord[];
+  get accessLevels(): { [key: number]: AccessLevel; };
+  get stateInfo(): IStateInfo;
+  get secretInfo(): ISecretInfo;
+}
+
+export interface IType {
+  get id(): number;
+  get title(): string;
+  get name(): string;
+  get icon(): string;
+  get sort(): number;
+  get hasFiles(): boolean;
+  get children(): number[];
+  get attributes(): IAttribute[];
+  get isDeleted(): boolean;
+  get kind(): number;
+  get isMountable(): boolean;
+  get isService(): boolean;
+  get isProject(): boolean;
+  get configuration(): string;
+}
+
+export interface IChild {
+  get objectId(): string;
+  get typeId(): number;
+}
+
+export interface ISecretInfo {
+  get isSecret(): boolean;
+  get secretParentId(): string;
+  get secretChangedBy(): number;
+}
+
+export interface IStateInfo {
+  get state(): ObjectState;
+  get date(): string;
+  get personId(): number;
+  get positionId(): number;
+}

package/src/lib/data/file.ts

@@ -0,0 +1,25 @@
+export interface IFile {
+  get body(): IFileBody;
+  get name(): string;
+  get signatures(): ISignature[];
+}
+
+export interface IFileBody {
+  get id(): string;
+  get size(): number;
+  get md5(): any;
+  get modified(): string;
+  get created(): string;
+  get accessed(): string;
+}
+
+export interface ISignature {
+  get id(): string;
+  get databaseId(): string;
+  get positionId(): number;
+  get role(): string;
+  get sign(): string;
+  get requestedSigner(): string;
+  get isAdditional(): boolean;
+  get objectId(): string;
+}

package/src/lib/data/files-snapshot.ts

@@ -0,0 +1,9 @@
+import { IFile } from "./file";
+
+export interface IFileSnapshot {
+  get created(): string;
+  get creatorId(): number;
+  get reason(): string;
+  get files(): IFile[];
+  get hasAnnotations(): boolean;
+}

package/src/lib/data/index.ts

@@ -0,0 +1,12 @@
+export * from './access';
+export * from './annotations';
+export * from './attribute';
+export * from './data-object';
+export * from './file';
+export * from './files-snapshot';
+export * from './person';
+export * from './relation';
+export * from './object-builder';
+export * from './modifier';
+export * from './organisation-unit'
+export * from './subscriptionType'

package/src/lib/data/modifier.ts

@@ -0,0 +1,31 @@
+import { Observable } from "rxjs/internal/Observable";
+import { IDataObject } from ".";
+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/data/object-builder.ts

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

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

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

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

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

package/src/lib/idata.plugin.ts

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

package/src/lib/injectable/index.ts

@@ -1 +1,4 @@
-export * from './objects.repository';
+export * from './objects-repository';
+export * from './render-context-provider';
+export * from './modifier-provider'
+export * from './repository-events'

package/src/lib/injectable/modifier-provider.ts

@@ -0,0 +1,11 @@
+import { IModifier } from "../data/modifier";
+
+/**
+ * Provides modifier
+ */
+export interface IModifierProvider {
+  /**
+   * 
+   */
+  newModifier(): IModifier;
+}