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

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

@@ -1,8 +1,8 @@
-import type { AnyObject, InexactPartial } from "../../../types/utils.d.mts";
+import type { AnyMutableObject } from "#utils";
+import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.d.mts";
-import type * as CONST from "../constants.mts";
-import type * as fields from "../data/fields.d.mts";
-import type * as documents from "./_module.mts";
+import type { SchemaField } from "../data/fields.d.mts";
+import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
 /**
  * The Macro Document.
@@ -11,164 +11,350 @@ import type * as documents from "./_module.mts";
 // 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 BaseMacro extends Document<"Macro", BaseMacro.Schema, any> {
+declare abstract class BaseMacro<out _SubType extends BaseMacro.SubType = BaseMacro.SubType> extends Document<
+  "Macro",
+  BaseMacro.Schema,
+  any
+> {
   /**
-   * @privateRemarks Manual override of the return due to TS limitations with static `this`
+   * @param data    - Initial data from which to construct the `BaseMacro`
+   * @param context - Construction context options
+   *
+   * @deprecated Constructing `BaseMacro` 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 Macro.implementation | `new Macro.implementation(...)`} instead which will give you
+   * a system specific implementation of `Macro`.
    */
-  static get TYPES(): BaseMacro.TypeNames[];
+  constructor(...args: Macro.ConstructorArgs);
 
   /**
-   * @param data    - Initial data from which to construct the Macro
-   * @param context - Construction context options
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Macro",
+   *   collection: "macros",
+   *   indexed: true,
+   *   compendiumIndexFields: ["_id", "name", "img", "sort", "folder"],
+   *   label: "DOCUMENT.Macro",
+   *   labelPlural: "DOCUMENT.Macros",
+   *   coreTypes: Object.values(CONST.MACRO_TYPES),
+   *   permissions: {
+   *     create: this.#canCreate,
+   *     update: this.#canUpdate
+   *   },
+   *   schemaVersion: "12.324"
+   * })
+   * ```
    */
-  // TODO(LukeAbby): This constructor is a symptom of a circular error.
-  // constructor(data: BaseMacro.ConstructorData, context?: Document.ConstructionContext<BaseMacro.Parent>);
-
-  override parent: BaseMacro.Parent;
-
   static override metadata: BaseMacro.Metadata;
 
   static override defineSchema(): BaseMacro.Schema;
 
   /**
    * The default icon used for newly created Macro documents.
+   * @defaultValue `"icons/svg/dice-target.svg"`
    */
-  static DEFAULT_ICON: "icons/svg/dice-target.svg";
+  static DEFAULT_ICON: string;
 
-  static override migrateData(source: AnyObject): AnyObject;
+  /**
+   * @remarks
+   * Migrations:
+   * - `flags.core.sourceId` to `_stats.compendiumSource` (since v12, no specified end)
+   */
+  static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
-  static override validateJoint(data: Record<string, unknown>): void;
+  /**
+   * @remarks
+   * @throws If `data.command` doesn't pass {@link foundry.data.fields.JavaScriptField | `JavaScriptField`} validation
+   */
+  static override validateJoint(data: Macro.Source): void;
 
-  static override canUserCreate(user: foundry.documents.BaseUser): boolean;
+  /** @remarks Returns `user.hasRole("PLAYER")` */
+  static override canUserCreate(user: User.Implementation): boolean;
 
