@rankwrangler/http-client 0.11.0 → 0.13.0

package/README.md

@@ -48,8 +48,7 @@ screen compact Products with market metrics. `keyword.results` preserves dated e
 evidence and can wait for collection under the existing 24-hour reuse policy.
 
 Product `get` returns the current Product. `getMany` returns basic listing data, and `history`
-returns compact rank and price series. Brand Analytics keyword `get`, `search`, and `history`
-remain separate from observed search results. Retryable `TIMEOUT` errors preserve retry hints.
+returns compact rank and price series. Keyword `get` and `search` read the stored keyword directory, separately from observed search results. Retryable `TIMEOUT` errors preserve retry hints.
 
 ## Types
 
@@ -58,7 +57,7 @@ import type { PublicRouterInputs, PublicRouterOutputs } from '@rankwrangler/http
 
 type ProductGetInput = PublicRouterInputs['product']['get'];
 type ProductSearchOutput = PublicRouterOutputs['product']['search'];
-type KeywordHistoryOutput = PublicRouterOutputs['keyword']['history'];
+type KeywordSearchOutput = PublicRouterOutputs['keyword']['search'];
 ```
 
 When the public router changes, regenerate and build the declarations:

package/dist/app-router.d.ts

@@ -198,82 +198,17 @@ export interface ContextRequest {
 		host?: string;
 	};
 }
-declare const TOP_SEARCH_TERMS_REPORT_PERIODS: readonly [
-	"DAY",
-	"WEEK"
+declare const keywordStages: readonly [
+	"graduated",
+	"trial",
+	"dropped",
+	"untracked"
 ];
-declare const TOP_SEARCH_TERMS_REFRESH_TRIGGERS: readonly [
-	"requested",
-	"automatic"
+declare const keywordFreshness: readonly [
+	"live",
+	"needsSync",
+	"syncing"
 ];
-export type TopSearchTermsReportPeriod = (typeof TOP_SEARCH_TERMS_REPORT_PERIODS)[number];
-export type TopSearchTermsRefreshTrigger = (typeof TOP_SEARCH_TERMS_REFRESH_TRIGGERS)[number];
-export type SearchTermsTrendDelta = {
-	rankDelta: number | null;
-	clickShareDelta: number | null;
-	conversionShareDelta: number | null;
-};
-export type SearchTermsTrendDeltas = {
-	d1: SearchTermsTrendDelta;
-	d7: SearchTermsTrendDelta;
-	d30: SearchTermsTrendDelta;
-};
-export interface KeywordEvidence {
-	searchFrequencyRank: number;
-	clickShareTop3: number;
-	conversionShareTop3: number;
-	topRowsCount: number;
-	isMerchRelevant: boolean;
-	merchReason: string;
-}
-export interface KeywordCurrent {
-	keyword: string;
-	marketplaceId: string;
-	reportPeriod: TopSearchTermsReportPeriod;
-	dataStartDate: string;
-	dataEndDate: string;
-	observedDate: string;
-	fetchedAt: string;
-	trigger: TopSearchTermsRefreshTrigger;
-	evidence: KeywordEvidence;
-}
-export interface KeywordSearchItem extends KeywordEvidence {
-	keyword: string;
-	observedDate: string;
-	trigger: TopSearchTermsRefreshTrigger;
-}
-export interface KeywordSearchSummary {
-	marketplaceId: string;
-	reportPeriod: TopSearchTermsReportPeriod;
-	dataStartDate: string | null;
-	dataEndDate: string | null;
-	observedDate: string | null;
-	fetchedAt: string | null;
-	totalFiltered: number;
-}
-export interface KeywordSearchResponse {
-	status: "ready" | "empty";
-	items: KeywordSearchItem[];
-	nextCursor: number | null;
-	summary: KeywordSearchSummary;
-}
-export interface KeywordHistoryPoint {
-	observedDate: string;
-	searchFrequencyRank: number;
-	clickShareTop3: number;
-	conversionShareTop3: number;
-	trigger: TopSearchTermsRefreshTrigger;
-}
-export interface KeywordHistoryResponse {
-	keyword: string;
-	marketplaceId: string;
-	reportPeriod: TopSearchTermsReportPeriod;
-	rangeDays: number;
-	status: "ready" | "empty";
-	latestObservedDate: string | null;
-	points: KeywordHistoryPoint[];
-	deltas: SearchTermsTrendDeltas;
-}
 export type PublicCutoutThumbnail = {
 	status: "available";
 	url: string;
@@ -505,15 +440,27 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 				get: import("@trpc/server").TRPCQueryProcedure<{
 					input: {
 						keyword: string;
-						dataEndDate?: string | undefined;
-						dataStartDate?: string | undefined;
-						marketplaceId?: "ATVPDKIKX0DER" | undefined;
-						reportPeriod?: "DAY" | "WEEK" | undefined;
 					};
 					output: {
 						keyword: string;
-						status: "ready" | "empty";
-						current: KeywordCurrent | null;
+						data: {
+							createdAt: string;
+							lastCheckedAt: string | null;
+							nextCheckAt: string | null;
+							id: string;
+							queryId: string;
+							term: string;
+							stage: (typeof keywordStages)[number];
+							freshness: (typeof keywordFreshness)[number] | null;
+							retryScheduled: boolean;
+							heat: string;
+							score: number | null;
+							searchFrequencyRank: number | null;
+							sources: string[];
+							products: number;
+							merch: number;
+							intervalDays: number | null;
+						};
 					};
 					meta: object;
 				}>;
@@ -525,30 +472,61 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 					output: KeywordResults;
 					meta: object;
 				}>;
-				history: import("@trpc/server").TRPCQueryProcedure<{
-					input: {
-						keyword: string;
-						marketplaceId?: "ATVPDKIKX0DER" | undefined;
-						rangeDays?: number | undefined;
-						reportPeriod?: "DAY" | "WEEK" | undefined;
-					};
-					output: KeywordHistoryResponse;
-					meta: object;
-				}>;
 				search: import("@trpc/server").TRPCQueryProcedure<{
 					input: {
 						text: string;
-						cursor?: number | undefined;
+						freshness?: "live" | "needsSync" | "syncing" | "all" | undefined;
+						sort?: "work" | "newest" | undefined;
+						stage?: "trial" | "graduated" | "dropped" | "untracked" | "all" | undefined;
 						limit?: number | undefined;
-						maxRank?: number | undefined;
-						merchOnly?: boolean | undefined;
-						minRank?: number | undefined;
-						dataEndDate?: string | undefined;
-						dataStartDate?: string | undefined;
-						marketplaceId?: "ATVPDKIKX0DER" | undefined;
-						reportPeriod?: "DAY" | "WEEK" | undefined;
+						heat?: "unrated" | "hot" | "warm" | "cold" | "all" | undefined;
+						cursor?: {
+							key: [
+								number,
+								number,
+								number,
+								number,
+								number,
+								number,
+								string
+							];
+							asOf: string;
+							sort: "work" | "newest";
+						} | undefined;
+					};
+					output: {
+						items: {
+							createdAt: string;
+							lastCheckedAt: string | null;
+							nextCheckAt: string | null;
+							id: string;
+							queryId: string;
+							term: string;
+							stage: (typeof keywordStages)[number];
+							freshness: (typeof keywordFreshness)[number] | null;
+							retryScheduled: boolean;
+							heat: string;
+							score: number | null;
+							searchFrequencyRank: number | null;
+							sources: string[];
+							products: number;
+							merch: number;
+							intervalDays: number | null;
+						}[];
+						nextCursor: {
+							sort: "fresh" | "work" | "newest" | "score" | "medianBsr" | "merch";
+							asOf: string;
+							key: [
+								number,
+								number,
+								number,
+								number,
+								number,
+								number,
+								string
+							];
+						} | null;
 					};
-					output: KeywordSearchResponse;
 					meta: object;
 				}>;
 			}>>;
@@ -599,7 +577,7 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 					input: {
 						marketplaceId: string;
 						asin: string;
-						bucket?: "auto" | "day" | "week" | "month" | undefined;
+						bucket?: "week" | "day" | "auto" | "month" | undefined;
 						days?: unknown;
 						endAt?: unknown;
 						limit?: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rankwrangler/http-client",
-    "version": "0.11.0",
+    "version": "0.13.0",
     "description": "Typed tRPC client for RankWrangler",
     "repository": {
         "type": "git",