@faeyumbrea/lib-camera-api-types 1.13.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,28 @@
+# libCamera API types
+
+TypeScript declarations for libCamera's public API. Foundry loads the installed
+module at runtime; this package only supplies types for your integration.
+
+Install the exact package version matching the libCamera release you support.
+For example:
+
+```sh
+npm install --save-dev --save-exact @faeyumbrea/lib-camera-api-types@1.14.0
+```
+
+```ts
+import type { ModuleApi } from '@faeyumbrea/lib-camera-api-types';
+
+const camera = game.modules.get('lib-camera')?.api as ModuleApi | undefined;
+if (!camera || camera.apiMajor !== 1) {
+  throw new Error('This integration needs libCamera API 1.');
+}
+```
+
+Use type-only imports. There is no JavaScript entry point in this package.
+The second version number is the Foundry generation: `1.13.x` targets Foundry 13,
+and `1.14.x` targets Foundry 14. A module hotfix such as `1.14.0.1` maps to npm
+version `1.14.0-hotfix.1`; pin it explicitly rather than relying on a version range.
+
+[Developer guides and released API references](https://docs.void.monster/lib-camera/)
+cover registration, ownership, movement, and lifecycle handling.

package/api.d.ts

@@ -0,0 +1,34 @@
+import type { CameraView3D } from './camera-3d.js';
+import type { LocalConsumer } from './controller.js';
+import type { CameraBounds, FrameOptions } from './framing.js';
+import type { CameraPosition } from './movement.js';
+import type { ConsumerOptions } from './ownership.js';
+import type { RemoteCamera } from './remote.js';
+export interface ModuleApi {
+    readonly id: 'lib-camera';
+    readonly apiMajor: 1;
+    moveRemote: RemoteCamera['move'];
+    set3DRemote: RemoteCamera['set3D'];
+    observeUser: RemoteCamera['watch'];
+    followUser: RemoteCamera['followUser'];
+    /** Compute views without taking ownership or moving the camera. */
+    frame: (bounds: readonly CameraBounds[], options?: FrameOptions) => CameraPosition | undefined;
+    frameTokens: (tokenIds: readonly string[], options?: FrameOptions) => CameraPosition | undefined;
+    sceneBounds: () => CameraBounds | undefined;
+    /** Registration is available at init; movement requires a ready canvas. */
+    register: (options: ConsumerOptions) => LocalConsumer;
+    read: () => Readonly<CameraPosition> | undefined;
+    /** Native 3D position and look-at target; absent unless 3D Canvas is active and ready. */
+    read3D: () => Readonly<CameraView3D> | undefined;
+    tokenPosition: (tokenId: string) => Readonly<{
+        x: number;
+        y: number;
+    }> | undefined;
+    gridPosition: (row: number, column: number) => Readonly<{
+        x: number;
+        y: number;
+    }> | undefined;
+    /** Stop this client immediately and persist its opt-out. */
+    panic: () => Promise<void>;
+    openControls: () => void;
+}

package/camera-3d.d.ts

@@ -0,0 +1,61 @@
+import type { CameraClaim, RejectionReason } from './ownership.js';
+/** Native 3D Canvas units: X/Z span the scene; Y is elevation. */
+export interface Vector3D {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface CameraView3D {
+    position: Readonly<Vector3D>;
+    target: Readonly<Vector3D>;
+}
+export type CameraResult3D = {
+    status: 'completed';
+    view: Readonly<CameraView3D>;
+} | {
+    status: 'rejected';
+    reason: RejectionReason | 'invalid-input' | 'inactive-claim' | 'unavailable' | 'unsupported-mode';
+} | {
+    status: 'failed';
+    reason: 'adapter-error';
+};
+interface MutableVector extends Vector3D {
+    set: (x: number, y: number, z: number) => unknown;
+}
+/** Shared exposed surface of 3D Canvas 8 (Foundry 13) and 9 (Foundry 14). */
+export interface Canvas3D {
+    _active: boolean;
+    _ready: boolean;
+    firstPersonMode: boolean;
+    _toggleCameraLockPosition?: unknown;
+    GameCamera: {
+        enabled: boolean;
+    };
+    cutsceneEngine: {
+        isPlaying: boolean;
+    };
+    camera: {
+        position: MutableVector;
+    };
+    controls: {
+        target: MutableVector;
+        enableDamping: boolean;
+        autoRotate: boolean;
+        update: () => unknown;
+    };
+    stopCameraAnimation: () => void;
+}
+export declare function validView3D(view: CameraView3D): boolean;
+export declare class Camera3D {
+    readonly getCanvas: () => Canvas3D | undefined;
+    constructor(getCanvas: () => Canvas3D | undefined);
+    read(): Readonly<CameraView3D> | undefined;
+    availability(): 'unavailable' | 'unsupported-mode' | undefined;
+    /**
+     * Immediate write through native orbit controls, which may constrain the result.
+     * Free-camera collision handling can later reproject the target along the viewing ray.
+     * Preserves camera mode and control settings; does not hold the view against manual input.
+     */
+    set(claim: CameraClaim, next: CameraView3D): CameraResult3D;
+}
+export {};

package/controller.d.ts

@@ -0,0 +1,52 @@
+import type { Camera3D, CameraResult3D, CameraView3D } from './camera-3d.js';
+import type { CameraFollow } from './follow.js';
+import type { CameraAdapter, CameraPosition, MovementResult, MoveOptions } from './movement.js';
+import type { CameraClaim, ConsumerOptions, RejectionReason } from './ownership.js';
+import { CameraCoordinator } from './ownership.js';
+export interface CameraSession extends CameraClaim {
+    /** Replace this claim's current movement, continuing from the actual view. */
+    retarget: (options: MoveOptions, signal?: AbortSignal) => Promise<MovementResult>;
+    set3D: (view: CameraView3D) => CameraResult3D;
+    move: (options: MoveOptions, signal?: AbortSignal) => Promise<MovementResult>;
+}
+export type SessionResult = {
+    ok: true;
+    claim: CameraSession;
+} | {
+    ok: false;
+    reason: RejectionReason | 'unavailable';
+};
+export interface LocalConsumer {
+    readonly id: string;
+    follow: (source: () => MoveOptions | undefined, interval?: number) => {
+        ok: true;
+        follow: CameraFollow;
+    } | {
+        ok: false;
+        reason: RejectionReason | 'unavailable';
+    };
+    /** Acquire, set the 3D view immediately, and release. */
+    set3D: (view: CameraView3D) => CameraResult3D;
+    acquire: () => SessionResult;
+    /** Acquire, move, and release, including when movement fails. */
+    move: (options: MoveOptions, signal?: AbortSignal) => Promise<MovementResult | {
+        status: 'rejected';
+        reason: RejectionReason;
+    }>;
+    unregister: () => void;
+}
+export declare class CameraController {
+    #private;
+    readonly adapter: CameraAdapter;
+    readonly getUserId: () => string | undefined;
+    readonly camera3D?: Camera3D | undefined;
+    readonly ownership: CameraCoordinator;
+    readonly consumers: Map<string, LocalConsumer>;
+    constructor(adapter: CameraAdapter, getUserId: () => string | undefined, camera3D?: Camera3D | undefined);
+    read(): Readonly<CameraPosition> | undefined;
+    register(options: ConsumerOptions): LocalConsumer;
+    releaseLocal(): void;
+    panic(): void;
+    resume(): void;
+    reset(): void;
+}

package/follow.d.ts

@@ -0,0 +1,13 @@
+import type { CameraSession } from './controller.js';
+import type { MovementResult, MoveOptions } from './movement.js';
+export interface CameraFollow {
+    readonly active: boolean;
+    readonly paused: boolean;
+    /** Resolves on stop, preemption, panic, teardown or a source/movement failure. */
+    readonly done: Promise<MovementResult>;
+    pause: () => void;
+    resume: () => void;
+    stop: () => void;
+}
+/** Sample a consumer-selected source; tracking policy remains with the consumer. */
+export declare function followCamera(session: CameraSession, source: () => MoveOptions | undefined, interval?: number): CameraFollow;

package/framing.d.ts

@@ -0,0 +1,26 @@
+import type { CameraPosition } from './movement.js';
+export interface CameraBounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface FrameOptions {
+    /** Margin on each side, expressed in grid tiles. */
+    margin?: number;
+    /** Minimum and maximum number of horizontal grid tiles visible. */
+    closest?: number;
+    widest?: number;
+}
+export interface ViewDimensions {
+    width: number;
+    height: number;
+    gridSize: number;
+}
+/** Shared with OBS Utils: more visible tiles means a smaller scale. */
+export declare function tilesToScale(tiles: number, screenWidth: number, gridSize: number): number;
+export declare function validBounds(bounds: CameraBounds): boolean;
+/** OBS Utils framing, with explicit inputs instead of world settings. */
+export declare function frameBounds(bounds: readonly CameraBounds[], screen: ViewDimensions, options?: FrameOptions): CameraPosition | undefined;
+/** Keep the viewport inside a rectangle, increasing scale when necessary (OBS Utils). */
+export declare function clampView(position: CameraPosition, bounds: CameraBounds, screen: ViewDimensions): CameraPosition;

package/movement.d.ts

@@ -0,0 +1,47 @@
+import type { CameraBounds } from './framing.js';
+import type { CameraClaim, ReleaseReason } from './ownership.js';
+export interface CameraPosition {
+    x: number;
+    y: number;
+    scale: number;
+    level?: string;
+}
+export interface MoveOptions extends Partial<CameraPosition> {
+    /** Milliseconds; zero applies the view immediately. Maximum: one minute. */
+    duration?: number;
+    easing?: 'linear' | 'cosine' | 'easeInCircle' | 'easeOutCircle' | 'easeInOutCircle' | 'easeInCosine' | 'easeOutCosine' | 'easeInOutCosine' | 'easeOutCubic' | 'easeInOutCubic';
+    /** true constrains to scene bounds; a rectangle constrains to that region. */
+    bounds?: true | CameraBounds;
+    /** Suppress manual camera input only for this operation. */
+    lockInput?: boolean;
+}
+export type MovementResult = {
+    status: 'completed';
+    position: Readonly<CameraPosition>;
+} | {
+    status: 'cancelled';
+    reason: ReleaseReason | 'cancelled' | 'interrupted' | 'retargeted';
+} | {
+    status: 'rejected';
+    reason: 'invalid-input' | 'inactive-claim' | 'busy' | 'unavailable';
+} | {
+    status: 'failed';
+    reason: 'adapter-error';
+};
+/** Boundary to Foundry. Adapters must stop writing synchronously when aborted. */
+export interface CameraAdapter {
+    read: () => Readonly<CameraPosition> | undefined;
+    pan: (position: CameraPosition) => void;
+    animate: (position: CameraPosition, options: Required<Pick<MoveOptions, 'duration' | 'easing'>>, signal: AbortSignal) => Promise<boolean>;
+    lockInput: () => () => void;
+    prepare?: (options: MoveOptions, signal: AbortSignal) => Promise<boolean>;
+    constrain?: (position: CameraPosition, bounds: NonNullable<MoveOptions['bounds']>) => CameraPosition;
+}
+export declare function validMove(options: MoveOptions): boolean;
+/** One operation per claim. Cancellation never releases a caller's longer-lived claim. */
+export declare class CameraMovement {
+    #private;
+    readonly adapter: CameraAdapter;
+    constructor(adapter: CameraAdapter);
+    move(claim: CameraClaim, options: MoveOptions, signal?: AbortSignal): Promise<MovementResult>;
+}

package/ownership.d.ts

@@ -0,0 +1,80 @@
+/** Why a live claim ended. Movement adapters must observe the claim signal. */
+export type ReleaseReason = 'released' | 'superseded' | 'unregistered' | 'panic' | 'canvas-teardown' | 'disposed';
+export type RejectionReason = 'disabled' | 'unregistered' | 'busy' | 'disposed' | 'canvas-teardown';
+export interface ConsumerOptions {
+    /** Module ID. Registration is coordination, not an authorization boundary. */
+    id: string;
+    name: string;
+    priority?: number;
+}
+export interface ClaimSnapshot {
+    readonly consumerId: string;
+    readonly userId: string;
+    readonly priority: number;
+}
+export interface CameraClaim {
+    readonly consumerId: string;
+    readonly userId: string;
+    readonly active: boolean;
+    /** Aborted exactly once. signal.reason is a ReleaseReason. */
+    readonly signal: AbortSignal;
+    /** A stale claim cannot release a newer claim. */
+    release: () => void;
+}
+export type ClaimResult = {
+    readonly ok: true;
+    readonly claim: CameraClaim;
+} | {
+    readonly ok: false;
+    readonly reason: RejectionReason;
+    readonly owner?: ClaimSnapshot;
+};
+export interface CameraConsumer {
+    readonly id: string;
+    /** An existing claim is never silently replaced by another from the same consumer. */
+    acquire: (userId: string) => ClaimResult;
+    unregister: () => void;
+}
+export interface PriorityOverride {
+    consumerId: string;
+    /** Omit for a default applying to all users. */
+    userId?: string;
+    priority: number;
+}
+export interface ConsumerSnapshot {
+    readonly id: string;
+    readonly name: string;
+    readonly priority: number;
+}
+export interface Diagnostic {
+    readonly sequence: number;
+    readonly action: 'acquired' | 'rejected' | 'ended';
+    readonly consumerId: string;
+    readonly userId: string;
+    readonly reason?: ReleaseReason | RejectionReason;
+}
+/**
+ * Per-user ownership arbitration for cooperative camera consumers.
+ * The integration layer authenticates remote requests and enforces input locks.
+ */
+export declare class CameraCoordinator {
+    #private;
+    constructor({ diagnosticLimit }?: {
+        diagnosticLimit?: number;
+    });
+    register({ id, name, priority }: ConsumerOptions): CameraConsumer;
+    /** Replace configuration atomically. New priorities apply to the next acquisition. */
+    setPriorities(overrides: readonly PriorityOverride[]): void;
+    getConsumers(userId?: string): readonly ConsumerSnapshot[];
+    getOwner(userId: string): ClaimSnapshot | undefined;
+    getClaims(): readonly ClaimSnapshot[];
+    getDiagnostics(): readonly Diagnostic[];
+    isDisabled(userId?: string): boolean;
+    /** Stop and block one user, or every user when omitted. Resume is explicit. */
+    panic(userId?: string): void;
+    /** Global resume preserves individual users' opt-outs. */
+    resume(userId?: string): void;
+    /** Release transient claims on a canvas transition; retain user configuration. */
+    reset(): void;
+    dispose(): void;
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@faeyumbrea/lib-camera-api-types",
+  "version": "1.13.0",
+  "description": "Public API declarations for libCamera 1.13.0 on Foundry 13.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/FaeyUmbrea/foundry-lib-camera.git"
+  },
+  "homepage": "https://docs.void.monster/lib-camera/public/1.13.0/dev/",
+  "types": "./public-api.d.ts",
+  "exports": {
+    ".": {
+      "types": "./public-api.d.ts"
+    }
+  },
+  "files": [
+    "**/*.d.ts",
+    "LICENSE",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/",
+    "tag": "foundry-13"
+  }
+}

package/public-api.d.ts

@@ -0,0 +1,10 @@
+export type { ModuleApi } from './api.js';
+export type { CameraResult3D, CameraView3D, Vector3D } from './camera-3d.js';
+export type { CameraSession, LocalConsumer, SessionResult } from './controller.js';
+export type { CameraFollow } from './follow.js';
+export type { CameraBounds, FrameOptions, ViewDimensions } from './framing.js';
+export type { CameraPosition, MovementResult, MoveOptions } from './movement.js';
+export type { CameraClaim, CameraConsumer, ClaimResult, ClaimSnapshot, ConsumerOptions, ConsumerSnapshot, Diagnostic, PriorityOverride, RejectionReason, ReleaseReason, } from './ownership.js';
+export type { CameraCoordinator } from './ownership.js';
+export type { RemoteOptions, RemoteOutcome, RemoteUserResult, ViewportSample, ViewportSubscription } from './remote.js';
+export type { TrackingMode } from './viewport-filter.js';

package/remote.d.ts

@@ -0,0 +1,59 @@
+import type { CameraResult3D, CameraView3D } from './camera-3d.js';
+import type { CameraController } from './controller.js';
+import type { CameraPosition, MovementResult, MoveOptions } from './movement.js';
+import type { TrackingMode } from './viewport-filter.js';
+export type RemoteOutcome = MovementResult | CameraResult3D | {
+    status: 'rejected';
+    reason: 'unauthorized' | 'wrong-scene' | 'unregistered';
+};
+export interface RemoteUserResult {
+    userId: string;
+    /** Acknowledgements from responding sessions; this is not proof that every session responded. */
+    outcomes: RemoteOutcome[];
+    status: 'acknowledged' | 'timeout' | 'cancelled' | 'offline' | 'rejected';
+}
+export interface RemoteOptions {
+    timeout?: number;
+    signal?: AbortSignal;
+}
+export interface ViewportSample {
+    userId: string;
+    sceneId: string;
+    position: Readonly<CameraPosition>;
+}
+export interface ViewportSubscription {
+    stop: () => void;
+}
+export interface RemoteEnvironment {
+    userId: () => string | undefined;
+    users: () => readonly {
+        id: string;
+        isGM: boolean;
+        active: boolean;
+    }[];
+    sceneId: () => string | undefined;
+    read: () => Readonly<CameraPosition> | undefined;
+    emit: (packet: object, recipients: string[]) => void;
+}
+/** Foundry supplies sender identity as the second socket callback argument. Never read it from payloads. */
+export declare class RemoteCamera {
+    #private;
+    readonly controller: CameraController;
+    readonly environment: RemoteEnvironment;
+    constructor(controller: CameraController, environment: RemoteEnvironment);
+    move(consumer: string, targets: string | readonly string[], options: MoveOptions, remote?: RemoteOptions): Promise<RemoteUserResult[]>;
+    set3D(consumer: string, targets: string | readonly string[], view: CameraView3D, remote?: RemoteOptions): Promise<RemoteUserResult[]>;
+    watch(userId: string, callback: (sample: ViewportSample) => void, mode?: TrackingMode): ViewportSubscription;
+    /** Follow the latest responding session of a user on this scene; all sessions remain addressable together. */
+    followUser(consumerId: string, userId: string, options?: Pick<MoveOptions, 'duration' | 'easing' | 'bounds' | 'lockInput'>, mode?: TrackingMode): {
+        ok: true;
+        follow: import("./follow.js").CameraFollow;
+    } | {
+        ok: false;
+        reason: import("./ownership.js").RejectionReason | "unavailable";
+    };
+    /** Bound socket traffic to approximately 30 Hz, retaining the newest sample. */
+    publish(): void;
+    receive(packet: unknown, sender: unknown): Promise<void>;
+    dispose(): void;
+}

package/viewport-filter.d.ts

@@ -0,0 +1,11 @@
+import type { ViewportSample } from './remote.js';
+export type TrackingMode = 'raw' | 'smooth' | 'dragRelease';
+/** OBS Utils' five-sample smoothing and drag-release behavior, scoped to one subscription. */
+export declare class ViewportFilter {
+    #private;
+    readonly mode: TrackingMode;
+    readonly callback: (sample: ViewportSample) => void;
+    constructor(mode: TrackingMode, callback: (sample: ViewportSample) => void);
+    push(sample: ViewportSample): void;
+    dispose(): void;
+}