typed-factorio 1.17.0 → 2.0.0

package/runtime/generated/global-functions.d.ts

@@ -2,32 +2,34 @@
 
 /** @noSelfInFile */
 
-/**
- * `log()` can print {@link LocalisedString LocalisedStrings} to the Factorio {@linkplain https://wiki.factorio.com/Log_file log file}. This, in combination with the serpent library, makes debugging in the data stage easier because it allows the inspection of entire prototype tables. For example, printing all properties of the sulfur item prototype can be done like so: `log(serpent.block(data.raw["item"]["sulfur"]))`
- * @see {@link https://lua-api.factorio.com/latest/Libraries.html#2.-new-functions Online documentation}
- */
-declare function log(string: LocalisedString): void
+import type { LocalisedString, table, uint } from "factorio:runtime"
 
-/**
- * `localised_print()` allows printing {@link LocalisedString} to stdout without polluting the Factorio {@linkplain https://wiki.factorio.com/Log_file log file}. This is primarily useful when communicating with external tools that launch Factorio as a child process.
- * @see {@link https://lua-api.factorio.com/latest/Libraries.html#2.-new-functions Online documentation}
- */
-declare function localised_print(string: LocalisedString): void
-
-/**
- * Factorio provides the `table_size()` function as a simple way to determine the size of tables with non-continuous keys, as the standard `#` operator does not work correctly for these. The function is a C++ implementation of the following Lua code, which is faster than doing the same 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}, their size has to be determined with {@link LuaCustomTable#length LuaCustomTable::length_operator} instead.
- * @see {@link https://lua-api.factorio.com/latest/Libraries.html#2.-new-functions Online documentation}
- */
-declare function table_size(table: table): uint
+declare global {
+  /**
+   * `log()` can print {@link LocalisedString LocalisedStrings} to the Factorio {@linkplain https://wiki.factorio.com/Log_file log file}. This, in combination with the serpent library, makes debugging in the data stage easier because it allows the inspection of entire prototype tables. For example, printing all properties of the sulfur item prototype can be done like so: `log(serpent.block(data.raw["item"]["sulfur"]))`
+   * @see {@link https://lua-api.factorio.com/1.1.89/auxiliary/libraries.html#new-functions Online documentation}
+   */
+  function log(string: LocalisedString): void
+  /**
+   * `localised_print()` allows printing {@link LocalisedString} to stdout without polluting the Factorio {@linkplain https://wiki.factorio.com/Log_file log file}. This is primarily useful when communicating with external tools that launch Factorio as a child process.
+   * @see {@link https://lua-api.factorio.com/1.1.89/auxiliary/libraries.html#new-functions Online documentation}
+   */
+  function localised_print(string: LocalisedString): void
+  /**
+   * Factorio provides the `table_size()` function as a simple way to determine the size of tables with non-continuous keys, as the standard `#` operator does not work correctly for these. The function is a C++ implementation of the following Lua code, which is faster than doing the same 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}, their size has to be determined with {@link LuaCustomTable#length LuaCustomTable::length_operator} instead.
+   * @see {@link https://lua-api.factorio.com/1.1.89/auxiliary/libraries.html#new-functions Online documentation}
+   */
+  function table_size(table: table): uint
+}

package/runtime/generated/global-objects.d.ts

