@abra-promotions/webhooks-for-tapcart 1.0.1

package/README.md

@@ -0,0 +1,75 @@
+# @abra/tapcart-webhooks
+
+Abra Tapcart webhook integrations for promotions, cart management, and activation.
+
+## Installation
+
+```bash
+npm install @abra/tapcart-webhooks
+```
+
+## Usage
+
+useTapcart, and tapcartData are properties provided by tapcart for every block.
+
+### useAbra
+
+Main hook for Abra promotion logic, use it within tapcart to parse any product into it's discounted version.
+
+```javascript
+import { useAbra } from "@abra/tapcart-webhooks";
+
+const MyComponent = ({ useTapcart, tapcartData }) => {
+  //Initialize
+  const { abra } = useAbra({ useTapcart, tapcartData });
+
+  // Use  for promotion logic
+  const productWithDiscountedPrice = abra.getProductWithDiscount(product);
+  return <div>...</div>;
+};
+```
+
+### useAbraActivate
+
+Hook for activation logic, add it to the homepage, will enable and disable promotions
+
+```javascript
+import { useAbraActivate } from "@abra/tapcart-webhooks";
+
+const MyComponent = ({ useTapcart, tapcartData }) => {
+  useAbraActivate({
+    useTapcart,
+    tapcartData,
+    discountCode, // (Optional) used for activating private promotions
+    displayToast, // (Optional) whether will show a banner after a promotion is activated
+    redirectPath, // (Optional) Wheather it should redirect to a specific page after activating
+    testDeviceId, // (Optional) Allows activating test promotion code on this device
+    testPromotionCode, // (Optional) Code that will activate on test device
+    autoApplyDiscount, // (Optional) Make it false for automatic discounts
+  });
+
+  return <div>...</div>;
+};
+```
+
+### useAbraCart / AbraCartBlock
+
+Cart-specific functionality: control discounts, attributes and gift items. load it in the cart page.
+
+```javascript
+import { useAbraCart } from "@abra/tapcart-webhooks";
+
+const CartComponent = ({ useTapcart, tapcartData }) => {
+  useAbraCart({ useTapcart, tapcartData });
+  return <div>...</div>;
+};
+```
+
+## Requirements
+
+- React 16.8+
+- @tapcart/mobile-components ^0.7.25
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+interface TapcartData {
+  integrations?: Array<{
+    name: string;
+    storeFrontAccessToken?: string;
+    storeUrl?: string;
+  }>;
+  appId?: string;
+}
+
+interface TapcartActions {
+  action?: (
+    type: string,
+    data: any,
+    callbacks?: {
+      onSuccess?: (result: any) => void;
+      onError?: (error: Error) => void;
+    },
+  ) => void;
+  actions?: any;
+  variables?: any;
+}
+
+interface UseAbraProps {
+  useTapcart: () => TapcartActions;
+  tapcartData: TapcartData;
+}
+
+interface UseAbraActivateProps {
+  useTapcart: () => TapcartActions;
+  tapcartData: TapcartData;
+  testMode?: boolean;
+  testDeviceIds?: string[];
+  showBanner?: boolean;
+  autoApplyDiscount?: boolean;
+}
+
+interface UseAbraCartProps {
+  useTapcart: () => TapcartActions;
+  tapcartData: TapcartData;
+  addGiftOncePerSession?: boolean;
+}
+
+declare function useAbra(props: UseAbraProps): any;
+declare function useAbraActivate(props: UseAbraActivateProps): any;
+declare function useAbraCart(props: UseAbraCartProps): any;
+
+export { useAbra, useAbraActivate, useAbraCart };
+export type { TapcartActions, TapcartData, UseAbraActivateProps, UseAbraCartProps, UseAbraProps };