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

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

@@ -1,7 +1,6 @@
-import type { AnyMutableObject, AnyObject, InexactPartial } from "fvtt-types/utils";
+import type { AnyMutableObject } from "#utils";
 import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.d.mts";
-import type * as CONST from "../constants.mts";
 import type { SchemaField } from "../data/fields.d.mts";
 import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
@@ -30,31 +29,64 @@ declare abstract class BaseMacro<out _SubType extends BaseMacro.SubType = BaseMa
    */
   constructor(...args: Macro.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Macro",
+   *   collection: "macros",
+   *   indexed: true,
+   *   compendiumIndexFields: ["_id", "name", "img", "sort", "folder"],
+   *   label: "DOCUMENT.Macro",
+   *   labelPlural: "DOCUMENT.Macros",
+   *   coreTypes: Object.values(CONST.MACRO_TYPES),
+   *   permissions: {
+   *     create: this.#canCreate,
+   *     update: this.#canUpdate
+   *   },
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseMacro.Metadata;
 
   static override defineSchema(): BaseMacro.Schema;
 
   /**
    * The default icon used for newly created Macro documents.
+   * @defaultValue `"icons/svg/dice-target.svg"`
    */
-  static DEFAULT_ICON: "icons/svg/dice-target.svg";
+  static DEFAULT_ICON: string;
 
+  /**
+   * @remarks
+   * Migrations:
+   * - `flags.core.sourceId` to `_stats.compendiumSource` (since v12, no specified end)
+   */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
+  /**
+   * @remarks
+   * @throws If `data.command` doesn't pass {@link foundry.data.fields.JavaScriptField | `JavaScriptField`} validation
+   */
+  static override validateJoint(data: Macro.Source): void;
+
+  /** @remarks Returns `user.hasRole("PLAYER")` */
   static override canUserCreate(user: User.Implementation): boolean;
 
+  /**
+   * @remarks Returns `true` if `user` is the `author` of the `Macro` and `options.exact` is falsey.
+   * Otherwise, forwards to {@link Document.testUserPermission | `Document#testUserPermission`}
+   */
+  // options: not null (destructured)
   override testUserPermission(
     user: User.Implementation,
-    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | CONST.DOCUMENT_OWNERSHIP_LEVELS,
-    options?: InexactPartial<{
-      /**
-       * Require the exact permission level requested?
-       * @defaultValue `false`
-       */
-      exact: boolean;
-    }>,
+    permission: Document.ActionPermission,
+    options?: Document.TestUserPermissionOptions,
   ): boolean;
 
+  // _preCreate is overridden with no type changes
+
   /*
    * After this point these are not really overridden methods.
    * They are here because Foundry's documents are complex and have lots of edge cases.
@@ -69,37 +101,37 @@ declare abstract class BaseMacro<out _SubType extends BaseMacro.SubType = BaseMa
 
   static " fvtt_types_internal_document_name_static": "Macro";
 
-  readonly parentCollection: Macro.ParentCollectionName | null;
+  override readonly parentCollection: Macro.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): Macro.ImplementationClass;
 
-  static get baseDocument(): typeof BaseMacro;
+  static override get baseDocument(): typeof BaseMacro;
 
-  static get collectionName(): Macro.ParentCollectionName;
+  static override get collectionName(): Macro.ParentCollectionName;
 
-  static get documentName(): Macro.Name;
+  static override get documentName(): Macro.Name;
 
-  static get TYPES(): BaseMacro.SubType[];
+  static override get TYPES(): BaseMacro.SubType[];
 
-  static get hasTypeData(): true;
+  static override get hasTypeData(): true;
 
-  static get hierarchy(): Macro.Hierarchy;
+  static override get hierarchy(): Macro.Hierarchy;
 
   override parent: BaseMacro.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<Macro.Implementation | Macro.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<Macro.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<Macro.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: Macro.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<Macro.Database.Update>,
   ): Promise<Macro.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<Macro.Database.Delete>,
   ): Promise<Macro.Implementation[]>;
@@ -139,110 +171,142 @@ declare abstract class BaseMacro<out _SubType extends BaseMacro.SubType = BaseMa
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: Macro.CreateData,
     options: Macro.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(data: Macro.CreateData, options: Macro.Database.OnCreateOperation, userId: string): void;
+  protected override _onCreate(data: Macro.CreateData, options: Macro.Database.OnCreateOperation, userId: string): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: Macro.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<Macro.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: Macro.Implementation[],
     operation: Macro.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: Macro.UpdateData,
     options: Macro.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(changed: Macro.UpdateData, options: Macro.Database.OnUpdateOperation, userId: string): void;
+  protected override _onUpdate(
+    changed: Macro.UpdateData,
+    options: Macro.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: Macro.Implementation[],
     operation: Macro.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: Macro.Implementation[],
     operation: Macro.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(options: Macro.Database.PreDeleteOptions, user: User.Implementation): Promise<boolean | void>;
+  protected override _preDelete(
+    options: Macro.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
 
-  protected _onDelete(options: Macro.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: Macro.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: Macro.Implementation[],
     operation: Macro.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: Macro.Implementation[],
     operation: Macro.Database.Delete,
     user: User.Implementation,
   ): Promise<void>;
 
-  static get hasSystemData(): true;
+  static override get hasSystemData(): true;
 
   // 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: Macro.Implementation[],
     context: Document.ModificationContext<Macro.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: Macro.Implementation[],
     context: Document.ModificationContext<Macro.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: Macro.Implementation[],
     context: Document.ModificationContext<Macro.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<Macro.Schema>;
+  protected static override _schema: SchemaField<Macro.Schema>;
 
-  static get schema(): SchemaField<Macro.Schema>;
+  static override get schema(): SchemaField<Macro.Schema>;
 
-  static override validateJoint(data: Macro.Source): void;
-
-  static override fromSource(
-    source: Macro.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
-  ): Macro.Implementation;
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(source: Macro.CreateData, context?: DataModel.FromSourceOptions): Macro.Implementation;
 
   static override fromJSON(json: string): Macro.Implementation;
+
+  static #BaseMacro: true;
 }
 export default BaseMacro;
 

package/src/foundry/common/documents/measured-template.d.mts

@@ -1,4 +1,4 @@
-import type { AnyMutableObject, AnyObject } 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";
@@ -46,22 +46,28 @@ declare abstract class BaseMeasuredTemplate extends Document<"MeasuredTemplate",
 
   static override defineSchema(): BaseMeasuredTemplate.Schema;
 
+  /**
+   * @remarks Returns `true` if `user` is the `author` of the `MeasuredTemplate` and `options.exact` is falsey.
+   * Otherwise, forwards to {@link Document.testUserPermission | Document#testUserPermission`}
+   */
   // options: not null (destructured)
   override testUserPermission(
-    user: User.Internal.Implementation,
-    permission: Document.TestableOwnershipLevel,
+    user: User.Implementation,
+    permission: Document.ActionPermission,
     options?: Document.TestUserPermissionOptions,
   ): boolean;
 
   /**
-   * @remarks Migrates:
-   * - `user` to `author`
+   * @remarks
+   * Migrations:
+   * - `user` to `author` (since v12, no specified end)
    */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
   /**
-   * @remarks Shims:
-   * - `user` to `author` since v12, until v14
+   * @remarks
+   * Shims:
+   * - `user` to `author` (since v12, until v14)
    */
   // options: not null (destructured)
   static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
@@ -89,37 +95,37 @@ declare abstract class BaseMeasuredTemplate extends Document<"MeasuredTemplate",
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: MeasuredTemplateDocument.ParentCollectionName | null;
+  override readonly parentCollection: MeasuredTemplateDocument.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): MeasuredTemplateDocument.ImplementationClass;
 
