fvtt-types/src/foundry/client/documents/table-result.d.mts

TypeScript type definitions for Foundry VTT

import type { ConfiguredTableResult } from "#configuration";
import type { Identity, InexactPartial, Merge } from "#utils";
import type Document from "#common/abstract/document.d.mts";
import type { DataSchema } from "#common/data/fields.d.mts";
import type BaseTableResult from "#common/documents/table-result.d.mts";

import fields = foundry.data.fields;

declare namespace TableResult {
  /**
   * The document's name.
   */
  type Name = "TableResult";

  /**
   * The context used to create a `TableResult`.
   */
  interface ConstructionContext extends Document.ConstructionContext<Parent> {}

  /**
   * The documents embedded within `TableResult`.
   */
  type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;

  /**
   * The implementation of the `TableResult` document instance configured through `CONFIG.TableResult.documentClass` in Foundry and
   * {@linkcode DocumentClassConfig} or {@link ConfiguredTableResult | `fvtt-types/configuration/ConfiguredTableResult`} in fvtt-types.
   */
  type Implementation = Document.ImplementationFor<Name>;

  /**
   * The implementation of the `TableResult` document configured through `CONFIG.TableResult.documentClass` in Foundry and
   * {@linkcode DocumentClassConfig} in fvtt-types.
   */
  type ImplementationClass = Document.ImplementationClassFor<Name>;

  /**
   * A document's metadata is special information about the document ranging anywhere from its name,
   * whether it's indexed, or to the permissions a user has over it.
   */
  interface Metadata
    extends Merge<
      Document.Metadata.Default,
      Readonly<{
        name: "TableResult";
        collection: "results";
        label: string;
        labelPlural: string;
        coreTypes: foundry.CONST.TABLE_RESULT_TYPES[];
        permissions: Metadata.Permissions;
        compendiumIndexFields: ["type"];
        schemaVersion: string;
      }>
    > {}

  namespace Metadata {
    /**
     * The permissions for whether a certain user can create, update, or delete this document.
     */
    interface Permissions {
      create: "OWNER";
      update(user: User.Internal.Implementation, doc: Implementation, data: UpdateData): boolean;
      delete: "OWNER";
    }
  }

  /**
   * The subtypes of `TableResult` that Foundry provides. `TableResult` does not have `system` and therefore
   * there is no way for a user to configure custom subtypes. Nevertheless Foundry has a number of
   * built in subtypes usable for `TableResult`.
   */
  type SubType = foundry.Game.Model.TypeNames<Name>;

  /**
   * @deprecated `TableResult` does not have `system` and therefore there is no way for a user to
   * configure custom subtypes.
   *
   * This type exists only to be informative.
   */
  type ConfiguredSubType = never;

  /**
   * @deprecated `TableResult` does not have `system` and therefore there is no way for a user to
   * configure custom subtypes. This means `Known` as a concept does not apply to it.
   *
   * This type exists only to be informative.
   */
  type Known = never;

  /**
   * `OfType` returns an instance of `TableResult` with the corresponding type. This works with both the
   * builtin `TableResult` class or a custom subclass if that is set up in
   * {@link ConfiguredTableResult | `fvtt-types/configuration/ConfiguredTableResult`}.
   *
   * Note that `TableResult` does not have a `system` property and therefore there is no way for a user
   * to configure custom subtypes. See {@linkcode TableResult.SubType} for more information.
   */
  // Note(LukeAbby): The lack of a `system` is why `Document.Internal.DiscriminateSystem` isn't applied.
  type OfType<Type extends SubType> = _OfType[Type];

  /** @internal */
  interface _OfType
    extends Identity<{
      [Type in SubType]: Type extends unknown
        ? ConfiguredTableResult<Type> extends { document: infer Document }
          ? Document
          : // eslint-disable-next-line @typescript-eslint/no-restricted-types
            TableResult<Type>
        : never;
    }> {}

