typed-factorio 1.7.0 → 1.7.4

package/.yarn/unplugged/open-npm-8.4.0-df63cfe537/node_modules/open/index.d.ts

@@ -0,0 +1,153 @@
+import {ChildProcess} from 'child_process';
+
+declare namespace open {
+	interface Options {
+		/**
+		Wait for the opened app to exit before fulfilling the promise. If `false` it's fulfilled immediately when opening the app.
+
+		Note that it waits for the app to exit, not just for the window to close.
+
+		On Windows, you have to explicitly specify an app for it to be able to wait.
+
+		@default false
+		*/
+		readonly wait?: boolean;
+
+		/**
+		__macOS only__
+
+		Do not bring the app to the foreground.
+
+		@default false
+		*/
+		readonly background?: boolean;
+
+		/**
+		__macOS only__
+
+		Open a new instance of the app even it's already running.
+
+		A new instance is always opened on other platforms.
+
+		@default false
+		*/
+		readonly newInstance?: boolean;
+
+		/**
+		Specify the `name` of the app to open the `target` with, and optionally, app `arguments`. `app` can be an array of apps to try to open and `name` can be an array of app names to try. If each app fails, the last error will be thrown.
+
+		The app name is platform dependent. Don't hard code it in reusable modules. For example, Chrome is `google chrome` on macOS, `google-chrome` on Linux and `chrome` on Windows. If possible, use [`open.apps`](#openapps) which auto-detects the correct binary to use.
+
+		You may also pass in the app's full path. For example on WSL, this can be `/mnt/c/Program Files (x86)/Google/Chrome/Application/chrome.exe` for the Windows installation of Chrome.
+
+		The app `arguments` are app dependent. Check the app's documentation for what arguments it accepts.
+		*/
+		readonly app?: App | readonly App[];
+
+		/**
+		Allow the opened app to exit with nonzero exit code when the `wait` option is `true`.
+
+		We do not recommend setting this option. The convention for success is exit code zero.
+
+		@default false
+		*/
+		readonly allowNonzeroExitCode?: boolean;
+	}
+
+	interface OpenAppOptions extends Omit<Options, 'app'> {
+		/**
+		Arguments passed to the app.
+
+		These arguments are app dependent. Check the app's documentation for what arguments it accepts.
+		*/
+		readonly arguments?: readonly string[];
+	}
+
+	type AppName =
+		| 'chrome'
+		| 'firefox'
+		| 'edge';
+
+	type App = {
+		name: string | readonly string[];
+		arguments?: readonly string[];
+	};
+}
+
+// eslint-disable-next-line no-redeclare
+declare const open: {
+	/**
+	Open stuff like URLs, files, executables. Cross-platform.
+
+	Uses the command `open` on macOS, `start` on Windows and `xdg-open` on other platforms.
+
+	There is a caveat for [double-quotes on Windows](https://github.com/sindresorhus/open#double-quotes-on-windows) where all double-quotes are stripped from the `target`.
+
+	@param target - The thing you want to open. Can be a URL, file, or executable. Opens in the default app for the file type. For example, URLs open in your default browser.
+	@returns The [spawned child process](https://nodejs.org/api/child_process.html#child_process_class_childprocess). You would normally not need to use this for anything, but it can be useful if you'd like to attach custom event listeners or perform other operations directly on the spawned process.
+
+	@example
+	```
+	import open = require('open');
+
+	// Opens the image in the default image viewer
+	await open('unicorn.png', {wait: true});
+	console.log('The image viewer app closed');
+
+	// Opens the url in the default browser
+	await open('https://sindresorhus.com');
+
+	// Opens the URL in a specified browser.
+	await open('https://sindresorhus.com', {app: {name: 'firefox'}});
+
+	// Specify app arguments.
+	await open('https://sindresorhus.com', {app: {name: 'google chrome', arguments: ['--incognito']}});
+	```
+	*/
+	(
+		target: string,
+		options?: open.Options
+	): Promise<ChildProcess>;
+
+	/**
+	An object containing auto-detected binary names for common apps. Useful to work around cross-platform differences.
+
+	@example
+	```
+	import open = require('open');
+
+	await open('https://google.com', {
+		app: {
+			name: open.apps.chrome
+		}
+	});
+	```
+	*/
+	apps: Record<open.AppName, string | readonly string[]>;
+
+	/**
+	Open an app. Cross-platform.
+
+	Uses the command `open` on macOS, `start` on Windows and `xdg-open` on other platforms.
+
+	@param name - The app you want to open. Can be either builtin supported `open.apps` names or other name supported in platform.
+	@returns The [spawned child process](https://nodejs.org/api/child_process.html#child_process_class_childprocess). You would normally not need to use this for anything, but it can be useful if you'd like to attach custom event listeners or perform other operations directly on the spawned process.
+
+	@example
+	```
+	const {apps, openApp} = require('open');
+
+	// Open Firefox
+	await openApp(apps.firefox);
+
+	// Open Chrome incognito mode
+	await openApp(apps.chrome, {arguments: ['--incognito']});
+
+	// Open Xcode
+	await openApp('xcode');
+	```
+	*/
+	openApp: (name: open.App['name'], options?: open.OpenAppOptions) => Promise<ChildProcess>;
+};
+
+export = open;

