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

package/src/foundry/client/data/documents/table.d.mts

@@ -1,22 +1,489 @@
-import type { InexactPartial } from "../../../../types/utils.d.mts";
+import type { InexactPartial, Merge } from "fvtt-types/utils";
+import type { documents } from "../../../client-esm/client.d.mts";
 import type Document from "../../../common/abstract/document.d.mts";
-import type { DocumentDatabaseOperations } from "../../../common/abstract/document.d.mts";
-import type BaseRollTable from "../../../common/documents/roll-table.d.mts";
+import type { DataSchema } from "../../../common/data/fields.d.mts";
+import type { fields } from "../../../common/data/module.d.mts";
 
 declare global {
   namespace RollTable {
-    type Metadata = Document.MetadataFor<RollTable>;
+    /**
+     * The document's name.
+     */
+    type Name = "RollTable";
+
+    /**
+     * The arguments to construct the document.
+     */
+    type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;
+
+    /**
+     * The documents embedded within `RollTable`.
+     */
+    type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;
+
+    /**
+     * The implementation of the `RollTable` document instance configured through `CONFIG.RollTable.documentClass` in Foundry and
+     * {@link DocumentClassConfig | `DocumentClassConfig`} or {@link ConfiguredRollTable | `fvtt-types/configuration/ConfiguredRollTable`} in fvtt-types.
+     */
+    type Implementation = Document.ImplementationFor<Name>;
+
+    /**
+     * The implementation of the `RollTable` document configured through `CONFIG.RollTable.documentClass` in Foundry and
+     * {@link DocumentClassConfig | `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: "RollTable";
+          collection: "tables";
+          indexed: true;
+          compendiumIndexFields: ["_id", "name", "img", "sort", "folder"];
+          embedded: Metadata.Embedded;
+          label: string;
+          labelPlural: string;
+          schemaVersion: string;
+        }>
+      > {}
+
+    namespace Metadata {
+      /**
+       * The embedded metadata
+       */
+      interface Embedded {
+        TableResult: "results";
+      }
+    }
+
+    /**
+     * 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 = null;
+
+    /**
+     * A document's direct descendants are documents that are contained directly within its schema.
+     * This is a union of all such instances, or never if the document doesn't have any descendants.
+     */
+    type DirectDescendant = TableResult.Stored;
+
+    /**
+     * A document's direct descendants are documents that are contained directly within its schema.
+     * This is a union of all such classes, or never if the document doesn't have any descendants.
+     */
+    type DirectDescendantClass = TableResult.ImplementationClass;
+
+    /**
+     * A document's descendants are any documents that are contained within, either within its schema
+     * or its descendant's schemas.
+     * This is a union of all such instances, or never if the document doesn't have any descendants.
+     */
+    type Descendant = DirectDescendant;
+
+    /**
+     * 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 = DirectDescendantClass;
+    /**
+     * 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)`
+     */
+    // Note: Takes any document in the heritage chain (i.e. itself or any parent, transitive or not) that can be contained in a compendium.
+    type Pack = CompendiumCollection.ForDocument<Name>;
+
+    /**
+     * 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 = Document.ImplementationFor<Embedded.Name>;
+
+    namespace Embedded {
+      /**
+       * 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 Name = keyof Metadata.Embedded;
+
+      /**
+       * Gets the collection name for an embedded document.
+       */
+      type CollectionNameOf<CollectionName extends Embedded.CollectionName> = Document.Embedded.CollectionNameFor<
+        Metadata.Embedded,
+        CollectionName
+      >;
+
+      /**
+       * Gets the collection document for an embedded document.
+       */
+      // TODO(LukeAbby): There's a circularity. Should be `Document.Embedded.CollectionDocumentFor<Metadata.Embedded, CollectionName>`
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      type DocumentFor<CollectionName extends Embedded.CollectionName> = Document.Any;
+
+      /**
+       * Gets the collection for an embedded document.
+       */
+      type CollectionFor<CollectionName extends Embedded.CollectionName> = Document.Embedded.CollectionFor<
+        // TODO(LukeAbby): This should be `TokenDocument.Implementation` but this causes a circularity.
+        Document.Any,
+        Metadata.Embedded,
+        CollectionName
+      >;
+
+      /**
+       * A valid name to refer to a collection embedded in this document. For example an `Actor`
+       * has the key `"items"` which contains `Item` instance which would make both `"Item" | "Items"`
+       * valid keys (amongst others).
+       */
+      type CollectionName = Document.Embedded.CollectionName<Metadata.Embedded>;
+    }
+
+    /**
+     * 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 `RollTable`s. Will be `never` if none exists.
+     */
+    type CollectionClass = RollTables.ConfiguredClass;
+
+    /**
+     * The world collection that contains `RollTable`s. Will be `never` if none exists.
+     */
+    type Collection = RollTables.Configured;
 
