@orangecheck/me-client 0.11.0 → 0.13.0

package/README.md

@@ -1,5 +1,9 @@
 # @orangecheck/me-client
 
+> **Full reference:** [docs.ochk.io/sdk/me-client](https://docs.ochk.io/sdk/me-client) — auto-generated from the TypeScript source on every release.
+> Hand-written prose below is the high-level overview; the docs site is the source of truth for every export, type, and signature.
+
+
 Drop-in client for [me.ochk.io](https://me.ochk.io). Sign-in-with-OC button, popup signin orchestrator, framework-agnostic server-side verification, session lifecycle hooks, payment authorization, webhook signature verification, the canonical billable-event taxonomy as TypeScript types.
 
 > You pay for sessions and actions, not for clicks.

package/dist/index.d.mts

@@ -172,6 +172,7 @@ interface FireEventOptions {
     payment_amount_sats?: number;
     user_address?: string;
     metadata?: Record<string, unknown>;
+    is_agent?: boolean;
 }
 declare function fire(options: FireEventOptions): Promise<BillableEvent>;
 interface BatchEventInput {
@@ -180,6 +181,7 @@ interface BatchEventInput {
     action_label?: string;
     note?: string;
     idempotency_key?: string;
+    is_agent?: boolean;
 }
 type BatchEventResult = {
     index: number;
@@ -275,8 +277,20 @@ declare function getBearerToken(): string | null;
 declare function clearBearerToken(): void;
 declare class MeClientError extends Error {
     readonly status: number;
-    constructor(message: string, status: number);
+    readonly errorCode: string | undefined;
+    readonly retryAfterSeconds: number | undefined;
+    constructor(message: string, status: number, opts?: {
+        errorCode?: string;
+        retryAfterSeconds?: number;
+    });
+    get isRateLimited(): boolean;
 }
+interface WithRateLimitRetryOptions {
+    maxRetries?: number;
+    maxRetryAfterSeconds?: number;
+    baseBackoffMs?: number;
+}
+declare function withRateLimitRetry<T>(fn: () => Promise<T>, opts?: WithRateLimitRetryOptions): Promise<T>;
 
 declare const oc: {
     session: {
@@ -311,4 +325,4 @@ declare const oc: {
     };
 };
 
-export { type AttestTier, type BillableEvent, type ClassASubtype, type ClassBSubtype, type ClassCSubtype, type ComputedFees, type EventClass, type EventSubtype, type Federation, type FederationStatus, type FireEventOptions, type GrantedOptions, type GrantedResult, type IntegratorEventConfig, type IntegratorPriceConfig, MIN_INTEGRATOR_PRICE_SATS, MeClientError, type OcPublicJwk, OcSignInButton, type OcSignInButtonProps, PLATFORM_FEE_POLICY, type PaymentAuthorizeOptions, type PaymentResult, type RequestOptions, type Scope, type Session, type SessionPolicy, type SignInOptions, type SigningMethod, type SiteFeeShape, type TelemetryEvent, type ValidationResult, type VerifyEventResult, type VerifyOptions, type VerifyResult, clearBearerToken, computeFees, config, event, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, scope, session, setBearerToken, setOrigin, validateIntegratorConfig, webhook };
+export { type AttestTier, type BillableEvent, type ClassASubtype, type ClassBSubtype, type ClassCSubtype, type ComputedFees, type EventClass, type EventSubtype, type Federation, type FederationStatus, type FireEventOptions, type GrantedOptions, type GrantedResult, type IntegratorEventConfig, type IntegratorPriceConfig, MIN_INTEGRATOR_PRICE_SATS, MeClientError, type OcPublicJwk, OcSignInButton, type OcSignInButtonProps, PLATFORM_FEE_POLICY, type PaymentAuthorizeOptions, type PaymentResult, type RequestOptions, type Scope, type Session, type SessionPolicy, type SignInOptions, type SigningMethod, type SiteFeeShape, type TelemetryEvent, type ValidationResult, type VerifyEventResult, type VerifyOptions, type VerifyResult, type WithRateLimitRetryOptions, clearBearerToken, computeFees, config, event, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, scope, session, setBearerToken, setOrigin, validateIntegratorConfig, webhook, withRateLimitRetry };

package/dist/index.d.ts

@@ -172,6 +172,7 @@ interface FireEventOptions {
     payment_amount_sats?: number;
     user_address?: string;
     metadata?: Record<string, unknown>;
+    is_agent?: boolean;
 }
 declare function fire(options: FireEventOptions): Promise<BillableEvent>;
 interface BatchEventInput {
@@ -180,6 +181,7 @@ interface BatchEventInput {
     action_label?: string;
     note?: string;
     idempotency_key?: string;
+    is_agent?: boolean;
 }
 type BatchEventResult = {
     index: number;
@@ -275,8 +277,20 @@ declare function getBearerToken(): string | null;
 declare function clearBearerToken(): void;
 declare class MeClientError extends Error {
     readonly status: number;
-    constructor(message: string, status: number);
+    readonly errorCode: string | undefined;
+    readonly retryAfterSeconds: number | undefined;
+    constructor(message: string, status: number, opts?: {
+        errorCode?: string;
+        retryAfterSeconds?: number;
+    });
+    get isRateLimited(): boolean;
 }
+interface WithRateLimitRetryOptions {
+    maxRetries?: number;
+    maxRetryAfterSeconds?: number;
+    baseBackoffMs?: number;
+}
+declare function withRateLimitRetry<T>(fn: () => Promise<T>, opts?: WithRateLimitRetryOptions): Promise<T>;
 
 declare const oc: {
     session: {
@@ -311,4 +325,4 @@ declare const oc: {
     };
 };
 
-export { type AttestTier, type BillableEvent, type ClassASubtype, type ClassBSubtype, type ClassCSubtype, type ComputedFees, type EventClass, type EventSubtype, type Federation, type FederationStatus, type FireEventOptions, type GrantedOptions, type GrantedResult, type IntegratorEventConfig, type IntegratorPriceConfig, MIN_INTEGRATOR_PRICE_SATS, MeClientError, type OcPublicJwk, OcSignInButton, type OcSignInButtonProps, PLATFORM_FEE_POLICY, type PaymentAuthorizeOptions, type PaymentResult, type RequestOptions, type Scope, type Session, type SessionPolicy, type SignInOptions, type SigningMethod, type SiteFeeShape, type TelemetryEvent, type ValidationResult, type VerifyEventResult, type VerifyOptions, type VerifyResult, clearBearerToken, computeFees, config, event, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, scope, session, setBearerToken, setOrigin, validateIntegratorConfig, webhook };
+export { type AttestTier, type BillableEvent, type ClassASubtype, type ClassBSubtype, type ClassCSubtype, type ComputedFees, type EventClass, type EventSubtype, type Federation, type FederationStatus, type FireEventOptions, type GrantedOptions, type GrantedResult, type IntegratorEventConfig, type IntegratorPriceConfig, MIN_INTEGRATOR_PRICE_SATS, MeClientError, type OcPublicJwk, OcSignInButton, type OcSignInButtonProps, PLATFORM_FEE_POLICY, type PaymentAuthorizeOptions, type PaymentResult, type RequestOptions, type Scope, type Session, type SessionPolicy, type SignInOptions, type SigningMethod, type SiteFeeShape, type TelemetryEvent, type ValidationResult, type VerifyEventResult, type VerifyOptions, type VerifyResult, type WithRateLimitRetryOptions, clearBearerToken, computeFees, config, event, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, scope, session, setBearerToken, setOrigin, validateIntegratorConfig, webhook, withRateLimitRetry };

package/dist/index.js

@@ -60,22 +60,69 @@ async function api(path, opts = {}) {
   });
   if (!res.ok) {
     let message = `me.ochk.io ${res.status}`;
+    let errorCode;
+    let body;
     try {
       const data = await res.json();
-      if (data?.error) message = data.error;
+      body = data;
+      if (data?.error) {
+        errorCode = data.error;
+        message = data.reason ?? data.error;
+      }
     } catch {
     }
-    throw new MeClientError(message, res.status);
+    let retryAfterSeconds;
+    if (res.status === 429) {
+      const headerValue = res.headers.get("retry-after");
+      if (headerValue) {
+        const parsed = Number.parseInt(headerValue, 10);
+        if (Number.isFinite(parsed) && parsed >= 0) retryAfterSeconds = parsed;
+      }
+      if (retryAfterSeconds == null && typeof body?.retry_after_seconds === "number") {
+        retryAfterSeconds = body.retry_after_seconds;
+      }
+    }
+    throw new MeClientError(message, res.status, { errorCode, retryAfterSeconds });
   }
   return await res.json();
 }
 var MeClientError = class extends Error {
-  constructor(message, status) {
+  constructor(message, status, opts) {
     super(message);
     this.name = "MeClientError";
     this.status = status;
+    this.errorCode = opts?.errorCode;
+    this.retryAfterSeconds = opts?.retryAfterSeconds;
+  }
+  /** True for the 429 surface · convenience boolean so callers don't
+   *  have to compare status === 429 every time. */
+  get isRateLimited() {
+    return this.status === 429;
   }
 };
+async function withRateLimitRetry(fn, opts = {}) {
+  const maxRetries = opts.maxRetries ?? 2;
+  const maxRetryAfter = opts.maxRetryAfterSeconds ?? 30;
+  const baseBackoff = opts.baseBackoffMs ?? 250;
+  let attempt = 0;
+  while (true) {
+    try {
+      return await fn();
+    } catch (err) {
+      if (!(err instanceof MeClientError) || !err.isRateLimited) throw err;
+      if (attempt >= maxRetries) throw err;
+      let waitMs;
+      if (err.retryAfterSeconds != null) {
+        if (err.retryAfterSeconds > maxRetryAfter) throw err;
+        waitMs = err.retryAfterSeconds * 1e3;
+      } else {
+        waitMs = baseBackoff * 2 ** attempt;
+      }
+      await new Promise((resolve) => setTimeout(resolve, waitMs));
+      attempt++;
+    }
+  }
+}
 
 // src/session.ts
 var DEFAULT_POLICY = {
@@ -835,5 +882,6 @@ exports.setBearerToken = setBearerToken;
 exports.setOrigin = setOrigin;
 exports.validateIntegratorConfig = validateIntegratorConfig;
 exports.webhook = webhook;
+exports.withRateLimitRetry = withRateLimitRetry;
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map