@ketvietlab/ketsuite 0.1.1

package/dist/modules/hospitality_core/screens.d.ts

@@ -0,0 +1,763 @@
+import type { Translator } from '@ketvietlab/ketjs';
+import type { TemplateResult } from '@ketvietlab/ketjs-view';
+import type { Frame } from '../../ui/index.ts';
+export type PropertyRow = {
+    id: string;
+    code: string;
+    name: string;
+    accommodationType: string;
+    starRating: number;
+    city?: string | null;
+    country?: string | null;
+    addressLine?: string | null;
+    publicName?: string | null;
+    description?: string | null;
+    active: boolean;
+    rooms: number;
+    availableRooms: number;
+    attentionRooms: number;
+};
+export type PropertyDetail = {
+    id: string;
+    code: string;
+    name: string;
+    publicName?: string | null;
+    accommodationType: string;
+    timezone: string;
+    defaultCheckIn: string;
+    defaultCheckOut: string;
+    enforceTimes: boolean;
+    longStayBillOnCheckIn?: boolean | null;
+    starRating: number;
+    street1?: string | null;
+    street2?: string | null;
+    locality?: string | null;
+    postalCode?: string | null;
+    countryCode?: string | null;
+    countryId?: string | null;
+    divisionId?: string | null;
+    divisionText?: string | null;
+    addressLine?: string | null;
+    latitude?: string | number | null;
+    longitude?: string | number | null;
+    description?: string | null;
+    houseRules?: string | null;
+    childrenStayFree: boolean;
+    minimumGuestAge?: number | null;
+    defaultCancellationPolicyId?: string | null;
+    defaultCancellationPolicy?: {
+        code?: string;
+        name?: string;
+    } | null;
+    active: boolean;
+    buildings?: Array<{
+        id?: string;
+    }>;
+    floors?: Array<{
+        id?: string;
+    }>;
+    roomTypes?: Array<{
+        id?: string;
+    }>;
+    rooms?: RoomRow[];
+    contacts?: Array<{
+        id?: string;
+    }>;
+};
+export type PropertyFormValues = Pick<PropertyDetail, 'id' | 'code' | 'name' | 'publicName' | 'accommodationType' | 'timezone' | 'defaultCheckIn' | 'defaultCheckOut' | 'enforceTimes' | 'longStayBillOnCheckIn' | 'starRating' | 'description' | 'houseRules' | 'childrenStayFree' | 'minimumGuestAge' | 'defaultCancellationPolicyId'>;
+export type BuildingRow = {
+    id: string;
+    propertyId: string;
+    code: string;
+    name: string;
+    sequence: number;
+    active: boolean;
+    floors?: Array<{
+        id?: string;
+        active?: boolean;
+    }>;
+    rooms?: Array<{
+        id?: string;
+        active?: boolean;
+    }>;
+};
+export type BuildingDetail = BuildingRow & {
+    property?: {
+        code?: string;
+        name?: string;
+        active?: boolean;
+    } | null;
+    floors: FloorRow[];
+    rooms: RoomRow[];
+};
+export type BuildingFormValues = Pick<BuildingRow, 'id' | 'propertyId' | 'code' | 'name' | 'sequence'>;
+export type FloorRow = {
+    id: string;
+    propertyId: string;
+    buildingId: string;
+    code: string;
+    name: string;
+    sequence: number;
+    active: boolean;
+    building?: {
+        code?: string;
+        name?: string;
+    } | null;
+    rooms?: Array<{
+        id?: string;
+        active?: boolean;
+    }>;
+};
+export type FloorDetail = FloorRow & {
+    property?: {
+        code?: string;
+        name?: string;
+        active?: boolean;
+    } | null;
+    building?: {
+        id?: string;
+        code?: string;
+        name?: string;
+        active?: boolean;
+    } | null;
+    rooms: RoomRow[];
+};
+export type FloorFormValues = Pick<FloorRow, 'id' | 'propertyId' | 'buildingId' | 'code' | 'name' | 'sequence'>;
+export type RoomRow = {
+    id: string;
+    propertyId: string;
+    code: string;
+    name: string;
+    roomTypeId: string;
+    buildingId?: string | null;
+    floorId?: string | null;
+    capacity: number;
+    status: string;
+    note?: string | null;
+    active: boolean;
+    roomType?: {
+        code?: string;
+        name?: string;
+    } | null;
+    property?: {
+        code?: string;
+        name?: string;
+    } | null;
+    building?: {
+        code?: string;
+        name?: string;
+    } | null;
+    floor?: {
+        code?: string;
+        name?: string;
+    } | null;
+    currentStay?: {
+        id?: string;
+        code?: string;
+        checkIn?: string;
+        checkOut?: string;
+        partner?: {
+            name?: string;
+        } | null;
+    } | null;
+};
+export type RoomDetail = RoomRow & {
+    property?: {
+        id?: string;
+        code?: string;
+        name?: string;
+    } | null;
+    roomType?: {
+        id?: string;
+        code?: string;
+        name?: string;
+    } | null;
+    building?: {
+        id?: string;
+        code?: string;
+        name?: string;
+    } | null;
+    floor?: {
+        id?: string;
+        code?: string;
+        name?: string;
+    } | null;
+};
+export type RoomFormValues = Pick<RoomDetail, 'id' | 'propertyId' | 'roomTypeId' | 'buildingId' | 'floorId' | 'code' | 'name' | 'capacity'>;
+export type RoomStatusSummary = {
+    available: number;
+    occupied: number;
+    dirty: number;
+    cleaning: number;
+    maintenance: number;
+    outOfOrder: number;
+};
+export type RoomTypeRow = {
+    id: string;
+    propertyId?: string;
+    code: string;
+    name: string;
+    publicName?: string | null;
+    description?: string | null;
+    defaultCapacity: number;
+    maxAdults?: number;
+    maxChildren?: number;
+    maxInfants?: number;
+    maxExtraBeds?: number;
+    sizeSqm?: string | number | null;
+    viewType?: string | null;
+    sharedBathroom?: boolean;
+    baseRate: string | number;
+    published: boolean;
+    active: boolean;
+    rooms?: unknown[];
+};
+export type RoomTypeDetail = Omit<RoomTypeRow, 'propertyId' | 'maxAdults' | 'maxChildren' | 'maxInfants' | 'maxExtraBeds' | 'viewType' | 'sharedBathroom'> & {
+    propertyId: string;
+    maxAdults: number;
+    maxChildren: number;
+    maxInfants: number;
+    maxExtraBeds: number;
+    viewType?: string | null;
+    sharedBathroom: boolean;
+    color?: string | null;
+    cancellationPolicyId?: string | null;
+    property?: {
+        id?: string;
+        code?: string;
+        name?: string;
+    } | null;
+    rooms?: RoomRow[];
+    beds?: Array<{
+        id?: string;
+        type?: string;
+        quantity?: number;
+    }>;
+    ratePlans?: Array<{
+        id?: string;
+        code?: string;
+        name?: string;
+        active?: boolean;
+    }>;
+    cancellationPolicy?: {
+        id?: string;
+        code?: string;
+        name?: string;
+    } | null;
+};
+export type RoomTypeFormValues = Pick<RoomTypeDetail, 'id' | 'propertyId' | 'code' | 'name' | 'publicName' | 'description' | 'defaultCapacity' | 'maxAdults' | 'maxChildren' | 'maxInfants' | 'maxExtraBeds' | 'sizeSqm' | 'viewType' | 'sharedBathroom' | 'baseRate' | 'color' | 'cancellationPolicyId' | 'published'>;
+export type ContentImageRow = {
+    id: string;
+    attachmentId: string;
+    propertyId?: string | null;
+    roomTypeId?: string | null;
+    category: string;
+    caption?: string | null;
+    sequence: number;
+    primary: boolean;
+    attachment?: {
+        id?: string;
+        name?: string;
+    } | null;
+};
+export type ContentCompleteness = {
+    completed: number;
+    total: number;
+    percent: number;
+};
+export type NightAuditPreview = {
+    propertyId: string;
+    auditDate: string;
+    inHouseCount: number;
+    serviceDue: number;
+    rentDue: number;
+    existingCount: number;
+    estimatedAmount: string | number;
+};
+export type NightAuditRow = {
+    id: string;
+    propertyId: string;
+    auditDate: string;
+    state: string;
+    inHouseCount: number;
+    servicePosted: number;
+    rentPosted: number;
+    existingCount: number;
+    totalAmount: string | number;
+    attempt: number;
+    requestedAt: string;
+    startedAt?: string | null;
+    completedAt?: string | null;
+    error?: string | null;
+};
+export type StayNoticeRow = {
+    id: string;
+    propertyId: string;
+    stayId: string;
+    stayGuestId: string;
+    state: string;
+    reason?: string | null;
+    dueAt: string;
+    guestName: string;
+    documentType?: string | null;
+    documentLast4?: string | null;
+    issueCodes: string[];
+    attempt: number;
+    preparedAt?: string | null;
+    submissionChannel?: string | null;
+    submittedAt?: string | null;
+    submittedBy?: string | null;
+    receiptRef?: string | null;
+    confirmedAt?: string | null;
+    confirmedBy?: string | null;
+};
+export type AmenityRow = {
+    id: string;
+    code: string;
+    name: string;
+    scope: string;
+};
+export type PolicyRow = {
+    id: string;
+    code: string;
+    name: string;
+    type: string;
+    freeCancellationHours: number;
+    penaltyPercent: string | number;
+};
+export type RatePlanRow = {
+    id: string;
+    propertyId: string;
+    roomTypeId: string;
+    code: string;
+    name: string;
+    rateType: string;
+    amount: string | number;
+    isDefault: boolean;
+    mealPlan?: string | null;
+    minStay: number;
+    maxStay: number;
+    active: boolean;
+    roomType?: {
+        code?: string;
+        name?: string;
+    } | null;
+};
+export type InventoryRow = {
+    id: string;
+    propertyId: string;
+    roomTypeId: string;
+    date: string;
+    total: number;
+    sold: number;
+    blocked: number;
+    available: number;
+    minLos: number;
+    maxLos: number;
+    closedToArrival: boolean;
+    closedToDeparture: boolean;
+    stopSell: boolean;
+    persisted: boolean;
+};
+export type CleaningTaskRow = {
+    id: string;
+    code: string;
+    propertyId: string;
+    roomId: string;
+    stayId?: string | null;
+    taskType: string;
+    priority: string;
+    state: string;
+    requestedAt: string;
+    startedAt?: string | null;
+    doneAt?: string | null;
+    notes?: string | null;
+    room?: {
+        code?: string;
+        name?: string;
+        status?: string;
+    } | null;
+    property?: {
+        code?: string;
+        name?: string;
+    } | null;
+    stay?: {
+        code?: string;
+    } | null;
+    assigneeId?: string | null;
+};
+export type CleaningTaskSummary = {
+    todo: number;
+    inProgress: number;
+    done: number;
+    cancelled: number;
+};
+export type ReservationRow = {
+    id: string;
+    code: string;
+    partnerId: string;
+    provider: string;
+    roomTypeId: string;
+    checkIn: string;
+    checkOut: string;
+    adults: number;
+    children: number;
+    amountTotal: string | number;
+    state: string;
+    partner?: {
+        name?: string;
+    } | null;
+    roomType?: {
+        name?: string;
+    } | null;
+};
+export type ReservationDetail = ReservationRow & {
+    propertyId: string;
+    folioId: string;
+    stayId?: string | null;
+    bookingType: string;
+    billingMode: string;
+    rate: string | number;
+    quantity: string | number;
+    cancelReason?: string | null;
+    noShowAt?: string | null;
+    noShowReason?: string | null;
+    createdAt: string;
+    updatedAt: string;
+    folio?: {
+        code?: string;
+        state?: string;
+    } | null;
+    stay?: StayRow | null;
+};
+export type ReservationQuote = {
+    ok: boolean;
+    ratePlanId?: string | null;
+    bookingType?: string | null;
+    billingMode?: string | null;
+    checkIn?: string | null;
+    checkOut?: string | null;
+    rate?: string | number | null;
+    quantity?: string | number | null;
+    amountTotal?: string | number | null;
+    minimumAvailable?: number | null;
+    errors?: Array<{
+        messageKey?: string;
+        params?: Record<string, unknown>;
+    }>;
+};
+export type ReservationIntakeValues = {
+    id: string;
+    code: string;
+    propertyId: string;
+    roomTypeId: string;
+    partnerId: string;
+    bookingType: string;
+    checkIn: string;
+    checkOut: string;
+    adults: number;
+    children: number;
+    rate: string;
+};
+export type ReservationAmendmentValues = {
+    partnerId: string;
+    roomTypeId: string;
+    checkIn: string;
+    checkOut: string;
+    adults: number;
+    children: number;
+    rate: string;
+};
+export type StayRow = {
+    id: string;
+    code: string;
+    folioId: string;
+    propertyId: string;
+    reservationId?: string | null;
+    partnerId: string;
+    roomTypeId: string;
+    currentRoomId?: string | null;
+    bookingType: string;
+    checkIn: string;
+    checkOut: string;
+    adults: number;
+    children: number;
+    billingMode: string;
+    rate: string | number;
+    nextBillDate?: string | null;
+    state: string;
+    checkedInAt?: string | null;
+    checkedOutAt?: string | null;
+    partner?: {
+        name?: string;
+    } | null;
+    roomType?: {
+        name?: string;
+    } | null;
+    currentRoom?: {
+        name?: string;
+        code?: string;
+    } | null;
+    reservation?: {
+        id?: string;
+        code?: string;
+    } | null;
+    assignments?: StayAssignmentRow[];
+    guests?: StayGuestRow[];
+};
+export type StayAssignmentRow = {
+    id: string;
+    roomId: string;
+    roomTypeId: string;
+    startAt: string;
+    endAt?: string | null;
+    state: string;
+    reason?: string | null;
+    roomName?: string;
+};
+export type StayGuestRow = {
+    id: string;
+    partnerId?: string | null;
+    displayName: string;
+    primary: boolean;
+};
+export type GuestDocumentRow = {
+    id: string;
+    stayId?: string | null;
+    partnerId: string;
+    type: string;
+    numberLast4?: string | null;
+    fullName: string;
+    nationality?: string | null;
+    ocrState: string;
+    dateOfBirthPresent: boolean;
+};
+export type FolioRow = {
+    id: string;
+    code: string;
+    propertyId: string;
+    partnerId: string;
+    state: string;
+    amountTotal: string | number;
+    version: number;
+    openedAt: string;
+    closedAt?: string | null;
+    partner?: {
+        name?: string;
+    } | null;
+    stays?: FolioStayRow[];
+    charges?: FolioChargeRow[];
+};
+export type FolioStayRow = {
+    id: string;
+    code: string;
+    currentRoomId?: string | null;
+    checkIn: string;
+    checkOut: string;
+    state: string;
+};
+export type FolioChargeRow = {
+    id: string;
+    stayId?: string | null;
+    description: string;
+    type: string;
+    quantity: string | number;
+    unitPrice: string | number;
+    amount: string | number;
+    occurredAt: string;
+    state: string;
+    voidedAt?: string | null;
+    voidReason?: string | null;
+};
+export type PropertyChargeRow = {
+    id: string;
+    propertyId: string;
+    chargeType: string;
+    name: string;
+    amount: string | number;
+    description?: string | null;
+    active: boolean;
+};
+export type ServiceProductRow = {
+    id: string;
+    code?: string | null;
+    name: string;
+    unitPrice: string | number;
+    uomId?: string | null;
+};
+export type ExtraLineRow = {
+    id: string;
+    reservationId?: string | null;
+    stayId?: string | null;
+    folioId: string;
+    propertyId: string;
+    productId: string;
+    uomId?: string | null;
+    description: string;
+    quantity: string | number;
+    unitPrice: string | number;
+    recurrence: string;
+    active: boolean;
+    productName: string;
+    productCode?: string | null;
+    reservation?: {
+        code?: string;
+    } | null;
+    stay?: {
+        code?: string;
+    } | null;
+    materializedCount: number;
+    materializedAmount: string | number;
+};
+export type ServiceChargeRow = {
+    id: string;
+    folioId: string;
+    stayId?: string | null;
+    extraLineId: string;
+    description: string;
+    quantity: string | number;
+    unitPrice: string | number;
+    amount: string | number;
+    occurredAt: string;
+    serviceDate?: string | null;
+    state: string;
+    productName: string;
+    folio?: {
+        code?: string;
+    } | null;
+    stay?: {
+        code?: string;
+    } | null;
+};
+export type TapeChart = {
+    timezone: string;
+    from: string;
+    to: string;
+    rooms: Array<RoomRow & {
+        roomType?: {
+            name?: string;
+        } | null;
+    }>;
+    events: Array<{
+        id: string;
+        stayId: string;
+        roomId?: string | null;
+        guest: string;
+        provider: string;
+        state: string;
+        start: string;
+        end: string;
+    }>;
+};
+export declare const propertiesScreen: (_: Translator, rows: PropertyRow[], totals: {
+    rooms: number;
+    available: number;
+    attention: number;
+}, locale: string, frame: Frame) => TemplateResult;
+export declare const newPropertyScreen: (_: Translator, values: PropertyFormValues, policies: readonly PolicyRow[], locale: string, frame: Frame, errors?: readonly string[]) => TemplateResult;
+export declare const propertyDetailScreen: (_: Translator, property: PropertyDetail, policies: readonly PolicyRow[], locale: string, frame: Frame, status?: string | null, errors?: readonly string[], attempted?: PropertyFormValues) => TemplateResult;
+export declare const roomsScreen: (_: Translator, data: {
+    rows: RoomRow[];
+    properties: PropertyRow[];
+    propertyId?: string;
+    roomTypes: RoomTypeRow[];
+    buildings: BuildingRow[];
+    floors: FloorRow[];
+}, locale: string, frame: Frame, status?: string | null, errors?: readonly string[]) => TemplateResult;
+export declare const buildingDetailScreen: (_: Translator, building: BuildingDetail, values: BuildingFormValues, locale: string, frame: Frame, status?: string | null, errors?: readonly string[]) => TemplateResult;
+export declare const floorDetailScreen: (_: Translator, floor: FloorDetail, values: FloorFormValues, locale: string, frame: Frame, status?: string | null, errors?: readonly string[]) => TemplateResult;
+export declare const newRoomScreen: (_: Translator, values: RoomFormValues, properties: PropertyRow[], roomTypes: RoomTypeRow[], buildings: BuildingRow[], floors: FloorRow[], locale: string, frame: Frame, errors?: readonly string[]) => TemplateResult;
+export declare const roomDetailScreen: (_: Translator, room: RoomDetail, values: RoomFormValues, properties: PropertyRow[], roomTypes: RoomTypeRow[], buildings: BuildingRow[], floors: FloorRow[], locale: string, frame: Frame, status?: string | null, errors?: readonly string[]) => TemplateResult;
+export declare const cleaningTasksScreen: (_: Translator, data: {
+    rows: CleaningTaskRow[];
+    properties: PropertyRow[];
+    propertyId?: string;
+    state: string;
+    rooms: RoomRow[];
+    summary: CleaningTaskSummary;
+    id: string;
+    code: string;
+    selectedRoomId?: string;
+}, locale: string, timezone: string, frame: Frame, status?: string | null) => TemplateResult;
+export declare const cleaningTaskDetailScreen: (_: Translator, task: CleaningTaskRow, locale: string, timezone: string, frame: Frame, status?: string | null, errors?: readonly string[]) => TemplateResult;
+export declare const housekeepingRoomsScreen: (_: Translator, data: {
+    rows: RoomRow[];
+    properties: PropertyRow[];
+    propertyId?: string;
+    state: string;
+    summary: RoomStatusSummary;
+}, locale: string, frame: Frame) => TemplateResult;
+export declare const housekeepingRoomDetailScreen: (_: Translator, room: RoomRow, tasks: CleaningTaskRow[], locale: string, timezone: string, frame: Frame, status?: string | null, errors?: readonly string[]) => TemplateResult;
+export declare const roomTypesScreen: (_: Translator, rows: RoomTypeRow[], properties: PropertyRow[], propertyId: string | undefined, locale: string, frame: Frame) => TemplateResult;
+export declare const newRoomTypeScreen: (_: Translator, values: RoomTypeFormValues, properties: PropertyRow[], policies: PolicyRow[], locale: string, frame: Frame, errors?: readonly string[]) => TemplateResult;
+export declare const roomTypeDetailScreen: (_: Translator, roomType: RoomTypeDetail, properties: PropertyRow[], policies: PolicyRow[], locale: string, frame: Frame, status?: string | null, errors?: readonly string[], attempted?: RoomTypeFormValues) => TemplateResult;
+export declare const amenitiesScreen: (_: Translator, rows: AmenityRow[], frame: Frame) => TemplateResult;
+export declare const policiesScreen: (_: Translator, rows: PolicyRow[], frame: Frame) => TemplateResult;
+export declare const contentScreen: (_: Translator, properties: PropertyRow[], roomTypes: RoomTypeRow[], propertyId: string | undefined, target: string, images: ContentImageRow[], completeness: ContentCompleteness, locale: string, query: string, frame: Frame, status?: string | null) => TemplateResult;
+type Choice = {
+    id: string;
+    code?: string;
+    name: string;
+    propertyId?: string;
+};
+export declare const nightAuditScreen: (_: Translator, data: {
+    properties: Choice[];
+    propertyId?: string;
+    auditDate: string;
+    today: string;
+    preview?: NightAuditPreview;
+    runs: NightAuditRow[];
+}, locale: string, frame: Frame, state?: string | null) => TemplateResult;
+export declare const stayNoticesScreen: (_: Translator, data: {
+    properties: Choice[];
+    propertyId?: string;
+    state: string;
+    rows: StayNoticeRow[];
+    selected?: StayNoticeRow;
+}, locale: string, timezone: string, frame: Frame, feedbackState?: string | null) => TemplateResult;
+export declare const servicesScreen: (_: Translator, data: {
+    properties: Choice[];
+    propertyId?: string;
+    products: ServiceProductRow[];
+    targets: Array<Choice & {
+        type: 'reservation' | 'stay';
+    }>;
+    propertyCharges: PropertyChargeRow[];
+    extraLines: ExtraLineRow[];
+    charges: ServiceChargeRow[];
+    ids: {
+        propertyCharge: string;
+        extraLine: string;
+        requestKey: string;
+    };
+}, locale: string, timezone: string, frame: Frame, state?: string | null) => TemplateResult;
+export declare const ratePlansScreen: (_: Translator, rows: RatePlanRow[], properties: Choice[], roomTypes: Choice[], propertyId: string | undefined, frame: Frame, state?: string | null) => TemplateResult;
+export declare const inventoryScreen: (_: Translator, rows: InventoryRow[], properties: Choice[], roomTypes: Choice[], selected: {
+    propertyId?: string;
+    roomTypeId?: string;
+    from: string;
+    to: string;
+}, frame: Frame, state?: string | null) => TemplateResult;
+export declare const frontDeskScreen: (_: Translator, rows: StayRow[], overdueRows: StayRow[], totals: {
+    arrivals: number;
+    inHouse: number;
+    departures: number;
+    overdue: number;
+    openFolios: number;
+}, locale: string, timezone: string, frame: Frame) => TemplateResult;
+export declare const reservationsScreen: (_: Translator, data: {
+    rows: ReservationRow[];
+    properties: Choice[];
+    roomTypes: Choice[];
+    partners: Choice[];
+    values: ReservationIntakeValues;
+    quote?: ReservationQuote | null;
+}, locale: string, timezone: string, frame: Frame, status?: string | null) => TemplateResult;
+export declare const reservationDetailScreen: (_: Translator, reservation: ReservationDetail, rooms: RoomRow[], roomTypes: Choice[], partners: Choice[], amendment: ReservationAmendmentValues, departure: string, locale: string, timezone: string, frame: Frame, status?: string | null, errors?: readonly string[]) => TemplateResult;
+export declare const stayDetailScreen: (_: Translator, stay: StayRow, rooms: RoomRow[], partners: Choice[], documents: GuestDocumentRow[], documentId: string, locale: string, timezone: string, frame: Frame, status?: string | null, errors?: readonly string[]) => TemplateResult;
+export declare const staysScreen: (_: Translator, rows: StayRow[], locale: string, timezone: string, frame: Frame) => TemplateResult;
+export declare const folioDetailScreen: (_: Translator, folio: FolioRow, locale: string, timezone: string, frame: Frame, chargeId: string, status?: string | null, errors?: readonly string[]) => TemplateResult;
+export declare const foliosScreen: (_: Translator, rows: FolioRow[], locale: string, timezone: string, frame: Frame) => TemplateResult;
+export declare const tapeChartScreen: (_: Translator, chart: TapeChart, locale: string, frame: Frame) => TemplateResult;
+export {};
+//# sourceMappingURL=screens.d.ts.map