@@ -2,44 +2,45 @@
 
 /** @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}.
- * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
- */
-declare const game: LuaGameScript
-
-/**
- * Provides an interface for registering event handlers.
- * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
- */
-declare const script: LuaBootstrap
-
-/**
- * Allows inter-mod communication by way of providing a repository of interfaces that is shared by all mods.
- * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
- */
-declare const remote: LuaRemote
-
-/**
- * Allows registering custom commands for the in-game console accessible via the grave key.
- * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
- */
-declare const commands: LuaCommandProcessor
-
-/**
- * Allows reading the current mod settings.
- * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
- */
-declare const settings: LuaSettings
-
-/**
- * Allows printing messages to the calling RCON instance if any.
- * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
- */
-declare const rcon: LuaRCON
-
-/**
- * Allows rendering of geometric shapes, text and sprites in the game world.
- * @see {@link https://lua-api.factorio.com/latest/ Online documentation}
- */
-declare const rendering: LuaRendering
+import type {
+  LuaBootstrap,
+  LuaCommandProcessor,
+  LuaGameScript,
+  LuaRCON,
+  LuaRemote,
+  LuaRendering,
+} from "factorio:runtime"
+
+declare global {
+  /**
+   * The main scripting interface through which most of the API is accessed.
+   * @see {@link https://lua-api.factorio.com/1.1.89/index-runtime.html Online documentation}
+   */
+  const game: LuaGameScript
+  /**
+   * Provides an interface for registering game event handlers.
+   * @see {@link https://lua-api.factorio.com/1.1.89/index-runtime.html Online documentation}
+   */
+  const script: LuaBootstrap
+  /**
+   * Allows registration and use of functions to communicate between mods.
+   * @see {@link https://lua-api.factorio.com/1.1.89/index-runtime.html Online documentation}
+   */
+  const remote: LuaRemote
+  /**
+   * Allows registration of custom commands for the in-game console.
+   * @see {@link https://lua-api.factorio.com/1.1.89/index-runtime.html Online documentation}
+   */
+  const commands: LuaCommandProcessor
+  //The "settings" global is declared in common/settings-global.d.ts; its runtime type is handled below.
+  /**
+   * Allows printing messages to the calling RCON instance, if any.
+   * @see {@link https://lua-api.factorio.com/1.1.89/index-runtime.html Online documentation}
+   */
+  const rcon: LuaRCON
+  /**
+   * Allows rendering of geometric shapes, text and sprites in the game world.
+   * @see {@link https://lua-api.factorio.com/1.1.89/index-runtime.html Online documentation}
+   */
+  const rendering: LuaRendering
+}

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

@@ -3,54 +3,55 @@
 /** @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`.
+ * @noResolution
  */
-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 LuaForce#index LuaForce.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 ForceIndex`.
- */
-type ForceIndex = uint & IndexBrand<"_forceIndexBrand">
-
-/**
- * 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
+declare module "factorio:runtime" {
+  /**
+   * See {@link LuaPlayer#index LuaPlayer.index}.
+   *
+   * You can cast a raw number to this type, e.g. `1 as PlayerIndex`.
+   */
+  type PlayerIndex = uint & {
+    _playerIndexBrand: void
+  }
+  /**
+   * See {@link LuaSurface#index LuaSurface.index}.
+   *
+   * You can cast a raw number to this type, e.g. `1 as SurfaceIndex`.
+   */
+  type SurfaceIndex = uint & {
+    _surfaceIndexBrand: void
+  }
+  /**
+   * See {@link LuaForce#index LuaForce.index}.
+   *
+   * You can cast a raw number to this type, e.g. `1 as ForceIndex`.
+   */
+  type ForceIndex = uint & {
+    _forceIndexBrand: void
+  }
+  /**
+   * See {@link LuaEntity#unit_number LuaEntity.unit_number}.
+   *
+   * You can cast a raw number to this type, e.g. `1 as UnitNumber`.
+   */
+  type UnitNumber = uint & {
+    _unitNumberBrand: void
+  }
+  /**
+   * See {@link LuaGuiElement#index LuaGuiElement.index}.
+   *
+   * You can cast a raw number to this type, e.g. `1 as GuiElementIndex`.
+   */
+  type GuiElementIndex = uint & {
+    _guiElementIndexBrand: void
+  }
+  /**
+   * See {@link LuaBootstrap#register_on_entity_destroyed LuaBootstrap.register_on_entity_destroyed}.
+   *
+   * You can cast a raw number to this type, e.g. `1 as RegistrationNumber`.
+   */
+  type RegistrationNumber = uint64 & {
+    _registrationNumberBrand: void
+  }
+}

package/runtime/index.d.ts

@@ -1,19 +1,11 @@
-/// <reference types="lua-types/5.2" />
+// This file declares globals for the factorio runtime stage.
 
-// generated
-/// <reference path="./generated/builtin-types.d.ts" />
+/// <reference path="../index.d.ts" />
 /// <reference path="./generated/global-objects.d.ts" />
