typed-factorio 0.19.1 → 1.0.0-RC

package/generated/index-types.d.ts

@@ -0,0 +1,49 @@
+// This is an auto-generated file. Do not edit directly!
+
+/** @noSelfInFile */
+
+/**
+ * See {@link LuaPlayer#index LuaPlayer.index}.
+ *
+ * If using strict-index-types, and you need to use a plain number for this type, you can use a cast, e.g. `1 as PlayerIndex`.
+ */
+type PlayerIndex = uint & IndexBrand<"_playerIndexBrand">
+
+/**
+ * See {@link LuaSurface#index LuaSurface.index}.
+ *
+ * If using strict-index-types, and you need to use a plain number for this type, you can use a cast, e.g. `1 as SurfaceIndex`.
+ */
+type SurfaceIndex = uint & IndexBrand<"_surfaceIndexBrand">
+
+/**
+ * See {@link LuaEntity#unit_number LuaEntity.unit_number}.
+ *
+ * If using strict-index-types, and you need to use a plain number for this type, you can use a cast, e.g. `1 as UnitNumber`.
+ */
+type UnitNumber = uint & IndexBrand<"_unitNumberBrand">
+
+/**
+ * See {@link LuaGuiElement#index LuaGuiElement.index}.
+ *
+ * If using strict-index-types, and you need to use a plain number for this type, you can use a cast, e.g. `1 as GuiElementIndex`.
+ */
+type GuiElementIndex = uint & IndexBrand<"_guiElementIndexBrand">
+
+/**
+ * See {@link LuaBootstrap#register_on_entity_destroyed LuaBootstrap.register_on_entity_destroyed}.
+ *
+ * If using strict-index-types, and you need to use a plain number for this type, you can use a cast, e.g. `1 as RegistrationNumber`.
+ */
+type RegistrationNumber = uint64 & IndexBrand<"_registrationNumberBrand">
+
+interface __OptInFeatures {}
+
+/**
+ * Equals a branded type when __OptInFeatures contains strictIndexTypes, otherwise equals `unknown`.
+ */
+type IndexBrand<B extends string> = "strictIndexTypes" extends keyof __OptInFeatures
+  ? {
+      [K in B]: any
+    }
+  : unknown

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "0.19.1",
+  "version": "1.0.0-RC",
   "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",

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,14 +1,10 @@
 /** @noSelfInFile */
-
-/**
- * Iterating with `pairs` will only iterate the array part of a {@link LuaCustomTable}.
- *
- * **Note**: you can also iterate on a LuaCustomTable directly without using `pairs`, e.g. `for(const [k, v] of table)`.
- */
-declare function pairs<V>(table: LuaCustomTable<number | string, V>): LuaIterable<LuaMultiReturn<[number, V]>>
+///<reference types="lua-types/5.2" />
 
 /** **Note**: you can also iterate on a LuaCustomTable directly without using `pairs`, e.g. `for(const [k, v] of table)`. */
-declare function pairs<K extends number | string, V>(table: LuaCustomTable<K, V>): LuaIterable<LuaMultiReturn<[K, V]>>
+declare function pairs<T extends LuaCustomTable<any, any>>(
+  table: T
+): LuaIterable<LuaMultiReturn<T extends Iterable<infer E> ? E : never>>
 
 /** @deprecated {@link LuaCustomTable} cannot be iterated with `ipairs`; Use {@link pairs} instead. */
 declare function ipairs(table: LuaCustomTable<any, any>): never

package/strict-index-types.d.ts

@@ -0,0 +1,3 @@
+interface __OptInFeatures {
+  strictIndexTypes: true
+}

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" />