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

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

@@ -1,9 +1,8 @@
 import type { AnyObject } 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 * as fields from "../data/fields.d.mts";
-
-type DataSchema = foundry.data.fields.DataSchema;
+import type { DataField, SchemaField } from "../data/fields.d.mts";
+import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
 /**
  * The Document definition for a Wall.
@@ -12,170 +11,286 @@ type DataSchema = foundry.data.fields.DataSchema;
 // 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 BaseWall extends Document<"Wall", BaseWall.Schema, any> {
+declare class BaseWall extends Document<WallDocument.Name, BaseWall.Schema, any> {
   /**
-   * @param data    - Initial data from which to construct the Wall
+   * @param data    - Initial data from which to construct the `BaseWall`
    * @param context - Construction context options
+   *
+   * @deprecated Constructing `BaseWall` 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 WallDocument.implementation | `new WallDocument.implementation(...)`} instead which will give you
+   * a system specific implementation of `WallDocument`.
    */
-  // TODO(LukeAbby): This constructor is a symptom of a circular error.
-  // constructor(data: BaseWall.ConstructorData, context?: Document.ConstructionContext<BaseWall.Parent>);
-
-  override parent: BaseWall.Parent;
+  constructor(...args: WallDocument.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Wall",
+   *   collection: "walls",
+   *   label: "DOCUMENT.Wall",
+   *   labelPlural: "DOCUMENT.Walls",
+   *   permissions: {
+   *     update: this.#canUpdate
+   *   },
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseWall.Metadata;
 
   static override defineSchema(): BaseWall.Schema;
 
-  static override migrateData(source: AnyObject): 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 override " fvtt_types_internal_document_name_static": WallDocument.Name;
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+
+  readonly parentCollection: WallDocument.ParentCollectionName | null;
+
+  readonly pack: string | null;
+
+  static override get implementation(): WallDocument.ImplementationClass;
+
+  static get baseDocument(): typeof BaseWall;
+
+  static get collectionName(): WallDocument.ParentCollectionName;
+
+  static get documentName(): WallDocument.Name;
+
+  static get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+
+  static get hasTypeData(): undefined;
+
+  static get hierarchy(): WallDocument.Hierarchy;
+
+  override parent: WallDocument.Parent;
+
+  static override createDocuments<Temporary extends boolean | undefined = false>(
+    data: Array<WallDocument.Implementation | WallDocument.CreateData> | undefined,
+    operation?: WallDocument.Database.CreateDocumentsOperation<Temporary>,
+  ): Promise<Array<Document.TemporaryIf<WallDocument.Implementation, Temporary>>>;
+
+  static override updateDocuments(
+    updates: WallDocument.UpdateData[] | undefined,
+    operation?: WallDocument.Database.UpdateDocumentsOperation,
+  ): Promise<WallDocument.Implementation[]>;
+
+  static override deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: WallDocument.Database.DeleteDocumentsOperation,
+  ): Promise<WallDocument.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = false>(
+    data: WallDocument.CreateData | WallDocument.CreateData[],
+    operation?: WallDocument.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<WallDocument.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: WallDocument.UpdateData | undefined,
+    operation?: WallDocument.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: WallDocument.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(
+    documentId: string,
+    options?: WallDocument.Database.GetOptions,
+  ): WallDocument.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 WallDocument.Flags.Scope, Key extends WallDocument.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<WallDocument.Name, Scope, Key>;
+
+  override setFlag<
+    Scope extends WallDocument.Flags.Scope,
+    Key extends WallDocument.Flags.Key<Scope>,
+    Value extends Document.GetFlag<WallDocument.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
+
+  override unsetFlag<Scope extends WallDocument.Flags.Scope, Key extends WallDocument.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Promise<this>;
+
+  protected override _preCreate(
+    data: WallDocument.CreateData,
+    options: WallDocument.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onCreate(
+    data: WallDocument.CreateData,
+    options: WallDocument.Database.OnCreateOptions,
+    userId: string,
+  ): void;
+
+  protected static override _preCreateOperation(
+    documents: WallDocument.Implementation[],
+    operation: WallDocument.Database.PreCreateOperation,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onCreateOperation(
+    documents: WallDocument.Implementation[],
+    operation: WallDocument.Database.OnCreateOperation,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preUpdate(
+    changed: WallDocument.UpdateData,
+    options: WallDocument.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onUpdate(
+    changed: WallDocument.UpdateData,
+    options: WallDocument.Database.OnUpdateOptions,
+    userId: string,
+  ): void;
+
+  protected static override _preUpdateOperation(
+    documents: WallDocument.Implementation[],
+    operation: WallDocument.Database.PreUpdateOperation,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onUpdateOperation(
+    documents: WallDocument.Implementation[],
+    operation: WallDocument.Database.OnUpdateOperation,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preDelete(
+    options: WallDocument.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onDelete(options: WallDocument.Database.OnDeleteOptions, userId: string): void;
+
+  protected static override _preDeleteOperation(
+    documents: WallDocument.Implementation[],
+    operation: WallDocument.Database.PreDeleteOperation,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onDeleteOperation(
+    documents: WallDocument.Implementation[],
+    operation: WallDocument.Database.OnDeleteOperation,
+    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 override _onCreateDocuments(
+    documents: WallDocument.Implementation[],
+    context: WallDocument.Database.OnCreateDocumentsContext,
+  ): Promise<void>;
+
+  protected static override _onUpdateDocuments(
+    documents: WallDocument.Implementation[],
+    context: WallDocument.Database.OnUpdateDocumentsContext,
+  ): Promise<void>;
+
+  protected static override _onDeleteDocuments(
+    documents: WallDocument.Implementation[],
+    context: WallDocument.Database.OnDeleteDocumentsContext,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static override _schema: SchemaField<WallDocument.Schema>;
+
+  static override get schema(): SchemaField<WallDocument.Schema>;
+
+  static override validateJoint(data: WallDocument.Source): void;
+
+  static override fromSource(
+    source: WallDocument.CreateData,
+    { strict, ...context }?: DataModel.FromSourceOptions,
+  ): WallDocument.Implementation;
+
+  static override fromJSON(json: string): WallDocument.Implementation;
 }
 
 export default BaseWall;
 
 declare namespace BaseWall {
-  type Parent = Scene.ConfiguredInstance | null;
-
-  type Metadata = Document.MetadataFor<BaseWall>;
-
-  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>;
-
-  export interface ThresholdSchema extends DataSchema {
-    /**
-     * Minimum distance from a light source for which this wall blocks light
-     */
-    light: fields.NumberField<{ required: true; nullable: true; initial: null; positive: true }>;
-
-    /**
-     * Minimum distance from a vision source for which this wall blocks vision
-     */
-    sight: fields.NumberField<{ required: true; nullable: true; initial: null; positive: true }>;
-
-    /**
-     * Minimum distance from a sound source for which this wall blocks sound
-     */
-    sound: fields.NumberField<{ required: true; nullable: true; initial: null; positive: true }>;
-
-    /**
-     * Whether to attenuate the source radius when passing through the wall
-     */
-    attenuation: fields.BooleanField;
-  }
-  interface Schema extends DataSchema {
-    /**
-     * The _id which uniquely identifies this BaseWall embedded document
-     * @defaultValue `null`
-     */
-    _id: fields.DocumentIdField;
-
-    /**
-     * The wall coordinates, a length-4 array of finite numbers [x0,y0,x1,y1]
-     */
-    c: fields.ArrayField<
-      fields.NumberField<{ required: true; integer: true; nullable: false }>,
-      {
-        validate: (c: [x0: number, y0: number, x1: number, y1: number]) => boolean;
-        validationError: "must be a length-4 array of integer coordinates";
-      },
-      // TODO(LukeAbby): Make the array shape easier to override.
-      fields.ArrayField.AssignmentElementType<fields.NumberField<{ required: true; integer: true; nullable: false }>>,
-      fields.ArrayField.InitializedElementType<fields.NumberField<{ required: true; integer: true; nullable: false }>>,
-      [x0: number, y0: number, x1: number, y1: number],
-      [x0: number, y0: number, x1: number, y1: number],
-      fields.ArrayField.PersistedElementType<fields.NumberField<{ required: true; integer: true; nullable: false }>>,
-      [x0: number, y0: number, x1: number, y1: number]
-    >;
-
-    /**
-     * The illumination restriction type of this wall
-     * @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL`
-     */
-    light: fields.NumberField<{
-      required: true;
-      choices: CONST.WALL_SENSE_TYPES[];
-      initial: typeof CONST.WALL_SENSE_TYPES.NORMAL;
-      validationError: "must be a value in CONST.WALL_SENSE_TYPES";
-    }>;
-
-    /**
-     * The movement restriction type of this wall
-     * @defaultValue `CONST.WALL_MOVEMENT_TYPES.NORMAL`
-     */
-    move: fields.NumberField<{
-      required: true;
-      choices: CONST.WALL_MOVEMENT_TYPES[];
-      initial: typeof CONST.WALL_MOVEMENT_TYPES.NORMAL;
-      validationError: "must be a value in CONST.WALL_MOVEMENT_TYPES";
-    }>;
-
-    /**
-     * The visual restriction type of this wall
-     * @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL`
-     */
-    sight: fields.NumberField<{
-      required: true;
-      choices: CONST.WALL_SENSE_TYPES[];
-      initial: typeof CONST.WALL_SENSE_TYPES.NORMAL;
-      validationError: "must be a value in CONST.WALL_SENSE_TYPES";
-    }>;
-
-    /**
-     * The auditory restriction type of this wall
-     * @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL`
-     */
-    sound: fields.NumberField<{
-      required: true;
-      choices: CONST.WALL_SENSE_TYPES[];
-      initial: typeof CONST.WALL_SENSE_TYPES.NORMAL;
-      validationError: "must be a value in CONST.WALL_SENSE_TYPES";
-    }>;
-
-    /**
-     * The direction of effect imposed by this wall
-     * @defaultValue `CONST.WALL_DIRECTIONS.BOTH`
-     */
-    dir: fields.NumberField<{
-      required: true;
-      choices: CONST.WALL_DIRECTIONS[];
-      initial: typeof CONST.WALL_DIRECTIONS.BOTH;
-      validationError: "must be a value in CONST.WALL_DIRECTIONS";
-    }>;
-
-    /**
-     * The type of door which this wall contains, if any
-     * @defaultValue `CONST.WALL_DOOR_TYPES.NONE`
-     */
-    door: fields.NumberField<{
-      required: true;
-      choices: CONST.WALL_DOOR_TYPES[];
-      initial: typeof CONST.WALL_DOOR_TYPES.NONE;
-      validationError: "must be a value in CONST.WALL_DOOR_TYPES";
-    }>;
-
-    /**
-     * The state of the door this wall contains, if any
-     * @defaultValue `CONST.WALL_DOOR_STATES.CLOSED`
-     */
-    ds: fields.NumberField<{
-      required: true;
-      choices: CONST.WALL_DOOR_STATES[];
-      initial: typeof CONST.WALL_DOOR_STATES.CLOSED;
-      validationError: "must be a value in CONST.WALL_DOOR_STATES";
-    }>;
-
-    doorSound: fields.StringField<{ required: false; blank: true; initial: undefined }>;
-
-    /**
-     * Configuration of threshold data for this wall
-     */
-    threshold: fields.SchemaField<ThresholdSchema>;
-
-    /**
-     * An object of optional key/value flags
-     * @defaultValue `{}`
-     */
-    flags: fields.ObjectField.FlagsField<"Wall">;
-  }
+  export import Name = WallDocument.Name;
+  export import ConstructorArgs = WallDocument.ConstructorArgs;
+  export import Hierarchy = WallDocument.Hierarchy;
+  export import Metadata = WallDocument.Metadata;
+  export import Parent = WallDocument.Parent;
+  export import Descendant = WallDocument.Descendant;
+  export import DescendantClass = WallDocument.DescendantClass;
+  export import Pack = WallDocument.Pack;
+  export import Embedded = WallDocument.Embedded;
+  export import ParentCollectionName = WallDocument.ParentCollectionName;
+  export import CollectionClass = WallDocument.CollectionClass;
+  export import Collection = WallDocument.Collection;
+  export import Invalid = WallDocument.Invalid;
+  export import Stored = WallDocument.Stored;
+  export import Source = WallDocument.Source;
+  export import PersistedData = WallDocument.PersistedData;
+  export import CreateData = WallDocument.CreateData;
+  export import InitializedData = WallDocument.InitializedData;
+  export import UpdateData = WallDocument.UpdateData;
+  export import Schema = WallDocument.Schema;
+  export import DatabaseOperation = WallDocument.Database;
+  export import Flags = WallDocument.Flags;
+
+  /**
+   * @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<BaseWallDocument.Schema>`}
+   */
+  type SchemaField = foundry.data.fields.SchemaField<Schema>;
+
+  /**
+   * @deprecated {@link BaseWall.CreateData | `BaseWall.CreateData`}
+   */
+  type ConstructorData = BaseWall.CreateData;
 }

package/src/foundry/common/grid/_types.d.mts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
 // After seeing that none of these types add anything or are even exported a
 // very reasonable question may be: Why on earth does this file exist?
 //