create-appraisejs 0.3.0-alpha.0 → 0.3.0-alpha.1

package/templates/starter/src/services/test-suite/test-suite-service.test.ts

@@ -0,0 +1,127 @@
+import { describe, expect, it, vi } from 'vitest'
+import { TagType } from '@prisma/client'
+import { automationProjectionService } from '@/lib/automation/projection-service'
+import {
+  createTestSuiteFromInput,
+  deleteTestSuitesByIds,
+  updateTestSuiteFromInput,
+} from './test-suite-service'
+
+vi.mock('@/config/db-config', () => ({
+  default: {
+    tag: {
+      findMany: vi.fn(),
+      deleteMany: vi.fn(),
+      create: vi.fn(),
+    },
+    testSuite: {
+      deleteMany: vi.fn(),
+      findUnique: vi.fn(),
+      update: vi.fn(),
+      create: vi.fn(),
+    },
+    $transaction: vi.fn(),
+  },
+}))
+
+vi.mock('@/lib/automation/projection-service', () => ({
+  automationProjectionService: {
+    deleteFeature: vi.fn().mockResolvedValue(undefined),
+    generateFeature: vi.fn().mockResolvedValue(undefined),
+  },
+}))
+
+vi.mock('@/lib/test-suite-identifier-service', () => ({
+  getOrCreateTestSuiteIdentifierTagId: vi.fn().mockResolvedValue('identifier-tag'),
+  ensureTestSuiteIdentifierTags: vi.fn().mockResolvedValue(undefined),
+}))
+
+import prisma from '@/config/db-config'
+
+describe('deleteTestSuitesByIds', () => {
+  it('deletes suites and skips orphan-tag cleanup when no identifier tags', async () => {
+    vi.mocked(prisma.tag.findMany).mockResolvedValue([])
+    vi.mocked(prisma.testSuite.deleteMany).mockResolvedValue({ count: 0 })
+
+    await deleteTestSuitesByIds(['suite-1'])
+
+    expect(automationProjectionService.deleteFeature).toHaveBeenCalledWith('suite-1')
+    expect(prisma.testSuite.deleteMany).toHaveBeenCalledWith({
+      where: { id: { in: ['suite-1'] } },
+    })
+    expect(prisma.tag.deleteMany).not.toHaveBeenCalled()
+  })
+})
+
+describe('createTestSuiteFromInput', () => {
+  it('creates a suite with an identifier tag and generates its feature', async () => {
+    vi.mocked(prisma.$transaction).mockImplementation(async callback => {
+      const tx = {
+        tag: {
+          create: vi.fn().mockResolvedValue({ id: 'identifier-tag' }),
+        },
+        testSuite: {
+          create: vi.fn().mockResolvedValue({ id: 'suite-1', name: 'Login Suite' }),
+        },
+      }
+
+      return callback(tx as never)
+    })
+
+    const result = await createTestSuiteFromInput({
+      name: 'Login Suite',
+      description: 'Covers login',
+      moduleId: 'module-1',
+      testCases: ['tc-1'],
+      tagIds: ['tag-1'],
+    })
+
+    expect(result).toEqual({ id: 'suite-1', name: 'Login Suite' })
+    expect(automationProjectionService.generateFeature).toHaveBeenCalledWith('suite-1')
+  })
+})
+
+describe('updateTestSuiteFromInput', () => {
+  it('recreates the feature when the name changes and preserves the identifier tag', async () => {
+    vi.mocked(prisma.testSuite.findUnique).mockResolvedValue({
+      id: 'suite-1',
+      name: 'Old Name',
+      moduleId: 'module-1',
+      module: { id: 'module-1' },
+      tags: [{ id: 'identifier-tag', type: TagType.IDENTIFIER }],
+    } as never)
+    vi.mocked(prisma.testSuite.update).mockResolvedValue({ id: 'suite-1' } as never)
+
+    await updateTestSuiteFromInput(
+      {
+        name: 'New Name',
+        description: 'Updated',
+        moduleId: 'module-1',
+        testCases: ['tc-1'],
+        tagIds: ['tag-1'],
+      },
+      'suite-1',
+    )
+
+    expect(automationProjectionService.deleteFeature).toHaveBeenCalledWith('suite-1')
+    expect(prisma.testSuite.update).toHaveBeenCalledWith({
+      where: { id: 'suite-1' },
+      data: {
+        name: 'New Name',
+        description: 'Updated',
+        testCases: {
+          set: [{ id: 'tc-1' }],
+        },
+        tags: {
+          set: [{ id: 'identifier-tag' }, { id: 'tag-1' }],
+        },
+        module: {
+          connect: {
+            id: 'module-1',
+          },
+        },
+      },
+    })
+    expect(automationProjectionService.generateFeature).toHaveBeenCalledWith('suite-1')
+  })
+})