+  /**
+   * @remarks Returns `true` if `user` is the `author` of the `Macro` and `options.exact` is falsey.
+   * Otherwise, forwards to {@link Document.testUserPermission | `Document#testUserPermission`}
+   */
+  // options: not null (destructured)
   override testUserPermission(
-    user: documents.BaseUser,
-    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | CONST.DOCUMENT_OWNERSHIP_LEVELS,
-    options?: InexactPartial<{
-      /**
-       * Require the exact permission level requested?
-       * @defaultValue `false`
-       */
-      exact: boolean;
-    }>,
+    user: User.Implementation,
+    permission: Document.ActionPermission,
+    options?: Document.TestUserPermissionOptions,
+  ): boolean;
+
+  // _preCreate is overridden with no type changes
+
+  /*
+   * 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 */
+
+  static " fvtt_types_internal_document_name_static": "Macro";
+
+  override readonly parentCollection: Macro.ParentCollectionName | null;
+
+  override readonly pack: string | null;
+
+  static override get implementation(): Macro.ImplementationClass;
+
+  static override get baseDocument(): typeof BaseMacro;
+
+  static override get collectionName(): Macro.ParentCollectionName;
+
+  static override get documentName(): Macro.Name;
+
+  static override get TYPES(): BaseMacro.SubType[];
+
+  static override get hasTypeData(): true;
+
+  static override get hierarchy(): Macro.Hierarchy;
+
+  override parent: BaseMacro.Parent;
+
+  static override createDocuments<Temporary extends boolean | undefined = false>(
+    data: Array<Macro.Implementation | Macro.CreateData> | undefined,
+    operation?: Document.Database.CreateOperation<Macro.Database.Create<Temporary>>,
+  ): Promise<Array<Document.TemporaryIf<Macro.Implementation, Temporary>>>;
+
+  static override updateDocuments(
+    updates: Macro.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<Macro.Database.Update>,
+  ): Promise<Macro.Implementation[]>;
+
+  static override deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: Document.Database.DeleteDocumentsOperation<Macro.Database.Delete>,
+  ): Promise<Macro.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = false>(
+    data: Macro.CreateData | Macro.CreateData[],
+    operation?: Macro.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<Macro.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: Macro.UpdateData | undefined,
+    operation?: Macro.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: Macro.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(documentId: string, options?: Macro.Database.GetOptions): Macro.Implementation | null;
+
+  static override getCollectionName(name: string): null;
+
+  // Same as Document for now
+  override traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
+
+  override getFlag<Scope extends Macro.Flags.Scope, Key extends Macro.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<Macro.Name, Scope, Key>;
+
+  override setFlag<
+    Scope extends Macro.Flags.Scope,
+    Key extends Macro.Flags.Key<Scope>,
+    Value extends Document.GetFlag<Macro.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
+
+  override unsetFlag<Scope extends Macro.Flags.Scope, Key extends Macro.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Promise<this>;
+
+  protected override _preCreate(
+    data: Macro.CreateData,
+    options: Macro.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onCreate(data: Macro.CreateData, options: Macro.Database.OnCreateOperation, userId: string): void;
+
+  protected static override _preCreateOperation(
+    documents: Macro.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<Macro.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onCreateOperation(
+    documents: Macro.Implementation[],
+    operation: Macro.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preUpdate(
+    changed: Macro.UpdateData,
+    options: Macro.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onUpdate(
+    changed: Macro.UpdateData,
+    options: Macro.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preUpdateOperation(
+    documents: Macro.Implementation[],
+    operation: Macro.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onUpdateOperation(
+    documents: Macro.Implementation[],
+    operation: Macro.Database.Update,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preDelete(
+    options: Macro.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onDelete(options: Macro.Database.OnDeleteOperation, userId: string): void;
+
+  protected static override _preDeleteOperation(
+    documents: Macro.Implementation[],
+    operation: Macro.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onDeleteOperation(
+    documents: Macro.Implementation[],
+    operation: Macro.Database.Delete,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  static override get hasSystemData(): true;
+
+  // These data field things have been ticketed but will probably go into backlog hell for a while.
+  // We'll end up copy and pasting without modification for now I think. It makes it a tiny bit easier to update though.
+
+  // 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;
+
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onCreateDocuments` static method is deprecated in favor of {@link Document._onCreateOperation | `Document._onCreateOperation`}"
+   */
+  protected static override _onCreateDocuments(
+    documents: Macro.Implementation[],
+    context: Document.ModificationContext<Macro.Parent>,
+  ): Promise<void>;
+
   /**
-   * @privateRemarks _preCreate all 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.
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onUpdateDocuments` static method is deprecated in favor of {@link Document._onUpdateOperation | `Document._onUpdateOperation`}"
    */
+  protected static override _onUpdateDocuments(
+    documents: Macro.Implementation[],
+    context: Document.ModificationContext<Macro.Parent>,
+  ): Promise<void>;
+
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onDeleteDocuments` static method is deprecated in favor of {@link Document._onDeleteOperation | `Document._onDeleteOperation`}"
+   */
+  protected static override _onDeleteDocuments(
+    documents: Macro.Implementation[],
+    context: Document.ModificationContext<Macro.Parent>,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static override _schema: SchemaField<Macro.Schema>;
+
+  static override get schema(): SchemaField<Macro.Schema>;
+
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(source: Macro.CreateData, context?: DataModel.FromSourceOptions): Macro.Implementation;
+
+  static override fromJSON(json: string): Macro.Implementation;
+
+  static #BaseMacro: true;
 }
 export default BaseMacro;
 
 declare namespace BaseMacro {
-  type Parent = null;
-
-  type TypeNames = Game.Model.TypeNames<"Macro">;
-
-  type Metadata = Document.MetadataFor<BaseMacro>;
-
-  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 Macro document
-     * @defaultValue `null`
-     */
-    _id: fields.DocumentIdField;
-
-    /**
-     * The name of this Macro
-     * @defaultValue `""`
-     */
-    name: fields.StringField<{
-      required: true;
-      blank: false;
-      label: "Name";
-      textSearch: true;
-    }>;
-
-    /**
-     * A Macro subtype from CONST.MACRO_TYPES
-     * @defaultValue `CONST.MACRO_TYPES.CHAT`
-     */
-    type: fields.DocumentTypeField<
-      typeof BaseMacro,
-      {
-        initial: typeof CONST.MACRO_TYPES.CHAT;
-        label: "Type";
-      }
-    >;
-
-    /**
-     * The _id of a User document which created this Macro *
-     * @defaultValue `game?.user?.id`
-     */
-    author: fields.ForeignDocumentField<typeof documents.BaseUser, { initial: () => string }>;
-
-    /**
-     * An image file path which provides the thumbnail artwork for this Macro
-     * @defaultValue `BaseMacro.DEFAULT_ICON`
-     */
-    img: fields.FilePathField<{
-      categories: ["IMAGE"];
-      initial: () => typeof BaseMacro.DEFAULT_ICON;
-      label: "Image";
-    }>;
-
-    /**
-     * The scope of this Macro application from CONST.MACRO_SCOPES
-     * @defaultValue `"global"`
-     */
-    scope: fields.StringField<{
-      required: true;
-      choices: CONST.MACRO_SCOPES[];
-      initial: (typeof CONST.MACRO_SCOPES)[0];
-      validationError: "must be a value in CONST.MACRO_SCOPES";
-      label: "Scope";
-    }>;
-
-    /**
-     * The string content of the macro command
-     * @defaultValue `""`
-     */
-    command: fields.StringField<{
-      required: true;
-      blank: true;
-      label: "Command";
-    }>;
-
-    /**
-     * The _id of a Folder which contains this Macro
-     * @defaultValue `null`
-     */
-    folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
-
-    /**
-     * The numeric sort value which orders this Macro relative to its siblings
-     * @defaultValue `0`
-     */
-    sort: fields.IntegerSortField;
-
-    /**
-     * An object which configures ownership of this Macro
-     * @defaultValue see {@link fields.DocumentOwnershipField}
-     */
-    ownership: fields.DocumentOwnershipField;
-
-    /**
-     * An object of optional key/value flags
-     * @defaultValue `{}`
-     */
-    flags: fields.ObjectField.FlagsField<"Macro">;
-
-    /**
-     * An object of creation and access information
-     * @defaultValue see {@link fields.DocumentStatsField}
-     */
-    _stats: fields.DocumentStatsField;
-  }
+  export import Name = Macro.Name;
+  export import ConstructorArgs = Macro.ConstructorArgs;
+  export import Hierarchy = Macro.Hierarchy;
+  export import Metadata = Macro.Metadata;
+  export import SubType = Macro.SubType;
+  export import ConfiguredSubTypes = Macro.ConfiguredSubTypes;
+  export import Known = Macro.Known;
+  export import OfType = Macro.OfType;
+  export import Parent = Macro.Parent;
+  export import Descendant = Macro.Descendant;
+  export import DescendantClass = Macro.DescendantClass;
+  export import Pack = Macro.Pack;
+  export import Embedded = Macro.Embedded;
+  export import ParentCollectionName = Macro.ParentCollectionName;
+  export import CollectionClass = Macro.CollectionClass;
+  export import Collection = Macro.Collection;
+  export import Invalid = Macro.Invalid;
+  export import Stored = Macro.Stored;
+  export import Source = Macro.Source;
+  export import PersistedData = Macro.PersistedData;
+  export import CreateData = Macro.CreateData;
+  export import InitializedData = Macro.InitializedData;
+  export import UpdateData = Macro.UpdateData;
+  export import Schema = Macro.Schema;
+  export import DatabaseOperation = Macro.Database;
+  export import Flags = Macro.Flags;
+
+  /**
+   * @deprecated This type is used by Foundry too vaguely.
+   * In one context the most correct type is after initialization whereas in another one it should be
+   * before but Foundry uses it interchangeably.
+   */
+  type Properties = SchemaField.InitializedData<Schema>;
+
+  /** @deprecated {@link BaseMacro.SubType | `BaseMacro.SubType`} */
+  type TypeNames = SubType;
+
+  /**
+   * @deprecated {@link foundry.data.fields.SchemaField | `SchemaField<BaseMacro.Schema>`}
+   */
+  type SchemaField = foundry.data.fields.SchemaField<Schema>;
+
+  /**
+   * @deprecated {@link BaseMacro.CreateData | `BaseMacro.CreateData`}
+   */
+  type ConstructorData = BaseMacro.CreateData;
 }