@mudlet/mudlet-web 0.3.0 → 0.4.0

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

@@ -0,0 +1,71 @@
+import { type SerializeInput } from './mudletXmlExport';
+export interface PackageExportMeta {
+    /** Package identity — also the XML filename and the install directory name. */
+    name: string;
+    author?: string;
+    title?: string;
+    description?: string;
+    version?: string;
+    helpURL?: string;
+    dependencies?: string[];
+    /** Icon filename as stored under `.mudlet/Icon/`; empty when there's no icon. */
+    icon?: string;
+    /** ISO-8601 creation stamp. Passed in rather than read from the clock so the
+     *  builders stay pure and testable. */
+    created: string;
+}
+/** Strip characters that are illegal in zip entry / filesystem names. */
+export declare function sanitizePackageName(raw: string, fallback?: string): string;
+/**
+ * Mudlet's `config.lua`: every key is written even when empty, in the order
+ * dlgPackageExporter emits them, with `created` as a plain quoted string.
+ */
+export declare function buildConfigLua(meta: PackageExportMeta): string;
+interface TreeNode {
+    id: string;
+    parentId: string | null;
+    isGroup: boolean;
+}
+/** Every descendant id of `rootId`, excluding the root itself. */
+export declare function descendantIds<T extends TreeNode>(nodes: T[], rootId: string): string[];
+/**
+ * Reduce a category's nodes to the selected ones, re-parenting any node whose
+ * parent wasn't selected to the top level.
+ *
+ * Mudlet drops such a node instead: its exporter walks from the roots and never
+ * reaches a selected child under an unselected group, so checking one trigger
+ * inside a folder exports nothing. Re-rooting keeps the item and makes the
+ * selection mean what it looks like; a fully-checked subtree serializes
+ * identically either way.
+ */
+export declare function selectExportNodes<T extends TreeNode>(nodes: T[], selected: ReadonlySet<string>): T[];
+/** Ids of every category, as the modal tracks them. */
+export interface PackageSelection {
+    scripts: ReadonlySet<string>;
+    aliases: ReadonlySet<string>;
+    triggers: ReadonlySet<string>;
+    timers: ReadonlySet<string>;
+    keys: ReadonlySet<string>;
+    buttons: ReadonlySet<string>;
+}
+/** Apply a selection across all six categories at once. */
+export declare function selectExportInput(all: SerializeInput, selection: PackageSelection): SerializeInput;
+export declare function countSelected(input: SerializeInput): number;
+export interface PackageExportInput {
+    meta: PackageExportMeta;
+    /** Already filtered through `selectExportInput`. */
+    nodes: SerializeInput;
+    /** Extra files to carry, keyed by path relative to the package root. */
+    assets?: Record<string, Uint8Array>;
+    /** Icon bytes; stored at `.mudlet/Icon/<meta.icon>` when `meta.icon` is set. */
+    iconBytes?: Uint8Array;
+}
+/**
+ * Build the package's file map. `config.lua` and `<name>.xml` are written last
+ * and always win: an asset list harvested from an installed package directory
+ * contains the *previous* pair, and letting those through would ship stale
+ * metadata alongside the freshly serialized items.
+ */
+export declare function buildPackageEntries(input: PackageExportInput): Record<string, Uint8Array>;
+export declare function buildPackageZip(input: PackageExportInput): Uint8Array;
+export {};

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

@@ -69,4 +69,7 @@ export declare function reloadModuleFromVfs(manifest: PackageManifest, vfs: Prof
  *
  * Throws on read/parse failures.
  */
-export declare function installModuleFromVfsPath(absolutePath: string, vfs: ProfileVFS): InstallResult;
+export declare function installModuleFromVfsPath(absolutePath: string, vfs: ProfileVFS, 
+/** Consulted first, so a module under the read-only /lua/ namespace installs
+ *  as readily as one in the profile — see LuaRuntime.readBuiltinBytes. */
+readBuiltin?: (path: string) => Uint8Array | null): InstallResult;