package/templates/starter/src/services/test-suite/test-suite-service.ts

@@ -0,0 +1,197 @@
+import prisma from '@/config/db-config'
+import { testSuiteSchema } from '@/constants/form-opts/test-suite-form-opts'
+import { automationProjectionService } from '@/lib/automation/projection-service'
+import { getOrCreateTestSuiteIdentifierTagId } from '@/lib/test-suite-identifier-service'
+import { ensureTestSuiteIdentifierTags } from '@/lib/test-suite-identifier-service'
+import { generateUniqueTestSuiteIdentifier } from '@/lib/test-suite-utils'
+import { ServiceError } from '@/services/shared/errors'
+import { TagType } from '@prisma/client'
+import { z } from 'zod'
+
+export async function listTestSuites() {
+  await ensureTestSuiteIdentifierTags()
+
+  return prisma.testSuite.findMany({
+    include: {
+      module: true,
+      testCases: true,
+      tags: true,
+    },
+  })
+}
+
+export async function createTestSuiteFromInput(value: z.infer<typeof testSuiteSchema>) {
+  const suiteIdentifier = generateUniqueTestSuiteIdentifier()
+  const newTestSuite = await prisma.$transaction(async tx => {
+    const suiteIdentifierTag = await tx.tag.create({
+      data: {
+        name: suiteIdentifier,
+        type: TagType.IDENTIFIER,
+        tagExpression: `@${suiteIdentifier}`,
+      },
+    })
+
+    return tx.testSuite.create({
+      data: {
+        name: value.name,
+        description: value.description,
+        module: {
+          connect: {
+            id: value.moduleId,
+          },
+        },
+        testCases: {
+          connect: value.testCases?.map(id => ({ id })),
+        },
+        tags: {
+          connect: [{ id: suiteIdentifierTag.id }, ...(value.tagIds?.map(id => ({ id })) || [])],
+        },
+      },
+    })
+  })
+
+  try {
+    await automationProjectionService.generateFeature(newTestSuite.id)
+  } catch (error) {
+    console.error('Error generating feature file:', error)
+  }
+
+  return newTestSuite
+}
+
+export async function getTestSuiteByIdOrThrow(id: string) {
+  await ensureTestSuiteIdentifierTags([id])
+
+  const testSuite = await prisma.testSuite.findUnique({
+    where: { id },
+    include: {
+      testCases: true,
+      tags: {
+        where: {
+          type: TagType.FILTER,
+        },
+      },
+    },
+  })
+
+  if (!testSuite) {
+    throw new ServiceError('Test suite not found', 'NOT_FOUND', 404)
+  }
+
+  return testSuite
+}
+
+export async function deleteTestSuitesByIds(ids: string[]): Promise<void> {
+  const suiteIdentifierTags = await prisma.tag.findMany({
+    where: {
+      type: TagType.IDENTIFIER,
+      name: {
+        startsWith: 'ts_',
+      },
+      testSuites: {
+        some: {
+          id: {
+            in: ids,
+          },
+        },
+      },
+    },
+    select: {
+      id: true,
+    },
+  })
+
+  for (const testSuiteId of ids) {
+    try {
+      await automationProjectionService.deleteFeature(testSuiteId)
+    } catch (error) {
+      console.error(`Error deleting feature file for test suite ${testSuiteId}:`, error)
+    }
+  }
+
+  await prisma.testSuite.deleteMany({
+    where: { id: { in: ids } },
+  })
+
+  if (suiteIdentifierTags.length > 0) {
+    await prisma.tag.deleteMany({
+      where: {
+        id: {
+          in: suiteIdentifierTags.map(tag => tag.id),
+        },
+        testSuites: {
+          none: {},
+        },
+        testCases: {
+          none: {},
+        },
+        testRuns: {
+          none: {},
+        },
+      },
+    })
+  }
+}
+
+export async function updateTestSuiteFromInput(
+  value: z.infer<typeof testSuiteSchema>,
+  id: string,
+): Promise<void> {
+  const currentTestSuite = await prisma.testSuite.findUnique({
+    where: { id },
+    include: {
+      module: true,
+      tags: {
+        where: {
+          type: TagType.IDENTIFIER,
+        },
+        select: {
+          id: true,
+        },
+      },
+    },
+  })
+
+  if (!currentTestSuite) {
+    throw new ServiceError('Test suite not found', 'NOT_FOUND', 404)
+  }
+
+  const nameChanged = currentTestSuite.name !== value.name
+  const moduleChanged = currentTestSuite.moduleId !== value.moduleId
+
+  if (nameChanged || moduleChanged) {
+    try {
+      await automationProjectionService.deleteFeature(currentTestSuite.id)
+    } catch (error) {
+      console.error('Error deleting old feature file:', error)
+    }
+  }
+
+  const suiteIdentifierTagId = await getOrCreateTestSuiteIdentifierTagId(id)
+  const updatedTestSuite = await prisma.testSuite.update({
+    where: { id },
+    data: {
+      name: value.name,
+      description: value.description,
+      testCases: {
+        set: value.testCases?.map(testCaseId => ({ id: testCaseId })),
+      },
+      tags: {
+        set: [suiteIdentifierTagId, ...(value.tagIds || [])]
+          .filter((tagId): tagId is string => Boolean(tagId))
+          .map(tagId => ({ id: tagId })),
+      },
+      module: {
+        connect: {
+          id: value.moduleId,
+        },
+      },
+    },
+  })
+
+  try {
+    await automationProjectionService.generateFeature(updatedTestSuite.id)
+  } catch (error) {
+    console.error('Error generating updated feature file:', error)
+  }
+}

