@pagebridge/sanity 0.0.2 → 0.1.1

package/src/components/SearchPerformancePane.tsx

@@ -1,237 +0,0 @@
-import { useEffect, useState } from "react";
-import { useClient } from "sanity";
-import { Card, Stack, Text, Badge, Flex, Box, Spinner, Tooltip } from "@sanity/ui";
-import { ArrowUpIcon, ArrowDownIcon, ArrowRightIcon, CheckmarkCircleIcon, CloseCircleIcon, WarningOutlineIcon } from "@sanity/icons";
-
-interface IndexStatus {
-  verdict: "indexed" | "not_indexed" | "excluded";
-  coverageState: string | null;
-  lastCrawlTime: string | null;
-}
-
-interface PerformanceData {
-  clicks: number;
-  impressions: number;
-  ctr: number;
-  position: number;
-  positionDelta: number;
-  topQueries: { query: string; clicks: number; position: number }[];
-  lastUpdated: string;
-  indexStatus?: IndexStatus;
-}
-
-interface SearchPerformancePaneProps {
-  documentId: string;
-}
-
-export function SearchPerformancePane({
-  documentId,
-}: SearchPerformancePaneProps) {
-  const client = useClient({ apiVersion: "2024-01-01" });
-  const [data, setData] = useState<PerformanceData | undefined>(undefined);
-  const [loading, setLoading] = useState(true);
-
-  useEffect(() => {
-    async function fetchData() {
-      const snapshot = await client.fetch(
-        `*[_type == "gscSnapshot" && linkedDocument._ref == $id && period == "last28"][0]{
-          clicks,
-          impressions,
-          ctr,
-          position,
-          topQueries,
-          fetchedAt,
-          indexStatus
-        }`,
-        { id: documentId },
-      );
-
-      const previousSnapshot = await client.fetch(
-        `*[_type == "gscSnapshot" && linkedDocument._ref == $id && period == "last28"] | order(fetchedAt desc)[1]{
-          position
-        }`,
-        { id: documentId },
-      );
-
-      if (snapshot) {
-        setData({
-          ...snapshot,
-          positionDelta: previousSnapshot
-            ? snapshot.position - previousSnapshot.position
-            : 0,
-          lastUpdated: snapshot.fetchedAt,
-          indexStatus: snapshot.indexStatus,
-        });
-      }
-      setLoading(false);
-    }
-
-    fetchData();
-  }, [documentId, client]);
-
-  if (loading) {
-    return (
-      <Card padding={4}>
-        <Flex justify="center">
-          <Spinner />
-        </Flex>
-      </Card>
-    );
-  }
-
-  if (!data) {
-    return (
-      <Card padding={4} tone="caution">
-        <Text>No search data available for this document.</Text>
-      </Card>
-    );
-  }
-
-  return (
-    <Card padding={4}>
-      <Stack space={4}>
-        <Flex justify="space-between" align="center">
-          <Text weight="semibold" size={2}>
-            Search Performance (Last 28 Days)
-          </Text>
-          {data.indexStatus && <IndexStatusBadge status={data.indexStatus} />}
-        </Flex>
-
-        <Flex gap={3} wrap="wrap">
-          <MetricCard label="Clicks" value={data.clicks.toLocaleString()} />
-          <MetricCard
-            label="Impressions"
-            value={data.impressions.toLocaleString()}
-          />
-          <MetricCard label="CTR" value={`${(data.ctr * 100).toFixed(1)}%`} />
-          <MetricCard
-            label="Avg. Position"
-            value={data.position.toFixed(1)}
-            trend={data.positionDelta}
-            invertTrend
-          />
-        </Flex>
-
-        {data.topQueries?.length > 0 && (
-          <Box>
-            <Text size={1} weight="semibold" muted style={{ marginBottom: 8 }}>
-              Top Queries
-            </Text>
-            <Stack space={2}>
-              {data.topQueries.slice(0, 5).map((q, i) => (
-                <Flex key={i} justify="space-between" align="center">
-                  <Text size={1} style={{ flex: 1 }}>
-                    {q.query}
-                  </Text>
-                  <Text size={1} muted>
-                    {q.clicks} clicks · pos {q.position.toFixed(1)}
-                  </Text>
-                </Flex>
-              ))}
-            </Stack>
-          </Box>
-        )}
-
-        <Text size={0} muted>
-          Last updated: {new Date(data.lastUpdated).toLocaleDateString()}
-        </Text>
-      </Stack>
-    </Card>
-  );
-}
-
-interface MetricCardProps {
-  label: string;
-  value: string;
-  trend?: number;
-  invertTrend?: boolean;
-}
-
-function MetricCard({ label, value, trend, invertTrend }: MetricCardProps) {
-  const TrendIcon =
-    trend === undefined || trend === 0
-      ? ArrowRightIcon
-      : (invertTrend ? trend < 0 : trend > 0)
-        ? ArrowUpIcon
-        : ArrowDownIcon;
-
-  const trendTone =
-    trend === undefined || trend === 0
-      ? "default"
-      : (invertTrend ? trend < 0 : trend > 0)
-        ? "positive"
-        : "critical";
-
-  return (
-    <Card padding={3} radius={2} shadow={1} style={{ minWidth: 100 }}>
-      <Stack space={2}>
-        <Text size={0} muted>
-          {label}
-        </Text>
-        <Flex align="center" gap={2}>
-          <Text size={3} weight="semibold">
-            {value}
-          </Text>
-          {trend !== undefined && trend !== 0 && (
-            <Badge tone={trendTone} fontSize={0}>
-              <TrendIcon />
-              {Math.abs(trend).toFixed(1)}
-            </Badge>
-          )}
-        </Flex>
-      </Stack>
-    </Card>
-  );
-}
-
-interface IndexStatusBadgeProps {
-  status: IndexStatus;
-}
-
-function IndexStatusBadge({ status }: IndexStatusBadgeProps) {
-  const config = {
-    indexed: {
-      tone: "positive" as const,
-      icon: CheckmarkCircleIcon,
-      label: "Indexed",
-    },
-    not_indexed: {
-      tone: "critical" as const,
-      icon: CloseCircleIcon,
-      label: "Not Indexed",
-    },
-    excluded: {
-      tone: "caution" as const,
-      icon: WarningOutlineIcon,
-      label: "Excluded",
-    },
-  };
-
-  const { tone, icon: Icon, label } = config[status.verdict];
-  const tooltipContent = status.coverageState || label;
-
-  return (
-    <Tooltip
-      content={
-        <Box padding={2}>
-          <Stack space={2}>
-            <Text size={1}>{tooltipContent}</Text>
-            {status.lastCrawlTime && (
-              <Text size={0} muted>
-                Last crawled: {new Date(status.lastCrawlTime).toLocaleDateString()}
-              </Text>
-            )}
-          </Stack>
-        </Box>
-      }
-      placement="top"
-    >
-      <Badge tone={tone} fontSize={1} style={{ cursor: "help" }}>
-        <Flex align="center" gap={1}>
-          <Icon />
-          {label}
-        </Flex>
-      </Badge>
-    </Tooltip>
-  );
-}

