@revturbine/sdk 0.2.22 → 0.2.23

package/dist/types/web-sdk/react/useCan.d.ts

@@ -1,22 +1,47 @@
 import { type UseEntitlementOptions, type UseEntitlementResult } from './useEntitlement';
 /**
- * Verb-parity alias of {@link useEntitlement} — the reactive counterpart to the
- * imperative `rt.can(handle)`. Takes the entitlement handle positionally (matching
+ * Result of {@link useCan} — the entitlement check reduced to the shape a `can`
+ * question actually needs.
+ */
+export interface UseCanResult {
+    /**
+     * `true` when the user may proceed. This is `allowed || limited` (equivalently,
+     * not `denied`): a `limited` entitlement still grants access — it just means the
+     * usage/credit balance is running low. Fail-open, matching the SDK: `can` is also
+     * `true` before the check resolves and if the entitlement service is unreachable.
+     * Gate on `!can` to block; never gate on `!allowed` (that would also block
+     * `limited` users who are still entitled).
+     */
+    can: boolean;
+    /**
+     * `true` when access is granted but the balance is approaching its limit (the
+     * "running low" state). Surface a soft warning while still allowing the action.
+     */
+    limited: boolean;
+    /**
+     * The full entitlement result (`status`, `reason`, `current_tier`, `placement`,
+     * …), or `null` until the check resolves — the escape hatch for details beyond
+     * `can` / `limited`.
+     */
+    result: UseEntitlementResult['result'];
+}
+/**
+ * Reactive counterpart to the imperative `rt.can(handle)` — the entitlement check
+ * as a `can` question. Takes the entitlement handle positionally (matching
  * `rt.can('handle')`), plus the same options {@link useEntitlement} accepts, and
- * returns the identical reactive result (`allowed` / `denied` / `limited` /
- * `result` / `recheck` / …).
+ * returns a curated `{ can, limited, result }`.
  *
- * Use this when you want the hook name to read like the `can` verb; it is a thin
- * wrapper with no behavioral difference from `useEntitlement({ handle })`.
+ * For the full reactive surface (`allowed` / `denied` / `isLoading` / `error` /
+ * `gatedPlacement` / `recheck`), use {@link useEntitlement} directly.
  *
  * @example
  * ```tsx
- * function BrandKitSection() {
- *   const { allowed, denied, result } = useCan('brand_kit');
- *   if (denied) return <UpgradePrompt reason={result?.reason} />;
- *   return <BrandKitEditor />;
+ * function BatchExport() {
+ *   const { can, limited } = useCan('batch_export');
+ *   if (!can) return <UpgradePrompt />;
+ *   return <BatchExportButton warnLowBalance={limited} />;
  * }
  * ```
  */
-export declare function useCan(handle: string, options?: Omit<UseEntitlementOptions, 'handle'>): UseEntitlementResult;
+export declare function useCan(handle: string, options?: Omit<UseEntitlementOptions, 'handle'>): UseCanResult;
 //# sourceMappingURL=useCan.d.ts.map

package/dist/types/web-sdk/react/useCan.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCan.d.ts","sourceRoot":"","sources":["../../../../react/useCan.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,KAAK,qBAAqB,EAAE,KAAK,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAEzG;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,MAAM,CACpB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,qBAAqB,EAAE,QAAQ,CAAC,GAC9C,oBAAoB,CAEtB"}
+{"version":3,"file":"useCan.d.ts","sourceRoot":"","sources":["../../../../react/useCan.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,KAAK,qBAAqB,EAAE,KAAK,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAEzG;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;OAOG;IACH,GAAG,EAAE,OAAO,CAAC;IACb;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,MAAM,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;CACxC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,MAAM,CACpB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,IAAI,CAAC,qBAAqB,EAAE,QAAQ,CAAC,GAC9C,YAAY,CAGd"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revturbine/sdk",
-  "version": "0.2.22",
+  "version": "0.2.23",
   "description": "RevTurbine customer-facing SDK — placement decisioning, entitlement checks, and usage tracking.",
   "type": "module",
   "exports": {