@themeparks/typelib 1.0.4 → 1.1.0

package/src/types/livedata.types.ts

@@ -0,0 +1,498 @@
+// THIS FILE IS GENERATED - DO NOT EDIT DIRECTLY
+
+import { PriceData } from './pricedata.types.js';
+
+export enum LiveStatusTypeEnum {
+    "OPERATING" = 'OPERATING',
+    "DOWN" = 'DOWN',
+    "CLOSED" = 'CLOSED',
+    "REFURBISHMENT" = 'REFURBISHMENT',
+}
+
+/** Current operating status of an entity */
+export type LiveStatusType = keyof typeof LiveStatusTypeEnum;
+
+// Function to convert string to LiveStatusTypeEnum
+export function StringToLiveStatusType(value: string): LiveStatusTypeEnum {
+    const lowerValue = value.toLowerCase();
+    switch (lowerValue) {
+        case 'operating':
+            return LiveStatusTypeEnum.OPERATING;
+        case 'down':
+            return LiveStatusTypeEnum.DOWN;
+        case 'closed':
+            return LiveStatusTypeEnum.CLOSED;
+        case 'refurbishment':
+            return LiveStatusTypeEnum.REFURBISHMENT;
+    }
+    throw new Error('Unknown LiveStatusType value: ' + value);
+}
+
+export enum ReturnTimeStateEnum {
+    "AVAILABLE" = 'AVAILABLE',
+    "TEMP_FULL" = 'TEMP_FULL',
+    "FINISHED" = 'FINISHED',
+}
+
+/** State of return time availability */
+export type ReturnTimeState = keyof typeof ReturnTimeStateEnum;
+
+// Function to convert string to ReturnTimeStateEnum
+export function StringToReturnTimeState(value: string): ReturnTimeStateEnum {
+    const lowerValue = value.toLowerCase();
+    switch (lowerValue) {
+        case 'available':
+            return ReturnTimeStateEnum.AVAILABLE;
+        case 'temp_full':
+            return ReturnTimeStateEnum.TEMP_FULL;
+        case 'finished':
+            return ReturnTimeStateEnum.FINISHED;
+    }
+    throw new Error('Unknown ReturnTimeState value: ' + value);
+}
+
+export enum BoardingGroupStateEnum {
+    "AVAILABLE" = 'AVAILABLE',
+    "PAUSED" = 'PAUSED',
+    "CLOSED" = 'CLOSED',
+}
+
+/** State of boarding group availability */
+export type BoardingGroupState = keyof typeof BoardingGroupStateEnum;
+
+// Function to convert string to BoardingGroupStateEnum
+export function StringToBoardingGroupState(value: string): BoardingGroupStateEnum {
+    const lowerValue = value.toLowerCase();
+    switch (lowerValue) {
+        case 'available':
+            return BoardingGroupStateEnum.AVAILABLE;
+        case 'paused':
+            return BoardingGroupStateEnum.PAUSED;
+        case 'closed':
+            return BoardingGroupStateEnum.CLOSED;
+    }
+    throw new Error('Unknown BoardingGroupState value: ' + value);
+}
+
+export enum QueueTypeEnum {
+    "STANDBY" = 'STANDBY',
+    "SINGLE_RIDER" = 'SINGLE_RIDER',
+    "RETURN_TIME" = 'RETURN_TIME',
+    "PAID_RETURN_TIME" = 'PAID_RETURN_TIME',
+    "BOARDING_GROUP" = 'BOARDING_GROUP',
+    "PAID_STANDBY" = 'PAID_STANDBY',
+}
+
+/** Types of queues that an attraction may have */
+export type QueueType = keyof typeof QueueTypeEnum;
+
+// Function to convert string to QueueTypeEnum
+export function StringToQueueType(value: string): QueueTypeEnum {
+    const lowerValue = value.toLowerCase();
+    switch (lowerValue) {
+        case 'standby':
+            return QueueTypeEnum.STANDBY;
+        case 'single_rider':
+            return QueueTypeEnum.SINGLE_RIDER;
+        case 'return_time':
+            return QueueTypeEnum.RETURN_TIME;
+        case 'paid_return_time':
+            return QueueTypeEnum.PAID_RETURN_TIME;
+        case 'boarding_group':
+            return QueueTypeEnum.BOARDING_GROUP;
+        case 'paid_standby':
+            return QueueTypeEnum.PAID_STANDBY;
+    }
+    throw new Error('Unknown QueueType value: ' + value);
+}
+
+export type LiveQueue = {
+    
+    /** Standard queue type for most attractions. Wait in line for attraction, no additional cost. */
+    STANDBY?: {
+    
+    /** Current standby wait time in minutes */
+    waitTime?: number;
+};
+    
+    /** Single Rider queue type for attractions that offer it. Usually a shorter wait time, but you may be separated from your party. No additional cost. */
+    SINGLE_RIDER?: {
+    
+    /** Current single rider wait time in minutes */
+    waitTime: number | null;
+};
+    
+    /** Return Time queue type for attractions that offer it. You get a return time to come back and ride the attraction later, instead of waiting in a physical line. No additional cost. */
+    RETURN_TIME?: {
+    
+    /** State of return time availability */
+    state: ReturnTimeState;
+    
+    /** Start time of return window */
+    returnStart: string | null;
+    
+    /** End time of return window */
+    returnEnd: string | null;
+};
+    
+    /** Paid Return Time queue type for attractions that offer it. You pay an additional cost to get a return time to come back and ride the attraction later, instead of waiting in a physical line. */
+    PAID_RETURN_TIME?: {
+    
+    /** State of return time availability */
+    state: ReturnTimeState;
+    
+    /** Start time of return window */
+    returnStart: string | null;
+    
+    /** End time of return window */
+    returnEnd: string | null;
+    
+    /** Price information for paid return time */
+    price: PriceData;
+};
+    
+    /** Boarding Group queue type for attractions that offer it. You get allocated a boarding group number and wait until your group is called. No additional cost. */
+    BOARDING_GROUP?: {
+    
+    /** State of boarding group availability */
+    allocationStatus: BoardingGroupState;
+    
+    /** Current boarding group start number */
+    currentGroupStart: number | null;
+    
+    /** Current boarding group end number */
+    currentGroupEnd: number | null;
+    
+    /** Next boarding group allocation time */
+    nextAllocationTime: string | null;
+    
+    /** Estimated wait time in minutes */
+    estimatedWait: number | null;
+};
+    
+    /** Paid Standby queue type for attractions that offer it. You pay an additional cost to use a separate standby line, usually with a shorter wait time. */
+    PAID_STANDBY?: {
+    
+    /** Current paid standby wait time in minutes */
+    waitTime: number | null;
+};
+}
+
+/** Time entry for shows or attraction operating hours */
+export type LiveTimeSlot = {
+    
+    /** Type of time entry */
+    type: string;
+    
+    /** Start time */
+    startTime?: string | null;
+    
+    /** End time */
+    endTime?: string | null;
+}
+
+/** Dining availability information for restaurants */
+export type DiningAvailability = {
+    
+    /** Available party size */
+    partySize?: number | null;
+    
+    /** Current wait time in minutes */
+    waitTime?: number | null;
+}
+
+export type LiveData = {
+    
+    /** Entity identifier */
+    id: string;
+    
+    /** Current operating status of the entity */
+    status?: LiveStatusType;
+    
+    /** Current queue information for entities with queues (e.g. attractions) */
+    queue?: LiveQueue;
+    
+    /** Array of showtime entries for entities that have scheduled showtimes (e.g. shows) */
+    showtimes?: LiveTimeSlot[];
+    
+    /** Array of operating hours entries for entities that have specific operating hours (e.g. parks, restaurants) */
+    operatingHours?: LiveTimeSlot[];
+    
+    /** Array of dining availability entries for entities that have dining options (e.g. restaurants) */
+    diningAvailability?: DiningAvailability[];
+}
+
+
+// Runtime Schema Registration
+import { registerTypeSchema } from "../type_register.js";
+
+registerTypeSchema("LiveStatusType", {
+  "type": "string",
+  "enum": [
+    "OPERATING",
+    "DOWN",
+    "CLOSED",
+    "REFURBISHMENT"
+  ],
+  "description": "Current operating status of an entity"
+});
+
+registerTypeSchema("ReturnTimeState", {
+  "type": "string",
+  "enum": [
+    "AVAILABLE",
+    "TEMP_FULL",
+    "FINISHED"
+  ],
+  "description": "State of return time availability"
+});
+
+registerTypeSchema("BoardingGroupState", {
+  "type": "string",
+  "enum": [
+    "AVAILABLE",
+    "PAUSED",
+    "CLOSED"
+  ],
+  "description": "State of boarding group availability"
+});
+
+registerTypeSchema("QueueType", {
+  "type": "string",
+  "enum": [
+    "STANDBY",
+    "SINGLE_RIDER",
+    "RETURN_TIME",
+    "PAID_RETURN_TIME",
+    "BOARDING_GROUP",
+    "PAID_STANDBY"
+  ],
+  "description": "Types of queues that an attraction may have"
+});
+
+registerTypeSchema("LiveQueue", {
+  "type": "object",
+  "properties": {
+    "STANDBY": {
+      "type": "object",
+      "properties": {
+        "waitTime": {
+          "type": "number",
+          "description": "Current standby wait time in minutes"
+        }
+      },
+      "description": "Standard queue type for most attractions. Wait in line for attraction, no additional cost."
+    },
+    "SINGLE_RIDER": {
+      "type": "object",
+      "required": [
+        "waitTime"
+      ],
+      "properties": {
+        "waitTime": {
+          "type": "number",
+          "nullable": true,
+          "description": "Current single rider wait time in minutes"
+        }
+      },
+      "description": "Single Rider queue type for attractions that offer it. Usually a shorter wait time, but you may be separated from your party. No additional cost."
+    },
+    "RETURN_TIME": {
+      "type": "object",
+      "required": [
+        "state",
+        "returnStart",
+        "returnEnd"
+      ],
+      "properties": {
+        "state": {
+          "$ref": "#/properties/ReturnTimeState",
+          "description": "State of return time availability"
+        },
+        "returnStart": {
+          "type": "string",
+          "format": "date-time",
+          "nullable": true,
+          "description": "Start time of return window"
+        },
+        "returnEnd": {
+          "type": "string",
+          "format": "date-time",
+          "nullable": true,
+          "description": "End time of return window"
+        }
+      },
+      "description": "Return Time queue type for attractions that offer it. You get a return time to come back and ride the attraction later, instead of waiting in a physical line. No additional cost."
+    },
+    "PAID_RETURN_TIME": {
+      "type": "object",
+      "required": [
+        "state",
+        "returnStart",
+        "returnEnd",
+        "price"
+      ],
+      "properties": {
+        "state": {
+          "$ref": "#/properties/ReturnTimeState",
+          "description": "State of return time availability"
+        },
+        "returnStart": {
+          "type": "string",
+          "format": "date-time",
+          "nullable": true,
+          "description": "Start time of return window"
+        },
+        "returnEnd": {
+          "type": "string",
+          "format": "date-time",
+          "nullable": true,
+          "description": "End time of return window"
+        },
+        "price": {
+          "$ref": "#/properties/PriceData",
+          "description": "Price information for paid return time"
+        }
+      },
+      "description": "Paid Return Time queue type for attractions that offer it. You pay an additional cost to get a return time to come back and ride the attraction later, instead of waiting in a physical line."
+    },
+    "BOARDING_GROUP": {
+      "type": "object",
+      "required": [
+        "allocationStatus",
+        "currentGroupStart",
+        "currentGroupEnd",
+        "nextAllocationTime",
+        "estimatedWait"
+      ],
+      "properties": {
+        "allocationStatus": {
+          "$ref": "#/properties/BoardingGroupState",
+          "description": "State of boarding group availability"
+        },
+        "currentGroupStart": {
+          "type": "number",
+          "nullable": true,
+          "description": "Current boarding group start number"
+        },
+        "currentGroupEnd": {
+          "type": "number",
+          "nullable": true,
+          "description": "Current boarding group end number"
+        },
+        "nextAllocationTime": {
+          "type": "string",
+          "format": "date-time",
+          "nullable": true,
+          "description": "Next boarding group allocation time"
+        },
+        "estimatedWait": {
+          "type": "number",
+          "nullable": true,
+          "description": "Estimated wait time in minutes"
+        }
+      },
+      "description": "Boarding Group queue type for attractions that offer it. You get allocated a boarding group number and wait until your group is called. No additional cost."
+    },
+    "PAID_STANDBY": {
+      "type": "object",
+      "required": [
+        "waitTime"
+      ],
+      "properties": {
+        "waitTime": {
+          "type": "number",
+          "nullable": true,
+          "description": "Current paid standby wait time in minutes"
+        }
+      },
+      "description": "Paid Standby queue type for attractions that offer it. You pay an additional cost to use a separate standby line, usually with a shorter wait time."
+    }
+  }
+});
+
+registerTypeSchema("LiveTimeSlot", {
+  "type": "object",
+  "required": [
+    "type"
+  ],
+  "properties": {
+    "type": {
+      "type": "string",
+      "description": "Type of time entry"
+    },
+    "startTime": {
+      "type": "string",
+      "format": "date-time",
+      "nullable": true,
+      "description": "Start time"
+    },
+    "endTime": {
+      "type": "string",
+      "format": "date-time",
+      "nullable": true,
+      "description": "End time"
+    }
+  },
+  "description": "Time entry for shows or attraction operating hours"
+});
+
+registerTypeSchema("DiningAvailability", {
+  "type": "object",
+  "properties": {
+    "partySize": {
+      "type": "number",
+      "nullable": true,
+      "description": "Available party size"
+    },
+    "waitTime": {
+      "type": "number",
+      "nullable": true,
+      "description": "Current wait time in minutes"
+    }
+  },
+  "description": "Dining availability information for restaurants"
+});
+
+registerTypeSchema("LiveData", {
+  "type": "object",
+  "required": [
+    "id"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Entity identifier"
+    },
+    "status": {
+      "$ref": "#/properties/LiveStatusType",
+      "description": "Current operating status of the entity"
+    },
+    "queue": {
+      "$ref": "#/properties/LiveQueue",
+      "description": "Current queue information for entities with queues (e.g. attractions)"
+    },
+    "showtimes": {
+      "type": "array",
+      "items": {
+        "$ref": "#/properties/LiveTimeSlot"
+      },
+      "description": "Array of showtime entries for entities that have scheduled showtimes (e.g. shows)"
+    },
+    "operatingHours": {
+      "type": "array",
+      "items": {
+        "$ref": "#/properties/LiveTimeSlot"
+      },
+      "description": "Array of operating hours entries for entities that have specific operating hours (e.g. parks, restaurants)"
+    },
+    "diningAvailability": {
+      "type": "array",
+      "items": {
+        "$ref": "#/properties/DiningAvailability"
+      },
+      "description": "Array of dining availability entries for entities that have dining options (e.g. restaurants)"
+    }
+  }
+});
+

