@wtree/payload-ecommerce-coupon 3.77.6 → 3.77.7

package/README.md

@@ -206,6 +206,123 @@ import { useCouponCode, validateCouponCode, usePartnerStats } from '@wtree/paylo
 - `validateCouponCode({ code, cartValue?, cartID?, customerEmail? })`
 - `usePartnerStats()`
 
+### PartnerDashboard UI component
+
+The package also exports ready-to-use partner dashboard UI components:
+
+```ts
+import {
+  PartnerDashboard,
+  EarningsSummary,
+  ReferralPerformance,
+  RecentReferrals,
+  ReferralCodes,
+  ProgramOverview,
+  CommissionBreakdown,
+} from '@wtree/payload-ecommerce-coupon'
+import '@wtree/payload-ecommerce-coupon/dist/styles.css'
+```
+
+> The dashboard components are client-side React components. Use them in your frontend app (for example, a Next.js client component).
+
+#### Quick usage
+
+```tsx
+'use client'
+
+import { PartnerDashboard } from '@wtree/payload-ecommerce-coupon'
+import '@wtree/payload-ecommerce-coupon/dist/styles.css'
+
+export default function PartnerPage() {
+  return <PartnerDashboard apiEndpoint="/api/referrals/partner-stats" />
+}
+```
+
+#### PartnerDashboard props
+
+```ts
+type PartnerDashboardProps = {
+  showEarningsSummary?: boolean
+  showReferralPerformance?: boolean
+  showRecentReferrals?: boolean
+  showReferralCodes?: boolean
+  showProgramOverview?: boolean
+  showCommissionBreakdown?: boolean
+  apiEndpoint?: string
+}
+```
+
+Example with custom widget visibility:
+
+```tsx
+<PartnerDashboard
+  apiEndpoint="/api/referrals/partner-stats"
+  showEarningsSummary
+  showReferralPerformance
+  showRecentReferrals={false}
+  showReferralCodes
+  showProgramOverview
+  showCommissionBreakdown
+/>
+```
+
+#### Theming and style-guide compatibility
+
+The `PartnerDashboard` styles are tokenized with CSS variables so your app can keep its own design system and branding.
+
+By default, dashboard typography inherits from the host app (`font-family: inherit`) and colors use overridable tokens.
+
+Basic override example:
+
+```css
+.partner-dashboard {
+  --pd-color-text: var(--app-text-color);
+  --pd-color-text-muted: var(--app-text-muted);
+  --pd-color-surface: var(--app-surface);
+  --pd-color-surface-muted: var(--app-surface-muted);
+  --pd-color-border: var(--app-border);
+  --pd-color-primary: var(--app-primary);
+  --pd-color-primary-strong: var(--app-primary-strong);
+  --pd-color-success: var(--app-success);
+  --pd-color-warning: var(--app-warning);
+  --pd-color-danger: var(--app-danger);
+}
+```
+
+You can also set global aliases once:
+
+```css
+:root {
+  --color-text: #111827;
+  --color-text-muted: #6b7280;
+  --color-surface: #ffffff;
+  --color-surface-muted: #f9fafb;
+  --color-border: #e5e7eb;
+  --color-primary: #2563eb;
+  --color-primary-strong: #1d4ed8;
+  --color-primary-soft: #dbeafe;
+  --color-success: #059669;
+  --color-warning: #d97706;
+  --color-danger: #dc2626;
+}
+```
+
+Common dashboard tokens you may override:
+
+- Layout/spacing: `--pd-space-*`, `--pd-grid-min-column`, `--pd-referrals-status-col-width`
+- Typography: `--pd-font-family`, `--pd-font-size-*`, `--pd-font-weight-*`
+- Surfaces/borders: `--pd-color-bg`, `--pd-color-surface`, `--pd-color-surface-muted`, `--pd-color-border`
+- Semantic colors: `--pd-color-primary`, `--pd-color-success`, `--pd-color-warning`, `--pd-color-danger`
+- Widget accents:
+  - `--pd-color-earnings-total-*`
+  - `--pd-color-earnings-pending-*`
+  - `--pd-color-earnings-paid-*`
+  - `--pd-color-status-pending-*`
+  - `--pd-color-status-paid-*`
+  - `--pd-color-status-cancelled-*`
+
+This keeps plugin UI behavior consistent while respecting your product’s style guide.
+
 ---
 
 ## Configuration overview
