feat: laravel 12 compatibility, new JS API, configuration changes (#7)

* chore: don’t auto update dependencies

* ci: test laravel 12

* feat: allow laravel 12

* ci: use testbench 10

* chore: update dependencies

* feat: use new JS API

* feat: merge url with configuration

* chore: make compatible with laravel 12

* fix: tests

* chore: use testbench 9 with laravel 11

* chore: make testbench requirement work with laravel 10/11/12

* chore: allow older version of pest php laravel plugin

* chore: allow older pestphp versions

* feat: make /scalar the default path

* chore: whitespace

Author: hanspagel

.github/workflows/dependabot-auto-merge.yml

@@ -18,9 +18,12 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest]
         php: [8.3, 8.2]
-        laravel: [11.*, 10.*]
+        laravel: [12.*, 11.*, 10.*]
         stability: [prefer-lowest, prefer-stable]
         include:
+          - laravel: 12.*
+            testbench: 10.*
+            carbon: ^3.0
           - laravel: 11.*
             testbench: 9.*
             carbon: ^2.63

.github/workflows/run-tests.yml

@@ -19,15 +19,15 @@
     "require": {
         "php": "^8.2",
         "spatie/laravel-package-tools": "^1.16",
-        "illuminate/contracts": "^10.0||^11.0"
+        "illuminate/contracts": "^10.0||^11.0||^12.0"
     },
     "require-dev": {
         "laravel/pint": "^1.14",
-        "nunomaduro/collision": "^8.1.1||^7.10.0",
-        "orchestra/testbench": "^9.0.0||^8.22.0",
-        "pestphp/pest": "^2.34",
-        "pestphp/pest-plugin-arch": "^2.7",
-        "pestphp/pest-plugin-laravel": "^2.3"
+        "nunomaduro/collision": "^8.7.0||^7.10.0",
+        "orchestra/testbench": "^8.0||^9.0||^10.0",
+        "pestphp/pest": "^2.3.4||^3.7.4",
+        "pestphp/pest-plugin-arch": "^2.7.0||^3.0.0",
+        "pestphp/pest-plugin-laravel": "^2.3.0||^3.1.0"
     },
     "autoload": {
         "psr-4": {

composer.json

@@ -24,7 +24,7 @@
     | affect the paths of its internal API that aren't exposed to users.
     |
     */
-    'path' => '/reference',
+    'path' => '/scalar',
 
     /*
     |--------------------------------------------------------------------------
@@ -87,36 +87,48 @@
         // 'saturn',
         // 'solarized',
         // 'none',
+
         /** The layout to use for the references */
         'layout' => 'modern',
+
         /** URL to a request proxy for the API client */
-        'proxy' => 'https://proxy.scalar.com',
+        'proxyUrl' => 'https://proxy.scalar.com',
+
         /** Whether to show the sidebar */
         'showSidebar' => true,
+
         /**
          * Whether to show models in the sidebar, search, and content.
          */
         'hideModels' => false,
+
         /**
          * Whether to show the “Download OpenAPI Document” button
          */
         'hideDownloadButton' => false,
+
         /**
          * Whether to show the “Test Request” button
          */
         'hideTestRequestButton' => false,
+
         /**
          * Whether to show the sidebar search bar
          */
         'hideSearch' => false,
+
         /** Whether dark mode is on or off initially (light mode) */
         'darkMode' => false,
+
         /** forceDarkModeState makes it always this state no matter what*/
         'forceDarkModeState' => 'dark',
+
         /** Whether to show the dark mode toggle */
         'hideDarkModeToggle' => false,
+
         /** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
         'searchHotKey' => 'k',
+
         /**
          * If used, passed data will be added to the HTML header
          *
@@ -125,50 +137,58 @@
         'metaData' => [
             'title' => config('app.name').' API Reference',
         ],
+
         /**
          * Path to a favicon image
          *
          * @example '/favicon.svg'
          */
         'favicon' => '',
+
         /**
          * List of httpsnippet clients to hide from the clients menu
          * By default hides Unirest, pass `[]` to show all clients
          */
         'hiddenClients' => [
 
         ],
+
         /** Determine the HTTP client that’s selected by default */
         'defaultHttpClient' => [
             'targetId' => 'shell',
             'clientKey' => 'curl',
         ],
+
         /** Custom CSS to be added to the page */
-        'customCss' => '',
+        // 'customCss' => '',
+
         /** Prefill authentication */
-        'authentication' => [
-            // TODO
-        ],
+        // 'authentication' => [
+        //     // TODO
+        // ],
+
         /**
          * The baseServerURL is used when the spec servers are relative paths and we are using SSR.
          * On the client we can grab the window.location.origin but on the server we need
          * to use this prop.
          */
-        'baseServerURL' => '',
+        // 'baseServerURL' => '',
+
         /**
          * List of servers to override the openapi spec servers
          */
-        'servers' => null,
         // 'servers' => [
         //     [
         //         'url' => 'https://api.scalar.com',
         //         'description' => 'Production server',
         //     ],
         // ],
+
         /**
          * We’re using Inter and JetBrains Mono as the default fonts. If you want to use your own fonts, set this to false.
          */
         'withDefaultFonts' => true,
+
         /**
          * By default we only open the relevant tag based on the url, however if you want all the tags open by default then set this configuration option :)
          */

config/scalar.php

@@ -1,12 +1,11 @@
 @extends('scalar::layout')
 
 @section('content')
-    <script id="api-reference" data-url="{{ \Scalar\Scalar::url() }}"></script>
+    <div id="app"></div>
+
+    <script src="{{ \Scalar\Scalar::cdn() }}"></script>
 
     <script>
-        document.getElementById('api-reference').dataset.configuration =
-            JSON.stringify({!! \Scalar\Scalar::configuration() !!})
+       Scalar.createApiReference('#app', {!! \Scalar\Scalar::configuration() !!})
     </script>
-
-    <script src="{{ \Scalar\Scalar::cdn() }}"></script>
 @endsection

resources/views/reference.blade.php

@@ -38,6 +38,7 @@ public static function configuration()
         /** Render as JSON */
         return collect($configuration)->merge([
             'theme' => $theme,
+            'url' => config('scalar.url'),
         ]);
     }
 }

src/Scalar.php

@@ -23,15 +23,15 @@
     $response = $this->get(config('scalar.path'));
 
     $response->assertOk()
-        ->assertSee('data-url')
-        ->assertSee(config('scalar.url'));
+        ->assertSee('Scalar.createApiReference')
+        ->assertSee(str_replace('/', '\/', config('scalar.url')));
 });
 
 it('contains the jsDelivr URL', function () {
     $response = $this->get(config('scalar.path'));
 
     $response->assertOk()
-        ->assertSee('https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json');
+        ->assertSee('https:\/\/cdn.jsdelivr.net\/npm\/@scalar\/galaxy\/dist\/latest.json');
 });
 
 it('reflects changes in the config', function () {
@@ -41,7 +41,7 @@
     // Modify config
     config()->set('scalar.cdn', 'https://example.com/cdn');
 
-    $response = $this->get('/reference');
+    $response = $this->get('/scalar');
 
     $response->assertOk()
         ->assertSee('https://example.com/cdn')