@sharpee/world-model 0.9.60-beta

package/dist/entities/entity-types.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityType = void 0;
+exports.isEntityType = isEntityType;
+exports.getEntityTypePrefix = getEntityTypePrefix;
+/**
+ * Standard Interactive Fiction entity types
+ *
+ * These represent the fundamental object types in IF games.
+ * The values match the type strings used throughout the system.
+ */
+exports.EntityType = {
+    /** A location in the game world */
+    ROOM: 'room',
+    /** A doorway or portal between rooms */
+    DOOR: 'door',
+    /** A generic takeable object */
+    ITEM: 'item',
+    /** A character (NPC or player) */
+    ACTOR: 'actor',
+    /** An object that can contain other objects */
+    CONTAINER: 'container',
+    /** An object that can support other objects on top */
+    SUPPORTER: 'supporter',
+    /** Fixed decorative objects that can't be taken */
+    SCENERY: 'scenery',
+    /** A directional exit (rarely used as entity) */
+    EXIT: 'exit',
+    /** Generic object type (default) */
+    OBJECT: 'object'
+};
+/**
+ * Type guard to check if a string is a valid IF entity type
+ */
+function isEntityType(type) {
+    return Object.values(exports.EntityType).includes(type);
+}
+/**
+ * Get the ID prefix for an entity type
+ * Used for generating consistent entity IDs
+ */
+function getEntityTypePrefix(type) {
+    const prefixMap = {
+        [exports.EntityType.ROOM]: 'r',
+        [exports.EntityType.DOOR]: 'd',
+        [exports.EntityType.ITEM]: 'i',
+        [exports.EntityType.ACTOR]: 'a',
+        [exports.EntityType.CONTAINER]: 'c',
+        [exports.EntityType.SUPPORTER]: 's',
+        [exports.EntityType.SCENERY]: 'y',
+        [exports.EntityType.EXIT]: 'e',
+        [exports.EntityType.OBJECT]: 'o'
+    };
+    return prefixMap[type] || 'o';
+}
+//# sourceMappingURL=entity-types.js.map

package/dist/entities/entity-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-types.js","sourceRoot":"","sources":["../../src/entities/entity-types.ts"],"names":[],"mappings":";;;AA2CA,oCAEC;AAMD,kDAcC;AAjED;;;;;GAKG;AACU,QAAA,UAAU,GAAG;IACxB,mCAAmC;IACnC,IAAI,EAAE,MAAM;IAEZ,wCAAwC;IACxC,IAAI,EAAE,MAAM;IAEZ,gCAAgC;IAChC,IAAI,EAAE,MAAM;IAEZ,kCAAkC;IAClC,KAAK,EAAE,OAAO;IAEd,+CAA+C;IAC/C,SAAS,EAAE,WAAW;IAEtB,sDAAsD;IACtD,SAAS,EAAE,WAAW;IAEtB,mDAAmD;IACnD,OAAO,EAAE,SAAS;IAElB,iDAAiD;IACjD,IAAI,EAAE,MAAM;IAEZ,oCAAoC;IACpC,MAAM,EAAE,QAAQ;CACR,CAAC;AAOX;;GAEG;AACH,SAAgB,YAAY,CAAC,IAAY;IACvC,OAAO,MAAM,CAAC,MAAM,CAAC,kBAAU,CAAC,CAAC,QAAQ,CAAC,IAAkB,CAAC,CAAC;AAChE,CAAC;AAED;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,IAAgB;IAClD,MAAM,SAAS,GAA+B;QAC5C,CAAC,kBAAU,CAAC,IAAI,CAAC,EAAE,GAAG;QACtB,CAAC,kBAAU,CAAC,IAAI,CAAC,EAAE,GAAG;QACtB,CAAC,kBAAU,CAAC,IAAI,CAAC,EAAE,GAAG;QACtB,CAAC,kBAAU,CAAC,KAAK,CAAC,EAAE,GAAG;QACvB,CAAC,kBAAU,CAAC,SAAS,CAAC,EAAE,GAAG;QAC3B,CAAC,kBAAU,CAAC,SAAS,CAAC,EAAE,GAAG;QAC3B,CAAC,kBAAU,CAAC,OAAO,CAAC,EAAE,GAAG;QACzB,CAAC,kBAAU,CAAC,IAAI,CAAC,EAAE,GAAG;QACtB,CAAC,kBAAU,CAAC,MAAM,CAAC,EAAE,GAAG;KACzB,CAAC;IAEF,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC;AAChC,CAAC"}

package/dist/entities/if-entity.d.ts

