@colyseus/core 0.17.42 → 0.18.0

package/build/RoomPlugin.cjs

@@ -0,0 +1,252 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/core/src/RoomPlugin.ts
+var RoomPlugin_exports = {};
+__export(RoomPlugin_exports, {
+  DEFAULT_PLUGIN_ORDER: () => DEFAULT_PLUGIN_ORDER,
+  PLUGIN_LIFECYCLE_KEYS: () => PLUGIN_LIFECYCLE_KEYS,
+  RoomPlugin: () => RoomPlugin,
+  attachToTestRoom: () => attachToTestRoom,
+  computePluginLayout: () => computePluginLayout,
+  definePlugins: () => definePlugins,
+  installPluginHookWrappers: () => installPluginHookWrappers,
+  setupRoomPlugins: () => setupRoomPlugins
+});
+module.exports = __toCommonJS(RoomPlugin_exports);
+var RoomPlugin = class {
+};
+function definePlugins(plugins) {
+  if (!Array.isArray(plugins)) {
+    return plugins;
+  }
+  const out = {};
+  for (const p of plugins) {
+    const key = p["pluginName"];
+    if (typeof key !== "string" || key.length === 0) {
+      throw new Error(
+        `[Room] plugin ${p.constructor.name} is missing a 'pluginName' field. Declare \`readonly pluginName = '<key>' as const\` on the class, or register it via the keyed-record form \`definePlugins({ <key>: <plugin> })\`.`
+      );
+    }
+    if (out[key]) {
+      throw new Error(
+        `[Room] two plugins resolve to pluginName "${key}". Configure one of them via constructor argument, or use the keyed-record form to disambiguate.`
+      );
+    }
+    out[key] = p;
+  }
+  return out;
+}
+var PLUGIN_LIFECYCLE_KEYS = ["onCreate", "onAuth", "onJoin", "onLeave", "onDispose"];
+function attachToTestRoom(plugin, roomStub = {}) {
+  plugin.room = roomStub;
+  return roomStub;
+}
+var DEP_KEY_PREFIX = "__dep:";
+var DEFAULT_PLUGIN_ORDER = {
+  onCreate: "before",
+  onAuth: "before",
+  onJoin: "before",
+  onLeave: "after",
+  onDispose: "after"
+};
+function computePluginLayout(plugins) {
+  const resolved = resolveDependencies(plugins);
+  const hooks = {};
+  let anyHook = false;
+  for (const hook of PLUGIN_LIFECYCLE_KEYS) {
+    const before = [];
+    const after = [];
+    for (const { key, plugin } of resolved.entries) {
+      if (typeof plugin[hook] !== "function") {
+        continue;
+      }
+      const order = plugin["order"]?.[hook] ?? DEFAULT_PLUGIN_ORDER[hook];
+      (order === "before" ? before : after).push(key);
+      anyHook = true;
+    }
+    hooks[hook] = { before, after };
+  }
+  const messageOwners = /* @__PURE__ */ new Map();
+  for (const { key, plugin } of resolved.entries) {
+    const messages = plugin["messages"];
+    if (!messages) {
+      continue;
+    }
+    for (const messageKey of Object.keys(messages)) {
+      const prior = messageOwners.get(messageKey);
+      if (prior !== void 0) {
+        throw new Error(
+          `[Room] message key "${messageKey}" declared by multiple plugins: "${prior}" and "${key}". Resolve by giving one of them a different key, or override on the room's own \`messages\`.`
+        );
+      }
+      messageOwners.set(messageKey, key);
+    }
+  }
+  if (!anyHook && messageOwners.size === 0 && resolved.autoDeps.length === 0) {
+    return null;
+  }
+  return { hooks, messageOwners, autoDeps: resolved.autoDeps };
+}
+function resolveDependencies(plugins) {
+  const entries = [];
+  for (const [key, plugin] of Object.entries(plugins)) {
+    entries.push({ key, plugin });
+  }
+  const present = /* @__PURE__ */ new Set();
+  for (const { plugin } of entries) {
+    present.add(plugin.constructor);
+  }
+  const autoDeps = [];
+  const visiting = /* @__PURE__ */ new Set();
+  const path = [];
+  function walk(depCtor) {
+    if (present.has(depCtor)) {
+      return;
+    }
+    if (visiting.has(depCtor)) {
+      const cycle = [...path, depCtor.name].join(" \u2192 ");
+      throw new Error(`[Room] plugin dependency cycle: ${cycle}`);
+    }
+    visiting.add(depCtor);
+    path.push(depCtor.name);
+    const deeper = depCtor.dependencies;
+    if (Array.isArray(deeper)) {
+      for (const inner of deeper) {
+        walk(inner);
+      }
+    }
+    let instance;
+    try {
+      instance = new depCtor();
+    } catch (err) {
+      throw new Error(
+        `[Room] auto-included plugin "${depCtor.name}" must be constructible with no arguments. If it needs options, register it explicitly in definePlugins({...}). (cause: ${err?.message ?? err})`
+      );
+    }
+    const key = DEP_KEY_PREFIX + depCtor.name;
+    entries.push({ key, plugin: instance });
+    autoDeps.push({ key, ctor: depCtor });
+    present.add(depCtor);
+    visiting.delete(depCtor);
+    path.pop();
+  }
+  const userEntriesSnapshot = entries.slice();
+  for (const { plugin } of userEntriesSnapshot) {
+    const deps = plugin.constructor.dependencies;
+    if (!Array.isArray(deps)) {
+      continue;
+    }
+    for (const depCtor of deps) {
+      walk(depCtor);
+    }
+  }
+  return { entries, autoDeps };
+}
+function installPluginHookWrappers(ctor, layout) {
+  if (layout === null) {
+    return;
+  }
+  const proto = ctor.prototype;
+  for (const hook of PLUGIN_LIFECYCLE_KEYS) {
+    const { before, after } = layout.hooks[hook];
+    if (before.length === 0 && after.length === 0) {
+      continue;
+    }
+    const original = proto[hook];
+    proto[hook] = async function(...args) {
+      const lookup = (k) => k.startsWith(DEP_KEY_PREFIX) ? this._autoPlugins[k] : this.plugins[k];
+      for (const k of before) {
+        const p = lookup(k);
+        await p[hook].call(p, ...args);
+      }
+      let result;
+      if (original) {
+        result = await original.apply(this, args);
+      }
+      for (const k of after) {
+        const p = lookup(k);
+        await p[hook].call(p, ...args);
+      }
+      return result;
+    };
+  }
+}
+function setupRoomPlugins(room) {
+  const plugins = room.plugins;
+  const layout = resolveOrComputeLayout(room.constructor, plugins);
+  attachRoomReference(room, plugins);
+  if (layout && layout.autoDeps.length > 0) {
+    room._autoPlugins = instantiateAutoDeps(room, layout);
+  }
+  if (layout && layout.messageOwners.size > 0) {
+    mergePluginMessages(room, layout);
+  }
+  Object.freeze(plugins);
+  if (room._autoPlugins) {
+    Object.freeze(room._autoPlugins);
+  }
+}
+function resolveOrComputeLayout(ctor, plugins) {
+  if (Object.prototype.hasOwnProperty.call(ctor, "__pluginLayout")) {
+    return ctor.__pluginLayout;
+  }
+  const layout = computePluginLayout(plugins);
+  installPluginHookWrappers(ctor, layout);
+  ctor.__pluginLayout = layout;
+  return layout;
+}
+function attachRoomReference(room, plugins) {
+  for (const plugin of Object.values(plugins)) {
+    plugin.room = room;
+  }
+}
+function instantiateAutoDeps(room, layout) {
+  const auto = {};
+  for (const { key, ctor: depCtor } of layout.autoDeps) {
+    const instance = new depCtor();
+    instance.room = room;
+    auto[key] = instance;
+  }
+  return auto;
+}
+function mergePluginMessages(room, layout) {
+  const plugins = room.plugins;
+  for (const [messageKey, pluginKey] of layout.messageOwners) {
+    if (room.messages?.[messageKey]) {
+      continue;
+    }
+    const source = pluginKey.startsWith(DEP_KEY_PREFIX) ? room._autoPlugins[pluginKey] : plugins[pluginKey];
+    const handler = source["messages"]?.[messageKey];
+    if (handler !== void 0) {
+      (room.messages ??= {})[messageKey] = handler;
+    }
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFAULT_PLUGIN_ORDER,
+  PLUGIN_LIFECYCLE_KEYS,
+  RoomPlugin,
+  attachToTestRoom,
+  computePluginLayout,
+  definePlugins,
+  installPluginHookWrappers,
+  setupRoomPlugins
+});

