@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250717053920 → 13.346.0-beta.20250717151537

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "@league-of-foundry-developers/foundry-vtt-types",
4
- "version": "13.346.0-beta.20250717053920",
4
+ "version": "13.346.0-beta.20250717151537",
5
5
  "description": "TypeScript type definitions for Foundry VTT",
6
6
  "type": "module",
7
7
  "types": "./src/index.d.mts",
@@ -12,13 +12,61 @@ declare module "#configuration" {
12
12
 
13
13
  /**
14
14
  * The Scene Navigation UI element.
15
- * @remarks TODO: Stub
16
15
  */
17
16
  declare class SceneNavigation<
18
17
  RenderContext extends SceneNavigation.RenderContext = SceneNavigation.RenderContext,
19
18
  Configuration extends SceneNavigation.Configuration = SceneNavigation.Configuration,
20
19
  RenderOptions extends SceneNavigation.RenderOptions = SceneNavigation.RenderOptions,
21
- > extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
20
+ > extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
21
+ static override DEFAULT_OPTIONS: DeepPartial<ApplicationV2.Configuration> & object;
22
+ static override PARTS: Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
23
+
24
+ /**
25
+ * Whether the scene navigation is currently expanded.
26
+ */
27
+ get expanded(): boolean;
28
+
29
+ protected override _prepareContext(
30
+ options: DeepPartial<RenderOptions> & { isFirstRender: boolean },
31
+ ): Promise<RenderContext>;
32
+
33
+ protected override _onFirstRender(
34
+ context: DeepPartial<RenderContext>,
35
+ options: DeepPartial<RenderOptions>,
36
+ ): Promise<void>;
37
+
38
+ protected override _onRender(context: DeepPartial<RenderContext>, options: DeepPartial<RenderOptions>): Promise<void>;
39
+
40
+ /**
41
+ * Get the set of ContextMenu options which should be applied for Scenes in the menu.
42
+ */
43
+ protected _getContextMenuOptions(): foundry.applications.ux.ContextMenu.Entry<HTMLElement>[];
44
+
45
+ /**
46
+ * Expand Scene Navigation, displaying inactive Scenes.
47
+ */
48
+ expand(): void;
49
+
50
+ /**
51
+ * Collapse Scene Navigation, hiding inactive Scenes.
52
+ */
53
+ collapse(): Promise<void>;
54
+
55
+ /**
56
+ * Toggle the expanded state of scene navigation.
57
+ * @param expanded - Force the expanded state to the provided value, otherwise toggle the state.
58
+ */
59
+ toggleExpanded(expanded?: boolean): void;
60
+
61
+ /**
62
+ * @deprecated "SceneNavigation.displayProgressBar is deprecated in favor of {@linkcode Notifications#notify} using the \{progress: true\} option" (since v13, until v15)
63
+ * @ignore
64
+ */
65
+ static displayProgressBar({ label, pct }?: SceneNavigation.DisplayProgressBarOptions): void;
66
+
67
+ static #SceneNavigationStatic: true;
68
+ #SceneNavigation: true;
69
+ }
22
70
 
23
71
  declare namespace SceneNavigation {
24
72
  interface Any extends AnySceneNavigation {}
@@ -40,6 +88,11 @@ declare namespace SceneNavigation {
40
88
  canExpand: number;
41
89
  }
42
90
 
91
+ interface DisplayProgressBarOptions {
92
+ label?: string | undefined;
93
+ pct?: number | undefined;
94
+ }
95
+
43
96
  interface Configuration<SceneNavigation extends SceneNavigation.Any = SceneNavigation.Any>
44
97
  extends HandlebarsApplicationMixin.Configuration,
45
98
  ApplicationV2.Configuration<SceneNavigation> {}
@@ -974,6 +974,17 @@ export interface AllHooks extends DynamicHooks {
974
974
  app: foundry.applications.ui.Players,
975
975
  contextOptions: ContextMenu.Entry<HTMLElement>[],
976
976
  ) => boolean | void;
977
+
978
+ /**
979
+ * A hook event that fires when the context menu for a SceneNavigation entry is constructed.
980
+ * @param app - The Application instance that the context menu is constructed in
981
+ * @param contextOptions - The context menu entries
982
+ * @remarks This is called by {@linkcode Hooks.callAll}.
983
+ */
984
+ getSceneContextOptions: (
985
+ app: foundry.applications.ui.SceneNavigation,
986
+ contextOptions: ContextMenu.Entry<HTMLElement>[],
987
+ ) => void;
977
988
  }
978
989
 
979
990
  declare global {