avvir 6.0.4 → 7.1.0

package/source/models/api/api_user_permission.ts

@@ -1,17 +1,17 @@
-import {UserPermissionType} from "../enums/user_permission_type";
-import {UserPermissionAction} from "../enums/user_permission_action"
+import type UserPermissionAction from "../enums/user_permission_action";
+import type UserPermissionType from "../enums/user_permission_type";
 
 export class ApiUserPermission {
-  id: number
-  userId: number
-  projectFirebaseId: string
-  organizationFirebaseId: string
-  masterformatCode: string
-  permissionType: UserPermissionType
-  permissionAction: UserPermissionAction
-  organizationName: string
-  projectName: string
-  workPackageId: number
+  id: number;
+  userId: number;
+  projectFirebaseId: string;
+  organizationFirebaseId: string;
+  masterformatCode: string;
+  permissionType: UserPermissionType;
+  permissionAction: UserPermissionAction;
+  organizationName: string;
+  projectName: string;
+  workPackageId: number;
 
   constructor({
                 id,
@@ -24,7 +24,8 @@ export class ApiUserPermission {
                 organizationName,
                 projectName,
                 workPackageId
-  }: Partial<ApiUserPermission>) {
+              }: Partial<ApiUserPermission>)
+  {
     this.id = id;
     this.userId = userId;
     this.projectFirebaseId = projectFirebaseId;

package/source/models/api/api_view.ts

@@ -1,13 +1,16 @@
-import {Vector3} from "three";
-import {DateLike, ModifyPartial, Vector3Like} from "./type_aliases";
+import { Vector3 } from "three";
+
 import addDateGetterAndSetterToDomainModel from "../../mixins/add_date_getter_and_setter_to_domain_model";
-import {UniformatId} from "uniformat";
-import {ApiInspectionModes} from "../enums";
-import SystemOfMeasurement from "../enums/system_of_measurement";
+import addReadOnlyPropertiesToModel from "../../mixins/add_read_only_properties_to_model";
+
+import type SystemOfMeasurement from "../enums/system_of_measurement";
+import type { ApiInspectionModes } from "../enums";
+import type { DateLike, ModifyPartial, Vector3Like } from "./type_aliases";
+import type { UniformatId } from "uniformat";
 
 export class PhotoViewerDetails {
   constructor(photoViewerDetails: Partial<PhotoViewerDetails> = {}) {
-    const {photoSessionId, photoLocationId, photoSessionIds} = photoViewerDetails;
+    const { photoSessionId, photoLocationId, photoSessionIds } = photoViewerDetails;
     this.photoSessionId = photoSessionId;
     this.photoLocationId = photoLocationId;
     this.photoSessionIds = photoSessionIds || [];
@@ -20,29 +23,29 @@ export class PhotoViewerDetails {
 
 export class DeviationTolerance {
   constructor(tolerance: Partial<DeviationTolerance> = {}) {
-    const {value, systemOfMeasurement} = tolerance;
+    const { value, systemOfMeasurement } = tolerance;
     this.value = value;
     this.systemOfMeasurement = systemOfMeasurement;
   }
 
   value: number;
-  systemOfMeasurement: SystemOfMeasurement
+  systemOfMeasurement: SystemOfMeasurement;
 }
 
 export class ViewTrades {
   constructor(trades: Partial<ViewTrades> = {}) {
-    const {shownUniformatCodes} = trades;
+    const { shownUniformatCodes } = trades;
     this.shownUniformatCodes = shownUniformatCodes;
   }
 
   shownUniformatCodes: UniformatId[];
 }
 
-export type ViewCameraParameter = ModifyPartial<ViewCamera, { position: Vector3Like, target: Vector3Like }>
+export type ViewCameraArgument = ModifyPartial<ViewCamera, { position: Vector3Like, target: Vector3Like }>
 
 export class ViewCamera {
-  constructor(camera: ViewCameraParameter = {}) {
-    const {position, target} = camera;
+  constructor(camera: ViewCameraArgument = {}) {
+    const { position, target } = camera;
     this.position = new Vector3(position?.x, position?.y, position?.z);
     this.target = new Vector3(target?.x, target?.y, target?.z);
   }
@@ -51,9 +54,14 @@ export class ViewCamera {
   target: Vector3;
 }
 
+export type ViewFiltersArgument = ModifyPartial<ViewFilters, {
+  trades: Partial<ViewTrades>,
+  deviationTolerance: Partial<DeviationTolerance>
+}>
+
 export class ViewFilters {
-  constructor(filters: Partial<ViewFilters> = {}) {
-    const {trades, deviationTolerance, pointCloudVisible, sectionPointCloud} = filters;
+  constructor(filters: ViewFiltersArgument = {}) {
+    const { trades, deviationTolerance, pointCloudVisible, sectionPointCloud } = filters;
     this.trades = new ViewTrades(trades);
     this.deviationTolerance = new DeviationTolerance(deviationTolerance);
     this.pointCloudVisible = pointCloudVisible;
@@ -67,16 +75,20 @@ export class ViewFilters {
 }
 
 export type SelectedElements = string[]
-export type ViewAttributesParameter = ModifyPartial<ViewAttributes, { camera: ViewCameraParameter }>
+export type ViewAttributesArgument = ModifyPartial<ViewAttributes, {
+  camera: ViewCameraArgument
+  filters: ViewFiltersArgument
+  photoViewerDetails: Partial<PhotoViewerDetails>
+}>
 
 export class ViewAttributes {
-  constructor(attributes: ViewAttributesParameter = {}) {
-    const {camera, filters, selectedElements, inspectionMode, photoViewerDetails} = attributes;
+  constructor(attributes: ViewAttributesArgument = {}) {
+    const { camera, filters, selectedElements, inspectionMode, photoViewerDetails } = attributes;
     this.camera = new ViewCamera(camera);
     this.filters = new ViewFilters(filters);
-    this.selectedElements = selectedElements;
+    this.selectedElements = selectedElements || [];
     this.inspectionMode = inspectionMode;
-    this.photoViewerDetails = photoViewerDetails;
+    this.photoViewerDetails = new PhotoViewerDetails(photoViewerDetails);
   }
 
   camera: ViewCamera;
@@ -86,7 +98,10 @@ export class ViewAttributes {
   photoViewerDetails: PhotoViewerDetails;
 }
 
-export type ViewParameter = ModifyPartial<ApiView, { viewAttributes: ViewAttributesParameter, createdAt: DateLike }>
+export type ApiViewArgument = ModifyPartial<ApiView, {
+  viewAttributes: ViewAttributesArgument,
+  createdAt: DateLike
+}>
 
 export class ApiView {
   constructor({
@@ -98,23 +113,20 @@ export class ApiView {
                 createdBy,
                 createdAt,
                 commentThreadIds
-              }: ViewParameter) {
+              }: ApiViewArgument)
+  {
+    addReadOnlyPropertiesToModel(this, { id, firebaseProjectId, firebaseFloorId, firebaseScanDatasetId, createdBy });
     addDateGetterAndSetterToDomainModel(this, "createdAt", createdAt);
-    this.id = id;
-    this.firebaseProjectId = firebaseProjectId;
-    this.firebaseFloorId = firebaseFloorId;
-    this.firebaseScanDatasetId = firebaseScanDatasetId;
     this.viewAttributes = new ViewAttributes(viewAttributes);
-    this.createdBy = createdBy;
     this.commentThreadIds = commentThreadIds;
   }
 
-  id: number;
-  firebaseProjectId: string;
-  firebaseFloorId: string;
-  firebaseScanDatasetId: string;
+  readonly id: number;
+  readonly firebaseProjectId: string;
+  readonly firebaseFloorId: string;
+  readonly firebaseScanDatasetId: string;
   viewAttributes: ViewAttributes;
-  createdBy: string;
+  readonly createdBy: string;
   createdAt: Date;
   commentThreadIds: number[];
 }

package/source/models/api/api_work_package.ts

@@ -1,7 +1,8 @@
 import { addReadOnlyPropertiesToModel } from "../../mixins";
-import { ProjectWorkPackageType } from "../enums";
 
-export default class ApiWorkPackage {
+import type { ProjectWorkPackageType } from "../enums";
+
+export class ApiWorkPackage {
   constructor({ id, name, firebaseProjectId, type }: Partial<ApiWorkPackage> = {}) {
     addReadOnlyPropertiesToModel(this, { id, firebaseProjectId, type });
     this.name = name;
@@ -10,5 +11,7 @@ export default class ApiWorkPackage {
   readonly id: number;
   name: string;
   readonly firebaseProjectId: string;
-  readonly type: ProjectWorkPackageType
+  readonly type: ProjectWorkPackageType;
 }
+
+export default ApiWorkPackage;

package/source/models/api/deprecated_api_pipeline.ts

@@ -1,3 +1,6 @@
+/**
+ * @deprecated use {@link ApiPipeline} instead
+ */
 export class DeprecatedApiPipeline {
   workflowName: string;
   startTime: number;

package/source/models/api/index.ts

@@ -1,126 +1,68 @@
-export { ArgoMetadata, ApiArgoResponse } from "./api_argo_response";
+export * from "./api_action_payload";
+export { ApiArgoResponse, ArgoMetadata } from "./api_argo_response";
+export { ApiBcfBuildingElement, ApiBcfBuildingElementArgument } from "./api_bcf_building_element";
+export { ApiBcfIssue, ApiBcfIssueArgument } from "./api_bcf_issue";
+export { ApiClassificationCode } from "./api_classification_code";
+export * from "./api_cloud_file";
 export { ApiComment } from "./api_comment";
 export { ApiCommentThread } from "./api_comment_thread";
-export { AvvirApiFiles, AvvirApiFileIds, ApiCloudFileArgument, ApiCloudFile } from "./api_cloud_file";
-export { ApiConstructionGrid } from "./api_construction_grid";
+export * from "./api_construction_grid";
 export { ApiCreateInvitationForm } from "./api_create_invitation_form";
-export { ApiDetailedElement } from "./api_detailed_element";
-export { ApiElementDeviation } from "./api_element_deviation";
-export { ApiFloor, ApiFloorArgument } from "./api_floor";
-export { ApiGridLine } from "./api_grid_line";
-export { ApiInvitation } from "./api_invitation";
-export { ApiInspectReport } from "./api_inspect_report";
-export { ApiInspectReportEntry } from "./api_inspect_report_entry";
-export { ApiInspectReportEntryElement } from "./api_inspect_report_entry_element";
-export { ApiMasterformat } from "./api_masterformat";
-export { ApiMatrix3 } from "./api_matrix_3";
-export { ApiMatrix4 } from "./api_matrix_4";
-export { ApiOrganization } from "./api_organization";
-export { ApiPhotoArea } from "./api_photo_area";
-export { ApiPhotoLocation, ApiPhotoLocationArgs } from "./api_photo_location";
-export { ApiPhotoLocationProperties, ApiPhotoLocation3d, ApiPhotoLocation3dArguments } from "./api_photo_location_3d";
-export { ApiPhotoSessionArgs, ApiPhotoSession } from "./api_photo_session";
-export { ApiPipeline, ApiPipelineArgument } from "./api_pipeline";
-export { ApiPlannedElement } from "./api_planned_element";
-export { ApiProject, ApiProjectArgument } from "./api_project";
-export { ApiProjectReport } from "./api_project_report";
-export { ApiProjectSettings } from "./api_project_settings";
-export {
-  ApiProjectCostAnalysisProgressArgument, ApiProjectCostAnalysisProgress
-} from "./api_project_cost_analysis_progress";
-export { ApiProjectMasterformatProgress } from "./api_project_masterformat_progress";
-export { ApiProjectReportVersion } from "./api_project_report_version";
-export { ApiProjectAreaWorkPackage } from "./api_project_area_work_package";
-export { ApiProjectArea } from "./api_project_area";
-export { ApiProjectSummary, ApiProjectAreaProgress } from "./api_project_summary";
-export { ApiProjectWorkPackage } from "./api_project_work_package";
-export { ApiProjectListing } from "./api_project_listing";
-export { ApiClassificationCode } from "./api_classification_code";
-export { ApiRecipe, ApiRecipeStep, ApiRecipeArgument, ApiRecipeStepArgument } from "./api_recipe";
+export * from "./api_detailed_element";
+export * from "./api_element_deviation";
+export * from "./api_floor";
+export * from "./api_purpose_type";
+export * from "./api_grid_line";
+export { ApiGroup, ApiGroupMember } from "./api_groups";
+export * from "./api_inspect_report";
+export * from "./api_inspect_report_entry";
+export * from "./api_inspect_report_entry_element";
+export { ApiIntegrationCredentials, ApiIntegrationCredentialsArgument } from "./api_integration_credentials";
+export { ApiIntegrationProject, ApiIntegrationProjectArgument } from "./api_integration_project";
+export * from "./api_invitation";
+export * from "./api_masterformat";
+export { ApiMasterformatProgress, ApiMasterformatProgressArgument } from "./api_masterformat_progress";
+export * from "./api_matrix_3";
+export * from "./api_matrix_4";
+export * from "./api_organization";
+export * from "./api_photo_area";
+export { ApiPhotoLocation3d, ApiPhotoLocation3dArgument, ApiPhotoLocationProperties } from "./api_photo_location_3d";
+export * from "./api_photo_location";
+export * from "./api_photo_session";
+export * from "./api_pipeline";
+export * from "./api_planned_element";
+export * from "./api_progress_category";
+export * from "./api_progress_scan_dataset";
+export * from "./api_project";
+export * from "./api_project_area";
+export * from "./api_project_summary";
+export * from "./api_project_area_work_package";
+export { ApiProjectCostAnalysisProgress, ApiProjectCostAnalysisProgressArgument } from "./api_project_cost_analysis_progress";
 export { ApiProjectCostAnalysisProgressValidationResult } from "./api_project_cost_anaylsis_progress_validation_result";
-export { ApiProjectWorkPackageCost } from "./api_project_work_package_cost";
-export {
-  ApiPhotoAreaPurposeType,
-  ApiScanDatasetPurposeType,
-  ApiFloorPurposeType,
-  ApiPurposeType,
-  ApiProjectPurposeType,
-  ApiScanDatasetTypeKeys,
-  ApiPurposeTypeKeys,
-  ApiFloorTypeKeys,
-  ApiProjectTypeKeys,
-  ApiPhotoAreaTypeKeys,
-  ApiFloorTypeMap,
-  ApiPhotoAreaTypeMap,
-  ApiProjectTypeMap,
-  ApiScanDatasetTypeMap,
-  isApiPurposeType,
-  isApiFloorPurposeType,
-  isApiPhotoAreaPurposeType,
-  isApiScanDatasetPurposeType
-} from "./api_purpose_type";
-
-export { ApiRunningProcess, ApiRunningProcessArgs } from "./api_running_process";
-export { ApiScanDataset, ApiScanDatasetArgument, ApiScanDatasetQaState } from "./api_scan_dataset";
-
-export {
-  ApiScannedElement,
-  isDeviationScanResult,
-  ApiScannedElementTypeMap,
-  ApiScannedElementType,
-  DeviationScanResult,
-  InPlaceScanResult,
-  NotBuiltScanResult
-} from "./api_scanned_element";
-
-export { ApiUser } from "./api_user";
-export { DeprecatedApiPipeline } from "./deprecated_api_pipeline";
-export { ApiProgressCategory } from "./api_progress_category";
-export { ApiProgressScanDataset } from "./api_progress_scan_dataset";
-
-export {
-  PhotoViewerDetails,
-  ViewCamera,
-  ApiView,
-  ViewAttributes,
-  ViewParameter,
-  ViewCameraParameter,
-  ViewFilters,
-  ViewTrades,
-  DeviationTolerance,
-  ViewAttributesParameter,
-  SelectedElements
-} from "./api_view";
-
-export { ApiQueryResource } from "./api_query_resource";
-export { ApiUserAction } from "./api_user_action";
-export { ApiActionPayload, ApiBehavioralData } from "./api_action_payload";
-export { ApiIntegrationCredentials, ApiIntegrationCredentialsArgs } from "./api_integration_credentials";
-export { ApiIntegrationProject, ApiIntegrationProjectArgs } from "./api_integration_project";
-export { ApiTeamMember } from "./api_team_member";
-
-export {
-  AssociationIds,
-  DateLike,
-  Matrix3Like,
-  Matrix4Like,
-  FileLike,
-  Vector2Like,
-  Vector3Like,
-  Vector4Like,
-  Modify,
-  ModifyPartial,
-  DeepPartial
-} from "./type_aliases";
-
-export { ApiQuaternion, isApiQuaternion } from "./api_quaternion";
-export { ApiBcfIssue, ApiBcfIssueArgs } from "./api_bcf_issue";
-export { ApiBcfBuildingElementArgs, ApiBcfBuildingElement } from "./api_bcf_building_element";
-export { ApiUserPermission } from "./api_user_permission";
-export { ApiUserForOrganization } from "./api_user_for_organization";
-export { ApiRpcSession } from "./api_rpc_session";
+export { ApiProjectListing } from "./api_project_listing";
+export { ApiProjectMasterformatProgress } from "./api_project_masterformat_progress";
+export * from "./api_project_report";
+export * from "./api_project_report_version";
+export * from "./api_project_settings";
+export * from "./api_project_work_package";
+export * from "./api_project_work_package_cost";
+export * from "./api_quaternion";
+export * from "./api_query_resource";
+export * from "./api_recipe";
 export { ApiRpcQueryRequest } from "./api_rpc_query_request";
 export { ApiRpcQueryResponse } from "./api_rpc_query_response";
-export { ApiScanDatasetStats } from "./api_scandataset_stats";
-export { ApiGroup, ApiGroupMember } from "./api_groups";
-export { ApiMasterformatProgressArgs, ApiMasterformatProgress } from "./api_masterformat_progress";
+export { ApiRpcSession } from "./api_rpc_session";
+export * from "./api_running_process";
+export * from "./api_scan_dataset";
+export * from "./api_scandataset_stats";
+export * from "./api_scanned_element";
+export * from "./api_team_member";
+export * from "./api_user";
+export * from "./api_user_action";
+export * from "./api_user_for_organization";
+export * from "./api_user_permission";
+export * from "./api_view";
+export * from "./api_work_package";
+export * from "./type_aliases";
+export * from "./deprecated_api_pipeline";
+export * from "./trade";

package/source/models/api/trade/api_captured_trade_cost.ts

@@ -1,4 +1,4 @@
-export default class ApiCapturedTradeCost {
+export class ApiCapturedTradeCost {
   constructor({ tradeCode, capturedQuantity, modeledQuantity }: Partial<ApiCapturedTradeCost> = {}) {
     this.tradeCode = tradeCode;
     this.capturedQuantity = capturedQuantity;
@@ -9,3 +9,5 @@ export default class ApiCapturedTradeCost {
   capturedQuantity: number;
   modeledQuantity: number;
 }
+
+export default ApiCapturedTradeCost;

package/source/models/api/trade/api_planned_trade_cost.ts

@@ -1,4 +1,4 @@
-export default class ApiPlannedTradeCost {
+export class ApiPlannedTradeCost {
   constructor({
                 tradeCode,
                 unitOfMeasure,
@@ -19,3 +19,5 @@ export default class ApiPlannedTradeCost {
   plannedTotalCost: number;
   plannedQuantity: number;
 }
+
+export default ApiPlannedTradeCost;

package/source/models/api/trade/api_trade.ts

@@ -1,4 +1,4 @@
-export default class ApiTrade {
+export class ApiTrade {
   constructor({ code, parentCode, title, workPackageId, childCodes }: Partial<ApiTrade> = {}) {
     this.code = code;
     if (parentCode) {
@@ -15,3 +15,5 @@ export default class ApiTrade {
   workPackageId: number;
   childCodes: string[];
 }
+
+export default ApiTrade;

package/source/models/api/trade/api_trade_cost.ts

@@ -1,4 +1,4 @@
-export default class ApiTradeCost {
+export class ApiTradeCost {
   constructor({ tradeCode, unitOfMeasure, plannedUnitCost, plannedTotalCost, plannedQuantity, capturedQuantity, modeledQuantity, reportedQuantity }: Partial<ApiTradeCost> = {}) {
     this.tradeCode = tradeCode;
     this.unitOfMeasure = unitOfMeasure;
@@ -20,3 +20,5 @@ export default class ApiTradeCost {
   modeledQuantity: number;
   reportedQuantity: number;
 }
+
+export default ApiTradeCost;

package/source/models/api/trade/index.ts

@@ -0,0 +1,4 @@
+export { ApiCapturedTradeCost } from "./api_captured_trade_cost";
+export { ApiPlannedTradeCost } from "./api_planned_trade_cost";
+export { ApiTrade } from "./api_trade";
+export { ApiTradeCost } from "./api_trade_cost";

package/source/models/enums/api_floor_file_deletion_mode.ts

@@ -0,0 +1,9 @@
+export enum ApiFloorFileDeletionMode {
+  ALL_FILES = "ALL_FILES",
+  FLOOR_ONLY = "FLOOR_ONLY"
+}
+
+export const ALL_FILES = ApiFloorFileDeletionMode.ALL_FILES;
+export const FLOOR_ONLY = ApiFloorFileDeletionMode.FLOOR_ONLY;
+
+export default ApiFloorFileDeletionMode;

package/source/models/enums/index.ts

@@ -1,24 +1,25 @@
+export * from "./api_built_status";
+export * from "./api_floor_file_deletion_mode";
+export * from "./api_integration_credentials_type";
+export * from "./association_type";
 export * from "./deviation_status";
-export * from "./inspection_modes";
 export * from "./event_type";
+export * from "./inspection_modes";
 export * from "./notification_level";
 export * from "./photo_projection_type";
 export * from "./photo_rotation_type";
 export * from "./pipeline_types";
 export * from "./process_status";
+export * from "./progress_type";
+export * from "./project_work_package_type";
 export * from "./running_process_status";
-export * from "./api_built_status";
 export * from "./system_of_measurement";
 export * from "./uploader_status";
-export * from "./user_auth_type";
-export * from "./user_role";
 export * from "./user_action_type";
-export * from "./api_integration_credentials_type";
+export * from "./user_auth_type";
 export * from "./user_permission_action";
 export * from "./user_permission_type";
-export * from "./association_type";
-export * from "./project_work_package_type";
-export * from "./progress_type";
+export * from "./user_role";
 
 export {
   ProjectPurposeType,

package/dist/esm/models/api/ApiFloorFileDeletionMode.d.ts

@@ -1,4 +0,0 @@
-export declare enum ApiFloorFileDeletionMode {
-    ALL_FILES = "ALL_FILES",
-    FLOOR_ONLY = "FLOOR_ONLY"
-}

package/dist/esm/models/api/ApiFloorFileDeletionMode.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ApiFloorFileDeletionMode.js","sourceRoot":"","sources":["../../../../source/models/api/ApiFloorFileDeletionMode.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAChC,mDAAuB,CAAA;IACvB,qDAAyB,CAAA;AAC7B,CAAC,EAHW,wBAAwB,KAAxB,wBAAwB,QAGnC"}

package/source/models/api/ApiFloorFileDeletionMode.ts

@@ -1,4 +0,0 @@
-export enum ApiFloorFileDeletionMode {
-    ALL_FILES = "ALL_FILES",
-    FLOOR_ONLY = "FLOOR_ONLY"
-}