package/build/RoomPlugin.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/RoomPlugin.ts"],
+  "sourcesContent": ["/**\n * Room plugins.\n *\n * A plugin is a composable extension to a Room \u2014 it can declare message\n * handlers, attach lifecycle hooks, and expose public methods that the\n * room can call (`this.plugins.<key>.someMethod()`). The framework\n * instantiates one plugin per room, sets `this.room` after the room is\n * constructed, then merges the plugin's `messages` with the room's own\n * and wires its lifecycle hooks alongside the room's.\n *\n * Example: a tiny chat plugin contributing a single message handler:\n *\n *   class ChatPlugin extends RoomPlugin {\n *     private history: string[] = [];\n *     constructor(private opts: { historyLimit: number }) { super(); }\n *\n *     messages = {\n *       chat: (client: Client, msg: { text: string }) => {\n *         this.history.push(msg.text);\n *         if (this.history.length > this.opts.historyLimit) this.history.shift();\n *         this.room.broadcast('chat', { from: client.userId, text: msg.text });\n *       },\n *     };\n *\n *     // Public \u2014 callable as `this.plugins.chat.getHistory()` from the room\n *     getHistory(): readonly string[] { return this.history; }\n *   }\n *\n * Use via `definePlugins`:\n *\n *   class MyRoom extends Room<{ state: MyState }> {\n *     plugins = definePlugins({\n *       chat: new ChatPlugin({ historyLimit: 100 }),\n *     });\n *   }\n */\nimport type { Room } from './Room.ts';\nimport type { AuthContext, Client } from './Transport.ts';\nimport type { Messages } from '@colyseus/shared-types';\n\n/**\n * Ordering hint for a plugin's lifecycle hook relative to the room's own\n * hook. Sensible per-hook defaults are applied when omitted (see\n * `Room.__init` for the exact ordering policy).\n *\n *   onCreate  / onAuth / onJoin  \u2192 plugins run BEFORE room (guards + setup)\n *   onLeave   / onDispose        \u2192 plugins run AFTER room (capture final state)\n */\nexport interface RoomPluginOrder {\n  onCreate?:  'before' | 'after';\n  onAuth?:    'before' | 'after';\n  onJoin?:    'before' | 'after';\n  onLeave?:   'before' | 'after';\n  onDispose?: 'before' | 'after';\n}\n\n/**\n * Base class for room plugins. Subclass to define a plugin; the framework\n * sets `this.room` after the host room is fully constructed.\n *\n * Don't access `this.room` from the plugin's constructor \u2014 it hasn't been\n * wired yet. Everything room-dependent goes in `onCreate` / `onJoin` /\n * etc. or in public methods that are called from the room post-init.\n *\n * @typeParam This - The Room subclass this plugin is attached to. Narrow\n *   for schema-driven plugins that need a specific state shape, e.g.\n *   `class PhysicsPlugin extends RoomPlugin<Room<{ state: PhysicsContract }>>`.\n */\nexport abstract class RoomPlugin<This extends Room = Room> {\n  /**\n   * Live room reference. Wired by the framework at __init, AFTER the\n   * room's own construction \u2014 accessing it from the plugin's\n   * constructor throws.\n   */\n  protected readonly room!: This;\n\n  /**\n   * Canonical key for the plugin when registered via `definePlugins([...])`.\n   * Declared on the subclass with `as const` so the literal type flows\n   * into `room.plugins.<key>`:\n   *\n   *   class ChatPlugin extends RoomPlugin {\n   *     readonly pluginName = 'chat' as const;\n   *   }\n   *\n   * Optional under the keyed-record form (`definePlugins({ chat: ... })`),\n   * required under the array form. Must stay `public` so `extends` /\n   * `keyof` can see the literal \u2014 those are blind to protected from\n   * outside the class. End-user autocomplete hides it via `Omit` in\n   * `definePlugins`'s return type.\n   *\n   * For multi-instance use, accept the name at construction:\n   *\n   *   readonly pluginName: string;\n   *   constructor(name = 'chat') { super(); this.pluginName = name; }\n   */\n  readonly pluginName?: string;\n\n  /**\n   * Declarative message handlers \u2014 merged into the room's `messages` at\n   * __init. Conflict against the room's own key: room wins. Conflict\n   * between two plugins: throws at __init.\n   */\n  protected messages?: Messages<This>;\n\n  /** Optional per-hook ordering vs the room's own hook. */\n  protected order?: RoomPluginOrder;\n\n  // Lifecycle hooks \u2014 override any subset. `protected` so they don't\n  // leak into `this.plugins.<key>.onJoin(...)` autocomplete; subclass\n  // overrides must keep `protected` (TS widens to public silently\n  // otherwise).\n  protected onCreate?(options: any): void | Promise<void>;\n  protected onAuth?(client: Client, options: any, context: AuthContext): void | Promise<void>;\n  protected onJoin?(client: Client, options?: any): void | Promise<void>;\n  protected onLeave?(client: Client, code?: number): void | Promise<void>;\n  protected onDispose?(): void | Promise<void>;\n}\n\n/**\n * Plugin-class constructor type used by the `dependencies` static\n * declaration. Constrained to zero-arg constructors because the\n * framework auto-instantiates missing dependencies with no\n * configuration \u2014 plugins that need options can't be auto-included\n * and must be registered explicitly in `definePlugins({...})`.\n */\nexport type RoomPluginClass = new () => RoomPlugin<any>;\n\n/**\n * Static `dependencies` declaration. List other plugin classes this\n * plugin needs alongside it; the framework auto-instantiates any\n * missing ones at room construction time. Transitive deps are\n * resolved recursively. Cycles throw at class-init.\n *\n * Example:\n *   class UniqueSessionPlugin extends RoomPlugin {\n *     static dependencies: PluginDependencies = [TrackUserSessionsPlugin];\n *   }\n */\nexport type PluginDependencies = ReadonlyArray<RoomPluginClass>;\n\n/**\n * Define a Room's plugin record. The framework wires plugins at\n * `__init` \u2014 first construct of the class computes the layout\n * (cached on the constructor) and installs hook wrappers on the\n * prototype. The `const T` modifier preserves literal types so\n * `this.plugins.<key>.method()` autocompletes against each plugin's\n * specific subclass.\n */\n// Pulls each plugin's `pluginName` literal as the record key. Subclass\n// must narrow with `as const` \u2014 plain `string` resolves to `never`\n// and the entry is dropped (callers see a TS error on\n// `plugins.<thatKey>`).\ntype ExtractPluginName<P> = P extends { pluginName: infer K }\n  ? (K extends string ? K : never)\n  : never;\n\n/** Hide `pluginName` from end-user autocomplete on `this.plugins.<key>`. */\ntype PluginPublicSurface<P> = Omit<P, 'pluginName'>;\n\ntype PluginsArrayToRecord<T extends readonly RoomPlugin<any>[]> = {\n  [P in T[number] as ExtractPluginName<P>]: PluginPublicSurface<P>;\n};\n\n/**\n * Array form (recommended). Each plugin declares its own canonical\n * key via `readonly pluginName = '...' as const`; the framework\n * turns the array into a typed record so `plugins.<pluginName>`\n * autocompletes the right instance type.\n *\n *   class GameRoom extends Room {\n *     plugins = definePlugins([\n *       new ChatPlugin(),                    // pluginName: 'chat'\n *       new UniqueSessionPlugin({ max: 1 }), // pluginName: 'uniqueSession'\n *     ]);\n *   }\n *   this.plugins.chat.send('hi');\n *\n * Throws at runtime if any plugin is missing `pluginName` or if two\n * plugins resolve to the same key.\n */\nexport function definePlugins<const T extends readonly RoomPlugin<any>[]>(\n  plugins: T,\n): PluginsArrayToRecord<T>;\n\n/**\n * Record form (legacy / multi-instance escape hatch). The caller\n * chooses the key per-room. Useful when registering two instances of\n * the same plugin class without configuring `pluginName` per\n * instance \u2014 e.g. `{ adminChat: new ChatPlugin(), playerChat: new ChatPlugin() }`.\n */\nexport function definePlugins<const T extends Record<string, RoomPlugin<any>>>(\n  plugins: T,\n): { [K in keyof T]: PluginPublicSurface<T[K]> };\n\nexport function definePlugins(plugins: any): any {\n  if (!Array.isArray(plugins)) { return plugins; }\n  const out: Record<string, RoomPlugin> = {};\n  for (const p of plugins) {\n    const key = p['pluginName'];\n    if (typeof key !== 'string' || key.length === 0) {\n      throw new Error(\n        `[Room] plugin ${p.constructor.name} is missing a 'pluginName' field. ` +\n        `Declare \\`readonly pluginName = '<key>' as const\\` on the class, ` +\n        `or register it via the keyed-record form \\`definePlugins({ <key>: <plugin> })\\`.`,\n      );\n    }\n    if (out[key]) {\n      throw new Error(\n        `[Room] two plugins resolve to pluginName \"${key}\". Configure one of ` +\n        `them via constructor argument, or use the keyed-record form to disambiguate.`,\n      );\n    }\n    out[key] = p;\n  }\n  return out;\n}\n\n/**\n * Lifecycle hook keys recognized by the framework \u2014 used internally to\n * separate \"framework-recognized methods\" from \"user-defined public\n * methods\" when wiring a plugin into a room. Exported for the test\n * harness; downstream code should not need it.\n */\nexport const PLUGIN_LIFECYCLE_KEYS = ['onCreate', 'onAuth', 'onJoin', 'onLeave', 'onDispose'] as const;\nexport type PluginLifecycleKey = (typeof PLUGIN_LIFECYCLE_KEYS)[number];\n\n/**\n * Test helper \u2014 attach a stub or fake room to a plugin so its methods\n * and lifecycle hooks can be exercised in isolation without spinning up\n * a real Colyseus server.\n *\n *   const plugin = new ChatPlugin({ historyLimit: 5 });\n *   const room = attachToTestRoom(plugin, { broadcast: sinon.spy() });\n *   await plugin.messages!.chat!.call(plugin, { userId: 'u1' }, { text: 'hi' });\n *\n * The second arg is shallow-merged onto the stub so tests only declare\n * the room properties they actually exercise. Returns the room stub for\n * post-call assertions.\n */\nexport function attachToTestRoom<This extends Room, R extends Partial<This>>(\n  plugin: RoomPlugin<This>,\n  roomStub: R = {} as R,\n): R {\n  (plugin as any).room = roomStub;\n  return roomStub;\n}\n\n// ---------------------------------------------------------------------------\n// Layout machinery \u2014 used by Room.__init to set plugins up once per class.\n// Lives in this file (rather than Room.ts) so the plugin-related types and\n// helpers stay co-located. These are framework internals; callers outside\n// `@colyseus/core` should not depend on them.\n// ---------------------------------------------------------------------------\n\n/**\n * Precomputed plugin layout for a Room subclass \u2014 populated on first\n * construct, cached on the constructor. Hook wrappers are installed\n * on the prototype in the same pass (see `installPluginHookWrappers`).\n *\n * @internal\n */\nexport interface PluginLayout {\n  /** Per-hook participation: which plugin keys run before/after the room's own hook. */\n  hooks: Record<PluginLifecycleKey, { before: string[]; after: string[] }>;\n  /** Message key \u2192 plugin key. Conflict detection ran when this was built. */\n  messageOwners: Map<string, string>;\n  /** Sentinel-keyed plugin classes to instantiate per room. */\n  autoDeps: Array<{ key: string; ctor: RoomPluginClass }>;\n}\n\n/** Sentinel prefix for framework-instantiated deps. The colon prevents\n *  collisions with any JS identifier the user could use as a key. */\nconst DEP_KEY_PREFIX = '__dep:';\n\n/**\n * Default before/after policy for lifecycle hooks vs the room's own\n * hook. Plugins can override per-hook via the `order` field on the\n * plugin instance.\n *\n *   onCreate / onAuth / onJoin \u2192 plugins run BEFORE room (guards + setup)\n *   onLeave  / onDispose       \u2192 plugins run AFTER room (capture final state)\n *\n * @internal\n */\nexport const DEFAULT_PLUGIN_ORDER: Record<PluginLifecycleKey, 'before' | 'after'> = {\n  onCreate:  'before',\n  onAuth:    'before',\n  onJoin:    'before',\n  onLeave:   'after',\n  onDispose: 'after',\n};\n\n/**\n * Walk the room's plugin instances and produce the lifecycle + message\n * layout for the Room class. Called once per Room subclass \u2014 on the\n * first construct \u2014 and the result is cached on the constructor. Throws\n * on duplicate message keys (named both plugin keys) so the failure is\n * visible at class-init rather than at first message dispatch.\n *\n * Returns `null` when no plugins participate in any hook AND none\n * declare a message \u2014 distinguishes \"computed, nothing to do\" from\n * \"not computed yet\" in the `__pluginLayout` cache.\n *\n * @internal\n */\nexport function computePluginLayout(plugins: Record<string, RoomPlugin>): PluginLayout | null {\n  // Resolve `static dependencies` closures over the user's record.\n  // Returns an expanded list (user + auto-deps), the auto-dep\n  // class table for per-room instantiation, and a unified view of\n  // entries to iterate when computing hooks / message owners.\n  const resolved = resolveDependencies(plugins);\n\n  const hooks = {} as Record<PluginLifecycleKey, { before: string[]; after: string[] }>;\n  let anyHook = false;\n\n  for (const hook of PLUGIN_LIFECYCLE_KEYS) {\n    const before: string[] = [];\n    const after: string[] = [];\n    for (const { key, plugin } of resolved.entries) {\n      if (typeof plugin[hook] !== 'function') { continue; }\n      // Bracket access \u2014 `order` and `messages` are protected; TS\n      // skips visibility checks on indexed access.\n      const order = plugin['order']?.[hook] ?? DEFAULT_PLUGIN_ORDER[hook];\n      (order === 'before' ? before : after).push(key);\n      anyHook = true;\n    }\n    hooks[hook] = { before, after };\n  }\n\n  const messageOwners = new Map<string, string>();\n  for (const { key, plugin } of resolved.entries) {\n    const messages = plugin['messages'];\n    if (!messages) { continue; }\n    for (const messageKey of Object.keys(messages)) {\n      const prior = messageOwners.get(messageKey);\n      if (prior !== undefined) {\n        throw new Error(\n          `[Room] message key \"${messageKey}\" declared by multiple plugins: ` +\n          `\"${prior}\" and \"${key}\". Resolve by giving one of them a ` +\n          `different key, or override on the room's own \\`messages\\`.`,\n        );\n      }\n      messageOwners.set(messageKey, key);\n    }\n  }\n\n  if (!anyHook && messageOwners.size === 0 && resolved.autoDeps.length === 0) { return null; }\n  return { hooks, messageOwners, autoDeps: resolved.autoDeps };\n}\n\n/**\n * Walk every plugin's `static dependencies` recursively, instantiating\n * missing classes (zero-arg only). Throws on cycles. Auto-deps are\n * keyed `__dep:<ClassName>` in the returned entries.\n */\nfunction resolveDependencies(plugins: Record<string, RoomPlugin>): {\n  entries: Array<{ key: string; plugin: RoomPlugin }>;\n  autoDeps: Array<{ key: string; ctor: RoomPluginClass }>;\n} {\n  const entries: Array<{ key: string; plugin: RoomPlugin }> = [];\n  for (const [key, plugin] of Object.entries(plugins)) {\n    entries.push({ key, plugin });\n  }\n\n  const present = new Set<RoomPluginClass>();\n  for (const { plugin } of entries) {\n    present.add(plugin.constructor as RoomPluginClass);\n  }\n\n  const autoDeps: Array<{ key: string; ctor: RoomPluginClass }> = [];\n  const visiting = new Set<RoomPluginClass>();\n  const path: string[] = [];\n\n  function walk(depCtor: RoomPluginClass): void {\n    if (present.has(depCtor)) { return; }\n    if (visiting.has(depCtor)) {\n      const cycle = [...path, depCtor.name].join(' \u2192 ');\n      throw new Error(`[Room] plugin dependency cycle: ${cycle}`);\n    }\n    visiting.add(depCtor);\n    path.push(depCtor.name);\n\n    // Recurse into deeper deps first \u2192 topological order in `entries`.\n    const deeper = (depCtor as any).dependencies as PluginDependencies | undefined;\n    if (Array.isArray(deeper)) {\n      for (const inner of deeper) { walk(inner); }\n    }\n\n    let instance: RoomPlugin;\n    try { instance = new depCtor(); }\n    catch (err: any) {\n      throw new Error(\n        `[Room] auto-included plugin \"${depCtor.name}\" must be ` +\n        `constructible with no arguments. If it needs options, ` +\n        `register it explicitly in definePlugins({...}). ` +\n        `(cause: ${err?.message ?? err})`,\n      );\n    }\n    const key = DEP_KEY_PREFIX + depCtor.name;\n    entries.push({ key, plugin: instance });\n    autoDeps.push({ key, ctor: depCtor });\n    present.add(depCtor);\n\n    visiting.delete(depCtor);\n    path.pop();\n  }\n\n  // Snapshot before mutating \u2014 transitive deps are handled recursively\n  // inside `walk()`.\n  const userEntriesSnapshot = entries.slice();\n  for (const { plugin } of userEntriesSnapshot) {\n    const deps = (plugin.constructor as any).dependencies as PluginDependencies | undefined;\n    if (!Array.isArray(deps)) { continue; }\n    for (const depCtor of deps) { walk(depCtor); }\n  }\n\n  return { entries, autoDeps };\n}\n\n/**\n * Install one wrapper per participating hook on the Room subclass's\n * prototype. The wrapper closes over plugin KEYS (resolved to refs at\n * call time) and invokes the captured original room hook between the\n * before/after plugin runs.\n *\n * @internal\n */\nexport function installPluginHookWrappers(\n  ctor: { prototype: any },\n  layout: PluginLayout | null,\n): void {\n  if (layout === null) { return; }\n  const proto = ctor.prototype;\n  for (const hook of PLUGIN_LIFECYCLE_KEYS) {\n    const { before, after } = layout.hooks[hook];\n    if (before.length === 0 && after.length === 0) { continue; }\n\n    const original = proto[hook] as Function | undefined;\n    proto[hook] = async function (\n      this: { plugins?: Record<string, RoomPlugin>; _autoPlugins?: Record<string, RoomPlugin> },\n      ...args: any[]\n    ) {\n      // User plugins live on `this.plugins`, auto-deps (sentinel-keyed)\n      // on `this._autoPlugins` \u2014 kept separate so user types stay clean.\n      const lookup = (k: string): RoomPlugin =>\n        (k.startsWith(DEP_KEY_PREFIX) ? this._autoPlugins![k] : this.plugins![k]);\n      for (const k of before) {\n        const p = lookup(k);\n        await (p[hook] as Function).call(p, ...args);\n      }\n      let result: unknown;\n      if (original) { result = await original.apply(this, args); }\n      for (const k of after) {\n        const p = lookup(k);\n        await (p[hook] as Function).call(p, ...args);\n      }\n      return result;\n    };\n  }\n}\n\n/** Structural shape used by `setupRoomPlugins` \u2014 avoids a Room import\n *  so the dependency graph stays one-way (Room \u2192 RoomPlugin). */\ninterface RoomPluginHost {\n  plugins?: Record<string, RoomPlugin<any>>;\n  _autoPlugins?: Record<string, RoomPlugin<any>>;\n  messages?: Record<string, Function> | any;\n  constructor: { __pluginLayout?: PluginLayout | null; prototype: any };\n}\n\n/**\n * Wire a Room instance's plugins. Once-per-class layout (hook\n * participation, message owners, dep resolution) is cached on the\n * constructor; per-instance work attaches `room` refs, instantiates\n * auto-deps, and merges plugin messages.\n *\n * @internal\n */\nexport function setupRoomPlugins(room: RoomPluginHost): void {\n  const plugins = room.plugins!;\n  const layout = resolveOrComputeLayout(room.constructor, plugins);\n\n  attachRoomReference(room, plugins);\n\n  if (layout && layout.autoDeps.length > 0) {\n    room._autoPlugins = instantiateAutoDeps(room, layout);\n  }\n\n  if (layout && layout.messageOwners.size > 0) {\n    mergePluginMessages(room, layout);\n  }\n\n  Object.freeze(plugins);\n  if (room._autoPlugins) { Object.freeze(room._autoPlugins); }\n}\n\n/**\n * Read cached layout for this subclass, or compute + install on\n * first construct. `hasOwnProperty` so a subclass that redeclares\n * `plugins` doesn't inherit the parent's wrapping.\n */\nfunction resolveOrComputeLayout(\n  ctor: RoomPluginHost['constructor'],\n  plugins: Record<string, RoomPlugin>,\n): PluginLayout | null | undefined {\n  if (Object.prototype.hasOwnProperty.call(ctor, '__pluginLayout')) {\n    return ctor.__pluginLayout;\n  }\n  const layout = computePluginLayout(plugins);\n  installPluginHookWrappers(ctor, layout);\n  ctor.__pluginLayout = layout;\n  return layout;\n}\n\n/** Wire `plugin.room = room` on every user-explicit plugin. */\nfunction attachRoomReference(\n  room: RoomPluginHost,\n  plugins: Record<string, RoomPlugin>,\n): void {\n  for (const plugin of Object.values(plugins)) {\n    (plugin as any).room = room;\n  }\n}\n\n/**\n * Build `_autoPlugins` \u2014 one fresh instance per `static dependencies`\n * entry. Kept separate from `room.plugins` so sentinel keys\n * (`__dep:<ClassName>`) don't leak into the user's typed view.\n */\nfunction instantiateAutoDeps(\n  room: RoomPluginHost,\n  layout: PluginLayout,\n): Record<string, RoomPlugin> {\n  const auto: Record<string, RoomPlugin> = {};\n  for (const { key, ctor: depCtor } of layout.autoDeps) {\n    const instance = new depCtor();\n    (instance as any).room = room;\n    auto[key] = instance;\n  }\n  return auto;\n}\n\n/**\n * Copy plugin message handlers into `room.messages` (room's own key\n * wins; plugin-vs-plugin conflicts already threw at layout time).\n */\nfunction mergePluginMessages(\n  room: RoomPluginHost,\n  layout: PluginLayout,\n): void {\n  const plugins = room.plugins!;\n  for (const [messageKey, pluginKey] of layout.messageOwners) {\n    if (room.messages?.[messageKey]) { continue; }\n    const source = pluginKey.startsWith(DEP_KEY_PREFIX)\n      ? room._autoPlugins![pluginKey]\n      : plugins[pluginKey];\n    const handler = source['messages']?.[messageKey];\n    if (handler !== undefined) {\n      (room.messages ??= {} as any)[messageKey] = handler;\n    }\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAoEO,IAAe,aAAf,MAAoD;AAiD3D;AA8EO,SAAS,cAAc,SAAmB;AAC/C,MAAI,CAAC,MAAM,QAAQ,OAAO,GAAG;AAAE,WAAO;AAAA,EAAS;AAC/C,QAAM,MAAkC,CAAC;AACzC,aAAW,KAAK,SAAS;AACvB,UAAM,MAAM,EAAE,YAAY;AAC1B,QAAI,OAAO,QAAQ,YAAY,IAAI,WAAW,GAAG;AAC/C,YAAM,IAAI;AAAA,QACR,iBAAiB,EAAE,YAAY,IAAI;AAAA,MAGrC;AAAA,IACF;AACA,QAAI,IAAI,GAAG,GAAG;AACZ,YAAM,IAAI;AAAA,QACR,6CAA6C,GAAG;AAAA,MAElD;AAAA,IACF;AACA,QAAI,GAAG,IAAI;AAAA,EACb;AACA,SAAO;AACT;AAQO,IAAM,wBAAwB,CAAC,YAAY,UAAU,UAAU,WAAW,WAAW;AAgBrF,SAAS,iBACd,QACA,WAAc,CAAC,GACZ;AACH,EAAC,OAAe,OAAO;AACvB,SAAO;AACT;AA2BA,IAAM,iBAAiB;AAYhB,IAAM,uBAAuE;AAAA,EAClF,UAAW;AAAA,EACX,QAAW;AAAA,EACX,QAAW;AAAA,EACX,SAAW;AAAA,EACX,WAAW;AACb;AAeO,SAAS,oBAAoB,SAA0D;AAK5F,QAAM,WAAW,oBAAoB,OAAO;AAE5C,QAAM,QAAQ,CAAC;AACf,MAAI,UAAU;AAEd,aAAW,QAAQ,uBAAuB;AACxC,UAAM,SAAmB,CAAC;AAC1B,UAAM,QAAkB,CAAC;AACzB,eAAW,EAAE,KAAK,OAAO,KAAK,SAAS,SAAS;AAC9C,UAAI,OAAO,OAAO,IAAI,MAAM,YAAY;AAAE;AAAA,MAAU;AAGpD,YAAM,QAAQ,OAAO,OAAO,IAAI,IAAI,KAAK,qBAAqB,IAAI;AAClE,OAAC,UAAU,WAAW,SAAS,OAAO,KAAK,GAAG;AAC9C,gBAAU;AAAA,IACZ;AACA,UAAM,IAAI,IAAI,EAAE,QAAQ,MAAM;AAAA,EAChC;AAEA,QAAM,gBAAgB,oBAAI,IAAoB;AAC9C,aAAW,EAAE,KAAK,OAAO,KAAK,SAAS,SAAS;AAC9C,UAAM,WAAW,OAAO,UAAU;AAClC,QAAI,CAAC,UAAU;AAAE;AAAA,IAAU;AAC3B,eAAW,cAAc,OAAO,KAAK,QAAQ,GAAG;AAC9C,YAAM,QAAQ,cAAc,IAAI,UAAU;AAC1C,UAAI,UAAU,QAAW;AACvB,cAAM,IAAI;AAAA,UACR,uBAAuB,UAAU,oCAC7B,KAAK,UAAU,GAAG;AAAA,QAExB;AAAA,MACF;AACA,oBAAc,IAAI,YAAY,GAAG;AAAA,IACnC;AAAA,EACF;AAEA,MAAI,CAAC,WAAW,cAAc,SAAS,KAAK,SAAS,SAAS,WAAW,GAAG;AAAE,WAAO;AAAA,EAAM;AAC3F,SAAO,EAAE,OAAO,eAAe,UAAU,SAAS,SAAS;AAC7D;AAOA,SAAS,oBAAoB,SAG3B;AACA,QAAM,UAAsD,CAAC;AAC7D,aAAW,CAAC,KAAK,MAAM,KAAK,OAAO,QAAQ,OAAO,GAAG;AACnD,YAAQ,KAAK,EAAE,KAAK,OAAO,CAAC;AAAA,EAC9B;AAEA,QAAM,UAAU,oBAAI,IAAqB;AACzC,aAAW,EAAE,OAAO,KAAK,SAAS;AAChC,YAAQ,IAAI,OAAO,WAA8B;AAAA,EACnD;AAEA,QAAM,WAA0D,CAAC;AACjE,QAAM,WAAW,oBAAI,IAAqB;AAC1C,QAAM,OAAiB,CAAC;AAExB,WAAS,KAAK,SAAgC;AAC5C,QAAI,QAAQ,IAAI,OAAO,GAAG;AAAE;AAAA,IAAQ;AACpC,QAAI,SAAS,IAAI,OAAO,GAAG;AACzB,YAAM,QAAQ,CAAC,GAAG,MAAM,QAAQ,IAAI,EAAE,KAAK,UAAK;AAChD,YAAM,IAAI,MAAM,mCAAmC,KAAK,EAAE;AAAA,IAC5D;AACA,aAAS,IAAI,OAAO;AACpB,SAAK,KAAK,QAAQ,IAAI;AAGtB,UAAM,SAAU,QAAgB;AAChC,QAAI,MAAM,QAAQ,MAAM,GAAG;AACzB,iBAAW,SAAS,QAAQ;AAAE,aAAK,KAAK;AAAA,MAAG;AAAA,IAC7C;AAEA,QAAI;AACJ,QAAI;AAAE,iBAAW,IAAI,QAAQ;AAAA,IAAG,SACzB,KAAU;AACf,YAAM,IAAI;AAAA,QACR,gCAAgC,QAAQ,IAAI,2HAGjC,KAAK,WAAW,GAAG;AAAA,MAChC;AAAA,IACF;AACA,UAAM,MAAM,iBAAiB,QAAQ;AACrC,YAAQ,KAAK,EAAE,KAAK,QAAQ,SAAS,CAAC;AACtC,aAAS,KAAK,EAAE,KAAK,MAAM,QAAQ,CAAC;AACpC,YAAQ,IAAI,OAAO;AAEnB,aAAS,OAAO,OAAO;AACvB,SAAK,IAAI;AAAA,EACX;AAIA,QAAM,sBAAsB,QAAQ,MAAM;AAC1C,aAAW,EAAE,OAAO,KAAK,qBAAqB;AAC5C,UAAM,OAAQ,OAAO,YAAoB;AACzC,QAAI,CAAC,MAAM,QAAQ,IAAI,GAAG;AAAE;AAAA,IAAU;AACtC,eAAW,WAAW,MAAM;AAAE,WAAK,OAAO;AAAA,IAAG;AAAA,EAC/C;AAEA,SAAO,EAAE,SAAS,SAAS;AAC7B;AAUO,SAAS,0BACd,MACA,QACM;AACN,MAAI,WAAW,MAAM;AAAE;AAAA,EAAQ;AAC/B,QAAM,QAAQ,KAAK;AACnB,aAAW,QAAQ,uBAAuB;AACxC,UAAM,EAAE,QAAQ,MAAM,IAAI,OAAO,MAAM,IAAI;AAC3C,QAAI,OAAO,WAAW,KAAK,MAAM,WAAW,GAAG;AAAE;AAAA,IAAU;AAE3D,UAAM,WAAW,MAAM,IAAI;AAC3B,UAAM,IAAI,IAAI,kBAET,MACH;AAGA,YAAM,SAAS,CAAC,MACb,EAAE,WAAW,cAAc,IAAI,KAAK,aAAc,CAAC,IAAI,KAAK,QAAS,CAAC;AACzE,iBAAW,KAAK,QAAQ;AACtB,cAAM,IAAI,OAAO,CAAC;AAClB,cAAO,EAAE,IAAI,EAAe,KAAK,GAAG,GAAG,IAAI;AAAA,MAC7C;AACA,UAAI;AACJ,UAAI,UAAU;AAAE,iBAAS,MAAM,SAAS,MAAM,MAAM,IAAI;AAAA,MAAG;AAC3D,iBAAW,KAAK,OAAO;AACrB,cAAM,IAAI,OAAO,CAAC;AAClB,cAAO,EAAE,IAAI,EAAe,KAAK,GAAG,GAAG,IAAI;AAAA,MAC7C;AACA,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAmBO,SAAS,iBAAiB,MAA4B;AAC3D,QAAM,UAAU,KAAK;AACrB,QAAM,SAAS,uBAAuB,KAAK,aAAa,OAAO;AAE/D,sBAAoB,MAAM,OAAO;AAEjC,MAAI,UAAU,OAAO,SAAS,SAAS,GAAG;AACxC,SAAK,eAAe,oBAAoB,MAAM,MAAM;AAAA,EACtD;AAEA,MAAI,UAAU,OAAO,cAAc,OAAO,GAAG;AAC3C,wBAAoB,MAAM,MAAM;AAAA,EAClC;AAEA,SAAO,OAAO,OAAO;AACrB,MAAI,KAAK,cAAc;AAAE,WAAO,OAAO,KAAK,YAAY;AAAA,EAAG;AAC7D;AAOA,SAAS,uBACP,MACA,SACiC;AACjC,MAAI,OAAO,UAAU,eAAe,KAAK,MAAM,gBAAgB,GAAG;AAChE,WAAO,KAAK;AAAA,EACd;AACA,QAAM,SAAS,oBAAoB,OAAO;AAC1C,4BAA0B,MAAM,MAAM;AACtC,OAAK,iBAAiB;AACtB,SAAO;AACT;AAGA,SAAS,oBACP,MACA,SACM;AACN,aAAW,UAAU,OAAO,OAAO,OAAO,GAAG;AAC3C,IAAC,OAAe,OAAO;AAAA,EACzB;AACF;AAOA,SAAS,oBACP,MACA,QAC4B;AAC5B,QAAM,OAAmC,CAAC;AAC1C,aAAW,EAAE,KAAK,MAAM,QAAQ,KAAK,OAAO,UAAU;AACpD,UAAM,WAAW,IAAI,QAAQ;AAC7B,IAAC,SAAiB,OAAO;AACzB,SAAK,GAAG,IAAI;AAAA,EACd;AACA,SAAO;AACT;AAMA,SAAS,oBACP,MACA,QACM;AACN,QAAM,UAAU,KAAK;AACrB,aAAW,CAAC,YAAY,SAAS,KAAK,OAAO,eAAe;AAC1D,QAAI,KAAK,WAAW,UAAU,GAAG;AAAE;AAAA,IAAU;AAC7C,UAAM,SAAS,UAAU,WAAW,cAAc,IAC9C,KAAK,aAAc,SAAS,IAC5B,QAAQ,SAAS;AACrB,UAAM,UAAU,OAAO,UAAU,IAAI,UAAU;AAC/C,QAAI,YAAY,QAAW;AACzB,OAAC,KAAK,aAAa,CAAC,GAAU,UAAU,IAAI;AAAA,IAC9C;AAAA,EACF;AACF;",
+  "names": []
+}