-    type ConfiguredClass = Document.ConfiguredClassForName<"RollTable">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"RollTable">;
+    /**
+     * An instance of `RollTable` that comes from the database but failed validation meaining that
+     * its `system` and `_source` could theoretically be anything.
+     */
+    interface Invalid extends Document.Invalid<RollTable.Implementation> {}
 
-    interface DatabaseOperations extends DocumentDatabaseOperations<RollTable> {}
+    /**
+     * An instance of `RollTable` that comes from the database.
+     */
+    interface Stored extends Document.Stored<RollTable.Implementation> {}
 
-    // Helpful aliases
-    type ConstructorData = BaseRollTable.ConstructorData;
-    type UpdateData = BaseRollTable.UpdateData;
-    type Schema = BaseRollTable.Schema;
-    type Source = BaseRollTable.Source;
+    /**
+     * The data put in {@link RollTable._source | `RollTable#_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 {@link Set | `Set`}.
+     */
+    interface Source extends fields.SchemaField.SourceData<Schema> {}
+
+    /**
+     * @deprecated {@link RollTable.Source | `RollTable.Source`}
+     */
+    type PersistedData = Source;
+
+    /**
+     * The data necessary to create a document. Used in places like {@link RollTable.create | `RollTable.create`}
+     * and {@link RollTable | `new RollTable(...)`}.
+     *
+     * For example a {@link fields.SetField | `SetField`} can accept any {@link Iterable | `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 RollTable.name | `RollTable#name`}.
+     *
+     * This is data transformed from {@link RollTable.Source | `RollTable.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 RollTable.update | `RollTable#update`}.
+     * It is a distinct type from {@link RollTable.CreateData | `DeepPartial<RollTable.CreateData>`} because
+     * it has different rules for `null` and `undefined`.
+     */
+    interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
+
+    /**
+     * The schema for {@link RollTable | `RollTable`}. This is the source of truth for how an RollTable document
+     * must be structured.
+     *
+     * Foundry uses this schema to validate the structure of the {@link RollTable | `RollTable`}. 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 RollTable document
+       * @defaultValue `null`
+       */
+      _id: fields.DocumentIdField;
+
+      /**
+       * The name of this RollTable
+       * @defaultValue `""`
+       */
+      name: fields.StringField<{ required: true; blank: false; textSearch: true }>;
+
+      /**
+       * An image file path which provides the thumbnail artwork for this RollTable
+       * @defaultValue `BaseRollTable.DEFAULT_ICON`
+       */
+      img: fields.FilePathField<{
+        categories: ["IMAGE"];
+        initial: () => typeof documents.BaseRollTable.DEFAULT_ICON;
+      }>;
+
+      /**
+       * The HTML text description for this RollTable document
+       * @defaultValue `""`
+       */
+      description: fields.StringField<{ textSearch: true }>;
+
+      /**
+       * A Collection of TableResult embedded documents which belong to this RollTable
+       * @defaultValue `[]`
+       */
+      results: fields.EmbeddedCollectionField<typeof documents.BaseTableResult, RollTable.Implementation>;
+
+      /**
+       * The Roll formula which determines the results chosen from the table
+       * @defaultValue `""`
+       */
+      formula: fields.StringField;
+
+      /**
+       * Are results from this table drawn with replacement?
+       * @defaultValue `true`
+       */
+      replacement: fields.BooleanField<{ initial: true }>;
+
+      /**
+       * Is the Roll result used to draw from this RollTable displayed in chat?
+       * @defaultValue `true`
+       */
+      displayRoll: fields.BooleanField<{ initial: true }>;
+
+      /**
+       * The _id of a Folder which contains this RollTable
+       * @defaultValue `null`
+       */
+      folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
+
+      /**
+       * The numeric sort value which orders this RollTable relative to its siblings
+       * @defaultValue `0`
+       */
+      sort: fields.IntegerSortField;
+
+      /**
+       * An object which configures ownership of this RollTable
+       * @defaultValue see {@link fields.DocumentOwnershipField | `fields.DocumentOwnershipField`}
+       */
+      ownership: fields.DocumentOwnershipField;
+
+      /**
+       * An object of optional key/value flags
+       * @defaultValue `{}`
+       */
+      flags: fields.ObjectField.FlagsField<Name>;
+
+      /**
+       * An object of creation and access information
+       * @defaultValue see {@link fields.DocumentStatsField | `fields.DocumentStatsField`}
+       */
+      _stats: fields.DocumentStatsField;
+    }
+
+    namespace Database {
+      /** Options passed along in Get operations for RollTables */
+      interface Get extends foundry.abstract.types.DatabaseGetOperation<RollTable.Parent> {}
+
+      /** Options passed along in Create operations for RollTables */
+      interface Create<Temporary extends boolean | undefined = boolean | undefined>
+        extends foundry.abstract.types.DatabaseCreateOperation<RollTable.CreateData, RollTable.Parent, Temporary> {}
+
+      /** Options passed along in Delete operations for RollTables */
+      interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<RollTable.Parent> {}
+
+      /** Options passed along in Update operations for RollTables */
+      interface Update extends foundry.abstract.types.DatabaseUpdateOperation<RollTable.UpdateData, RollTable.Parent> {}
+
+      /** Operation for {@link RollTable.createDocuments | `RollTable.createDocuments`} */
+      interface CreateDocumentsOperation<Temporary extends boolean | undefined>
+        extends Document.Database.CreateOperation<RollTable.Database.Create<Temporary>> {}
+
+      /** Operation for {@link RollTable.updateDocuments | `RollTable.updateDocuments`} */
+      interface UpdateDocumentsOperation
+        extends Document.Database.UpdateDocumentsOperation<RollTable.Database.Update> {}
+
+      /** Operation for {@link RollTable.deleteDocuments | `RollTable.deleteDocuments`} */
+      interface DeleteDocumentsOperation
+        extends Document.Database.DeleteDocumentsOperation<RollTable.Database.Delete> {}
+
+      /** Operation for {@link RollTable.create | `RollTable.create`} */
+      interface CreateOperation<Temporary extends boolean | undefined>
+        extends Document.Database.CreateOperation<RollTable.Database.Create<Temporary>> {}
+
+      /** Operation for {@link RollTable.update | `RollTable#update`} */
+      interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}
+
+      interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}
+
+      /** Options for {@link RollTable.get | `RollTable.get`} */
+      interface GetOptions extends Document.Database.GetOptions {}
+
+      /** Options for {@link RollTable._preCreate | `RollTable#_preCreate`} */
+      interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}
+
+      /** Options for {@link RollTable._onCreate | `RollTable#_onCreate`} */
+      interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}
+
+      /** Operation for {@link RollTable._preCreateOperation | `RollTable._preCreateOperation`} */
+      interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<RollTable.Database.Create> {}
+
+      /** Operation for {@link RollTable._onCreateOperation | `RollTable#_onCreateOperation`} */
+      interface OnCreateOperation extends RollTable.Database.Create {}
+
+      /** Options for {@link RollTable._preUpdate | `RollTable#_preUpdate`} */
+      interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}
+
+      /** Options for {@link RollTable._onUpdate | `RollTable#_onUpdate`} */
+      interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}
+
+      /** Operation for {@link RollTable._preUpdateOperation | `RollTable._preUpdateOperation`} */
+      interface PreUpdateOperation extends RollTable.Database.Update {}
+
+      /** Operation for {@link RollTable._onUpdateOperation | `RollTable._preUpdateOperation`} */
+      interface OnUpdateOperation extends RollTable.Database.Update {}
+
+      /** Options for {@link RollTable._preDelete | `RollTable#_preDelete`} */
+      interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}
+
+      /** Options for {@link RollTable._onDelete | `RollTable#_onDelete`} */
+      interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}
+
+      /** Options for {@link RollTable._preDeleteOperation | `RollTable#_preDeleteOperation`} */
+      interface PreDeleteOperation extends RollTable.Database.Delete {}
+
+      /** Options for {@link RollTable._onDeleteOperation | `RollTable#_onDeleteOperation`} */
+      interface OnDeleteOperation extends RollTable.Database.Delete {}
+
+      /** Context for {@link RollTable._onDeleteOperation | `RollTable._onDeleteOperation`} */
+      interface OnDeleteDocumentsContext extends Document.ModificationContext<RollTable.Parent> {}
+
+      /** Context for {@link RollTable._onCreateDocuments | `RollTable._onCreateDocuments`} */
+      interface OnCreateDocumentsContext extends Document.ModificationContext<RollTable.Parent> {}
+
+      /** Context for {@link RollTable._onUpdateDocuments | `RollTable._onUpdateDocuments`} */
+      interface OnUpdateDocumentsContext extends Document.ModificationContext<RollTable.Parent> {}
+
+      /**
+       * Options for {@link RollTable._preCreateDescendantDocuments | `RollTable#_preCreateDescendantDocuments`}
+       * and {@link RollTable._onCreateDescendantDocuments | `RollTable#_onCreateDescendantDocuments`}
+       */
+      interface CreateOptions extends Document.Database.CreateOptions<RollTable.Database.Create> {}
+
+      /**
+       * Options for {@link RollTable._preUpdateDescendantDocuments | `RollTable#_preUpdateDescendantDocuments`}
+       * and {@link RollTable._onUpdateDescendantDocuments | `RollTable#_onUpdateDescendantDocuments`}
+       */
+      interface UpdateOptions extends Document.Database.UpdateOptions<RollTable.Database.Update> {}
+
+      /**
+       * Options for {@link RollTable._preDeleteDescendantDocuments | `RollTable#_preDeleteDescendantDocuments`}
+       * and {@link RollTable._onDeleteDescendantDocuments | `RollTable#_onDeleteDescendantDocuments`}
+       */
+      interface DeleteOptions extends Document.Database.DeleteOptions<RollTable.Database.Delete> {}
+    }
+
+    /**
+     * An object containing the executed Roll and the produced results
+     */
+    interface Draw {
+      /**
+       * The Dice roll which generated the draw
+       */
+      roll: Roll;
+
+      /**
+       * An array of drawn TableResult documents
+       */
+      results: Document.ToConfiguredInstance<typeof foundry.documents.BaseTableResult>[];
+    }
+
+    /**
+     * The flags that are available for this document in the form `{ [scope: string]: { [key: string]: unknown } }`.
+     */
+    interface Flags extends Document.ConfiguredFlagsForName<Name> {}
+
+    namespace Flags {
+      /**
+       * The valid scopes for the flags on this document e.g. `"core"` or `"dnd5e"`.
+       */
+      type Scope = Document.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.FlagKeyOf<Document.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.GetFlag<Name, Scope, Key>;
+    }
+
+    type PreCreateDescendantDocumentsArgs = Document.PreCreateDescendantDocumentsArgs<
+      RollTable.Stored,
+      RollTable.DirectDescendant,
+      RollTable.Metadata.Embedded
+    >;
+
+    type OnCreateDescendantDocumentsArgs = Document.OnCreateDescendantDocumentsArgs<
+      RollTable.Stored,
+      RollTable.DirectDescendant,
+      RollTable.Metadata.Embedded
+    >;
+
+    type PreUpdateDescendantDocumentsArgs = Document.PreUpdateDescendantDocumentsArgs<
+      RollTable.Stored,
+      RollTable.DirectDescendant,
+      RollTable.Metadata.Embedded
+    >;
+
+    type OnUpdateDescendantDocumentsArgs = Document.OnUpdateDescendantDocumentsArgs<
+      RollTable.Stored,
+      RollTable.DirectDescendant,
+      RollTable.Metadata.Embedded
+    >;
+
+    type PreDeleteDescendantDocumentsArgs = Document.PreDeleteDescendantDocumentsArgs<
+      RollTable.Stored,
+      RollTable.DirectDescendant,
+      RollTable.Metadata.Embedded
+    >;
+
+    type OnDeleteDescendantDocumentsArgs = Document.OnDeleteDescendantDocumentsArgs<
+      RollTable.Stored,
+      RollTable.DirectDescendant,
+      RollTable.Metadata.Embedded
+    >;
 
     /**
      * Optional arguments which customize the draw
@@ -37,7 +504,7 @@ declare global {
        * One or more table results which have been drawn
        * @defaultValue `[]`
        */
