@nextsparkjs/theme-crm 0.1.0-beta.18 → 0.1.0-beta.20

package/tests/cypress/src/session-helpers.ts

@@ -0,0 +1,94 @@
+/**
+ * CRM Theme Session Helpers
+ *
+ * Direct login functions for CRM theme tests using CRM-specific users.
+ * These helpers don't depend on ACTIVE_THEME environment variable.
+ */
+
+import { DevKeyring } from '../../../../../../test/cypress/src/classes/components/auth/DevKeyring.js'
+
+/**
+ * CRM Test Users - hardcoded for CRM theme tests
+ */
+export const CRM_USERS = {
+  OWNER: 'crm_owner_roberto@nextspark.dev',   // CEO
+  ADMIN: 'crm_admin_sofia@nextspark.dev',     // Sales Manager
+  MEMBER: 'crm_member_miguel@nextspark.dev',  // Sales Rep
+  LAURA: 'crm_member_laura@nextspark.dev',    // Marketing
+} as const
+
+/**
+ * Login as CRM Owner (CEO)
+ * Session is cached and reused across tests
+ */
+export function loginAsCrmOwner() {
+  cy.session('crm-owner-session', () => {
+    cy.visit('/login')
+    const devKeyring = new DevKeyring()
+    devKeyring.validateVisible()
+    devKeyring.quickLoginByEmail(CRM_USERS.OWNER)
+    cy.url().should('include', '/dashboard')
+  }, {
+    validate: () => {
+      cy.visit('/dashboard')
+      cy.url().should('include', '/dashboard')
+    }
+  })
+}
+
+/**
+ * Login as CRM Admin (Sales Manager)
+ * Session is cached and reused across tests
+ */
+export function loginAsCrmAdmin() {
+  cy.session('crm-admin-session', () => {
+    cy.visit('/login')
+    const devKeyring = new DevKeyring()
+    devKeyring.validateVisible()
+    devKeyring.quickLoginByEmail(CRM_USERS.ADMIN)
+    cy.url().should('include', '/dashboard')
+  }, {
+    validate: () => {
+      cy.visit('/dashboard')
+      cy.url().should('include', '/dashboard')
+    }
+  })
+}
+
+/**
+ * Login as CRM Member (Sales Rep)
+ * Session is cached and reused across tests
+ */
+export function loginAsCrmMember() {
+  cy.session('crm-member-session', () => {
+    cy.visit('/login')
+    const devKeyring = new DevKeyring()
+    devKeyring.validateVisible()
+    devKeyring.quickLoginByEmail(CRM_USERS.MEMBER)
+    cy.url().should('include', '/dashboard')
+  }, {
+    validate: () => {
+      cy.visit('/dashboard')
+      cy.url().should('include', '/dashboard')
+    }
+  })
+}
+
+/**
+ * Login as CRM Laura (Marketing)
+ * Session is cached and reused across tests
+ */
+export function loginAsCrmLaura() {
+  cy.session('crm-laura-session', () => {
+    cy.visit('/login')
+    const devKeyring = new DevKeyring()
+    devKeyring.validateVisible()
+    devKeyring.quickLoginByEmail(CRM_USERS.LAURA)
+    cy.url().should('include', '/dashboard')
+  }, {
+    validate: () => {
+      cy.visit('/dashboard')
+      cy.url().should('include', '/dashboard')
+    }
+  })
+}

package/tests/cypress/support/e2e.ts

