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

package/tests/cypress/src/components/EntityDetail.ts

@@ -0,0 +1,290 @@
+/**
+ * Generic Entity Detail POM for CRM Theme
+ *
+ * Page Object Model for entity detail pages in CRM theme.
+ * Reusable for all entities by providing the entity slug and singular name.
+ *
+ * Usage:
+ *   const contactDetail = new EntityDetail('contacts', 'contact')
+ *   const opportunityDetail = new EntityDetail('opportunities', 'opportunity')
+ */
+
+export interface EntityDetailConfig {
+  /** Plural entity slug for URL (e.g., 'contacts', 'opportunities') */
+  entitySlug: string
+  /** Singular entity name for selectors (e.g., 'contact', 'opportunity') */
+  singularName: string
+  /** Custom sections this entity has (e.g., ['activities', 'notes'] for contacts) */
+  sections?: string[]
+}
+
+export class EntityDetail {
+  private entitySlug: string
+  private singularName: string
+  private sections: string[]
+
+  /**
+   * Create a new EntityDetail POM instance
+   * @param entitySlug - Plural entity slug for URL (e.g., 'contacts', 'opportunities')
+   * @param singularName - Singular name for selectors (e.g., 'contact', 'opportunity')
+   * @param sections - Custom sections this entity has
+   */
+  constructor(entitySlug: string, singularName: string, sections: string[] = []) {
+    this.entitySlug = entitySlug
+    this.singularName = singularName
+    this.sections = sections
+  }
+
+  // ============================================
+  // DYNAMIC SELECTORS
+  // ============================================
+
+  /**
+   * Get selectors for this entity detail page
+   */
+  get selectors() {
+    return {
+      // Page container
+      page: `[data-cy="${this.singularName}-detail-page"]`,
+
+      // Header elements
+      header: `[data-cy="${this.singularName}-detail-header"]`,
+      title: `[data-cy="${this.singularName}-title"]`,
+      backButton: `[data-cy="${this.singularName}-back-btn"]`,
+      editButton: `[data-cy="${this.singularName}-edit-btn"]`,
+      deleteButton: `[data-cy="${this.singularName}-delete-btn"]`,
+
+      // Status
+      statusBadge: `[data-cy="${this.singularName}-status-badge"]`,
+
+      // Panels
+      fieldsPanel: `[data-cy="${this.singularName}-fields-panel"]`,
+      descriptionPanel: `[data-cy="${this.singularName}-description-panel"]`,
+
+      // Dynamic section selector
+      section: (sectionName: string) => `[data-cy="${this.singularName}-${sectionName}-section"]`,
+
+      // Related item in a section (e.g., contact-activity-{id})
+      relatedItem: (relatedType: string, id: string) => `[data-cy="${this.singularName}-${relatedType}-${id}"]`,
+
+      // Generic panels (stats, etc.)
+      statsCards: `[data-cy="${this.singularName}-stats-cards"]`,
+    }
+  }
+
+  // ============================================
+  // STATIC FACTORY METHODS
+  // ============================================
+
+  /**
+   * Pre-configured entity detail configurations for CRM entities
+   */
+  static configs: Record<string, EntityDetailConfig> = {
+    // Core CRM entities
+    leads: { entitySlug: 'leads', singularName: 'lead', sections: ['activities', 'notes'] },
+    contacts: { entitySlug: 'contacts', singularName: 'contact', sections: ['activities', 'notes', 'opportunities'] },
+    companies: { entitySlug: 'companies', singularName: 'company', sections: ['contacts', 'opportunities', 'notes'] },
+    opportunities: { entitySlug: 'opportunities', singularName: 'opportunity', sections: ['activities', 'notes'] },
+    activities: { entitySlug: 'activities', singularName: 'activity', sections: [] },
+    campaigns: { entitySlug: 'campaigns', singularName: 'campaign', sections: ['leads', 'activities'] },
+    pipelines: { entitySlug: 'pipelines', singularName: 'pipeline', sections: ['stages'] },
+    products: { entitySlug: 'products', singularName: 'product', sections: [] },
+    notes: { entitySlug: 'notes', singularName: 'note', sections: [] },
+  }
+
+  /**
+   * Create an EntityDetail from pre-configured entity name
+   */
+  static for(entityName: keyof typeof EntityDetail.configs): EntityDetail {
+    const config = EntityDetail.configs[entityName]
+    if (!config) {
+      throw new Error(`Unknown entity: ${entityName}. Available: ${Object.keys(EntityDetail.configs).join(', ')}`)
+    }
+    return new EntityDetail(config.entitySlug, config.singularName, config.sections)
+  }
+
+  // ============================================
+  // VALIDATION METHODS
+  // ============================================
+
+  /**
+   * Validate the detail page is visible
+   */
+  validatePageVisible() {
+    cy.get(this.selectors.page).should('be.visible')
+    return this
+  }
+
+  /**
+   * Validate the header is visible
+   */
+  validateHeaderVisible() {
+    cy.get(this.selectors.header).should('be.visible')
+    return this
+  }
+
+  /**
+   * Validate the title text
+   */
+  validateTitle(expectedTitle: string) {
+    cy.get(this.selectors.title).should('contain.text', expectedTitle)
+    return this
+  }
+
+  /**
+   * Validate the status badge has specific text
+   */
+  validateStatus(expectedStatus: string) {
+    cy.get(this.selectors.statusBadge).should('contain.text', expectedStatus)
+    return this
+  }
+
+  /**
+   * Validate the fields panel is visible
+   */
+  validateFieldsPanelVisible() {
+    cy.get(this.selectors.fieldsPanel).should('be.visible')
+    return this
+  }
+
+  /**
+   * Validate a custom section is visible
+   */
+  validateSectionVisible(sectionName: string) {
+    cy.get(this.selectors.section(sectionName)).should('be.visible')
+    return this
+  }
+
+  /**
+   * Validate edit button is visible
+   */
+  validateEditButtonVisible() {
+    cy.get(this.selectors.editButton).should('be.visible')
+    return this
+  }
+
+  /**
+   * Validate delete button is visible
+   */
+  validateDeleteButtonVisible() {
+    cy.get(this.selectors.deleteButton).should('be.visible')
+    return this
+  }
+
+  /**
+   * Validate edit button is not visible (user doesn't have permission)
+   */
+  validateEditButtonHidden() {
+    cy.get(this.selectors.editButton).should('not.exist')
+    return this
+  }
+
+  /**
+   * Validate delete button is not visible (user doesn't have permission)
+   */
+  validateDeleteButtonHidden() {
+    cy.get(this.selectors.deleteButton).should('not.exist')
+    return this
+  }
+
+  // ============================================
+  // INTERACTION METHODS
+  // ============================================
+
+  /**
+   * Click the back button to return to list
+   */
+  clickBack() {
+    cy.get(this.selectors.backButton).click()
+    cy.url().should('include', `/dashboard/${this.entitySlug}`)
+    return this
+  }
+
+  /**
+   * Click the edit button to open edit form
+   */
+  clickEdit() {
+    cy.get(this.selectors.editButton).click()
+    cy.url().should('include', '/edit')
+    return this
+  }
+
+  /**
+   * Click the delete button (will open confirmation dialog)
+   */
+  clickDelete() {
+    cy.get(this.selectors.deleteButton).click()
+    return this
+  }
+
+  /**
+   * Confirm deletion in the dialog
+   */
+  confirmDelete() {
+    cy.get('[data-cy="confirm-delete-btn"]').click()
+    return this
+  }
+
+  /**
+   * Cancel deletion in the dialog
+   */
+  cancelDelete() {
+    cy.get('[data-cy="cancel-delete-btn"]').click()
+    return this
+  }
+
+  /**
+   * Click on a related item in a section
+   */
+  clickRelatedItem(relatedType: string, id: string) {
+    cy.get(this.selectors.relatedItem(relatedType, id)).click()
+    return this
+  }
+
+  // ============================================
+  // WAIT METHODS
+  // ============================================
+
+  /**
+   * Wait for the detail page to load
+   */
+  waitForPageLoad() {
+    cy.get(this.selectors.page).should('be.visible')
+    return this
+  }
+
+  /**
+   * Visit the detail page directly
+   */
+  visit(id: string) {
+    cy.visit(`/dashboard/${this.entitySlug}/${id}`)
+    this.waitForPageLoad()
+    return this
+  }
+
+  // ============================================
+  // FIELD VALUE ASSERTIONS
+  // ============================================
+
+  /**
+   * Assert a field value in the fields panel
+   * Uses FieldDisplay component pattern
+   */
+  assertFieldValue(fieldLabel: string, expectedValue: string) {
+    cy.get(this.selectors.fieldsPanel)
+      .contains(fieldLabel)
+      .parent()
+      .should('contain.text', expectedValue)
+    return this
+  }
+
+  /**
+   * Assert the description panel contains text
+   */
+  assertDescriptionContains(text: string) {
+    cy.get(this.selectors.descriptionPanel).should('contain.text', text)
+    return this
+  }
+}
+
+export default EntityDetail

