typed-factorio 0.5.0 → 0.7.0

package/generated/events.d.ts

@@ -15,7 +15,7 @@ interface CustomInputEvent {
   /** Information about the prototype that is selected when the custom input is used. `nil` if none is selected. */
   readonly selected_prototype?: SelectedPrototypeData
   /** Identifier of the event */
-  readonly name: defines.events
+  readonly name: string
   /** Tick the event was generated. */
   readonly tick: uint
 }
@@ -347,6 +347,8 @@ interface OnCutsceneCancelledEvent {
  *
  * This refers to an index in the table previously passed to set_controller which started the cutscene.
  *
+ * **Note**: Due to implementation omission, waypoint_index is 0-based.
+ *
  * {@link https://lua-api.factorio.com/next/Events.html#on_cutscene_waypoint_reached View documentation}
  */
 interface OnCutsceneWaypointReachedEvent {
@@ -2959,201 +2961,16 @@ interface ScriptRaisedSetTilesEvent {
   readonly tick: uint
 }
 
-interface EventTypes {
-  [defines.events.on_tick]: OnTickEvent
-  [defines.events.on_gui_click]: OnGuiClickEvent
-  [defines.events.on_gui_confirmed]: OnGuiConfirmedEvent
-  [defines.events.on_gui_text_changed]: OnGuiTextChangedEvent
-  [defines.events.on_gui_checked_state_changed]: OnGuiCheckedStateChangedEvent
-  [defines.events.on_entity_died]: OnEntityDiedEvent
-  [defines.events.on_post_entity_died]: OnPostEntityDiedEvent
-  [defines.events.on_entity_damaged]: OnEntityDamagedEvent
-  [defines.events.on_picked_up_item]: OnPickedUpItemEvent
-  [defines.events.on_built_entity]: OnBuiltEntityEvent
-  [defines.events.on_sector_scanned]: OnSectorScannedEvent
-  [defines.events.on_player_mined_item]: OnPlayerMinedItemEvent
-  [defines.events.on_pre_build]: OnPreBuildEvent
-  [defines.events.on_rocket_launched]: OnRocketLaunchedEvent
-  [defines.events.on_pre_player_mined_item]: OnPrePlayerMinedItemEvent
-  [defines.events.on_chunk_generated]: OnChunkGeneratedEvent
-  [defines.events.on_player_crafted_item]: OnPlayerCraftedItemEvent
-  [defines.events.on_robot_built_entity]: OnRobotBuiltEntityEvent
-  [defines.events.on_robot_pre_mined]: OnRobotPreMinedEvent
-  [defines.events.on_robot_mined]: OnRobotMinedEvent
-  [defines.events.on_research_started]: OnResearchStartedEvent
-  [defines.events.on_research_finished]: OnResearchFinishedEvent
-  [defines.events.on_research_reversed]: OnResearchReversedEvent
-  [defines.events.on_player_rotated_entity]: OnPlayerRotatedEntityEvent
-  [defines.events.on_marked_for_deconstruction]: OnMarkedForDeconstructionEvent
-  [defines.events.on_cancelled_deconstruction]: OnCancelledDeconstructionEvent
-  [defines.events.on_trigger_created_entity]: OnTriggerCreatedEntityEvent
-  [defines.events.on_trigger_fired_artillery]: OnTriggerFiredArtilleryEvent
-  [defines.events.on_train_changed_state]: OnTrainChangedStateEvent
-  [defines.events.on_player_created]: OnPlayerCreatedEvent
-  [defines.events.on_resource_depleted]: OnResourceDepletedEvent
-  [defines.events.on_player_driving_changed_state]: OnPlayerDrivingChangedStateEvent
-  [defines.events.on_force_created]: OnForceCreatedEvent
-  [defines.events.on_forces_merging]: OnForcesMergingEvent
-  [defines.events.on_player_cursor_stack_changed]: OnPlayerCursorStackChangedEvent
-  [defines.events.on_pre_entity_settings_pasted]: OnPreEntitySettingsPastedEvent
-  [defines.events.on_entity_settings_pasted]: OnEntitySettingsPastedEvent
-  [defines.events.on_player_main_inventory_changed]: OnPlayerMainInventoryChangedEvent
-  [defines.events.on_player_armor_inventory_changed]: OnPlayerArmorInventoryChangedEvent
-  [defines.events.on_player_ammo_inventory_changed]: OnPlayerAmmoInventoryChangedEvent
-  [defines.events.on_player_gun_inventory_changed]: OnPlayerGunInventoryChangedEvent
-  [defines.events.on_player_placed_equipment]: OnPlayerPlacedEquipmentEvent
-  [defines.events.on_player_removed_equipment]: OnPlayerRemovedEquipmentEvent
-  [defines.events.on_pre_player_died]: OnPrePlayerDiedEvent
-  [defines.events.on_player_died]: OnPlayerDiedEvent
-  [defines.events.on_player_respawned]: OnPlayerRespawnedEvent
-  [defines.events.on_player_joined_game]: OnPlayerJoinedGameEvent
-  [defines.events.on_player_left_game]: OnPlayerLeftGameEvent
-  [defines.events.on_player_built_tile]: OnPlayerBuiltTileEvent
-  [defines.events.on_player_mined_tile]: OnPlayerMinedTileEvent
-  [defines.events.on_robot_built_tile]: OnRobotBuiltTileEvent
-  [defines.events.on_robot_mined_tile]: OnRobotMinedTileEvent
-  [defines.events.on_player_selected_area]: OnPlayerSelectedAreaEvent
-  [defines.events.on_player_alt_selected_area]: OnPlayerAltSelectedAreaEvent
-  [defines.events.on_player_changed_surface]: OnPlayerChangedSurfaceEvent
-  [defines.events.on_selected_entity_changed]: OnSelectedEntityChangedEvent
-  [defines.events.on_market_item_purchased]: OnMarketItemPurchasedEvent
-  [defines.events.on_player_dropped_item]: OnPlayerDroppedItemEvent
-  [defines.events.on_biter_base_built]: OnBiterBaseBuiltEvent
-  [defines.events.on_player_changed_force]: OnPlayerChangedForceEvent
-  [defines.events.on_entity_renamed]: OnEntityRenamedEvent
-  [defines.events.on_gui_selection_state_changed]: OnGuiSelectionStateChangedEvent
-  [defines.events.on_runtime_mod_setting_changed]: OnRuntimeModSettingChangedEvent
-  [defines.events.on_difficulty_settings_changed]: OnDifficultySettingsChangedEvent
-  [defines.events.on_surface_created]: OnSurfaceCreatedEvent
-  [defines.events.on_surface_deleted]: OnSurfaceDeletedEvent
-  [defines.events.on_pre_surface_deleted]: OnPreSurfaceDeletedEvent
-  [defines.events.on_player_mined_entity]: OnPlayerMinedEntityEvent
-  [defines.events.on_robot_mined_entity]: OnRobotMinedEntityEvent
-  [defines.events.on_train_created]: OnTrainCreatedEvent
-  [defines.events.on_gui_elem_changed]: OnGuiElemChangedEvent
-  [defines.events.on_player_setup_blueprint]: OnPlayerSetupBlueprintEvent
-  [defines.events.on_player_deconstructed_area]: OnPlayerDeconstructedAreaEvent
-  [defines.events.on_player_configured_blueprint]: OnPlayerConfiguredBlueprintEvent
-  [defines.events.on_console_chat]: OnConsoleChatEvent
-  [defines.events.on_console_command]: OnConsoleCommandEvent
-  [defines.events.on_player_removed]: OnPlayerRemovedEvent
-  [defines.events.on_pre_player_removed]: OnPrePlayerRemovedEvent
-  [defines.events.on_player_used_capsule]: OnPlayerUsedCapsuleEvent
-  [defines.events.script_raised_built]: ScriptRaisedBuiltEvent
-  [defines.events.script_raised_destroy]: ScriptRaisedDestroyEvent
-  [defines.events.script_raised_revive]: ScriptRaisedReviveEvent
-  [defines.events.script_raised_set_tiles]: ScriptRaisedSetTilesEvent
-  [defines.events.on_player_promoted]: OnPlayerPromotedEvent
-  [defines.events.on_player_demoted]: OnPlayerDemotedEvent
-  [defines.events.on_combat_robot_expired]: OnCombatRobotExpiredEvent
-  [defines.events.on_worker_robot_expired]: OnWorkerRobotExpiredEvent
-  [defines.events.on_player_changed_position]: OnPlayerChangedPositionEvent
-  [defines.events.on_mod_item_opened]: OnModItemOpenedEvent
-  [defines.events.on_gui_opened]: OnGuiOpenedEvent
-  [defines.events.on_gui_closed]: OnGuiClosedEvent
-  [defines.events.on_gui_value_changed]: OnGuiValueChangedEvent
-  [defines.events.on_player_muted]: OnPlayerMutedEvent
-  [defines.events.on_player_unmuted]: OnPlayerUnmutedEvent
-  [defines.events.on_player_cheat_mode_enabled]: OnPlayerCheatModeEnabledEvent
-  [defines.events.on_player_cheat_mode_disabled]: OnPlayerCheatModeDisabledEvent
-  [defines.events.on_character_corpse_expired]: OnCharacterCorpseExpiredEvent
-  [defines.events.on_pre_ghost_deconstructed]: OnPreGhostDeconstructedEvent
-  [defines.events.on_player_pipette]: OnPlayerPipetteEvent
-  [defines.events.on_player_display_resolution_changed]: OnPlayerDisplayResolutionChangedEvent
-  [defines.events.on_player_display_scale_changed]: OnPlayerDisplayScaleChangedEvent
-  [defines.events.on_pre_player_crafted_item]: OnPrePlayerCraftedItemEvent
-  [defines.events.on_player_cancelled_crafting]: OnPlayerCancelledCraftingEvent
-  [defines.events.on_chunk_charted]: OnChunkChartedEvent
-  [defines.events.on_technology_effects_reset]: OnTechnologyEffectsResetEvent
-  [defines.events.on_force_reset]: OnForceResetEvent
-  [defines.events.on_land_mine_armed]: OnLandMineArmedEvent
-  [defines.events.on_forces_merged]: OnForcesMergedEvent
-  [defines.events.on_player_trash_inventory_changed]: OnPlayerTrashInventoryChangedEvent
-  [defines.events.on_pre_player_left_game]: OnPrePlayerLeftGameEvent
-  [defines.events.on_pre_surface_cleared]: OnPreSurfaceClearedEvent
-  [defines.events.on_surface_cleared]: OnSurfaceClearedEvent
-  [defines.events.on_chunk_deleted]: OnChunkDeletedEvent
-  [defines.events.on_pre_chunk_deleted]: OnPreChunkDeletedEvent
-  [defines.events.on_train_schedule_changed]: OnTrainScheduleChangedEvent
-  [defines.events.on_player_banned]: OnPlayerBannedEvent
-  [defines.events.on_player_kicked]: OnPlayerKickedEvent
-  [defines.events.on_player_unbanned]: OnPlayerUnbannedEvent
-  [defines.events.on_rocket_launch_ordered]: OnRocketLaunchOrderedEvent
-  [defines.events.on_script_path_request_finished]: OnScriptPathRequestFinishedEvent
-  [defines.events.on_ai_command_completed]: OnAiCommandCompletedEvent
-  [defines.events.on_marked_for_upgrade]: OnMarkedForUpgradeEvent
-  [defines.events.on_cancelled_upgrade]: OnCancelledUpgradeEvent
-  [defines.events.on_player_toggled_map_editor]: OnPlayerToggledMapEditorEvent
-  [defines.events.on_entity_cloned]: OnEntityClonedEvent
-  [defines.events.on_area_cloned]: OnAreaClonedEvent
-  [defines.events.on_brush_cloned]: OnBrushClonedEvent
-  [defines.events.on_game_created_from_scenario]: OnGameCreatedFromScenarioEvent
-  [defines.events.on_surface_imported]: OnSurfaceImportedEvent
-  [defines.events.on_surface_renamed]: OnSurfaceRenamedEvent
-  [defines.events.on_player_toggled_alt_mode]: OnPlayerToggledAltModeEvent
-  [defines.events.on_player_repaired_entity]: OnPlayerRepairedEntityEvent
-  [defines.events.on_player_fast_transferred]: OnPlayerFastTransferredEvent
-  [defines.events.on_pre_robot_exploded_cliff]: OnPreRobotExplodedCliffEvent
-  [defines.events.on_robot_exploded_cliff]: OnRobotExplodedCliffEvent
-  [defines.events.on_entity_spawned]: OnEntitySpawnedEvent
-  [defines.events.on_cutscene_waypoint_reached]: OnCutsceneWaypointReachedEvent
-  [defines.events.on_unit_group_created]: OnUnitGroupCreatedEvent
-  [defines.events.on_unit_added_to_group]: OnUnitAddedToGroupEvent
-  [defines.events.on_unit_removed_from_group]: OnUnitRemovedFromGroupEvent
-  [defines.events.on_unit_group_finished_gathering]: OnUnitGroupFinishedGatheringEvent
-  [defines.events.on_build_base_arrived]: OnBuildBaseArrivedEvent
-  [defines.events.on_chart_tag_added]: OnChartTagAddedEvent
-  [defines.events.on_chart_tag_modified]: OnChartTagModifiedEvent
-  [defines.events.on_chart_tag_removed]: OnChartTagRemovedEvent
-  [defines.events.on_lua_shortcut]: OnLuaShortcutEvent
-  [defines.events.on_gui_location_changed]: OnGuiLocationChangedEvent
-  [defines.events.on_gui_selected_tab_changed]: OnGuiSelectedTabChangedEvent
-  [defines.events.on_gui_switch_state_changed]: OnGuiSwitchStateChangedEvent
-  [defines.events.on_force_cease_fire_changed]: OnForceCeaseFireChangedEvent
-  [defines.events.on_force_friends_changed]: OnForceFriendsChangedEvent
-  [defines.events.on_string_translated]: OnStringTranslatedEvent
-  [defines.events.on_script_trigger_effect]: OnScriptTriggerEffectEvent
-  [defines.events.on_player_set_quick_bar_slot]: OnPlayerSetQuickBarSlotEvent
-  [defines.events.on_pre_player_toggled_map_editor]: OnPrePlayerToggledMapEditorEvent
-  [defines.events.on_pre_script_inventory_resized]: OnPreScriptInventoryResizedEvent
-  [defines.events.on_script_inventory_resized]: OnScriptInventoryResizedEvent
-  [defines.events.on_entity_destroyed]: OnEntityDestroyedEvent
-  [defines.events.on_player_clicked_gps_tag]: OnPlayerClickedGpsTagEvent
-  [defines.events.on_player_flushed_fluid]: OnPlayerFlushedFluidEvent
-  [defines.events.on_permission_group_edited]: OnPermissionGroupEditedEvent
-  [defines.events.on_pre_permission_string_imported]: OnPrePermissionStringImportedEvent
-  [defines.events.on_permission_string_imported]: OnPermissionStringImportedEvent
-  [defines.events.on_pre_permission_group_deleted]: OnPrePermissionGroupDeletedEvent
-  [defines.events.on_permission_group_deleted]: OnPermissionGroupDeletedEvent
-  [defines.events.on_permission_group_added]: OnPermissionGroupAddedEvent
-  [defines.events.on_cutscene_cancelled]: OnCutsceneCancelledEvent
-  [defines.events.on_player_configured_spider_remote]: OnPlayerConfiguredSpiderRemoteEvent
-  [defines.events.on_player_used_spider_remote]: OnPlayerUsedSpiderRemoteEvent
-  [defines.events.on_spider_command_completed]: OnSpiderCommandCompletedEvent
-  [defines.events.on_entity_logistic_slot_changed]: OnEntityLogisticSlotChangedEvent
-  [defines.events.on_equipment_inserted]: OnEquipmentInsertedEvent
-  [defines.events.on_equipment_removed]: OnEquipmentRemovedEvent
-}
-
-interface EventFilters {
-  [defines.events.on_entity_died]: LuaEntityDiedEventFilter
-  [defines.events.on_post_entity_died]: LuaPostEntityDiedEventFilter
-  [defines.events.on_entity_damaged]: LuaEntityDamagedEventFilter
-  [defines.events.on_built_entity]: LuaPlayerBuiltEntityEventFilter
-  [defines.events.on_sector_scanned]: LuaSectorScannedEventFilter
-  [defines.events.on_pre_player_mined_item]: LuaPrePlayerMinedEntityEventFilter
-  [defines.events.on_robot_built_entity]: LuaRobotBuiltEntityEventFilter
-  [defines.events.on_robot_pre_mined]: LuaPreRobotMinedEntityEventFilter
-  [defines.events.on_marked_for_deconstruction]: LuaEntityMarkedForDeconstructionEventFilter
-  [defines.events.on_cancelled_deconstruction]: LuaEntityDeconstructionCancelledEventFilter
-  [defines.events.on_player_mined_entity]: LuaPlayerMinedEntityEventFilter
-  [defines.events.on_robot_mined_entity]: LuaRobotMinedEntityEventFilter
-  [defines.events.script_raised_built]: LuaScriptRaisedBuiltEventFilter
-  [defines.events.script_raised_destroy]: LuaScriptRaisedDestroyEventFilter
-  [defines.events.script_raised_revive]: LuaScriptRaisedReviveEventFilter
-  [defines.events.on_pre_ghost_deconstructed]: LuaPreGhostDeconstructedEventFilter
-  [defines.events.on_marked_for_upgrade]: LuaEntityMarkedForUpgradeEventFilter
-  [defines.events.on_cancelled_upgrade]: LuaUpgradeCancelledEventFilter
-  [defines.events.on_entity_cloned]: LuaEntityClonedEventFilter
-  [defines.events.on_player_repaired_entity]: LuaPlayerRepairedEntityEventFilter
+/** An event id. */
+type EventId<T extends table, F extends table | void = void> = uint & {
+  readonly _eventData: T
+  readonly _filter: F
+}
+
+/**
+ * An event id generated by {@link LuaBootstrap.generate_event_name LuaBootstrap::generate_event_name} and raisable via
+ * {@link LuaBootstrap.raise_event LuaBootstrap::raise_event}.
+ */
+type CustomEventId<T extends table> = EventId<T> & {
+  _customEventIdBrand: any
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",
@@ -25,7 +25,8 @@
   },
   "dependencies": {
     "lua-types": "^2.10.1",
-    "typescript-to-lua": "^0.42.0"
+    "typescript": "~4.3.5",
+    "typescript-to-lua": "^1.0.0"
   },
   "devDependencies": {
     "@types/jest": "^26.0.24",
@@ -33,7 +34,6 @@
     "jest": "^27.0.6",
     "prettier": "^2.3.2",
     "ts-jest": "^27.0.4",
-    "ts-node": "^10.1.0",
-    "typescript": "^4.3.5"
+    "ts-node": "^10.1.0"
   }
 }