@@ -361,6 +478,13 @@ Main exports include:
 - `useCouponCode`
 - `validateCouponCode`
 - `usePartnerStats`
+- `PartnerDashboard`
+- `EarningsSummary`
+- `ReferralPerformance`
+- `RecentReferrals`
+- `ReferralCodes`
+- `ProgramOverview`
+- `CommissionBreakdown`
 - `getCartTotalWithDiscounts`
 - `recordCouponUsageForOrder`
 - full TypeScript types for plugin options/policies/integration

package/dist/client/index.d.ts

@@ -3,5 +3,7 @@ export { EarningsSummary } from '../components/PartnerDashboard/EarningsSummary'
 export { RecentReferrals } from '../components/PartnerDashboard/RecentReferrals';
 export { ReferralCodes } from '../components/PartnerDashboard/ReferralCodes';
 export { ReferralPerformance } from '../components/PartnerDashboard/ReferralPerformance';
+export { ProgramOverview } from '../components/PartnerDashboard/ProgramOverview';
+export { CommissionBreakdown } from '../components/PartnerDashboard/CommissionBreakdown';
 export { useCouponCode, usePartnerStats, validateCouponCode } from './hooks';
 //# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAA;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAA;AACxF,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAA;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAA;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAA;AACxF,OAAO,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAA;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAA;AACxF,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA"}

package/dist/components/PartnerDashboard/CommissionBreakdown.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import type { PartnerStats } from '../../types';
+export type CommissionBreakdownProps = {
+    stats: PartnerStats;
+    currency: string;
+};
+export declare const CommissionBreakdown: React.FC<CommissionBreakdownProps>;
+export default CommissionBreakdown;
+//# sourceMappingURL=CommissionBreakdown.d.ts.map

package/dist/components/PartnerDashboard/CommissionBreakdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommissionBreakdown.d.ts","sourceRoot":"","sources":["../../../src/components/PartnerDashboard/CommissionBreakdown.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,YAAY,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAeD,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC,wBAAwB,CA0FlE,CAAA;AAED,eAAe,mBAAmB,CAAA"}

package/dist/components/PartnerDashboard/ProgramOverview.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { PartnerDashboardData } from '../../types';
+export type ProgramOverviewProps = {
+    program: PartnerDashboardData['program'];
+};
+export declare const ProgramOverview: React.FC<ProgramOverviewProps>;
+export default ProgramOverview;
+//# sourceMappingURL=ProgramOverview.d.ts.map

package/dist/components/PartnerDashboard/ProgramOverview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProgramOverview.d.ts","sourceRoot":"","sources":["../../../src/components/PartnerDashboard/ProgramOverview.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAEvD,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,oBAAoB,CAAC,SAAS,CAAC,CAAA;CACzC,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CAmC1D,CAAA;AAED,eAAe,eAAe,CAAA"}

package/dist/components/PartnerDashboard/index.d.ts

@@ -1,10 +1,11 @@
 import React from 'react';
-import './styles.css';
 export type PartnerDashboardProps = {
     showEarningsSummary?: boolean;
     showReferralPerformance?: boolean;
     showRecentReferrals?: boolean;
     showReferralCodes?: boolean;
+    showProgramOverview?: boolean;
+    showCommissionBreakdown?: boolean;
     apiEndpoint?: string;
 };
 export declare const PartnerDashboard: React.FC<PartnerDashboardProps>;

