create-content-sdk-app 2.0.2 → 2.1.0-canary.2

package/dist/templates/nextjs/package.json

@@ -1,68 +1,68 @@
-{
-  "name": "content-sdk-nextjs",
-  "description": "Application utilizing Content SDK and Next.js",
-  "version": "0.1.0",
-  "private": true,
-  "config": {
-    "appName": "content-sdk-nextjs",
-    "graphQLEndpointPath": "/sitecore/api/graph/edge",
-    "language": "en",
-    "template": "nextjs"
-  },
-  "author": {
-    "name": "Sitecore Corporation",
-    "url": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sitecore/content-sdk.git"
-  },
-  "bugs": {
-    "url": "https://github.com/sitecore/content-sdk/issues"
-  },
-  "license": "Apache-2.0",
-  "dependencies": {
-    "@sitecore-content-sdk/nextjs": "<%- version %>",
-    "@sitecore-content-sdk/analytics-core": "<%- version %>",
-    "@sitecore-content-sdk/events": "<%- version %>",
-    "@sitecore-feaas/clientside": "^0.6.0",
-    "@sitecore/components": "~2.1.0",
-    "next": "^16.1.1",
-    "next-localization": "^0.12.0",
-    "react": "^19.2.1",
-    "react-dom": "^19.2.1"
-  },
-  "devDependencies": {
-    "@sitecore-content-sdk/cli": "<%- version %>",
-    "@types/node": "^24.10.4",
-    "@types/react": "^19.2.7",
-    "@types/react-dom": "^19.2.3",
-    "@stylistic/eslint-plugin": "^5.2.2",
-    "@typescript-eslint/eslint-plugin": "8.39.0",
-    "@typescript-eslint/parser": "8.39.0",
-    "cross-env": "~7.0.3",
-    "eslint": "^9.32.0",
-    "eslint-config-next": "15.5.3",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-import": "2.32.0",
-    "eslint-plugin-jsdoc": "52.0.3",
-    "eslint-plugin-prettier": "^5.5.3",
-    "eslint-plugin-react": "7.37.5",
-    "eslint-plugin-react-hooks": "5.2.0",
-    "npm-run-all2": "~8.0.1",
-    "prettier": "^3.6.2",
-    "typescript": "~5.8.3"
-  },
-  "scripts": {
-    "build": "cross-env NODE_ENV=production npm-run-all --serial sitecore-tools:generate-map sitecore-tools:build next:build",
-    "lint": "eslint ./src/**/*.tsx ./src/**/*.ts",
-    "next:build": "next build",
-    "next:dev": "cross-env NODE_OPTIONS='--inspect' next dev",
-    "next:start": "next start",
-    "sitecore-tools:generate-map": "sitecore-tools project component generate-map",
-    "sitecore-tools:generate-map:watch": "sitecore-tools project component generate-map --watch",
-    "sitecore-tools:build": "sitecore-tools project build",
-    "dev": "cross-env NODE_ENV=development npm-run-all --serial sitecore-tools:generate-map sitecore-tools:build --parallel next:dev sitecore-tools:generate-map:watch",
-    "start": "cross-env-shell NODE_ENV=production npm-run-all --serial build next:start"
-  }
-}
+{
+  "name": "content-sdk-nextjs",
+  "description": "Application utilizing Content SDK and Next.js",
+  "version": "0.1.0",
+  "private": true,
+  "config": {
+    "appName": "content-sdk-nextjs",
+    "graphQLEndpointPath": "/sitecore/api/graph/edge",
+    "language": "en",
+    "template": "nextjs"
+  },
+  "author": {
+    "name": "Sitecore Corporation",
+    "url": "https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sitecore/content-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sitecore/content-sdk/issues"
+  },
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@sitecore-content-sdk/nextjs": "<%- version %>",
+    "@sitecore-content-sdk/analytics-core": "<%- version %>",
+    "@sitecore-content-sdk/events": "<%- version %>",
+    "@sitecore-feaas/clientside": "^0.6.0",
+    "@sitecore/components": "~2.1.0",
+    "next": "^16.2.0",
+    "next-localization": "^0.12.0",
+    "react": "^19.2.1",
+    "react-dom": "^19.2.1"
+  },
+  "devDependencies": {
+    "@sitecore-content-sdk/cli": "<%- version %>",
+    "@types/node": "^24.10.4",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "@stylistic/eslint-plugin": "^5.2.2",
+    "@typescript-eslint/eslint-plugin": "8.39.0",
+    "@typescript-eslint/parser": "8.39.0",
+    "cross-env": "~7.0.3",
+    "eslint": "^9.32.0",
+    "eslint-config-next": "16.2.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import": "2.32.0",
+    "eslint-plugin-jsdoc": "52.0.3",
+    "eslint-plugin-prettier": "^5.5.3",
+    "eslint-plugin-react": "7.37.5",
+    "eslint-plugin-react-hooks": "5.2.0",
+    "npm-run-all2": "~8.0.1",
+    "prettier": "^3.6.2",
+    "typescript": "~5.8.3"
+  },
+  "scripts": {
+    "build": "cross-env NODE_ENV=production npm-run-all --serial sitecore-tools:generate-map sitecore-tools:build next:build",
+    "lint": "eslint ./src/**/*.tsx ./src/**/*.ts",
+    "next:build": "next build",
+    "next:dev": "cross-env NODE_OPTIONS='--inspect' next dev",
+    "next:start": "next start",
+    "sitecore-tools:generate-map": "sitecore-tools project component generate-map",
+    "sitecore-tools:generate-map:watch": "sitecore-tools project component generate-map --watch",
+    "sitecore-tools:build": "sitecore-tools project build",
+    "dev": "cross-env NODE_ENV=development npm-run-all --serial sitecore-tools:generate-map sitecore-tools:build --parallel next:dev sitecore-tools:generate-map:watch",
+    "start": "cross-env-shell NODE_ENV=production npm-run-all --serial build next:start"
+  }
+}

