@pilotdev/pilot-web-sdk 26.8.0 → 26.10.0

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

@@ -0,0 +1,28 @@
+import { IDataObject } from "../data";
+
+/**
+ * Context for document 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/contexts/settings-feature-context.ts

@@ -0,0 +1,26 @@
+import { BehaviorSubject, Observable } from 'rxjs';
+import { ISettingValueProvider } from '../personal-settings';
+
+export class SettingsFeatureContext {
+  private _isValidSubject: BehaviorSubject<boolean> = new BehaviorSubject<boolean>(true);
+
+  constructor(
+    private readonly _valueProvider: ISettingValueProvider,
+  ) {}
+
+  get valueProvider(): ISettingValueProvider {
+    return this._valueProvider;
+  }
+
+  set isValid(state: boolean) {
+    this._isValidSubject.next(state);
+  }
+
+  get isValid(): boolean {
+    return this._isValidSubject.value;
+  }
+
+  get isValidSubscription(): Observable<boolean> {
+    return this._isValidSubject.asObservable();
+  }
+}

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,160 @@
+import { IDataObject } from "./data-object";
+import { IUserState } from "./user-state";
+
+export interface IAnnotationContainerObject {
+  get container(): IAnnotationContainer;
+  get source(): IDataObject;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  get attributes(): any;
+  get markups(): IMarkup[];
+  get statesInfo(): IAnnotationStatesInfo;
+}
+
+export interface IAnnotationContainer {
+  get annotationId(): string;
+  get version(): string;
+  get positionX(): number;
+  get positionY(): number;
+  get pageNumber(): number;
+  get data(): string;
+  get kind(): string;
+}
+
+export interface IMarkup {
+  get annotationId(): string;
+  get id(): number;
+  get page(): number;
+  get style(): IMarkupStyle | undefined;
+  get subtype(): MarkupSubtype;
+}
+
+export interface IMarkupStyle {
+  get colorRgb(): number | undefined;
+  get strokeWidth(): number | undefined;
+  get backgroundColorRgb(): number | undefined;
+  get lineStyle(): MarkupLineStyle | undefined;
+}
+
+export enum MarkupLineStyle {
+  Solid = 0,
+  Dashed = 1,
+  Beveled = 2,
+  Inset = 3,
+  Underline = 4
+}
+
+export enum BorderEffect {
+  None = 0,
+  Cloud = 1
+}
+
+export interface IAnnotationStatesInfo {
+  get states(): Map<string, IUserState>;
+  get availableTransitions(): IStateTransitionCommandArg[];
+  get metadataVersion(): number;
+}
+
+export interface IStateTransitionCommandArg {
+  get stateTo(): IUserState;
+  get transitionTitle(): string;
+  get attrName(): string;
+}
+
+export interface IEllipseMarkup extends IMarkup {
+  get center(): MarkupPoint;
+  get radiusX(): number;
+  get radiusY(): number;
+}
+
+export interface IRectangleMarkup extends IMarkup {
+  get bounds(): MarkupRect;
+}
+
+export interface ILineMarkup extends IMarkup {
+  get start(): MarkupPoint;
+  get end(): MarkupPoint;
+  get startEnding(): MarkupLineEndings;
+  get endEnding(): MarkupLineEndings;
+}
+
+export interface IPolylineMarkup extends IMarkup {
+  get points(): MarkupPoint[];
+  get borderEffect(): BorderEffect;
+}
+
+export interface IPolygonMarkup extends IMarkup {
+  get points(): MarkupPoint[];
+  get borderEffect(): BorderEffect;
+}
+
+export interface IInkMarkup extends IMarkup {
+  get points(): MarkupPoint[];
+}
+
+export interface IFreeTextMarkup extends IMarkup {
+  get bounds(): MarkupRect;
+  get text(): string;
+}
+
+export interface ITextDecorationMarkup extends IMarkup {
+  get quadPoints(): MarkupPoint[];
+  get kind(): MarkupTextDecorationKind;
+}
+
+export interface ITextMarkup extends IMarkup {
+  get bounds(): MarkupRect;
+}
+
+export enum MarkupTextDecorationKind {
+  Highlight = 0,
+  Underline = 1,
+  Squiggly = 2,
+  StrikeOut = 3
+}
+
+export type MarkupPoint = {
+  x: number;
+  y: number;
+}
+
+export type MarkupRect = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+export enum MarkupLineEndings {
+  None = 0,
+  Square = 1,
+  Circle = 2,
+  Diamond = 3,
+  OpenArrow = 4,
+  ClosedArrow = 5,
+  // Butt = 6,
+  // ReverseOpenArrow = 7,
+  // ReverseClosedArrow = 8,
+  // Slash = 9
+}
+
+export type MarkupSubtype =
+  | 'Link'
+  | 'Text'
+  | 'Widget'
+  | 'Popup'
+  | 'FreeText'
+  | 'Line'
+  | 'Arrow'
+  | 'Square'
+  | 'Circle'
+  | 'PolyLine'
+  | 'Polygon'
+  | 'Cloud'
+  | 'Caret'
+  | 'Ink'
+  | 'Highlight'
+  | 'Underline'
+  | 'Squiggly'
+  | 'StrikeOut'
+  | 'Stamp'
+  | 'FileAttachment';

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,
+  Inherited = 10,
+  Boolean = 11,
+  ByteArray = 12,
+}

package/src/lib/data/bim-features/bim-compare-diff.ts

@@ -0,0 +1,16 @@
+export enum CompareResultType {
+  Added = "added",
+  Modified = "modified",
+  AttributesModified = "attributesModified",
+  Deleted = "deleted",
+  Unchanged = "unchanged"
+}
+
+export interface IDisplayParam {
+  visible: boolean;
+  highlight: boolean;
+  r: number;
+  g: number;
+  b: number;
+  a: number;
+}

package/src/lib/data/bim-features/bim-search-set.ts

@@ -0,0 +1,16 @@
+import { IDataObject } from "../data-object";
+
+export interface IBimSearchSetData {
+  get id(): string;
+  get title(): string;
+  get query(): string;
+
+  get source(): IDataObject;
+  get isFolder(): boolean;
+  get isDeleted(): boolean;
+}
+
+export interface IBimModelSearchResult {
+  get globalIdReadable(): string;
+  get modelPartId(): string;
+}

package/src/lib/data/cades-type.ts

@@ -0,0 +1,11 @@
+export enum CadesType {
+  Unknown = 0,
+  NotCades = 1,
+  CadesBes = 2,
+  CadesEpes = 3,
+  CadesT = 4,
+  CadesC = 5,
+  CadesXLongType1 = 6,
+  CadesXLongType2 = 7,
+  CadesA = 8
+}

package/src/lib/data/certificate.ts

@@ -0,0 +1,34 @@
+/**
+ * Represents a certificate with validity dates, issuer, and subject information.
+ */
+export interface ICertificate {
+  /**
+   * the thumbprint of the certificate.
+   */
+  get thumbprint(): string;
+
+  /**
+   * Validity end date of the certificate.
+   */
+  get validToDate(): string;
+
+  /**
+   * Validity start date of the certificate.
+   */
+  get validFromDate(): string;
+
+  /**
+   * Issuer of the certificate.
+   */
+  get issuer(): string;
+
+  /**
+   * Subject of the certificate.
+   */
+  get subject(): string;
+
+  /**
+   * The signature algorithm used in the certificate.
+   */
+  get publicKeyOid(): string;
+}

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

