@mafiahub/types 0.1.6 → 0.1.7

package/framework/discord.d.ts

@@ -1,153 +1,151 @@
-declare namespace Framework {
-    /** Activity verb shown before the app name. Name or the numeric Discord enum. */
-    type DiscordActivityType = "playing" | "streaming" | "listening" | "watching" | number;
+/** Activity verb shown before the app name. Name or the numeric Discord enum. */
+type DiscordActivityType = "playing" | "streaming" | "listening" | "watching" | number;
 
-    /** Party join privacy. Name or the numeric Discord enum. */
-    type DiscordPartyPrivacy = "private" | "public" | number;
+/** Party join privacy. Name or the numeric Discord enum. */
+type DiscordPartyPrivacy = "private" | "public" | number;
 
-    /** Options accepted by {@link Discord.setPresence}. Every field is optional. */
-    interface DiscordPresenceOptions {
-        /** Activity verb; defaults to `"playing"`. */
-        type?: DiscordActivityType;
-        /** Activity name. */
-        name?: string;
-        /** Top line of the presence. */
-        details?: string;
-        /** Bottom line of the presence. */
-        state?: string;
-        /** Elapsed-time anchor, unix seconds. `0` clears it. */
-        startTimestamp?: number;
-        /** Countdown anchor, unix seconds. `0` clears it. */
-        endTimestamp?: number;
-        /** Asset key of the large image. */
-        largeImage?: string;
-        /** Tooltip for the large image. */
-        largeText?: string;
-        /** Asset key of the small image (overlaps the large one). */
-        smallImage?: string;
-        /** Tooltip for the small image. */
-        smallText?: string;
-        /** Party grouping — enables Discord "X of Y" and, with a join secret, invites. */
-        party?: {
-            id?: string;
-            /** `[current, max]` party size. */
-            size?: [number, number];
-            privacy?: DiscordPartyPrivacy;
-        };
-        /** Invite/spectate secrets (opaque strings your game round-trips). */
-        secrets?: {
-            match?: string;
-            join?: string;
-            spectate?: string;
-        };
-        /** Whether this is an instanced (session) activity. */
-        instance?: boolean;
-        /** Supported-platform bitmask (Desktop = 1, Android = 2, iOS = 4). */
-        supportedPlatforms?: number;
-    }
+/** Options accepted by {@link Discord.setPresence}. Every field is optional. */
+interface DiscordPresenceOptions {
+    /** Activity verb; defaults to `"playing"`. */
+    type?: DiscordActivityType;
+    /** Activity name. */
+    name?: string;
+    /** Top line of the presence. */
+    details?: string;
+    /** Bottom line of the presence. */
+    state?: string;
+    /** Elapsed-time anchor, unix seconds. `0` clears it. */
+    startTimestamp?: number;
+    /** Countdown anchor, unix seconds. `0` clears it. */
+    endTimestamp?: number;
+    /** Asset key of the large image. */
+    largeImage?: string;
+    /** Tooltip for the large image. */
+    largeText?: string;
+    /** Asset key of the small image (overlaps the large one). */
+    smallImage?: string;
+    /** Tooltip for the small image. */
+    smallText?: string;
+    /** Party grouping — enables Discord "X of Y" and, with a join secret, invites. */
+    party?: {
+        id?: string;
+        /** `[current, max]` party size. */
+        size?: [number, number];
+        privacy?: DiscordPartyPrivacy;
+    };
+    /** Invite/spectate secrets (opaque strings your game round-trips). */
+    secrets?: {
+        match?: string;
+        join?: string;
+        spectate?: string;
+    };
+    /** Whether this is an instanced (session) activity. */
+    instance?: boolean;
+    /** Supported-platform bitmask (Desktop = 1, Android = 2, iOS = 4). */
+    supportedPlatforms?: number;
+}
 
-    /**
-     * Client-side Discord rich presence API. **Client only** — not available on
-     * the server.
-     *
-     * Field setters *stage* changes onto a pending activity; nothing is shown
-     * until {@link Discord.update} (or the batch {@link Discord.setPresence}) is
-     * called. This mirrors Discord's model — an activity is published as one whole
-     * object and updates are rate-limited — so compose, then commit once. All
-     * calls no-op (setters silently, commits return `false`) when Discord presence
-     * is disabled or unavailable.
-     *
-     * @example
-     * // Batch form — apply several fields and publish in one call:
-     * Framework.Discord.setPresence({
-     *     details: "In the city",
-     *     state: "Freeroam",
-     *     largeImage: "map-city",
-     *     startTimestamp: Math.floor(Date.now() / 1000),
-     *     party: { size: [4, 32] },
-     * });
-     *
-     * @example
-     * // Granular form — stage, then commit:
-     * Framework.Discord.setDetails("Racing");
-     * Framework.Discord.setPartySize(2, 8);
-     * Framework.Discord.update();
-     */
-    const Discord: {
-        /** Stage the activity {@link DiscordActivityType type}. */
-        setType(type: DiscordActivityType): void;
-        /** Stage the activity name. */
-        setName(name: string): void;
-        /** Stage the top line. */
-        setDetails(details: string): void;
-        /** Stage the bottom line. */
-        setState(state: string): void;
+/**
+ * Client-side Discord rich presence API. **Client only** — not available on
+ * the server.
+ *
+ * Field setters *stage* changes onto a pending activity; nothing is shown
+ * until {@link Discord.update} (or the batch {@link Discord.setPresence}) is
+ * called. This mirrors Discord's model — an activity is published as one whole
+ * object and updates are rate-limited — so compose, then commit once. All
+ * calls no-op (setters silently, commits return `false`) when Discord presence
+ * is disabled or unavailable.
+ *
+ * @example
+ * // Batch form — apply several fields and publish in one call:
+ * Discord.setPresence({
+ *     details: "In the city",
+ *     state: "Freeroam",
+ *     largeImage: "map-city",
+ *     startTimestamp: Math.floor(Date.now() / 1000),
+ *     party: { size: [4, 32] },
+ * });
+ *
+ * @example
+ * // Granular form — stage, then commit:
+ * Discord.setDetails("Racing");
+ * Discord.setPartySize(2, 8);
+ * Discord.update();
+ */
+declare const Discord: {
+    /** Stage the activity {@link DiscordActivityType type}. */
+    setType(type: DiscordActivityType): void;
+    /** Stage the activity name. */
+    setName(name: string): void;
+    /** Stage the top line. */
+    setDetails(details: string): void;
+    /** Stage the bottom line. */
+    setState(state: string): void;
 
-        /** Stage the elapsed-time anchor (unix seconds; `0` clears). */
-        setStartTimestamp(seconds: number): void;
-        /** Stage the countdown anchor (unix seconds; `0` clears). */
-        setEndTimestamp(seconds: number): void;
+    /** Stage the elapsed-time anchor (unix seconds; `0` clears). */
+    setStartTimestamp(seconds: number): void;
+    /** Stage the countdown anchor (unix seconds; `0` clears). */
+    setEndTimestamp(seconds: number): void;
 
-        /** Stage the large image asset key. */
-        setLargeImage(assetKey: string): void;
-        /** Stage the large image tooltip. */
-        setLargeText(text: string): void;
-        /** Stage the small image asset key. */
-        setSmallImage(assetKey: string): void;
-        /** Stage the small image tooltip. */
-        setSmallText(text: string): void;
-        /** Stage several asset fields at once. */
-        setAssets(assets: { largeImage?: string; largeText?: string; smallImage?: string; smallText?: string }): void;
+    /** Stage the large image asset key. */
+    setLargeImage(assetKey: string): void;
+    /** Stage the large image tooltip. */
+    setLargeText(text: string): void;
+    /** Stage the small image asset key. */
+    setSmallImage(assetKey: string): void;
+    /** Stage the small image tooltip. */
+    setSmallText(text: string): void;
+    /** Stage several asset fields at once. */
+    setAssets(assets: { largeImage?: string; largeText?: string; smallImage?: string; smallText?: string }): void;
 
-        /** Stage the party id. */
-        setPartyId(id: string): void;
-        /** Stage the party size (current of max). */
-        setPartySize(current: number, max: number): void;
-        /** Stage the party join privacy. */
-        setPartyPrivacy(privacy: DiscordPartyPrivacy): void;
-        /** Stage several party fields at once. */
-        setParty(party: { id?: string; size?: [number, number]; privacy?: DiscordPartyPrivacy }): void;
+    /** Stage the party id. */
+    setPartyId(id: string): void;
+    /** Stage the party size (current of max). */
+    setPartySize(current: number, max: number): void;
+    /** Stage the party join privacy. */
+    setPartyPrivacy(privacy: DiscordPartyPrivacy): void;
+    /** Stage several party fields at once. */
+    setParty(party: { id?: string; size?: [number, number]; privacy?: DiscordPartyPrivacy }): void;
 
-        /** Stage the match secret. */
-        setMatchSecret(secret: string): void;
-        /** Stage the join secret (enables Ask to Join). */
-        setJoinSecret(secret: string): void;
-        /** Stage the spectate secret. */
-        setSpectateSecret(secret: string): void;
-        /** Stage several secret fields at once. */
-        setSecrets(secrets: { match?: string; join?: string; spectate?: string }): void;
+    /** Stage the match secret. */
+    setMatchSecret(secret: string): void;
+    /** Stage the join secret (enables Ask to Join). */
+    setJoinSecret(secret: string): void;
+    /** Stage the spectate secret. */
+    setSpectateSecret(secret: string): void;
+    /** Stage several secret fields at once. */
+    setSecrets(secrets: { match?: string; join?: string; spectate?: string }): void;
 
-        /** Stage the instanced flag. */
-        setInstance(instance: boolean): void;
-        /** Stage the supported-platform bitmask (Desktop = 1, Android = 2, iOS = 4). */
-        setSupportedPlatforms(flags: number): void;
+    /** Stage the instanced flag. */
+    setInstance(instance: boolean): void;
+    /** Stage the supported-platform bitmask (Desktop = 1, Android = 2, iOS = 4). */
+    setSupportedPlatforms(flags: number): void;
 
-        /**
-         * Apply a batch of fields and publish immediately (a merge of the matching
-         * setters followed by {@link Discord.update}).
-         * @returns `true` if the update was dispatched, `false` if unavailable.
-         */
-        setPresence(options: DiscordPresenceOptions): boolean;
+    /**
+     * Apply a batch of fields and publish immediately (a merge of the matching
+     * setters followed by {@link Discord.update}).
+     * @returns `true` if the update was dispatched, `false` if unavailable.
+     */
+    setPresence(options: DiscordPresenceOptions): boolean;
 
-        /**
-         * Publish the currently staged activity.
-         * @returns `true` if dispatched, `false` if unavailable.
-         */
-        update(): boolean;
+    /**
+     * Publish the currently staged activity.
+     * @returns `true` if dispatched, `false` if unavailable.
+     */
+    update(): boolean;
 
-        /**
-         * Clear the activity on Discord and reset the staged state.
-         * @returns `true` if dispatched, `false` if unavailable.
-         */
-        clear(): boolean;
+    /**
+     * Clear the activity on Discord and reset the staged state.
+     * @returns `true` if dispatched, `false` if unavailable.
+     */
+    clear(): boolean;
 
-        /** Reset the staged state without publishing. */
-        reset(): void;
+    /** Reset the staged state without publishing. */
+    reset(): void;
 
-        /** Snowflake of the signed-in Discord user, or `""` until known. */
-        getUserId(): string;
+    /** Snowflake of the signed-in Discord user, or `""` until known. */
+    getUserId(): string;
 
-        /** Whether the Discord client is connected and presence can be published. */
-        isAvailable(): boolean;
-    };
-}
+    /** Whether the Discord client is connected and presence can be published. */
+    isAvailable(): boolean;
+};

