@mudlet/mudlet-web 0.5.0 → 1.0.1

package/dist-lib/import/defaultPackages.d.ts

@@ -9,19 +9,39 @@ interface DefaultPackage {
     /** When set, an installed copy with a different manifest version is
      *  reinstalled fresh — how brands ship package updates to players. */
     version?: string;
+    /** For a loader that fetches a game's interface and then uninstalls itself:
+     *  that interface's package name. A profile that already has it is skipped,
+     *  so backfilling the loader into an existing profile can't re-download and
+     *  reinstall an interface the player set up by hand. */
+    replacedBy?: string;
 }
+/** The loader Mudlet preinstalls for the game at `host`, if it has one. */
+export declare function gameLoader(host: string | undefined): DefaultPackage | undefined;
 /**
  * Games that get the IRE mapper instead of the generic one — verbatim from the
  * `mudlet-mapper.xml` row of `defaultScripts` in mudlet.cpp.
  */
 export declare const IRE_MAPPER_GAMES: string[];
 /**
- * Games whose own bundled loader installs a full interface, so the starter UI is
- * not preinstalled for them — it would only fight the game's GUI for the same
- * screen space. Mirrors the `providesOwnUi` entries of `TGameDetails.h`'s
- * `scmDefaultGames`, including each game's `alternateHostUrls`.
+ * Games whose new profiles start with "fix unnecessary linebreaks" on — verbatim
+ * from `Host::setupIreDriverBugfix`. The IRE mapper's list minus stickmud.com:
+ * IRE servers start every reply after a GA prompt with a stray newline, and other
+ * GA games (StickMUD included) don't.
  */
-export declare const GAMES_WITH_OWN_UI: string[];
+export declare const IRE_DRIVER_BUGFIX_GAMES: string[];
+/**
+ * Turn `fixUnnecessaryLinebreaks` on for a profile just created for an IRE game —
+ * Mudlet's `Host::setupIreDriverBugfix`, which `loadProfile` calls alongside
+ * `setupPreInstallPackages` when it sets up a brand-new profile.
+ *
+ * Called once, where a profile is created (the connection form, the game list,
+ * a brand's managed profile) — not on every open, so a player who turns the fix
+ * off keeps it off, and an existing profile is never changed under them. Like
+ * desktop it only ever turns the fix on, and it leaves an explicit value alone (a
+ * brand's `profileDefaults` may set one). Imported and linked Mudlet profiles
+ * bring their own setting and are skipped, as they are for the packages.
+ */
+export declare function setupIreDriverBugfix(connectionId: string): void;
 /** Every bundled default, whatever the host — for tests and tooling. */
 export declare const ALL_DEFAULTS: DefaultPackage[];
 /**
@@ -35,27 +55,42 @@ export declare const ALL_DEFAULTS: DefaultPackage[];
  *
  * Exactly one mapper, always. `centerview()` is the only thing that moves the
  * map view and only a mapper calls it, so a profile with no mapper never follows
- * the player — and two mappers would both fire on the same movement.
+ * the player — and two mappers would both fire on the same movement. That holds
+ * for the loader games too: Mudlet gives them generic_mapper like everyone else,
+ * and the Icesus and MorgenGrauen packages their loaders fetch uninstall it
+ * themselves, since each brings a mapper of its own.
+ *
+ * A game with a bundled loader gets it ({@link gameLoader}), as Mudlet does.
  *
  * The starter UI is the one host-conditional pick: Mudlet skips it for players
  * who aren't new (`experiencedMudletPlayer()` — any profile folder older than
  * six months) because "veterans will have their own layouts already", and for
- * games whose own loader installs a full interface. mudix has no profile-age
- * signal to mirror the first, so `createdAt` stands in for it — see
- * {@link isNewProfile}.
+ * games that install a full interface of their own — it would only fight that
+ * interface for the same screen space. Mudlet Web has no profile-age signal to
+ * mirror the first, so `createdAt` stands in for it — see {@link isNewProfile}.
+ * The second reads the game catalogue's `ownUi` the way `setupPreInstallPackages`
+ * does: a game with a bundled loader always brings its interface, while one that
+ * sends it by Client.GUI only does when the profile lets that in
+ * (`serverGuiAccepted` — the profile's `allowMudPackageInstall`).
  *
  * mpkg is the one *build*-conditional pick, and for the reason Mudlet has:
  * see {@link TEST_BUILD}.
  */
 export declare function stockDefaults(host?: string, conn?: {
     createdAt?: string;
-}): DefaultPackage[];
+}, serverGuiAccepted?: boolean): DefaultPackage[];
+/**
+ * Whether the game at `host` will install a full interface of its own — Mudlet's
+ * `ownUiArrives` in `setupPreInstallPackages`. A bundled loader always does; a
+ * Client.GUI package only arrives if the profile accepts one.
+ */
+export declare function ownUiArrives(host: string | undefined, serverGuiAccepted: boolean): boolean;
 /**
  * Whether a profile is new enough to be offered the starter UI.
  *
  * `addConnection` stamps `createdAt` on every profile it creates, so a profile
  * without one was made before the field existed — i.e. someone has already been
- * using it, quite possibly with a layout of their own. That's mudix's stand-in
+ * using it, quite possibly with a layout of their own. That's Mudlet Web's stand-in
  * for Mudlet's "no profile folder older than six months" check: it errs the safe
  * way, since dropping a dock, gauges and a chat window onto an established
  * profile is far more disruptive than withholding them from a new one.
@@ -70,16 +105,24 @@ export declare function isNewProfile(conn?: {
 export type InstallablePackage = DefaultPackage & {
     removable?: boolean;
 };
+/** Whether the user may uninstall the named package. Only brand packages
+ *  marked `removable: false` are locked; everything else — stock defaults
+ *  included — is removable. A brand `packages` function is handed every bundled
+ *  default, not one game's pick, so a stock package it locks is caught
+ *  whichever host the profile is on. */
+export declare function isPackageRemovable(name: string): boolean;
 /**
  * The packages to preinstall into a profile.
  *
  * A brand's list is exact and replaces the stock defaults rather than adding to
  * them — `[]` preinstalls nothing, and a brand shipping its own mapper simply
- * doesn't list ours. Unset means no opinion: the stock defaults for this game.
+ * doesn't list ours. A brand function is handed this game's stock defaults and
+ * returns the exact list. Unset means no opinion: the stock defaults for this
+ * game.
  */
-export declare function resolveDefaultPackages(brandPackages: InstallablePackage[] | undefined, host?: string, conn?: {
+export declare function resolveDefaultPackages(brandPackages: InstallablePackage[] | ((stock: InstallablePackage[]) => InstallablePackage[]) | undefined, host?: string, conn?: {
     createdAt?: string;
-}): InstallablePackage[];
+}, serverGuiAccepted?: boolean): InstallablePackage[];
 /** Hostname `stockDefaults` matches its game lists against, lowercased. */
 export declare function connectionHost(conn: {
     mode?: string;