package/generated/classes.d.ts

@@ -286,7 +286,7 @@ interface LuaBootstrap {
    * @remarks Depending on when a given entity is destroyed, {@link OnEntityDestroyedEvent on_entity_destroyed} will either be fired at the end of the current tick or at the end of the next tick.
    * @see {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.register_on_entity_destroyed Online documentation}
    */
-  register_on_entity_destroyed(entity: LuaEntity): uint64
+  register_on_entity_destroyed(entity: LuaEntity): RegistrationNumber
   /**
    * Generate a new, unique event ID that can be used to raise custom events with {@link LuaBootstrap#raise_event LuaBootstrap::raise_event}.
    * @returns The newly generated event ID.
@@ -1407,8 +1407,8 @@ interface LuaControl {
    * @remarks Items in the cursor stack will take priority over the cursor ghost.
    * @see {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.cursor_ghost Online documentation}
    */
-  get cursor_ghost(): LuaItemPrototype
-  set cursor_ghost(value: ItemPrototypeIdentification)
+  get cursor_ghost(): LuaItemPrototype | nil
+  set cursor_ghost(value: ItemPrototypeIdentification | nil)
   /**
    * `true` if the player is in a vehicle. Writing to this attribute puts the player in or out of a vehicle.
    *
@@ -1575,7 +1575,10 @@ interface LuaControlBehavior {
    * @returns The circuit network or nil.
    * @see {@link https://lua-api.factorio.com/latest/LuaControlBehavior.html#LuaControlBehavior.get_circuit_network Online documentation}
    */
-  get_circuit_network(wire: defines.wire_type, circuit_connector?: defines.circuit_connector_id): LuaCircuitNetwork
+  get_circuit_network(
+    wire: defines.wire_type,
+    circuit_connector?: defines.circuit_connector_id
+  ): LuaCircuitNetwork | nil
   /**
    * The concrete type of this control behavior.
    * @see {@link https://lua-api.factorio.com/latest/LuaControlBehavior.html#LuaControlBehavior.type Online documentation}
@@ -3268,8 +3271,8 @@ interface LuaEntity extends LuaControl {
    * @remarks Car color is overridden by the color of the current driver/passenger, if there is one.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.color Online documentation}
    */
-  get color(): Color
-  set color(value: Color | ColorArray)
+  get color(): Color | nil
+  set color(value: Color | ColorArray | nil)
   /**
    * The text of this flying-text entity.
    *
@@ -3413,8 +3416,8 @@ interface LuaEntity extends LuaControl {
    * _Can only be used if this is EntityWithOwner_
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.last_user Online documentation}
    */
-  get last_user(): LuaPlayer | LuaPlayer
-  set last_user(value: LuaPlayer | PlayerIdentification)
+  get last_user(): LuaPlayer | nil
+  set last_user(value: LuaPlayer | PlayerIdentification | nil)
   /**
    * The buffer size for the electric energy source. `nil` if the entity doesn't have an electric energy source.
    * @remarks Write access is limited to the ElectricEnergyInterface type
@@ -3702,8 +3705,8 @@ interface LuaEntity extends LuaControl {
    * @remarks A character associated with a player is not directly controlled by any player.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.associated_player Online documentation}
    */
-  get associated_player(): LuaPlayer | LuaPlayer
-  set associated_player(value: LuaPlayer | PlayerIdentification)
+  get associated_player(): LuaPlayer | nil
+  set associated_player(value: LuaPlayer | PlayerIdentification | nil)
   /**
    * The last tick this character entity was attacked.
    *
@@ -3834,15 +3837,15 @@ interface LuaEntity extends LuaControl {
    * Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_player Online documentation}
    */
-  get render_player(): LuaPlayer | LuaPlayer
-  set render_player(value: LuaPlayer | PlayerIdentification)
+  get render_player(): LuaPlayer | nil
+  set render_player(value: LuaPlayer | PlayerIdentification | nil)
   /**
    * The forces that this `simple-entity-with-owner`, `simple-entity-with-force`, or `flying-text` is visible to. `nil` or an empty array when this entity is rendered for all forces.
    * @remarks Reading will always give an array of {@link LuaForce}
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_to_forces Online documentation}
    */
-  get render_to_forces(): LuaForce[]
-  set render_to_forces(value: readonly ForceIdentification[])
+  get render_to_forces(): LuaForce[] | nil
+  set render_to_forces(value: readonly ForceIdentification[] | nil)
   /**
    * The rail target of this pump, if any.
    *
@@ -3938,8 +3941,8 @@ interface LuaEntity extends LuaControl {
    * _Can only be used if this is SpiderVehicle_
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.autopilot_destination Online documentation}
    */
-  get autopilot_destination(): MapPosition
-  set autopilot_destination(value: MapPosition | MapPositionArray)
+  get autopilot_destination(): MapPosition | nil
+  set autopilot_destination(value: MapPosition | MapPositionArray | nil)
   /**
    * The queued destination positions of spidertron's autopilot.
    *
@@ -4767,8 +4770,8 @@ interface BaseEntity extends LuaControl {
    * @remarks Car color is overridden by the color of the current driver/passenger, if there is one.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.color Online documentation}
    */
-  get color(): Color
-  set color(value: Color | ColorArray)
+  get color(): Color | nil
+  set color(value: Color | ColorArray | nil)
   /**
    * The productivity bonus of this entity.
    * @remarks This includes force based bonuses as well as beacon/module bonuses.
@@ -4998,15 +5001,15 @@ interface BaseEntity extends LuaControl {
    * Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_player Online documentation}
    */
-  get render_player(): LuaPlayer | LuaPlayer
-  set render_player(value: LuaPlayer | PlayerIdentification)
+  get render_player(): LuaPlayer | nil
+  set render_player(value: LuaPlayer | PlayerIdentification | nil)
   /**
    * The forces that this `simple-entity-with-owner`, `simple-entity-with-force`, or `flying-text` is visible to. `nil` or an empty array when this entity is rendered for all forces.
    * @remarks Reading will always give an array of {@link LuaForce}
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_to_forces Online documentation}
    */
-  get render_to_forces(): LuaForce[]
-  set render_to_forces(value: readonly ForceIdentification[])
+  get render_to_forces(): LuaForce[] | nil
+  set render_to_forces(value: readonly ForceIdentification[] | nil)
   /**
    * Returns the id of the electric network that this entity is connected to, if any.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.electric_network_id Online documentation}
@@ -5919,8 +5922,8 @@ interface SpiderVehicleEntity extends BaseEntity {
    * _Can only be used if this is SpiderVehicle_
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.autopilot_destination Online documentation}
    */
-  get autopilot_destination(): MapPosition
-  set autopilot_destination(value: MapPosition | MapPositionArray)
+  get autopilot_destination(): MapPosition | nil
+  set autopilot_destination(value: MapPosition | MapPositionArray | nil)
   /**
    * The queued destination positions of spidertron's autopilot.
    *
@@ -6138,8 +6141,8 @@ interface CharacterEntity extends BaseEntity {
    * @remarks A character associated with a player is not directly controlled by any player.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.associated_player Online documentation}
    */
-  get associated_player(): LuaPlayer | LuaPlayer
-  set associated_player(value: LuaPlayer | PlayerIdentification)
+  get associated_player(): LuaPlayer | nil
+  set associated_player(value: LuaPlayer | PlayerIdentification | nil)
   /**
    * The last tick this character entity was attacked.
    *
@@ -6236,8 +6239,8 @@ interface EntityWithOwnerEntity extends BaseEntity {
    * _Can only be used if this is EntityWithOwner_
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.last_user Online documentation}
    */
-  get last_user(): LuaPlayer | LuaPlayer
-  set last_user(value: LuaPlayer | PlayerIdentification)
+  get last_user(): LuaPlayer | nil
+  set last_user(value: LuaPlayer | PlayerIdentification | nil)
 }
 
 interface ElectricEnergyInterfaceEntity extends BaseEntity {
@@ -10506,7 +10509,7 @@ interface LuaFluidBox extends Array<Fluid | nil> {
    * Gets unique fluid system identifier of selected fluid box. May return nil for fluid wagon, fluid turret's internal buffer or a fluidbox which does not belong to a fluid system
    * @see {@link https://lua-api.factorio.com/latest/LuaFluidBox.html#LuaFluidBox.get_fluid_system_id Online documentation}
    */
-  get_fluid_system_id(index: uint): uint
+  get_fluid_system_id(index: uint): uint | nil
   /**
    * Flushes all fluid from this fluidbox and its fluid system.
    * @param fluid If provided, only this fluid is flushed.
@@ -11365,8 +11368,8 @@ interface LuaForce {
    * Custom color for this force. If specified, will take priority over other sources of the force color. Writing nil clears custom color. Will return nil if it was not specified or if was set to {0,0,0,0}
    * @see {@link https://lua-api.factorio.com/latest/LuaForce.html#LuaForce.custom_color Online documentation}
    */
-  get custom_color(): Color
-  set custom_color(value: Color | ColorArray)
+  get custom_color(): Color | nil
+  set custom_color(value: Color | ColorArray | nil)
   /**
    * Effective color of this force.
    * @see {@link https://lua-api.factorio.com/latest/LuaForce.html#LuaForce.color Online documentation}
@@ -13292,8 +13295,8 @@ interface BaseGuiElement {
    * The location of this widget when stored in {@link LuaGui#screen LuaGui::screen}. `nil` if not set or not in {@link LuaGui#screen LuaGui::screen}.
    * @see {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.location Online documentation}
    */
-  get location(): GuiLocation
-  set location(value: GuiLocation | GuiLocationArray)
+  get location(): GuiLocation | nil
+  set location(value: GuiLocation | GuiLocationArray | nil)
   /**
    * Whether this GUI element is enabled. Disabled GUI elements don't trigger events when clicked.
    * @see {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.enabled Online documentation}
@@ -16336,16 +16339,16 @@ interface LuaItemStack {
    * _Can only be used if this is BlueprintItem_
    * @see {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.blueprint_snap_to_grid Online documentation}
    */
-  get blueprint_snap_to_grid(): TilePosition
-  set blueprint_snap_to_grid(value: TilePosition | TilePositionArray)
+  get blueprint_snap_to_grid(): TilePosition | nil
+  set blueprint_snap_to_grid(value: TilePosition | TilePositionArray | nil)
   /**
    * The offset from the absolute grid. `nil` if absolute snapping is not enabled.
    *
    * _Can only be used if this is BlueprintItem_
    * @see {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.blueprint_position_relative_to_grid Online documentation}
    */
-  get blueprint_position_relative_to_grid(): TilePosition
-  set blueprint_position_relative_to_grid(value: TilePosition | TilePositionArray)
+  get blueprint_position_relative_to_grid(): TilePosition | nil
+  set blueprint_position_relative_to_grid(value: TilePosition | TilePositionArray | nil)
   /**
    * If absolute snapping is enabled on this blueprint item.
    *
@@ -16366,8 +16369,8 @@ interface LuaItemStack {
    * _Can only be used if this is ItemWithLabel_
    * @see {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.label_color Online documentation}
    */
-  get label_color(): Color
-  set label_color(value: Color | ColorArray)
+  get label_color(): Color | nil
+  set label_color(value: Color | ColorArray | nil)
   /**
    * Whether the label for this item can be manually changed. When false the label can only be changed through the API.
    *
@@ -17021,16 +17024,16 @@ interface BlueprintItemStack extends BaseItemStack {
    * _Can only be used if this is BlueprintItem_
    * @see {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.blueprint_snap_to_grid Online documentation}
    */
-  get blueprint_snap_to_grid(): TilePosition
-  set blueprint_snap_to_grid(value: TilePosition | TilePositionArray)
+  get blueprint_snap_to_grid(): TilePosition | nil
+  set blueprint_snap_to_grid(value: TilePosition | TilePositionArray | nil)
   /**
    * The offset from the absolute grid. `nil` if absolute snapping is not enabled.
    *
    * _Can only be used if this is BlueprintItem_
    * @see {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.blueprint_position_relative_to_grid Online documentation}
    */
-  get blueprint_position_relative_to_grid(): TilePosition
-  set blueprint_position_relative_to_grid(value: TilePosition | TilePositionArray)
+  get blueprint_position_relative_to_grid(): TilePosition | nil
+  set blueprint_position_relative_to_grid(value: TilePosition | TilePositionArray | nil)
   /**
    * If absolute snapping is enabled on this blueprint item.
    *
@@ -17291,8 +17294,8 @@ interface ItemWithLabelItemStack extends BaseItemStack {
    * _Can only be used if this is ItemWithLabel_
    * @see {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.label_color Online documentation}
    */
-  get label_color(): Color
-  set label_color(value: Color | ColorArray)
+  get label_color(): Color | nil
+  set label_color(value: Color | ColorArray | nil)
   /**
    * Whether the label for this item can be manually changed. When false the label can only be changed through the API.
    *
@@ -20081,7 +20084,7 @@ interface LuaRendering {
    * Gets the type of the given object. The types are "text", "line", "circle", "rectangle", "arc", "polygon", "sprite", "light" and "animation".
    * @see {@link https://lua-api.factorio.com/latest/LuaRendering.html#LuaRendering.get_type Online documentation}
    */
-  get_type(id: uint64): string
+  get_type(id: uint64): "text" | "line" | "circle" | "rectangle" | "arc" | "polygon" | "sprite" | "light" | "animation"
   /**
    * Reorder this object so that it is drawn in front of the already existing objects.
    * @see {@link https://lua-api.factorio.com/latest/LuaRendering.html#LuaRendering.bring_to_front Online documentation}
@@ -22429,7 +22432,7 @@ interface LuaSurface {
      * The force the result will be an enemy of. Uses the player force if not specified.
      */
     readonly force?: ForceIdentification
-  }): LuaEntity
+  }): LuaEntity | nil
   /**
    * Give a command to multiple units. This will automatically select suitable units for the task.
    * @returns Number of units actually sent. May be less than `count` if not enough units were available.
@@ -23901,8 +23904,8 @@ interface LuaTrain {
    * @remarks The schedule can't be changed by modifying the returned table. Instead, changes must be made by assigning a new table to this attribute.
    * @see {@link https://lua-api.factorio.com/latest/LuaTrain.html#LuaTrain.schedule Online documentation}
    */
