typed-factorio 2.14.0 → 3.0.1

package/README.md

@@ -28,7 +28,7 @@ Example:
 ```
 
 The stages used will select the global variables defined.
-You can include multiple stages, but there are some caveats. See [Using multiple stages in the same project](#using-multiple-stages-in-the-same-project) for more info.
+You can include multiple stages, but there are some caveats. See [Using multiple stages in the same project](#using-multiple-loading-stages-in-the-same-project) for more info.
 
 ## Usage notes
 
@@ -107,14 +107,15 @@ const foo = util.copy(bar)
 
 If you wish to see types for more lualib modules, feel free to open an issue or pull request.
 
-### The `global` table
+### The `storage` table
 
-The `global` table (in the runtime stage) can have any shape, so it is not defined here. Instead, you can define it yourself:
+The `storage` table (in the runtime stage) can have any shape, so it is not defined here. Instead, you can define it yourself:
 
-- Add `declare const global: <Your type>` in a `.d.ts` file included in your project, to apply it project-wide.
-- Add `declare const global: {...}` to each file where needed. This way, you can define only properties that each file specifically uses.
+- Add `declare const storage: <Your type>` in a `.d.ts` file. Make sure this file is included by your tsconfig!
+- Add `declare global { const storage: <Your type> }` in a `.ts` file included in your project.
+- Add `declare const storage: {...}` to each file where needed. This way, you can define only properties that each file specifically uses.
 
-## Using multiple stages in the same project
+## Using multiple loading stages in the same project
 
 Every Factorio loading stage declares different global variables.
 To add types for multiple Factorio stages, you have a few options:
@@ -123,17 +124,19 @@ To add types for multiple Factorio stages, you have a few options:
 2. Add _only_ the runtime stage, then manually declare other global variables in files that use them. There are types in `"factorio:common"` to allow this:
    ```ts
    // -- For the prototype stage --
-   import { PrototypeData, ActiveMods } from "factorio:common"
+   import { PrototypeData, ActiveMods, FeatureFlags } from "factorio:common"
    declare const data: PrototypeData
    declare const mods: ActiveMods
+   declare const feature_flags: FeatureFlags
    // The `settings` global variable is already declared in the runtime stage.
    // However, in the prototype stage _only_ `settings.startup` are available.
    ```
    ```ts
    // -- For the settings stage --
-   import { SettingsData, ActiveMods } from "factorio:common"
+   import { SettingsData, ActiveMods, FeatureFlags } from "factorio:common"
    declare const data: SettingsData
    declare const mods: ActiveMods
+   declare const feature_flags: FeatureFlags
    ```
 3. Use a separate `tsconfig.json` for each stage. In each `tsconfig.json`, add only files in that stage to the `"include"` field, e.g. `include: ["src/control.ts"]` for the runtime stage. However, this means you need to run `tstl` separately for each stage, and files shared by multiple stages will be compiled multiple times.
 

package/common/data-global.d.ts

@@ -13,3 +13,11 @@ declare const data: import("factorio:common").DataGlobal
  * In the runtime stage, use `script.active_mods`.
  */
 declare const mods: import("factorio:common").ActiveMods
+
+/**
+ * A dict of feature flags and their status.
+ *
+ * This global is only available in the settings or prototype stage.
+ * In the runtime stage, use `script.feature_flags`.
+ */
+declare const feature_flags: import("factorio:common").FeatureFlags

package/common/types.d.ts

@@ -1,6 +1,6 @@
 /** @noResolution */
 declare module "factorio:common" {
-  import { ModSetting } from "factorio:runtime"
+  import { ModSetting, LuaBootstrap } from "factorio:runtime"
   import { Data } from "factorio:prototype"
   import { SettingsPrototypeMap } from "factorio:settings"
   /**
@@ -48,6 +48,8 @@ declare module "factorio:common" {
     readonly [modName: string]: VersionString | undefined
   }
 
+  export type FeatureFlags = LuaBootstrap["feature_flags"]
+
   /**
    * Represents the `data` global variable for the prototype stage.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "2.14.0",
+  "version": "3.0.1",
   "description": "Featureful typescript definitions for the Factorio modding api.",
   "keywords": [
     "factorio",
@@ -46,7 +46,6 @@
     "@types/node": "^20.11.29",
     "@typescript-eslint/eslint-plugin": "^7.3.0",
     "@typescript-eslint/parser": "^7.3.0",
-    "chalk": "^5.3.0",
     "download": "^8.0.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",