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

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

@@ -1,6 +1,8 @@
+import type { AnyMutableObject } from "#utils";
+import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
-import type * as fields from "../data/fields.d.mts";
-import type BaseUser from "./user.d.mts";
+import type { DataField, SchemaField } from "../data/fields.d.mts";
+import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
 /**
  * The Setting Document.
@@ -9,69 +11,298 @@ import type BaseUser from "./user.d.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 BaseSetting extends Document<"Setting", BaseSetting.Schema, any> {
+declare abstract class BaseSetting extends Document<"Setting", BaseSetting.Schema, any> {
   /**
-   * @param data    - Initial data from which to construct the Setting
+   * @param data    - Initial data from which to construct the `BaseSetting`
    * @param context - Construction context options
+   *
+   * @deprecated Constructing `BaseSetting` 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 Setting.implementation | `new Setting.implementation(...)`} instead which will give you
+   * a system specific implementation of `Setting`.
    */
-  // TODO(LukeAbby): This constructor is a symptom of a circular error.
-  // constructor(data: BaseSetting.ConstructorData, context?: Document.ConstructionContext<BaseSetting.Parent>);
-
-  override parent: BaseSetting.Parent;
+  constructor(...args: Setting.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Setting",
+   *   collection: "settings",
+   *   label: "DOCUMENT.Setting",
+   *   labelPlural: "DOCUMENT.Settings",
+   *   permissions: {
+   *     create: this.#canModify,
+   *     update: this.#canModify,
+   *     delete: this.#canModify
+   *   },
+   *   schemaVersion: "12.324"
+   * });
+   * ```
+   */
   static override metadata: BaseSetting.Metadata;
 
   static override defineSchema(): BaseSetting.Schema;
 
-  static canUserCreate(user: BaseUser): boolean;
+  /** @remarks Returns `user.hasPermission("SETTINGS_MODIFY")` */
+  static canUserCreate(user: User.Implementation): boolean;
+
+  /*
+   * 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": "Setting";
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+
+  override readonly parentCollection: Setting.ParentCollectionName | null;
+
+  override readonly pack: string | null;
+
+  static override get baseDocument(): typeof BaseSetting;
+
+  static override get implementation(): Setting.ImplementationClass;
+
+  static override get collectionName(): Setting.ParentCollectionName;
+
+  static override get documentName(): Setting.Name;
+
+  static override get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+
+  static override get hasTypeData(): undefined;
+
+  static override get hierarchy(): Setting.Hierarchy;
+
+  override parent: Setting.Parent;
+
+  static override createDocuments<Temporary extends boolean | undefined = false>(
+    data: Array<Setting.Implementation | Setting.CreateData> | undefined,
+    operation?: Document.Database.CreateOperation<Setting.Database.Create<Temporary>>,
+  ): Promise<Array<Document.TemporaryIf<Setting.Implementation, Temporary>>>;
+
+  static override updateDocuments(
+    updates: Setting.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<Setting.Database.Update>,
+  ): Promise<Setting.Implementation[]>;
+
+  static override deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: Document.Database.DeleteDocumentsOperation<Setting.Database.Delete>,
+  ): Promise<Setting.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = false>(
+    data: Setting.CreateData | Setting.CreateData[],
+    operation?: Setting.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<Setting.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: Setting.UpdateData | undefined,
+    operation?: Setting.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: Setting.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(documentId: string, options?: Setting.Database.GetOptions): Setting.Implementation | null;
+
+  static override getCollectionName(name: string): null;
+
+  // Same as Document for now
+  override traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
+
+  protected override _preCreate(
+    data: Setting.CreateData,
+    options: Setting.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onCreate(
+    data: Setting.CreateData,
+    options: Setting.Database.OnCreateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preCreateOperation(
+    documents: Setting.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<Setting.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onCreateOperation(
+    documents: Setting.Implementation[],
+    operation: Setting.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preUpdate(
+    changed: Setting.UpdateData,
+    options: Setting.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onUpdate(
+    changed: Setting.UpdateData,
+    options: Setting.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preUpdateOperation(
+    documents: Setting.Implementation[],
+    operation: Setting.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onUpdateOperation(
+    documents: Setting.Implementation[],
+    operation: Setting.Database.Update,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preDelete(
+    options: Setting.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onDelete(options: Setting.Database.OnDeleteOperation, userId: string): void;
+
+  protected static override _preDeleteOperation(
+    documents: Setting.Implementation[],
+    operation: Setting.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onDeleteOperation(
+    documents: Setting.Implementation[],
+    operation: Setting.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: Setting.Implementation[],
+    context: Document.ModificationContext<Setting.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: Setting.Implementation[],
+    context: Document.ModificationContext<Setting.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: Setting.Implementation[],
+    context: Document.ModificationContext<Setting.Parent>,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static override _schema: SchemaField<Setting.Schema>;
+
+  static override get schema(): SchemaField<Setting.Schema>;
+
+  static override validateJoint(data: Setting.Source): void;
+
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(source: Setting.CreateData, context?: DataModel.FromSourceOptions): Setting.Implementation;
+
+  static override fromJSON(json: string): Setting.Implementation;
+
+  static #BaseSetting: true;
 }
 
 export default BaseSetting;
 
 declare namespace BaseSetting {
-  type Parent = null;
-
-  type Metadata = Document.MetadataFor<BaseSetting>;
-
-  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 Setting document
-     * @defaultValue `null`
-     */
-    _id: fields.DocumentIdField;
-
-    /**
-     * The setting key, a composite of \{scope\}.\{name\}
-     * @defaultValue `""`
-     */
-    key: fields.StringField<{
-      required: true;
-      nullable: false;
-      blank: false;
-      validate: (k: string) => boolean;
-      validationError: "must have the format {scope}.{field}";
-    }>;
-
-    /**
-     * The setting value, which is serialized to JSON
-     * @defaultValue `undefined`
-     */
-    value: fields.JSONField<{
-      required: true;
-      nullable: true;
-      initial: null;
-    }>;
-
-    /**
-     * An object of creation and access information
-     * @defaultValue see {@link fields.DocumentStatsField}
-     */
-    _stats: fields.DocumentStatsField;
-  }
+  export import Name = Setting.Name;
+  export import ConstructorArgs = Setting.ConstructorArgs;
+  export import Hierarchy = Setting.Hierarchy;
+  export import Metadata = Setting.Metadata;
+  export import Parent = Setting.Parent;
+  export import Descendant = Setting.Descendant;
+  export import DescendantClass = Setting.DescendantClass;
+  export import Pack = Setting.Pack;
+  export import Embedded = Setting.Embedded;
+  export import ParentCollectionName = Setting.ParentCollectionName;
+  export import CollectionClass = Setting.CollectionClass;
+  export import Collection = Setting.Collection;
+  export import Invalid = Setting.Invalid;
+  export import Stored = Setting.Stored;
+  export import Source = Setting.Source;
+  export import PersistedData = Setting.PersistedData;
+  export import CreateData = Setting.CreateData;
+  export import InitializedData = Setting.InitializedData;
+  export import UpdateData = Setting.UpdateData;
+  export import Schema = Setting.Schema;
+  export import DatabaseOperation = Setting.Database;
+
+  /**
+   * @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<BaseSetting.Schema>`}
+   */
+  type SchemaField = foundry.data.fields.SchemaField<Schema>;
+
+  /**
+   * @deprecated {@link BaseSetting.CreateData | `BaseSetting.CreateData`}
+   */
+  type ConstructorData = BaseSetting.CreateData;
 }