package/templates/starter/src/types/diagram/diagram.ts

@@ -0,0 +1,34 @@
+import { StepParameterType } from '@prisma/client'
+
+export type NodeData = {
+  order: number
+  label: string
+  gherkinStep?: string
+  isFirstNode?: boolean
+  icon?: string
+  parameters: {
+    name: string
+    value: string
+    type: StepParameterType
+    order: number
+  }[]
+  templateStepId: string
+}
+
+export type NodeOrderMap = Record<string, NodeData>
+
+export type TemplateTestCaseNodeData = {
+  order: number
+  label: string
+  gherkinStep?: string
+  icon?: string
+  parameters: {
+    name: string
+    defaultValue: string
+    type: StepParameterType
+    order: number
+  }[]
+  templateStepId: string
+}
+
+export type TemplateTestCaseNodeOrderMap = Record<string, TemplateTestCaseNodeData>

package/templates/starter/src/types/diagram/template-step.ts

@@ -0,0 +1,11 @@
+import { TemplateStep, TemplateStepGroup } from '@prisma/client'
+
+/** Template step with optional group relation (e.g. from getAllTemplateStepsAction). */
+export type TemplateStepWithGroup = TemplateStep & {
+  templateStepGroup?: TemplateStepGroup
+}
+
+/** Returns the group name in title case for display (e.g. "navigation" -> "Navigation"). */
+export function capitalizeGroupName(name: string): string {
+  return name.replace(/\b\w/g, c => c.toUpperCase())
+}