  /**
   * A document's parent is something that can contain it.
   * For example an `Item` can be contained by an `Actor` which makes `Actor` one of its possible parents.
   */
  type Parent = RollTable.Implementation | null;

  /**
   * A document's descendants are any child documents, grandchild documents, etc.
   * This is a union of all instances, or never if the document doesn't have any descendants.
   */
  type Descendant = never;

  /**
   * A document's descendants are any child documents, grandchild documents, etc.
   * This is a union of all classes, or never if the document doesn't have any descendants.
   */
  type DescendantClass = never;

  /**
   * Types of `CompendiumCollection` this document might be contained in.
   * Note that `this.pack` will always return a string; this is the type for `game.packs.get(this.pack)`
   *
   * Will be `never` if cannot be contained in a `CompendiumCollection`.
   */
  type Pack = foundry.documents.collections.CompendiumCollection.ForDocument<"RollTable">;

  /**
   * An embedded document is a document contained in another.
   * For example an `Item` can be contained by an `Actor` which means `Item` can be embedded in `Actor`.
   *
   * If this is `never` it is because there are no embeddable documents (or there's a bug!).
   */
  type Embedded = never;

  /**
   * The name of the world or embedded collection this document can find itself in.
   * For example an `Item` is always going to be inside a collection with a key of `items`.
   * This is a fixed string per document type and is primarily useful for {@link ClientDocumentMixin | `Descendant Document Events`}.
   */
  type ParentCollectionName = Metadata["collection"];

  /**
   * The world collection that contains this document type. Will be `never` if none exists.
   */
  type CollectionClass = never;

  /**
   * The world collection that contains this document type. Will be `never` if none exists.
   */
  type Collection = never;

  /**
   * An instance of `TableResult` that comes from the database but failed validation meaning that
   * its `system` and `_source` could theoretically be anything.
   */
  type Invalid<SubType extends TableResult.SubType = TableResult.SubType> = Document.Internal.Invalid<OfType<SubType>>;

  /**
   * An instance of `TableResult` that comes from the database.
   */
  type Stored<SubType extends TableResult.SubType = TableResult.SubType> = Document.Internal.Stored<OfType<SubType>>;

  /**
   * The data put in {@link TableResult._source | `TableResult#_source`}. This data is what was
   * persisted to the database and therefore it must be valid JSON.
   *
   * For example a {@link fields.SetField | `SetField`} is persisted to the database as an array
   * but initialized as a {@linkcode Set}.
   */
  interface Source extends fields.SchemaField.SourceData<Schema> {}

  /**
   * The data necessary to create a document. Used in places like {@linkcode TableResult.create}
   * and {@link TableResult | `new TableResult(...)`}.
   *
   * For example a {@link fields.SetField | `SetField`} can accept any {@linkcode Iterable}
   * with the right values. This means you can pass a `Set` instance, an array of values,
   * a generator, or any other iterable.
   */
  interface CreateData extends fields.SchemaField.CreateData<Schema> {}

