gscdump 1.4.0 → 1.4.2

package/dist/core/types.d.mts

@@ -0,0 +1,201 @@
+/** Search Console property returned by the Sites resource. */
+interface ApiSite {
+  permissionLevel?: string | null;
+  siteUrl?: string | null;
+}
+/** Per-content-type counts returned with a sitemap. */
+interface ApiSitemapContent {
+  /** Deprecated by Google, retained because it can still appear on the wire. */
+  indexed?: string | null;
+  submitted?: string | null;
+  type?: string | null;
+}
+/** Sitemap returned by the Search Console Sitemaps resource. */
+interface ApiSitemap {
+  contents?: ApiSitemapContent[];
+  errors?: string | null;
+  isPending?: boolean | null;
+  isSitemapsIndex?: boolean | null;
+  lastDownloaded?: string | null;
+  lastSubmitted?: string | null;
+  path?: string | null;
+  type?: string | null;
+  warnings?: string | null;
+}
+/** A Search Analytics dimension filter. */
+interface DimensionFilter {
+  dimension?: string | null;
+  expression?: string | null;
+  operator?: string | null;
+}
+/** A group of Search Analytics dimension filters. */
+interface DimensionFilterGroup {
+  filters?: DimensionFilter[];
+  groupType?: string | null;
+}
+/** Raw Search Analytics request accepted by Google's REST endpoint. */
+interface SearchAnalyticsQuery {
+  aggregationType?: string | null;
+  dataState?: string | null;
+  dimensionFilterGroups?: DimensionFilterGroup[];
+  dimensions?: string[] | null;
+  endDate?: string | null;
+  rowLimit?: number | null;
+  searchType?: string | null;
+  startDate?: string | null;
+  startRow?: number | null;
+  type?: string | null;
+}
+/** Raw Search Analytics result row. */
+interface DataRow {
+  clicks?: number | null;
+  ctr?: number | null;
+  impressions?: number | null;
+  keys?: string[] | null;
+  position?: number | null;
+}
+/** Completeness metadata returned with recent Search Analytics data. */
+interface SearchAnalyticsMetadata {
+  firstIncompleteDate?: string | null;
+  firstIncompleteHour?: string | null;
+  /** Field name returned by the direct REST endpoint. */
+  first_incomplete_date?: string | null;
+  /** Field name returned by the direct REST endpoint. */
+  first_incomplete_hour?: string | null;
+}
+/** Raw Search Analytics response returned by Google's REST endpoint. */
+interface SearchAnalyticsResponse {
+  metadata?: SearchAnalyticsMetadata;
+  responseAggregationType?: string | null;
+  rows?: DataRow[];
+}
+interface AmpIssue {
+  issueMessage?: string | null;
+  severity?: string | null;
+}
+interface AmpInspectionResult {
+  ampIndexStatusVerdict?: string | null;
+  ampUrl?: string | null;
+  indexingState?: string | null;
+  issues?: AmpIssue[];
+  lastCrawlTime?: string | null;
+  pageFetchState?: string | null;
+  robotsTxtState?: string | null;
+  verdict?: string | null;
+}
+interface IndexStatusResult {
+  coverageState?: string | null;
+  crawledAs?: string | null;
+  googleCanonical?: string | null;
+  indexingState?: string | null;
+  lastCrawlTime?: string | null;
+  pageFetchState?: string | null;
+  referringUrls?: string[] | null;
+  robotsTxtState?: string | null;
+  sitemap?: string[] | null;
+  userCanonical?: string | null;
+  verdict?: string | null;
+}
+interface MobileUsabilityIssue {
+  issueType?: string | null;
+  message?: string | null;
+  severity?: string | null;
+}
+interface MobileUsabilityResult {
+  issues?: MobileUsabilityIssue[];
+  verdict?: string | null;
+}
+interface RichResultsIssue {
+  issueMessage?: string | null;
+  severity?: string | null;
+}
+interface RichResultsItem {
+  issues?: RichResultsIssue[];
+  name?: string | null;
+}
+interface RichResultsDetectedItem {
+  items?: RichResultsItem[];
+  richResultType?: string | null;
+}
+interface RichResultsResult {
+  detectedItems?: RichResultsDetectedItem[];
+  verdict?: string | null;
+}
+/** URL inspection payload returned by Search Console. */
+interface UrlInspectionResult {
+  ampResult?: AmpInspectionResult;
+  indexStatusResult?: IndexStatusResult;
+  inspectionResultLink?: string | null;
+  mobileUsabilityResult?: MobileUsabilityResult;
+  richResultsResult?: RichResultsResult;
+}
+interface InspectUrlIndexResponse {
+  inspectionResult?: UrlInspectionResult;
+}
+/** A single Indexing API notification. */
+interface UrlNotification {
+  notifyTime?: string | null;
+  type?: string | null;
+  url?: string | null;
+}
+/** Latest Indexing API notifications recorded for a URL. */
+interface UrlNotificationMetadata {
+  latestRemove?: UrlNotification;
+  latestUpdate?: UrlNotification;
+  url?: string | null;
+}
+interface PublishUrlNotificationResponse {
+  urlNotificationMetadata?: UrlNotificationMetadata;
+}
+type RequiredNonNullable<T> = Required<Exclude<T, null | undefined>>;
+interface Site extends Required<Omit<ApiSite, 'siteUrl'>> {
+  siteUrl: string;
+}
+interface Period {
+  start: Date | string;
+  end: Date | string;
+}
+interface ResolvedAnalyticsRange {
+  period: Period;
+  prevPeriod?: Period;
+}
+interface SiteAnalytics {
+  analytics: {
+    period: {
+      totalClicks: number;
+      totalImpressions: number;
+    };
+    prevPeriod: {
+      totalClicks: number;
+      totalImpressions: number;
+    };
+  };
+  sitemaps: ApiSitemap[];
+  indexedUrls: string[];
+  period: {
+    url: string;
+    clicks: number;
+    clicksPercent: number;
+    prevClicks: number;
+    impressions: number;
+    impressionsPercent: number;
+    prevImpressions: number;
+  }[];
+  keywords: {
+    keyword: string;
+    position: number;
+    prevPosition: number;
+    positionPercent: number;
+    ctr: number;
+    ctrPercent: number;
+    prevCtr: number;
+    clicks: number;
+  }[];
+  graph: {
+    keys?: undefined;
+    time: string;
+    clicks: number;
+    impressions: number;
+  }[];
+}
+export { AmpInspectionResult, AmpIssue, ApiSite, ApiSitemap, ApiSitemapContent, DataRow, DimensionFilter, DimensionFilterGroup, IndexStatusResult, InspectUrlIndexResponse, MobileUsabilityIssue, MobileUsabilityResult, Period, PublishUrlNotificationResponse, RequiredNonNullable, ResolvedAnalyticsRange, RichResultsDetectedItem, RichResultsIssue, RichResultsItem, RichResultsResult, SearchAnalyticsMetadata, SearchAnalyticsQuery, SearchAnalyticsResponse, Site, SiteAnalytics, UrlInspectionResult, UrlNotification, UrlNotificationMetadata };

