@gscdump/nuxt 0.22.4 → 1.5.3

package/app/utils/gsc-rows.ts

@@ -1,72 +0,0 @@
-// Shape-canonicalising helpers for GSC row payloads.
-//
-// Free-tier rows (GSC API) ship `position`; engine rows ship `sum_position`.
-// Both formats coerce to the same denominator: `sum_position = position * impressions`,
-// so downstream `weightedPosition / impressions` math works without branching.
-//
-// Lifted from the per-page detail pages where the coalesce + totals reducer
-// was duplicated. The `+1` in `position` is GSC's 1-indexed convention
-// (position 1 == top result), applied once after weighting.
-
-export interface RawDailyRow {
-  date: string
-  clicks: number
-  impressions: number
-  sum_position?: number
-  position?: number
-}
-
-export interface CanonicalDailyRow {
-  date: string
-  clicks: number
-  impressions: number
-  sum_position: number
-}
-
-export interface GscRowTotals {
-  clicks: number
-  impressions: number
-  ctr: number
-  position: number
-}
-
-export interface GscDailySummary {
-  daily: CanonicalDailyRow[]
-  totals: GscRowTotals
-  chartData: Array<{ date: string, clicks: number, impressions: number }>
-}
-
-/** Fill `sum_position` from `position * impressions` when the row only carries `position`. */
-export function coerceRowMetrics<
-  T extends { impressions: number, sum_position?: number, position?: number },
->(row: T): T & { sum_position: number } {
-  return {
-    ...row,
-    sum_position: row.sum_position ?? (row.position ?? 0) * row.impressions,
-  }
-}
-
-/** Sort daily rows by date asc, coerce `sum_position`, reduce totals, derive chartData. */
-export function summarizeDailyRows(raw: readonly RawDailyRow[]): GscDailySummary {
-  const daily: CanonicalDailyRow[] = raw
-    .map(coerceRowMetrics)
-    .map(r => ({ date: r.date, clicks: r.clicks, impressions: r.impressions, sum_position: r.sum_position }))
-    .sort((a, b) => a.date.localeCompare(b.date))
-
-  let clicks = 0
-  let impressions = 0
-  let weightedPosition = 0
-  for (const d of daily) {
-    clicks += d.clicks
-    impressions += d.impressions
-    weightedPosition += d.sum_position
-  }
-  const totals: GscRowTotals = {
-    clicks,
-    impressions,
-    ctr: impressions > 0 ? clicks / impressions : 0,
-    position: impressions > 0 ? weightedPosition / impressions + 1 : 0,
-  }
-  const chartData = daily.map(d => ({ date: d.date, clicks: d.clicks, impressions: d.impressions }))
-  return { daily, totals, chartData }
-}

package/app/utils/gsc-rpc.ts

@@ -1,18 +0,0 @@
-import type { NuxtRpcErrorEvent, UseNuxtRpcOptions } from 'nuxt-use-query/rpc'
-import { toHumanNuxtRpcError, useNuxtRpc } from 'nuxt-use-query/rpc'
-import { useGscFetch } from './gsc-fetch'
-
-// Layer-shared RPC executor. Routes through `useGscFetch()` so auth headers and
-// the configured `apiBase` (cross-origin gscdump.com deployments) are honoured.
-// Defaults `onError` to log a humanised message via `toHumanNuxtRpcError`; the
-// toast is already emitted by `useGscFetch`'s `onResponseError`, so this is
-// non-duplicate diagnostic output that hosts can override.
-export function useGscRpc(options: UseNuxtRpcOptions = {}): ReturnType<typeof useNuxtRpc> {
-  return useNuxtRpc({
-    ...options,
-    fetch: options.fetch ?? (useGscFetch() as UseNuxtRpcOptions['fetch']),
-    onError: options.onError ?? ((event: NuxtRpcErrorEvent) => {
-      console.warn(`[gsc-rpc] ${event.operation.method} ${event.operation.path}: ${toHumanNuxtRpcError(event.error)}`)
-    }),
-  })
-}

package/app/utils/position.ts