package/src/index.ts

@@ -1,18 +0,0 @@
-// Note: React components are not exported here to avoid loading them during schema extraction
-// They are lazy-loaded within the plugin when needed
-export {
-  gscPlugin,
-  createGscStructureResolver,
-  createPageBridgeStructure,
-  PAGEBRIDGE_TYPES,
-  type GscPluginConfig,
-} from "./plugin";
-export {
-  gscSite,
-  gscSnapshot,
-  gscRefreshTask,
-  createGscSnapshot,
-  createGscRefreshTask,
-  type GscSnapshotOptions,
-  type GscRefreshTaskOptions,
-} from "./schemas";

package/src/plugin.ts

@@ -1,120 +0,0 @@
-import { definePlugin } from "sanity";
-import type {
-  DefaultDocumentNodeResolver,
-  StructureBuilder,
-} from "sanity/structure";
-import { ChartUpwardIcon, EarthGlobeIcon } from "@sanity/icons";
-import { gscSite } from "./schemas/gscSite";
-import { createGscSnapshot } from "./schemas/gscSnapshot";
-import { createGscRefreshTask } from "./schemas/gscRefreshTask";
-import type { ComponentType } from "react";
-
-export interface GscPluginConfig {
-  /**
-   * Array of Sanity document type names that represent your content.
-   * These will be available for linking in gscSnapshot and gscRefreshTask schemas.
-   * Example: ['post', 'article', 'page']
-   */
-  contentTypes?: string[];
-}
-
-/** Document type names registered by the PageBridge plugin */
-export const PAGEBRIDGE_TYPES = [
-  "gscSite",
-  "gscSnapshot",
-  "gscRefreshTask",
-] as const;
-
-/**
- * Creates a "PageBridge" folder list item for the desk structure.
- * Use with structureTool's `structure` option to group PageBridge
- * documents into a single folder and filter them from the default list.
- *
- * @example
- * ```ts
- * structureTool({
- *   structure: (S, context) =>
- *     S.list()
- *       .title("Content")
- *       .items([
- *         createPageBridgeStructure(S),
- *         S.divider(),
- *         ...S.documentTypeListItems().filter(
- *           (item) => !PAGEBRIDGE_TYPES.includes(item.getId() as any),
- *         ),
- *       ]),
- * })
- * ```
- */
-export const createPageBridgeStructure = (S: StructureBuilder) =>
-  S.listItem()
-    .title("PageBridge")
-    .icon(EarthGlobeIcon)
-    .child(
-      S.list()
-        .title("PageBridge")
-        .items([
-          S.listItem()
-            .title("GSC Sites")
-            .schemaType("gscSite")
-            .child(S.documentTypeList("gscSite").title("GSC Sites")),
-          S.listItem()
-            .title("Snapshots")
-            .schemaType("gscSnapshot")
-            .child(S.documentTypeList("gscSnapshot").title("Snapshots")),
-          S.listItem()
-            .title("Refresh Tasks")
-            .schemaType("gscRefreshTask")
-            .child(S.documentTypeList("gscRefreshTask").title("Refresh Tasks")),
-        ]),
-    );
-
-/**
- * Creates a structure resolver that adds the Performance view to content types
- * Use this with structureTool's defaultDocumentNode option
- */
-export const createGscStructureResolver = (
-  contentTypes: string[] = [],
-): DefaultDocumentNodeResolver => {
-  return (S, { schemaType }) => {
-    if (contentTypes.includes(schemaType)) {
-      // Lazy import to avoid loading React component during schema extraction
-      const SearchPerformancePane: ComponentType<any> =
-        require("./components/SearchPerformancePane").SearchPerformancePane;
-
-      return S.document().views([
-        S.view.form(),
-        S.view
-          .component(SearchPerformancePane)
-          .title("Performance")
-          .icon(ChartUpwardIcon),
-      ]);
-    }
-    return S.document().views([S.view.form()]);
-  };
-};
-
-export const gscPlugin = definePlugin<GscPluginConfig | void>((config) => {
-  const contentTypes = config?.contentTypes ?? [];
-
-  const gscSnapshot = createGscSnapshot({ contentTypes });
-  const gscRefreshTask = createGscRefreshTask({ contentTypes });
-
-  // Lazy import to avoid loading React component during schema extraction
-  const RefreshQueueTool: ComponentType<any> =
-    require("./components/RefreshQueueTool").RefreshQueueTool;
-
-  return {
-    name: "pagebridge-sanity",
-    schema: {
-      types: [gscSite, gscSnapshot, gscRefreshTask],
-    },
-    tools: [
-      {
-        name: "gsc-refresh-queue",
-        title: "Refresh Queue",
-        component: RefreshQueueTool,
-      },
-    ],
-  };
-});

