@antelopejs/dms-marketing 0.2.2

package/frontend-vue/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+  - '.'

package/frontend-vue/tests/drafts.test.ts

@@ -0,0 +1,54 @@
+import { describe, expect, it } from 'vitest'
+import {
+  parseExperimentValue,
+  parseExperimentVariationsValue,
+} from '../app/composables/useExperiment'
+import { parseFunnelStepsValue } from '../app/composables/useFunnelSteps'
+
+// Both shapes reach the inputs: the real value on a form, a JSON string on a
+// table cell. Neither parser may throw — they run while rendering.
+describe('parseFunnelStepsValue', () => {
+  it('reads the array and its JSON form alike', () => {
+    const steps = [{ kind: 'url' as const, value: '/pricing' }]
+    expect(parseFunnelStepsValue(steps)).toEqual(steps)
+    expect(parseFunnelStepsValue(JSON.stringify(steps))).toEqual(steps)
+  })
+
+  it('answers an empty list on anything else', () => {
+    for (const input of [null, undefined, '', 'not json', '{}', 42]) {
+      expect(parseFunnelStepsValue(input)).toEqual([])
+    }
+  })
+})
+
+describe('parseExperimentValue', () => {
+  it('reads the object and its JSON form alike', () => {
+    const experiment = {
+      key: 'cta',
+      variations: [{ key: 'a', weight: 1 }],
+      runs: [{ startedAt: 1, stoppedAt: null }],
+    }
+    expect(parseExperimentValue(experiment)).toEqual(experiment)
+    expect(parseExperimentValue(JSON.stringify(experiment))).toEqual(experiment)
+  })
+
+  it('reads a value carrying no runs as a split that served no traffic', () => {
+    expect(
+      parseExperimentValue({ key: 'cta', variations: [] })?.runs,
+    ).toEqual([])
+  })
+
+  it('answers null on anything else', () => {
+    for (const input of [null, undefined, '', 'not json', 42]) {
+      expect(parseExperimentValue(input)).toBeNull()
+    }
+  })
+})
+
+describe('parseExperimentVariationsValue', () => {
+  it('answers an empty list on anything that is not an array', () => {
+    for (const input of [null, undefined, '', 'not json', '{}']) {
+      expect(parseExperimentVariationsValue(input)).toEqual([])
+    }
+  })
+})

package/frontend-vue/tests/i18n.test.ts

@@ -0,0 +1,86 @@
+import { readFileSync, readdirSync } from 'node:fs'
+import { join } from 'node:path'
+import { describe, expect, it } from 'vitest'
+import en from '../i18n/locales/marketing-en-GB.json'
+import fr from '../i18n/locales/marketing-fr-FR.json'
+
+// vitest runs with the frontend module as its root; the backend sits one level
+// above it.
+const BACKEND_SOURCE_DIR = join(process.cwd(), '..', 'src')
+
+// `$page.marketing.a.b` as the backend writes it. A literal that stops on a
+// dot is the prefix of a key completed by a template expression; those are
+// resolved at runtime and cannot be checked here.
+const KEY_LITERAL = /\$page\.marketing\.[\w.]+/g
+const DYNAMIC_KEY_SUFFIX = '.'
+
+function keysOf(value: unknown, prefix = ''): string[] {
+  if (typeof value !== 'object' || value === null) {
+    return [prefix]
+  }
+  return Object.entries(value).flatMap(([key, child]) =>
+    keysOf(child, prefix ? `${prefix}.${key}` : key),
+  )
+}
+
+function typescriptFiles(directory: string): string[] {
+  return readdirSync(directory, { withFileTypes: true }).flatMap((entry) => {
+    const path = join(directory, entry.name)
+    if (entry.isDirectory()) {
+      return typescriptFiles(path)
+    }
+    return entry.isFile() && path.endsWith('.ts') ? [path] : []
+  })
+}
+
+function backendKeys(): string[] {
+  const found = new Set<string>()
+  for (const file of typescriptFiles(BACKEND_SOURCE_DIR)) {
+    for (const literal of readFileSync(file, 'utf8').match(KEY_LITERAL) ?? []) {
+      const key = literal.slice(1)
+      if (!key.endsWith(DYNAMIC_KEY_SUFFIX)) {
+        found.add(key)
+      }
+    }
+  }
+  return [...found].sort()
+}
+
+function resolveKey(root: unknown, key: string): unknown {
+  return key
+    .split('.')
+    .reduce<unknown>(
+      (node, part) =>
+        typeof node === 'object' && node !== null
+          ? (node as Record<string, unknown>)[part]
+          : undefined,
+      root,
+    )
+}
+
+describe('locales', () => {
+  it('carry the same key set', () => {
+    expect(keysOf(fr).sort()).toEqual(keysOf(en).sort())
+  })
+
+  it('cover every namespace the surfaces use', () => {
+    for (const namespace of [
+      'overview',
+      'pages',
+      'campaigns',
+      'funnels',
+      'settings',
+      'websites',
+      'errors',
+    ]) {
+      expect(en.page.marketing).toHaveProperty(namespace)
+    }
+  })
+
+  it('resolve every static key the backend emits', () => {
+    const keys = backendKeys()
+    expect(keys.length).toBeGreaterThan(0)
+    expect(keys.filter((key) => typeof resolveKey(en, key) !== 'string')).toEqual([])
+    expect(keys.filter((key) => typeof resolveKey(fr, key) !== 'string')).toEqual([])
+  })
+})

