@duffcloudservices/cms 0.3.12 → 0.3.14

package/src/composables/useReleaseNotes.ts

@@ -1,153 +1,153 @@
-/**
- * useReleaseNotes Composable
- *
- * Fetches and displays versioned release notes from the DCS Portal API.
- * Supports fetching specific versions or the latest release.
- *
- * @example
- * ```vue
- * <script setup lang="ts">
- * import { useReleaseNotes } from '@duffcloudservices/cms'
- * import { useRoute } from 'vue-router'
- *
- * const route = useRoute()
- * const version = route.params.version as string || 'latest'
- *
- * const { releaseNote, isLoading, error } = useReleaseNotes(version)
- * </script>
- *
- * <template>
- *   <div v-if="isLoading">Loading...</div>
- *   <div v-else-if="error">{{ error }}</div>
- *   <article v-else-if="releaseNote">
- *     <h1>{{ releaseNote.title }}</h1>
- *     <p>{{ releaseNote.summary }}</p>
- *     <div v-html="renderedMarkdown" />
- *   </article>
- * </template>
- * ```
- */
-
-import { ref, onMounted } from 'vue'
-import type { ReleaseNote, ReleaseNotesReturn } from '../types/release-notes'
-
-/**
- * Get environment variable value.
- */
-function getEnvVar(key: string, defaultValue = ''): string {
-  try {
-    if (typeof import.meta !== 'undefined' && import.meta.env) {
-      const value = (import.meta.env as Record<string, string | undefined>)[key]
-      if (value !== undefined) return value
-    }
-  } catch {
-    // import.meta not available
-  }
-  return defaultValue
-}
-
-// Simple cache for release notes
-const releaseNotesCache = new Map<string, { data: ReleaseNote; expiresAt: number }>()
-const CACHE_TTL = 5 * 60 * 1000 // 5 minutes
-
-/**
- * useReleaseNotes composable for fetching release notes from the DCS API.
- *
- * @param version - Semantic version (e.g., "1.2.0") or "latest"
- * @param options - Optional configuration
- * @returns Release notes data and state
- */
-export function useReleaseNotes(
-  version: string,
-  options: { fetchOnMount?: boolean } = {}
-): ReleaseNotesReturn {
-  const { fetchOnMount = true } = options
-
-  const apiBaseUrl = getEnvVar('VITE_API_BASE_URL', 'https://portal.duffcloudservices.com')
-  const siteSlug = getEnvVar('VITE_SITE_SLUG', '')
-
-  const releaseNote = ref<ReleaseNote | null>(null)
-  const isLoading = ref(false)
-  const error = ref<string | null>(null)
-
-  async function fetchReleaseNotes(): Promise<void> {
-    if (!siteSlug) {
-      error.value = 'VITE_SITE_SLUG environment variable not set'
-      return
-    }
-
-    // Check cache
-    const cacheKey = `${siteSlug}:${version}`
-    const cached = releaseNotesCache.get(cacheKey)
-    if (cached && cached.expiresAt > Date.now()) {
-      releaseNote.value = cached.data
-      return
-    }
-
-    isLoading.value = true
-    error.value = null
-
-    try {
-      const url = `${apiBaseUrl}/api/v1/sites/${siteSlug}/release-notes/${version}`
-      const response = await fetch(url, {
-        headers: {
-          Accept: 'application/json',
-        },
-      })
-
-      if (!response.ok) {
-        if (response.status === 404) {
-          error.value = `Release notes for version ${version} not found`
-          return
-        }
-        throw new Error(`HTTP ${response.status}: ${response.statusText}`)
-      }
-
-      const data = await response.json()
-
-      // Normalize the response
-      const note: ReleaseNote = {
-        version: data.version,
-        title: data.title,
-        summary: data.summary || '',
-        notesMarkdown: data.notesMarkdown || data.notes || '',
-        changeCount: data.changeCount || 0,
-        releaseDate: data.releaseDate || data.releasedAt || '',
-      }
-
-      // Cache the result
-      releaseNotesCache.set(cacheKey, {
-        data: note,
-        expiresAt: Date.now() + CACHE_TTL,
-      })
-
-      releaseNote.value = note
-    } catch (e) {
-      error.value = e instanceof Error ? e.message : 'Failed to load release notes'
-      console.error('[@duffcloudservices/cms] Failed to fetch release notes:', e)
-    } finally {
-      isLoading.value = false
-    }
-  }
-
-  async function refresh(): Promise<void> {
-    // Clear cache
-    const cacheKey = `${siteSlug}:${version}`
-    releaseNotesCache.delete(cacheKey)
-    await fetchReleaseNotes()
-  }
-
-  // Fetch on mount if enabled
-  if (fetchOnMount && typeof window !== 'undefined') {
-    onMounted(() => {
-      fetchReleaseNotes()
-    })
-  }
-
-  return {
-    releaseNote,
-    isLoading,
-    error,
-    refresh,
-  }
-}
+/**
+ * useReleaseNotes Composable
+ *
+ * Fetches and displays versioned release notes from the DCS Portal API.
+ * Supports fetching specific versions or the latest release.
+ *
+ * @example
+ * ```vue
+ * <script setup lang="ts">
+ * import { useReleaseNotes } from '@duffcloudservices/cms'
+ * import { useRoute } from 'vue-router'
+ *
+ * const route = useRoute()
+ * const version = route.params.version as string || 'latest'
+ *
+ * const { releaseNote, isLoading, error } = useReleaseNotes(version)
+ * </script>
+ *
+ * <template>
+ *   <div v-if="isLoading">Loading...</div>
+ *   <div v-else-if="error">{{ error }}</div>
+ *   <article v-else-if="releaseNote">
+ *     <h1>{{ releaseNote.title }}</h1>
+ *     <p>{{ releaseNote.summary }}</p>
+ *     <div v-html="renderedMarkdown" />
+ *   </article>
+ * </template>
+ * ```
+ */
+
+import { ref, onMounted } from 'vue'
+import type { ReleaseNote, ReleaseNotesReturn } from '../types/release-notes'
+
+/**
+ * Get environment variable value.
+ */
+function getEnvVar(key: string, defaultValue = ''): string {
+  try {
+    if (typeof import.meta !== 'undefined' && import.meta.env) {
+      const value = (import.meta.env as Record<string, string | undefined>)[key]
+      if (value !== undefined) return value
+    }
+  } catch {
+    // import.meta not available
+  }
+  return defaultValue
+}
+
+// Simple cache for release notes
+const releaseNotesCache = new Map<string, { data: ReleaseNote; expiresAt: number }>()
+const CACHE_TTL = 5 * 60 * 1000 // 5 minutes
+
+/**
+ * useReleaseNotes composable for fetching release notes from the DCS API.
+ *
+ * @param version - Semantic version (e.g., "1.2.0") or "latest"
+ * @param options - Optional configuration
+ * @returns Release notes data and state
+ */
+export function useReleaseNotes(
+  version: string,
+  options: { fetchOnMount?: boolean } = {}
+): ReleaseNotesReturn {
+  const { fetchOnMount = true } = options
+
+  const apiBaseUrl = getEnvVar('VITE_API_BASE_URL', 'https://portal.duffcloudservices.com')
+  const siteSlug = getEnvVar('VITE_SITE_SLUG', '')
+
+  const releaseNote = ref<ReleaseNote | null>(null)
+  const isLoading = ref(false)
+  const error = ref<string | null>(null)
+
+  async function fetchReleaseNotes(): Promise<void> {
+    if (!siteSlug) {
+      error.value = 'VITE_SITE_SLUG environment variable not set'
+      return
+    }
+
+    // Check cache
+    const cacheKey = `${siteSlug}:${version}`
+    const cached = releaseNotesCache.get(cacheKey)
+    if (cached && cached.expiresAt > Date.now()) {
+      releaseNote.value = cached.data
+      return
+    }
+
+    isLoading.value = true
+    error.value = null
+
+    try {
+      const url = `${apiBaseUrl}/api/v1/sites/${siteSlug}/release-notes/${version}`
+      const response = await fetch(url, {
+        headers: {
+          Accept: 'application/json',
+        },
+      })
+
+      if (!response.ok) {
+        if (response.status === 404) {
+          error.value = `Release notes for version ${version} not found`
+          return
+        }
+        throw new Error(`HTTP ${response.status}: ${response.statusText}`)
+      }
+
+      const data = await response.json()
+
+      // Normalize the response
+      const note: ReleaseNote = {
+        version: data.version,
+        title: data.title,
+        summary: data.summary || '',
+        notesMarkdown: data.notesMarkdown || data.notes || '',
+        changeCount: data.changeCount || 0,
+        releaseDate: data.releaseDate || data.releasedAt || '',
+      }
+
+      // Cache the result
+      releaseNotesCache.set(cacheKey, {
+        data: note,
+        expiresAt: Date.now() + CACHE_TTL,
+      })
+
+      releaseNote.value = note
+    } catch (e) {
+      error.value = e instanceof Error ? e.message : 'Failed to load release notes'
+      console.error('[@duffcloudservices/cms] Failed to fetch release notes:', e)
+    } finally {
+      isLoading.value = false
+    }
+  }
+
+  async function refresh(): Promise<void> {
+    // Clear cache
+    const cacheKey = `${siteSlug}:${version}`
+    releaseNotesCache.delete(cacheKey)
+    await fetchReleaseNotes()
+  }
+
+  // Fetch on mount if enabled
+  if (fetchOnMount && typeof window !== 'undefined') {
+    onMounted(() => {
+      fetchReleaseNotes()
+    })
+  }
+
+  return {
+    releaseNote,
+    isLoading,
+    error,
+    refresh,
+  }
+}

