@turndown/library 0.1.16 → 0.1.20

package/dist/types/base/index.js

@@ -65,4 +65,120 @@ export const US_STATES_CODE = {
     AS: "AS",
     MP: "MP",
 };
+export const UNITED_STATES_JURISDICTIONS = {
+    Alabama: "Alabama",
+    Alaska: "Alaska",
+    AmericanSamoa: "American Samoa",
+    Arizona: "Arizona",
+    Arkansas: "Arkansas",
+    BakerIsland: "Baker Island",
+    California: "California",
+    Colorado: "Colorado",
+    Connecticut: "Connecticut",
+    Delaware: "Delaware",
+    DistrictOfColumbia: "District of Columbia",
+    Florida: "Florida",
+    Georgia: "Georgia",
+    Guam: "Guam",
+    Hawaii: "Hawaii",
+    HowlandIsland: "Howland Island",
+    Idaho: "Idaho",
+    Illinois: "Illinois",
+    Indiana: "Indiana",
+    Iowa: "Iowa",
+    JarvisIsland: "Jarvis Island",
+    JohnstonAtoll: "Johnston Atoll",
+    Kansas: "Kansas",
+    Kentucky: "Kentucky",
+    KingmanReef: "Kingman Reef",
+    Louisiana: "Louisiana",
+    Maine: "Maine",
+    Maryland: "Maryland",
+    Massachusetts: "Massachusetts",
+    Michigan: "Michigan",
+    MidwayAtoll: "Midway Atoll",
+    Minnesota: "Minnesota",
+    Mississippi: "Mississippi",
+    Missouri: "Missouri",
+    Montana: "Montana",
+    NavassaIsland: "Navassa Island",
+    Nebraska: "Nebraska",
+    Nevada: "Nevada",
+    NewHampshire: "New Hampshire",
+    NewJersey: "New Jersey",
+    NewMexico: "New Mexico",
+    NewYork: "New York",
+    NorthCarolina: "North Carolina",
+    NorthDakota: "North Dakota",
+    NorthernMarianaIslands: "Northern Mariana Islands",
+    Ohio: "Ohio",
+    Oklahoma: "Oklahoma",
+    Oregon: "Oregon",
+    PalmyraAtoll: "Palmyra Atoll",
+    Pennsylvania: "Pennsylvania",
+    PuertoRico: "Puerto Rico",
+    RhodeIsland: "Rhode Island",
+    SouthCarolina: "South Carolina",
+    SouthDakota: "South Dakota",
+    Tennessee: "Tennessee",
+    Texas: "Texas",
+    UnitedStatesVirginIslands: "United States Virgin Islands",
+    Utah: "Utah",
+    Vermont: "Vermont",
+    Virginia: "Virginia",
+    WakeIsland: "Wake Island",
+    Washington: "Washington",
+    WestVirginia: "West Virginia",
+    Wisconsin: "Wisconsin",
+    Wyoming: "Wyoming",
+};
+export const UnitedStatesJurisdictionOptions = Object.values(UNITED_STATES_JURISDICTIONS).map((jurisdiction) => ({
+    label: jurisdiction,
+    value: jurisdiction,
+}));
+export const STATUS = {
+    Pending: "Pending",
+    InProgress: "InProgress",
+    Completed: "Completed",
+    Overdue: "Overdue",
+    Active: "Active",
+    Inactive: "Inactive",
+};
+export const StatusOptions = Object.values(STATUS).map((status) => ({
+    label: status,
+    value: status,
+}));
+export const SEVERITY = {
+    Low: "Low",
+    Medium: "Medium",
+    High: "High",
+};
+export const SeverityOptions = Object.values(SEVERITY).map((severity) => ({
+    label: severity,
+    value: severity,
+}));
+export const SERVICE_TYPES = {
+    Cleaning: "Cleaning",
+    Maintenance: "Maintenance",
+    Inspection: "Inspections",
+    Other: "Other",
+};
+export const ServiceTypeOptions = Object.values(SERVICE_TYPES).map((serviceType) => ({
+    label: serviceType,
+    value: serviceType,
+}));
+export const MONTHS = [
+    "January",
+    "February",
+    "March",
+    "April",
+    "May",
+    "June",
+    "July",
+    "August",
+    "September",
+    "October",
+    "November",
+    "December",
+];
 export * from "./paging.types";

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