@@ -0,0 +1,83 @@
+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 modifiedBy(): IPerson;
+  get created(): string;
+  get modifiedDate(): string;
+  get actualFileSnapshot(): IFileSnapshot;
+  get previousFileSnapshots(): IFileSnapshot[];
+  get context(): string[];
+  get relations(): IRelation[];
+  get access(): IAccessRecord[];
+  get accessLevel(): AccessLevel;
+  get allowedSubtypes(): number[];
+  get stateInfo(): IStateInfo;
+  get secretInfo(): ISecretInfo;
+  get historyItems(): string[];
+  get subscribers(): number[];
+}
+
+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/expected-error.ts

@@ -0,0 +1,10 @@
+export class ExpectedError extends Error {
+  isExpected: boolean = true;
+
+  constructor(
+    message: string,
+    public isSilent: boolean = false
+  ) {
+    super(message);
+  }
+}

package/src/lib/data/file.ts

@@ -0,0 +1,33 @@
+import { CadesType } from "./cades-type";
+
+export interface IFile {
+  get body(): IFileBody;
+  get name(): string;
+  get creatorId(): number;
+  get signatureRequests(): ISignatureRequest[];
+}
+
+export interface IFileBody {
+  get id(): string;
+  get size(): number;
+  get md5Hex(): string;
+  get modified(): string;
+  get created(): string;
+  get accessed(): string;
+}
+
+export interface ISignatureRequest {
+  get id(): string;
+  /**
+   * @deprecated
+   */
+  readonly databaseId?: string | undefined;
+  get positionId(): number;
+  get role(): string | undefined;
+  get signs(): string[] | undefined;
+  get requestedSigner(): string | undefined;
+  get objectId(): string | undefined;
+  get publicKeyOid(): string | undefined;
+  get lastSignCadesType(): CadesType;
+  get isAdvancementRequired(): boolean;
+}

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/organisation-unit.ts