package/dist/templates/nextjs/sitecore.config.ts.example

@@ -1,40 +1,40 @@
-import { defineConfig } from '@sitecore-content-sdk/nextjs/config';
-/**
- * @type {import('@sitecore-content-sdk/nextjs/config').SitecoreConfig}
- * See the documentation for `defineConfig`:
- * https://doc.sitecore.com/xmc/en/developers/content-sdk/the-sitecore-configuration-file.html
- */
-export default defineConfig({
-  api: {
-    edge: {
-      contextId:
-        process.env.SITECORE_EDGE_CONTEXT_ID ||
-        process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID ||
-        '',
-      clientContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID,
-      edgeUrl:
-        process.env.NEXT_PUBLIC_SITECORE_EDGE_PLATFORM_HOSTNAME ||
-        process.env.SITECORE_EDGE_PLATFORM_HOSTNAME,
-    },
-    local: {
-      apiKey: process.env.NEXT_PUBLIC_SITECORE_API_KEY || '',
-      apiHost: process.env.NEXT_PUBLIC_SITECORE_API_HOST || '',
-    },
-  },
-  defaultSite: process.env.NEXT_PUBLIC_DEFAULT_SITE_NAME,
-  defaultLanguage: process.env.NEXT_PUBLIC_DEFAULT_LANGUAGE || 'en',
-  editingSecret: process.env.SITECORE_EDITING_SECRET,
-  redirects: {
-    enabled: true,
-    locales: ['en'],
-  },
-  multisite: {
-    enabled: true,
-    useCookieResolution: () => process.env.VERCEL_ENV === 'preview',
-  },
-  personalize: {
-    scope: process.env.NEXT_PUBLIC_PERSONALIZE_SCOPE,
-    edgeTimeout: parseInt(process.env.PERSONALIZE_PROXY_EDGE_TIMEOUT!, 10),
-    cdpTimeout: parseInt(process.env.PERSONALIZE_PROXY_EDGE_TIMEOUT!, 10),
-  },
-});
+import { defineConfig } from '@sitecore-content-sdk/nextjs/config';
+/**
+ * @type {import('@sitecore-content-sdk/nextjs/config').SitecoreConfig}
+ * See the documentation for `defineConfig`:
+ * https://doc.sitecore.com/xmc/en/developers/content-sdk/the-sitecore-configuration-file.html
+ */
+export default defineConfig({
+  api: {
+    edge: {
+      contextId:
+        process.env.SITECORE_EDGE_CONTEXT_ID ||
+        process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID ||
+        '',
+      clientContextId: process.env.NEXT_PUBLIC_SITECORE_EDGE_CONTEXT_ID,
+      edgeUrl:
+        process.env.NEXT_PUBLIC_SITECORE_EDGE_PLATFORM_HOSTNAME ||
+        process.env.SITECORE_EDGE_PLATFORM_HOSTNAME,
+    },
+    local: {
+      apiKey: process.env.NEXT_PUBLIC_SITECORE_API_KEY || '',
+      apiHost: process.env.NEXT_PUBLIC_SITECORE_API_HOST || '',
+    },
+  },
+  defaultSite: process.env.NEXT_PUBLIC_DEFAULT_SITE_NAME,
+  defaultLanguage: process.env.NEXT_PUBLIC_DEFAULT_LANGUAGE || 'en',
+  editingSecret: process.env.SITECORE_EDITING_SECRET,
+  redirects: {
+    enabled: true,
+    locales: ['en'],
+  },
+  multisite: {
+    enabled: true,
+    useCookieResolution: () => process.env.VERCEL_ENV === 'preview',
+  },
+  personalize: {
+    scope: process.env.NEXT_PUBLIC_PERSONALIZE_SCOPE,
+    edgeTimeout: parseInt(process.env.PERSONALIZE_PROXY_EDGE_TIMEOUT!, 10),
+    cdpTimeout: parseInt(process.env.PERSONALIZE_PROXY_EDGE_TIMEOUT!, 10),
+  },
+});