@@ -0,0 +1,89 @@
+/**
+ * Cypress E2E Support File for Theme
+ *
+ * This file is used when running tests in npm mode (outside monorepo).
+ * In monorepo mode, the core support file is used instead via cypress.config.ts.
+ *
+ * For documentation video commands, install cypress-slow-down:
+ *   pnpm add -D cypress-slow-down
+ *   Then uncomment the doc-commands import below.
+ */
+
+import '@testing-library/cypress/add-commands'
+
+// Import @cypress/grep for test filtering by tags
+import registerCypressGrep from '@cypress/grep'
+registerCypressGrep()
+
+// Doc commands are optional (require cypress-slow-down)
+// Uncomment if you have cypress-slow-down installed:
+// import './doc-commands'
+
+// Global error handling
+Cypress.on('uncaught:exception', (err) => {
+  // Ignore React hydration errors
+  if (err.message.includes('Hydration')) {
+    return false
+  }
+  // Ignore ResizeObserver errors
+  if (err.message.includes('ResizeObserver')) {
+    return false
+  }
+  return true
+})
+
+// Global before hook
+beforeEach(() => {
+  cy.clearCookies()
+  cy.clearLocalStorage()
+})
+
+// Type declarations for @cypress/grep and custom commands
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Custom command to make API requests with better error handling
+       */
+      apiRequest(options: Partial<Cypress.RequestOptions>): Chainable<Cypress.Response<any>>
+
+      /**
+       * Login command for authenticated tests
+       */
+      login(email: string, password: string): Chainable<void>
+    }
+    interface SuiteConfigOverrides {
+      tags?: string | string[]
+    }
+    interface TestConfigOverrides {
+      tags?: string | string[]
+    }
+  }
+}
+
+// Custom API request command
+Cypress.Commands.add('apiRequest', (options) => {
+  const defaultOptions = {
+    failOnStatusCode: false,
+    timeout: 15000,
+    headers: {
+      'Content-Type': 'application/json',
+      ...options.headers
+    }
+  }
+  return cy.request({
+    ...defaultOptions,
+    ...options
+  })
+})
+
+// Login command for authenticated tests
+Cypress.Commands.add('login', (email: string, password: string) => {
+  cy.session([email, password], () => {
+    cy.visit('/login')
+    cy.get('[data-testid="email-input"], input[name="email"]').type(email)
+    cy.get('[data-testid="password-input"], input[name="password"]').type(password)
+    cy.get('[data-testid="submit-button"], button[type="submit"]').click()
+    cy.url().should('include', '/dashboard')
+  })
+})

package/tests/cypress.config.ts