package/dist/components/PartnerDashboard/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/PartnerDashboard/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAA8B,MAAM,OAAO,CAAA;AASlD,OAAO,cAAc,CAAA;AAErB,MAAM,MAAM,qBAAqB,GAAG;IAClC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,KAAK,CAAC,EAAE,CAAC,qBAAqB,CAqH5D,CAAA;AAED,eAAe,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/PartnerDashboard/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAA8B,MAAM,OAAO,CAAA;AAWlD,MAAM,MAAM,qBAAqB,GAAG;IAClC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,KAAK,CAAC,EAAE,CAAC,qBAAqB,CA2H5D,CAAA;AAED,eAAe,gBAAgB,CAAA"}

package/dist/index.d.ts

@@ -3,6 +3,13 @@ import { createReferralCodesCollection } from './collections/createReferralCodes
 import { createReferralProgramsCollection } from './collections/createReferralProgramsCollection';
 import { payloadEcommerceCouponPlugin } from './plugin';
 export { useCouponCode, usePartnerStats, validateCouponCode } from './client/hooks';
+export { PartnerDashboard } from './components/PartnerDashboard';
+export { EarningsSummary } from './components/PartnerDashboard/EarningsSummary';
+export { RecentReferrals } from './components/PartnerDashboard/RecentReferrals';
+export { ReferralCodes } from './components/PartnerDashboard/ReferralCodes';
+export { ReferralPerformance } from './components/PartnerDashboard/ReferralPerformance';
+export { ProgramOverview } from './components/PartnerDashboard/ProgramOverview';
+export { CommissionBreakdown } from './components/PartnerDashboard/CommissionBreakdown';
 export { calculateCommissionAndDiscount, getProgramMinimumOrderAmount, } from './utilities/calculateValues';
 export { getCartTotalWithDiscounts } from './utilities/getCartTotalWithDiscounts';
 export { recordCouponUsageForOrder } from './utilities/recordCouponUsageForOrder';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAA;AAC/E,OAAO,EAAE,6BAA6B,EAAE,MAAM,6CAA6C,CAAA;AAC3F,OAAO,EAAE,gCAAgC,EAAE,MAAM,gDAAgD,CAAA;AACjG,OAAO,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAA;AAEvD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACnF,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,GAC7B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAA;AACjF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAA;AACjF,OAAO,EACL,uBAAuB,EACvB,6BAA6B,EAC7B,gCAAgC,EAChC,4BAA4B,IAAI,sBAAsB,GACvD,CAAA;AAED,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,kBAAkB,EAClB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,YAAY,EACZ,yBAAyB,EACzB,4BAA4B,EAC5B,uBAAuB,EACvB,uBAAuB,EACvB,0BAA0B,EAC1B,aAAa,EACb,6BAA6B,EAC7B,qBAAqB,EACrB,UAAU,GACX,MAAM,SAAS,CAAA;AAChB,YAAY,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAA;AAC/E,OAAO,EAAE,6BAA6B,EAAE,MAAM,6CAA6C,CAAA;AAC3F,OAAO,EAAE,gCAAgC,EAAE,MAAM,gDAAgD,CAAA;AACjG,OAAO,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAA;AAEvD,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACnF,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,+CAA+C,CAAA;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,+CAA+C,CAAA;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,6CAA6C,CAAA;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,mDAAmD,CAAA;AACvF,OAAO,EAAE,eAAe,EAAE,MAAM,+CAA+C,CAAA;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,mDAAmD,CAAA;AAEvF,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,GAC7B,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAA;AACjF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAA;AACjF,OAAO,EACL,uBAAuB,EACvB,6BAA6B,EAC7B,gCAAgC,EAChC,4BAA4B,IAAI,sBAAsB,GACvD,CAAA;AAED,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,kBAAkB,EAClB,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,YAAY,EACZ,yBAAyB,EACzB,4BAA4B,EAC5B,uBAAuB,EACvB,uBAAuB,EACvB,0BAA0B,EAC1B,aAAa,EACb,6BAA6B,EAC7B,qBAAqB,EACrB,UAAU,GACX,MAAM,SAAS,CAAA;AAChB,YAAY,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAA"}