QueueSystem.ts

import { SchemaDefinition } from '@sozialhelden/simpl-schema';
import BooleanField from './BooleanField.js';
import { getGrabBarsSchemaDefinition, GrabBars } from './GrabBars.js';
import { getInteractableSchemaDefinition, Interactable } from './Interactable.js';
import getPrefixedSchemaDefinition from './lib/getPrefixedSchemaDefinition.js';

export const QueueSystemInteractions = ['enqueue', 'skipQueue', 'wait', 'leaveQueue', 'arrive', 'checkIn', 'checkOut', 'getTicket', 'getOnesTurn'] as const;
export type QueueSystemInteraction = typeof QueueSystemInteractions[number];
export const QueueSystemInteractionsSet = new Set(QueueSystemInteractions);

/**
 * Describes a system that encourages or forces people to queue up.
 */
export interface QueueSystem extends Interactable<QueueSystemInteraction> {
  /**
   * `true` if the queueing uses rails / cattle bars, `false` if not.
   */
  usesCattleBars?: boolean;

  /**
   * `true` if the queueing uses tickets (usually numbered), `false` if not.
   */

  needsTickets?: boolean;

  /**
   * `true` if you can skip the queue with a disability, `false` if not.
   */

  canSkipQueueWithDisability?: boolean;

  /**
   * Number of seats that can be used by people while waiting in the queue.
   */
  numberOfSeats?: number;

  /**
   * Number of queue server points.
   */

  numberOfQueueServerPoints?: number;

  /**
   * `true` if the queueing system announces the next person in line visually, `false` if not.
   */
  hasVisualAnnouncements?: boolean;

  /**
   * Grab bars inside the queueing system, if applicable.
   */
  grabBars?: GrabBars;
}

export const getQueueSystemSchemaDefinition: () => SchemaDefinition = () => ({
  isAccessibleWithWheelchair: BooleanField,
  usesCattleBars: BooleanField,
  needsTickets: BooleanField,
  hasVisualAnnouncements: BooleanField,
  ...getPrefixedSchemaDefinition('grabBars', getGrabBarsSchemaDefinition()),
  ticketEquipmentId: {
    type: String,
    optional: true,
  },
  canSkipQueueWithDisability: BooleanField,
  numberOfSeats: {
    type: 'SimpleSchema.Integer',
    optional: true,
  },
  numberOfQueueServerPoints: {
    type: 'SimpleSchema.Integer',
    optional: true,
  },
  ...getInteractableSchemaDefinition(QueueSystemInteractionsSet),
});