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

package/dist/templates/nextjs/.cursor/rules/general.mdc

@@ -1,81 +1,81 @@
----
-description: Core coding principles for your Sitecore project
-alwaysApply: true
-globs: []
----
-
-# General Coding Principles
-
-## Universal Standards
-
-DRY Principle:
-
-- Don't Repeat Yourself - extract common functionality
-- Create reusable utilities and helper functions
-- Use composition over inheritance
-- Share types and interfaces across modules
-
-SOLID Principles:
-
-- Single Responsibility: each function/class has one purpose
-- Open/Closed: extend functionality through composition
-- Dependency Inversion: depend on abstractions, not implementations
-
-Code Clarity:
-
-- Write self-documenting code with clear intent
-- Use meaningful names that express business concepts
-- Prefer explicit over implicit behavior
-- Make dependencies and requirements obvious
-
-## Architecture Patterns
-
-Modular Design:
-
-- Organize code into focused, cohesive modules
-- Minimize coupling between modules
-- Use clear interfaces between layers
-- Follow established patterns consistently
-
-Data Flow:
-
-- Prefer unidirectional data flow
-- Validate inputs at system boundaries
-- Transform data at appropriate layers
-- Handle errors close to their source
-
-Testing:
-
-- Write testable code with minimal dependencies
-- Use dependency injection for better testability
-- Mock external services and side effects
-- Test behavior, not implementation details
-
-## Development Standards
-
-Version Control:
-
-- Write descriptive commit messages
-- Keep commits focused and atomic
-- Use branching strategies appropriate to team size
-- Review code before merging
-
-Documentation:
-
-- Document public APIs and interfaces
-- Include usage examples for complex functionality
-- Keep documentation close to code
-- Update documentation with code changes
-
-Performance:
-
-- Optimize for readability first, performance second
-- Profile before optimizing
-- Cache expensive operations appropriately
-- Consider memory usage and cleanup
-
-Referenced:
-@src/components/
-@src/lib/
-@package.json
-
+---
+description: Core coding principles for your Sitecore project
+alwaysApply: true
+globs: []
+---
+
+# General Coding Principles
+
+## Universal Standards
+
+DRY Principle:
+
+- Don't Repeat Yourself - extract common functionality
+- Create reusable utilities and helper functions
+- Use composition over inheritance
+- Share types and interfaces across modules
+
+SOLID Principles:
+
+- Single Responsibility: each function/class has one purpose
+- Open/Closed: extend functionality through composition
+- Dependency Inversion: depend on abstractions, not implementations
+
+Code Clarity:
+
+- Write self-documenting code with clear intent
+- Use meaningful names that express business concepts
+- Prefer explicit over implicit behavior
+- Make dependencies and requirements obvious
+
+## Architecture Patterns
+
+Modular Design:
+
+- Organize code into focused, cohesive modules
+- Minimize coupling between modules
+- Use clear interfaces between layers
+- Follow established patterns consistently
+
+Data Flow:
+
+- Prefer unidirectional data flow
+- Validate inputs at system boundaries
+- Transform data at appropriate layers
+- Handle errors close to their source
+
+Testing:
+
+- Write testable code with minimal dependencies
+- Use dependency injection for better testability
+- Mock external services and side effects
+- Test behavior, not implementation details
+
+## Development Standards
+
+Version Control:
+
+- Write descriptive commit messages
+- Keep commits focused and atomic
+- Use branching strategies appropriate to team size
+- Review code before merging
+
+Documentation:
+
+- Document public APIs and interfaces
+- Include usage examples for complex functionality
+- Keep documentation close to code
+- Update documentation with code changes
+
+Performance:
+
+- Optimize for readability first, performance second
+- Profile before optimizing
+- Cache expensive operations appropriately
+- Consider memory usage and cleanup
+
+Referenced:
+@src/components/
+@src/lib/
+@package.json
+

package/dist/templates/nextjs/.cursor/rules/javascript.mdc