package/src/types/pricedata.types.ts

@@ -0,0 +1,77 @@
+// THIS FILE IS GENERATED - DO NOT EDIT DIRECTLY
+
+export enum CurrencyTypesEnum {
+    "USD" = 'USD',
+    "EUR" = 'EUR',
+    "GBP" = 'GBP',
+    "JPY" = 'JPY',
+}
+
+/** Currently supported currency codes by ThemeParks.wiki */
+export type CurrencyTypes = keyof typeof CurrencyTypesEnum;
+
+// Function to convert string to CurrencyTypesEnum
+export function StringToCurrencyTypes(value: string): CurrencyTypesEnum {
+    const lowerValue = value.toLowerCase();
+    switch (lowerValue) {
+        case 'usd':
+            return CurrencyTypesEnum.USD;
+        case 'eur':
+            return CurrencyTypesEnum.EUR;
+        case 'gbp':
+            return CurrencyTypesEnum.GBP;
+        case 'jpy':
+            return CurrencyTypesEnum.JPY;
+    }
+    throw new Error('Unknown CurrencyTypes value: ' + value);
+}
+
+export type PriceData = {
+    
+    /** Numerical price amount. Always in the lowest denomination (e.g. cents for USD) */
+    amount: number;
+    
+    /** Currency code */
+    currency: CurrencyTypes;
+    
+    /** Formatted price string in human-readable format. E.g. $12.00 */
+    formatted?: string;
+}
+
+
+// Runtime Schema Registration
+import { registerTypeSchema } from "../type_register.js";
+
+registerTypeSchema("CurrencyTypes", {
+  "type": "string",
+  "enum": [
+    "USD",
+    "EUR",
+    "GBP",
+    "JPY"
+  ],
+  "description": "Currently supported currency codes by ThemeParks.wiki"
+});
+
+registerTypeSchema("PriceData", {
+  "type": "object",
+  "required": [
+    "amount",
+    "currency"
+  ],
+  "properties": {
+    "amount": {
+      "type": "number",
+      "description": "Numerical price amount. Always in the lowest denomination (e.g. cents for USD)"
+    },
+    "currency": {
+      "$ref": "#/properties/CurrencyTypes",
+      "description": "Currency code"
+    },
+    "formatted": {
+      "type": "string",
+      "description": "Formatted price string in human-readable format. E.g. $12.00"
+    }
+  }
+});
+

