@open-slot-ui/core 0.5.0 → 0.6.0

package/dist/index.d.cts

@@ -1255,6 +1255,11 @@ declare class OpenUI {
     };
     /** Minimum round duration (ms) from jurisdiction — stored for the GAME to enforce. */
     minimumRoundDuration: number;
+    /** Buy-feature confirm threshold, as a multiple of the base bet. A play (buy or
+     *  bet-mode activation) that costs STRICTLY MORE than this must show a confirm step
+     *  — Stake requires that bet modes above 2× never activate on a single click. `0`
+     *  (the default) = off. Set via `spec.buyFeature.confirmAboveCost` or a jurisdiction. */
+    confirmBuyAboveCost: number;
     private sessionNet;
     private prevVolumes;
     /** The frozen UISpec `createUI` built this from, if any — authored = run = tested. */
@@ -1363,6 +1368,10 @@ declare class OpenUI {
     /** Read-back: did the applied jurisdiction disable this feature? (real guard, not
      *  just a hide — `confirmBuy`/autoplay entry points consult this). */
     isDisabled(feature: 'autoplay' | 'buyFeature' | 'turbo' | 'fullscreen' | 'slamstop' | 'spacebar'): boolean;
+    /** True when a buy / bet-mode activation of `cost`× the base bet must be confirmed
+     *  before it commits (Stake: no one-click activation above `confirmBuyAboveCost`×).
+     *  Always false when the threshold is 0/unset or `cost` isn't a finite number. */
+    shouldConfirmBuy(cost: number): boolean;
     /**
      * Start a reality-check reminder (RTS 13). Every `everyMinutes` (WALL-CLOCK, so a
      * backgrounded tab can't cheat it) it emits a `realityCheck` event, stops autoplay,
@@ -1403,6 +1412,11 @@ interface JurisdictionConfig {
     displaySessionTimer?: boolean;
     /** Minimum ms a round must take — stored on the HUD for the GAME to enforce. */
     minimumRoundDuration?: number;
+    /** Buy-feature confirm threshold (× base bet). A play costing more than this must
+     *  be confirmed before it commits — Stake requires that bet modes above 2× never
+     *  activate on a single click, so a Stake preset sets this to `2`. Not part of the
+     *  wallet schema; a convenience so a jurisdiction can require the confirm step. */
+    confirmBuyAboveCost?: number;
 }
 /**
  * Apply a Stake Engine `jurisdiction` config to a live HUD — the whole switchboard
@@ -1679,6 +1693,15 @@ interface UISpec {
         name?: string;
         version?: string;
     };
+    /** Buy-feature / bet-mode confirmation. `confirmAboveCost` (× base bet) makes any
+     *  play costing MORE than that require a confirm step before it commits — Stake
+     *  requires bet modes above 2× to never activate on a single click, so set `2`.
+     *  The game routes a purchase/activation through `hud.requestBuyFeature(...)`, which
+     *  shows the confirm popup itself when the cost exceeds the threshold. A jurisdiction
+     *  can set the same threshold (`JurisdictionConfig.confirmBuyAboveCost`). */
+    buyFeature?: {
+        confirmAboveCost?: number;
+    };
     /** Reality-check reminder (RTS 13): open-ui runs a wall-clock timer, emits a
      *  `realityCheck` event, stops autoplay, and (unless `showModal:false`) shows an
      *  acknowledge modal. You supply only the cadence + text. `title`/`message` are
@@ -1791,14 +1814,26 @@ interface SocialPhraseIssue {
 }
 /** Every restricted phrase in `text` (empty when clean). Pure + total. */
 declare function findForbiddenPhrases(text: string): ForbiddenMatch[];
+/** A collected string. `text` is the base English (what renders with no social
+ *  override); `key` is the i18n key used to look up a social override — it defaults
+ *  to `text`, since a game's menu/rules copy doubles as its own key. */
 type Entry = {
     source: string;
     text: string;
+    key?: string;
 };
 /** Collect every English string a spec ships (menu/rules blocks, titles, labels+hints,
  *  game name, the `en` dictionary) with a source path — the input to {@link checkSocialPhrases}. */
 declare function collectSocialCopy(spec: UISpec): Entry[];
