typed-factorio 0.15.0 → 0.18.0

package/generator/typescript-internal.d.ts

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

package/package.json

@@ -1,55 +1,58 @@
-{
-  "name": "typed-factorio",
-  "version": "0.15.0",
-  "description": "Featureful typescript definitions for the the Factorio modding lua api.",
-  "keywords": [
-    "factorio", "types", "typescript-to-lua", "tstl"
-  ],
-  "repository": "https://github.com/GlassBricks/typed-factorio",
-  "license": "MIT",
-  "files": [
-    "**/*.d.ts"
-  ],
-  "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",
-    "clean": "rimraf generated",
-    "pretest": "yarn run generate",
-    "test": "jest",
-    "lint": "eslint .",
-    "check": "yarn run lint && yarn run test",
-    "prepublishOnly": "yarn run check",
-    "download-latest-runtime-api": "ts-node ./scripts/downloadLatest.ts"
-  },
-  "peerDependencies": {
-    "lua-types": "^2.11.0",
-    "typescript-to-lua": "^1.0.0"
-  },
-  "devDependencies": {
-    "@types/jest": "^27.0.3",
-    "@types/node": "^16.11.12",
-    "@types/prettier": "^2.4.2",
-    "@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",
-    "eslint-import-resolver-typescript": "^2.5.0",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-promise": "^5.2.0",
-    "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",
-    "typescript-to-lua": "^1.2.0"
-  }
-}
+{
+  "name": "typed-factorio",
+  "version": "0.18.0",
+  "description": "Featureful typescript definitions for the the Factorio modding lua api.",
+  "keywords": [
+    "factorio",
+    "types",
+    "typescript-to-lua",
+    "tstl"
+  ],
+  "repository": "https://github.com/GlassBricks/typed-factorio",
+  "license": "MIT",
+  "files": [
+    "**/*.d.ts"
+  ],
+  "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",
+    "clean": "rimraf generated",
+    "pretest": "yarn run generate",
+    "test": "jest",
+    "lint": "eslint .",
+    "check": "yarn run lint && yarn run test",
+    "prepublishOnly": "yarn run check",
+    "download-latest-runtime-api": "ts-node ./scripts/downloadLatest.ts"
+  },
+  "peerDependencies": {
+    "lua-types": "^2.11.0",
+    "typescript-to-lua": "^1.3.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.0.3",
+    "@types/node": "^16.11.12",
+    "@types/prettier": "^2.4.2",
+    "@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",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^5.2.0",
+    "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",
+    "typescript-to-lua": "^1.3.1"
+  }
+}

package/runtime/index.d.ts

@@ -1,10 +1,10 @@
-/// <reference types="lua-types/5.2" />
-
-/// <reference path="../generated/index.d.ts" />
-
-/// <reference path="librariesAndFunctions.d.ts" />
-/// <reference path="pairs.d.ts" />
-
-// lualib
-/// <reference path="util.d.ts" />
-/// <reference path="mod-gui.d.ts" />
+/// <reference types="lua-types/5.2" />
+
+/// <reference path="../generated/index.d.ts" />
+
+/// <reference path="librariesAndFunctions.d.ts" />
+/// <reference path="pairs.d.ts" />
+
+// lualib
+/// <reference path="util.d.ts" />
+/// <reference path="mod-gui.d.ts" />

package/runtime/librariesAndFunctions.d.ts

