@neko-os/rc-subscription 0.2.0 → 0.3.0

package/README.md

@@ -84,6 +84,7 @@ import { ActiveSubscriptionView } from 'neko-rc-subscription'
 |--------|-------------|
 | `useSubscription()` | Full subscription context: `{ isSubscribed, isLoading, customerInfo, offerings, paywallConfig, refresh }` |
 | `useIsSubscribed()` | Shorthand boolean — `true` when active entitlement exists. |
+| `useSubscribedAction(fn?)` | Returns an action wrapper that runs `fn` when subscribed, otherwise opens the paywall. See [Gating an action](#gating-an-action). |
 
 ### Functions
 
@@ -123,6 +124,37 @@ import { ActiveSubscriptionView } from 'neko-rc-subscription'
 | `size` | `string` | `'xs'` | Button size. |
 | `buttonProps` | `object` | — | Extra props forwarded to the unlock Button. |
 
+## Gating an action
+
+`useSubscribedAction` wraps any callback so it only fires for subscribed users — otherwise the paywall opens (navigates to `subscription/active`). Use it for one-off actions that don't warrant a full gate component (`SubscriptionRequired` / `SubscriptionRequiredCTA`).
+
+Two equivalent call styles:
+
+```jsx
+import { useSubscribedAction } from 'neko-rc-subscription'
+
+// Bind the fn up front
+function ExportButton() {
+  const exportData = useSubscribedAction(() => doExport())
+  return <Button label="Export" onPress={exportData} />
+}
+
+// Bind nothing — pass the fn at call time (handy when the callback varies)
+function Row({ item }) {
+  const run = useSubscribedAction()
+  return <Button label="Pin" onPress={() => run(() => pin(item))} />
+}
+```
+
+While subscription state is still loading (`isLoading`), the action is a no-op — it neither runs the fn nor opens the paywall, so an already-subscribed user is never bounced to the paywall during init.
+
+Arguments are forwarded to the wrapped fn, and its return value is passed through (or `undefined` when the paywall is shown instead):
+
+```jsx
+const save = useSubscribedAction(saveReport)
+save(reportId)            // -> saveReport(reportId) when subscribed
+```
+
 ## Package Support
 
 The paywall auto-renders available packages from the current RevenueCat offering. Supported package types:

package/dist/config.js

@@ -4,4 +4,8 @@ export var RC_API_KEY =
 Platform.OS === 'ios' ? process.env.EXPO_PUBLIC_RC_API_KEY_IOS : process.env.EXPO_PUBLIC_RC_API_KEY_ANDROID;
 export var RC_ENTITLEMENT_ID = process.env.EXPO_PUBLIC_RC_ENTITLEMENT_ID || 'premium';
 export var PRIVACY_POLICY_URL = process.env.EXPO_PUBLIC_PRIVACY_POLICY_URL;
-export var TERMS_OF_USE_URL = process.env.EXPO_PUBLIC_TERMS_OF_USE_URL;
+export var TERMS_OF_USE_URL = process.env.EXPO_PUBLIC_TERMS_OF_USE_URL;
+
+
+
+export var SUBSCRIPTION_ROUTE = 'subscription/active';

package/dist/containers/SubscriptionHandler.js

@@ -1,7 +1,8 @@
-var _jsxFileName = "/Users/christianstorch/Apps/nekoapps/libs/neko-rc-subscription/src/containers/SubscriptionHandler.js";function _slicedToArray(r, e) {return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest();}function _nonIterableRest() {throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}function _unsupportedIterableToArray(r, a) {if (r) {if ("string" == typeof r) return _arrayLikeToArray(r, a);var t = {}.toString.call(r).slice(8, -1);return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0;}}function _arrayLikeToArray(r, a) {(null == a || a > r.length) && (a = r.length);for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e];return n;}function _iterableToArrayLimit(r, l) {var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];if (null != t) {var e,n,i,u,a = [],f = !0,o = !1;try {if (i = (t = t.call(r)).next, 0 === l) {if (Object(t) !== t) return;f = !1;} else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0);} catch (r) {o = !0, n = r;} finally {try {if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return;} finally {if (o) throw n;}}return a;}}function _arrayWithHoles(r) {if (Array.isArray(r)) return r;}function asyncGeneratorStep(n, t, e, r, o, a, c) {try {var i = n[a](c),u = i.value;} catch (n) {return void e(n);}i.done ? t(u) : Promise.resolve(u).then(r, o);}function _asyncToGenerator(n) {return function () {var t = this,e = arguments;return new Promise(function (r, o) {var a = n.apply(t, e);function _next(n) {asyncGeneratorStep(a, r, o, _next, _throw, "next", n);}function _throw(n) {asyncGeneratorStep(a, r, o, _next, _throw, "throw", n);}_next(void 0);});};}import React, { createContext, useContext, useEffect, useState } from 'react';
+var _jsxFileName = "/Users/christianstorch/Apps/nekoapps/libs/neko-rc-subscription/src/containers/SubscriptionHandler.js";function _slicedToArray(r, e) {return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest();}function _nonIterableRest() {throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}function _iterableToArrayLimit(r, l) {var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"];if (null != t) {var e,n,i,u,a = [],f = !0,o = !1;try {if (i = (t = t.call(r)).next, 0 === l) {if (Object(t) !== t) return;f = !1;} else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0);} catch (r) {o = !0, n = r;} finally {try {if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return;} finally {if (o) throw n;}}return a;}}function _arrayWithHoles(r) {if (Array.isArray(r)) return r;}function _toConsumableArray(r) {return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread();}function _nonIterableSpread() {throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}function _unsupportedIterableToArray(r, a) {if (r) {if ("string" == typeof r) return _arrayLikeToArray(r, a);var t = {}.toString.call(r).slice(8, -1);return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0;}}function _iterableToArray(r) {if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r);}function _arrayWithoutHoles(r) {if (Array.isArray(r)) return _arrayLikeToArray(r);}function _arrayLikeToArray(r, a) {(null == a || a > r.length) && (a = r.length);for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e];return n;}function asyncGeneratorStep(n, t, e, r, o, a, c) {try {var i = n[a](c),u = i.value;} catch (n) {return void e(n);}i.done ? t(u) : Promise.resolve(u).then(r, o);}function _asyncToGenerator(n) {return function () {var t = this,e = arguments;return new Promise(function (r, o) {var a = n.apply(t, e);function _next(n) {asyncGeneratorStep(a, r, o, _next, _throw, "next", n);}function _throw(n) {asyncGeneratorStep(a, r, o, _next, _throw, "throw", n);}_next(void 0);});};}import React, { createContext, useCallback, useContext, useEffect, useState } from 'react';
 import Purchases from 'react-native-purchases';
+import { useNavigation } from '@react-navigation/native';
 
-import { RC_API_KEY, RC_ENTITLEMENT_ID } from "../config";import { jsx as _jsx } from "react/jsx-runtime";
+import { RC_API_KEY, RC_ENTITLEMENT_ID, SUBSCRIPTION_ROUTE } from "../config";import { jsx as _jsx } from "react/jsx-runtime";
 
 var SubscriptionContext = createContext({
   isSubscribed: false,
@@ -20,6 +21,55 @@ export function useIsSubscribed() {
   return useContext(SubscriptionContext).isSubscribed;
 }
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+export function useSubscribedAction(boundFn) {
+  var _useSubscription = useSubscription(),isSubscribed = _useSubscription.isSubscribed,isLoading = _useSubscription.isLoading;
+  var _useNavigation = useNavigation(),navigate = _useNavigation.navigate;
+
+  return useCallback(
+    function () {for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {args[_key] = arguments[_key];}
+      var fn = boundFn || args[0];
+      var fnArgs = boundFn ? args : args.slice(1);
+
+      if (typeof fn !== 'function') {
+        if (__DEV__) {
+          console.warn(
+            '[neko-rc-subscription] useSubscribedAction: no function to run — ' +
+            'pass it to the hook `useSubscribedAction(fn)` or to the action `action(fn)`.'
+          );
+        }
+        return undefined;
+      }
+
+
+
+      if (isLoading) return undefined;
+
+      if (!isSubscribed) {
+        navigate(SUBSCRIPTION_ROUTE);
+        return undefined;
+      }
+
+      return fn.apply(void 0, _toConsumableArray(fnArgs));
+    },
+    [isSubscribed, isLoading, navigate, boundFn]
+  );
+}
+
 export default function SubscriptionHandler(_ref) {var children = _ref.children,paywallConfig = _ref.paywallConfig;
   var _useState = useState(false),_useState2 = _slicedToArray(_useState, 2),isSubscribed = _useState2[0],setIsSubscribed = _useState2[1];
   var _useState3 = useState(true),_useState4 = _slicedToArray(_useState3, 2),isLoading = _useState4[0],setIsLoading = _useState4[1];

package/dist/containers/SubscriptionRequiredCTA.js

@@ -1,6 +1,7 @@
 var _jsxFileName = "/Users/christianstorch/Apps/nekoapps/libs/neko-rc-subscription/src/containers/SubscriptionRequiredCTA.js";var _excluded = ["children", "disabled", "hideButton", "size", "buttonProps"];function _objectWithoutProperties(e, t) {if (null == e) return {};var o,r,i = _objectWithoutPropertiesLoose(e, t);if (Object.getOwnPropertySymbols) {var n = Object.getOwnPropertySymbols(e);for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]);}return i;}function _objectWithoutPropertiesLoose(r, e) {if (null == r) return {};var t = {};for (var n in r) if ({}.hasOwnProperty.call(r, n)) {if (-1 !== e.indexOf(n)) continue;t[n] = r[n];}return t;}import { BlurView, Button, View, useTranslation } from '@neko-os/ui';
 import { useNavigation } from '@react-navigation/native';
 
+import { SUBSCRIPTION_ROUTE } from "../config";
 import { useIsSubscribed } from "./SubscriptionHandler";import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 
 export default function SubscriptionRequiredCTA(_ref)
@@ -20,7 +21,7 @@ export default function SubscriptionRequiredCTA(_ref)
   return (
     _jsxs(View, Object.assign({ relative: true, hiddenOverflow: true }, props, { children: [
       children,
-      _jsx(BlurView, { absoluteFill: true, center: true, zIndex: 10, intensity: 18, onPress: function onPress() {return navigate('subscription/active');}, children:
+      _jsx(BlurView, { absoluteFill: true, center: true, zIndex: 10, intensity: 18, onPress: function onPress() {return navigate(SUBSCRIPTION_ROUTE);}, children:
         !hideButton &&
         _jsx(Button, Object.assign({
           label: t('cta.unlock'),
@@ -28,7 +29,7 @@ export default function SubscriptionRequiredCTA(_ref)
           yellow: true,
           size: size || 'xs' },
         buttonProps, {
-          onPress: function onPress() {return navigate('subscription/active');} })
+          onPress: function onPress() {return navigate(SUBSCRIPTION_ROUTE);} })
         ) }
 
       )] })

package/dist/index.js

@@ -1,5 +1,5 @@
 export { registerSubscriptionLocales } from "./locales/index";
-export { default as SubscriptionHandler, useIsSubscribed, useSubscription } from "./containers/SubscriptionHandler";
+export { default as SubscriptionHandler, useIsSubscribed, useSubscribedAction, useSubscription } from "./containers/SubscriptionHandler";
 export { default as SubscriptionRequired } from "./containers/SubscriptionRequired";
 export { default as SubscriptionRequiredCTA } from "./containers/SubscriptionRequiredCTA";
 export { default as Paywall } from "./containers/paywall/Paywall";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neko-os/rc-subscription",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT",
   "author": "Christian Storch <ccstorch@gmail.com>",
   "main": "dist/index.js",

package/src/config.js

@@ -5,3 +5,7 @@ export const RC_API_KEY =
 export const RC_ENTITLEMENT_ID = process.env.EXPO_PUBLIC_RC_ENTITLEMENT_ID || 'premium'
 export const PRIVACY_POLICY_URL = process.env.EXPO_PUBLIC_PRIVACY_POLICY_URL
 export const TERMS_OF_USE_URL = process.env.EXPO_PUBLIC_TERMS_OF_USE_URL
+
+// Route that renders ActiveSubscriptionView, which shows the Paywall when the
+// user is not subscribed. Used to imperatively open the paywall.
+export const SUBSCRIPTION_ROUTE = 'subscription/active'

package/src/containers/SubscriptionHandler.js

@@ -1,7 +1,8 @@
-import React, { createContext, useContext, useEffect, useState } from 'react'
+import React, { createContext, useCallback, useContext, useEffect, useState } from 'react'
 import Purchases from 'react-native-purchases'
+import { useNavigation } from '@react-navigation/native'
 
-import { RC_API_KEY, RC_ENTITLEMENT_ID } from '../config'
+import { RC_API_KEY, RC_ENTITLEMENT_ID, SUBSCRIPTION_ROUTE } from '../config'
 
 const SubscriptionContext = createContext({
   isSubscribed: false,
@@ -20,6 +21,55 @@ export function useIsSubscribed() {
   return useContext(SubscriptionContext).isSubscribed
 }
 
+/**
+ * Returns an action wrapper that only runs when the user is subscribed,
+ * otherwise opens the paywall (navigates to `subscription/active`).
+ *
+ * Two equivalent call styles:
+ *
+ *   const action = useSubscribedAction(fn)   // bind the fn up front
+ *   action(...args)                          // -> fn(...args) if subscribed
+ *
+ *   const action = useSubscribedAction()     // bind nothing
+ *   action(fn, ...args)                      // -> fn(...args) if subscribed
+ *
+ * Returns the result of `fn` when subscribed, or `undefined` when the paywall
+ * is shown instead.
+ */
+export function useSubscribedAction(boundFn) {
+  const { isSubscribed, isLoading } = useSubscription()
+  const { navigate } = useNavigation()
+
+  return useCallback(
+    (...args) => {
+      const fn = boundFn || args[0]
+      const fnArgs = boundFn ? args : args.slice(1)
+
+      if (typeof fn !== 'function') {
+        if (__DEV__) {
+          console.warn(
+            '[neko-rc-subscription] useSubscribedAction: no function to run — ' +
+              'pass it to the hook `useSubscribedAction(fn)` or to the action `action(fn)`.',
+          )
+        }
+        return undefined
+      }
+
+      // Subscription state not resolved yet: no-op rather than wrongly bouncing
+      // an already-subscribed user to the paywall.
+      if (isLoading) return undefined
+
+      if (!isSubscribed) {
+        navigate(SUBSCRIPTION_ROUTE)
+        return undefined
+      }
+
+      return fn(...fnArgs)
+    },
+    [isSubscribed, isLoading, navigate, boundFn],
+  )
+}
+
 export default function SubscriptionHandler({ children, paywallConfig }) {
   const [isSubscribed, setIsSubscribed] = useState(false)
   const [isLoading, setIsLoading] = useState(true)

package/src/containers/SubscriptionRequiredCTA.js

@@ -1,6 +1,7 @@
 import { BlurView, Button, View, useTranslation } from '@neko-os/ui'
 import { useNavigation } from '@react-navigation/native'
 
+import { SUBSCRIPTION_ROUTE } from '../config'
 import { useIsSubscribed } from './SubscriptionHandler'
 
 export default function SubscriptionRequiredCTA({
@@ -20,7 +21,7 @@ export default function SubscriptionRequiredCTA({
   return (
     <View relative hiddenOverflow {...props}>
       {children}
-      <BlurView absoluteFill center zIndex={10} intensity={18} onPress={() => navigate('subscription/active')}>
+      <BlurView absoluteFill center zIndex={10} intensity={18} onPress={() => navigate(SUBSCRIPTION_ROUTE)}>
         {!hideButton && (
           <Button
             label={t('cta.unlock')}
@@ -28,7 +29,7 @@ export default function SubscriptionRequiredCTA({
             yellow
             size={size || 'xs'}
             {...buttonProps}
-            onPress={() => navigate('subscription/active')}
+            onPress={() => navigate(SUBSCRIPTION_ROUTE)}
           />
         )}
       </BlurView>

package/src/index.js

@@ -1,5 +1,5 @@
 export { registerSubscriptionLocales } from './locales/index'
-export { default as SubscriptionHandler, useIsSubscribed, useSubscription } from './containers/SubscriptionHandler'
+export { default as SubscriptionHandler, useIsSubscribed, useSubscribedAction, useSubscription } from './containers/SubscriptionHandler'
 export { default as SubscriptionRequired } from './containers/SubscriptionRequired'
 export { default as SubscriptionRequiredCTA } from './containers/SubscriptionRequiredCTA'
 export { default as Paywall } from './containers/paywall/Paywall'