-/** Scan a whole spec's English copy and return every restricted-phrase finding. */
+/**
+ * Scan a spec's English copy AS IT RENDERS IN SOCIAL MODE and return every restricted
+ * phrase. Each collected string is first resolved through the social dictionary
+ * (`locale.socialMessages.en` → built-in `openuiSocialDefaults` → the base text) —
+ * exactly like the translator does — so a game that already swaps "bet"/"pay(table)"
+ * for compliant wording in social mode is NOT flagged, while a phrase with NO social
+ * override (the classic slipped-through "paytable") IS. English by design: the check
+ * targets the base `en` copy that every jurisdiction review starts from.
+ */
 declare function checkSocialPhrases(spec: UISpec): SocialPhraseIssue[];
 
 /**

package/dist/index.d.ts

@@ -1255,6 +1255,11 @@ declare class OpenUI {
     };
     /** Minimum round duration (ms) from jurisdiction — stored for the GAME to enforce. */
     minimumRoundDuration: number;
+    /** Buy-feature confirm threshold, as a multiple of the base bet. A play (buy or
+     *  bet-mode activation) that costs STRICTLY MORE than this must show a confirm step
+     *  — Stake requires that bet modes above 2× never activate on a single click. `0`
+     *  (the default) = off. Set via `spec.buyFeature.confirmAboveCost` or a jurisdiction. */
+    confirmBuyAboveCost: number;
     private sessionNet;
     private prevVolumes;
     /** The frozen UISpec `createUI` built this from, if any — authored = run = tested. */
@@ -1363,6 +1368,10 @@ declare class OpenUI {
     /** Read-back: did the applied jurisdiction disable this feature? (real guard, not
      *  just a hide — `confirmBuy`/autoplay entry points consult this). */
     isDisabled(feature: 'autoplay' | 'buyFeature' | 'turbo' | 'fullscreen' | 'slamstop' | 'spacebar'): boolean;
+    /** True when a buy / bet-mode activation of `cost`× the base bet must be confirmed
+     *  before it commits (Stake: no one-click activation above `confirmBuyAboveCost`×).
+     *  Always false when the threshold is 0/unset or `cost` isn't a finite number. */
+    shouldConfirmBuy(cost: number): boolean;
     /**
      * Start a reality-check reminder (RTS 13). Every `everyMinutes` (WALL-CLOCK, so a
      * backgrounded tab can't cheat it) it emits a `realityCheck` event, stops autoplay,
@@ -1403,6 +1412,11 @@ interface JurisdictionConfig {
     displaySessionTimer?: boolean;
     /** Minimum ms a round must take — stored on the HUD for the GAME to enforce. */
     minimumRoundDuration?: number;
+    /** Buy-feature confirm threshold (× base bet). A play costing more than this must
+     *  be confirmed before it commits — Stake requires that bet modes above 2× never
+     *  activate on a single click, so a Stake preset sets this to `2`. Not part of the
+     *  wallet schema; a convenience so a jurisdiction can require the confirm step. */
+    confirmBuyAboveCost?: number;
 }
 /**
  * Apply a Stake Engine `jurisdiction` config to a live HUD — the whole switchboard
@@ -1679,6 +1693,15 @@ interface UISpec {
         name?: string;
         version?: string;
     };
+    /** Buy-feature / bet-mode confirmation. `confirmAboveCost` (× base bet) makes any
+     *  play costing MORE than that require a confirm step before it commits — Stake
+     *  requires bet modes above 2× to never activate on a single click, so set `2`.
+     *  The game routes a purchase/activation through `hud.requestBuyFeature(...)`, which
+     *  shows the confirm popup itself when the cost exceeds the threshold. A jurisdiction
+     *  can set the same threshold (`JurisdictionConfig.confirmBuyAboveCost`). */
+    buyFeature?: {
+        confirmAboveCost?: number;
+    };
     /** Reality-check reminder (RTS 13): open-ui runs a wall-clock timer, emits a
      *  `realityCheck` event, stops autoplay, and (unless `showModal:false`) shows an
      *  acknowledge modal. You supply only the cadence + text. `title`/`message` are
@@ -1791,14 +1814,26 @@ interface SocialPhraseIssue {
 }
 /** Every restricted phrase in `text` (empty when clean). Pure + total. */
 declare function findForbiddenPhrases(text: string): ForbiddenMatch[];
