@rentcheck/biz 1.0.63 → 1.0.65

package/dist/utils/inspections/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userIsInvitedTeammate = void 0;
+const userIsInvitedTeammate = (inspection) => {
+    const validRoles = ['invitee-write', 'invitee-readonly'];
+    const validAssigneeTypes = ['teammates'];
+    if (validRoles.includes(inspection.role) &&
+        validAssigneeTypes.includes(inspection.assigned_recipients.type)) {
+        return true;
+    }
+    return false;
+};
+exports.userIsInvitedTeammate = userIsInvitedTeammate;

package/dist/utils/permission-groups/index.d.ts

@@ -0,0 +1,2 @@
+import { ApiPermissionGroup, ApiPermissionGroupDigest } from '@rentcheck/types';
+export declare const buildDigest: (data: ApiPermissionGroup) => ApiPermissionGroupDigest;

package/dist/utils/permission-groups/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDigest = void 0;
+const buildDigest = (data) => {
+    return {
+        id: data.id,
+        name: data.name,
+        user_count: data.users.length,
+    };
+};
+exports.buildDigest = buildDigest;

package/dist/utils/properties/index.d.ts

@@ -1 +1,4 @@
+import { APIProperty, AppFolioIntegration, Property, RentmanagerIntegration } from '@rentcheck/types';
 export * from './validations';
+export declare const propertyIsOutOfSync: (property: Property, integration?: AppFolioIntegration | RentmanagerIntegration) => boolean;
+export declare const getIntegrationVendor: (property: APIProperty | Property) => string | undefined;

package/dist/utils/properties/index.js

@@ -13,5 +13,35 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIntegrationVendor = exports.propertyIsOutOfSync = void 0;
+const moment_1 = __importDefault(require("moment"));
 __exportStar(require("./validations"), exports);
+const propertyIsOutOfSync = (property, integration) => {
+    if (property.property_type === 'Community') {
+        return false;
+    }
+    if (!integration) {
+        return false;
+    }
+    if (!property.rentmanager_sync && !property.appfolio_sync) {
+        return true;
+    }
+    const sync = property.rentmanager_sync || property.appfolio_sync;
+    return ((sync === null || sync === void 0 ? void 0 : sync.last_sync) &&
+        (0, moment_1.default)((0, moment_1.default)()).diff(sync.last_sync.toDate(), 'days') >= 7);
+};
+exports.propertyIsOutOfSync = propertyIsOutOfSync;
+const getIntegrationVendor = (property) => {
+    if (property.rentmanager_sync) {
+        return 'Rent Manager';
+    }
+    if (property.appfolio_sync) {
+        return 'AppFolio';
+    }
+    return undefined;
+};
+exports.getIntegrationVendor = getIntegrationVendor;

package/dist/utils/subscriptions/index.d.ts

@@ -3,3 +3,4 @@ import { ChargebeeEventSubscription } from '@rentcheck/types/dist/integrations/C
 export declare const isOnEssentialsPlan: (subscription?: ApiSubscription | null) => boolean;
 export declare const isOnProPlan: (subscription?: ApiSubscription | ChargebeeEventSubscription | null) => boolean;
 export declare const hasPropertySyncIntegrationAddons: (subscription: ApiSubscription | Subscription | null) => boolean;
+export declare const hasPremiumVideoAddons: (subscription: ApiSubscription | Subscription | null) => boolean;

