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

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

@@ -1,8 +1,8 @@
-import type { AnyObject } from "../../../types/utils.mts";
+import type { AnyMutableObject } from "#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 { DataField, SchemaField } from "../data/fields.d.mts";
+import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
 /**
  * The Document definition for a Tile.
@@ -11,185 +11,350 @@ import type * as fields from "../data/fields.d.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 BaseTile extends Document<"Tile", BaseTile.Schema, any> {
+declare abstract class BaseTile extends Document<"Tile", BaseTile.Schema, any> {
   /**
-   * @param data    - Initial data from which to construct the Tile
+   * @param data    - Initial data from which to construct the `BaseTile`
    * @param context - Construction context options
+   *
+   * @deprecated Constructing `BaseTile` 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 TileDocument.implementation | `new TileDocument.implementation(...)`} instead which will give you
+   * a system specific implementation of `TileDocument`.
    */
-  // TODO(LukeAbby): This constructor is a symptom of a circular error.
-  // constructor(data: BaseTile.ConstructorData, context?: Document.ConstructionContext<BaseTile.Parent>);
-
-  override parent: BaseTile.Parent;
+  constructor(...args: TileDocument.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Tile",
+   *   collection: "tiles",
+   *   label: "DOCUMENT.Tile",
+   *   labelPlural: "DOCUMENT.Tiles",
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseTile.Metadata;
 
   static override defineSchema(): BaseTile.Schema;
 
-  static override migrateData(source: AnyObject): AnyObject;
-
-  static override shimData(
-    data: AnyObject,
-    options?: {
-      /**
-       * Apply shims to embedded models?
-       * @defaultValue `true`
-       */
-      embedded?: boolean;
-    },
-  ): AnyObject;
+  /**
+   * @remarks
+   * Migrations:
+   * - `z` to `sort` (since v12, no specified end)
+   * - `roof` to `restrictions.light` and `restrictions.weather` (since v12, no specified end)
+   */
+  static override migrateData(source: AnyMutableObject): AnyMutableObject;
+
+  /**
+   * @remarks
+   * Shims:
+   * - `z` to `sort` (since v12, until v14)
+   */
+  // options: not null (destructured)
+  static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks "You are accessing `roof` which has been migrated to `restrictions.{light|weather}`"
+   *
+   * Getter returns `this.restrictions.light && this.restrictions.weather`, setter sets both
+   */
+  set roof(value: boolean);
+
+  get roof();
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks "You are accessing `z` which has been migrated to `sort`"
+   */
+  get z(): this["sort"];
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks "`BaseTile#overhead` is deprecated."
+   *
+   * Returns `this.elevation >= this.parent?.foregroundElevation`
+   */
+  get overhead(): boolean;
+
+  /*
+   * 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": "Tile";
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+
+  override readonly parentCollection: TileDocument.ParentCollectionName | null;
+
+  override readonly pack: string | null;
+
+  static override get implementation(): TileDocument.ImplementationClass;
+
+  static override get baseDocument(): typeof BaseTile;
+
+  static override get collectionName(): TileDocument.ParentCollectionName;
+
+  static override get documentName(): TileDocument.Name;
+
+  static override get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+
+  static override get hasTypeData(): undefined;
+
+  static override get hierarchy(): TileDocument.Hierarchy;
+
+  override parent: TileDocument.Parent;
+
+  static override createDocuments<Temporary extends boolean | undefined = false>(
+    data: Array<TileDocument.Implementation | TileDocument.CreateData> | undefined,
+    operation?: Document.Database.CreateOperation<TileDocument.Database.Create<Temporary>>,
+  ): Promise<Array<Document.TemporaryIf<TileDocument.Implementation, Temporary>>>;
+
+  static override updateDocuments(
+    updates: TileDocument.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<TileDocument.Database.Update>,
+  ): Promise<TileDocument.Implementation[]>;
+
+  static override deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: Document.Database.DeleteDocumentsOperation<TileDocument.Database.Delete>,
+  ): Promise<TileDocument.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = false>(
+    data: TileDocument.CreateData | TileDocument.CreateData[],
+    operation?: TileDocument.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<TileDocument.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: TileDocument.UpdateData | undefined,
+    operation?: TileDocument.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: TileDocument.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(
+    documentId: string,
+    options?: TileDocument.Database.GetOptions,
+  ): TileDocument.Implementation | null;
+
+  static override getCollectionName(name: string): null;
+
+  // Same as Document for now
+  override traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
+
+  override getFlag<Scope extends TileDocument.Flags.Scope, Key extends TileDocument.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<TileDocument.Name, Scope, Key>;
+
+  override setFlag<
+    Scope extends TileDocument.Flags.Scope,
+    Key extends TileDocument.Flags.Key<Scope>,
+    Value extends Document.GetFlag<TileDocument.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
+
+  override unsetFlag<Scope extends TileDocument.Flags.Scope, Key extends TileDocument.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Promise<this>;
+
+  protected override _preCreate(
+    data: TileDocument.CreateData,
+    options: TileDocument.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onCreate(
+    data: TileDocument.CreateData,
+    options: TileDocument.Database.OnCreateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preCreateOperation(
+    documents: TileDocument.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<TileDocument.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onCreateOperation(
+    documents: TileDocument.Implementation[],
+    operation: TileDocument.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preUpdate(
+    changed: TileDocument.UpdateData,
+    options: TileDocument.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onUpdate(
+    changed: TileDocument.UpdateData,
+    options: TileDocument.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preUpdateOperation(
+    documents: TileDocument.Implementation[],
+    operation: TileDocument.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onUpdateOperation(
+    documents: TileDocument.Implementation[],
+    operation: TileDocument.Database.Update,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preDelete(
+    options: TileDocument.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onDelete(options: TileDocument.Database.OnDeleteOperation, userId: string): void;
+
+  protected static override _preDeleteOperation(
+    documents: TileDocument.Implementation[],
+    operation: TileDocument.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  // 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.
+
+  // options: not null (parameter default only in _addDataFieldShim)
+  protected static override _addDataFieldShims(
+    data: AnyMutableObject,
+    shims: Record<string, string>,
+    options?: Document.DataFieldShimOptions,
+  ): void;
+
+  // options: not null (parameter default only)
+  protected static override _addDataFieldShim(
+    data: AnyMutableObject,
+    oldKey: string,
+    newKey: string,
+    options?: Document.DataFieldShimOptions,
+  ): void;
+
+  protected static override _addDataFieldMigration(
+    data: AnyMutableObject,
+    oldKey: string,
+    newKey: string,
+    apply?: ((data: AnyMutableObject) => unknown) | null,
+  ): boolean;
+
+  // options: not null (destructured where forwarded)
+  protected static override _logDataFieldMigration(
+    oldKey: string,
+    newKey: string,
+    options?: LogCompatibilityWarningOptions,
+  ): void;
+
+  protected static override _onDeleteOperation(
+    documents: TileDocument.Implementation[],
+    operation: TileDocument.Database.Delete,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onCreateDocuments` static method is deprecated in favor of {@link Document._onCreateOperation | `Document._onCreateOperation`}"
+   */
+  protected static override _onCreateDocuments(
+    documents: TileDocument.Implementation[],
+    context: Document.ModificationContext<TileDocument.Parent>,
+  ): Promise<void>;
+
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onUpdateDocuments` static method is deprecated in favor of {@link Document._onUpdateOperation | `Document._onUpdateOperation`}"
+   */
+  protected static override _onUpdateDocuments(
+    documents: TileDocument.Implementation[],
+    context: Document.ModificationContext<TileDocument.Parent>,
+  ): Promise<void>;
+
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onDeleteDocuments` static method is deprecated in favor of {@link Document._onDeleteOperation | `Document._onDeleteOperation`}"
+   */
+  protected static override _onDeleteDocuments(
+    documents: TileDocument.Implementation[],
+    context: Document.ModificationContext<TileDocument.Parent>,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static override _schema: SchemaField<TileDocument.Schema>;
+
+  static override get schema(): SchemaField<TileDocument.Schema>;
+
+  static override validateJoint(data: TileDocument.Source): void;
+
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(
+    source: TileDocument.CreateData,
+    context?: DataModel.FromSourceOptions,
+  ): TileDocument.Implementation;
+
+  static override fromJSON(json: string): TileDocument.Implementation;
 }
 
 export default BaseTile;
 
 declare namespace BaseTile {
-  type Parent = Scene.ConfiguredInstance | null;
-
-  type Metadata = Document.MetadataFor<BaseTile>;
-
-  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 Tile embedded document
-     * @defaultValue `null`
-     */
-    _id: fields.DocumentIdField;
-
-    /**
-     * An image or video texture which this tile displays.
-     * @defaultValue `null`
-     */
-    texture: TextureData<{ categories: ("IMAGE" | "VIDEO")[]; initial: null; wildcard: false }>;
-
-    /**
-     * The pixel width of the tile
-     */
-    width: fields.NumberField<{
-      required: true;
-      min: 0;
-      nullable: false;
-      step: 0.1;
-    }>;
-
-    /**
-     * The pixel height of the tile
-     */
-    height: fields.NumberField<{ required: true; min: 0; nullable: false; step: 0.1 }>;
-
-    /**
-     * The x-coordinate position of the top-left corner of the tile
-     * @defaultValue `0`
-     */
-    x: fields.NumberField<{ required: true; integer: true; nullable: false; initial: 0; label: "XCoord" }>;
-
-    /**
-     * The y-coordinate position of the top-left corner of the tile
-     * @defaultValue `0`
-     */
-    y: fields.NumberField<{ required: true; integer: true; nullable: false; initial: 0; label: "YCoord" }>;
-
-    /**
-     * The z-index ordering of this tile relative to its siblings
-     * @defaultValue `100`
-     */
-    z: fields.NumberField<{ required: true; integer: true; nullable: false; initial: 100 }>;
-
-    /**
-     * The angle of rotation for the tile between 0 and 360
-     * @defaultValue `0`
-     */
-    rotation: fields.AngleField;
-
-    /**
-     * The tile opacity
-     * @defaultValue `1`
-     */
-    alpha: fields.AlphaField;
-
-    /**
-     * Is the tile currently hidden?
-     * @defaultValue `false`
-     */
-    hidden: fields.BooleanField;
-
-    /**
-     * Is the tile currently locked?
-     * @defaultValue `false`
-     */
-    locked: fields.BooleanField;
-
-    /**
-     * Is the tile an overhead tile?
-     * @defaultValue `false`
-     */
-    overhead: fields.BooleanField;
-
-    /**
-     * Is the tile a roof?
-     * @defaultValue `false`
-     */
-    roof: fields.BooleanField;
-
-    /**
-     * The tile's occlusion settings
-     * @defaultValue see properties
-     */
-    occlusion: fields.SchemaField<{
-      /**
-       * The occlusion mode from CONST.TILE_OCCLUSION_MODES
-       * @defaultValue `1`
-       */
-      mode: fields.NumberField<{
-        choices: CONST.OCCLUSION_MODES[];
-        initial: typeof CONST.OCCLUSION_MODES.FADE;
-        validationError: "must be a value in CONST.TILE_OCCLUSION_MODES";
-      }>;
-
-      /**
-       * The occlusion alpha between 0 and 1
-       * @defaultValue `0`
-       */
-      alpha: fields.AlphaField<{ initial: 0 }>;
-
-      /**
-       * An optional radius of occlusion used for RADIAL mode
-       * @defaultValue `null`
-       */
-      radius: fields.NumberField<{ positive: true }>;
-    }>;
-
-    /**
-     * The tile's video settings
-     * @defaultValue see properties
-     */
-    video: fields.SchemaField<{
-      /**
-       * Automatically loop the video?
-       * @defaultValue `true`
-       */
-      loop: fields.BooleanField<{ initial: true }>;
-
-      /**
-       * Should the video play automatically?
-       * @defaultValue `true`
-       */
-      autoplay: fields.BooleanField<{ initial: true }>;
-
-      /**
-       * The volume level of any audio that the video file contains
-       * @defaultValue `0`
-       */
-      volume: fields.AlphaField<{ initial: 0; step: 0.01 }>;
-    }>;
-
-    /**
-     * An object of optional key/value flags
-     * @defaultValue `{}`
-     */
-    flags: fields.ObjectField.FlagsField<"Tile">;
-  }
+  export import Name = TileDocument.Name;
+  export import ConstructorArgs = TileDocument.ConstructorArgs;
+  export import Hierarchy = TileDocument.Hierarchy;
+  export import Metadata = TileDocument.Metadata;
+  export import Parent = TileDocument.Parent;
+  export import Descendant = TileDocument.Descendant;
+  export import DescendantClass = TileDocument.DescendantClass;
+  export import Pack = TileDocument.Pack;
+  export import Embedded = TileDocument.Embedded;
+  export import ParentCollectionName = TileDocument.ParentCollectionName;
+  export import CollectionClass = TileDocument.CollectionClass;
+  export import Collection = TileDocument.Collection;
+  export import Invalid = TileDocument.Invalid;
+  export import Stored = TileDocument.Stored;
+  export import Source = TileDocument.Source;
+  export import PersistedData = TileDocument.PersistedData;
+  export import CreateData = TileDocument.CreateData;
+  export import InitializedData = TileDocument.InitializedData;
+  export import UpdateData = TileDocument.UpdateData;
+  export import Schema = TileDocument.Schema;
+  export import DatabaseOperation = TileDocument.Database;
+  export import Flags = TileDocument.Flags;
+  export import CoreFlags = TileDocument.CoreFlags;
+
+  /**
+   * @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>;
+
+  /**
+   * @deprecated {@link foundry.data.fields.SchemaField | `SchemaField<BaseTileDocument.Schema>`}
+   */
+  type SchemaField = foundry.data.fields.SchemaField<Schema>;
+
+  /**
+   * @deprecated {@link BaseTile.CreateData | `BaseTile.CreateData`}
+   */
+  type ConstructorData = BaseTile.CreateData;
 }