+/** A collected string. `text` is the base English (what renders with no social
+ *  override); `key` is the i18n key used to look up a social override — it defaults
+ *  to `text`, since a game's menu/rules copy doubles as its own key. */
 type Entry = {
     source: string;
     text: string;
+    key?: string;
 };
 /** Collect every English string a spec ships (menu/rules blocks, titles, labels+hints,
  *  game name, the `en` dictionary) with a source path — the input to {@link checkSocialPhrases}. */
 declare function collectSocialCopy(spec: UISpec): Entry[];
-/** Scan a whole spec's English copy and return every restricted-phrase finding. */
+/**
+ * Scan a spec's English copy AS IT RENDERS IN SOCIAL MODE and return every restricted
+ * phrase. Each collected string is first resolved through the social dictionary
+ * (`locale.socialMessages.en` → built-in `openuiSocialDefaults` → the base text) —
+ * exactly like the translator does — so a game that already swaps "bet"/"pay(table)"
+ * for compliant wording in social mode is NOT flagged, while a phrase with NO social
+ * override (the classic slipped-through "paytable") IS. English by design: the check
+ * targets the base `en` copy that every jurisdiction review starts from.
+ */
 declare function checkSocialPhrases(spec: UISpec): SocialPhraseIssue[];
 
 /**

package/dist/index.js

@@ -1247,6 +1247,9 @@ function validateSpec(spec) {
     if (spec.realityCheck != null && !(typeof spec.realityCheck.everyMinutes === "number" && spec.realityCheck.everyMinutes > 0)) {
       add("error", "realityCheck.everyMinutes", "bad-interval", "realityCheck.everyMinutes must be a number > 0");
     }
+    if (spec.buyFeature?.confirmAboveCost != null && !(typeof spec.buyFeature.confirmAboveCost === "number" && Number.isFinite(spec.buyFeature.confirmAboveCost) && spec.buyFeature.confirmAboveCost >= 0)) {
+      add("error", "buyFeature.confirmAboveCost", "bad-threshold", "buyFeature.confirmAboveCost must be a finite number >= 0");
+    }
     if (spec.controls) {
       for (const [id, ov] of Object.entries(spec.controls)) {
         checkLayout(ov.layout?.anchor, `controls.${id}.layout.anchor`);
@@ -1399,6 +1402,9 @@ function applyJurisdiction(ui, jur) {
   if (typeof jur.minimumRoundDuration === "number" && Number.isFinite(jur.minimumRoundDuration)) {
     ui.minimumRoundDuration = Math.max(0, jur.minimumRoundDuration);
   }
+  if (typeof jur.confirmBuyAboveCost === "number" && Number.isFinite(jur.confirmBuyAboveCost)) {
+    ui.confirmBuyAboveCost = Math.max(0, jur.confirmBuyAboveCost);
+  }
 }
 
 // src/notice.ts
@@ -1456,6 +1462,8 @@ var openuiDefaults = {
   "openui.replay": "Replay",
   "openui.buyFeature.title": "Buy feature",
   "openui.buyFeature.message": "Buy this feature now?",
+  // Confirm step for a higher-cost play — {{name}} / {{price}} are interpolated.
+  "openui.buyFeature.confirm": "Buy {{name}} for {{price}}?",
   "openui.freeSpins": "FS",
   // reality check (RTS 13) — {{minutes}} is interpolated by open-ui's scheduler
   "openui.realityCheck.title": "Reality check",
@@ -1491,6 +1499,7 @@ var openuiSocialDefaults = {
   "openui.err.insufficient.title": "Insufficient balance",
   "openui.buyFeature.title": "Play bonus",
   "openui.buyFeature.message": "Play this bonus now?",
+  "openui.buyFeature.confirm": "Play {{name}} for {{price}}?",
   "openui.err.insufficient.message": "You don't have enough balance for this play.",
   "openui.err.limit.message": "A play limit has been reached. Please try again later."
 };
@@ -1671,6 +1680,11 @@ var OpenUI = class {
   gameInfo = {};
   /** Minimum round duration (ms) from jurisdiction — stored for the GAME to enforce. */
   minimumRoundDuration = 0;
