@turndown/library 0.1.20 → 0.1.22

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

@@ -1,6 +1,15 @@
 import type { IAuthTokenResponse } from "..";
 import type { TAccountType, IDeviceInfo, IUserSafe } from "../user";
 import type { IGetUserResponse } from "../user/routes";
+export interface IAuthSessionIdParams {
+    sessionId: string;
+}
+export interface IAuthInvitationTokenParams {
+    token: string;
+}
+export interface IAuthInvitationIdParams {
+    invitationId: string;
+}
 export interface IRegisterRequest {
     email: string;
     password: string;
@@ -31,7 +40,7 @@ export interface IRefreshSessionResponse {
     companyId?: string;
 }
 export interface ILogoutRequest {
-    refreshToken: string;
+    refreshToken?: string;
 }
 export interface ILogoutResponse {
     message: string;
@@ -55,7 +64,7 @@ export interface IGetSessionsResponse {
     createdAt: string;
     lastUsedAt: string;
 }
-export interface IRevokeSessionRequest {
+export interface IRevokeSessionRequest extends IAuthSessionIdParams {
 }
 export interface IRevokeSessionResponse {
     message: string;
@@ -83,7 +92,11 @@ export interface IGetLoginHistoryResponse {
     failureReason?: string;
     createdAt: Date;
 }
-export interface IValidateInvitationRequest {
+export interface IGetLoginHistoryListResponse {
+    history: IGetLoginHistoryResponse[];
+    length: number;
+}
+export interface IValidateInvitationRequest extends IAuthInvitationTokenParams {
 }
 export interface IValidateInvitationResponse {
     id: string;
@@ -106,7 +119,7 @@ export interface IRegisterWithInvitationRequest {
 export interface IRegisterWithInvitationResponse extends IAuthTokenResponse {
 }
 export interface IAcceptInvitationRequest {
-    userId: string;
+    userId?: string;
     token: string;
 }
 export interface IAcceptInvitationResponse {
@@ -114,6 +127,10 @@ export interface IAcceptInvitationResponse {
     companyName: string;
     role: TAccountType;
 }
+export interface IAcceptInvitationRouteResponse {
+    invite: IAcceptInvitationResponse;
+    message: string;
+}
 export interface IGetPendingInvitationsRequest {
 }
 export interface IGetPendingInvitationsResponse {
@@ -127,9 +144,12 @@ export interface IGetPendingInvitationsResponse {
     expiresAt: string;
     createdAt: string;
 }
-export interface IRevokeInvitationRequest {
-    invitationId: string;
-    revokedBy: string;
+export interface IGetPendingInvitationsListResponse {
+    invitations: IGetPendingInvitationsResponse[];
+    length: number;
+}
+export interface IRevokeInvitationRequest extends IAuthInvitationIdParams {
+    revokedBy?: string;
 }
 export interface IRevokeInvitationResponse {
     message: string;

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

@@ -6,6 +6,18 @@ export type TUnknownRecord = Record<string, unknown>;
 export type TurndownObject<TObject extends object = TUnknownRecord> = {
     [TKey in keyof TObject]: TObject[TKey];
 };
+export type TEmptyObject = Record<string, never>;
+export interface IMessageResponse {
+    message: string;
+}
+export interface ISuccessResponse {
+    success: boolean;
+}
+export interface ICountResponse {
+    count: number;
+}
+export interface IEmptyRouteParams {
+}
 export interface IMetaData {
     createdAt: Date;
     updatedAt: Date;

package/dist/types/checklist-template/routes.d.ts

@@ -1,56 +1,85 @@
-export interface ICreateTemplateRequest {
+import type { IChecklistTemplate, IChecklistTemplateItem, IChecklistTemplateWithItems, ICreateTemplateInput, ICreateTemplateItemInput } from ".";
+import type { ICountResponse, IMessageResponse } from "../base";
+export interface IChecklistTemplateCompanyRouteParams {
+    companyId: string;
 }
-export interface ICreateTemplateResponse {
+export interface ITemplateIdParams {
+    templateId: string;
 }
-export interface ICreateTemplateWithItemsRequest {
+export interface ITemplateItemIdParams {
+    itemId: string;
 }
-export interface ICreateTemplateWithItemsResponse {
+export interface ITemplateAndItemIdParams {
+    templateId: string;
+    itemId: string;
 }
-export interface IGetTemplatesByCompanyIdRequest {
+export interface IIncludeInactiveQuery {
+    includeInactive?: string;
 }
-export interface IGetTemplatesByCompanyIdResponse {
+export interface ICreateTemplateRequest extends Partial<Omit<ICreateTemplateInput, "companyId" | "createdBy">> {
+    name: string;
 }
-export interface IGetTemplateByIdRequest {
+export interface ICreateTemplateResponse extends IChecklistTemplate {
 }
-export interface IGetTemplateByIdResponse {
+export interface ICreateTemplateWithItemsRequest extends ICreateTemplateInput {
+    items: ICreateTemplateItemInput[];
 }
-export interface IGetTemplateWithItemsRequest {
+export interface ICreateTemplateWithItemsResponse extends IChecklistTemplateWithItems {
 }
-export interface IGetTemplateWithItemsResponse {
+export interface IGetTemplatesByCompanyIdRequest extends IChecklistTemplateCompanyRouteParams {
 }
-export interface IUpdateTemplateRequest {
+export type IGetTemplatesByCompanyIdResponse = IChecklistTemplate[];
+export interface IGetTemplateByIdRequest extends ITemplateIdParams {
 }
-export interface IUpdateTemplateResponse {
+export interface IGetTemplateByIdResponse extends IChecklistTemplate {
 }
-export interface IDeleteTemplateRequest {
+export interface IGetTemplateWithItemsRequest extends ITemplateIdParams {
 }
-export interface IDeleteTemplateResponse {
+export interface IGetTemplateWithItemsResponse extends IChecklistTemplateWithItems {
+}
+export interface IUpdateTemplateRequest extends Partial<ICreateTemplateInput> {
+}
+export interface IUpdateTemplateResponse extends IChecklistTemplate {
+}
+export interface IDeleteTemplateRequest extends ITemplateIdParams {
+}
+export interface IDeleteTemplateResponse extends IMessageResponse {
 }
 export interface IToggleTemplateActiveRequest {
+    isActive: boolean;
+}
+export interface IToggleTemplateActiveResponse extends IChecklistTemplate {
+}
+export interface IGetTemplateUsageRequest extends ITemplateIdParams {
 }
-export interface IToggleTemplateActiveResponse {
+export interface IGetTemplateUsageResponse extends ICountResponse {
 }
-export interface IGetTemplateUsageRequest {
+export interface IGetTemplateItemsRequest extends ITemplateIdParams {
 }
-export interface IGetTemplateUsageResponse {
+export type IGetTemplateItemsResponse = IChecklistTemplateItem[];
+export interface IAddTemplateItemRequest extends ICreateTemplateItemInput {
+    title: string;
 }
-export interface IGetTemplateItemsRequest {
+export interface IAddTemplateItemResponse extends IChecklistTemplateItem {
 }
-export interface IGetTemplateItemsResponse {
+export interface IUpdateTemplateItemRequest extends Partial<ICreateTemplateItemInput> {
 }
-export interface IAddTemplateItemRequest {
+export interface IUpdateTemplateItemResponse extends IChecklistTemplateItem {
 }
-export interface IAddTemplateItemResponse {
+export interface IDuplicateTemplateItemRequest extends ITemplateItemIdParams {
 }
-export interface IUpdateTemplateItemRequest {
+export interface IDuplicateTemplateItemResponse extends IChecklistTemplateItem {
 }
-export interface IUpdateTemplateItemResponse {
+export interface IDeleteTemplateItemRequest extends ITemplateItemIdParams {
 }
-export interface IDeleteTemplateItemRequest {
+export interface IDeleteTemplateItemResponse extends IMessageResponse {
 }
-export interface IDeleteTemplateItemResponse {
+export interface ITemplateItemOrder {
+    itemId: string;
+    displayOrder: number;
 }
 export interface IReorderTemplateItemsRequest {
+    itemOrders: ITemplateItemOrder[];
 }
-export interface IReorderTemplateItemsResponse {
+export interface IReorderTemplateItemsResponse extends IMessageResponse {
 }

package/dist/types/checklist-template/routes.js

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

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

@@ -1,5 +1,22 @@
-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;
@@ -9,44 +26,75 @@ export interface ICreateCompanyRequest {
     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,6 @@
 export * from "./routes";
-export type TDamageSeverity = "MINOR" | "MODERATE" | "SEVERE" | "CRITICAL";
-export type TDamageStatus = "OPEN" | "IN_REVIEW" | "RESOLVED" | "ESCALATED";
+export type TDamageSeverity = "LOW" | "MEDIUM" | "HIGH" | "CRITICAL";
+export type TDamageStatus = "OPEN" | "IN_REVIEW" | "ASSIGNED" | "IN_PROGRESS" | "RESOLVED" | "CLOSED" | "ESCALATED";
 export interface IDamageReport {
     id: string;
     propertyId: string;

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",
+};