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

package/src/foundry/common/documents/table-result.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.mts";
-import type * as CONST from "../constants.mts";
 import type { DataField, SchemaField } from "../data/fields.d.mts";
 import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
@@ -28,22 +27,43 @@ declare abstract class BaseTableResult<
    */
   constructor(...args: TableResult.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "TableResult",
+   *   collection: "results",
+   *   label: "DOCUMENT.TableResult",
+   *   labelPlural: "DOCUMENT.TableResults",
+   *   coreTypes: Object.values(CONST.TABLE_RESULT_TYPES),
+   *   permissions: {
+   *     update: this.#canUpdate
+   *   },
+   *   compendiumIndexFields: ["type"],
+   *   schemaVersion: "12.324"
+   * });
+   * ```
+   */
   static override metadata: BaseTableResult.Metadata;
 
   static override defineSchema(): BaseTableResult.Schema;
 
+  /**
+   * @remarks If `this.isEmbedded`, uses `this.parent.testUserPermission`, otherwise `super`'s. Core's `RollTable` implementation
+   * doesn't override this method, so without further extension those are both {@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;
 
+  /**
+   * @remarks
+   * Migrations:
+   * - Numeric `type`s to their new — since v12 — string values
+   */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
   /*
@@ -63,37 +83,37 @@ declare abstract class BaseTableResult<
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: TableResult.ParentCollectionName | null;
+  override readonly parentCollection: TableResult.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): TableResult.ImplementationClass;
 
-  static get baseDocument(): typeof BaseTableResult;
+  static override get baseDocument(): typeof BaseTableResult;
 
-  static get collectionName(): TableResult.ParentCollectionName;
+  static override get collectionName(): TableResult.ParentCollectionName;
 
-  static get documentName(): TableResult.Name;
+  static override get documentName(): TableResult.Name;
 
-  static get TYPES(): BaseTableResult.SubType[];
+  static override get TYPES(): BaseTableResult.SubType[];
 
-  static get hasTypeData(): undefined;
+  static override get hasTypeData(): undefined;
 
-  static get hierarchy(): TableResult.Hierarchy;
+  static override get hierarchy(): TableResult.Hierarchy;
 
   override parent: BaseTableResult.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<TableResult.Implementation | TableResult.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<TableResult.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<TableResult.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: TableResult.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<TableResult.Database.Update>,
   ): Promise<TableResult.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<TableResult.Database.Delete>,
   ): Promise<TableResult.Implementation[]>;
@@ -110,7 +130,7 @@ declare abstract class BaseTableResult<
 
   override delete(operation?: TableResult.Database.DeleteOperation): Promise<this | undefined>;
 
-  static get(documentId: string, options?: TableResult.Database.GetOptions): TableResult.Implementation | null;
+  static override get(documentId: string, options?: TableResult.Database.GetOptions): TableResult.Implementation | null;
 
   static override getCollectionName(name: string): null;
 
@@ -133,121 +153,151 @@ declare abstract class BaseTableResult<
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: TableResult.CreateData,
     options: TableResult.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: TableResult.CreateData,
     options: TableResult.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: TableResult.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<TableResult.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: TableResult.Implementation[],
     operation: TableResult.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: TableResult.UpdateData,
     options: TableResult.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: TableResult.UpdateData,
     options: TableResult.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: TableResult.Implementation[],
     operation: TableResult.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: TableResult.Implementation[],
     operation: TableResult.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: TableResult.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: TableResult.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: TableResult.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: TableResult.Implementation[],
     operation: TableResult.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: TableResult.Implementation[],
     operation: TableResult.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: TableResult.Implementation[],
     context: Document.ModificationContext<TableResult.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: TableResult.Implementation[],
     context: Document.ModificationContext<TableResult.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: TableResult.Implementation[],
     context: Document.ModificationContext<TableResult.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<TableResult.Schema>;
+  protected static override _schema: SchemaField<TableResult.Schema>;
 
-  static get schema(): SchemaField<TableResult.Schema>;
+  static override get schema(): SchemaField<TableResult.Schema>;
 
-  static validateJoint(data: TableResult.Source): void;
+  static override validateJoint(data: TableResult.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: TableResult.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): TableResult.Implementation;
 
   static override fromJSON(json: string): TableResult.Implementation;
+
+  static #BaseTableResult: true;
 }
 
 export default BaseTableResult;

package/src/foundry/common/documents/tile.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";
@@ -42,16 +42,19 @@ declare abstract class BaseTile extends Document<"Tile", BaseTile.Schema, any> {
   static override defineSchema(): BaseTile.Schema;
 
   /**
-   * @remarks Migrates:
-   * - `z` to `sort`
-   * - `roof` to `restrictions.light` and `restrictions.weather`
+   * @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
+   * @remarks
+   * Shims:
+   * - `z` to `sort` (since v12, until v14)
    */
+  // options: not null (destructured)
   static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
 
   /**
@@ -95,37 +98,37 @@ declare abstract class BaseTile extends Document<"Tile", BaseTile.Schema, any> {
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: TileDocument.ParentCollectionName | null;
+  override readonly parentCollection: TileDocument.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): TileDocument.ImplementationClass;
 
-  static get baseDocument(): typeof BaseTile;
+  static override get baseDocument(): typeof BaseTile;
 
-  static get collectionName(): TileDocument.ParentCollectionName;
+  static override get collectionName(): TileDocument.ParentCollectionName;
 
-  static get documentName(): TileDocument.Name;
+  static override get documentName(): TileDocument.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(): TileDocument.Hierarchy;
+  static override get hierarchy(): TileDocument.Hierarchy;
 
   override parent: TileDocument.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  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 updateDocuments(
+  static override updateDocuments(
     updates: TileDocument.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<TileDocument.Database.Update>,
   ): Promise<TileDocument.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<TileDocument.Database.Delete>,
   ): Promise<TileDocument.Implementation[]>;
@@ -142,7 +145,10 @@ declare abstract class BaseTile extends Document<"Tile", BaseTile.Schema, any> {
 
   override delete(operation?: TileDocument.Database.DeleteOperation): Promise<this | undefined>;
 
-  static get(documentId: string, options?: TileDocument.Database.GetOptions): TileDocument.Implementation | null;
+  static override get(
+    documentId: string,
+    options?: TileDocument.Database.GetOptions,
+  ): TileDocument.Implementation | null;
 
   static override getCollectionName(name: string): null;
 
@@ -165,62 +171,62 @@ declare abstract class BaseTile extends Document<"Tile", BaseTile.Schema, any> {
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: TileDocument.CreateData,
     options: TileDocument.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: TileDocument.CreateData,
     options: TileDocument.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: TileDocument.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<TileDocument.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: TileDocument.Implementation[],
     operation: TileDocument.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: TileDocument.UpdateData,
     options: TileDocument.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: TileDocument.UpdateData,
     options: TileDocument.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: TileDocument.Implementation[],
     operation: TileDocument.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: TileDocument.Implementation[],
     operation: TileDocument.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: TileDocument.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: TileDocument.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: TileDocument.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: TileDocument.Implementation[],
     operation: TileDocument.Database.Delete,
     user: User.Implementation,
@@ -228,53 +234,81 @@ declare abstract class BaseTile extends Document<"Tile", BaseTile.Schema, any> {
 
   // 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 _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: TileDocument.Implementation[],
     operation: TileDocument.Database.Delete,
     user: User.Implementation,
   ): Promise<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: TileDocument.Implementation[],
     context: Document.ModificationContext<TileDocument.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: TileDocument.Implementation[],
     context: Document.ModificationContext<TileDocument.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: TileDocument.Implementation[],
     context: Document.ModificationContext<TileDocument.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<TileDocument.Schema>;
+  protected static override _schema: SchemaField<TileDocument.Schema>;
 
-  static get schema(): SchemaField<TileDocument.Schema>;
+  static override get schema(): SchemaField<TileDocument.Schema>;
 
-  static validateJoint(data: TileDocument.Source): void;
+  static override validateJoint(data: TileDocument.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: TileDocument.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): TileDocument.Implementation;
 
   static override fromJSON(json: string): TileDocument.Implementation;