typed-factorio 3.10.0 → 3.11.0

package/common/serpent.d.ts

@@ -1,94 +1,94 @@
-// from https://lua-api.factorio.com/latest/Libraries.html
-
-/** @noSelfInFile */
-
-/**
- * Factorio provides the {@link https://github.com/pkulchenko/serpent serpent library} as a global variable named
- * `serpent` for all mods to use. Its purpose is to allow for easy printing of Lua tables (using `serpent.block()` for
- * example), which can be useful when debugging. It can't pretty-print LuaObjects such as {@link LuaEntity} however.
- *
- * The serpent library was modified for 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 {
-  /** @noSelf */
-  interface Options {
-    /** 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
-  }
-
-  /** Full serialization; sets name, compact and sparse options; */
-  function dump(tbl: unknown, options?: Partial<Options>): string
-
-  /** Single line pretty printing, no self-ref section; sets sortkeys and comment options; */
-  function line(tbl: unknown, options?: Partial<Options>): string
-
-  /** Multi-line indented pretty printing, no self-ref section; sets indent, sortkeys, and comment options. */
-  function block(tbl: unknown, options?: Partial<Options>): 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]>
-}
+// from https://lua-api.factorio.com/latest/Libraries.html
+
+/** @noSelfInFile */
+
+/**
+ * Factorio provides the {@link https://github.com/pkulchenko/serpent serpent library} as a global variable named
+ * `serpent` for all mods to use. Its purpose is to allow for easy printing of Lua tables (using `serpent.block()` for
+ * example), which can be useful when debugging. It can't pretty-print LuaObjects such as {@link LuaEntity} however.
+ *
+ * The serpent library was modified for 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 {
+  /** @noSelf */
+  interface Options {
+    /** 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
+  }
+
+  /** Full serialization; sets name, compact and sparse options; */
+  function dump(tbl: unknown, options?: Partial<Options>): string
+
+  /** Single line pretty printing, no self-ref section; sets sortkeys and comment options; */
+  function line(tbl: unknown, options?: Partial<Options>): string
+
+  /** Multi-line indented pretty printing, no self-ref section; sets indent, sortkeys, and comment options. */
+  function block(tbl: unknown, options?: Partial<Options>): 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]>
+}

package/common/settings-global.d.ts

@@ -1,8 +1,8 @@
-/**
- * Provides access to the current mod settings.
- * This is available in the prototype and runtime stages.
- *
- * In the prototype stage, _only_ the `startup` settings are available.
- * In the runtime stage, this is extended with the full {@link LuaSettings} interface.
- */
-declare const settings: import("factorio:common").SettingsGlobal
+/**
+ * Provides access to the current mod settings.
+ * This is available in the prototype and runtime stages.
+ *
+ * In the prototype stage, _only_ the `startup` settings are available.
+ * In the runtime stage, this is extended with the full {@link LuaSettings} interface.
+ */
+declare const settings: import("factorio:common").SettingsGlobal

package/common/types.d.ts