package/dist/core/types.mjs

@@ -0,0 +1 @@
+export {};

package/dist/dates.d.mts

@@ -1,3 +1,3 @@
-import { DAYS_PER_RANGE, GSC_FINALIZED_LAG_DAYS, GSC_FRESHEST_LAG_DAYS, GSC_RETENTION_MONTHS, MS_PER_DAY, addDays, countDays, daysAgo, generateGscDateRange, getBackfillProgress, getDateRange, getFreshestGscDate, getLatestGscDate, getNextDate, getOldestGscDate, getPendingDates, getPstDate, groupIntoRanges, toIsoDate } from "./_chunks/gsc-dates.mjs";
-import { currentPstDate, daysAgoPst } from "./_chunks/dayjs.mjs";
+import { DAYS_PER_RANGE, GSC_FINALIZED_LAG_DAYS, GSC_FRESHEST_LAG_DAYS, GSC_RETENTION_MONTHS, MS_PER_DAY, addDays, countDays, daysAgo, generateGscDateRange, getBackfillProgress, getDateRange, getFreshestGscDate, getLatestGscDate, getNextDate, getOldestGscDate, getPendingDates, getPstDate, groupIntoRanges, toIsoDate } from "./core/gsc-dates.mjs";
+import { currentPstDate, daysAgoPst } from "./query/utils/dayjs.mjs";
 export { DAYS_PER_RANGE, GSC_FINALIZED_LAG_DAYS, GSC_FRESHEST_LAG_DAYS, GSC_RETENTION_MONTHS, MS_PER_DAY, addDays, countDays, currentPstDate, daysAgoPst, daysAgo as daysAgoUtc, generateGscDateRange, getBackfillProgress, getDateRange, getFreshestGscDate, getLatestGscDate, getNextDate, getOldestGscDate, getPendingDates, getPstDate, groupIntoRanges, toIsoDate };

package/dist/dates.mjs

@@ -1,3 +1,3 @@
-import { DAYS_PER_RANGE, GSC_FINALIZED_LAG_DAYS, GSC_FRESHEST_LAG_DAYS, GSC_RETENTION_MONTHS, MS_PER_DAY, addDays, countDays, daysAgo, generateGscDateRange, getBackfillProgress, getDateRange, getFreshestGscDate, getLatestGscDate, getNextDate, getOldestGscDate, getPendingDates, getPstDate, groupIntoRanges, toIsoDate } from "./_chunks/gsc-dates.mjs";
-import { currentPstDate, daysAgoPst } from "./_chunks/dayjs.mjs";
+import { DAYS_PER_RANGE, GSC_FINALIZED_LAG_DAYS, GSC_FRESHEST_LAG_DAYS, GSC_RETENTION_MONTHS, MS_PER_DAY, addDays, countDays, daysAgo, generateGscDateRange, getBackfillProgress, getDateRange, getFreshestGscDate, getLatestGscDate, getNextDate, getOldestGscDate, getPendingDates, getPstDate, groupIntoRanges, toIsoDate } from "./core/gsc-dates.mjs";
+import { currentPstDate, daysAgoPst } from "./query/utils/dayjs.mjs";
 export { DAYS_PER_RANGE, GSC_FINALIZED_LAG_DAYS, GSC_FRESHEST_LAG_DAYS, GSC_RETENTION_MONTHS, MS_PER_DAY, addDays, countDays, currentPstDate, daysAgoPst, daysAgo as daysAgoUtc, generateGscDateRange, getBackfillProgress, getDateRange, getFreshestGscDate, getLatestGscDate, getNextDate, getOldestGscDate, getPendingDates, getPstDate, groupIntoRanges, toIsoDate };