generator-folklore 3.0.38 → 3.0.40

package/lib/generators/build/index.js

@@ -23,7 +23,7 @@ class AppGenerator extends _generator.default {
     });
     this.option('entry-path', {
       type: String,
-      defaults: './src/index.js'
+      defaults: './src/index.ts'
     });
     this.option('build-path', {
       type: String,

package/lib/generators/eslint/index.js

@@ -27,13 +27,11 @@ class EslintGenerator extends _generator.default {
         this.addDevDependencies({
           '@babel/eslint-parser': '^7.18.9',
           '@babel/preset-typescript': '^7.26.0',
-          '@eslint-react/eslint-plugin': '^1.53.0',
-          'eslint-plugin-react': '^7.37.5',
+          '@eslint-react/eslint-plugin': '^2.0.0',
           eslint: '^9.36.0',
           'eslint-config-prettier': '^10.1.8',
           'eslint-plugin-formatjs': '^5.4.0',
           'eslint-plugin-import': '^2.32.0',
-          'eslint-plugin-jsx-a11y': '^6.10.2',
           'eslint-plugin-prettier': '^5.5.4',
           typescript: '^5.7.3',
           'typescript-eslint': '^8.25.0'

package/lib/generators/eslint/templates/.eslint.config.js

@@ -1,14 +1,13 @@
-const reactPlugin = require('eslint-plugin-react');
-const formatjs = require('eslint-plugin-formatjs');
-const globals = require('globals');
-const babelParser = require('@babel/eslint-parser');
-const importPlugin = require('eslint-plugin-import');
-const js = require('@eslint/js');
-const tseslint = require('typescript-eslint');
-const eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended');
-const eslintReact = require('@eslint-react/eslint-plugin');
+import formatjs from 'eslint-plugin-formatjs';
+import globals from 'globals';
+import babelParser from '@babel/eslint-parser';
+import importPlugin from 'eslint-plugin-import';
+import js from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import eslintReact from '@eslint-react/eslint-plugin';
 
-module.exports = tseslint.config(
+export default tseslint.config(
     {
         files: ['**/*.js', '**/*.jsx', '**/*.ts', '**/*.tsx'],
     },
@@ -18,7 +17,7 @@ module.exports = tseslint.config(
     {
         settings: {
             react: {
-                defaultVersion: '18',
+                defaultVersion: '19',
             },
         },
         languageOptions: {
@@ -51,8 +50,6 @@ module.exports = tseslint.config(
     importPlugin.flatConfigs.typescript,
     importPlugin.flatConfigs.recommended,
     formatjs.configs.recommended,
-    reactPlugin.configs.flat.recommended,
-    reactPlugin.configs.flat['jsx-runtime'],
     eslintPluginPrettierRecommended,
     {
         rules: {

package/lib/generators/html-project/index.js

@@ -109,6 +109,10 @@ class HTMLProjectGenerator extends _generator.default {
       'skip-install': true,
       quiet: true
     });
+    this.composeWith('folklore:postcss', {
+      quiet: true,
+      'skip-install': true
+    });
     this.composeWith('folklore:svgo', {
       quiet: true,
       'skip-install': true
@@ -142,11 +146,10 @@ class HTMLProjectGenerator extends _generator.default {
         quiet: true
       });
     }
-    console.log(srcPath, jsSrcPath, _path.default.join(jsSrcPath, 'index.js'), _path.default.join(srcPath, 'index.html.ejs'));
     this.log('merging with folklore build');
     this.composeWith('folklore:build', {
       'src-path': srcPath,
-      'entry-path': _path.default.join(jsSrcPath, 'index.js'),
+      'entry-path': _path.default.join(jsSrcPath, 'index.ts'),
       'html-path': _path.default.join(srcPath, 'index.html.ejs'),
       'build-path': destPath,
       'empty-path': destPath,

package/lib/generators/laravel/templates/laravel/resources/views/layouts/main.blade.php

@@ -11,7 +11,7 @@
     <meta name="language" content="{{ $locale }}">
 
 	<title>@yield('title')</title>
-	<meta name="description" content="@yield('description')" data-react-helmet="true">
+	<meta name="description" content="@yield('description')">
 
 	<link rel="shortcut icon" href="{{ asset('favicon.ico') }}" type="image/x-ico">
 	<link rel="icon" href="{{ asset('favicon.png') }}" type="image/png">
@@ -20,12 +20,12 @@
         <!-- Open Graph meta -->
 		<meta property="og:locale" content="{{ $locale }}_CA">
 		@hasSection('thumbnail')
-			<meta property="og:image" content="@yield('thumbnail')" data-react-helmet="true">
+			<meta property="og:image" content="@yield('thumbnail')">
 		@endif
-		<meta property="og:title" content="@yield('title')" data-react-helmet="true">
-		<meta property="og:type" content="website" data-react-helmet="true">
-		<meta property="og:description" content="@yield('description')" data-react-helmet="true">
-		<meta property="og:url" content="{{ Request::url() }}" data-react-helmet="true">
+		<meta property="og:title" content="@yield('title')">
+		<meta property="og:type" content="website">
+		<meta property="og:description" content="@yield('description')">
+		<meta property="og:url" content="{{ Request::url() }}">
     @show
 
     @section('head:analytics')

package/lib/generators/laravel-panneau/index.js

@@ -56,11 +56,11 @@ class LaravelPanneauGenerator extends _generator.default {
       },
       packageJSON() {
         this.addDependencies({
-          '@panneau/app': '^3.0.293',
-          '@panneau/core': '^3.0.292',
-          '@panneau/data': '^3.0.292',
-          '@panneau/field-text': '^3.0.293',
-          '@panneau/field-localized': '^3.0.293'
+          '@panneau/app': '^4.0.0',
+          '@panneau/core': '^4.0.0',
+          '@panneau/data': '^4.0.0',
+          '@panneau/field-text': '^4.0.0',
+          '@panneau/field-localized': '^4.0.0'
         });
       },
       config() {
@@ -96,8 +96,8 @@ class LaravelPanneauGenerator extends _generator.default {
         this.fs.copyTpl(source, destination, {});
       },
       indexJs() {
-        const source = this.templatePath('index.js');
-        const destination = this.destinationPath('resources/assets/js/index.js');
+        const source = this.templatePath('index.ts');
+        const destination = this.destinationPath('resources/assets/js/index.ts');
         this.fs.copyTpl(source, destination, {});
       },
       files() {

package/lib/generators/laravel-panneau/templates/app/Http/Middleware/Authenticate.php

@@ -15,8 +15,7 @@ class Authenticate extends Middleware
     protected function redirectTo($request)
     {
         if (!$request->expectsJson()) {
-            $routeWithLocale =
-                route('panneau.auth.login') .
+            $routeWithLocale = route('login') .
                 '?' .
                 http_build_query([
                     'next' => $request->fullUrl(),

package/lib/generators/laravel-panneau/templates/app/Panneau/PanneauServiceProvider.php

@@ -45,8 +45,6 @@ class PanneauServiceProvider extends BaseServiceProvider
                 return config('locale.locales');
             });
 
-            UploadField::setEndpoint(route('panneau.upload'));
-
             PageSlugField::setRoutesResolver(function ($locale) {
                 return [
                     'page' => url()->routeForReactRouter($locale . '.page', [

package/lib/generators/laravel-panneau/templates/{index.js → index.ts}

@@ -1,13 +1,24 @@
-import React from 'react';
+import React, { type ComponentType } from 'react';
 import { createRoot } from 'react-dom/client';
 
 import shouldPolyfill from './polyfills/should';
 
-function getAppProps() {
-    return window.props || {};
+interface Props {
+    isPanneau?: boolean;
+    [key: string]: unknown;
 }
 
-function renderApp(Container, props) {
+declare global {
+    interface Window {
+        props?: Props;
+    }
+}
+
+function getAppProps(): Props {
+    return window.props || ({} as Props);
+}
+
+function renderApp(Container: ComponentType<Props>, props: Props) {
     const element = document.getElementById('app');
     const container = React.createElement(Container, props);
     const strictMode = React.createElement(React.StrictMode, {}, container);
@@ -15,7 +26,7 @@ function renderApp(Container, props) {
     root.render(strictMode);
 }
 
-function loadContainer({ isPanneau = false }) {
+function loadContainer({ isPanneau = false }: Props) {
     return isPanneau
         ? import('./components/Panneau').then(({ default: Container }) => Container)
         : import('./components/App').then(({ default: Container }) => Container);

package/lib/generators/laravel-panneau/templates/resources/assets/js/components/{Panneau.jsx → Panneau.tsx}

@@ -1,30 +1,30 @@
+import '@panneau/app/assets/css/styles.css';
+
 import { getCSRFHeaders } from '@folklore/fetch';
 import Panneau from '@panneau/app';
+import { PanneauDefinition } from '@panneau/core';
 import { FIELDS_NAMESPACE } from '@panneau/core/contexts';
-import PropTypes from 'prop-types';
-import React, { useState, useEffect } from 'react';
+import { useEffect, useState } from 'react';
 
 import * as fieldsComponents from './panneau/fields';
 
-import '@panneau/app/assets/css/styles.css';
-import '@panneau/themes/assets/css/styles.css';
-import '@panneau/themes/assets/css/vendor.css';
+import '../../styles/panneau.css';
 
-const propTypes = {
-    definition: PropTypes.object.isRequired, // eslint-disable-line react/forbid-prop-types
-    baseUrl: PropTypes.string.isRequired,
-    uploadEndpoint: PropTypes.string,
-    user: PropTypes.object,
-    statusCode: PropTypes.string,
-};
+export interface PanneauContainerProps {
+    definition: PanneauDefinition;
+    baseUrl: string;
+    uploadEndpoint?: string;
+    user?: User | null;
+    statusCode?: number | null;
+}
 
-const defaultProps = {
-    user: null,
-    uploadEndpoint: '/panneau/upload',
-    statusCode: null,
-};
-
-const PanneauContainer = ({ definition, user, baseUrl, uploadEndpoint, statusCode }) => {
+const PanneauContainer = ({
+    definition,
+    user = null,
+    baseUrl,
+    uploadEndpoint = '/panneau/upload',
+    statusCode = null,
+}: PanneauContainerProps) => {
     const { routes = {} } = definition;
     const isAuthorized = statusCode !== 401 && statusCode !== 403;
     const [localeLoaded, setLocaleLoaded] = useState(false);
@@ -62,7 +62,4 @@ const PanneauContainer = ({ definition, user, baseUrl, uploadEndpoint, statusCod
     ) : null;
 };
 
-PanneauContainer.propTypes = propTypes;
-PanneauContainer.defaultProps = defaultProps;
-
 export default PanneauContainer;

package/lib/generators/laravel-panneau/templates/resources/assets/js/components/panneau/fields/{PageSlug.jsx → PageSlug.tsx}

@@ -1,45 +1,67 @@
-/* eslint-disable react/jsx-props-no-spreading */
+import { generatePath } from '@folklore/routes';
 import { useFormValue } from '@panneau/core/contexts';
 import TextField from '@panneau/field-text';
 import classNames from 'classnames';
-import PropTypes from 'prop-types';
-import React from 'react';
-import { generatePath } from '@folklore/routes';
 
-const propTypes = {
-    fieldLocale: PropTypes.string,
-    value: PropTypes.string,
-    className: PropTypes.string,
-    routes: PropTypes.objectOf(PropTypes.string).isRequired,
-};
+type LocalizedSlug = Record<string, string | null | undefined>;
 
-const defaultProps = {
-    fieldLocale: null,
-    value: null,
-    className: null,
-};
+interface PageParent {
+    slug?: LocalizedSlug | null;
+}
+
+interface PageFormValue {
+    parent?: PageParent | null;
+    handle?: string | null;
+}
+
+interface PageSlugRoutes {
+    page?: string | null;
+    page_with_parent?: string | null;
+}
 
-const PageSlugField = ({ routes, fieldLocale, className, value, ...props }) => {
-    const page = useFormValue();
+interface PageSlugFieldProps {
+    fieldLocale?: string | null;
+    value?: string | null;
+    className?: string | null;
+    routes: PageSlugRoutes;
+    [key: string]: unknown;
+}
+
+const PageSlugField = ({
+    routes,
+    fieldLocale = null,
+    className = null,
+    value = null,
+    ...props
+}: PageSlugFieldProps) => {
+    const page = useFormValue() as PageFormValue | null;
     const { parent = null, handle = null } = page || {};
-    const { slug: parentSlug } = parent || {};
+    const { slug: parentSlug = null } = parent || {};
     const { page: pageRoute = null, page_with_parent: pageWithParentRoute = null } = routes || {};
+
     let url =
         pageRoute !== null
             ? generatePath(pageRoute, {
                   page: 'REPLACE',
               })
             : null;
+
     if (parent !== null && pageWithParentRoute !== null) {
+        const localizedParentSlug =
+            fieldLocale !== null && parentSlug !== null ? parentSlug[fieldLocale] || null : null;
         url = generatePath(pageWithParentRoute, {
-            parent: parentSlug !== null ? parentSlug[fieldLocale] || null : null,
+            parent: localizedParentSlug,
             page: 'REPLACE',
         });
     }
+
     if (handle === 'home') {
         url = `/${fieldLocale}`;
     }
 
+    const fieldClassName =
+        className !== null ? classNames('flex-nowrap', className) : classNames('flex-nowrap');
+
     return (
         <TextField
             prepend={
@@ -50,19 +72,11 @@ const PageSlugField = ({ routes, fieldLocale, className, value, ...props }) => {
                       )}`
                     : null
             }
-            className={classNames([
-                'flex-nowrap',
-                {
-                    [className]: className !== null,
-                },
-            ])}
+            className={fieldClassName}
             value={handle === 'home' ? null : value}
             {...props}
         />
     );
 };
 
-PageSlugField.propTypes = propTypes;
-PageSlugField.defaultProps = defaultProps;
-
 export default PageSlugField;

package/lib/generators/laravel-panneau/templates/resources/assets/js/components/panneau/fields/PageSlugLocalized.tsx

@@ -0,0 +1,42 @@
+import { useFormValue } from '@panneau/core/contexts';
+import LocalizedField from '@panneau/field-localized';
+import get from 'lodash/get';
+import isEmpty from 'lodash/isEmpty';
+import { useMemo } from 'react';
+import slugify from 'slugify';
+
+type LocalizedValue = Record<string, string>;
+
+interface PageTitleValue {
+    title?: LocalizedValue | null;
+}
+
+interface PageSlugLocalizedFieldProps {
+    value?: LocalizedValue | null;
+    locales?: string[] | null;
+    [key: string]: unknown;
+}
+
+const PageSlugField = ({ value = null, locales = null, ...props }: PageSlugLocalizedFieldProps) => {
+    const page = useFormValue() as PageTitleValue | null;
+    const { title = null } = page || {};
+    const finalValue = useMemo(() => {
+        if (locales === null) {
+            return value;
+        }
+        return locales.reduce<LocalizedValue | null>(
+            (newValue, key) =>
+                newValue === null || isEmpty(newValue[key])
+                    ? {
+                          ...newValue,
+                          [key]: slugify(get(title, key, '')),
+                      }
+                    : newValue,
+            value,
+        );
+    }, [locales, value, title]);
+
+    return <LocalizedField value={finalValue} locales={locales || []} {...props} />;
+};
+
+export default PageSlugField;

package/lib/generators/laravel-project/index.js

@@ -217,6 +217,10 @@ class LaravelProjectGenerator extends _generator.default {
       quiet: true,
       'skip-install': true
     });
+    this.composeWith('folklore:postcss', {
+      quiet: true,
+      'skip-install': true
+    });
     this.composeWith('folklore:react-app', {
       'project-name': this.options['project-name'],
       path: jsSrcPath,
@@ -233,7 +237,7 @@ class LaravelProjectGenerator extends _generator.default {
     });
     this.composeWith('folklore:build', {
       'src-path': assetsPath,
-      'entry-path': _path.default.join(jsSrcPath, 'index.js'),
+      'entry-path': _path.default.join(jsSrcPath, 'index.ts'),
       'build-path': publicPath,
       quiet: true,
       'skip-install': true
@@ -313,7 +317,7 @@ class LaravelProjectGenerator extends _generator.default {
           },
           extra: {
             laravel: {
-              'dont-discover': ['laravel/telescope', 'folklore/laravel-folklore']
+              'dont-discover': ['laravel/telescope']
             }
           },
           'minimum-stability': 'dev',
@@ -324,11 +328,11 @@ class LaravelProjectGenerator extends _generator.default {
         this.packageJson.merge({
           scripts: {
             clean: 'rm -rf public/static && rm -rf public/precache-*',
-            'build:scripts': 'flklr build --load-env ./resources/assets/js/index.js',
+            'build:scripts': 'flklr build --load-env ./resources/assets/js/index.ts',
             'build:views': 'php artisan assets:view',
             build: 'npm run clean && npm run build:scripts && npm run build:views',
             start: 'npm run server',
-            server: 'flklr serve --load-env ./resources/assets/js/index.js'
+            server: 'flklr serve --load-env ./resources/assets/js/index.ts'
           }
         });
       },

package/lib/generators/laravel-project/templates/env

@@ -4,7 +4,19 @@ APP_KEY=
 APP_DEBUG=true
 APP_URL=<%= url %>
 
+APP_LOCALE=en
+APP_FALLBACK_LOCALE=en
+APP_FAKER_LOCALE=en_US
+
+APP_MAINTENANCE_DRIVER=file
+# APP_MAINTENANCE_STORE=database
+
+# PHP_CLI_SERVER_WORKERS=4
+
+BCRYPT_ROUNDS=12
+
 LOG_CHANNEL=stack
+LOG_STACK=single
 LOG_DEPRECATIONS_CHANNEL=null
 LOG_LEVEL=debug
 
@@ -15,27 +27,40 @@ DB_DATABASE=<%= db_name %>
 DB_USERNAME=<%= db_username %>
 DB_PASSWORD=<%= db_password %>
 
-BROADCAST_DRIVER=log
-CACHE_DRIVER=file
-FILESYSTEM_DISK=local
-QUEUE_CONNECTION=sync
 SESSION_DRIVER=file
 SESSION_LIFETIME=120
+SESSION_ENCRYPT=false
+SESSION_PATH=/
+SESSION_DOMAIN=null
+
+BROADCAST_CONNECTION=log
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=database
+
+CACHE_STORE=file
+# CACHE_PREFIX=
 
 MEMCACHED_HOST=127.0.0.1
 
+REDIS_CLIENT=phpredis
 REDIS_HOST=127.0.0.1
 REDIS_PASSWORD=null
 REDIS_PORT=6379
 
-MAIL_MAILER=smtp
-MAIL_HOST=mailhog
-MAIL_PORT=1025
+MAIL_MAILER=log
+MAIL_SCHEME=null
+MAIL_HOST=127.0.0.1
+MAIL_PORT=2525
 MAIL_USERNAME=null
 MAIL_PASSWORD=null
-MAIL_ENCRYPTION=null
 MAIL_FROM_ADDRESS="dev@folklore.email"
 MAIL_FROM_NAME="${APP_NAME}"
 
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
 # react-scripts variables
 FLKLR_PROXY=<%= proxy_url %>

package/lib/generators/laravel-project/templates/laravel/app/Http/Middleware/Authenticate.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Illuminate\Auth\Middleware\Authenticate as Middleware;
+
+class Authenticate extends Middleware
+{
+    /**
+     * Get the path the user should be redirected to when they are not authenticated.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return string|null
+     */
+    protected function redirectTo($request)
+    {
+        if (!$request->expectsJson() && $request->isPanneau()) {
+            return route('panneau.auth.login') .
+                '?' .
+                http_build_query([
+                    'next' => $request->fullUrl(),
+                ]);
+        }
+
+        return route('login') .
+            http_build_query([
+                'next' => $request->fullUrl(),
+            ]);
+    }
+}

package/lib/generators/laravel-project/templates/laravel/app/Models/User.php

@@ -5,13 +5,12 @@ namespace App\Models;
 // use Illuminate\Contracts\Auth\MustVerifyEmail;
 use Folklore\Models\User as BaseUser;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
-use Laravel\Sanctum\HasApiTokens;
 use App\Contracts\Entities\User as UserContract;
 use App\Entities\User as UserResource;
 
 class User extends BaseUser
 {
-    use HasApiTokens, HasFactory;
+    use HasFactory;
 
     public function toEntity(): UserContract
     {

package/lib/generators/laravel-project/templates/laravel/app/Providers/AppServiceProvider.php

@@ -60,9 +60,14 @@ class AppServiceProvider extends ServiceProvider
 
     protected function registerTelescope()
     {
-        if ($this->app->environment('local')) {
+        if (
+            $this->app->environment('local') &&
+            class_exists(\Laravel\Telescope\TelescopeServiceProvider::class)
+        ) {
             $this->app->register(\Laravel\Telescope\TelescopeServiceProvider::class);
-            $this->app->register(TelescopeServiceProvider::class);
+            if (class_exists(TelescopeServiceProvider::class)) {
+                $this->app->register(TelescopeServiceProvider::class);
+            }
         }
     }
 

package/lib/generators/laravel-project/templates/laravel/app/Providers/RouteServiceProvider.php

@@ -2,11 +2,7 @@
 
 namespace App\Providers;
 
-use Illuminate\Cache\RateLimiting\Limit;
 use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
-use Illuminate\Http\Request;
-use Illuminate\Support\Facades\RateLimiter;
-use Illuminate\Support\Facades\Route;
 
 class RouteServiceProvider extends ServiceProvider
 {
@@ -26,32 +22,9 @@ class RouteServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        $this->configureRateLimiting();
-
         $this->bootPatterns();
 
         $this->bootBindings();
-
-        $this->routes(function () {
-            Route::middleware('api')
-                ->prefix('api')
-                ->group(base_path('routes/api.php'));
-
-            Route::middleware('web')
-                ->group(base_path('routes/web.php'));
-        });
-    }
-
-    /**
-     * Configure the rate limiters for the application.
-     *
-     * @return void
-     */
-    protected function configureRateLimiting()
-    {
-        RateLimiter::for('api', function (Request $request) {
-            return Limit::perMinute(60)->by($request->user()?->id ?: $request->ip());
-        });
     }
 
     protected function bootPatterns()