package/src/composables/useResponsiveImage.ts

@@ -1,85 +1,85 @@
-/**
- * Vue 3 composable that resolves responsive image variants for DCS CDN-hosted assets.
- *
- * Wraps the framework-agnostic `resolveResponsiveImage` from `@duffcloudservices/cms-core`
- * with reactive Vue refs so it can be used directly in `<script setup>` blocks.
- *
- * @example
- * ```vue
- * <script setup lang="ts">
- * import { useResponsiveImage } from '@duffcloudservices/cms'
- *
- * const hero = useResponsiveImage({
- *   src: 'https://files.duffcloudservices.com/kept/assets/hero/abc-123.jpg',
- *   alt: 'Hero image',
- *   context: 'hero',
- * })
- * </script>
- *
- * <template>
- *   <picture v-if="hero.hasVariants">
- *     <source
- *       v-for="source in hero.sources"
- *       :key="source.type"
- *       :srcset="source.srcset"
- *       :type="source.type"
- *       :sizes="source.sizes"
- *     />
- *     <img v-bind="hero.imgProps" class="w-full h-full object-cover" />
- *   </picture>
- *   <img v-else v-bind="hero.imgProps" class="w-full h-full object-cover" />
- * </template>
- * ```
- */
-
-import { computed, type MaybeRefOrGetter, toValue } from 'vue'
-import {
-  resolveResponsiveImage,
-  type ImageContext,
-  type ResponsiveImageResult,
-} from '@duffcloudservices/cms-core'
-
-export interface UseResponsiveImageOptions {
-  /** Source URL — can be a reactive ref, getter, or plain string. */
-  src: MaybeRefOrGetter<string>
-  /** Alt text — can be a reactive ref, getter, or plain string. */
-  alt: MaybeRefOrGetter<string>
-  /** Sizing context — determines which variants to include. */
-  context?: MaybeRefOrGetter<ImageContext | undefined>
-  /** Optional `sizes` attribute override. */
-  sizes?: MaybeRefOrGetter<string | undefined>
-  /** Skip variant resolution and use the original URL only. */
-  original?: MaybeRefOrGetter<boolean | undefined>
-}
-
-/**
- * Reactively resolves responsive image metadata for a DCS CDN URL.
- *
- * The returned object is a computed ref that recomputes whenever any
- * of the input refs change. Spread `imgProps` onto an `<img>` or
- * combine with `sources` inside a `<picture>` element.
- */
-export function useResponsiveImage(options: UseResponsiveImageOptions): ResponsiveImageResult {
-  const result = computed(() =>
-    resolveResponsiveImage({
-      src: toValue(options.src),
-      alt: toValue(options.alt),
-      context: toValue(options.context),
-      sizes: toValue(options.sizes),
-      original: toValue(options.original) ?? undefined,
-    }),
-  )
-
-  // Return a reactive proxy that delegates to the computed
-  return {
-    get imgProps() {
-      return result.value.imgProps
-    },
-    get sources() {
-      return result.value.sources
-    },
-    get hasVariants() {
-      return result.value.hasVariants
-    },
-  }
-}
+/**
+ * Vue 3 composable that resolves responsive image variants for DCS CDN-hosted assets.
+ *
+ * Wraps the framework-agnostic `resolveResponsiveImage` from `@duffcloudservices/cms-core`
+ * with reactive Vue refs so it can be used directly in `<script setup>` blocks.
+ *
+ * @example
+ * ```vue
+ * <script setup lang="ts">
+ * import { useResponsiveImage } from '@duffcloudservices/cms'
+ *
+ * const hero = useResponsiveImage({
+ *   src: 'https://files.duffcloudservices.com/kept/assets/hero/abc-123.jpg',
+ *   alt: 'Hero image',
+ *   context: 'hero',
+ * })
+ * </script>
+ *
+ * <template>
+ *   <picture v-if="hero.hasVariants">
+ *     <source
+ *       v-for="source in hero.sources"
+ *       :key="source.type"
+ *       :srcset="source.srcset"
+ *       :type="source.type"
+ *       :sizes="source.sizes"
+ *     />
+ *     <img v-bind="hero.imgProps" class="w-full h-full object-cover" />
+ *   </picture>
+ *   <img v-else v-bind="hero.imgProps" class="w-full h-full object-cover" />
+ * </template>
+ * ```
+ */
+
+import { computed, type MaybeRefOrGetter, toValue } from 'vue'
+import {
+  resolveResponsiveImage,
+  type ImageContext,
+  type ResponsiveImageResult,
+} from '@duffcloudservices/cms-core'
+
+export interface UseResponsiveImageOptions {
+  /** Source URL — can be a reactive ref, getter, or plain string. */
+  src: MaybeRefOrGetter<string>
+  /** Alt text — can be a reactive ref, getter, or plain string. */
+  alt: MaybeRefOrGetter<string>
+  /** Sizing context — determines which variants to include. */
+  context?: MaybeRefOrGetter<ImageContext | undefined>
+  /** Optional `sizes` attribute override. */
+  sizes?: MaybeRefOrGetter<string | undefined>
+  /** Skip variant resolution and use the original URL only. */
+  original?: MaybeRefOrGetter<boolean | undefined>
+}
+
+/**
+ * Reactively resolves responsive image metadata for a DCS CDN URL.
+ *
+ * The returned object is a computed ref that recomputes whenever any
+ * of the input refs change. Spread `imgProps` onto an `<img>` or
+ * combine with `sources` inside a `<picture>` element.
+ */
+export function useResponsiveImage(options: UseResponsiveImageOptions): ResponsiveImageResult {
+  const result = computed(() =>
+    resolveResponsiveImage({
+      src: toValue(options.src),
+      alt: toValue(options.alt),
+      context: toValue(options.context),
+      sizes: toValue(options.sizes),
+      original: toValue(options.original) ?? undefined,
+    }),
+  )
+
+  // Return a reactive proxy that delegates to the computed
+  return {
+    get imgProps() {
+      return result.value.imgProps
+    },
+    get sources() {
+      return result.value.sources
+    },
+    get hasVariants() {
+      return result.value.hasVariants
+    },
+  }
+}