Add Hashed Type to Map (#59)

phpstan.neon

@@ -8,6 +8,8 @@ parameters:
     # Determines the level of checking. 5 is a good starter point 8 is max
     level: 5
 
+    checkGenericClassInNonGenericObjectType: false
+
     ignoreErrors:
         - '#Call to an undefined method ReflectionType::getName\(\)#'
 

src/Actions/BuildModelDetails.php

@@ -9,6 +9,10 @@
 use ReflectionException;
 use Symfony\Component\Finder\SplFileInfo;
 
+/**
+ * @template TKey
+ * @template TValue{reflectionModel: \ReflectionClass, name: string, columns: \Illuminate\Support\Collection, nonColumns: \Illuminate\Support\Collection, relations: \Illuminate\Support\Collection, interfaces: \Illuminate\Support\Collection, imports: \Illuminate\Support\Collection}
+ */
 class BuildModelDetails
 {
     use ClassBaseName;
@@ -17,7 +21,7 @@ class BuildModelDetails
     /**
      * Build the model details.
      *
-     * @return array
+     * @return array<TKey, TValue>|null
      *
      * @throws ReflectionException
      */
@@ -84,6 +88,8 @@ public function __invoke(SplFileInfo $modelFile, bool $resolveAbstract = false):
     }
 
     /**
+     * @return array<TKey, TValue>|null
+     *
      * @throws NestedCommandException
      */
     private function getModelDetails(SplFileInfo $modelFile, bool $resolveAbstract): ?array

src/Actions/GenerateCliOutput.php

@@ -18,8 +18,14 @@ class GenerateCliOutput
 
     protected string $indent = '';
 
+    /**
+     * @var array<int, ReflectionClass>
+     */
     protected array $enumReflectors = [];
 
+    /**
+     * @var array<int,  array<string, mixed>>
+     */
     protected array $imports = [];
 
     /**

src/Actions/GenerateJsonOutput.php

@@ -5,12 +5,19 @@
 use FumeApp\ModelTyper\Traits\ClassBaseName;
 use FumeApp\ModelTyper\Traits\ModelRefClass;
 use Illuminate\Support\Collection;
+use ReflectionClass;
 use Symfony\Component\Finder\SplFileInfo;
 
 class GenerateJsonOutput
 {
+    /**
+     * @var array<string, array<string, mixed>>
+     */
     protected array $output = [];
 
+    /**
+     * @var array<int, ReflectionClass>
+     */
     protected array $enumReflectors = [];
 
     use ClassBaseName;

src/Actions/GetModels.php

@@ -14,6 +14,8 @@ class GetModels
     /**
      * Return collection of models.
      *
+     * @param  array<string>|null  $includedModels
+     * @param  array<string>|null  $excludedModels
      * @return Collection<int, SplFileInfo>
      */
     public function __invoke(?string $model = null, ?array $includedModels = null, ?array $excludedModels = null): Collection

src/Actions/RunModelShowCommand.php

@@ -28,6 +28,8 @@ public function __construct(Application $app = null)
      *
      * @see https://github.com/laravel/framework/blob/9.x/src/Illuminate/Foundation/Console/ShowModelCommand.php
      *
+     * @return array<string, mixed>
+     *
      * @throws NestedCommandException
      */
     public function __invoke(string $model, bool $resolveAbstract = false): array

src/Actions/WriteColumnAttribute.php

@@ -16,7 +16,8 @@ class WriteColumnAttribute
     /**
      * Get model columns and attributes to the output.
      *
-     * @param  array  $attribute <{name: string, type: string, increments: bool, nullable: bool, default: mixed, unique: bool, fillable: bool, hidden: bool, appended: mixed, cast: string}>
+     * @param  array{name: string, type: string, increments: bool, nullable: bool, default: mixed, unique: bool, fillable: bool, hidden?: bool, appended: mixed, cast?: string|null, forceType?: bool}  $attribute
+     * @return array{array{name: string, type: string}, ReflectionClass|null}|array{string, ReflectionClass|null}|array{null, null}
      */
     public function __invoke(ReflectionClass $reflectionModel, array $attribute, string $indent = '', bool $jsonOutput = false, bool $noHidden = false, bool $timestampsDate = false, bool $optionalNullables = false): array
     {

src/Actions/WriteEnumConst.php

@@ -8,6 +8,8 @@ class WriteEnumConst
 {
     /**
      * Write the enum const to the output.
+     *
+     * @return array{type: string, name: string}|string
      */
     public function __invoke(ReflectionClass $reflection, string $indent = '', bool $jsonOutput = false): array|string
     {

src/Actions/WriteRelationship.php

@@ -12,7 +12,8 @@ class WriteRelationship
     /**
      * Write the relationship to the output.
      *
-     * @param  array  $relation <{name: string, type: string, related:string}>
+     * @param  array{name: string, type: string, related:string}  $relation
+     * @return array{type: string, name: string}|string
      */
     public function __invoke(array $relation, string $indent = '', bool $jsonOutput = false, bool $optionalRelation = false, bool $plurals = false): array|string
     {

src/Constants/TypescriptMappings.php

@@ -4,6 +4,9 @@
 
 class TypescriptMappings
 {
+    /**
+     * @var array<string, string>
+     */
     public static array $mappings = [
         'bigint' => 'number',
         'int' => 'number',
@@ -20,5 +23,6 @@ class TypescriptMappings
         'array' => 'string[]',
         'point' => 'Point',
         'guid' => 'string',
+        'hashed' => 'string',
     ];
 }

src/Overrides/ErrorEmittingConsoleComponentFactory.php

@@ -24,8 +24,10 @@ public function __construct(Factory $factory, bool $throwExceptions = false)
 
     /**
      * Reroute calls to underlying instance unless intercepted by override.
+     *
+     * @param  array<mixed>  $arguments
      */
-    public function __call($name, $arguments)
+    public function __call(string $name, array $arguments): mixed
     {
         if ($name === 'error') {
             return $this->emitError(...$arguments);

src/Traits/ModelRefClass.php

@@ -9,7 +9,7 @@ trait ModelRefClass
     /**
      * Get the reflection interface.
      *
-     * @param  array  $info - The model details from the model:show command.
+     * @param  array<string, mixed>  $info
      */
     public function getRefInterface(array $info): ReflectionClass
     {

src/TypescriptInterface.php

@@ -4,6 +4,12 @@
 
 class TypescriptInterface
 {
+    /**
+     * @param  array<string, mixed>  $columns
+     * @param  array<string, mixed>  $mutators
+     * @param  array<string, mixed>  $relations
+     * @param  array<string, mixed>  $interfaces
+     */
     public function __construct(
         public string $name,
         public array $columns,