@@ -1,123 +1,123 @@
-// from https://lua-api.factorio.com/latest/Libraries.html
-// last updated for 1.1.35, 1.1.36, 1.1.37
-
-/** @noSelfInFile */
-
-/** @noSelf */
-interface SerpentOptions {
-  /** Indentation; triggers long multi-line output. */
-  indent: string
-  /** Provide stringified value in a comment (up to maxlevel of depth). */
-  comment: boolean | number
-  /** Sort keys. */
-  sortkeys: boolean | ((this: void, keys: any[], table: any) => void)
-  /** Force sparse encoding (no nil filling based on #t). */
-  sparse: boolean
-  /** Remove spaces. */
-  compact: boolean
-  /** Raise fatal error on non-serializable values. */
-  fatal: boolean
-  /** Disable bytecode serialization for easy comparison. */
-  nocode: boolean
-  /** Disable checking numbers against undefined and huge values. */
-  nohuge: boolean
-  /** Specify max level up to which to expand nested tables. */
-  maxlevel: number
-  /** Specify max number of elements in a table. */
-  maxnum: number
-  /** Specify max length for all table elements. */
-  maxlength: number
-  /**
-   * Use __tostring metamethod when serializing tables (v0.29); set to false to disable and serialize the table as is,
-   * even when __tostring is present.
-   */
-  metatostring: boolean
-  /**
-   * Specify format for numeric values as shortest possible round-trippable double (v0.30). Use "%.16g" for better
-   * readability and "%.17g" (the default value) to preserve floating point precision.
-   */
-  numformat: string
-  /** Allows to specify a list of values to ignore (as keys). */
-  valignore: string[]
-  /** Allows to specify the list of keys to be serialized. Any keys not in this list are not included in final output (as keys). */
-  keyallow: string[]
-  /** Allows to specity the list of keys to ignore in serialization. */
-  keyignore: string[]
-  /** Allows to specify a list of value types to ignore (as keys). */
-  valtypeignore: string[]
-  /** Provide custom output for tables. */
-  custom(opts: {
-    /** The name of the current element with '=' or an empty string in case of array index, */
-    tag: string
-    /** An opening table bracket { and associated indentation and newline (if any), */
-    head: string
-    /** Table elements concatenated into a string using commas and indentation/newlines (if any), */
-    body: string
-    /** A closing table bracket } and associated indentation and newline (if any), and */
-    tail: string
-    /** The current level. */
-    level: number
-  }): string
-  /** Name; triggers full serialization with self-ref section. */
-  name: string
-
-  refcomment: boolean | number
-  tablecomment: boolean | number
-}
-
-/**
- * Factorio provides the {@link https://github.com/pkulchenko/serpent serpent library} as a global variable `serpent` for
- * all mods to use. It allows for easy debugging of tables, because serpent makes it trivial to print them, for example
- * by using `serpent.block()`. However, serpent cannot pretty-print LuaObjects such as LuaEntity. The serpent library
- * was modified to improve determinism, e.g. comments are turned off by default to avoid returning table addresses.
- * Furthermore, two options were added: `refcomment` (true/false/maxlevel) and `tablecomment` (true/false/maxlevel),
- * which allow to separately control the self-reference and table value output of the `comment` option.
- */
-declare namespace serpent {
-  /** Full serialization; sets name, compact and sparse options; */
-  function dump(tbl: unknown, options?: Partial<SerpentOptions>): string
-
-  /** Single line pretty printing, no self-ref section; sets sortkeys and comment options; */
-  function line(tbl: unknown, options?: Partial<SerpentOptions>): string
-
-  /** Multi-line indented pretty printing, no self-ref section; sets indent, sortkeys, and comment options. */
-  function block(tbl: unknown, options?: Partial<SerpentOptions>): string
-
-  /**
-   * For loading serialized fragments, serpent also provides `load` function that adds safety checks and reports an
-   * error if there is any executable code in the fragment.
-   */
-  function load<T>(str: string, options?: { safe?: boolean }): LuaMultiReturn<[true, T] | [false, string]>
-}
-
-/**
- * This function allows to log {@link LocalisedString} to the Factorio
- * {@link https://wiki.factorio.com/Log_file log file}. This, in combination with serpent, makes debugging in the data
- * stage easier, because it allows to simply inspect entire prototype tables. For example, this allows to see all
- * properties of the sulfur item prototype: `log(serpent.block(data.raw["item"]["sulfur"]))`
- */
-declare function log(ls: LocalisedString): void
-
-/**
- * This function allows printing {@link LocalisedString}s to stdout without polluting the logfile. This is primarily
- * useful for communicating with external tools that launch Factorio as a child process.
- */
-declare function localised_print(ls: LocalisedString): void
-
-/**
- * Factorio provides the function `table_size()` as a simple way to find the size of tables with non-continuous keys,
- * because the standard `#` does not work correctly for these. The function is a C++-side implementation of the
- * following Lua code, thus it is faster than using this code in Lua:
- *
- *     local function size(t)
- *       local count = 0
- *        for k,v in pairs(t) do
- *         count = count + 1
- *       end
- *       return count
- *     end
- *
- * Note that `table_size()` does not work correctly for {@link LuaCustomTable}s, their size has to be determined with
- * {@link LuaCustomTable.length LuaCustomTable::operator #} instead.
- */
-declare function table_size(tbl: table): number
+// from https://lua-api.factorio.com/latest/Libraries.html
+// last updated for 1.1.35, 1.1.36, 1.1.37
+
+/** @noSelfInFile */
+
+/** @noSelf */
+interface SerpentOptions {
+  /** Indentation; triggers long multi-line output. */
+  indent: string
+  /** Provide stringified value in a comment (up to maxlevel of depth). */
+  comment: boolean | number
+  /** Sort keys. */
+  sortkeys: boolean | ((this: void, keys: any[], table: any) => void)
+  /** Force sparse encoding (no nil filling based on #t). */
+  sparse: boolean
+  /** Remove spaces. */
+  compact: boolean
+  /** Raise fatal error on non-serializable values. */
+  fatal: boolean
+  /** Disable bytecode serialization for easy comparison. */
+  nocode: boolean
+  /** Disable checking numbers against undefined and huge values. */
+  nohuge: boolean
+  /** Specify max level up to which to expand nested tables. */
+  maxlevel: number
+  /** Specify max number of elements in a table. */
+  maxnum: number
+  /** Specify max length for all table elements. */
+  maxlength: number
+  /**
+   * Use __tostring metamethod when serializing tables (v0.29); set to false to disable and serialize the table as is,
+   * even when __tostring is present.
+   */
+  metatostring: boolean
+  /**
+   * Specify format for numeric values as shortest possible round-trippable double (v0.30). Use "%.16g" for better
+   * readability and "%.17g" (the default value) to preserve floating point precision.
+   */
+  numformat: string
+  /** Allows to specify a list of values to ignore (as keys). */
+  valignore: string[]
+  /** Allows to specify the list of keys to be serialized. Any keys not in this list are not included in final output (as keys). */
+  keyallow: string[]
+  /** Allows to specity the list of keys to ignore in serialization. */
+  keyignore: string[]
+  /** Allows to specify a list of value types to ignore (as keys). */
+  valtypeignore: string[]
+  /** Provide custom output for tables. */
+  custom(opts: {
+    /** The name of the current element with '=' or an empty string in case of array index, */
+    tag: string
+    /** An opening table bracket { and associated indentation and newline (if any), */
+    head: string
+    /** Table elements concatenated into a string using commas and indentation/newlines (if any), */
+    body: string
+    /** A closing table bracket } and associated indentation and newline (if any), and */
+    tail: string
+    /** The current level. */
+    level: number
+  }): string
+  /** Name; triggers full serialization with self-ref section. */
+  name: string
+
+  refcomment: boolean | number
+  tablecomment: boolean | number
+}
+
+/**
+ * Factorio provides the {@link https://github.com/pkulchenko/serpent serpent library} as a global variable `serpent` for
+ * all mods to use. It allows for easy debugging of tables, because serpent makes it trivial to print them, for example
+ * by using `serpent.block()`. However, serpent cannot pretty-print LuaObjects such as LuaEntity. The serpent library
+ * was modified to improve determinism, e.g. comments are turned off by default to avoid returning table addresses.
+ * Furthermore, two options were added: `refcomment` (true/false/maxlevel) and `tablecomment` (true/false/maxlevel),
+ * which allow to separately control the self-reference and table value output of the `comment` option.
+ */
+declare namespace serpent {
+  /** Full serialization; sets name, compact and sparse options; */
+  function dump(tbl: unknown, options?: Partial<SerpentOptions>): string
+
+  /** Single line pretty printing, no self-ref section; sets sortkeys and comment options; */
+  function line(tbl: unknown, options?: Partial<SerpentOptions>): string
+
+  /** Multi-line indented pretty printing, no self-ref section; sets indent, sortkeys, and comment options. */
+  function block(tbl: unknown, options?: Partial<SerpentOptions>): string
+
+  /**
+   * For loading serialized fragments, serpent also provides `load` function that adds safety checks and reports an
+   * error if there is any executable code in the fragment.
+   */
+  function load<T>(str: string, options?: { safe?: boolean }): LuaMultiReturn<[true, T] | [false, string]>
+}
+
+/**
+ * This function allows to log {@link LocalisedString} to the Factorio
+ * {@link https://wiki.factorio.com/Log_file log file}. This, in combination with serpent, makes debugging in the data
+ * stage easier, because it allows to simply inspect entire prototype tables. For example, this allows to see all
+ * properties of the sulfur item prototype: `log(serpent.block(data.raw["item"]["sulfur"]))`
+ */
+declare function log(ls: LocalisedString): void
+
+/**
+ * This function allows printing {@link LocalisedString}s to stdout without polluting the logfile. This is primarily
+ * useful for communicating with external tools that launch Factorio as a child process.
+ */
+declare function localised_print(ls: LocalisedString): void
+
+/**
+ * Factorio provides the function `table_size()` as a simple way to find the size of tables with non-continuous keys,
+ * because the standard `#` does not work correctly for these. The function is a C++-side implementation of the
+ * following Lua code, thus it is faster than using this code in Lua:
+ *
+ *     local function size(t)
+ *       local count = 0
+ *        for k,v in pairs(t) do
+ *         count = count + 1
+ *       end
+ *       return count
+ *     end
+ *
+ * Note that `table_size()` does not work correctly for {@link LuaCustomTable}s, their size has to be determined with
+ * {@link LuaCustomTable.length LuaCustomTable::operator #} instead.
+ */
+declare function table_size(tbl: table): number

