@checkbox-site/node 0.1.0 → 0.2.0

package/README.md

@@ -31,6 +31,7 @@ sandbox and never need activation.
 | Retries | Network errors, 409 `idempotency_key_in_use`, 429 (honours `Retry-After`) and 5xx are retried with exponential backoff and jitter (`maxNetworkRetries`, default 2) |
 | Idempotency | Every POST that changes something gets an `Idempotency-Key` automatically, reused across retries; pass your own with `{ idempotencyKey }` |
 | Versioning | Sends `Checkbox-Version: 2026-10-30` (the version the SDK was generated for); override with `new Checkbox(key, { apiVersion })` or per request |
+| Base URL | `new Checkbox(key, { baseUrl: 'http://localhost:4000' })`, or the `CHECKBOX_API_BASE` environment variable (the same one the MCP server reads); a trailing `/v1` is ignored. Default `https://app.checkbox.site` |
 | Mode | `checkbox.mode` is `'test'` or `'live'` from the key prefix (`ck_test_` / `ck_live_` / `rk_…` / legacy `sk_live_`) |
 | Errors | `CheckboxInvalidRequestError`, `CheckboxAuthenticationError`, `CheckboxPermissionError`, `CheckboxRateLimitError`, `CheckboxIdempotencyError`, `CheckboxAPIError`, `CheckboxConnectionError` (all `CheckboxError`), each with a stable `code`, `param`, `statusCode`, `requestId`, `docUrl` and `nextAction` |
 | Webhooks | `checkbox.webhooks.constructEvent(rawBody, signatureHeader, secret)` verifies `Checkbox-Signature` and returns a typed `WebhookEvent`; `constructEventAsync` for edge runtimes |
@@ -45,6 +46,7 @@ const checkbox = new Checkbox(process.env.CHECKBOX_API_KEY, {
   maxNetworkRetries: 2, // default
   timeout: 80_000, // ms per attempt
   appInfo: { name: 'my-app', version: '1.0.0' },
+  // baseUrl: 'http://localhost:4000', // API origin (default https://app.checkbox.site); or set CHECKBOX_API_BASE
 });
 
 // Register a site (idempotent per key) and read its compliance plan: ordered tasks with the law, the exact change and
@@ -70,7 +72,7 @@ try {
   await checkbox.certificates.create(site.id);
 } catch (err) {
   if (!(err instanceof CheckboxError)) throw err;
-  // resource_conflict: not eligible yet (verify the domain, stay compliant for 7 days);
+  // resource_conflict: not eligible yet (verify the domain, keep the checks passing for 7 days);
   // account_not_activated: a live key before any domain is verified.
   console.log(err.code, err.message, err.nextAction);
 }

package/dist/client.d.ts

