@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1-beta.20250704.94554

package/src/foundry/public/scripts/ktx2/basis_transcoder.d.mts

@@ -0,0 +1,5 @@
+import type { BASIS as _BASIS } from "pixi-basis-ktx2";
+
+declare global {
+  var BASIS: _BASIS;
+}

package/src/foundry/public/scripts/ktx2/index.d.mts

@@ -0,0 +1,2 @@
+import "./pixi-ktx2.min.d.mts";
+import "./basis_transcoder.d.mts";

package/src/foundry/public/scripts/ktx2/pixi-ktx2.min.d.mts

@@ -0,0 +1,5 @@
+import type * as _PixiBasisKTX2 from "pixi-basis-ktx2";
+
+declare global {
+  var PixiBasisKTX2: typeof _PixiBasisKTX2;
+}

package/src/foundry/public/scripts/workers/image-compressor.d.mts

@@ -3,17 +3,25 @@ import * as worker from "../../../../types/workers/image-compressor.mjs";
 
 declare global {
   export import FORMATS = worker.FORMATS;
-  export import Debug = worker.Debug;
 
   export import ProcessBufferToBase64Options = worker.ProcessBufferToBase64Options;
+  export import ProcessBufferRedToBufferRGBAOptions = worker.ProcessBufferRedToBufferRGBAOptions;
+  export import ProcessBufferRGBAToBufferRedOptions = worker.ProcessBufferRGBAToBufferRedOptions;
+  export import CopyBufferOptions = worker.CopyBufferOptions;
+  export import Debug = worker.Debug;
   export import ExpandOrReduceBufferOptions = worker.ExpandOrReduceBufferOptions;
-  export import ProcessBufferToBase64Return = worker.ProcessBufferToBase64Return;
-  export import ProcessBufferRedToBufferRGBAReturn = worker.ProcessBufferRedToBufferRGBAReturn;
-  export import ProcessBufferRGBAToBufferREDReturn = worker.ProcessBufferRGBAToBufferREDReturn;
+  export import ControlHashesReturnObject = worker.ControlHashesReturnObject;
+
+  export import ProcessBufferToBase64Result = worker.ProcessBufferToBase64Result;
+  export import ProcessBufferRedToBufferRGBAResult = worker.ProcessBufferRedToBufferRGBAResult;
+  export import ProcessBufferRGBAToBufferRedResult = worker.ProcessBufferRGBAToBufferRedResult;
+  export import CopyBufferResult = worker.CopyBufferResult;
+  export import BufferOperationReturn = worker.BufferOperationReturn;
 
   export import processBufferToBase64 = worker.processBufferToBase64;
   export import processBufferRedToBufferRGBA = worker.processBufferRedToBufferRGBA;
   export import processBufferRGBAToBufferRED = worker.processBufferRGBAToBufferRED;
+  export import copyBuffer = worker.copyBuffer;
   export import controlHashes = worker.controlHashes;
   export import pixelsToOffscreenCanvas = worker.pixelsToOffscreenCanvas;
   export import offscreenToBase64 = worker.offscreenToBase64;

package/src/types/augments/particles.d.mts

@@ -1,6 +1,6 @@
 /* eslint-disable import-x/export */
 
-import type { Brand } from "fvtt-types/utils";
+import type { Brand } from "#utils";
 
 export namespace behaviors {
   type BehaviorOrder = Brand<number, "PIXI.particles.behaviors.BehaviorOrder">;

package/src/types/augments/pixi.d.mts

@@ -1,4 +1,4 @@
-import type { Brand, Identity } from "fvtt-types/utils";
+import type { Brand, Identity } from "#utils";
 import * as _PIXI from "pixi.js";
 
 // Note(LukeAbby): The `smooth.d.mts` and `smooth.d.mts` files exist to make it DRY to selectively tweak PIXI sub-namespaces.
@@ -272,7 +272,7 @@ declare global {
     /**
      * Configure whether filter textures are cleared after binding.
      *
-     * Filter textures need not be cleared if the filter does not use pixel blending. {@link PIXI.CLEAR_MODES.BLIT | `PIXI.CLEAR_MODES.BLIT`} will detect
+     * Filter textures need not be cleared if the filter does not use pixel blending. {@linkcode PIXI.CLEAR_MODES.BLIT} will detect
      * this and skip clearing as an optimization.
      */
     const CLEAR_MODES: {
@@ -291,7 +291,7 @@ declare global {
       /** Always clear the filter texture. */
       CLEAR: 1 & CLEAR_MODES;
 
-      /** Clear only if {@link PIXI.FilterSystem.forceClear | `PIXI.FilterSystem.forceClear`} is set or if the filter uses pixel blending. */
+      /** Clear only if {@linkcode PIXI.FilterSystem.forceClear} is set or if the filter uses pixel blending. */
       BLIT: 2 & CLEAR_MODES;
     };
 
@@ -440,7 +440,7 @@ declare global {
     /**
      * The gc modes that are supported by pixi.
      *
-     * The {@link PIXI.TextureGCSystem.defaultMode | `PIXI.TextureGCSystem.defaultMode`} Garbage Collection mode for PixiJS textures is AUTO
+     * The {@linkcode PIXI.TextureGCSystem.defaultMode} Garbage Collection mode for PixiJS textures is AUTO
      * If set to GC_MODE, the renderer will occasionally check textures usage. If they are not
      * used for a specified period of time they will be removed from the GPU. They will of course
      * be uploaded again when they are required. This is a silent behind the scenes process that
@@ -633,7 +633,7 @@ declare global {
     /**
      * Mipmap filtering modes that are supported by pixi.
      *
-     * The {@link PIXI.BaseTexture.defaultOptions.mipmap | `PIXI.BaseTexture.defaultOptions.mipmap`} affects default texture filtering.
+     * The {@linkcode PIXI.BaseTexture.defaultOptions.mipmap} affects default texture filtering.
      * Mipmaps are generated for a baseTexture if its `mipmap` field is `ON`,
      * or its `POW2` and texture dimensions are powers of 2.
      * Since WebGL 1 don't support mipmap for non-power-of-two textures,
@@ -736,7 +736,7 @@ declare global {
     /**
      * The scale modes that are supported by pixi.
      *
-     * The {@link PIXI.BaseTexture.defaultOptions.scaleMode | `PIXI.BaseTexture.defaultOptions.scaleMode`} scale mode affects the default scaling mode of future operations.
+     * The {@linkcode PIXI.BaseTexture.defaultOptions.scaleMode} scale mode affects the default scaling mode of future operations.
      * It can be re-assigned to either LINEAR or NEAREST, depending upon suitability.
      */
     const SCALE_MODES: {
@@ -902,24 +902,24 @@ declare global {
 
     /**
      * Represents the update priorities used by internal PIXI classes when registered with
-     * the {@link PIXI.Ticker | `PIXI.Ticker`} object. Higher priority items are updated first and lower
+     * the {@linkcode PIXI.Ticker} object. Higher priority items are updated first and lower
      * priority items, such as render, should go later.
      * @remarks Includes Foundry's additions of `OBJECTS`, `PRIMARY`, and `PERCEPTION`
      */
     const UPDATE_PRIORITY: {
-      /** Highest priority used for interaction events in {@link PIXI.EventSystem | `PIXI.EventSystem`} */
+      /** Highest priority used for interaction events in {@linkcode PIXI.EventSystem} */
       INTERACTION: 50 & UPDATE_PRIORITY;
 
-      /** High priority updating, used by {@link PIXI.AnimatedSprite | `PIXI.AnimatedSprite`} */
+      /** High priority updating, used by {@linkcode PIXI.AnimatedSprite} */
       HIGH: 25 & UPDATE_PRIORITY;
 
       /** Default priority for ticker events, see {@link PIXI.Ticker.add | `PIXI.Ticker#add`}. */
       NORMAL: 0 & UPDATE_PRIORITY;
 
-      /** Low priority used for {@link PIXI.Application | `PIXI.Application`} rendering. */
+      /** Low priority used for {@linkcode PIXI.Application} rendering. */
       LOW: 25 & UPDATE_PRIORITY;
 
-      /** Lowest priority used for {@link PIXI.BasePrepare | `PIXI.BasePrepare`} utility. */
+      /** Lowest priority used for {@linkcode PIXI.BasePrepare} utility. */
       UTILITY: 50 & UPDATE_PRIORITY;
 
       /** @remarks Foundry addition, defined as `HIGH - 2` */
@@ -1010,6 +1010,15 @@ declare global {
       interface Any extends AnyPIXIShader {}
       interface AnyConstructor extends Identity<typeof AnyPIXIShader> {}
     }
+
+    class Texture<R extends PIXI.Resource = PIXI.Resource> extends _PIXI.Texture<R> {
+      // Note(LukeAbby): `Texture.from` does not correctly.
+      static from<R extends PIXI.Resource = PIXI.Resource, RO = any>(
+        source: PIXI.Resource | PIXI.TextureSource | PIXI.TextureSource[],
+        options?: PIXI.IBaseTextureOptions<RO>,
+        strict?: boolean,
+      ): PIXI.Texture<R>;
+    }
   }
 }
 

package/src/types/augments/smooth.d.mts

@@ -1,4 +1,4 @@
-import type { Brand } from "fvtt-types/utils";
+import type { Brand } from "#utils";
 
 type JOINT_TYPE = Brand<number, "PIXI.smooth.JOINT_TYPE">;
 declare const JOINT_TYPE: {

package/src/types/augments/socket.io-client.d.mts

@@ -1,7 +1,6 @@
 import type * as _io from "socket.io-client";
 
 declare global {
-  // eslint-disable-next-line no-var
   var io: typeof _io & typeof _io.io & { connect: typeof _io.io };
   namespace io {
     type Socket = _io.Socket;

package/src/types/augments/tinyMCE.d.mts

@@ -1,6 +1,6 @@
 import _tinymce from "tinymce";
 import type * as _tinymceTypes from "tinymce";
-import type { AnyObject } from "fvtt-types/utils";
+import type { AnyObject } from "#utils";
 
 declare global {
   let tinyMCE: typeof _tinymce;

package/src/types/config.d.mts

@@ -1,11 +1,8 @@
 // This is an issue only on Windows. It's worked around in this weird way to avoid ESLint
 // whining about an unused disable.
-/* eslint import-x/no-unresolved: [2, { ignore: ["fvtt-types/configuration"] }] */
 
-import type { InterfaceToObject, MustConform } from "fvtt-types/utils";
-
-// eslint-disable-next-line import-x/extensions
-import * as configuration from "fvtt-types/configuration";
+import type { InterfaceToObject, MustConform } from "#utils";
+import * as configuration from "#configuration";
 
 declare global {
   interface AssumeHookRan extends configuration.AssumeHookRan {}
@@ -34,7 +31,7 @@ type MustBeValid<T extends ValidDataModel> = T;
 type _TestValidDataModelConfig = MustConform<DataModelConfig, ValidDataModel>;
 
 interface ValidSettingConfig {
-  readonly [K: string]: ClientSettings.Type;
+  readonly [K: string]: foundry.helpers.ClientSettings.Type;
 }
 
 type _TestValidSettingConfig = MustConform<InterfaceToObject<SettingConfig>, ValidSettingConfig>;

package/src/types/documentConfiguration.d.mts

@@ -1,9 +1,9 @@
 // This file pertains to setting up documents, including defaults. For this reason there's a lot of references to `SomeDocument` instead of `SomeDocument.implementation`.
 /* eslint-disable @typescript-eslint/no-restricted-types, no-restricted-syntax */
 
-import type { documents } from "../foundry/client-esm/client.d.mts";
+import type { documents } from "../foundry/client/client.d.mts";
 import type { Document } from "../foundry/common/abstract/_module.d.mts";
-import type { InterfaceToObject, MakeConform, MustConform, FixedInstanceType } from "fvtt-types/utils";
+import type { InterfaceToObject, MakeConform, MustConform, FixedInstanceType } from "#utils";
 
 type DocumentConform<T> = MakeConform<T, Document.AnyConstructor>;
 
@@ -17,9 +17,11 @@ interface DefaultDocumentClasses {
   ChatMessage: typeof ChatMessage;
   Combat: typeof Combat;
   Combatant: typeof Combatant;
+  CombatantGroup: typeof CombatantGroup;
   FogExploration: typeof FogExploration;
   Folder: typeof Folder;
   Item: typeof Item;
+  JournalEntryCategory: typeof JournalEntryCategory;
   JournalEntryPage: typeof JournalEntryPage;
   JournalEntry: typeof JournalEntry;
   Macro: typeof Macro;
@@ -52,9 +54,11 @@ interface DefaultDocumentInstance {
   ChatMessage: ChatMessage;
   Combat: Combat;
   Combatant: Combatant;
+  CombatantGroup: CombatantGroup;
   FogExploration: FogExploration;
   Folder: Folder;
   Item: Item;
+  JournalEntryCategory: JournalEntryCategory;
   JournalEntryPage: JournalEntryPage;
   JournalEntry: JournalEntry;
   Macro: Macro;
@@ -98,7 +102,7 @@ type GetDocumentInstance<ConcreteDocumentType extends Document.Type> =
 
 // This interface exists as a way to catch circular errors easier.
 // This makes it more verbose than it might seem it has to be but it's important to stay this way.
-interface _ConfiguredDocumentClass {
+export interface ConfiguredDocumentClass {
   ActiveEffect: GetDocumentClass<"ActiveEffect">;
   ActorDelta: GetDocumentClass<"ActorDelta">;
   Actor: GetDocumentClass<"Actor">;
@@ -108,9 +112,11 @@ interface _ConfiguredDocumentClass {
   ChatMessage: GetDocumentClass<"ChatMessage">;
   Combat: GetDocumentClass<"Combat">;
   Combatant: GetDocumentClass<"Combatant">;
+  CombatantGroup: GetDocumentClass<"CombatantGroup">;
   FogExploration: GetDocumentClass<"FogExploration">;
   Folder: GetDocumentClass<"Folder">;
   Item: GetDocumentClass<"Item">;
+  JournalEntryCategory: GetDocumentClass<"JournalEntryCategory">;
   JournalEntryPage: GetDocumentClass<"JournalEntryPage">;
   JournalEntry: GetDocumentClass<"JournalEntry">;
   Macro: GetDocumentClass<"Macro">;
@@ -134,7 +140,7 @@ interface _ConfiguredDocumentClass {
   Wall: GetDocumentClass<"Wall">;
 }
 
-interface _ConfiguredDocumentInstance {
+export interface ConfiguredDocumentInstance {
   ActiveEffect: GetDocumentInstance<"ActiveEffect">;
   ActorDelta: GetDocumentInstance<"ActorDelta">;
   Actor: GetDocumentInstance<"Actor">;
@@ -144,9 +150,11 @@ interface _ConfiguredDocumentInstance {
   ChatMessage: GetDocumentInstance<"ChatMessage">;
   Combat: GetDocumentInstance<"Combat">;
   Combatant: GetDocumentInstance<"Combatant">;
+  CombatantGroup: GetDocumentInstance<"CombatantGroup">;
   FogExploration: GetDocumentInstance<"FogExploration">;
   Folder: GetDocumentInstance<"Folder">;
   Item: GetDocumentInstance<"Item">;
+  JournalEntryCategory: GetDocumentInstance<"JournalEntryCategory">;
   JournalEntryPage: GetDocumentInstance<"JournalEntryPage">;
   JournalEntry: GetDocumentInstance<"JournalEntry">;
   Macro: GetDocumentInstance<"Macro">;
@@ -171,30 +179,15 @@ interface _ConfiguredDocumentInstance {
 }
 
 type TestConfiguredClassesValid = MustConform<
-  InterfaceToObject<_ConfiguredDocumentClass>,
+  InterfaceToObject<ConfiguredDocumentClass>,
   Record<string, Document.AnyConstructor>
 >;
 
-type ConformedConfiguredClass = {
-  [K in keyof _ConfiguredDocumentClass]: MakeConform<
-    _ConfiguredDocumentClass[K],
-    Document.Internal.Constructor,
-    ConfigurationFailure[K]
-  >;
-};
-
 type TestConfiguredInstanceValid = MustConform<
-  InterfaceToObject<_ConfiguredDocumentInstance>,
+  InterfaceToObject<ConfiguredDocumentInstance>,
   Record<string, Document.Any>
 >;
 
-type ConformedConfiguredInstance = {
-  [K in keyof _ConfiguredDocumentInstance]: MakeConform<_ConfiguredDocumentInstance[K], Document.Any>;
-};
-
-export interface ConfiguredDocumentClass extends ConformedConfiguredClass {}
-export interface ConfiguredDocumentInstance extends ConformedConfiguredInstance {}
-
 export interface ConfiguredMetadata {
   ActiveEffect: ActiveEffect.Metadata;
   ActorDelta: ActorDelta.Metadata;
@@ -207,10 +200,12 @@ export interface ConfiguredMetadata {
   ChatMessage: ChatMessage.Metadata;
   Combat: Combat.Metadata;
   Combatant: Combatant.Metadata;
+  CombatantGroup: CombatantGroup.Metadata;
   Drawing: DrawingDocument.Metadata;
   FogExploration: FogExploration.Metadata;
   Folder: Folder.Metadata;
   Item: Item.Metadata;
+  JournalEntryCategory: JournalEntryCategory.Metadata;
   JournalEntryPage: JournalEntryPage.Metadata;
   JournalEntry: JournalEntry.Metadata;
   Macro: Macro.Metadata;
@@ -246,9 +241,11 @@ export interface CreateData {
   ChatMessage: documents.BaseChatMessage.CreateData;
   Combat: documents.BaseCombat.CreateData;
   Combatant: documents.BaseCombatant.CreateData;
+  CombatantGroup: documents.BaseCombatantGroup.CreateData;
   FogExploration: documents.BaseFogExploration.CreateData;
   Folder: documents.BaseFolder.CreateData;
   Item: documents.BaseItem.CreateData;
+  JournalEntryCategory: documents.BaseJournalEntryCategory.CreateData;
   JournalEntryPage: documents.BaseJournalEntryPage.CreateData;
   JournalEntry: documents.BaseJournalEntry.CreateData;
   Macro: documents.BaseMacro.CreateData;
@@ -288,9 +285,11 @@ interface MisconfiguredCards extends ConformToDocumentConstructor<typeof Cards>
 interface MisconfiguredChatMessage extends ConformToDocumentConstructor<typeof ChatMessage> {}
 interface MisconfiguredCombat extends ConformToDocumentConstructor<typeof Combat> {}
 interface MisconfiguredCombatant extends ConformToDocumentConstructor<typeof Combatant> {}
+interface MisconfiguredCombatantGroup extends ConformToDocumentConstructor<typeof CombatantGroup> {}
 interface MisconfiguredFogExploration extends ConformToDocumentConstructor<typeof FogExploration> {}
 interface MisconfiguredFolder extends ConformToDocumentConstructor<typeof Folder> {}
 interface MisconfiguredItem extends ConformToDocumentConstructor<typeof Item> {}
+interface MisconfiguredJournalEntryCategory extends ConformToDocumentConstructor<typeof JournalEntryCategory> {}
 interface MisconfiguredJournalEntryPage extends ConformToDocumentConstructor<typeof JournalEntryPage> {}
 interface MisconfiguredJournalEntry extends ConformToDocumentConstructor<typeof JournalEntry> {}
 interface MisconfiguredMacro extends ConformToDocumentConstructor<typeof Macro> {}
@@ -324,9 +323,11 @@ export interface ConfigurationFailure {
   ChatMessage: MisconfiguredChatMessage;
   Combat: MisconfiguredCombat;
   Combatant: MisconfiguredCombatant;
+  CombatantGroup: MisconfiguredCombatantGroup;
   FogExploration: MisconfiguredFogExploration;
   Folder: MisconfiguredFolder;
   Item: MisconfiguredItem;
+  JournalEntryCategory: MisconfiguredJournalEntryCategory;
   JournalEntryPage: MisconfiguredJournalEntryPage;
   JournalEntry: MisconfiguredJournalEntry;
   Macro: MisconfiguredMacro;

package/src/types/lib.d.mts

@@ -1,4 +1,4 @@
-import type { Identity } from "fvtt-types/utils";
+import type { Identity } from "#utils";
 
 declare global {
   namespace AudioNode {

package/src/types/workers/image-compressor.d.mts

@@ -1,117 +1,152 @@
-import type { EmptyObject, InexactPartial } from "fvtt-types/utils";
+import type { EmptyObject, InexactPartial } from "#utils";
 
 export declare const FORMATS: {
   RED: typeof PIXI.FORMATS.RED;
   RGBA: typeof PIXI.FORMATS.RGBA;
 };
 
-export interface Debug {
+/** @internal */
+type _CommonOptionalProperties = InexactPartial<{
   /**
    * Debug option.
    * @remarks Enables logging via `console.debug`
    */
-  debug?: boolean | undefined | null;
-}
+  debug: boolean;
+
+  /** Hash to test. */
+  hash: string;
+
+  /** Skip hash? */
+  skipHash: boolean;
+}>;
 
 /** @internal */
-export type _ProcessBufferToBase64Options = InexactPartial<{
+type _ProcessBufferToBase64Options = InexactPartial<{
   /**
    * The required image type.
    * @defaultValue `"image/png"`
-   * @remarks Can't be null as it only has a parameter default
    */
   type: string;
 
   /**
    * The required image quality.
    * @defaultValue `1`
-   * @remarks Can't be null as it only has a parameter default
    */
   quality: number;
+}>;
 
-  /**
-   * Hash to test.
-   * @remarks Can't be null as it's passed directly to the `controlHashes` function,
-   * where it is only checked for `=== undefined`
-   */
-  hash: string;
+/** @internal */
+interface _CommonRequiredProperties {
+  /** Width of the image. */
+  width: number;
 
-  /**
-   * The format the buffer is in
-   * @remarks Only matters whether it's `FORMATS.RED` or not. Property is undocumented by foundry.
-   */
-  readFormat: PIXI.FORMATS | null;
+  /** Height of the image */
+  height: number;
+}
+
+type _Out = InexactPartial<{
+  /** The output buffer. */
+  out: ArrayBuffer;
 }>;
 
-/** @internal */
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-type _BaseBufferOptions = {
+export interface ProcessBufferToBase64Options
+  extends _ProcessBufferToBase64Options,
+    _CommonRequiredProperties,
+    _CommonOptionalProperties {
   /** Buffer used to create the image data. */
   buffer: Uint8ClampedArray;
+}
 
-  /** Buffered image width. */
-  width: number;
+export interface ProcessBufferRedToBufferRGBAOptions
+  extends _Out,
+    _CommonRequiredProperties,
+    _CommonOptionalProperties {
+  /** Buffer to expand. */
+  buffer: Uint8ClampedArray;
+}
 
-  /** Buffered image height. */
-  height: number;
-};
+export interface ProcessBufferRGBAToBufferRedOptions
+  extends _Out,
+    _CommonRequiredProperties,
+    _CommonOptionalProperties {
+  /** Buffer to reduce. */
+  buffer: Uint8ClampedArray;
+}
 
-export interface ProcessBufferToBase64Options extends _BaseBufferOptions, _ProcessBufferToBase64Options, Debug {}
+export interface CopyBufferOptions extends _CommonOptionalProperties, _Out {
+  /** Buffer to copy. */
+  buffer: Uint8ClampedArray;
+}
 
-export interface ExpandOrReduceBufferOptions
-  extends _BaseBufferOptions,
-    Debug,
-    Pick<_ProcessBufferToBase64Options, "hash"> {}
+export interface Debug extends Pick<_CommonOptionalProperties, "debug"> {}
 
-export type ProcessBufferToBase64Return = [
-  {
-    base64img: string | undefined;
-    buffer: Uint8ClampedArray;
-    hash: string | undefined;
-  },
-  [bufferBuffer: ArrayBufferLike],
-];
+export interface ExpandOrReduceBufferOptions extends Debug, _Out {}
 
-export type ProcessBufferRedToBufferRGBAReturn = [
-  {
-    rgbaBuffer: Uint8ClampedArray | undefined;
-    buffer: Uint8ClampedArray;
-    hash: string | undefined;
-  },
-  [rgbaBufferBuffer: ArrayBufferLike, bufferBuffer: ArrayBufferLike],
-];
+/** @internal */
+interface _CommonResultProperties {
+  buffer: Uint8ClampedArray;
+  out: ArrayBuffer | undefined;
+  hash: string | undefined;
+}
+
+export interface ProcessBufferToBase64Result extends Omit<_CommonResultProperties, "out"> {
+  base64img: string | undefined;
+}
+
+export interface ProcessBufferRedToBufferRGBAResult extends _CommonResultProperties {
+  rgbaBuffer: Uint8ClampedArray | undefined;
+}
+
+export interface ProcessBufferRGBAToBufferRedResult extends _CommonResultProperties {
+  redBuffer: Uint8ClampedArray | undefined;
+}
 
-export type ProcessBufferRGBAToBufferREDReturn = [
-  {
-    redBuffer: Uint8ClampedArray | undefined;
-    buffer: Uint8ClampedArray;
-    hash: string | undefined;
-  },
-  [bufferBuffer: ArrayBufferLike],
+export interface CopyBufferResult extends _CommonResultProperties {
+  copy: Uint8ClampedArray | undefined;
+}
+
+/**
+ * @privateRemarks There isn't any point being more specific with the names of the `transfer` elements,
+ * as `copyBuffer` can return `buffer.buffer` in either the first or second position
+ */
+export type BufferOperationReturn<ResultType> = [
+  result: ResultType,
+  transfer: [firstBuffer: ArrayBufferLike, secondBuffer?: ArrayBufferLike],
 ];
 
+export interface ControlHashesReturnObject {
+  /** boolean to know if the hashes are the same */
+  same: boolean;
+
+  /** the previous or the new hash */
+  hash: string;
+}
+
 /**
  * Process the image compression.
  */
 export declare function processBufferToBase64(
   options: ProcessBufferToBase64Options,
-): Promise<ProcessBufferToBase64Return>;
+): Promise<BufferOperationReturn<ProcessBufferToBase64Result>>;
 
 /**
  * Expand a single RED channel buffer into a RGBA buffer and returns it to the main thread.
- * The created RGBA buffer is transfered.
+ * The created RGBA buffer is transferred.
  */
 export declare function processBufferRedToBufferRGBA(
-  options: ExpandOrReduceBufferOptions,
-): Promise<ProcessBufferRedToBufferRGBAReturn>;
+  options: ProcessBufferRedToBufferRGBAOptions,
+): Promise<BufferOperationReturn<ProcessBufferRedToBufferRGBAResult>>;
 
 /**
  * Reduce a RGBA buffer into a single RED buffer and returns it to the main thread.
- * The created RGBA buffer is transfered.
+ * The created RGBA buffer is transferred.
  */
 export declare function processBufferRGBAToBufferRED(
-  options: ExpandOrReduceBufferOptions,
-): Promise<ProcessBufferRGBAToBufferREDReturn>;
+  options: ProcessBufferRGBAToBufferRedOptions,
+): Promise<BufferOperationReturn<ProcessBufferRGBAToBufferRedResult>>;
+
+/** Copy the buffer. */
+export declare function copyBuffer(options: CopyBufferOptions): Promise<BufferOperationReturn<CopyBufferResult>>;
 
 /**
  * Control the hash of a provided buffer.
@@ -120,11 +155,11 @@ export declare function processBufferRGBAToBufferRED(
  * @returns Returns an empty object if `hash === undefined` else returns `{same: <boolean to know if the hashes are the same>, hash: <the previous or the new hash>}`
  */
 export declare function controlHashes(buffer: Uint8ClampedArray, hash?: undefined): EmptyObject;
-export declare function controlHashes(buffer: Uint8ClampedArray, hash: string): { same: boolean; hash: string };
+export declare function controlHashes(buffer: Uint8ClampedArray, hash: string): ControlHashesReturnObject;
 export declare function controlHashes(
   buffer: Uint8ClampedArray,
   hash?: string,
-): EmptyObject | { same: boolean; hash: string };
+): EmptyObject | ControlHashesReturnObject;
 
 /**
  * Create an offscreen canvas element containing the pixel data.
@@ -136,7 +171,7 @@ export declare function pixelsToOffscreenCanvas(
   buffer: Uint8ClampedArray,
   width: number,
   height: number,
-  { debug }?: Debug,
+  options?: Debug,
 ): OffscreenCanvas;
 
 /**
@@ -147,7 +182,7 @@ export declare function offscreenToBase64(
   offscreen: OffscreenCanvas,
   type?: string,
   quality?: number,
-  { debug }?: Debug,
+  options?: Debug,
 ): Promise<string>;
 
 /**
@@ -162,7 +197,7 @@ export declare function expandBuffer(
   buffer: Uint8ClampedArray,
   width: number,
   height: number,
-  { debug }?: Debug,
+  options?: ExpandOrReduceBufferOptions,
 ): Uint8ClampedArray;
 
 /**
@@ -172,5 +207,5 @@ export declare function reduceBuffer(
   buffer: Uint8ClampedArray,
   width: number,
   height: number,
-  { debug }?: Debug,
+  options?: ExpandOrReduceBufferOptions,
 ): Uint8ClampedArray;