@antelopejs/dms-mailing 0.4.0 → 0.5.0

package/frontend-vue/tests/retention-input.test.ts

@@ -1,3 +1,4 @@
+// @vitest-environment jsdom
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 import { computed, createApp, h, nextTick, reactive, type App } from 'vue'
 import RetentionInput from '../app/components/RetentionInput.vue'
@@ -7,15 +8,14 @@ import {
 	stubNuxtGlobals,
 	type NuxtStubs,
 } from './helpers/nuxt-globals'
+import {
+	stubApiData,
+	stubRegionalFormat,
+	type ApiDataStub,
+} from './helpers/api-data'
 import type { RetentionPreview } from '../app/types/mailing'
 
-const api = {
-	retentionPreview: vi.fn(),
-}
-
-vi.mock('../app/composables/useMailingApi', () => ({
-	useMailingApi: () => api,
-}))
+const PREVIEW_URL = '/api/mailing/settings/retention-preview'
 
 const SAVED_DAYS = 90
 const DEBOUNCE_MS = 400
@@ -70,15 +70,37 @@ function segmented(host: HTMLElement): HTMLElement {
 
 describe('RetentionInput', () => {
 	let stubs: NuxtStubs
+	let api: ApiDataStub
 	let harness: Harness | undefined
 
 	beforeEach(() => {
 		vi.useFakeTimers()
 		stubs = stubNuxtGlobals()
 		vi.stubGlobal('computed', computed)
-		api.retentionPreview.mockImplementation(async (days: number) =>
-			preview(days, days < SAVED_DAYS ? 3 : 0),
+		stubRegionalFormat()
+		api = stubApiData()
+		api.respond(({ query }) => {
+			const days = Number(query.days)
+			return preview(days, days < SAVED_DAYS ? 3 : 0)
+		})
+	})
+
+	it('reads the saved days at once, then the days picked once they hold still', async () => {
+		harness = mountRetention()
+		await flush()
+		expect(api.reads).toEqual([
+			{ url: PREVIEW_URL, query: { days: String(SAVED_DAYS) } },
+		])
+		expect(harness.host.textContent).toContain(
+			'dms_mailing.settings.retention.preview_none',
 		)
+		harness.state.days = 30
+		await nextTick()
+		harness.state.days = 365
+		await nextTick()
+		await vi.advanceTimersByTimeAsync(DEBOUNCE_MS)
+		await flush()
+		expect(api.reads.map((read) => read.query.days)).toEqual(['90', '365'])
 	})
 
 	afterEach(() => {

package/frontend-vue/tests/send-modals.test.ts

@@ -1,3 +1,4 @@
+// @vitest-environment jsdom
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 import RealSendModal from '../app/components/RealSendModal.vue'
 import RecipientsField from '../app/components/RecipientsField.vue'
@@ -16,6 +17,7 @@ import {
 	typeInto,
 	type NuxtStubs,
 } from './helpers/nuxt-globals'
+import { mailingReads, stubApiData } from './helpers/api-data'
 
 const api = {
 	templateContent: vi.fn(),
@@ -24,7 +26,8 @@ const api = {
 	realSend: vi.fn(),
 }
 
-vi.mock('../app/composables/useMailingApi', () => ({
+vi.mock('../app/composables/useMailingApi', async (importOriginal) => ({
+	...(await importOriginal<object>()),
 	useMailingApi: () => api,
 }))
 
@@ -101,6 +104,11 @@ let stubs: NuxtStubs
 
 beforeEach(() => {
 	stubs = stubNuxtGlobals('camille@acme.com')
+	stubApiData().respond(
+		mailingReads({ templateContent: api.templateContent }, ({ url }) => {
+			throw new Error(`unexpected read ${url}`)
+		}),
+	)
 	api.preview.mockResolvedValue({
 		html: '',
 		subject: '20% off every chair',

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

@@ -1,3 +1,4 @@
+// @vitest-environment jsdom
 import { describe, expect, it } from 'vitest'
 import { isTypingTarget, matchShortcut } from '../app/utils/shortcuts'
 import type { KeyStroke } from '../app/utils/shortcuts'

package/frontend-vue/tests/template-drawer.test.ts

@@ -1,3 +1,4 @@
+// @vitest-environment jsdom
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 import DuplicateModal from '../app/components/DuplicateModal.vue'
 import StarterGallery from '../app/components/StarterGallery.vue'
@@ -16,6 +17,7 @@ import {
 	typeInto,
 	type NuxtStubs,
 } from './helpers/nuxt-globals'
+import { mailingReads, stubApiData } from './helpers/api-data'
 
 const api = {
 	templateContent: vi.fn(),
@@ -28,12 +30,12 @@ const api = {
 	listTemplates: vi.fn(),
 	duplicate: vi.fn(),
 	starters: vi.fn(),
-	listCategories: vi.fn(),
 	createTemplate: vi.fn(),
 	saveTemplateDetails: vi.fn(),
 }
 
-vi.mock('../app/composables/useMailingApi', () => ({
+vi.mock('../app/composables/useMailingApi', async (importOriginal) => ({
+	...(await importOriginal<object>()),
 	useMailingApi: () => api,
 }))
 
@@ -107,9 +109,27 @@ const globals = {
 
 let stubs: NuxtStubs
 
+let starters: unknown[] = []
+
 beforeEach(() => {
 	stubs = stubNuxtGlobals()
 	menuGroups = []
+	starters = []
+	stubApiData().respond(
+		mailingReads(
+			{
+				templateContent: api.templateContent,
+				performance: api.performance,
+				listTemplates: api.listTemplates,
+			},
+			({ url }) => {
+				if (url === '/api/mailing/templates/categories')
+					return { categories: [] }
+				if (url === '/api/mailing/templates/starters') return { starters }
+				throw new Error(`unexpected read ${url}`)
+			},
+		),
+	)
 	api.performance.mockResolvedValue({
 		id: 't1',
 		slug: 'order-confirmed',
@@ -402,18 +422,15 @@ describe('DuplicateModal', () => {
 
 describe('StarterGallery', () => {
 	beforeEach(() => {
-		api.starters.mockResolvedValue({
-			starters: [
-				{
-					id: 'order-confirmed',
-					name: 'Order confirmation',
-					slug: 'order-confirmed',
-					category: 'orders',
-					locales: ['en'],
-				},
-			],
-		})
-		api.listCategories.mockResolvedValue({ categories: [] })
+		starters = [
+			{
+				id: 'order-confirmed',
+				name: 'Order confirmation',
+				slug: 'order-confirmed',
+				category: 'orders',
+				locales: ['en'],
+			},
+		]
 	})
 
 	it('creates a starter as a draft and opens it', async () => {

package/frontend-vue/tests/template-gallery.test.ts

@@ -1,3 +1,4 @@
+// @vitest-environment jsdom
 import { reactive } from 'vue'
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 import TemplateGallery from '../app/components/TemplateGallery.vue'
@@ -11,15 +12,15 @@ import {
 	type NuxtStubs,
 } from './helpers/nuxt-globals'
 
-const api = {
-	listCategories: vi.fn(),
-	templatesOverview: vi.fn(),
-	listTemplates: vi.fn(),
-}
+import {
+	stubApiData,
+	stubRegionalFormat,
+	type ApiDataStub,
+} from './helpers/api-data'
 
-vi.mock('../app/composables/useMailingApi', () => ({
-	useMailingApi: () => api,
-}))
+const CATEGORIES_URL = '/api/mailing/templates/categories'
+const OVERVIEW_URL = '/api/mailing/templates/overview'
+const LIST_URL = '/api/mailing/tables/templates/list'
 
 const RECENT = new Date(Date.now() - 3_600_000).toISOString()
 
@@ -113,22 +114,32 @@ const globals = {
 }
 
 let stubs: NuxtStubs
+let api: ApiDataStub
 let routeQuery: Record<string, unknown> = {}
+let templateTotal = 3
+
+const readsOf = (url: string) => api.reads.filter((read) => read.url === url)
 
 beforeEach(() => {
 	stubs = stubNuxtGlobals()
+	stubRegionalFormat()
 	routeQuery = {}
+	templateTotal = 3
 	vi.stubGlobal('useDmsRoute', () => ({ query: routeQuery }))
-	api.listCategories.mockResolvedValue({
-		categories: [
-			{ id: 'orders', label: 'Orders', icon: 'i-ph-package' },
-			{ id: 'billing', label: 'Billing', icon: 'i-ph-file-text' },
-		],
-	})
-	api.templatesOverview.mockResolvedValue({
-		items: [stats('live', 6812), stats('missing', 12)],
+	api = stubApiData()
+	api.respond(({ url }) => {
+		if (url === CATEGORIES_URL)
+			return {
+				categories: [
+					{ id: 'orders', label: 'Orders', icon: 'i-ph-package' },
+					{ id: 'billing', label: 'Billing', icon: 'i-ph-file-text' },
+				],
+			}
+		if (url === OVERVIEW_URL)
+			return { items: [stats('live', 6812), stats('missing', 12)] }
+		if (url === LIST_URL) return { results: [LIVE], total: templateTotal }
+		throw new Error(`unexpected read ${url}`)
 	})
-	api.listTemplates.mockResolvedValue({ results: [], total: 3 })
 })
 
 afterEach(() => {
@@ -205,21 +216,32 @@ describe('TemplateGallery', () => {
 		cleared.unmount()
 	})
 
+	it('reads the template count alone, not the rows', async () => {
+		const view = mount(
+			TemplateGallery,
+			{ context: context({ items: [LIVE] }) },
+			globals,
+		)
+		await flush()
+		expect(readsOf(LIST_URL)).toEqual([
+			{ url: LIST_URL, query: { limit: '1' } },
+		])
+		view.unmount()
+	})
+
 	it('reloads the figures when the table refreshes, not when it pages', async () => {
-		api.listTemplates.mockClear()
-		api.templatesOverview.mockClear()
 		const ctx = reactive(context({ items: [LIVE] }))
 		const view = mount(TemplateGallery, { context: ctx }, globals)
 		await flush()
-		expect(api.listTemplates).toHaveBeenCalledTimes(1)
+		expect(readsOf(LIST_URL)).toHaveLength(1)
 		ctx.items = [LIVE]
 		await flush()
-		expect(api.listTemplates).toHaveBeenCalledTimes(2)
-		expect(api.templatesOverview).toHaveBeenCalledTimes(2)
+		expect(readsOf(LIST_URL)).toHaveLength(2)
+		expect(readsOf(OVERVIEW_URL)).toHaveLength(2)
 		ctx.pagination.pageIndex = 1
 		ctx.items = [MISSING_DE]
 		await flush()
-		expect(api.listTemplates).toHaveBeenCalledTimes(2)
+		expect(readsOf(LIST_URL)).toHaveLength(2)
 		view.unmount()
 	})
 
@@ -261,7 +283,7 @@ describe('TemplateGallery', () => {
 	})
 
 	it('shows the starters on a first run', async () => {
-		api.listTemplates.mockResolvedValue({ results: [], total: 0 })
+		templateTotal = 0
 		const view = mount(
 			TemplateGallery,
 			{ context: context({ items: [] }) },

package/frontend-vue/tests/variable-path.test.ts

@@ -1,3 +1,4 @@
+// @vitest-environment jsdom
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 import VariablePath from '../app/components/VariablePath.vue'
 import { mount, stubNuxtGlobals } from './helpers/nuxt-globals'

package/frontend-vue/vitest.config.ts

@@ -4,7 +4,10 @@ import { defineConfig } from 'vitest/config'
 export default defineConfig({
 	plugins: [vue()],
 	test: {
-		environment: 'jsdom',
+		// Most suites need no DOM, and setting jsdom up per file is the bulk of
+		// the run; the files that mount components opt in with a
+		// `// @vitest-environment jsdom` header.
+		environment: 'node',
 		include: ['tests/**/*.test.ts'],
 	},
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/dms-mailing",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -38,7 +38,7 @@
     "@antelopejs/interface-data-api": ">=0.2.1 <1.0.0",
     "@antelopejs/interface-database": ">=0.1.9 <1.0.0",
     "@antelopejs/interface-database-decorators": ">=0.1.7 <1.0.0",
-    "@antelopejs/interface-dms": ">=0.5.13 <1.0.0",
+    "@antelopejs/interface-dms": ">=0.7.0 <1.0.0",
     "@antelopejs/interface-dms-mailing": ">=0.7.0 <0.8.0",
     "@antelopejs/interface-email": ">=0.0.5 <1.0.0",
     "node-cron": "^4.2.1",
@@ -86,9 +86,9 @@
     "knip:all": "knip",
     "release": "pnpm --filter @antelopejs/interface-dms-mailing build && pnpm --dir frontend-vue install --frozen-lockfile && release-it",
     "test": "pnpm run test:backend && pnpm run test:layer",
-    "test:backend": "pnpm run build && ajs module test .",
+    "test:backend": "([ -n \"$DMS_PREBUILT\" ] || pnpm run build) && ajs module test .",
     "test:layer": "cd frontend-vue && pnpm test",
-    "test:unit": "pnpm run build && DMS_MAILING_TEST_DIR=dist/test/unit ajs module test .",
-    "test:integration": "pnpm run build && DMS_MAILING_TEST_DIR=dist/test/integration ajs module test ."
+    "test:unit": "([ -n \"$DMS_PREBUILT\" ] || pnpm run build) && DMS_MAILING_TEST_DIR=dist/test/unit ajs module test .",
+    "test:integration": "([ -n \"$DMS_PREBUILT\" ] || pnpm run build) && DMS_MAILING_TEST_DIR=dist/test/integration ajs module test ."
   }
 }

package/src/pages/sends.ts

@@ -122,7 +122,7 @@ const sendAgainAction = (isTest: boolean): SendRowAction => ({
   },
   target: {
     type: "api",
-    url: `${API_BASE_PATH}/sends/{_id}/replay`,
+    url: `${API_BASE_PATH}/sends/{{row._id}}/replay`,
     method: "POST",
     successMessage: "$dms_mailing.sends.actions.sent_again",
   },
@@ -152,7 +152,7 @@ const suppressedAddressAction: SendRowAction = {
   },
   target: {
     type: "page",
-    url: `${SUPPRESSIONS_PAGE}?email={suppressionAddress}`,
+    url: `${SUPPRESSIONS_PAGE}?email={{row.suppressionAddress}}`,
   },
 };
 

package/src/pages/suppressions.ts

@@ -133,7 +133,7 @@ export class SuppressionsPageController extends PageController(
           showLabel: true,
           target: {
             type: "api",
-            url: `${SUPPRESSIONS_URL}/{_id}`,
+            url: `${SUPPRESSIONS_URL}/{{row._id}}`,
             method: "DELETE",
             successMessage: key("actions.reactivated"),
           },
@@ -149,7 +149,7 @@ export class SuppressionsPageController extends PageController(
           label: key("actions.see_send"),
           icon: "i-ph-paper-plane-tilt",
           rule: { field: "sendId", notEquals: "" },
-          target: { type: "page", url: `${SENDS_PATH}?record={sendId}` },
+          target: { type: "page", url: `${SENDS_PATH}?record={{row.sendId}}` },
         },
       ],
     },

package/src/pages/templates.ts

@@ -144,7 +144,7 @@ export class TemplatesPageController extends PageController(
           label: "$dms_mailing.templates.actions.open_editor",
           icon: "i-ph-pencil-simple",
           isDefault: true,
-          target: { type: "page", url: `${TEMPLATES_PATH}/{_id}` },
+          target: { type: "page", url: `${TEMPLATES_PATH}/{{row._id}}` },
         },
         {
           label: "$dms_mailing.templates.actions.details",
@@ -184,7 +184,7 @@ export class TemplatesPageController extends PageController(
           rule: { field: "status", notEquals: ARCHIVED_STATUS },
           target: {
             type: "api",
-            url: `${API_BASE_PATH}/templates/{_id}/archive`,
+            url: `${API_BASE_PATH}/templates/{{row._id}}/archive`,
             method: "POST",
             successMessage: "$dms_mailing.templates.actions.archived",
           },
@@ -200,7 +200,7 @@ export class TemplatesPageController extends PageController(
           rule: { field: "status", equals: ARCHIVED_STATUS },
           target: {
             type: "api",
-            url: `${API_BASE_PATH}/templates/{_id}/restore`,
+            url: `${API_BASE_PATH}/templates/{{row._id}}/restore`,
             method: "POST",
             successMessage: "$dms_mailing.templates.actions.restored",
           },

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

@@ -1,8 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { SEND_STATUSES } from '../app/types/mailing'
-
-describe('types', () => {
-	it('exposes the send statuses', () => {
-		expect(SEND_STATUSES).toContain('bounced')
-	})
-})