@@ -45,7 +45,7 @@ export interface Checkbox extends ResourceInstances {
  */
 export declare class Checkbox implements RequestSender {
     #private;
-    static readonly VERSION = "0.1.0";
+    static readonly VERSION = "0.2.0";
     static readonly API_VERSION = "2026-10-30";
     static readonly errors: typeof errors;
     static readonly webhooks: Webhooks;
@@ -390,6 +390,23 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "Check domain verification now";
         };
+        readonly resyncBilling: {
+            readonly operationId: "resyncBilling";
+            readonly namespace: "billings";
+            readonly method: "resync";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/billing/resync";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "sites:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Re-sync Stripe settings";
+        };
         readonly createScan: {
             readonly operationId: "createScan";
             readonly namespace: "scans";
@@ -730,6 +747,23 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "List fix plans for a site";
         };
+        readonly publishShopifyTerms: {
+            readonly operationId: "publishShopifyTerms";
+            readonly namespace: "fixes";
+            readonly method: "publishShopifyTerms";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/fixes/shopify/publish";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: true;
+            readonly auth: true;
+            readonly scope: "fixes:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Publish the renewal terms to the Shopify app block";
+        };
         readonly listEvidence: {
             readonly operationId: "listEvidence";
             readonly namespace: "evidence";
@@ -1138,6 +1172,40 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "Get the dates each required notice must be sent";
         };
+        readonly listSiteSuggestions: {
+            readonly operationId: "listSiteSuggestions";
+            readonly namespace: "suggestions";
+            readonly method: "forSite";
+            readonly httpMethod: "GET";
+            readonly path: "/v1/sites/{site}/suggestions";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly ["surfaces"];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "checks:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Get conversion suggestions for a site";
+        };
+        readonly suggestImprovements: {
+            readonly operationId: "suggestImprovements";
+            readonly namespace: "suggestions";
+            readonly method: "generate";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/suggestions";
+            readonly pathParams: readonly [];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "checks:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Get conversion suggestions for copy you send";
+        };
         readonly getElementsBundle: {
             readonly operationId: "getElementsBundle";
             readonly namespace: "elements";
@@ -1580,6 +1648,23 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "Delete a registered checkout config";
         };
+        readonly deleteSiteStripeCheckoutConfig: {
+            readonly operationId: "deleteSiteStripeCheckoutConfig";
+            readonly namespace: "siteStripeCheckoutConfigs";
+            readonly method: "del";
+            readonly httpMethod: "DELETE";
+            readonly path: "/v1/sites/{site}/stripe_checkout_configs/{stripe_checkout_config}";
+            readonly pathParams: readonly ["site", "stripe_checkout_config"];
+            readonly queryParams: readonly [];
+            readonly body: false;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "test_runs:write";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Delete a registered checkout config (site path)";
+        };
         readonly createTestRun: {
             readonly operationId: "createTestRun";
             readonly namespace: "testRuns";
@@ -1621,7 +1706,7 @@ export declare class Checkbox implements RequestSender {
             readonly httpMethod: "GET";
             readonly path: "/v1/test_runs/{test_run}";
             readonly pathParams: readonly ["test_run"];
-            readonly queryParams: readonly [];
+            readonly queryParams: readonly ["wait"];
             readonly body: false;
             readonly idempotent: false;
             readonly auth: true;
@@ -1801,6 +1886,23 @@ export declare class Checkbox implements RequestSender {
             readonly paginated: false;
             readonly summary: "Send feedback";
         };
+        readonly claimReviewPrompt: {
+            readonly operationId: "claimReviewPrompt";
+            readonly namespace: "reviewPrompts";
+            readonly method: "claim";
+            readonly httpMethod: "POST";
+            readonly path: "/v1/sites/{site}/review_prompt";
+            readonly pathParams: readonly ["site"];
+            readonly queryParams: readonly [];
+            readonly body: true;
+            readonly idempotent: false;
+            readonly auth: true;
+            readonly scope: "compliance_plans:read";
+            readonly response: "json";
+            readonly list: false;
+            readonly paginated: false;
+            readonly summary: "Claim the one-time review prompt for a site";
+        };
     };
     static readonly Webhooks: typeof Webhooks;
     /** Webhook signature verification: `checkbox.webhooks.constructEvent(rawBody, header, secret)`. */

package/dist/client.js

@@ -13,7 +13,7 @@ export const DEFAULT_MAX_NETWORK_RETRIES = 2;
 const MAX_RETRY_DELAY_MS = 20_000;
 /** `ck_test_…` / `rk_test_…` / `pk_test_…` -> test; `ck_live_…` / `rk_live_…` / `sk_live_…` / `pk_live_…` -> live. */
 export function modeOfKey(key) {
-    const m = /^(?:ck|rk|sk|pk)_(test|live)_/.exec(key ?? '');
+    const m = /^(?:ckr|ck|rk|sk|pk)_(test|live)_/.exec(key ?? '');
     return m ? m[1] : undefined;
 }
 const env = (name) => {
@@ -77,7 +77,8 @@ export class Checkbox {
         this.#apiKey = (apiKey ?? env('CHECKBOX_API_KEY') ?? env('CHECKBOX_SECRET_KEY'))?.trim() || undefined;
         this.#config = { maxNetworkRetries: DEFAULT_MAX_NETWORK_RETRIES, timeout: DEFAULT_TIMEOUT_MS, ...config };
         this.apiVersion = config.apiVersion ?? API_VERSION;
-        this.baseUrl = (config.baseUrl ?? env('CHECKBOX_API_BASE') ?? DEFAULT_BASE_URL).replace(/\/+$/, '');
+        // Round-4 pilot (express): the dashboard shows the base URL with /v1; with or without it, requests go to /v1/… once.
+        this.baseUrl = (config.baseUrl ?? env('CHECKBOX_API_BASE') ?? DEFAULT_BASE_URL).replace(/\/+$/, '').replace(/\/v1$/i, '');
         this.mode = modeOfKey(this.#apiKey);
         const app = config.appInfo ? ` ${config.appInfo.name}${config.appInfo.version ? `/${config.appInfo.version}` : ''}${config.appInfo.url ? ` (${config.appInfo.url})` : ''}` : '';
         this.#userAgent = `checkbox-node/${SDK_VERSION} ${runtimeLabel()}${app}`;