create-content-sdk-app 2.0.0-canary.8 → 2.0.0

package/dist/templates/angular/src/server.ts

@@ -0,0 +1,65 @@
+import {
+  AngularNodeAppEngine,
+  createNodeRequestHandler,
+  isMainModule,
+  writeResponseToNodeResponse,
+} from '@angular/ssr/node';
+import express from 'express';
+import { join } from 'node:path';
+import { createLoaderDataServiceMiddleware } from '@sitecore-content-sdk/angular';
+import { LOADERS } from './app/loaders';
+
+const browserDistFolder = join(import.meta.dirname, '../browser');
+
+const app = express();
+const angularApp = new AngularNodeAppEngine();
+
+/**
+ * Loader data endpoint (/_data). Must use the same loaders as the client registry
+ * so client-side navigation can fetch route data via POST /_data.
+ */
+app.use(express.json());
+app.use(createLoaderDataServiceMiddleware({ loaders: LOADERS }));
+/**
+ * Serve static files from /browser
+ */
+app.use(
+  express.static(browserDistFolder, {
+    maxAge: '1y',
+    index: false,
+    redirect: false,
+  })
+);
+
+/**
+ * Handle all other requests by rendering the Angular application.
+ * Catches ExternalRedirectError from loaders so server-side external redirects send HTTP 302.
+ */
+app.use((req, res, next) => {
+  angularApp
+    .handle(req)
+    .then((response) => (response ? writeResponseToNodeResponse(response, res) : next()))
+    .catch((err) => {
+      next(err);
+    });
+});
+
+/**
+ * Start the server if this module is the main entry point
+ * The server listens on the port defined by the `PORT` environment variable, or defaults to 4000.
+ */
+if (isMainModule(import.meta.url)) {
+  const port = process.env.PORT || 4000;
+  app.listen(port, (error) => {
+    if (error) {
+      throw error;
+    }
+
+    console.log(`Node Express server listening on http://localhost:${port}`);
+  });
+}
+
+/**
+ * Request handler used by the Angular CLI (for dev-server and during build) or Firebase Cloud Functions.
+ */
+export const reqHandler = createNodeRequestHandler(app);

package/dist/templates/angular/src/styles.css

@@ -0,0 +1,3 @@
+/* You can add global styles to this file, and also import other style files */
+
+@import "tailwindcss";

package/dist/templates/angular/tsconfig.json

@@ -0,0 +1,38 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "importHelpers": true,
+    "outDir": "./dist/out-tsc",
+    "sourceMap": true,
+    "declaration": false,
+    "moduleResolution": "bundler",
+    "emitDecoratorMetadata": true,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "allowJs": true,
+    "target": "es2022",
+    "module": "es2022",
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "newLine": "LF",
+    "types": ["node"],
+    // add additional type root in case of monorepo where dependencies are hoisted to root node_modules
+    "typeRoots": ["node_modules/@types", "../node_modules/@types"],
+    "lib": ["es2019", "dom", "esnext.asynciterable"],
+    "paths": {
+      "@angular/*": ["./node_modules/@angular/*"],
+      "rxjs": ["node_modules/rxjs", "./node_modules/rxjs"],
+      "lib/*": ["src/app/lib/*"],
+      ".sitecore": ["./.sitecore"]
+    },
+    "baseUrl": "./",
+    "esModuleInterop": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.spec.ts"]
+}

package/dist/templates/angular/tsconfig.spec.json

@@ -0,0 +1,10 @@
+/* To learn more about Typescript configuration file: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html. */
+/* To learn more about Angular compiler options: https://angular.dev/reference/configs/angular-compiler-options. */
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./out-tsc/spec",
+    "types": ["vitest/globals"]
+  },
+  "include": ["src/**/*.d.ts", "src/**/*.spec.ts"]
+}

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/
+