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

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

@@ -1,4 +1,4 @@
-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";
@@ -53,46 +53,58 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
 
   /**
    * The default icon used for newly created Token documents
-   * @defaultValue `CONST.DEFAULT_TOKEN` (`"icons/svg/mystery-man.svg"`)
+   * @defaultValue `CONST.DEFAULT_TOKEN`
    */
   static DEFAULT_ICON: string;
 
+  /**
+   * @remarks If `this.actor`, uses {@link Actor.testUserPermission | `this.actor.testUserPermission`} otherwise `super`'s. Core's `Actor` implementation
+   * doesn't override this method, so without further extension, that's equivalent to {@link Document.testUserPermission | `Document#testUserPermission`}
+   */
   // options: not null (destructured)
   override testUserPermission(
     user: User.Implementation,
-    permission: Document.TestableOwnershipLevel,
+    permission: Document.ActionPermission,
     options?: Document.TestUserPermissionOptions,
   ): boolean;
 
-  updateSource(changes?: TokenDocument.UpdateData, options?: DataModel.UpdateSourceOptions): TokenDocument.UpdateData;
+  // changes, options: not null (parameter default only)
+  override updateSource(
+    changes?: TokenDocument.UpdateData,
+    options?: DataModel.UpdateOptions,
+  ): TokenDocument.UpdateData;
 
   // TODO: Update with the Delta conditionality
-  toObject(source: true): this["_source"];
-  toObject(source?: boolean): ReturnType<this["schema"]["toObject"]>;
+  override toObject(source?: boolean | null): TokenDocument.Source;
 
   /**
-   * @remarks Migrates:
-   * - `actorData` to `delta`
+   * @remarks
+   * Migrations:
+   * - `actorData` to `delta` (since v11, no specified end)
    */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
   /**
-   * @remarks Shims:
-   * - `actorData` to `delta` since v11, until v13
-   * - `effects` to nothing since v12, until v14 ("TokenDocument#effects is deprecated in favor of using ActiveEffect documents on the associated Actor")
-   * - `overlayEffect` to nothing since v12, until v14 ("TokenDocument#overlayEffect is deprecated in favor of using ActiveEffect documents on the associated Actor")
+   * @remarks
+   * Shims:
+   * - `actorData` to `delta` (since v11, until v13)
+   * - `effects` to nothing (since v12, until v14)
+   *   - "`TokenDocument#effects` is deprecated in favor of using {@linkcode ActiveEffect} documents on the associated `Actor`")
+   * - `overlayEffect` to nothing (since v12, until v14)
+   *   - "`TokenDocument#overlayEffect` is deprecated in favor of using `ActiveEffect` documents on the associated `Actor`")
    */
+  // options: not null (destructured)
   static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
 
   /**
    * @deprecated since v12, until v14
-   * @remarks "TokenDocument#overlayEffect is deprecated in favor of using ActiveEffect documents on the associated Actor"
+   * @remarks "TokenDocument#overlayEffect is deprecated in favor of using {@linkcode ActiveEffect} documents on the associated Actor"
    */
   get effects(): [];
 
   /**
    * @deprecated since v12, until v14
-   * @remarks "TokenDocument# is deprecated in favor of using ActiveEffect documents on the associated Actor"
+   * @remarks "TokenDocument# is deprecated in favor of using {@linkcode ActiveEffect} documents on the associated Actor"
    */
   get overlayEffect(): "";
 
@@ -113,37 +125,37 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: TokenDocument.ParentCollectionName | null;
+  override readonly parentCollection: TokenDocument.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): TokenDocument.ImplementationClass;
 
-  static get baseDocument(): typeof BaseToken;
+  static override get baseDocument(): typeof BaseToken;
 
-  static get collectionName(): TokenDocument.ParentCollectionName;
+  static override get collectionName(): TokenDocument.ParentCollectionName;
 
-  static get documentName(): TokenDocument.Name;
+  static override get documentName(): TokenDocument.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(): TokenDocument.Hierarchy;
+  static override get hierarchy(): TokenDocument.Hierarchy;
 
   override parent: TokenDocument.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<TokenDocument.Implementation | TokenDocument.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<TokenDocument.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<TokenDocument.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: TokenDocument.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<TokenDocument.Database.Update>,
   ): Promise<TokenDocument.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<TokenDocument.Database.Delete>,
   ): Promise<TokenDocument.Implementation[]>;
@@ -174,7 +186,7 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
    * runtime, namely returning a `EmbeddedCollection` corresponding to a field in `BaseToken`'s
    * schema. However {@link TokenDocument.getEmbeddedCollection | `TokenDocument#getEmbeddedCollection`}
    * is overridden to add new cases and since `BaseToken` is a superclass it had to be widened to
-   * accomodate that.
+   * accommodate that.
    */
   override getEmbeddedCollection(embeddedName: TokenDocument.Embedded.CollectionName): Collection.Any;
 
