fix: account for possible 'single' property in the default post types for post path matching

.changeset/free-rocks-take.md

@@ -0,0 +1,5 @@
+---
+"@headstartwp/core": patch
+---
+
+Fix: account for possible `single` property in the default post types when executing the default post path matching.

.github/workflows/build-test.yml

@@ -6,14 +6,16 @@ jobs:
   build-test:
     runs-on: ${{ matrix.os }}
     strategy:
+      # This ensures only one combination runs at a time to avoid rate limiting
+      max-parallel: 1
       matrix:
         os: [ubuntu-latest, windows-latest]
         node-version: [18, 20, 22]
         exclude:
           - os: windows-latest
             node-version: 18
           - os: windows-latest
-            node-version: 20
+            node-version: 20   
 
     steps:
       - name: Configure Git line endings

docs/documentation/01-Getting Started/headless-config.md

@@ -111,6 +111,27 @@ module.exports = {
 }
 ```
 
+Another use case is if you want your posts to sit at a different prefix (e.g: `/blog`), you can change your permalinks in WordPress (e.g: `/blog/%postname/`) and update the default `post` post type so that its `sigle` property is equal to `/blog`.
+
+```js title="headstartwp.config.js"
+module.exports = {
+    sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,
+    hostUrl: process.env.HOST_URL,
+    customPostTypes: (defaultPostTypes) => {
+		return defaultPostTypes.map((postType) => {
+			if (postType === 'post') {
+				return {
+					...postType,
+					single: '/blog'
+				}
+			}
+
+			return postType;
+		};
+	}
+}
+```
+
 ## customTaxonomies
 
 To add support for custom taxonomies, add your custom taxonomy to the `customTaxonomies` setting in `headstartwp.config.js`.

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

@@ -191,7 +191,13 @@ export class SinglePostFetchStrategy<
 				}
 			}
 
-			return postPath === currentPath || postPath === `/${this.locale}${currentPath}`;
+			const postPostTypeObject = getCustomPostType('post', this.baseURL);
+			const postSinglePrefix = postPostTypeObject?.single?.replace(/\/?$/, '') ?? '';
+
+			return (
+				postPath === `${postSinglePrefix}${currentPath}` ||
+				postPath === `/${this.locale}${postSinglePrefix}${currentPath}`
+			);
 		});
 	}
 

packages/core/src/data/strategies/__tests__/SinglePostFetchStrategy.ts

@@ -1,4 +1,4 @@
-import { setHeadlessConfig } from '../../../utils';
+import { getHeadstartWPConfig, setHeadlessConfig, setHeadstartWPConfig } from '../../../utils';
 import { apiGet } from '../../api';
 import { PostParams, SinglePostFetchStrategy } from '../SinglePostFetchStrategy';
 
@@ -439,20 +439,57 @@ describe('SinglePostFetchStrategy', () => {
 		});
 	});
 
-	it('handles post path mapping', async () => {
+	it.each([
+		{
+			settings: {
+				customPostTypes: [{ slug: 'post', single: '/', endpoint: '/wp-json/wp/v2/posts' }],
+			},
+			mockedData: [
+				{ title: 'test', id: 1, link: `http://sourceurl.com/%s` },
+				{
+					title: 'test',
+					id: 2,
+					link: `http://sourceurl.com/%s`,
+				},
+			],
+		},
+		{
+			settings: {
+				customPostTypes: [
+					{
+						slug: 'post',
+						single: '/blog',
+						archive: '/blog',
+						endpoint: '/wp-json/wp/v2/posts',
+					},
+				],
+			},
+			mockedData: [
+				{ title: 'test', id: 1, link: `http://sourceurl.com/blog/%s` },
+				{
+					title: 'test',
+					id: 2,
+					link: `http://sourceurl.com/blog/%s`,
+				},
+			],
+		},
+	])('handles post path mapping with and without prefix', async ({ settings, mockedData }) => {
 		const englishPostSlug = 'test';
 		const utf8EncodedPostSlug = 'لأخبار-المالية';
+		const originalSettings = getHeadstartWPConfig();
+
+		setHeadstartWPConfig({
+			...originalSettings,
+			...settings,
+		});
 
 		const post1 = {
-			title: 'test',
-			id: 1,
-			link: `http://sourceurl.com/${englishPostSlug}`,
+			...mockedData[0],
+			link: `${mockedData[0].link.replace('%s', englishPostSlug)}`,
 		};
-
 		const post2 = {
-			title: 'test',
-			id: 2,
-			link: `http://sourceurl.com/${encodeURIComponent(utf8EncodedPostSlug)}`,
+			...mockedData[1],
+			link: `${mockedData[1].link.replace('%s', encodeURIComponent(utf8EncodedPostSlug))}`,
 		};
 
 		apiGetMock.mockResolvedValue({