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

package/src/foundry/common/documents/cards.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";
@@ -29,6 +29,24 @@ declare abstract class BaseCards<out SubType extends BaseCards.SubType = BaseCar
    */
   constructor(...args: Cards.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * super.metadata, {
+   *   name: "Cards",
+   *   collection: "cards",
+   *   indexed: true,
+   *   compendiumIndexFields: ["_id", "name", "description", "img", "type", "sort", "folder"],
+   *   embedded: {Card: "cards"},
+   *   hasTypeData: true,
+   *   label: "DOCUMENT.Cards",
+   *   labelPlural: "DOCUMENT.CardsPlural",
+   *   permissions: {create: "CARDS_CREATE"},
+   *   coreTypes: ["deck", "hand", "pile"],
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseCards.Metadata;
 
   static override defineSchema(): BaseCards.Schema;
@@ -39,6 +57,11 @@ declare abstract class BaseCards<out SubType extends BaseCards.SubType = BaseCar
    */
   static DEFAULT_ICON: string;
 
+  /**
+   * @remarks
+   * Migrations:
+   * - `flags.core.sourceId` to `_stats.compendiumSource` (since v12, no specified end)
+   */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
   /*
@@ -58,39 +81,39 @@ declare abstract class BaseCards<out SubType extends BaseCards.SubType = BaseCar
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: Cards.ParentCollectionName | null;
+  override readonly parentCollection: Cards.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
-  static get implementation(): Cards.ImplementationClass;
+  static override get implementation(): Cards.ImplementationClass;
 
-  static get baseDocument(): typeof BaseCards;
+  static override get baseDocument(): typeof BaseCards;
 
-  static get collectionName(): Cards.ParentCollectionName;
+  static override get collectionName(): Cards.ParentCollectionName;
 
-  static get documentName(): Cards.Name;
+  static override get documentName(): Cards.Name;
 
-  static get TYPES(): BaseCards.SubType[];
+  static override get TYPES(): BaseCards.SubType[];
 
-  static get hasTypeData(): true;
+  static override get hasTypeData(): true;
 
-  static get hierarchy(): Cards.Hierarchy;
+  static override get hierarchy(): Cards.Hierarchy;
 
   override system: Cards.SystemOfType<SubType>;
 
   override parent: BaseCards.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<Cards.Implementation | Cards.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<Cards.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<Cards.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: Cards.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<Cards.Database.Update>,
   ): Promise<Cards.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<Cards.Database.Delete>,
   ): Promise<Cards.Implementation[]>;
@@ -163,108 +186,140 @@ declare abstract class BaseCards<out SubType extends BaseCards.SubType = BaseCar
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: Cards.CreateData,
     options: Cards.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(data: Cards.CreateData, options: Cards.Database.OnCreateOperation, userId: string): void;
+  protected override _onCreate(data: Cards.CreateData, options: Cards.Database.OnCreateOperation, userId: string): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: Cards.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<Cards.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: Cards.Implementation[],
     operation: Cards.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: Cards.UpdateData,
     options: Cards.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(changed: Cards.UpdateData, options: Cards.Database.OnUpdateOperation, userId: string): void;
+  protected override _onUpdate(
+    changed: Cards.UpdateData,
+    options: Cards.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: Cards.Implementation[],
     operation: Cards.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: Cards.Implementation[],
     operation: Cards.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(options: Cards.Database.PreDeleteOptions, user: User.Implementation): Promise<boolean | void>;
+  protected override _preDelete(
+    options: Cards.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
 
-  protected _onDelete(options: Cards.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: Cards.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: Cards.Implementation[],
     operation: Cards.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: Cards.Implementation[],
     operation: Cards.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,
-    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: Cards.Implementation[],
     context: Document.ModificationContext<Cards.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: Cards.Implementation[],
     context: Document.ModificationContext<Cards.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: Cards.Implementation[],
     context: Document.ModificationContext<Cards.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<Cards.Schema>;
+  protected static override _schema: SchemaField<Cards.Schema>;
 
-  static get schema(): SchemaField<Cards.Schema>;
+  static override get schema(): SchemaField<Cards.Schema>;
 
-  static validateJoint(data: Cards.Source): void;
+  static override validateJoint(data: Cards.Source): void;
 
-  static override fromSource(
-    source: Cards.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
-  ): Cards.Implementation;
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(source: Cards.CreateData, context?: DataModel.FromSourceOptions): Cards.Implementation;
 
   static override fromJSON(json: string): Cards.Implementation;
 }

package/src/foundry/common/documents/chat-message.d.mts

@@ -1,7 +1,6 @@
-import type { AnyObject, AnyMutableObject, InexactPartial } 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 * as CONST from "../constants.mts";
 import type { SchemaField } from "../data/fields.d.mts";
 import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
@@ -28,28 +27,54 @@ declare abstract class BaseChatMessage<
    */
   constructor(...args: ChatMessage.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "ChatMessage",
+   *   collection: "messages",
+   *   label: "DOCUMENT.ChatMessage",
+   *   labelPlural: "DOCUMENT.ChatMessages",
+   *   hasTypeData: true,
+   *   isPrimary: true,
+   *   permissions: {
+   *     create: this.#canCreate,
+   *     update: this.#canUpdate
+   *   },
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseChatMessage.Metadata;
 
   static override defineSchema(): BaseChatMessage.Schema;
 
+  /**
+   * @remarks Returns `true` if `user` is the `author` of the `ChatMessage` 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<{ exact: boolean }>,
+    permission: Document.ActionPermission,
+    options?: Document.TestUserPermissionOptions,
   ): boolean;
 
+  /**
+   * @remarks
+   * Migrations:
+   * - `user` to `author` (since v12, no specified end)
+   * - existing numeric `type`s to `style`, setting `type` to `"base"` (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:
+   * - `user` to `author` (since v12, until v14)
+   */
+  // options: not null (destructured)
+  static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
 
   /**
    * @deprecated since v12, will be removed in v14
@@ -71,39 +96,39 @@ declare abstract class BaseChatMessage<
 
   static " fvtt_types_internal_document_name_static": "ChatMessage";
 
-  readonly parentCollection: ChatMessage.ParentCollectionName | null;
+  override readonly parentCollection: ChatMessage.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): ChatMessage.ImplementationClass;
 
-  static get baseDocument(): typeof BaseChatMessage;
+  static override get baseDocument(): typeof BaseChatMessage;
 
-  static get collectionName(): ChatMessage.ParentCollectionName;
+  static override get collectionName(): ChatMessage.ParentCollectionName;
 
-  static get documentName(): ChatMessage.Name;
+  static override get documentName(): ChatMessage.Name;
 
-  static get TYPES(): BaseChatMessage.SubType[];
+  static override get TYPES(): BaseChatMessage.SubType[];
 
-  static get hasTypeData(): true;
+  static override get hasTypeData(): true;
 
-  static get hierarchy(): ChatMessage.Hierarchy;
+  static override get hierarchy(): ChatMessage.Hierarchy;
 
   override system: ChatMessage.SystemOfType<SubType>;
 
   override parent: BaseChatMessage.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<ChatMessage.Implementation | ChatMessage.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<ChatMessage.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<ChatMessage.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: ChatMessage.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<ChatMessage.Database.Update>,
   ): Promise<ChatMessage.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<ChatMessage.Database.Delete>,
   ): Promise<ChatMessage.Implementation[]>;
@@ -143,123 +168,151 @@ declare abstract class BaseChatMessage<
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: ChatMessage.CreateData,
     options: ChatMessage.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: ChatMessage.CreateData,
     options: ChatMessage.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: ChatMessage.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<ChatMessage.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: ChatMessage.Implementation[],
     operation: ChatMessage.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: ChatMessage.UpdateData,
     options: ChatMessage.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: ChatMessage.UpdateData,
     options: ChatMessage.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: ChatMessage.Implementation[],
     operation: ChatMessage.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: ChatMessage.Implementation[],
     operation: ChatMessage.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: ChatMessage.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: ChatMessage.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: ChatMessage.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: ChatMessage.Implementation[],
     operation: ChatMessage.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: ChatMessage.Implementation[],
     operation: ChatMessage.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: ChatMessage.Implementation[],
     context: Document.ModificationContext<ChatMessage.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: ChatMessage.Implementation[],
     context: Document.ModificationContext<ChatMessage.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: ChatMessage.Implementation[],
     context: Document.ModificationContext<ChatMessage.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<ChatMessage.Schema>;
+  protected static override _schema: SchemaField<ChatMessage.Schema>;
 
-  static get schema(): SchemaField<ChatMessage.Schema>;
+  static override get schema(): SchemaField<ChatMessage.Schema>;
 
-  static validateJoint(data: ChatMessage.Source): void;
+  static override validateJoint(data: ChatMessage.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: ChatMessage.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): ChatMessage.Implementation;
 
   static override fromJSON(json: string): ChatMessage.Implementation;
 
-  #baseChatMessage: true;
+  static #BaseChatMessage: true;
 }
 
 export default BaseChatMessage;