@@ -224,68 +236,68 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.Schema, any
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: TokenDocument.CreateData,
     options: TokenDocument.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: TokenDocument.CreateData,
     options: TokenDocument.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: TokenDocument.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<TokenDocument.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: TokenDocument.Implementation[],
     operation: TokenDocument.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: TokenDocument.UpdateData,
     options: TokenDocument.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: TokenDocument.UpdateData,
     options: TokenDocument.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: TokenDocument.Implementation[],
     operation: TokenDocument.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: TokenDocument.Implementation[],
     operation: TokenDocument.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: TokenDocument.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: TokenDocument.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: TokenDocument.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: TokenDocument.Implementation[],
     operation: TokenDocument.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: TokenDocument.Implementation[],
     operation: TokenDocument.Database.Delete,
     user: User.Implementation,
@@ -293,50 +305,80 @@ declare abstract class BaseToken extends Document<"Token", BaseToken.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,
-    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: TokenDocument.Implementation[],
     context: Document.ModificationContext<TokenDocument.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: TokenDocument.Implementation[],
     context: Document.ModificationContext<TokenDocument.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: TokenDocument.Implementation[],
     context: Document.ModificationContext<TokenDocument.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<TokenDocument.Schema>;
+  protected static override _schema: SchemaField<TokenDocument.Schema>;
 
-  static get schema(): SchemaField<TokenDocument.Schema>;
+  static override get schema(): SchemaField<TokenDocument.Schema>;
 
-  static validateJoint(data: TokenDocument.Source): void;
+  static override validateJoint(data: TokenDocument.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: TokenDocument.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): TokenDocument.Implementation;
 
   static override fromJSON(json: string): TokenDocument.Implementation;
+
+  static #BaseToken: true;
 }
 
 /**
@@ -346,10 +388,11 @@ export class ActorDeltaField<
   DocumentType extends Document.AnyConstructor,
   Options extends fields.EmbeddedDocumentField.Options<DocumentType> = fields.EmbeddedDocumentField.DefaultOptions,
 > extends fields.EmbeddedDocumentField<DocumentType, Options> {
+  // options: not null (parameter default only)
   override initialize(
     value: fields.EmbeddedDocumentField.PersistedType<DocumentType, Options>,
     model: DataModel.Any,
-    options?: InexactPartial<DataModel.DataValidationOptions>,
+    options?: DataField.InitializeOptions,
   ):
     | fields.EmbeddedDocumentField.InitializedType<DocumentType, Options>
     | (() => fields.EmbeddedDocumentField.InitializedType<DocumentType, Options> | null);

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

@@ -1,4 +1,4 @@
-import type { 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 * as CONST from "../constants.mts";
@@ -26,23 +26,29 @@ declare abstract class BaseUser extends Document<"User", BaseUser.Schema, any> {
    */
   constructor(...args: User.ConstructorArgs);
 
-  static override metadata: User.Metadata;
-
-  static override defineSchema(): BaseUser.Schema;
-
   /**
-   * Validate the structure of the User hotbar object
-   * @param bar - The attempted hotbar data
-   * @internal
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "User",
+   *   collection: "users",
+   *   label: "DOCUMENT.User",
+   *   labelPlural: "DOCUMENT.Users",
+   *   permissions: {
+   *     create: this.#canCreate,
+   *     update: this.#canUpdate,
+   *     delete: this.#canDelete
+   *   },
+   *   schemaVersion: "12.324",
+   * });
+   * ```
    */
-  static #validateHotbar(bar: AnyObject): boolean;
+  static override metadata: User.Metadata;
 
-  /**
-   * Validate the structure of the User permissions object
-   * @param perms - The attempted permissions data
-   * @internal
-   */
-  static #validatePermissions(perms: AnyObject): boolean;
+  /** @defaultValue `["USER"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  static override defineSchema(): BaseUser.Schema;
 
   /**
    * A convenience test for whether this User has the NONE role.
@@ -57,14 +63,14 @@ declare abstract class BaseUser extends Document<"User", BaseUser.Schema, any> {
   /**
    * Test whether the User is able to perform a certain permission action.
    * The provided permission string may pertain to an explicit permission setting or a named user role.
-   * Alternatively, Gamemaster users are assumed to be allowed to take all actions.
    *
    * @param action - The action to test
    * @returns Does the user have the ability to perform this action?
    */
-  can(action: keyof typeof CONST.USER_PERMISSIONS | CONST.USER_ROLE_NAMES | CONST.USER_ROLES): boolean;
+  can(action: BaseUser.ActionPermission): boolean;
 
-  override getUserLevel(user?: User.Internal.Implementation): CONST.DOCUMENT_OWNERSHIP_LEVELS | null;
+  /** @remarks Returns `.OWNER` for the User in question, `.NONE` for everyone else */
+  override getUserLevel(user?: User.Internal.Implementation | null): CONST.DOCUMENT_OWNERSHIP_LEVELS;
 
   /**
    * Test whether the User has at least a specific permission
@@ -78,34 +84,8 @@ declare abstract class BaseUser extends Document<"User", BaseUser.Schema, any> {
    * @param role - The role name from USER_ROLES to test
    * @returns Does the user have at this role level (or greater)?
    */
