ValidName
BookingStatus
RPC_SubmitSessionReport
_internal

entity Booking
  "Planned attendance for a child at a centre for a session"

  Date: date "When attendance is planned"
  Status: BookingStatus "Current state"
end

# This is a comment
entity Child  # inline comment
  FirstName: name "First name"
end

entity Foo
  ...
end

domain ChildCare
  "Comprehensive domain model for managing child care centres and families"

  company "Acme"
  version "1.0.0"

  services
    Scheduling
    Billing
    Organisation
  end
end

entity Booking
  "Planned attendance for a child at a centre for a session"

  BookingDate: date "Date when attendance is planned"
  Status: BookingStatus "Current state of the booking"
  AdjustedHours: decimal(12,2), optional "Adjusted hours after modifications"
  IsActive: boolean, default(true) "Whether the booking is active"

  belongs_to Child
  has_one Session
  has_many Attendance
  has_one Absence?
  references CentreForScheduling
end

FieldName: DataType[, optional][, default(value)] ["Description"]

keyword TargetName ["Description"]
keyword Alias: TargetName ["Description"]

has_many Attendances: Attendance "All recorded attendances for this booking"

key Booking
  BookingId: id

  index [Child, Date, Session] unique
end

index [Field1, Field2, ...] unique
index [Field1, Field2, ...]

value DateRange
  "A period between two dates"

  Start: date "Start of the range (inclusive)"
  End: date "End of the range (inclusive)"
end

union ContactMethod
  "How to reach a person"

  variant Email
    "Contact via email"
    Address: email "Email address"
  end

  variant Phone
    "Contact via phone"
    Number: text(20) "Phone number"
    Extension: text(10), optional "Extension"
  end
end

enum BookingStatus
  "Possible states of a booking"

  Planned: 1 "Booking is scheduled for the future"
  Attending: 2 "Child has signed in"
  Attended: 3 "Child has signed out"
  Absence: 4 "Child did not attend"
  Cancelled: 5 "Booking was cancelled"
end

ValueName: IntegerValue ["Description"]

flags DaysOfWeek
  "Set of days — multiple values can be selected simultaneously"

  Monday: 1 "Monday"
  Tuesday: 2 "Tuesday"
  Wednesday: 4 "Wednesday"
  Thursday: 8 "Thursday"
  Friday: 16 "Friday"
  Saturday: 32 "Saturday"
  Sunday: 64 "Sunday"
end

shared AbsenceReason
  "Standard reasons for child absences"

  Code: text(10) "Short code"
  Description: text(100) "Display name"
  IsChargeable: boolean "Whether this reason incurs charges"
end

shared OrganisationForScheduling
  "Organisation reference data as used by the Scheduling service"

  Name: name "Organisation name"
  PhoneNumber: text(20), optional "Contact number"
end

service Scheduling
  "Manages bookings, attendance, and sessions"

  entities
    Booking
    Attendance
    Session
    Room
  end

  enums
    BookingStatus
    CareType
  end

  references
    ChildForScheduling
    CentreForScheduling
    OrganisationForScheduling
  end

  calls
    FileStorageRPC
    CreateUserNotification
  end

  implements
    Gov_Submit_SessionReport
  end
end

command PlaceBooking
  "Place a booking for a child at a session"

  input
    ChildId: id "The child to book"
    SessionId: id "The session being booked"
    Date: date "The booking date"
    Notes: text(500), optional "Additional notes"
  end

  output
    BookingResult "The created booking summary"
  end

  errors
    ChildNotEnrolled "Child is not enrolled at the centre"
    SessionFull "No capacity remaining in the session"
  end

  publishes
    BookingPlaced
  end
end

command GovSubmitSessionReport
  "Submits session reports to government"
  transport grpc

  input
    Request: RPC_SubmitSessionReportRequest "The request payload"
  end

  output
    RPC_SubmitSessionReportResponse "The response payload"
  end
end

command StreamAttendanceUpdates
  "Stream attendance updates as they occur"
  transport grpc
  streaming server

  input
    CentreId: id "Centre to watch"
  end

  output
    AttendanceUpdate "Individual attendance event"
  end
end

query GetActualBookings
  "Bookings combined with attendance and absence data"

  input
    CentreToken: text "The centre identifier"
    Date: date "The date to query"
    IncludeAbsences: boolean, default(true) "Whether to include absence records"
  end

  returns ActualBookingResult
end

query ListChildren
  "All children enrolled at a centre"

  input
    CentreId: id "The centre to query"
  end

  returns many Child
end

event AttendanceRecorded
  "A child's attendance has been recorded for a booked session"

  BookingId: id "The booking attendance was recorded against"
  ChildId: id "The child who attended"
  TimeIn: time "When the child arrived"
  TimeOut: time, optional "When the child left"
  RecordedAt: datetime "When this record was created"
end

projection AttendanceReport
  "Attendance data flattened for reporting"

  ChildName: name "Child's full name"
  Date: date "Attendance date"
  SessionName: text(100) "Session name"
  TimeIn: time "Sign-in time"
  TimeOut: time, optional "Sign-out time"
  CentreName: text(60) "Centre name"
  IsAbsent: boolean "Whether this was an absence"
end

entity Child
  FirstName: name "First name"
  Image: image, optional "Child's photo"
end

entity RoomSessionFee
  Amount: money "The fee amount"
  CCSRate: percentage "The CCS subsidy rate"
end

entity Centre
  Location: geospatial, optional "Geographic coordinates"
end

domain   entity   key   value   union   enum   flags
shared   service  command   query   event   projection

services   entities   enums   references   calls   implements
input   output   errors   publishes   returns   index
variant

has_one   has_many   belongs_to   many_to_many   references

optional   default(value)   generated

transport http        # default — REST over HTTP
transport grpc        # gRPC binary protocol

streaming none        # default — request/response
streaming server      # server streams multiple responses
streaming client      # client streams multiple requests
streaming bidirectional

company   version                       # .def metadata
index [Fields, ...] unique             # .key indexes
returns   returns many                 # .query return type

end

# shared/organisation-for-scheduling.shared
shared OrganisationForScheduling
  "Organisation data as needed by the Scheduling service"

  Name: name "Organisation name"
end

service Scheduling
  references
    OrganisationForScheduling
  end
end

entity Booking
  references OrganisationForScheduling
end

# Consuming service
service CCSSOrchestration
  calls
    GovSubmitSessionReport
  end
end

# Providing service
service GovSyncCore
  implements
    GovSubmitSessionReport
  end
end