-  get schedule(): TrainSchedule
-  set schedule(value: TrainScheduleWrite)
+  get schedule(): TrainSchedule | nil
+  set schedule(value: TrainScheduleWrite | nil)
   /**
    * This train's current state.
    * @see {@link https://lua-api.factorio.com/latest/LuaTrain.html#LuaTrain.state Online documentation}

package/package.json

@@ -1,57 +1,57 @@
 {
   "name": "typed-factorio",
-  "version": "1.7.0",
+  "version": "1.7.4",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
-    "factorio",
-    "types",
-    "typescript-to-lua",
-    "tstl"
+    "factorio", "types", "typescript-to-lua", "tstl"
   ],
   "repository": "https://github.com/GlassBricks/typed-factorio",
   "license": "MIT",
   "files": [
-    "**/*.d.ts"
+    "**/*.d.ts",
+    "*.d.ts",
+    "!generator/**/*"
   ],
+  "type": "module",
   "homepage": "https://github.com/GlassBricks/typed-factorio#readme",
   "scripts": {
-    "generate": "ts-node -P generator/tsconfig.json generator/main.ts",
+    "generate": "ts-node --esm -P generator/tsconfig.json generator/main.ts",
     "clean": "rimraf generated",
-    "pretest": "yarn run generate",
     "test": "jest",
     "lint": "eslint .",
-    "check": "yarn run lint && yarn run test",
+    "check": "yarn run lint && yarn run generate && yarn run test",
     "prepublishOnly": "yarn run check",
-    "download-latest-runtime-api": "ts-node ./scripts/download-latest.ts",
-    "new-version-changelog": "ts-node ./scripts/new-version-changelog.ts",
+    "download-latest-runtime-api": "ts-node --esm ./scripts/download-latest.ts",
+    "new-version-changelog": "ts-node --esm ./scripts/new-version-changelog.ts",
     "next-version": "yarn run download-latest-runtime-api && yarn run clean && yarn run check && yarn run new-version-changelog && git add . && yarn version --minor"
   },
   "peerDependencies": {
-    "lua-types": "^2.11.0",
+    "lua-types": "^2.13.0",
     "typescript-to-lua": "^1.6.1"
   },
   "devDependencies": {
-    "@types/jest": "^28.1.6",
-    "@types/node": "^18.6.2",
-    "@types/prettier": "^2.6.4",
-    "@typescript-eslint/eslint-plugin": "^5.31.0",
-    "@typescript-eslint/parser": "^5.31.0",
-    "chalk": "^4.1.2",
-    "eslint": "^8.20.0",
+    "@types/jest": "^28.1.8",
+    "@types/node": "^18.7.15",
+    "@types/prettier": "^2.7.0",
+    "@typescript-eslint/eslint-plugin": "^5.36.2",
+    "@typescript-eslint/parser": "^5.36.2",
+    "chalk": "^5.0.1",
+    "eslint": "~8.23.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-config-standard": "^17.0.0",
-    "eslint-import-resolver-typescript": "^3.3.0",
+    "eslint-import-resolver-typescript": "^3.5.1",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-n": "^15.2.4",
+    "eslint-plugin-n": "^15.2.5",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-promise": "^6.0.1",
     "jest": "^28.1.3",
-    "lua-types": "^2.11.0",
+    "lua-types": "^2.13.0",
     "prettier": "^2.7.1",
-    "ts-jest": "^28.0.7",
+    "ts-jest": "^28.0.8",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4",
-    "typescript-to-lua": "^1.7.1"
-  }
+    "typescript": "~4.8.2",
+    "typescript-to-lua": "^1.10.0"
+  },
+  "packageManager": "yarn@3.2.3"
 }

