typed-factorio 0.18.1 → 0.20.0-beta.1

package/generated/global-objects.d.ts

@@ -3,8 +3,7 @@
 /** @noSelfInFile */
 
 /**
- * This is the main object, through which most of the API is accessed. It is, however, not available inside handlers
- * registered with {@link LuaBootstrap.on_load LuaBootstrap::on_load}.
+ * This is the main object, through which most of the API is accessed. It is, however, not available inside handlers registered with {@link LuaBootstrap#on_load LuaBootstrap::on_load}.
  *
  * {@link https://lua-api.factorio.com/latest/ View documentation}
  */

package/generated/index-types-strict.d.ts

@@ -0,0 +1,52 @@
+// This is an auto-generated file. Do not edit directly!
+
+/** @noSelfInFile */
+
+/**
+ * See {@link LuaPlayer#index LuaPlayer.index}.
+ *
+ * If you need to use a number/numeric literal for this type, you can use a cast, e.g. `2 as PlayerIndex`.
+ */
+type PlayerIndex =
+  | (uint & {
+      _playerIndexBrand: void
+    })
+  | 1
+
+/**
+ * See {@link LuaSurface#index LuaSurface.index}.
+ *
+ * If you need to use a number/numeric literal for this type, you can use a cast, e.g. `2 as SurfaceIndex`.
+ */
+type SurfaceIndex =
+  | (uint & {
+      _surfaceIndexBrand: void
+    })
+  | 1
+
+/**
+ * See {@link LuaEntity#unit_number LuaEntity.unit_number}.
+ *
+ * If you need to use a number/numeric literal for this type, you can use a cast, e.g. `2 as UnitNumber`.
+ */
+type UnitNumber = uint & {
+  _unitNumberBrand: void
+}
+
+/**
+ * See {@link LuaGuiElement#index LuaGuiElement.index}.
+ *
+ * If you need to use a number/numeric literal for this type, you can use a cast, e.g. `2 as GuiElementIndex`.
+ */
+type GuiElementIndex = uint & {
+  _guiElementIndexBrand: void
+}
+
+/**
+ * See {@link LuaBootstrap#register_on_entity_destroyed LuaBootstrap.register_on_entity_destroyed}.
+ *
+ * If you need to use a number/numeric literal for this type, you can use a cast, e.g. `2 as RegistrationNumber`.
+ */
+type RegistrationNumber = uint64 & {
+  _registrationNumberBrand: void
+}

package/generated/index-types.d.ts