package/templates/starter/src/types/executor/browser.type.ts

@@ -0,0 +1 @@
+export type BrowserName = 'chromium' | 'firefox' | 'webkit'

package/templates/starter/src/types/form/actionHandler.ts

@@ -0,0 +1,19 @@
+/** Payload types for action `data` fields. */
+export type ActionResponseData =
+  | Record<string, unknown>
+  | Record<string, unknown>[]
+  | unknown[]
+  | unknown
+
+/**
+ * Server Action JSON return shape.
+ * Refactored actions should set `success: true` with `data`, or `success: false` with `error`.
+ * Callers often read `error` without narrowing; all fields stay optional for compatibility.
+ */
+export type ActionResponse = {
+  status: number
+  success?: boolean
+  data?: ActionResponseData
+  message?: string
+  error?: string
+}

package/templates/starter/src/types/locator/locator.type.ts

@@ -0,0 +1,11 @@
+export type CSSSelector = string
+export type XPathSelector = `/${string}` | `//${string}`
+export type SelectorName = string
+export type Selector = CSSSelector | XPathSelector
+export type Locator = Record<string, Selector>
+export type LocatorMap = {
+  name: string
+  path: string
+}
+
+export type LocatorCollection = Record<string, Locator>

package/templates/starter/src/types/locator-picker.ts

@@ -0,0 +1,65 @@
+export type LocatorPickerStatus = 'starting' | 'ready' | 'picked' | 'saving' | 'closed' | 'error'
+
+export type GroupResolutionMode = 'existing' | 'create'
+
+export type PickedLocatorStrategy = 'test-id' | 'role' | 'label' | 'placeholder' | 'id' | 'css' | 'xpath'
+
+export interface PickedLocatorPayload {
+  sessionId: string
+  selector: string
+  currentUrl: string
+  pathname: string
+  pageTitle: string
+  tagName: string
+  text?: string
+  accessibleName?: string
+  strategy?: PickedLocatorStrategy
+}
+
+export interface LocatorPickerGroupSuggestion {
+  mode: GroupResolutionMode
+  route: string
+  existingLocatorGroupId?: string
+  existingLocatorGroupName?: string
+  suggestedGroupName: string
+  suggestedModuleId?: string
+  suggestedModulePath?: string
+  requiresModuleSelection: boolean
+}
+
+export interface LocatorPickerSession {
+  sessionId: string
+  launchSource: {
+    environmentId?: string
+    environmentName?: string
+    url: string
+  }
+  browserName: 'chromium'
+  status: LocatorPickerStatus
+  currentUrl: string
+  currentPathname: string
+  pageTitle: string
+  companionPid: number | null
+  crashLogPath?: string
+  pickedLocator?: PickedLocatorPayload
+  startedAt: string
+  updatedAt: string
+  error?: string
+}
+
+export interface StartLocatorPickerSessionRequest {
+  environmentId?: string
+  url?: string
+}
+
+export interface SavePickedLocatorRequest {
+  locatorId?: string
+  sessionId?: string
+  locatorName: string
+  selector: string
+  resolutionMode: GroupResolutionMode
+  existingLocatorGroupId?: string
+  newLocatorGroupName?: string
+  route?: string
+  moduleId?: string
+}

package/templates/starter/src/types/step/step.type.ts

@@ -0,0 +1 @@
+export type Locator = string

package/templates/starter/src/types/table/data-table.ts

@@ -0,0 +1,6 @@
+import { ColumnDef } from '@tanstack/react-table'
+
+export interface DataTableProps<TData, TValue> {
+  columns: ColumnDef<TData, TValue>[]
+  data: TData[]
+}

package/templates/starter/src/types/test-case-picker.ts