package/build/RoomPlugin.d.ts

@@ -0,0 +1,271 @@
+/**
+ * Room plugins.
+ *
+ * A plugin is a composable extension to a Room — it can declare message
+ * handlers, attach lifecycle hooks, and expose public methods that the
+ * room can call (`this.plugins.<key>.someMethod()`). The framework
+ * instantiates one plugin per room, sets `this.room` after the room is
+ * constructed, then merges the plugin's `messages` with the room's own
+ * and wires its lifecycle hooks alongside the room's.
+ *
+ * Example: a tiny chat plugin contributing a single message handler:
+ *
+ *   class ChatPlugin extends RoomPlugin {
+ *     private history: string[] = [];
+ *     constructor(private opts: { historyLimit: number }) { super(); }
+ *
+ *     messages = {
+ *       chat: (client: Client, msg: { text: string }) => {
+ *         this.history.push(msg.text);
+ *         if (this.history.length > this.opts.historyLimit) this.history.shift();
+ *         this.room.broadcast('chat', { from: client.userId, text: msg.text });
+ *       },
+ *     };
+ *
+ *     // Public — callable as `this.plugins.chat.getHistory()` from the room
+ *     getHistory(): readonly string[] { return this.history; }
+ *   }
+ *
+ * Use via `definePlugins`:
+ *
+ *   class MyRoom extends Room<{ state: MyState }> {
+ *     plugins = definePlugins({
+ *       chat: new ChatPlugin({ historyLimit: 100 }),
+ *     });
+ *   }
+ */
+import type { Room } from './Room.ts';
+import type { AuthContext, Client } from './Transport.ts';
+import type { Messages } from '@colyseus/shared-types';
+/**
+ * Ordering hint for a plugin's lifecycle hook relative to the room's own
+ * hook. Sensible per-hook defaults are applied when omitted (see
+ * `Room.__init` for the exact ordering policy).
+ *
+ *   onCreate  / onAuth / onJoin  → plugins run BEFORE room (guards + setup)
+ *   onLeave   / onDispose        → plugins run AFTER room (capture final state)
+ */
+export interface RoomPluginOrder {
+    onCreate?: 'before' | 'after';
+    onAuth?: 'before' | 'after';
+    onJoin?: 'before' | 'after';
+    onLeave?: 'before' | 'after';
+    onDispose?: 'before' | 'after';
+}
+/**
+ * Base class for room plugins. Subclass to define a plugin; the framework
+ * sets `this.room` after the host room is fully constructed.
+ *
+ * Don't access `this.room` from the plugin's constructor — it hasn't been
+ * wired yet. Everything room-dependent goes in `onCreate` / `onJoin` /
+ * etc. or in public methods that are called from the room post-init.
+ *
+ * @typeParam This - The Room subclass this plugin is attached to. Narrow
+ *   for schema-driven plugins that need a specific state shape, e.g.
+ *   `class PhysicsPlugin extends RoomPlugin<Room<{ state: PhysicsContract }>>`.
+ */
+export declare abstract class RoomPlugin<This extends Room = Room> {
+    /**
+     * Live room reference. Wired by the framework at __init, AFTER the
+     * room's own construction — accessing it from the plugin's
+     * constructor throws.
+     */
+    protected readonly room: This;
+    /**
+     * Canonical key for the plugin when registered via `definePlugins([...])`.
+     * Declared on the subclass with `as const` so the literal type flows
+     * into `room.plugins.<key>`:
+     *
+     *   class ChatPlugin extends RoomPlugin {
+     *     readonly pluginName = 'chat' as const;
+     *   }
+     *
+     * Optional under the keyed-record form (`definePlugins({ chat: ... })`),
+     * required under the array form. Must stay `public` so `extends` /
+     * `keyof` can see the literal — those are blind to protected from
+     * outside the class. End-user autocomplete hides it via `Omit` in
+     * `definePlugins`'s return type.
+     *
+     * For multi-instance use, accept the name at construction:
+     *
+     *   readonly pluginName: string;
+     *   constructor(name = 'chat') { super(); this.pluginName = name; }
+     */
+    readonly pluginName?: string;
+    /**
+     * Declarative message handlers — merged into the room's `messages` at
+     * __init. Conflict against the room's own key: room wins. Conflict
+     * between two plugins: throws at __init.
+     */
+    protected messages?: Messages<This>;
+    /** Optional per-hook ordering vs the room's own hook. */
+    protected order?: RoomPluginOrder;
+    protected onCreate?(options: any): void | Promise<void>;
+    protected onAuth?(client: Client, options: any, context: AuthContext): void | Promise<void>;
+    protected onJoin?(client: Client, options?: any): void | Promise<void>;
+    protected onLeave?(client: Client, code?: number): void | Promise<void>;
+    protected onDispose?(): void | Promise<void>;
+}
+/**
+ * Plugin-class constructor type used by the `dependencies` static
+ * declaration. Constrained to zero-arg constructors because the
+ * framework auto-instantiates missing dependencies with no
+ * configuration — plugins that need options can't be auto-included
+ * and must be registered explicitly in `definePlugins({...})`.
+ */
+export type RoomPluginClass = new () => RoomPlugin<any>;
+/**
+ * Static `dependencies` declaration. List other plugin classes this
+ * plugin needs alongside it; the framework auto-instantiates any
+ * missing ones at room construction time. Transitive deps are
+ * resolved recursively. Cycles throw at class-init.
+ *
+ * Example:
+ *   class UniqueSessionPlugin extends RoomPlugin {
+ *     static dependencies: PluginDependencies = [TrackUserSessionsPlugin];
+ *   }
+ */
+export type PluginDependencies = ReadonlyArray<RoomPluginClass>;
+/**
+ * Define a Room's plugin record. The framework wires plugins at
+ * `__init` — first construct of the class computes the layout
+ * (cached on the constructor) and installs hook wrappers on the
+ * prototype. The `const T` modifier preserves literal types so
+ * `this.plugins.<key>.method()` autocompletes against each plugin's
+ * specific subclass.
+ */
+type ExtractPluginName<P> = P extends {
+    pluginName: infer K;
+} ? (K extends string ? K : never) : never;
+/** Hide `pluginName` from end-user autocomplete on `this.plugins.<key>`. */
+type PluginPublicSurface<P> = Omit<P, 'pluginName'>;
+type PluginsArrayToRecord<T extends readonly RoomPlugin<any>[]> = {
+    [P in T[number] as ExtractPluginName<P>]: PluginPublicSurface<P>;
+};
+/**
+ * Array form (recommended). Each plugin declares its own canonical
+ * key via `readonly pluginName = '...' as const`; the framework
+ * turns the array into a typed record so `plugins.<pluginName>`
+ * autocompletes the right instance type.
+ *
+ *   class GameRoom extends Room {
+ *     plugins = definePlugins([
+ *       new ChatPlugin(),                    // pluginName: 'chat'
+ *       new UniqueSessionPlugin({ max: 1 }), // pluginName: 'uniqueSession'
+ *     ]);
+ *   }
+ *   this.plugins.chat.send('hi');
+ *
+ * Throws at runtime if any plugin is missing `pluginName` or if two
+ * plugins resolve to the same key.
+ */
+export declare function definePlugins<const T extends readonly RoomPlugin<any>[]>(plugins: T): PluginsArrayToRecord<T>;
+/**
+ * Record form (legacy / multi-instance escape hatch). The caller
+ * chooses the key per-room. Useful when registering two instances of
+ * the same plugin class without configuring `pluginName` per
+ * instance — e.g. `{ adminChat: new ChatPlugin(), playerChat: new ChatPlugin() }`.
+ */
+export declare function definePlugins<const T extends Record<string, RoomPlugin<any>>>(plugins: T): {
+    [K in keyof T]: PluginPublicSurface<T[K]>;
+};
+/**
+ * Lifecycle hook keys recognized by the framework — used internally to
+ * separate "framework-recognized methods" from "user-defined public
+ * methods" when wiring a plugin into a room. Exported for the test
+ * harness; downstream code should not need it.
+ */
+export declare const PLUGIN_LIFECYCLE_KEYS: readonly ["onCreate", "onAuth", "onJoin", "onLeave", "onDispose"];
+export type PluginLifecycleKey = (typeof PLUGIN_LIFECYCLE_KEYS)[number];
+/**
+ * Test helper — attach a stub or fake room to a plugin so its methods
+ * and lifecycle hooks can be exercised in isolation without spinning up
+ * a real Colyseus server.
+ *
+ *   const plugin = new ChatPlugin({ historyLimit: 5 });
+ *   const room = attachToTestRoom(plugin, { broadcast: sinon.spy() });
+ *   await plugin.messages!.chat!.call(plugin, { userId: 'u1' }, { text: 'hi' });
+ *
+ * The second arg is shallow-merged onto the stub so tests only declare
+ * the room properties they actually exercise. Returns the room stub for
+ * post-call assertions.
+ */
+export declare function attachToTestRoom<This extends Room, R extends Partial<This>>(plugin: RoomPlugin<This>, roomStub?: R): R;
+/**
+ * Precomputed plugin layout for a Room subclass — populated on first
+ * construct, cached on the constructor. Hook wrappers are installed
+ * on the prototype in the same pass (see `installPluginHookWrappers`).
+ *
+ * @internal
+ */
+export interface PluginLayout {
+    /** Per-hook participation: which plugin keys run before/after the room's own hook. */
+    hooks: Record<PluginLifecycleKey, {
+        before: string[];
+        after: string[];
+    }>;
+    /** Message key → plugin key. Conflict detection ran when this was built. */
+    messageOwners: Map<string, string>;
+    /** Sentinel-keyed plugin classes to instantiate per room. */
+    autoDeps: Array<{
+        key: string;
+        ctor: RoomPluginClass;
+    }>;
+}
+/**
+ * Default before/after policy for lifecycle hooks vs the room's own
+ * hook. Plugins can override per-hook via the `order` field on the
+ * plugin instance.
+ *
+ *   onCreate / onAuth / onJoin → plugins run BEFORE room (guards + setup)
+ *   onLeave  / onDispose       → plugins run AFTER room (capture final state)
+ *
+ * @internal
+ */
+export declare const DEFAULT_PLUGIN_ORDER: Record<PluginLifecycleKey, 'before' | 'after'>;
+/**
+ * Walk the room's plugin instances and produce the lifecycle + message
+ * layout for the Room class. Called once per Room subclass — on the
+ * first construct — and the result is cached on the constructor. Throws
+ * on duplicate message keys (named both plugin keys) so the failure is
+ * visible at class-init rather than at first message dispatch.
+ *
+ * Returns `null` when no plugins participate in any hook AND none
+ * declare a message — distinguishes "computed, nothing to do" from
+ * "not computed yet" in the `__pluginLayout` cache.
+ *
+ * @internal
+ */
+export declare function computePluginLayout(plugins: Record<string, RoomPlugin>): PluginLayout | null;
+/**
+ * Install one wrapper per participating hook on the Room subclass's
+ * prototype. The wrapper closes over plugin KEYS (resolved to refs at
+ * call time) and invokes the captured original room hook between the
+ * before/after plugin runs.
+ *
+ * @internal
+ */
+export declare function installPluginHookWrappers(ctor: {
+    prototype: any;
+}, layout: PluginLayout | null): void;
+/** Structural shape used by `setupRoomPlugins` — avoids a Room import
+ *  so the dependency graph stays one-way (Room → RoomPlugin). */
+interface RoomPluginHost {
+    plugins?: Record<string, RoomPlugin<any>>;
+    _autoPlugins?: Record<string, RoomPlugin<any>>;
+    messages?: Record<string, Function> | any;
+    constructor: {
+        __pluginLayout?: PluginLayout | null;
+        prototype: any;
+    };
+}
+/**
+ * Wire a Room instance's plugins. Once-per-class layout (hook
+ * participation, message owners, dep resolution) is cached on the
+ * constructor; per-instance work attaches `room` refs, instantiates
+ * auto-deps, and merges plugin messages.
+ *
+ * @internal
+ */
+export declare function setupRoomPlugins(room: RoomPluginHost): void;
+export {};