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

package/tests/cypress/src/controllers/PipelineAPIController.ts

@@ -0,0 +1,116 @@
+/**
+ * PipelineAPIController - TypeScript controller for Pipelines API
+ *
+ * Handles CRUD operations for /api/v1/pipelines endpoints
+ */
+
+import { BaseAPIController, APIRequestOptions, APIResponse } from './BaseAPIController'
+
+export interface PipelineStage {
+  id?: string
+  name: string
+  probability: number
+  order: number
+}
+
+export interface PipelineData {
+  name?: string
+  description?: string
+  stages?: PipelineStage[]
+  isDefault?: boolean
+}
+
+export interface PipelineGetAllOptions extends APIRequestOptions {
+  isDefault?: boolean
+}
+
+export class PipelineAPIController extends BaseAPIController {
+  protected entitySlug = 'pipelines'
+
+  /**
+   * GET all pipelines with filtering options
+   */
+  getAll(options: PipelineGetAllOptions = {}): Cypress.Chainable<APIResponse> {
+    return super.getAll(options)
+  }
+
+  /**
+   * Set pipeline as default
+   */
+  setAsDefault(id: string, options: APIRequestOptions = {}): Cypress.Chainable<APIResponse> {
+    return this.update(id, { isDefault: true }, options)
+  }
+
+  /**
+   * Add stage to pipeline
+   */
+  addStage(id: string, stage: PipelineStage, options: APIRequestOptions = {}): Cypress.Chainable<APIResponse> {
+    return this.getById(id).then((response) => {
+      if (response.status !== 200) {
+        throw new Error(`Failed to get pipeline: ${response.body?.error || 'Unknown error'}`)
+      }
+      const currentStages = (response.body.data as { stages?: PipelineStage[] }).stages || []
+      const newStages = [...currentStages, stage]
+      return this.update(id, { stages: newStages }, options)
+    })
+  }
+
+  /**
+   * Generate random pipeline data for testing
+   */
+  generateRandomData(overrides: Partial<PipelineData> = {}): PipelineData {
+    const timestamp = Date.now()
+    const randomId = Math.random().toString(36).substring(2, 8)
+
+    const pipelineNames = [
+      'Sales Pipeline',
+      'Enterprise Sales',
+      'SMB Pipeline',
+      'Partner Pipeline',
+      'Renewal Pipeline',
+      'Upsell Pipeline'
+    ]
+
+    const defaultStages: PipelineStage[] = [
+      { name: 'Qualification', probability: 10, order: 1 },
+      { name: 'Discovery', probability: 25, order: 2 },
+      { name: 'Proposal', probability: 50, order: 3 },
+      { name: 'Negotiation', probability: 75, order: 4 },
+      { name: 'Closed Won', probability: 100, order: 5 }
+    ]
+
+    return {
+      name: `${pipelineNames[Math.floor(Math.random() * pipelineNames.length)]} ${randomId}`,
+      description: `Test pipeline created at ${new Date(timestamp).toISOString()}`,
+      stages: defaultStages,
+      isDefault: false,
+      ...overrides
+    }
+  }
+
+  /**
+   * Validate pipeline object structure
+   */
+  validateObject(pipeline: Record<string, unknown>, allowMetas = false): void {
+    this.validateSystemFields(pipeline)
+
+    expect(pipeline).to.have.property('name')
+    expect(pipeline.name).to.be.a('string')
+
+    this.validateOptionalStringFields(pipeline, ['description'])
+
+    if (pipeline.stages !== null && pipeline.stages !== undefined) {
+      expect(pipeline.stages).to.be.an('array')
+    }
+
+    if (pipeline.isDefault !== null && pipeline.isDefault !== undefined) {
+      expect(pipeline.isDefault).to.be.a('boolean')
+    }
+
+    if (allowMetas && Object.prototype.hasOwnProperty.call(pipeline, 'metas')) {
+      expect(pipeline.metas).to.be.an('object')
+    }
+  }
+}
+
+export default PipelineAPIController

package/tests/cypress/src/controllers/ProductAPIController.ts

