@league-of-foundry-developers/foundry-vtt-types 12.331.3-beta → 12.331.4-beta

package/src/foundry/common/documents/scene.d.mts

@@ -1,9 +1,8 @@
-import type { AnyObject } from "../../../types/utils.mts";
+import type { AnyObject, AnyMutableObject } from "fvtt-types/utils";
+import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
-import type * as CONST from "../constants.mts";
-import type { TextureData } from "../data/data.mts";
-import type * as fields from "../data/fields.d.mts";
-import type * as documents from "./_module.mts";
+import type { DataField, SchemaField } from "../data/fields.d.mts";
+import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
 /**
  * The Document definition for a Scene.
@@ -12,21 +11,25 @@ import type * as documents from "./_module.mts";
 // Note(LukeAbby): You may wonder why documents don't simply pass the `Parent` generic parameter.
 // This pattern evolved from trying to avoid circular loops and even internal tsc errors.
 // See: https://gist.github.com/LukeAbby/0d01b6e20ef19ebc304d7d18cef9cc21
-declare class BaseScene extends Document<"Scene", BaseScene.Schema, any> {
+declare abstract class BaseScene extends Document<"Scene", BaseScene.Schema, any> {
   /**
-   * @param data    - Initial data from which to construct the Scene
+   * @param data    - Initial data from which to construct the `BaseScene`
    * @param context - Construction context options
+   *
+   * @deprecated Constructing `BaseScene` directly is not advised. The base document classes exist in
+   * order to use documents on both the client (i.e. where all your code runs) and behind the scenes
+   * on the server to manage document validation and storage.
+   *
+   * You should use {@link Scene.implementation | `new Scene.implementation(...)`} instead which will give you
+   * a system specific implementation of `Scene`.
    */
-  // TODO(LukeAbby): This constructor is a symptom of a circular error.
-  // constructor(data: BaseScene.ConstructorData, context?: Document.ConstructionContext<BaseScene.Parent>);
-
-  override parent: BaseScene.Parent;
+  constructor(...args: Scene.ConstructorArgs);
 
   static override metadata: BaseScene.Metadata;
 
   static override defineSchema(): BaseScene.Schema;
 
-  static override migrateData(source: AnyObject): AnyObject;
+  static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
   static override shimData(
     data: AnyObject,
@@ -38,336 +41,273 @@ declare class BaseScene extends Document<"Scene", BaseScene.Schema, any> {
       embedded?: boolean;
     },
   ): AnyObject;
