@turndown/library 0.1.20 → 0.1.23

package/dist/types/company/routes.d.ts

@@ -1,52 +1,100 @@
-import { ICompany, TCompanyType } from ".";
-import { TAccountType } from "../user";
+import type { ICompany, TCompanyType } from ".";
+import type { IMessageResponse } from "../base";
+import type { TAccountType } from "../user";
+export interface ICompanyRouteParams {
+    companyId: string;
+}
+export interface ICompanyUserRouteParams {
+    userId: string;
+}
+export interface ICompanyInvitationTokenParams {
+    token: string;
+}
+export interface ICompanyInvitationIdParams extends ICompanyRouteParams {
+    invitationId: string;
+}
+export interface IGetCompaniesQuery {
+    search?: string;
+    filter?: "active" | "pending" | "all";
+}
 export interface ICreateCompanyRequest {
     displayName: string;
-    addressLine1?: string;
+    addressLine1: string;
     addressLine2?: string;
-    city?: string;
-    stateCode?: string;
-    postalCode?: string;
+    city: string;
+    stateCode: string;
+    postalCode: string;
     companyType: TCompanyType;
 }
-export interface ICreateCompanyResponse {
-    company: ICompany;
+export interface ICreateCompanyResponse extends ICompany {
 }
-export interface IGetCompanyByIdRequest {
+export interface IGetCompaniesRequest {
 }
-export interface IGetCompanyByIdResponse {
-    company: ICompany;
+export type IGetCompaniesResponse = ICompany[];
+export interface IGetCompanyByIdRequest extends ICompanyRouteParams {
 }
-export interface IUpdateCompanyRequest {
-    companyId: string;
-    company: Partial<ICompany>;
+export interface IGetCompanyByIdResponse extends ICompany {
+}
+export interface IUpdateCompanyRequest extends Partial<ICompany> {
 }
-export interface IUpdateCompanyResponse {
-    company: ICompany;
+export interface IUpdateCompanyResponse extends ICompany {
 }
 export interface IInviteUserToCompanyRequest {
-    companyId: string;
     email: string;
     role: TAccountType;
-    userId: string;
 }
-export interface IInviteUserToCompanyResponse {
-    message: string;
+export interface IInviteUserToCompanyResponse extends IMessageResponse {
+}
+export interface IGetCompanyUsersRequest extends ICompanyRouteParams {
+}
+export interface ICompanyUserSummary {
+    id: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    role: TAccountType;
+}
+export type IGetCompanyUsersResponse = Array<ICompany & ICompanyUserSummary>;
+export interface IGetUserCompaniesRequest extends ICompanyUserRouteParams {
+}
+export type IGetUserCompaniesResponse = ICompany[];
+export interface IInviteCompanyToCompanyRequest {
+    message?: string;
+}
+export interface IInviteCompanyToCompanyResponse {
+    id: string;
+    token: string;
+    expiresAt: Date | string;
+}
+export interface IValidateCompanyInvitationRequest extends ICompanyInvitationTokenParams {
+}
+export interface IValidateCompanyInvitationResponse {
+    id: string;
+    requesterCompanyId: string;
+    providerCompanyId: string;
+    invitedBy: string;
+    message?: string | null;
+    expiresAt: Date | string;
+    requesterCompanyName: string;
+    providerCompanyName: string;
+    invitedByName: string;
+}
+export interface IAcceptCompanyInvitationRequest extends ICompanyInvitationTokenParams {
+}
+export interface IAcceptCompanyInvitationResponse {
+    requesterCompanyId: string;
+    providerCompanyId: string;
+    requesterCompanyName: string;
+    providerCompanyName: string;
+}
+export interface IDeclineCompanyInvitationRequest extends ICompanyInvitationTokenParams {
 }
-export interface IGetCompanyUsersRequest {
+export interface IDeclineCompanyInvitationResponse extends IMessageResponse {
 }
-export interface IGetCompanyUsersResponse {
-    company: Partial<ICompany>;
-    users: {
-        id: string;
-        email: string;
-        firstName: string;
-        lastName: string;
-        role: TAccountType;
-    }[];
+export interface IGetPendingCompanyInvitationsRequest extends ICompanyRouteParams {
 }
-export interface IGetUserCompaniesRequest {
+export type IGetPendingCompanyInvitationsResponse = IValidateCompanyInvitationResponse[];
+export interface IRevokeCompanyInvitationRequest extends ICompanyInvitationIdParams {
 }
-export interface IGetUserCompaniesResponse {
-    companies: ICompany[];
+export interface IRevokeCompanyInvitationResponse extends IMessageResponse {
 }

package/dist/types/company/routes.js

@@ -1,2 +1 @@
-// company.interfaces.ts
 export {};

package/dist/types/damage-report/index.d.ts

@@ -1,6 +1,22 @@
+import { TRecordValue } from "../base";
 export * from "./routes";
-export type TDamageSeverity = "MINOR" | "MODERATE" | "SEVERE" | "CRITICAL";
-export type TDamageStatus = "OPEN" | "IN_REVIEW" | "RESOLVED" | "ESCALATED";
+export declare const DAMAGE_SEVERITY: {
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+    readonly HIGH: "HIGH";
+    readonly CRITICAL: "CRITICAL";
+};
+export type TDamageSeverity = TRecordValue<typeof DAMAGE_SEVERITY>;
+export declare const DAMAGE_STATUS: {
+    OPEN: string;
+    IN_REVIEW: string;
+    ASSIGNED: string;
+    IN_PROGRESS: string;
+    RESOLVED: string;
+    CLOSED: string;
+    ESCALATED: string;
+};
+export type TDamageStatus = TRecordValue<typeof DAMAGE_STATUS>;
 export interface IDamageReport {
     id: string;
     propertyId: string;

package/dist/types/damage-report/index.js

@@ -1 +1,16 @@
 export * from "./routes";
+export const DAMAGE_SEVERITY = {
+    LOW: "LOW",
+    MEDIUM: "MEDIUM",
+    HIGH: "HIGH",
+    CRITICAL: "CRITICAL",
+};
+export const DAMAGE_STATUS = {
+    OPEN: "OPEN",
+    IN_REVIEW: "IN_REVIEW",
+    ASSIGNED: "ASSIGNED",
+    IN_PROGRESS: "IN_PROGRESS",
+    RESOLVED: "RESOLVED",
+    CLOSED: "CLOSED",
+    ESCALATED: "ESCALATED",
+};

package/dist/types/damage-report/routes.d.ts

@@ -1,76 +1,153 @@
-export interface ICreateDamageReportRequest {
+import type { IDamageComment, IDamagePhoto, IDamageReport, TDamageStatus } from ".";
+export interface IDamageReportPropertyRouteParams {
+    propertyId: string;
 }
-export interface ICreateDamageReportResponse {
+export interface IDamageReportRoomRouteParams {
+    roomId: string;
 }
-export interface IGetDamageReportByIdRequest {
+export interface IDamageReportRouteParams {
+    reportId: string;
 }
-export interface IGetDamageReportByIdResponse {
+export interface IDamageReportWorkOrderRouteParams {
+    workOrderId: string;
 }
-export interface IUpdateDamageReportRequest {
+export interface IIncludeResolvedQuery {
+    includeResolved?: string;
 }
-export interface IUpdateDamageReportResponse {
+export interface ICreateDamageReportRequest extends Partial<IDamageReport> {
+    propertyId: string;
+    roomId: string;
+    reportedBy: string;
+    severity: IDamageReport["severity"];
+    title: string;
+    description: string;
 }
-export interface IUpdateDamageReportStatusRequest {
-}
-export interface IUpdateDamageReportStatusResponse {
-}
-export interface IAssignDamageReportRequest {
-}
-export interface IAssignDamageReportResponse {
-}
-export interface IResolveDamageReportRequest {
-}
-export interface IResolveDamageReportResponse {
-}
-export interface IGetDamageReportsByPropertyIdRequest {
-}
-export interface IGetDamageReportsByPropertyIdResponse {
+export interface ICreateDamageReportResponse extends IDamageReport {
 }
-export interface IGetDamageReportsByRoomIdRequest {
+export interface IGetDamageReportByIdRequest extends IDamageReportRouteParams {
 }
-export interface IGetDamageReportsByRoomIdResponse {
+export interface IGetDamageReportByIdResponse extends IDamageReport {
 }
-export interface IGetDamageReportPhotosRequest {
+export interface IUpdateDamageReportRequest extends Partial<IDamageReport> {
 }
-export interface IGetDamageReportPhotosResponse {
+export interface IUpdateDamageReportResponse extends IDamageReport {
 }
-export interface IAddDamageReportPhotoRequest {
-}
-export interface IAddDamageReportPhotoResponse {
+export interface IUpdateDamageReportStatusRequest {
+    status: TDamageStatus;
+    changedBy: string;
+    reason?: string;
 }
-export interface IGetDamageReportCommentsRequest {
+export interface IUpdateDamageReportStatusResponse extends IDamageReport {
 }
-export interface IGetDamageReportCommentsResponse {
+export interface IAssignDamageReportRequest {
+    assignedTo: string;
 }
-export interface IAddDamageReportCommentRequest {
+export interface IAssignDamageReportResponse extends IDamageReport {
 }
-export interface IAddDamageReportCommentResponse {
+export interface IResolveDamageReportRequest {
+    resolvedBy: string;
+    resolutionNotes?: string;
+    actualCost?: number;
 }
-export interface IGetDamageReportHistoryRequest {
+export interface IResolveDamageReportResponse extends IDamageReport {
 }
-export interface IGetDamageReportHistoryResponse {
+export interface IGetDamageReportsByPropertyIdRequest extends IDamageReportPropertyRouteParams {
 }
-export interface ICreateWorkOrderRequest {
+export type IGetDamageReportsByPropertyIdResponse = IDamageReport[];
+export interface IGetDamageReportsByRoomIdRequest extends IDamageReportRoomRouteParams {
 }
-export interface ICreateWorkOrderResponse {
+export type IGetDamageReportsByRoomIdResponse = IDamageReport[];
+export interface IGetDamageReportPhotosRequest extends IDamageReportRouteParams {
 }
-export interface IGetWorkOrderByIdRequest {
+export type IGetDamageReportPhotosResponse = IDamagePhoto[];
+export interface IAddDamageReportPhotoRequest {
+    photoId: string;
+    isBeforePhoto?: boolean;
+    caption?: string;
+    uploadedBy?: string;
 }
-export interface IGetWorkOrderByIdResponse {
+export interface IAddDamageReportPhotoResponse extends IDamagePhoto {
 }
-export interface IUpdateWorkOrderRequest {
+export interface IGetDamageReportCommentsRequest extends IDamageReportRouteParams {
 }
-export interface IUpdateWorkOrderResponse {
+export type IGetDamageReportCommentsResponse = IDamageComment[];
+export interface IAddDamageReportCommentRequest {
+    userId: string;
+    comment: string;
+    isInternal?: boolean;
+}
+export interface IAddDamageReportCommentResponse extends IDamageComment {
+}
+export interface IDamageReportStatusHistory {
+    id: string;
+    damageReportId: string;
+    previousStatus: TDamageStatus | null;
+    newStatus: TDamageStatus;
+    changedBy: string;
+    reason: string | null;
+    createdAt: Date;
+}
+export interface IGetDamageReportHistoryRequest extends IDamageReportRouteParams {
+}
+export type IGetDamageReportHistoryResponse = IDamageReportStatusHistory[];
+export type TWorkOrderPriority = "LOW" | "NORMAL" | "HIGH" | "URGENT";
+export type TWorkOrderStatus = "PENDING" | "SCHEDULED" | "IN_PROGRESS" | "COMPLETED" | "CANCELLED";
+export interface IWorkOrder {
+    id: string;
+    damageReportId: string | null;
+    propertyId: string;
+    roomId: string | null;
+    workOrderNumber: string | null;
+    priority: TWorkOrderPriority;
+    category: string | null;
+    assignedTo: string | null;
+    assignedAt: Date | null;
+    scheduledDate: Date | null;
+    scheduledTimeStart: string | null;
+    scheduledTimeEnd: string | null;
+    startedAt: Date | null;
+    completedAt: Date | null;
+    completedBy: string | null;
+    description: string;
+    workPerformed: string | null;
+    materialsUsed: string | null;
+    laborHours: number | null;
+    laborCost: number | null;
+    materialsCost: number | null;
+    totalCost: number | null;
+    status: TWorkOrderStatus;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface ICreateWorkOrderRequest extends Partial<IWorkOrder> {
+    propertyId: string;
+    description: string;
+}
+export interface ICreateWorkOrderResponse extends IWorkOrder {
+}
+export interface IGetWorkOrderByIdRequest extends IDamageReportWorkOrderRouteParams {
+}
+export interface IGetWorkOrderByIdResponse extends IWorkOrder {
+}
+export interface IUpdateWorkOrderRequest extends Partial<IWorkOrder> {
+}
+export interface IUpdateWorkOrderResponse extends IWorkOrder {
 }
 export interface IAssignWorkOrderRequest {
+    assignedTo: string;
 }
-export interface IAssignWorkOrderResponse {
+export interface IAssignWorkOrderResponse extends IWorkOrder {
 }
 export interface ICompleteWorkOrderRequest {
+    completedBy: string;
+    workPerformed: string;
+    materialsUsed?: string;
+    laborHours?: number;
+    laborCost?: number;
+    materialsCost?: number;
 }
-export interface ICompleteWorkOrderResponse {
-}
-export interface IGetWorkOrdersByPropertyIdRequest {
+export interface ICompleteWorkOrderResponse extends IWorkOrder {
 }
-export interface IGetWorkOrdersByPropertyIdResponse {
+export interface IGetWorkOrdersByPropertyIdRequest extends IDamageReportPropertyRouteParams {
 }
+export type IGetWorkOrdersByPropertyIdResponse = IWorkOrder[];

package/dist/types/damage-report/routes.js

@@ -1,2 +1 @@
-// damage-report.interfaces.ts
 export {};

package/dist/types/health/index.d.ts

@@ -0,0 +1,20 @@
+export * from "./routes";
+export interface IHealthCheckResponse {
+    status: "healthy";
+    database: "connected";
+    timestamp: string;
+    environment?: string;
+}
+export interface IHealthChecks {
+    database: "unknown" | "connected" | "disconnected";
+    uptime: number;
+    memory: {
+        rss: number;
+        heapTotal: number;
+        heapUsed: number;
+        external: number;
+        arrayBuffers: number;
+    };
+    timestamp: string;
+    databaseError?: string;
+}

package/dist/types/health/index.js

@@ -0,0 +1 @@
+export * from "./routes";

package/dist/types/health/routes.d.ts

@@ -0,0 +1,10 @@
+import type { IHealthChecks, IHealthCheckResponse } from ".";
+export interface IGetHealthRequest {
+}
+export interface IGetHealthResponse extends IHealthCheckResponse {
+}
+export interface IGetDetailedHealthRequest {
+}
+export interface IGetDetailedHealthResponse {
+    checks: IHealthChecks;
+}

package/dist/types/health/routes.js

@@ -0,0 +1 @@
+export {};

package/dist/types/image/index.d.ts

@@ -0,0 +1,34 @@
+export * from "./routes";
+export declare const IMAGE_ENTITY_TYPE: {
+    readonly USER_PROFILE: "USER_PROFILE";
+    readonly PROPERTY: "PROPERTY";
+    readonly COMPANY: "COMPANY";
+    readonly CHECKLIST_ITEM: "CHECKLIST_ITEM";
+    readonly PROPERTY_ROOM: "PROPERTY_ROOM";
+    readonly MAINTENANCE_TICKET: "MAINTENANCE_TICKET";
+    readonly WORK_REPORT: "WORK_REPORT";
+    readonly TURNDOWN_DEFAULT: "TURNDOWN_DEFAULT";
+};
+export type TStoredImageEntityType = (typeof IMAGE_ENTITY_TYPE)[keyof typeof IMAGE_ENTITY_TYPE];
+export interface IImage {
+    id: string;
+    s3Key: string;
+    s3Bucket: string;
+    entityType: TStoredImageEntityType;
+    entityId: string;
+    fileName: string;
+    mimeType: string;
+    fileSizeBytes?: number;
+    width?: number;
+    height?: number;
+    isPublic: boolean;
+    category?: string;
+    displayOrder: number;
+    uploadedBy?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt?: Date;
+}
+export interface IImageWithUrl extends IImage {
+    url: string;
+}

package/dist/types/image/index.js

@@ -0,0 +1,11 @@
+export * from "./routes";
+export const IMAGE_ENTITY_TYPE = {
+    USER_PROFILE: "USER_PROFILE",
+    PROPERTY: "PROPERTY",
+    COMPANY: "COMPANY",
+    CHECKLIST_ITEM: "CHECKLIST_ITEM",
+    PROPERTY_ROOM: "PROPERTY_ROOM",
+    MAINTENANCE_TICKET: "MAINTENANCE_TICKET",
+    WORK_REPORT: "WORK_REPORT",
+    TURNDOWN_DEFAULT: "TURNDOWN_DEFAULT",
+};

package/dist/types/image/routes.d.ts

@@ -0,0 +1,32 @@
+import type { IImageWithUrl } from ".";
+import type { ISuccessResponse } from "../base";
+export interface IImageUserRouteParams {
+    userId: string;
+}
+export interface IImagePropertyRouteParams {
+    propertyId: string;
+}
+export interface IImageRoomRouteParams {
+    roomId: string;
+}
+export interface IImageCompanyRouteParams {
+    companyId: string;
+}
+export interface IImageRouteParams {
+    imageId: string;
+}
+export interface IUploadProfileImageRequest {
+}
+export interface IUploadProfileImageResponse {
+    image: IImageWithUrl;
+}
+export interface IUploadImagesResponse {
+    images: IImageWithUrl[];
+}
+export interface IGetImagesForEntityResponse {
+    images: IImageWithUrl[];
+}
+export interface IDeleteImageRequest extends IImageRouteParams {
+}
+export interface IDeleteImageResponse extends ISuccessResponse {
+}

package/dist/types/image/routes.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -10,6 +10,8 @@ export * from "./checklist-template";
 export * from "./company";
 export * from "./damage-report";
 export * from "./errors";
+export * from "./health";
+export * from "./image";
 export * from "./inventory";
 export * from "./job";
 export * from "./property";

package/dist/types/index.js

@@ -10,6 +10,8 @@ export * from "./checklist-template";
 export * from "./company";
 export * from "./damage-report";
 export * from "./errors";
+export * from "./health";
+export * from "./image";
 export * from "./inventory";
 export * from "./job";
 export * from "./property";

package/dist/types/inventory/index.d.ts

@@ -122,77 +122,3 @@ export interface IInventoryRestockOrderItem {
     totalCost?: number;
     createdAt: Date;
 }
-export interface IRoomInventory extends IMetaData {
-    id: string;
-    roomId: string;
-    inventoryItemId: string;
-    currentLevel: number;
-    minimumLevel: number;
-    maximumLevel?: number;
-    parLevel?: number;
-    lastRestockedAt?: Date;
-    lastRestockedBy?: string;
-    lastCheckedAt?: Date;
-    lastCheckedBy?: string;
-    autoReorder: boolean;
-    locationNotes?: string;
-}
-export interface IPropertyInventory extends IMetaData {
-    id: string;
-    propertyId: string;
-    inventoryItemId: string;
-    currentLevel: number;
-    minimumLevel: number;
-    maximumLevel?: number;
-    parLevel?: number;
-    lastRestockedAt?: Date;
-    lastRestockedBy?: string;
-    lastCheckedAt?: Date;
-    lastCheckedBy?: string;
-    autoReorder: boolean;
-    locationNotes?: string;
-}
-export interface IInventoryCount {
-    id: string;
-    checklistExecutionId: string;
-    roomInventoryId: string;
-    previousLevel: number;
-    countedLevel: number;
-    consumedAmount: number;
-    restockedAmount: number;
-    finalLevel: number;
-    countedBy: string;
-    countedAt: Date;
-    needsRestock: boolean;
-    notes?: string;
-    createdAt: Date;
-}
-export interface IInventoryRestockOrder {
-    id: string;
-    companyId: string;
-    orderNumber?: string;
-    status: TInventoryRestockOrderStatus;
-    totalItems?: number;
-    totalCost?: number;
-    orderedBy?: string;
-    orderedAt?: Date;
-    expectedDelivery?: Date;
-    receivedBy?: string;
-    receivedAt?: Date;
-    supplierInfo?: string;
-    notes?: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
-export interface IInventoryRestockOrderItem {
-    id: string;
-    orderId: string;
-    inventoryItemId: string;
-    roomInventoryId?: string;
-    propertyInventoryId?: string;
-    quantityOrdered: number;
-    quantityReceived: number;
-    unitCost?: number;
-    totalCost?: number;
-    createdAt: Date;
-}