@@ -1,7 +0,0 @@
-// Rollup-row position helper. `sum_position` is GSC's average-position sum
-// across impressions; dividing back out (+1 because GSC is 1-indexed) gives
-// the impression-weighted average position. Returns 0 when there were no
-// impressions so the column renders blank rather than NaN.
-export function positionFor(r: { impressions: number, sum_position: number }): number {
-  return r.impressions > 0 ? r.sum_position / r.impressions + 1 : 0
-}

package/module.ts

@@ -1,81 +0,0 @@
-// Nuxt module for @gscdump/nuxt.
-//
-// Responsibilities:
-//  - Merge the layer's public runtime-config defaults (apiBase, duckdbBundleBase)
-//    with env-var fallbacks. The layer is a portable client; hosts pick where
-//    `/api/__gsc/*` calls go via `GSCDUMP_ANALYTICS_API_BASE`.
-//  - Generate the `$gscAnalyzers` plugin from `options.analyzers` so hosts
-//    only declare their analyzer registry path in `nuxt.config.ts` — no
-//    plugin boilerplate.
-//
-// Auth-provider wiring is NOT a Nuxt module hook; the host wires its own
-// Nitro server handlers using primitives from @gscdump/cloudflare,
-// @gscdump/engine-sqlite, and @gscdump/analysis. Using a build-time hook
-// here would fire before the host's plugin has a chance to register.
-
-import type { GscAnalyticsRuntimeConfig } from './types'
-import process from 'node:process'
-import { addPluginTemplate, defineNuxtModule } from '@nuxt/kit'
-import { defu } from 'defu'
-
-export interface ModuleOptions {
-  /**
-   * Path to a TS/JS file exporting `ANALYZERS` (a `GscAnalyzerDefinition[]`).
-   * Accepts Nuxt aliases (`~/gscAnalyzers`) or absolute paths. When set, the
-   * module generates a plugin that provides `$gscAnalyzers` so hosts do not
-   * need to hand-roll their own plugin file.
-   */
-  analyzers?: string
-}
-
-declare module 'nuxt/schema' {
-  interface NuxtConfig { gscdumpAnalytics?: ModuleOptions }
-  interface NuxtOptions { gscdumpAnalytics: ModuleOptions }
-}
-
-export default defineNuxtModule<ModuleOptions>({
-  meta: {
-    name: '@gscdump/nuxt',
-    configKey: 'gscdumpAnalytics',
-    compatibility: { nuxt: '>=4.0.0' },
-  },
-  setup(options, nuxt) {
-    const defaults: GscAnalyticsRuntimeConfig = {
-      apiBase: process.env.GSCDUMP_ANALYTICS_API_BASE ?? '',
-      duckdbBundleBase: process.env.GSCDUMP_DUCKDB_BUNDLE_BASE ?? '',
-      timezone: process.env.GSCDUMP_ANALYTICS_TIMEZONE ?? '',
-      toastErrors: process.env.GSCDUMP_ANALYTICS_TOAST_ERRORS === 'true',
-      defaultEngine: (process.env.GSCDUMP_ANALYTICS_DEFAULT_ENGINE as GscAnalyticsRuntimeConfig['defaultEngine'] | undefined) ?? 'auto',
-    }
-    nuxt.options.runtimeConfig.public.analytics = defu(
-      nuxt.options.runtimeConfig.public.analytics as Partial<GscAnalyticsRuntimeConfig> | undefined,
-      defaults,
-    )
-
-    if (options.analyzers) {
-      // Generated plugin imports the host's analyzer file and provides
-      // `$gscAnalyzers`. Runs after the layer's `analytics.ts` plugin (which
-      // doesn't provide `$gscAnalyzers`), so consumers see this array.
-      addPluginTemplate({
-        filename: 'gscdump-analyzers.plugin.mjs',
-        getContents: () => [
-          `import { defineNuxtPlugin } from '#app'`,
-          `import { ANALYZERS } from ${JSON.stringify(options.analyzers)}`,
-          `export default defineNuxtPlugin(() => ({ provide: { gscAnalyzers: ANALYZERS } }))`,
-          ``,
-        ].join('\n'),
-      })
-    }
-
-    // Strip internal composables from the consumer auto-import surface.
-    // `app/composables/_useFoo.ts` stays usable inside the layer via explicit
-    // relative imports, but never appears as a global auto-import in host apps.
-    nuxt.hook('imports:extend', (imports) => {
-      for (let i = imports.length - 1; i >= 0; i--) {
-        const from = imports[i]?.from ?? ''
-        if (/\/_use[A-Z]/.test(from))
-          imports.splice(i, 1)
-      }
-    })
-  },
-})

