@turndown/library 0.1.16 → 0.1.20

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/index.d.ts

@@ -11,6 +11,7 @@ export * from "./company";
 export * from "./damage-report";
 export * from "./errors";
 export * from "./inventory";
+export * from "./job";
 export * from "./property";
 export * from "./room";
 export * from "./room-checklist";

package/dist/types/index.js

@@ -11,6 +11,7 @@ export * from "./company";
 export * from "./damage-report";
 export * from "./errors";
 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,7 +110,7 @@ export interface InventoryRestockOrder {
     createdAt: Date;
     updatedAt: Date;
 }
-export interface InventoryRestockOrderItem {
+export interface IInventoryRestockOrderItem {
     id: string;
     orderId: string;
     inventoryItemId: string;
@@ -122,7 +122,7 @@ export interface InventoryRestockOrderItem {
     totalCost?: number;
     createdAt: Date;
 }
-export interface RoomInventory extends MetaData {
+export interface IRoomInventory extends IMetaData {
     id: string;
     roomId: string;
     inventoryItemId: string;
@@ -137,7 +137,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;
@@ -152,7 +152,7 @@ export interface PropertyInventory extends MetaData {
     autoReorder: boolean;
     locationNotes?: string;
 }
-export interface InventoryCount {
+export interface IInventoryCount {
     id: string;
     checklistExecutionId: string;
     roomInventoryId: string;
@@ -167,11 +167,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;
@@ -184,7 +184,7 @@ export interface InventoryRestockOrder {
     createdAt: Date;
     updatedAt: Date;
 }
-export interface InventoryRestockOrderItem {
+export interface IInventoryRestockOrderItem {
     id: string;
     orderId: string;
     inventoryItemId: string;

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

@@ -1,72 +1,72 @@
-export interface CreateInventoryItemRequest {
+export interface ICreateInventoryItemRequest {
 }
-export interface CreateInventoryItemResponse {
+export interface ICreateInventoryItemResponse {
 }
-export interface GetInventoryItemByIdRequest {
+export interface IGetInventoryItemByIdRequest {
 }
-export interface GetInventoryItemByIdResponse {
+export interface IGetInventoryItemByIdResponse {
 }
-export interface UpdateInventoryItemRequest {
+export interface IUpdateInventoryItemRequest {
 }
-export interface UpdateInventoryItemResponse {
+export interface IUpdateInventoryItemResponse {
 }
-export interface DeleteInventoryItemRequest {
+export interface IDeleteInventoryItemRequest {
 }
-export interface DeleteInventoryItemResponse {
+export interface IDeleteInventoryItemResponse {
 }
-export interface GetInventoryByCompanyIdRequest {
+export interface IGetInventoryByCompanyIdRequest {
 }
-export interface GetInventoryByCompanyIdResponse {
+export interface IGetInventoryByCompanyIdResponse {
 }
-export interface AddInventoryToPropertyRequest {
+export interface IAddInventoryToPropertyRequest {
 }
-export interface AddInventoryToPropertyResponse {
+export interface IAddInventoryToPropertyResponse {
 }
-export interface GetPropertyInventoryRequest {
+export interface IGetPropertyInventoryRequest {
 }
-export interface GetPropertyInventoryResponse {
+export interface IGetPropertyInventoryResponse {
 }
-export interface GetPropertyInventoryNeedingRestockRequest {
+export interface IGetPropertyInventoryNeedingRestockRequest {
 }
-export interface GetPropertyInventoryNeedingRestockResponse {
+export interface IGetPropertyInventoryNeedingRestockResponse {
 }
-export interface AddInventoryToRoomRequest {
+export interface IAddInventoryToRoomRequest {
 }
-export interface AddInventoryToRoomResponse {
+export interface IAddInventoryToRoomResponse {
 }
-export interface GetRoomInventoryRequest {
+export interface IGetRoomInventoryRequest {
 }
-export interface GetRoomInventoryResponse {
+export interface IGetRoomInventoryResponse {
 }
-export interface UpdateRoomInventoryRequest {
+export interface IUpdateRoomInventoryRequest {
 }
-export interface UpdateRoomInventoryResponse {
+export interface IUpdateRoomInventoryResponse {
 }
-export interface GetRoomInventoryNeedingRestockRequest {
+export interface IGetRoomInventoryNeedingRestockRequest {
 }
-export interface GetRoomInventoryNeedingRestockResponse {
+export interface IGetRoomInventoryNeedingRestockResponse {
 }
-export interface RecordInventoryCountRequest {
+export interface IRecordInventoryCountRequest {
 }
-export interface RecordInventoryCountResponse {
+export interface IRecordInventoryCountResponse {
 }
-export interface GetInventoryCountsByExecutionIdRequest {
+export interface IGetInventoryCountsByExecutionIdRequest {
 }
-export interface GetInventoryCountsByExecutionIdResponse {
+export interface IGetInventoryCountsByExecutionIdResponse {
 }
-export interface CreateRestockOrderRequest {
+export interface ICreateRestockOrderRequest {
 }
-export interface CreateRestockOrderResponse {
+export interface ICreateRestockOrderResponse {
 }
-export interface GetRestockOrdersByCompanyIdRequest {
+export interface IGetRestockOrdersByCompanyIdRequest {
 }
-export interface GetRestockOrdersByCompanyIdResponse {
+export interface IGetRestockOrdersByCompanyIdResponse {
 }
-export interface GetRestockOrderItemsRequest {
+export interface IGetRestockOrderItemsRequest {
 }
-export interface GetRestockOrderItemsResponse {
+export interface IGetRestockOrderItemsResponse {
 }
-export interface UpdateRestockOrderStatusRequest {
+export interface IUpdateRestockOrderStatusRequest {
 }
-export interface UpdateRestockOrderStatusResponse {
+export interface IUpdateRestockOrderStatusResponse {
 }

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,55 @@
-export interface CreatePropertyRequest {
+import type { IPropertyAccessInformation, IPropertyDetail, IPropertySummary } from ".";
+export interface ICreatePropertyRequest {
+    displayName: string;
+    propertyType: string;
+    status: string;
+    addressLine1: string;
+    city: string;
+    stateCode: string;
+    postalCode: string;
+    specialNotes?: string;
 }
-export interface CreatePropertyResponse {
+export interface IUpdatePropertyRequest extends Partial<ICreatePropertyRequest> {
 }
-export interface GetPropertyByIdRequest {
+export interface IGetPropertiesRequest {
+    companyId?: string;
 }
-export interface GetPropertyByIdResponse {
+export interface IGetPropertyByIdRequest {
+    id: string;
 }
-export interface UpdatePropertyRequest {
+export interface IDeletePropertyRequest {
+    id: string;
 }
-export interface UpdatePropertyResponse {
+export interface IGetPropertiesResponse {
+    properties: IPropertySummary[];
 }
-export interface DeletePropertyRequest {
+export interface IGetPropertyResponse {
+    property: IPropertyDetail;
 }
-export interface DeletePropertyResponse {
+export interface ICreatePropertyResponse {
+    property: IPropertyDetail;
 }
-export interface GetPropertiesByCompanyIdRequest {
+export interface IUpdatePropertyResponse {
+    property: IPropertyDetail;
 }
-export interface GetPropertiesByCompanyIdResponse {
+export interface IDeletePropertyResponse {
+    message?: string;
 }
-export interface UpdatePropertyAccessInformationRequest {
+export interface IUpdatePropertyAccessInformationRequest extends Partial<IPropertyAccessInformation> {
+    propertyId: string;
 }
-export interface UpdatePropertyAccessInformationResponse {
+export interface IUpdatePropertyAccessInformationResponse {
+    propertyAccessInformation: IPropertyAccessInformation;
 }
-export interface GetPropertyAccessInformationRequest {
+export interface IGetPropertyAccessInformationRequest {
+    propertyId: string;
 }
-export interface GetPropertyAccessInformationResponse {
+export interface IGetPropertyAccessInformationResponse {
+    propertyAccessInformation: IPropertyAccessInformation | null;
+}
+export interface IGetPropertyByIdResponse extends IGetPropertyResponse {
+}
+export interface IGetPropertiesByCompanyIdRequest extends IGetPropertiesRequest {
+}
+export interface IGetPropertiesByCompanyIdResponse extends IGetPropertiesResponse {
 }

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,16 @@
-export interface CreateRoomRequest {
+export interface ICreateRoomRequest {
 }
-export interface CreateRoomResponse {
+export interface ICreateRoomResponse {
 }
-export interface GetRoomsByPropertyIdRequest {
+export interface IGetRoomsByPropertyIdRequest {
 }
-export interface GetRoomsByPropertyIdResponse {
+export interface IGetRoomsByPropertyIdResponse {
 }
-export interface UpdateRoomRequest {
+export interface IUpdateRoomRequest {
 }
-export interface UpdateRoomResponse {
+export interface IUpdateRoomResponse {
 }
-export interface DeleteRoomRequest {
+export interface IDeleteRoomRequest {
 }
-export interface DeleteRoomResponse {
+export interface IDeleteRoomResponse {
 }