@consilioweb/payload-seo-analyzer 1.7.1

package/dist/client.d.cts

@@ -0,0 +1,133 @@
+import React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare const SeoAnalyzer: React.FC;
+
+declare function SeoView(): react_jsx_runtime.JSX.Element;
+
+declare function SeoNavLink(): react_jsx_runtime.JSX.Element;
+
+interface AuditItem {
+    id: number | string;
+    collection: string;
+    title: string;
+    slug: string;
+    updatedAt: string;
+    contentLastReviewed: string;
+    daysSinceUpdate: number | null;
+}
+declare function ContentDecaySection({ items }: {
+    items: AuditItem[];
+}): react_jsx_runtime.JSX.Element;
+
+interface ScoreHistoryChartProps {
+    documentId: string;
+    collection: string;
+}
+declare const ScoreHistoryChart: React.FC<ScoreHistoryChartProps>;
+
+declare function SitemapAuditView(): react_jsx_runtime.JSX.Element | null;
+
+declare function SeoConfigView(): react_jsx_runtime.JSX.Element;
+
+interface SeoSocialPreviewProps {
+    metaTitle?: string;
+    metaDescription?: string;
+    imageUrl?: string;
+    hostname?: string;
+}
+declare function SeoSocialPreview({ metaTitle, metaDescription, imageUrl, hostname, }: SeoSocialPreviewProps): react_jsx_runtime.JSX.Element;
+
+declare function RedirectManagerView(): react_jsx_runtime.JSX.Element;
+
+declare function CannibalizationView(): react_jsx_runtime.JSX.Element;
+
+declare function SchemaBuilderView(): react_jsx_runtime.JSX.Element;
+
+declare function PerformanceView(): react_jsx_runtime.JSX.Element;
+
+declare function KeywordResearchView(): react_jsx_runtime.JSX.Element;
+
+declare function LinkGraphView(): react_jsx_runtime.JSX.Element;
+
+/**
+ * MetaTitleField — Custom Payload CMS field component for meta title.
+ *
+ * Adds a character counter (30-60 optimal range) with color indicator,
+ * a progress bar, and an optional "Generate" button that calls the
+ * plugin's generate endpoint to auto-fill the title via user-provided
+ * generate functions.
+ *
+ * This component is registered as a custom Field component on the
+ * `meta.title` field when the SEO Analyzer plugin creates meta fields.
+ */
+interface MetaTitleFieldProps {
+    path: string;
+    hasGenerateFn?: boolean;
+    basePath?: string;
+}
+declare function MetaTitleField({ path, hasGenerateFn, basePath, }: MetaTitleFieldProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * MetaDescriptionField — Custom Payload CMS field component for meta description.
+ *
+ * Adds a character counter (120-160 optimal range) with color indicator,
+ * a progress bar, and an optional "Generate" button that calls the
+ * plugin's generate endpoint to auto-fill the description via user-provided
+ * generate functions.
+ *
+ * This component is registered as a custom Field component on the
+ * `meta.description` field when the SEO Analyzer plugin creates meta fields.
+ */
+interface MetaDescriptionFieldProps {
+    path: string;
+    hasGenerateFn?: boolean;
+    basePath?: string;
+}
+declare function MetaDescriptionField({ path, hasGenerateFn, basePath, }: MetaDescriptionFieldProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * MetaImageField — Custom Payload CMS field component for meta image.
+ *
+ * Displays a status indicator for the meta image and an optional
+ * "Generate" button that calls the plugin's generate endpoint to
+ * auto-fill the image reference via user-provided generate functions.
+ *
+ * This component does NOT render the actual upload field — Payload
+ * handles that natively. It adds the generate button UI alongside
+ * the native upload field.
+ */
+interface MetaImageFieldProps {
+    path: string;
+    hasGenerateFn?: boolean;
+    basePath?: string;
+}
+declare function MetaImageField({ path, hasGenerateFn, basePath, }: MetaImageFieldProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * OverviewField — UI-only Payload CMS field that shows meta completeness.
+ *
+ * Displays three indicators (Title, Description, Image) with check/cross
+ * status and a completeness progress bar (0/3 to 3/3). Uses Payload's
+ * `useFormFields` hook to reactively read meta field values from the
+ * current document form state.
+ *
+ * Intended for use in the editor sidebar as a quick glance overview.
+ */
+interface OverviewFieldProps {
+    titlePath?: string;
+    descriptionPath?: string;
+    imagePath?: string;
+}
+declare function OverviewField({ titlePath, descriptionPath, imagePath, }: OverviewFieldProps): react_jsx_runtime.JSX.Element;
+
+interface SerpPreviewProps {
+    metaTitle?: string;
+    metaDescription?: string;
+    slug?: string;
+    hostname?: string;
+    favicon?: string;
+}
+declare function SerpPreview({ metaTitle, metaDescription, slug, hostname, favicon, }: SerpPreviewProps): react_jsx_runtime.JSX.Element;
+
+export { CannibalizationView, ContentDecaySection, KeywordResearchView, LinkGraphView, MetaDescriptionField, MetaImageField, MetaTitleField, OverviewField, PerformanceView, RedirectManagerView, SchemaBuilderView, ScoreHistoryChart, SeoAnalyzer as SeoAnalyzerField, SeoConfigView, SeoNavLink, SeoSocialPreview, SeoView, SerpPreview, SerpPreview as SerpPreviewField, SitemapAuditView };

package/dist/client.d.ts

@@ -0,0 +1,133 @@
+import React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare const SeoAnalyzer: React.FC;
+
+declare function SeoView(): react_jsx_runtime.JSX.Element;
+
+declare function SeoNavLink(): react_jsx_runtime.JSX.Element;
+
+interface AuditItem {
+    id: number | string;
+    collection: string;
+    title: string;
+    slug: string;
+    updatedAt: string;
+    contentLastReviewed: string;
+    daysSinceUpdate: number | null;
+}
+declare function ContentDecaySection({ items }: {
+    items: AuditItem[];
+}): react_jsx_runtime.JSX.Element;
+
+interface ScoreHistoryChartProps {
+    documentId: string;
+    collection: string;
+}
+declare const ScoreHistoryChart: React.FC<ScoreHistoryChartProps>;
+
+declare function SitemapAuditView(): react_jsx_runtime.JSX.Element | null;
+
+declare function SeoConfigView(): react_jsx_runtime.JSX.Element;
+
+interface SeoSocialPreviewProps {
+    metaTitle?: string;
+    metaDescription?: string;
+    imageUrl?: string;
+    hostname?: string;
+}
+declare function SeoSocialPreview({ metaTitle, metaDescription, imageUrl, hostname, }: SeoSocialPreviewProps): react_jsx_runtime.JSX.Element;
+
+declare function RedirectManagerView(): react_jsx_runtime.JSX.Element;
+
+declare function CannibalizationView(): react_jsx_runtime.JSX.Element;
+
+declare function SchemaBuilderView(): react_jsx_runtime.JSX.Element;
+
+declare function PerformanceView(): react_jsx_runtime.JSX.Element;
+
+declare function KeywordResearchView(): react_jsx_runtime.JSX.Element;
+
+declare function LinkGraphView(): react_jsx_runtime.JSX.Element;
+
+/**
+ * MetaTitleField — Custom Payload CMS field component for meta title.
+ *
+ * Adds a character counter (30-60 optimal range) with color indicator,
+ * a progress bar, and an optional "Generate" button that calls the
+ * plugin's generate endpoint to auto-fill the title via user-provided
+ * generate functions.
+ *
+ * This component is registered as a custom Field component on the
+ * `meta.title` field when the SEO Analyzer plugin creates meta fields.
+ */
+interface MetaTitleFieldProps {
+    path: string;
+    hasGenerateFn?: boolean;
+    basePath?: string;
+}
+declare function MetaTitleField({ path, hasGenerateFn, basePath, }: MetaTitleFieldProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * MetaDescriptionField — Custom Payload CMS field component for meta description.
+ *
+ * Adds a character counter (120-160 optimal range) with color indicator,
+ * a progress bar, and an optional "Generate" button that calls the
+ * plugin's generate endpoint to auto-fill the description via user-provided
+ * generate functions.
+ *
+ * This component is registered as a custom Field component on the
+ * `meta.description` field when the SEO Analyzer plugin creates meta fields.
+ */
+interface MetaDescriptionFieldProps {
+    path: string;
+    hasGenerateFn?: boolean;
+    basePath?: string;
+}
+declare function MetaDescriptionField({ path, hasGenerateFn, basePath, }: MetaDescriptionFieldProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * MetaImageField — Custom Payload CMS field component for meta image.
+ *
+ * Displays a status indicator for the meta image and an optional
+ * "Generate" button that calls the plugin's generate endpoint to
+ * auto-fill the image reference via user-provided generate functions.
+ *
+ * This component does NOT render the actual upload field — Payload
+ * handles that natively. It adds the generate button UI alongside
+ * the native upload field.
+ */
+interface MetaImageFieldProps {
+    path: string;
+    hasGenerateFn?: boolean;
+    basePath?: string;
+}
+declare function MetaImageField({ path, hasGenerateFn, basePath, }: MetaImageFieldProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * OverviewField — UI-only Payload CMS field that shows meta completeness.
+ *
+ * Displays three indicators (Title, Description, Image) with check/cross
+ * status and a completeness progress bar (0/3 to 3/3). Uses Payload's
+ * `useFormFields` hook to reactively read meta field values from the
+ * current document form state.
+ *
+ * Intended for use in the editor sidebar as a quick glance overview.
+ */
+interface OverviewFieldProps {
+    titlePath?: string;
+    descriptionPath?: string;
+    imagePath?: string;
+}
+declare function OverviewField({ titlePath, descriptionPath, imagePath, }: OverviewFieldProps): react_jsx_runtime.JSX.Element;
+
+interface SerpPreviewProps {
+    metaTitle?: string;
+    metaDescription?: string;
+    slug?: string;
+    hostname?: string;
+    favicon?: string;
+}
+declare function SerpPreview({ metaTitle, metaDescription, slug, hostname, favicon, }: SerpPreviewProps): react_jsx_runtime.JSX.Element;
+
+export { CannibalizationView, ContentDecaySection, KeywordResearchView, LinkGraphView, MetaDescriptionField, MetaImageField, MetaTitleField, OverviewField, PerformanceView, RedirectManagerView, SchemaBuilderView, ScoreHistoryChart, SeoAnalyzer as SeoAnalyzerField, SeoConfigView, SeoNavLink, SeoSocialPreview, SeoView, SerpPreview, SerpPreview as SerpPreviewField, SitemapAuditView };