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

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

@@ -1,9 +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 * as CONST from "../constants.mts";
-import type * as fields from "../data/fields.d.mts";
-import type { ShapeData } from "../data/module.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 Drawing.
@@ -12,229 +11,351 @@ 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 BaseDrawing extends Document<"Drawing", BaseDrawing.Schema, any> {
+declare abstract class BaseDrawing extends Document<"Drawing", BaseDrawing.Schema, any> {
   /**
-   * @param data    - Initial data from which to construct the Drawing
+   * @param data    - Initial data from which to construct the `BaseDrawing`
    * @param context - Construction context options
+   *
+   * @deprecated Constructing `BaseDrawing` 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 DrawingDocument.implementation | `new DrawingDocument.implementation(...)`} instead which will give you
+   * a system specific implementation of `DrawingDocument`.
    */
-  // TODO(LukeAbby): This constructor is a symptom of a circular error.
-  // constructor(data?: BaseDrawing.ConstructorData, context?: Document.ConstructionContext<BaseDrawing.Parent>);
-
-  override parent: BaseDrawing.Parent;
+  constructor(...args: DrawingDocument.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Drawing",
+   *   collection: "drawings",
+   *   label: "DOCUMENT.Drawing",
+   *   labelPlural: "DOCUMENT.Drawings",
+   *   isEmbedded: true,
+   *   permissions: {
+   *     create: this.#canCreate,
+   *     update: this.#canUpdate
+   *   },
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseDrawing.Metadata;
 
   static override defineSchema(): BaseDrawing.Schema;
 
+  /** @remarks Returns `user.hasPermission("DRAWING_CREATE")` */
+  static override canUserCreate(user: User.Implementation): boolean;
+
   /**
-   * Validate whether the drawing has some visible content (as required by validation).
+   * @remarks Returns `true` if `user` is the `author` of the `Drawing` and `options.exact` is falsey.
+   * Otherwise, forwards to {@link Document.testUserPermission | `Document#testUserPermission`}
    */
-  static #validateVisibleContent(data: BaseDrawing.UpdateData): boolean;
+  // options: not null (destructured)
+  override testUserPermission(
+    user: User.Implementation,
+    permission: Document.ActionPermission,
+    options?: Document.TestUserPermissionOptions,
+  ): boolean;
 
-  static override validateJoint(data: fields.SchemaField.InnerAssignmentType<documents.BaseDrawing.Schema>): void;
+  /**
+   * @remarks
+   * Migrations:
+   * - `z` to `elevation` (since v12, no specified end)
+   */
+  static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
   /**
-   * Is a user able to update or delete an existing Drawing document??
-   * @internal
+   * @remarks
+   * Shims:
+   * - `z` to `elevation` (since v12, until v14)
    */
-  static #canModify(user: documents.BaseUser, doc: BaseDrawing, data: BaseDrawing.UpdateData): boolean;
+  // options: not null (destructured)
+  static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
 
-  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;
-    }>,
+  /**
+   * @remarks
+   * @throws If `data` fails `BaseDrawing.#validateVisibleContent` validation (must have some visible text, fill, *or* line)
+   */
+  static override validateJoint(data: DrawingDocument.Source): void;
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks "You are accessing `z` which has been migrated to `elevation`"
+   */
+  get z(): this["elevation"];
+
+  /*
+   * After this point these are not really overridden methods.
+   * They are here because they're static properties but depend on the instance and so can't be
+   * defined DRY-ly while also being easily overridable.
+   */
+
+  static " fvtt_types_internal_document_name_static": "Drawing";
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+
+  override readonly parentCollection: DrawingDocument.ParentCollectionName | null;
+
+  override readonly pack: string | null;
+
+  static override get implementation(): DrawingDocument.ImplementationClass;
+
+  static override get baseDocument(): typeof BaseDrawing;
+
+  static override get collectionName(): DrawingDocument.ParentCollectionName;
+
+  static override get documentName(): DrawingDocument.Name;
+
+  static override get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+
+  static override get hasTypeData(): undefined;
+
+  static override get hierarchy(): DrawingDocument.Hierarchy;
+
+  override parent: DrawingDocument.Parent;
+
+  static override createDocuments<Temporary extends boolean | undefined = false>(
+    data: Array<DrawingDocument.Implementation | DrawingDocument.CreateData> | undefined,
+    operation?: Document.Database.CreateOperation<DrawingDocument.Database.Create<Temporary>>,
+  ): Promise<Array<Document.TemporaryIf<DrawingDocument.Implementation, Temporary>>>;
+
+  static override updateDocuments(
+    updates: DrawingDocument.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<DrawingDocument.Database.Update>,
+  ): Promise<DrawingDocument.Implementation[]>;
+
+  static override deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: Document.Database.DeleteDocumentsOperation<DrawingDocument.Database.Delete>,
+  ): Promise<DrawingDocument.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = false>(
+    data: DrawingDocument.CreateData | DrawingDocument.CreateData[],
+    operation?: DrawingDocument.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<DrawingDocument.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: DrawingDocument.UpdateData | undefined,
+    operation?: DrawingDocument.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: DrawingDocument.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(
+    documentId: string,
+    options?: DrawingDocument.Database.GetOptions,
+  ): DrawingDocument.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 DrawingDocument.Flags.Scope, Key extends DrawingDocument.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<DrawingDocument.Name, Scope, Key>;
+
+  override setFlag<
+    Scope extends DrawingDocument.Flags.Scope,
+    Key extends DrawingDocument.Flags.Key<Scope>,
+    Value extends Document.GetFlag<DrawingDocument.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
+
+  override unsetFlag<Scope extends DrawingDocument.Flags.Scope, Key extends DrawingDocument.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Promise<this>;
+
+  protected override _preCreate(
+    data: DrawingDocument.CreateData,
+    options: DrawingDocument.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onCreate(
+    data: DrawingDocument.CreateData,
+    options: DrawingDocument.Database.OnCreateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preCreateOperation(
+    documents: DrawingDocument.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<DrawingDocument.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onCreateOperation(
+    documents: DrawingDocument.Implementation[],
+    operation: DrawingDocument.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preUpdate(
+    changed: DrawingDocument.UpdateData,
+    options: DrawingDocument.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onUpdate(
+    changed: DrawingDocument.UpdateData,
+    options: DrawingDocument.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preUpdateOperation(
+    documents: DrawingDocument.Implementation[],
+    operation: DrawingDocument.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onUpdateOperation(
+    documents: DrawingDocument.Implementation[],
+    operation: DrawingDocument.Database.Update,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preDelete(
+    options: DrawingDocument.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onDelete(options: DrawingDocument.Database.OnDeleteOperation, userId: string): void;
+
+  protected static override _preDeleteOperation(
+    documents: DrawingDocument.Implementation[],
+    operation: DrawingDocument.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onDeleteOperation(
+    documents: DrawingDocument.Implementation[],
+    operation: DrawingDocument.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;
 
-  static override cleanData(source?: AnyObject, options?: fields.DataField.CleanOptions): AnyObject;
+  // 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: DrawingDocument.Implementation[],
+    context: Document.ModificationContext<DrawingDocument.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: DrawingDocument.Implementation[],
+    context: Document.ModificationContext<DrawingDocument.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: DrawingDocument.Implementation[],
+    context: Document.ModificationContext<DrawingDocument.Parent>,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static override _schema: SchemaField<DrawingDocument.Schema>;
 
-  static override migrateData(source: AnyObject): AnyObject;
+  static override get schema(): SchemaField<DrawingDocument.Schema>;
 
-  static override shimData(
-    data: AnyObject,
-    options?: {
-      /**
-       * Apply shims to embedded models?
-       * @defaultValue `true`
-       */
-      embedded?: boolean;
-    },
-  ): AnyObject;
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(
+    source: DrawingDocument.CreateData,
+    context?: DataModel.FromSourceOptions,
+  ): DrawingDocument.Implementation;
+
+  static override fromJSON(json: string): DrawingDocument.Implementation;
+
+  static #BaseDrawing: true;
 }
 
 export default BaseDrawing;
 
 declare namespace BaseDrawing {
-  type Parent = Scene.ConfiguredInstance | null;
-
-  type Metadata = Document.MetadataFor<BaseDrawing>;
-
-  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 BaseDrawing embedded document
-     * @defaultValue `null`
-     */
-    _id: fields.DocumentIdField;
-
-    /**
-     * The _id of the user who created the drawing
-     * @defaultValue `game.user?.id`
-     */
-    author: fields.ForeignDocumentField<typeof documents.BaseUser, { nullable: false; initial: () => string }>;
-
-    /**
-     * The geometric shape of the drawing
-     * @defaultValue see {@link ShapeData.Schema}
-     */
-    shape: fields.EmbeddedDataField<typeof ShapeData>;
-
-    /**
-     * The x-coordinate position of the top-left corner of the drawn shape
-     * @defaultValue `0`
-     */
-    x: fields.NumberField<{ required: true; nullable: false; initial: 0; label: "XCoord" }>;
-
-    /**
-     * The y-coordinate position of the top-left corner of the drawn shape
-     * @defaultValue `0`
-     */
-    y: fields.NumberField<{ required: true; nullable: false; initial: 0; label: "YCoord" }>;
-
-    /**
-     * The z-index of this drawing relative to other siblings
-     * @defaultValue `0`
-     */
-    z: fields.NumberField<{ required: true; integer: true; nullable: false; initial: 0; label: "DRAWING.ZIndex" }>;
-
-    /**
-     * The angle of rotation for the drawing figure
-     * @defaultValue `0`
-     */
-    rotation: fields.AngleField<{ label: "DRAWING.Rotation" }>;
-
-    /**
-     * An amount of bezier smoothing applied, between 0 and 1
-     * @defaultValue `0`
-     */
-    bezierFactor: fields.AlphaField<{
-      initial: 0;
-      label: "DRAWING.SmoothingFactor";
-      max: 0.5;
-      hint: "DRAWING.SmoothingFactorHint";
-    }>;
-
-    /**
-     * The fill type of the drawing shape, a value from CONST.DRAWING_FILL_TYPES
-     * @defaultValue `CONST.DRAWING_FILL_TYPES.NONE`
-     */
-    fillType: fields.NumberField<{
-      required: true;
-      initial: typeof CONST.DRAWING_FILL_TYPES.NONE;
-      choices: CONST.DRAWING_FILL_TYPES[];
-      label: "DRAWING.FillTypes";
-      validationError: "must be a value in CONST.DRAWING_FILL_TYPES";
-    }>;
-
-    /**
-     * An optional color string with which to fill the drawing geometry
-     * @defaultValue `game.user?.color`
-     */
-    fillColor: fields.ColorField<{ initial: () => string; label: "DRAWING.FillColor" }>;
-
-    /**
-     * The opacity of the fill applied to the drawing geometry
-     * @defaultValue `0.5`
-     */
-    fillAlpha: fields.AlphaField<{ initial: 0.5; label: "DRAWING.FillOpacity" }>;
-
-    /**
-     * The width in pixels of the boundary lines of the drawing geometry
-     * @defaultValue `8`
-     */
-    strokeWidth: fields.NumberField<{ integer: true; initial: 8; min: 0; label: "DRAWING.LineWidth" }>;
-
-    /**
-     * The color of the boundary lines of the drawing geometry
-     * @defaultValue `game.user?.color`
-     */
-    strokeColor: fields.ColorField<{ initial: () => string; label: "DRAWING.StrokeColor" }>;
-
-    /**
-     * The opacity of the boundary lines of the drawing geometry
-     * @defaultValue `1`
-     */
-    strokeAlpha: fields.AlphaField<{ initial: 1; label: "DRAWING.LineOpacity" }>;
-
-    /**
-     * The path to a tiling image texture used to fill the drawing geometry
-     * @defaultValue `null`
-     */
-    texture: fields.FilePathField<{ categories: ["IMAGE"]; label: "DRAWING.FillTexture" }>;
-
-    /**
-     * Optional text which is displayed overtop of the drawing
-     * @defaultValue `""`
-     */
-    text: fields.StringField<{ label: "DRAWING.TextLabel" }>;
-
-    /**
-     * The font family used to display text within this drawing, defaults to CONFIG.defaultFontFamily
-     * @defaultValue `globalThis.CONFIG?.defaultFontFamily || "Signika"`
-     */
-    fontFamily: fields.StringField<{ blank: false; label: "DRAWING.FontFamily"; initial: () => string }>;
-
-    /**
-     * The font size used to display text within this drawing
-     * @defaultValue `48`
-     */
-    fontSize: fields.NumberField<{
-      integer: true;
-      min: 8;
-      max: 256;
-      initial: 48;
-      label: "DRAWING.FontSize";
-      validationError: "must be an integer between 8 and 256";
-    }>;
-
-    /**
-     * The color of text displayed within this drawing
-     * @defaultValue `#FFFFFF`
-     */
-    textColor: fields.ColorField<{ initial: "#FFFFFF"; label: "DRAWING.TextColor" }>;
-
-    /**
-     * The opacity of text displayed within this drawing
-     * @defaultValue `1`
-     */
-    textAlpha: fields.AlphaField<{ label: "DRAWING.TextOpacity" }>;
-
-    /**
-     * Is the drawing currently hidden?
-     * @defaultValue `false`
-     */
-    hidden: fields.BooleanField;
-
-    /**
-     * Is the drawing currently locked?
-     * @defaultValue `false`
-     */
-    locked: fields.BooleanField;
-
-    /**
-     * An object of optional key/value flags
-     * @defaultValue `{}`
-     */
-    flags: fields.ObjectField.FlagsField<"Drawing">;
-  }
+  export import Name = DrawingDocument.Name;
+  export import ConstructorArgs = DrawingDocument.ConstructorArgs;
+  export import Hierarchy = DrawingDocument.Hierarchy;
+  export import Metadata = DrawingDocument.Metadata;
+  export import Parent = DrawingDocument.Parent;
+  export import Descendant = DrawingDocument.Descendant;
+  export import DescendantClass = DrawingDocument.DescendantClass;
+  export import Pack = DrawingDocument.Pack;
+  export import Embedded = DrawingDocument.Embedded;
+  export import ParentCollectionName = DrawingDocument.ParentCollectionName;
+  export import CollectionClass = DrawingDocument.CollectionClass;
+  export import Collection = DrawingDocument.Collection;
+  export import Invalid = DrawingDocument.Invalid;
+  export import Stored = DrawingDocument.Stored;
+  export import Source = DrawingDocument.Source;
+  export import PersistedData = DrawingDocument.PersistedData;
+  export import CreateData = DrawingDocument.CreateData;
+  export import InitializedData = DrawingDocument.InitializedData;
+  export import UpdateData = DrawingDocument.UpdateData;
+  export import Schema = DrawingDocument.Schema;
+  export import DatabaseOperation = DrawingDocument.Database;
+  export import Flags = DrawingDocument.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<BaseDrawing.Schema>`}
+   */
+  type SchemaField = foundry.data.fields.SchemaField<Schema>;
+
+  /**
+   * @deprecated {@link BaseDrawing.CreateData | `BaseDrawing.CreateData`}
+   */
+  type ConstructorData = BaseDrawing.CreateData;
 }