@vespura/vmenu-plugin 0.0.1 → 1.0.9

package/README.md

@@ -1,45 +1,45 @@
-# @vespura/vmenu-plugin
-
-The TypeScript and JavaScript plugin API for vMenu Enhanced, the version of vMenu that runs on FiveM Enhanced (GTA V Enhanced).
-
-A plugin is a normal FiveM resource of your own. With this package, your resource can add menus to vMenu, under a Plugins entry on its main menu. You describe the menu in code and the package talks to vMenu over events for you. vMenu never needs to know about your resource ahead of time.
-
-Everything the C# plugin API can do is here too. That covers buttons, checkboxes, lists, sliders, dynamic lists, submenus, confirm rows, separators, keys, player actions, translations, permission and setting gates, notifications, text prompts and themes.
-
-```ts
-import { Gate, Text, VMenuPlugin } from '@vespura/vmenu-plugin/client';
-
-const plugin = VMenuPlugin.create('My Plugin');
-
-plugin.translations.add('en', { greet: 'Say hello' });
-
-const enabled = plugin.settings.bool('Enabled', true, 'Turns my plugin on or off.');
-
-const greet = plugin.rootMenu.addButton(Text.key('greet'), {
-  gate: Gate.permission('Greet').and(Gate.setting(enabled)),
-});
-
-greet.onSelected(() => plugin.notify('success', 'Hello!'));
-
-await plugin.connect();
-```
-
-Your server script declares the permissions and settings through `@vespura/vmenu-plugin/server`:
-
-```ts
-import { ServerPluginDeclaration, VMenuServer } from '@vespura/vmenu-plugin/server';
-
-await VMenuServer.register(
-  new ServerPluginDeclaration('My Plugin')
-    .addPermission('Greet', 'Lets someone use the greet button.')
-    .addBoolSetting('Enabled', true, 'Turns my plugin on or off.'),
-);
-```
-
-The package ships ES modules, so bundle your client and server scripts with a bundler such as esbuild before FiveM loads them. Writing plain JavaScript without a bundler? The vMenu Enhanced release zip also has a single `vmenu.js` file in its `plugin-api` folder, to copy into your resource, with the exact same API on a global `vMenu` object.
-
-The package version always matches the vMenu Enhanced release it belongs to. A full example resource lives in the [vMenu.ExamplePlugin](https://github.com/TomGrobbe/vMenu.ExamplePlugin) repository, and the documentation is at [docs.vespura.com](https://docs.vespura.com/vmenu/enhanced/plugins/typescript/).
-
-## License
-
-This package is licensed under the **GNU General Public License v3.0 or later**, `GPL-3.0-or-later`, the same license vMenu Enhanced itself uses. A plugin built on it is a work based on vMenu, so the license comes along with your plugin. Running it on your own server asks nothing of you. The moment you hand your plugin to somebody else, you owe them the complete source under this same license. The [C# package's readme](https://www.nuget.org/packages/vMenu.Enhanced.ClientAPI) explains this in more detail. This is a plain language summary, not legal advice.
+# @vespura/vmenu-plugin
+
+The TypeScript and JavaScript plugin API for vMenu Enhanced, the version of vMenu that runs on FiveM Enhanced (GTA V Enhanced).
+
+A plugin is a normal FiveM resource of your own. With this package, your resource can add menus to vMenu, under a Plugins entry on its main menu. You describe the menu in code and the package talks to vMenu over events for you. vMenu never needs to know about your resource ahead of time.
+
+Everything the C# plugin API can do is here too. That covers buttons, checkboxes, lists, sliders, dynamic lists, submenus, confirm rows, separators, keys, player actions, translations, permission and setting gates, notifications, text prompts and themes.
+
+```ts
+import { Gate, NotifyStyle, Text, VMenuPlugin } from '@vespura/vmenu-plugin/client';
+
+const plugin = VMenuPlugin.create('My Plugin');
+
+plugin.translations.add('en', { greet: 'Say hello' });
+
+const enabled = plugin.settings.bool('Enabled', true, 'Turns my plugin on or off.');
+
+const greet = plugin.rootMenu.addButton(Text.key('greet'), {
+  gate: Gate.permission('Greet').and(Gate.setting(enabled)),
+});
+
+greet.onSelected(() => plugin.notify(NotifyStyle.Success, 'Hello!'));
+
+await plugin.connect();
+```
+
+Your server script declares the permissions and settings through `@vespura/vmenu-plugin/server`:
+
+```ts
+import { ServerPluginDeclaration, VMenuServer } from '@vespura/vmenu-plugin/server';
+
+await VMenuServer.register(
+  new ServerPluginDeclaration('My Plugin')
+    .addPermission('Greet', 'Lets someone use the greet button.')
+    .addBoolSetting('Enabled', true, 'Turns my plugin on or off.'),
+);
+```
+
+The package ships ES modules, so bundle your client and server scripts with a bundler such as esbuild before FiveM loads them. Writing plain JavaScript without a bundler? The vMenu Enhanced release zip also has a single `vmenu.js` file in its `plugin-api` folder, to copy into your resource, with the exact same API on a global `vMenu` object.
+
+The package version always matches the vMenu Enhanced release it belongs to. A full example resource lives in the [vMenu.ExamplePlugin](https://github.com/TomGrobbe/vMenu.ExamplePlugin) repository, and the documentation is at [docs.vespura.com](https://docs.vespura.com/vmenu/enhanced/plugins/typescript/).
+
+## License
+
+This package is licensed under the **GNU General Public License v3.0 or later**, `GPL-3.0-or-later`, the same license vMenu Enhanced itself uses. A plugin built on it is a work based on vMenu, so the license comes along with your plugin. Running it on your own server asks nothing of you. The moment you hand your plugin to somebody else, you owe them the complete source under this same license. The [C# package's readme](https://www.nuget.org/packages/vMenu.Enhanced.ClientAPI) explains this in more detail. This is a plain language summary, not legal advice.

package/dist/client.js

@@ -1,5 +1,5 @@
 // src/version.ts
-var version = true ? "0.0.1" : "0.0.0-local";
+var version = true ? "1.0.9" : "0.0.0-local";
 
 // src/text.ts
 var Text = class _Text {
@@ -24,8 +24,8 @@ var Text = class _Text {
     if (text === null || text === void 0) {
       return void 0;
     }
-    if (typeof text === "string") {
-      return { text };
+    if (!(text instanceof _Text)) {
+      return { text: String(text) };
     }
     if (!text.isKey) {
       return { text: text.value };
@@ -127,6 +127,10 @@ function formatFloat(value) {
   const text = value.toFixed(4).replace(/0+$/, "");
   return text.endsWith(".") ? `${text}0` : text;
 }
+function int(value) {
+  const number = Math.trunc(Number(value));
+  return Number.isFinite(number) ? number : 0;
+}
 
 // src/protocol.ts
 var PROTOCOL_VERSION = 2;
@@ -673,6 +677,7 @@ var PluginList = class extends PluginItem {
     return this.node.selectedIndex ?? 0;
   }
   set selectedIndex(value) {
+    value = int(value);
     if (this.selectedIndex === value) {
       return;
     }
@@ -682,6 +687,7 @@ var PluginList = class extends PluginItem {
   /** Replaces the options, optionally moving the selection at the same time. */
   setOptions(options, selectedIndex) {
     const refs = Text.toRefs(options);
+    selectedIndex = selectedIndex === void 0 ? void 0 : int(selectedIndex);
     if (sameTexts(this.node.options, refs) && (selectedIndex === void 0 || selectedIndex === this.selectedIndex)) {
       return;
     }
@@ -764,6 +770,7 @@ var PluginSlider = class extends PluginItem {
     return this.node.position ?? this.min;
   }
   set position(value) {
+    value = int(value);
     if (this.position === value) {
       return;
     }
@@ -806,6 +813,7 @@ var PluginDynamicList = class extends PluginItem {
     return this.node.value ?? "";
   }
   set value(value) {
+    value = String(value);
     if (this.value === value) {
       return;
     }
@@ -823,7 +831,7 @@ var PluginDynamicList = class extends PluginItem {
       case CallbackTypes.DynamicChanging:
         if (typeof callback.left === "boolean") {
           const next = this.changeRequested?.(callback.currentValue ?? "", callback.left);
-          if (typeof next === "string") {
+          if (next !== null && next !== void 0) {
             this.value = next;
           }
         }
@@ -1008,14 +1016,14 @@ var PluginMenu = class _PluginMenu {
   addList(text, values, options) {
     const node = this.newNode(EntryTypes.List, text, options);
     node.options = Text.toRefs(values);
-    node.selectedIndex = options?.selectedIndex ?? 0;
+    node.selectedIndex = int(options?.selectedIndex ?? 0);
     return this.attach(new PluginList(node, text), options);
   }
   /** Adds a list that asks for a second press before it does anything. */
   addConfirmList(text, values, options) {
     const node = this.newNode(EntryTypes.ConfirmList, text, options);
     node.options = Text.toRefs(values);
-    node.selectedIndex = options?.selectedIndex ?? 0;
+    node.selectedIndex = int(options?.selectedIndex ?? 0);
     const item = new PluginConfirmList(node, text);
     if (options?.confirmationDescription !== void 0) {
       item.confirmationDescription = options.confirmationDescription;
@@ -1025,16 +1033,16 @@ var PluginMenu = class _PluginMenu {
   /** Adds a row with a bar the player drags between `min` and `max`. */
   addSlider(text, min, max, position, options) {
     const node = this.newNode(EntryTypes.Slider, text, options);
-    node.min = min;
-    node.max = max;
-    node.position = position;
+    node.min = int(min);
+    node.max = int(max);
+    node.position = int(position);
     node.showDivider = options?.showDivider ?? false;
     return this.attach(new PluginSlider(node, text), options);
   }
   /** Adds a row whose value your code works out each time the player scrolls it, through `changeRequested`. */
   addDynamicList(text, initialValue, options) {
     const node = this.newNode(EntryTypes.DynamicList, text, options);
-    node.value = initialValue;
+    node.value = String(initialValue);
     return this.attach(new PluginDynamicList(node, text), options);
   }
   /** Adds a row that only shows text, used to split a menu into sections. */
@@ -1071,7 +1079,7 @@ var PluginMenu = class _PluginMenu {
       description: Text.toRef(options?.description),
       defaultKey,
       defaultButton: options?.defaultButton,
-      shadowedControl: options?.shadowedControl
+      shadowedControl: options?.shadowedControl === void 0 ? void 0 : int(options.shadowedControl)
     };
     (_a = this.node).keys ?? (_a.keys = []);
     this.node.keys.push(node);
@@ -1087,7 +1095,7 @@ var PluginMenu = class _PluginMenu {
    */
   insertAt(index, add) {
     const previous = this.insertIndex;
-    this.insertIndex = clamp(index, 0, this.itemList.length);
+    this.insertIndex = clamp(int(index), 0, this.itemList.length);
     try {
       add();
     } finally {
@@ -1100,7 +1108,7 @@ var PluginMenu = class _PluginMenu {
     if (from < 0) {
       return;
     }
-    const to = clamp(index, 0, this.itemList.length - 1);
+    const to = clamp(int(index), 0, this.itemList.length - 1);
     if (to === from) {
       return;
     }
@@ -1314,12 +1322,13 @@ var PluginPlayerList = class extends PluginItem {
     return this.node.selectedIndex ?? 0;
   }
   set selectedIndex(value) {
-    this.node.selectedIndex = value;
-    this.emit({ op: UpdateOps.SetSelectedIndex, itemId: this.id, index: value });
+    this.node.selectedIndex = int(value);
+    this.emit({ op: UpdateOps.SetSelectedIndex, itemId: this.id, index: this.node.selectedIndex });
   }
   /** Replaces the options, optionally moving the selection at the same time. */
   setOptions(options, selectedIndex) {
     this.node.options = Text.toRefs(options);
+    selectedIndex = selectedIndex === void 0 ? void 0 : int(selectedIndex);
     if (selectedIndex !== void 0) {
       this.node.selectedIndex = selectedIndex;
     }
@@ -1369,7 +1378,7 @@ var PluginPlayerActions = class {
   addList(text, values, options) {
     const node = this.newNode(EntryTypes.List, text, options);
     node.options = Text.toRefs(values);
-    node.selectedIndex = options?.selectedIndex ?? 0;
+    node.selectedIndex = int(options?.selectedIndex ?? 0);
     return this.attach(new PluginPlayerList(node, text), options);
   }
   /** Adds a row that only shows text. */
@@ -1448,9 +1457,9 @@ var PluginThemes = class {
       return;
     }
     const current = list.current?.toLowerCase();
-    this.availableValue = (list.themes ?? []).map((theme) => ({
+    this.availableValue = (Array.isArray(list.themes) ? list.themes : []).filter((theme) => typeof theme?.id === "string").map((theme) => ({
       id: theme.id,
-      name: theme.name,
+      name: typeof theme.name === "string" ? theme.name : theme.id,
       isCurrent: theme.id.toLowerCase() === current
     }));
     this.currentIdValue = list.current ?? void 0;
@@ -1489,6 +1498,12 @@ var PluginTranslations = class {
 };
 
 // src/client/plugin.ts
+var NotifyStyle = {
+  Info: "info",
+  Success: "success",
+  Warning: "warning",
+  Error: "error"
+};
 var CarriedItemOps = /* @__PURE__ */ new Set([
   UpdateOps.SetText,
   UpdateOps.SetDescription,
@@ -1581,7 +1596,7 @@ var VMenuPlugin = class _VMenuPlugin {
     if (!this.connected) {
       return;
     }
-    emitLocal(PluginEvents.Notify, JSON.stringify({ style, text: Text.toRef(text), durationMs }));
+    emitLocal(PluginEvents.Notify, JSON.stringify({ style, text: Text.toRef(text), durationMs: durationMs === void 0 ? void 0 : int(durationMs) }));
   }
   /** Asks the player for text through vMenu's input box. Resolves to null if they cancelled or the box was unavailable. */
   async getText(title, options) {
@@ -1598,8 +1613,8 @@ var VMenuPlugin = class _VMenuPlugin {
       requestId,
       prompts: prompts.map((prompt) => ({
         title: Text.toRef(prompt.title),
-        maxLength: prompt.maxLength ?? 60,
-        initial: prompt.initialValue ?? "",
+        maxLength: int(prompt.maxLength ?? 60),
+        initial: String(prompt.initialValue ?? ""),
         suggestions: prompt.suggestions && prompt.suggestions.length > 0 ? prompt.suggestions.map((suggestion) => ({ value: suggestion.value, description: suggestion.description })) : void 0
       }))
     };
@@ -1877,6 +1892,7 @@ var VMenuPlugin = class _VMenuPlugin {
 };
 export {
   Gate,
+  NotifyStyle,
   PluginBoolSetting,
   PluginButton,
   PluginCheckbox,

package/dist/server.js

@@ -1,5 +1,5 @@
 // src/version.ts
-var version = true ? "0.0.1" : "0.0.0-local";
+var version = true ? "1.0.9" : "0.0.0-local";
 
 // src/format.ts
 function formatFloat(value) {
@@ -111,7 +111,7 @@ var natives = globalThis;
 var currentResource = () => natives.GetCurrentResourceName();
 var emitLocal = (eventName, ...args) => natives.emit(eventName, ...args);
 var onLocal = (eventName, handler) => natives.on(eventName, handler);
-var isAceAllowed = (playerSource, object) => natives.IsPlayerAceAllowed(playerSource, object) === true;
+var isAceAllowed = (playerSource, object) => Boolean(natives.IsPlayerAceAllowed(playerSource, object));
 var log = {
   info: (resource, message) => console.log(`[${resource}] ${message}`),
   warn: (resource, message) => console.warn(`[${resource}] ${message}`),

package/dist/types/client/diff.d.ts

@@ -1,4 +1,4 @@
-import type { GateNode, TextRef } from '../protocol';
+import type { GateNode, TextRef } from '../protocol.js';
 export declare function sameText(left: TextRef | undefined, right: TextRef | undefined): boolean;
 export declare function sameTexts(left: TextRef[] | undefined, right: TextRef[] | undefined): boolean;
 export declare function sameGate(left: GateNode | undefined, right: GateNode | undefined): boolean;

package/dist/types/client/gate.d.ts

@@ -1,4 +1,4 @@
-import type { PluginBoolSetting } from './settings';
+import type { PluginBoolSetting } from './settings.js';
 /** A gate, or a permission's short name as a shortcut for `Gate.permission(name)`. */
 export type GateLike = Gate | string;
 /**

package/dist/types/client/host.d.ts

@@ -1,7 +1,7 @@
-import type { UpdateOp } from '../protocol';
-import type { PluginItem } from './item';
-import type { PluginKey } from './key';
-import type { PluginMenu } from './menu';
+import type { UpdateOp } from '../protocol.js';
+import type { PluginItem } from './item.js';
+import type { PluginKey } from './key.js';
+import type { PluginMenu } from './menu.js';
 export interface PluginHost {
     readonly resource: string;
     readonly isConnected: boolean;

package/dist/types/client/index.d.ts

@@ -1,14 +1,14 @@
-export { version } from '../version';
-export { Text, type TextLike } from '../text';
-export type { Unsubscribe } from '../signal';
-export type { RegisterResult } from '../protocol';
-export { Gate, type GateLike } from './gate';
-export { PluginSetting, PluginBoolSetting, PluginIntSetting, PluginFloatSetting, PluginStringSetting, PluginSettings, } from './settings';
-export { PluginItem, type ItemOptions } from './item';
-export { PluginButton, PluginConfirmButton, PluginCheckbox, PluginList, PluginConfirmList, PluginSlider, PluginDynamicList, PluginSeparator, PluginSubmenu, } from './items';
-export { PluginKey, type PluginKeyPress } from './key';
-export { PluginMenu, type CheckboxOptions, type ConfirmOptions, type KeyOptions, type ListOptions, type SliderOptions, type SubmenuOptions, } from './menu';
-export { PluginPlayerActions, PluginPlayerButton, PluginPlayerConfirmButton, PluginPlayerList, type PlayerTarget, } from './playerActions';
-export { PluginThemes, type PluginTheme } from './themes';
-export { PluginTranslations } from './translations';
-export { VMenuPlugin, type NotifyStyle, type PluginPrompt, type PromptSuggestion } from './plugin';
+export { version } from '../version.js';
+export { Text, type TextLike } from '../text.js';
+export type { Unsubscribe } from '../signal.js';
+export type { RegisterResult } from '../protocol.js';
+export { Gate, type GateLike } from './gate.js';
+export { PluginSetting, PluginBoolSetting, PluginIntSetting, PluginFloatSetting, PluginStringSetting, PluginSettings, } from './settings.js';
+export { PluginItem, type ItemOptions } from './item.js';
+export { PluginButton, PluginConfirmButton, PluginCheckbox, PluginList, PluginConfirmList, PluginSlider, PluginDynamicList, PluginSeparator, PluginSubmenu, } from './items.js';
+export { PluginKey, type PluginKeyPress } from './key.js';
+export { PluginMenu, type CheckboxOptions, type ConfirmOptions, type KeyOptions, type ListOptions, type SliderOptions, type SubmenuOptions, } from './menu.js';
+export { PluginPlayerActions, PluginPlayerButton, PluginPlayerConfirmButton, PluginPlayerList, type PlayerTarget, } from './playerActions.js';
+export { PluginThemes, type PluginTheme } from './themes.js';
+export { PluginTranslations } from './translations.js';
+export { VMenuPlugin, NotifyStyle, type PluginPrompt, type PromptSuggestion } from './plugin.js';

package/dist/types/client/item.d.ts

@@ -1,7 +1,7 @@
-import { type UpdateOp } from '../protocol';
-import { Signal, type Unsubscribe } from '../signal';
-import { type TextLike } from '../text';
-import { type GateLike } from './gate';
+import { type UpdateOp } from '../protocol.js';
+import { Signal, type Unsubscribe } from '../signal.js';
+import { type TextLike } from '../text.js';
+import { type GateLike } from './gate.js';
 /** Properties every row accepts when you add it. Setting them here sends them along with the row itself. */
 export interface ItemOptions {
     /** A stable id of your own. Generated when left out. Unique within your plugin. */

package/dist/types/client/items.d.ts

@@ -1,7 +1,7 @@
-import type { Unsubscribe } from '../signal';
-import { type TextLike } from '../text';
-import { PluginItem } from './item';
-import type { PluginMenu } from './menu';
+import type { Unsubscribe } from '../signal.js';
+import { type TextLike } from '../text.js';
+import { PluginItem } from './item.js';
+import type { PluginMenu } from './menu.js';
 /** A row the player presses. */
 export declare class PluginButton extends PluginItem {
     private readonly selected;

package/dist/types/client/key.d.ts

@@ -1,7 +1,7 @@
-import { type Unsubscribe } from '../signal';
-import { type TextLike } from '../text';
-import { type GateLike } from './gate';
-import type { PluginItem } from './item';
+import { type Unsubscribe } from '../signal.js';
+import { type TextLike } from '../text.js';
+import { type GateLike } from './gate.js';
+import type { PluginItem } from './item.js';
 /**
  * Which row the cursor was on when a key was pressed. At most one of the two is set, and neither
  * when the menu is empty or the row is not one of yours.

package/dist/types/client/menu.d.ts

@@ -1,8 +1,8 @@
-import { type Unsubscribe } from '../signal';
-import { type TextLike } from '../text';
-import { PluginItem, type ItemOptions } from './item';
-import { PluginButton, PluginCheckbox, PluginConfirmButton, PluginConfirmList, PluginDynamicList, PluginList, PluginSeparator, PluginSlider, PluginSubmenu } from './items';
-import { PluginKey } from './key';
+import { type Unsubscribe } from '../signal.js';
+import { type TextLike } from '../text.js';
+import { PluginItem, type ItemOptions } from './item.js';
+import { PluginButton, PluginCheckbox, PluginConfirmButton, PluginConfirmList, PluginDynamicList, PluginList, PluginSeparator, PluginSlider, PluginSubmenu } from './items.js';
+import { PluginKey } from './key.js';
 /** Extra properties for a confirm button or confirm list. */
 export interface ConfirmOptions extends ItemOptions {
     /** What the row asks before its second press. */

package/dist/types/client/playerActions.d.ts

@@ -1,7 +1,7 @@
-import type { Unsubscribe } from '../signal';
-import { type TextLike } from '../text';
-import { PluginItem, type ItemOptions } from './item';
-import { PluginSeparator } from './items';
+import type { Unsubscribe } from '../signal.js';
+import { type TextLike } from '../text.js';
+import { PluginItem, type ItemOptions } from './item.js';
+import { PluginSeparator } from './items.js';
 /**
  * The player a player action was used on, read from vMenu's Online Players snapshot. The snapshot
  * can be stale and the player may have left, so your server side must check the target still exists

package/dist/types/client/plugin.d.ts

@@ -1,14 +1,20 @@
-import { type RegisterResult } from '../protocol';
-import { type Unsubscribe } from '../signal';
-import { type TextLike } from '../text';
-import type { PluginHost } from './host';
-import { PluginMenu } from './menu';
-import { PluginPlayerActions } from './playerActions';
-import { PluginSettings } from './settings';
-import { PluginThemes } from './themes';
-import { PluginTranslations } from './translations';
+import { type RegisterResult } from '../protocol.js';
+import { type Unsubscribe } from '../signal.js';
+import { type TextLike } from '../text.js';
+import { PluginMenu } from './menu.js';
+import { PluginPlayerActions } from './playerActions.js';
+import { PluginSettings } from './settings.js';
+import { PluginThemes } from './themes.js';
+import { PluginTranslations } from './translations.js';
+/** How a notification is coloured in vMenu's notification area. The plain strings work too. */
+export declare const NotifyStyle: {
+    readonly Info: 'info';
+    readonly Success: 'success';
+    readonly Warning: 'warning';
+    readonly Error: 'error';
+};
 /** How a notification is coloured in vMenu's notification area. */
-export type NotifyStyle = 'info' | 'success' | 'warning' | 'error';
+export type NotifyStyle = (typeof NotifyStyle)[keyof typeof NotifyStyle];
 /** One suggestion row the input box offers while the player types. */
 export interface PromptSuggestion {
     /** What lands in the box when the suggestion is picked. */
@@ -30,7 +36,7 @@ export interface PluginPrompt {
  * settings, then call `connect`. It registers again by itself whenever vMenu restarts, so everything
  * you declared and changed since is restored.
  */
-export declare class VMenuPlugin implements PluginHost {
+export declare class VMenuPlugin {
     private readonly displayName;
     private readonly itemsById;
     private readonly menusById;

package/dist/types/client/themes.d.ts

@@ -1,4 +1,4 @@
-import { type Unsubscribe } from '../signal';
+import { type Unsubscribe } from '../signal.js';
 /** One of vMenu's looks. Hand the `id` to `themes.set` to put the menus in it, and show the `name` to the player. */
 export interface PluginTheme {
     readonly id: string;

package/dist/types/format.d.ts

@@ -1 +1,2 @@
 export declare function formatFloat(value: number): string;
+export declare function int(value: unknown): number;

package/dist/types/iife.d.ts

@@ -1,2 +1,2 @@
-export * from './client/index';
-export { ServerPluginDeclaration, VMenuServer } from './server/index';
+export * from './client/index.js';
+export { ServerPluginDeclaration, VMenuServer } from './server/index.js';

package/dist/types/server/index.d.ts

@@ -1,5 +1,5 @@
-export { version } from '../version';
-export type { Unsubscribe } from '../signal';
-export type { RegisterResult } from '../protocol';
-export { ServerPluginDeclaration } from './declaration';
-export { VMenuServer } from './server';
+export { version } from '../version.js';
+export type { Unsubscribe } from '../signal.js';
+export type { RegisterResult } from '../protocol.js';
+export { ServerPluginDeclaration } from './declaration.js';
+export { VMenuServer } from './server.js';

package/dist/types/server/server.d.ts

@@ -1,6 +1,6 @@
-import { type RegisterResult } from '../protocol';
-import { type Unsubscribe } from '../signal';
-import type { ServerPluginDeclaration } from './declaration';
+import { type RegisterResult } from '../protocol.js';
+import { type Unsubscribe } from '../signal.js';
+import type { ServerPluginDeclaration } from './declaration.js';
 /**
  * The server side entry point for a plugin. Call `register` once at startup; registering again
  * after a vMenu restart happens by itself. Then use `isPlayerAllowed` to check the permissions you declared.

package/dist/vmenu.js

@@ -1,6 +1,5 @@
-// vMenu Enhanced plugin API for JavaScript, built for vMenu Enhanced v0.0.1.
+// vMenu Enhanced plugin API for JavaScript, built for vMenu Enhanced v1.0.9.
 // Copy this file into your resource and load it before your own scripts, see https://docs.vespura.com/vmenu/enhanced/plugins/javascript/
-// Licensed GPL-3.0-or-later, https://github.com/TomGrobbe/vMenu/blob/enhanced/LICENSE.md
 "use strict";
 var vMenu = (() => {
   var __defProp = Object.defineProperty;
@@ -25,6 +24,7 @@ var vMenu = (() => {
   var iife_exports = {};
   __export(iife_exports, {
     Gate: () => Gate,
+    NotifyStyle: () => NotifyStyle,
     PluginBoolSetting: () => PluginBoolSetting,
     PluginButton: () => PluginButton,
     PluginCheckbox: () => PluginCheckbox,
@@ -57,7 +57,7 @@ var vMenu = (() => {
   });
 
   // src/version.ts
-  var version = true ? "0.0.1" : "0.0.0-local";
+  var version = true ? "1.0.9" : "0.0.0-local";
 
   // src/text.ts
   var Text = class _Text {
@@ -82,8 +82,8 @@ var vMenu = (() => {
       if (text === null || text === void 0) {
         return void 0;
       }
-      if (typeof text === "string") {
-        return { text };
+      if (!(text instanceof _Text)) {
+        return { text: String(text) };
       }
       if (!text.isKey) {
         return { text: text.value };
@@ -161,7 +161,7 @@ var vMenu = (() => {
   var getConvar = (name, fallback) => natives.GetConvar(name, fallback) ?? fallback;
   var getKvp = (key) => natives.GetResourceKvpString(key) ?? void 0;
   var setKvp = (key, value) => natives.SetResourceKvp(key, value);
-  var isAceAllowed = (playerSource, object) => natives.IsPlayerAceAllowed(playerSource, object) === true;
+  var isAceAllowed = (playerSource, object) => Boolean(natives.IsPlayerAceAllowed(playerSource, object));
   var log = {
     info: (resource, message) => console.log(`[${resource}] ${message}`),
     warn: (resource, message) => console.warn(`[${resource}] ${message}`),
@@ -186,6 +186,10 @@ var vMenu = (() => {
     const text = value.toFixed(4).replace(/0+$/, "");
     return text.endsWith(".") ? `${text}0` : text;
   }
+  function int(value) {
+    const number = Math.trunc(Number(value));
+    return Number.isFinite(number) ? number : 0;
+  }
 
   // src/protocol.ts
   var PROTOCOL_VERSION = 2;
@@ -734,6 +738,7 @@ var vMenu = (() => {
       return this.node.selectedIndex ?? 0;
     }
     set selectedIndex(value) {
+      value = int(value);
       if (this.selectedIndex === value) {
         return;
       }
@@ -743,6 +748,7 @@ var vMenu = (() => {
     /** Replaces the options, optionally moving the selection at the same time. */
     setOptions(options, selectedIndex) {
       const refs = Text.toRefs(options);
+      selectedIndex = selectedIndex === void 0 ? void 0 : int(selectedIndex);
       if (sameTexts(this.node.options, refs) && (selectedIndex === void 0 || selectedIndex === this.selectedIndex)) {
         return;
       }
@@ -825,6 +831,7 @@ var vMenu = (() => {
       return this.node.position ?? this.min;
     }
     set position(value) {
+      value = int(value);
       if (this.position === value) {
         return;
       }
@@ -867,6 +874,7 @@ var vMenu = (() => {
       return this.node.value ?? "";
     }
     set value(value) {
+      value = String(value);
       if (this.value === value) {
         return;
       }
@@ -884,7 +892,7 @@ var vMenu = (() => {
         case CallbackTypes.DynamicChanging:
           if (typeof callback.left === "boolean") {
             const next = this.changeRequested?.(callback.currentValue ?? "", callback.left);
-            if (typeof next === "string") {
+            if (next !== null && next !== void 0) {
               this.value = next;
             }
           }
@@ -1069,14 +1077,14 @@ var vMenu = (() => {
     addList(text, values, options) {
       const node = this.newNode(EntryTypes.List, text, options);
       node.options = Text.toRefs(values);
-      node.selectedIndex = options?.selectedIndex ?? 0;
+      node.selectedIndex = int(options?.selectedIndex ?? 0);
       return this.attach(new PluginList(node, text), options);
     }
     /** Adds a list that asks for a second press before it does anything. */
     addConfirmList(text, values, options) {
       const node = this.newNode(EntryTypes.ConfirmList, text, options);
       node.options = Text.toRefs(values);
-      node.selectedIndex = options?.selectedIndex ?? 0;
+      node.selectedIndex = int(options?.selectedIndex ?? 0);
       const item = new PluginConfirmList(node, text);
       if (options?.confirmationDescription !== void 0) {
         item.confirmationDescription = options.confirmationDescription;
@@ -1086,16 +1094,16 @@ var vMenu = (() => {
     /** Adds a row with a bar the player drags between `min` and `max`. */
     addSlider(text, min, max, position, options) {
       const node = this.newNode(EntryTypes.Slider, text, options);
-      node.min = min;
-      node.max = max;
-      node.position = position;
+      node.min = int(min);
+      node.max = int(max);
+      node.position = int(position);
       node.showDivider = options?.showDivider ?? false;
       return this.attach(new PluginSlider(node, text), options);
     }
     /** Adds a row whose value your code works out each time the player scrolls it, through `changeRequested`. */
     addDynamicList(text, initialValue, options) {
       const node = this.newNode(EntryTypes.DynamicList, text, options);
-      node.value = initialValue;
+      node.value = String(initialValue);
       return this.attach(new PluginDynamicList(node, text), options);
     }
     /** Adds a row that only shows text, used to split a menu into sections. */
@@ -1132,7 +1140,7 @@ var vMenu = (() => {
         description: Text.toRef(options?.description),
         defaultKey,
         defaultButton: options?.defaultButton,
-        shadowedControl: options?.shadowedControl
+        shadowedControl: options?.shadowedControl === void 0 ? void 0 : int(options.shadowedControl)
       };
       (_a = this.node).keys ?? (_a.keys = []);
       this.node.keys.push(node);
@@ -1148,7 +1156,7 @@ var vMenu = (() => {
      */
     insertAt(index, add) {
       const previous = this.insertIndex;
-      this.insertIndex = clamp(index, 0, this.itemList.length);
+      this.insertIndex = clamp(int(index), 0, this.itemList.length);
       try {
         add();
       } finally {
@@ -1161,7 +1169,7 @@ var vMenu = (() => {
       if (from < 0) {
         return;
       }
-      const to = clamp(index, 0, this.itemList.length - 1);
+      const to = clamp(int(index), 0, this.itemList.length - 1);
       if (to === from) {
         return;
       }
@@ -1375,12 +1383,13 @@ var vMenu = (() => {
       return this.node.selectedIndex ?? 0;
     }
     set selectedIndex(value) {
-      this.node.selectedIndex = value;
-      this.emit({ op: UpdateOps.SetSelectedIndex, itemId: this.id, index: value });
+      this.node.selectedIndex = int(value);
+      this.emit({ op: UpdateOps.SetSelectedIndex, itemId: this.id, index: this.node.selectedIndex });
     }
     /** Replaces the options, optionally moving the selection at the same time. */
     setOptions(options, selectedIndex) {
       this.node.options = Text.toRefs(options);
+      selectedIndex = selectedIndex === void 0 ? void 0 : int(selectedIndex);
       if (selectedIndex !== void 0) {
         this.node.selectedIndex = selectedIndex;
       }
@@ -1430,7 +1439,7 @@ var vMenu = (() => {
     addList(text, values, options) {
       const node = this.newNode(EntryTypes.List, text, options);
       node.options = Text.toRefs(values);
-      node.selectedIndex = options?.selectedIndex ?? 0;
+      node.selectedIndex = int(options?.selectedIndex ?? 0);
       return this.attach(new PluginPlayerList(node, text), options);
     }
     /** Adds a row that only shows text. */
@@ -1509,9 +1518,9 @@ var vMenu = (() => {
         return;
       }
       const current = list.current?.toLowerCase();
-      this.availableValue = (list.themes ?? []).map((theme) => ({
+      this.availableValue = (Array.isArray(list.themes) ? list.themes : []).filter((theme) => typeof theme?.id === "string").map((theme) => ({
         id: theme.id,
-        name: theme.name,
+        name: typeof theme.name === "string" ? theme.name : theme.id,
         isCurrent: theme.id.toLowerCase() === current
       }));
       this.currentIdValue = list.current ?? void 0;
@@ -1550,6 +1559,12 @@ var vMenu = (() => {
   };
 
   // src/client/plugin.ts
+  var NotifyStyle = {
+    Info: "info",
+    Success: "success",
+    Warning: "warning",
+    Error: "error"
+  };
   var CarriedItemOps = /* @__PURE__ */ new Set([
     UpdateOps.SetText,
     UpdateOps.SetDescription,
@@ -1642,7 +1657,7 @@ var vMenu = (() => {
       if (!this.connected) {
         return;
       }
-      emitLocal(PluginEvents.Notify, JSON.stringify({ style, text: Text.toRef(text), durationMs }));
+      emitLocal(PluginEvents.Notify, JSON.stringify({ style, text: Text.toRef(text), durationMs: durationMs === void 0 ? void 0 : int(durationMs) }));
     }
     /** Asks the player for text through vMenu's input box. Resolves to null if they cancelled or the box was unavailable. */
     async getText(title, options) {
@@ -1659,8 +1674,8 @@ var vMenu = (() => {
         requestId,
         prompts: prompts.map((prompt) => ({
           title: Text.toRef(prompt.title),
-          maxLength: prompt.maxLength ?? 60,
-          initial: prompt.initialValue ?? "",
+          maxLength: int(prompt.maxLength ?? 60),
+          initial: String(prompt.initialValue ?? ""),
           suggestions: prompt.suggestions && prompt.suggestions.length > 0 ? prompt.suggestions.map((suggestion) => ({ value: suggestion.value, description: suggestion.description })) : void 0
         }))
       };

package/package.json

@@ -1,44 +1,43 @@
-{
-  "name": "@vespura/vmenu-plugin",
-  "version": "0.0.1",
-  "description": "Build vMenu Enhanced plugins in TypeScript or JavaScript.",
-  "license": "GPL-3.0-or-later",
-  "author": "Tom Grobbe",
-  "homepage": "https://docs.vespura.com/vmenu/enhanced/plugins/",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/TomGrobbe/vMenu.git",
-    "directory": "src/PluginApi/vMenu.Enhanced.JsAPI"
-  },
-  "keywords": [
-    "fivem",
-    "vmenu",
-    "plugin"
-  ],
-  "type": "module",
-  "sideEffects": false,
-  "exports": {
-    "./client": {
-      "types": "./dist/types/client/index.d.ts",
-      "import": "./dist/client.js"
-    },
-    "./server": {
-      "types": "./dist/types/server/index.d.ts",
-      "import": "./dist/server.js"
-    }
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE.md"
-  ],
-  "scripts": {
-    "check": "tsc --noEmit && node scripts/check-contracts.mjs",
-    "build": "node scripts/check-contracts.mjs && node scripts/build.mjs",
-    "prepack": "node scripts/build.mjs"
-  },
-  "devDependencies": {
-    "esbuild": "0.28.2",
-    "typescript": "7.0.2"
-  }
-}
+{
+  "name": "@vespura/vmenu-plugin",
+  "version": "1.0.9",
+  "description": "Build vMenu Enhanced plugins in TypeScript or JavaScript.",
+  "license": "GPL-3.0-or-later",
+  "author": "Tom Grobbe",
+  "homepage": "https://docs.vespura.com/vmenu/enhanced/plugins/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TomGrobbe/vMenu.git",
+    "directory": "src/PluginApi/vMenu.Enhanced.JsAPI"
+  },
+  "keywords": [
+    "fivem",
+    "vmenu",
+    "plugin"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    "./client": {
+      "types": "./dist/types/client/index.d.ts",
+      "import": "./dist/client.js"
+    },
+    "./server": {
+      "types": "./dist/types/server/index.d.ts",
+      "import": "./dist/server.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "scripts": {
+    "check": "tsc --noEmit && node scripts/check-contracts.mjs",
+    "build": "node scripts/check-contracts.mjs && node scripts/build.mjs"
+  },
+  "devDependencies": {
+    "esbuild": "0.28.2",
+    "typescript": "7.0.2"
+  }
+}