@turndown/library 0.1.16 → 0.1.22

package/dist/types/api/index.js

@@ -2,11 +2,18 @@
  * API Response Types
  * Standard response structure for all API endpoints
  */
+export const HTTP_METHOD = {
+    Get: "GET",
+    Post: "POST",
+    Put: "PUT",
+    Patch: "PATCH",
+    Delete: "DELETE",
+};
 /**
  * Error Codes
  * Standardized error codes used across the platform
  */
-export const ErrorCodes = {
+export const ERROR_CODES = {
     // 400 - Bad Request
     BAD_REQUEST: "BAD_REQUEST",
     VALIDATION_ERROR: "VALIDATION_ERROR",
@@ -32,7 +39,7 @@ export const ErrorCodes = {
  * HTTP Status Codes
  * Common status codes used in responses
  */
-export const HttpStatus = {
+export const HTTP_STATUS = {
     OK: 200,
     CREATED: 201,
     NO_CONTENT: 204,

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

@@ -1,40 +1,78 @@
 export * from "./routes";
-/**
- * Authentication Types
- * Request/Response types for authentication endpoints
- */
-import { UserSafe } from "../user";
+import type { TServiceType } from "../base";
+import type { IUserSafe } from "../user";
+export declare const AUTH_STATUS: {
+    readonly Initializing: "Initializing";
+    readonly Unauthenticated: "Unauthenticated";
+    readonly Authenticated: "Authenticated";
+    readonly Refreshing: "Refreshing";
+    readonly SessionExpired: "SessionExpired";
+};
+export type TAuthStatus = (typeof AUTH_STATUS)[keyof typeof AUTH_STATUS];
 /**
  * Token Payload
  * JWT token payload structure
  */
-export interface TokenPayload {
+export interface ITokenPayload {
     userId: string;
     email: string;
     name: string;
 }
-export interface RefreshTokenData {
+export interface IRefreshTokenData {
     token: string;
     tokenHash: string;
     tokenFamily: string;
     expiresAt: string;
 }
-/**
- * Auth Token Response
- * Standard structure for authentication responses with tokens
- */
-export interface AuthTokenResponse {
-    user: UserSafe;
+export interface IAuthTokenResponse {
+    user: IUserSafe;
     accessToken: string;
     refreshToken: string;
-    expiresAt: string;
+    expiresAt?: string | null;
     companyId?: string;
 }
+export interface IStoredAuthSession {
+    accessToken: string | null;
+    refreshToken: string | null;
+    expiresAt?: string | null;
+}
+export interface IAuthTokens {
+    accessToken: string | null;
+    /**
+     * For browser apps, prefer storing the refresh token in an HTTP-only cookie.
+     * Keep this optional so the same shape can support mobile or non-cookie flows.
+     */
+    refreshToken?: string | null;
+    expiresAt?: string | null;
+}
+export interface IAuthSession {
+    authenticatedUser: IUserSafe | null;
+    accessToken: string | null;
+    expiresAt?: string | null;
+}
+export interface ISetAuthSessionParams {
+    user: IUserSafe | null;
+    accessToken: string;
+    refreshToken: string;
+    expiresAt?: string | null;
+}
+export interface ILoginCredentials {
+    email: string;
+    password: string;
+    rememberMe: boolean;
+}
+export interface IRegisterCredentials {
+    businessType: TServiceType[];
+    firstName: string;
+    lastName: string;
+    email: string;
+    password: string;
+}
 /**
  * Password Validation Rules
  * Rules for password validation
  */
-export interface PasswordValidationRules {
+export interface IPasswordValidationRules {
     minLength: number;
     requireUppercase: boolean;
     requireLowercase: boolean;
@@ -45,7 +83,7 @@ export interface PasswordValidationRules {
  * Password Validation Result
  * Result of password validation
  */
-export interface PasswordValidationResult {
+export interface IPasswordValidationResult {
     valid: boolean;
     errors: string[];
 }
@@ -53,7 +91,7 @@ export interface PasswordValidationResult {
  * Email Validation Result
  * Result of email validation
  */
-export interface EmailValidationResult {
+export interface IEmailValidationResult {
     valid: boolean;
     error?: string;
 }
@@ -61,7 +99,7 @@ export interface EmailValidationResult {
  * Rate Limit Status
  * Information about rate limiting status
  */
-export interface RateLimitStatus {
+export interface IRateLimitStatus {
     isLimited: boolean;
     attempts: number;
     maxAttempts: number;

package/dist/types/auth/index.js

@@ -1 +1,8 @@
 export * from "./routes";
+export const AUTH_STATUS = {
+    Initializing: "Initializing",
+    Unauthenticated: "Unauthenticated",
+    Authenticated: "Authenticated",
+    Refreshing: "Refreshing",
+    SessionExpired: "SessionExpired",
+};

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

@@ -1,75 +1,89 @@
-import { AuthTokenResponse } from "..";
-import { AccountType, DeviceInfo } from "../user";
-import { GetUserResponse } from "../user/routes";
-export interface RegisterRequest {
+import type { IAuthTokenResponse } from "..";
+import type { TAccountType, IDeviceInfo, IUserSafe } from "../user";
+import type { IGetUserResponse } from "../user/routes";
+export interface IAuthSessionIdParams {
+    sessionId: string;
+}
+export interface IAuthInvitationTokenParams {
+    token: string;
+}
+export interface IAuthInvitationIdParams {
+    invitationId: string;
+}
+export interface IRegisterRequest {
     email: string;
     password: string;
     firstName: string;
     lastName?: string;
-    accountType: AccountType;
-    deviceInfo?: DeviceInfo;
+    accountType: TAccountType;
+    deviceInfo?: IDeviceInfo;
 }
-export interface RegisterResponse extends AuthTokenResponse {
+export interface IRegisterResponse extends IAuthTokenResponse {
 }
-export interface LoginRequest {
+export interface ILoginRequest {
     email: string;
     password: string;
-    deviceInfo?: DeviceInfo;
+    deviceInfo?: IDeviceInfo;
 }
-export interface LoginResponse extends AuthTokenResponse {
+export interface ILoginResponse extends IAuthTokenResponse {
     passwordResetRequired?: boolean;
 }
-export interface RefreshRequest {
+export interface IRefreshSessionRequest {
     refreshToken: string;
-    deviceInfo?: DeviceInfo;
-}
-export interface RefreshResponse extends AuthTokenResponse {
+    deviceInfo?: IDeviceInfo;
 }
-export interface LogoutRequest {
+export interface IRefreshSessionResponse {
+    user?: IUserSafe;
+    accessToken: string;
     refreshToken: string;
+    expiresAt?: string | null;
+    companyId?: string;
 }
-export interface LogoutResponse {
+export interface ILogoutRequest {
+    refreshToken?: string;
+}
+export interface ILogoutResponse {
     message: string;
 }
-export interface LogoutAllRequest {
+export interface ILogoutAllRequest {
     userId: string;
 }
-export interface LogoutAllResponse {
+export interface ILogoutAllResponse {
     message: string;
 }
-export interface GetMeRequest {
+export interface IGetMeRequest {
     userId: string;
 }
-export interface GetMeResponse extends GetUserResponse {
+export interface IGetMeResponse extends IGetUserResponse {
 }
-export interface GetSessionsRequest {
+export interface IGetSessionsRequest {
 }
-export interface GetSessionsResponse {
+export interface IGetSessionsResponse {
     id: string;
     deviceInfo: string;
     createdAt: string;
     lastUsedAt: string;
 }
-export interface RevokeSessionRequest {
+export interface IRevokeSessionRequest extends IAuthSessionIdParams {
 }
-export interface RevokeSessionResponse {
+export interface IRevokeSessionResponse {
     message: string;
 }
-export interface ChangePasswordRequest {
+export interface IChangePasswordRequest {
     currentPassword: string;
     newPassword: string;
 }
-export interface ChangePasswordResponse extends GetUserResponse {
+export interface IChangePasswordResponse extends IGetUserResponse {
 }
-export interface ForgotPasswordRequest {
+export interface IForgotPasswordRequest {
     email: string;
 }
-export interface ForgotPasswordResponse {
+export interface IForgotPasswordResponse {
     message: string;
 }
-export interface GetLoginHistoryRequest {
+export interface IGetLoginHistoryRequest {
 }
-export interface GetLoginHistoryResponse {
+export interface IGetLoginHistoryResponse {
     id: string;
     email: string;
     ipAddress: string;
@@ -78,54 +92,69 @@ export interface GetLoginHistoryResponse {
     failureReason?: string;
     createdAt: Date;
 }
-export interface ValidateInvitationRequest {
+export interface IGetLoginHistoryListResponse {
+    history: IGetLoginHistoryResponse[];
+    length: number;
+}
+export interface IValidateInvitationRequest extends IAuthInvitationTokenParams {
 }
-export interface ValidateInvitationResponse {
+export interface IValidateInvitationResponse {
     id: string;
     companyId: string;
     companyName: string;
     email: string;
-    role: AccountType;
+    role: TAccountType;
     invitedBy: string;
     invitedByName: string;
     expiresAt: string;
     userExists: boolean;
 }
-export interface RegisterWithInvitationRequest {
+export interface IRegisterWithInvitationRequest {
     token: string;
     password: string;
     firstName: string;
     lastName?: string;
-    deviceInfo?: DeviceInfo;
+    deviceInfo?: IDeviceInfo;
 }
-export interface RegisterWithInvitationResponse extends AuthTokenResponse {
+export interface IRegisterWithInvitationResponse extends IAuthTokenResponse {
 }
-export interface AcceptInvitationRequest {
-    userId: string;
+export interface IAcceptInvitationRequest {
+    userId?: string;
     token: string;
 }
-export interface AcceptInvitationResponse {
+export interface IAcceptInvitationResponse {
     companyId: string;
     companyName: string;
-    role: AccountType;
+    role: TAccountType;
+}
+export interface IAcceptInvitationRouteResponse {
+    invite: IAcceptInvitationResponse;
+    message: string;
 }
-export interface GetPendingInvitationsRequest {
+export interface IGetPendingInvitationsRequest {
 }
-export interface GetPendingInvitationsResponse {
+export interface IGetPendingInvitationsResponse {
     id: string;
     token: string;
     companyId: string;
     companyName: string;
-    role: AccountType;
+    role: TAccountType;
     invitedBy: string;
     invitedByName: string;
     expiresAt: string;
     createdAt: string;
 }
-export interface RevokeInvitationRequest {
-    invitationId: string;
-    revokedBy: string;
+export interface IGetPendingInvitationsListResponse {
+    invitations: IGetPendingInvitationsResponse[];
+    length: number;
 }
-export interface RevokeInvitationResponse {
+export interface IRevokeInvitationRequest extends IAuthInvitationIdParams {
+    revokedBy?: string;
+}
+export interface IRevokeInvitationResponse {
     message: string;
 }
+export interface IRefreshRequest extends IRefreshSessionRequest {
+}
+export interface IRefreshResponse extends IRefreshSessionResponse {
+}

package/dist/types/auth/routes.js

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

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

@@ -1,78 +1,209 @@
-export type GenericTurndownObject = Record<string, any> | any | undefined;
-export type TurndownObject<T = GenericTurndownObject> = Record<string, T> | T | undefined;
-export interface MetaData {
+export type TJsonPrimitive = string | number | boolean | null;
+export type TJsonValue = TJsonPrimitive | TJsonValue[] | {
+    [key: string]: TJsonValue;
+};
+export type TUnknownRecord = Record<string, unknown>;
+export type TurndownObject<TObject extends object = TUnknownRecord> = {
+    [TKey in keyof TObject]: TObject[TKey];
+};
+export type TEmptyObject = Record<string, never>;
+export interface IMessageResponse {
+    message: string;
+}
+export interface ISuccessResponse {
+    success: boolean;
+}
+export interface ICountResponse {
+    count: number;
+}
+export interface IEmptyRouteParams {
+}
+export interface IMetaData {
     createdAt: Date;
     updatedAt: Date;
     deletedAt?: Date;
 }
-export type ObjectValues<T> = T[keyof T];
-export type ObjectKeys<T> = [keyof T];
-export type Mode = "CREATE" | "EDIT" | "DELETE" | "DETAILS" | null;
+export type TRecordValue<T> = T[keyof T];
+export type TRecordKeys<T> = [keyof T];
+export interface IVersion {
+    major: number;
+    minor: number;
+    patch: number;
+}
+export type TVersionInput = string | IVersion;
+export interface ISelectOption<TValue extends string = string> {
+    label: string;
+    value: TValue;
+}
+export type TMode = "CREATE" | "EDIT" | "DELETE" | "DETAILS" | null;
 export declare const IMAGE_ENTITY: {
-    USER_PROFILE: string;
-    PROPERTY: string;
-    PROPERTY_ROOM: string;
-    MAINTENANCE_TICKET: string;
-    WORK_REPORT: string;
+    readonly USER_PROFILE: "user_profile";
+    readonly PROPERTY: "property";
+    readonly PROPERTY_ROOM: "property_room";
+    readonly MAINTENANCE_TICKET: "maintenance_ticket";
+    readonly WORK_REPORT: "work_report";
 };
-export type ImageEntityType = ObjectValues<typeof IMAGE_ENTITY>;
+export type TImageEntityType = TRecordValue<typeof IMAGE_ENTITY>;
 export declare const US_STATES_CODE: {
-    AL: string;
-    AK: string;
-    AZ: string;
-    AR: string;
-    CA: string;
-    CO: string;
-    CT: string;
-    DE: string;
-    FL: string;
-    GA: string;
-    HI: string;
-    ID: string;
-    IL: string;
-    IN: string;
-    IA: string;
-    KS: string;
-    KY: string;
-    LA: string;
-    ME: string;
-    MD: string;
-    MA: string;
-    MI: string;
-    MN: string;
-    MS: string;
-    MO: string;
-    MT: string;
-    NE: string;
-    NV: string;
-    NH: string;
-    NJ: string;
-    NM: string;
-    NY: string;
-    NC: string;
-    ND: string;
-    OH: string;
-    OK: string;
-    OR: string;
-    PA: string;
-    RI: string;
-    SC: string;
-    SD: string;
-    TN: string;
-    TX: string;
-    UT: string;
-    VT: string;
-    VA: string;
-    WA: string;
-    WV: string;
-    WI: string;
-    WY: string;
-    DC: string;
-    PR: string;
-    GU: string;
-    VI: string;
-    AS: string;
-    MP: string;
+    readonly AL: "AL";
+    readonly AK: "AK";
+    readonly AZ: "AZ";
+    readonly AR: "AR";
+    readonly CA: "CA";
+    readonly CO: "CO";
+    readonly CT: "CT";
+    readonly DE: "DE";
+    readonly FL: "FL";
+    readonly GA: "GA";
+    readonly HI: "HI";
+    readonly ID: "ID";
+    readonly IL: "IL";
+    readonly IN: "IN";
+    readonly IA: "IA";
+    readonly KS: "KS";
+    readonly KY: "KY";
+    readonly LA: "LA";
+    readonly ME: "ME";
+    readonly MD: "MD";
+    readonly MA: "MA";
+    readonly MI: "MI";
+    readonly MN: "MN";
+    readonly MS: "MS";
+    readonly MO: "MO";
+    readonly MT: "MT";
+    readonly NE: "NE";
+    readonly NV: "NV";
+    readonly NH: "NH";
+    readonly NJ: "NJ";
+    readonly NM: "NM";
+    readonly NY: "NY";
+    readonly NC: "NC";
+    readonly ND: "ND";
+    readonly OH: "OH";
+    readonly OK: "OK";
+    readonly OR: "OR";
+    readonly PA: "PA";
+    readonly RI: "RI";
+    readonly SC: "SC";
+    readonly SD: "SD";
+    readonly TN: "TN";
+    readonly TX: "TX";
+    readonly UT: "UT";
+    readonly VT: "VT";
+    readonly VA: "VA";
+    readonly WA: "WA";
+    readonly WV: "WV";
+    readonly WI: "WI";
+    readonly WY: "WY";
+    readonly DC: "DC";
+    readonly PR: "PR";
+    readonly GU: "GU";
+    readonly VI: "VI";
+    readonly AS: "AS";
+    readonly MP: "MP";
+};
+export type TUnitedStatesStateCode = TRecordValue<typeof US_STATES_CODE>;
+export declare const UNITED_STATES_JURISDICTIONS: {
+    readonly Alabama: "Alabama";
+    readonly Alaska: "Alaska";
+    readonly AmericanSamoa: "American Samoa";
+    readonly Arizona: "Arizona";
+    readonly Arkansas: "Arkansas";
+    readonly BakerIsland: "Baker Island";
+    readonly California: "California";
+    readonly Colorado: "Colorado";
+    readonly Connecticut: "Connecticut";
+    readonly Delaware: "Delaware";
+    readonly DistrictOfColumbia: "District of Columbia";
+    readonly Florida: "Florida";
+    readonly Georgia: "Georgia";
+    readonly Guam: "Guam";
+    readonly Hawaii: "Hawaii";
+    readonly HowlandIsland: "Howland Island";
+    readonly Idaho: "Idaho";
+    readonly Illinois: "Illinois";
+    readonly Indiana: "Indiana";
+    readonly Iowa: "Iowa";
+    readonly JarvisIsland: "Jarvis Island";
+    readonly JohnstonAtoll: "Johnston Atoll";
+    readonly Kansas: "Kansas";
+    readonly Kentucky: "Kentucky";
+    readonly KingmanReef: "Kingman Reef";
+    readonly Louisiana: "Louisiana";
+    readonly Maine: "Maine";
+    readonly Maryland: "Maryland";
+    readonly Massachusetts: "Massachusetts";
+    readonly Michigan: "Michigan";
+    readonly MidwayAtoll: "Midway Atoll";
+    readonly Minnesota: "Minnesota";
+    readonly Mississippi: "Mississippi";
+    readonly Missouri: "Missouri";
+    readonly Montana: "Montana";
+    readonly NavassaIsland: "Navassa Island";
+    readonly Nebraska: "Nebraska";
+    readonly Nevada: "Nevada";
+    readonly NewHampshire: "New Hampshire";
+    readonly NewJersey: "New Jersey";
+    readonly NewMexico: "New Mexico";
+    readonly NewYork: "New York";
+    readonly NorthCarolina: "North Carolina";
+    readonly NorthDakota: "North Dakota";
+    readonly NorthernMarianaIslands: "Northern Mariana Islands";
+    readonly Ohio: "Ohio";
+    readonly Oklahoma: "Oklahoma";
+    readonly Oregon: "Oregon";
+    readonly PalmyraAtoll: "Palmyra Atoll";
+    readonly Pennsylvania: "Pennsylvania";
+    readonly PuertoRico: "Puerto Rico";
+    readonly RhodeIsland: "Rhode Island";
+    readonly SouthCarolina: "South Carolina";
+    readonly SouthDakota: "South Dakota";
+    readonly Tennessee: "Tennessee";
+    readonly Texas: "Texas";
+    readonly UnitedStatesVirginIslands: "United States Virgin Islands";
+    readonly Utah: "Utah";
+    readonly Vermont: "Vermont";
+    readonly Virginia: "Virginia";
+    readonly WakeIsland: "Wake Island";
+    readonly Washington: "Washington";
+    readonly WestVirginia: "West Virginia";
+    readonly Wisconsin: "Wisconsin";
+    readonly Wyoming: "Wyoming";
+};
+export type TUnitedStatesJurisdiction = TRecordValue<typeof UNITED_STATES_JURISDICTIONS>;
+export declare const UnitedStatesJurisdictionOptions: ISelectOption<TUnitedStatesJurisdiction>[];
+export declare const STATUS: {
+    readonly Pending: "Pending";
+    readonly InProgress: "InProgress";
+    readonly Completed: "Completed";
+    readonly Overdue: "Overdue";
+    readonly Active: "Active";
+    readonly Inactive: "Inactive";
 };
-export type USStateCodeType = ObjectValues<typeof US_STATES_CODE>;
+export type TStatus = TRecordValue<typeof STATUS>;
+export declare const StatusOptions: ISelectOption<TStatus>[];
+export declare const SEVERITY: {
+    readonly Low: "Low";
+    readonly Medium: "Medium";
+    readonly High: "High";
+};
+export type TSeverity = TRecordValue<typeof SEVERITY>;
+export declare const SeverityOptions: ISelectOption<TSeverity>[];
+export declare const SERVICE_TYPES: {
+    readonly Cleaning: "Cleaning";
+    readonly Maintenance: "Maintenance";
+    readonly Inspection: "Inspections";
+    readonly Other: "Other";
+};
+export type TServiceType = TRecordValue<typeof SERVICE_TYPES>;
+export declare const ServiceTypeOptions: ISelectOption<TServiceType>[];
+export declare const MONTHS: readonly ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"];
+export type TMonth = (typeof MONTHS)[number];
+export interface IWeekDay {
+    date: Date;
+    dayOfMonth: number;
+    shortLabel: string;
+    letter: string;
+    isToday: boolean;
+}
 export * from "./paging.types";