package/framework/exports.d.ts

@@ -1,21 +1,19 @@
-declare namespace Framework {
-    const Exports: {
-        /**
-         * Register a value or function from the calling resource.
-         * @param name Export name, preferably declared in the resource manifest.
-         * @param value JavaScript value retained for dependent resources.
-         * @returns `true` when registration succeeds.
-         */
-        register(name: string, value: any): boolean;
+declare const Exports: {
+    /**
+     * Register a value or function from the calling resource.
+     * @param name Export name, preferably declared in the resource manifest.
+     * @param value JavaScript value retained for dependent resources.
+     * @returns `true` when registration succeeds.
+     */
+    register(name: string, value: any): boolean;
 
-        /**
-         * Get a specific export from another resource.
-         * Throws if the resource is not found, not running, or the export
-         * does not exist.
-         * @param resourceName Name of the running resource that owns the export.
-         * @param exportName Registered export name.
-         * @returns The exported value with its original JavaScript identity.
-         */
-        get(resourceName: string, exportName: string): any;
-    };
-}
+    /**
+     * Get a specific export from another resource.
+     * Throws if the resource is not found, not running, or the export
+     * does not exist.
+     * @param resourceName Name of the running resource that owns the export.
+     * @param exportName Registered export name.
+     * @returns The exported value with its original JavaScript identity.
+     */
+    get(resourceName: string, exportName: string): any;
+};