@@ -1,7 +1,7 @@
 /**
- * Represents the pagination metadata for a paginated response.
+ * Represents the pagination IMetaData for a paginated response.
  */
-export interface PagingResult {
+export interface IPagingResult {
     hasNextPage: boolean;
     totalPages: number;
     totalRecords: number;
@@ -10,14 +10,14 @@ export interface PagingResult {
  * A generic wrapper that combines data with pagination information.
  * @template T - The type of data being paginated
  */
-export interface DataWithPagingResult<T> {
+export interface IDataWithPagingResult<T> {
     data: T;
-    pagination: PagingResult;
+    pagination: IPagingResult;
 }
 /**
  * Defines a sorting condition for query results.
  */
-export interface SortCondition {
+export interface ISortCondition {
     name: string;
     direction: "ASC" | "DESC";
 }
@@ -25,7 +25,7 @@ export interface SortCondition {
  * Defines a filter condition for querying data.
  * Only one of valueString, valueNumber, or valueBoolean should be provided based on the field type.
  */
-export interface FilterCondition {
+export interface IFilterCondition {
     name: string;
     condition: "=" | ">" | "<" | "!=" | "LIKE" | "IN" | ">=" | "<=";
     valueString?: string;
@@ -36,12 +36,12 @@ export interface FilterCondition {
 /**
  * Represents a request for paginated data with optional sorting and filtering.
  */
-export interface PaginationRequest {
+export interface IPaginationRequest {
     page: number;
     size: number;
-    sort?: SortCondition[];
-    filters?: FilterCondition[];
+    sort?: ISortCondition[];
+    filters?: IFilterCondition[];
 }
-export declare const createPagingObject: (page: number, size: number, sort?: SortCondition[], filters?: FilterCondition[]) => {
-    pagination: any;
+export declare const createPagingObject: (page: number, size: number, sort?: ISortCondition[], filters?: IFilterCondition[]) => {
+    pagination: IPaginationRequest;
 };

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

@@ -1,15 +1,15 @@
-import { MetaData } from "../index";
+import { IMetaData } from "../index";
 export * from "./routes";
-export interface ChecklistTemplate extends MetaData {
+export interface IChecklistTemplate extends IMetaData {
     id: string;
     name: string;
     description?: string;
     companyId: string;
     createdBy: string;
     isActive: boolean;
-    items: ChecklistTemplateItem[];
+    items: IChecklistTemplateItem[];
 }
-export interface ChecklistTemplateItem extends MetaData {
+export interface IChecklistTemplateItem extends IMetaData {
     id: string;
     templateId: string;
     title: string;
@@ -22,13 +22,13 @@ export interface ChecklistTemplateItem extends MetaData {
 /**
  * Template with items
  */
-export interface ChecklistTemplateWithItems extends ChecklistTemplate {
-    items: ChecklistTemplateItem[];
+export interface IChecklistTemplateWithItems extends IChecklistTemplate {
+    items: IChecklistTemplateItem[];
 }
 /**
  * Input for creating a template
  */
-export interface CreateTemplateInput {
+export interface ICreateTemplateInput {
     name: string;
     description?: string;
     companyId: string;
@@ -38,7 +38,7 @@ export interface CreateTemplateInput {
 /**
  * Input for creating template items
  */
-export interface CreateTemplateItemInput {
+export interface ICreateTemplateItemInput {
     title: string;
     description?: string;
     displayOrder: number;

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

@@ -1,56 +1,56 @@
-export interface CreateTemplateRequest {
+export interface ICreateTemplateRequest {
 }
-export interface CreateTemplateResponse {
+export interface ICreateTemplateResponse {
 }
-export interface CreateTemplateWithItemsRequest {
+export interface ICreateTemplateWithItemsRequest {
 }
-export interface CreateTemplateWithItemsResponse {
+export interface ICreateTemplateWithItemsResponse {
 }
-export interface GetTemplatesByCompanyIdRequest {
+export interface IGetTemplatesByCompanyIdRequest {
 }
-export interface GetTemplatesByCompanyIdResponse {
+export interface IGetTemplatesByCompanyIdResponse {
 }
-export interface GetTemplateByIdRequest {
+export interface IGetTemplateByIdRequest {
 }
-export interface GetTemplateByIdResponse {
+export interface IGetTemplateByIdResponse {
 }
-export interface GetTemplateWithItemsRequest {
+export interface IGetTemplateWithItemsRequest {
 }
-export interface GetTemplateWithItemsResponse {
+export interface IGetTemplateWithItemsResponse {
 }
-export interface UpdateTemplateRequest {
+export interface IUpdateTemplateRequest {
 }
-export interface UpdateTemplateResponse {
+export interface IUpdateTemplateResponse {
 }
-export interface DeleteTemplateRequest {
+export interface IDeleteTemplateRequest {
 }
-export interface DeleteTemplateResponse {
+export interface IDeleteTemplateResponse {
 }
-export interface ToggleTemplateActiveRequest {
+export interface IToggleTemplateActiveRequest {
 }
-export interface ToggleTemplateActiveResponse {
+export interface IToggleTemplateActiveResponse {
 }
-export interface GetTemplateUsageRequest {
+export interface IGetTemplateUsageRequest {
 }
-export interface GetTemplateUsageResponse {
+export interface IGetTemplateUsageResponse {
 }
-export interface GetTemplateItemsRequest {
+export interface IGetTemplateItemsRequest {
 }
-export interface GetTemplateItemsResponse {
+export interface IGetTemplateItemsResponse {
 }
-export interface AddTemplateItemRequest {
+export interface IAddTemplateItemRequest {
 }
-export interface AddTemplateItemResponse {
+export interface IAddTemplateItemResponse {
 }
-export interface UpdateTemplateItemRequest {
+export interface IUpdateTemplateItemRequest {
 }
-export interface UpdateTemplateItemResponse {
+export interface IUpdateTemplateItemResponse {
 }
-export interface DeleteTemplateItemRequest {
+export interface IDeleteTemplateItemRequest {
 }
-export interface DeleteTemplateItemResponse {
+export interface IDeleteTemplateItemResponse {
 }
-export interface ReorderTemplateItemsRequest {
+export interface IReorderTemplateItemsRequest {
 }
-export interface ReorderTemplateItemsResponse {
+export interface IReorderTemplateItemsResponse {
 }

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

@@ -1,13 +1,13 @@
-import { MetaData, ObjectValues, USStateCodeType } from "../index";
+import { IMetaData, TRecordValue, TUnitedStatesStateCode } from "../index";
 export * from "./routes";
-export interface Company extends MetaData {
+export interface ICompany extends IMetaData {
     id: string;
     displayName: string;
     addressLine1?: string;
     addressLine2?: string;
     city?: string;
-    stateCode?: USStateCodeType;
-    companyType: CompanyType;
+    stateCode?: TUnitedStatesStateCode;
+    companyType: TCompanyType;
     postalCode?: string;
     country?: string;
     timezone?: string;
@@ -19,4 +19,4 @@ export declare const COMPANY_TYPES: {
     readonly CLEANER: "CLEANER";
     readonly OTHER: "OTHER";
 };
-export type CompanyType = ObjectValues<typeof COMPANY_TYPES>;
+export type TCompanyType = TRecordValue<typeof COMPANY_TYPES>;

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

@@ -1,52 +1,52 @@
-import { Company, CompanyType } from ".";
-import { AccountType } from "../user";
-export interface CreateCompanyRequest {
+import { ICompany, TCompanyType } from ".";
+import { TAccountType } from "../user";
+export interface ICreateCompanyRequest {
     displayName: string;
     addressLine1?: string;
     addressLine2?: string;
     city?: string;
     stateCode?: string;
     postalCode?: string;
-    companyType: CompanyType;
+    companyType: TCompanyType;
 }
-export interface CreateCompanyResponse {
-    company: Company;
+export interface ICreateCompanyResponse {
+    company: ICompany;
 }
-export interface GetCompanyByIdRequest {
+export interface IGetCompanyByIdRequest {
 }
-export interface GetCompanyByIdResponse {
-    company: Company;
+export interface IGetCompanyByIdResponse {
+    company: ICompany;
 }
-export interface UpdateCompanyRequest {
+export interface IUpdateCompanyRequest {
     companyId: string;
-    company: Partial<Company>;
+    company: Partial<ICompany>;
 }
-export interface UpdateCompanyResponse {
-    company: Company;
+export interface IUpdateCompanyResponse {
+    company: ICompany;
 }
-export interface InviteUserToCompanyRequest {
+export interface IInviteUserToCompanyRequest {
     companyId: string;
     email: string;
-    role: AccountType;
+    role: TAccountType;
     userId: string;
 }
-export interface InviteUserToCompanyResponse {
+export interface IInviteUserToCompanyResponse {
     message: string;
 }
-export interface GetCompanyUsersRequest {
+export interface IGetCompanyUsersRequest {
 }
-export interface GetCompanyUsersResponse {
-    company: Partial<Company>;
+export interface IGetCompanyUsersResponse {
+    company: Partial<ICompany>;
     users: {
         id: string;
         email: string;
         firstName: string;
         lastName: string;
-        role: AccountType;
+        role: TAccountType;
     }[];
 }
-export interface GetUserCompaniesRequest {
+export interface IGetUserCompaniesRequest {
 }
-export interface GetUserCompaniesResponse {
-    companies: Company[];
+export interface IGetUserCompaniesResponse {
+    companies: ICompany[];
 }

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

@@ -1,14 +1,14 @@
 export * from "./routes";
-export type DamageSeverity = "MINOR" | "MODERATE" | "SEVERE" | "CRITICAL";
-export type DamageStatus = "OPEN" | "IN_REVIEW" | "RESOLVED" | "ESCALATED";
-export interface DamageReport {
+export type TDamageSeverity = "MINOR" | "MODERATE" | "SEVERE" | "CRITICAL";
+export type TDamageStatus = "OPEN" | "IN_REVIEW" | "RESOLVED" | "ESCALATED";
+export interface IDamageReport {
     id: string;
     propertyId: string;
     roomId: string;
     cleaningSessionId?: string;
     reportedBy: string;
-    severity: DamageSeverity;
-    status: DamageStatus;
+    severity: TDamageSeverity;
+    status: TDamageStatus;
     title: string;
     description: string;
     locationDetails?: string;
@@ -19,10 +19,10 @@ export interface DamageReport {
     resolvedBy?: string;
     resolutionNotes?: string;
     requiresProfessional: boolean;
-    photos: DamagePhoto[];
-    comments: DamageComment[];
+    photos: IDamagePhoto[];
+    comments: IDamageComment[];
 }
-export interface DamagePhoto {
+export interface IDamagePhoto {
     id: string;
     damageReportId: string;
     photoId: string;
@@ -31,7 +31,7 @@ export interface DamagePhoto {
     isBeforePhoto: boolean;
     displayOrder: number;
 }
-export interface DamageComment {
+export interface IDamageComment {
     id: string;
     damageReportId: string;
     userId: string;

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

@@ -1,76 +1,76 @@
-export interface CreateDamageReportRequest {
+export interface ICreateDamageReportRequest {
 }
-export interface CreateDamageReportResponse {
+export interface ICreateDamageReportResponse {
 }
-export interface GetDamageReportByIdRequest {
+export interface IGetDamageReportByIdRequest {
 }
-export interface GetDamageReportByIdResponse {
+export interface IGetDamageReportByIdResponse {
 }
-export interface UpdateDamageReportRequest {
+export interface IUpdateDamageReportRequest {
 }
-export interface UpdateDamageReportResponse {
+export interface IUpdateDamageReportResponse {
 }
-export interface UpdateDamageReportStatusRequest {
+export interface IUpdateDamageReportStatusRequest {
 }
-export interface UpdateDamageReportStatusResponse {
+export interface IUpdateDamageReportStatusResponse {
 }
-export interface AssignDamageReportRequest {
+export interface IAssignDamageReportRequest {
 }
-export interface AssignDamageReportResponse {
+export interface IAssignDamageReportResponse {
 }
-export interface ResolveDamageReportRequest {
+export interface IResolveDamageReportRequest {
 }
-export interface ResolveDamageReportResponse {
+export interface IResolveDamageReportResponse {
 }
-export interface GetDamageReportsByPropertyIdRequest {
+export interface IGetDamageReportsByPropertyIdRequest {
 }
-export interface GetDamageReportsByPropertyIdResponse {
+export interface IGetDamageReportsByPropertyIdResponse {
 }
-export interface GetDamageReportsByRoomIdRequest {
+export interface IGetDamageReportsByRoomIdRequest {
 }
-export interface GetDamageReportsByRoomIdResponse {
+export interface IGetDamageReportsByRoomIdResponse {
 }
-export interface GetDamageReportPhotosRequest {
+export interface IGetDamageReportPhotosRequest {
 }
-export interface GetDamageReportPhotosResponse {
+export interface IGetDamageReportPhotosResponse {
 }
-export interface AddDamageReportPhotoRequest {
+export interface IAddDamageReportPhotoRequest {
 }
-export interface AddDamageReportPhotoResponse {
+export interface IAddDamageReportPhotoResponse {
 }
-export interface GetDamageReportCommentsRequest {
+export interface IGetDamageReportCommentsRequest {
 }
-export interface GetDamageReportCommentsResponse {
+export interface IGetDamageReportCommentsResponse {
 }
-export interface AddDamageReportCommentRequest {
+export interface IAddDamageReportCommentRequest {
 }
-export interface AddDamageReportCommentResponse {
+export interface IAddDamageReportCommentResponse {
 }
-export interface GetDamageReportHistoryRequest {
+export interface IGetDamageReportHistoryRequest {
 }
-export interface GetDamageReportHistoryResponse {
+export interface IGetDamageReportHistoryResponse {
 }
-export interface CreateWorkOrderRequest {
+export interface ICreateWorkOrderRequest {
 }
-export interface CreateWorkOrderResponse {
+export interface ICreateWorkOrderResponse {
 }
-export interface GetWorkOrderByIdRequest {
+export interface IGetWorkOrderByIdRequest {
 }
-export interface GetWorkOrderByIdResponse {
+export interface IGetWorkOrderByIdResponse {
 }
-export interface UpdateWorkOrderRequest {
+export interface IUpdateWorkOrderRequest {
 }
-export interface UpdateWorkOrderResponse {
+export interface IUpdateWorkOrderResponse {
 }
-export interface AssignWorkOrderRequest {
+export interface IAssignWorkOrderRequest {
 }
-export interface AssignWorkOrderResponse {
+export interface IAssignWorkOrderResponse {
 }
-export interface CompleteWorkOrderRequest {
+export interface ICompleteWorkOrderRequest {
 }
-export interface CompleteWorkOrderResponse {
+export interface ICompleteWorkOrderResponse {
 }
-export interface GetWorkOrdersByPropertyIdRequest {
+export interface IGetWorkOrdersByPropertyIdRequest {
 }
-export interface GetWorkOrdersByPropertyIdResponse {
+export interface IGetWorkOrdersByPropertyIdResponse {
 }

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;