@@ -0,0 +1,165 @@
+/**
+ * Cypress Configuration for crm Theme
+ *
+ * This config works in both monorepo and npm mode.
+ * Run with: NEXT_PUBLIC_ACTIVE_THEME=default pnpm cy:open
+ */
+
+import { defineConfig } from 'cypress'
+import path from 'path'
+import fs from 'fs'
+import { fileURLToPath } from 'url'
+
+// ESM-compatible __dirname
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+// Paths relative to this config file
+const themeRoot = path.resolve(__dirname, '..')
+const projectRoot = path.resolve(__dirname, '../../../..')
+const narrationsOutputDir = path.join(__dirname, 'cypress/videos/narrations')
+
+// Detect if running in npm mode (no packages/core folder) vs monorepo
+const isNpmMode = !fs.existsSync(path.join(projectRoot, 'packages/core'))
+
+// Load environment variables
+import dotenv from 'dotenv'
+dotenv.config({ path: path.join(projectRoot, '.env') })
+
+// Server port (from .env or default 3000)
+const port = process.env.PORT || 3000
+
+export default defineConfig({
+  e2e: {
+    // Base URL for the application
+    baseUrl: `http://localhost:${port}`,
+
+    // Spec patterns: theme tests (core tests only in monorepo)
+    specPattern: isNpmMode
+      ? [
+          // npm mode: only theme tests
+          path.join(__dirname, 'cypress/e2e/**/*.cy.{js,ts}'),
+        ]
+      : [
+          // Monorepo: core tests + theme tests
+          path.join(projectRoot, 'packages/core/tests/cypress/e2e/core/**/*.cy.{js,ts}'),
+          path.join(__dirname, 'cypress/e2e/**/*.cy.{js,ts}'),
+        ],
+
+    // Support file (theme-local in npm mode, core in monorepo)
+    supportFile: isNpmMode
+      ? path.join(__dirname, 'cypress/support/e2e.ts')
+      : path.join(projectRoot, 'packages/core/tests/cypress/support/e2e.ts'),
+
+    // Fixtures folder (theme-specific)
+    fixturesFolder: path.join(__dirname, 'cypress/fixtures'),
+
+    // Output folders (theme-specific)
+    downloadsFolder: path.join(__dirname, 'cypress/downloads'),
+    screenshotsFolder: path.join(__dirname, 'cypress/screenshots'),
+    videosFolder: path.join(__dirname, 'cypress/videos'),
+
+    // Viewport settings
+    viewportWidth: 1280,
+    viewportHeight: 720,
+
+    // Video and screenshot settings
+    video: true,
+    screenshotOnRunFailure: true,
+
+    // Timeouts
+    defaultCommandTimeout: 10000,
+    requestTimeout: 10000,
+    responseTimeout: 10000,
+    pageLoadTimeout: 30000,
+
+    // Browser settings
+    chromeWebSecurity: false,
+
+    // Test isolation
+    testIsolation: true,
+
+    // Retry settings
+    retries: {
+      runMode: 1,
+      openMode: 0,
+    },
+
+    // Environment variables
+    env: {
+      // Theme info
+      ACTIVE_THEME: 'crm',
+      THEME_PATH: themeRoot,
+
+      // Test user credentials
+      TEST_USER_EMAIL: 'user@example.com',
+      TEST_USER_PASSWORD: 'Testing1234',
+
+      // Feature flags
+      ENABLE_ALLURE: true,
+
+      // Allure reporting
+      allureResultsPath: path.join(__dirname, 'cypress/allure-results'),
+
+      // API settings
+      API_URL: `http://localhost:${port}/api`,
+      API_BASE_URL: `http://localhost:${port}`,
+
+      // @cypress/grep - filter specs by tags
+      grepFilterSpecs: true,
+      grepOmitFiltered: true,
+    },
+
+    async setupNodeEvents(on, config) {
+      // Allure plugin setup (allure-cypress)
+      const { allureCypress } = await import('allure-cypress/reporter')
+      allureCypress(on, config, {
+        resultsDir: path.join(__dirname, 'cypress/allure-results'),
+      })
+
+      // @cypress/grep plugin for test filtering by tags
+      const grepPlugin = await import('@cypress/grep/src/plugin.js')
+      ;(grepPlugin.default || grepPlugin)(config)
+
+      // Documentation video tasks
+      on('task', {
+        /**
+         * Save narrations to JSON file for post-processing
+         */
+        saveNarrations({ specName, narrations }: { specName: string; narrations: unknown[] }) {
+          // Ensure output directory exists
+          if (!fs.existsSync(narrationsOutputDir)) {
+            fs.mkdirSync(narrationsOutputDir, { recursive: true })
+          }
+
+          const filename = `${specName}-narrations.json`
+          const filepath = path.join(narrationsOutputDir, filename)
+
+          fs.writeFileSync(filepath, JSON.stringify(narrations, null, 2))
+          console.log(`📝 Narrations saved to: ${filepath}`)
+
+          return null
+        },
+
+        /**
+         * Add narration entry (called per narration)
+         */
+        addNarration(narration: unknown) {
+          // This could be used for real-time streaming to a narration service
+          console.log('🎙️ Narration:', narration)
+          return null
+        },
+      })
+
+      return config
+    },
+  },
+
+  // Component testing (future use)
+  component: {
+    devServer: {
+      framework: 'next',
+      bundler: 'webpack',
+    },
+  },
+})

package/tests/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../../../tsconfig.cypress.json",
+  "compilerOptions": {
+    "baseUrl": "../../../..",
+    "paths": {
+      "@/*": ["./*"],
+      "@/core/*": ["./core/*"],
+      "@/contents/*": ["./contents/*"]
+    }
+  },
+  "include": [
+    "../../../../cypress.d.ts",
+    "cypress/**/*.ts"
+  ]
+}