@rankwrangler/http-client 0.13.0 → 0.15.0

package/README.md

@@ -13,7 +13,7 @@ npm install @rankwrangler/http-client
 import { createRankWranglerClient } from '@rankwrangler/http-client';
 
 const client = createRankWranglerClient({
-    baseUrl: 'https://rankwrangler.merchbase.co',
+    baseUrl: 'https://rankwrangler-api.merchbase.co',
     apiKey: process.env.MERCHBASE_API_KEY,
 });
 

package/dist/app-router.d.ts

@@ -1,5 +1,6 @@
 // Generated by dts-bundle-generator v9.5.1
 
+export type ServiceAccessErrorCode = "access_denied" | "access_unavailable" | "insufficient_scope" | "unauthenticated" | "unknown_service";
 export type AmazonListingStatus = "active" | "deleted";
 declare const rankwranglerServiceAccounts: import("drizzle-orm/pg-core").PgTableWithColumns<{
 	name: "rankwrangler_service_accounts";
@@ -184,18 +185,22 @@ declare const rankwranglerServiceAccounts: import("drizzle-orm/pg-core").PgTable
 	};
 	dialect: "pg";
 }>;
-export type RankWranglerServicePrincipal = Omit<typeof rankwranglerServiceAccounts.$inferSelect, "merchbaseUserId"> & {
+/** The immutable identity of a user's service account; usage is read fresh where it is metered. */
+export type RankWranglerServicePrincipal = Pick<typeof rankwranglerServiceAccounts.$inferSelect, "id" | "service"> & {
 	merchbaseUserId: string;
 };
-export interface ClerkUser {
+export interface MerchbaseUser {
 	sub: string;
 	email?: string;
 }
-export type CredentialKind = "api_key" | "oauth" | "session";
 export interface ContextRequest {
+	method?: string;
+	url?: string;
 	headers: {
 		authorization?: string;
 		host?: string;
+		"cf-access-jwt-assertion"?: string;
+		"x-merchbase-user-id"?: string | string[];
 	};
 }
 declare const keywordStages: readonly [
@@ -231,7 +236,7 @@ export interface Product {
 		} | {
 			status: "unavailable";
 		};
-		isMerchListing: boolean | null;
+		isMerchListing: boolean;
 		amazonListingStatus: AmazonListingStatus;
 	};
 	category: {
@@ -270,7 +275,7 @@ export interface KeywordResultsProduct {
 	} | {
 		status: "unavailable";
 	};
-	isMerchListing: boolean | null;
+	isMerchListing: boolean;
 	amazonListingStatus: AmazonListingStatus;
 	category: {
 		id: number;
@@ -349,13 +354,13 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 		credentialKind: null;
 		authExpiresAtMs: null;
 		accessPrincipal: null;
-		accessError: import("@merchbaseco/access").ServiceAccessErrorCode | null;
+		accessError: ServiceAccessErrorCode | null;
 		request: ContextRequest;
 	} | {
-		user: ClerkUser;
+		user: MerchbaseUser;
 		isAdmin: boolean;
 		authType: "access";
-		credentialKind: CredentialKind;
+		credentialKind: "session" | "api_key" | "service_delegated" | "oauth";
 		authExpiresAtMs: number | null;
 		accessPrincipal: RankWranglerServicePrincipal;
 		accessError: null;
@@ -373,13 +378,13 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 			credentialKind: null;
 			authExpiresAtMs: null;
 			accessPrincipal: null;
-			accessError: import("@merchbaseco/access").ServiceAccessErrorCode | null;
+			accessError: ServiceAccessErrorCode | null;
 			request: ContextRequest;
 		} | {
-			user: ClerkUser;
+			user: MerchbaseUser;
 			isAdmin: boolean;
 			authType: "access";
-			credentialKind: CredentialKind;
+			credentialKind: "session" | "api_key" | "service_delegated" | "oauth";
 			authExpiresAtMs: number | null;
 			accessPrincipal: RankWranglerServicePrincipal;
 			accessError: null;
@@ -397,13 +402,13 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 				credentialKind: null;
 				authExpiresAtMs: null;
 				accessPrincipal: null;
-				accessError: import("@merchbaseco/access").ServiceAccessErrorCode | null;
+				accessError: ServiceAccessErrorCode | null;
 				request: ContextRequest;
 			} | {
-				user: ClerkUser;
+				user: MerchbaseUser;
 				isAdmin: boolean;
 				authType: "access";
-				credentialKind: CredentialKind;
+				credentialKind: "session" | "api_key" | "service_delegated" | "oauth";
 				authExpiresAtMs: number | null;
 				accessPrincipal: RankWranglerServicePrincipal;
 				accessError: null;
@@ -421,13 +426,13 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 					credentialKind: null;
 					authExpiresAtMs: null;
 					accessPrincipal: null;
-					accessError: import("@merchbaseco/access").ServiceAccessErrorCode | null;
+					accessError: ServiceAccessErrorCode | null;
 					request: ContextRequest;
 				} | {
-					user: ClerkUser;
+					user: MerchbaseUser;
 					isAdmin: boolean;
 					authType: "access";
-					credentialKind: CredentialKind;
+					credentialKind: "session" | "api_key" | "service_delegated" | "oauth";
 					authExpiresAtMs: number | null;
 					accessPrincipal: RankWranglerServicePrincipal;
 					accessError: null;
@@ -444,22 +449,22 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 					output: {
 						keyword: string;
 						data: {
-							createdAt: string;
-							lastCheckedAt: string | null;
-							nextCheckAt: string | null;
+							freshness: (typeof keywordFreshness)[number] | null;
+							products: number;
 							id: string;
+							createdAt: string;
+							searchFrequencyRank: number | null;
+							intervalDays: number | null;
 							queryId: string;
-							term: string;
+							nextCheckAt: string | null;
 							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;
+							term: string;
+							retryScheduled: boolean;
+							sources: string[];
+							lastCheckedAt: string | null;
 						};
 					};
 					meta: object;
@@ -476,9 +481,9 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 					input: {
 						text: string;
 						freshness?: "live" | "needsSync" | "syncing" | "all" | undefined;
-						sort?: "work" | "newest" | undefined;
-						stage?: "trial" | "graduated" | "dropped" | "untracked" | "all" | undefined;
 						limit?: number | undefined;
+						sort?: "work" | "newest" | undefined;
+						stage?: "trial" | "dropped" | "graduated" | "untracked" | "all" | undefined;
 						heat?: "unrated" | "hot" | "warm" | "cold" | "all" | undefined;
 						cursor?: {
 							key: [
@@ -496,22 +501,22 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 					};
 					output: {
 						items: {
-							createdAt: string;
-							lastCheckedAt: string | null;
-							nextCheckAt: string | null;
+							freshness: (typeof keywordFreshness)[number] | null;
+							products: number;
 							id: string;
+							createdAt: string;
+							searchFrequencyRank: number | null;
+							intervalDays: number | null;
 							queryId: string;
-							term: string;
+							nextCheckAt: string | null;
 							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;
+							term: string;
+							retryScheduled: boolean;
+							sources: string[];
+							lastCheckedAt: string | null;
 						}[];
 						nextCursor: {
 							sort: "fresh" | "work" | "newest" | "score" | "medianBsr" | "merch";
@@ -538,13 +543,13 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 					credentialKind: null;
 					authExpiresAtMs: null;
 					accessPrincipal: null;
-					accessError: import("@merchbaseco/access").ServiceAccessErrorCode | null;
+					accessError: ServiceAccessErrorCode | null;
 					request: ContextRequest;
 				} | {
-					user: ClerkUser;
+					user: MerchbaseUser;
 					isAdmin: boolean;
 					authType: "access";
-					credentialKind: CredentialKind;
+					credentialKind: "session" | "api_key" | "service_delegated" | "oauth";
 					authExpiresAtMs: number | null;
 					accessPrincipal: RankWranglerServicePrincipal;
 					accessError: null;
@@ -593,7 +598,7 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 						textFields?: "title" | "all" | undefined;
 						excludeWords?: string[] | undefined;
 						marketplaceIds?: string[] | undefined;
-						isMerchListing?: boolean | "unknown" | "all" | undefined;
+						isMerchListing?: boolean | "all" | undefined;
 						amazonListingStatus?: "active" | "deleted" | "all" | undefined;
 						brands?: string[] | undefined;
 						excludeBrands?: string[] | undefined;
@@ -643,6 +648,7 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 							} | null;
 						} | null;
 						items: {
+							extra?: undefined;
 							marketplaceId: string;
 							asin: string;
 							title: string | null;
@@ -656,7 +662,7 @@ export declare const publicAppRouter: import("@trpc/server").TRPCBuiltRouter<{
 								status: "unavailable";
 								url?: undefined;
 							};
-							isMerchListing: boolean | null;
+							isMerchListing: boolean;
 							amazonListingStatus: AmazonListingStatus;
 							categoryId: number | null;
 							salesRank: number | null;

package/dist/credential-headers.d.ts

@@ -0,0 +1 @@
+export declare const credentialHeaders: (credential: string) => Record<string, string>;

package/dist/credential-headers.js

@@ -0,0 +1,23 @@
+export const credentialHeaders = (credential) => {
+    if (!credential.startsWith('mbk_v1.'))
+        return { Authorization: `Bearer ${credential}` };
+    try {
+        if (credential.length > 2048)
+            throw new Error();
+        const encoded = credential.slice(7);
+        if (!/^[A-Za-z0-9_-]+$/.test(encoded))
+            throw new Error();
+        const decoded = atob(encoded.replace(/-/g, '+').replace(/_/g, '/'));
+        if (btoa(decoded).replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, '') !== encoded)
+            throw new Error();
+        const parsed = JSON.parse(decoded);
+        if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed) || Object.keys(parsed).length !== 2 || !('clientId' in parsed) || !('clientSecret' in parsed) ||
+            typeof parsed.clientId !== 'string' || !/^[A-Za-z0-9._-]{1,256}$/.test(parsed.clientId) ||
+            typeof parsed.clientSecret !== 'string' || !/^[A-Za-z0-9_-]{32,512}$/.test(parsed.clientSecret))
+            throw new Error();
+        return { 'CF-Access-Client-Id': parsed.clientId, 'CF-Access-Client-Secret': parsed.clientSecret };
+    }
+    catch {
+        throw new Error('Invalid Merchbase machine credential.');
+    }
+};

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { createTRPCProxyClient } from '@trpc/client';
 import type { inferRouterInputs, inferRouterOutputs } from '@trpc/server';
 import type { PublicAppRouter } from './app-router';
-export declare const DEFAULT_API_BASE_URL = "https://rankwrangler.merchbase.co";
+export declare const DEFAULT_API_BASE_URL = "https://rankwrangler-api.merchbase.co";
 export type AppRouter = PublicAppRouter;
 export type RouterInputs = inferRouterInputs<PublicAppRouter>;
 export type RouterOutputs = inferRouterOutputs<PublicAppRouter>;

package/dist/index.js

@@ -1,10 +1,11 @@
+import { credentialHeaders } from './credential-headers.js';
 import { createTRPCProxyClient, httpBatchLink, httpLink } from '@trpc/client';
 const TRAILING_SLASHES_REGEX = /\/+$/;
-export const DEFAULT_API_BASE_URL = 'https://rankwrangler.merchbase.co';
+export const DEFAULT_API_BASE_URL = 'https://rankwrangler-api.merchbase.co';
 export const createRankWranglerClient = ({ baseUrl, apiKey, headers, batch = true, }) => {
     const url = `${normalizeBaseUrl(baseUrl)}/api`;
     const resolveHeaders = () => ({
-        ...(apiKey ? { Authorization: `Bearer ${apiKey}` } : {}),
+        ...(apiKey ? credentialHeaders(apiKey) : {}),
         ...(headers ?? {}),
     });
     if (batch) {
@@ -12,6 +13,7 @@ export const createRankWranglerClient = ({ baseUrl, apiKey, headers, batch = tru
             links: [
                 httpBatchLink({
                     url,
+                    fetch: (input, init) => fetch(input, { ...init, redirect: 'manual' }),
                     headers: resolveHeaders,
                 }),
             ],
@@ -22,6 +24,7 @@ export const createRankWranglerClient = ({ baseUrl, apiKey, headers, batch = tru
         links: [
             httpLink({
                 url,
+                fetch: (input, init) => fetch(input, { ...init, redirect: 'manual' }),
                 headers: resolveHeaders,
             }),
         ],

package/package.json

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