@orangecheck/me-client 0.16.0 → 0.18.0

package/dist/index.js

@@ -444,11 +444,240 @@ function verify(envelope, config2, payment_amount_sats) {
 }
 var event = { fire, fireBatch, verify };
 
+// src/templates.ts
+var FIXED = (sats) => ({
+  kind: "fixed_sats",
+  sats
+});
+var PCT = (pct) => ({
+  kind: "percent_of_amount",
+  pct
+});
+var ARCHETYPE_TEMPLATES = [
+  {
+    id: "saas-paywall",
+    label: "SaaS \xB7 paywall",
+    summary: "Subscription product \xB7 users sign up, sign in, sometimes pay for premium tiers. Default cashback to encourage signup + retention.",
+    examples: ["Notion-like notes app", "Linear-like project tracker", "Figma-like editor"],
+    events: {
+      account_creation: {
+        enabled: true,
+        site_pays: FIXED(1300),
+        user_share_pct: 0.65
+      },
+      session_creation: {
+        enabled: true,
+        site_pays: FIXED(55),
+        user_share_pct: 0.65
+      },
+      payment_authorization: {
+        enabled: true,
+        site_pays: PCT(75e-4),
+        user_share_pct: 0.65
+      },
+      payment_method_connected: {
+        enabled: true,
+        site_pays: FIXED(320),
+        user_share_pct: 0.65
+      }
+    }
+  },
+  {
+    id: "marketplace",
+    label: "marketplace",
+    summary: "Two-sided marketplace \xB7 buyers + sellers transact. Heavy on payment_authorization and scoped_action_authorization for listings.",
+    examples: ["Stripe-like checkout", "Etsy-like marketplace", "Uber-like ride-hailing"],
+    events: {
+      account_creation: {
+        enabled: true,
+        site_pays: FIXED(1300),
+        user_share_pct: 0.65
+      },
+      session_creation: {
+        enabled: true,
+        site_pays: FIXED(55),
+        user_share_pct: 0.65
+      },
+      payment_authorization: {
+        enabled: true,
+        site_pays: PCT(75e-4),
+        user_share_pct: 0.65
+      },
+      scoped_action_authorization: {
+        enabled: true,
+        site_pays: FIXED(100),
+        user_share_pct: 0.65
+      },
+      payment_method_connected: {
+        enabled: true,
+        site_pays: FIXED(320),
+        user_share_pct: 0.65
+      },
+      attest_verification_at_gate: {
+        enabled: true,
+        site_pays: FIXED(280),
+        user_share_pct: 0.65
+      }
+    }
+  },
+  {
+    id: "content-platform",
+    label: "content platform",
+    summary: "User-generated content \xB7 posts, reviews, votes, comments. Each meaningful action is scoped_action_authorization; stamp_signing for credentialed reviews.",
+    examples: ["Reddit-like forum", "YouTube-like video host", "Substack-like publishing"],
+    events: {
+      account_creation: {
+        enabled: true,
+        site_pays: FIXED(1300),
+        user_share_pct: 0.7
+      },
+      session_creation: {
+        enabled: true,
+        site_pays: FIXED(55),
+        user_share_pct: 0.7
+      },
+      scoped_action_authorization: {
+        enabled: true,
+        site_pays: FIXED(100),
+        user_share_pct: 0.7
+      },
+      stamp_signing: {
+        enabled: true,
+        site_pays: FIXED(55),
+        user_share_pct: 0.7
+      }
+    }
+  },
+  {
+    id: "gaming",
+    label: "gaming",
+    summary: "Game with monetized actions \xB7 pledges + scoped actions are core. Higher cashback ratios reward in-game engagement.",
+    examples: [
+      "on-chain prediction markets",
+      "skill-staking tournaments",
+      "PvP wager games"
+    ],
+    events: {
+      account_creation: {
+        enabled: true,
+        site_pays: FIXED(1300),
+        user_share_pct: 0.7
+      },
+      session_creation: {
+        enabled: true,
+        site_pays: FIXED(55),
+        user_share_pct: 0.7
+      },
+      scoped_action_authorization: {
+        enabled: true,
+        site_pays: FIXED(100),
+        user_share_pct: 0.7
+      },
+      payment_authorization: {
+        enabled: true,
+        site_pays: PCT(5e-3),
+        user_share_pct: 0.7
+      },
+      pledge_resolution: {
+        enabled: true,
+        site_pays: PCT(0.01),
+        user_share_pct: 0.7
+      },
+      attest_verification_at_gate: {
+        enabled: true,
+        site_pays: FIXED(280),
+        user_share_pct: 0.7
+      }
+    }
+  },
+  {
+    id: "agent-only",
+    label: "agent-only",
+    summary: "AI-agent surface \xB7 oc-agent delegations are the primary auth pattern. Session_creation off (delegations replace sessions); agent_delegation_issued + scoped_action_authorization carry the activity.",
+    examples: [
+      "AI assistant calling APIs on user behalf",
+      "autonomous trading bot",
+      "agent-driven customer support"
+    ],
+    events: {
+      account_creation: {
+        enabled: true,
+        site_pays: FIXED(1300),
+        user_share_pct: 0.65
+      },
+      agent_delegation_issued: {
+        enabled: true,
+        site_pays: FIXED(320),
+        user_share_pct: 0.65
+      },
+      scoped_action_authorization: {
+        enabled: true,
+        site_pays: FIXED(100),
+        user_share_pct: 0.65
+      }
+    }
+  }
+];
+var ARCHETYPES_BY_ID = Object.fromEntries(
+  ARCHETYPE_TEMPLATES.map((t) => [t.id, t])
+);
+var ALL_SUBTYPES = [
+  "account_creation",
+  "account_recovery",
+  "attest_bond_increased",
+  "payment_method_connected",
+  "agent_delegation_issued",
+  "recovery_method_updated",
+  "payment_authorization",
+  "scoped_action_authorization",
+  "attest_verification_at_gate",
+  "stamp_signing",
+  "pledge_resolution",
+  "session_creation"
+];
+var DEFAULT_DISABLED = {
+  enabled: false,
+  site_pays: { kind: "fixed_sats", sats: 100 },
+  user_share_pct: 0.65
+};
+function fromTemplate(useCase, identity) {
+  const template = ARCHETYPES_BY_ID[useCase];
+  if (!template) {
+    throw new Error(
+      `oc.config.fromTemplate: unknown archetype "${useCase}". Valid: ${Object.keys(
+        ARCHETYPES_BY_ID
+      ).join(", ")}`
+    );
+  }
+  const events = {};
+  for (const sub of ALL_SUBTYPES) {
+    events[sub] = template.events[sub] ?? DEFAULT_DISABLED;
+  }
+  return {
+    project_key: identity.project_key,
+    domain: identity.domain,
+    display_name: identity.display_name,
+    updated_at: (/* @__PURE__ */ new Date()).toISOString(),
+    events
+  };
+}
+function getArchetypeTemplate(id) {
+  return ARCHETYPES_BY_ID[id];
+}
+
 // src/config.ts
 function validate(cfg) {
   return validateIntegratorConfig(cfg);
 }
