@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

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

@@ -1,10 +1,9 @@
-import type { 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 * as fields from "../data/fields.d.mts";
-import type BaseActor from "./actor.mts";
-
-type DataSchema = foundry.data.fields.DataSchema;
+import type { DataField, SchemaField } from "../data/fields.d.mts";
+import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
 /**
  * The User Document.
@@ -13,33 +12,43 @@ type DataSchema = foundry.data.fields.DataSchema;
 // Note(LukeAbby): You may wonder why documents don't simply pass the `Parent` generic parameter.
 // This pattern evolved from trying to avoid circular loops and even internal tsc errors.
 // See: https://gist.github.com/LukeAbby/0d01b6e20ef19ebc304d7d18cef9cc21
-declare class BaseUser extends Document<"User", BaseUser.Schema, any> {
+declare abstract class BaseUser extends Document<"User", BaseUser.Schema, any> {
   /**
-   * @param data    - Initial data from which to construct the User
+   * @param data    - Initial data from which to construct the `BaseUser`
    * @param context - Construction context options
+   *
+   * @remarks Constructing `BaseUser` directly is not advised. The base document classes exist in
+   * order to use documents on both the client (i.e. where all your code runs) and behind the scenes
+   * on the server to manage document validation and storage.
+   *
+   * You should use {@link User.implementation | `new User.implementation(...)`} instead which will give you
+   * a system specific implementation of `User`.
    */
-  // TODO(LukeAbby): This constructor is a symptom of a circular error.
-  // constructor(data: BaseUser.ConstructorData, context?: BaseUser.Parent);
-
-  override parent: BaseUser.Parent;
-
-  static override metadata: Readonly<Document.MetadataFor<BaseUser>>;
-
-  static override defineSchema(): BaseUser.Schema;
+  constructor(data: User.CreateData, context?: User.ConstructionContext);
 
   /**
-   * 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: "13.341",
+   * });
+   * ```
    */
-  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 `["DOCUMENT", "USER"]` */
+  static override LOCALIZATION_PREFIXES: string[];
+
+  static override defineSchema(): BaseUser.Schema;
 
   /**
    * A convenience test for whether this User has the NONE role.
@@ -54,14 +63,14 @@ declare 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): CONST.DOCUMENT_OWNERSHIP_LEVELS | null;
+  /** @remarks Returns `.OWNER` for the User in question, `.NONE` for everyone else */
+  override getUserLevel(user: User.Internal.Implementation): CONST.DOCUMENT_OWNERSHIP_LEVELS;
 
   /**
    * Test whether the User has at least a specific permission
@@ -75,166 +84,269 @@ declare 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,
-    }?: {
-      /**
-       * Require the role match to be exact
-       * @defaultValue `false`
-       */
-      exact?: 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.
+   * They are here because Foundry's documents are complex and have lots of edge cases.
+   * There are DRY ways of representing this but this ends up being harder to understand
+   * for end users extending these functions, especially for static methods. There are also a
+   * number of methods that don't make sense to call directly on `Document` like `createDocuments`,
+   * as there is no data that can safely construct every possible document. Finally keeping definitions
+   * separate like this helps against circularities.
+   */
+
+  /* Document overrides */
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any], void, undefined>;
+
+  override readonly parentCollection: User.ParentCollectionName | null;
+
+  override readonly pack: null;
+
+  static override get implementation(): User.ImplementationClass;
+
+  static override get baseDocument(): typeof BaseUser;
+
+  static override get collectionName(): User.ParentCollectionName;
+
+  static override get documentName(): User.Name;
+
+  static override get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+
+  static override get hasTypeData(): undefined;
+
+  static override get hierarchy(): User.Hierarchy;
+
+  override parent: User.Parent;
+
+  static override createDocuments<Temporary extends boolean | undefined = undefined>(
+    data: Array<User.Implementation | User.CreateData> | undefined,
+    operation?: Document.Database.CreateOperation<User.Database.Create<Temporary>>,
+  ): Promise<Array<Document.TemporaryIf<User.Implementation, Temporary>>>;
+
+  static override updateDocuments(
+    updates: User.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<User.Database.Update>,
+  ): Promise<User.Implementation[]>;
+
+  static override deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: Document.Database.DeleteDocumentsOperation<User.Database.Delete>,
+  ): Promise<User.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = undefined>(
+    data: User.CreateData | User.CreateData[],
+    operation?: User.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<User.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: User.UpdateData | undefined,
+    operation?: User.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: User.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(documentId: string, options?: User.Database.GetOptions): User.Implementation | null;
+
+  static override getCollectionName(name: string): null;
+
+  // Same as Document for now
+  override traverseEmbeddedDocuments(
+    _parentPath?: string,
+  ): Generator<[string, Document.AnyChild<this>], void, undefined>;
+
+  override getFlag<Scope extends User.Flags.Scope, Key extends User.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<User.Name, Scope, Key>;
+
+  override setFlag<
+    Scope extends User.Flags.Scope,
+    Key extends User.Flags.Key<Scope>,
+    Value extends Document.GetFlag<User.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
+
+  override unsetFlag<Scope extends User.Flags.Scope, Key extends User.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Promise<this>;
+
+  protected override _preCreate(
+    data: User.CreateData,
+    options: User.Database.PreCreateOptions,
+    user: User.Internal.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onCreate(data: User.CreateData, options: User.Database.OnCreateOperation, userId: string): void;
+
+  protected static override _preCreateOperation(
+    documents: User.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<User.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onCreateOperation(
+    documents: User.Implementation[],
+    operation: User.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preUpdate(
+    changed: User.UpdateData,
+    options: User.Database.PreUpdateOptions,
+    user: User.Internal.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onUpdate(
+    changed: User.UpdateData,
+    options: User.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preUpdateOperation(
+    documents: User.Implementation[],
+    operation: User.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onUpdateOperation(
+    documents: User.Implementation[],
+    operation: User.Database.Update,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preDelete(
+    options: User.Database.PreDeleteOptions,
+    user: User.Internal.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onDelete(options: User.Database.OnDeleteOperation, userId: string): void;
+
+  protected static override _preDeleteOperation(
+    documents: User.Implementation[],
+    operation: User.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onDeleteOperation(
+    documents: User.Implementation[],
+    operation: User.Database.Delete,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  // These data field things have been ticketed but will probably go into backlog hell for a while.
+
+  // 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: AnyMutableObject) => unknown) | null,
   ): boolean;
 
+  // options: not null (destructured where forwarded)
+  protected static override _logDataFieldMigration(
+    oldKey: string,
+    newKey: string,
+    options?: LogCompatibilityWarningOptions,
+  ): void;
+
   /**
-   * 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
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onCreateDocuments` static method is deprecated in favor of {@link Document._onCreateOperation | `Document._onCreateOperation`}"
    */
-  static #canCreate(user: User, doc: BaseUser, data?: BaseUser.ConstructorData): boolean;
+  protected static override _onCreateDocuments(
+    documents: User.Implementation[],
+    context: Document.ModificationContext<User.Parent>,
+  ): Promise<void>;
 
   /**
-   * 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
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onUpdateDocuments` static method is deprecated in favor of {@link Document._onUpdateOperation | `Document._onUpdateOperation`}"
    */
-  static #canUpdate(user: User, doc: BaseUser, changes: BaseUser.ConstructorData): boolean;
+  protected static override _onUpdateDocuments(
+    documents: User.Implementation[],
+    context: Document.ModificationContext<User.Parent>,
+  ): Promise<void>;
 
   /**
-   * 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
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onDeleteDocuments` static method is deprecated in favor of {@link Document._onDeleteOperation | `Document._onDeleteOperation`}"
    */
-  static #canDelete(user: User, doc: BaseUser): boolean;
+  protected static override _onDeleteDocuments(
+    documents: User.Implementation[],
+    context: Document.ModificationContext<User.Parent>,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static override _schema: SchemaField<User.Schema>;
+
+  static override get schema(): SchemaField<User.Schema>;
+
+  static override validateJoint(data: User.Source): void;
+
+  // 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;
 
 declare namespace BaseUser {
-  type Parent = null;
-
-  type Metadata = Document.MetadataFor<BaseUser>;
-
-  type Hotbar = Record<number | `${number}`, string>;
-  type Permissions = Record<keyof typeof CONST.USER_PERMISSIONS, boolean>;
-
-  type SchemaField = fields.SchemaField<Schema>;
-  type ConstructorData = fields.SchemaField.InnerConstructorType<Schema>;
-  type UpdateData = fields.SchemaField.InnerAssignmentType<Schema>;
-  type Properties = fields.SchemaField.InnerInitializedType<Schema>;
-  type Source = fields.SchemaField.InnerPersistedType<Schema>;
-
-  interface Schema extends DataSchema {
-    /**
-     * The _id which uniquely identifies this User document.
-     * @defaultValue `null`
-     */
-    _id: fields.DocumentIdField;
-
-    /**
-     * The user's name.
-     */
-    name: fields.StringField<{ required: true; blank: false; textSearch: true }, string>;
-
-    /**
-     * The user's role, see CONST.USER_ROLES.
-     * @defaultValue `CONST.USER_ROLES.PLAYER`
-     */
-    role: fields.NumberField<
-      {
-        required: true;
-        choices: CONST.USER_ROLES[];
-        initial: typeof CONST.USER_ROLES.PLAYER;
-        readonly: true;
-      },
-      CONST.USER_ROLES | null | undefined,
-      CONST.USER_ROLES,
-      CONST.USER_ROLES
-    >;
-
-    /**
-     * The user's password. Available only on the Server side for security.
-     * @defaultValue `""`
-     */
-    password: fields.StringField<{ required: true; blank: true }>;
-
-    /**
-     * The user's password salt. Available only on the Server side for security.
-     * @defaultValue `""`
-     */
-    passwordSalt: fields.StringField;
-
-    /**
-     * The user's avatar image.
-     * @defaultValue `null`
-     */
-    avatar: fields.FilePathField<{ categories: "IMAGE"[] }>;
-
-    /**
-     * A linked Actor document that is this user's impersonated character.
-     * @defaultValue `null`
-     */
-    character: fields.ForeignDocumentField<typeof BaseActor>;
-
-    /**
-     * A color to represent this user.
-     * @defaultValue a randomly chosen color string
-     */
-    color: fields.ColorField<{ required: true; nullable: false; initial: () => string }>;
-
-    /**
-     *
-     */
-    pronouns: fields.StringField<{ required: true }>;
-
-    /**
-     * A mapping of hotbar slot number to Macro id for the user.
-     * @defaultValue `{}`
-     */
-    hotbar: fields.ObjectField<
-      {
-        required: true;
-        validate: (bar: AnyObject) => boolean;
-        validationError: "must be a mapping of slots to macro identifiers";
-      },
-      Hotbar | null | undefined,
-      Hotbar,
-      Hotbar
-    >;
-
-    /**
-     * The user's individual permission configuration, see CONST.USER_PERMISSIONS.
-     * @defaultValue `{}`
-     */
-    permissions: fields.ObjectField<
-      {
-        required: true;
-        validate: (perms: AnyObject) => boolean;
-        validationError: "must be a mapping of permission names to booleans";
-      },
-      InexactPartial<Permissions> | null | undefined,
-      InexactPartial<Permissions>,
-      InexactPartial<Permissions>
-    >;
-
-    /**
-     * An object of optional key/value flags.
-     * @defaultValue `{}`
-     */
-    flags: fields.ObjectField.FlagsField<"User">;
-
-    /**
-     * An object of creation and access information
-     * @defaultValue see {@link fields.DocumentStatsField}
-     */
-    _stats: fields.DocumentStatsField;
+  export import Name = User.Name;
+  export import ConstructionContext = User.ConstructionContext;
+  export import ConstructorArgs = User.ConstructorArgs;
+  export import Hierarchy = User.Hierarchy;
+  export import Metadata = User.Metadata;
+  export import Parent = User.Parent;
+  export import Descendant = User.Descendant;
+  export import DescendantClass = User.DescendantClass;
+  export import Pack = User.Pack;
+  export import Embedded = User.Embedded;
+  export import ParentCollectionName = User.ParentCollectionName;
+  export import CollectionClass = User.CollectionClass;
+  export import Collection = User.Collection;
+  export import Invalid = User.Invalid;
+  export import Stored = User.Stored;
+  export import Source = User.Source;
+  export import CreateData = User.CreateData;
+  export import InitializedData = User.InitializedData;
+  export import UpdateData = User.UpdateData;
+  export import Schema = User.Schema;
+  export import DatabaseOperation = User.Database;
+  export import Flags = User.Flags;
+  export import PingData = User.PingData;
+  export import ActivityData = User.ActivityData;
+  export import HasRoleOptions = User.HasRoleOptions;
+  export import ActionPermission = User.ActionPermission;
+
+  namespace Internal {
+    // Note(LukeAbby): The point of this is to give the base class of `User` a name.
+    // The expression `ClientDocumentMixin(BaseUser)` is more intuitive but it has worse
+    // caching, likely due to the majority of tsc's caching working off of names.
+    // See https://gist.github.com/LukeAbby/18a928fdc35c5d54dc121ed5dbf412fd.
+    interface ClientDocument extends foundry.documents.abstract.ClientDocumentMixin.Mix<typeof BaseUser> {}
+    const ClientDocument: ClientDocument;
   }
 }