@@ -1,112 +1,112 @@
----
-description: JavaScript/TypeScript rules for your Sitecore project
-alwaysApply: false
-globs:
-  - '**/*.js'
-  - '**/*.ts'
-  - '**/*.tsx'
-  - '**/*.mjs'
----
-
-# JavaScript/TypeScript Rules
-
-## Naming Conventions
-
-Variables and Functions:
-
-- Use camelCase: `getUserData()`, `isLoading`, `currentUser`
-- Boolean variables: prefix with `is`, `has`, `can`, `should`
-- Event handlers: prefix with `handle` or `on`: `handleClick`, `onSubmit`
-
-Components (React):
-
-- Use PascalCase: `SitecoreComponent`, `PageLayout`, `ContentBlock`
-- File names match component names: `SitecoreComponent.tsx`
-
-Constants:
-
-- Use UPPER_SNAKE_CASE: `API_ENDPOINT`, `DEFAULT_TIMEOUT`, `MAX_RETRIES`
-- Export at module level when shared
-
-Directories:
-
-- Use kebab-case: `src/components`, `src/api-clients`, `src/sitecore-utils`
-- Organize by feature when appropriate: `src/content-management/`
-
-Types and Interfaces:
-
-- Use PascalCase with descriptive names: `ContentItem`, `LayoutProps`, `SitecoreConfig`
-- Prefix interfaces with `I` only when needed for disambiguation
-
-## Code Layout and Organization
-
-Directory Structure:
-
-```
-src/
-  components/          # UI components (React)
-  lib/                 # Configuration and utilities
-  pages/               # Next.js pages (or app/ for App Router)
-  assets/              # Static assets and styles
-  types/               # TypeScript type definitions
-  hooks/               # Custom React hooks
-```
-
-File Organization:
-
-- Group related functionality in feature directories
-- Keep components co-located with their styles and tests
-- Export public APIs through index.ts files
-
-## Error Handling
-
-API Calls:
-
-- Always wrap in try/catch blocks
-- Throw custom errors with context: `SitecoreFetchError`, `ConfigurationError`
-- Handle edge cases with guard clauses
-
-```typescript
-async function fetchContent(id: string): Promise<ContentItem> {
-  if (!id) {
-    throw new Error('Content ID is required');
-  }
-
-  try {
-    const response = await sitecoreClient.getItem(id);
-    return response.data;
-  } catch (error) {
-    throw new SitecoreFetchError(`Failed to fetch content ${id}`, error);
-  }
-}
-```
-
-## Security
-
-Input Validation:
-
-- Sanitize user inputs before processing
-- Validate data at application boundaries
-- Use type guards for runtime type checking
-- Escape content when rendering to prevent XSS
-
-## Performance
-
-Optimization Patterns:
-
-- Cache API responses using React Query or SWR
-- Memoize components with React.memo when appropriate
-- Lazy-load non-critical modules: `const Component = lazy(() => import('./Component'))`
-- Use useCallback and useMemo for expensive operations
-
-TypeScript:
-
-- Enable strict mode in tsconfig.json
-- Prefer type assertions over any: `value as ContentItem`
-- Use discriminated unions for complex state management
-
-Referenced:
-@src/components/
-@src/lib/
-@src/types/
-
+---
+description: JavaScript/TypeScript rules for your Sitecore project
+alwaysApply: false
+globs:
+  - '**/*.js'
+  - '**/*.ts'
+  - '**/*.tsx'
+  - '**/*.mjs'
+---
+
+# JavaScript/TypeScript Rules
+
+## Naming Conventions
+
+Variables and Functions:
+
+- Use camelCase: `getUserData()`, `isLoading`, `currentUser`
+- Boolean variables: prefix with `is`, `has`, `can`, `should`
+- Event handlers: prefix with `handle` or `on`: `handleClick`, `onSubmit`
+
+Components (React):
+
+- Use PascalCase: `SitecoreComponent`, `PageLayout`, `ContentBlock`
+- File names match component names: `SitecoreComponent.tsx`
+
+Constants:
+
+- Use UPPER_SNAKE_CASE: `API_ENDPOINT`, `DEFAULT_TIMEOUT`, `MAX_RETRIES`
+- Export at module level when shared
+
+Directories:
+
+- Use kebab-case: `src/components`, `src/api-clients`, `src/sitecore-utils`
+- Organize by feature when appropriate: `src/content-management/`
+
+Types and Interfaces:
+
+- Use PascalCase with descriptive names: `ContentItem`, `LayoutProps`, `SitecoreConfig`
+- Prefix interfaces with `I` only when needed for disambiguation
+
+## Code Layout and Organization
+
+Directory Structure:
+
+```
+src/
+  components/          # UI components (React)
+  lib/                 # Configuration and utilities
+  pages/               # Next.js pages (or app/ for App Router)
+  assets/              # Static assets and styles
+  types/               # TypeScript type definitions
+  hooks/               # Custom React hooks
+```
+
+File Organization:
+
+- Group related functionality in feature directories
+- Keep components co-located with their styles and tests
+- Export public APIs through index.ts files
+
+## Error Handling
+
+API Calls:
+
+- Always wrap in try/catch blocks
+- Throw custom errors with context: `SitecoreFetchError`, `ConfigurationError`
+- Handle edge cases with guard clauses
+
+```typescript
+async function fetchContent(id: string): Promise<ContentItem> {
+  if (!id) {
+    throw new Error('Content ID is required');
+  }
+
+  try {
+    const response = await sitecoreClient.getItem(id);
+    return response.data;
+  } catch (error) {
+    throw new SitecoreFetchError(`Failed to fetch content ${id}`, error);
+  }
+}
+```
+
+## Security
+
+Input Validation:
+
+- Sanitize user inputs before processing
+- Validate data at application boundaries
+- Use type guards for runtime type checking
+- Escape content when rendering to prevent XSS
+
+## Performance
+
+Optimization Patterns:
+
+- Cache API responses using React Query or SWR
+- Memoize components with React.memo when appropriate
+- Lazy-load non-critical modules: `const Component = lazy(() => import('./Component'))`
+- Use useCallback and useMemo for expensive operations
+
+TypeScript:
+
+- Enable strict mode in tsconfig.json
+- Prefer type assertions over any: `value as ContentItem`
+- Use discriminated unions for complex state management
+
+Referenced:
+@src/components/
+@src/lib/
+@src/types/
+