-  static get baseDocument(): typeof BaseMeasuredTemplate;
+  static override get baseDocument(): typeof BaseMeasuredTemplate;
 
-  static get collectionName(): MeasuredTemplateDocument.ParentCollectionName;
+  static override get collectionName(): MeasuredTemplateDocument.ParentCollectionName;
 
-  static get documentName(): MeasuredTemplateDocument.Name;
+  static override get documentName(): MeasuredTemplateDocument.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(): MeasuredTemplateDocument.Hierarchy;
+  static override get hierarchy(): MeasuredTemplateDocument.Hierarchy;
 
   override parent: MeasuredTemplateDocument.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<MeasuredTemplateDocument.Implementation | MeasuredTemplateDocument.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<MeasuredTemplateDocument.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<MeasuredTemplateDocument.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: MeasuredTemplateDocument.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<MeasuredTemplateDocument.Database.Update>,
   ): Promise<MeasuredTemplateDocument.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<MeasuredTemplateDocument.Database.Delete>,
   ): Promise<MeasuredTemplateDocument.Implementation[]>;
@@ -162,119 +168,149 @@ declare abstract class BaseMeasuredTemplate extends Document<"MeasuredTemplate",
     Key extends MeasuredTemplateDocument.Flags.Key<Scope>,
   >(scope: Scope, key: Key): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: MeasuredTemplateDocument.CreateData,
     options: MeasuredTemplateDocument.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: MeasuredTemplateDocument.CreateData,
     options: MeasuredTemplateDocument.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: MeasuredTemplateDocument.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<MeasuredTemplateDocument.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: MeasuredTemplateDocument.Implementation[],
     operation: MeasuredTemplateDocument.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: MeasuredTemplateDocument.UpdateData,
     options: MeasuredTemplateDocument.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: MeasuredTemplateDocument.UpdateData,
     options: MeasuredTemplateDocument.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: MeasuredTemplateDocument.Implementation[],
     operation: MeasuredTemplateDocument.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: MeasuredTemplateDocument.Implementation[],
     operation: MeasuredTemplateDocument.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: MeasuredTemplateDocument.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: MeasuredTemplateDocument.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: MeasuredTemplateDocument.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: MeasuredTemplateDocument.Implementation[],
     operation: MeasuredTemplateDocument.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: MeasuredTemplateDocument.Implementation[],
     operation: MeasuredTemplateDocument.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: MeasuredTemplateDocument.Implementation[],
     context: Document.ModificationContext<MeasuredTemplateDocument.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: MeasuredTemplateDocument.Implementation[],
     context: Document.ModificationContext<MeasuredTemplateDocument.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: MeasuredTemplateDocument.Implementation[],
     context: Document.ModificationContext<MeasuredTemplateDocument.Parent>,
   ): Promise<void>;
 
-  protected static _schema: SchemaField<MeasuredTemplateDocument.Schema>;
+  protected static override _schema: SchemaField<MeasuredTemplateDocument.Schema>;
 
-  static get schema(): SchemaField<MeasuredTemplateDocument.Schema>;
+  static override get schema(): SchemaField<MeasuredTemplateDocument.Schema>;
 
-  static validateJoint(data: MeasuredTemplateDocument.Source): void;
+  static override validateJoint(data: MeasuredTemplateDocument.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: MeasuredTemplateDocument.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): MeasuredTemplateDocument.Implementation;
 
   static override fromJSON(json: string): MeasuredTemplateDocument.Implementation;
+
+  static #BaseMeasuredTemplate: true;
 }
 
 export default BaseMeasuredTemplate;