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

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

@@ -1,4 +1,4 @@
-import type { AnyObject, AnyMutableObject } from "fvtt-types/utils";
+import type { AnyMutableObject } from "#utils";
 import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
 import type { DataField, SchemaField } from "../data/fields.d.mts";
@@ -25,22 +25,137 @@ declare abstract class BaseScene extends Document<"Scene", BaseScene.Schema, any
    */
   constructor(...args: Scene.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Scene",
+   *   collection: "scenes",
+   *   indexed: true,
+   *   compendiumIndexFields: ["_id", "name", "thumb", "sort", "folder"],
+   *   embedded: {
+   *     AmbientLight: "lights",
+   *     AmbientSound: "sounds",
+   *     Drawing: "drawings",
+   *     MeasuredTemplate: "templates",
+   *     Note: "notes",
+   *     Region: "regions",
+   *     Tile: "tiles",
+   *     Token: "tokens",
+   *     Wall: "walls"
+   *   },
+   *   label: "DOCUMENT.Scene",
+   *   labelPlural: "DOCUMENT.Scenes",
+   *   preserveOnImport: [...super.metadata.preserveOnImport, "active"],
+   *   schemaVersion: "12.325"
+   * });
+   * ```
+   */
   static override metadata: BaseScene.Metadata;
 
   static override defineSchema(): BaseScene.Schema;
 
+  /**
+   * @remarks
+   * Migrations:
+   * - `fogExploration` to `fog.exploration` (since v12, until 14 (probably))
+   * - `fogReset` to `fog.reset` (since v12, until 14 (probably))
+   * - `fogOverlay` to `fog.overlay` (since v12, until 14 (probably))
+   * - `fogExploredColor` to `fog.colors.explored` (since v12, until 14 (probably))
+   * - `fogUnexploredColor` to `fog.colors.unexplored` (since v12, until 14 (probably))
+   * - `globalLight` to `environment.globalLight.enabled` (since v12, until 14 (probably))
+   * - `globalLightThreshold` to `environment.globalLight.darkness.max` (since v12, until 14 (probably))
+   * - `darkness` to `environment.darknessLevel` (since v12, until 14 (probably))
+   * - `flags.core.sourceId` to `_stats.compendiumSource` (since v12, no specified end)
+   */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
-  static override shimData(
-    data: AnyObject,
-    options?: {
-      /**
-       * Apply shims to embedded models?
-       * @defaultValue `true`
-       */
-      embedded?: boolean;
-    },
-  ): AnyObject;
+  /**
+   * @remarks
+   * Shims:
+   * - `fogExploration` to `fog.exploration` (since v12, until 14)
+   * - `fogReset` to `fog.reset` (since v12, until 14)
+   * - `fogOverlay` to `fog.overlay` (since v12, until 14)
+   * - `fogExploredColor` to `fog.colors.explored` (since v12, until 14)
+   * - `fogUnexploredColor` to `fog.colors.unexplored` (since v12, until 14)
+   * - `globalLight` to `environment.globalLight.enabled` (since v12, until 14)
+   * - `globalLightThreshold` to `environment.globalLight.darkness.max` (since v12, until 14)
+   * - `darkness` to `environment.darknessLevel` (since v12, until 14)
+   */
+  // options: not null (destructured)
+  static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks Replaced with `fog.exploration`
+   * @privateRemarks Defined via `Object.defineProperties` operating on `this.prototype` in a static initialization block with options: `{configurable: true}`
+   */
+  get fogExploration(): this["fog"]["exploration"];
+
+  set fogExploration(value);
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks Replaced with `fog.reset`
+   * @privateRemarks Defined via `Object.defineProperties` operating on `this.prototype` in a static initialization block with options: `{configurable: true}`
+   */
+  get fogReset(): this["fog"]["reset"];
+
+  set fogReset(value);
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks Replaced with `fog.overlay`
+   * @privateRemarks Defined via `Object.defineProperties` operating on `this.prototype` in a static initialization block with options: `{configurable: true}`
+   */
+  get fogOverlay(): this["fog"]["overlay"];
+
+  set fogOverlay(value);
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks Replaced with `fog.colors.explored`
+   * @privateRemarks Defined via `Object.defineProperties` operating on `this.prototype` in a static initialization block with options: `{configurable: true}`
+   */
+  get fogExploredColor(): this["fog"]["colors"]["explored"];
+
+  set fogExploredColor(value);
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks Replaced with `fog.colors.unexplored`
+   * @privateRemarks Defined via `Object.defineProperties` operating on `this.prototype` in a static initialization block with options: `{configurable: true}`
+   */
+  get fogUnexploredColor(): this["fog"]["colors"]["unexplored"];
+
+  set fogUnexploredColor(value);
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks Replaced with `environment.globalLight.enabled`
+   * @privateRemarks Defined via `Object.defineProperties` operating on `this.prototype` in a static initialization block with options: `{configurable: true}`
+   */
+  get globalLight(): this["environment"]["globalLight"]["enabled"];
+
+  set globalLight(value);
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks Replaced with `environment.globalLight.darkness.max`
+   * @privateRemarks Defined via `Object.defineProperties` operating on `this.prototype` in a static initialization block with options: `{configurable: true}`
+   */
+  get globalLightThreshold(): this["environment"]["globalLight"]["darkness"]["max"];
+
+  set globalLightThreshold(value);
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks Replaced with `environment.darknessLevel`
+   * @privateRemarks Defined via `Object.defineProperties` operating on `this.prototype` in a static initialization block with options: `{configurable: true}`
+   */
+  get darkness(): this["environment"]["darknessLevel"];
+
+  set darkness(value);
 
   /*
    * After this point these are not really overridden methods.
@@ -79,17 +194,17 @@ declare abstract class BaseScene extends Document<"Scene", BaseScene.Schema, any
 
   override parent: Scene.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override 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(
+  static override updateDocuments(
     updates: Scene.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<Scene.Database.Update>,
   ): Promise<Scene.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<Scene.Database.Delete>,
   ): Promise<Scene.Implementation[]>;
@@ -162,108 +277,140 @@ declare abstract class BaseScene extends Document<"Scene", BaseScene.Schema, any
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _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 override _onCreate(data: Scene.CreateData, options: Scene.Database.OnCreateOperation, userId: string): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: Scene.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<Scene.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: Scene.Implementation[],
     operation: Scene.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _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 override _onUpdate(
+    changed: Scene.UpdateData,
+    options: Scene.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: Scene.Implementation[],
     operation: Scene.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _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 override _preDelete(
+    options: Scene.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
 
-  protected _onDelete(options: Scene.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: Scene.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: Scene.Implementation[],
     operation: Scene.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: Scene.Implementation[],
     operation: Scene.Database.Delete,
     user: User.Implementation,
   ): Promise<void>;
 
-  static get hasSystemData(): undefined;
+  static override 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,
+  // 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: AnyObject) => unknown,
-  ): unknown;
+    apply?: ((data: AnyMutableObject) => unknown) | null,
+  ): boolean;
 
-  protected static _logDataFieldMigration(
+  // options: not null (destructured where forwarded)
+  protected static override _logDataFieldMigration(
     oldKey: string,
     newKey: string,
     options?: LogCompatibilityWarningOptions,
   ): void;
 
-  protected static _onCreateDocuments(
+  /**
+   * @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: Scene.Implementation[],
     context: Document.ModificationContext<Scene.Parent>,
   ): Promise<void>;
 
-  protected static _onUpdateDocuments(
+  /**
+   * @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: Scene.Implementation[],
     context: Document.ModificationContext<Scene.Parent>,
   ): Promise<void>;
 
-  protected static _onDeleteDocuments(
+  /**
+   * @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: Scene.Implementation[],
     context: Document.ModificationContext<Scene.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<Scene.Schema>;
+  protected static override _schema: SchemaField<Scene.Schema>;
 
-  static get schema(): SchemaField<Scene.Schema>;
+  static override get schema(): SchemaField<Scene.Schema>;
 
-  static validateJoint(data: Scene.Source): void;
+  static override validateJoint(data: Scene.Source): void;
 
-  static override fromSource(
-    source: Scene.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
-  ): Scene.Implementation;
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(source: Scene.CreateData, context?: DataModel.FromSourceOptions): Scene.Implementation;
 
   static override fromJSON(json: string): Scene.Implementation;
 }

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

@@ -1,4 +1,4 @@
-import type { AnyObject } from "../../../utils/index.d.mts";
+import type { AnyMutableObject } from "#utils";
 import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
 import type { DataField, SchemaField } from "../data/fields.d.mts";
@@ -25,10 +25,28 @@ declare abstract class BaseSetting extends Document<"Setting", BaseSetting.Schem
    */
   constructor(...args: Setting.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Setting",
+   *   collection: "settings",
+   *   label: "DOCUMENT.Setting",
+   *   labelPlural: "DOCUMENT.Settings",
+   *   permissions: {
+   *     create: this.#canModify,
+   *     update: this.#canModify,
+   *     delete: this.#canModify
+   *   },
+   *   schemaVersion: "12.324"
+   * });
+   * ```
+   */
   static override metadata: BaseSetting.Metadata;
 
   static override defineSchema(): BaseSetting.Schema;
 