@@ -0,0 +1,259 @@
+import { IEntity, EntityId, IEntityCreationParams } from '@sharpee/core';
+import { ITrait, ITraitConstructor } from '../traits/trait';
+import { TraitType } from '../traits/trait-types';
+import { IEventHandlers } from '../events/types';
+/**
+ * Interactive Fiction Entity with trait-based composition.
+ * Implements the core Entity interface and adds trait management capabilities.
+ */
+export declare class IFEntity implements IEntity {
+    readonly id: EntityId;
+    readonly type: string;
+    attributes: Record<string, unknown>;
+    relationships: Record<string, EntityId[]>;
+    traits: Map<TraitType, ITrait>;
+    /**
+     * Author-controlled disambiguation priorities per action
+     * Higher priority = more likely to be selected when ambiguous
+     * Key is action ID (e.g., 'if.action.eating')
+     * Value is priority (default 100, higher = preferred)
+     */
+    private scopePriorities;
+    /**
+     * Author-controlled minimum scope levels
+     * Allows entities to be "in scope" regardless of spatial location.
+     * Key is room ID (or '*' for all rooms)
+     * Value is minimum scope level (0=UNAWARE, 1=AWARE, 2=VISIBLE, 3=REACHABLE, 4=CARRIED)
+     *
+     * Example uses:
+     * - sky.setMinimumScope(2) - always visible everywhere
+     * - mountain.setMinimumScope(2, ['overlook']) - visible from specific room
+     * - butterfly.setMinimumScope(3, ['garden']) - reachable in garden
+     */
+    private minimumScopes;
+    /**
+     * Event handlers for this entity
+     * Key is the event type (e.g., 'if.event.pushed')
+     * Value is the handler function
+     */
+    on?: IEventHandlers;
+    constructor(id: string, type: string, params?: Partial<IEntityCreationParams>);
+    /**
+     * Check if entity has a specific trait
+     */
+    has(type: TraitType | string): boolean;
+    /**
+     * Get a typed trait from the entity
+     */
+    get<T extends ITrait>(type: TraitType | string | ITraitConstructor<T>): T | undefined;
+    /**
+     * Alias for get() method - for backwards compatibility
+     */
+    getTrait<T extends ITrait>(type: TraitType | string | ITraitConstructor<T>): T | undefined;
+    /**
+     * Add a trait to the entity
+     */
+    add(trait: ITrait): this;
+    /**
+     * Remove a trait from the entity
+     */
+    remove(type: TraitType | string): boolean;
+    /**
+     * Check if entity has all specified traits
+     */
+    hasAll(...types: (TraitType | string)[]): boolean;
+    /**
+     * Check if entity has any of the specified traits
+     */
+    hasAny(...types: (TraitType | string)[]): boolean;
+    /**
+     * Get all traits on this entity
+     */
+    getTraits(): ITrait[];
+    /**
+     * Get all trait types on this entity
+     */
+    getTraitTypes(): (TraitType | string)[];
+    /**
+     * Clear all traits from the entity
+     */
+    clearTraits(): void;
+    /**
+     * Get or set author-controlled disambiguation priority for an action.
+     *
+     * When multiple entities match a command, higher priority entities are
+     * preferred for automatic disambiguation.
+     *
+     * @param actionId - The action ID (e.g., 'if.action.eating')
+     * @param priority - Optional priority to set (100 = default, higher = preferred)
+     * @returns The current priority for this action (default 100)
+     *
+     * @example
+     * // Make real apple preferred for eating over wax apple
+     * realApple.scope('if.action.eating', 150);
+     * waxApple.scope('if.action.eating', 50);
+     *
+     * @example
+     * // Get current priority
+     * const priority = apple.scope('if.action.eating');  // Returns 150
+     */
+    scope(actionId: string, priority?: number): number;
+    /**
+     * Clear disambiguation priority for an action (resets to default)
+     */
+    clearScope(actionId: string): void;
+    /**
+     * Clear all disambiguation priorities
+     */
+    clearAllScopes(): void;
+    /**
+     * Get all scope priorities for serialization
+     */
+    getScopePriorities(): Record<string, number>;
+    /**
+     * Set minimum scope level for this entity.
+     *
+     * Makes an entity "in scope" regardless of its spatial location.
+     * The scope resolver will return the maximum of the physical scope
+     * and the minimum scope (additive only - can raise scope, not lower it).
+     *
+     * Scope levels (numeric values match ScopeLevel enum in stdlib):
+     * - 0: UNAWARE - not in scope
+     * - 1: AWARE - can hear/smell but not see
+     * - 2: VISIBLE - can see but not reach
+     * - 3: REACHABLE - can physically interact
+     * - 4: CARRIED - in inventory (rarely used for minimum)
+     *
+     * @param level The minimum scope level (0-4)
+     * @param rooms Optional array of room IDs where this applies. If omitted, applies everywhere.
+     *
+     * @example
+     * // Sky is always visible everywhere
+     * sky.setMinimumScope(2);
+     *
+     * // Mountain visible only from overlook and trail
+     * mountain.setMinimumScope(2, ['overlook', 'mountain_trail']);
+     *
+     * // Butterfly reachable (but may escape) in garden areas
+     * butterfly.setMinimumScope(3, ['garden', 'meadow', 'pond']);
+     *
+     * // Ticking clock audible from adjacent rooms
+     * clock.setMinimumScope(1, ['hallway', 'study']);
+     */
+    setMinimumScope(level: number, rooms?: string[]): this;
+    /**
+     * Get the minimum scope level for this entity in a specific room.
+     *
+     * @param roomId The room to check (or null to get global minimum)
+     * @returns The minimum scope level, or 0 (UNAWARE) if not set
+     */
+    getMinimumScope(roomId: string | null): number;
+    /**
+     * Clear minimum scope for specific rooms or all rooms.
+     *
+     * @param rooms Optional array of room IDs to clear. If omitted, clears all.
+     */
+    clearMinimumScope(rooms?: string[]): void;
+    /**
+     * Get all minimum scopes for serialization
+     */
+    getMinimumScopes(): Record<string, number>;
+    /**
+     * Clone this entity with all its traits
+     */
+    clone(newId: string): IFEntity;
+    /**
+     * Serialize entity and traits to JSON
+     */
+    toJSON(): any;
+    /**
+     * Create entity from JSON data
+     */
+    static fromJSON(json: any): IFEntity;
+    /**
+     * Check if this is a room
+     */
+    get isRoom(): boolean;
+    /**
+     * Check if this can contain other entities
+     */
+    get canContain(): boolean;
+    /**
+     * Check if this is takeable (default behavior unless has scenery trait)
+     */
+    get isTakeable(): boolean;
+    /**
+     * Check if this is fixed in place (has scenery trait)
+     */
+    get isScenery(): boolean;
+    /**
+     * Check if this can be opened
+     */
+    get isOpenable(): boolean;
+    /**
+     * Check if this is currently open
+     */
+    get isOpen(): boolean;
+    /**
+     * Check if this can be locked
+     */
+    get isLockable(): boolean;
+    /**
+     * Check if this is currently locked
+     */
+    get isLocked(): boolean;
+    /**
+     * Check if this is a container
+     */
+    get isContainer(): boolean;
+    /**
+     * Check if this is a supporter
+     */
+    get isSupporter(): boolean;
+    /**
+     * Check if this is a door
+     */
+    get isDoor(): boolean;
+    /**
+     * Check if this is an actor
+     */
+    get isActor(): boolean;
+    /**
+     * Check if this is the player
+     */
+    get isPlayer(): boolean;
+    /**
+     * Check if this provides light
+     */
+    get providesLight(): boolean;
+    /**
+     * Check if this is switchable
+     */
+    get isSwitchable(): boolean;
+    /**
+     * Check if this can be entered by actors
+     * Vehicles are inherently enterable (boats, baskets, etc.)
+     */
+    get enterable(): boolean;
+    /**
+     * Check if this is switched on
+     */
+    get isOn(): boolean;
+    /**
+     * Get the name of this entity
+     */
+    get name(): string;
+    /**
+     * Get the description of this entity
+     */
+    get description(): string | undefined;
+    /**
+     * Get the weight of this entity
+     */
+    get weight(): number;
+    /**
+     * Alias for has() method - for backwards compatibility
+     */
+    hasTrait(type: TraitType | string): boolean;
+}
+//# sourceMappingURL=if-entity.d.ts.map

