@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1

package/src/foundry/client/documents/folder.d.mts

@@ -0,0 +1,659 @@
+import type { ConfiguredFolder } from "fvtt-types/configuration";
+import type { InexactPartial, IntentionalPartial, Merge, NullishProps } from "#utils";
+import type Document from "#common/abstract/document.d.mts";
+import type { DataSchema } from "#common/data/fields.d.mts";
+import type BaseFolder from "#common/documents/folder.d.mts";
+
+import fields = foundry.data.fields;
+
+declare namespace Folder {
+  /**
+   * The document's name.
+   */
+  type Name = "Folder";
+
+  /**
+   * The context used to create a `Folder`.
+   */
+  interface ConstructionContext extends Document.ConstructionContext<Parent> {}
+
+  /**
+   * The documents embedded within `Folder`.
+   */
+  type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;
+
+  /**
+   * The implementation of the `Folder` document instance configured through `CONFIG.Folder.documentClass` in Foundry and
+   * {@linkcode DocumentClassConfig} or {@link ConfiguredFolder | `fvtt-types/configuration/ConfiguredFolder`} in fvtt-types.
+   */
+  type Implementation = Document.ImplementationFor<Name>;
+
+  /**
+   * The implementation of the `Folder` document configured through `CONFIG.Folder.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: "Folder";
+        collection: "folders";
+        label: string;
+        labelPlural: string;
+        coreTypes: typeof CONST.FOLDER_DOCUMENT_TYPES;
+        schemaVersion: string;
+      }>
+    > {}
+
+  // No need for Metadata namespace
+
+  /**
+   * The subtypes of `Folder` that Foundry provides. `Folder` 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 `Folder`.
+   *
+   * Each of `Folder`'s subtypes correspond to something that it is intended to contain. This
+   * includes various documents as well as a {@linkcode Compendium}. The documents a
+   * `Folder` can contain specifically are an {@linkcode Actor}, {@linkcode Adventure},
+   * {@linkcode Item}, {@linkcode Scene}, {@linkcode JournalEntry},
+   * {@linkcode Playlist}, {@linkcode RollTable}, {@linkcode Cards}, or a
+   * {@linkcode Macro}
+   */
+  type SubType = foundry.Game.Model.TypeNames<Name>;
+
+  /**
+   * @deprecated `Folder` 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 ConfiguredSubTypes = never;
+
+  /**
+   * @deprecated `Folder` 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 `Folder` with the corresponding type. This works with both the
+   * builtin `Folder` class or a custom subclass if that is set up in
+   * {@link ConfiguredFolder | `fvtt-types/configuration/ConfiguredFolder`}.
+   *
+   * Note that `Folder` does not have a `system` property and therefore there is no way for a user
+   * to configure custom subtypes. See {@linkcode Folder.SubType} for more information.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-restricted-types
+  type OfType<Type extends SubType> = Document.Internal.OfType<ConfiguredFolder<Type>, () => Folder<Type>>;
+
+  /**
+   * 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 = Actor.Implementation | Item.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`.
+   */
+  // 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 = foundry.documents.collections.CompendiumCollection.ForDocument<CONST.COMPENDIUM_DOCUMENT_TYPES>;
+
+  /**
+   * 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 `Folder`s. Will be `never` if none exists.
+   */
+  type CollectionClass = foundry.documents.collections.Folders.ConfiguredClass;
+
+  /**
+   * The world collection that contains `Folder`s. Will be `never` if none exists.
+   */
+  type Collection = foundry.documents.collections.Folders.Configured;
+
+  /**
+   * An instance of `Folder` that comes from the database but failed validation meaning that
+   * its `system` and `_source` could theoretically be anything.
+   */
+  interface Invalid extends Document.Internal.Invalid<Implementation> {}
+
+  /**
+   * An instance of `Folder` that comes from the database.
+   */
+  type Stored<SubType extends Folder.SubType = Folder.SubType> = Document.Internal.Stored<OfType<SubType>>;
+
+  /**
+   * The data put in {@link Folder._source | `Folder#_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 Folder.create}
+   * and {@link Folder | `new Folder(...)`}.
+   *
+   * 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 Folder.name | `Folder#name`}.
+   *
+   * This is data transformed from {@linkcode Folder.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 Folder.update | `Folder#update`}.
+   * It is a distinct type from {@link Folder.CreateData | `DeepPartial<Folder.CreateData>`} because
+   * it has different rules for `null` and `undefined`.
+   */
+  interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
+
+  /**
+   * The schema for {@linkcode Folder}. This is the source of truth for how an Folder document
+   * must be structured.
+   *
+   * Foundry uses this schema to validate the structure of the {@linkcode Folder}. 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 Folder document
+     * @defaultValue `null`
+     */
+    _id: fields.DocumentIdField;
+
+    /** The name of this Folder */
+    name: fields.StringField<
+      { required: true; blank: false; textSearch: true },
+      // Note(LukeAbby): Field override because `blank: false` isn't fully accounted for or something.
+      string,
+      string,
+      string
+    >;
+
+    /** The document type which this Folder contains, from {@linkcode CONST.FOLDER_DOCUMENT_TYPES} */
+    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+    type: fields.DocumentTypeField<typeof BaseFolder, {}, Folder.SubType, Folder.SubType, Folder.SubType>;
+
+    /**
+     * An HTML description of the contents of this folder
+     * @defaultValue `""`
+     */
+    description: fields.HTMLField<{ textSearch: true }>;
+
+    /**
+     * The _id of a parent Folder which contains this Folder
+     * @defaultValue `null`
+     */
+    folder: fields.ForeignDocumentField<typeof BaseFolder>;
+
+    /**
+     * The sorting mode used to organize documents within this Folder, in ["a", "m"]
+     * @defaultValue `"a"`
+     */
+    sorting: fields.StringField<{ required: true; initial: "a"; choices: typeof BaseFolder.SORTING_MODES }>;
+
+    /**
+     * The numeric sort value which orders this Folder relative to its siblings
+     * @defaultValue `0`
+     */
+    sort: fields.IntegerSortField;
+
+    /**
+     * A color string used for the background color of this Folder
+     * @defaultValue `null`
+     */
+    color: fields.ColorField;
+
+    /**
+     * An object of optional key/value flags
+     * @defaultValue `{}`
+     */
+    flags: fields.DocumentFlagsField<Name>;
+
+    /**
+     * An object of creation and access information
+     * @defaultValue see {@linkcode fields.DocumentStatsField}
+     */
+    _stats: fields.DocumentStatsField;
+  }
+
+  namespace Database {
+    /** Options passed along in Get operations for Folders */
+    interface Get extends foundry.abstract.types.DatabaseGetOperation<Folder.Parent> {}
+
+    /** Options passed along in Create operations for Folders */
+    interface Create<Temporary extends boolean | undefined = boolean | undefined>
+      extends foundry.abstract.types.DatabaseCreateOperation<Folder.CreateData, Folder.Parent, Temporary> {}
+
+    /** Options passed along in Delete operations for Folders */
+    interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<Folder.Parent> {}
+
+    /** Options passed along in Update operations for Folders */
+    interface Update extends foundry.abstract.types.DatabaseUpdateOperation<Folder.UpdateData, Folder.Parent> {}
+
+    /** Operation for {@linkcode Folder.createDocuments} */
+    interface CreateDocumentsOperation<Temporary extends boolean | undefined>
+      extends Document.Database.CreateOperation<Folder.Database.Create<Temporary>> {}
+
+    /** Operation for {@linkcode Folder.updateDocuments} */
+    interface UpdateDocumentsOperation extends Document.Database.UpdateDocumentsOperation<Folder.Database.Update> {}
+
+    /** Operation for {@linkcode Folder.deleteDocuments} */
+    interface DeleteDocumentsOperation extends Document.Database.DeleteDocumentsOperation<Folder.Database.Delete> {}
+
+    /** Operation for {@linkcode Folder.create} */
+    interface CreateOperation<Temporary extends boolean | undefined>
+      extends Document.Database.CreateOperation<Folder.Database.Create<Temporary>> {}
+
+    /** Operation for {@link Folder.update | `Folder#update`} */
+    interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}
+
+    interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}
+
+    /** Options for {@linkcode Folder.get} */
+    interface GetOptions extends Document.Database.GetOptions {}
+
+    /** Options for {@link Folder._preCreate | `Folder#_preCreate`} */
+    interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}
+
+    /** Options for {@link Folder._onCreate | `Folder#_onCreate`} */
+    interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}
+
+    /** Operation for {@linkcode Folder._preCreateOperation} */
+    interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<Folder.Database.Create> {}
+
+    /** Operation for {@link Folder._onCreateOperation | `Folder#_onCreateOperation`} */
+    interface OnCreateOperation extends Folder.Database.Create {}
+
+    /** Options for {@link Folder._preUpdate | `Folder#_preUpdate`} */
+    interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}
+
+    /** Options for {@link Folder._onUpdate | `Folder#_onUpdate`} */
+    interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}
+
+    /** Operation for {@linkcode Folder._preUpdateOperation} */
+    interface PreUpdateOperation extends Folder.Database.Update {}
+
+    /** Operation for {@link Folder._onUpdateOperation | `Folder._preUpdateOperation`} */
+    interface OnUpdateOperation extends Folder.Database.Update {}
+
+    /** Options for {@link Folder._preDelete | `Folder#_preDelete`} */
+    interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}
+
+    /** Options for {@link Folder._onDelete | `Folder#_onDelete`} */
+    interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}
+
+    /** Options for {@link Folder._preDeleteOperation | `Folder#_preDeleteOperation`} */
+    interface PreDeleteOperation extends Folder.Database.Delete {}
+
+    /** Options for {@link Folder._onDeleteOperation | `Folder#_onDeleteOperation`} */
+    interface OnDeleteOperation extends Folder.Database.Delete {}
+
+    /** Context for {@linkcode Folder._onDeleteOperation} */
+    interface OnDeleteDocumentsContext extends Document.ModificationContext<Folder.Parent> {}
+
+    /** Context for {@linkcode Folder._onCreateDocuments} */
+    interface OnCreateDocumentsContext extends Document.ModificationContext<Folder.Parent> {}
+
+    /** Context for {@linkcode Folder._onUpdateDocuments} */
+    interface OnUpdateDocumentsContext extends Document.ModificationContext<Folder.Parent> {}
+
+    /**
+     * Options for {@link Folder._preCreateDescendantDocuments | `Folder#_preCreateDescendantDocuments`}
+     * and {@link Folder._onCreateDescendantDocuments | `Folder#_onCreateDescendantDocuments`}
+     */
+    interface CreateOptions extends Document.Database.CreateOptions<Folder.Database.Create> {}
+
+    /**
+     * Options for {@link Folder._preUpdateDescendantDocuments | `Folder#_preUpdateDescendantDocuments`}
+     * and {@link Folder._onUpdateDescendantDocuments | `Folder#_onUpdateDescendantDocuments`}
+     */
+    interface UpdateOptions extends Document.Database.UpdateOptions<Folder.Database.Update> {}
+
+    /**
+     * Options for {@link Folder._preDeleteDescendantDocuments | `Folder#_preDeleteDescendantDocuments`}
+     * and {@link Folder._onDeleteDescendantDocuments | `Folder#_onDeleteDescendantDocuments`}
+     */
+    interface DeleteOptions extends Document.Database.DeleteOptions<Folder.Database.Delete> {}
+
+    /**
+     * Create options for {@linkcode Folder.createDialog}.
+     */
+    interface DialogCreateOptions extends InexactPartial<Create> {}
+  }
+
+  /**
+   * 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>;
+  }
+
+  interface DropData extends Document.Internal.DropData<Name> {}
+  interface DropDataOptions extends Document.DropDataOptions {}
+
+  interface DefaultNameContext extends Document.DefaultNameContext<Name, Parent> {}
+
+  interface CreateDialogData extends Document.CreateDialogData<CreateData> {}
+
+  /**
+   * @remarks Rather than a simple `Dialog`, {@link Folder.createDialog | `Folder.createDialog`} creates a {@link FolderConfig | `FolderConfig`},
+   * passing along the returned `Promise`'s `resolve` to the app.
+   */
+  // TODO: Generally fix this up to be correct, temp fix here for the appv1 removal
+  // TODO (v13): `options.document` is also force set
+  interface CreateDialogOptions
+    extends InexactPartial<Omit<foundry.applications.sheets.FolderConfig.Configuration, "resolve">> {
+    /** @deprecated This is force set to the `resolve` of the Promise returned by this `createDialog` call */
+    resolve?: never;
+  }
+
+  /**
+   * Actual document types that go in folders
+   */
+  type DocumentType = Exclude<CONST.FOLDER_DOCUMENT_TYPES, "Compendium">;
+
+  type DocumentCollection<Type extends SubType> = Type extends "Compendium"
+    ? Collection.Any | undefined
+    : foundry.documents.abstract.WorldCollection.Any;
+
+  /** @internal */
+  type _ExportToCompendiumOptions = NullishProps<{
+    /**
+     * Update existing entries in the Compendium pack, matching by name
+     * @defaultValue `false`
+     */
+    updateByName: boolean;
+
+    /**
+     * Retain the original _id attribute when updating an entity
+     * @defaultValue `false`
+     * @remarks No default applied despite Foundry's typing, but `undefined` will be treated falsily
+     */
+    keepId: boolean;
+
+    /**
+     * Retain the existing Folder structure
+     * @defaultValue `false`
+     * @remarks No default applied despite Foundry's typing, but `undefined` will be treated falsily
+     */
+    keepFolders: boolean;
+
+    /**
+     * A target folder id to which the documents will be exported
+     * @defaultValue `null`
+     */
+    folder: string;
+  }>;
+
+  /** @privateRemarks `keepId` omitted to override comment */
+  interface ExportToCompendiumOptions
+    extends _ExportToCompendiumOptions,
+      Omit<ClientDocument.ToCompendiumOptions, "keepId"> {}
+
+  /** @internal */
+  type _ExportDialogOptions = NullishProps<{
+    /**
+     * @remarks A compendium to preselect in the dialog
+     * @defaultValue `null`
+     */
+    pack: string;
+
+    /**
+     * @remarks Initial state of the `Merge by Name` checkbox in the dialog
+     * @defaultValue `true`
+     */
+    merge: boolean;
+
+    /**
+     * @remarks Initial state of the `Keep Document IDs` checkbox in the dialog
+     * @defaultValue `true`
+     */
+    keepId: boolean;
+
+    /**
+     * @remarks Initial state of the `Keep Folder Structure` checkbox in the dialog
+     * @defaultValue `true`
+     */
+    keepFolders: boolean;
+  }>;
+
+  interface ExportDialogOptions extends _ExportDialogOptions, IntentionalPartial<foundry.appv1.api.Dialog.Options> {}
+
+  // TODO: Handle compendium. This requires the index to be configured.
+  type Contents<SubType extends Folder.SubType> = Document.StoredForName<Extract<SubType, Document.Type>>[];
+
+  // TODO: Compendium Pack index
+  type DocumentClass<SubType extends Folder.SubType> = Document.ImplementationClassFor<Extract<SubType, Document.Type>>;
+
+  interface ChildNode extends foundry.documents.abstract.DirectoryCollectionMixin.TreeNode<Implementation> {}
+
+  /**
+   * 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>;
+}
+
+/**
+ * The client-side Folder document which extends the common BaseFolder model.
+ *
+ * @see {@linkcode Folders}            The world-level collection of Folder documents
+ * @see {@linkcode FolderConfig}       The Folder configuration application
+ */
+declare class Folder<out SubType extends Folder.SubType = Folder.SubType> extends BaseFolder.Internal
+  .ClientDocument<SubType> {
+  /**
+   * @param data    - Initial data from which to construct the `Folder`
+   * @param context - Construction context options
+   */
+  constructor(data: Folder.CreateData, context?: Folder.ConstructionContext);
+
+  /**
+   * The depth of this folder in its sidebar tree
+   *
+   * @remarks For folders that have been populated by the {@linkcode SidebarDirectory}, this is always be defined
+   */
+  depth: number | undefined;
+
+  /**
+   * An array of nodes representing the children of this one. This differs from the results of
+   * {@link Folder.getSubfolders | `Folder#getSubfolders`}, which reports the subset of child Folders
+   * displayed to the current User in the UI.
+   *
+   * Initialized by {@link DirectoryCollection.initializeTree | `DirectoryCollection#initializeTree`}, so always
+   * `undefined` in temporary documents, and prior to first UI render in stored documents
+   */
+  children: Folder.ChildNode | undefined;
+
+  /**
+   * Return whether the folder is displayed in the sidebar to the current User.
+   * @defaultValue `false`
+   */
+  displayed: boolean;
+
+  /**
+   * The array of the Document instances which are contained within this Folder,
+   * unless it's a Folder inside a Compendium pack, in which case it's the array
+   * of objects inside the index of the pack that are contained in this Folder.
+   */
+  get contents(): Folder.Contents<SubType>;
+
+  set contents(value);
+
+  /**
+   * The reference to the Document type which is contained within this Folder.
+   */
+  get documentClass(): Folder.DocumentClass<SubType>;
+
+  /**
+   * The reference to the WorldCollection instance which provides Documents to this Folder,
+   * unless it's a Folder inside a Compendium pack, in which case it's the index of the pack.
+   * A world Folder containing CompendiumCollections will have neither.
+   */
+  // TODO: Compendium Pack index
+  // TODO: Infer specific world collection from SubType
+  get documentCollection(): Folder.DocumentCollection<SubType>;
+
+  /**
+   * Return whether the folder is currently expanded within the sidebar interface.
+   */
+  get expanded(): boolean;
+
+  /**
+   * Return the list of ancestors of this folder, starting with the parent.
+   */
+  get ancestors(): Folder.Implementation[];
+
+  override get inCompendium(): boolean;
+
+  // _preCreate overridden but with no signature changes.
+  // For type simplicity it is left off. These methods historically have been the source of a large amount of computation from tsc.
+
+  /** @remarks Creates and renders a {@link FolderConfig | `FolderConfig`} instead of a simple Dialog */
+  static override createDialog(
+    data?: Folder.CreateDialogData,
+    createOptions?: Folder.Database.DialogCreateOptions,
+    options?: Folder.CreateDialogOptions,
+  ): Promise<Folder.Stored | null | undefined>;
+
+  override deleteDialog(
+    options?: InexactPartial<foundry.applications.api.DialogV2.ConfirmConfig>,
+    operation?: Document.Database.DeleteOperationForName<"Folder">,
+  ): Promise<this | false | null | undefined>;
+
+  /**
+   * Export all Documents contained in this Folder to a given Compendium pack.
+   * Optionally update existing Documents within the Pack by name, otherwise append all new entries.
+   * @param pack    - A Compendium pack to which the documents will be exported
+   * @param options - Additional options which customize how content is exported. See {@link ClientDocument.toCompendium | `ClientDocument#toCompendium`} (default: `{}`)
+   * @returns The updated Compendium Collection instance
+   */
+  exportToCompendium<Pack extends foundry.documents.collections.CompendiumCollection.Any>(
+    pack: Pack,
+    options?: Folder.ExportToCompendiumOptions,
+  ): Promise<Pack>;
+
+  /**
+   * Provide a dialog form that allows for exporting the contents of a Folder into an eligible Compendium pack.
+   * @param pack    - A pack ID to set as the default choice in the select input
+   * @param options - Additional options passed to the Dialog.prompt method (default: `{}`)
+   * @returns A Promise which resolves or rejects once the dialog has been submitted or closed
+   *
+   * @remarks - Foundry documents `pack` as just being a `string` but it is unused in favor of `options.pack`, and Foundry itself
+   * calls `exportDialog` with `null`.
+   */
+  exportDialog(pack: string | null, options?: Folder.ExportDialogOptions): Promise<void>;
+
+  /**
+   * Get the Folder documents which are sub-folders of the current folder, either direct children or recursively.
+   * @param recursive - Identify child folders recursively, if false only direct children are returned (default: `false`)
+   * @returns An array of Folder documents which are subfolders of this one
+   */
+  getSubfolders(recursive?: boolean): Folder.Stored<SubType>[];
+
+  /**
+   * Get the Folder documents which are parent folders of the current folder or any if its parents.
+   * @returns An array of Folder documents which are parent folders of this one
+   */
+  getParentFolders(): Folder.Stored<SubType>[];
+
+  /*
+   * 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 Folder does not have any descendant documents.
+
+  static override defaultName(context?: Folder.DefaultNameContext): string;
+
+  static override fromDropData(
+    data: Folder.DropData,
+    options?: Folder.DropDataOptions,
+  ): Promise<Folder.Implementation | undefined>;
+
+  static override fromImport(
+    source: Folder.Source,
+    context?: Document.FromImportContext<Folder.Parent> | null,
+  ): Promise<Folder.Implementation>;
+
+  override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
+
+  #Folder: true;
+}
+
+export default Folder;