@league-of-foundry-developers/foundry-vtt-types 0.8.9-4 → 0.8.9-8

package/README.md

@@ -1,7 +1,5 @@
 # foundry-vtt-types
 
-
-
 <div align=center>
 
 TypeScript type definitions for [Foundry Virtual Tabletop](https://foundryvtt.com/) (unofficial)
@@ -19,10 +17,16 @@ TypeScript type definitions for [Foundry Virtual Tabletop](https://foundryvtt.co
 
 We aim to support the latest patch release of minor versions of Foundry VTT, starting with 0.7.
 
-At the moment, the latest 0.7.x and 0.8.x versions are supported. However, note that work on 0.8.x has not been completed yet, so there are still quite a few things which are either missing or typed incorrectly. Take a look at [0.8.x issues](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+0.8.x%22) to see what still needs to be done.
+At the moment, the latest 0.7.x and 0.8.x versions are supported. However, note that work on 0.8.x has not been
+completed yet, so there are still quite a few things which are either missing or typed incorrectly. Take a look at
+[0.8.x issues](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+0.8.x%22)
+to see what still needs to be done.
+
 ## Installation
 
-You can install foundry-vtt-types from the [npm registry](https://npmjs.org/). We provide distribution tags for the different supported Foundry VTT versions that have the form `fvtt-<foundry-version>`. For example, the distribution tag for Foundry VTT 0.8.8 is `fvtt-0.8.8`.
+You can install foundry-vtt-types from the [npm registry](https://npmjs.org/). We provide distribution tags for the
+different supported Foundry VTT versions that have the form `fvtt-<foundry-version>`. For example, the distribution tag
+for Foundry VTT 0.8.8 is `fvtt-0.8.8`.
 
 In order to install the desired version, run
 
@@ -36,7 +40,8 @@ For example, to install the type definitions for Foundry VTT 0.8.8 run
 npm install --save-dev @league-of-foundry-developers/foundry-vtt-types@fvtt-0.8.8
 ```
 
-You can then update foundry-vtt-types using the regular update mechanism for npm (see [npm update](https://docs.npmjs.com/cli/v7/commands/npm-update)).
+You can then update foundry-vtt-types using the regular update mechanism for npm
+(see [npm update](https://docs.npmjs.com/cli/v7/commands/npm-update)).
 
 ## Usage
 
@@ -54,29 +59,42 @@ Add foundry-vtt-types to your types section in your `tsconfig.json`:
 
 This will make the type definitions available globally in your project.
 
-Make sure you are using `"moduleResolution": "node"`, too. It is required for some dependencies to be resolved correctly.
+Make sure you are using `"moduleResolution": "node"`, too. It is required for some dependencies to be resolved
+correctly.
 
-Also make sure to set `"strictNullChecks": true` because otherwise, some of the conditional types used in the type definitions resolve incorrectly and you will see a lot of errors.
+Also make sure to set `"strictNullChecks": true` because otherwise, some of the conditional types used in the type
+definitions resolve incorrectly and you will see a lot of errors.
 
-You can find some information about how to actually work with the type definitions in the [Wiki](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/wiki). If you are working with Foundry VTT 0.8.x, a good starting point is [[0.8.x] FAQ](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/wiki/%5B0.8.x%5D-FAQ).
+You can find some information about how to actually work with the type definitions in the
+[Wiki](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/wiki). If you are working with Foundry VTT
+0.8.x, a good starting point is
+[[0.8.x] FAQ](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/wiki/%5B0.8.x%5D-FAQ).
 
 ## Acknowledgments
 
-Originally forked from [Foundry Project Creator Types](https://gitlab.com/foundry-projects/foundry-pc/foundry-pc-types) by [@NickEastNL](https://gitlab.com/NvanOosten)
+Originally forked from [Foundry Project Creator Types](https://gitlab.com/foundry-projects/foundry-pc/foundry-pc-types)
+by [@NickEastNL](https://gitlab.com/NvanOosten)
 
 ## Contributing
 
-Contributions are very welcome in order to decrease the individual workload. Filing issues for wrong / missing types is also a great way to help us improve the type definitions.
+Contributions are very welcome in order to decrease the individual workload. Filing issues for wrong / missing types is
+also a great way to help us improve the type definitions.
 
-There are individual branches for the different supported Foundry VTT versions that are being worked on. They are named according to the minor version of the Foundry VTT version, e.g. the branch for Foundry VTT 0.8 is called `foundry-0.8.x`. All work to improve the type definitions for a specific version needs to be done through Pull Requests to the corresponding branch.
+There are individual branches for the different supported Foundry VTT versions that are being worked on. They are named
+according to the minor version of the Foundry VTT version, e.g. the branch for Foundry VTT 0.8 is called
+`foundry-0.8.x`. All work to improve the type definitions for a specific version needs to be done through Pull Requests
+to the corresponding branch.
 
 Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more details on how to contribute.
 
-If you have any specific questions, feel free to contact us in the [League of Extraordinary Foundry Developers Discord](https://discord.gg/52DNPzqm2Z).
+If you have any specific questions, feel free to contact us in the
+[League of Extraordinary Foundry Developers Discord](https://discord.gg/52DNPzqm2Z).
 
 ## Type-Checking, Linting, Testing
 
-When contributing, make sure sure that the type checks pass, the linter is green and the tests are green. We _do_ have checks in the CI but running this locally also helps you while developing and saves you time as you don't have to wait for the CI.
+When contributing, make sure sure that the type checks pass, the linter is green and the tests are green. We _do_ have
+checks in the CI but running this locally also helps you while developing and saves you time as you don't have to wait
+for the CI.
 
 You can run type checking and linting with the following command:
 
@@ -90,6 +108,16 @@ You can run the tests with
 npm run test
 ```
 
+## Creating a release
+
+To create a release, you have to create a new release commit, tag it and create a GitHub release from that. The CI will
+handle the rest.
+
+```
+npm version prerelease
+git push --follow-tags
+```
+
 ## License
 
 This project is licensed under the MIT license. You can find a copy at [LICENSE](LICENSE).

package/index-lenient.d.ts

@@ -0,0 +1,10 @@
+import './index';
+
+declare global {
+  interface LenientGlobalVariableTypes {
+    canvas: never;
+    game: never;
+    socket: never;
+    ui: never;
+  }
+}

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "0.8.9-4",
+  "version": "0.8.9-8",
   "description": "TypeScript type definitions for Foundry VTT",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts"
+    },
+    "./lenient": {
+      "types": "./index-lenient.d.ts"
+    }
+  },
   "scripts": {
     "lint": "./node_modules/typescript/bin/tsc && eslint --ext .d.ts,.test-d.ts .",
     "lint:fix": "eslint --fix --ext .d.ts,.test-d.ts .",
@@ -60,6 +68,7 @@
   },
   "files": [
     "index.d.ts",
+    "index-lenient.d.ts",
     "src"
   ],
   "publishConfig": {

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

@@ -27,22 +27,28 @@ declare abstract class DatabaseBackend {
 
   /**
    * Get primary Document instances
+   * @remarks
+   * foundry actually declares this function to take parameters `documentClass`, `query`, `options`, and `user` but
+   * that's not how it is called and also not how the subclasses implement it.
+   * See https://gitlab.com/foundrynet/foundryvtt/-/issues/6177
    */
   protected abstract _getDocuments<T extends Document<any, any>>(
     documentClass: ConstructorOf<T>,
-    query: Request,
-    options: RequestOptions,
+    request: Request,
     user: BaseUser
   ): Promise<T[]>;
 
   /**
    * Get embedded Document instances
+   * @remarks
+   * foundry actually declares this function to take parameters `documentClass`, `parent`, `query`, `options`, and
+   * `user` but that's not how it is called and also not how the subclasses implement it.
+   * See https://gitlab.com/foundrynet/foundryvtt/-/issues/6177
    */
   protected abstract _getEmbeddedDocuments<T extends Document<any, any>>(
     documentClass: ConstructorOf<T>,
     parent: T extends Document<any, infer U> ? U : never,
-    query: Request,
-    options: RequestOptions,
+    request: Request,
     user: BaseUser
   ): Promise<T[]>;
 
@@ -198,7 +204,8 @@ declare abstract class DatabaseBackend {
    * @param action    - The action performed
    * @param type      - The document type
    * @param documents - The documents modified
-   * @param info      - The logging level
+   * @param level     - The logging level
+   *                    (default: `'info'`)
    * @param parent    - A parent document
    * @param pack      - A compendium pack within which the operation occurred
    */
@@ -225,24 +232,16 @@ declare abstract class DatabaseBackend {
   protected _logContext({ parent, pack }?: { parent?: Document<any, any>; pack?: string }): string;
 }
 
-interface Request {
+export interface Request {
   data?: AnyDocumentData[];
   updates?: AnyDocumentData[];
   ids?: string[];
   parent?: Document<any, any>;
-  query?: object | IdQuery | SceneIdUserQuery;
+  query?: Record<string, unknown>;
   options?: RequestOptions;
   pack?: string;
 }
 
-export interface IdQuery {
-  _id: string;
-}
-export interface SceneIdUserQuery {
-  sceneId: string;
-  user: string;
-}
-
 export interface RequestOptions {
   index?: boolean;
   broadcast?: boolean;

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

@@ -1,5 +1,4 @@
 import { BaseUser } from '../documents.mjs';
-import DatabaseBackend from './backend.mjs';
 import { AnyDocumentData } from './data.mjs';
 import {
   ConfiguredDocumentClass,
@@ -82,7 +81,7 @@ declare abstract class Document<
   /**
    * The database backend used to execute operations and handle results
    */
-  static get database(): DatabaseBackend; // TODO: Reference type defined in CONFIG
+  static get database(): CONFIG['DatabaseBackend'];
 
   /**
    * Return a reference to the implemented subclass of this base document type.
@@ -703,6 +702,11 @@ export interface DocumentModificationOptions {
    */
   index?: boolean;
 
+  /**
+   * An array of fields to retrieve when indexing the collection
+   */
+  indexFields?: string[];
+
   /**
    * When performing a creation operation, keep the provided _id instead of clearing it.
    * @defaultValue `false`

package/src/foundry/common/data/data.mjs/drawingData.d.ts

@@ -3,7 +3,12 @@ import { BaseUser } from '../../documents.mjs';
 import { ForeignDocumentField } from '../fields.mjs';
 import * as fields from '../fields.mjs';
 import * as documents from '../../documents.mjs';
-import { ConfiguredDocumentClass, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
+import {
+  ConfiguredDocumentClass,
+  ConfiguredFlags,
+  FieldReturnType,
+  PropertiesToSource
+} from '../../../../types/helperTypes';
 
 interface DrawingDataSchema extends DocumentSchema {
   _id: typeof fields.DOCUMENT_ID;
@@ -211,7 +216,7 @@ interface DrawingDataProperties {
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags: Record<string, unknown>;
+  flags: ConfiguredFlags<'Drawing'>;
 }
 
 interface DrawingDataConstructorData {
@@ -365,7 +370,7 @@ interface DrawingDataConstructorData {
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: Record<string, unknown> | null;
+  flags?: ConfiguredFlags<'Drawing'> | null;
 }
 
 /**

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

@@ -13,6 +13,8 @@ export { JournalEntryData } from './journalEntryData';
 export { MacroData } from './macroData';
 export { MeasuredTemplateData } from './measuredTemplateData';
 export { NoteData } from './noteData';
+export { PlaylistData } from './playlistData';
+export { PlaylistSoundData } from './playlistSoundData';
 export { PrototypeTokenData } from './prototypeTokenData';
 export { RollTableData } from './rollTableData';
 export { SceneData } from './sceneData';

package/src/foundry/common/data/data.mjs/playlistData.d.ts

@@ -0,0 +1,171 @@
+import * as documents from '../../documents.mjs';
+import * as fields from '../fields.mjs';
+
+import type { ConfiguredDocumentClass, ConfiguredFlags, PropertiesToSource } from '../../../../types/helperTypes';
+import type EmbeddedCollection from '../../abstract/embedded-collection.mjs';
+import type DocumentData from '../../abstract/data.mjs';
+
+interface PlaylistDataSchema extends DocumentSchema {
+  _id: typeof fields.DOCUMENT_ID;
+  name: typeof fields.REQUIRED_STRING;
+  description: typeof fields.BLANK_STRING;
+  sounds: fields.EmbeddedCollectionField<typeof documents.BasePlaylistSound>;
+  mode: DocumentField<foundry.CONST.PlaylistMode> & {
+    type: typeof Number;
+    required: true;
+    default: typeof CONST.PLAYLIST_MODES.SEQUENTIAL;
+    validate: (m: unknown) => m is foundry.CONST.PlaylistMode;
+    validationError: 'Invalid {name} {field} provided which must be a value from CONST.PLAYLIST_MODES';
+  };
+  playing: typeof fields.BOOLEAN_FIELD;
+  fade: typeof fields.INTEGER_FIELD;
+  folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
+  sort: typeof fields.INTEGER_SORT_FIELD;
+  seed: typeof fields.NONNEGATIVE_INTEGER_FIELD;
+  permission: typeof fields.DOCUMENT_PERMISSIONS;
+  flags: typeof fields.OBJECT_FIELD;
+}
+
+interface PlaylistDataProperties {
+  /**
+   * The _id which uniquely identifies this Playlist document
+   */
+  _id: string | null;
+
+  /**
+   * The name of this playlist
+   */
+  name: string;
+
+  /**
+   * @defaultValue `''`
+   */
+  description: string;
+
+  /**
+   * A Collection of PlaylistSounds embedded documents which belong to this playlist
+   */
+  sounds: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BasePlaylistSound>, PlaylistData>;
+
+  /**
+   * The playback mode for sounds in this playlist
+   * @defaultValue `CONST.PLAYLIST_MODES.SEQUENTIAL`
+   */
+  mode: foundry.CONST.PlaylistMode;
+
+  /**
+   * Is this playlist currently playing?
+   * @defaultValue `false`
+   */
+  playing: boolean;
+
+  fade: number | undefined;
+
+  /**
+   * The _id of a Folder which contains this playlist
+   * @defaultValue `null`
+   */
+  folder: string | null;
+
+  /**
+   * The numeric sort value which orders this playlist relative to its siblings
+   * @defaultValue `0`
+   */
+  sort: number;
+
+  seed: number | undefined;
+
+  /**
+   * An object which configures user permissions to this playlist
+   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
+   */
+  permission: Record<string, foundry.CONST.EntityPermission>;
+
+  /**
+   * An object of optional key/value flags
+   * @defaultValue `{}`
+   */
+  flags: ConfiguredFlags<'Playlist'>;
+}
+
+interface PlaylistDataConstructorData {
+  /**
+   * The _id which uniquely identifies this Playlist document
+   */
+  _id?: string | null | undefined;
+
+  /**
+   * The name of this playlist
+   */
+  name: string;
+
+  /**
+   * @defaultValue `''`
+   */
+  description?: string | null | undefined;
+
+  /**
+   * A Collection of PlaylistSounds embedded documents which belong to this playlist
+   */
+  sounds?:
+    | EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BasePlaylistSound>, PlaylistData>
+    | null
+    | undefined;
+
+  /**
+   * The playback mode for sounds in this playlist
+   * @defaultValue `CONST.PLAYLIST_MODES.SEQUENTIAL`
+   */
+  mode?: foundry.CONST.PlaylistMode | null | undefined;
+
+  /**
+   * Is this playlist currently playing?
+   * @defaultValue `false`
+   */
+  playing?: boolean | null | undefined;
+
+  fade?: number | undefined | null;
+
+  /**
+   * The _id of a Folder which contains this playlist
+   * @defaultValue `null`
+   */
+  folder?: string | null | undefined;
+
+  /**
+   * The numeric sort value which orders this playlist relative to its siblings
+   * @defaultValue `0`
+   */
+  sort?: number | null | undefined;
+
+  seed?: number | undefined | null;
+
+  /**
+   * An object which configures user permissions to this playlist
+   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
+   */
+  permission?: Record<string, foundry.CONST.EntityPermission> | undefined | null;
+
+  /**
+   * An object of optional key/value flags
+   * @defaultValue `{}`
+   */
+  flags?: ConfiguredFlags<'Playlist'> | null | undefined;
+}
+
+/**
+ * The data schema for a Playlist document.
+ * @see BasePlaylist
+ */
+export declare class PlaylistData extends DocumentData<
+  PlaylistDataSchema,
+  PlaylistDataProperties,
+  PropertiesToSource<PlaylistDataProperties>,
+  PlaylistDataConstructorData,
+  documents.BasePlaylist
+> {
+  static defineSchema(): PlaylistDataSchema;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface PlaylistData extends PlaylistDataProperties {}

package/src/foundry/common/data/data.mjs/playlistSoundData.d.ts

@@ -0,0 +1,143 @@
+import * as fields from '../fields.mjs';
+import type { ConfiguredFlags, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
+import type DocumentData from '../../abstract/data.mjs';
+import type { documents } from '../../module.mjs';
+
+interface PlaylistSoundDataSchema extends DocumentSchema {
+  _id: typeof fields.DOCUMENT_ID;
+  name: typeof fields.REQUIRED_STRING;
+  description: typeof fields.BLANK_STRING;
+  path: typeof fields.AUDIO_FIELD;
+  playing: typeof fields.BOOLEAN_FIELD;
+  pausedTime: FieldReturnType<typeof fields.NUMERIC_FIELD, { default: null }>;
+  repeat: typeof fields.BOOLEAN_FIELD;
+  volume: FieldReturnType<typeof fields.ALPHA_FIELD, { default: 0.5 }>;
+  fade: typeof fields.INTEGER_FIELD;
+  flags: typeof fields.OBJECT_FIELD;
+}
+
+interface PlaylistSoundDataProperties {
+  /**
+   * The _id which uniquely identifies this PlaylistSound document
+   */
+  _id: string | null;
+
+  /**
+   * The name of this sound track
+   */
+  name: string;
+
+  /**
+   * @defaultValue `''`
+   */
+  description: string;
+
+  /**
+   * The audio file path that is played by this sound
+   */
+  path: string | undefined | null;
+
+  /**
+   * Is this sound currently playing?
+   * @defaultValue `false`
+   */
+  playing: boolean;
+
+  /**
+   * @defaultValue `null`
+   */
+  pausedTime: number | null;
+
+  /**
+   * Does this sound loop?
+   * @defaultValue `false`
+   */
+  repeat: boolean;
+
+  /**
+   * The audio volume of the sound, from 0 to 1
+   * @defaultValue `0.5`
+   */
+  volume: number;
+
+  fade: number | undefined;
+
+  /**
+   * An object of optional key/value flags
+   * @defaultValue `{}`
+   */
+  flags: ConfiguredFlags<'PlaylistSound'>;
+}
+
+interface PlaylistSoundDataConstructorData {
+  /**
+   * The _id which uniquely identifies this PlaylistSound document
+   */
+  _id?: string | null | undefined;
+
+  /**
+   * The name of this sound track
+   */
+  name: string;
+
+  /**
+   * @defaultValue `''`
+   */
+  description?: string | null | undefined;
+
+  /**
+   * The audio file path that is played by this sound
+   */
+  path?: string | undefined | null;
+
+  /**
+   * Is this sound currently playing?
+   * @defaultValue `false`
+   */
+  playing?: boolean | null | undefined;
+
+  /**
+   * @defaultValue `null`
+   */
+  pausedTime?: number | null | undefined;
+
+  /**
+   * Does this sound loop?
+   * @defaultValue `false`
+   */
+  repeat?: boolean | null | undefined;
+
+  /**
+   * The audio volume of the sound, from 0 to 1
+   * @defaultValue `0.5`
+   */
+  volume?: number | null | undefined;
+
+  fade?: number | null | undefined;
+
+  /**
+   * An object of optional key/value flags
+   * @defaultValue `{}`
+   */
+  flags?: ConfiguredFlags<'PlaylistSound'> | null | undefined;
+}
+
+/**
+ * The data schema for a PlaylistSound embedded document.
+ * @see BasePlaylistSound
+ */
+export declare class PlaylistSoundData extends DocumentData<
+  PlaylistSoundDataSchema,
+  PlaylistSoundDataProperties,
+  PropertiesToSource<PlaylistSoundDataProperties>,
+  PlaylistSoundDataConstructorData,
+  documents.BasePlaylistSound
+> {
+  static defineSchema(): PlaylistSoundDataSchema;
+
+  /** @override */
+  protected _initialize(): void;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface PlaylistSoundData extends PlaylistSoundDataProperties {}

package/src/foundry/common/data/fields.mjs.d.ts

@@ -80,8 +80,8 @@ interface AudioField extends DocumentField<string> {
 /**
  * A standard integer field which may be used in a Document.
  * @remarks
- * Property type: `string | undefined`
- * Constructor type: `string | undefined | null`
+ * Property type: `number | undefined`
+ * Constructor type: `number | undefined | null`
  */
 export declare const INTEGER_FIELD: IntegerField;
 interface IntegerField extends DocumentField<number> {

package/src/foundry/common/documents.mjs/basePlaylist.d.ts

@@ -1,11 +1,16 @@
 import { DocumentMetadata } from '../abstract/document.mjs';
 import { Document } from '../abstract/module.mjs';
+import * as data from '../data/data.mjs';
 import { BasePlaylistSound } from './basePlaylistSound';
 
 /**
  * The base Playlist model definition which defines common behavior of an Playlist document between both client and server.
  */
-export declare class BasePlaylist extends Document<any, any> {
+export declare class BasePlaylist extends Document<data.PlaylistData> {
+  /** @override */
+  static get schema(): typeof data.PlaylistData;
+
+  /** @override */
   static get metadata(): Merge<
     DocumentMetadata,
     {
@@ -18,4 +23,9 @@ export declare class BasePlaylist extends Document<any, any> {
       isPrimary: true;
     }
   >;
+
+  /**
+   * A reference to the Collection of ActiveEffect instances in the Actor document, indexed by _id.
+   */
+  get sounds(): this['data']['sounds'];
 }

package/src/foundry/common/documents.mjs/basePlaylistSound.d.ts

@@ -1,10 +1,22 @@
-import { DocumentMetadata } from '../abstract/document.mjs';
 import { Document } from '../abstract/module.mjs';
+import * as data from '../data/data.mjs';
+
+import type { BasePlaylist } from './basePlaylist';
+import type { BaseUser } from './baseUser';
+import type { DocumentMetadata } from '../abstract/document.mjs';
+import type { ConfiguredDocumentClass } from '../../../types/helperTypes';
 
 /**
  * The PlaylistSound model definition which defines common behaviour of a PlaylistSound document between both client and server.
  */
-export declare class BasePlaylistSound extends Document<any, any> {
+export declare class BasePlaylistSound extends Document<
+  data.PlaylistSoundData,
+  InstanceType<ConfiguredDocumentClass<typeof BasePlaylist>>
+> {
+  /** @override */
+  static get schema(): typeof data.PlaylistSoundData;
+
+  /** @override */
   static get metadata(): Merge<
     DocumentMetadata,
     {
@@ -14,4 +26,11 @@ export declare class BasePlaylistSound extends Document<any, any> {
       isEmbedded: true;
     }
   >;
+
+  /** @override */
+  testUserPermission(
+    user: BaseUser,
+    permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.EntityPermission,
+    { exact }?: { exact?: boolean }
+  ): boolean;
 }

package/src/foundry/common/types.mjs.d.ts

@@ -84,4 +84,9 @@ interface SocketResponse {
    * Data returned as a result of the request
    */
   data?: RequestData;
+
+  /**
+   * An Array of created data objects
+   */
+  result?: object[];
 }