package/nuxt.config.ts

@@ -1,61 +0,0 @@
-// Layer-mode Nuxt config for @gscdump/nuxt.
-//
-// Consuming apps pull this in via `extends: ['@gscdump/nuxt']` in
-// their own nuxt.config.ts. Anything declared here is a shared default; hosts
-// can override in the normal Nuxt fashion (defu-merged, app config wins).
-//
-// Contract: the layer assumes every consumer is a Nuxt UI v4 app. We register
-// `@nuxt/ui` here and ship the shared main.css so hosts don't have to
-// rediscover the setup — components in this layer freely use UButton,
-// UPopover, UIcon, etc.
-
-import { fileURLToPath } from 'node:url'
-
-export default defineNuxtConfig({
-  // Register the layer's module so hooks + runtime config land on host apps
-  // without them having to wire each module individually.
-  //
-  // `nuxt-use-query` provides `useNuxtQuery` / `useQueryCache` — TanStack-Query-
-  // shaped wrapper over `useFetch`. Composables in this layer fetch through
-  // it for SWR + dedup.
-  modules: [
-    fileURLToPath(new URL('./module.ts', import.meta.url)),
-    '@nuxt/ui',
-    '@vueuse/nuxt',
-    'nuxt-use-query',
-  ],
-
-  // Enforce shared/contracts + app/queries pattern at build time so host apps
-  // can't drift back to hardcoded `/api/*` literals in components / composables.
-  // Hosts can opt out per-site by overriding `nuxtUseQuery.contracts.enabled`.
-  nuxtUseQuery: {
-    contracts: {
-      enabled: true,
-      // `@gscdump/contracts` is the shared package alias for hosted-API wire
-      // shapes — query files must import from there (or a host
-      // `shared/contracts/*`).
-      apiPrefixes: ['/api/__gsc', '/api/sync-progress'],
-      queryDirs: ['app/queries', 'layers/*/app/queries'],
-      contractDirs: ['shared/contracts', 'layers/*/shared/contracts', '@gscdump/contracts'],
-      serverApiDirs: ['server/api', 'layers/*/server/api'],
-      requireServerContracts: false,
-      // The config file declares these prefixes so the scanner must skip it.
-      // (overrides the default ignore set — keep the defaults alongside it.)
-      ignore: ['.git', '.nuxt', '.output', 'coverage', 'dist', 'node_modules', 'nuxt.config.ts'],
-    },
-  },
-
-  css: [
-    fileURLToPath(new URL('./app/assets/css/main.css', import.meta.url)),
-  ],
-
-  // runtimeConfig defaults live in module.ts (single source of truth).
-
-  vite: {
-    optimizeDeps: {
-      // DuckDB-WASM workers use URL imports Vite's prebundler cannot resolve.
-      // Keep them outside optimizeDeps so they stream as-is.
-      exclude: ['@duckdb/duckdb-wasm'],
-    },
-  },
-})

package/types.ts