@@ -0,0 +1,113 @@
+/**
+ * ProductAPIController - TypeScript controller for Products API
+ *
+ * Handles CRUD operations for /api/v1/products endpoints
+ */
+
+import { BaseAPIController, APIRequestOptions, APIResponse } from './BaseAPIController'
+
+export interface ProductData {
+  name?: string
+  code?: string
+  description?: string
+  price?: number
+  currency?: string
+  category?: string
+  isActive?: boolean
+  sku?: string
+  unit?: string
+}
+
+export interface ProductGetAllOptions extends APIRequestOptions {
+  category?: string
+  isActive?: boolean
+  minPrice?: number
+  maxPrice?: number
+}
+
+export class ProductAPIController extends BaseAPIController {
+  protected entitySlug = 'products'
+
+  /**
+   * GET all products with filtering options
+   */
+  getAll(options: ProductGetAllOptions = {}): Cypress.Chainable<APIResponse> {
+    return super.getAll(options)
+  }
+
+  /**
+   * Activate product
+   */
+  activate(id: string, options: APIRequestOptions = {}): Cypress.Chainable<APIResponse> {
+    return this.update(id, { isActive: true }, options)
+  }
+
+  /**
+   * Deactivate product
+   */
+  deactivate(id: string, options: APIRequestOptions = {}): Cypress.Chainable<APIResponse> {
+    return this.update(id, { isActive: false }, options)
+  }
+
+  /**
+   * Generate random product data for testing
+   */
+  generateRandomData(overrides: Partial<ProductData> = {}): ProductData {
+    const timestamp = Date.now()
+    const randomId = Math.random().toString(36).substring(2, 8)
+
+    const categories = ['Software', 'Hardware', 'Services', 'Consulting', 'Support', 'Training']
+    const currencies = ['USD', 'EUR', 'GBP']
+    const units = ['unit', 'hour', 'month', 'year', 'license']
+
+    const productNames = [
+      'Enterprise License',
+      'Professional Package',
+      'Basic Plan',
+      'Premium Support',
+      'Custom Development',
+      'Training Session'
+    ]
+
+    return {
+      name: `${productNames[Math.floor(Math.random() * productNames.length)]} ${randomId}`,
+      code: `PROD-${timestamp}-${randomId}`.toUpperCase(),
+      description: `Test product created at ${new Date(timestamp).toISOString()}`,
+      price: Math.floor(Math.random() * 10000) + 100,
+      currency: currencies[Math.floor(Math.random() * currencies.length)],
+      category: categories[Math.floor(Math.random() * categories.length)],
+      isActive: true,
+      sku: `SKU-${randomId}`.toUpperCase(),
+      unit: units[Math.floor(Math.random() * units.length)],
+      ...overrides
+    }
+  }
+
+  /**
+   * Validate product object structure
+   */
+  validateObject(product: Record<string, unknown>, allowMetas = false): void {
+    this.validateSystemFields(product)
+
+    expect(product).to.have.property('name')
+    expect(product.name).to.be.a('string')
+
+    this.validateOptionalStringFields(product, [
+      'code', 'description', 'currency', 'category', 'sku', 'unit'
+    ])
+
+    if (product.price !== null && product.price !== undefined) {
+      expect(Number(product.price)).to.be.a('number')
+    }
+
+    if (product.isActive !== null && product.isActive !== undefined) {
+      expect(product.isActive).to.be.a('boolean')
+    }
+
+    if (allowMetas && Object.prototype.hasOwnProperty.call(product, 'metas')) {
+      expect(product.metas).to.be.an('object')
+    }
+  }
+}
+
+export default ProductAPIController

package/tests/cypress/src/controllers/index.ts

@@ -0,0 +1,35 @@
+/**
+ * CRM API Controllers Index
+ *
+ * Exports all TypeScript API controllers for CRM entities
+ */
+
+export { BaseAPIController } from './BaseAPIController'
+export type { APIRequestOptions, APIResponse, CreateTestRecordOptions } from './BaseAPIController'
+
+export { ActivityAPIController } from './ActivityAPIController'
+export type { ActivityData, ActivityGetAllOptions } from './ActivityAPIController'
+
+export { LeadAPIController } from './LeadAPIController'
+export type { LeadData, LeadGetAllOptions } from './LeadAPIController'
+
+export { ProductAPIController } from './ProductAPIController'
+export type { ProductData, ProductGetAllOptions } from './ProductAPIController'
+
+export { PipelineAPIController } from './PipelineAPIController'
+export type { PipelineData, PipelineStage, PipelineGetAllOptions } from './PipelineAPIController'
+
+export { ContactAPIController } from './ContactAPIController'
+export type { ContactData, ContactGetAllOptions } from './ContactAPIController'
+
+export { CampaignAPIController } from './CampaignAPIController'
+export type { CampaignData, CampaignGetAllOptions } from './CampaignAPIController'
+
+export { CompanyAPIController } from './CompanyAPIController'
+export type { CompanyData, CompanyGetAllOptions } from './CompanyAPIController'
+
+export { OpportunityAPIController } from './OpportunityAPIController'
+export type { OpportunityData, OpportunityGetAllOptions } from './OpportunityAPIController'
+
+export { NoteAPIController } from './NoteAPIController'
+export type { NoteData, NoteGetAllOptions } from './NoteAPIController'

