Merge pull request #1182 from UFOMelkor/core-flag-config

Moves core flags for ActiveEffect to ActiveEffectData
League-of-Foundry-Developers · Sep 18, 2021 · 48e4789 · 48e4789
2 parents ee1e63c + 47326ab
commit 48e4789
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 10 deletions.
diff --git a/src/foundry/common/data/data.mjs/activeEffectData.d.ts b/src/foundry/common/data/data.mjs/activeEffectData.d.ts
@@ -26,6 +26,10 @@ interface ActiveEffectDataSchema extends DocumentSchema {
   flags: typeof fields.OBJECT_FIELD; // TODO: add more concrete object type
 }
 
+interface CoreFlags {
+  core?: { statusId?: string; overlay?: boolean };
+}
+
 interface ActiveEffectDataProperties {
   /**
    * The _id which uniquely identifies the ActiveEffect within a parent Actor or Item
@@ -79,7 +83,7 @@ interface ActiveEffectDataProperties {
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags: ConfiguredFlags<'ActiveEffect'>;
+  flags: ConfiguredFlags<'ActiveEffect'> & CoreFlags;
 }
 
 interface ActiveEffectDataConstructorData {
@@ -135,7 +139,7 @@ interface ActiveEffectDataConstructorData {
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: ConfiguredFlags<'ActiveEffect'> | null;
+  flags?: (ConfiguredFlags<'ActiveEffect'> & CoreFlags) | null;
 }
 
 /**

diff --git a/src/foundry/foundry.js/config.d.ts b/src/foundry/foundry.js/config.d.ts
@@ -157,14 +157,8 @@ declare global {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface SourceConfig {}
 
-  interface FlagConfig {
-    ActiveEffect: {
-      core?: {
-        statusId?: string;
-        overlay?: boolean;
-      };
-    };
-  }
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface FlagConfig {}
 
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface WebRTCConfig {}

diff --git a/test-d/foundry/foundry.js/clientDocuments/activeEffect.test-d.ts b/test-d/foundry/foundry.js/clientDocuments/activeEffect.test-d.ts
@@ -2,6 +2,17 @@ import { expectError, expectType } from 'tsd';
 
 const eff = new ActiveEffect({});
 
+declare global {
+  interface FlagConfig {
+    ActiveEffect: {
+      mySystem?: {
+        importantFlag?: boolean;
+      };
+    };
+  }
+}
+
+expectType<boolean | undefined>(eff.getFlag('mySystem', 'importantFlag'));
 expectType<string | undefined>(eff.getFlag('core', 'statusId'));
 expectType<boolean | undefined>(eff.getFlag('core', 'overlay'));
 expectError(eff.setFlag('core', 'statusId', 0));