@league-of-foundry-developers/foundry-vtt-types 9.280.0 → 12.331.1-beta

package/src/foundry/common/abstract/embedded-collection.mjs.d.ts

@@ -1,79 +0,0 @@
-import _Collection from '../utils/collection.mjs';
-import { AnyDocumentData } from './data.mjs';
-import { DocumentConstructor, ToObjectFalseType } from '../../../types/helperTypes';
-
-type Collection<T> = Omit<_Collection<T>, 'set' | 'delete'>;
-
-interface CollectionConstructor {
-  new (): Collection<any>;
-  new <T>(entries?: readonly (readonly [string, T])[] | null): Collection<T>;
-  new <T>(iterable: Iterable<readonly [string, T]>): Collection<T>;
-  readonly [Symbol.species]: CollectionConstructor;
-  readonly prototype: Collection<any>;
-}
-
-declare const Collection: CollectionConstructor;
-
-/**
- * An extension of the Collection.
- * Used for the specific task of containing embedded Document instances within a parent Document.
- */
-declare class EmbeddedCollection<
-  ContainedDocumentConstructor extends DocumentConstructor,
-  ParentDocumentData extends AnyDocumentData
-> extends Collection<InstanceType<ContainedDocumentConstructor>> {
-  /**
-   * @param documentData  - The parent DocumentData instance to which this collection belongs
-   * @param sourceArray   - The source data array for the collection in the parent Document data
-   * @param documentClass - The Document class implementation contained by the collection
-   */
-  constructor(
-    documentData: ParentDocumentData,
-    sourceArray: ConstructorParameters<ContainedDocumentConstructor>[0][],
-    documentClass: ContainedDocumentConstructor
-  );
-
-  /**
-   * The parent DocumentData to which this EmbeddedCollection instance belongs.
-   */
-  readonly parent: ParentDocumentData;
-
-  /**
-   * The parent DocumentData to which this EmbeddedCollection instance belongs.
-   */
-  readonly document: ParentDocumentData['document'];
-
-  /**
-   * The Document implementation used to construct instances within this collection
-   */
-  readonly documentClass: ContainedDocumentConstructor;
-
-  /**
-   * The source data array from which the embedded collection is created
-   */
-  readonly _source: DeepPartial<InstanceType<ContainedDocumentConstructor>['data']['_source']>[];
-
-  /**
-   * Initialize the EmbeddedCollection object by constructing its contained Document instances
-   */
-  protected _initialize(): void;
-
-  set(
-    key: string,
-    value: InstanceType<ContainedDocumentConstructor>,
-    { modifySource }: { modifySource?: boolean }
-  ): this;
-
-  delete(key: string, { modifySource }: { modifySource?: boolean }): boolean;
-
-  /**
-   * Convert the EmbeddedCollection to an array of simple objects.
-   * @param source - Draw data for contained Documents from the underlying data source?
-   *                 (default: `true`)
-   * @returns The extracted array of primitive objects
-   */
-  toObject(source?: true): ReturnType<InstanceType<ContainedDocumentConstructor>['data']['toJSON']>[];
-  toObject(source: false): ToObjectFalseType<InstanceType<ContainedDocumentConstructor>['data']>[];
-}
-
-export default EmbeddedCollection;

package/src/foundry/common/abstract/module.mjs.d.ts

@@ -1,6 +0,0 @@
-/**
- * Abstract data classes which define the interfaces for data schema, document, and embedded document types.
- */
-export { default as DocumentData } from './data.mjs';
-export { default as Document } from './document.mjs';
-export { default as DatabaseBackend } from './backend.mjs';

package/src/foundry/common/config.mjs/index.d.ts

@@ -1 +0,0 @@
-export { ReleaseData } from './releaseData';

package/src/foundry/common/config.mjs/releaseData.d.ts

@@ -1,100 +0,0 @@
-import { PropertiesToSource } from '../../../types/helperTypes';
-import { DocumentData } from '../abstract/module.mjs';
-import * as fields from '../data/fields.mjs';
-
-export interface ReleaseDataSchema extends DocumentSchema {
-  generation: typeof fields.REQUIRED_NUMBER;
-  channel: typeof fields.REQUIRED_STRING;
-  suffix: typeof fields.STRING_FIELD;
-  build: typeof fields.REQUIRED_NUMBER;
-  time: typeof fields.TIMESTAMP_FIELD;
-  node_version: typeof fields.POSITIVE_INTEGER_FIELD;
-  notes: typeof fields.BLANK_STRING;
-  download: typeof fields.BLANK_STRING;
-}
-
-export interface ReleaseDataProperties {
-  /** The major generation of the Release */
-  generation: number;
-
-  /** The channel the Release belongs to, such as "stable" */
-  channel: string;
-
-  /** An optional appended string display for the Release */
-  suffix: string | undefined;
-
-  /** The internal build number for the Release */
-  build: number;
-
-  /** When the Release was released */
-  time: number | undefined;
-
-  /** The minimum required Node.js major version */
-  node_version: number | undefined;
-
-  /** Release notes for the update version */
-  notes: string;
-
-  /** A temporary download URL where this version may be obtained */
-  download: string;
-}
-
-export interface ReleaseDataConstructorData {
-  /** The major generation of the Release */
-  generation?: number | undefined | null;
-
-  /** The channel the Release belongs to, such as "stable" */
-  channel: string;
-
-  /** An optional appended string display for the Release */
-  suffix?: string | undefined | null;
-
-  /** The internal build number for the Release */
-  build?: number | undefined | null;
-
-  /** When the Release was released */
-  time?: number | undefined | null;
-
-  /** The minimum required Node.js major version */
-  node_version?: number | undefined | null;
-
-  /** Release notes for the update version */
-  notes?: string | undefined | null;
-
-  /** A temporary download URL where this version may be obtained */
-  download?: string | undefined | null;
-}
-
-type ReleaseDataSource = PropertiesToSource<ReleaseDataProperties>;
-
-/** A data object which represents the details of this Release of Foundry VTT */
-export declare class ReleaseData<
-  Schema extends ReleaseDataSchema = ReleaseDataSchema,
-  Properties extends ReleaseDataProperties = ReleaseDataProperties,
-  ConstructorData extends ReleaseDataConstructorData = ReleaseDataConstructorData
-> extends DocumentData<Schema, Properties, ReleaseDataSource, ConstructorData> {
-  static defineSchema(): ReleaseDataSchema;
-
-  /** A formatted string for shortened display, such as "Version 9" */
-  get shortDisplay(): string;
-
-  /** A formatted string for general display, such as "V9 Prototype 1" */
-  get display(): string;
-
-  /** A formatted string for Version compatibility checking, such as "9.150" */
-  get version(): string;
-
-  /**
-   * Is this ReleaseData object newer than some other version?
-   * @param other - Some other version to compare against
-   * @returns Is this ReleaseData a newer version?
-   */
-  isNewer(other: string | ReleaseData): boolean;
-
-  /**
-   * Is this ReleaseData object a newer generation than some other version?
-   * @param other - Some other version to compare against
-   * @returns Is this ReleaseData a newer generation?
-   */
-  isGenerationalChange(other: string | ReleaseData): boolean;
-}