package/tests/cypress/src/components/EntityForm.ts

@@ -0,0 +1,357 @@
+/**
+ * Generic Entity Form POM for CRM Theme
+ *
+ * Page Object Model for entity create/edit forms in CRM theme.
+ * Uses standardized data-cy selectors from entities.json.
+ *
+ * Convention: {slug}-{component}-{detail}
+ * Examples: leads-form, contacts-field-email, opportunities-form-submit
+ *
+ * Usage:
+ *   const leadForm = EntityForm.for('leads')
+ *   const contactForm = EntityForm.for('contacts')
+ */
+
+// Import entity configs from CRM theme
+import entitiesConfig from '../../fixtures/entities.json'
+
+export interface EntityConfig {
+  slug: string
+  singular: string
+  plural: string
+  tableName: string
+  fields: string[]
+  sections: string[]
+  filters: string[]
+}
+
+export class EntityForm {
+  private config: EntityConfig
+  private slug: string
+
+  /**
+   * Create a new EntityForm POM instance from entity config
+   */
+  constructor(entityKey: string) {
+    const config = entitiesConfig.entities[entityKey as keyof typeof entitiesConfig.entities]
+    if (!config) {
+      throw new Error(`Unknown entity: ${entityKey}. Available: ${Object.keys(entitiesConfig.entities).join(', ')}`)
+    }
+    this.config = config as EntityConfig
+    this.slug = config.slug
+  }
+
+  // ============================================
+  // STATIC FACTORY METHOD
+  // ============================================
+
+  /**
+   * Create an EntityForm from entity key
+   */
+  static for(entityKey: string): EntityForm {
+    return new EntityForm(entityKey)
+  }
+
+  // ============================================
+  // DYNAMIC SELECTORS (from entities.json convention)
+  // ============================================
+
+  /**
+   * Get selectors for this entity form following the standard convention
+   */
+  get selectors() {
+    const slug = this.slug
+    return {
+      // Page and form containers
+      page: `[data-cy="${slug}-form-page"]`,
+      form: `[data-cy="${slug}-form"]`,
+      pageTitle: '[data-cy="page-title"]',
+
+      // Buttons
+      submitButton: `[data-cy="${slug}-form-submit"]`,
+      cancelButton: `[data-cy="${slug}-form-cancel"]`,
+
+      // Sections
+      section: (sectionName: string) => `[data-cy="${slug}-section-${sectionName}"]`,
+
+      // Fields
+      field: (fieldName: string) => `[data-cy="${slug}-field-${fieldName}"]`,
+      fieldInput: (fieldName: string) => `[data-cy="${slug}-field-${fieldName}"] input`,
+      fieldTextarea: (fieldName: string) => `[data-cy="${slug}-field-${fieldName}"] textarea`,
+      fieldSelect: (fieldName: string) => `[data-cy="${slug}-field-${fieldName}"] [role="combobox"]`,
+      fieldCheckbox: (fieldName: string) => `[data-cy="${slug}-field-${fieldName}"] input[type="checkbox"]`,
+      fieldOption: (fieldName: string, value: string) => `[data-cy="${slug}-field-${fieldName}-option-${value}"]`,
+      fieldError: (fieldName: string) => `[data-cy="${slug}-field-${fieldName}-error"]`,
+    }
+  }
+
+  /**
+   * Get the entity config
+   */
+  get entityConfig(): EntityConfig {
+    return this.config
+  }
+
+  /**
+   * Get available fields for this entity
+   */
+  get fields(): string[] {
+    return this.config.fields
+  }
+
+  /**
+   * Get available sections for this entity
+   */
+  get sections(): string[] {
+    return this.config.sections
+  }
+
+  // ============================================
+  // VALIDATION METHODS
+  // ============================================
+
+  /**
+   * Validate the form page is visible
+   */
+  validatePageVisible() {
+    cy.get(this.selectors.page).should('be.visible')
+    return this
+  }
+
+  /**
+   * Validate the form is visible
+   */
+  validateFormVisible() {
+    cy.get(this.selectors.form).should('be.visible')
+    return this
+  }
+
+  /**
+   * Validate the page title text
+   */
+  validatePageTitle(expectedTitle: string) {
+    cy.get(this.selectors.pageTitle).should('contain.text', expectedTitle)
+    return this
+  }
+
+  /**
+   * Validate a section is visible
+   */
+  validateSectionVisible(sectionName: string) {
+    cy.get(this.selectors.section(sectionName)).should('be.visible')
+    return this
+  }
+
+  /**
+   * Validate a field is visible
+   */
+  validateFieldVisible(fieldName: string) {
+    cy.get(this.selectors.field(fieldName)).should('be.visible')
+    return this
+  }
+
+  /**
+   * Validate a field has an error message
+   */
+  validateFieldHasError(fieldName: string, errorMessage?: string) {
+    const errorSelector = this.selectors.fieldError(fieldName)
+    cy.get(errorSelector).should('be.visible')
+    if (errorMessage) {
+      cy.get(errorSelector).should('contain.text', errorMessage)
+    }
+    return this
+  }
+
+  /**
+   * Validate submit button is enabled
+   */
+  validateSubmitEnabled() {
+    cy.get(this.selectors.submitButton).should('not.be.disabled')
+    return this
+  }
+
+  /**
+   * Validate submit button is disabled
+   */
+  validateSubmitDisabled() {
+    cy.get(this.selectors.submitButton).should('be.disabled')
+    return this
+  }
+
+  // ============================================
+  // INPUT METHODS
+  // ============================================
+
+  /**
+   * Type into a text input field
+   */
+  typeInField(fieldName: string, value: string) {
+    cy.get(this.selectors.fieldInput(fieldName)).clear().type(value)
+    return this
+  }
+
+  /**
+   * Type into a textarea field
+   */
+  typeInTextarea(fieldName: string, value: string) {
+    cy.get(this.selectors.fieldTextarea(fieldName)).clear().type(value)
+    return this
+  }
+
+  /**
+   * Clear a text input field
+   */
+  clearField(fieldName: string) {
+    cy.get(this.selectors.fieldInput(fieldName)).clear()
+    return this
+  }
+
+  /**
+   * Select an option from a select/combobox field
+   */
+  selectOption(fieldName: string, optionValue: string) {
+    cy.get(this.selectors.fieldSelect(fieldName)).click()
+    cy.get(this.selectors.fieldOption(fieldName, optionValue)).click()
+    return this
+  }
+
+  /**
+   * Check a checkbox field
+   */
+  checkField(fieldName: string) {
+    cy.get(this.selectors.fieldCheckbox(fieldName)).check()
+    return this
+  }
+
+  /**
+   * Uncheck a checkbox field
+   */
+  uncheckField(fieldName: string) {
+    cy.get(this.selectors.fieldCheckbox(fieldName)).uncheck()
+    return this
+  }
+
+  /**
+   * Fill a date input field
+   */
+  fillDate(fieldName: string, dateString: string) {
+    cy.get(this.selectors.fieldInput(fieldName)).clear().type(dateString)
+    return this
+  }
+
+  // ============================================
+  // FORM SUBMISSION METHODS
+  // ============================================
+
+  /**
+   * Click the submit button
+   */
+  submit() {
+    cy.get(this.selectors.submitButton).click()
+    return this
+  }
+
+  /**
+   * Click the cancel button
+   */
+  cancel() {
+    cy.get(this.selectors.cancelButton).click()
+    return this
+  }
+
+  // ============================================
+  // BULK FILL METHODS
+  // ============================================
+
+  /**
+   * Fill multiple fields at once
+   */
+  fillForm(data: Record<string, string | boolean>) {
+    Object.entries(data).forEach(([fieldName, value]) => {
+      if (typeof value === 'boolean') {
+        if (value) {
+          this.checkField(fieldName)
+        } else {
+          this.uncheckField(fieldName)
+        }
+      } else {
+        // Try input first, then textarea
+        cy.get(this.selectors.field(fieldName)).then($field => {
+          const hasInput = $field.find('input:not([type="checkbox"])').length > 0
+          const hasTextarea = $field.find('textarea').length > 0
+          const hasSelect = $field.find('[role="combobox"]').length > 0
+
+          if (hasInput) {
+            this.typeInField(fieldName, value)
+          } else if (hasTextarea) {
+            this.typeInTextarea(fieldName, value)
+          } else if (hasSelect) {
+            this.selectOption(fieldName, value)
+          }
+        })
+      }
+    })
+    return this
+  }
+
+  // ============================================
+  // NAVIGATION METHODS
+  // ============================================
+
+  /**
+   * Visit the create form page
+   */
+  visitCreate() {
+    cy.visit(`/dashboard/${this.slug}/create`)
+    this.validatePageVisible()
+    return this
+  }
+
+  /**
+   * Visit the edit form page
+   */
+  visitEdit(id: string) {
+    cy.visit(`/dashboard/${this.slug}/${id}/edit`)
+    this.validatePageVisible()
+    return this
+  }
+
+  /**
+   * Wait for form to be ready (all fields loaded)
+   */
+  waitForFormReady() {
+    cy.get(this.selectors.form).should('be.visible')
+    cy.get(this.selectors.submitButton).should('be.visible')
+    return this
+  }
+
+  // ============================================
+  // ASSERTION HELPERS
+  // ============================================
+
+  /**
+   * Assert field has specific value
+   */
+  assertFieldValue(fieldName: string, expectedValue: string) {
+    cy.get(this.selectors.fieldInput(fieldName)).should('have.value', expectedValue)
+    return this
+  }
+
+  /**
+   * Assert textarea has specific value
+   */
+  assertTextareaValue(fieldName: string, expectedValue: string) {
+    cy.get(this.selectors.fieldTextarea(fieldName)).should('have.value', expectedValue)
+    return this
+  }
+
+  /**
+   * Assert select displays specific option
+   */
+  assertSelectValue(fieldName: string, expectedText: string) {
+    cy.get(this.selectors.fieldSelect(fieldName)).should('contain.text', expectedText)
+    return this
+  }
+}
+
+export default EntityForm