@@ -0,0 +1,22 @@
+
+export interface IOrganisationUnit {
+  get id(): number;
+  get title(): string;
+  get kind(): OrgUnitKind;
+  get children(): number[];
+  get parentId(): number;
+  get isDeleted(): boolean;
+  get isBoss(): boolean;
+  get version(): number;
+  get person(): number;
+  get vicePersons(): number[];
+  get isCanceled(): boolean;
+  get groupPersons(): number[];
+  get permanentVicePersons(): 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,9 @@
+import { RelationType } from "./data-object";
+
+export interface IRelation {
+  get id(): string;
+  get targetId(): string;
+  get type(): RelationType;
+  get name(): string;
+  get versionId(): string;
+}

package/{lib/data/signature-custom-state.d.ts → src/lib/data/signature-custom-state.ts}

@@ -16,8 +16,8 @@
  * };
  */
 export interface ISignatureCustomState {
-    icon: string;
-    iconName: string;
-    title: string;
-    description: string;
+  icon: string;
+  iconName: string;
+  title: string;
+  description: string;
 }

package/{lib/data/signature-verification-result.d.ts → src/lib/data/signature-verification-result.ts}

@@ -1,18 +1,22 @@
 import { SignatureVerificationStatus } from "./signature-verification-status";
 import { ISignatureCustomState } from "./signature-custom-state";
 import { CadesType } from "./cades-type";
+
+
 export interface ISignatureVerificationResultBase {
-    verificationStatus: SignatureVerificationStatus;
-    error?: string;
-    signerName?: string;
+  verificationStatus: SignatureVerificationStatus;
+  error?: string;
+  signerName?: string;
 }
+
 export interface ISignatureVerificationResult extends ISignatureVerificationResultBase {
-    issuerName?: string;
-    signDate?: string;
-    customState?: ISignatureCustomState;
-    signerNameForeground?: string;
+  issuerName?: string;
+  signDate?: string;
+  customState?: ISignatureCustomState;
+  signerNameForeground?: string;
 }
+
 export interface IImportedSignatureVerificationResult extends ISignatureVerificationResultBase {
-    publicKeyOid: string;
-    cadesType: CadesType;
+  publicKeyOid: string;
+  cadesType: CadesType;
 }

package/src/lib/data/signature-verification-status.ts

@@ -0,0 +1,10 @@
+export enum SignatureVerificationStatus
+{
+  Unknown,
+  Valid,
+  ValidWithWarnings,
+  CannotBeChecked,
+  Duplicate,
+  Invalid,
+  Error,
+}

package/src/lib/data/subscription-type.ts

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

package/src/lib/data/theme.ts

@@ -0,0 +1,9 @@
+export enum Theme {
+  Light,
+  Dark
+}
+
+export interface Themes {
+  get theme(): Theme;
+}
+

package/src/lib/data/user-state-machine.ts

@@ -0,0 +1,11 @@
+export interface IUserStateMachine {
+  get id(): string;
+  get title(): string;
+  get stateTransitions(): Map<string, ITransition[]>;
+}
+
+export interface ITransition {
+  get stateTo(): string;
+  get displayName(): string;
+  get availableForPositionsSource(): string[];
+}

package/src/lib/data/user-state.ts

@@ -0,0 +1,21 @@
+export interface IUserState {
+  get id(): string;
+  get name(): string;
+  get title(): string;
+  get icon(): string;
+  get color(): UserStateColors;
+  get isDeleted(): boolean;
+  get isCompletionState(): boolean;
+  get isSystemState(): boolean;
+}
+
+export enum UserStateColors {
+  None = 0,
+  Color1 = 1,
+  Color2 = 2,
+  Color3 = 3,
+  Color4 = 4,
+  Color5 = 5,
+  Color6 = 6,
+  Color7 = 7
+}