package/dist/templates/nextjs/.cursor/rules/project-setup.mdc

@@ -1,100 +1,100 @@
----
-description: Getting started with your Sitecore Content SDK Next.js project
-alwaysApply: true
-globs: []
----
-
-# Sitecore Content SDK Next.js Project
-
-## Project Overview
-
-This is a Sitecore Content SDK application built with Next.js. The project structure follows Sitecore best practices for XM Cloud development.
-
-Key Technologies:
-
-- Next.js (React framework)
-- Sitecore Content SDK
-- TypeScript
-- Sitecore XM Cloud
-
-## 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`
-
-Environment Configuration:
-
-- Copy `.env.example` to `.env.local`
-- Add your Sitecore API endpoint and key
-- Configure site name and other settings
-
-## Sitecore Integration
-
-Configuration:
-
-- Configure Sitecore connection in `sitecore.config.ts`
-- Register components in the component map
-- Use Sitecore field components for content rendering
-- Follow Sitecore's layout service patterns
-
-Component Development:
-
-- Create components in `src/components/`
-- Export from component files for registration
-- Use TypeScript interfaces for component props
-- Follow Sitecore field handling patterns
-
-## Project Structure
-
-```
-src/
-  components/          # React-specific SDK
-  lib/                 # Configuration and utilities
-  pages/               # Next.js pages
-  assets/              # Static assets and styles
-```
-
-## Best Practices
-
-Sitecore Components:
-
-- Use descriptive component names
-- Handle field validation gracefully
-- Implement proper error boundaries
-- Cache content when appropriate
-
-Performance:
-
-- Optimize images using Next.js Image component
-- Implement proper loading states
-- Use React.memo for expensive components
-- Consider server-side rendering implications
-
-## 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
-```
-
-## Next Steps
-
-1. Configure your Sitecore connection
-2. Create your first component
-3. Add content types and templates
-4. Set up your development workflow
-5. Deploy to your hosting platform
-
-Referenced:
-@src/components/
-@sitecore.config.ts
-@package.json
-@.env.example
-
+---
+description: Getting started with your Sitecore Content SDK Next.js project
+alwaysApply: true
+globs: []
+---
+
+# Sitecore Content SDK Next.js Project
+
+## Project Overview
+
+This is a Sitecore Content SDK application built with Next.js. The project structure follows Sitecore best practices for XM Cloud development.
+
+Key Technologies:
+
+- Next.js (React framework)
+- Sitecore Content SDK
+- TypeScript
+- Sitecore XM Cloud
+
+## 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`
+
+Environment Configuration:
+
+- Copy `.env.example` to `.env.local`
+- Add your Sitecore API endpoint and key
+- Configure site name and other settings
+
+## Sitecore Integration
+
+Configuration:
+
+- Configure Sitecore connection in `sitecore.config.ts`
+- Register components in the component map
+- Use Sitecore field components for content rendering
+- Follow Sitecore's layout service patterns
+
+Component Development:
+
+- Create components in `src/components/`
+- Export from component files for registration
+- Use TypeScript interfaces for component props
+- Follow Sitecore field handling patterns
+
+## Project Structure
+
+```
+src/
+  components/          # React-specific SDK
+  lib/                 # Configuration and utilities
+  pages/               # Next.js pages
+  assets/              # Static assets and styles
+```
+
+## Best Practices
+
+Sitecore Components:
+
+- Use descriptive component names
+- Handle field validation gracefully
+- Implement proper error boundaries
+- Cache content when appropriate
+
+Performance:
+
+- Optimize images using Next.js Image component
+- Implement proper loading states
+- Use React.memo for expensive components
+- Consider server-side rendering implications
+
+## 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
+```
+
+## Next Steps
+
+1. Configure your Sitecore connection
+2. Create your first component
+3. Add content types and templates
+4. Set up your development workflow
+5. Deploy to your hosting platform
+
+Referenced:
+@src/components/
+@sitecore.config.ts
+@package.json
+@.env.example
+