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

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

@@ -1,8 +1,8 @@
-import type { AnyObject, InexactPartial } from "../../../types/utils.mts";
+import type { AnyMutableObject } from "#utils";
+import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
-import type { TextureData } from "../data/data.mts";
-import type * as fields from "../data/fields.d.mts";
-import type * as documents from "./_module.mts";
+import type { DataField, SchemaField } from "../data/fields.d.mts";
+import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
 /**
  * The Document definition for a Note.
@@ -11,16 +11,35 @@ 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 BaseNote extends Document<"Note", BaseNote.Schema, any> {
+declare abstract class BaseNote extends Document<"Note", BaseNote.Schema, any> {
   /**
-   * @param data    - Initial data from which to construct the Note
+   * @param data    - Initial data from which to construct the `BaseNote`
    * @param context - Construction context options
+   *
+   * @deprecated Constructing `BaseNote` 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 NoteDocument.implementation | `new NoteDocument.implementation(...)`} instead which will give you
+   * a system specific implementation of `NoteDocument`.
    */
-  // TODO(LukeAbby): This constructor is a symptom of a circular error.
-  // constructor(data?: BaseNote.ConstructorData, context?: Document.ConstructionContext<BaseNote.Parent>);
-
-  override parent: BaseNote.Parent;
+  constructor(...args: NoteDocument.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Note",
+   *   collection: "notes",
+   *   label: "DOCUMENT.Note",
+   *   labelPlural: "DOCUMENT.Notes",
+   *   permissions: {
+   *     create: "NOTE_CREATE"
+   *   },
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseNote.Metadata;
 
   static override defineSchema(): BaseNote.Schema;
@@ -31,153 +50,295 @@ declare class BaseNote extends Document<"Note", BaseNote.Schema, any> {
    */
   static DEFAULT_ICON: string;
 
+  /**
+   * @remarks Returns `true` for GMs regardless of `options.exact`
+   *
+   * If this is an unlinked note (lacks an `entryId`), returns `user.hasPermission("NOTE_CREATE")`. Otherwise,
+   * `this.entry.testUserPermission`, or `false` if `!this.entry`. Core's `JournalEntry` implementation doesn't
+   * override this method, so without further extension that's equivalent to {@link Document.testUserPermission | `Document#testUserPermission`}
+   * */
+  // options: not null (destructured)
   override testUserPermission(
-    user: foundry.documents.BaseUser,
-    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS,
-    options?: InexactPartial<{
-      /**
-       * Require the exact permission level requested?
-       * @defaultValue `false`
-       */
-      exact: boolean;
-    }>,
+    user: User.Internal.Implementation,
+    permission: Document.ActionPermission,
+    options?: Document.TestUserPermissionOptions,
   ): boolean;
 
-  static override migrateData(source: AnyObject): AnyObject;
-
-  static override shimData(
-    data: AnyObject,
-    options?: {
-      /**
-       * Apply shims to embedded models?
-       * @defaultValue `true`
-       */
-      embedded?: boolean;
-    },
-  ): AnyObject;
+  /*
+   * 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": "Note";
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+
+  override readonly parentCollection: NoteDocument.ParentCollectionName | null;
+
+  override readonly pack: string | null;
+
+  static override get implementation(): NoteDocument.ImplementationClass;
+
+  static override get baseDocument(): typeof BaseNote;
+
+  static override get collectionName(): NoteDocument.ParentCollectionName;
+
+  static override get documentName(): NoteDocument.Name;
+
+  static override get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+
+  static override get hasTypeData(): undefined;
+
+  static override get hierarchy(): NoteDocument.Hierarchy;
+
+  override parent: NoteDocument.Parent;
+
+  static override createDocuments<Temporary extends boolean | undefined = false>(
+    data: Array<NoteDocument.Implementation | NoteDocument.CreateData> | undefined,
+    operation?: Document.Database.CreateOperation<NoteDocument.Database.Create<Temporary>>,
+  ): Promise<Array<Document.TemporaryIf<NoteDocument.Implementation, Temporary>>>;
+
+  static override updateDocuments(
+    updates: NoteDocument.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<NoteDocument.Database.Update>,
+  ): Promise<NoteDocument.Implementation[]>;
+
+  static override deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: Document.Database.DeleteDocumentsOperation<NoteDocument.Database.Delete>,
+  ): Promise<NoteDocument.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = false>(
+    data: NoteDocument.CreateData | NoteDocument.CreateData[],
+    operation?: NoteDocument.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<NoteDocument.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: NoteDocument.UpdateData | undefined,
+    operation?: NoteDocument.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: NoteDocument.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(
+    documentId: string,
+    options?: NoteDocument.Database.GetOptions,
+  ): NoteDocument.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 NoteDocument.Flags.Scope, Key extends NoteDocument.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<NoteDocument.Name, Scope, Key>;
+
+  override setFlag<
+    Scope extends NoteDocument.Flags.Scope,
+    Key extends NoteDocument.Flags.Key<Scope>,
+    Value extends Document.GetFlag<NoteDocument.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
+
+  override unsetFlag<Scope extends NoteDocument.Flags.Scope, Key extends NoteDocument.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Promise<this>;
+
+  protected override _preCreate(
+    data: NoteDocument.CreateData,
+    options: NoteDocument.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onCreate(
+    data: NoteDocument.CreateData,
+    options: NoteDocument.Database.OnCreateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preCreateOperation(
+    documents: NoteDocument.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<NoteDocument.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onCreateOperation(
+    documents: NoteDocument.Implementation[],
+    operation: NoteDocument.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preUpdate(
+    changed: NoteDocument.UpdateData,
+    options: NoteDocument.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onUpdate(
+    changed: NoteDocument.UpdateData,
+    options: NoteDocument.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preUpdateOperation(
+    documents: NoteDocument.Implementation[],
+    operation: NoteDocument.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onUpdateOperation(
+    documents: NoteDocument.Implementation[],
+    operation: NoteDocument.Database.Update,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preDelete(
+    options: NoteDocument.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onDelete(options: NoteDocument.Database.OnDeleteOperation, userId: string): void;
+
+  protected static override _preDeleteOperation(
+    documents: NoteDocument.Implementation[],
+    operation: NoteDocument.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onDeleteOperation(
+    documents: NoteDocument.Implementation[],
+    operation: NoteDocument.Database.Delete,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  static override get hasSystemData(): undefined;
+
+  // 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: NoteDocument.Implementation[],
+    context: Document.ModificationContext<NoteDocument.Parent>,
+  ): Promise<void>;
+
+  /**
+   * @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: NoteDocument.Implementation[],
+    context: Document.ModificationContext<NoteDocument.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: NoteDocument.Implementation[],
+    context: Document.ModificationContext<NoteDocument.Parent>,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static override _schema: SchemaField<NoteDocument.Schema>;
+
+  static override get schema(): SchemaField<NoteDocument.Schema>;
+
+  static override validateJoint(data: NoteDocument.Source): void;
+
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(
+    source: NoteDocument.CreateData,
+    context?: DataModel.FromSourceOptions,
+  ): NoteDocument.Implementation;
+
+  static override fromJSON(json: string): NoteDocument.Implementation;
 }
 
 export default BaseNote;
 
 declare namespace BaseNote {
-  type Parent = Scene.ConfiguredInstance | null;
-
-  type Metadata = Document.MetadataFor<BaseNote>;
-
-  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 BaseNote embedded document
-     * @defaultValue `null`
-     */
-    _id: fields.DocumentIdField;
-
-    /**
-     * The _id of a JournalEntry document which this Note represents
-     * @defaultValue `null`
-     */
-    entryId: fields.ForeignDocumentField<typeof documents.BaseJournalEntry, { idOnly: true }>;
-
-    /**
-     * The _id of a specific JournalEntryPage document which this Note represents
-     * @defaultValue `null`
-     */
-    pageId: fields.ForeignDocumentField<typeof documents.BaseJournalEntryPage, { idOnly: true }>;
-
-    /**
-     * The x-coordinate position of the center of the note icon
-     * @defaultValue `0`
-     */
-    x: fields.NumberField<{ required: true; integer: true; nullable: false; initial: 0; label: "XCoord" }>;
-
-    /**
-     * The y-coordinate position of the center of the note icon
-     * @defaultValue `0`
-     */
-    y: fields.NumberField<{ required: true; integer: true; nullable: false; initial: 0; label: "YCoord" }>;
-
-    /**
-     * An image icon used to represent this note
-     * @defaultValue `BaseNote.DEFAULT_ICON`
-     */
-    texture: TextureData<{
-      categories: ["IMAGE"];
-      initial: () => typeof BaseNote.DEFAULT_ICON;
-      label: "NOTE.EntryIcon";
-    }>;
-
-    /**
-     * The pixel size of the map note icon
-     * @defaultValue `40`
-     */
-    iconSize: fields.NumberField<{
-      required: true;
-      integer: true;
-      min: 32;
-      initial: 40;
-      validationError: "must be an integer greater than 32";
-      label: "NOTE.IconSize";
-    }>;
-
-    /**
-     * Optional text which overrides the title of the linked Journal Entry
-     * @defaultValue `""`
-     */
-    text: fields.StringField<{ label: "NOTE.TextLabel"; textSearch: true }>;
-
-    /**
-     * The font family used to display the text label on this note, defaults to CONFIG.defaultFontFamily
-     * @defaultValue `globalThis.CONFIG?.defaultFontFamily || "Signika"`
-     */
-    fontFamily: fields.StringField<{ required: true; label: "NOTE.FontFamily"; initial: () => string }>;
-
-    /**
-     * The font size used to display the text label on this note
-     * @defaultValue `32`
-     */
-    fontSize: fields.NumberField<{
-      required: true;
-      integer: true;
-      min: 8;
-      max: 128;
-      initial: 32;
-      validationError: "must be an integer between 8 and 128";
-      label: "NOTE.FontSize";
-    }>;
-
-    /**
-     * A value in CONST.TEXT_ANCHOR_POINTS which defines where the text label anchors to the note icon.
-     * @defaultValue `CONST.TEXT_ANCHOR_POINTS.BOTTOM`
-     */
-    textAnchor: fields.NumberField<{
-      required: true;
-      choices: foundry.CONST.TEXT_ANCHOR_POINTS[];
-      initial: typeof CONST.TEXT_ANCHOR_POINTS.BOTTOM;
-      label: "NOTE.AnchorPoint";
-      validationError: "must be a value in CONST.TEXT_ANCHOR_POINTS";
-    }>;
-
-    /**
-     * The string that defines the color with which the note text is rendered
-     * @defaultValue `#FFFFFF`
-     */
-    textColor: fields.ColorField<{ initial: "#FFFFFF"; label: "NOTE.TextColor" }>;
-
-    /**
-     * Whether this map pin is globally visible or requires LoS to see.
-     * @defaultValue `false`
-     */
-    global: fields.BooleanField;
-
-    /**
-     * An object of optional key/value flags
-     * @defaultValue `{}`
-     */
-    flags: fields.ObjectField.FlagsField<"Note">;
-  }
+  export import Name = NoteDocument.Name;
+  export import ConstructorArgs = NoteDocument.ConstructorArgs;
+  export import Hierarchy = NoteDocument.Hierarchy;
+  export import Metadata = NoteDocument.Metadata;
+  export import Parent = NoteDocument.Parent;
+  export import Descendant = NoteDocument.Descendant;
+  export import DescendantClass = NoteDocument.DescendantClass;
+  export import Pack = NoteDocument.Pack;
+  export import Embedded = NoteDocument.Embedded;
+  export import ParentCollectionName = NoteDocument.ParentCollectionName;
+  export import CollectionClass = NoteDocument.CollectionClass;
+  export import Collection = NoteDocument.Collection;
+  export import Invalid = NoteDocument.Invalid;
+  export import Stored = NoteDocument.Stored;
+  export import Source = NoteDocument.Source;
+  export import PersistedData = NoteDocument.PersistedData;
+  export import CreateData = NoteDocument.CreateData;
+  export import InitializedData = NoteDocument.InitializedData;
+  export import UpdateData = NoteDocument.UpdateData;
+  export import Schema = NoteDocument.Schema;
+  export import DatabaseOperation = NoteDocument.Database;
+  export import Flags = NoteDocument.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 foundry.data.fields.SchemaField | `SchemaField<BaseNote.Schema>`}
+   */
+  type SchemaField = foundry.data.fields.SchemaField<Schema>;
+
+  /**
+   * @deprecated {@link BaseNote.CreateData | `BaseNote.CreateData`}
+   */
+  type ConstructorData = BaseNote.CreateData;
 }