+  /** @remarks Returns `user.hasPermission("SETTINGS_MODIFY")` */
   static canUserCreate(user: User.Implementation): boolean;
 
   /*
@@ -48,37 +66,37 @@ declare abstract class BaseSetting extends Document<"Setting", BaseSetting.Schem
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: Setting.ParentCollectionName | null;
+  override readonly parentCollection: Setting.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
-  static get baseDocument(): typeof BaseSetting;
+  static override get baseDocument(): typeof BaseSetting;
 
-  static get implementation(): Setting.ImplementationClass;
+  static override get implementation(): Setting.ImplementationClass;
 
-  static get collectionName(): Setting.ParentCollectionName;
+  static override get collectionName(): Setting.ParentCollectionName;
 
-  static get documentName(): Setting.Name;
+  static override get documentName(): Setting.Name;
 
-  static get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+  static override get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
 
-  static get hasTypeData(): undefined;
+  static override get hasTypeData(): undefined;
 
-  static get hierarchy(): Setting.Hierarchy;
+  static override get hierarchy(): Setting.Hierarchy;
 
   override parent: Setting.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<Setting.Implementation | Setting.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<Setting.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<Setting.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: Setting.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<Setting.Database.Update>,
   ): Promise<Setting.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<Setting.Database.Delete>,
   ): Promise<Setting.Implementation[]>;
@@ -102,110 +120,148 @@ declare abstract class BaseSetting extends Document<"Setting", BaseSetting.Schem
   // Same as Document for now
   override traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: Setting.CreateData,
     options: Setting.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(data: Setting.CreateData, options: Setting.Database.OnCreateOperation, userId: string): void;
+  protected override _onCreate(
+    data: Setting.CreateData,
+    options: Setting.Database.OnCreateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: Setting.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<Setting.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: Setting.Implementation[],
     operation: Setting.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: Setting.UpdateData,
     options: Setting.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(changed: Setting.UpdateData, options: Setting.Database.OnUpdateOperation, userId: string): void;
+  protected override _onUpdate(
+    changed: Setting.UpdateData,
+    options: Setting.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: Setting.Implementation[],
     operation: Setting.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: Setting.Implementation[],
     operation: Setting.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(options: Setting.Database.PreDeleteOptions, user: User.Implementation): Promise<boolean | void>;
+  protected override _preDelete(
+    options: Setting.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
 
-  protected _onDelete(options: Setting.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: Setting.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: Setting.Implementation[],
     operation: Setting.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: Setting.Implementation[],
     operation: Setting.Database.Delete,
     user: User.Implementation,
   ): Promise<void>;
 
-  static get hasSystemData(): undefined;
+  static override 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,
+  // 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,
-    apply?: (data: AnyObject) => unknown,
-  ): unknown;
+    options?: Document.DataFieldShimOptions,
+  ): void;
 
-  protected static _logDataFieldMigration(
+  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 _onCreateDocuments(
+  /**
+   * @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: Setting.Implementation[],
     context: Document.ModificationContext<Setting.Parent>,
   ): Promise<void>;
 
-  protected static _onUpdateDocuments(
+  /**
+   * @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: Setting.Implementation[],
     context: Document.ModificationContext<Setting.Parent>,
   ): Promise<void>;
 
-  protected static _onDeleteDocuments(
+  /**
+   * @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: Setting.Implementation[],
     context: Document.ModificationContext<Setting.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<Setting.Schema>;
+  protected static override _schema: SchemaField<Setting.Schema>;
 
-  static get schema(): SchemaField<Setting.Schema>;
+  static override get schema(): SchemaField<Setting.Schema>;
 
-  static validateJoint(data: Setting.Source): void;
+  static override validateJoint(data: Setting.Source): void;
 
-  static override fromSource(
-    source: Setting.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
-  ): Setting.Implementation;
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(source: Setting.CreateData, context?: DataModel.FromSourceOptions): Setting.Implementation;
 
   static override fromJSON(json: string): Setting.Implementation;
+
+  static #BaseSetting: true;
 }
 
 export default BaseSetting;