package/frontend-vue/tests/period.test.ts

@@ -0,0 +1,35 @@
+import { describe, expect, it } from 'vitest'
+import {
+  DEFAULT_PERIOD_DAYS,
+  DEFAULT_PERIOD_PRESET,
+  ndToPreset,
+  periodDays,
+} from '../app/composables/useMarketingPeriod'
+
+describe('periodDays', () => {
+  it('reads the day count of an Nd window', () => {
+    expect(periodDays('30d')).toBe(30)
+    expect(periodDays('1d')).toBe(1)
+  })
+
+  it('falls back to the default on anything unparseable', () => {
+    for (const input of [undefined, '', 'week', '0d', '-7d']) {
+      expect(periodDays(input)).toBe(DEFAULT_PERIOD_DAYS)
+    }
+  })
+})
+
+describe('ndToPreset', () => {
+  it('maps the offered windows back onto their preset', () => {
+    expect(ndToPreset('1d')).toBe('today')
+    expect(ndToPreset('7d')).toBe('last-7-days')
+    expect(ndToPreset('30d')).toBe('last-30-days')
+    expect(ndToPreset('90d')).toBe('last-90-days')
+  })
+
+  // An arbitrary window must not silently round to a neighbouring preset.
+  it('falls back to the default on a window no preset offers', () => {
+    expect(ndToPreset('13d')).toBe(DEFAULT_PERIOD_PRESET)
+    expect(ndToPreset(undefined)).toBe(DEFAULT_PERIOD_PRESET)
+  })
+})

package/frontend-vue/tests/registration.test.ts

@@ -0,0 +1,63 @@
+import { expect, it, vi } from 'vitest'
+import frontendModule from '../dms.frontend'
+
+/**
+ * The backend addresses this module's surfaces by component name — the pages
+ * through `CustomComponent('DmsMarketing…')`, the DataTypes through their
+ * form components — so a name that stops being registered silently falls back
+ * to the generic card renderer instead of failing.
+ */
+const BACKEND_ADDRESSED = [
+  'DmsMarketingOverviewView',
+  'DmsMarketingPagesView',
+  'DmsMarketingCampaignsView',
+  'DmsMarketingFunnelsView',
+  'DmsMarketingFunnelStepsInput',
+  'DmsMarketingExperimentInput',
+]
+
+it('registers every component under the DmsMarketing prefix', async () => {
+  const registerComponent = vi.fn()
+  const registerPlugin = vi.fn()
+  await frontendModule.setup({
+    options: { public: {} },
+    registerComponent,
+    registerPage: vi.fn(),
+    registerDynamicPage: vi.fn(),
+    registerLayout: vi.fn(),
+    registerErrorPage: vi.fn(),
+    registerPlugin,
+    registerMiddleware: vi.fn(),
+    provide: vi.fn(),
+    use: vi.fn(),
+  })
+
+  const names = registerComponent.mock.calls.map(([name]) => name)
+  expect(names.length).toBeGreaterThan(0)
+  expect(new Set(names).size).toBe(names.length)
+  for (const name of names) {
+    expect(name.startsWith('DmsMarketing')).toBe(true)
+  }
+  for (const name of BACKEND_ADDRESSED) {
+    expect(names).toContain(name)
+  }
+})
+
+it('registers the funnel-steps DataType plugin client-side only', async () => {
+  const registerPlugin = vi.fn()
+  await frontendModule.setup({
+    options: { public: {} },
+    registerComponent: vi.fn(),
+    registerPage: vi.fn(),
+    registerDynamicPage: vi.fn(),
+    registerLayout: vi.fn(),
+    registerErrorPage: vi.fn(),
+    registerPlugin,
+    registerMiddleware: vi.fn(),
+    provide: vi.fn(),
+    use: vi.fn(),
+  })
+
+  expect(registerPlugin).toHaveBeenCalledTimes(1)
+  expect(registerPlugin.mock.calls[0]![1]).toEqual({ clientOnly: true })
+})

