@merkle-open/magnolia-headless-frontend-nextjs 0.0.1 → 0.0.2

package/README.md

@@ -1,76 +1,76 @@
-# Magnolia NextJs Headless Frontend
-- [Templates](./src/templates/_README.md)
-- [Proxy/Middleware](./src/middleware/_README.md)
-- [Config](./src/config/_README.md)
-- [API](./src/api/_README.md)
-- [Dynamic-Page](./README_dynamic-page.md)
-
-## setup
-- Add the following dependencies to your package.json
-  - `@merkle-open/magnolia-headless-frontend-nextjs`
-  - [`tsyringe`](https://github.com/Microsoft/tsyringe)
-  - `reflect-metadata`
-  - `next`
-  - `react`
-  - `react-dom`
-- Configure tsconfig.json to include the following settings (`./tsconfig.json`)
-  ```json
-  {
-    "compilerOptions": {
-      "experimentalDecorators": true,
-      "emitDecoratorMetadata": true
-    },
-    "include": [
-      "node_modules/@merkle-open/magnolia-headless-frontend-nextjs"
-    ]
-  }
-  ```
-- Configure the [middleware composer](./src/middleware/_README.md#configure-middleware-composer)
-- Implement and bind the interfaces specified [here](./src/config/_README.md) 
-- Implement API endpoints specified [here](./src/api/_README.md)
-- Configure [instrumentation.ts](https://nextjs.org/docs/app/guides/instrumentation#importing-files-with-side-effects) (`./instrumentation.ts`)
-  ```typescript
-  export async function register() {
-      await import('reflect-metadata');
-  }
-  ```
-- Setup [dynamic page](./README_dynamic-page.md)
-- Setup Dependencies (`./Dependencies.ts`)
-  ```typescript
-  import 'reflect-metadata';
-  import { container } from 'tsyringe';
-  import { register as registerOss } from '@merkle-open/magnolia-headless-frontend-nextjs';
-  import registerConfigs from './config/_Dependencies.ts';
-  
-  registerConfigs(container);
-  registerOss(container);
-  
-  export { container };
-  ```
-- Setup next.config.ts (`./next.config.ts`)
-  ```typescript
-  import type { NextConfig } from 'next';
-  import type { Rewrite } from 'next/dist/lib/load-custom-routes';
-  
-  const nextConfig: NextConfig = {
-      transpilePackages: ['@merkle-open/magnolia-headless-frontend-nextjs'],
-      async rewrites(): Promise<Rewrite[]> {
-          return [
-              {
-                  source: '/robots.txt',
-                  destination: '/api/robots.txt',
-              },
-              {
-                  source: '/:language([a-z]{2})/sitemap/:type',
-                  destination: '/api/:language/sitemap/:type',
-              },
-              {
-                  source: '/:language([a-z]{2})/:path*',
-                  destination: '/dynamic/:language/:path*',
-              },
-          ];
-      },
-      ...
-  };
-  export default nextConfig;
-  ```
+# Magnolia NextJs Headless Frontend
+- [Templates](./src/templates/_README.md)
+- [Proxy/Middleware](./src/middleware/_README.md)
+- [Config](./src/config/_README.md)
+- [API](./src/api/_README.md)
+- [Dynamic-Page](./README_dynamic-page.md)
+
+## setup
+- Add the following dependencies to your package.json
+  - `@merkle-open/magnolia-headless-frontend-nextjs`
+  - [`tsyringe`](https://github.com/Microsoft/tsyringe)
+  - `reflect-metadata`
+  - `next`
+  - `react`
+  - `react-dom`
+- Configure tsconfig.json to include the following settings (`./tsconfig.json`)
+  ```json
+  {
+    "compilerOptions": {
+      "experimentalDecorators": true,
+      "emitDecoratorMetadata": true
+    },
+    "include": [
+      "node_modules/@merkle-open/magnolia-headless-frontend-nextjs"
+    ]
+  }
+  ```
+- Configure the [middleware composer](./src/middleware/_README.md#configure-middleware-composer)
+- Implement and bind the interfaces specified [here](./src/config/_README.md) 
+- Implement API endpoints specified [here](./src/api/_README.md)
+- Configure [instrumentation.ts](https://nextjs.org/docs/app/guides/instrumentation#importing-files-with-side-effects) (`./instrumentation.ts`)
+  ```typescript
+  export async function register() {
+      await import('reflect-metadata');
+  }
+  ```
+- Setup [dynamic page](./README_dynamic-page.md)
+- Setup Dependencies (`./Dependencies.ts`)
+  ```typescript
+  import 'reflect-metadata';
+  import { container } from 'tsyringe';
+  import { register as registerOss } from '@merkle-open/magnolia-headless-frontend-nextjs';
+  import registerConfigs from './config/_Dependencies.ts';
+  
+  registerConfigs(container);
+  registerOss(container);
+  
+  export { container };
+  ```
+- Setup next.config.ts (`./next.config.ts`)
+  ```typescript
+  import type { NextConfig } from 'next';
+  import type { Rewrite } from 'next/dist/lib/load-custom-routes';
+  
+  const nextConfig: NextConfig = {
+      transpilePackages: ['@merkle-open/magnolia-headless-frontend-nextjs'],
+      async rewrites(): Promise<Rewrite[]> {
+          return [
+              {
+                  source: '/robots.txt',
+                  destination: '/api/robots.txt',
+              },
+              {
+                  source: '/:language([a-z]{2})/sitemap/:type',
+                  destination: '/api/:language/sitemap/:type',
+              },
+              {
+                  source: '/:language([a-z]{2})/:path*',
+                  destination: '/dynamic/:language/:path*',
+              },
+          ];
+      },
+      ...
+  };
+  export default nextConfig;
+  ```

package/index.ts

@@ -1 +1 @@
-export * from './src/Index.ts';
+export * from './src/Index.ts';

package/package.json

@@ -1,61 +1,61 @@
-{
-  "name": "@merkle-open/magnolia-headless-frontend-nextjs",
-  "version": "0.0.1",
-  "description": "Magnolia headless frontend nextJs",
-  "license": "MIT",
-  "author": "Merkle Inc.",
-  "private": false,
-  "main": "index.ts",
-  "module": "index.ts",
-  "type": "module",
-  "engines": {
-    "node": ">=24"
-  },
-  "files": [
-    "README.md",
-    "index.ts",
-    "src"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/merkle-open/magnolia-headless.git"
-  },
-  "scripts": {
-    "generate-oss-magnoliaConfig": "npx tsx src/scripts/generate-magnolia-config.ts src/templates src/templates",
-    "build": "tsc --build",
-    "clean": "tsc --build --clean",
-    "format": "prettier --write src/**",
-    "lint": "eslint src/**",
-    "prepare": "cd .. && husky magnolia-headless-frontend-nextjs/.husky"
-  },
-  "dependencies": {
-    "@magnolia/react-editor": "2.1.1"
-  },
-  "peerDependencies": {
-    "next": "^16.1",
-    "react": "^19.2",
-    "react-dom": "^19.2",
-    "reflect-metadata": "^0.2",
-    "tsyringe": "^4.4"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.39.3",
-    "@types/node": "^25.0.10",
-    "@types/react": "19.2.10",
-    "@typescript-eslint/eslint-plugin": "^8.56.1",
-    "@typescript-eslint/parser": "^8.56.1",
-    "eslint": "^9.39.3",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.5",
-    "eslint-plugin-react": "^7.37.5",
-    "husky": "^9.1.7",
-    "lint-staged": "^16.2.7",
-    "prettier": "^3.8.1",
-    "tsx": "^4.21.0",
-    "typescript-eslint": "^8.56.1",
-    "jiti": "^2.6.1"
-  },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx,md,mdx,html,css}": "npm run format"
-  }
-}
+{
+  "name": "@merkle-open/magnolia-headless-frontend-nextjs",
+  "version": "0.0.2",
+  "description": "Magnolia headless frontend nextJs",
+  "license": "MIT",
+  "author": "Merkle Inc.",
+  "private": false,
+  "main": "index.ts",
+  "module": "index.ts",
+  "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
+  "files": [
+    "README.md",
+    "index.ts",
+    "src"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/merkle-open/magnolia-headless.git"
+  },
+  "scripts": {
+    "generate-oss-magnoliaConfig": "npx tsx src/scripts/generate-magnolia-config.ts src/templates src/templates",
+    "build": "tsc --build",
+    "clean": "tsc --build --clean",
+    "format": "prettier --write src/**",
+    "lint": "eslint src/**",
+    "prepare": "cd .. && husky magnolia-headless-frontend-nextjs/.husky"
+  },
+  "dependencies": {
+    "@magnolia/react-editor": "2.1.1"
+  },
+  "peerDependencies": {
+    "next": "^16.1",
+    "react": "^19.2",
+    "react-dom": "^19.2",
+    "reflect-metadata": "^0.2",
+    "tsyringe": "^4.4"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.3",
+    "@types/node": "^25.0.10",
+    "@types/react": "19.2.10",
+    "@typescript-eslint/eslint-plugin": "^8.56.1",
+    "@typescript-eslint/parser": "^8.56.1",
+    "eslint": "^9.39.3",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-plugin-react": "^7.37.5",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.8.1",
+    "tsx": "^4.21.0",
+    "typescript-eslint": "^8.56.1",
+    "jiti": "^2.6.1"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,md,mdx,html,css}": "npm run format"
+  }
+}

package/src/Constants.ts

@@ -1 +1 @@
-export const TOKEN_PREFIX = 'com.merkle.oss.magnolia.headless.';
+export const TOKEN_PREFIX = 'com.merkle.oss.magnolia.headless.';

package/src/Dependencies.ts

@@ -1,14 +1,14 @@
-import { DependencyContainer } from 'tsyringe';
-import registerApis from './api/_Dependencies.ts';
-import registerDynamicPages from './dynamic-page/_Dependencies.ts';
-import registerHelpers from './helper/_Dependencies.ts';
-import registerMiddlewares from './middleware/_Dependencies.ts';
-import registerTemplates from './templates/_Dependencies.ts';
-
-export function register(container: DependencyContainer) {
-	registerApis(container);
-	registerDynamicPages(container);
-	registerHelpers(container);
-	registerMiddlewares(container);
-	registerTemplates(container);
-}
+import { DependencyContainer } from 'tsyringe';
+import registerApis from './api/_Dependencies.ts';
+import registerDynamicPages from './dynamic-page/_Dependencies.ts';
+import registerHelpers from './helper/_Dependencies.ts';
+import registerMiddlewares from './middleware/_Dependencies.ts';
+import registerTemplates from './templates/_Dependencies.ts';
+
+export function register(container: DependencyContainer) {
+	registerApis(container);
+	registerDynamicPages(container);
+	registerHelpers(container);
+	registerMiddlewares(container);
+	registerTemplates(container);
+}

package/src/Index.ts

@@ -1,8 +1,8 @@
-export * from './api/_Index.ts';
-export * from './dynamic-page/_Index.ts';
-export * from './config/_Index.ts';
-export * from './helper/_Index.ts';
-export * from './middleware/_Index.ts';
-export * from './templates/_Index.ts';
-export * from './Constants.ts';
-export * from './Dependencies.ts';
+export * from './api/_Index.ts';
+export * from './dynamic-page/_Index.ts';
+export * from './config/_Index.ts';
+export * from './helper/_Index.ts';
+export * from './middleware/_Index.ts';
+export * from './templates/_Index.ts';
+export * from './Constants.ts';
+export * from './Dependencies.ts';

package/src/api/ErrorPageApi.ts

@@ -1,30 +1,30 @@
-import { NextRequest } from 'next/server';
-import { inject, injectable } from 'tsyringe';
-import { ErrorType, MagnoliaPageRestClient } from '../helper/MagnoliaPageRestClient.ts';
-
-import { TOKEN_PREFIX } from '../Constants.ts';
-
-@injectable()
-export class ErrorPageApi {
-	constructor(@inject(TOKEN_PREFIX + 'MagnoliaPageRestClient') private magnoliaPageRestClient: MagnoliaPageRestClient) {}
-
-	public async get(req: NextRequest, language: string): Promise<Response> {
-		const queryParams = req.nextUrl.searchParams;
-		const url = new URL(`https://${req.headers.get('host')}/${language}`);
-		const errorType = this.getErrorTypeFromString(queryParams.get('errorType'));
-		const headers = new Headers();
-		headers.set('Content-Type', 'application/json');
-		return this.magnoliaPageRestClient
-			.getErrorPageContent(url, errorType)
-			.then((content) => JSON.stringify(content))
-			.then((body) => new Response(body, { headers: headers }));
-	}
-
-	private getErrorTypeFromString(value: string): ErrorType | undefined {
-		const directions = Object.values(ErrorType);
-		if (directions.includes(value as ErrorType)) {
-			return value as ErrorType;
-		}
-		return undefined;
-	}
-}
+import { NextRequest } from 'next/server';
+import { inject, injectable } from 'tsyringe';
+import { ErrorType, MagnoliaPageRestClient } from '../helper/MagnoliaPageRestClient.ts';
+
+import { TOKEN_PREFIX } from '../Constants.ts';
+
+@injectable()
+export class ErrorPageApi {
+	constructor(@inject(TOKEN_PREFIX + 'MagnoliaPageRestClient') private magnoliaPageRestClient: MagnoliaPageRestClient) {}
+
+	public async get(req: NextRequest, language: string): Promise<Response> {
+		const queryParams = req.nextUrl.searchParams;
+		const url = new URL(`https://${req.headers.get('host')}/${language}`);
+		const errorType = this.getErrorTypeFromString(queryParams.get('errorType'));
+		const headers = new Headers();
+		headers.set('Content-Type', 'application/json');
+		return this.magnoliaPageRestClient
+			.getErrorPageContent(url, errorType)
+			.then((content) => JSON.stringify(content))
+			.then((body) => new Response(body, { headers: headers }));
+	}
+
+	private getErrorTypeFromString(value: string): ErrorType | undefined {
+		const directions = Object.values(ErrorType);
+		if (directions.includes(value as ErrorType)) {
+			return value as ErrorType;
+		}
+		return undefined;
+	}
+}

package/src/api/RobotsTxtApi.ts

@@ -1,33 +1,33 @@
-import { RestClient } from '../helper/RestClient.ts';
-import { NextRequest } from 'next/server';
-import { inject, injectable } from 'tsyringe';
-import type { HeadlessConfigProviderI, MagnoliaApiEndpointsProvider } from '../config/ConfigProvider.ts';
-
-import { TOKEN_PREFIX } from '../Constants.ts';
-
-@injectable()
-export class RobotsTxtApi {
-	private readonly apisProvider: MagnoliaApiEndpointsProvider;
-
-	constructor(
-		@inject(TOKEN_PREFIX + 'HeadlessConfigProviderI') configProvider: HeadlessConfigProviderI,
-		@inject(TOKEN_PREFIX + 'RestClient') private restClient: RestClient,
-	) {
-		this.apisProvider = configProvider.get().magnoliaApisProvider;
-	}
-
-	public async get(req: NextRequest, sitemapUrlTemplate: string): Promise<Response> {
-		const domain: string = new URL('https://' + req.headers.get('host')).hostname; //strip port
-		const headers = new Headers();
-		headers.set('Content-Type', 'text/plain');
-		return this.getRobots(domain, sitemapUrlTemplate).then((robots) => new Response(robots, { headers: headers }));
-	}
-
-	private async getRobots(domain: string, sitemapUrlTemplate: string): Promise<string> {
-		const queryParams = new URLSearchParams();
-		queryParams.set('domain', domain);
-		queryParams.set('sitemapUrlTemplate', sitemapUrlTemplate);
-		const url = this.apisProvider.robots() + '?' + queryParams.toString();
-		return this.restClient.fetchMagnoliaBasicAuth(url).then((response) => this.restClient.getText(url, response));
-	}
-}
+import { RestClient } from '../helper/RestClient.ts';
+import { NextRequest } from 'next/server';
+import { inject, injectable } from 'tsyringe';
+import type { HeadlessConfigProviderI, MagnoliaApiEndpointsProvider } from '../config/ConfigProvider.ts';
+
+import { TOKEN_PREFIX } from '../Constants.ts';
+
+@injectable()
+export class RobotsTxtApi {
+	private readonly apisProvider: MagnoliaApiEndpointsProvider;
+
+	constructor(
+		@inject(TOKEN_PREFIX + 'HeadlessConfigProviderI') configProvider: HeadlessConfigProviderI,
+		@inject(TOKEN_PREFIX + 'RestClient') private restClient: RestClient,
+	) {
+		this.apisProvider = configProvider.get().magnoliaApisProvider;
+	}
+
+	public async get(req: NextRequest, sitemapUrlTemplate: string): Promise<Response> {
+		const domain: string = new URL('https://' + req.headers.get('host')).hostname; //strip port
+		const headers = new Headers();
+		headers.set('Content-Type', 'text/plain');
+		return this.getRobots(domain, sitemapUrlTemplate).then((robots) => new Response(robots, { headers: headers }));
+	}
+
+	private async getRobots(domain: string, sitemapUrlTemplate: string): Promise<string> {
+		const queryParams = new URLSearchParams();
+		queryParams.set('domain', domain);
+		queryParams.set('sitemapUrlTemplate', sitemapUrlTemplate);
+		const url = this.apisProvider.robots() + '?' + queryParams.toString();
+		return this.restClient.fetchMagnoliaBasicAuth(url).then((response) => this.restClient.getText(url, response));
+	}
+}

package/src/api/SitemapApi.ts

@@ -1,33 +1,33 @@
-import { RestClient } from '../helper/RestClient.ts';
-import { NextRequest } from 'next/server';
-import { inject, injectable } from 'tsyringe';
-import type { HeadlessConfigProviderI, MagnoliaApiEndpointsProvider } from '../config/ConfigProvider.ts';
-
-import { TOKEN_PREFIX } from '../Constants.ts';
-
-@injectable()
-export class SitemapApi {
-	private readonly apisProvider: MagnoliaApiEndpointsProvider;
-
-	constructor(
-		@inject(TOKEN_PREFIX + 'HeadlessConfigProviderI') configProvider: HeadlessConfigProviderI,
-		@inject(TOKEN_PREFIX + 'RestClient') private restClient: RestClient,
-	) {
-		this.apisProvider = configProvider.get().magnoliaApisProvider;
-	}
-
-	public async get(req: NextRequest, language: string, type: string): Promise<Response> {
-		const domain: string = new URL('https://' + req.headers.get('host')).hostname; //strip port
-		const headers = new Headers();
-		headers.set('Content-Type', 'application/xml');
-		return this.getSitemap(domain, language, type).then((sitemap) => new Response(sitemap, { headers: headers }));
-	}
-
-	private async getSitemap(domain: string, language: string, type: string): Promise<string> {
-		const queryParams = new URLSearchParams();
-		queryParams.set('domain', domain);
-		queryParams.set('type', type);
-		const url = this.apisProvider.sitemap(language) + '?' + queryParams.toString();
-		return this.restClient.fetchMagnoliaBasicAuth(url).then((response) => this.restClient.getText(url, response, 'application/xml'));
-	}
-}
+import { RestClient } from '../helper/RestClient.ts';
+import { NextRequest } from 'next/server';
+import { inject, injectable } from 'tsyringe';
+import type { HeadlessConfigProviderI, MagnoliaApiEndpointsProvider } from '../config/ConfigProvider.ts';
+
+import { TOKEN_PREFIX } from '../Constants.ts';
+
+@injectable()
+export class SitemapApi {
+	private readonly apisProvider: MagnoliaApiEndpointsProvider;
+
+	constructor(
+		@inject(TOKEN_PREFIX + 'HeadlessConfigProviderI') configProvider: HeadlessConfigProviderI,
+		@inject(TOKEN_PREFIX + 'RestClient') private restClient: RestClient,
+	) {
+		this.apisProvider = configProvider.get().magnoliaApisProvider;
+	}
+
+	public async get(req: NextRequest, language: string, type: string): Promise<Response> {
+		const domain: string = new URL('https://' + req.headers.get('host')).hostname; //strip port
+		const headers = new Headers();
+		headers.set('Content-Type', 'application/xml');
+		return this.getSitemap(domain, language, type).then((sitemap) => new Response(sitemap, { headers: headers }));
+	}
+
+	private async getSitemap(domain: string, language: string, type: string): Promise<string> {
+		const queryParams = new URLSearchParams();
+		queryParams.set('domain', domain);
+		queryParams.set('type', type);
+		const url = this.apisProvider.sitemap(language) + '?' + queryParams.toString();
+		return this.restClient.fetchMagnoliaBasicAuth(url).then((response) => this.restClient.getText(url, response, 'application/xml'));
+	}
+}

package/src/api/_Dependencies.ts

@@ -1,12 +1,12 @@
-import { DependencyContainer } from 'tsyringe';
-import { ErrorPageApi } from './ErrorPageApi.ts';
-import { RobotsTxtApi } from './RobotsTxtApi.ts';
-import { SitemapApi } from './SitemapApi.ts';
-
-import { TOKEN_PREFIX } from '../Constants.ts';
-
-export default function register(container: DependencyContainer) {
-	container.register(TOKEN_PREFIX + 'ErrorPageApi', { useClass: ErrorPageApi });
-	container.register(TOKEN_PREFIX + 'RobotsTxtApi', { useClass: RobotsTxtApi });
-	container.register(TOKEN_PREFIX + 'SitemapApi', { useClass: SitemapApi });
-}
+import { DependencyContainer } from 'tsyringe';
+import { ErrorPageApi } from './ErrorPageApi.ts';
+import { RobotsTxtApi } from './RobotsTxtApi.ts';
+import { SitemapApi } from './SitemapApi.ts';
+
+import { TOKEN_PREFIX } from '../Constants.ts';
+
+export default function register(container: DependencyContainer) {
+	container.register(TOKEN_PREFIX + 'ErrorPageApi', { useClass: ErrorPageApi });
+	container.register(TOKEN_PREFIX + 'RobotsTxtApi', { useClass: RobotsTxtApi });
+	container.register(TOKEN_PREFIX + 'SitemapApi', { useClass: SitemapApi });
+}

package/src/api/_Index.ts

@@ -1,3 +1,3 @@
-export * from './ErrorPageApi.ts';
-export * from './RobotsTxtApi.ts';
-export * from './SitemapApi.ts';
+export * from './ErrorPageApi.ts';
+export * from './RobotsTxtApi.ts';
+export * from './SitemapApi.ts';