@kevlid/discordmenus 0.1.4 → 0.1.5

package/index.d.ts

@@ -3,10 +3,15 @@ export type GetFunction = (
     options?: Record<string, unknown>,
 ) => unknown | Promise<unknown>;
 
+/** Passed to save(): decoded option key, value, and context (includes category = decoded category key). */
 export type SaveFunction = (
     key: string,
     value: unknown,
-    options?: Record<string, unknown>,
+    options?: Record<string, unknown> & {
+        guildId?: string | null;
+        userId?: string | null;
+        category?: string | null;
+    },
 ) => unknown | Promise<unknown>;
 
 export type PermissionResolvable = string | number | bigint;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kevlid/discordmenus",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Components v2 settings menus for Discord bots",
   "main": "src/index.js",
   "types": "index.d.ts",

package/src/handle/component.js

@@ -77,7 +77,11 @@ async function handleListBranch({
                     arrayClone(await menu.get(optionKey, { guildId, userId })),
                 );
                 addItems.push(shapeObjectListItem(props, {}));
-                await menu.save(optionKey, addItems, { guildId, userId });
+                await menu.save(optionKey, addItems, {
+                    guildId,
+                    userId,
+                    category: menu.getCategoryKey(category),
+                });
                 return updateMessage(
                     await menu.renderListObjectItemPage(optionKey, addItems.length - 1, {
                         ...menuCtx,
@@ -116,11 +120,11 @@ async function handleListBranch({
                 const currentItem = doneItems[itemIndex];
                 if (objectListItemFailsRequired(option, currentItem)) {
                     doneItems.splice(itemIndex, 1);
-                    await menu.save(
-                        optionKey,
-                        normalizeObjectListItems(option.itemConfig.properties, doneItems),
-                        { guildId, userId },
-                    );
+                    await menu.save(optionKey, normalizeObjectListItems(option.itemConfig.properties, doneItems), {
+                        guildId,
+                        userId,
+                        category: menu.getCategoryKey(category),
+                    });
                 }
                 return updateMessage(await renderMenu(menu_key, menuCtx));
             }
@@ -151,7 +155,11 @@ async function handleListBranch({
                 ...asObject(boolItems[itemIndex]),
                 [propertyKey]: newBoolValue,
             });
-            await menu.save(optionKey, boolItems, { guildId, userId });
+            await menu.save(optionKey, boolItems, {
+                guildId,
+                userId,
+                category: menu.getCategoryKey(category),
+            });
             return updateMessage(
                 await menu.renderListObjectItemPage(optionKey, itemIndex, { ...menuCtx, listPage: sub }),
             );
@@ -165,7 +173,11 @@ async function handleListBranch({
                 deleteItems = normalizeObjectListItems(props, deleteItems);
             }
             deleteItems.splice(itemIndex, 1);
-            await menu.save(optionKey, deleteItems, { guildId, userId });
+            await menu.save(optionKey, deleteItems, {
+                guildId,
+                userId,
+                category: menu.getCategoryKey(category),
+            });
             if (objectItems) {
                 if (deleteItems.length <= 0) {
                     return updateMessage(await renderMenu(menu_key, menuCtx));
@@ -222,7 +234,11 @@ async function handleObjectBranch({
         const defaults = boolObjectOption ? objectDefaultsFromKeys(boolObjectOption.options) : {};
         const updatedObj = Object.assign(defaults, baseObj);
         updatedObj[subKey] = newValue;
-        await menu.save(objectKey, updatedObj, { guildId, userId });
+        await menu.save(objectKey, updatedObj, {
+            guildId,
+            userId,
+            category: menu.getCategoryKey(category),
+        });
         return updateMessage(await menu.renderObjectPage(objectKey, objectCtx));
     }
     if (subAction === Presets.subModal) {
@@ -276,7 +292,11 @@ async function handleObjectBranch({
         const obj = asObject(await menu.get(objectKey, { guildId, userId }));
         const items = arrayClone(obj[subKey]);
         items.splice(itemIndex, 1);
-        await menu.save(objectKey, Object.assign({}, obj, { [subKey]: items }), { guildId, userId });
+        await menu.save(objectKey, Object.assign({}, obj, { [subKey]: items }), {
+            guildId,
+            userId,
+            category: menu.getCategoryKey(category),
+        });
         return updateMessage(
             await menu.renderObjectListPage(objectKey, subKey, sub, { ...menuCtx, objectPage }),
         );
@@ -325,7 +345,11 @@ async function handleComponent(interaction, menu, menu_key, renderMenu) {
     } else if (action === OptionTypes.String || action === OptionTypes.Number) {
         result = openModal(await menu.renderModal(values[0], { category, index: page, guildId }));
     } else if (action === OptionTypes.Boolean) {
-        await menu.save(values[0], values[2] === "true", { guildId, userId });
+        await menu.save(values[0], values[2] === "true", {
+            guildId,
+            userId,
+            category: menu.getCategoryKey(category),
+        });
         result = updateMessage(
             await renderMenu(menu_key, { category, index: page, userId, guildId }),
         );
@@ -387,7 +411,11 @@ async function handleComponent(interaction, menu, menu_key, renderMenu) {
                 saveValue = only;
             }
         }
-        await menu.save(optionKey, saveValue, { guildId, userId });
+        await menu.save(optionKey, saveValue, {
+            guildId,
+            userId,
+            category: menu.getCategoryKey(category),
+        });
         result = updateMessage(
             await renderMenu(menu_key, { category, index: page, userId, guildId }),
         );

package/src/handle/modal.js

@@ -65,7 +65,11 @@ async function handleListModal(menu, values, options, rawValue, category, page,
             ...asObject(objItems[objItemIndex]),
             [property.key]: parsedPropertyValue,
         });
-        await menu.save(optionKey, objItems, { guildId, userId });
+        await menu.save(optionKey, objItems, {
+            guildId,
+            userId,
+            category: menu.getCategoryKey(category),
+        });
         return updateMessage(
             await menu.renderListObjectItemPage(optionKey, objItemIndex, { ...menuCtx, listPage: sub }),
         );
@@ -95,7 +99,11 @@ async function handleListModal(menu, values, options, rawValue, category, page,
     } else {
         throw new Error(`Unknown list sub-action "${subAction}"`);
     }
-    await menu.save(optionKey, items, { guildId, userId });
+    await menu.save(optionKey, items, {
+        guildId,
+        userId,
+        category: menu.getCategoryKey(category),
+    });
     return updateMessage(await menu.renderListPage(optionKey, sub, menuCtx));
 }
 
@@ -146,7 +154,11 @@ async function handleObjectModal(menu, values, options, rawValue, category, page
         const defaults = objectDefaultsFromKeys(option.options);
         const updatedObj = Object.assign(defaults, baseObj);
         updatedObj[subKey] = parsedValue;
-        await menu.save(optionKey, updatedObj, { guildId, userId });
+        await menu.save(optionKey, updatedObj, {
+            guildId,
+            userId,
+            category: menu.getCategoryKey(category),
+        });
         return updateMessage(await menu.renderObjectPage(optionKey, menuCtx));
     }
 
@@ -177,7 +189,11 @@ async function handleObjectModal(menu, values, options, rawValue, category, page
         } else {
             throw new Error(`Unknown list action "${listAction}"`);
         }
-        await menu.save(optionKey, Object.assign({}, baseObj, { [subKey]: items }), { guildId, userId });
+        await menu.save(optionKey, Object.assign({}, baseObj, { [subKey]: items }), {
+            guildId,
+            userId,
+            category: menu.getCategoryKey(category),
+        });
         return updateMessage(
             await menu.renderObjectListPage(optionKey, subKey, sub, menuCtx),
         );
@@ -214,7 +230,11 @@ async function handleModal(interaction, menu, menu_key, renderMenu) {
         return handleObjectModal(menu, values, options, rawValue, category, page, guildId, userId);
     }
     if (optionType === OptionTypes.String) {
-        await menu.save(values[0], rawValue, { guildId, userId });
+        await menu.save(values[0], rawValue, {
+            guildId,
+            userId,
+            category: menu.getCategoryKey(category),
+        });
         return updateMessage(await renderMenu(menu_key, menuCtx));
     }
     if (optionType === OptionTypes.Number) {
@@ -222,7 +242,11 @@ async function handleModal(interaction, menu, menu_key, renderMenu) {
         if (Number.isNaN(value)) {
             throw new Error("Invalid number");
         }
-        await menu.save(values[0], value, { guildId, userId });
+        await menu.save(values[0], value, {
+            guildId,
+            userId,
+            category: menu.getCategoryKey(category),
+        });
         return updateMessage(await renderMenu(menu_key, menuCtx));
     }
     throw new Error(`Option type "${optionType}" does not support modal input`);

package/src/menuInstance.js

@@ -58,6 +58,7 @@ class MenuInstance {
     build() {
         const built = this.builder.build();
         this.pages = [];
+        this.categoryKeys = [];
 
         for (const category of built.categories) {
             const categoryPages = [];
@@ -84,6 +85,7 @@ class MenuInstance {
             }
             if (categoryPages.length > 0) {
                 this.pages.push(categoryPages);
+                this.categoryKeys.push(decodeKey(category.key));
             }
         }
 
@@ -108,6 +110,14 @@ class MenuInstance {
         return page.options.find(o => o.key === optionKey) ?? null;
     }
 
+    getCategoryKey(categoryIndex) {
+        this.ensureBuilt();
+        if (typeof categoryIndex !== "number" || categoryIndex < 0 || categoryIndex >= this.categoryKeys.length) {
+            return null;
+        }
+        return this.categoryKeys[categoryIndex] ?? null;
+    }
+
     findOption(optionKey) {
         for (let cat = 0; cat < this.pages.length; cat++) {
             const categoryPages = this.pages[cat];
@@ -214,7 +224,11 @@ class MenuInstance {
             const props = option.itemConfig.properties;
             if (objectListItemsNeedReshape(props, items)) {
                 items = normalizeObjectListItems(props, arrayClone(items));
-                await this.save(option.key, items, { guildId, userId });
+                await this.save(option.key, items, {
+                    guildId,
+                    userId,
+                    category: this.getCategoryKey(category),
+                });
             }
         }
         return renderListPage(this.key, option, items, listPage, userId, category, index);
@@ -292,7 +306,11 @@ class MenuInstance {
             const props = option.itemConfig.properties;
             if (objectListItemsNeedReshape(props, items)) {
                 items = normalizeObjectListItems(props, arrayClone(items));
-                await this.save(option.key, items, { guildId, userId });
+                await this.save(option.key, items, {
+                    guildId,
+                    userId,
+                    category: this.getCategoryKey(category),
+                });
             }
         }
         const safeIndex = items.length <= 0 ? 0 : Math.max(0, Math.min(itemIndex, items.length - 1));