package/framework/imports.d.ts

@@ -1,12 +1,10 @@
-declare namespace Framework {
-    const imports: {
-        /**
-         * Get the exports object from another resource.
-         * Throws if the resource is not found or not running.
-         * Importing without a declared dependency produces a warning.
-         * @param resourceName Name of the running resource whose exports should be read.
-         * @returns An object keyed by export name, or an empty object when none are registered.
-         */
-        get(resourceName: string): Record<string, any>;
-    };
-}
+declare const Imports: {
+    /**
+     * Get the exports object from another resource.
+     * Throws if the resource is not found or not running.
+     * Importing without a declared dependency produces a warning.
+     * @param resourceName Name of the running resource whose exports should be read.
+     * @returns An object keyed by export name, or an empty object when none are registered.
+     */
+    get(resourceName: string): Record<string, any>;
+};

package/framework/key.d.ts

@@ -1,57 +1,55 @@
-declare namespace Framework {
+/**
+ * Client-side keybinding API. **Client only** — not available on the server.
+ *
+ * Binds a physical key to a handler that fires on key-down, key-up, or both
+ * edges. Binds are resource-owned: they are cleared automatically when the
+ * resource stops. Handlers only fire while the game is in the foreground and
+ * no UI (chat box, menu, focused web view) is capturing input.
+ *
+ * Key names are case-insensitive. Recognised names:
+ * - Letters `a`–`z`, digits `0`–`9`
+ * - Function keys `f1`–`f12`
+ * - Arrows `up` `down` `left` `right`
+ * - Modifiers `shift` `lshift` `rshift`, `ctrl`/`control` `lctrl` `rctrl`,
+ *   `alt` `lalt` `ralt`
+ * - Editing `space` `enter`/`return` `escape`/`esc` `tab` `backspace`
+ *   `insert` `delete` `home` `end` `pageup` `pagedown` `capslock`
+ * - Numpad `numpad0`–`numpad9` (aliases `num0`–`num9`)
+ * - Mouse `mouse1` (left) `mouse2` (right) `mouse3` (middle) `mouse4` `mouse5`
+ *
+ * @example
+ * // Toggle a HUD on key-down:
+ * Key.bind("f6", "down", () => toggleHud());
+ *
+ * // Hold-to-act (fires on both edges); state is "down" then "up":
+ * Key.bind("b", "both", (key, state) => setAiming(state === "down"));
+ *
+ * // State omitted defaults to "down":
+ * Key.bind("h", () => honk());
+ */
+declare const Key: {
     /**
-     * Client-side keybinding API. **Client only** — not available on the server.
-     *
-     * Binds a physical key to a handler that fires on key-down, key-up, or both
-     * edges. Binds are resource-owned: they are cleared automatically when the
-     * resource stops. Handlers only fire while the game is in the foreground and
-     * no UI (chat box, menu, focused web view) is capturing input.
-     *
-     * Key names are case-insensitive. Recognised names:
-     * - Letters `a`–`z`, digits `0`–`9`
-     * - Function keys `f1`–`f12`
-     * - Arrows `up` `down` `left` `right`
-     * - Modifiers `shift` `lshift` `rshift`, `ctrl`/`control` `lctrl` `rctrl`,
-     *   `alt` `lalt` `ralt`
-     * - Editing `space` `enter`/`return` `escape`/`esc` `tab` `backspace`
-     *   `insert` `delete` `home` `end` `pageup` `pagedown` `capslock`
-     * - Numpad `numpad0`–`numpad9` (aliases `num0`–`num9`)
-     * - Mouse `mouse1` (left) `mouse2` (right) `mouse3` (middle) `mouse4` `mouse5`
-     *
-     * @example
-     * // Toggle a HUD on key-down:
-     * Framework.Key.bind("f6", "down", () => toggleHud());
-     *
-     * // Hold-to-act (fires on both edges); state is "down" then "up":
-     * Framework.Key.bind("b", "both", (key, state) => setAiming(state === "down"));
-     *
-     * // State omitted defaults to "down":
-     * Framework.Key.bind("h", () => honk());
+     * Bind a handler to a key.
+     * @param key Case-insensitive key name (see the {@link Key} table).
+     * @param state `"down"`, `"up"`, or `"both"`. If omitted, defaults to `"down"`.
+     * @param handler Called as `handler(key, state)` where `state` is the actual
+     *   edge that fired (`"down"` or `"up"`).
+     * @returns `true` once bound. Throws on an unknown key name or bad state.
      */
-    const Key: {
-        /**
-         * Bind a handler to a key.
-         * @param key Case-insensitive key name (see the {@link Key} table).
-         * @param state `"down"`, `"up"`, or `"both"`. If omitted, defaults to `"down"`.
-         * @param handler Called as `handler(key, state)` where `state` is the actual
-         *   edge that fired (`"down"` or `"up"`).
-         * @returns `true` once bound. Throws on an unknown key name or bad state.
-         */
-        bind(key: string, state: "down" | "up" | "both", handler: (key: string, state: "down" | "up") => void): boolean;
-        bind(key: string, handler: (key: string, state: "down" | "up") => void): boolean;
+    bind(key: string, state: "down" | "up" | "both", handler: (key: string, state: "down" | "up") => void): boolean;
+    bind(key: string, handler: (key: string, state: "down" | "up") => void): boolean;
 
-        /**
-         * Remove binds for a key. With no filters, removes every handler on that key.
-         * @param state Optional: only remove binds registered with this state.
-         * @param handler Optional: only remove this exact handler function.
-         * @returns `true` if at least one bind was removed.
-         */
-        unbind(key: string, state?: "down" | "up" | "both", handler?: (key: string, state: "down" | "up") => void): boolean;
+    /**
+     * Remove binds for a key. With no filters, removes every handler on that key.
+     * @param state Optional: only remove binds registered with this state.
+     * @param handler Optional: only remove this exact handler function.
+     * @returns `true` if at least one bind was removed.
+     */
+    unbind(key: string, state?: "down" | "up" | "both", handler?: (key: string, state: "down" | "up") => void): boolean;
 
-        /**
-         * Live physical state of a key. Returns `false` while UI owns input or the
-         * game window is in the background (same gate as bind dispatch).
-         */
-        isDown(key: string): boolean;
-    };
-}
+    /**
+     * Live physical state of a key. Returns `false` while UI owns input or the
+     * game window is in the background (same gate as bind dispatch).
+     */
+    isDown(key: string): boolean;
+};