package/tests/cypress/src/entities/ActivitiesPOM.ts

@@ -0,0 +1,130 @@
+/**
+ * Activities Page Object Model for CRM Theme
+ *
+ * Entity-specific POM for Activities.
+ *
+ * Usage:
+ *   const activities = new ActivitiesPOM()
+ *   activities.list.validateTableVisible()
+ *   activities.form.selectOption('type', 'call')
+ */
+
+import { EntityList } from '../components/EntityList'
+import { EntityForm } from '../components/EntityForm'
+import { EntityDetail } from '../components/EntityDetail'
+
+export class ActivitiesPOM {
+  /** Generic list POM for activities */
+  readonly list: EntityList
+
+  /** Generic form POM for activities */
+  readonly form: EntityForm
+
+  /** Generic detail POM for activities */
+  readonly detail: EntityDetail
+
+  /** Activity entity slug */
+  readonly slug = 'activities'
+
+  constructor() {
+    this.list = EntityList.for('activities')
+    this.form = EntityForm.for('activities')
+    this.detail = new EntityDetail('activities', 'activity', [])
+  }
+
+  // ============================================
+  // NAVIGATION METHODS
+  // ============================================
+
+  /**
+   * Visit the activities list page
+   */
+  visitList() {
+    cy.visit('/dashboard/activities')
+    this.list.waitForPageLoad()
+    return this
+  }
+
+  /**
+   * Visit activity detail page
+   */
+  visitDetail(activityId: string) {
+    this.detail.visit(activityId)
+    return this
+  }
+
+  /**
+   * Visit create activity page
+   */
+  visitCreate() {
+    this.form.visitCreate()
+    return this
+  }
+
+  /**
+   * Visit edit activity page
+   */
+  visitEdit(activityId: string) {
+    this.form.visitEdit(activityId)
+    return this
+  }
+
+  // ============================================
+  // FORM HELPERS
+  // ============================================
+
+  /**
+   * Fill activity form with common fields
+   */
+  fillActivityForm(data: {
+    type?: string
+    subject?: string
+    description?: string
+    dueDate?: string
+    relatedTo?: string
+    contactId?: string
+    companyId?: string
+    opportunityId?: string
+  }) {
+    if (data.type) {
+      this.form.selectOption('type', data.type)
+    }
+    if (data.subject) {
+      this.form.typeInField('subject', data.subject)
+    }
+    if (data.description) {
+      this.form.typeInTextarea('description', data.description)
+    }
+    if (data.dueDate) {
+      this.form.fillDate('dueDate', data.dueDate)
+    }
+    if (data.contactId) {
+      this.form.selectOption('contactId', data.contactId)
+    }
+    if (data.companyId) {
+      this.form.selectOption('companyId', data.companyId)
+    }
+    if (data.opportunityId) {
+      this.form.selectOption('opportunityId', data.opportunityId)
+    }
+    return this
+  }
+
+  /**
+   * Submit the activity form
+   */
+  submitForm() {
+    this.form.submit()
+    return this
+  }
+
+  /**
+   * Mark activity as complete
+   */
+  markComplete() {
+    cy.get('[data-cy="activity-complete-btn"]').click()
+    return this
+  }
+}
+
+export default ActivitiesPOM

package/tests/cypress/src/entities/CompaniesPOM.ts