@@ -1,106 +1,106 @@
-/** @noResolution */
-declare module "factorio:common" {
-  import { ModSetting, LuaBootstrap } from "factorio:runtime"
-  import { Data } from "factorio:prototype"
-  import { SettingsPrototypeMap } from "factorio:settings"
-  /**
-   * A type map of type name -> prototype type.
-   *
-   * Including the settings/prototype stage in your tsconfig extends this interface.
-   */
-  export interface GlobalPrototypeMap {}
-
-  /** Represents any valid prototype. */
-  export interface AnyPrototype<M = GlobalPrototypeMap> {
-    readonly type: keyof M
-    readonly name: string
-  }
-
-  /**
-   * See {@link Data} for documentation.
-   */
-  export interface DataGlobal<M = GlobalPrototypeMap> {
-    /**
-     * A table of the already added prototypes.
-     * Indexed by prototype type, then by prototype name.
-     */
-    readonly raw: {
-      readonly [type in keyof M]: {
-        readonly [name in string]?: M[type]
-      }
-    }
-
-    extend<P extends AnyPrototype<M>>(prototypes: readonly P[]): void
-
-    is_demo: boolean
-  }
-
-  export interface SettingsGlobal {
-    readonly startup: {
-      readonly [name: string]: ModSetting
-    }
-  }
-
-  /** A version string, in the form "major.minor.patch". */
-  export type VersionString = `${bigint}.${bigint}.${bigint}`
-
-  export interface ActiveMods {
-    readonly [modName: string]: VersionString | undefined
-  }
-
-  export type FeatureFlags = LuaBootstrap["feature_flags"]
-
-  /**
-   * Represents the `data` global variable for the prototype stage.
-   *
-   * If you did _not_ add `"typed-factorio/prototype"` to your tsconfig, you can manually declare this global like so:
-   * ```ts
-   * import { PrototypeData } from "factorio:prototype"
-   * declare const data: PrototypeData
-   *
-   * data.extend(...)
-   * ```
-   */
-  export type PrototypeData = Data
-
-  /**
-   * Represents the `data` global variable for the settings stage.
-   *
-   * If you did _not_ add `"typed-factorio/settings"` to your tsconfig, you can manually declare this global like so:
-   * ```ts
-   * import { SettingsData } from "factorio:settings"
-   * declare const data: SettingsData
-   *
-   * data.extend(...)
-   * ```
-   */
-  export type SettingsData = DataGlobal<SettingsPrototypeMap>
-
-  /**
-   * You can optionally extend this interface to provide type checking and autocompletion for custom input names, like so:
-   * ```ts
-   * declare module "factorio:common" {
-   *    export interface CustomInputNames {
-   *        "my-custom-event": true
-   *    }
-   * }
-   *
-   * // this enables type checking for the following:
-   * script.on_event("my-custom-event", ...)
-   *
-   * data.extend<CustomInputPrototype>([{
-   *   type: "custom-input",
-   *   name: "my-custom-event", // type checked
-   * }])
-   * ```
-   * @see CustomInputName
-   */
-  export interface CustomInputNames {}
-
-  /**
-   * All custom event names. See {@link CustomInputNames}.
-   *
-   * If none are specified, this is just `string`.
-   */
-  export type CustomInputName = [keyof CustomInputNames] extends [never] ? string : keyof CustomInputNames
-}
+/** @noResolution */
+declare module "factorio:common" {
+  import { ModSetting, LuaBootstrap } from "factorio:runtime"
+  import { Data } from "factorio:prototype"
+  import { SettingsPrototypeMap } from "factorio:settings"
+  /**
+   * A type map of type name -> prototype type.
+   *
+   * Including the settings/prototype stage in your tsconfig extends this interface.
+   */
+  export interface GlobalPrototypeMap {}
+
+  /** Represents any valid prototype. */
+  export interface AnyPrototype<M = GlobalPrototypeMap> {
+    readonly type: keyof M
+    readonly name: string
+  }
+
+  /**
+   * See {@link Data} for documentation.
+   */
+  export interface DataGlobal<M = GlobalPrototypeMap> {
+    /**
+     * A table of the already added prototypes.
+     * Indexed by prototype type, then by prototype name.
+     */
+    readonly raw: {
+      readonly [type in keyof M]: {
+        readonly [name in string]?: M[type]
+      }
+    }
+
+    extend<P extends AnyPrototype<M>>(prototypes: readonly P[]): void
+
+    is_demo: boolean
+  }
+
+  export interface SettingsGlobal {
+    readonly startup: {
+      readonly [name: string]: ModSetting
+    }
+  }
+
+  /** A version string, in the form "major.minor.patch". */
+  export type VersionString = `${bigint}.${bigint}.${bigint}`
+
+  export interface ActiveMods {
+    readonly [modName: string]: VersionString | undefined
+  }
+
+  export type FeatureFlags = LuaBootstrap["feature_flags"]
+
+  /**
+   * Represents the `data` global variable for the prototype stage.
+   *
+   * If you did _not_ add `"typed-factorio/prototype"` to your tsconfig, you can manually declare this global like so:
+   * ```ts
+   * import { PrototypeData } from "factorio:prototype"
+   * declare const data: PrototypeData
+   *
+   * data.extend(...)
+   * ```
+   */
+  export type PrototypeData = Data
+
+  /**
+   * Represents the `data` global variable for the settings stage.
+   *
+   * If you did _not_ add `"typed-factorio/settings"` to your tsconfig, you can manually declare this global like so:
+   * ```ts
+   * import { SettingsData } from "factorio:settings"
+   * declare const data: SettingsData
+   *
+   * data.extend(...)
+   * ```
+   */
+  export type SettingsData = DataGlobal<SettingsPrototypeMap>
+
+  /**
+   * You can optionally extend this interface to provide type checking and autocompletion for custom input names, like so:
+   * ```ts
+   * declare module "factorio:common" {
+   *    export interface CustomInputNames {
+   *        "my-custom-event": true
+   *    }
+   * }
+   *
+   * // this enables type checking for the following:
+   * script.on_event("my-custom-event", ...)
+   *
+   * data.extend<CustomInputPrototype>([{
+   *   type: "custom-input",
+   *   name: "my-custom-event", // type checked
+   * }])
+   * ```
+   * @see CustomInputName
+   */
+  export interface CustomInputNames {}
+
+  /**
+   * All custom event names. See {@link CustomInputNames}.
+   *
+   * If none are specified, this is just `string`.
+   */
+  export type CustomInputName = [keyof CustomInputNames] extends [never] ? string : keyof CustomInputNames
+}

