@antelopejs/dms-marketing 0.3.2 → 0.4.0

package/frontend-vue/app/composables/useMarketingWebsiteForm.ts

@@ -1,69 +0,0 @@
-import { useI18n } from '#dms/frontend-module'
-import TrackerSnippet from '../components/TrackerSnippet.vue'
-import { dmsComponent } from '../utils/dmsComponent'
-import type { MarketingWebsite } from './useMarketingApi'
-
-const WEBSITES_URL = '/api/marketing/websites'
-
-const WEBSITE_FORM_SCHEMA = {
-  type: 'object',
-  properties: {
-    name: { type: 'string', minLength: 1, maxLength: 100 },
-    domain: { type: 'string', minLength: 1, maxLength: 253 },
-  },
-  required: ['name', 'domain'],
-}
-
-const WEBSITE_FORM_FIELDS = [
-  {
-    id: 'name',
-    label: '$page.marketing.websites.column.name',
-    required: true,
-    component: {
-      componentName: 'dms-input-text',
-      options: { placeholder: '$page.marketing.websites.form.name' },
-    },
-  },
-  {
-    id: 'domain',
-    label: '$page.marketing.websites.column.domain',
-    description: '$page.marketing.websites.form.domain_description',
-    required: true,
-    component: {
-      componentName: 'dms-input-text',
-      options: { placeholder: '$page.marketing.websites.form.domain' },
-    },
-  },
-]
-
-export function useMarketingWebsiteForm() {
-  const modal = useModal()
-  const { t } = useI18n()
-
-  function openCreate(): Promise<MarketingWebsite | undefined> {
-    const instance = modal.open<MarketingWebsite | undefined>({
-      title: t('page.marketing.websites.create_title'),
-      component: dmsComponent('dms-form'),
-      componentOptions: {
-        fields: WEBSITE_FORM_FIELDS,
-        schema: WEBSITE_FORM_SCHEMA,
-        submitUrl: WEBSITES_URL,
-        submitUrlMethod: 'POST',
-        onSuccessCallback: (response?: unknown) => {
-          instance.close(response as MarketingWebsite)
-        },
-      },
-    })
-    return instance.result
-  }
-
-  function openSnippet(website: MarketingWebsite): Promise<void> {
-    return modal.open<undefined>({
-      title: t('page.marketing.websites.snippet.title'),
-      component: TrackerSnippet,
-      componentOptions: { website },
-    }).result
-  }
-
-  return { openCreate, openSnippet }
-}

package/frontend-vue/app/composables/useMarketingWebsites.ts

@@ -1,80 +0,0 @@
-import { computed, ref, type ComputedRef, type Ref } from 'vue'
-import { useLatestRequest } from './useLatestRequest'
-import { useMarketingApi, type MarketingWebsite } from './useMarketingApi'
-import { useMarketingWebsiteForm } from './useMarketingWebsiteForm'
-
-/**
- * The tenant's tracked sites and the one currently being looked at — the
- * preamble of every marketing surface that is not scoped by a TableView.
- *
- * The list is what the endpoint returns, most-recently-active first, so the
- * default selection is a site that has something to show. A selection carried
- * in from a deep link wins over that default, but only while it still names a
- * site that exists: a stale link must land on a populated page, not a blank
- * one.
- */
-export interface MarketingWebsitesState {
-  websites: ComputedRef<MarketingWebsite[]>
-  /** `{ label, value }` pairs for a USelect. */
-  items: ComputedRef<{ label: string, value: string }[]>
-  selectedId: Ref<string | undefined>
-  selected: ComputedRef<MarketingWebsite | null>
-  /** True until the list has answered once, then only while it refetches. */
-  loading: ComputedRef<boolean>
-  failed: Ref<boolean>
-  load: () => Promise<void>
-  create: () => Promise<void>
-  showSnippet: () => Promise<void>
-}
-
-export function useMarketingWebsites(
-  initialId?: string,
-): MarketingWebsitesState {
-  const api = useMarketingApi()
-  const form = useMarketingWebsiteForm()
-  const selectedId = ref<string | undefined>(initialId || undefined)
-  const request = useLatestRequest(() => api.listWebsites())
-
-  const websites = computed(() => request.data.value ?? [])
-  const selected = computed(
-    () => websites.value.find(site => site._id === selectedId.value) ?? null,
-  )
-
-  async function load(): Promise<void> {
-    await request.run()
-    const linked = websites.value.find(site => site._id === selectedId.value)
-    selectedId.value = linked?._id ?? websites.value[0]?._id
-  }
-
-  async function create(): Promise<void> {
-    const created = await form.openCreate()
-    if (!created) {
-      return
-    }
-    selectedId.value = created._id
-    await load()
-    await form.openSnippet(created)
-  }
-
-  async function showSnippet(): Promise<void> {
-    if (selected.value) {
-      await form.openSnippet(selected.value)
-    }
-  }
-
-  return {
-    websites,
-    items: computed(() =>
-      websites.value.map(site => ({ label: site.name, value: site._id })),
-    ),
-    selectedId,
-    selected,
-    // Not asked yet reads as loading: a component that told them apart would
-    // flash its "no website tracked" state before the first answer lands.
-    loading: computed(() => !request.settled.value || request.loading.value),
-    failed: request.failed,
-    load,
-    create,
-    showSnippet,
-  }
-}

package/frontend-vue/app/utils/dmsComponent.ts

@@ -1,18 +0,0 @@
-import type { Component } from 'vue'
-import { resolveDmsComponent } from '#dms/frontend-module'
-
-/**
- * A DMS core component addressed by name.
- *
- * The core frontend module registers its components before any other module's
- * entry runs, so a name that does not resolve is a programming error rather
- * than a state worth rendering around — and the callers hand the result to
- * APIs that take a component, not an optional one.
- */
-export function dmsComponent(name: string): Component {
-  const component = resolveDmsComponent(name)
-  if (!component) {
-    throw new Error(`Unknown DMS component: ${name}`)
-  }
-  return component
-}

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

@@ -1,35 +0,0 @@
-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)
-  })
-})