package/dist/utils/subscriptions/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasPropertySyncIntegrationAddons = exports.isOnProPlan = exports.isOnEssentialsPlan = void 0;
+exports.hasPremiumVideoAddons = exports.hasPropertySyncIntegrationAddons = exports.isOnProPlan = exports.isOnEssentialsPlan = void 0;
 const integrations_1 = require("../../permissions/integrations");
 const isOnEssentialsPlan = (subscription) => {
     if (!(subscription === null || subscription === void 0 ? void 0 : subscription.plan)) {
@@ -33,3 +33,10 @@ const hasPropertySyncIntegrationAddons = (subscription) => {
         integrations_1.RentManager.canInstall(subscription));
 };
 exports.hasPropertySyncIntegrationAddons = hasPropertySyncIntegrationAddons;
+const hasPremiumVideoAddons = (subscription) => {
+    if (!subscription) {
+        return false;
+    }
+    return subscription.addons.some((a) => a.id.startsWith('premium-video'));
+};
+exports.hasPremiumVideoAddons = hasPremiumVideoAddons;

package/dist/utils/tenants/index.d.ts

@@ -1,2 +1,2 @@
-import { Tenant, TenantSyncData } from '@rentcheck/types';
-export declare const getSyncData: (tenant: Tenant) => TenantSyncData;
+import { SyncData, Tenant } from '@rentcheck/types';
+export declare const getSyncData: (tenant: Tenant) => SyncData;

package/dist/utils/tenants/index.js

@@ -4,13 +4,13 @@ exports.getSyncData = void 0;
 const dates_1 = require("../dates");
 const getSyncData = (tenant) => {
     if (tenant.appfolio_sync) {
-        return Object.assign(Object.assign({ integration_type: 'appfolio' }, tenant.appfolio_sync), { last_sync: (0, dates_1.parseDate)('firestore', tenant.appfolio_sync.last_sync, null) });
+        return Object.assign(Object.assign({ vendor: 'appfolio' }, tenant.appfolio_sync), { last_sync: (0, dates_1.parse)('firestore', tenant.appfolio_sync.last_sync, null) });
     }
     if (tenant.rentmanager_sync) {
-        return Object.assign(Object.assign({ integration_type: 'rentmanager' }, tenant.rentmanager_sync), { last_sync: (0, dates_1.parseDate)('firestore', tenant.rentmanager_sync.last_sync, null) });
+        return Object.assign(Object.assign({ vendor: 'rentmanager' }, tenant.rentmanager_sync), { last_sync: (0, dates_1.parse)('firestore', tenant.rentmanager_sync.last_sync, null) });
     }
     if (tenant.yardi_sync) {
-        return Object.assign(Object.assign({ integration_type: 'yardi' }, tenant.yardi_sync), { last_sync: (0, dates_1.parseDate)('firestore', tenant.yardi_sync, null) });
+        return Object.assign(Object.assign({ vendor: 'yardi' }, tenant.yardi_sync), { last_sync: (0, dates_1.parse)('firestore', tenant.yardi_sync, null) });
     }
     return undefined;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rentcheck/biz",
-  "version": "1.0.63",
+  "version": "1.0.65",
   "description": "RC biz",
   "author": "engineering@getrentcheck.com",
   "license": "MIT",
@@ -16,12 +16,16 @@
     "@babel/runtime": "^7.16.7",
     "@types/lodash": "^4.14.194",
     "jest": "^27.5.1",
+    "moment": "^2.24.0",
     "typescript": "^4.2.3"
   },
   "dependencies": {
     "@rentcheck/types": "^1.0.0",
     "lodash": "^4.17.21"
   },
+  "peerDependencies": {
+    "moment": "^2.24.0"
+  },
   "localDependencies": {
     "@rentcheck/types": "../types"
   }

package/src/permissions/inspections.ts

@@ -1,4 +1,10 @@
-import { AccountSettings, ApiSubscription } from '@rentcheck/types';
+import {
+	AccountSettings,
+	ApiSubscription,
+	Inspection,
+	PermissionGroup,
+	Profile,
+} from '@rentcheck/types';
 import * as Utils from '../utils';
 
 export const canRecordVideo = (subscription?: ApiSubscription | null) => {
@@ -47,3 +53,43 @@ export const areFlagDefaultPhotosEnabled = (
 
 	return accountSettings.is_maintenance_flag_default_photos_enabled;
 };
+
+type CanAccessParams = {
+	user: Profile;
+	inspection: Inspection;
+	permissionGroups: PermissionGroup[];
+};
+
+export const canAccess = ({
+	user,
+	inspection,
+	permissionGroups,
+}: CanAccessParams): boolean => {
+	const userIdIsInAuthorizedUserIds = inspection.authorized_user_ids.includes(
+		user.id
+	);
+	if (userIdIsInAuthorizedUserIds) return true;
+
+	const userOrgIds = user.organizations.map((org) => org.id);
+	const userOrOrgsHaveAccessToInspection = userOrgIds.some((orgId) =>
+		inspection.authorized_user_ids.includes(orgId)
+	);
+
+	const validInspectionTemplatesForUser =
+		permissionGroups
+			?.map((permissionGroup) => permissionGroup.inspection_templates)
+			?.flat() ?? [];
+	const userPermissionGroupsHaveAccessToInspectionTemplate =
+		validInspectionTemplatesForUser?.includes(
+			inspection.inspection_template.id
+		);
+
+	if (
+		userOrOrgsHaveAccessToInspection &&
+		userPermissionGroupsHaveAccessToInspectionTemplate
+	) {
+		return true;
+	}
+
+	return false;
+};

package/src/rules/inspections/index.ts

@@ -1,9 +1,19 @@
-import { ApiInspectionWithTemplate, Profile } from '@rentcheck/types';
+import {
+	APIProperty,
+	ApiInspection,
+	ApiInspectionWithTemplate,
+	Feature,
+	InspectionRole,
+	InspectionStatusDisplay,
+	Profile,
+	Recipients,
+} from '@rentcheck/types';
 
 import { Users } from '../../utils';
+import { userIsInvitedTeammate } from '../../utils/inspections';
 
 export const shouldShowLibraryOption = (
-	inspection?: ApiInspectionWithTemplate,
+	inspection?: ApiInspection,
 	profile?: Profile
 ) => {
 	if (!inspection) return false;
@@ -11,7 +21,7 @@ export const shouldShowLibraryOption = (
 	return Users.canPerformInspection(inspection) && !Users.isRenter(profile);
 };
 
-export const shouldShow360Option = (inspection?: ApiInspectionWithTemplate) => {
+export const shouldShow360Option = (inspection?: ApiInspection) => {
 	if (!inspection) return false;
 
 	return inspection.settings.can_take_360_photos
@@ -20,12 +30,447 @@ export const shouldShow360Option = (inspection?: ApiInspectionWithTemplate) => {
 };
 
 export const shouldShowVideoOption = (
-	inspection?: ApiInspectionWithTemplate,
-	profile?: Profile
+	inspection?: ApiInspection,
+	profile?: Profile,
+	feature?: Feature
 ) => {
+	if (feature?.is_video_enabled) return true;
+
 	if (!inspection) return false;
 
 	return inspection.settings.can_record_video && !Users.isRenter(profile)
 		? !!inspection.fast_track
 		: false;
 };
+
+export const canApprove = (inspection: ApiInspection, profile?: Profile) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'Awaiting Review',
+		'Revision Review',
+	];
+
+	if (!profile) return false;
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (inspection.role !== 'creator') return false;
+
+	return true;
+};
+
+export const canReject = (inspection: ApiInspection, profile?: Profile) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'Awaiting Review',
+		'Revision Review',
+	];
+
+	if (!profile) return false;
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (inspection.role !== 'creator') return false;
+
+	if (inspection.review) return false;
+
+	return true;
+};
+
+export const canEditLabel = (inspection: ApiInspection) => {
+	if (userIsInvitedTeammate(inspection)) return true;
+
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	return true;
+};
+
+export const canCancelReviewRequest = (inspection: ApiInspection) => {
+	const validRoles: InspectionRole[] = ['creator'];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	if (inspection.inspection_status !== 'In Review') return false;
+
+	if (inspection.assigned_recipients.type !== 'emails') return false;
+
+	return true;
+};
+
+export const canCancelRevisionRequest = (inspection: ApiInspection) => {
+	const validRoles: InspectionRole[] = ['creator'];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	if (inspection.inspection_status !== 'Revision Requested') return false;
+
+	return true;
+};
+
+export const canArchive = (inspection: ApiInspection) => {
+	if (userIsInvitedTeammate(inspection)) return true;
+
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	if (inspection.archived) return false;
+
+	return true;
+};
+
+export const canUnarchive = (inspection: ApiInspection) => {
+	if (userIsInvitedTeammate(inspection)) return true;
+
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	if (!inspection.archived) return false;
+
+	return true;
+};
+
+export const canDelete = (inspection: ApiInspection) => {
+	if (userIsInvitedTeammate(inspection)) return true;
+
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+	const validStatuses: InspectionStatusDisplay[] = ['Scheduled', 'Not Started'];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	return true;
+};
+
+export const canSendReminder = (inspection: ApiInspection) => {
+	const validRoles: InspectionRole[] = ['creator'];
+	const validStatuses: InspectionStatusDisplay[] = [
+		'Not Started',
+		'Started',
+		'Revision Requested',
+	];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	return true;
+};
+
+export const canMarkAsComplete = (inspection: ApiInspection) => {
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+	const validStatuses: InspectionStatusDisplay[] = [
+		'Started',
+		'Revision Requested',
+	];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	return true;
+};
+
+export const canDownloadImages = (
+	inspection: ApiInspection,
+	features: Feature[]
+) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'In Review',
+		'Completed',
+		'Awaiting Review',
+		'Revision Review',
+		'Approved',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (!features.some((f) => f.images.length > 0 || f.videos.length > 0))
+		return false;
+
+	return true;
+};
+
+export const canDownloadMaintenanceFlags = (
+	inspection: ApiInspection,
+	features: Feature[]
+) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'In Review',
+		'Completed',
+		'Awaiting Review',
+		'Revision Review',
+		'Approved',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (!features.some((f) => f.maintenance_flags.length > 0)) return false;
+
+	return true;
+};
+
+export const canRequestSignatures = (inspection: ApiInspection) => {
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+	const validStatuses: InspectionStatusDisplay[] = [
+		'In Review',
+		'Completed',
+		'Awaiting Review',
+		'Revision Review',
+		'Approved',
+	];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	return true;
+};
+
+export const canCreateMaintenanceReport = (
+	inspection: ApiInspection,
+	features: Feature[]
+) => {
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+	const validStatuses: InspectionStatusDisplay[] = [
+		'In Review',
+		'Completed',
+		'Awaiting Review',
+		'Revision Review',
+		'Approved',
+	];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (!features.some((f) => f.maintenance_flags.length > 0)) return false;
+
+	return true;
+};
+
+export const canShowCompletedDate = (inspection: ApiInspection) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'Awaiting Review',
+		'Completed',
+		'Revision Requested',
+		'Revision Review',
+		'In Review',
+		'Approved',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (!inspection.completed_date) return false;
+
+	return true;
+};
+
+export const canShowCompletedBy = (inspection: ApiInspection) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'Awaiting Review',
+		'Completed',
+		'Revision Requested',
+		'Revision Review',
+		'In Review',
+		'Approved',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (!inspection.completed_by) return false;
+
+	return true;
+};
+
+export const canShowDueDate = (inspection: ApiInspection) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'Scheduled',
+		'Not Started',
+		'Started',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	return true;
+};
+
+export const canShowAssignee = (inspection: ApiInspection) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'Scheduled',
+		'Not Started',
+		'Started',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	return true;
+};
+
+export const canEditAssignee = (inspection: ApiInspection) => {
+	if (!canShowAssignee(inspection)) return false;
+
+	if (userIsInvitedTeammate(inspection)) return true;
+
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	return true;
+};
+
+export const canShowInviteDate = (inspection: ApiInspection) => {
+	const validStatuses: InspectionStatusDisplay[] = ['Scheduled'];
+	const validAssigneeTypes: Recipients['type'][] = [
+		'emails',
+		'residents',
+		'teammates',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (!validAssigneeTypes.includes(inspection.assigned_recipients.type))
+		return false;
+
+	if (!inspection.invite_date) return false;
+
+	return true;
+};
+
+export const canShowRevisionDueDate = (inspection: ApiInspection) => {
+	const validStatuses: InspectionStatusDisplay[] = ['Revision Requested'];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (!inspection.rejection?.due_date) return false;
+
+	return true;
+};
+
+export const canShowReviewDueDate = (inspection: ApiInspection) => {
+	const validStatuses: InspectionStatusDisplay[] = ['In Review'];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (!inspection.review?.due_date) return false;
+
+	return true;
+};
+
+export const canShowHyperlinkToPropertyPage = (inspection: ApiInspection) => {
+	if (userIsInvitedTeammate(inspection)) return true;
+
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	return true;
+};
+
+export const canEditDueDate = (inspection: ApiInspection) => {
+	if (!canShowDueDate(inspection)) return false;
+
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	return true;
+};
+
+export const canShare = (inspection: ApiInspection) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'In Review',
+		'Completed',
+		'Awaiting Review',
+		'Revision Review',
+		'Approved',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	return true;
+};
+
+export const canDownloadReport = (inspection: ApiInspection) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'In Review',
+		'Completed',
+		'Awaiting Review',
+		'Revision Review',
+		'Approved',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	return true;
+};
+
+export const canCopyInspectionDeeplink = (inspection: ApiInspection) => {
+	const validStatuses: InspectionStatusDisplay[] = [
+		'Scheduled',
+		'Not Started',
+		'Started',
+		'Revision Requested',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	return true;
+};
+
+export const canManualSync = (
+	inspection: ApiInspectionWithTemplate,
+	property: APIProperty
+) => {
+	/**
+	 * If the property is not synced to either provider we don't
+	 * have anywhere to sync the inspection to.
+	 */
+	if (!property.rentmanager_sync && !property.appfolio_sync) return false;
+
+	/**
+	 * if the inspection has already been synced and we registered
+	 * no errors, we don't need to show the button. Manual sync is
+	 * only intended to be shown as an initial sync or a retry.
+	 */
+	if (inspection.sync_data && !inspection.sync_data.error) return false;
+
+	/**
+	 * Only inspections that are Completed or In Review can be synced.
+	 */
+	const validStatuses: InspectionStatusDisplay[] = [
+		'In Review',
+		'Completed',
+		'Awaiting Review',
+		'Revision Review',
+		'Approved',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	return true;
+};
+
+export const canShowSyncStatus = (inspection: ApiInspectionWithTemplate) => {
+	if (!inspection.sync_data) return false;
+
+	const validStatuses: InspectionStatusDisplay[] = [
+		'In Review',
+		'Completed',
+		'Awaiting Review',
+		'Revision Review',
+		'Approved',
+	];
+
+	if (!validStatuses.includes(inspection.inspection_status)) return false;
+
+	if (userIsInvitedTeammate(inspection)) return true;
+
+	const validRoles: InspectionRole[] = ['creator', 'self-perform'];
+
+	if (!validRoles.includes(inspection.role)) return false;
+
+	return true;
+};

package/src/rules/teammates/index.ts

@@ -9,7 +9,7 @@ export const canAccess = (
 
 	if (!user) return false;
 
-	return user.organizations.some((org) => org.role === 'admin');
+	return true;
 };
 
 export const canEdit = (