package/runtime/mod-gui.d.ts

@@ -1,11 +1,11 @@
-/** @noSelfInFile */
-
-/** @noResolution */
-declare module "mod-gui" {
-  const button_style: string
-  const frame_style: string
-
-  function get_button_flow(player: LuaPlayer): FrameGuiElement
-
-  function get_frame_flow(player: LuaPlayer): FlowGuiElement
-}
+/** @noSelfInFile */
+
+/** @noResolution */
+declare module "mod-gui" {
+  const button_style: string
+  const frame_style: string
+
+  function get_button_flow(player: LuaPlayer): FrameGuiElement
+
+  function get_frame_flow(player: LuaPlayer): FlowGuiElement
+}

package/runtime/pairs.d.ts

@@ -1,13 +1,14 @@
-/** @noSelfInFile */
-
-/** Iterating with `pairs` will only iterate the array part of a {@link LuaCustomTable}. */
-declare function pairs<V>(table: LuaCustomTable<number | string, V>): LuaIterable<LuaMultiReturn<[number, V]>>
-
-declare function pairs<K extends keyof any, V>(table: LuaCustomTable<K, V>): LuaIterable<LuaMultiReturn<[K, V]>>
-
-/**
- * {@link LuaCustomTable} cannot be iterated with `ipairs`. Use `pairs` instead.
- *
- * @deprecated
- */
-declare function ipairs(table: LuaCustomTable<any, any>): never
+/** @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]>>
+
+/** **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]>>
+
+/** @deprecated {@link LuaCustomTable} cannot be iterated with `ipairs`; Use {@link pairs} instead. */
+declare function ipairs(table: LuaCustomTable<any, any>): never