typed-factorio 1.5.0 → 1.5.1

package/Changelog.md

@@ -1,3 +1,7 @@
+# v1.5.1
+
+- Added old `Read` types as deprecated type aliases of new types; to help with migration.
+
 # v1.5.0
 
 ### BREAKING

package/generated/concepts.d.ts

@@ -357,6 +357,11 @@ interface ScriptAreaWrite {
   readonly id: uint
 }
 
+/**
+ * @deprecated Use {@link ScriptArea} instead
+ */
+type ScriptAreaRead = ScriptArea
+
 /**
  * A position defined using the map editor.
  * @see ScriptPositionWrite
@@ -380,6 +385,11 @@ interface ScriptPositionWrite {
   readonly id: uint
 }
 
+/**
+ * @deprecated Use {@link ScriptPosition} instead
+ */
+type ScriptPositionRead = ScriptPosition
+
 /**
  * Red, green, blue and alpha values, all in range [0, 1] or all in range [0, 255] if any value is > 1. All values here are optional. Color channels default to `0`, the alpha channel defaults to `1`.
  *
@@ -1353,6 +1363,11 @@ interface BlueprintEntityWrite {
   readonly station?: string
 }
 
+/**
+ * @deprecated Use {@link BlueprintEntity} instead
+ */
+type BlueprintEntityRead = BlueprintEntity
+
 /**
  * @see TileWrite
  * @see {@link https://lua-api.factorio.com/latest/Concepts.html#Tile Online documentation}
@@ -1383,6 +1398,11 @@ interface TileWrite {
   readonly name: string
 }
 
+/**
+ * @deprecated Use {@link Tile} instead
+ */
+type TileRead = Tile
+
 interface Fluid {
   /**
    * Fluid prototype name of the fluid.
@@ -1947,6 +1967,11 @@ interface AutoplaceControlWrite {
   readonly richness: MapGenSize
 }
 
+/**
+ * @deprecated Use {@link AutoplaceControl} instead
+ */
+type AutoplaceControlRead = AutoplaceControl
+
 /**
  * @see AutoplaceSettingsWrite
  * @see {@link https://lua-api.factorio.com/latest/Concepts.html#AutoplaceSettings Online documentation}
@@ -1971,6 +1996,11 @@ interface AutoplaceSettingsWrite {
   readonly settings: Record<string, AutoplaceControlWrite>
 }
 
+/**
+ * @deprecated Use {@link AutoplaceSettings} instead
+ */
+type AutoplaceSettingsRead = AutoplaceSettings
+
 /**
  * @see CliffPlacementSettingsWrite
  * @see {@link https://lua-api.factorio.com/latest/Concepts.html#CliffPlacementSettings Online documentation}
@@ -2017,6 +2047,11 @@ interface CliffPlacementSettingsWrite {
   readonly richness: MapGenSize
 }
 
+/**
+ * @deprecated Use {@link CliffPlacementSettings} instead
+ */
+type CliffPlacementSettingsRead = CliffPlacementSettings
+
 /**
  * The 'map type' dropdown in the map generation GUI is actually a selector for elevation generator. The base game sets `property_expression_names.elevation` to `"0_16-elevation"` to reproduce terrain from 0.16 or to `"0_17-island"` for the island preset. If generators are available for other properties, the 'map type' dropdown in the GUI will be renamed to 'elevation' and shown along with selectors for the other selectable properties.
  * @see MapGenSettingsWrite
@@ -2180,6 +2215,11 @@ interface MapGenSettingsWrite {
   readonly property_expression_names: Record<string, string>
 }
 
+/**
+ * @deprecated Use {@link MapGenSettings} instead
+ */
+type MapGenSettingsRead = MapGenSettings
+
 interface AdvancedMapGenSettings {
   readonly pollution: PollutionMapSettings
   readonly enemy_evolution: EnemyEvolutionMapSettings
@@ -2481,6 +2521,11 @@ interface DeciderCombinatorParametersWrite {
   readonly copy_count_from_input?: boolean
 }
 
+/**
+ * @deprecated Use {@link DeciderCombinatorParameters} instead
+ */
+type DeciderCombinatorParametersRead = DeciderCombinatorParameters
+
 interface InserterCircuitConditions {
   readonly circuit?: CircuitConditionWrite
   readonly logistics?: CircuitConditionWrite
@@ -2532,6 +2577,11 @@ interface CircuitConditionWrite {
   readonly constant?: int
 }
 
+/**
+ * @deprecated Use {@link CircuitCondition} instead
+ */
+type CircuitConditionRead = CircuitCondition
+
 /**
  * @see CircuitConditionDefinitionWrite
  * @see {@link https://lua-api.factorio.com/latest/Concepts.html#CircuitConditionDefinition Online documentation}
@@ -2556,6 +2606,11 @@ interface CircuitConditionDefinitionWrite {
   readonly fulfilled?: boolean
 }
 
+/**
+ * @deprecated Use {@link CircuitConditionDefinition} instead
+ */
+type CircuitConditionDefinitionRead = CircuitConditionDefinition
+
 interface CircuitConnectionDefinition {
   /**
    * Wire color, either {@link defines.wire_type.red} or {@link defines.wire_type.green}.
@@ -3158,6 +3213,11 @@ interface WaitConditionWrite {
   readonly condition?: CircuitConditionWrite
 }
 
+/**
+ * @deprecated Use {@link WaitCondition} instead
+ */
+type WaitConditionRead = WaitCondition
+
 /**
  * @see TrainScheduleRecordWrite
  * @see {@link https://lua-api.factorio.com/latest/Concepts.html#TrainScheduleRecord Online documentation}
@@ -3206,6 +3266,11 @@ interface TrainScheduleRecordWrite {
   readonly temporary?: boolean
 }
 
+/**
+ * @deprecated Use {@link TrainScheduleRecord} instead
+ */
+type TrainScheduleRecordRead = TrainScheduleRecord
+
 /**
  * @see TrainScheduleWrite
  * @see {@link https://lua-api.factorio.com/latest/Concepts.html#TrainSchedule Online documentation}
@@ -3230,6 +3295,11 @@ interface TrainScheduleWrite {
   readonly records: readonly TrainScheduleRecordWrite[]
 }
 
+/**
+ * @deprecated Use {@link TrainSchedule} instead
+ */
+type TrainScheduleRead = TrainSchedule
+
 interface BaseGuiArrowSpecification {
   /**
    * This determines which of the following fields will be required. Must be one of `"nowhere"` (will remove the arrow entirely), `"goal"` (will point to the current goal), `"entity_info"`, `"active_window"`, `"entity"`, `"position"`, `"crafting_queue"` or `"item_stack"` (will point to a given item stack in an inventory). Depending on this value, other fields may have to be specified.
@@ -4503,6 +4573,11 @@ type PrototypeFilterWrite = readonly (
   | TechnologyPrototypeFilterWrite
 )[]
 
+/**
+ * @deprecated Use {@link PrototypeFilter} instead
+ */
+type PrototypeFilterRead = PrototypeFilter
+
 /**
  * Common attributes to all variants of {@link ItemPrototypeFilter}.
  */
@@ -6297,6 +6372,11 @@ type EventFilterWrite = readonly (
   | LuaPlayerRepairedEntityEventFilter
 )[]
 
+/**
+ * @deprecated Use {@link EventFilter} instead
+ */
+type EventFilterRead = EventFilter
+
 /**
  * Common attributes to all variants of {@link LuaScriptRaisedReviveEventFilter}.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",