@turndown/library 0.1.64 → 0.1.65

package/dist/index-CzB45yLv.d.ts

@@ -0,0 +1,334 @@
+/**
+ * Pagination metadata for a paginated response.
+ */
+interface IPagingResult {
+    hasNextPage: boolean;
+    totalPages: number;
+    totalRecords: number;
+}
+/**
+ * Generic wrapper for paginated data.
+ */
+interface IDataWithPagingResult<TData> {
+    data: TData;
+    pagination: IPagingResult;
+}
+declare const SortDirection: {
+    readonly Asc: "Asc";
+    readonly Desc: "Desc";
+};
+type TSortDirection = (typeof SortDirection)[keyof typeof SortDirection];
+/**
+ * Sorting condition for query results.
+ */
+interface ISortCondition {
+    name: string;
+    direction: TSortDirection;
+}
+declare const FilterCondition: {
+    readonly Equal: "=";
+    readonly GreaterThan: ">";
+    readonly LessThan: "<";
+    readonly NotEqual: "!=";
+    readonly Like: "LIKE";
+    readonly In: "IN";
+    readonly GreaterThanOrEqual: ">=";
+    readonly LessThanOrEqual: "<=";
+};
+type TFilterCondition = (typeof FilterCondition)[keyof typeof FilterCondition];
+interface IFilterConditionBase {
+    name: string;
+    condition: TFilterCondition;
+    useAnd?: boolean;
+}
+interface IStringFilterCondition extends IFilterConditionBase {
+    valueString: string;
+    valueNumber?: never;
+    valueBoolean?: never;
+}
+interface INumberFilterCondition extends IFilterConditionBase {
+    valueString?: never;
+    valueNumber: number;
+    valueBoolean?: never;
+}
+interface IBooleanFilterCondition extends IFilterConditionBase {
+    valueString?: never;
+    valueNumber?: never;
+    valueBoolean: boolean;
+}
+/**
+ * Filter condition for querying data.
+ *
+ * Exactly one value field should be provided.
+ */
+type TFilterConditionValue = IStringFilterCondition | INumberFilterCondition | IBooleanFilterCondition;
+/**
+ * Kept as an exported alias to preserve the existing public API name.
+ */
+type IFilterCondition = TFilterConditionValue;
+/**
+ * Request shape for paginated data with optional sorting and filtering.
+ */
+interface IPaginationRequest {
+    page: number;
+    size: number;
+    sort?: ISortCondition[];
+    filters?: IFilterCondition[];
+}
+interface IPagingObject {
+    pagination: IPaginationRequest;
+}
+declare const createPagingObject: (page: number, size: number, sort?: ISortCondition[], filters?: IFilterCondition[]) => IPagingObject;
+
+type TJsonPrimitive = string | number | boolean | null;
+type TJsonObject = {
+    [key: string]: TJsonValue;
+};
+type TJsonValue = TJsonPrimitive | TJsonValue[] | TJsonObject;
+type TUnknownRecord = Record<string, unknown>;
+/**
+ * Serialized ISO-8601 date/time value returned by API JSON contracts.
+ */
+type TDateTimeString = string;
+type TurndownObject<TObject extends object = TUnknownRecord> = TObject;
+type TEmptyObject = Record<string, never>;
+type IEmptyRouteRequest = TEmptyObject;
+type IEmptyRouteParams = TEmptyObject;
+declare const ENVIRONMENT: {
+    readonly Prod: "Prod";
+    readonly Dev: "Dev";
+    readonly Local: "Local";
+    readonly Test: "Test";
+};
+type TEnvironment = (typeof ENVIRONMENT)[keyof typeof ENVIRONMENT];
+interface IMessageResponse {
+    message: string;
+}
+interface ISuccessResponse {
+    success: boolean;
+}
+interface ICountResponse {
+    count: number;
+}
+interface IMetaData {
+    createdAt: TDateTimeString;
+    updatedAt: TDateTimeString;
+    deletedAt: TDateTimeString | null;
+}
+type TRecordValue<TRecord extends object> = TRecord[keyof TRecord];
+type TRecordKeys<TRecord extends object> = keyof TRecord;
+interface IVersion {
+    major: number;
+    minor: number;
+    patch: number;
+}
+type TVersionInput = string | IVersion;
+interface ISelectOption<TValue extends string = string> {
+    label: string;
+    value: TValue;
+}
+declare const MODE: {
+    readonly Create: "Create";
+    readonly Edit: "Edit";
+    readonly Delete: "Delete";
+    readonly Details: "Details";
+};
+type TMode = TRecordValue<typeof MODE> | null;
+declare const IMAGE_ENTITY: {
+    readonly USER_PROFILE: "USER_PROFILE";
+    readonly PROPERTY: "PROPERTY";
+    readonly COMPANY: "COMPANY";
+    readonly CHECKLIST_ITEM: "CHECKLIST_ITEM";
+    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";
+};
+type TImageEntityType = TRecordValue<typeof IMAGE_ENTITY>;
+type TUSStateCode = TRecordKeys<typeof US_JURISDICTIONS>;
+declare const US_JURISDICTIONS: {
+    readonly AL: "Alabama";
+    readonly AK: "Alaska";
+    readonly AZ: "Arizona";
+    readonly AR: "Arkansas";
+    readonly CA: "California";
+    readonly CO: "Colorado";
+    readonly CT: "Connecticut";
+    readonly DE: "Delaware";
+    readonly FL: "Florida";
+    readonly GA: "Georgia";
+    readonly HI: "Hawaii";
+    readonly ID: "Idaho";
+    readonly IL: "Illinois";
+    readonly IN: "Indiana";
+    readonly IA: "Iowa";
+    readonly KS: "Kansas";
+    readonly KY: "Kentucky";
+    readonly LA: "Louisiana";
+    readonly ME: "Maine";
+    readonly MD: "Maryland";
+    readonly MA: "Massachusetts";
+    readonly MI: "Michigan";
+    readonly MN: "Minnesota";
+    readonly MS: "Mississippi";
+    readonly MO: "Missouri";
+    readonly MT: "Montana";
+    readonly NE: "Nebraska";
+    readonly NV: "Nevada";
+    readonly NH: "New Hampshire";
+    readonly NJ: "New Jersey";
+    readonly NM: "New Mexico";
+    readonly NY: "New York";
+    readonly NC: "North Carolina";
+    readonly ND: "North Dakota";
+    readonly OH: "Ohio";
+    readonly OK: "Oklahoma";
+    readonly OR: "Oregon";
+    readonly PA: "Pennsylvania";
+    readonly RI: "Rhode Island";
+    readonly SC: "South Carolina";
+    readonly SD: "South Dakota";
+    readonly TN: "Tennessee";
+    readonly TX: "Texas";
+    readonly UT: "Utah";
+    readonly VT: "Vermont";
+    readonly VA: "Virginia";
+    readonly WA: "Washington";
+    readonly WV: "West Virginia";
+    readonly WI: "Wisconsin";
+    readonly WY: "Wyoming";
+    readonly DC: "District of Columbia";
+    readonly PR: "Puerto Rico";
+    readonly GU: "Guam";
+    readonly VI: "United States Virgin Islands";
+    readonly AS: "American Samoa";
+    readonly MP: "Northern Mariana Islands";
+};
+type TUSJurisdiction = TRecordValue<typeof US_JURISDICTIONS>;
+declare const STATUS: {
+    readonly PENDING: "PENDING";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly COMPLETED: "COMPLETED";
+    readonly OVERDUE: "OVERDUE";
+    readonly ACTIVE: "ACTIVE";
+    readonly INACTIVE: "INACTIVE";
+};
+type TStatus = TRecordValue<typeof STATUS>;
+declare const SEVERITY: {
+    readonly LOW: "LOW";
+    readonly MEDIUM: "MEDIUM";
+    readonly HIGH: "HIGH";
+};
+type TSeverity = TRecordValue<typeof SEVERITY>;
+declare const SERVICE_TYPES: {
+    readonly PROPERTY: "PROPERTY";
+    readonly CLEANING: "CLEANING";
+    readonly MAINTENANCE: "MAINTENANCE";
+    readonly INSPECTION: "INSPECTION";
+    readonly OTHER: "OTHER";
+};
+type TServiceType = TRecordValue<typeof SERVICE_TYPES>;
+declare const MONTHS: readonly ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"];
+type TMonths = (typeof MONTHS)[number];
+declare const WEEK_DAY: {
+    readonly Sunday: "Sunday";
+    readonly Monday: "Monday";
+    readonly Tuesday: "Tuesday";
+    readonly Wednesday: "Wednesday";
+    readonly Thursday: "Thursday";
+    readonly Friday: "Friday";
+    readonly Saturday: "Saturday";
+};
+type TWeekDay = TRecordValue<typeof WEEK_DAY>;
+declare const WEEK_DAY_SHORT_LABEL: {
+    readonly Sunday: "Sun";
+    readonly Monday: "Mon";
+    readonly Tuesday: "Tue";
+    readonly Wednesday: "Wed";
+    readonly Thursday: "Thu";
+    readonly Friday: "Fri";
+    readonly Saturday: "Sat";
+};
+type TWeekDayShortLabel = TRecordValue<typeof WEEK_DAY_SHORT_LABEL>;
+declare const WEEK_DAY_LETTER: {
+    readonly Sunday: "S";
+    readonly Monday: "M";
+    readonly Tuesday: "T";
+    readonly Wednesday: "W";
+    readonly Thursday: "T";
+    readonly Friday: "F";
+    readonly Saturday: "S";
+};
+type TWeekDayLetter = TRecordValue<typeof WEEK_DAY_LETTER>;
+interface IWeekDay {
+    date: Date;
+    dayOfMonth: number;
+    day: TWeekDay;
+    shortLabel: TWeekDayShortLabel;
+    letter: TWeekDayLetter;
+    isToday: boolean;
+}
+declare const UnitedStatesJurisdictionOptions: ISelectOption<TRecordValue<{
+    readonly AL: "Alabama";
+    readonly AK: "Alaska";
+    readonly AZ: "Arizona";
+    readonly AR: "Arkansas";
+    readonly CA: "California";
+    readonly CO: "Colorado";
+    readonly CT: "Connecticut";
+    readonly DE: "Delaware";
+    readonly FL: "Florida";
+    readonly GA: "Georgia";
+    readonly HI: "Hawaii";
+    readonly ID: "Idaho";
+    readonly IL: "Illinois";
+    readonly IN: "Indiana";
+    readonly IA: "Iowa";
+    readonly KS: "Kansas";
+    readonly KY: "Kentucky";
+    readonly LA: "Louisiana";
+    readonly ME: "Maine";
+    readonly MD: "Maryland";
+    readonly MA: "Massachusetts";
+    readonly MI: "Michigan";
+    readonly MN: "Minnesota";
+    readonly MS: "Mississippi";
+    readonly MO: "Missouri";
+    readonly MT: "Montana";
+    readonly NE: "Nebraska";
+    readonly NV: "Nevada";
+    readonly NH: "New Hampshire";
+    readonly NJ: "New Jersey";
+    readonly NM: "New Mexico";
+    readonly NY: "New York";
+    readonly NC: "North Carolina";
+    readonly ND: "North Dakota";
+    readonly OH: "Ohio";
+    readonly OK: "Oklahoma";
+    readonly OR: "Oregon";
+    readonly PA: "Pennsylvania";
+    readonly RI: "Rhode Island";
+    readonly SC: "South Carolina";
+    readonly SD: "South Dakota";
+    readonly TN: "Tennessee";
+    readonly TX: "Texas";
+    readonly UT: "Utah";
+    readonly VT: "Vermont";
+    readonly VA: "Virginia";
+    readonly WA: "Washington";
+    readonly WV: "West Virginia";
+    readonly WI: "Wisconsin";
+    readonly WY: "Wyoming";
+    readonly DC: "District of Columbia";
+    readonly PR: "Puerto Rico";
+    readonly GU: "Guam";
+    readonly VI: "United States Virgin Islands";
+    readonly AS: "American Samoa";
+    readonly MP: "Northern Mariana Islands";
+}>>[];
+declare const StatusOptions: ISelectOption<TStatus>[];
+declare const SeverityOptions: ISelectOption<TSeverity>[];
+declare const ServiceTypeOptions: ISelectOption<TServiceType>[];
+
+export { type TWeekDayLetter as $, type TEmptyObject as A, type TEnvironment as B, type TFilterCondition as C, type TFilterConditionValue as D, ENVIRONMENT as E, FilterCondition as F, type TImageEntityType as G, type TJsonObject as H, type IBooleanFilterCondition as I, type TJsonPrimitive as J, type TJsonValue as K, type TMode as L, MODE as M, type TMonths as N, type TRecordKeys as O, type TRecordValue as P, type TServiceType as Q, type TSeverity as R, SERVICE_TYPES as S, type TDateTimeString as T, type TSortDirection as U, type TStatus as V, type TUSJurisdiction as W, type TUSStateCode as X, type TUnknownRecord as Y, type TVersionInput as Z, type TWeekDay as _, type ICountResponse as a, type TWeekDayShortLabel as a0, type TurndownObject as a1, US_JURISDICTIONS as a2, UnitedStatesJurisdictionOptions as a3, WEEK_DAY as a4, WEEK_DAY_LETTER as a5, WEEK_DAY_SHORT_LABEL as a6, createPagingObject as a7, type IDataWithPagingResult as b, type IEmptyRouteParams as c, type IEmptyRouteRequest as d, type IFilterCondition as e, type IFilterConditionBase as f, IMAGE_ENTITY as g, type IMessageResponse as h, type IMetaData as i, type INumberFilterCondition as j, type IPaginationRequest as k, type IPagingObject as l, type IPagingResult as m, type ISelectOption as n, type ISortCondition as o, type IStringFilterCondition as p, type ISuccessResponse as q, type IVersion as r, type IWeekDay as s, MONTHS as t, SEVERITY as u, STATUS as v, ServiceTypeOptions as w, SeverityOptions as x, SortDirection as y, StatusOptions as z };