package/index.d.ts

@@ -1,25 +1,25 @@
-/*
-This file includes _only_ types for all factorio stages; it declares the factorio:common, factorio:prototype,
-and factorio:runtime modules.
-*/
-/// <reference types="lua-types/5.2" />
-
-/// <reference path="common/types.d.ts" />
-
-/// <reference path="settings/types.d.ts" />
-
-/// <reference path="prototype/generated/prototypes.d.ts" />
-/// <reference path="prototype/generated/types.d.ts" />
-
-/// <reference path="runtime/generated/events.d.ts" />
-/// <reference path="runtime/generated/classes.d.ts" />
-/// <reference path="runtime/generated/concepts.d.ts" />
-/// <reference path="runtime/generated/index-types.d.ts" />
-/// <reference path="runtime/pairs.d.ts" />
-
-/// <reference path="lualib/index.d.ts" />
-
-// common globals
-/// <reference path="common/serpent.d.ts" />
-/// <reference path="runtime/generated/defines.d.ts" />
-/// <reference path="runtime/generated/global-functions.d.ts" />
+/*
+This file includes _only_ types for all factorio stages; it declares the factorio:common, factorio:prototype,
+and factorio:runtime modules.
+*/
+/// <reference types="lua-types/5.2" />
+
+/// <reference path="common/types.d.ts" />
+
+/// <reference path="settings/types.d.ts" />
+
+/// <reference path="prototype/generated/prototypes.d.ts" />
+/// <reference path="prototype/generated/types.d.ts" />
+
+/// <reference path="runtime/generated/events.d.ts" />
+/// <reference path="runtime/generated/classes.d.ts" />
+/// <reference path="runtime/generated/concepts.d.ts" />
+/// <reference path="runtime/generated/index-types.d.ts" />
+/// <reference path="runtime/pairs.d.ts" />
+
+/// <reference path="lualib/index.d.ts" />
+
+// common globals
+/// <reference path="common/serpent.d.ts" />
+/// <reference path="runtime/generated/defines.d.ts" />
+/// <reference path="runtime/generated/global-functions.d.ts" />

package/lualib/index.d.ts

@@ -1,2 +1,2 @@
-/// <reference path="util.d.ts" />
-/// <reference path="mod-gui.d.ts" />
+/// <reference path="util.d.ts" />
+/// <reference path="mod-gui.d.ts" />

package/lualib/mod-gui.d.ts

@@ -1,12 +1,12 @@
-/** @noSelfInFile */
-
-/** @noResolution */
-declare module "mod-gui" {
-  import { FlowGuiElement, FrameGuiElement, LuaPlayer } from "factorio:runtime"
-  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" {
+  import { FlowGuiElement, FrameGuiElement, LuaPlayer } from "factorio:runtime"
+  const button_style: string
+  const frame_style: string
+
+  function get_button_flow(player: LuaPlayer): FrameGuiElement
+
+  function get_frame_flow(player: LuaPlayer): FlowGuiElement
+}