@turndown/library 0.1.16 → 0.1.22

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,85 @@
-export interface CreateTemplateRequest {
+import type { IChecklistTemplate, IChecklistTemplateItem, IChecklistTemplateWithItems, ICreateTemplateInput, ICreateTemplateItemInput } from ".";
+import type { ICountResponse, IMessageResponse } from "../base";
+export interface IChecklistTemplateCompanyRouteParams {
+    companyId: string;
 }
-export interface CreateTemplateResponse {
+export interface ITemplateIdParams {
+    templateId: string;
 }
-export interface CreateTemplateWithItemsRequest {
+export interface ITemplateItemIdParams {
+    itemId: string;
 }
-export interface CreateTemplateWithItemsResponse {
+export interface ITemplateAndItemIdParams {
+    templateId: string;
+    itemId: string;
 }
-export interface GetTemplatesByCompanyIdRequest {
+export interface IIncludeInactiveQuery {
+    includeInactive?: string;
 }
-export interface GetTemplatesByCompanyIdResponse {
+export interface ICreateTemplateRequest extends Partial<Omit<ICreateTemplateInput, "companyId" | "createdBy">> {
+    name: string;
 }
-export interface GetTemplateByIdRequest {
+export interface ICreateTemplateResponse extends IChecklistTemplate {
 }
-export interface GetTemplateByIdResponse {
+export interface ICreateTemplateWithItemsRequest extends ICreateTemplateInput {
+    items: ICreateTemplateItemInput[];
 }
-export interface GetTemplateWithItemsRequest {
+export interface ICreateTemplateWithItemsResponse extends IChecklistTemplateWithItems {
 }
-export interface GetTemplateWithItemsResponse {
+export interface IGetTemplatesByCompanyIdRequest extends IChecklistTemplateCompanyRouteParams {
 }
-export interface UpdateTemplateRequest {
+export type IGetTemplatesByCompanyIdResponse = IChecklistTemplate[];
+export interface IGetTemplateByIdRequest extends ITemplateIdParams {
 }
-export interface UpdateTemplateResponse {
+export interface IGetTemplateByIdResponse extends IChecklistTemplate {
 }
-export interface DeleteTemplateRequest {
+export interface IGetTemplateWithItemsRequest extends ITemplateIdParams {
 }
-export interface DeleteTemplateResponse {
+export interface IGetTemplateWithItemsResponse extends IChecklistTemplateWithItems {
 }
-export interface ToggleTemplateActiveRequest {
+export interface IUpdateTemplateRequest extends Partial<ICreateTemplateInput> {
 }
-export interface ToggleTemplateActiveResponse {
+export interface IUpdateTemplateResponse extends IChecklistTemplate {
 }
-export interface GetTemplateUsageRequest {
+export interface IDeleteTemplateRequest extends ITemplateIdParams {
 }
-export interface GetTemplateUsageResponse {
+export interface IDeleteTemplateResponse extends IMessageResponse {
 }
-export interface GetTemplateItemsRequest {
+export interface IToggleTemplateActiveRequest {
+    isActive: boolean;
 }
-export interface GetTemplateItemsResponse {
+export interface IToggleTemplateActiveResponse extends IChecklistTemplate {
 }
-export interface AddTemplateItemRequest {
+export interface IGetTemplateUsageRequest extends ITemplateIdParams {
 }
-export interface AddTemplateItemResponse {
+export interface IGetTemplateUsageResponse extends ICountResponse {
 }
-export interface UpdateTemplateItemRequest {
+export interface IGetTemplateItemsRequest extends ITemplateIdParams {
 }
-export interface UpdateTemplateItemResponse {
+export type IGetTemplateItemsResponse = IChecklistTemplateItem[];
+export interface IAddTemplateItemRequest extends ICreateTemplateItemInput {
+    title: string;
 }
-export interface DeleteTemplateItemRequest {
+export interface IAddTemplateItemResponse extends IChecklistTemplateItem {
 }
-export interface DeleteTemplateItemResponse {
+export interface IUpdateTemplateItemRequest extends Partial<ICreateTemplateItemInput> {
 }
-export interface ReorderTemplateItemsRequest {
+export interface IUpdateTemplateItemResponse extends IChecklistTemplateItem {
 }
-export interface ReorderTemplateItemsResponse {
+export interface IDuplicateTemplateItemRequest extends ITemplateItemIdParams {
+}
+export interface IDuplicateTemplateItemResponse extends IChecklistTemplateItem {
+}
+export interface IDeleteTemplateItemRequest extends ITemplateItemIdParams {
+}
+export interface IDeleteTemplateItemResponse extends IMessageResponse {
+}
+export interface ITemplateItemOrder {
+    itemId: string;
+    displayOrder: number;
+}
+export interface IReorderTemplateItemsRequest {
+    itemOrders: ITemplateItemOrder[];
+}
+export interface IReorderTemplateItemsResponse extends IMessageResponse {
 }

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

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

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,100 @@
-import { Company, CompanyType } from ".";
-import { AccountType } from "../user";
-export interface CreateCompanyRequest {
+import type { ICompany, TCompanyType } from ".";
+import type { IMessageResponse } from "../base";
+import type { TAccountType } from "../user";
+export interface ICompanyRouteParams {
+    companyId: string;
+}
+export interface ICompanyUserRouteParams {
+    userId: string;
+}
+export interface ICompanyInvitationTokenParams {
+    token: string;
+}
+export interface ICompanyInvitationIdParams extends ICompanyRouteParams {
+    invitationId: string;
+}
+export interface IGetCompaniesQuery {
+    search?: string;
+    filter?: "active" | "pending" | "all";
+}
+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 extends ICompany {
 }
-export interface GetCompanyByIdRequest {
+export interface IGetCompaniesRequest {
 }
-export interface GetCompanyByIdResponse {
-    company: Company;
+export type IGetCompaniesResponse = ICompany[];
+export interface IGetCompanyByIdRequest extends ICompanyRouteParams {
 }
-export interface UpdateCompanyRequest {
-    companyId: string;
-    company: Partial<Company>;
+export interface IGetCompanyByIdResponse extends ICompany {
 }
-export interface UpdateCompanyResponse {
-    company: Company;
+export interface IUpdateCompanyRequest extends Partial<ICompany> {
 }
-export interface InviteUserToCompanyRequest {
-    companyId: string;
+export interface IUpdateCompanyResponse extends ICompany {
+}
+export interface IInviteUserToCompanyRequest {
     email: string;
-    role: AccountType;
-    userId: string;
+    role: TAccountType;
+}
+export interface IInviteUserToCompanyResponse extends IMessageResponse {
+}
+export interface IGetCompanyUsersRequest extends ICompanyRouteParams {
+}
+export interface ICompanyUserSummary {
+    id: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    role: TAccountType;
+}
+export type IGetCompanyUsersResponse = Array<ICompany & ICompanyUserSummary>;
+export interface IGetUserCompaniesRequest extends ICompanyUserRouteParams {
+}
+export type IGetUserCompaniesResponse = ICompany[];
+export interface IInviteCompanyToCompanyRequest {
+    message?: string;
+}
+export interface IInviteCompanyToCompanyResponse {
+    id: string;
+    token: string;
+    expiresAt: Date | string;
+}
+export interface IValidateCompanyInvitationRequest extends ICompanyInvitationTokenParams {
+}
+export interface IValidateCompanyInvitationResponse {
+    id: string;
+    requesterCompanyId: string;
+    providerCompanyId: string;
+    invitedBy: string;
+    message?: string | null;
+    expiresAt: Date | string;
+    requesterCompanyName: string;
+    providerCompanyName: string;
+    invitedByName: string;
+}
+export interface IAcceptCompanyInvitationRequest extends ICompanyInvitationTokenParams {
+}
+export interface IAcceptCompanyInvitationResponse {
+    requesterCompanyId: string;
+    providerCompanyId: string;
+    requesterCompanyName: string;
+    providerCompanyName: string;
 }
-export interface InviteUserToCompanyResponse {
-    message: string;
+export interface IDeclineCompanyInvitationRequest extends ICompanyInvitationTokenParams {
 }
-export interface GetCompanyUsersRequest {
+export interface IDeclineCompanyInvitationResponse extends IMessageResponse {
 }
-export interface GetCompanyUsersResponse {
-    company: Partial<Company>;
-    users: {
-        id: string;
-        email: string;
-        firstName: string;
-        lastName: string;
-        role: AccountType;
-    }[];
+export interface IGetPendingCompanyInvitationsRequest extends ICompanyRouteParams {
 }
-export interface GetUserCompaniesRequest {
+export type IGetPendingCompanyInvitationsResponse = IValidateCompanyInvitationResponse[];
+export interface IRevokeCompanyInvitationRequest extends ICompanyInvitationIdParams {
 }
-export interface GetUserCompaniesResponse {
-    companies: Company[];
+export interface IRevokeCompanyInvitationResponse extends IMessageResponse {
 }

package/dist/types/company/routes.js

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

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 = "LOW" | "MEDIUM" | "HIGH" | "CRITICAL";
+export type TDamageStatus = "OPEN" | "IN_REVIEW" | "ASSIGNED" | "IN_PROGRESS" | "RESOLVED" | "CLOSED" | "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;