  /**
   * The data after a {@link foundry.abstract.Document | `Document`} has been initialized, for example
   * {@link TableResult.name | `TableResult#name`}.
   *
   * This is data transformed from {@linkcode TableResult.Source} and turned into more
   * convenient runtime data structures. For example a {@link fields.SetField | `SetField`} is
   * persisted to the database as an array of values but at runtime it is a `Set` instance.
   */
  interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}

  /**
   * The data used to update a document, for example {@link TableResult.update | `TableResult#update`}.
   * It is a distinct type from {@link TableResult.CreateData | `DeepPartial<TableResult.CreateData>`} because
   * it has different rules for `null` and `undefined`.
   */
  interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}

  /**
   * The schema for {@linkcode TableResult}. This is the source of truth for how an TableResult document
   * must be structured.
   *
   * Foundry uses this schema to validate the structure of the {@linkcode TableResult}. For example
   * a {@link fields.StringField | `StringField`} will enforce that the value is a string. More
   * complex fields like {@link fields.SetField | `SetField`} goes through various conversions
   * starting as an array in the database, initialized as a set, and allows updates with any
   * iterable.
   */
  interface Schema extends DataSchema {
    /**
     * The _id which uniquely identifies this TableResult embedded document
     * @defaultValue `null`
     */
    _id: fields.DocumentIdField;

    /**
     * A result subtype from CONST.TABLE_RESULT_TYPES
     * @defaultValue `CONST.TABLE_RESULT_TYPES.TEXT`
     */
    type: fields.DocumentTypeField<
      typeof BaseTableResult,
      {
        initial: typeof CONST.TABLE_RESULT_TYPES.TEXT;
      }
    >;

    /**
     * @defaultValue `""`
     */
    name: fields.StringField<{ required: true; nullable: false; blank: true; initial: ""; textSearch: true }>;

    /**
     * An image file url that represents the table result
     * @defaultValue `null`
     */
    img: fields.FilePathField<{ categories: ["IMAGE"] }>;

    /**
     * @defaultValue `""`
     */
    description: fields.HTMLField<{ textSearch: true }>;

    /**
     * @defaultValue `undefined`
     */
    documentUuid: fields.DocumentUUIDField<{ required: false; nullable: true; initial: undefined }>;

    /**
     * The probabilistic weight of this result relative to other results
     * @defaultValue `1`
     */
    weight: fields.NumberField<{ required: true; integer: true; positive: true; nullable: false; initial: 1 }>;

    /**
     * A length 2 array of ascending integers which defines the range of dice roll
     * @defaultValue `[]`
     */
    range: fields.ArrayField<
      fields.NumberField<{ integer: true }>,
      {
        min: 2;
        max: 2;
        validate: (r: unknown) => r is [start: number, end: number];
        validationError: "must be a length-2 array of ascending integers";
      },
      [start: number, end: number],
      [start: number, end: number],
      [start: number, end: number]
    >;

    /**
     * Has this result already been drawn (without replacement)
     * @defaultValue `false`
     */
    drawn: fields.BooleanField;

    /**
     * An object of optional key/value flags
     * @defaultValue `{}`
     */
    flags: fields.DocumentFlagsField<Name>;

    _stats: fields.DocumentStatsField;
  }

  namespace Database {
    /** Options passed along in Get operations for TableResults */
    interface Get extends foundry.abstract.types.DatabaseGetOperation<TableResult.Parent> {}

    /** Options passed along in Create operations for TableResults */
    interface Create<Temporary extends boolean | undefined = boolean | undefined>
      extends foundry.abstract.types.DatabaseCreateOperation<TableResult.CreateData, TableResult.Parent, Temporary> {
      animate?: boolean;
    }

    /** Options passed along in Delete operations for TableResults */
    interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<TableResult.Parent> {
      animate?: boolean;
    }

    /** Options passed along in Update operations for TableResults */
    interface Update
      extends foundry.abstract.types.DatabaseUpdateOperation<TableResult.UpdateData, TableResult.Parent> {
      animate?: boolean;
    }

    /** Operation for {@linkcode TableResult.createDocuments} */
    interface CreateDocumentsOperation<Temporary extends boolean | undefined>
      extends Document.Database.CreateOperation<TableResult.Database.Create<Temporary>> {}

    /** Operation for {@linkcode TableResult.updateDocuments} */
    interface UpdateDocumentsOperation
      extends Document.Database.UpdateDocumentsOperation<TableResult.Database.Update> {}

    /** Operation for {@linkcode TableResult.deleteDocuments} */
    interface DeleteDocumentsOperation
      extends Document.Database.DeleteDocumentsOperation<TableResult.Database.Delete> {}

    /** Operation for {@linkcode TableResult.create} */
    interface CreateOperation<Temporary extends boolean | undefined>
      extends Document.Database.CreateOperation<TableResult.Database.Create<Temporary>> {}

    /** Operation for {@link TableResult.update | `TableResult#update`} */
    interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}

    interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}

    /** Options for {@linkcode TableResult.get} */
    interface GetOptions extends Document.Database.GetOptions {}

    /** Options for {@link TableResult._preCreate | `TableResult#_preCreate`} */
    interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}

    /** Options for {@link TableResult._onCreate | `TableResult#_onCreate`} */
    interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}

    /** Operation for {@linkcode TableResult._preCreateOperation} */
    interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<TableResult.Database.Create> {}

    /** Operation for {@link TableResult._onCreateOperation | `TableResult#_onCreateOperation`} */
    interface OnCreateOperation extends TableResult.Database.Create {}

    /** Options for {@link TableResult._preUpdate | `TableResult#_preUpdate`} */
    interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}

    /** Options for {@link TableResult._onUpdate | `TableResult#_onUpdate`} */
    interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}

    /** Operation for {@linkcode TableResult._preUpdateOperation} */
    interface PreUpdateOperation extends TableResult.Database.Update {}

    /** Operation for {@link TableResult._onUpdateOperation | `TableResult._preUpdateOperation`} */
    interface OnUpdateOperation extends TableResult.Database.Update {}

    /** Options for {@link TableResult._preDelete | `TableResult#_preDelete`} */
    interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}

    /** Options for {@link TableResult._onDelete | `TableResult#_onDelete`} */
    interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}

    /** Options for {@link TableResult._preDeleteOperation | `TableResult#_preDeleteOperation`} */
    interface PreDeleteOperation extends TableResult.Database.Delete {}

    /** Options for {@link TableResult._onDeleteOperation | `TableResult#_onDeleteOperation`} */
    interface OnDeleteOperation extends TableResult.Database.Delete {}

    /** Context for {@linkcode TableResult._onDeleteOperation} */
    interface OnDeleteDocumentsContext extends Document.ModificationContext<TableResult.Parent> {}

    /** Context for {@linkcode TableResult._onCreateDocuments} */
    interface OnCreateDocumentsContext extends Document.ModificationContext<TableResult.Parent> {}

    /** Context for {@linkcode TableResult._onUpdateDocuments} */
    interface OnUpdateDocumentsContext extends Document.ModificationContext<TableResult.Parent> {}

    /**
     * Options for {@link TableResult._preCreateDescendantDocuments | `TableResult#_preCreateDescendantDocuments`}
     * and {@link TableResult._onCreateDescendantDocuments | `TableResult#_onCreateDescendantDocuments`}
     */
    interface CreateOptions extends Document.Database.CreateOptions<TableResult.Database.Create> {}

    /**
     * Options for {@link TableResult._preUpdateDescendantDocuments | `TableResult#_preUpdateDescendantDocuments`}
     * and {@link TableResult._onUpdateDescendantDocuments | `TableResult#_onUpdateDescendantDocuments`}
     */
    interface UpdateOptions extends Document.Database.UpdateOptions<TableResult.Database.Update> {}

    /**
     * Options for {@link TableResult._preDeleteDescendantDocuments | `TableResult#_preDeleteDescendantDocuments`}
     * and {@link TableResult._onDeleteDescendantDocuments | `TableResult#_onDeleteDescendantDocuments`}
     */
    interface DeleteOptions extends Document.Database.DeleteOptions<TableResult.Database.Delete> {}

    /**
     * Create options for {@linkcode TableResult.createDialog}.
     */
    interface DialogCreateOptions extends InexactPartial<Create> {}
  }

  /**
   * If `Temporary` is true then `TableResult.Implementation`, otherwise `TableResult.Stored`.
   */
  type TemporaryIf<Temporary extends boolean | undefined> = true extends Temporary
    ? TableResult.Implementation
    : TableResult.Stored;

  /**
   * The flags that are available for this document in the form `{ [scope: string]: { [key: string]: unknown } }`.
   */
  interface Flags extends Document.Internal.ConfiguredFlagsForName<Name> {}

  namespace Flags {
    /**
     * The valid scopes for the flags on this document e.g. `"core"` or `"dnd5e"`.
     */
    type Scope = Document.Internal.FlagKeyOf<Flags>;

    /**
     * The valid keys for a certain scope for example if the scope is "core" then a valid key may be `"sheetLock"` or `"viewMode"`.
     */
    type Key<Scope extends Flags.Scope> = Document.Internal.FlagKeyOf<Document.Internal.FlagGetKey<Flags, Scope>>;

    /**
     * Gets the type of a particular flag given a `Scope` and a `Key`.
     */
    type Get<Scope extends Flags.Scope, Key extends Flags.Key<Scope>> = Document.Internal.GetFlag<Flags, Scope, Key>;
  }

  interface DropData extends Document.Internal.DropData<Name> {}
  interface DropDataOptions extends Document.DropDataOptions {}

  interface DefaultNameContext extends Document.DefaultNameContext<Name, NonNullable<Parent>> {}

  interface CreateDialogData extends Document.CreateDialogData<CreateData> {}
  interface CreateDialogOptions extends Document.CreateDialogOptions<Name> {}

  /**
   * The arguments to construct the document.
   *
   * @deprecated Writing the signature directly has helped reduce circularities and therefore is
   * now recommended.
   */
  // eslint-disable-next-line @typescript-eslint/no-deprecated
  type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;

  /**
   * @deprecated Replaced with {@linkcode TableResult.ConfiguredSubType} (will be removed in v14).
   */
  // eslint-disable-next-line @typescript-eslint/no-deprecated
  type ConfiguredSubTypes = ConfiguredSubType;
}

