@rankwrangler/http-client 0.11.0 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -48,8 +48,7 @@ screen compact Products with market metrics. `keyword.results` preserves dated e
48
48
  evidence and can wait for collection under the existing 24-hour reuse policy.
49
49
 
50
50
  Product `get` returns the current Product. `getMany` returns basic listing data, and `history`
51
- returns compact rank and price series. Brand Analytics keyword `get`, `search`, and `history`
52
- remain separate from observed search results. Retryable `TIMEOUT` errors preserve retry hints.
51
+ 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.
53
52
 
54
53
  ## Types
55
54
 
@@ -58,7 +57,7 @@ import type { PublicRouterInputs, PublicRouterOutputs } from '@rankwrangler/http
58
57
 
59
58
  type ProductGetInput = PublicRouterInputs['product']['get'];
60
59
  type ProductSearchOutput = PublicRouterOutputs['product']['search'];
61
- type KeywordHistoryOutput = PublicRouterOutputs['keyword']['history'];
60
+ type KeywordSearchOutput = PublicRouterOutputs['keyword']['search'];
62
61
  ```
63
62
 
64
63
  When the public router changes, regenerate and build the declarations:
@@ -198,82 +198,6 @@ export interface ContextRequest {
198
198
  host?: string;
199
199
  };
200
200
  }
201
- declare const TOP_SEARCH_TERMS_REPORT_PERIODS: readonly [
202
- "DAY",
203
- "WEEK"
204
- ];
205
- declare const TOP_SEARCH_TERMS_REFRESH_TRIGGERS: readonly [
206
- "requested",
207
- "automatic"
208
- ];
209
- export type TopSearchTermsReportPeriod = (typeof TOP_SEARCH_TERMS_REPORT_PERIODS)[number];
210
- export type TopSearchTermsRefreshTrigger = (typeof TOP_SEARCH_TERMS_REFRESH_TRIGGERS)[number];
211
- export type SearchTermsTrendDelta = {
212
- rankDelta: number | null;
213
- clickShareDelta: number | null;
214
- conversionShareDelta: number | null;
215
- };
216
- export type SearchTermsTrendDeltas = {
217
- d1: SearchTermsTrendDelta;
218
- d7: SearchTermsTrendDelta;
219
- d30: SearchTermsTrendDelta;
220
- };
221
- export interface KeywordEvidence {
222
- searchFrequencyRank: number;
223
- clickShareTop3: number;
224
- conversionShareTop3: number;
225
- topRowsCount: number;
226
- isMerchRelevant: boolean;
227
- merchReason: string;
228
- }
229
- export interface KeywordCurrent {
230
- keyword: string;
231
- marketplaceId: string;
232
- reportPeriod: TopSearchTermsReportPeriod;
233
- dataStartDate: string;
234
- dataEndDate: string;
235
- observedDate: string;
236
- fetchedAt: string;
237
- trigger: TopSearchTermsRefreshTrigger;
238
- evidence: KeywordEvidence;
239
- }
240
- export interface KeywordSearchItem extends KeywordEvidence {
241
- keyword: string;
242
- observedDate: string;
243
- trigger: TopSearchTermsRefreshTrigger;
244
- }
245
- export interface KeywordSearchSummary {
246
- marketplaceId: string;
247
- reportPeriod: TopSearchTermsReportPeriod;
248
- dataStartDate: string | null;
249
- dataEndDate: string | null;
250
- observedDate: string | null;
251
- fetchedAt: string | null;
252
- totalFiltered: number;
253
- }
254
- export interface KeywordSearchResponse {
255
- status: "ready" | "empty";
256
- items: KeywordSearchItem[];
257
- nextCursor: number | null;
258
- summary: KeywordSearchSummary;
259
- }
260
- export interface KeywordHistoryPoint {
261
- observedDate: string;
262
- searchFrequencyRank: number;
263
- clickShareTop3: number;
264
- conversionShareTop3: number;
265
- trigger: TopSearchTermsRefreshTrigger;
266
- }
267
- export interface KeywordHistoryResponse {
268
- keyword: string;
269
- marketplaceId: string;
270
- reportPeriod: TopSearchTermsReportPeriod;
271
- rangeDays: number;
272
- status: "ready" | "empty";
273
- latestObservedDate: string | null;
274
- points: KeywordHistoryPoint[];
275
- deltas: SearchTermsTrendDeltas;
276
- }
277
201
  export type PublicCutoutThumbnail = {
278
202
  status: "available";
279
203
  url: string;
@@ -505,15 +429,26 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
505
429
  get: import("@trpc/server").TRPCQueryProcedure<{
506
430
  input: {
507
431
  keyword: string;
508
- dataEndDate?: string | undefined;
509
- dataStartDate?: string | undefined;
510
- marketplaceId?: "ATVPDKIKX0DER" | undefined;
511
- reportPeriod?: "DAY" | "WEEK" | undefined;
512
432
  };
513
433
  output: {
514
434
  keyword: string;
515
- status: "ready" | "empty";
516
- current: KeywordCurrent | null;
435
+ data: {
436
+ createdAt: string;
437
+ lastCheckedAt: string | null;
438
+ nextCheckAt: string | null;
439
+ id: string;
440
+ queryId: string | null;
441
+ term: string;
442
+ status: "queued" | "scanning" | "upToDate" | "untracked";
443
+ untrackedReason: "notRelevant" | "noMerchFound" | "notScheduled" | null;
444
+ retryScheduled: boolean;
445
+ heat: string;
446
+ score: number | null;
447
+ sources: string[];
448
+ products: number;
449
+ merch: number;
450
+ intervalDays: number | null;
451
+ };
517
452
  };
518
453
  meta: object;
519
454
  }>;
@@ -525,30 +460,61 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
525
460
  output: KeywordResults;
526
461
  meta: object;
527
462
  }>;
528
- history: import("@trpc/server").TRPCQueryProcedure<{
529
- input: {
530
- keyword: string;
531
- marketplaceId?: "ATVPDKIKX0DER" | undefined;
532
- rangeDays?: number | undefined;
533
- reportPeriod?: "DAY" | "WEEK" | undefined;
534
- };
535
- output: KeywordHistoryResponse;
536
- meta: object;
537
- }>;
538
463
  search: import("@trpc/server").TRPCQueryProcedure<{
539
464
  input: {
540
465
  text: string;
541
- cursor?: number | undefined;
466
+ state?: "all" | "queued" | "scanning" | "upToDate" | "untracked" | undefined;
467
+ sort?: "work" | "newest" | undefined;
542
468
  limit?: number | undefined;
543
- maxRank?: number | undefined;
544
- merchOnly?: boolean | undefined;
545
- minRank?: number | undefined;
546
- dataEndDate?: string | undefined;
547
- dataStartDate?: string | undefined;
548
- marketplaceId?: "ATVPDKIKX0DER" | undefined;
549
- reportPeriod?: "DAY" | "WEEK" | undefined;
469
+ heat?: "unrated" | "hot" | "warm" | "cold" | "all" | undefined;
470
+ cursor?: {
471
+ key: [
472
+ number,
473
+ number,
474
+ number,
475
+ number,
476
+ number,
477
+ number,
478
+ string
479
+ ];
480
+ asOf: string;
481
+ trialTurn: boolean;
482
+ sort: "work" | "newest";
483
+ } | undefined;
484
+ };
485
+ output: {
486
+ items: {
487
+ createdAt: string;
488
+ lastCheckedAt: string | null;
489
+ nextCheckAt: string | null;
490
+ id: string;
491
+ queryId: string | null;
492
+ term: string;
493
+ status: "queued" | "scanning" | "upToDate" | "untracked";
494
+ untrackedReason: "notRelevant" | "noMerchFound" | "notScheduled" | null;
495
+ retryScheduled: boolean;
496
+ heat: string;
497
+ score: number | null;
498
+ sources: string[];
499
+ products: number;
500
+ merch: number;
501
+ intervalDays: number | null;
502
+ }[];
503
+ nextCursor: {
504
+ key: [
505
+ number,
506
+ number,
507
+ number,
508
+ number,
509
+ number,
510
+ number,
511
+ string
512
+ ];
513
+ asOf: string;
514
+ trialTurn: boolean;
515
+ sort: "work" | "newest";
516
+ } | null;
550
517
  };
551
- output: KeywordSearchResponse;
552
518
  meta: object;
553
519
  }>;
554
520
  }>>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rankwrangler/http-client",
3
- "version": "0.11.0",
3
+ "version": "0.12.0",
4
4
  "description": "Typed tRPC client for RankWrangler",
5
5
  "repository": {
6
6
  "type": "git",