package/src/schemas/gscRefreshTask.ts

@@ -1,203 +0,0 @@
-import { defineType, defineField } from "sanity";
-
-export interface GscRefreshTaskOptions {
-  contentTypes?: string[];
-}
-
-export const createGscRefreshTask = (options: GscRefreshTaskOptions = {}) => {
-  const contentTypes = options.contentTypes ?? [];
-
-  return defineType({
-    name: "gscRefreshTask",
-    title: "Refresh Task",
-    type: "document",
-    fields: [
-      defineField({
-        name: "site",
-        type: "reference",
-        to: [{ type: "gscSite" }],
-        validation: (Rule) => Rule.required(),
-      }),
-      ...(contentTypes.length > 0
-        ? [
-            defineField({
-              name: "linkedDocument",
-              title: "Content to Refresh",
-              type: "reference",
-              to: contentTypes.map((type) => ({ type })),
-              validation: (Rule) => Rule.required(),
-            }),
-          ]
-        : []),
-      defineField({
-        name: "reason",
-        title: "Reason",
-        type: "string",
-        options: {
-          list: [
-            { title: "Position Decay", value: "position_decay" },
-            { title: "Low CTR", value: "low_ctr" },
-            { title: "Impressions Drop", value: "impressions_drop" },
-            { title: "Manual", value: "manual" },
-          ],
-        },
-      }),
-      defineField({
-        name: "severity",
-        title: "Severity",
-        type: "string",
-        options: {
-          list: [
-            { title: "Low", value: "low" },
-            { title: "Medium", value: "medium" },
-            { title: "High", value: "high" },
-          ],
-        },
-      }),
-      defineField({
-        name: "status",
-        title: "Status",
-        type: "string",
-        options: {
-          list: [
-            { title: "Open", value: "open" },
-            { title: "Snoozed", value: "snoozed" },
-            { title: "In Progress", value: "in_progress" },
-            { title: "Done", value: "done" },
-            { title: "Dismissed", value: "dismissed" },
-          ],
-        },
-        initialValue: "open",
-      }),
-      defineField({
-        name: "snoozedUntil",
-        title: "Snoozed Until",
-        type: "datetime",
-        hidden: ({ parent }) => parent?.status !== "snoozed",
-      }),
-      defineField({
-        name: "metrics",
-        title: "Metrics at Detection",
-        type: "object",
-        fields: [
-          defineField({
-            name: "positionBefore",
-            type: "number",
-            title: "Position (28 days ago)",
-          }),
-          defineField({
-            name: "positionNow",
-            type: "number",
-            title: "Position (current)",
-          }),
-          defineField({
-            name: "positionDelta",
-            type: "number",
-            title: "Position Change",
-          }),
-          defineField({
-            name: "ctrBefore",
-            type: "number",
-            title: "CTR (28 days ago)",
-          }),
-          defineField({
-            name: "ctrNow",
-            type: "number",
-            title: "CTR (current)",
-          }),
-          defineField({
-            name: "impressions",
-            type: "number",
-            title: "Impressions (last 28d)",
-          }),
-        ],
-      }),
-      defineField({
-        name: "queryContext",
-        title: "Top Queries",
-        type: "array",
-        description: "What people searched to find this page",
-        of: [
-          {
-            type: "object",
-            fields: [
-              defineField({
-                name: "query",
-                type: "string",
-                title: "Query",
-              }),
-              defineField({
-                name: "impressions",
-                type: "number",
-                title: "Impressions",
-              }),
-              defineField({
-                name: "clicks",
-                type: "number",
-                title: "Clicks",
-              }),
-              defineField({
-                name: "position",
-                type: "number",
-                title: "Avg Position",
-              }),
-            ],
-            preview: {
-              select: {
-                query: "query",
-                impressions: "impressions",
-                position: "position",
-              },
-              prepare({ query, impressions, position }) {
-                return {
-                  title: query,
-                  subtitle: `Pos ${position?.toFixed(1)} · ${impressions} impr`,
-                };
-              },
-            },
-          },
-        ],
-      }),
-      defineField({
-        name: "notes",
-        title: "Notes",
-        type: "text",
-        description: "Why was this snoozed/dismissed?",
-      }),
-      defineField({
-        name: "createdAt",
-        type: "datetime",
-      }),
-      defineField({
-        name: "resolvedAt",
-        type: "datetime",
-      }),
-    ],
-    orderings: [
-      {
-        title: "Severity",
-        name: "severityDesc",
-        by: [
-          { field: "severity", direction: "desc" },
-          { field: "createdAt", direction: "desc" },
-        ],
-      },
-    ],
-    preview: {
-      select: {
-        title: "linkedDocument.title",
-        reason: "reason",
-        severity: "severity",
-      },
-      prepare({ title, reason, severity }) {
-        return {
-          title: title || "Unknown document",
-          subtitle: `${severity} · ${reason.replace(/_/g, " ")}`,
-        };
-      },
-    },
-  });
-};
-
-// Default export for backward compatibility (without linkedDocument)
-export const gscRefreshTask = createGscRefreshTask();

