@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

package/src/foundry/client/data/documents/scene.d.mts

@@ -1,42 +1,865 @@
-import type { InexactPartial } from "fvtt-types/utils";
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseScene from "../../../common/documents/scene.d.mts";
+import type { InexactPartial, Merge } from "fvtt-types/utils";
+import type { documents } from "#client-esm/client.d.mts";
+import type Document from "#common/abstract/document.d.mts";
+import type { DataSchema } from "#common/data/fields.d.mts";
+import type { TextureData } from "#common/data/data.mjs";
+
+import fields = foundry.data.fields;
 
 declare global {
   namespace Scene {
-    type Metadata = Document.MetadataFor<Scene>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"Scene">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Scene">;
-
-    /* eslint-disable @typescript-eslint/no-empty-object-type */
-    export interface DatabaseOperations
-      extends Document.Database.Operations<
-        Scene,
-        {},
-        { thumb: (string | null)[]; autoReposition: boolean; animateDarkness: number },
-        {}
+    /**
+     * The document's name.
+     */
+    type Name = "Scene";
+
+    /**
+     * The arguments to construct the document.
+     */
+    type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;
+
+    /**
+     * The documents embedded within `Scene`.
+     */
+    type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;
+
+    /**
+     * The implementation of the `Scene` document instance configured through `CONFIG.Scene.documentClass` in Foundry and
+     * {@link DocumentClassConfig | `DocumentClassConfig`} or {@link ConfiguredScene | `fvtt-types/configuration/ConfiguredScene`} in fvtt-types.
+     */
+    type Implementation = Document.ImplementationFor<"Scene">;
+
+    /**
+     * The implementation of the `Scene` document configured through `CONFIG.Scene.documentClass` in Foundry and
+     * {@link DocumentClassConfig | `DocumentClassConfig`} in fvtt-types.
+     */
+    type ImplementationClass = Document.ImplementationClassFor<"Scene">;
+
+    /**
+     * A document's metadata is special information about the document ranging anywhere from its name,
+     * whether it's indexed, or to the permissions a user has over it.
+     */
+    interface Metadata
+      extends Merge<
+        Document.Metadata.Default,
+        Readonly<{
+          name: "Scene";
+          collection: "scenes";
+          indexed: true;
+          compendiumIndexFields: ["_id", "name", "thumb", "sort", "folder"];
+          embedded: Metadata.Embedded;
+          label: string;
+          labelPlural: string;
+          preserveOnImport: ["_id", "sort", "ownership", "active"];
+          schemaVersion: string;
+        }>
       > {}
-    /* eslint-enable @typescript-eslint/no-empty-object-type */
 
-    // Helpful aliases
-    type ConstructorData = BaseScene.ConstructorData;
-    type UpdateData = BaseScene.UpdateData;
-    type Schema = BaseScene.Schema;
-    type Source = BaseScene.Source;
+    namespace Metadata {
+      /**
+       * The embedded metadata
+       */
+      interface Embedded {
+        AmbientLight: "lights";
+        AmbientSound: "sounds";
+        Drawing: "drawings";
+        MeasuredTemplate: "templates";
+        Note: "notes";
+        Region: "regions";
+        Tile: "tiles";
+        Token: "tokens";
+        Wall: "walls";
+      }
+    }
+
+    /**
+     * A document's parent is something that can contain it.
+     * For example an `Item` can be contained by an `Actor` which makes `Actor` one of its possible parents.
+     */
+    type Parent = null;
+
+    /**
+     * A document's direct descendants are documents that are contained directly within its schema.
+     * This is a union of all such instances, or never if the document doesn't have any descendants.
+     */
+    type DirectDescendant =
+      | AmbientLightDocument.Implementation
+      | AmbientSoundDocument.Implementation
+      | DrawingDocument.Implementation
+      | MeasuredTemplateDocument.Implementation
+      | NoteDocument.Implementation
+      | RegionDocument.Implementation
+      | TileDocument.Implementation
+      | TokenDocument.Implementation
+      | WallDocument.Implementation;
+
+    /**
+     * A document's direct descendants are documents that are contained directly within its schema.
+     * This is a union of all such classes, or never if the document doesn't have any descendants.
+     */
+    type DirectDescendantClass =
+      | AmbientLightDocument.ImplementationClass
+      | AmbientSoundDocument.ImplementationClass
+      | DrawingDocument.ImplementationClass
+      | MeasuredTemplateDocument.ImplementationClass
+      | NoteDocument.ImplementationClass
+      | RegionDocument.ImplementationClass
+      | TileDocument.ImplementationClass
+      | TokenDocument.ImplementationClass
+      | WallDocument.ImplementationClass;
+
+    /**
+     * A document's descendants are any documents that are contained within, either within its schema
+     * or its descendant's schemas.
+     * This is a union of all such instances, or never if the document doesn't have any descendants.
+     */
+    type Descendant = DirectDescendant | RegionDocument.Descendant | TokenDocument.Descendant;
+
+    /**
+     * A document's descendants are any child documents, grandchild documents, etc.
+     * This is a union of all classes, or never if the document doesn't have any descendants.
+     */
+    type DescendantClass = DirectDescendantClass | RegionDocument.DescendantClass | TokenDocument.DescendantClass;
+
+    /**
+     * Types of `CompendiumCollection` this document might be contained in.
+     * Note that `this.pack` will always return a string; this is the type for `game.packs.get(this.pack)`
+     */
+    type Pack = CompendiumCollection.ForDocument<"Scene">;
+
+    /**
+     * An embedded document is a document contained in another.
+     * For example an `Item` can be contained by an `Actor` which means `Item` can be embedded in `Actor`.
+     *
+     * If this is `never` it is because there are no embeddable documents (or there's a bug!).
+     */
+    type Embedded = Document.ImplementationFor<Embedded.Name>;
+
+    namespace Embedded {
+      /**
+       * An embedded document is a document contained in another.
+       * For example an `Item` can be contained by an `Actor` which means `Item` can be embedded in `Actor`.
+       *
+       * If this is `never` it is because there are no embeddable documents (or there's a bug!).
+       */
+      type Name = keyof Metadata.Embedded;
+
+      /**
+       * Gets the collection name for an embedded document.
+       */
+      type CollectionNameOf<CollectionName extends Embedded.CollectionName> = Document.Embedded.CollectionNameFor<
+        Metadata.Embedded,
+        CollectionName
+      >;
+
+      /**
+       * Gets the collection document for an embedded document.
+       */
+      // TODO(LukeAbby): There's a circularity. Should be `Document.Embedded.CollectionDocumentFor<Metadata.Embedded, CollectionName>`
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      type DocumentFor<CollectionName extends Embedded.CollectionName> = Document.Any;
+
+      /**
+       * Gets the collection for an embedded document.
+       */
+      type CollectionFor<CollectionName extends Embedded.CollectionName> = Document.Embedded.CollectionFor<
+        // TODO(LukeAbby): This should be `TokenDocument.Implementation` but this causes a circularity.
+        Document.Any,
+        Metadata.Embedded,
+        CollectionName
+      >;
+
+      /**
+       * A valid name to refer to a collection embedded in this document. For example an `Actor`
+       * has the key `"items"` which contains `Item` instance which would make both `"Item" | "Items"`
+       * valid keys (amongst others).
+       */
+      type CollectionName = Document.Embedded.CollectionName<Metadata.Embedded>;
+    }
+
+    /**
+     * The name of the world or embedded collection this document can find itself in.
+     * For example an `Item` is always going to be inside a collection with a key of `items`.
+     * This is a fixed string per document type and is primarily useful for {@link ClientDocumentMixin | `Descendant Document Events`}.
+     */
+    type ParentCollectionName = Metadata["collection"];
+
+    /**
+     * The world collection that contains `Scene`s. Will be `never` if none exists.
+     */
+    type CollectionClass = Scenes.ConfiguredClass;
+
+    /**
+     * The world collection that contains `Scene`s. Will be `never` if none exists.
+     */
+    type Collection = Scenes.Configured;
+
+    /**
+     * An instance of `Scene` that comes from the database but failed validation meaining that
+     * its `system` and `_source` could theoretically be anything.
+     */
+    interface Invalid extends Document.Invalid<Scene.Implementation> {}
+
+    /**
+     * An instance of `Scene` that comes from the database.
+     */
+    interface Stored extends Document.Stored<Scene.Implementation> {}
+
+    /**
+     * The data put in {@link Scene._source | `Scene#_source`}. This data is what was
+     * persisted to the database and therefore it must be valid JSON.
+     *
+     * For example a {@link fields.SetField | `SetField`} is persisted to the database as an array
+     * but initialized as a {@link Set | `Set`}.
+     */
+    interface Source extends fields.SchemaField.SourceData<Schema> {}
+
+    /**
+     * @deprecated {@link Scene.Source | `Scene.Source`}
+     */
+    type PersistedData = Source;
+
+    /**
+     * The data necessary to create a document. Used in places like {@link Scene.create | `Scene.create`}
+     * and {@link Scene | `new Scene(...)`}.
+     *
+     * For example a {@link fields.SetField | `SetField`} can accept any {@link Iterable | `Iterable`}
+     * with the right values. This means you can pass a `Set` instance, an array of values,
+     * a generator, or any other iterable.
+     */
+    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+
+    /**
+     * The data after a {@link foundry.abstract.Document | `Document`} has been initialized, for example
+     * {@link Scene.name | `Scene#name`}.
+     *
+     * This is data transformed from {@link Scene.Source | `Scene.Source`} and turned into more
+     * convenient runtime data structures. For example a {@link fields.SetField | `SetField`} is
+     * persisted to the database as an array of values but at runtime it is a `Set` instance.
+     */
+    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+
+    /**
+     * The data used to update a document, for example {@link Scene.update | `Scene#update`}.
+     * It is a distinct type from {@link Scene.CreateData | `DeepPartial<Scene.CreateData>`} because
+     * it has different rules for `null` and `undefined`.
+     */
+    interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
+
+    /**
+     * The schema for {@link Scene | `Scene`}. This is the source of truth for how an Scene document
+     * must be structured.
+     *
+     * Foundry uses this schema to validate the structure of the {@link Scene | `Scene`}. For example
+     * a {@link fields.StringField | `StringField`} will enforce that the value is a string. More
+     * complex fields like {@link fields.SetField | `SetField`} goes through various conversions
+     * starting as an array in the database, initialized as a set, and allows updates with any
+     * iterable.
+     */
+    interface Schema extends DataSchema {
+      /**
+       * The _id which uniquely identifies this Scene document
+       * @defaultValue `null`
+       */
+      _id: fields.DocumentIdField;
+
+      /**
+       * The name of this scene
+       * @defaultValue `""`
+       */
+      name: fields.StringField<{ required: true; blank: false; textSearch: true }>;
+
+      /**
+       * Is this scene currently active? Only one scene may be active at a given time
+       * @defaultValue `false`
+       */
+      active: fields.BooleanField;
+
+      /**
+       * Is this scene displayed in the top navigation bar?
+       * @defaultValue `true`
+       */
+      navigation: fields.BooleanField<{ initial: true }>;
+
+      /**
+       * The sorting order of this Scene in the navigation bar relative to siblings
+       * @defaultValue `0`
+       */
+      navOrder: fields.NumberField<{ required: true; nullable: false; integer: true; initial: 0 }>;
+
+      /**
+       * A string which overrides Scene name for display in the navigation bar
+       * @defaultValue `""`
+       */
+      navName: fields.HTMLField<{ textSearch: true }>;
+
+      /**
+       * An image or video file that provides the background texture for the scene.
+       * @defaultValue see {@link TextureData | `TextureData`}
+       */
+      background: TextureData;
+
+      /**
+       * An image or video file path providing foreground media for the scene
+       * @defaultValue `null`
+       */
+      foreground: fields.FilePathField<{ categories: ["IMAGE", "VIDEO"] }>;
+
+      /**
+       * The elevation of the foreground layer where overhead tiles reside
+       * @defaultValue `null`
+       */
+      foregroundElevation: fields.NumberField<{ required: false; positive: true; integer: true }>;
+
+      /**
+       * A thumbnail image which depicts the scene at lower resolution
+       * @defaultValue `null`
+       */
+      thumb: fields.FilePathField<{ categories: ["IMAGE"] }>;
+
+      /**
+       * The width of the scene canvas, normally the width of the background media
+       * @defaultValue `4000`
+       */
+      width: fields.NumberField<{ integer: true; positive: true; initial: 4000 }>;
+
+      /**
+       * The height of the scene canvas, normally the height of the background media
+       * @defaultValue `3000`
+       */
+      height: fields.NumberField<{ integer: true; positive: true; initial: 3000 }>;
+
+      /**
+       * The proportion of canvas padding applied around the outside of the scene
+       * dimensions to provide additional buffer space
+       * @defaultValue `0.25`
+       */
+      padding: fields.NumberField<{ required: true; nullable: false; min: 0; max: 0.5; step: 0.05; initial: 0.25 }>;
+
+      /**
+       * The initial view coordinates for the scene
+       * @defaultValue `undefined`
+       */
+      initial: fields.SchemaField<{
+        x: fields.NumberField<{ integer: true; nullable: true; initial: undefined }>;
+        y: fields.NumberField<{ integer: true; nullable: true; initial: undefined }>;
+        scale: fields.NumberField<{ nullable: true; min: 0.25; max: 3; initial: undefined }>;
+      }>;
+
+      /**
+       * The color of the canvas displayed behind the scene background
+       * @defaultValue `"#999999"`
+       */
+      backgroundColor: fields.ColorField<{ initial: "#999999" }>;
+
+      /**
+       * Grid configuration for the scene
+       * @defaultValue see properties
+       */
+      grid: fields.SchemaField<{
+        /**
+         * The type of grid, a number from CONST.GRID_TYPES.
+         * @defaultValue `CONST.GRID_TYPES.SQUARE`
+         */
+        type: fields.NumberField<{
+          required: true;
+          choices: CONST.GRID_TYPES[];
+          initial: typeof CONST.GRID_TYPES.SQUARE;
+          validationError: "must be a value in CONST.GRID_TYPES";
+        }>;
+
+        /**
+         * The grid size which represents the width (or height) of a single grid space.
+         * @defaultValue `100`
+         */
+        size: fields.NumberField<{
+          required: true;
+          nullable: false;
+          integer: true;
+          min: typeof CONST.GRID_MIN_SIZE;
+          initial: 100;
+          validationError: `must be an integer number of pixels, ${typeof CONST.GRID_MIN_SIZE} or greater`;
+        }>;
+
+        /**
+         * A string representing the color used to render the grid lines.
+         * @defaultValue `"#000000"`
+         */
+        color: fields.ColorField<{ required: true; nullable: false; initial: "#000000" }>;
+
+        /**
+         * A number between 0 and 1 for the opacity of the grid lines.
+         * @defaultValue `0.2`
+         */
+        alpha: fields.AlphaField<{ initial: 0.2 }>;
+
+        /**
+         * The number of distance units which are represented by a single grid space.
+         * @defaultValue `game.system.gridDistance || 1`
+         */
+        distance: fields.NumberField<{ required: true; nullable: false; positive: true; initial: () => number }>;
+
+        /**
+         * A label for the units of measure which are used for grid distance.
+         * @defaultValue `game.system.gridUnits ?? ""`
+         */
+        units: fields.StringField<{ initial: () => string }>;
+      }>;
+
+      /**
+       * Do Tokens require vision in order to see the Scene environment?
+       * @defaultValue `true`
+       */
+      tokenVision: fields.BooleanField<{ initial: true }>;
+
+      /**
+       * Is a global source of illumination present which provides dim light to all
+       * areas of the Scene?
+       * @defaultValue `true`
+       */
+      fogExploration: fields.BooleanField<{ initial: true }>;
+
+      /**
+       * The ambient darkness level in this Scene, where 0 represents midday
+       * (maximum illumination) and 1 represents midnight (maximum darkness)
+       * @defaultValue `Date.now`
+       */
+      fogReset: fields.NumberField<{ nullable: false; initial: number }>;
+
+      /**
+       * A darkness threshold between 0 and 1. When the Scene darkness level
+       * exceeds this threshold Global Illumination is automatically disabled
+       * @defaultValue `false`
+       */
+      globalLight: fields.BooleanField;
+
+      /**
+       * Should fog exploration progress be tracked for this Scene?
+       * @defaultValue `null`
+       */
+      globalLightThreshold: fields.AlphaField<{ nullable: true; initial: null }>;
+
+      /**
+       * The timestamp at which fog of war was last reset for this Scene.
+       * @defaultValue `0`
+       */
+      darkness: fields.AlphaField<{ initial: 0 }>;
+
+      /**
+       * A special overlay image or video texture which is used for fog of war
+       * @defaultValue `null`
+       */
+      fogOverlay: fields.FilePathField<{ categories: ("IMAGE" | "VIDEO")[] }>;
+
+      /**
+       * A color tint applied to explored regions of fog of war
+       * @defaultValue `null`
+       */
+      fogExploredColor: fields.ColorField<{ label: "SCENES.FogExploredColor" }>;
+
+      /**
+       * A color tint applied to unexplored regions of fog of war
+       * @defaultValue `null`
+       */
+      fogUnexploredColor: fields.ColorField<{ label: "SCENES.FogUnexploredColor" }>;
+
+      /**
+       * A collection of embedded Drawing objects.
+       * @defaultValue `[]`
+       */
+      drawings: fields.EmbeddedCollectionField<typeof documents.BaseDrawing, Scene.Implementation>;
+
+      /**
+       * A collection of embedded Tile objects.
+       * @defaultValue `[]`
+       */
+      tokens: fields.EmbeddedCollectionField<typeof documents.BaseToken, Scene.Implementation>;
+
+      /**
+       * A collection of embedded Token objects.
+       * @defaultValue `[]`
+       */
+      lights: fields.EmbeddedCollectionField<typeof documents.BaseAmbientLight, Scene.Implementation>;
+
+      /**
+       * A collection of embedded AmbientLight objects.
+       * @defaultValue `[]`
+       */
+      notes: fields.EmbeddedCollectionField<typeof documents.BaseNote, Scene.Implementation>;
+
+      /**
+       * A collection of embedded Note objects.
+       * @defaultValue `[]`
+       */
+      sounds: fields.EmbeddedCollectionField<typeof documents.BaseAmbientSound, Scene.Implementation>;
+
+      /**
+       * A collection of embedded Region documents.
+       * @defaultValue `[]`
+       */
+      regions: fields.EmbeddedCollectionField<typeof documents.BaseRegion, Scene.Implementation>;
+
+      /**
+       * A collection of embedded AmbientSound objects.
+       * @defaultValue `[]`
+       */
+      templates: fields.EmbeddedCollectionField<typeof documents.BaseMeasuredTemplate, Scene.Implementation>;
+
+      /**
+       * A collection of embedded MeasuredTemplate objects.
+       * @defaultValue `[]`
+       */
+      tiles: fields.EmbeddedCollectionField<typeof documents.BaseTile, Scene.Implementation>;
+
+      /**
+       * A collection of embedded Wall objects
+       * @defaultValue `[]`
+       */
+      walls: fields.EmbeddedCollectionField<typeof documents.BaseWall, Scene.Implementation>;
+
+      /**
+       * A linked Playlist document which should begin automatically playing when this
+       * Scene becomes active.
+       * @defaultValue `null`
+       */
+      playlist: fields.ForeignDocumentField<typeof documents.BasePlaylist>;
+
+      /**
+       * A linked PlaylistSound document from the selected playlist that will
+       * begin automatically playing when this Scene becomes active
+       * @defaultValue `null`
+       */
+      playlistSound: fields.ForeignDocumentField<typeof documents.BasePlaylistSound, { idOnly: true }>;
+
+      /**
+       * A JournalEntry document which provides narrative details about this Scene
+       * @defaultValue `null`
+       */
+      journal: fields.ForeignDocumentField<typeof documents.BaseJournalEntry>;
+
+      /**
+       * A document ID for a JournalEntryPage which provides narrative details about this Scene
+       * @defaultValue `null`
+       */
+      journalEntryPage: fields.ForeignDocumentField<typeof documents.BaseJournalEntryPage, { idOnly: true }>;
+
+      /**
+       * A named weather effect which should be rendered in this Scene.
+       * @defaultValue `""`
+       */
+      weather: fields.StringField;
+
+      /**
+       * The _id of a Folder which contains this Actor
+       * @defaultValue `null`
+       */
+      folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
+
+      /**
+       * The numeric sort value which orders this Actor relative to its siblings
+       * @defaultValue `0`
+       */
+      sort: fields.IntegerSortField;
+
+      /**
+       * An object which configures ownership of this Scene
+       * @defaultValue see {@link fields.DocumentOwnershipField | `fields.DocumentOwnershipField`}
+       */
+      ownership: fields.DocumentOwnershipField;
+
+      /**
+       * An object of optional key/value flags
+       * @defaultValue `{}`
+       */
+      flags: fields.ObjectField.FlagsField<"Scene">;
+
+      /**
+       * An object of creation and access information
+       * @defaultValue see {@link fields.DocumentStatsField | `fields.DocumentStatsField`}
+       */
+      _stats: fields.DocumentStatsField;
+    }
+
+    namespace Database {
+      /** Options passed along in Get operations for Scenes */
+      interface Get extends foundry.abstract.types.DatabaseGetOperation<Scene.Parent> {}
+
+      /** Options passed along in Create operations for Scenes */
+      interface Create<Temporary extends boolean | undefined = boolean | undefined>
+        extends foundry.abstract.types.DatabaseCreateOperation<Scene.CreateData, Scene.Parent, Temporary> {}
+
+      /** Options passed along in Delete operations for Scenes */
+      interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<Scene.Parent> {}
+
+      /** Options passed along in Update operations for Scenes */
+      interface Update extends foundry.abstract.types.DatabaseUpdateOperation<Scene.UpdateData, Scene.Parent> {
+        thumb?: (string | null)[];
+        autoReposition?: boolean;
+        animateDarkness?: number;
+      }
+
+      /** Operation for {@link Scene.createDocuments | `Scene.createDocuments`} */
+      interface CreateDocumentsOperation<Temporary extends boolean | undefined>
+        extends Document.Database.CreateOperation<Scene.Database.Create<Temporary>> {}
+
+      /** Operation for {@link Scene.updateDocuments | `Scene.updateDocuments`} */
+      interface UpdateDocumentsOperation extends Document.Database.UpdateDocumentsOperation<Scene.Database.Update> {}
+
+      /** Operation for {@link Scene.deleteDocuments | `Scene.deleteDocuments`} */
+      interface DeleteDocumentsOperation extends Document.Database.DeleteDocumentsOperation<Scene.Database.Delete> {}
+
+      /** Operation for {@link Scene.create | `Scene.create`} */
+      interface CreateOperation<Temporary extends boolean | undefined>
+        extends Document.Database.CreateOperation<Scene.Database.Create<Temporary>> {}
+
+      /** Operation for {@link Scene.update | `Scene#update`} */
+      interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}
+
+      interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}
+
+      /** Options for {@link Scene.get | `Scene.get`} */
+      interface GetOptions extends Document.Database.GetOptions {}
+
+      /** Options for {@link Scene._preCreate | `Scene#_preCreate`} */
+      interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}
+
+      /** Options for {@link Scene._onCreate | `Scene#_onCreate`} */
+      interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}
+
+      /** Operation for {@link Scene._preCreateOperation | `Scene._preCreateOperation`} */
+      interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<Scene.Database.Create> {}
+
+      /** Operation for {@link Scene._onCreateOperation | `Scene#_onCreateOperation`} */
+      interface OnCreateOperation extends Scene.Database.Create {}
+
+      /** Options for {@link Scene._preUpdate | `Scene#_preUpdate`} */
+      interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}
+
+      /** Options for {@link Scene._onUpdate | `Scene#_onUpdate`} */
+      interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}
+
+      /** Operation for {@link Scene._preUpdateOperation | `Scene._preUpdateOperation`} */
+      interface PreUpdateOperation extends Scene.Database.Update {}
+
+      /** Operation for {@link Scene._onUpdateOperation | `Scene._preUpdateOperation`} */
+      interface OnUpdateOperation extends Scene.Database.Update {}
+
+      /** Options for {@link Scene._preDelete | `Scene#_preDelete`} */
+      interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}
+
+      /** Options for {@link Scene._onDelete | `Scene#_onDelete`} */
+      interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}
+
+      /** Options for {@link Scene._preDeleteOperation | `Scene#_preDeleteOperation`} */
+      interface PreDeleteOperation extends Scene.Database.Delete {}
+
+      /** Options for {@link Scene._onDeleteOperation | `Scene#_onDeleteOperation`} */
+      interface OnDeleteOperation extends Scene.Database.Delete {}
+
+      /** Context for {@link Scene._onDeleteOperation | `Scene._onDeleteOperation`} */
+      interface OnDeleteDocumentsContext extends Document.ModificationContext<Scene.Parent> {}
+
+      /** Context for {@link Scene._onCreateDocuments | `Scene._onCreateDocuments`} */
+      interface OnCreateDocumentsContext extends Document.ModificationContext<Scene.Parent> {}
+
+      /** Context for {@link Scene._onUpdateDocuments | `Scene._onUpdateDocuments`} */
+      interface OnUpdateDocumentsContext extends Document.ModificationContext<Scene.Parent> {}
+
+      /**
+       * Options for {@link Scene._preCreateDescendantDocuments | `Scene#_preCreateDescendantDocuments`}
+       * and {@link Scene._onCreateDescendantDocuments | `Scene#_onCreateDescendantDocuments`}
+       */
+      interface CreateOptions extends Document.Database.CreateOptions<Scene.Database.Create> {}
+
+      /**
+       * Options for {@link Scene._preUpdateDescendantDocuments | `Scene#_preUpdateDescendantDocuments`}
+       * and {@link Scene._onUpdateDescendantDocuments | `Scene#_onUpdateDescendantDocuments`}
+       */
+      interface UpdateOptions extends Document.Database.UpdateOptions<Scene.Database.Update> {}
+
+      /**
+       * Options for {@link Scene._preDeleteDescendantDocuments | `Scene#_preDeleteDescendantDocuments`}
+       * and {@link Scene._onDeleteDescendantDocuments | `Scene#_onDeleteDescendantDocuments`}
+       */
+      interface DeleteOptions extends Document.Database.DeleteOptions<Scene.Database.Delete> {}
+    }
+
+    /**
+     * The flags that are available for this document in the form `{ [scope: string]: { [key: string]: unknown } }`.
+     */
+    interface Flags extends Document.ConfiguredFlagsForName<Name> {}
+
+    namespace Flags {
+      /**
+       * The valid scopes for the flags on this document e.g. `"core"` or `"dnd5e"`.
+       */
+      type Scope = Document.FlagKeyOf<Flags>;
+
+      /**
+       * The valid keys for a certain scope for example if the scope is "core" then a valid key may be `"sheetLock"` or `"viewMode"`.
+       */
+      type Key<Scope extends Flags.Scope> = Document.FlagKeyOf<Document.FlagGetKey<Flags, Scope>>;
+
+      /**
+       * Gets the type of a particular flag given a `Scope` and a `Key`.
+       */
+      type Get<Scope extends Flags.Scope, Key extends Flags.Key<Scope>> = Document.GetFlag<Name, Scope, Key>;
+    }
+
+    type PreCreateDescendantDocumentsArgs =
+      | Document.PreCreateDescendantDocumentsArgs<Scene.Stored, Scene.DirectDescendant, Scene.Metadata.Embedded>
+      | TokenDocument.PreCreateDescendantDocumentsArgs
+      | RegionDocument.PreCreateDescendantDocumentsArgs;
+
+    type OnCreateDescendantDocumentsArgs =
+      | Document.OnCreateDescendantDocumentsArgs<Scene.Stored, Scene.DirectDescendant, Scene.Metadata.Embedded>
+      | TokenDocument.OnCreateDescendantDocumentsArgs
+      | RegionDocument.OnCreateDescendantDocumentsArgs;
+
+    type PreUpdateDescendantDocumentsArgs =
+      | Document.PreUpdateDescendantDocumentsArgs<Scene.Stored, Scene.DirectDescendant, Scene.Metadata.Embedded>
+      | TokenDocument.PreUpdateDescendantDocumentsArgs
+      | RegionDocument.PreUpdateDescendantDocumentsArgs;
+
+    type OnUpdateDescendantDocumentsArgs =
+      | Document.OnUpdateDescendantDocumentsArgs<Scene.Stored, Scene.DirectDescendant, Scene.Metadata.Embedded>
+      | TokenDocument.OnUpdateDescendantDocumentsArgs
+      | RegionDocument.OnUpdateDescendantDocumentsArgs;
+
+    type PreDeleteDescendantDocumentsArgs =
+      | Document.PreDeleteDescendantDocumentsArgs<Scene.Stored, Scene.DirectDescendant, Scene.Metadata.Embedded>
+      | TokenDocument.PreDeleteDescendantDocumentsArgs
+      | RegionDocument.PreDeleteDescendantDocumentsArgs;
+
+    type OnDeleteDescendantDocumentsArgs =
+      | Document.OnDeleteDescendantDocumentsArgs<Scene.Stored, Scene.DirectDescendant, Scene.Metadata.Embedded>
+      | TokenDocument.OnDeleteDescendantDocumentsArgs
+      | RegionDocument.OnDeleteDescendantDocumentsArgs;
+
+    interface Dimensions {
+      /** The width of the canvas. */
+      width: number;
+
+      /** The height of the canvas. */
+      height: number;
+
+      /** The grid size. */
+      size: number;
+
+      /** The canvas rectangle. */
+      rect: Canvas.Rectangle;
+
+      /** The X coordinate of the scene rectangle within the larger canvas. */
+      sceneX: number;
+
+      /** The Y coordinate of the scene rectangle within the larger canvas. */
+      sceneY: number;
+
+      /** The width of the scene. */
+      sceneWidth: number;
+
+      /** The height of the scene. */
+      sceneHeight: number;
+
+      /** The scene rectangle. */
+      sceneRect: Canvas.Rectangle;
+
+      /** The number of distance units in a single grid space. */
+      distance: number;
+
+      /** The factor to convert distance units to pixels */
+      distancePixels: number;
+
+      /** The units of distance */
+      units: string;
+
+      /** The aspect ratio of the scene rectangle. */
+      ratio: number;
+
+      /** The length of the longest line that can be drawn on the canvas. */
+      maxR: number;
+
+      /** The number of grid rows on the canvas */
+      rows: number;
+
+      /** The number of grid columns on the canvas */
+      columns: number;
+    }
+
+    interface _ThumbnailCreationData extends ImageHelper.TextureToImageOptions {
+      /**
+       * A background image to use for thumbnail creation, otherwise the current scene
+       * background is used.
+       *
+       * @remarks This cannot be `null` because Foundry writes `const newImage = img !== undefined;`.
+       */
+      img: string;
+
+      /**
+       * The desired thumbnail width. Default is 300px
+       * @defaultValue `300`
+       */
+      width: number | null;
+
+      /**
+       * The desired thumbnail height. Default is 100px;
+       * @defaultValue `100`
+       */
+      height: number | null;
+
+      /**
+       * Which image format should be used? image/png, image/jpeg, or image/webp
+       * @defaultValue `"image/webp"`
+       *
+       * @remarks Foundry writes `image/jpg` but this functions the same as `image/png  `.
+       * The correct MIME type is `image/jpeg`.
+       */
+      format: ImageHelper.Format | null;
+
+      /**
+       * What compression quality should be used for jpeg or webp, between 0 and 1
+       * @defaultValue `0.8`
+       */
+      quality: number | null;
+    }
+
+    interface ThumbnailCreationData extends InexactPartial<_ThumbnailCreationData> {}
+
+    /**
+     * @deprecated {@link Scene.Database | `Scene.DatabaseOperation`}
+     */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    interface DatabaseOperations extends Document.Database.Operations<Scene.Implementation> {}
+
+    /**
+     * @deprecated {@link Scene.CreateData | `Scene.CreateData`}
+     */
+    interface ConstructorData extends Scene.CreateData {}
+
+    /**
+     * @deprecated {@link Scene.implementation | `Scene.ImplementationClass`}
+     */
+    type ConfiguredClass = ImplementationClass;
+
+    /**
+     * @deprecated {@link Scene.Implementation | `Scene.Implementation`}
+     */
+    type ConfiguredInstance = Implementation;
   }
 
   /**
    * The client-side Scene document which extends the common BaseScene model.
    *
-   * @see {@link Scenes}            The world-level collection of Scene documents
-   * @see {@link SceneConfig}       The Scene configuration application
+   * @see {@link Scenes | `Scenes`}            The world-level collection of Scene documents
+   * @see {@link SceneConfig | `SceneConfig`}       The Scene configuration application
    *
    */
   class Scene extends ClientDocumentMixin(foundry.documents.BaseScene) {
-    static override metadata: Scene.Metadata;
-
-    static get implementation(): Scene.ConfiguredClass;
+    /**
+     * @param data    - Initial data from which to construct the `Scene`
+     * @param context - Construction context options
+     */
+    constructor(...args: Scene.ConstructorArgs);
 
     /**
      * Track the viewed position of each scene (while in memory only, not persisted)
@@ -88,22 +911,8 @@ declare global {
      * @param options    - (default: `{}`)
      */
     override clone<Save extends boolean = false>(
-      createData?: foundry.documents.BaseScene.ConstructorData,
-      context?: InexactPartial<
-        {
-          /**
-           * Save the clone to the World database?
-           * @defaultValue `false`
-           */
-          save: Save;
-
-          /**
-           * Keep the same ID of the original document
-           * @defaultValue `false`
-           */
-          keepId: boolean;
-        } & Document.ConstructionContext<this["parent"]>
-      >,
+      createData?: Scene.CreateData,
+      context?: Document.CloneContext<Save> & InexactPartial<Document.ConstructionContext<Scene.Parent>>,
     ): Save extends true ? Promise<this> : this;
 
     override reset(): void;
@@ -115,7 +924,7 @@ declare global {
      * Apply padding to enlarge the playable space and round to the nearest 2x grid size to ensure symmetry.
      * The rounding accomplishes that the padding buffer around the map always contains whole grid spaces.
      */
-    getDimensions(): SceneDimensions;
+    getDimensions(): Scene.Dimensions;
 
     override _onClickDocumentLink(event: MouseEvent): unknown;
 
@@ -127,9 +936,7 @@ declare global {
     /**
      * Handle repositioning of placed objects when the Scene dimensions change
      */
-    protected _repositionObject(
-      sceneUpdateData: foundry.documents.BaseScene.ConstructorData,
-    ): foundry.documents.BaseScene.ConstructorData;
+    protected _repositionObject(sceneUpdateData: Scene.CreateData): Scene.CreateData;
 
     /**
      * Handle Scene activation workflow if the active state is changed to true
@@ -138,127 +945,157 @@ declare global {
     protected _onActivate(active: boolean): ReturnType<this["view"]> | ReturnType<Canvas["draw"]>;
 
     /**
-     * @privateRemarks _preCreateDescendantDocuments, _preUpdateDescendantDocuments, _preDeleteDescendantDocuments, and_onUpdateDescendantDocuments are all overridden but with no signature changes.
-     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class SwadeScene extends Scene {
+     *   protected override _preCreateDescendantDocuments(...args: Scene.PreCreateDescendantDocumentsArgs) {
+     *     super._preCreateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, data, options, userId] = args;
+     *     if (collection === "tokens") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _preCreateDescendantDocuments(...args: Scene.PreCreateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class LancerScene extends Scene {
+     *   protected override _preUpdateDescendantDocuments(...args: Scene.OnUpdateDescendantDocuments) {
+     *     super._preUpdateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, changes, options, userId] = args;
+     *     if (collection === "tokens") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
      */
+    protected override _preUpdateDescendantDocuments(...args: Scene.PreUpdateDescendantDocumentsArgs): void;
 
-    override toCompendium<
-      FlagsOpt extends boolean = false,
-      SourceOpt extends boolean = true,
-      SortOpt extends boolean = true,
-      FolderOpt extends boolean = false,
-      OwnershipOpt extends boolean = false,
-      StateOpt extends boolean = true,
-      IdOpt extends boolean = false,
-    >(
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class Ptr2eScene extends Scene {
+     *   protected override _onUpdateDescendantDocuments(...args: Scene.OnUpdateDescendantDocumentsArgs) {
+     *     super._onUpdateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, changes, options, userId] = args;
+     *     if (collection === "tokens") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _onUpdateDescendantDocuments(...args: Scene.OnUpdateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class KultScene extends Scene {
+     *   protected override _preDeleteDescendantDocuments(...args: Scene.PreDeleteDescendantDocumentsArgs) {
+     *     super._preDeleteDescendantDocuments(...args);
+     *
+     *     const [parent, collection, ids, options, userId] = args;
+     *     if (collection === "tokens") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _preDeleteDescendantDocuments(...args: Scene.PreDeleteDescendantDocumentsArgs): void;
+
+    toCompendium<Options extends ClientDocument.ToCompendiumOptions>(
       pack?: CompendiumCollection<CompendiumCollection.Metadata> | null,
-      options?: InexactPartial<
-        ClientDocument.CompendiumExportOptions<FlagsOpt, SourceOpt, SortOpt, FolderOpt, OwnershipOpt, StateOpt, IdOpt>
-      >,
-    ): Omit<
-      this["_source"],
-      | (IdOpt extends false ? "_id" : never)
-      | ClientDocument.OmitProperty<SortOpt, "sort" | "navigation" | "navOrder">
-      | ClientDocument.OmitProperty<FolderOpt, "folder">
-      | ClientDocument.OmitProperty<FlagsOpt, "flags">
-      | ClientDocument.OmitProperty<OwnershipOpt, "ownership">
-      | ClientDocument.OmitProperty<StateOpt, "active" | "fogReset" | "playing">
-    >;
+      options?: Options,
+    ): ClientDocument.ToCompendiumReturnType<foundry.documents.BaseScene, Options>;
 
     /**
      * Create a 300px by 100px thumbnail image for this scene background
      * @param data - (default: `{}`)
      * @returns The created thumbnail data.
      */
-    createThumbnail(data?: ThumbnailCreationData): ReturnType<typeof ImageHelper.createThumbnail>;
-  }
+    createThumbnail(data?: Scene.ThumbnailCreationData): Promise<ImageHelper.ThumbnailReturn>;
 
-  interface SceneDimensions {
-    /** The width of the canvas. */
-    width: number;
-
-    /** The height of the canvas. */
-    height: number;
-
-    /** The grid size. */
-    size: number;
-
-    /** The canvas rectangle. */
-    rect: Canvas.Rectangle;
-
-    /** The X coordinate of the scene rectangle within the larger canvas. */
-    sceneX: number;
-
-    /** The Y coordinate of the scene rectangle within the larger canvas. */
-    sceneY: number;
-
-    /** The width of the scene. */
-    sceneWidth: number;
-
-    /** The height of the scene. */
-    sceneHeight: number;
+    /*
+     * After this point these are not really overridden methods.
+     * They are here because Foundry's documents are complex and have lots of edge cases.
+     * There are DRY ways of representing this but this ends up being harder to understand
+     * for end users extending these functions, especially for static methods. There are also a
+     * number of methods that don't make sense to call directly on `Document` like `createDocuments`,
+     * as there is no data that can safely construct every possible document. Finally keeping definitions
+     * separate like this helps against circularities.
+     */
 
-    /** The scene rectangle. */
-    sceneRect: Canvas.Rectangle;
+    // ClientDocument overrides
 
-    /** The number of distance units in a single grid space. */
-    distance: number;
+    // Other Descendant Document operations are actually overridden above
 
-    /** The factor to convert distance units to pixels */
-    distancePixels: number;
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class GurpsScene extends Scene {
+     *   protected override _onCreateDescendantDocuments(...args: Scene.OnCreateDescendantDocumentsArgs) {
+     *     super._onCreateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, data, options, userId] = args;
+     *     if (collection === "tokens") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _onCreateDescendantDocuments(...args: Scene.OnCreateDescendantDocumentsArgs): void;
 
-    /** The units of distance */
-    units: string;
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class BladesScene extends Scene {
+     *   protected override _onDeleteDescendantDocuments(...args: Scene.OnUpdateDescendantDocuments) {
+     *     super._onDeleteDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, ids, options, userId] = args;
+     *     if (collection === "tokens") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _onDeleteDescendantDocuments(...args: Scene.OnDeleteDescendantDocumentsArgs): void;
 
-    /** The aspect ratio of the scene rectangle. */
-    ratio: number;
+    static override defaultName(context?: Document.DefaultNameContext<string, Scene.Parent>): string;
 
-    /** The length of the longest line that can be drawn on the canvas. */
-    maxR: number;
+    static override createDialog(
+      data?: Document.CreateDialogData<Scene.CreateData>,
+      context?: Document.CreateDialogContext<string, Scene.Parent>,
+    ): Promise<Scene.Stored | null | undefined>;
 
-    /** The number of grid rows on the canvas */
-    rows: number;
+    static override fromDropData(
+      data: Document.DropData<Scene.Implementation>,
+      options?: Document.FromDropDataOptions,
+    ): Promise<Scene.Implementation | undefined>;
 
-    /** The number of grid columns on the canvas */
-    columns: number;
+    static override fromImport(
+      source: Scene.Source,
+      context?: Document.FromImportContext<Scene.Parent>,
+    ): Promise<Scene.Implementation>;
   }
-}
-
-interface _ThumbnailCreationData extends ImageHelper.TextureToImageOptions {
-  /**
-   * A background image to use for thumbnail creation, otherwise the current scene
-   * background is used.
-   *
-   * @remarks This cannot be `null` because Foundry writes `const newImage = img !== undefined;`.
-   */
-  img: string;
-
-  /**
-   * The desired thumbnail width. Default is 300px
-   * @defaultValue `300`
-   */
-  width: number | null;
-
-  /**
-   * The desired thumbnail height. Default is 100px;
-   * @defaultValue `100`
-   */
-  height: number | null;
 
-  /**
-   * Which image format should be used? image/png, image/jpeg, or image/webp
-   * @defaultValue `"image/webp"`
-   *
-   * @remarks Foundry writes `image/jpg` but this functions the same as `image/png  `.
-   * The correct MIME type is `image/jpeg`.
-   */
-  format: ImageHelper.Format | null;
-
-  /**
-   * What compression quality should be used for jpeg or webp, between 0 and 1
-   * @defaultValue `0.8`
-   */
-  quality: number | null;
+  /** @deprecated {@link Scene.Dimensions | `Scene.Dimensions`} */
+  type SceneDimensions = Scene.Dimensions;
 }
-
-interface ThumbnailCreationData extends InexactPartial<_ThumbnailCreationData> {}