CLose story 1.2

2026-05-21 23:08:34 +02:00
commit 110b295a7b
75 changed files with 16065 additions and 0 deletions
@@ -0,0 +1,83 @@
+/**
+ * PendingOp contract.
+ *
+ * A PendingOp tracks an in-flight visibility state change from the moment
+ * the GM issues the intent until the authoritative echo is received (or
+ * the 3-second timeout fires and triggers a revert).
+ *
+ * Lifecycle:
+ *   create → register in Map<opId, PendingOp>
+ *   echo received → delete from map + clearTimeout(timeoutId)
+ *   3s timeout fires → revert to previousState + GM notification
+ *
+ * @module contracts/pending-op
+ */
+
+/** @typedef {Object} PendingOp */
+
+/** Shape version constant for PendingOp. @type {1} */
+export const PENDING_OP_VERSION = 1;
+
+/**
+ * @typedef {Object} PendingOp
+ * @property {string} opId - Unique operation identifier (non-empty string).
+ * @property {string} userId - Target participant userId (non-empty string).
+ * @property {string} targetState - Desired VisibilityState (non-empty string).
+ * @property {string} previousState - State before this op; used for revert (non-empty string).
+ * @property {number} issuedAt - Timestamp (ms) when op was issued — Date.now() integer.
+ * @property {number|null} timeoutId - setTimeout handle; null if timeout not yet set.
+ */
+
+/**
+ * Creates a new PendingOp.
+ * @param {string} opId - Unique operation identifier.
+ * @param {string} userId - Target participant userId.
+ * @param {string} targetState - Desired VisibilityState.
+ * @param {string} previousState - State before this op.
+ * @param {number} [issuedAt] - Timestamp; defaults to Date.now().
+ * @returns {PendingOp}
+ */
+export function createPendingOp(opId, userId, targetState, previousState, issuedAt = Date.now()) {
+  return { opId, userId, targetState, previousState, issuedAt, timeoutId: null };
+}
+
+/**
+ * Validates a PendingOp DTO. Throws TypeError on any violation.
+ * @param {unknown} data - Value to validate.
+ * @returns {PendingOp} The validated PendingOp.
+ * @throws {TypeError} If data fails validation.
+ */
+export function isValidPendingOp(data) {
+  if (data === null || typeof data !== "object") {
+    throw new TypeError("PendingOp: must be an object");
+  }
+  const obj = /** @type {Record<string, unknown>} */ (data);
+  const { opId, userId, targetState, previousState, issuedAt, timeoutId, ...rest } = obj;
+  if (Object.keys(rest).length > 0) {
+    throw new TypeError(`PendingOp: unknown keys: ${Object.keys(rest).join(", ")}`);
+  }
+  if (typeof opId !== "string" || opId.trim().length === 0) {
+    throw new TypeError("PendingOp: opId must be a non-empty string");
+  }
+  if (typeof userId !== "string" || userId.trim().length === 0) {
+    throw new TypeError("PendingOp: userId must be a non-empty string");
+  }
+  if (typeof targetState !== "string" || targetState.trim().length === 0) {
+    throw new TypeError("PendingOp: targetState must be a non-empty string");
+  }
+  if (typeof previousState !== "string" || previousState.trim().length === 0) {
+    throw new TypeError("PendingOp: previousState must be a non-empty string");
+  }
+  if (typeof issuedAt !== "number" || !Number.isFinite(issuedAt) || issuedAt < 0 || !Number.isInteger(issuedAt)) {
+    throw new TypeError("PendingOp: issuedAt must be a finite non-negative integer");
+  }
+  if (timeoutId !== null) {
+    if (typeof timeoutId !== "number") {
+      throw new TypeError("PendingOp: timeoutId must be a number or null");
+    }
+    if (!Number.isFinite(timeoutId) || timeoutId < 0) {
+      throw new TypeError("PendingOp: timeoutId must be a finite non-negative number");
+    }
+  }
+  return /** @type {PendingOp} */ (data);
+}
@@ -0,0 +1,82 @@
+/**
+ * Scene Preset contract.
+ *
+ * A Scene Preset is a named snapshot of the Visibility Matrix, stored as a
+ * flag on a FoundryVTT Scene document. Up to 50 presets per world.
+ *
+ * Storage key: scene.getFlag('video-view-manager', 'preset')
+ * Shape: { _version: 1, presets: { [name: string]: ScenePreset } }
+ *
+ * @module contracts/scene-preset
+ */
+
+/**
+ * @typedef {Object} ScenePreset
+ * @property {1} _version - Schema version; always 1 for v1.
+ * @property {string} name - Unique preset name (non-empty string).
+ * @property {Object.<string, string>} matrix - userId→VisibilityState snapshot.
+ * @property {number} createdAt - Timestamp (ms) when preset was created.
+ * @property {number} updatedAt - Timestamp (ms) when preset was last updated.
+ */
+
+export const SCENE_PRESET_VERSION = 1;
+export const MAX_PRESETS_PER_WORLD = 50;
+
+/**
+ * Creates a new ScenePreset.
+ * @param {string} name - Unique preset name.
+ * @param {Object.<string, string>} [matrix={}] - userId→VisibilityState snapshot.
+ * @param {number} [now] - Timestamp; defaults to Date.now().
+ * @returns {ScenePreset}
+ */
+export function createScenePreset(name, matrix = {}, now = Date.now()) {
+  return {
+    _version: SCENE_PRESET_VERSION,
+    name,
+    matrix: { ...matrix },
+    createdAt: now,
+    updatedAt: now,
+  };
+}
+
+/**
+ * Validates a ScenePreset DTO. Throws TypeError on any violation.
+ * @param {unknown} data - Value to validate.
+ * @returns {ScenePreset} The validated preset.
+ * @throws {TypeError} If data fails validation.
+ */
+export function isValidScenePreset(data) {
+  if (data === null || typeof data !== "object") {
+    throw new TypeError("ScenePreset: must be an object");
+  }
+  const obj = /** @type {Record<string, unknown>} */ (data);
+  const { _version, name, matrix, createdAt, updatedAt, ...rest } = obj;
+  if (Object.keys(rest).length > 0) {
+    throw new TypeError(`ScenePreset: unknown keys: ${Object.keys(rest).join(", ")}`);
+  }
+  if (_version !== SCENE_PRESET_VERSION) {
+    throw new TypeError(`ScenePreset: _version must be ${SCENE_PRESET_VERSION}, got ${_version}`);
+  }
+  if (typeof name !== "string" || name.length === 0) {
+    throw new TypeError("ScenePreset: name must be a non-empty string");
+  }
+  if (matrix === null || typeof matrix !== "object" || Array.isArray(matrix)) {
+    throw new TypeError("ScenePreset: matrix must be a plain object");
+  }
+  const matrixObj = /** @type {Record<string, unknown>} */ (matrix);
+  for (const [userId, state] of Object.entries(matrixObj)) {
+    if (typeof userId !== "string" || userId.length === 0) {
+      throw new TypeError(`ScenePreset: userId key must be non-empty string, got "${userId}"`);
+    }
+    if (typeof state !== "string" || state.length === 0) {
+      throw new TypeError(`ScenePreset: state for "${userId}" must be a non-empty string`);
+    }
+  }
+  if (typeof createdAt !== "number" || !Number.isFinite(createdAt) || createdAt < 0) {
+    throw new TypeError("ScenePreset: createdAt must be a finite non-negative integer");
+  }
+  if (typeof updatedAt !== "number" || !Number.isFinite(updatedAt) || updatedAt < 0) {
+    throw new TypeError("ScenePreset: updatedAt must be a finite non-negative integer");
+  }
+  return /** @type {ScenePreset} */ (data);
+}
@@ -0,0 +1,132 @@
+/**
+ * Socket message contract.
+ *
+ * Two message directions:
+ *   Intent (GM → all):   scrying-pool.visibility.set    { opId, userId, targetState }
+ *   Echo   (all ← GM):   scrying-pool.visibility.updated { opId, userId, state, revision }
+ *
+ * Validated at both send and receive. Payload ≥ 4096 bytes → throw before emit.
+ *
+ * @module contracts/socket-message
+ */
+
+/** @typedef {'scrying-pool.visibility.set'|'scrying-pool.visibility.updated'|'scrying-pool.preset.apply'|'scrying-pool.preset.applied'} SocketEventName */
+
+/**
+ * @typedef {Object} SocketIntentPayload
+ * @property {string} opId - Unique operation ID (non-empty string).
+ * @property {string} userId - Target participant userId (non-empty string).
+ * @property {string} targetState - Desired VisibilityState.
+ */
+
+/**
+ * @typedef {Object} SocketEchoPayload
+ * @property {string} opId - Matches the originating intent opId.
+ * @property {string} userId - Affected participant userId.
+ * @property {string} state - Authoritative VisibilityState after this operation.
+ * @property {number} revision - Monotonically increasing revision counter.
+ */
+
+/**
+ * @typedef {Object} SocketMessage
+ * @property {SocketEventName} event - Socket event name.
+ * @property {SocketIntentPayload|SocketEchoPayload} payload - Message payload.
+ */
+
+export const SOCKET_EVENTS = Object.freeze({
+  VISIBILITY_SET: "scrying-pool.visibility.set",
+  VISIBILITY_UPDATED: "scrying-pool.visibility.updated",
+  PRESET_APPLY: "scrying-pool.preset.apply",
+  PRESET_APPLIED: "scrying-pool.preset.applied",
+});
+
+export const MAX_PAYLOAD_BYTES = 4096;
+
+/**
+ * Creates a socket intent message (GM → all clients).
+ * @param {string} opId - Unique operation ID.
+ * @param {string} userId - Target participant userId.
+ * @param {string} targetState - Desired VisibilityState.
+ * @returns {SocketMessage}
+ */
+export function createSocketIntentMessage(opId, userId, targetState) {
+  return {
+    event: SOCKET_EVENTS.VISIBILITY_SET,
+    payload: { opId, userId, targetState },
+  };
+}
+
+/**
+ * Creates a socket echo message (authoritative broadcast to all clients).
+ * @param {string} opId - Originating intent opId.
+ * @param {string} userId - Affected participant userId.
+ * @param {string} state - Authoritative VisibilityState.
+ * @param {number} revision - Revision counter.
+ * @returns {SocketMessage}
+ */
+export function createSocketEchoMessage(opId, userId, state, revision) {
+  return {
+    event: SOCKET_EVENTS.VISIBILITY_UPDATED,
+    payload: { opId, userId, state, revision },
+  };
+}
+
+/**
+ * Validates a SocketMessage DTO. Throws TypeError on any violation.
+ * @param {unknown} data - Value to validate.
+ * @returns {SocketMessage} The validated message.
+ * @throws {TypeError} If data fails validation.
+ */
+export function isValidSocketMessage(data) {
+  if (data === null || typeof data !== "object") {
+    throw new TypeError("SocketMessage: must be an object");
+  }
+  const obj = /** @type {Record<string, unknown>} */ (data);
+  const { event, payload, ...rest } = obj;
+  if (Object.keys(rest).length > 0) {
+    throw new TypeError(`SocketMessage: unknown keys: ${Object.keys(rest).join(", ")}`);
+  }
+  if (!Object.values(SOCKET_EVENTS).includes(/** @type {any} */ (event))) {
+    throw new TypeError(`SocketMessage: unknown event "${event}"`);
+  }
+  if (payload === null || typeof payload !== "object") {
+    throw new TypeError("SocketMessage: payload must be an object");
+  }
+  const p = /** @type {Record<string, unknown>} */ (payload);
+  // Validate intent payload
+  if (event === SOCKET_EVENTS.VISIBILITY_SET) {
+    const { opId, userId, targetState, ...payloadRest } = p;
+    if (Object.keys(payloadRest).length > 0) {
+      throw new TypeError(`SocketMessage intent: unknown payload keys: ${Object.keys(payloadRest).join(", ")}`);
+    }
+    if (typeof opId !== "string" || opId.length === 0) {
+      throw new TypeError("SocketMessage: opId must be a non-empty string");
+    }
+    if (typeof userId !== "string" || userId.length === 0) {
+      throw new TypeError("SocketMessage: userId must be a non-empty string");
+    }
+    if (typeof targetState !== "string" || targetState.length === 0) {
+      throw new TypeError("SocketMessage: targetState must be a non-empty string");
+    }
+  }
+  // Validate echo payload
+  if (event === SOCKET_EVENTS.VISIBILITY_UPDATED) {
+    const { opId, userId, state, revision, ...payloadRest } = p;
+    if (Object.keys(payloadRest).length > 0) {
+      throw new TypeError(`SocketMessage echo: unknown payload keys: ${Object.keys(payloadRest).join(", ")}`);
+    }
+    if (typeof opId !== "string" || opId.length === 0) {
+      throw new TypeError("SocketMessage: opId must be a non-empty string");
+    }
+    if (typeof userId !== "string" || userId.length === 0) {
+      throw new TypeError("SocketMessage: userId must be a non-empty string");
+    }
+    if (typeof state !== "string" || state.length === 0) {
+      throw new TypeError("SocketMessage: state must be a non-empty string");
+    }
+    if (typeof revision !== "number" || !Number.isFinite(revision) || revision < 0) {
+      throw new TypeError("SocketMessage: revision must be a finite non-negative number");
+    }
+  }
+  return /** @type {SocketMessage} */ (data);
+}
@@ -0,0 +1,73 @@
+/**
+ * Visibility Matrix contract.
+ *
+ * Canonical shape: { _version: 1, matrix: { [userId: string]: VisibilityState } }
+ * where VisibilityState ∈ VISIBILITY_STATES.
+ *
+ * StateStore is the sole writer of this structure. All other modules treat it as read-only.
+ *
+ * @module contracts/visibility-matrix
+ */
+
+/** @typedef {'active'|'hidden'|'self-muted'|'offline'|'cam-lost'|'reconnecting'|'never-connected'|'ghost'} VisibilityState */
+
+/**
+ * @typedef {Object} VisibilityMatrix
+ * @property {1} _version - Schema version; always 1 for v1.
+ * @property {Object.<string, VisibilityState>} matrix - userId → VisibilityState map.
+ */
+
+export const VISIBILITY_STATES = Object.freeze([
+  "active",
+  "hidden",
+  "self-muted",
+  "offline",
+  "cam-lost",
+  "reconnecting",
+  "never-connected",
+  "ghost",
+]);
+
+export const VISIBILITY_MATRIX_VERSION = 1;
+
+/**
+ * Creates a new VisibilityMatrix with an optional initial matrix.
+ * @param {Object.<string, VisibilityState>} [matrix={}] - Initial userId→state entries.
+ * @returns {VisibilityMatrix}
+ */
+export function createVisibilityMatrix(matrix = {}) {
+  return { _version: VISIBILITY_MATRIX_VERSION, matrix: { ...matrix } };
+}
+
+/**
+ * Validates a VisibilityMatrix DTO. Throws TypeError on any violation.
+ * @param {unknown} data - Value to validate.
+ * @returns {VisibilityMatrix} The validated matrix.
+ * @throws {TypeError} If data fails validation.
+ */
+export function isValidVisibilityMatrix(data) {
+  if (data === null || typeof data !== "object") {
+    throw new TypeError("VisibilityMatrix: must be an object");
+  }
+  const obj = /** @type {Record<string, unknown>} */ (data);
+  const { _version, matrix, ...rest } = obj;
+  if (Object.keys(rest).length > 0) {
+    throw new TypeError(`VisibilityMatrix: unknown keys: ${Object.keys(rest).join(", ")}`);
+  }
+  if (_version !== VISIBILITY_MATRIX_VERSION) {
+    throw new TypeError(`VisibilityMatrix: _version must be ${VISIBILITY_MATRIX_VERSION}, got ${_version}`);
+  }
+  if (matrix === null || typeof matrix !== "object" || Array.isArray(matrix)) {
+    throw new TypeError("VisibilityMatrix: matrix must be a plain object");
+  }
+  const matrixObj = /** @type {Record<string, unknown>} */ (matrix);
+  for (const [userId, state] of Object.entries(matrixObj)) {
+    if (typeof userId !== "string" || userId.length === 0) {
+      throw new TypeError(`VisibilityMatrix: userId must be a non-empty string, got "${userId}"`);
+    }
+    if (!VISIBILITY_STATES.includes(/** @type {any} */ (state))) {
+      throw new TypeError(`VisibilityMatrix: invalid state "${state}" for userId "${userId}"`);
+    }
+  }
+  return /** @type {VisibilityMatrix} */ (data);
+}