@@ -0,0 +1,38 @@
+// This is an auto-generated file. Do not edit directly!
+
+/** @noSelfInFile */
+
+/**
+ * See {@link LuaPlayer#index LuaPlayer.index}..
+ *
+ * This can be a "branded" type for stricter types; see docs on how to opt-in to this.
+ */
+type PlayerIndex = uint
+
+/**
+ * See {@link LuaSurface#index LuaSurface.index}..
+ *
+ * This can be a "branded" type for stricter types; see docs on how to opt-in to this.
+ */
+type SurfaceIndex = uint
+
+/**
+ * See {@link LuaEntity#unit_number LuaEntity.unit_number}..
+ *
+ * This can be a "branded" type for stricter types; see docs on how to opt-in to this.
+ */
+type UnitNumber = uint
+
+/**
+ * See {@link LuaGuiElement#index LuaGuiElement.index}..
+ *
+ * This can be a "branded" type for stricter types; see docs on how to opt-in to this.
+ */
+type GuiElementIndex = uint
+
+/**
+ * See {@link LuaBootstrap#register_on_entity_destroyed LuaBootstrap.register_on_entity_destroyed}..
+ *
+ * This can be a "branded" type for stricter types; see docs on how to opt-in to this.
+ */
+type RegistrationNumber = uint64

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "0.18.1",
+  "version": "0.20.0-beta.1",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",
@@ -15,9 +15,7 @@
   ],
   "homepage": "https://github.com/GlassBricks/typed-factorio#readme",
   "scripts": {
-    "gen": "ts-node -P generator/tsconfig.json generator/main.ts",
-    "generate": "yarn run gen --in ./generatorSrc --out ./generated --warn-as-error",
-    "generate:dev": "yarn run gen --in ./generatorSrc --out ./generated --no-format",
+    "generate": "ts-node -P generator/tsconfig.json generator/main.ts",
     "clean": "rimraf generated",
     "pretest": "yarn run generate",
     "test": "jest",
@@ -37,7 +35,6 @@
     "@typescript-eslint/eslint-plugin": "^5.6.0",
     "@typescript-eslint/parser": "^5.6.0",
     "chalk": "^3.0.0",
-    "commander": "^8.3.0",
     "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.3.0",
     "eslint-config-standard": "^16.0.3",
@@ -49,7 +46,6 @@
     "jest": "^27.4.3",
     "lua-types": "^2.11.0",
     "prettier": "^2.5.1",
-    "prettier-plugin-jsdoc": "^0.3.30",
     "ts-jest": "^27.1.0",
     "ts-node": "^10.4.0",
     "typescript": "4.5.2",

package/runtime/index.d.ts

@@ -1,7 +1,15 @@
 /// <reference types="lua-types/5.2" />
 
-/// <reference path="../generated/index.d.ts" />
+// generated
+/// <reference path="../generated/builtin-types.d.ts" />
+/// <reference path="../generated/global-objects.d.ts" />
+/// <reference path="../generated/defines.d.ts" />
+/// <reference path="../generated/events.d.ts" />
+/// <reference path="../generated/classes.d.ts" />
+/// <reference path="../generated/concepts.d.ts" />
+/// <reference path="../generated/index-types.d.ts" />
 
+// other runtime
 /// <reference path="librariesAndFunctions.d.ts" />
 /// <reference path="pairs.d.ts" />
 

package/runtime/pairs.d.ts

@@ -1,4 +1,5 @@
 /** @noSelfInFile */
+///<reference types="lua-types/5.2" />
 
 /**
  * Iterating with `pairs` will only iterate the array part of a {@link LuaCustomTable}.

package/runtime/strict-index-types.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="lua-types/5.2" />
+
+// generated
+/// <reference path="../generated/builtin-types.d.ts" />
+/// <reference path="../generated/global-objects.d.ts" />
+/// <reference path="../generated/defines.d.ts" />
+/// <reference path="../generated/events.d.ts" />
+/// <reference path="../generated/classes.d.ts" />
+/// <reference path="../generated/concepts.d.ts" />
+/// <reference path="../generated/index-types-strict.d.ts" />
+
+// other runtime
+/// <reference path="librariesAndFunctions.d.ts" />
+/// <reference path="pairs.d.ts" />
+
+// lualib
+/// <reference path="util.d.ts" />
+/// <reference path="mod-gui.d.ts" />

package/runtime/util.d.ts

@@ -13,9 +13,9 @@ declare module "util" {
 
   function copy<T>(table: T): T
 
-  function distance(position1: Position, position2: Position): number
+  function distance(position1: MapPosition, position2: MapPosition): number
 
-  function positiontostr(position: Position): string
+  function positiontostr(position: MapPosition): string
 
   function formattime(ticks: number): string
 
@@ -29,11 +29,11 @@ declare module "util" {
   function multiply_color(c1: Color, n: number): ColorArray
 
   function moveposition(
-    position: Position,
+    position: MapPosition,
     direction: defines.direction.north | defines.direction.east | defines.direction.south | defines.direction.west,
     distance: number
-  ): Position
-  function moveposition(position: Position, direction: defines.direction, distance: number): Position | undefined
+  ): MapPosition
+  function moveposition(position: MapPosition, direction: defines.direction, distance: number): MapPosition | undefined
 
   function oppositedirection(direction: defines.direction): defines.direction
 
@@ -41,21 +41,21 @@ declare module "util" {
   function multiplystripes<T>(count: number, stripes: T[]): T[]
 
   /** Gets tile position by pixel */
-  function by_pixel(x: number, y: number): Position
+  function by_pixel(x: number, y: number): MapPosition
 
   /** Gets tile position by pixel, hr */
-  function by_pixel_hr(x: number, y: number): Position
+  function by_pixel_hr(x: number, y: number): MapPosition
 
   // omitted: foreach_sprite_definition
 
-  function add_shift(a: PositionArray | undefined, b: PositionArray): PositionArray
-  function add_shift(a: PositionArray, b: PositionArray | undefined): PositionArray
-  function add_shift(a: PositionArray | undefined, b: PositionArray | undefined): PositionArray | undefined
+  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
 
   // omitted: add_shift_offset
 
-  function mul_shift(shift: PositionArray, scale: number | undefined): PositionArray
-  function mul_shift(shift: PositionArray | undefined, scale: number | undefined): PositionArray | undefined
+  function mul_shift(shift: MapPositionArray, scale: number | undefined): MapPositionArray
+  function mul_shift(shift: MapPositionArray | undefined, scale: number | undefined): MapPositionArray | undefined
 
   function format_number(amount: number, append_suffix?: boolean): string
 

package/generated/index.d.ts

@@ -1,9 +0,0 @@
-// This is an auto-generated file. Do not edit directly!
-
-///<reference types="lua-types/5.2" />
-///<reference path="builtin-types.d.ts" />
-///<reference path="global-objects.d.ts" />
-///<reference path="defines.d.ts" />
-///<reference path="events.d.ts" />
-///<reference path="classes.d.ts" />
-///<reference path="concepts.d.ts" />