@turndown/library 0.1.23 → 0.1.24

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

@@ -46,6 +46,7 @@ export declare const ERROR_CODES: {
     readonly NOT_FOUND: "NOT_FOUND";
     readonly CONFLICT: "CONFLICT";
     readonly ALREADY_EXISTS: "ALREADY_EXISTS";
+    readonly RATE_LIMIT: "RATE_LIMIT";
     readonly RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED";
     readonly INTERNAL_ERROR: "INTERNAL_ERROR";
     readonly DATABASE_ERROR: "DATABASE_ERROR";

package/dist/types/api/index.js

@@ -30,6 +30,7 @@ export const ERROR_CODES = {
     CONFLICT: "CONFLICT",
     ALREADY_EXISTS: "ALREADY_EXISTS",
     // 429 - Rate Limiting
+    RATE_LIMIT: "RATE_LIMIT",
     RATE_LIMIT_EXCEEDED: "RATE_LIMIT_EXCEEDED",
     // 500 - Server Errors
     INTERNAL_ERROR: "INTERNAL_ERROR",

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

@@ -1,5 +1,4 @@
 import { TRecordValue } from "../base";
-export * from "./routes";
 export declare const DAMAGE_SEVERITY: {
     readonly LOW: "LOW";
     readonly MEDIUM: "MEDIUM";
@@ -8,44 +7,72 @@ export declare const DAMAGE_SEVERITY: {
 };
 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;
+    readonly OPEN: "OPEN";
+    readonly IN_REVIEW: "IN_REVIEW";
+    readonly ASSIGNED: "ASSIGNED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly RESOLVED: "RESOLVED";
+    readonly CLOSED: "CLOSED";
+    readonly ESCALATED: "ESCALATED";
 };
 export type TDamageStatus = TRecordValue<typeof DAMAGE_STATUS>;
+export declare const WORK_ORDER_PRIORITY: {
+    readonly LOW: "LOW";
+    readonly NORMAL: "NORMAL";
+    readonly HIGH: "HIGH";
+    readonly URGENT: "URGENT";
+};
+export type TWorkOrderPriority = TRecordValue<typeof WORK_ORDER_PRIORITY>;
+export declare const WORK_ORDER_STATUS: {
+    readonly PENDING: "PENDING";
+    readonly SCHEDULED: "SCHEDULED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly COMPLETED: "COMPLETED";
+    readonly CANCELLED: "CANCELLED";
+};
+export type TWorkOrderStatus = TRecordValue<typeof WORK_ORDER_STATUS>;
 export interface IDamageReport {
     id: string;
     propertyId: string;
     roomId: string;
+    workSessionId: string | null;
     cleaningSessionId?: string;
     reportedBy: string;
+    reportedAt: Date;
     severity: TDamageSeverity;
     status: TDamageStatus;
     title: string;
     description: string;
-    locationDetails?: string;
-    estimatedCost?: number;
-    actualCost?: number;
-    assignedTo?: string;
-    resolvedAt?: Date;
-    resolvedBy?: string;
-    resolutionNotes?: string;
+    locationDetails: string | null;
+    estimatedCost: number | null;
+    actualCost: number | null;
+    assignedTo: string | null;
+    assignedAt: Date | null;
+    resolvedAt: Date | null;
+    resolvedBy: string | null;
+    resolutionNotes: string | null;
     requiresProfessional: boolean;
-    photos: IDamagePhoto[];
-    comments: IDamageComment[];
+    vendorInfo: string | null;
+    insuranceClaimNumber: string | null;
+    isTenantResponsible: boolean;
+    tenantChargeAmount: number | null;
+    createdAt: Date;
+    updatedAt: Date;
+    photos?: IDamagePhoto[];
+    comments?: IDamageComment[];
 }
-export interface IDamagePhoto {
+export interface IDamageReportPhoto {
     id: string;
     damageReportId: string;
     photoId: string;
-    photoUrl: string;
-    caption?: string;
+    photoUrl?: string;
+    caption: string | null;
     isBeforePhoto: boolean;
     displayOrder: number;
+    uploadedBy: string | null;
+    createdAt: Date;
+}
+export interface IDamagePhoto extends IDamageReportPhoto {
 }
 export interface IDamageComment {
     id: string;
@@ -53,5 +80,69 @@ export interface IDamageComment {
     userId: string;
     userName?: string;
     comment: string;
+    isInternal: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface IDamageReportStatusHistory {
+    id: string;
+    damageReportId: string;
+    previousStatus: TDamageStatus | null;
+    newStatus: TDamageStatus;
+    changedBy: string;
+    reason: string | null;
+    createdAt: Date;
+}
+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 ICreateDamageReportInput {
+    propertyId: string;
+    roomId: string;
+    workSessionId?: string;
+    reportedBy: string;
+    severity: TDamageSeverity;
+    title: string;
+    description: string;
+    locationDetails?: string;
+    estimatedCost?: number;
+    requiresProfessional?: boolean;
+    isTenantResponsible?: boolean;
+    tenantChargeAmount?: number;
 }
+export interface ICreateWorkOrderInput {
+    damageReportId?: string;
+    propertyId: string;
+    roomId?: string;
+    priority?: TWorkOrderPriority;
+    category?: string;
+    description: string;
+    scheduledDate?: Date;
+    scheduledTimeStart?: string;
+    scheduledTimeEnd?: string;
+}
+export * from "./routes";

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

@@ -1,4 +1,3 @@
-export * from "./routes";
 export const DAMAGE_SEVERITY = {
     LOW: "LOW",
     MEDIUM: "MEDIUM",
@@ -14,3 +13,17 @@ export const DAMAGE_STATUS = {
     CLOSED: "CLOSED",
     ESCALATED: "ESCALATED",
 };
+export const WORK_ORDER_PRIORITY = {
+    LOW: "LOW",
+    NORMAL: "NORMAL",
+    HIGH: "HIGH",
+    URGENT: "URGENT",
+};
+export const WORK_ORDER_STATUS = {
+    PENDING: "PENDING",
+    SCHEDULED: "SCHEDULED",
+    IN_PROGRESS: "IN_PROGRESS",
+    COMPLETED: "COMPLETED",
+    CANCELLED: "CANCELLED",
+};
+export * from "./routes";

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

@@ -1,4 +1,4 @@
-import type { IDamageComment, IDamagePhoto, IDamageReport, TDamageStatus } from ".";
+import type { ICreateDamageReportInput, ICreateWorkOrderInput, IDamageComment, IDamagePhoto, IDamageReport, IDamageReportStatusHistory, IWorkOrder, TDamageStatus, TWorkOrderStatus } from ".";
 export interface IDamageReportPropertyRouteParams {
     propertyId: string;
 }
@@ -14,13 +14,7 @@ export interface IDamageReportWorkOrderRouteParams {
 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 ICreateDamageReportRequest extends ICreateDamageReportInput {
 }
 export interface ICreateDamageReportResponse extends IDamageReport {
 }
@@ -78,50 +72,10 @@ export interface IAddDamageReportCommentRequest {
 }
 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 ICreateWorkOrderRequest extends ICreateWorkOrderInput {
 }
 export interface ICreateWorkOrderResponse extends IWorkOrder {
 }
@@ -151,3 +105,8 @@ export interface ICompleteWorkOrderResponse extends IWorkOrder {
 export interface IGetWorkOrdersByPropertyIdRequest extends IDamageReportPropertyRouteParams {
 }
 export type IGetWorkOrdersByPropertyIdResponse = IWorkOrder[];
+export interface IUpdateWorkOrderStatusRequest {
+    status: TWorkOrderStatus;
+}
+export interface IUpdateWorkOrderStatusResponse extends IWorkOrder {
+}

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

@@ -7,6 +7,7 @@ export declare const IMAGE_ENTITY_TYPE: {
     readonly PROPERTY_ROOM: "PROPERTY_ROOM";
     readonly MAINTENANCE_TICKET: "MAINTENANCE_TICKET";
     readonly WORK_REPORT: "WORK_REPORT";
+    readonly CLEANING_REPORT: "CLEANING_REPORT";
     readonly TURNDOWN_DEFAULT: "TURNDOWN_DEFAULT";
 };
 export type TStoredImageEntityType = (typeof IMAGE_ENTITY_TYPE)[keyof typeof IMAGE_ENTITY_TYPE];

package/dist/types/image/index.js

@@ -7,5 +7,6 @@ export const IMAGE_ENTITY_TYPE = {
     PROPERTY_ROOM: "PROPERTY_ROOM",
     MAINTENANCE_TICKET: "MAINTENANCE_TICKET",
     WORK_REPORT: "WORK_REPORT",
+    CLEANING_REPORT: "CLEANING_REPORT",
     TURNDOWN_DEFAULT: "TURNDOWN_DEFAULT",
 };

package/dist/types/index.d.ts

@@ -17,5 +17,6 @@ export * from "./job";
 export * from "./property";
 export * from "./room";
 export * from "./room-checklist";
+export * from "./subscription";
 export * from "./user";
 export * from "./work-session";

package/dist/types/index.js

@@ -17,5 +17,6 @@ export * from "./job";
 export * from "./property";
 export * from "./room";
 export * from "./room-checklist";
+export * from "./subscription";
 export * from "./user";
 export * from "./work-session";

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

@@ -0,0 +1,32 @@
+import { TRecordValue } from "../base";
+export declare const SUBSCRIPTION_STATUS: {
+    readonly ACTIVE: "active";
+    readonly CANCELED: "canceled";
+    readonly EXPIRED: "expired";
+    readonly PAST_DUE: "past_due";
+    readonly TRIALING: "trialing";
+};
+export type TSubscriptionStatus = TRecordValue<typeof SUBSCRIPTION_STATUS>;
+export declare const SUBSCRIPTION_PROVIDER: {
+    readonly STRIPE: "stripe";
+    readonly APPLE: "apple";
+    readonly GOOGLE: "google";
+};
+export type TSubscriptionProvider = TRecordValue<typeof SUBSCRIPTION_PROVIDER>;
+export declare const BILLING_PERIOD: {
+    readonly MONTHLY: "monthly";
+    readonly YEARLY: "yearly";
+};
+export type TBillingPeriod = TRecordValue<typeof BILLING_PERIOD>;
+export interface IUserSubscription {
+    id: string;
+    userId: string;
+    planId: string;
+    status: TSubscriptionStatus;
+    billingPeriod: TBillingPeriod;
+    currentPeriodStart: Date;
+    currentPeriodEnd: Date;
+    provider: TSubscriptionProvider;
+    providerSubscriptionId: string;
+    cancelAtPeriodEnd: boolean;
+}

package/dist/types/subscription/index.js

@@ -0,0 +1,16 @@
+export const SUBSCRIPTION_STATUS = {
+    ACTIVE: "active",
+    CANCELED: "canceled",
+    EXPIRED: "expired",
+    PAST_DUE: "past_due",
+    TRIALING: "trialing",
+};
+export const SUBSCRIPTION_PROVIDER = {
+    STRIPE: "stripe",
+    APPLE: "apple",
+    GOOGLE: "google",
+};
+export const BILLING_PERIOD = {
+    MONTHLY: "monthly",
+    YEARLY: "yearly",
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turndown/library",
-  "version": "0.1.23",
+  "version": "0.1.24",
   "description": "Shared TypeScript library for the Turndown suite.",
   "keywords": [
     "types",