-var config = { validate };
+var config = {
+  validate,
+  fromTemplate,
+  /** Look up a template's metadata · for rendering "you picked X"
+   *  state and offering one-click swaps in your own UI. */
+  getArchetype: getArchetypeTemplate,
+  /** All available archetypes · render in a picker. */
+  archetypes: ARCHETYPE_TEMPLATES
+};
 
 // node_modules/jose/dist/webapi/lib/buffer_utils.js
 new TextEncoder();
@@ -909,9 +1138,135 @@ async function scopes(verb, options) {
 }
 var family = { scopes };
 
+// src/subtypes.ts
+var EVENT_SUBTYPES = {
+  // ── Class A · durable state transitions ──
+  account_creation: {
+    id: "account_creation",
+    class: "A",
+    label: "account creation",
+    fires_when: "a new oc identity creates a durable account record on your surface (first sign-in, profile row inserted)",
+    example: "user signed up via email-OTP and your account row was inserted in your DB",
+    common_use_cases: ["onboarding", "signup", "registration", "first-login"],
+    typical_price_hint: "~1300 sats (~$1.24)"
+  },
+  account_recovery: {
+    id: "account_recovery",
+    class: "A",
+    label: "account recovery",
+    fires_when: "a user re-binds an existing account to a new device or recovery method",
+    example: "user lost their device and recovered the account via email OTP + recovery code",
+    common_use_cases: ["recovery", "device-rebind", "restore-access"],
+    typical_price_hint: "~650 sats (~$0.62)"
+  },
+  attest_bond_increased: {
+    id: "attest_bond_increased",
+    class: "A",
+    label: "attest bond increased",
+    fires_when: "a user upgrades their bond size (locks more sats to attest_tier=bonded with higher cap)",
+    example: "user moved from 10k-sat bond to 100k-sat bond to clear your higher-trust gate",
+    common_use_cases: ["bond-upgrade", "tier-promotion", "sybil-resistance"],
+    typical_price_hint: "~1600 sats (~$1.52) \xB7 OFF by default"
+  },
+  payment_method_connected: {
+    id: "payment_method_connected",
+    class: "A",
+    label: "payment method connected",
+    fires_when: "a user connects a Lightning address, BIP-322 wallet, or payment-routing channel to their account",
+    example: "user pasted a lightning@address.com receive address into their profile",
+    common_use_cases: ["payment-setup", "wallet-connect", "payout-config"],
+    typical_price_hint: "~320 sats (~$0.30)"
+  },
+  agent_delegation_issued: {
+    id: "agent_delegation_issued",
+    class: "A",
+    label: "agent delegation issued",
+    fires_when: "a user signs an oc-agent delegation envelope authorizing an AI agent to act on their behalf",
+    example: 'user delegated a "summarize my emails" agent for 24 hours with scope email:read',
+    common_use_cases: ["agent-grant", "ai-delegation", "scoped-authorization"],
+    typical_price_hint: "~320 sats \xB7 OFF by default (power-user)"
+  },
+  recovery_method_updated: {
+    id: "recovery_method_updated",
+    class: "A",
+    label: "recovery method updated",
+    fires_when: "a user changes their recovery email, recovery key, or social-recovery contacts",
+    example: "user rotated their recovery email after a phone change",
+    common_use_cases: ["recovery-rotation", "security-update"],
+    typical_price_hint: "~160 sats (~$0.15)"
+  },
+  // ── Class B · action-bound ──
+  payment_authorization: {
+    id: "payment_authorization",
+    class: "B",
+    label: "payment authorized",
+    fires_when: "a user authorizes a payment of underlying value (Lightning, on-chain BTC, or fiat-quoted)",
+    example: "user paid $5.00 (\u22485260 sats) for a premium feature on your site",
+    common_use_cases: ["payment", "checkout", "paywall", "subscription"],
+    typical_price_hint: "0.75% of payment amount (percent_of_amount)"
+  },
+  scoped_action_authorization: {
+    id: "scoped_action_authorization",
+    class: "B",
+    label: "scoped action authorized",
+    fires_when: "a user takes a specific action your site bills on (post, vote, comment, claim) where each instance is meaningful",
+    example: "user posted a long-form review that earns them sats from your editorial budget",
+    common_use_cases: ["post", "vote", "comment", "claim", "submit"],
+    typical_price_hint: "~100 sats (~$0.10)"
+  },
+  attest_verification_at_gate: {
+    id: "attest_verification_at_gate",
+    class: "B",
+    label: "attest verification",
+    fires_when: "your site's gate consulted the user's attest_tier and admitted them (counted only when admitted)",
+    example: "admin gate checked attest_tier=bonded with bond\u226510k sats and granted access",
+    common_use_cases: ["gate-check", "tier-gate", "sybil-filter"],
+    typical_price_hint: "~280 sats (~$0.27) \xB7 OFF by default"
+  },
+  stamp_signing: {
+    id: "stamp_signing",
+    class: "B",
+    label: "stamp signed",
+    fires_when: "a user signs an oc-stamp envelope (provenance attestation, review credential, content stamp)",
+    example: "user stamped their published recipe with their oc identity for downstream verification",
+    common_use_cases: ["provenance", "review", "credential", "attestation"],
+    typical_price_hint: "~55 sats (~$0.05) \xB7 OFF by default"
+  },
+  pledge_resolution: {
+    id: "pledge_resolution",
+    class: "B",
+    label: "pledge resolved",
+    fires_when: "an oc-pledge bonded commitment resolves (paid out, slashed, or refunded) on your surface",
+    example: "user staked 50k sats on a prediction; market resolved and the pledge paid out",
+    common_use_cases: ["pledge", "staking", "resolution", "commit-reveal"],
+    typical_price_hint: "1% of pledge amount (percent_of_amount) \xB7 OFF by default"
+  },
+  // ── Class C · session ──
+  session_creation: {
+    id: "session_creation",
+    class: "C",
+    label: "session opened",
+    fires_when: "a fresh authenticated session is opened for a returning user (sign-in within an existing session is FREE)",
+    example: "user signed in after their last session expired; new session token issued",
+    common_use_cases: ["sign-in", "session", "authenticate"],
+    typical_price_hint: "~55 sats (~$0.05)"
+  }
+};
+function subtypesForClass(cls) {
+  return Object.values(EVENT_SUBTYPES).filter((m) => m.class === cls);
+}
+var ALL_EVENT_SUBTYPES = [
+  ...subtypesForClass("A"),
+  ...subtypesForClass("B"),
+  ...subtypesForClass("C")
+];
+
 // src/index.ts
 var oc = { session, payment, event, config, webhook, federations, scope, family };
 
