Class PackService

Index

Constructors

Methods

createUserPack deleteUserPack enabledPacks getPack installedPackNames isVisible listPacks setEnabled

Constructors

constructor

new PackService(
    userPaths: UserPathsService,
    userConfig: UserConfigService,
    registeredToolNames: () => readonly string[],
): PackService
Parameters
- userPaths: UserPathsService
- userConfig: UserConfigService
- registeredToolNames: () => readonly string[]
  Native tool names the process has registered, for the missing-tool warning.
Returns PackService
- Defined in server/src/packs/pack.service.ts:51

Methods

createUserPack

createUserPack(packName: string, title?: string): PackView
Creates an empty pack owned by this user, and enables it.

Enabling is part of creating because a pack the user just made and cannot see is a bug report. Tool code is never part of this: a user pack can grant tools the host has registered, but only the host installs the code.
Parameters
- packName: string
  The new pack's name
- Optionaltitle: string
  Optional display name
Returns PackView
The created pack

Throws
If the name is not a legal pack name

Throws
If a pack of that name already exists
- Defined in server/src/packs/pack.service.ts:131

deleteUserPack

deleteUserPack(packName: string): void
Deletes a pack this user owns.

Only ever their own directory. Agents and rooms already created from the pack are untouched and stay visible — they carry the pack's name, and a name with no pack behind it is treated as visible rather than hidden, so deleting a pack never makes a user's own work disappear.
Parameters
- packName: string
  The pack to delete
Returns void

Throws
If no such pack is installed

Throws
If the pack was installed by the host
- Defined in server/src/packs/pack.service.ts:167

enabledPacks

enabledPacks(): readonly string[]
The packs this user has enabled, as a thunk-friendly snapshot.

Filtered to packs that are actually installed, so a name left behind by a pack the host removed does not make the resolver stat a directory that will never exist. The name stays in the config, so reinstalling brings it back.

Returns readonly string[]
Enabled pack names, sorted
- Defined in server/src/packs/pack.service.ts:67

getPack

getPack(packName: string): PackView
Reads one pack.
Parameters
- packName: string
  The pack name
Returns PackView
The pack

Throws
If no such pack is installed
- Defined in server/src/packs/pack.service.ts:99

installedPackNames

installedPackNames(): string[]
Every pack name on disk, host and user, deduped.

Returns string[]
- Defined in server/src/packs/pack.service.ts:73

isVisible

isVisible(packName?: string): boolean
Whether something stamped with this pack name should be listed.

An item with no pack is always visible, and so is one naming a pack that is not installed — otherwise deleting a pack would hide the user's own agents and rooms rather than just the templates they came from.
Parameters
- OptionalpackName: string
  The pack stamped on the item, if any
Returns boolean
True when the item should appear in a listing
- Defined in server/src/packs/pack.service.ts:188

listPacks

listPacks(): PackView[]
Lists every installed pack with this user's view of it.

Returns PackView[]
The packs, sorted by title
- Defined in server/src/packs/pack.service.ts:85

setEnabled

setEnabled(packName: string, enabled: boolean): void
Turns a pack on or off for this user.
Parameters
- packName: string
  The pack to change
- enabled: boolean
  Whether it should be on
Returns void

Throws
If no such pack is installed
- Defined in server/src/packs/pack.service.ts:113