feat: seo handling

packages/core/package.json

@@ -82,7 +82,8 @@
     "react-inspector": "^6.0.1",
     "swr": "^2.2.5",
     "xss": "^1.0.15",
-    "deepmerge": "^4.3.1"
+    "deepmerge": "^4.3.1",
+    "schema-dts": "^1.1.2"
   },
   "peerDependencies": {
     "react": ">= 17.0.2"

packages/core/src/data/strategies/SearchFetchStrategy.ts

@@ -4,7 +4,7 @@ import { PostsArchiveFetchStrategy, PostsArchiveParams } from './PostsArchiveFet
 import { endpoints } from '../utils';
 import { apiGet } from '../api';
 import { addQueryArgs, getWPUrl } from '../../utils';
-import { PostEntity, QueriedObject } from '../types';
+import { PostEntity, QueriedObject, YoastJSON } from '../types';
 import { FetchOptions } from './AbstractFetchStrategy';
 
 /**
@@ -45,7 +45,7 @@ export class SearchFetchStrategy<
 	 */
 	async fetcher(url: string, params: Partial<P>, options: Partial<FetchOptions> = {}) {
 		const { burstCache = false } = options;
-		let seo_json: Record<string, any> = {};
+		let seo_json: YoastJSON | null = null;
 		let seo: string = '';
 
 		// Request SEO data.
@@ -70,12 +70,13 @@ export class SearchFetchStrategy<
 				type: 'post',
 				subtype: params.postType ?? 'post',
 				yoast_head: seo,
-				yoast_head_json: {
-					...seo_json,
-				},
 			},
 		};
 
+		if (seo_json && queriedObject.search) {
+			queriedObject.search.yoast_head_json = seo_json;
+		}
+
 		const response = await super.fetcher(url, params, { ...options, throwIfNotFound: false });
 
 		return {

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts

@@ -1,7 +1,7 @@
 import { getSiteBySourceUrl, addQueryArgs, getWPUrl } from '../../utils';
 import { endpoints } from '../utils';
 import { apiGet } from '../api';
-import { PostSearchEntity, TermSearchEntity, QueriedObject } from '../types';
+import { PostSearchEntity, TermSearchEntity, QueriedObject, YoastJSON } from '../types';
 import { searchMatchers } from '../utils/matchers';
 import { parsePath } from '../utils/parsePath';
 import { FetchOptions, AbstractFetchStrategy, EndpointParams } from './AbstractFetchStrategy';
@@ -124,7 +124,7 @@ export class SearchNativeFetchStrategy<
 	 */
 	async fetcher(url: string, params: Partial<P>, options: Partial<FetchOptions> = {}) {
 		const { burstCache = false } = options;
-		let seo_json: Record<string, any> = {};
+		let seo_json: YoastJSON | null = null;
 		let seo: string = '';
 
 		// Request SEO data.
@@ -142,7 +142,7 @@ export class SearchNativeFetchStrategy<
 			);
 
 			seo = result.json.html ?? null;
-			seo_json = { ...result.json.json };
+			seo_json = { ...(result.json.json as YoastJSON) };
 		} catch (e) {
 			// do nothing
 		}
@@ -153,12 +153,13 @@ export class SearchNativeFetchStrategy<
 				type: params.type ?? 'post',
 				subtype: params.subtype ?? 'post',
 				yoast_head: seo,
-				yoast_head_json: {
-					...seo_json,
-				},
 			},
 		};
 
+		if (seo_json && queriedObject.search) {
+			queriedObject.search.yoast_head_json = seo_json;
+		}
+
 		const response = await super.fetcher(url, params, {
 			...options,
 			throwIfNotFound: false,

packages/core/src/data/types/entities.ts

@@ -6,11 +6,13 @@
  * Those schemas are accessible making an OPTIONS call to each endpoint.
  */
 
+import { YoastJSON } from './yoast';
+
 /**
  * Empty interface from which all entities inherit.
  */
 export interface Entity {
-	yoast_head_json?: Record<string, any> | null;
+	yoast_head_json?: YoastJSON | null;
 	yoast_head?: string | null;
 	[k: string]: unknown;
 }
@@ -109,9 +111,6 @@ export interface PostTypeEntity extends Entity {
 	 * Whether or not the object can be pinged.
 	 */
 	ping_status: 'open' | 'closed';
-
-	yoast_head_json?: Record<string, any> | null;
-	yoast_head?: string | null;
 }
 
 /**
@@ -474,9 +473,6 @@ export interface TermEntity extends Entity {
 	 * Meta fields.
 	 */
 	meta: Record<string, unknown>;
-
-	yoast_head_json?: Record<string, any> | null;
-	yoast_head?: string | null;
 }
 
 /**
@@ -543,9 +539,6 @@ export interface AuthorEntity extends Entity {
 	 * Meta fields.
 	 */
 	meta: Record<string, unknown>;
-
-	yoast_head_json?: Record<string, any> | null;
-	yoast_head?: string | null;
 }
 
 /**

packages/core/src/data/types/index.ts

@@ -1 +1,2 @@
 export * from './entities';
+export * from './yoast';

packages/core/src/data/types/yoast.ts

@@ -0,0 +1,53 @@
+import type { Graph } from 'schema-dts';
+
+export type YoastJSON = {
+	title: string;
+	description: string;
+	robots: {
+		index: 'index' | 'noindex';
+		follow: 'follow' | 'nofollow';
+		'max-snippet'?: number;
+		'max-image-preview'?: 'none' | 'standard' | 'large';
+		'max-video-preview'?: string | number;
+	};
+	canonical: string;
+	og_locale?: string;
+	og_type?:
+		| 'article'
+		| 'book'
+		| 'music.song'
+		| 'music.album'
+		| 'music.playlist'
+		| 'music.radio_station'
+		| 'profile'
+		| 'website'
+		| 'video.tv_show'
+		| 'video.other'
+		| 'video.movie'
+		| 'video.episode';
+	og_title?: string;
+	og_description?: string;
+	og_image?: {
+		width?: number;
+		height?: number;
+		size?: string;
+		path?: string;
+		alt?: string;
+		pixels?: number;
+		id?: string;
+		url: string;
+	};
+	og_url?: string;
+	og_site_name?: string;
+	article_publisher?: string;
+	article_author?: string;
+	article_published_time?: string;
+	article_modified_time?: string;
+	author?: string;
+	twitter_card?: string;
+	twitter_creator?: string;
+	twitter_site?: string;
+	twitter_misc?: Record<string, string>;
+	schema?: Graph;
+	status?: number;
+};

packages/next/src/components/Yoast.tsx

@@ -1,7 +1,6 @@
 import { createElement, Fragment } from 'react';
 import {
 	HTMLReactParser as parse,
-	removeSourceUrl,
 	attributesToProps,
 	DOMNode,
 	domToReact,
@@ -11,19 +10,7 @@ import {
 } from '@headstartwp/core';
 import { useSettings } from '@headstartwp/core/react';
 import Head from 'next/head.js';
-
-export function convertUrl(url: string, hostUrl: string, sourceUrl: string) {
-	if (!url.startsWith(sourceUrl)) {
-		return url;
-	}
-
-	return `${hostUrl}${removeSourceUrl({
-		link: url,
-		publicUrl: hostUrl,
-		backendUrl: sourceUrl,
-		nonEmptyLink: false,
-	})}`;
-}
+import { convertUrl } from '../utils/convertUrl';
 
 type Props = {
 	seo: {

packages/next/src/rsc/data/index.ts

@@ -1,2 +1,3 @@
 export * from '../../data/convertToPath';
 export * from './queries';
+export * from './seo';