@nuxtseo/cli 0.1.4 → 0.2.0

package/dist/failures.d.ts

@@ -8,10 +8,11 @@ export declare const EXIT_CODE: {
     readonly retryable: 6;
     readonly infrastructure: 7;
     readonly notFound: 8;
+    readonly pagingCapReached: 9;
     readonly interrupted: 130;
 };
 export type ExitCode = typeof EXIT_CODE[keyof typeof EXIT_CODE];
-export type LocalFailureCode = 'authentication_required' | 'authorization_required' | 'confirmation_required' | 'conflict' | 'contract_violation' | 'infrastructure_failure' | 'interrupted' | 'invalid_cli_input' | 'not_found' | 'request_timeout' | 'retryable_failure' | 'site_ambiguous' | 'site_empty' | 'site_not_accessible' | 'state_error' | 'token_input_required' | 'transport_failure' | 'unexpected';
+export type LocalFailureCode = 'authentication_required' | 'authorization_required' | 'confirmation_required' | 'conflict' | 'contract_violation' | 'infrastructure_failure' | 'interrupted' | 'invalid_cli_input' | 'not_found' | 'paging_cap_reached' | 'request_timeout' | 'retryable_failure' | 'site_ambiguous' | 'site_empty' | 'site_not_accessible' | 'state_error' | 'token_input_required' | 'transport_failure' | 'unexpected';
 export type CliFailureCode = LocalFailureCode | Extract<SdkFailure, {
     _tag: 'ApiFailure';
 }>['code'];

package/dist/failures.js