package/src/schemas/gscSite.ts

@@ -1,71 +0,0 @@
-import { defineType, defineField } from "sanity";
-
-export const gscSite = defineType({
-  name: "gscSite",
-  title: "GSC Site",
-  type: "document",
-  fields: [
-    defineField({
-      name: "siteUrl",
-      title: "Site URL",
-      type: "string",
-      description: "Exactly as it appears in GSC (e.g., sc-domain:example.com)",
-      validation: (Rule) => Rule.required(),
-    }),
-    defineField({
-      name: "slug",
-      title: "Slug",
-      type: "slug",
-      options: { source: "siteUrl" },
-      description: "Used for filtering in multi-site setups",
-    }),
-    defineField({
-      name: "defaultLocale",
-      title: "Default Locale",
-      type: "string",
-      initialValue: "en",
-    }),
-    defineField({
-      name: "pathPrefix",
-      title: "Path Prefix",
-      type: "string",
-      description: 'If your blog lives at /blog, enter "/blog"',
-    }),
-    defineField({
-      name: "contentTypes",
-      title: "Content Types",
-      type: "array",
-      of: [{ type: "string" }],
-      initialValue: ["post", "page"],
-      description:
-        "Sanity document types to match URLs against (e.g., post, page, article)",
-    }),
-    defineField({
-      name: "slugField",
-      title: "Slug Field",
-      type: "string",
-      initialValue: "slug",
-      description: "The field name containing the URL slug (default: slug)",
-    }),
-    defineField({
-      name: "lastSyncedAt",
-      title: "Last Synced",
-      type: "datetime",
-      readOnly: true,
-    }),
-    defineField({
-      name: "lastDiagnosticsAt",
-      title: "Last Diagnostics Run",
-      type: "datetime",
-      readOnly: true,
-    }),
-    defineField({
-      name: "unmatchedCount",
-      title: "Unmatched URLs",
-      type: "number",
-      readOnly: true,
-      description:
-        "Number of GSC URLs that could not be matched to Sanity documents",
-    }),
-  ],
-});