-/// <reference path="./generated/global-functions.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" />
+/// <reference path="../common/settings-global.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" />
+/** @noResolution */
+declare module "factorio:common" {
+  import { LuaSettings } from "factorio:runtime"
+  export interface SettingsGlobal extends LuaSettings {}
+}

package/runtime/pairs.d.ts

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

package/settings/index.d.ts

@@ -0,0 +1,10 @@
+// This file declares globals for the factorio settings stage.
+
+/// <reference path="../index.d.ts" />
+/// <reference path="../common/data-global.d.ts" />
+
+/** @noResolution */
+declare module "factorio:common" {
+  import { PrototypeMap } from "factorio:settings"
+  export interface GlobalPrototypeMap extends PrototypeMap {}
+}

package/settings/types.d.ts

@@ -1,120 +1,111 @@
 // Based off of https://wiki.factorio.com/Tutorial:Mod_settings
 
-export type SettingType = "bool-setting" | "int-setting" | "double-setting" | "string-setting"
+/** @noResolution */
+declare module "factorio:settings" {
+  import { LocalisedString } from "factorio:prototype"
+  export type SettingType = "bool-setting" | "int-setting" | "double-setting" | "string-setting"
 
-export interface BaseSettingDefinition {
-  type: SettingType
-  /**
-   * The name of the settings prototype should be unique to avoid mod conflicts since the mod settings are global across
-   * all mods. Because of that it is recommended to prefix mod settings with your mod name,
-   */
-  name: string
-  localized_name?: LocalisedString
-  localized_description?: LocalisedString
+  export interface BaseSettingDefinition {
+    readonly type: SettingType
+    /**
+     * The name of the settings prototype should be unique to avoid mod conflicts since the mod settings are global across
+     * all mods. Because of that it is recommended to prefix mod settings with your mod name,
+     */
+    name: string
+    localized_name?: LocalisedString
+    localized_description?: LocalisedString
 
-  /**
-   * The order property can be used to change how the mod settings are ordered in the settings gui. Mod settings are sorted
-   *
-   * - First by mod
-   * - Then by the setting "order" string
-   * - Then finally by the setting name.
-   */
-  order?: string
-  /**
-   * The hidden property can be used to hide mod settings from GUIs, so that they cannot be seen or changed by players.
-   * However, other mods can still access hidden settings. {@link https://forums.factorio.com/83316}
-   */
-  hidden?: boolean
-  /**
-   * There are the overall kinds of settings:
-   *
-   * - **startup**: This kind of setting is available in the prototype stage, and can not be changed runtime. They have to
-   *   be set to the same values for all players on a server.
-   * - **runtime-global**: This kind of setting is global to an entire save game and can be changed runtime. On servers,
-   *   only admins can change these settings.
-   * - **runtime-per-user**: This kind of setting is only available runtime in the control.lua stage and each player has
-   *   their own instance of this setting. When a player joins a server their local setting of "keep mod settings per
-   *   save" determines if the local settings they have set are synced to the loaded save or if the save's settings are used.
-   *
-   * This "setting_type" also determines in which tab the setting is showed in the mod settings menu.
-   */
+    /**
+     * The order property can be used to change how the mod settings are ordered in the settings gui. Mod settings are sorted
+     *
+     * - First by mod
+     * - Then by the setting "order" string
+     * - Then finally by the setting name.
+     */
+    order?: string
+    /**
+     * The hidden property can be used to hide mod settings from GUIs, so that they cannot be seen or changed by players.
+     * However, other mods can still access hidden settings. {@link https://forums.factorio.com/83316}
+     */
+    hidden?: boolean
+    /**
+     * There are the overall kinds of settings:
+     *
+     * - **startup**: This kind of setting is available in the prototype stage, and can not be changed runtime. They have to
+     *   be set to the same values for all players on a server.
+     * - **runtime-global**: This kind of setting is global to an entire save game and can be changed runtime. On servers,
+     *   only admins can change these settings.
+     * - **runtime-per-user**: This kind of setting is only available runtime in the control.lua stage and each player has
+     *   their own instance of this setting. When a player joins a server their local setting of "keep mod settings per
+     *   save" determines if the local settings they have set are synced to the loaded save or if the save's settings are used.
+     *
+     * This "setting_type" also determines in which tab the setting is showed in the mod settings menu.
+     */
 
-  setting_type: "startup" | "runtime-global" | "runtime-per-user"
-}
-/** A true/false checkbox */
-export interface BoolSettingDefinition extends BaseSettingDefinition {
-  type: "bool-setting"
-  /** Defines the default value of the setting, in this case whether the checkbox is checked or not. */
-  default_value: boolean
-  /**
-   * Only loaded if `hidden = true`. This forces the setting to be of this value. This can be useful for mod
-   * compatibility. {@link https://forums.factorio.com/viewtopic.php?p=531322#p531322}
-   */
-  forced_value?: boolean
-}
-/** A signed 64 bit integer textfield (or selection dropdown) */
-export interface IntSettingDefinition extends BaseSettingDefinition {
-  type: "int-setting"
-  /** Defines the default value of the setting. */
-  default_value: number
-  /** Defines the lowest possible number. */
-  minimum_value?: number
-  /** Defines the highest possible number. */
-  maximum_value?: number
-  /**
-   * Makes it possible to force the player to choose between the defined numbers, creates a dropdown instead of a
-   * textfield. If only one allowed value is given, the settings is forced to be of that value.
-   */
-  allowed_values?: number[]
-}
-/** A double precision floating point textfield (or selection dropdown) */
-export interface DoubleSettingDefinition extends BaseSettingDefinition {
-  type: "double-setting"
-  /** Defines the default value of the setting. */
-  default_value: number
-  /** Defines the lowest possible number. */
-  minimum_value?: number
-  /** Defines the highest possible number. */
-  maximum_value?: number
-  /**
-   * Makes it possible to force the player to choose between the defined numbers, creates a dropdown instead of a
-   * textfield. If only one allowed value is given, the settings is forced to be of that value.
-   */
-  allowed_values?: number[]
-}
-/** A string textfield (or selection dropdown) */
-export interface StringSettingDefinition extends BaseSettingDefinition {
-  type: "string-setting"
-  /** Defines the default value of the setting. */
-  default_value: string
-  /** Defines whether it's possible for the user to set the textfield to empty and apply the setting. */
-  allow_blank?: boolean
-  /** Whether values that are input by the user should have whitespace removed from both ends of the string. */
-  auto_trim?: boolean
-  /**
-   * Makes it possible to force the player to choose between the defined strings, creates a dropdown instead of a
-   * textfield. The strings in the dropdown can be localized (translated) and can have a tooltip, see below. If only one
-   * allowed value is given, the settings is forced to be of that value.
-   */
-  allowed_values?: string[]
-}
-/** Setting definitions. See {@link https://wiki.factorio.com/Tutorial:Mod_settings} for more info. */
-export type SettingDefinition =
-  | BoolSettingDefinition
-  | IntSettingDefinition
-  | DoubleSettingDefinition
-  | StringSettingDefinition
+    setting_type: "startup" | "runtime-global" | "runtime-per-user"
+  }
+  /** A true/false checkbox */
+  export interface BoolSettingDefinition extends BaseSettingDefinition {
+    readonly type: "bool-setting"
+    /** Defines the default value of the setting, in this case whether the checkbox is checked or not. */
+    default_value: boolean
+    /**
+     * Only loaded if `hidden = true`. This forces the setting to be of this value. This can be useful for mod
+     * compatibility. {@link https://forums.factorio.com/viewtopic.php?p=531322#p531322}
+     */
+    forced_value?: boolean
+  }
+  /** A signed 64 bit integer textfield (or selection dropdown) */
+  export interface IntSettingDefinition extends BaseSettingDefinition {
+    readonly type: "int-setting"
+    /** Defines the default value of the setting. */
+    default_value: number
+    /** Defines the lowest possible number. */
+    minimum_value?: number
+    /** Defines the highest possible number. */
+    maximum_value?: number
+    /**
+     * Makes it possible to force the player to choose between the defined numbers, creates a dropdown instead of a
+     * textfield. If only one allowed value is given, the settings is forced to be of that value.
+     */
+    allowed_values?: number[]
+  }
+  /** A double precision floating point textfield (or selection dropdown) */
+  export interface DoubleSettingDefinition extends BaseSettingDefinition {
+    readonly type: "double-setting"
+    /** Defines the default value of the setting. */
+    default_value: number
+    /** Defines the lowest possible number. */
+    minimum_value?: number
+    /** Defines the highest possible number. */
+    maximum_value?: number
+    /**
+     * Makes it possible to force the player to choose between the defined numbers, creates a dropdown instead of a
+     * textfield. If only one allowed value is given, the settings is forced to be of that value.
+     */
+    allowed_values?: number[]
+  }
+  /** A string textfield (or selection dropdown) */
+  export interface StringSettingDefinition extends BaseSettingDefinition {
+    readonly type: "string-setting"
+    /** Defines the default value of the setting. */
+    default_value: string
+    /** Defines whether it's possible for the user to set the textfield to empty and apply the setting. */
+    allow_blank?: boolean
+    /** Whether values that are input by the user should have whitespace removed from both ends of the string. */
+    auto_trim?: boolean
+    /**
+     * Makes it possible to force the player to choose between the defined strings, creates a dropdown instead of a
+     * textfield. The strings in the dropdown can be localized (translated) and can have a tooltip, see below. If only one
+     * allowed value is given, the settings is forced to be of that value.
+     */
+    allowed_values?: string[]
+  }
 
-export interface Data {
-  readonly raw: {
-    [T in SettingDefinition["type"]]: Record<string, Extract<SettingDefinition, { type: T }>>
+  export interface PrototypeMap {
+    "bool-setting": BoolSettingDefinition
+    "int-setting": IntSettingDefinition
+    "double-setting": DoubleSettingDefinition
+    "string-setting": StringSettingDefinition
   }
-  /**
-   * The `data` table expects a specific format for each item in the table. Missing properties will either fall back to
-   * default values or give an error indicating what's missing. Extra properties that the game isn't looking for are
-   * simply ignored.
-   */
-  extend(prototypes: SettingDefinition[]): void
 }
-/** A mapping of mod names to mod version for all enabled mods. */
-export type Mods = Record<string, string>

package/custom-index-template.d.ts

@@ -1,23 +0,0 @@
-// This references the same files as "typed-factorio/runtime".
-// For example, if you want to modify a file, copy the file you want to modify to your project and make the changes. Then, copy this template file into your project and remove the line corresponding to modified file.
-// If you think your modification will be useful to others, please consider making a change suggestion by creating an issue on GitHub.
-
-/// <reference types="lua-types/5.2" />
-
-// generated
-/// <reference types="typed-factorio/runtime/generated/builtin-types.d.ts" />
-/// <reference types="typed-factorio/runtime/generated/global-objects.d.ts" />
-/// <reference types="typed-factorio/runtime/generated/global-functions.d.ts" />
-/// <reference types="typed-factorio/runtime/generated/defines.d.ts" />
-/// <reference types="typed-factorio/runtime/generated/events.d.ts" />
-/// <reference types="typed-factorio/runtime/generated/classes.d.ts" />
-/// <reference types="typed-factorio/runtime/generated/concepts.d.ts" />
-/// <reference types="typed-factorio/runtime/generated/index-types.d.ts" />
-
-// other runtime
-/// <reference types="typed-factorio/runtime/librariesAndFunctions.d.ts" />
-/// <reference types="typed-factorio/runtime/pairs.d.ts" />
-
-// lualib
-/// <reference types="typed-factorio/runtime/util.d.ts" />
-/// <reference types="typed-factorio/runtime/mod-gui.d.ts" />

package/data/types.d.ts

@@ -1,13 +0,0 @@
-export interface Data {
-  readonly raw: Record<string, Record<string, any>>
-
-  /**
-   * The `data` table expects a specific format for each item in the table. Missing properties will either fall back to
-   * default values or give an error indicating what's missing. Extra properties that the game isn't looking for are
-   * simply ignored.
-   */
-  extend(prototypes: Record<string, any>[]): void
-}
-
-/** A mapping of mod names to mod version for all enabled mods. */
-export type Mods = Record<string, string>