package/src/types/schedule.types.ts

@@ -0,0 +1,137 @@
+// THIS FILE IS GENERATED - DO NOT EDIT DIRECTLY
+
+export enum ScheduleTypeEnum {
+    "OPERATING" = 'OPERATING',
+    "TICKETED_EVENT" = 'TICKETED_EVENT',
+    "PRIVATE_EVENT" = 'PRIVATE_EVENT',
+    "EXTRA_HOURS" = 'EXTRA_HOURS',
+    "INFO" = 'INFO',
+}
+
+/** Types of schedule entries for parks */
+export type ScheduleType = keyof typeof ScheduleTypeEnum;
+
+// Function to convert string to ScheduleTypeEnum
+export function StringToScheduleType(value: string): ScheduleTypeEnum {
+    const lowerValue = value.toLowerCase();
+    switch (lowerValue) {
+        case 'operating':
+            return ScheduleTypeEnum.OPERATING;
+        case 'ticketed_event':
+            return ScheduleTypeEnum.TICKETED_EVENT;
+        case 'private_event':
+            return ScheduleTypeEnum.PRIVATE_EVENT;
+        case 'extra_hours':
+            return ScheduleTypeEnum.EXTRA_HOURS;
+        case 'info':
+            return ScheduleTypeEnum.INFO;
+    }
+    throw new Error('Unknown ScheduleType value: ' + value);
+}
+
+/** Represents a single schedule entry */
+export type ScheduleEntry = {
+    
+    /** The date of the schedule entry, YYYY-MM-DD format */
+    date: string;
+    
+    /** Type of schedule entry e.g. OPERATING, EXTRA_HOURS, etc. */
+    type: ScheduleType;
+    
+    /** Optional description of the schedule entry */
+    description?: string;
+    
+    /** Opening time for this schedule entry */
+    openingTime: string;
+    
+    /** Closing time for this schedule entry */
+    closingTime: string;
+}
+
+/** Represents the schedule for a specific park entity */
+export type EntitySchedule = {
+    
+    /** Identifier of the park entity this schedule belongs to */
+    id: string;
+    
+    /** Array of schedule entries for the park */
+    schedule: ScheduleEntry[];
+}
+
+
+// Runtime Schema Registration
+import { registerTypeSchema } from "../type_register.js";
+
+registerTypeSchema("ScheduleType", {
+  "type": "string",
+  "enum": [
+    "OPERATING",
+    "TICKETED_EVENT",
+    "PRIVATE_EVENT",
+    "EXTRA_HOURS",
+    "INFO"
+  ],
+  "description": "Types of schedule entries for parks"
+});
+
+registerTypeSchema("ScheduleEntry", {
+  "type": "object",
+  "required": [
+    "date",
+    "type",
+    "openingTime",
+    "closingTime"
+  ],
+  "properties": {
+    "date": {
+      "type": "string",
+      "description": "The date of the schedule entry, YYYY-MM-DD format",
+      "format": "date",
+      "example": "1992-04-12"
+    },
+    "type": {
+      "$ref": "#/properties/ScheduleType",
+      "description": "Type of schedule entry e.g. OPERATING, EXTRA_HOURS, etc."
+    },
+    "description": {
+      "type": "string",
+      "description": "Optional description of the schedule entry"
+    },
+    "openingTime": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Opening time for this schedule entry",
+      "example": "1992-04-12T09:00:00-07:00"
+    },
+    "closingTime": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Closing time for this schedule entry",
+      "example": "1992-04-12T17:00:00-07:00"
+    }
+  },
+  "description": "Represents a single schedule entry"
+});
+
+registerTypeSchema("EntitySchedule", {
+  "type": "object",
+  "required": [
+    "id",
+    "schedule"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Identifier of the park entity this schedule belongs to"
+    },
+    "schedule": {
+      "type": "array",
+      "items": {
+        "$ref": "#/properties/ScheduleEntry"
+      },
+      "description": "Array of schedule entries for the park"
+    }
+  },
+  "description": "Represents the schedule for a specific park entity"
+});
+