@@ -1,115 +0,0 @@
-// Public API surface of @gscdump/nuxt.
-// Anything not exported here is considered internal and may change without a major bump.
-//
-// This package is a frontend-only Nuxt layer. Server-side primitives (auth
-// providers, query sources, GSC API helpers) live in their respective sibling
-// packages: `@gscdump/analysis` (sources), `gscdump` (GSC API client), and
-// host-specific Nitro server code in the consuming app.
-
-import type { AnalyticsClient } from '@gscdump/sdk'
-import type { $Fetch } from 'ofetch'
-import type { GscAnalyticsContext } from './app/composables/useGscAnalytics'
-import type { GscAnalyzerDefinition } from './app/composables/useGscAnalyzerDefs'
-import type { GscQueryDispatcher } from './app/composables/useGscQueryDispatcher'
-
-export interface GscAnalyticsRuntimeConfig {
-  /**
-   * Base URL the client uses to reach the analytics API (`/api/__gsc/*`).
-   * Empty string = same-origin. Hosts running the layer as a portable client
-   * against a remote origin (e.g. an embedded dashboard pointing at
-   * https://gscdump.com) set this via `GSCDUMP_ANALYTICS_API_BASE`.
-   */
-  apiBase: string
-  /** Base URL for DuckDB-WASM worker + bundle assets. Empty = layer default. */
-  duckdbBundleBase: string
-  /** IANA tz name; empty = browser default. */
-  timezone: string
-  /** When true, layer auto-toasts classified fetch errors via Nuxt UI. */
-  toastErrors: boolean
-  /** Default engine when caller doesn't pass `opts.engine`. */
-  defaultEngine: 'auto' | 'browser' | 'server'
-}
-
-declare module '@nuxt/schema' {
-  interface PublicRuntimeConfig {
-    analytics: GscAnalyticsRuntimeConfig
-  }
-}
-
-declare module '#app' {
-  interface NuxtApp {
-    $gscAnalytics: GscAnalyticsContext
-    $gscQueryDispatcher: GscQueryDispatcher
-    $gscFetch: $Fetch
-    $gscAnalyticsClient: AnalyticsClient
-    $gscAnalyzers?: GscAnalyzerDefinition[]
-  }
-}
-
-export type { GscAnalyzerInstance, GscAnalyzerTimings } from './app/composables/useGscAnalyzer'
-export type {
-  GscAnalyzerBatchEntry,
-  GscAnalyzerBatchRunner,
-  GscAnalyzerBatchStatus,
-  UseGscAnalyzerBatchOptions,
-} from './app/composables/useGscAnalyzerBatch'
-export { defineGscAnalyzer } from './app/composables/useGscAnalyzerDefs'
-export type {
-  GscAnalyzerAccent,
-  GscAnalyzerCapabilities,
-  GscAnalyzerCapability,
-  GscAnalyzerDefinition,
-  GscAnalyzerDefinitionWithCapability,
-  GscAnalyzerInsightCard,
-  GscAnalyzerKind,
-  GscAnalyzerPanelResult,
-  GscAnalyzerPanelSpec,
-  GscAnalyzerStatTile,
-} from './app/composables/useGscAnalyzerDefs'
-export { gscPanelRunnerKey, useGscPanelRunner } from './app/composables/useGscPanelContext'
-
-export type { GscPanelRunnerContext } from './app/composables/useGscPanelContext'
-
-export type {
-  GscBackfillRunner,
-  GscQueryDecision,
-  GscQueryDecisionReason,
-  GscQueryEngine,
-  GscQueryMeta,
-  GscQueryStatus,
-  UseGscQueryOptions,
-  UseGscQueryReturn,
-} from './app/composables/useGscQuery'
-
-export type {
-  GscFactTable,
-  GscTableStage,
-  GscTableStatus,
-  UseGscSiteAnalyzerReturn,
-} from './app/composables/useGscSiteAnalyzer'
-
-export type {
-  AnalysisSourcesResponse,
-  CountriesResponse,
-  CountryRow,
-  GscApiRange,
-  GscRowQueryMeta,
-  GscRowQueryResponse,
-  IndexingDiagnostics,
-  IndexingIssue,
-  IndexingIssueSeverity,
-  IndexingUrlRow,
-  IndexingUrlsResponse,
-  IndexingUrlStatus,
-  InspectionHistoryRecord,
-  InspectionHistoryResponse,
-  SearchAppearanceResponse,
-  SearchAppearanceRow,
-  SiteListItem,
-  SitemapAddedRow,
-  SitemapChangesResponse,
-  SitemapHistoryRecord,
-  SitemapHistoryResponse,
-  SitemapRemovedRow,
-  SourceInfoResponse,
-} from '@gscdump/contracts'