package/frontend-vue/tests/routes.test.ts

@@ -0,0 +1,31 @@
+import { describe, expect, it } from 'vitest'
+import {
+  campaignsLink,
+  funnelsLink,
+  pagesLink,
+} from '../app/composables/useMarketingRoutes'
+
+describe('module links', () => {
+  it('stay bare when nothing is selected', () => {
+    expect(pagesLink()).toEqual({ path: '/modules/marketing/pages', query: {} })
+    expect(campaignsLink()).toEqual({
+      path: '/modules/marketing/campaigns',
+      query: {},
+    })
+    expect(funnelsLink()).toEqual({
+      path: '/modules/marketing/funnels',
+      query: {},
+    })
+  })
+
+  it('carry only the selections that have a value', () => {
+    expect(pagesLink({ website: 'w1', path: undefined, period: '7d' })).toEqual({
+      path: '/modules/marketing/pages',
+      query: { website: 'w1', period: '7d' },
+    })
+    expect(funnelsLink({ website: 'w1', funnel: null })).toEqual({
+      path: '/modules/marketing/funnels',
+      query: { website: 'w1' },
+    })
+  })
+})

package/frontend-vue/tests/stubs/frontend-module.ts

@@ -0,0 +1,56 @@
+/**
+ * Stand-in for the loader-provided `#dms/frontend-module` alias.
+ *
+ * The real module only exists inside the Vue workspace the DMS frontend
+ * loader generates; these tests run the module's own sources directly, so the
+ * few SDK helpers they reach are stubbed with the same shapes. The real
+ * contract is checked by `pnpm test:frontend`, which builds this module
+ * through the loader for real.
+ */
+import type { Component, Plugin } from 'vue'
+
+export type DmsPluginSetup = (context: unknown) => void | Promise<void>
+
+export interface DmsFrontendSdk {
+  options: { public: Record<string, unknown> }
+  registerComponent: (name: string, component: Component) => void
+  registerPage: (name: string, component: Component) => void
+  registerDynamicPage: (name: string, component: Component) => void
+  registerLayout: (name: string, component: Component) => void
+  registerErrorPage: (component: Component) => void
+  registerPlugin: (
+    setup: DmsPluginSetup,
+    options?: { clientOnly?: boolean },
+  ) => void
+  registerMiddleware: (name: string, handler: unknown) => void
+  provide: (key: string, value: unknown) => void
+  use: (plugin: Plugin) => void
+}
+
+export interface DmsFrontendModule {
+  setup(sdk: DmsFrontendSdk): void | Promise<void>
+}
+
+export function defineDmsPlugin(setup: DmsPluginSetup): DmsPluginSetup {
+  return setup
+}
+
+export function useI18n(): { t: (key: string) => string, te: () => boolean, locale: { value: string } } {
+  return { t: (key: string) => key, te: () => false, locale: { value: 'en' } }
+}
+
+export function useDmsRoute(): { query: Record<string, string>, path: string } {
+  return { query: {}, path: '/' }
+}
+
+export function useDmsRouter(): { replace: () => Promise<void>, push: () => Promise<void> } {
+  return { replace: async () => {}, push: async () => {} }
+}
+
+export function useDmsRuntimeConfig(): { public: Record<string, unknown> } {
+  return { public: {} }
+}
+
+export function resolveDmsComponent(): Component | undefined {
+  return undefined
+}

