feat: 'components' config syntax

Author: tobimori

.gitignore

@@ -27,3 +27,6 @@ index.dev.mjs
 /vendor/**/php4/*
 /vendor/getkirby/composer-installer
 i18n.cache
+
+# happens because of installing the plugin as dev dependency
+site/plugins/kirby-queues

classes/Ai.php

@@ -9,7 +9,7 @@
 /**
  * Ai facade
  */
-final class Ai
+class Ai
 {
 	private static array $providers = [];
 

classes/IndexNow.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace tobimori\Seo;
+
+class IndexNow
+{
+}

config/fields.php

@@ -4,6 +4,7 @@
 use Kirby\Cms\Page;
 use Kirby\Http\Response;
 use tobimori\Seo\Ai;
+use tobimori\Seo\Seo;
 
 return [
 	'seo-writer' => [
@@ -13,7 +14,7 @@
 			 * Enables/disables the character counter in the top right corner
 			 */
 			'ai' => function (string|bool $ai = false) {
-				if (!Ai::enabled()) {
+				if (!Seo::option('components.ai')::enabled()) {
 					return false;
 				}
 
@@ -37,8 +38,9 @@
 				'method' => 'POST',
 				'action' => function () {
 					$kirby = $this->kirby();
+					$component = Seo::option('components.ai');
 
-					if (!Ai::enabled()) {
+					if (!$component::enabled()) {
 						return Response::json([
 							'status' => 'error',
 							'message' => t('seo.ai.error.disabled')
@@ -100,7 +102,7 @@
 
 					try {
 						foreach (
-							Ai::streamTask($this->field()->ai(), [
+							$component::streamTask($this->field()->ai(), [
 								'instructions' => $data['instructions'] ?? null,
 								'edit' => $data['edit'] ?? null
 							]) as $chunk

config/options.php

@@ -1,9 +1,21 @@
 <?php
 
 use Kirby\Cms\Page;
+use tobimori\Seo\Meta;
 use tobimori\Seo\Seo;
+use tobimori\Seo\Ai;
+use tobimori\Seo\IndexNow;
+use tobimori\Seo\SchemaSingleton;
 
 return [
+	// if you want to extend some of the built-in classes, you can overwrite them using the components config option
+	// and page methods or similar stuff will adapt. full customizability!
+	'components' => [
+		'meta' => Meta::class,
+		'ai' => Ai::class,
+		'indexnow' => IndexNow::class,
+		'schema' => SchemaSingleton::class,
+	],
 	'cascade' => [
 		'fields',
 		'programmatic',
@@ -50,7 +62,10 @@
 		'slack'
 	],
 	'robots' => [
-		'active' => true, // whether robots handling should be done by the plugin
+		'enabled' => true, // whether robots handling should be done by the plugin
+
+		// @deprecated - please use robots.enabled
+		'active' => fn () => Seo::option('sitemap.enabled'),
 		'followPageStatus' => true, // should unlisted pages be noindex by default?
 		'pageSettings' => true, // whether to have robots settings on each page
 		'index' => fn () => !option('debug'), // default site-wide robots setting
@@ -59,7 +74,9 @@
 		'types' => ['index', 'follow', 'archive', 'imageindex', 'snippet'] // available robots types
 	],
 	'sitemap' => [
-		'active' => true,
+		'enabled' => true,
+		// @deprecated - please use sitemap.enabled
+		'active' => fn () => Seo::option('sitemap.enabled'),
 		'redirect' => true, // redirect /sitemap to /sitemap.xml
 		'locale' => 'en',
 		'generator' => require __DIR__ . '/options/sitemap.php',
@@ -77,6 +94,12 @@
 		'trailingSlash' => false, // whether to add trailing slashes to canonical URLs (except for files)
 	],
 	'ai' => require __DIR__ . '/options/ai.php',
+	'indexnow' => [
+		'enabled' => true,
+		'searchEngine' => 'https://api.indexnow.org' // one will propagate to all others. so this is fine @see https://www.indexnow.org/faq
+		// TODO: add batch job delay
+		// TODO: add propagation thing (i.e. do not only submit the current page but a 'team member' page will always affect the 'team' page)
+	],
 	'generateSchema' => true, // whether to generate default schema.org data
 	'locale' => 'en_US', // default locale, used for single-language sites
 	'dateFormat' => null, // custom date format

config/page-methods.php

@@ -1,13 +1,13 @@
 <?php
 
 use Kirby\Cms\Language;
-use tobimori\Seo\Meta;
 use tobimori\Seo\SchemaSingleton;
+use tobimori\Seo\Seo;
 
 return [
-	'schema' => fn ($type) => SchemaSingleton::getInstance($type, $this),
-	'schemas' => fn () => SchemaSingleton::getInstances($this),
-	'metadata' => fn (?Language $lang = null) => new Meta($this, $lang),
+	'schema' => fn ($type) => Seo::option('components.schema')::getInstance($type, $this),
+	'schemas' => fn () => Seo::option('components.schema')::getInstances($this),
+	'metadata' => fn (?Language $lang = null) => new (Seo::option('components.meta'))($this, $lang),
 	'robots' => fn (?Language $lang = null) => $this->metadata($lang)->robots(),
 	'indexUrl' => function () {
 		// Google: "fallback page for unmatched languages, especially on language/country selectors or auto-redirecting home pages."

config/site-methods.php

@@ -2,14 +2,12 @@
 
 use Kirby\Http\Url;
 use Kirby\Toolkit\Str;
-use tobimori\Seo\Meta;
-use tobimori\Seo\SchemaSingleton;
 use tobimori\Seo\Seo;
 
 return [
-	'schema' => fn ($type) => SchemaSingleton::getInstance($type),
-	'schemas' => fn () => SchemaSingleton::getInstances(),
-	'lang' => fn () => Meta::normalizeLocale(Seo::option('default.locale', args: [$this->homePage()]), '-'),
+	'schema' => fn ($type) => Seo::option('components.schema')::getInstance($type),
+	'schemas' => fn () => Seo::option('components.schema')::getInstances(),
+	'lang' => fn () => Seo::option('components.meta')::normalizeLocale(Seo::option('default.locale', args: [$this->homePage()]), '-'),
 	'canonicalFor' => function (string $url, bool $useRootUrl = false) {
 		// Determine the base URL
 		$base = Seo::option('canonical.base', Seo::option('canonicalBase'));

vendor/composer/autoload_classmap.php

@@ -17,6 +17,7 @@
 	'tobimori\\Seo\\Ai\\Drivers\\Anthropic' => $baseDir . '/classes/Ai/Drivers/Anthropic.php',
 	'tobimori\\Seo\\Ai\\Drivers\\OpenAi' => $baseDir . '/classes/Ai/Drivers/OpenAi.php',
 	'tobimori\\Seo\\Ai\\SseStream' => $baseDir . '/classes/Ai/SseStream.php',
+	'tobimori\\Seo\\IndexNow' => $baseDir . '/classes/IndexNow.php',
 	'tobimori\\Seo\\Meta' => $baseDir . '/classes/Meta.php',
 	'tobimori\\Seo\\RobotsViewButton' => $baseDir . '/classes/RobotsViewButton.php',
 	'tobimori\\Seo\\SchemaSingleton' => $baseDir . '/classes/SchemaSingleton.php',

vendor/composer/autoload_static.php

@@ -40,6 +40,7 @@ class ComposerStaticInit3e4bc37d480117d497c8333636c62d44
 		'tobimori\\Seo\\Ai\\Drivers\\Anthropic' => __DIR__ . '/../..' . '/classes/Ai/Drivers/Anthropic.php',
 		'tobimori\\Seo\\Ai\\Drivers\\OpenAi' => __DIR__ . '/../..' . '/classes/Ai/Drivers/OpenAi.php',
 		'tobimori\\Seo\\Ai\\SseStream' => __DIR__ . '/../..' . '/classes/Ai/SseStream.php',
+		'tobimori\\Seo\\IndexNow' => __DIR__ . '/../..' . '/classes/IndexNow.php',
 		'tobimori\\Seo\\Meta' => __DIR__ . '/../..' . '/classes/Meta.php',
 		'tobimori\\Seo\\RobotsViewButton' => __DIR__ . '/../..' . '/classes/RobotsViewButton.php',
 		'tobimori\\Seo\\SchemaSingleton' => __DIR__ . '/../..' . '/classes/SchemaSingleton.php',