package/runtime/util.d.ts

@@ -8,54 +8,58 @@ declare module "util" {
   namespace table {
     function deepcopy<T>(table: T): T
 
-    function compare<T>(tb1: T, tb2: T): boolean
+    function compare<T extends table>(tb1: T, tb2: T): boolean
   }
 
   function copy<T>(table: T): T
 
-  function distance(position1: MapPosition, position2: MapPosition): number
+  function distance(position1: MapPosition | MapPositionArray, position2: MapPosition | MapPositionArray): number
 
-  function positiontostr(position: MapPosition): string
+  function positiontostr(position: MapPosition | MapPositionArray): string
 
   function formattime(ticks: number): string
 
   /** Supports 'rrggbb', 'rgb', 'rrggbbaa', 'rgba', 'ww', 'w' */
-  function color(hex: string): ColorTable
+  function color(hex: string): Color
 
-  function premul_color(color: Color): ColorTable
+  function premul_color(color: Color): Color
 
   function mix_color(c1: Color, c2: Color): ColorArray
 
   function multiply_color(c1: Color, n: number): ColorArray
 
   function moveposition(
-    position: MapPosition,
+    position: MapPositionArray,
     direction: defines.direction.north | defines.direction.east | defines.direction.south | defines.direction.west,
     distance: number
-  ): MapPosition
-  function moveposition(position: MapPosition, direction: defines.direction, distance: number): MapPosition | undefined
+  ): MapPositionArray
+  function moveposition(
+    position: MapPositionArray,
+    direction: defines.direction,
+    distance: number
+  ): MapPositionArray | nil
 
   function oppositedirection(direction: defines.direction): defines.direction
 
   /** Creates a new array where each element in `stripes` is duplicated `count` times */
