@mudlet/mudlet-web 0.4.4 → 0.5.0

package/dist-lib/map/MapStore.d.ts

@@ -1,4 +1,4 @@
-import type { MudletArea, MudletFont, MudletMap, MudletMapHeader, MudletRoom } from 'mudlet-map-binary-reader';
+import type { MudletArea, MudletColor, MudletFont, MudletLabel, MudletMap, MudletMapHeader, MudletRoom } from 'mudlet-map-binary-reader';
 import { readerExport } from 'mudlet-map-binary-reader';
 import { type ExitWeightFilter, type PathfindResult } from './pathfinding';
 export type { ExitWeightFilter, PathfindResult } from './pathfinding';
@@ -28,6 +28,48 @@ export declare function makeRoom(areaId: number): MudletRoom;
  */
 export declare function mudletJsonMapToMudletMap(src: unknown): MudletMap | null;
 export declare function makeArea(): MudletArea;
+/**
+ * A map label as mudix stores it: the binary-map reader's shape plus the fields
+ * Mudlet's `TMapLabel` carries that its map file never persists — the font, the
+ * outline colour and the `temporary` flag. All optional, so labels read back
+ * from a binary map (which have none of them) stay valid without conversion.
+ */
+export interface MapLabel extends MudletLabel {
+    fontName?: string;
+    fontSize?: number;
+    temporary?: boolean;
+    outlineColor?: MudletColor;
+}
+/**
+ * The optional tail of Mudlet's `createMapLabel` — everything after the two
+ * colours. Defaults here are Mudlet's own (TLuaInterpreter::createMapLabel),
+ * not zero values: omitting them has to produce the label Mudlet would.
+ */
+export interface MapLabelOptions {
+    /** Map units per rendered pixel; divides the measured text box. Default 30. */
+    zoom?: number;
+    /** Point size the text is measured at. Default 50. */
+    fontSize?: number;
+    /** Paint above rooms rather than below them. Default true. */
+    showOnTop?: boolean;
+    /** Keep a fixed on-screen size instead of scaling with the map. Default true. */
+    noScaling?: boolean;
+    /** Font family; empty/absent means the default face. */
+    fontName?: string;
+    /** Foreground (and outline) alpha, 0-255. Default 255. */
+    fgAlpha?: number;
+    /** Background alpha, 0-255. Default 50 — Mudlet's labels are mostly see-through. */
+    bgAlpha?: number;
+    /** Excluded from the map save. Default false. */
+    temporary?: boolean;
+    /** Text outline colour. Defaults to the foreground colour, which is Mudlet's
+     *  way of saying "no outline" — it only draws one when the two differ. */
+    outline?: {
+        r: number;
+        g: number;
+        b: number;
+    };
+}
 export interface MapLabelInfo {
     X: number;
     Y: number;
@@ -824,13 +866,17 @@ export declare class MapStore {
     /**
      * Mudlet `createMapLabel(areaID, text, posx, posy, posz, fgRed, fgGreen,
      * fgBlue, bgRed, bgGreen, bgBlue [, zoom [, fontSize [, showOnTop [,
-     * noScaling]]]])`. Adds a text label to the area and returns its new id, or
-     * -1 if the area does not exist. (`zoom`/`fontSize` are accepted for
-     * signature parity — mudix stores labels but the renderer does not yet draw
-     * them, mirroring how labels loaded from binary maps are kept and queried
-     * but not painted.)
+     * noScaling [, fontName [, foregroundTransparency [, backgroundTransparency
+     * [, temporary [, outlineRed, outlineGreen, outlineBlue]]]]]]]]])`. Adds a
+     * text label to the area and returns its new id, or -1 if the area does not
+     * exist or the text is empty (both are Mudlet's own refusals).
+     *
+     * `fontName`, `temporary` and the outline colour have nowhere to live in the
+     * binary map format, so they are mudix-only fields on the stored label (see
+     * `MapLabel`); of the three only `temporary` is visible from Lua, because
+     * Mudlet's getMapLabel doesn't publish the other two either.
      */
-    createMapLabel(areaId: number, text: string, x: number, y: number, z: number, fgR: number, fgG: number, fgB: number, bgR: number, bgG: number, bgB: number, fontSize?: number, showOnTop?: boolean, noScaling?: boolean): number;
+    createMapLabel(areaId: number, text: string, x: number, y: number, z: number, fgR: number, fgG: number, fgB: number, bgR: number, bgG: number, bgB: number, opts?: MapLabelOptions): number;
     /**
      * Mudlet `createMapImageLabel(areaID, imagePathFileName, posx, posy, posz,
      * width, height, zoom [, showOnTop [, noScaling]])`. Adds an image label and

package/dist-lib/scripting/EngineHost.d.ts

@@ -85,6 +85,15 @@ export interface EngineHost {
     syncModuleToFile(name: string): Promise<void>;
     /** Write every module flagged to sync back out to its own file. */
     saveSyncedModules(): void;
+    /** Write the profile out as a Mudlet-format XML save, answering with the
+     *  full path written. The XML half of `saveProfile([location [, saveName]])`. */
+    saveProfileXml(location?: string, saveName?: string): {
+        ok: true;
+        path: string;
+    } | {
+        ok: false;
+        err: string;
+    };
     reloadModuleFromFile(name: string): boolean;
     setModuleSync(name: string, sync: boolean): void;
     getModuleSync(name: string): boolean;

package/dist-lib/scripting/ScriptingAPI.d.ts

@@ -425,6 +425,15 @@ export declare class ScriptingAPI {
     /** Write every module flagged to sync back out to its own file. Called by
      *  saveProfile — see the note there. */
     saveSyncedModules(): void;
+    /** Write the profile out as a Mudlet-format XML save. The XML half of
+     *  `saveProfile([location [, saveName]])` — see ScriptingEngine. */
+    saveProfileXml(location?: string, saveName?: string): {
+        ok: true;
+        path: string;
+    } | {
+        ok: false;
+        err: string;
+    };
     reloadModule(name: string): boolean;
     enableModuleSync(name: string): void;
     disableModuleSync(name: string): void;

package/dist-lib/scripting/ScriptingEngine.d.ts

@@ -147,6 +147,35 @@ export declare class ScriptingEngine implements EngineHost {
      * now that the folder backend truncates). Mudlet loads the newest such file.
      */
     private writeBackLinkedProfile;
+    /**
+     * The profile as a Mudlet-format `<MudletPackage>` save: `baseXml` with its
+     * automation and variable packages replaced by the live store state, and its
+     * `<Host>` settings updated in place.
+     *
+     * Basing on an existing save is what keeps the ~130 `<Host>` fields mudix
+     * doesn't model — and any element it doesn't understand — from being dropped
+     * on the way out. A profile with no save to base on gets the empty skeleton
+     * below, so its `<Host>` carries only the settings mudix does model.
+     */
+    private buildProfileXml;
+    /**
+     * The XML half of Mudlet `saveProfile([location [, saveName]])`: write this
+     * profile out as a Mudlet-format save and answer with the full path written.
+     *
+     * Mirrors `Host::saveProfile`'s naming — an empty location means the
+     * profile's own `current/`, an empty name means a `YYYY-MM-DD#HH-mm-ss`
+     * stamp, and a name without one gains `.xml`. A default-located save also
+     * takes over as this session's write-back target, so the automatic flushes
+     * keep updating the newest file rather than leaving a stale older one as the
+     * save Mudlet would load.
+     */
+    saveProfileXml(location?: string, saveName?: string): {
+        ok: true;
+        path: string;
+    } | {
+        ok: false;
+        err: string;
+    };
     /** `_G` entries for the Variables view (user globals nested, built-ins
      *  flagged). Empty until the runtime is up. */
     listGlobals(): LuaGlobalEntry[];

package/dist-lib/storage/schema.d.ts

@@ -27,10 +27,15 @@ export interface MudConnection {
      *  the connection record so the editor can read/write it without mounting the
      *  profile. */
     charLoginAccount?: string;
-    /** GMCP `Char.Login` password. ⚠ SECURITY: persisted in **plaintext** in
-     *  localStorage (the app store is not encrypted) — only ever written when the
-     *  user explicitly opts in. Convenient for auto-login but not secure on a
-     *  shared machine. Never logged; relayed straight to the server on login. */
+    /** @deprecated The pre-vault plaintext password field. Nothing writes it any
+     *  more: passwords now live encrypted in the credential vault
+     *  (`vault/CredentialVault`), because this one sat in localStorage in the
+     *  clear and the UI offering it had to warn against itself (issue #25).
+     *
+     *  Still *read* (see `utils/storedCredentials`) so an existing saved login
+     *  keeps working, and folded into the vault — then deleted from here — the
+     *  first time the user sets one up. Remove the field once enough releases
+     *  have passed for that migration to have run everywhere. */
     charLoginPassword?: string;
     /** Set when this profile was created by linking a Mudlet folder (Link mode):
      *  the folder is the source of truth — its `current/*.xml` is re-read on every