[12.x] Adds internal class (#56903)

* Adds internal json schema class

* Apply fixes from StyleCI

* Removes phpstan ignores

* missing type

* missing import

* visibility

* formatting

---------

Co-authored-by: StyleCI Bot <[email protected]>
Co-authored-by: Taylor Otwell <[email protected]>

Author: 3 people

composer.json

@@ -81,6 +81,7 @@
         "illuminate/filesystem": "self.version",
         "illuminate/hashing": "self.version",
         "illuminate/http": "self.version",
+        "illuminate/json-schema": "self.version",
         "illuminate/log": "self.version",
         "illuminate/macroable": "self.version",
         "illuminate/mail": "self.version",
@@ -113,6 +114,7 @@
         "league/flysystem-read-only": "^3.25.1",
         "league/flysystem-sftp-v3": "^3.25.1",
         "mockery/mockery": "^1.6.10",
+        "opis/json-schema": "^2.4.1",
         "orchestra/testbench-core": "^10.6.5",
         "pda/pheanstalk": "^5.0.6|^7.0.0",
         "php-http/discovery": "^1.15",

src/Illuminate/JsonSchema/.gitattributes

@@ -0,0 +1,2 @@
+/.github export-ignore
+.gitattributes export-ignore

src/Illuminate/JsonSchema/.github/workflows/close-pull-request.yml

@@ -0,0 +1,13 @@
+name: Close Pull Request
+
+on:
+  pull_request_target:
+    types: [opened]
+
+jobs:
+  run:
+    runs-on: ubuntu-24.04
+    steps:
+    - uses: superbrothers/close-pull-request@v3
+      with:
+        comment: "Thank you for your pull request. However, you have submitted this PR on the Illuminate organization which is a read-only sub split of `laravel/framework`. Please submit your PR on the https://github.com/laravel/framework repository.<br><br>Thanks!"

src/Illuminate/JsonSchema/JsonSchema.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Illuminate\JsonSchema;
+
+use Closure;
+use Illuminate\JsonSchema\Types\Type;
+
+/**
+ * @method static Types\ObjectType object(Closure|array<string, Types\Type> $properties = [])
+ * @method static Types\IntegerType integer()
+ * @method static Types\NumberType number()
+ * @method static Types\StringType string()
+ * @method static Types\BooleanType boolean()
+ * @method static Types\ArrayType array()
+ */
+class JsonSchema
+{
+    /**
+     * Dynamically pass static methods to the schema instance.
+     */
+    public static function __callStatic(string $name, mixed $arguments): Type
+    {
+        return (new JsonSchemaTypeFactory)->$name(...$arguments);
+    }
+}

src/Illuminate/JsonSchema/JsonSchemaTypeFactory.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Illuminate\JsonSchema;
+
+use Closure;
+
+class JsonSchemaTypeFactory extends JsonSchema
+{
+    /**
+     * Create a new object schema instance.
+     *
+     * @param  (Closure(JsonSchemaTypeFactory): array<string, Types\Type>)|array<string, Types\Type>  $properties
+     */
+    public function object(Closure|array $properties = []): Types\ObjectType
+    {
+        if ($properties instanceof Closure) {
+            $properties = $properties($this);
+        }
+
+        return new Types\ObjectType($properties);
+    }
+
+    /**
+     * Create a new array property instance.
+     */
+    public function array(): Types\ArrayType
+    {
+        return new Types\ArrayType;
+    }
+
+    /**
+     * Create a new string property instance.
+     */
+    public function string(): Types\StringType
+    {
+        return new Types\StringType;
+    }
+
+    /**
+     * Create a new integer property instance.
+     */
+    public function integer(): Types\IntegerType
+    {
+        return new Types\IntegerType;
+    }
+
+    /**
+     * Create a new number property instance.
+     */
+    public function number(): Types\NumberType
+    {
+        return new Types\NumberType;
+    }
+
+    /**
+     * Create a new boolean property instance.
+     */
+    public function boolean(): Types\BooleanType
+    {
+        return new Types\BooleanType;
+    }
+}

src/Illuminate/JsonSchema/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Taylor Otwell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

src/Illuminate/JsonSchema/Serializer.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace Illuminate\JsonSchema;
+
+use RuntimeException;
+
+class Serializer
+{
+    /**
+     * The properties to ignore when serializing.
+     *
+     * @var array<int, string>
+     */
+    protected static array $ignore = ['required'];
+
+    /**
+     * Serialize the given property to an array.
+     *
+     * @return array<string, mixed>
+     */
+    public static function serialize(Types\Type $type): array
+    {
+        /** @var array<string, mixed> $attributes */
+        $attributes = (fn () => get_object_vars($type))->call($type);
+
+        $attributes['type'] = match (get_class($type)) {
+            Types\ArrayType::class => 'array',
+            Types\BooleanType::class => 'boolean',
+            Types\IntegerType::class => 'integer',
+            Types\NumberType::class => 'number',
+            Types\ObjectType::class => 'object',
+            Types\StringType::class => 'string',
+            default => throw new RuntimeException('Unsupported ['.get_class($type).'] type.'),
+        };
+
+        $attributes = array_filter($attributes, static function (mixed $value, string $key) {
+            if (in_array($key, static::$ignore, true)) {
+                return false;
+            }
+
+            return $value !== null;
+        }, ARRAY_FILTER_USE_BOTH);
+
+        if ($type instanceof Types\ObjectType) {
+            if (count($attributes['properties']) === 0) {
+                unset($attributes['properties']);
+            } else {
+                $required = array_keys(array_filter(
+                    $attributes['properties'],
+                    static fn (Types\Type $property) => static::isRequired($property),
+                ));
+
+                if (count($required) > 0) {
+                    $attributes['required'] = $required;
+                }
+
+                $attributes['properties'] = array_map(
+                    static fn (Types\Type $property) => static::serialize($property),
+                    $attributes['properties'],
+                );
+            }
+        }
+
+        if ($type instanceof Types\ArrayType) {
+            if (isset($attributes['items']) && $attributes['items'] instanceof Types\Type) {
+                $attributes['items'] = static::serialize($attributes['items']);
+            }
+        }
+
+        return $attributes;
+    }
+
+    /**
+     * Determine if the given type is required.
+     */
+    protected static function isRequired(Types\Type $type): bool
+    {
+        $attributes = (fn () => get_object_vars($type))->call($type);
+
+        return isset($attributes['required']) && $attributes['required'] === true;
+    }
+}

src/Illuminate/JsonSchema/Types/ArrayType.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace Illuminate\JsonSchema\Types;
+
+class ArrayType extends Type
+{
+    /**
+     * The minimum number of items (inclusive).
+     */
+    protected ?int $minItems = null;
+
+    /**
+     * The maximum number of items (inclusive).
+     */
+    protected ?int $maxItems = null;
+
+    /**
+     * The schema of the items contained in the array.
+     */
+    protected ?Type $items = null;
+
+    /**
+     * Set the minimum number of items (inclusive).
+     */
+    public function min(int $value): static
+    {
+        $this->minItems = $value;
+
+        return $this;
+    }
+
+    /**
+     * Set the maximum number of items (inclusive).
+     */
+    public function max(int $value): static
+    {
+        $this->maxItems = $value;
+
+        return $this;
+    }
+
+    /**
+     * Set the schema for array items.
+     */
+    public function items(Type $type): static
+    {
+        $this->items = $type;
+
+        return $this;
+    }
+
+    /**
+     * Set the type's default value.
+     *
+     * @param  array<int, mixed>  $value
+     */
+    public function default(array $value): static
+    {
+        $this->default = $value;
+
+        return $this;
+    }
+}

src/Illuminate/JsonSchema/Types/BooleanType.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Illuminate\JsonSchema\Types;
+
+class BooleanType extends Type
+{
+    /**
+     * Set the type's default value.
+     */
+    public function default(bool $value): static
+    {
+        $this->default = $value;
+
+        return $this;
+    }
+}

src/Illuminate/JsonSchema/Types/IntegerType.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Illuminate\JsonSchema\Types;
+
+class IntegerType extends Type
+{
+    /**
+     * The minimum value (inclusive).
+     */
+    protected ?int $minimum = null;
+
+    /**
+     * The maximum value (inclusive).
+     */
+    protected ?int $maximum = null;
+
+    /**
+     * Set the minimum value (inclusive).
+     */
+    public function min(int $value): static
+    {
+        $this->minimum = $value;
+
+        return $this;
+    }
+
+    /**
+     * Set the maximum value (inclusive).
+     */
+    public function max(int $value): static
+    {
+        $this->maximum = $value;
+
+        return $this;
+    }
+
+    /**
+     * Set the type's default value.
+     */
+    public function default(int $value): static
+    {
+        $this->default = $value;
+
+        return $this;
+    }
+}