-  function multiplystripes<T>(count: number, stripes: T[]): T[]
+  function multiplystripes<T>(count: number, stripes: readonly T[]): T[]
 
   /** Gets tile position by pixel */
-  function by_pixel(x: number, y: number): MapPosition
+  function by_pixel(x: number, y: number): MapPositionArray
 
   /** Gets tile position by pixel, hr */
-  function by_pixel_hr(x: number, y: number): MapPosition
+  function by_pixel_hr(x: number, y: number): MapPositionArray
 
   // omitted: foreach_sprite_definition
 
-  function add_shift(a: MapPositionArray | undefined, b: MapPositionArray): MapPositionArray
-  function add_shift(a: MapPositionArray, b: MapPositionArray | undefined): MapPositionArray
-  function add_shift(a: MapPositionArray | undefined, b: MapPositionArray | undefined): MapPositionArray | undefined
+  function add_shift(a: MapPositionArray | nil, b: MapPositionArray): MapPositionArray
+  function add_shift(a: MapPositionArray, b: MapPositionArray | nil): MapPositionArray
+  function add_shift(a: MapPositionArray | nil, b: MapPositionArray | nil): MapPositionArray | nil
 
   // omitted: add_shift_offset
 
-  function mul_shift(shift: MapPositionArray, scale: number | undefined): MapPositionArray
-  function mul_shift(shift: MapPositionArray | undefined, scale: number | undefined): MapPositionArray | undefined
+  function mul_shift(shift: MapPositionArray, scale: number | nil): MapPositionArray
+  function mul_shift(shift: MapPositionArray | nil, scale: number | nil): MapPositionArray | nil
 
   function format_number(amount: number, append_suffix?: boolean): string
 