package/frontend-vue/vitest.config.ts

@@ -0,0 +1,20 @@
+import { fileURLToPath } from 'node:url'
+import vue from '@vitejs/plugin-vue'
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  plugins: [vue()],
+  resolve: {
+    alias: {
+      // Provided by the generated workspace at build time; stubbed here so the
+      // module's own sources can be imported outside it.
+      '#dms/frontend-module': fileURLToPath(
+        new URL('./tests/stubs/frontend-module.ts', import.meta.url),
+      ),
+    },
+  },
+  test: {
+    environment: 'jsdom',
+    include: ['tests/**/*.test.ts'],
+  },
+})

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@antelopejs/dms-marketing",
+  "version": "0.2.2",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AntelopeJS/dms-marketing.git"
+  },
+  "files": [
+    "LICENSE",
+    "dist",
+    "frontend-vue",
+    "static"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@antelopejs/interface-api": ">=0.0.13 <1.0.0",
+    "@antelopejs/interface-api-util": ">=0.1.2 <1.0.0",
+    "@antelopejs/interface-core": ">=0.0.13 <1.0.0",
+    "@antelopejs/interface-data-api": ">=0.1.9 <1.0.0",
+    "@antelopejs/interface-database": ">=0.1.7 <1.0.0",
+    "@antelopejs/interface-database-decorators": ">=0.1.6 <1.0.0",
+    "@antelopejs/interface-dms": ">=0.1.0 <1.0.0",
+    "@antelopejs/interface-dms-marketing": ">=0.1.0 <1.0.0",
+    "defu": "^6.1.4",
+    "maxmind": "^5.0.7",
+    "node-cron": "^4.2.1",
+    "ua-parser-js": "^2.0.9",
+    "zod": "~3.24.4"
+  },
+  "devDependencies": {
+    "@antelopejs/core": ">=1.8.0 <2",
+    "@antelopejs/dms": ">=0.3.5 <1.0.0",
+    "@antelopejs/dms-frontend": ">=0.2.0 <1.0.0",
+    "@antelopejs/interface-mongodb": ">=0.0.3 <1.0.0",
+    "@antelopejs/mongodb": "1.3.0",
+    "@antelopejs/tooling-configs": ">=0.0.6 <1.0.0",
+    "@types/node": "^22.19.15",
+    "knip": "^6.34.0",
+    "mongodb": "^6.21.0",
+    "mongodb-memory-server-core": "^10.4.3",
+    "oxfmt": "^0.66.0",
+    "oxlint": "1.81.0",
+    "oxlint-tsgolint": "^7.0.2001",
+    "release-it": "^19.2.4",
+    "release-it-changelogen": "^0.1.0",
+    "rimraf": "^6.1.3",
+    "typescript": "^5.9.3"
+  },
+  "antelopeJs": {
+    "baseUrl": "dist",
+    "test": "antelope.test.ts",
+    "implements": [
+      "@antelopejs/interface-dms-marketing"
+    ],
+    "paths": {
+      "@/*": [
+        "*"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "pnpm --filter @antelopejs/interface-dms-marketing build && rimraf dist && tsc -p tsconfig.build.json",
+    "test": "pnpm run test:backend && pnpm run test:layer",
+    "test:backend": "pnpm run build && ajs module test .",
+    "test:layer": "cd frontend-vue && pnpm test",
+    "test:frontend": "node scripts/check-frontend.mjs",
+    "dev": "ajs project run -w -p playground",
+    "frontend:dev": "cd playground && pnpm frontend:dev",
+    "lint": "oxlint && oxfmt --check . && cd frontend-vue && pnpm lint",
+    "lint:fix": "oxlint --fix --max-warnings=1000000 && oxfmt . && cd frontend-vue && pnpm lint:fix",
+    "format": "oxfmt . && cd frontend-vue && pnpm format",
+    "release": "pnpm --filter @antelopejs/interface-dms-marketing build && pnpm --dir frontend-vue install --frozen-lockfile && pnpm run lint && release-it",
+    "typecheck": "tsc -p tsconfig.json",
+    "knip": "knip --dependencies",
+    "knip:all": "knip"
+  }
+}