@@ -0,0 +1,6 @@
+import { Tag, TestCase, TestCaseStep } from '@prisma/client'
+
+export type TestCasePickerRow = TestCase & {
+  steps: TestCaseStep[]
+  tags: Tag[]
+}

package/templates/starter/src/types/test-suite-picker.ts

@@ -0,0 +1,18 @@
+import { Module, Tag, TestCase, TestCaseStep, TestSuite } from '@prisma/client'
+
+export type TestSuitePickerTestCaseRow = TestCase & {
+  steps: TestCaseStep[]
+  tags: Tag[]
+}
+
+export type TestSuitePickerRow = TestSuite & {
+  module: Module
+  tags: Tag[]
+  testCases: TestSuitePickerTestCaseRow[]
+}
+
+export type TestSuiteSelection = {
+  testSuiteId: string
+  runAll: boolean
+  testCaseIds: string[]
+}

package/templates/starter/tailwind.config.ts

@@ -0,0 +1,62 @@
+import type { Config } from 'tailwindcss'
+import animate from 'tailwindcss-animate'
+export default {
+  darkMode: ['class'],
+  content: [
+    './src/pages/**/*.{js,ts,jsx,tsx,mdx}',
+    './src/components/**/*.{js,ts,jsx,tsx,mdx}',
+    './src/app/**/*.{js,ts,jsx,tsx,mdx}',
+  ],
+  theme: {
+    extend: {
+      colors: {
+        background: 'var(--background)',
+        foreground: 'var(--foreground)',
+        card: {
+          DEFAULT: 'var(--card)',
+          foreground: 'var(--card-foreground)',
+        },
+        popover: {
+          DEFAULT: 'var(--popover)',
+          foreground: 'var(--popover-foreground)',
+        },
+        primary: {
+          DEFAULT: 'var(--primary)',
+          foreground: 'var(--primary-foreground)',
+        },
+        secondary: {
+          DEFAULT: 'var(--secondary)',
+          foreground: 'var(--secondary-foreground)',
+        },
+        muted: {
+          DEFAULT: 'var(--muted)',
+          foreground: 'var(--muted-foreground)',
+        },
+        accent: {
+          DEFAULT: 'var(--accent)',
+          foreground: 'var(--accent-foreground)',
+        },
+        destructive: {
+          DEFAULT: 'var(--destructive)',
+          foreground: 'var(--destructive-foreground)',
+        },
+        border: 'var(--border)',
+        input: 'var(--input)',
+        ring: 'var(--ring)',
+        chart: {
+          '1': 'var(--chart-1)',
+          '2': 'var(--chart-2)',
+          '3': 'var(--chart-3)',
+          '4': 'var(--chart-4)',
+          '5': 'var(--chart-5)',
+        },
+      },
+      borderRadius: {
+        lg: 'var(--radius)',
+        md: 'calc(var(--radius) - 2px)',
+        sm: 'calc(var(--radius) - 4px)',
+      },
+    },
+  },
+  plugins: [animate],
+} satisfies Config

package/templates/starter/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "target": "ES2017",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "react-jsx",
+    "incremental": true,
+    "forceConsistentCasingInFileNames": true,
+    "plugins": [{ "name": "next" }],
+    "paths": {
+      "@/*": ["./src/*"],
+      "@locator-picker-companion/*": ["./packages/locator-picker-companion/src/*"]
+    }
+  },
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts",
+    ".next/dev/types/**/*.ts"
+  ],
+  "exclude": ["node_modules", "packages/create-appraisejs", "packages/appraisejs", "templates/starter"]
+}

package/templates/default/.appraise-template-meta.json

@@ -1,5 +0,0 @@
-{
-  "preparedAt": "2026-04-04T14:58:45.169Z",
-  "inputHash": "9173dcae0e64b99bb955c10e9726ad493032476fe0e85ec5dde07f1c587c7cc3",
-  "databasePath": "prisma/dev.db"
-}