@@ -68,11 +72,11 @@ declare module "util" {
    * entries are themselves tables, in which case they are recursively merged. Non-merged tables are deep-copied, so
    * that the result is brand new.
    */
-  function merge<T extends object>(tables: T[]): T
+  function merge<T extends object>(tables: readonly T[]): T
 
-  function insert_safe(entity: LuaEntity | undefined, item_dict: Record<string, number> | undefined): void
+  function insert_safe(entity: LuaEntity | nil, item_dict: Record<string, number> | nil): void
 
-  function remove_safe(entity: LuaEntity | undefined, item_dict: Record<string, number> | undefined): void
+  function remove_safe(entity: LuaEntity | nil, item_dict: Record<string, number> | nil): void
 
   function split_whitespace(string: string): string[]
 
@@ -82,7 +86,7 @@ declare module "util" {
 
   function clamp(x: number, lower: number, upper: number): number
 
-  // omitted: get_walkable_tile
+  function get_walkable_tile(): string
 
   // omitted: combine_icons
   // omitted: technology_icons. Create an issue if you really want to see these
@@ -110,7 +114,7 @@ declare module "util" {
 
   function remove_from_list<T>(list: T[], value: T): boolean
 
-  function list_to_map<T extends keyof any>(list: T[]): Record<T, true>
-  function list_to_map<T>(list: T[]): LuaTable<T, true>
-  function list_to_map<T>(list: T): LuaTable<T[keyof T], true>
+  function list_to_map<V>(list: LuaPairsIterable<any, V>): LuaSet<NonNullable<V>>
+  function list_to_map<T extends AnyNotNil>(list: T[]): LuaSet<T>
+  function list_to_map<T extends AnyNotNil>(list: T): LuaSet<NonNullable<T[keyof T]>>
 }

package/Changelog.md

@@ -1,238 +0,0 @@
-# v1.7.0
-
-- Updated to factorio version 1.1.67
-
-# v1.6.1
-
-- Fixed write type for `BoundingBox`.
-- Simplified types for BlueprintEntity.
-
-# v1.6.0
-
-- Updated to factorio version 1.1.64
-
-# v1.5.1
-
-- Added old `Read` types as deprecated type aliases of new types; to help with migration.
-
-# v1.5.0
-
-### BREAKING
-
-- Read-only forms of concepts (the most common form used) is now specified with just the name; forms with a `Read` or `Table` suffix have been removed.
-- Write forms are now specified as either a union of table and array forms, or with a `Write` suffix for concepts.
-  - For table-or-array concepts: `MapPositionRead` -> `MapPosition`, `MapPosition` -> `MapPosition | PositionArray`
-  - For table concepts: `ScriptAreaRead` -> `ScriptArea`, `ScriptArea` -> `ScriptAreaWrite`
-- The minimum TSTL version has been increased to v1.6.1 (A bug with documentation comments was fixed in that version).
-
-### Other
-
-- Updated to factorio version 1.1.63.
-- Upgraded to factorio api docs json version 3.
-- The new type `nil` is used instead of `undefined` (they are equivalent).
-- More complete type for `BlueprintEntity`.
-- Fixed missing read-write forms for more concepts.
-- Improved documentation comments (enabled by json docs version 3).
-- Improved documentation comments for variant parameter groups.
-
-# v1.4.0
-
-- Improve doc comments for enum concepts
-- Improve doc comment formatting
-- Improve types of concepts with literal union types
-- Add read-specific types to AutoplaceControl and ComparatorString
-
-# v1.3.2
-
-- Move "notes" comment into the main body of doc comment, instead of in @remarks. This works around #13.
-- Add manually defined overload for LuaControl::teleport().
-
-# v1.3.1
-
-- Use @linkplain instead of @link for web links. This hopefully works around issue #13
-
-# v1.3.0
-
-- Updated to factorio version 1.1.61
-
-# v1.2.0
-
-- Updated to factorio version 1.1.60
-
-# v1.1.0
-
-- Updated to factorio version 1.1.59
-
-# v1.0.0
-
-- This project now has all the features that was originally planned, and can now guarantee reasonable backwards compatibility for future releases.
-- Updated to factorio version 1.1.57
-
-# v0.20.0
-
-- Updated to factorio version 1.1.56
-- This is an **opt-in** feature: Some numeric types which represent indices/number,e.g. player_index, entity_number, are now branded numbers with their own type, e.g. `PlayerIndex` and `EntityNumber`. See the README for more info.
-- Added custom-index-template.d.ts to assist trying out custom changes to types in a project.
-
-# v0.19.0
-
-- Updated to factorio version 1.1.53
-- Updated to json api version 2
-- Improved documentation comments
-
-## Changes
-
-- `Position`, `PositionArray`, and `PositionTable` have been replaced by `MapPosition`, `MapPositionArray`, and `MapPositionTable` respectively. These are now deprecated and may be removed in a future version.
-
-# v0.18.1
-
-- `TechnologyIdentification` now also has a more specific type when read.
-
-# v0.18.0
-
-- `ForceIdentification` and `ItemPrototypeIdentification` now have more specific types when read.
-- Properties which represent a flag concept now have the correct specific type, instead of `string`.
-
-# v0.17.1
-
-- Fixed documentation links for events
-
-# v0.17.0
-
-- Updated to factorio version 1.1.52
-
-# v0.16.0
-
-- `LuaCustomTable` can be iterated on in a for-of loop directly (without using `pairs`). This requires TSTL v1.3.0 or later.
-- TSTL dependency minimum version is now v1.3.0.
-
-# v0.15.0
-
-- Table or array concepts are now declared in table form wherever it is an "read" position.
-  - This works with setter overloading for applicable properties: `player.color.x; player.color = [1, 1, 1]` is now valid!
-  - This also applies to concepts/complex types which contain table_or_array properties.
-- Some concepts now also have a special form where it is known to be in a "read" position, where all table_or_array concepts are declared in table form. These concepts are suffixed with "Read", e.g. `ScriptAreaRead`.
-- Arrays which are known to be in a "write" only form (e.g. method parameters) now are marked readonly. This means you can now pass readonly arrays to these methods.
-- `MapPosition` is now a table or array concept.
-- Classes with subclasses are now declared with all properties, instead of an intersection of subclasses (reversion)
-- Subclass specializations added for some missing classes
-
-# v0.14.1
-
-- LuaStyle: `extra_margin/padding_when_activated` is now for subclass scroll_pane
-
-# v0.14.0
-
-- LuaStyle size, margin/padding setters now have more specific array types. These array types are `SizeArray` and `StyleValuesArray` for size and margin/padding, respectively.
-- `@noSelf` annotation is now only present when necessary.
-- For classes with subclasses:
-  - The original class name (e.g. `LuaItemStack`) still contains attributes of all subclasses (same as before).
-  - There is now a `Base` type (e.g. `BaseItemStack`) which only includes attributes common to all subclasses.
-  - There is a separate type definition for each subclass, e.g. `BlueprintItem`. Note that one instance may still belong to multiple subclasses (the subclasses are not mutually exclusive).
-  - The above two can be optionally used for stricter types.
-
-# v0.13.2
-
-- Fix: resize_to_sprite property should not be on subclass sprite-button
-- Fix: ChooseElemButtonSpec filters should be named elem_filters
-- Switch back to `/latest` api docs link
-  - New version of web api docs is now active
-
-# v0.13.0
-
-- Update to factorio version 1.1.49
-
-# v0.12.0
-
-- Update to factorio version 1.1.48
-
-# v0.11.1
-
-- Localised strings now accept boolean and undefined.
-
-# v0.11.0
-
-- Update to factorio version 1.1.46
-
-# v0.10.0
-
-- LuaGuiElement.style and LuaControl.opened now have different get/set types (more specific get type).
-- The array form of LocalizedString is now readonly.
-
-# v0.9.0
-
-- Update to factorio version 1.1.43
-- The `defines.events `_type_ was renamed to `defines.Events`, to reduce confusion between the namespace/type
-
-# v0.8.0
-
-- All event types now explicitly extend `EventData`
-- Variant parameter groups without additional fields now have their own type, instead of all being grouped into `Other`
-
-# v0.7.3
-
-- Update to factorio version 1.1.42
-  - No api changes, but improvements to descriptions
-
-# v0.7.2
-
-- Fix minor issue for event types
-
-# v0.7.0
-
-- Updated to factorio version 1.1.41 (no changes to lua api)
-- Improved smart types for events
-
-# v0.6.1
-
-- Added type for BlueprintControlBehavior
-
-# v0.6.0
-
-- Updated to factorio version 1.1.40
-- Fixed regression with duplicate strings in string union types
-
-# v0.5.0
-
-- Updated to factorio version 1.1.39
-- Documentation links now point to the new API docs website. More info here: https://forums.factorio.com/viewtopic.php?f=34&t=99797
-
-# v0.4.1
-
-### Changed
-
-- LuaRemote.addInterface now lets remote functions take any arguments.
-
-# v0.4.0
-
-## **BREAKING**
-
-- Only the latest version api is now provided.
-- It is now accessed using `typed-factorio/runtime` instead of `typed-factorio/<version>`
-
-### Added
-
-- Basic types for settings and data stage. See README for more details.
-- Types for "util" and "mod-gui" lualib modules
-
-### Fixed
-
-- LuaGuiElement::add with a literal now give diagnostic if you supply a field that shouldn't be there.
-
-### Internal
-
-- Split generated files into multiple files
-- Improved compilation tests
-
-# v0.3.0
-
-- Added factorio version `1.1.38`
-
-# v0.2.0
-
-- `AnyBasic` now uses type `table` instead of type `Record<any, AnyBasic>`
-- README changes
-
-# v0.1.0
-
-- Initial release

package/generator/typescript-internal.d.ts

@@ -1,9 +0,0 @@
-declare module "typescript" {
-  interface JSDocContainer {
-    jsDoc?: JSDoc[]
-  }
-  interface Node {
-    emitNode?: unknown
-  }
-}
-export {}