package/dist/templates/nextjs/src/proxy.ts

@@ -1,14 +1,22 @@
-import { type NextRequest } from 'next/server';
+import { NextFetchEvent, type NextRequest } from 'next/server';
 import {
   defineProxy,
   MultisiteProxy,
   PersonalizeProxy,
   RedirectsProxy,
+  BotTrackingProxy,
 } from '@sitecore-content-sdk/nextjs/proxy';
 import sites from '.sitecore/sites.json';
 import scConfig from 'sitecore.config';
 
-export default function proxy(req: NextRequest) {
+export default function proxy(req: NextRequest, event: NextFetchEvent) {
+  // BotTrackingProxy will detect and track bots before any other proxies run
+  const botTracking = new BotTrackingProxy({
+    ...scConfig.api.edge,
+    sites,
+    fetchEvent: event,
+  });
+
   // Instantiate proxies - they will use Edge config if available, otherwise fall back to local config
   // Each proxy will skip processing if required API configuration is not available
   const multisite = new MultisiteProxy({
@@ -62,7 +70,7 @@ export default function proxy(req: NextRequest) {
     // },
   });
 
-  return defineProxy(multisite, redirects, personalize).exec(req);
+  return defineProxy(botTracking, multisite, redirects, personalize).exec(req);
 }
 
 export const config = {

package/dist/templates/nextjs/tsconfig.json

@@ -1,40 +1,40 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "paths": {
-      "components/*": ["src/components/*"],
-      "lib/*": ["src/lib/*"],
-      "temp/*": ["src/temp/*"],
-      "assets/*": ["src/assets/*"],
-      <%_ if (helper.isDev) { _%>
-      "react": ["node_modules/react"],
-      "next/*": ["node_modules/next/*"],
-      <%_ } _%>
-    },
-    "target": "es5",
-    "types": ["node"],
-    "lib": ["dom", "dom.iterable", "esnext"],
-    "allowJs": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "strictFunctionTypes": false,
-    "downlevelIteration": true,
-    "noEmit": true,
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "jsx": "preserve",
-    "allowSyntheticDefaultImports": true,
-    "noImplicitReturns": true,
-    "noImplicitAny": true,
-    "noImplicitThis": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "incremental": true,
-    "forceConsistentCasingInFileNames": false
-  },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
-  "exclude": ["node_modules"]
-}
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "components/*": ["src/components/*"],
+      "lib/*": ["src/lib/*"],
+      "temp/*": ["src/temp/*"],
+      "assets/*": ["src/assets/*"],
+      <%_ if (helper.isDev) { _%>
+      "react": ["node_modules/react"],
+      "next/*": ["node_modules/next/*"],
+      <%_ } _%>
+    },
+    "target": "es5",
+    "types": ["node"],
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "strictFunctionTypes": false,
+    "downlevelIteration": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "allowSyntheticDefaultImports": true,
+    "noImplicitReturns": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "incremental": true,
+    "forceConsistentCasingInFileNames": false
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"]
+}

package/dist/templates/nextjs-app-router/.cursor/rules/app-router-setup.mdc