package/framework/messages.d.ts

@@ -1,32 +1,30 @@
-declare namespace Framework {
-    const messages: {
-        /**
-         * Register or replace a handler owned by the calling resource.
-         * @param messageType Message type unique within the receiving resource.
-         * @param handler Receives `(payload, reply)`. Call `reply(value)`
-         *   once to resolve a request; replies are ignored for fire-and-forget messages.
-         */
-        handle(
-            messageType: string,
-            handler: (payload: any, reply: (value: any) => void) => void,
-        ): void;
+declare const Messages: {
+    /**
+     * Register or replace a handler owned by the calling resource.
+     * @param messageType Message type unique within the receiving resource.
+     * @param handler Receives `(payload, reply)`. Call `reply(value)`
+     *   once to resolve a request; replies are ignored for fire-and-forget messages.
+     */
+    handle(
+        messageType: string,
+        handler: (payload: any, reply: (value: any) => void) => void,
+    ): void;
 
-        /**
-         * Send a request to another resource and await a reply.
-         * Rejects if the target resource has no handler or the handler throws.
-         * @param resourceName Destination running resource.
-         * @param messageType Handler type registered by the destination.
-         * @param payload Optional value delivered to the handler.
-         * @returns A promise resolved with the value passed to `reply`.
-         */
-        request(resourceName: string, messageType: string, payload?: any): Promise<any>;
+    /**
+     * Send a request to another resource and await a reply.
+     * Rejects if the target resource has no handler or the handler throws.
+     * @param resourceName Destination running resource.
+     * @param messageType Handler type registered by the destination.
+     * @param payload Optional value delivered to the handler.
+     * @returns A promise resolved with the value passed to `reply`.
+     */
+    request(resourceName: string, messageType: string, payload?: any): Promise<any>;
 
-        /**
-         * Send a fire-and-forget message to another local resource.
-         * @param resourceName Destination running resource.
-         * @param messageType Handler type registered by the destination.
-         * @param payload Optional value delivered to the handler.
-         */
-        send(resourceName: string, messageType: string, payload?: any): void;
-    };
-}
+    /**
+     * Send a fire-and-forget message to another local resource.
+     * @param resourceName Destination running resource.
+     * @param messageType Handler type registered by the destination.
+     * @param payload Optional value delivered to the handler.
+     */
+    send(resourceName: string, messageType: string, payload?: any): void;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mafiahub/types",
-    "version": "0.1.6",
+    "version": "0.1.7",
     "description": "TypeScript type definitions for the MafiaHub Framework scripting API",
     "types": "index.d.ts",
     "files": [