/**
 * The client-side TableResult document which extends the common BaseTableResult model.
 *
 * @see {@linkcode RollTable}         The RollTable document which contains TableResult embedded documents
 */
declare class TableResult<out SubType extends TableResult.SubType = TableResult.SubType> extends foundry.documents
  .BaseTableResult.Internal.ClientDocument<SubType> {
  /**
   * @param data    - Initial data from which to construct the `TableResult`
   * @param context - Construction context options
   */
  constructor(data: TableResult.CreateData, context?: TableResult.ConstructionContext);

  /**
   * A path reference to the icon image used to represent this result
   * @remarks Returns {@linkcode CONFIG.RollTable.resultIcon} if `this.img` is falsey
   */
  get icon(): string;

  /** @remarks Overrides `this.img` with the `img` of the associated Document, if this result is a `document` or `compendium` type */
  override prepareBaseData(): void;

  /**
   * Prepare a string representation for this result.
   */
  getHTML: Promise<string>;

  /**
   * Create a content-link anchor from this Result's referenced Document.
   */
  documentToAnchor(): HTMLAnchorElement | null;

  // _preUpdate is overridden but with no signature changes.

  /**
   * @deprecated since V13 until V15
   */
  getChatText(): string;

  /*
   * 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.
   */

  // ClientDocument overrides

  // Descendant Document operations have been left out because TableResult does not have any descendant documents.

  /** @remarks `context` must contain a `pack` or `parent`. */
  static override defaultName(context: TableResult.DefaultNameContext): string;

  /** @remarks `createOptions` must contain a `pack` or `parent`. */
  static override createDialog(
    data: TableResult.CreateDialogData | undefined,
    createOptions: TableResult.Database.DialogCreateOptions,
    options?: TableResult.CreateDialogOptions,
  ): Promise<TableResult.Stored | null | undefined>;

  override deleteDialog(
    options?: InexactPartial<foundry.applications.api.DialogV2.ConfirmConfig>,
    operation?: Document.Database.DeleteOperationForName<"TableResult">,
  ): Promise<this | false | null | undefined>;

  static override fromDropData(
    data: TableResult.DropData,
    options?: TableResult.DropDataOptions,
  ): Promise<TableResult.Implementation | undefined>;

  static override fromImport(
    source: TableResult.Source,
    context?: Document.FromImportContext<TableResult.Parent> | null,
  ): Promise<TableResult.Implementation>;

  override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;

  // Embedded document operations have been left out because TableResult does not have any embedded documents.

  static #TableResult: true;
}

export default TableResult;