+  /** Buy-feature confirm threshold, as a multiple of the base bet. A play (buy or
+   *  bet-mode activation) that costs STRICTLY MORE than this must show a confirm step
+   *  — Stake requires that bet modes above 2× never activate on a single click. `0`
+   *  (the default) = off. Set via `spec.buyFeature.confirmAboveCost` or a jurisdiction. */
+  confirmBuyAboveCost = 0;
   sessionNet = 0;
   prevVolumes = null;
   /** The frozen UISpec `createUI` built this from, if any — authored = run = tested. */
@@ -2020,6 +2034,13 @@ var OpenUI = class {
     const j = this.jurisdiction;
     return feature === "autoplay" && !!j.disabledAutoplay || feature === "buyFeature" && !!j.disabledBuyFeature || feature === "turbo" && !!j.disabledTurbo || feature === "fullscreen" && !!j.disabledFullscreen || feature === "slamstop" && !!j.disabledSlamstop || feature === "spacebar" && !!j.disabledSpacebar;
   }
+  /** True when a buy / bet-mode activation of `cost`× the base bet must be confirmed
+   *  before it commits (Stake: no one-click activation above `confirmBuyAboveCost`×).
+   *  Always false when the threshold is 0/unset or `cost` isn't a finite number. */
+  shouldConfirmBuy(cost) {
+    const t = this.confirmBuyAboveCost;
+    return t > 0 && Number.isFinite(cost) && cost > t;
+  }
   /**
    * Start a reality-check reminder (RTS 13). Every `everyMinutes` (WALL-CLOCK, so a
    * backgrounded tab can't cheat it) it emits a `realityCheck` event, stops autoplay,
@@ -2251,15 +2272,18 @@ function collectSocialCopy(spec) {
   if (spec.game?.name) out.push({ source: "game.name", text: spec.game.name });
   const en = spec.locale?.messages?.en;
   if (en) {
-    for (const [k, v] of Object.entries(en)) if (typeof v === "string") out.push({ source: `locale.en[${JSON.stringify(k)}]`, text: v });
+    for (const [k, v] of Object.entries(en)) if (typeof v === "string") out.push({ source: `locale.en[${JSON.stringify(k)}]`, text: v, key: k });
   }
   return out;
 }
 function checkSocialPhrases(spec) {
+  const socialEn = spec.locale?.socialMessages?.en ?? {};
+  const render = (e) => socialEn[e.key ?? e.text] ?? openuiSocialDefaults[e.key ?? e.text] ?? e.text;
   const issues = [];
-  for (const { source, text } of collectSocialCopy(spec)) {
+  for (const e of collectSocialCopy(spec)) {
+    const text = render(e);
     const matches = findForbiddenPhrases(text);
-    if (matches.length) issues.push({ source, text, matches });
+    if (matches.length) issues.push({ source: e.source, text, matches });
   }
   return issues;
 }
@@ -2350,6 +2374,9 @@ function createUI(spec = {}, hooks = {}) {
       }
     }
   }
+  if (spec.buyFeature?.confirmAboveCost != null && Number.isFinite(spec.buyFeature.confirmAboveCost)) {
+    ui.confirmBuyAboveCost = Math.max(0, spec.buyFeature.confirmAboveCost);
+  }
   if (spec.jurisdiction) ui.applyJurisdiction(spec.jurisdiction);
   const portraitControls = {};
   for (const [id, layout] of Object.entries(portraitDefaultLayouts)) {