+
+  /*
+   * 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.
+   */
+
+  /* Document overrides */
+
+  static " fvtt_types_internal_document_name_static": "Scene";
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+
+  readonly parentCollection: Scene.ParentCollectionName | null;
+
+  readonly pack: string | null;
+
+  static override get implementation(): Scene.ImplementationClass;
+
+  static get baseDocument(): typeof BaseScene;
+
+  static get collectionName(): Scene.ParentCollectionName;
+
+  static get documentName(): Scene.Name;
+
+  static get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+
+  static get hasTypeData(): undefined;
+
+  static get hierarchy(): Scene.Hierarchy;
+
+  override parent: Scene.Parent;
+
+  static createDocuments<Temporary extends boolean | undefined = false>(
+    data: Array<Scene.Implementation | Scene.CreateData> | undefined,
+    operation?: Document.Database.CreateOperation<Scene.Database.Create<Temporary>>,
+  ): Promise<Array<Document.TemporaryIf<Scene.Implementation, Temporary>>>;
+
+  static updateDocuments(
+    updates: Scene.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<Scene.Database.Update>,
+  ): Promise<Scene.Implementation[]>;
+
+  static deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: Document.Database.DeleteDocumentsOperation<Scene.Database.Delete>,
+  ): Promise<Scene.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = false>(
+    data: Scene.CreateData | Scene.CreateData[],
+    operation?: Scene.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<Scene.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: Scene.UpdateData | undefined,
+    operation?: Scene.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: Scene.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(documentId: string, options?: Scene.Database.GetOptions): Scene.Implementation | null;
+
+  static override getCollectionName<CollectionName extends Scene.Embedded.Name>(
+    name: CollectionName,
+  ): Scene.Embedded.CollectionNameOf<CollectionName> | null;
+
+  override getEmbeddedCollection<EmbeddedName extends Scene.Embedded.CollectionName>(
+    embeddedName: EmbeddedName,
+  ): Scene.Embedded.CollectionFor<EmbeddedName>;
+
+  override getEmbeddedDocument<EmbeddedName extends Scene.Embedded.CollectionName>(
+    embeddedName: EmbeddedName,
+    id: string,
+    options: Document.GetEmbeddedDocumentOptions,
+  ): Scene.Embedded.DocumentFor<EmbeddedName> | undefined;
+
+  override createEmbeddedDocuments<EmbeddedName extends Scene.Embedded.Name>(
+    embeddedName: EmbeddedName,
+    data: Document.CreateDataForName<EmbeddedName>[] | undefined,
+    // TODO(LukeAbby): The correct signature would be:
+    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
+    // However this causes a number of errors.
+    operation?: object,
+  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>> | undefined>;
+
+  override updateEmbeddedDocuments<EmbeddedName extends Scene.Embedded.Name>(
+    embeddedName: EmbeddedName,
+    updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
+    operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>> | undefined>;
+
+  override deleteEmbeddedDocuments<EmbeddedName extends Scene.Embedded.Name>(
+    embeddedName: EmbeddedName,
+    ids: Array<string>,
+    operation?: Document.Database.DeleteOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>>>;
+
+  // Same as Document for now
+  override traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
+
+  override getFlag<Scope extends Scene.Flags.Scope, Key extends Scene.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<Scene.Name, Scope, Key>;
+
+  override setFlag<
+    Scope extends Scene.Flags.Scope,
+    Key extends Scene.Flags.Key<Scope>,
+    Value extends Document.GetFlag<Scene.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
+
+  override unsetFlag<Scope extends Scene.Flags.Scope, Key extends Scene.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Promise<this>;
+
+  protected _preCreate(
+    data: Scene.CreateData,
+    options: Scene.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected _onCreate(data: Scene.CreateData, options: Scene.Database.OnCreateOperation, userId: string): void;
+
+  protected static _preCreateOperation(
+    documents: Scene.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<Scene.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static _onCreateOperation(
+    documents: Scene.Implementation[],
+    operation: Scene.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected _preUpdate(
+    changed: Scene.UpdateData,
+    options: Scene.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected _onUpdate(changed: Scene.UpdateData, options: Scene.Database.OnUpdateOperation, userId: string): void;
+
+  protected static _preUpdateOperation(
+    documents: Scene.Implementation[],
+    operation: Scene.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static _onUpdateOperation(
+    documents: Scene.Implementation[],
+    operation: Scene.Database.Update,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected _preDelete(options: Scene.Database.PreDeleteOptions, user: User.Implementation): Promise<boolean | void>;
+
+  protected _onDelete(options: Scene.Database.OnDeleteOperation, userId: string): void;
+
+  protected static _preDeleteOperation(
+    documents: Scene.Implementation[],
+    operation: Scene.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static _onDeleteOperation(
+    documents: Scene.Implementation[],
+    operation: Scene.Database.Delete,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  static get hasSystemData(): undefined;
+
+  // These data field things have been ticketed but will probably go into backlog hell for a while.
+  // We'll end up copy and pasting without modification for now I think. It makes it a tiny bit easier to update though.
+  protected static _addDataFieldShims(data: AnyObject, shims: AnyObject, options?: Document.DataFieldShimOptions): void;
+
+  protected static _addDataFieldMigration(
+    data: AnyObject,
+    oldKey: string,
+    newKey: string,
+    apply?: (data: AnyObject) => unknown,
+  ): unknown;
+
+  protected static _logDataFieldMigration(
+    oldKey: string,
+    newKey: string,
+    options?: LogCompatibilityWarningOptions,
+  ): void;
+
+  protected static _onCreateDocuments(
+    documents: Scene.Implementation[],
+    context: Document.ModificationContext<Scene.Parent>,
+  ): Promise<void>;
+
+  protected static _onUpdateDocuments(
+    documents: Scene.Implementation[],
+    context: Document.ModificationContext<Scene.Parent>,
+  ): Promise<void>;
+
+  protected static _onDeleteDocuments(
+    documents: Scene.Implementation[],
+    context: Document.ModificationContext<Scene.Parent>,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static _schema: SchemaField<Scene.Schema>;
+
+  static get schema(): SchemaField<Scene.Schema>;
+
+  static validateJoint(data: Scene.Source): void;
+
+  static override fromSource(
+    source: Scene.CreateData,
+    { strict, ...context }?: DataModel.FromSourceOptions,
+  ): Scene.Implementation;
+
+  static override fromJSON(json: string): Scene.Implementation;
 }
 
 export default BaseScene;
 
 declare namespace BaseScene {
-  type Parent = null;
-
-  type Metadata = Document.MetadataFor<BaseScene>;
-
-  type SchemaField = fields.SchemaField<Schema>;
-  type ConstructorData = fields.SchemaField.InnerConstructorType<Schema>;
-  type UpdateData = fields.SchemaField.InnerAssignmentType<Schema>;
-  type Properties = fields.SchemaField.InnerInitializedType<Schema>;
-  type Source = fields.SchemaField.InnerPersistedType<Schema>;
-
-  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}
-     */
-    background: TextureData<{ categories: ["IMAGE", "VIDEO"]; initial: null; wildcard: false }>;
-
-    /**
-     * 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" }>;
+  export import Name = Scene.Name;
+  export import ConstructorArgs = Scene.ConstructorArgs;
+  export import Hierarchy = Scene.Hierarchy;
+  export import Metadata = Scene.Metadata;
+  export import Parent = Scene.Parent;
+  export import Descendant = Scene.Descendant;
+  export import DescendantClass = Scene.DescendantClass;
+  export import Pack = Scene.Pack;
+  export import Embedded = Scene.Embedded;
+  export import ParentCollectionName = Scene.ParentCollectionName;
+  export import CollectionClass = Scene.CollectionClass;
+  export import Collection = Scene.Collection;
+  export import Invalid = Scene.Invalid;
+  export import Stored = Scene.Stored;
+  export import Source = Scene.Source;
+  export import PersistedData = Scene.PersistedData;
+  export import CreateData = Scene.CreateData;
+  export import InitializedData = Scene.InitializedData;
+  export import UpdateData = Scene.UpdateData;
+  export import Schema = Scene.Schema;
+  export import DatabaseOperation = Scene.Database;
+  export import Flags = Scene.Flags;
 
-      /**
-       * A number between 0 and 1 for the opacity of the grid lines.
-       * @defaultValue `0.2`
-       */
-      alpha: fields.AlphaField<{ initial: 0.2 }>;
+  /**
+   * @deprecated This type is used by Foundry too vaguely.
+   * In one context the most correct type is after initialization whereas in another one it should be
+   * before but Foundry uses it interchangeably.
+   */
+  type Properties = SchemaField.InitializedData<Schema>;
 
-      /**
-       * 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 }>;
+  /**
+   * @deprecated {@link foundry.data.fields.SchemaField | `SchemaField<BaseScene.Schema>`}
+   */
+  type SchemaField = foundry.data.fields.SchemaField<Schema>;
 
-      /**
-       * 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.ConfiguredInstance>;
-
-    /**
-     * A collection of embedded Tile objects.
-     * @defaultValue `[]`
-     */
-    tokens: fields.EmbeddedCollectionField<typeof documents.BaseToken, Scene.ConfiguredInstance>;
-
-    /**
-     * A collection of embedded Token objects.
-     * @defaultValue `[]`
-     */
-    lights: fields.EmbeddedCollectionField<typeof documents.BaseAmbientLight, Scene.ConfiguredInstance>;
-
-    /**
-     * A collection of embedded AmbientLight objects.
-     * @defaultValue `[]`
-     */
-    notes: fields.EmbeddedCollectionField<typeof documents.BaseNote, Scene.ConfiguredInstance>;
-
-    /**
-     * A collection of embedded Note objects.
-     * @defaultValue `[]`
-     */
-    sounds: fields.EmbeddedCollectionField<typeof documents.BaseAmbientSound, Scene.ConfiguredInstance>;
-
-    /**
-     * A collection of embedded AmbientSound objects.
-     * @defaultValue `[]`
-     */
-    templates: fields.EmbeddedCollectionField<typeof documents.BaseMeasuredTemplate, Scene.ConfiguredInstance>;
-
-    /**
-     * A collection of embedded MeasuredTemplate objects.
-     * @defaultValue `[]`
-     */
-    tiles: fields.EmbeddedCollectionField<typeof documents.BaseTile, Scene.ConfiguredInstance>;
-
-    /**
-     * A collection of embedded Wall objects
-     * @defaultValue `[]`
-     */
-    walls: fields.EmbeddedCollectionField<typeof documents.BaseWall, Scene.ConfiguredInstance>;
-
-    /**
-     * 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}
-     */
-    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}
-     */
-    _stats: fields.DocumentStatsField;
-  }
+  /**
+   * @deprecated {@link BaseScene.CreateData | `BaseScene.CreateData`}
+   */
+  type ConstructorData = BaseScene.CreateData;
 }