-  hasRole(role: CONST.USER_ROLE_NAMES | CONST.USER_ROLES, { exact }?: User.HasRoleOptions): boolean;
-
-  /**
-   * Is a user able to create an existing User?
-   * @param user - The user attempting the creation.
-   * @param doc  - The User document being created.
-   * @param data - The supplied creation data.
-   * @internal
-   */
-  static #canCreate(user: User.Implementation, doc: BaseUser, data?: BaseUser.CreateData): boolean;
-
-  /**
-   * Is a user able to update an existing User?
-   * @param user    - The user attempting the update.
-   * @param doc     - The User document being updated.
-   * @param changes - Proposed changes.
-   * @internal
-   */
-  static #canUpdate(user: User.Implementation, doc: BaseUser, changes: BaseUser.CreateData): boolean;
-
-  /**
-   * Is a user able to delete an existing User?
-   * Only Assistants and Gamemasters can delete users, and only if the target user has a lesser or equal role.
-   * @param user - The user attempting the deletion.
-   * @param doc  - The User document being deleted.
-   * @internal
-   */
-  static #canDelete(user: User.Implementation, doc: BaseUser): boolean;
+  // options: not null (destructured)
+  hasRole(role: CONST.USER_ROLE_NAMES | CONST.USER_ROLES, options?: BaseUser.HasRoleOptions): boolean;
 
   /*
    * After this point these are not really overridden methods.
@@ -124,37 +104,37 @@ declare abstract class BaseUser extends Document<"User", BaseUser.Schema, any> {
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: User.ParentCollectionName | null;
+  override readonly parentCollection: User.ParentCollectionName | null;
 
-  readonly pack: null;
+  override readonly pack: null;
 
-  static get implementation(): User.ImplementationClass;
+  static override get implementation(): User.ImplementationClass;
 
-  static get baseDocument(): typeof BaseUser;
+  static override get baseDocument(): typeof BaseUser;
 
-  static get collectionName(): User.ParentCollectionName;
+  static override get collectionName(): User.ParentCollectionName;
 
-  static get documentName(): User.Name;
+  static override get documentName(): User.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(): User.Hierarchy;
+  static override get hierarchy(): User.Hierarchy;
 
   override parent: User.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<User.Implementation | User.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<User.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<User.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: User.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<User.Database.Update>,
   ): Promise<User.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<User.Database.Delete>,
   ): Promise<User.Implementation[]>;
@@ -171,7 +151,7 @@ declare abstract class BaseUser extends Document<"User", BaseUser.Schema, any> {
 
   override delete(operation?: User.Database.DeleteOperation): Promise<this | undefined>;
 
-  static get(documentId: string, options?: User.Database.GetOptions): User.Implementation | null;
+  static override get(documentId: string, options?: User.Database.GetOptions): User.Implementation | null;
 
   static override getCollectionName(name: string): null;
 
@@ -194,112 +174,143 @@ declare abstract class BaseUser extends Document<"User", BaseUser.Schema, any> {
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: User.CreateData,
     options: User.Database.PreCreateOptions,
     user: User.Internal.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(data: User.CreateData, options: User.Database.OnCreateOperation, userId: string): void;
+  protected override _onCreate(data: User.CreateData, options: User.Database.OnCreateOperation, userId: string): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: User.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<User.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: User.Implementation[],
     operation: User.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: User.UpdateData,
     options: User.Database.PreUpdateOptions,
     user: User.Internal.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(changed: User.UpdateData, options: User.Database.OnUpdateOperation, userId: string): void;
+  protected override _onUpdate(
+    changed: User.UpdateData,
+    options: User.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: User.Implementation[],
     operation: User.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: User.Implementation[],
     operation: User.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: User.Database.PreDeleteOptions,
     user: User.Internal.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: User.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: User.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: User.Implementation[],
     operation: User.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: User.Implementation[],
     operation: User.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.
-  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: User.Implementation[],
     context: Document.ModificationContext<User.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: User.Implementation[],
     context: Document.ModificationContext<User.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: User.Implementation[],
     context: Document.ModificationContext<User.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<User.Schema>;
+  protected static override _schema: SchemaField<User.Schema>;
 
-  static get schema(): SchemaField<User.Schema>;
+  static override get schema(): SchemaField<User.Schema>;
 
-  static validateJoint(data: User.Source): void;
+  static override validateJoint(data: User.Source): void;
 
-  static override fromSource(
-    source: User.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
-  ): User.Implementation;
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(source: User.CreateData, context?: DataModel.FromSourceOptions): User.Implementation;
 
   static override fromJSON(json: string): User.Implementation;
+
+  static #BaseUser: true;
 }
 
 export default BaseUser;
@@ -330,7 +341,7 @@ declare namespace BaseUser {
   export import PingData = User.PingData;
   export import ActivityData = User.ActivityData;
   export import HasRoleOptions = User.HasRoleOptions;
-
+  export import ActionPermission = User.ActionPermission;
   /**
    * @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