package/dist/entities/if-entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"if-entity.d.ts","sourceRoot":"","sources":["../../src/entities/if-entity.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAW,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD;;;GAGG;AACH,qBAAa,QAAS,YAAW,OAAO;IACtC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC1C,MAAM,EAAE,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAE/B;;;;;OAKG;IACH,OAAO,CAAC,eAAe,CAAkC;IAEzD;;;;;;;;;;OAUG;IACH,OAAO,CAAC,aAAa,CAAkC;IAEvD;;;;OAIG;IACH,EAAE,CAAC,EAAE,cAAc,CAAC;gBAER,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAW7E;;OAEG;IACH,GAAG,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAItC;;OAEG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS;IAMrF;;OAEG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS;IAI1F;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAexB;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;IAIzC;;OAEG;IACH,MAAM,CAAC,GAAG,KAAK,EAAE,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO;IAIjD;;OAEG;IACH,MAAM,CAAC,GAAG,KAAK,EAAE,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,GAAG,OAAO;IAIjD;;OAEG;IACH,SAAS,IAAI,MAAM,EAAE;IAIrB;;OAEG;IACH,aAAa,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE;IAIvC;;OAEG;IACH,WAAW,IAAI,IAAI;IAMnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;IAOlD;;OAEG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIlC;;OAEG;IACH,cAAc,IAAI,IAAI;IAItB;;OAEG;IACH,kBAAkB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAM5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAatD;;;;;OAKG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM;IAa9C;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAUzC;;OAEG;IACH,gBAAgB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAI1C;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ;IAwB9B;;OAEG;IACH,MAAM,IAAI,GAAG;IA0Bb;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,GAAG,QAAQ;IAwDpC;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAGxB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAGpB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAGtB;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAGtB;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,OAAO,CAG3B;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,CAGlB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAmBjB;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAGpC;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO;CAG5C"}