@turndown/library 0.1.16 → 0.1.22

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

@@ -1,76 +1,153 @@
-export interface CreateDamageReportRequest {
+import type { IDamageComment, IDamagePhoto, IDamageReport, TDamageStatus } from ".";
+export interface IDamageReportPropertyRouteParams {
+    propertyId: string;
 }
-export interface CreateDamageReportResponse {
+export interface IDamageReportRoomRouteParams {
+    roomId: string;
 }
-export interface GetDamageReportByIdRequest {
+export interface IDamageReportRouteParams {
+    reportId: string;
 }
-export interface GetDamageReportByIdResponse {
+export interface IDamageReportWorkOrderRouteParams {
+    workOrderId: string;
+}
+export interface IIncludeResolvedQuery {
+    includeResolved?: string;
+}
+export interface ICreateDamageReportRequest extends Partial<IDamageReport> {
+    propertyId: string;
+    roomId: string;
+    reportedBy: string;
+    severity: IDamageReport["severity"];
+    title: string;
+    description: string;
+}
+export interface ICreateDamageReportResponse extends IDamageReport {
+}
+export interface IGetDamageReportByIdRequest extends IDamageReportRouteParams {
+}
+export interface IGetDamageReportByIdResponse extends IDamageReport {
+}
+export interface IUpdateDamageReportRequest extends Partial<IDamageReport> {
+}
+export interface IUpdateDamageReportResponse extends IDamageReport {
 }
-export interface UpdateDamageReportRequest {
+export interface IUpdateDamageReportStatusRequest {
+    status: TDamageStatus;
+    changedBy: string;
+    reason?: string;
 }
-export interface UpdateDamageReportResponse {
+export interface IUpdateDamageReportStatusResponse extends IDamageReport {
 }
-export interface UpdateDamageReportStatusRequest {
+export interface IAssignDamageReportRequest {
+    assignedTo: string;
 }
-export interface UpdateDamageReportStatusResponse {
+export interface IAssignDamageReportResponse extends IDamageReport {
 }
-export interface AssignDamageReportRequest {
+export interface IResolveDamageReportRequest {
+    resolvedBy: string;
+    resolutionNotes?: string;
+    actualCost?: number;
 }
-export interface AssignDamageReportResponse {
+export interface IResolveDamageReportResponse extends IDamageReport {
 }
-export interface ResolveDamageReportRequest {
+export interface IGetDamageReportsByPropertyIdRequest extends IDamageReportPropertyRouteParams {
 }
-export interface ResolveDamageReportResponse {
+export type IGetDamageReportsByPropertyIdResponse = IDamageReport[];
+export interface IGetDamageReportsByRoomIdRequest extends IDamageReportRoomRouteParams {
 }
-export interface GetDamageReportsByPropertyIdRequest {
+export type IGetDamageReportsByRoomIdResponse = IDamageReport[];
+export interface IGetDamageReportPhotosRequest extends IDamageReportRouteParams {
 }
-export interface GetDamageReportsByPropertyIdResponse {
+export type IGetDamageReportPhotosResponse = IDamagePhoto[];
+export interface IAddDamageReportPhotoRequest {
+    photoId: string;
+    isBeforePhoto?: boolean;
+    caption?: string;
+    uploadedBy?: string;
 }
-export interface GetDamageReportsByRoomIdRequest {
+export interface IAddDamageReportPhotoResponse extends IDamagePhoto {
 }
-export interface GetDamageReportsByRoomIdResponse {
+export interface IGetDamageReportCommentsRequest extends IDamageReportRouteParams {
 }
-export interface GetDamageReportPhotosRequest {
+export type IGetDamageReportCommentsResponse = IDamageComment[];
+export interface IAddDamageReportCommentRequest {
+    userId: string;
+    comment: string;
+    isInternal?: boolean;
 }
-export interface GetDamageReportPhotosResponse {
+export interface IAddDamageReportCommentResponse extends IDamageComment {
 }
-export interface AddDamageReportPhotoRequest {
+export interface IDamageReportStatusHistory {
+    id: string;
+    damageReportId: string;
+    previousStatus: TDamageStatus | null;
+    newStatus: TDamageStatus;
+    changedBy: string;
+    reason: string | null;
+    createdAt: Date;
 }
-export interface AddDamageReportPhotoResponse {
+export interface IGetDamageReportHistoryRequest extends IDamageReportRouteParams {
 }
-export interface GetDamageReportCommentsRequest {
+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 GetDamageReportCommentsResponse {
+export interface ICreateWorkOrderRequest extends Partial<IWorkOrder> {
+    propertyId: string;
+    description: string;
 }
-export interface AddDamageReportCommentRequest {
+export interface ICreateWorkOrderResponse extends IWorkOrder {
 }
-export interface AddDamageReportCommentResponse {
+export interface IGetWorkOrderByIdRequest extends IDamageReportWorkOrderRouteParams {
 }
-export interface GetDamageReportHistoryRequest {
-}
-export interface GetDamageReportHistoryResponse {
-}
-export interface CreateWorkOrderRequest {
-}
-export interface CreateWorkOrderResponse {
-}
-export interface GetWorkOrderByIdRequest {
-}
-export interface GetWorkOrderByIdResponse {
-}
-export interface UpdateWorkOrderRequest {
-}
-export interface UpdateWorkOrderResponse {
-}
-export interface AssignWorkOrderRequest {
-}
-export interface AssignWorkOrderResponse {
-}
-export interface CompleteWorkOrderRequest {
-}
-export interface CompleteWorkOrderResponse {
-}
-export interface GetWorkOrdersByPropertyIdRequest {
-}
-export interface GetWorkOrdersByPropertyIdResponse {
+export interface IGetWorkOrderByIdResponse extends IWorkOrder {
 }
+export interface IUpdateWorkOrderRequest extends Partial<IWorkOrder> {
+}
+export interface IUpdateWorkOrderResponse extends IWorkOrder {
+}
+export interface IAssignWorkOrderRequest {
+    assignedTo: string;
+}
+export interface IAssignWorkOrderResponse extends IWorkOrder {
+}
+export interface ICompleteWorkOrderRequest {
+    completedBy: string;
+    workPerformed: string;
+    materialsUsed?: string;
+    laborHours?: number;
+    laborCost?: number;
+    materialsCost?: number;
+}
+export interface ICompleteWorkOrderResponse extends IWorkOrder {
+}
+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/errors/index.d.ts

@@ -2,29 +2,28 @@
  * Error Types
  * Custom error types and validation error structures
  */
-import { ErrorCode } from "../api";
-import { TurndownObject } from "../base";
+import { TErrorCode } from "../api";
 /**
  * Validation Error Detail
  * Detailed information about a validation error
  */
-export interface ValidationErrorDetail {
+export interface IValidationErrorDetail {
     field: string;
     message: string;
-    value?: TurndownObject;
+    value?: unknown;
 }
 /**
  * Missing Fields Error Detail
  * Information about missing required fields
  */
-export interface MissingFieldsErrorDetail {
+export interface IMissingFieldsErrorDetail {
     missingFields: string[];
 }
 /**
  * Rate Limit Error Detail
  * Information about rate limiting
  */
-export interface RateLimitErrorDetail {
+export interface IRateLimitErrorDetail {
     retryAfter?: number;
     message: string;
 }
@@ -32,36 +31,36 @@ export interface RateLimitErrorDetail {
  * Error Response Detail
  * Union type for all possible error details
  */
-export type ErrorResponseDetail = ValidationErrorDetail[] | MissingFieldsErrorDetail | RateLimitErrorDetail | Record<string, TurndownObject> | string;
+export type TErrorResponseDetail = IValidationErrorDetail[] | IMissingFieldsErrorDetail | IRateLimitErrorDetail | Record<string, unknown> | string;
 /**
  * Typed API Error
  * API error with typed details
  */
-export interface TypedApiError<T = ErrorResponseDetail> {
+export interface ITypedApiError<T = TErrorResponseDetail> {
     message: string;
-    code: ErrorCode;
+    code: TErrorCode;
     details?: T;
 }
 /**
  * Error Helper Types
  * For identifying specific error types
  */
-export type ValidationError = TypedApiError<ValidationErrorDetail[]>;
-export type MissingFieldsError = TypedApiError<MissingFieldsErrorDetail>;
-export type RateLimitError = TypedApiError<RateLimitErrorDetail>;
+export type TValidationError = ITypedApiError<IValidationErrorDetail[]>;
+export type TMissingFieldsError = ITypedApiError<IMissingFieldsErrorDetail>;
+export type TRateLimitError = ITypedApiError<IRateLimitErrorDetail>;
 /**
  * Type guard for ValidationError
  */
-export declare function isValidationError(error: TurndownObject): error is ValidationError;
+export declare function isValidationError(error: unknown): error is TValidationError;
 /**
  * Type guard for MissingFieldsError
  */
-export declare function isMissingFieldsError(error: TurndownObject): error is MissingFieldsError;
+export declare function isMissingFieldsError(error: unknown): error is TMissingFieldsError;
 /**
  * Type guard for RateLimitError
  */
-export declare function isRateLimitError(error: TurndownObject): error is RateLimitError;
+export declare function isRateLimitError(error: unknown): error is TRateLimitError;
 /**
  * Type guard for authentication errors
  */
-export declare function isAuthError(error: TurndownObject): boolean;
+export declare function isAuthError(error: unknown): boolean;

package/dist/types/errors/index.js

@@ -2,30 +2,40 @@
  * Error Types
  * Custom error types and validation error structures
  */
+const isErrorLike = (error) => {
+    return typeof error === "object" && error !== null;
+};
 /**
  * Type guard for ValidationError
  */
 export function isValidationError(error) {
-    return error?.code === "VALIDATION_ERROR" && Array.isArray(error?.details);
+    return (isErrorLike(error) &&
+        error.code === "VALIDATION_ERROR" &&
+        Array.isArray(error.details));
 }
 /**
  * Type guard for MissingFieldsError
  */
 export function isMissingFieldsError(error) {
-    return (error?.code === "MISSING_FIELDS" &&
-        Array.isArray(error?.details?.missingFields));
+    return (isErrorLike(error) &&
+        error.code === "MISSING_FIELDS" &&
+        typeof error.details === "object" &&
+        error.details !== null &&
+        "missingFields" in error.details &&
+        Array.isArray(error.details.missingFields));
 }
 /**
  * Type guard for RateLimitError
  */
 export function isRateLimitError(error) {
-    return error?.code === "RATE_LIMIT_EXCEEDED";
+    return isErrorLike(error) && error.code === "RATE_LIMIT_EXCEEDED";
 }
 /**
  * Type guard for authentication errors
  */
 export function isAuthError(error) {
-    return (error?.code === "UNAUTHORIZED" ||
-        error?.code === "INVALID_TOKEN" ||
-        error?.code === "INVALID_CREDENTIALS");
+    return (isErrorLike(error) &&
+        (error.code === "UNAUTHORIZED" ||
+            error.code === "INVALID_TOKEN" ||
+            error.code === "INVALID_CREDENTIALS"));
 }

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,7 +10,10 @@ 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";
 export * from "./room";
 export * from "./room-checklist";

package/dist/types/index.js

@@ -10,7 +10,10 @@ 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";
 export * from "./room";
 export * from "./room-checklist";

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

@@ -1,4 +1,4 @@
-import { MetaData, ObjectValues } from "../index";
+import { IMetaData, TRecordValue } from "../index";
 export * from "./routes";
 declare const INVENTORY_RESTOCK_ORDER_STATUS: {
     readonly PENDING: "PENDING";
@@ -6,7 +6,7 @@ declare const INVENTORY_RESTOCK_ORDER_STATUS: {
     readonly SHIPPED: "SHIPPED";
     readonly RECEIVED: "RECEIVED";
 };
-export type InventoryRestockOrderStatus = ObjectValues<typeof INVENTORY_RESTOCK_ORDER_STATUS>;
+export type TInventoryRestockOrderStatus = TRecordValue<typeof INVENTORY_RESTOCK_ORDER_STATUS>;
 export declare const INVENTORY_UNITS: {
     COUNT: string;
     ROLLS: string;
@@ -26,19 +26,19 @@ export declare const INVENTORY_UNITS: {
     CARTONS: string;
     OTHER: string;
 };
-export type InventoryUnitType = ObjectValues<typeof INVENTORY_UNITS>;
+export type TInventoryUnitType = TRecordValue<typeof INVENTORY_UNITS>;
 export declare const INVENTORY_ITEM_TYPE: {
     readonly CONSUMABLE: "CONSUMABLE";
     readonly FIXED: "FIXED";
 };
-export type InventoryItemType = ObjectValues<typeof INVENTORY_ITEM_TYPE>;
-export interface InventoryItem extends MetaData {
+export type TInventoryItemType = TRecordValue<typeof INVENTORY_ITEM_TYPE>;
+export interface IInventoryItem extends IMetaData {
     id: string;
     companyId: string;
     name: string;
     description?: string;
-    itemType: InventoryItemType;
-    unit: InventoryUnitType;
+    itemType: TInventoryItemType;
+    unit: TInventoryUnitType;
     unitCustom?: string;
     minimumLevel: number;
     reorderLevel: number;
@@ -48,7 +48,7 @@ export interface InventoryItem extends MetaData {
     sku?: string;
     barcode?: string;
 }
-export interface RoomInventory extends MetaData {
+export interface IRoomInventory extends IMetaData {
     id: string;
     roomId: string;
     inventoryItemId: string;
@@ -63,7 +63,7 @@ export interface RoomInventory extends MetaData {
     autoReorder: boolean;
     locationNotes?: string;
 }
-export interface PropertyInventory extends MetaData {
+export interface IPropertyInventory extends IMetaData {
     id: string;
     propertyId: string;
     inventoryItemId: string;
@@ -78,7 +78,7 @@ export interface PropertyInventory extends MetaData {
     autoReorder: boolean;
     locationNotes?: string;
 }
-export interface InventoryCount {
+export interface IInventoryCount {
     id: string;
     checklistExecutionId: string;
     roomInventoryId: string;
@@ -93,11 +93,11 @@ export interface InventoryCount {
     notes?: string;
     createdAt: Date;
 }
-export interface InventoryRestockOrder {
+export interface IInventoryRestockOrder {
     id: string;
     companyId: string;
     orderNumber?: string;
-    status: InventoryRestockOrderStatus;
+    status: TInventoryRestockOrderStatus;
     totalItems?: number;
     totalCost?: number;
     orderedBy?: string;
@@ -110,81 +110,7 @@ export interface InventoryRestockOrder {
     createdAt: Date;
     updatedAt: Date;
 }
-export interface InventoryRestockOrderItem {
-    id: string;
-    orderId: string;
-    inventoryItemId: string;
-    roomInventoryId?: string;
-    propertyInventoryId?: string;
-    quantityOrdered: number;
-    quantityReceived: number;
-    unitCost?: number;
-    totalCost?: number;
-    createdAt: Date;
-}
-export interface RoomInventory extends MetaData {
-    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 PropertyInventory extends MetaData {
-    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 InventoryCount {
-    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 InventoryRestockOrder {
-    id: string;
-    companyId: string;
-    orderNumber?: string;
-    status: InventoryRestockOrderStatus;
-    totalItems?: number;
-    totalCost?: number;
-    orderedBy?: string;
-    orderedAt?: Date;
-    expectedDelivery?: Date;
-    receivedBy?: string;
-    receivedAt?: Date;
-    supplierInfo?: string;
-    notes?: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
-export interface InventoryRestockOrderItem {
+export interface IInventoryRestockOrderItem {
     id: string;
     orderId: string;
     inventoryItemId: string;