✨ Add ->value() method to easily fetch option values in slash commands (#55)

🎨 Improve slash command method hinting

---------

Co-authored-by: Brandon <[email protected]>

Author: marky291

src/Commands/SlashCommand.php

@@ -150,12 +150,8 @@ protected function clearOptions(): void
 
     /**
      * Retrieve the parsed command options.
-     *
-     * @param  string|null  $key
-     * @param  mixed  $default
-     * @return mixed
      */
-    protected function option($key = null, $default = null)
+    protected function option(?string $key = null, mixed $default = null): mixed
     {
         if (is_null($key) || ! $this->getOptions()) {
             return $this->getOptions();
@@ -164,12 +160,24 @@ protected function option($key = null, $default = null)
         return Arr::get($this->getOptions(), $key, $default);
     }
 
+    /**
+     * Retrieve the option value.
+     */
+    public function value(?string $option = null, mixed $default = null): mixed
+    {
+        $options = $this->flattenOptions($this->getOptions());
+
+        if (is_null($option)) {
+            return $options;
+        }
+
+        return $options[$option] ?? $default;
+    }
+
     /**
      * Set the command options.
-     *
-     * @return array
      */
-    public function options()
+    public function options(): array
     {
         return [];
     }
@@ -210,10 +218,8 @@ public function getPermissions(): ?string
 
     /**
      * Retrieve the slash command options.
-     *
-     * @return array
      */
-    public function getRegisteredOptions()
+    public function getRegisteredOptions(): ?array
     {
         if ($this->registeredOptions) {
             return $this->registeredOptions;
@@ -230,4 +236,31 @@ public function getRegisteredOptions()
             : new DiscordOption($this->discord(), $option)
         )->map(fn ($option) => $option->setName(Str::slug($option->name)))->all();
     }
+
+    /**
+     * Flatten the options into dot notated keys.
+     */
+    protected function flattenOptions(array $options, ?string $parent = null): array
+    {
+        return collect($options)->flatMap(function ($option) use ($parent) {
+            $key = $parent ? "{$parent}.{$option['name']}" : $option['name'];
+
+            if (is_array($option) && isset($option['options'])) {
+                $options = $this->flattenOptions($option['options'], $key);
+
+                if (array_key_exists('value', $option)) {
+                    return [
+                        ...[$key => $option['value']],
+                        ...$options,
+                    ];
+                }
+
+                return $options;
+            }
+
+            return isset($option['value'])
+                ? [$key => $option['value']]
+                : [];
+        })->all();
+    }
 }