@@ -15,6 +15,7 @@ export const EXIT_CODE = {
     retryable: 6,
     infrastructure: 7,
     notFound: 8,
+    pagingCapReached: 9,
     interrupted: 130,
 };
 export function ok(value) {
@@ -34,6 +35,8 @@ function defaultFailureCode(exitCode) {
             return 'retryable_failure';
         case EXIT_CODE.notFound:
             return 'not_found';
+        case EXIT_CODE.pagingCapReached:
+            return 'paging_cap_reached';
         case EXIT_CODE.interrupted:
             return 'interrupted';
         default:
@@ -83,10 +86,27 @@ function metadataLines(error) {
         details ? `Details: ${details}` : undefined,
     ].filter((line) => line !== undefined);
 }
+/**
+ * One client-side validation issue as a person can read it.
+ *
+ * These arrive as zod issue objects, so `String(issue)` printed
+ * `[object Object]` and the caller was told which operation and which location
+ * failed and nothing whatsoever about what was wrong with it.
+ */
+function requestIssueLine(issue) {
+    if (typeof issue === 'string')
+        return issue;
+    if (!issue || typeof issue !== 'object')
+        return String(issue);
+    const { path, message } = issue;
+    const field = Array.isArray(path) && path.length > 0 ? path.map(String).join('.') : null;
+    const text = typeof message === 'string' && message ? message : JSON.stringify(issue);
+    return field ? `${field}: ${text}` : text;
+}
 export function fromSdkFailure(error) {
     switch (error._tag) {
         case 'RequestFailure':
-            return fail(EXIT_CODE.invalidInput, `${error.operationId}: invalid ${error.location}. ${error.issues.map(String).join('; ')}`);
+            return fail(EXIT_CODE.invalidInput, `${error.operationId}: invalid ${error.location}. ${error.issues.map(requestIssueLine).join('; ')}`);
         case 'ApiFailure':
             return {
                 _tag: 'Err',

package/dist/parse.d.ts

@@ -15,12 +15,21 @@ export declare const DEFAULT_TIMEOUT_MS = 30000;
 export declare function extractGlobalOptions(rawArgs: readonly string[]): CliResult<ParsedGlobalOptions>;
 export declare function parseHttpUrl(input: string, label: string): CliResult<string>;
 export declare function parseAbsolutePageUrl(input: string): CliResult<string>;
+/**
+ * Search Console reads accept a site-relative path as well as an absolute URL.
+ * A leading `/` is passed through; anything else must be a full page URL.
+ */
+export declare function parsePageUrlOrPath(input: string): CliResult<string>;
 export declare function parseInteger(input: string | undefined, options: {
     name: string;
     minimum: number;
     maximum?: number;
     defaultValue: number;
 }): CliResult<number>;
+/**
+ * A ratio between 0 and 1, for example a click-through rate ceiling.
+ */
+export declare function parseRatio(input: string, name: string): CliResult<number>;
 export declare function parseChoice<const TChoice extends string>(input: string | undefined, options: {
     name: string;
     choices: readonly TChoice[];

package/dist/parse.js

@@ -112,6 +112,16 @@ export function parseAbsolutePageUrl(input) {
         url.hash = '';
     return ok(url.href);
 }
+/**
+ * Search Console reads accept a site-relative path as well as an absolute URL.
+ * A leading `/` is passed through; anything else must be a full page URL.
+ */
+export function parsePageUrlOrPath(input) {
+    const trimmed = input.trim();
+    if (trimmed.startsWith('/'))
+        return ok(trimmed);
+    return parseAbsolutePageUrl(trimmed);
+}
 export function parseInteger(input, options) {
     if (input === undefined)
         return ok(options.defaultValue);
@@ -124,6 +134,17 @@ export function parseInteger(input, options) {
     }
     return ok(parsed);
 }
+/**
+ * A ratio between 0 and 1, for example a click-through rate ceiling.
+ */
+export function parseRatio(input, name) {
+    if (!/^\d+(?:\.\d+)?$/.test(input))
+        return fail(EXIT_CODE.invalidInput, `${name} must be a number.`);
+    const parsed = Number(input);
+    if (!Number.isFinite(parsed) || parsed < 0 || parsed > 1)
+        return fail(EXIT_CODE.invalidInput, `${name} must be between 0 and 1.`);
+    return ok(parsed);
+}
 export function parseChoice(input, options) {
     if (input === undefined && options.defaultValue !== undefined)
         return ok(options.defaultValue);

package/dist/render.d.ts

@@ -1,13 +1,16 @@
-import type { AccountUsageResponse, SitesListResponse } from '@nuxtseo/protocol/v1';
-import type { ActionList, ActionResolve, ActionShow } from '@nuxtseo/protocol/v1/actions';
-import type { AuditContentDecay, AuditDuplicateClusters, AuditLinkOpportunities } from '@nuxtseo/protocol/v1/audit';
-import type { Mentions, RecoverableBacklinks } from '@nuxtseo/protocol/v1/backlinks';
+import type { AccountUsageResponse, SitesListResponse, SiteStatus } from '@nuxtseo/protocol/v1';
+import type { AccountTokenData } from '@nuxtseo/protocol/v1/account';
+import type { ActionDismiss, ActionList, ActionResolve, ActionShow } from '@nuxtseo/protocol/v1/actions';
+import type { AnalyticsQueryData, AnalyticsView } from '@nuxtseo/protocol/v1/analytics';
+import type { AuditChanges, AuditContentDecay, AuditDuplicateClusters, AuditLinkOpportunities, AuditLinkStructure } from '@nuxtseo/protocol/v1/audit';
+import type { BacklinkAnchors, BacklinksHistory, BacklinksSummary, Mentions, RecoverableBacklinks, ReferringDomains } from '@nuxtseo/protocol/v1/backlinks';
 import type { ContentBrief, ContentBriefCreateData, ContentBriefListData } from '@nuxtseo/protocol/v1/content';
-import type { IndexingDiagnosticsData, SearchAnalyticsData, SearchStatusData } from '@nuxtseo/protocol/v1/gsc';
-import type { PageInspect, PageScan } from '@nuxtseo/protocol/v1/pages';
-import type { SitePerformanceOverview } from '@nuxtseo/protocol/v1/performance';
-import type { KeywordResearchData, RankingsResearchData, SerpResearchData, StoredResearchOverview } from '@nuxtseo/protocol/v1/research';
-import type { TimelineEntries } from '@nuxtseo/protocol/v1/timeline';
+import type { IndexCohorts, IndexingDiagnosticsData, IndexingHistoryData, SearchAnalyticsData, SearchStatusData, UrlInspectionData } from '@nuxtseo/protocol/v1/gsc';
+import type { PageInspect, PageIssues, PageScan } from '@nuxtseo/protocol/v1/pages';
+import type { FieldVitalFindings, FieldVitals, MonitoredPages, PerformanceScanDetail, PerformanceScans, SitePerformanceOverview } from '@nuxtseo/protocol/v1/performance';
+import type { DomainAvailability, DomainTraffic, KeywordResearchData, RankingsResearchData, SerpResearchData, StoredResearchOverview } from '@nuxtseo/protocol/v1/research';
+import type { SiteSitemapActionResponse, SiteSitemapsResponse, SiteSitemapUrlsResponse } from '@nuxtseo/protocol/v1/sitemaps';
+import type { Annotation, AnnotationDeleted, Annotations, TimelineEntries } from '@nuxtseo/protocol/v1/timeline';
 export declare function renderSites(response: SitesListResponse, selectedSiteId?: string): string;
 export declare function renderUsage(response: AccountUsageResponse): string;
 export declare function renderActions(data: ActionList): string;
@@ -18,6 +21,19 @@ export declare function renderPageScan(data: PageScan): string;
 export declare function renderPerformance(data: SitePerformanceOverview): string;
 export declare function renderSearchStatus(data: SearchStatusData): string;
 export declare function renderSearchAnalytics(data: SearchAnalyticsData): string;
+export declare function renderIndexingHistory(data: IndexingHistoryData): string;
+export declare function renderUrlInspection(data: UrlInspectionData): string;
+export declare function renderAuditChanges(data: AuditChanges): string;
+export declare function renderLinkStructure(data: AuditLinkStructure): string;
+export declare function renderSitemaps(data: SiteSitemapsResponse['data']): string;
+export declare function renderSitemapUrls(data: SiteSitemapUrlsResponse['data']): string;
+export declare function renderSitemapAction(data: SiteSitemapActionResponse['data']): string;
+/**
+ * Web Analytics rows differ per view and share no discriminant field, so the
+ * requested view selects the projection instead of the payload.
+ */
+export declare function renderAnalytics(view: AnalyticsView, data: AnalyticsQueryData): string;
+export declare function renderAccountToken(data: AccountTokenData): string;
 export declare function renderIndexingDiagnostics(data: IndexingDiagnosticsData): string;
 export declare function renderResearchOverview(data: StoredResearchOverview): string;
 export declare function renderKeywordResearch(data: KeywordResearchData): string;
@@ -32,3 +48,21 @@ export declare function renderLinkOpportunities(data: AuditLinkOpportunities): s
 export declare function renderTimeline(data: TimelineEntries): string;
 export declare function renderRecoverableBacklinks(data: RecoverableBacklinks): string;
 export declare function renderMentions(data: Mentions): string;
+export declare function renderFieldVitals(data: FieldVitals): string;
+export declare function renderFieldVitalFindings(data: FieldVitalFindings): string;
+export declare function renderBacklinksSummary(data: BacklinksSummary): string;
+export declare function renderReferringDomains(data: ReferringDomains): string;
+export declare function renderBacklinkAnchors(data: BacklinkAnchors): string;
+export declare function renderBacklinksHistory(data: BacklinksHistory): string;
+export declare function renderSiteStatus(data: SiteStatus): string;
+export declare function renderActionDismissal(data: ActionDismiss): string;
+export declare function renderPageIssues(data: PageIssues): string;
+export declare function renderScans(data: PerformanceScans): string;
+export declare function renderMonitoredPages(data: MonitoredPages): string;
+export declare function renderScanDetail(data: PerformanceScanDetail): string;
+export declare function renderAnnotations(data: Annotations): string;
+export declare function renderAnnotation(data: Annotation): string;
+export declare function renderAnnotationDeleted(data: AnnotationDeleted): string;
+export declare function renderIndexCohorts(data: IndexCohorts): string;
+export declare function renderDomainTraffic(data: DomainTraffic): string;
+export declare function renderDomainAvailability(data: DomainAvailability): string;