-      results: TableResult[];
+      results: TableResult.Implementation[];
 
       /**
        * Whether to automatically display the results in chat
@@ -54,7 +521,7 @@ declare global {
     /**
      * Additional options which modify message creation
      */
-    interface ToMessageOptions {
+    interface ToMessageOptions<Temporary extends boolean | undefined = false> {
       /**
        * An optional Roll instance which produced the drawn results
        */
@@ -70,7 +537,7 @@ declare global {
        * Additional options which customize the created messages
        * @defaultValue `{}`
        */
-      messageOptions: Document.OnCreateOptions<"ChatMessage">;
+      messageOptions: ChatMessage.Database.CreateOperation<Temporary>;
     }
 
     interface RollOptions {
@@ -99,17 +566,42 @@ declare global {
        */
       rollable?: boolean | undefined;
     }
+
+    /**
+     * @deprecated {@link RollTable.Database | `RollTable.DatabaseOperation`}
+     */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    interface DatabaseOperations extends Document.Database.Operations<RollTable.Implementation> {}
+
+    /**
+     * @deprecated {@link RollTable.CreateData | `RollTable.CreateData`}
+     */
+    interface ConstructorData extends RollTable.CreateData {}
+
+    /**
+     * @deprecated {@link RollTable.implementation | `RollTable.ImplementationClass`}
+     */
+    type ConfiguredClass = ImplementationClass;
+
+    /**
+     * @deprecated {@link RollTable.Implementation | `RollTable.Implementation`}
+     */
+    type ConfiguredInstance = Implementation;
   }
 
   /**
    * The client-side RollTable document which extends the common BaseRollTable model.
    *
-   * @see {@link RollTables}         The world-level collection of RollTable documents
-   * @see {@link TableResult}        The embedded TableResult document
-   * @see {@link RollTableConfig}    The RollTable configuration application
+   * @see {@link RollTables | `RollTables`}         The world-level collection of RollTable documents
+   * @see {@link TableResult | `TableResult`}        The embedded TableResult document
+   * @see {@link RollTableConfig | `RollTableConfig`}    The RollTable configuration application
    */
   class RollTable extends ClientDocumentMixin(foundry.documents.BaseRollTable) {
-    static override metadata: RollTable.Metadata;
+    /**
+     * @param data    - Initial data from which to construct the `RollTable`
+     * @param context - Construction context options
+     */
+    constructor(...args: RollTable.ConstructorArgs);
 
     /**
      * Provide a thumbnail image path used to represent this document.
@@ -124,16 +616,16 @@ declare global {
      * @param options - Additional options which modify message creation
      */
     toMessage(
-      results: TableResult.ConfiguredInstance[],
+      results: TableResult.Implementation[],
       options?: InexactPartial<RollTable.ToMessageOptions>,
-    ): Promise<ChatMessage.ConfiguredInstance | undefined>;
+    ): Promise<ChatMessage.Implementation | undefined>;
 
     /**
      * Draw a result from the RollTable based on the table formula or a provided Roll instance
      * @param options - Optional arguments which customize the draw behavior
      * @returns A Promise which resolves to an object containing the executed roll and the produced results
      */
-    draw(options?: RollTable.DrawOptions): Promise<RollTableDraw>;
+    draw(options?: RollTable.DrawOptions): Promise<RollTable.Draw>;
 
     /**
      * Draw multiple results from a RollTable, constructing a final synthetic Roll as a dice pool of inner rolls.
@@ -141,7 +633,7 @@ declare global {
      * @param options - Optional arguments which customize the draw
      * @returns The drawn results
      */
-    drawMany(number: number, options?: InexactPartial<RollTable.DrawOptions>): Promise<RollTableDraw>;
+    drawMany(number: number, options?: InexactPartial<RollTable.DrawOptions>): Promise<RollTable.Draw>;
 
     /**
      * Normalize the probabilities of rolling each item in the RollTable based on their assigned weights
@@ -153,7 +645,7 @@ declare global {
      * @remarks Actually, returns list of TableEntries updated, not the RollTable.
      * As written, it force updates all records, not just the ones already drawn.
      */
-    resetResults(): Promise<TableResult.ConfiguredInstance[]>;
+    resetResults(): Promise<TableResult.Stored[]>;
 
     /**
      * Evaluate a RollTable by rolling its formula and retrieving a drawn result.
@@ -175,7 +667,7 @@ declare global {
      * const customResults = await table.roll({roll});
      * ```
      */
-    roll(options?: RollTable.RollOptions): Promise<RollTableDraw>;
+    roll(options?: RollTable.RollOptions): Promise<RollTable.Draw>;
 
     /**
      * Handle a roll from within embedded content.
@@ -188,7 +680,7 @@ declare global {
      * @param value - The rolled value
      * @returns An Array of results
      */
-    getResultsForRoll(value: number): TableResult.ConfiguredInstance[];
+    getResultsForRoll(value: number): TableResult.Stored[];
 
     /**
      * Create embedded roll table markup.
@@ -252,70 +744,161 @@ declare global {
       options?: TextEditor.EnrichmentOptions,
     ): Promise<HTMLElement | null>;
 
-    protected override _onCreateDescendantDocuments(
-      parent: ClientDocument,
-      collection: string,
-      documents: ClientDocument[],
-      data: unknown[],
-      options: Document.OnCreateOptions<"TableResult">,
-      userId: string,
-    ): void;
-
-    protected override _onDeleteDescendantDocuments(
-      parent: ClientDocument,
-      collection: string,
-      documents: ClientDocument[],
-      ids: string,
-      options: Document.OnDeleteOptions<"TableResult">,
-      userId: string,
-    ): void;
-
-    override toCompendium<
-      FlagsOpt extends boolean = false,
-      SourceOpt extends boolean = true,
-      SortOpt extends boolean = true,
-      FolderOpt extends boolean = false,
-      OwnershipOpt extends boolean = false,
-      StateOpt extends boolean = true,
-      IdOpt extends boolean = false,
-    >(
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class GurpsRollTable extends RollTable {
+     *   protected override _onCreateDescendantDocuments(...args: RollTable.OnCreateDescendantDocumentsArgs) {
+     *     super._onCreateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, data, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _onCreateDescendantDocuments(...args: RollTable.OnCreateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class BladesRollTable extends RollTable {
+     *   protected override _onDeleteDescendantDocuments(...args: RollTable.OnUpdateDescendantDocuments) {
+     *     super._onDeleteDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, ids, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _onDeleteDescendantDocuments(...args: RollTable.OnDeleteDescendantDocumentsArgs): void;
+
+    toCompendium<Options extends ClientDocument.ToCompendiumOptions>(
       pack?: CompendiumCollection<CompendiumCollection.Metadata> | null,
-      options?: InexactPartial<
-        ClientDocument.CompendiumExportOptions<FlagsOpt, SourceOpt, SortOpt, FolderOpt, OwnershipOpt, StateOpt, IdOpt>
-      >,
-    ): Omit<
-      this["_source"],
-      | (IdOpt extends false ? "_id" : never)
-      | ClientDocument.OmitProperty<SortOpt, "sort" | "navigation" | "navOrder">
-      | ClientDocument.OmitProperty<FolderOpt, "folder">
-      | ClientDocument.OmitProperty<FlagsOpt, "flags">
-      | ClientDocument.OmitProperty<OwnershipOpt, "ownership">
-      | ClientDocument.OmitProperty<StateOpt, "active" | "fogReset" | "playing"> // does not model the results.drawn = false
-    >;
+      options?: Options,
+    ): ClientDocument.ToCompendiumReturnType<foundry.documents.BaseRollTable, Options>;
 
     /**
      * Create a new RollTable document using all of the Documents from a specific Folder as new results.
      * @param folder  - The Folder document from which to create a roll table
      * @param options - Additional options passed to the RollTable.create method
      */
-    static fromFolder(
-      folder: Folder,
-      options?: Document.OnCreateOptions<"Folder">,
-    ): Promise<RollTable.ConfiguredInstance | undefined>;
-  }
+    static fromFolder<Temporary extends boolean | undefined = false>(
+      folder: Folder.Implementation,
+      options?: RollTable.Database.CreateOperation<Temporary>,
+    ): Promise<Document.TemporaryIf<WallDocument.Implementation, Temporary> | undefined>;
+
+    /*
+     * 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
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class SwadeRollTable extends RollTable {
+     *   protected override _preCreateDescendantDocuments(...args: RollTable.PreCreateDescendantDocumentsArgs) {
+     *     super._preCreateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, data, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _preCreateDescendantDocuments(...args: RollTable.PreCreateDescendantDocumentsArgs): void;
+
+    /**
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class LancerRollTable extends RollTable {
+     *   protected override _preUpdateDescendantDocuments(...args: RollTable.OnUpdateDescendantDocuments) {
+     *     super._preUpdateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, changes, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    protected override _preUpdateDescendantDocuments(...args: RollTable.PreUpdateDescendantDocumentsArgs): void;
 
-  /**
-   * An object containing the executed Roll and the produced results
-   */
-  interface RollTableDraw {
     /**
-     * The Dice roll which generated the draw
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class Ptr2eRollTable extends RollTable {
+     *   protected override _onUpdateDescendantDocuments(...args: RollTable.OnUpdateDescendantDocumentsArgs) {
+     *     super._onUpdateDescendantDocuments(...args);
+     *
+     *     const [parent, collection, documents, changes, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
      */
-    roll: Roll;
+    protected override _onUpdateDescendantDocuments(...args: RollTable.OnUpdateDescendantDocumentsArgs): void;
 
     /**
-     * An array of drawn TableResult documents
+     * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
+     * this method must be overriden like so:
+     * ```typescript
+     * class KultRollTable extends RollTable {
+     *   protected override _preDeleteDescendantDocuments(...args: RollTable.PreDeleteDescendantDocumentsArgs) {
+     *     super._preDeleteDescendantDocuments(...args);
+     *
+     *     const [parent, collection, ids, options, userId] = args;
+     *     if (collection === "cards") {
+     *         options; // Will be narrowed.
+     *     }
+     *   }
+     * }
+     * ```
      */
-    results: Document.ToConfiguredInstance<typeof foundry.documents.BaseTableResult>[];
+    protected override _preDeleteDescendantDocuments(...args: RollTable.PreDeleteDescendantDocumentsArgs): void;
+
+    static override defaultName(context?: Document.DefaultNameContext<string, RollTable.Parent>): string;
+
+    static override createDialog(
+      data?: Document.CreateDialogData<RollTable.CreateData>,
+      context?: Document.CreateDialogContext<string, RollTable.Parent>,
+    ): Promise<RollTable.Stored | null | undefined>;
+
+    static override fromDropData(
+      data: Document.DropData<RollTable.Implementation>,
+      options?: Document.FromDropDataOptions,
+    ): Promise<RollTable.Implementation | undefined>;
+
+    static override fromImport(
+      source: RollTable.Source,
+      context?: Document.FromImportContext<RollTable.Parent>,
+    ): Promise<RollTable.Implementation>;
   }
+
+  /**
+   * @deprecated {@link RollTable.Draw | `RollTable.Draw`}
+   */
+  type RollTableDraw = RollTable.Draw;
 }