+exports.ALL_EVENT_SUBTYPES = ALL_EVENT_SUBTYPES;
+exports.ARCHETYPE_TEMPLATES = ARCHETYPE_TEMPLATES;
+exports.EVENT_SUBTYPES = EVENT_SUBTYPES;
 exports.MIN_INTEGRATOR_PRICE_SATS = MIN_INTEGRATOR_PRICE_SATS;
 exports.MeClientError = MeClientError;
 exports.OcSignInButton = OcSignInButton;
@@ -919,9 +1274,11 @@ exports.PLATFORM_FEE_POLICY = PLATFORM_FEE_POLICY;
 exports.clearBearerToken = clearBearerToken;
 exports.computeFees = computeFees;
 exports.config = config;
+exports.configFromTemplate = fromTemplate;
 exports.event = event;
 exports.family = family;
 exports.federations = federations;
+exports.getArchetypeTemplate = getArchetypeTemplate;
 exports.getBearerToken = getBearerToken;
 exports.getOrigin = getOrigin;
 exports.oc = oc;
@@ -932,6 +1289,7 @@ exports.scope = scope;
 exports.session = session;
 exports.setBearerToken = setBearerToken;
 exports.setOrigin = setOrigin;
+exports.subtypesForClass = subtypesForClass;
 exports.validateIntegratorConfig = validateIntegratorConfig;
 exports.webhook = webhook;
 exports.withRateLimitRetry = withRateLimitRetry;