avvir 6.0.4 → 7.0.0

package/source/models/api/api_project_summary.ts

@@ -2,7 +2,7 @@ import ApiCloudFile, { ApiCloudFileArgument } from "./api_cloud_file";
 
 import type { ModifyPartial } from "type_aliases";
 
-export type ApiProjectSummaryArg = ModifyPartial<ApiProjectSummary, {
+export type ApiProjectSummaryArgument = ModifyPartial<ApiProjectSummary, {
   model: ApiCloudFileArgument
 }>
 
@@ -10,7 +10,7 @@ export class ApiProjectSummary {
   readonly model: ApiCloudFile;
   projectAreaIds: number[];
 
-  constructor({ model, projectAreaIds }: ApiProjectSummaryArg = {}) {
+  constructor({ model, projectAreaIds }: ApiProjectSummaryArgument = {}) {
     this.model = new ApiCloudFile(model);
     this.projectAreaIds = projectAreaIds || [];
   }

package/source/models/api/api_project_work_package.ts

@@ -1,17 +1,22 @@
-import { ProjectWorkPackageType } from "../enums";
+import type { ProjectWorkPackageType } from "../enums";
 
+/**
+ * @deprecated Use {@link ApiWorkPackage} instead.
+ */
 export class ApiProjectWorkPackage {
-    id?: number
-    name: string
-    ordinal: number
-    type?: ProjectWorkPackageType
-    masterformatCodes?: string[];
+  id?: number;
+  name: string;
+  ordinal: number;
+  type?: ProjectWorkPackageType;
+  masterformatCodes?: string[];
 
-    constructor({id, name, ordinal, type, masterformatCodes} : Partial<ApiProjectWorkPackage> = {}) {
-        this.id = id;
-        this.name = name;
-        this.ordinal = ordinal;
-        this.type = type;
-        this.masterformatCodes = masterformatCodes;
-    }
+  constructor({ id, name, ordinal, type, masterformatCodes }: Partial<ApiProjectWorkPackage> = {}) {
+    this.id = id;
+    this.name = name;
+    this.ordinal = ordinal;
+    this.type = type;
+    this.masterformatCodes = masterformatCodes;
+  }
 }
+
+export default ApiProjectWorkPackage;

package/source/models/api/api_project_work_package_cost.ts

@@ -1,18 +1,19 @@
 import addReadOnlyPropertiesToModel from "../../mixins/add_read_only_properties_to_model";
 
-export class ApiProjectWorkPackageCost{
-    constructor({id, name, captured, planned, modeled}) {
-        addReadOnlyPropertiesToModel(this, {id});
-        this.name = name;
-        this.captured = captured;
-        this.planned = planned;
-        this.modeled = modeled;
-    }
-    id: number;
-    name: string;
-    captured: number;
-    planned: number;
-    modeled: number;
+export class ApiProjectWorkPackageCost {
+  constructor({ id, name, captured, planned, modeled }: Partial<ApiProjectWorkPackageCost> = {}) {
+    addReadOnlyPropertiesToModel(this, { id });
+    this.name = name;
+    this.captured = captured;
+    this.planned = planned;
+    this.modeled = modeled;
+  }
+
+  readonly id: number;
+  name: string;
+  captured: number;
+  planned: number;
+  modeled: number;
 }
 
-export default ApiProjectWorkPackageCost;
+export default ApiProjectWorkPackageCost;

package/source/models/api/api_quaternion.ts

@@ -31,3 +31,5 @@ export function isApiQuaternion(type: any): type is ApiQuaternion {
     && Number.isFinite(type.c)
     && Number.isFinite(type.d);
 }
+
+export default ApiQuaternion;

package/source/models/api/api_query_resource.ts

@@ -2,3 +2,5 @@ export class ApiQueryResource {
   id: number;
   queriedIds: string[];
 }
+
+export default ApiQueryResource;

package/source/models/api/api_recipe.ts

@@ -1,55 +1,53 @@
-import { Modify } from "./type_aliases";
 import addReadOnlyPropertiesToModel from "../../mixins/add_read_only_properties_to_model";
 
-export interface ApiRecipeArgument extends Partial<Modify<ApiRecipe, {
-    name?: string | null
-    isEnabled?: boolean | null
-    modeledCode?: string | null
-    steps?: ApiRecipeStep[] | null
-}>> {
-}
+import type { ModifyPartial } from "type_aliases";
 
-export class ApiRecipe {
-    readonly id: number
-    readonly projectFirebaseId?: string
-    name: string
-    isEnabled: boolean
-    modeledCode?: string
-    steps?: ApiRecipeStep[]
+export type ApiRecipeArgument = ModifyPartial<ApiRecipe, {
+  steps?: Partial<ApiRecipeStep>[] | null
+}>
 
-    constructor({id, projectFirebaseId, name, isEnabled, modeledCode, steps}: ApiRecipeArgument) {
-        addReadOnlyPropertiesToModel(this, {id, projectFirebaseId});
-        this.name = name;
-        this.isEnabled = isEnabled || false;
-        this.modeledCode = modeledCode;
-        this.steps = steps || [];
-    }
-}
+export class ApiRecipe {
+  readonly id: number;
+  readonly firebaseProjectId?: string;
+  name: string;
+  isEnabled: boolean;
+  modeledCode?: string;
+  steps?: ApiRecipeStep[];
 
-export interface ApiRecipeStepArgument extends Partial<Modify<ApiRecipeStep, {
-    ordinal: number
-    name?: string | null
-    code?: string | null
-    partialProgressPercent?: number | null
-}>> {
+  constructor({ id, firebaseProjectId, name, isEnabled, modeledCode, steps }: ApiRecipeArgument) {
+    addReadOnlyPropertiesToModel(this, { id, firebaseProjectId });
+    this.name = name;
+    this.isEnabled = isEnabled || false;
+    this.modeledCode = modeledCode;
+    this.steps = steps?.map(step => new ApiRecipeStep(step)) || [];
+  }
 }
 
 export class ApiRecipeStep {
-    readonly id: number
-    readonly recipeId: number
-    readonly globalRecipeStepId: number
-    name: string
-    code: string
-    ordinal: number
-    partialProgressPercent: number
+  readonly id: number;
+  readonly recipeId: number;
+  readonly globalRecipeStepId: number;
+  name: string;
+  code: string;
+  ordinal: number;
+  partialProgressPercent: number;
 
-    constructor({ id, recipeId, globalRecipeStepId, ordinal, name, code, partialProgressPercent }: ApiRecipeStepArgument) {
-        addReadOnlyPropertiesToModel(this, { id, recipeId, globalRecipeStepId });
-        this.ordinal = ordinal;
-        this.name = name || null;
-        this.code = code || null;
-        this.partialProgressPercent = partialProgressPercent || 0.0;
-    }
+  constructor({
+                id,
+                recipeId,
+                globalRecipeStepId,
+                ordinal,
+                name,
+                code,
+                partialProgressPercent
+              }: Partial<ApiRecipeStep>)
+  {
+    addReadOnlyPropertiesToModel(this, { id, recipeId, globalRecipeStepId });
+    this.ordinal = ordinal;
+    this.name = name || null;
+    this.code = code || null;
+    this.partialProgressPercent = partialProgressPercent || 0.0;
+  }
 }
 
 export default ApiRecipe;

package/source/models/api/api_running_process.ts

@@ -1,20 +1,21 @@
-import ProcessStatus from "../enums/process_status";
-import {DateLike, ModifyPartial} from "./type_aliases";
 import addInstantGetterAndSetterToApiModel from "../../mixins/add_instant_getter_and_setter_to_api_model";
 
-export interface ApiRunningProcessArgs extends ModifyPartial<ApiRunningProcess, {
+import type ProcessStatus from "../enums/process_status";
+import type { DateLike, ModifyPartial } from "./type_aliases";
+
+export type ApiRunningProcessArgument = ModifyPartial<ApiRunningProcess, {
   startDate?: DateLike
   endDate?: DateLike
-}> { }
+}>
 
 export class ApiRunningProcess {
-  constructor({id, name, status, startDate, endDate, message}: ApiRunningProcessArgs = {}) {
+  constructor({ id, name, status, startDate, endDate, message }: ApiRunningProcessArgument = {}) {
     this.id = id;
     this.name = name;
     this.status = status;
-    this.message = message;
     addInstantGetterAndSetterToApiModel(this, "startDate", startDate);
     addInstantGetterAndSetterToApiModel(this, "endDate", endDate);
+    this.message = message;
   }
 
   id: number;

package/source/models/api/api_scan_dataset.ts

@@ -1,19 +1,20 @@
 import { Matrix4 } from "three";
+
 import addInstantGetterAndSetterToApiModel from "../../mixins/add_instant_getter_and_setter_to_api_model";
 import addReadOnlyPropertiesToModel from "../../mixins/add_read_only_properties_to_model";
-import ApiMatrix4 from "./api_matrix_4";
 import Matrix4Converter from "../../converters/matrix_4_converter";
-import { DateLike, ModifyPartial } from "type_aliases";
+
+import type ApiMatrix4 from "./api_matrix_4";
+import type { DateLike, ModifyPartial } from "type_aliases";
 
 export type ApiScanDatasetArgument = ModifyPartial<ApiScanDataset, {
-  coarseAlignmentMatrix?: ApiMatrix4 | Matrix4 | string | null
-  fineAlignmentMatrix?: ApiMatrix4 | Matrix4 | string | null
-  scanDate?: DateLike,
-  qaStarted?: DateLike,
-  qaComplete?: DateLike,
-  analysisCompleted?: DateLike,
-  manualAnalysisSkipped?: DateLike,
-  scanDateString?: string,
+  coarseAlignmentMatrix: ApiMatrix4 | Matrix4 | string | null
+  fineAlignmentMatrix: ApiMatrix4 | Matrix4 | string | null
+  scanDate: DateLike,
+  qaStarted: DateLike,
+  qaComplete: DateLike,
+  analysisCompleted: DateLike,
+  manualAnalysisSkipped: DateLike,
 }>
 
 export enum ApiScanDatasetQaState {

package/source/models/api/api_scandataset_stats.ts

@@ -1,55 +1,64 @@
-import {addInstantGetterAndSetterToApiModel} from "../../mixins";
+import { addInstantGetterAndSetterToApiModel } from "../../mixins";
 
-export class ApiScanDatasetStats {
-   organizationName: string;
-   scanDatasetId: number;
-   projectName: string;
-   floor: string;
-   scanDatasetName: string;
-   pipelineStartTime: Date;
-   pipelineEndTime: Date;
-   pipelineStatus: string;
-   qaCompleteTime: Date;
-   qaStartTime: Date;
-   squareFootage: number;
+import type { DateLike, ModifyPartial } from "type_aliases";
 
-   realityCaptureName?: string;
-   realityCaptureType?: string;
-   realityCaptureUploadedOn?: Date;
+export type ApiScanDatasetStatsArgument = ModifyPartial<ApiScanDatasetStats, {
+  pipelineStartTime: DateLike;
+  pipelineEndTime: DateLike;
+  qaCompleteTime: DateLike;
+  qaStartTime: DateLike;
+  realityCaptureUploadedOn: DateLike;
+}>
 
-   constructor(props: ApiScanDatasetStatsProps) {
-      addInstantGetterAndSetterToApiModel(this, 'pipelineStartTime', props.pipelineStartTime);
-      addInstantGetterAndSetterToApiModel(this, 'pipelineEndTime', props.pipelineEndTime);
-      addInstantGetterAndSetterToApiModel(this, 'qaCompleteTime', props.qaCompleteTime);
-      addInstantGetterAndSetterToApiModel(this, 'qaStartTime', props.qaStartTime);
-      addInstantGetterAndSetterToApiModel(this, 'realityCaptureUploadedOn', props.realityCaptureUploadedOn);
-      this.organizationName = props.organizationName;
-      this.projectName = props.projectName;
-      this.scanDatasetId = props.scanDatasetId;
-      this.scanDatasetName = props.scanDatasetName;
-      this.pipelineStatus = props.pipelineStatus;
-      this.squareFootage = props.squareFootage;
 
-      this.realityCaptureName = props.realityCaptureName;
-      this.realityCaptureType = props.realityCaptureType;
-   }
-}
+export class ApiScanDatasetStats {
+  constructor({
+                pipelineStartTime,
+                pipelineEndTime,
+                qaCompleteTime,
+                qaStartTime,
+                realityCaptureUploadedOn,
+                organizationName,
+                projectName,
+                floor,
+                scanDatasetId,
+                scanDatasetName,
+                pipelineStatus,
+                squareFootage,
+                realityCaptureName,
+                realityCaptureType
+              }: ApiScanDatasetStatsArgument = {})
+  {
+    addInstantGetterAndSetterToApiModel(this, "pipelineStartTime", pipelineStartTime);
+    addInstantGetterAndSetterToApiModel(this, "pipelineEndTime", pipelineEndTime);
+    addInstantGetterAndSetterToApiModel(this, "qaCompleteTime", qaCompleteTime);
+    addInstantGetterAndSetterToApiModel(this, "qaStartTime", qaStartTime);
+    addInstantGetterAndSetterToApiModel(this, "realityCaptureUploadedOn", realityCaptureUploadedOn);
+    this.organizationName = organizationName;
+    this.projectName = projectName;
+    this.floor = floor;
+    this.scanDatasetId = scanDatasetId;
+    this.scanDatasetName = scanDatasetName;
+    this.pipelineStatus = pipelineStatus;
+    this.squareFootage = squareFootage;
 
+    this.realityCaptureName = realityCaptureName;
+    this.realityCaptureType = realityCaptureType;
+  }
 
-type ApiScanDatasetStatsProps = {
-   organizationName: string;
-   scanDatasetId: number;
-   projectName: string;
-   floor: string;
-   scanDatasetName: string;
-   pipelineStartTime: number;
-   pipelineEndTime: number;
-   pipelineStatus: string;
-   qaCompleteTime: number;
-   qaStartTime: number;
-   squareFootage: number;
+  organizationName: string;
+  scanDatasetId: number;
+  projectName: string;
+  floor: string;
+  scanDatasetName: string;
+  pipelineStartTime: number;
+  pipelineEndTime: number;
+  pipelineStatus: string;
+  qaCompleteTime: number;
+  qaStartTime: number;
+  squareFootage: number;
 
-   realityCaptureName?: string;
-   realityCaptureType?: string;
-   realityCaptureUploadedOn?: number;
-}
+  realityCaptureName?: string;
+  realityCaptureType?: string;
+  realityCaptureUploadedOn?: number;
+}

package/source/models/api/api_scanned_element.ts

@@ -1,8 +1,12 @@
-import {ApiBuiltStatus} from "../enums";
-import {ApiElementDeviation} from "./api_element_deviation";
+import { ApiBuiltStatus } from "../enums";
 
+import type ApiElementDeviation from "./api_element_deviation";
+
+/**
+ * @deprecated This information is now all part of the {@link ApiPlannedElement}
+ */
 export class ApiScannedElement<Label extends ApiBuiltStatus> {
-  constructor({globalId, scanLabel, deviation, detectedInScan}: Partial<ApiScannedElement<Label>> = {}) {
+  constructor({ globalId, scanLabel, deviation, detectedInScan }: Partial<ApiScannedElement<Label>> = {}) {
     this.globalId = globalId;
     this.scanLabel = scanLabel;
     this.deviation = deviation;

package/source/models/api/api_team_member.ts

@@ -1,12 +1,12 @@
-import { ApiProjectWorkPackage } from "./api_project_work_package";
+import type ApiProjectWorkPackage from "./api_project_work_package";
 
 export class ApiTeamMember {
-  id?: number
-  name: string
-  userOrganization: string
-  email: string
-  role: string
-  masterformats?: string[]
+  id?: number;
+  name: string;
+  userOrganization: string;
+  email: string;
+  role: string;
+  masterformats?: string[];
   vendor?: ApiProjectWorkPackage;
 
   constructor({ id, name, userOrganization, email, role, masterformats, vendor }: Partial<ApiTeamMember> = {}) {
@@ -19,3 +19,5 @@ export class ApiTeamMember {
     this.vendor = vendor;
   }
 }
+
+export default ApiTeamMember;

package/source/models/api/api_user.ts

@@ -1,21 +1,21 @@
-import UserRole from "../enums/user_role";
+import type UserRole from "../enums/user_role";
 
 export class ApiUser {
-    name: string
-    userOrganization: string
-    email: string
-    role: UserRole
-    projectId: string
-    userId: number
+  name: string;
+  userOrganization: string;
+  email: string;
+  role: UserRole;
+  projectId: string;
+  userId: number;
 
-    constructor({name, userOrganization, email, role, projectId, userId}: Partial<ApiUser> = {}) {
-        this.name = name;
-        this.userOrganization = userOrganization;
-        this.email = email;
-        this.role = role;
-        this.projectId = projectId;
-        this.userId = userId
-    }
+  constructor({ name, userOrganization, email, role, projectId, userId }: Partial<ApiUser> = {}) {
+    this.name = name;
+    this.userOrganization = userOrganization;
+    this.email = email;
+    this.role = role;
+    this.projectId = projectId;
+    this.userId = userId;
+  }
 }
 
 export default ApiUser;

package/source/models/api/api_user_action.ts

@@ -1,15 +1,17 @@
-import {ApiActionPayload} from "./api_action_payload";
-import UserActionType from "../enums/user_action_type";
-import ApiUser from "./api_user";
-import {DateLike} from "./type_aliases";
 import addInstantGetterAndSetterToApiModel from "../../mixins/add_instant_getter_and_setter_to_api_model";
 
+import type ApiActionPayload from "./api_action_payload";
+import type ApiUser from "./api_user";
+import type UserActionType from "../enums/user_action_type";
+import type { DateLike } from "type_aliases";
+
 export class ApiUserAction {
   constructor(user: ApiUser,
               userEmail: string,
               type: UserActionType,
               createdAt: DateLike,
-              payload: ApiActionPayload[]) {
+              payload: ApiActionPayload[])
+  {
     this.user = user;
     this.userEmail = userEmail;
     this.type = type;

package/source/models/api/api_user_for_organization.ts

@@ -1,32 +1,53 @@
-import UserRole from "../enums/user_role";
-import {DateLike} from "./type_aliases";
+import { addInstantGetterAndSetterToApiModel } from "../../mixins";
+
+import type UserRole from "../enums/user_role";
+import type { DateLike, ModifyPartial } from "type_aliases";
+
+export type ApiUserForOrganizationArgument = ModifyPartial<ApiUserForOrganization, {
+  latestInvitationExpiry: DateLike
+  accountCreationTime: DateLike
+  accountAcceptedTime: DateLike
+}>
 
 export class ApiUserForOrganization {
-    id: number
-    name: string
-    email: string
-    role: UserRole
-    projects: string[]
-    accessType: string
-    inviteStatus: string
-    masterformatCodes: string[]
-    latestInvitationExpiry: DateLike
-    accountCreationTime: DateLike
-    accountAcceptedTime: DateLike
+  id: number;
+  name: string;
+  email: string;
+  role: UserRole;
+  projects: string[];
+  accessType: string;
+  inviteStatus: string;
+  masterformatCodes: string[];
+  latestInvitationExpiry: number;
+  accountCreationTime: number;
+  accountAcceptedTime: number;
 
-    constructor({id, name,  email, role, projects, accessType, inviteStatus, masterformatCodes, latestInvitationExpiry, accountCreationTime, accountAcceptedTime}: Partial<ApiUserForOrganization> = {}) {
-        this.id = id;
-        this.name = name;
-        this.email = email;
-        this.role = role;
-        this.projects = projects;
-        this.accessType = accessType;
-        this.inviteStatus = inviteStatus;
-        this.masterformatCodes = masterformatCodes;
-        this.latestInvitationExpiry = latestInvitationExpiry;
-        this.accountCreationTime = accountCreationTime;
-        this.accountAcceptedTime = accountAcceptedTime;
-    }
+  constructor({
+                id,
+                name,
+                email,
+                role,
+                projects,
+                accessType,
+                inviteStatus,
+                masterformatCodes,
+                latestInvitationExpiry,
+                accountCreationTime,
+                accountAcceptedTime
+              }: ApiUserForOrganizationArgument = {})
+  {
+    this.id = id;
+    this.name = name;
+    this.email = email;
+    this.role = role;
+    this.projects = projects;
+    this.accessType = accessType;
+    this.inviteStatus = inviteStatus;
+    this.masterformatCodes = masterformatCodes;
+    addInstantGetterAndSetterToApiModel(this, "latestInvitationExpiry", latestInvitationExpiry);
+    addInstantGetterAndSetterToApiModel(this, "accountCreationTime", accountCreationTime);
+    addInstantGetterAndSetterToApiModel(this, "accountAcceptedTime", accountAcceptedTime);
+  }
 }
 
 export default ApiUserForOrganization;

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;