@turndown/library 0.1.16 → 0.1.22

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

@@ -1,72 +1,109 @@
-export interface CreateInventoryItemRequest {
+import type { IInventoryCount, IInventoryItem, IInventoryRestockOrder, IInventoryRestockOrderItem, IPropertyInventory, IRoomInventory, TInventoryRestockOrderStatus } from ".";
+import type { IMessageResponse } from "../base";
+export interface IInventoryCompanyRouteParams {
+    companyId: string;
 }
-export interface CreateInventoryItemResponse {
+export interface IInventoryItemRouteParams {
+    itemId: string;
 }
-export interface GetInventoryItemByIdRequest {
+export interface IInventoryRoomRouteParams {
+    roomId: string;
 }
-export interface GetInventoryItemByIdResponse {
+export interface IInventoryPropertyRouteParams {
+    propertyId: string;
 }
-export interface UpdateInventoryItemRequest {
+export interface IInventoryExecutionRouteParams {
+    executionId: string;
 }
-export interface UpdateInventoryItemResponse {
+export interface IRoomInventoryIdParams {
+    roomInventoryId: string;
 }
-export interface DeleteInventoryItemRequest {
+export interface IInventoryOrderRouteParams {
+    orderId: string;
 }
-export interface DeleteInventoryItemResponse {
+export interface ICreateInventoryItemRequest extends Partial<IInventoryItem> {
+    companyId: string;
+    name: string;
 }
-export interface GetInventoryByCompanyIdRequest {
+export interface ICreateInventoryItemResponse extends IInventoryItem {
 }
-export interface GetInventoryByCompanyIdResponse {
+export interface IGetInventoryItemByIdRequest extends IInventoryItemRouteParams {
 }
-export interface AddInventoryToPropertyRequest {
+export interface IGetInventoryItemByIdResponse extends IInventoryItem {
 }
-export interface AddInventoryToPropertyResponse {
+export interface IUpdateInventoryItemRequest extends Partial<IInventoryItem> {
 }
-export interface GetPropertyInventoryRequest {
+export interface IUpdateInventoryItemResponse extends IInventoryItem {
 }
-export interface GetPropertyInventoryResponse {
+export interface IDeleteInventoryItemRequest extends IInventoryItemRouteParams {
 }
-export interface GetPropertyInventoryNeedingRestockRequest {
+export interface IDeleteInventoryItemResponse extends IMessageResponse {
 }
-export interface GetPropertyInventoryNeedingRestockResponse {
+export interface IGetInventoryByCompanyIdRequest extends IInventoryCompanyRouteParams {
 }
-export interface AddInventoryToRoomRequest {
+export type IGetInventoryByCompanyIdResponse = IInventoryItem[];
+export interface IAddInventoryToPropertyRequest extends Partial<IPropertyInventory> {
+    propertyId: string;
+    inventoryItemId: string;
 }
-export interface AddInventoryToRoomResponse {
+export interface IAddInventoryToPropertyResponse extends IPropertyInventory {
 }
-export interface GetRoomInventoryRequest {
+export interface IGetPropertyInventoryRequest extends IInventoryPropertyRouteParams {
 }
-export interface GetRoomInventoryResponse {
+export type IGetPropertyInventoryResponse = IPropertyInventory[];
+export interface IGetPropertyInventoryNeedingRestockRequest extends IInventoryPropertyRouteParams {
 }
-export interface UpdateRoomInventoryRequest {
+export type IGetPropertyInventoryNeedingRestockResponse = IPropertyInventory[];
+export interface IAddInventoryToRoomRequest extends Partial<IRoomInventory> {
+    roomId: string;
+    inventoryItemId: string;
 }
-export interface UpdateRoomInventoryResponse {
+export interface IAddInventoryToRoomResponse extends IRoomInventory {
 }
-export interface GetRoomInventoryNeedingRestockRequest {
+export interface IGetRoomInventoryRequest extends IInventoryRoomRouteParams {
 }
-export interface GetRoomInventoryNeedingRestockResponse {
+export type IGetRoomInventoryResponse = IRoomInventory[];
+export interface IUpdateRoomInventoryRequest extends Partial<IRoomInventory> {
 }
-export interface RecordInventoryCountRequest {
+export interface IUpdateRoomInventoryResponse extends IRoomInventory {
 }
-export interface RecordInventoryCountResponse {
+export interface IGetRoomInventoryNeedingRestockRequest extends IInventoryRoomRouteParams {
 }
-export interface GetInventoryCountsByExecutionIdRequest {
+export type IGetRoomInventoryNeedingRestockResponse = IRoomInventory[];
+export interface IRecordInventoryCountRequest extends Partial<IInventoryCount> {
+    checklistExecutionId: string;
+    roomInventoryId: string;
+    countedLevel: number;
+    countedBy: string;
 }
-export interface GetInventoryCountsByExecutionIdResponse {
+export interface IRecordInventoryCountResponse extends IInventoryCount {
 }
-export interface CreateRestockOrderRequest {
+export interface IGetInventoryCountsByExecutionIdRequest extends IInventoryExecutionRouteParams {
 }
-export interface CreateRestockOrderResponse {
+export type IGetInventoryCountsByExecutionIdResponse = IInventoryCount[];
+export interface IRestockOrderItemInput {
+    inventoryItemId: string;
+    roomInventoryId?: string;
+    propertyInventoryId?: string;
+    quantityOrdered: number;
+    unitCost?: number;
 }
-export interface GetRestockOrdersByCompanyIdRequest {
+export interface ICreateRestockOrderRequest extends Partial<IInventoryRestockOrder> {
+    companyId: string;
+    orderedBy: string;
+    items: IRestockOrderItemInput[];
 }
-export interface GetRestockOrdersByCompanyIdResponse {
+export interface ICreateRestockOrderResponse extends IInventoryRestockOrder {
 }
-export interface GetRestockOrderItemsRequest {
+export interface IGetRestockOrdersByCompanyIdRequest extends IInventoryCompanyRouteParams {
 }
-export interface GetRestockOrderItemsResponse {
+export type IGetRestockOrdersByCompanyIdResponse = IInventoryRestockOrder[];
+export interface IGetRestockOrderItemsRequest extends IInventoryOrderRouteParams {
 }
-export interface UpdateRestockOrderStatusRequest {
+export type IGetRestockOrderItemsResponse = IInventoryRestockOrderItem[];
+export interface IUpdateRestockOrderStatusRequest {
+    status: TInventoryRestockOrderStatus;
+    receivedBy?: string;
 }
-export interface UpdateRestockOrderStatusResponse {
+export interface IUpdateRestockOrderStatusResponse extends IInventoryRestockOrder {
 }

package/dist/types/inventory/routes.js

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

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

@@ -0,0 +1,7 @@
+import type { TServiceType, TStatus } from "../base";
+import type { TPropertyType } from "../property";
+export interface IJobFilterValues {
+    propertyType: TPropertyType;
+    status: TStatus;
+    role: TServiceType;
+}

package/dist/types/job/index.js

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

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

@@ -1,47 +1,33 @@
-import { MetaData, ObjectValues, USStateCodeType } from "../index";
+import { ISelectOption, IMetaData, TRecordValue, TStatus, TUnitedStatesStateCode } from "../index";
 export * from "./routes";
-declare const PROPERTY_TYPES: {
-    readonly HOUSE: "House";
-    readonly APARTMENT: "Apartment";
-    readonly CONDO: "Condo";
-    readonly TOWNHOUSE: "Townhouse";
-    readonly VILLA: "Villa";
-    readonly CABIN: "Cabin";
-    readonly COTTAGE: "Cottage";
-    readonly BUNGALOW: "Bungalow";
-    readonly FARMHOUSE: "Farmhouse";
-    readonly RANCH: "Ranch";
-    readonly LOFT: "Loft";
-    readonly STUDIO: "Studio";
-    readonly DUPLEX: "Duplex";
-    readonly TRIPLEX: "Triplex";
-    readonly PENTHOUSE: "Penthouse";
-    readonly CHALET: "Chalet";
-    readonly CASTLE: "Castle";
-    readonly BEACH_HOUSE: "Beach House";
-    readonly HOUSEBOAT: "Houseboat";
-    readonly YURT: "Yurt";
-    readonly TREEHOUSE: "Treehouse";
-    readonly OTHER: "Other";
+export declare const PROPERTY_STATUS: {
+    readonly Active: "Active";
+    readonly Inactive: "Inactive";
 };
-export type PropertyType = ObjectValues<typeof PROPERTY_TYPES>;
-export interface Property extends MetaData {
+export type TPropertyStatus = TRecordValue<typeof PROPERTY_STATUS>;
+export declare const PropertyStatusOptions: ISelectOption<TPropertyStatus>[];
+export declare const PROPERTY_TYPES: readonly ["Apartment", "Commercial", "Condo", "House"];
+export type TPropertyType = (typeof PROPERTY_TYPES)[number];
+export declare const PropertyTypeOptions: ISelectOption<TPropertyType>[];
+export interface IProperty extends IMetaData {
     id: string;
     displayName: string;
     addressLine1?: string;
     addressLine2?: string;
     city?: string;
-    stateCode?: USStateCodeType;
-    propertyType?: PropertyType;
+    stateCode?: TUnitedStatesStateCode | string;
+    propertyType?: TPropertyType;
+    status?: TPropertyStatus;
     sqft?: number;
     postalCode?: string;
     country?: string;
     timezone?: string;
+    imageUrl?: string;
     photoUrl?: string;
     companyId: string;
     specialNotes?: string;
 }
-export interface PropertyAccessInformation {
+export interface IPropertyAccessInformation {
     propertyId: string;
     entryInstructions?: string;
     accessCode?: string;
@@ -51,3 +37,76 @@ export interface PropertyAccessInformation {
     parkingInfo?: string;
     specialNotes?: string;
 }
+export interface IPropertyBase {
+    id: string;
+    name: string;
+    address?: string;
+    propertyType?: string;
+    imageUrl?: string;
+    status?: TPropertyStatus;
+}
+export interface IPropertyMetric {
+    id: string;
+    label: string;
+    value: string | number;
+    iconName?: string;
+}
+export interface IPropertyAccessItem {
+    id: string;
+    label: string;
+    value?: string;
+    iconName?: string;
+}
+export interface IPropertyRoomSummaryItem {
+    id: string;
+    name: string;
+    roomType?: string;
+    imageUrl?: string;
+    checklistCount?: number;
+    inventoryCount?: number;
+}
+export interface IPropertyJobSummaryItem {
+    id: string;
+    title: string;
+    description?: string;
+    status?: TStatus;
+}
+export interface IPropertyFormValues {
+    displayName: string;
+    propertyType: string;
+    status: string;
+    addressLine1: string;
+    city: string;
+    stateCode: string;
+    postalCode: string;
+    specialNotes: string;
+}
+export interface IPropertyAccessFormValues {
+    entryInstructions: string;
+    accessCode: string;
+    wifiName: string;
+    wifiPassword: string;
+    parkingInfo: string;
+    specialNotes: string;
+}
+export interface IPropertyFilterValues {
+    status: string;
+    propertyType: TPropertyType;
+}
+export interface IPropertySummary {
+    id: string;
+    displayName: string;
+    propertyType: TPropertyType;
+    addressLine1?: string;
+    city?: string;
+    stateCode?: string;
+    postalCode?: string;
+    imageUrl?: string;
+    status?: string;
+}
+export interface IPropertyDetail extends IPropertySummary {
+    specialNotes?: string;
+    roomCount?: number;
+    createdAt?: string;
+    updatedAt?: string;
+}

package/dist/types/property/index.js

@@ -1,25 +1,25 @@
 export * from "./routes";
-const PROPERTY_TYPES = {
-    HOUSE: "House",
-    APARTMENT: "Apartment",
-    CONDO: "Condo",
-    TOWNHOUSE: "Townhouse",
-    VILLA: "Villa",
-    CABIN: "Cabin",
-    COTTAGE: "Cottage",
-    BUNGALOW: "Bungalow",
-    FARMHOUSE: "Farmhouse",
-    RANCH: "Ranch",
-    LOFT: "Loft",
-    STUDIO: "Studio",
-    DUPLEX: "Duplex",
-    TRIPLEX: "Triplex",
-    PENTHOUSE: "Penthouse",
-    CHALET: "Chalet",
-    CASTLE: "Castle",
-    BEACH_HOUSE: "Beach House",
-    HOUSEBOAT: "Houseboat",
-    YURT: "Yurt",
-    TREEHOUSE: "Treehouse",
-    OTHER: "Other",
+export const PROPERTY_STATUS = {
+    Active: "Active",
+    Inactive: "Inactive",
 };
+export const PropertyStatusOptions = [
+    {
+        label: "Active",
+        value: PROPERTY_STATUS.Active,
+    },
+    {
+        label: "Inactive",
+        value: PROPERTY_STATUS.Inactive,
+    },
+];
+export const PROPERTY_TYPES = [
+    "Apartment",
+    "Commercial",
+    "Condo",
+    "House",
+];
+export const PropertyTypeOptions = PROPERTY_TYPES.map((propertyType) => ({
+    label: propertyType,
+    value: propertyType,
+}));

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

@@ -1,28 +1,54 @@
-export interface CreatePropertyRequest {
+import type { IProperty, IPropertyAccessInformation, IPropertyDetail, IPropertySummary } from ".";
+import type { IMessageResponse } from "../base";
+export interface IPropertyIdParams {
+    propertyId: string;
 }
-export interface CreatePropertyResponse {
+export interface ICompanyIdParams {
+    companyId: string;
 }
-export interface GetPropertyByIdRequest {
+export interface ICreatePropertyRequest {
+    companyId: string;
+    displayName: string;
+    propertyType: string;
+    status?: string;
+    addressLine1: string;
+    addressLine2?: string;
+    city: string;
+    stateCode: string;
+    postalCode: string;
+    country?: string;
+    sqft?: number;
+    timezone?: string;
+    photoUrl?: string;
+    specialNotes?: string;
 }
-export interface GetPropertyByIdResponse {
+export interface IUpdatePropertyRequest extends Partial<ICreatePropertyRequest> {
 }
-export interface UpdatePropertyRequest {
+export interface IGetPropertiesRequest {
+    companyId?: string;
 }
-export interface UpdatePropertyResponse {
+export interface IGetPropertyByIdRequest extends IPropertyIdParams {
 }
-export interface DeletePropertyRequest {
+export interface IDeletePropertyRequest extends IPropertyIdParams {
 }
-export interface DeletePropertyResponse {
+export type IGetPropertiesResponse = IPropertySummary[];
+export interface IGetPropertyResponse extends IPropertyDetail {
 }
-export interface GetPropertiesByCompanyIdRequest {
+export interface ICreatePropertyResponse extends IPropertyDetail {
 }
-export interface GetPropertiesByCompanyIdResponse {
+export interface IUpdatePropertyResponse extends IPropertyDetail {
 }
-export interface UpdatePropertyAccessInformationRequest {
+export interface IDeletePropertyResponse extends IMessageResponse {
 }
-export interface UpdatePropertyAccessInformationResponse {
+export interface IUpdatePropertyAccessInformationRequest extends Partial<IPropertyAccessInformation> {
 }
-export interface GetPropertyAccessInformationRequest {
+export interface IUpdatePropertyAccessInformationResponse extends IPropertyAccessInformation {
 }
-export interface GetPropertyAccessInformationResponse {
+export interface IGetPropertyAccessInformationRequest extends IPropertyIdParams {
 }
+export type IGetPropertyAccessInformationResponse = IPropertyAccessInformation | null;
+export interface IGetPropertyByIdResponse extends IGetPropertyResponse {
+}
+export interface IGetPropertiesByCompanyIdRequest extends ICompanyIdParams {
+}
+export type IGetPropertiesByCompanyIdResponse = IProperty[];

package/dist/types/property/routes.js

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

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

@@ -1,4 +1,4 @@
-import { MetaData, ObjectValues } from "../index";
+import { IMetaData, TRecordValue } from "../index";
 export * from "./routes";
 declare const ROOM_TYPE: {
     BEDROOM: string;
@@ -16,12 +16,12 @@ declare const ROOM_TYPE: {
     GARDEN: string;
     OTHER: string;
 };
-export type RoomType = ObjectValues<typeof ROOM_TYPE>;
-export interface Room extends MetaData {
+export type TRoomType = TRecordValue<typeof ROOM_TYPE>;
+export interface IRoom extends IMetaData {
     id: string;
     displayName: string;
     checklistTemplateId?: string;
-    roomType?: RoomType;
+    roomType?: TRoomType;
     heroPhoto?: string;
     propertyId: string;
     description?: string;

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

@@ -1,16 +1,35 @@
-export interface CreateRoomRequest {
+import type { IRoom } from ".";
+import type { IMessageResponse } from "../base";
+export interface IRoomPropertyRouteParams {
+    propertyId: string;
 }
-export interface CreateRoomResponse {
+export interface IRoomRouteParams {
+    roomId: string;
 }
-export interface GetRoomsByPropertyIdRequest {
+export interface ICreateRoomRequest {
+    propertyId: string;
+    displayName: string;
+    description?: string;
+    checklistTemplateId?: string;
 }
-export interface GetRoomsByPropertyIdResponse {
+export interface ICreateRoomResponse extends IRoom {
 }
-export interface UpdateRoomRequest {
+export interface IGetRoomsByPropertyIdRequest extends IRoomPropertyRouteParams {
 }
-export interface UpdateRoomResponse {
+export type IGetRoomsByPropertyIdResponse = IRoom[];
+export interface IGetDetailedRoomsByPropertyIdRequest extends IRoomPropertyRouteParams {
 }
-export interface DeleteRoomRequest {
+export type IGetDetailedRoomsByPropertyIdResponse = IRoom[];
+export interface IGetRoomByIdRequest extends IRoomRouteParams {
 }
-export interface DeleteRoomResponse {
+export interface IGetRoomByIdResponse extends IRoom {
+}
+export interface IUpdateRoomRequest extends Partial<ICreateRoomRequest> {
+    displayName?: string;
+}
+export interface IUpdateRoomResponse extends IRoom {
+}
+export interface IDeleteRoomRequest extends IRoomRouteParams {
+}
+export interface IDeleteRoomResponse extends IMessageResponse {
 }

package/dist/types/room/routes.js

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

package/dist/types/room-checklist/index.d.ts

@@ -1,15 +1,15 @@
-import { MetaData } from "../index";
-import { ChecklistTemplateItem } from "../checklist-template";
+import { IMetaData } from "../index";
+import { IChecklistTemplateItem } from "../checklist-template";
 export * from "./routes";
-export interface RoomChecklist extends MetaData {
+export interface IRoomChecklist extends IMetaData {
     id: string;
     roomId: string;
     templateId?: string;
     name: string;
     isActive: boolean;
-    items: RoomChecklistItem[];
+    items: IRoomChecklistItem[];
 }
-export interface RoomChecklistItem extends ChecklistTemplateItem {
+export interface IRoomChecklistItem extends IChecklistTemplateItem {
     roomChecklistId: string;
     templateItemId?: string;
     isCustom: boolean;
@@ -17,13 +17,13 @@ export interface RoomChecklistItem extends ChecklistTemplateItem {
 /**
  * Room checklist with items
  */
-export interface RoomChecklistWithItems extends RoomChecklist {
-    items: RoomChecklistItem[];
+export interface IRoomChecklistWithItems extends IRoomChecklist {
+    items: IRoomChecklistItem[];
 }
 /**
  * Input for creating a room checklist
  */
-export interface CreateRoomChecklistInput {
+export interface ICreateRoomChecklistInput {
     roomId: string;
     templateId?: string;
     name: string;
@@ -32,7 +32,7 @@ export interface CreateRoomChecklistInput {
 /**
  * Input for creating room checklist items
  */
-export interface CreateRoomChecklistItemInput {
+export interface ICreateRoomChecklistItemInput {
     title: string;
     description?: string;
     displayOrder: number;

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

@@ -1,56 +1,78 @@
-export interface CreateChecklistRequest {
+import type { ICreateRoomChecklistInput, ICreateRoomChecklistItemInput, IRoomChecklist, IRoomChecklistItem, IRoomChecklistWithItems } from ".";
+import type { IMessageResponse } from "../base";
+export interface IRoomChecklistRoomRouteParams {
+    roomId: string;
 }
-export interface CreateChecklistResponse {
+export interface IChecklistIdParams {
+    checklistId: string;
 }
-export interface CreateCustomChecklistRequest {
+export interface IChecklistAndItemIdParams {
+    checklistId: string;
+    itemId: string;
 }
-export interface CreateCustomChecklistResponse {
+export interface ICreateChecklistRequest extends Omit<ICreateRoomChecklistInput, "roomId"> {
+    name: string;
 }
-export interface GetChecklistByRoomIdRequest {
+export interface ICreateChecklistResponse extends IRoomChecklist {
 }
-export interface GetChecklistByRoomIdResponse {
+export interface ICreateCustomChecklistRequest {
+    roomId: string;
+    name: string;
+    items: ICreateRoomChecklistItemInput[];
 }
-export interface GetChecklistByIdRequest {
+export interface ICreateCustomChecklistResponse extends IRoomChecklistWithItems {
 }
-export interface GetChecklistByIdResponse {
+export interface IGetChecklistByRoomIdRequest extends IRoomChecklistRoomRouteParams {
 }
-export interface GetChecklistWithItemsRequest {
+export interface IGetChecklistByRoomIdResponse extends IRoomChecklist {
 }
-export interface GetChecklistWithItemsResponse {
+export interface IGetChecklistByIdRequest extends IChecklistIdParams {
 }
-export interface UpdateChecklistRequest {
+export interface IGetChecklistByIdResponse extends IRoomChecklist {
 }
-export interface UpdateChecklistResponse {
+export interface IGetChecklistWithItemsRequest extends IChecklistIdParams {
 }
-export interface DeleteChecklistRequest {
+export interface IGetChecklistWithItemsResponse extends IRoomChecklistWithItems {
 }
-export interface DeleteChecklistResponse {
+export interface IUpdateChecklistRequest extends Partial<ICreateRoomChecklistInput> {
 }
-export interface CloneChecklistRequest {
+export interface IUpdateChecklistResponse extends IRoomChecklist {
 }
-export interface CloneChecklistResponse {
+export interface IDeleteChecklistRequest extends IChecklistIdParams {
 }
-export interface GetChecklistItemsRequest {
+export interface IDeleteChecklistResponse extends IMessageResponse {
 }
-export interface GetChecklistItemsResponse {
+export interface ICloneChecklistRequest {
+    targetRoomId: string;
 }
-export interface GetCustomChecklistItemsRequest {
+export interface ICloneChecklistResponse extends IRoomChecklistWithItems {
 }
-export interface GetCustomChecklistItemsResponse {
+export interface IGetChecklistItemsRequest extends IChecklistIdParams {
 }
-export interface AddChecklistItemRequest {
+export type IGetChecklistItemsResponse = IRoomChecklistItem[];
+export interface IGetCustomChecklistItemsRequest extends IChecklistIdParams {
 }
-export interface AddChecklistItemResponse {
+export type IGetCustomChecklistItemsResponse = IRoomChecklistItem[];
+export interface IAddChecklistItemRequest extends ICreateRoomChecklistItemInput {
+    title: string;
+    displayOrder: number;
 }
-export interface UpdateChecklistItemRequest {
+export interface IAddChecklistItemResponse extends IRoomChecklistItem {
 }
-export interface UpdateChecklistItemResponse {
+export interface IUpdateChecklistItemRequest extends Partial<ICreateRoomChecklistItemInput> {
 }
-export interface DeleteChecklistItemRequest {
+export interface IUpdateChecklistItemResponse extends IRoomChecklistItem {
 }
-export interface DeleteChecklistItemResponse {
+export interface IDeleteChecklistItemRequest extends IChecklistAndItemIdParams {
 }
-export interface ReorderChecklistItemsRequest {
+export interface IDeleteChecklistItemResponse extends IMessageResponse {
 }
-export interface ReorderChecklistItemsResponse {
+export interface IChecklistItemOrder {
+    itemId: string;
+    displayOrder: number;
+}
+export interface IReorderChecklistItemsRequest {
+    itemOrders: IChecklistItemOrder[];
+}
+export interface IReorderChecklistItemsResponse extends IMessageResponse {
 }

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

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