@orangecheck/me-client 0.8.1 → 0.11.0

package/dist/index.d.mts

@@ -1,6 +1,28 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 
+type Scope = 'bitcoin_address' | 'email' | 'attest_tier' | 'display_name';
+interface GrantedOptions {
+    project_key: string;
+    signal?: AbortSignal;
+}
+interface GrantedResult {
+    sub: string;
+    scopes_granted: Scope[];
+    scopes: Partial<Record<Scope, string>>;
+}
+declare function granted(options: GrantedOptions): Promise<GrantedResult>;
+interface RequestOptions {
+    project_key: string;
+    return_to: string;
+    origin?: string;
+}
+declare function request(scopes: Scope[], options: RequestOptions): never;
+declare const scope: {
+    granted: typeof granted;
+    request: typeof request;
+};
+
 interface VerifyResult {
     ok: boolean;
     reason?: string;
@@ -18,10 +40,10 @@ interface VerifyOptions {
     jwk?: OcPublicJwk;
     jwksCacheTtlMs?: number;
 }
-declare function verify(rawBody: string | Uint8Array, sigHex: string, kid: string, options?: VerifyOptions): Promise<VerifyResult>;
+declare function verify$1(rawBody: string | Uint8Array, sigHex: string, kid: string, options?: VerifyOptions): Promise<VerifyResult>;
 declare function fetchJwksForce(issuer?: string): Promise<void>;
 declare const webhook: {
-    verify: typeof verify;
+    verify: typeof verify$1;
     fetchJwks: typeof fetchJwksForce;
 };
 
@@ -152,8 +174,57 @@ interface FireEventOptions {
     metadata?: Record<string, unknown>;
 }
 declare function fire(options: FireEventOptions): Promise<BillableEvent>;
+interface BatchEventInput {
+    subtype: EventSubtype;
+    payment_amount_sats?: number;
+    action_label?: string;
+    note?: string;
+    idempotency_key?: string;
+}
+type BatchEventResult = {
+    index: number;
+    status: 'recorded';
+    event: BillableEvent;
+} | {
+    index: number;
+    status: 'duplicate';
+    event: BillableEvent;
+} | {
+    index: number;
+    status: 'rejected';
+    reason: string;
+};
+interface FireBatchOptions {
+    project_key: string;
+    events: BatchEventInput[];
+}
+interface FireBatchResponse {
+    ok: boolean;
+    results: BatchEventResult[];
+    escrow_mode: 'simulation' | 'live';
+    simulation_mode_note?: string;
+}
+declare function fireBatch(options: FireBatchOptions): Promise<FireBatchResponse>;
+interface VerifyEventResult {
+    ok: boolean;
+    issues: Array<{
+        field: 'gross_fee_sats' | 'platform_fee_sats' | 'user_earned_sats' | 'site_rebate_sats' | 'subtype_disabled' | 'subtype_unconfigured' | 'percent_amount_missing';
+        expected: number | null;
+        actual: number | null;
+        message: string;
+    }>;
+    expected: {
+        gross_fee_sats: number;
+        platform_fee_sats: number;
+        user_earned_sats: number;
+        site_rebate_sats: number;
+    } | null;
+}
+declare function verify(envelope: BillableEvent, config: IntegratorPriceConfig, payment_amount_sats?: number): VerifyEventResult;
 declare const event: {
     fire: typeof fire;
+    fireBatch: typeof fireBatch;
+    verify: typeof verify;
 };
 
 interface OcSignInButtonProps extends Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, 'onError'> {
@@ -218,12 +289,14 @@ declare const oc: {
     };
     event: {
         fire: (options: FireEventOptions) => Promise<BillableEvent>;
+        fireBatch: (options: FireBatchOptions) => Promise<FireBatchResponse>;
+        verify: (envelope: BillableEvent, config: IntegratorPriceConfig, payment_amount_sats?: number) => VerifyEventResult;
     };
     config: {
         validate: (cfg: IntegratorPriceConfig) => ValidationResult;
     };
     webhook: {
-        verify: typeof verify;
+        verify: typeof verify$1;
         fetchJwks: typeof fetchJwksForce;
     };
     federations: {
@@ -232,6 +305,10 @@ declare const oc: {
         get: (slug: string) => Promise<Federation | null>;
         defaultLive: () => Promise<Federation | null>;
     };
+    scope: {
+        granted: (options: GrantedOptions) => Promise<GrantedResult>;
+        request: typeof request;
+    };
 };
 
-export { type AttestTier, type BillableEvent, type ClassASubtype, type ClassBSubtype, type ClassCSubtype, type ComputedFees, type EventClass, type EventSubtype, type Federation, type FederationStatus, type FireEventOptions, type IntegratorEventConfig, type IntegratorPriceConfig, MIN_INTEGRATOR_PRICE_SATS, MeClientError, type OcPublicJwk, OcSignInButton, type OcSignInButtonProps, PLATFORM_FEE_POLICY, type PaymentAuthorizeOptions, type PaymentResult, type Session, type SessionPolicy, type SignInOptions, type SigningMethod, type SiteFeeShape, type TelemetryEvent, type ValidationResult, type VerifyOptions, type VerifyResult, clearBearerToken, computeFees, config, event, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, 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, clearBearerToken, computeFees, config, event, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, scope, session, setBearerToken, setOrigin, validateIntegratorConfig, webhook };

package/dist/index.d.ts

@@ -1,6 +1,28 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 
+type Scope = 'bitcoin_address' | 'email' | 'attest_tier' | 'display_name';
+interface GrantedOptions {
+    project_key: string;
+    signal?: AbortSignal;
+}
+interface GrantedResult {
+    sub: string;
+    scopes_granted: Scope[];
+    scopes: Partial<Record<Scope, string>>;
+}
+declare function granted(options: GrantedOptions): Promise<GrantedResult>;
+interface RequestOptions {
+    project_key: string;
+    return_to: string;
+    origin?: string;
+}
+declare function request(scopes: Scope[], options: RequestOptions): never;
+declare const scope: {
+    granted: typeof granted;
+    request: typeof request;
+};
+
 interface VerifyResult {
     ok: boolean;
     reason?: string;
@@ -18,10 +40,10 @@ interface VerifyOptions {
     jwk?: OcPublicJwk;
     jwksCacheTtlMs?: number;
 }
-declare function verify(rawBody: string | Uint8Array, sigHex: string, kid: string, options?: VerifyOptions): Promise<VerifyResult>;
+declare function verify$1(rawBody: string | Uint8Array, sigHex: string, kid: string, options?: VerifyOptions): Promise<VerifyResult>;
 declare function fetchJwksForce(issuer?: string): Promise<void>;
 declare const webhook: {
-    verify: typeof verify;
+    verify: typeof verify$1;
     fetchJwks: typeof fetchJwksForce;
 };
 
@@ -152,8 +174,57 @@ interface FireEventOptions {
     metadata?: Record<string, unknown>;
 }
 declare function fire(options: FireEventOptions): Promise<BillableEvent>;
+interface BatchEventInput {
+    subtype: EventSubtype;
+    payment_amount_sats?: number;
+    action_label?: string;
+    note?: string;
+    idempotency_key?: string;
+}
+type BatchEventResult = {
+    index: number;
+    status: 'recorded';
+    event: BillableEvent;
+} | {
+    index: number;
+    status: 'duplicate';
+    event: BillableEvent;
+} | {
+    index: number;
+    status: 'rejected';
+    reason: string;
+};
+interface FireBatchOptions {
+    project_key: string;
+    events: BatchEventInput[];
+}
+interface FireBatchResponse {
+    ok: boolean;
+    results: BatchEventResult[];
+    escrow_mode: 'simulation' | 'live';
+    simulation_mode_note?: string;
+}
+declare function fireBatch(options: FireBatchOptions): Promise<FireBatchResponse>;
+interface VerifyEventResult {
+    ok: boolean;
+    issues: Array<{
+        field: 'gross_fee_sats' | 'platform_fee_sats' | 'user_earned_sats' | 'site_rebate_sats' | 'subtype_disabled' | 'subtype_unconfigured' | 'percent_amount_missing';
+        expected: number | null;
+        actual: number | null;
+        message: string;
+    }>;
+    expected: {
+        gross_fee_sats: number;
+        platform_fee_sats: number;
+        user_earned_sats: number;
+        site_rebate_sats: number;
+    } | null;
+}
+declare function verify(envelope: BillableEvent, config: IntegratorPriceConfig, payment_amount_sats?: number): VerifyEventResult;
 declare const event: {
     fire: typeof fire;
+    fireBatch: typeof fireBatch;
+    verify: typeof verify;
 };
 
 interface OcSignInButtonProps extends Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, 'onError'> {
@@ -218,12 +289,14 @@ declare const oc: {
     };
     event: {
         fire: (options: FireEventOptions) => Promise<BillableEvent>;
+        fireBatch: (options: FireBatchOptions) => Promise<FireBatchResponse>;
+        verify: (envelope: BillableEvent, config: IntegratorPriceConfig, payment_amount_sats?: number) => VerifyEventResult;
     };
     config: {
         validate: (cfg: IntegratorPriceConfig) => ValidationResult;
     };
     webhook: {
-        verify: typeof verify;
+        verify: typeof verify$1;
         fetchJwks: typeof fetchJwksForce;
     };
     federations: {
@@ -232,6 +305,10 @@ declare const oc: {
         get: (slug: string) => Promise<Federation | null>;
         defaultLive: () => Promise<Federation | null>;
     };
+    scope: {
+        granted: (options: GrantedOptions) => Promise<GrantedResult>;
+        request: typeof request;
+    };
 };
 
-export { type AttestTier, type BillableEvent, type ClassASubtype, type ClassBSubtype, type ClassCSubtype, type ComputedFees, type EventClass, type EventSubtype, type Federation, type FederationStatus, type FireEventOptions, type IntegratorEventConfig, type IntegratorPriceConfig, MIN_INTEGRATOR_PRICE_SATS, MeClientError, type OcPublicJwk, OcSignInButton, type OcSignInButtonProps, PLATFORM_FEE_POLICY, type PaymentAuthorizeOptions, type PaymentResult, type Session, type SessionPolicy, type SignInOptions, type SigningMethod, type SiteFeeShape, type TelemetryEvent, type ValidationResult, type VerifyOptions, type VerifyResult, clearBearerToken, computeFees, config, event, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, 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, clearBearerToken, computeFees, config, event, federations, getBearerToken, getOrigin, oc, onTelemetry, payment, scope, session, setBearerToken, setOrigin, validateIntegratorConfig, webhook };

package/dist/index.js

@@ -131,7 +131,7 @@ async function invalidate(sessionId) {
 }
 var session = { create, refresh, invalidate };
 function OcSignInButton({
-  scope,
+  scope: scope2,
   sessionPolicy,
   returnTo,
   onSignin,
@@ -152,7 +152,7 @@ function OcSignInButton({
         if (event2.defaultPrevented) return;
         setPending(true);
         try {
-          const result = await session.create({ scope, sessionPolicy, returnTo });
+          const result = await session.create({ scope: scope2, sessionPolicy, returnTo });
           onSignin?.(result);
         } catch (err) {
           onSignInError?.(err instanceof Error ? err : new Error(String(err)));
@@ -212,21 +212,6 @@ async function authorize(opts) {
 }
 var payment = { authorize };
 
-// src/event.ts
-async function fire(options) {
-  if (!options.project_key) {
-    throw new Error("event.fire requires project_key");
-  }
-  if (!options.subtype) {
-    throw new Error("event.fire requires subtype");
-  }
-  return api("/api/integrator/event", {
-    method: "POST",
-    body: options
-  });
-}
-var event = { fire };
-
 // src/types.ts
 var PLATFORM_FEE_POLICY = {
   /** Fraction of every gross_fee that OC retains. */
@@ -296,6 +281,122 @@ function validateIntegratorConfig(cfg) {
   return { ok: errors.length === 0, errors };
 }
 
+// src/event.ts
+async function fire(options) {
+  if (!options.project_key) {
+    throw new Error("event.fire requires project_key");
+  }
+  if (!options.subtype) {
+    throw new Error("event.fire requires subtype");
+  }
+  return api("/api/integrator/event", {
+    method: "POST",
+    body: options
+  });
+}
+async function fireBatch(options) {
+  if (!options.project_key) {
+    throw new Error("event.fireBatch requires project_key");
+  }
+  if (!Array.isArray(options.events) || options.events.length === 0) {
+    throw new Error("event.fireBatch requires at least one event");
+  }
+  if (options.events.length > 100) {
+    throw new Error(
+      `event.fireBatch \xB7 max 100 events per call (got ${options.events.length}). Split client-side.`
+    );
+  }
+  return api("/api/integrator/event/batch", {
+    method: "POST",
+    body: options
+  });
+}
+function verify(envelope, config2, payment_amount_sats) {
+  const issues = [];
+  const eventCfg = config2.events[envelope.subtype];
+  if (!eventCfg) {
+    return {
+      ok: false,
+      expected: null,
+      issues: [
+        {
+          field: "subtype_unconfigured",
+          expected: null,
+          actual: null,
+          message: `subtype ${envelope.subtype} is not configured on integrator ${config2.project_key}`
+        }
+      ]
+    };
+  }
+  if (!eventCfg.enabled) {
+    return {
+      ok: false,
+      expected: null,
+      issues: [
+        {
+          field: "subtype_disabled",
+          expected: null,
+          actual: null,
+          message: `subtype ${envelope.subtype} is disabled on integrator ${config2.project_key} but the envelope was billed`
+        }
+      ]
+    };
+  }
+  if (eventCfg.site_pays.kind === "percent_of_amount" && payment_amount_sats == null) {
+    return {
+      ok: false,
+      expected: null,
+      issues: [
+        {
+          field: "percent_amount_missing",
+          expected: null,
+          actual: null,
+          message: `subtype ${envelope.subtype} is percent_of_amount-priced; payment_amount_sats is required to verify`
+        }
+      ]
+    };
+  }
+  const expected = computeFees(eventCfg, payment_amount_sats);
+  if (envelope.gross_fee_sats !== expected.gross_fee_sats) {
+    issues.push({
+      field: "gross_fee_sats",
+      expected: expected.gross_fee_sats,
+      actual: envelope.gross_fee_sats,
+      message: `gross_fee_sats mismatch \xB7 expected ${expected.gross_fee_sats}, recorded ${envelope.gross_fee_sats}`
+    });
+  }
+  if (envelope.platform_fee_sats !== expected.platform_fee_sats) {
+    issues.push({
+      field: "platform_fee_sats",
+      expected: expected.platform_fee_sats,
+      actual: envelope.platform_fee_sats,
+      message: `platform_fee_sats mismatch \xB7 expected ${expected.platform_fee_sats}, recorded ${envelope.platform_fee_sats}`
+    });
+  }
+  if (envelope.user_earned_sats !== expected.user_earned_sats) {
+    issues.push({
+      field: "user_earned_sats",
+      expected: expected.user_earned_sats,
+      actual: envelope.user_earned_sats,
+      message: `user_earned_sats mismatch \xB7 expected ${expected.user_earned_sats}, recorded ${envelope.user_earned_sats}`
+    });
+  }
+  if (envelope.site_rebate_sats !== expected.site_rebate_sats) {
+    issues.push({
+      field: "site_rebate_sats",
+      expected: expected.site_rebate_sats,
+      actual: envelope.site_rebate_sats,
+      message: `site_rebate_sats mismatch \xB7 expected ${expected.site_rebate_sats}, recorded ${envelope.site_rebate_sats}`
+    });
+  }
+  return {
+    ok: issues.length === 0,
+    expected,
+    issues
+  };
+}
+var event = { fire, fireBatch, verify };
+
 // src/config.ts
 function validate(cfg) {
   return validateIntegratorConfig(cfg);
@@ -600,7 +701,7 @@ async function verifyEd25519(key, sig, msg) {
     return false;
   }
 }
-async function verify(rawBody, sigHex, kid, options = {}) {
+async function verify2(rawBody, sigHex, kid, options = {}) {
   if (!sigHex) return { ok: false, reason: "missing signature" };
   if (!kid) return { ok: false, reason: "missing kid" };
   const sig = hexToBytes(sigHex);
@@ -639,7 +740,7 @@ async function fetchJwksForce(issuer = DEFAULT_ISSUER) {
   jwksCache.delete(issuer);
   await fetchJwks(issuer, DEFAULT_TTL_MS);
 }
-var webhook = { verify, fetchJwks: fetchJwksForce };
+var webhook = { verify: verify2, fetchJwks: fetchJwksForce };
 
 // src/federations.ts
 async function list() {
@@ -660,8 +761,59 @@ async function defaultLive() {
 }
 var federations = { list, live, get, defaultLive };
 
+// src/scope.ts
+var VALID_SCOPES = [
+  "bitcoin_address",
+  "email",
+  "attest_tier",
+  "display_name"
+];
+async function granted(options) {
+  if (!options.project_key) {
+    throw new Error("oc.scope.granted: project_key is required");
+  }
+  const r = await api(
+    `/api/integrator/scopes/${encodeURIComponent(options.project_key)}`,
+    { method: "GET", signal: options.signal }
+  );
+  return {
+    sub: r.sub,
+    scopes_granted: r.scopes_granted,
+    scopes: r.scopes
+  };
+}
+function request(scopes, options) {
+  if (!options.project_key) {
+    throw new Error("oc.scope.request: project_key is required");
+  }
+  if (!options.return_to) {
+    throw new Error("oc.scope.request: return_to is required");
+  }
+  if (!Array.isArray(scopes) || scopes.length === 0) {
+    throw new Error("oc.scope.request: scopes must be a non-empty array");
+  }
+  for (const s of scopes) {
+    if (!VALID_SCOPES.includes(s)) {
+      throw new Error(
+        `oc.scope.request: unknown scope "${s}" \xB7 valid: ${VALID_SCOPES.join(", ")}`
+      );
+    }
+  }
+  if (typeof window === "undefined") {
+    throw new Error("oc.scope.request: must be called in a browser environment");
+  }
+  const origin2 = options.origin ?? getOrigin();
+  const url = new URL("/me/scope-grant", origin2);
+  url.searchParams.set("project_key", options.project_key);
+  url.searchParams.set("scopes", scopes.join(","));
+  url.searchParams.set("return_to", options.return_to);
+  window.location.assign(url.toString());
+  throw new Error("oc.scope.request: redirected to consent prompt");
+}
+var scope = { granted, request };
+
 // src/index.ts
-var oc = { session, payment, event, config, webhook, federations };
+var oc = { session, payment, event, config, webhook, federations, scope };
 
 exports.MIN_INTEGRATOR_PRICE_SATS = MIN_INTEGRATOR_PRICE_SATS;
 exports.MeClientError = MeClientError;
@@ -677,6 +829,7 @@ exports.getOrigin = getOrigin;
 exports.oc = oc;
 exports.onTelemetry = onTelemetry;
 exports.payment = payment;
+exports.scope = scope;
 exports.session = session;
 exports.setBearerToken = setBearerToken;
 exports.setOrigin = setOrigin;