@@ -0,0 +1,117 @@
+/**
+ * Companies Page Object Model for CRM Theme
+ *
+ * Entity-specific POM for Companies.
+ *
+ * Usage:
+ *   const companies = new CompaniesPOM()
+ *   companies.list.validateTableVisible()
+ *   companies.form.typeInField('name', 'Acme Inc')
+ */
+
+import { EntityList } from '../components/EntityList'
+import { EntityForm } from '../components/EntityForm'
+import { EntityDetail } from '../components/EntityDetail'
+
+export class CompaniesPOM {
+  /** Generic list POM for companies */
+  readonly list: EntityList
+
+  /** Generic form POM for companies */
+  readonly form: EntityForm
+
+  /** Generic detail POM for companies */
+  readonly detail: EntityDetail
+
+  /** Company entity slug */
+  readonly slug = 'companies'
+
+  constructor() {
+    this.list = EntityList.for('companies')
+    this.form = EntityForm.for('companies')
+    this.detail = new EntityDetail('companies', 'company', ['contacts', 'opportunities', 'notes'])
+  }
+
+  // ============================================
+  // NAVIGATION METHODS
+  // ============================================
+
+  /**
+   * Visit the companies list page
+   */
+  visitList() {
+    cy.visit('/dashboard/companies')
+    this.list.waitForPageLoad()
+    return this
+  }
+
+  /**
+   * Visit company detail page
+   */
+  visitDetail(companyId: string) {
+    this.detail.visit(companyId)
+    return this
+  }
+
+  /**
+   * Visit create company page
+   */
+  visitCreate() {
+    this.form.visitCreate()
+    return this
+  }
+
+  /**
+   * Visit edit company page
+   */
+  visitEdit(companyId: string) {
+    this.form.visitEdit(companyId)
+    return this
+  }
+
+  // ============================================
+  // FORM HELPERS
+  // ============================================
+
+  /**
+   * Fill company form with common fields
+   */
+  fillCompanyForm(data: {
+    name?: string
+    website?: string
+    industry?: string
+    size?: string
+    phone?: string
+    address?: string
+  }) {
+    if (data.name) {
+      this.form.typeInField('name', data.name)
+    }
+    if (data.website) {
+      this.form.typeInField('website', data.website)
+    }
+    if (data.industry) {
+      this.form.selectOption('industry', data.industry)
+    }
+    if (data.size) {
+      this.form.selectOption('size', data.size)
+    }
+    if (data.phone) {
+      this.form.typeInField('phone', data.phone)
+    }
+    if (data.address) {
+      this.form.typeInTextarea('address', data.address)
+    }
+    return this
+  }
+
+  /**
+   * Submit the company form
+   */
+  submitForm() {
+    this.form.submit()
+    return this
+  }
+}
+
+export default CompaniesPOM

package/tests/cypress/src/entities/ContactsPOM.ts

@@ -0,0 +1,117 @@
+/**
+ * Contacts Page Object Model for CRM Theme
+ *
+ * Entity-specific POM for Contacts.
+ *
+ * Usage:
+ *   const contacts = new ContactsPOM()
+ *   contacts.list.validateTableVisible()
+ *   contacts.form.typeInField('firstName', 'John')
+ */
+
+import { EntityList } from '../components/EntityList'
+import { EntityForm } from '../components/EntityForm'
+import { EntityDetail } from '../components/EntityDetail'
+
+export class ContactsPOM {
+  /** Generic list POM for contacts */
+  readonly list: EntityList
+
+  /** Generic form POM for contacts */
+  readonly form: EntityForm
+
+  /** Generic detail POM for contacts */
+  readonly detail: EntityDetail
+
+  /** Contact entity slug */
+  readonly slug = 'contacts'
+
+  constructor() {
+    this.list = EntityList.for('contacts')
+    this.form = EntityForm.for('contacts')
+    this.detail = new EntityDetail('contacts', 'contact', ['activities', 'notes', 'opportunities'])
+  }
+
+  // ============================================
+  // NAVIGATION METHODS
+  // ============================================
+
+  /**
+   * Visit the contacts list page
+   */
+  visitList() {
+    cy.visit('/dashboard/contacts')
+    this.list.waitForPageLoad()
+    return this
+  }
+
+  /**
+   * Visit contact detail page
+   */
+  visitDetail(contactId: string) {
+    this.detail.visit(contactId)
+    return this
+  }
+
+  /**
+   * Visit create contact page
+   */
+  visitCreate() {
+    this.form.visitCreate()
+    return this
+  }
+
+  /**
+   * Visit edit contact page
+   */
+  visitEdit(contactId: string) {
+    this.form.visitEdit(contactId)
+    return this
+  }
+
+  // ============================================
+  // FORM HELPERS
+  // ============================================
+
+  /**
+   * Fill contact form with common fields
+   */
+  fillContactForm(data: {
+    firstName?: string
+    lastName?: string
+    email?: string
+    phone?: string
+    companyId?: string
+    title?: string
+  }) {
+    if (data.firstName) {
+      this.form.typeInField('firstName', data.firstName)
+    }
+    if (data.lastName) {
+      this.form.typeInField('lastName', data.lastName)
+    }
+    if (data.email) {
+      this.form.typeInField('email', data.email)
+    }
+    if (data.phone) {
+      this.form.typeInField('phone', data.phone)
+    }
+    if (data.companyId) {
+      this.form.selectOption('companyId', data.companyId)
+    }
+    if (data.title) {
+      this.form.typeInField('title', data.title)
+    }
+    return this
+  }
+
+  /**
+   * Submit the contact form
+   */
+  submitForm() {
+    this.form.submit()
+    return this
+  }
+}
+
+export default ContactsPOM