@@ -1,116 +1,116 @@
----
-description: Getting started with your Sitecore Content SDK Next.js App Router project
-alwaysApply: true
-globs: []
----
-
-# Sitecore Content SDK Next.js App Router Project
-
-## Project Overview
-
-This is a Sitecore Content SDK application built with Next.js App Router. This project uses the latest Next.js features for improved performance and developer experience.
-
-Key Technologies:
-
-- Next.js App Router (React Server Components)
-- Sitecore Content SDK
-- TypeScript
-- Sitecore XM Cloud
-- next-intl for internationalization
-
-## Getting Started
-
-Development Workflow:
-
-1. Install dependencies: `npm install`
-2. Configure environment variables (copy `.env.example` to `.env.local`)
-3. Start development server: `npm run dev`
-4. Build for production: `npm run build`
-
-App Router Specifics:
-
-- Server Components by default
-- Client Components when interactivity needed
-- File-based routing in `src/app/` directory
-- Layout files for shared UI elements
-
-## Project Structure
-
-```
-src/
-  app/                 # App Router pages and layouts
-  components/          # React-specific SDK
-  lib/                 # Configuration and utilities
-  i18n/                # Internationalization setup
-```
-
-Component Development:
-
-- Server Components for data fetching and static content
-- Client Components for interactivity (use 'use client')
-- Shared components in `src/components/`
-- Follow Sitecore field handling patterns
-
-## App Router Best Practices
-
-Server vs Client Components:
-
-- Use Server Components for Sitecore content rendering
-- Use Client Components for user interactions
-- Minimize client-side JavaScript
-- Leverage server-side data fetching
-
-Routing and Layouts:
-
-- Use layout.tsx for shared page structure
-- Implement loading.tsx for loading states
-- Create error.tsx for error boundaries
-- Use page.tsx for route content
-
-## Sitecore Integration
-
-Content Rendering:
-
-- Fetch Sitecore data in Server Components
-- Use layout service for page structure
-- Handle content preview scenarios
-- Implement proper error handling
-
-Performance:
-
-- Leverage Server Components for better performance
-- Use streaming for improved loading experience
-- Implement proper caching strategies
-- Optimize images with Next.js Image component
-
-## Development Commands
-
-```bash
-npm run dev          # Start development server
-npm run build        # Build for production
-npm run start        # Start production server
-npm run lint         # Run ESLint
-npm run type-check   # Run TypeScript compiler
-```
-
-## Environment Configuration
-
-- Copy `.env.example` to `.env.local`
-- Add your Sitecore API endpoint and key
-- Configure site name and locale settings
-- Set up internationalization if needed
-
-## Next Steps
-
-1. Configure your Sitecore connection
-2. Set up internationalization (if needed)
-3. Create your first Server Component
-4. Add content types and templates
-5. Implement your layout structure
-6. Deploy to your hosting platform
-
-Referenced:
-@src/app/
-@src/components/
-@sitecore.config.ts
-@src/i18n/
+---
+description: Getting started with your Sitecore Content SDK Next.js App Router project
+alwaysApply: true
+globs: []
+---
+
+# Sitecore Content SDK Next.js App Router Project
+
+## Project Overview
+
+This is a Sitecore Content SDK application built with Next.js App Router. This project uses the latest Next.js features for improved performance and developer experience.
+
+Key Technologies:
+
+- Next.js App Router (React Server Components)
+- Sitecore Content SDK
+- TypeScript
+- Sitecore XM Cloud
+- next-intl for internationalization
+
+## Getting Started
+
+Development Workflow:
+
+1. Install dependencies: `npm install`
+2. Configure environment variables (copy `.env.example` to `.env.local`)
+3. Start development server: `npm run dev`
+4. Build for production: `npm run build`
+
+App Router Specifics:
+
+- Server Components by default
+- Client Components when interactivity needed
+- File-based routing in `src/app/` directory
+- Layout files for shared UI elements
+
+## Project Structure
+
+```
+src/
+  app/                 # App Router pages and layouts
+  components/          # React-specific SDK
+  lib/                 # Configuration and utilities
+  i18n/                # Internationalization setup
+```
+
+Component Development:
+
+- Server Components for data fetching and static content
+- Client Components for interactivity (use 'use client')
+- Shared components in `src/components/`
+- Follow Sitecore field handling patterns
+
+## App Router Best Practices
+
+Server vs Client Components:
+
+- Use Server Components for Sitecore content rendering
+- Use Client Components for user interactions
+- Minimize client-side JavaScript
+- Leverage server-side data fetching
+
+Routing and Layouts:
+
+- Use layout.tsx for shared page structure
+- Implement loading.tsx for loading states
+- Create error.tsx for error boundaries
+- Use page.tsx for route content
+
+## Sitecore Integration
+
+Content Rendering:
+
+- Fetch Sitecore data in Server Components
+- Use layout service for page structure
+- Handle content preview scenarios
+- Implement proper error handling
+
+Performance:
+
+- Leverage Server Components for better performance
+- Use streaming for improved loading experience
+- Implement proper caching strategies
+- Optimize images with Next.js Image component
+
+## Development Commands
+
+```bash
+npm run dev          # Start development server
+npm run build        # Build for production
+npm run start        # Start production server
+npm run lint         # Run ESLint
+npm run type-check   # Run TypeScript compiler
+```
+
+## Environment Configuration
+
+- Copy `.env.example` to `.env.local`
+- Add your Sitecore API endpoint and key
+- Configure site name and locale settings
+- Set up internationalization if needed
+
+## Next Steps
+
+1. Configure your Sitecore connection
+2. Set up internationalization (if needed)
+3. Create your first Server Component
+4. Add content types and templates
+5. Implement your layout structure
+6. Deploy to your hosting platform
+
+Referenced:
+@src/app/
+@src/components/
+@sitecore.config.ts
+@src/i18n/