@fayz-ai/plugin-courses 0.2.4 → 0.8.1

package/dist/pages/CoursesListPage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CoursesListPage.d.ts","sourceRoot":"","sources":["../../src/pages/CoursesListPage.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAY9B,wBAAgB,eAAe,sBA2F9B;yBA3Fe,eAAe"}
+{"version":3,"file":"CoursesListPage.d.ts","sourceRoot":"","sources":["../../src/pages/CoursesListPage.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAa9B,wBAAgB,eAAe,sBAuG9B;yBAvGe,eAAe"}

package/dist/pages/FinancialPage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FinancialPage.d.ts","sourceRoot":"","sources":["../../src/pages/FinancialPage.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAO9B,wBAAgB,aAAa,sBAmE5B;yBAnEe,aAAa"}
+{"version":3,"file":"FinancialPage.d.ts","sourceRoot":"","sources":["../../src/pages/FinancialPage.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAY9B,wBAAgB,aAAa,sBAmE5B;yBAnEe,aAAa"}

package/package.json

@@ -1,6 +1,9 @@
 {
   "name": "@fayz-ai/plugin-courses",
-  "version": "0.2.4",
+  "fayz": {
+    "status": "preview"
+  },
+  "version": "0.8.1",
   "description": "[experimental] Fayz SDK — courses admin management plugin",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -23,12 +26,12 @@
     "react-dom": "^18.0.0 || ^19.0.0"
   },
   "dependencies": {
-    "@tanstack/react-table": "^8.20.0",
     "lucide-react": "^0.400.0",
-    "@fayz-ai/core": "^0.6.0",
-    "@fayz-ai/ui": "^0.6.0",
-    "@fayz-ai/saas": "^0.6.0",
-    "@fayz-ai/courses": "^0.7.1"
+    "@tanstack/react-table": "^8.20.0",
+    "@fayz-ai/saas": "^0.8.2",
+    "@fayz-ai/core": "^0.8.2",
+    "@fayz-ai/ui": "^0.8.1",
+    "@fayz-ai/courses": "^0.8.0"
   },
   "devDependencies": {
     "@types/react": "^18.3.0",

package/src/dashboardWidgets.tsx

@@ -41,11 +41,24 @@ function FeesKpi() {
   return <KpiCard label={t('courses.kpi.fees') || 'Platform fees'} icon="Percent" loading={!s} value={s ? formatMoney(s.platformFeeTotal, s.currency) : undefined} />
 }
 
-export function createCoursesDashboardWidgets(): DashboardWidgetDef[] {
+/** Commerce KPIs are contributed only for the modules the host opted into —
+ *  a host embedding courses as a lightweight members feature must not get
+ *  revenue/MRR cards broadcast onto its home dashboard (FAY-1247 rule). */
+export function createCoursesDashboardWidgets(
+  modules: { sales?: boolean; subscriptions?: boolean; financial?: boolean } = {},
+): DashboardWidgetDef[] {
   return [
-    defineKpiWidget({ id: 'courses.kpi.revenue', title: 'courses.kpi.revenue', domain: 'courses', defaultOrder: 0, component: RevenueKpi }),
-    defineKpiWidget({ id: 'courses.kpi.sales', title: 'courses.kpi.sales', domain: 'courses', defaultOrder: 1, component: SalesKpi }),
-    defineKpiWidget({ id: 'courses.kpi.mrr', title: 'courses.kpi.mrr', domain: 'courses', defaultOrder: 2, component: MrrKpi }),
-    defineKpiWidget({ id: 'courses.kpi.fees', title: 'courses.kpi.fees', domain: 'courses', defaultOrder: 3, component: FeesKpi }),
+    ...(modules.sales
+      ? [
+          defineKpiWidget({ id: 'courses.kpi.revenue', title: 'courses.kpi.revenue', domain: 'courses', defaultOrder: 0, component: RevenueKpi }),
+          defineKpiWidget({ id: 'courses.kpi.sales', title: 'courses.kpi.sales', domain: 'courses', defaultOrder: 1, component: SalesKpi }),
+        ]
+      : []),
+    ...(modules.subscriptions
+      ? [defineKpiWidget({ id: 'courses.kpi.mrr', title: 'courses.kpi.mrr', domain: 'courses', defaultOrder: 2, component: MrrKpi })]
+      : []),
+    ...(modules.financial
+      ? [defineKpiWidget({ id: 'courses.kpi.fees', title: 'courses.kpi.fees', domain: 'courses', defaultOrder: 3, component: FeesKpi })]
+      : []),
   ]
 }

package/src/index.ts

@@ -33,8 +33,30 @@ export interface CoursesPluginOptions {
   navPosition?: number
   navSection?: 'main' | 'secondary' | 'settings'
   navLabel?: string
+  /** Nav labels for the module entries (default English). */
+  labels?: {
+    membersArea?: string
+    sales?: string
+    subscriptions?: string
+    financial?: string
+    reports?: string
+  }
   scope?: PluginScope
   verticalId?: VerticalId
+  /**
+   * Commerce-vertical modules — ALL OFF by default (the one architectural
+   * rule: shared-surface contributions are opt-in, never broadcast — FAY-1247).
+   * course-admin (the vertical owner) enables everything via its PluginRef
+   * config; a host embedding courses as a lightweight members feature (e.g.
+   * agency-os's "Memberships") gets only the base nav entry + editor.
+   */
+  modules?: {
+    membersArea?: boolean
+    sales?: boolean
+    subscriptions?: boolean
+    financial?: boolean
+    reports?: boolean
+  }
 }
 
 const asComp = (c: unknown) => c as React.ComponentType<unknown>
@@ -56,6 +78,31 @@ export function createCoursesPlugin(options?: CoursesPluginOptions): PluginManif
 
   const base = options?.navPosition ?? 1
   const section = options?.navSection ?? 'main'
+  const modules = options?.modules ?? {}
+
+  // Opt-in nav/routes per module. Position offsets stay stable relative to the
+  // enabled set so hosts control exactly where the block sits.
+  const labels = options?.labels ?? {}
+  const navigation = [
+    { section, position: base, label: options?.navLabel ?? 'Courses', route: '/courses', icon: 'BookOpen', permission: read('courses') },
+    ...(modules.membersArea ? [{ section, position: base + 1, label: labels.membersArea ?? 'Members area', route: '/courses/members', icon: 'GraduationCap', permission: read('courses') }] : []),
+    ...(modules.sales ? [{ section, position: base + 2, label: labels.sales ?? 'Sales', route: '/courses/sales', icon: 'TrendingUp', permission: read('courses.sales') }] : []),
+    ...(modules.subscriptions ? [{ section, position: base + 3, label: labels.subscriptions ?? 'Subscriptions', route: '/courses/subscriptions', icon: 'Repeat', permission: read('courses.sales') }] : []),
+    ...(modules.financial ? [{ section, position: base + 4, label: labels.financial ?? 'Financial', route: '/courses/financial', icon: 'CreditCard', permission: read('courses.finance') }] : []),
+    ...(modules.reports ? [{ section, position: base + 5, label: labels.reports ?? 'Reports', route: '/courses/reports', icon: 'BarChart3', permission: read('courses.sales') }] : []),
+  ]
+
+  const routes = [
+    // Static segments outscore the `:id` param in the saas router, so these
+    // resolve before the editor route (AdminShell sorts by routeScore).
+    { path: '/courses', component: asComp(CoursesListPage), permission: read('courses') },
+    ...(modules.membersArea ? [{ path: '/courses/members', component: asComp(MembersAreaPage), permission: read('courses') }] : []),
+    ...(modules.sales ? [{ path: '/courses/sales', component: asComp(SalesPage), permission: read('courses.sales') }] : []),
+    ...(modules.subscriptions ? [{ path: '/courses/subscriptions', component: asComp(SubscriptionsPage), permission: read('courses.sales') }] : []),
+    ...(modules.financial ? [{ path: '/courses/financial', component: asComp(FinancialPage), permission: read('courses.finance') }] : []),
+    ...(modules.reports ? [{ path: '/courses/reports', component: asComp(ReportsPage), permission: read('courses.sales') }] : []),
+    { path: '/courses/:id', component: asComp(CourseEditorPage) },
+  ]
 
   return {
     id: 'courses',
@@ -64,6 +111,10 @@ export function createCoursesPlugin(options?: CoursesPluginOptions): PluginManif
     version: '1.0.0',
     scope: options?.scope ?? 'vertical',
     verticalId: options?.verticalId,
+    // LMS is its own business model with opt-in commerce modules
+    // (members/sales/subscriptions — see modules.* below) — targets the
+    // saas/admin Panel world rather than the ecommerce storefront.
+    scaffolds: ['saas'],
     defaultEnabled: true,
     dependencies: [],
     declaredFeatures: [
@@ -71,27 +122,15 @@ export function createCoursesPlugin(options?: CoursesPluginOptions): PluginManif
       { id: 'courses.sales', label: 'Sales', group: 'Courses' },
       { id: 'courses.finance', label: 'Financial', group: 'Courses' },
     ],
-    navigation: [
-      { section, position: base, label: options?.navLabel ?? 'Courses', route: '/courses', icon: 'BookOpen', permission: read('courses') },
-      { section, position: base + 1, label: 'Members area', route: '/courses/members', icon: 'GraduationCap', permission: read('courses') },
-      { section, position: base + 2, label: 'Sales', route: '/courses/sales', icon: 'TrendingUp', permission: read('courses.sales') },
-      { section, position: base + 3, label: 'Subscriptions', route: '/courses/subscriptions', icon: 'Repeat', permission: read('courses.sales') },
-      { section, position: base + 4, label: 'Financial', route: '/courses/financial', icon: 'CreditCard', permission: read('courses.finance') },
-      { section, position: base + 5, label: 'Reports', route: '/courses/reports', icon: 'BarChart3', permission: read('courses.sales') },
-    ],
-    routes: [
-      // Static segments outscore the `:id` param in the saas router, so these
-      // resolve before the editor route (AdminShell sorts by routeScore).
-      { path: '/courses', component: asComp(CoursesListPage), permission: read('courses') },
-      { path: '/courses/members', component: asComp(MembersAreaPage), permission: read('courses') },
-      { path: '/courses/sales', component: asComp(SalesPage), permission: read('courses.sales') },
-      { path: '/courses/subscriptions', component: asComp(SubscriptionsPage), permission: read('courses.sales') },
-      { path: '/courses/financial', component: asComp(FinancialPage), permission: read('courses.finance') },
-      { path: '/courses/reports', component: asComp(ReportsPage), permission: read('courses.sales') },
-      { path: '/courses/:id', component: asComp(CourseEditorPage) },
+    declaredLimits: [
+      { key: 'courses', label: 'Courses', table: 'plg_courses_courses' },
     ],
+    navigation,
+    routes,
     widgets: [],
-    dashboardWidgets: createCoursesDashboardWidgets(),
+    // Commerce KPIs on the shared 'home' surface follow the same opt-in rule:
+    // no module enabled → no widgets broadcast into a host's dashboard.
+    dashboardWidgets: createCoursesDashboardWidgets(modules),
     connectors: [createStripeConnector()],
     settings: [
       { id: 'courses', label: 'Courses', icon: 'BookOpen', component: asComp(CoursesSettingsTab), order: 20, permission: read('courses') },

package/src/pages/CoursesListPage.tsx

@@ -2,6 +2,7 @@ import * as React from 'react'
 import { Button, Badge, PageHeaderActions, useModuleLayout } from '@fayz-ai/ui'
 import { useTranslation } from '@fayz-ai/core'
 import { getCoursesProvider, type Course } from '@fayz-ai/courses'
+import { useLimitGuard, invalidateLimit, PermissionGate, usePermissionOptional } from '@fayz-ai/saas'
 import { navigateTo } from '../nav'
 
 function statusVariant(status: Course['status']): 'success' | 'secondary' | 'outline' {
@@ -17,6 +18,8 @@ export function CoursesListPage() {
   const shellOwnsHeader = useModuleLayout() === 'tabs'
   const [courses, setCourses] = React.useState<Course[] | null>(null)
   const [creating, setCreating] = React.useState(false)
+  const guardCourses = useLimitGuard('courses')
+  const can = usePermissionOptional()
 
   const load = React.useCallback(async () => {
     setCourses(await getCoursesProvider().listCourses())
@@ -27,12 +30,18 @@ export function CoursesListPage() {
   }, [load])
 
   async function onCreate() {
+    // Defense in depth: never create without the role's `create` action.
+    if (!can('courses', 'create')) return
+    // Plan quantity guard (client-side, before the provider call). Opens the
+    // global UpgradeModal and aborts when the plan's course cap is reached.
+    if ((await guardCourses()) === 'blocked') return
     setCreating(true)
     try {
       const course = await getCoursesProvider().createCourse({
         title: t('courses.editor.untitledCourse') || 'Untitled course',
         status: 'draft',
       })
+      invalidateLimit('courses')
       navigateTo(`/courses/${course.id}`)
     } finally {
       setCreating(false)
@@ -43,9 +52,11 @@ export function CoursesListPage() {
     <div className="mx-auto max-w-6xl p-6 md:p-8">
       {shellOwnsHeader ? (
         <PageHeaderActions>
-          <Button onClick={onCreate} disabled={creating}>
-            {t('courses.new') || 'New course'}
-          </Button>
+          <PermissionGate feature="courses" action="create">
+            <Button onClick={onCreate} disabled={creating}>
+              {t('courses.new') || 'New course'}
+            </Button>
+          </PermissionGate>
         </PageHeaderActions>
       ) : (
         <div className="mb-6 flex items-center justify-between">
@@ -57,9 +68,11 @@ export function CoursesListPage() {
               </p>
             )}
           </div>
-          <Button onClick={onCreate} disabled={creating}>
-            {t('courses.new') || 'New course'}
-          </Button>
+          <PermissionGate feature="courses" action="create">
+            <Button onClick={onCreate} disabled={creating}>
+              {t('courses.new') || 'New course'}
+            </Button>
+          </PermissionGate>
         </div>
       )}
 

package/src/pages/FinancialPage.tsx

@@ -5,6 +5,11 @@ import { getCoursesProvider, type Payout, type FinancialSummary, type CreatorAcc
 import { PageContainer, StatCard, StatGrid, SimpleTable, type SimpleColumn } from '../components/CommerceUI'
 import { formatMoney, formatDate, formatPercent } from '../lib/format'
 
+// No plan gate here on purpose. The page is registered as a shell ROUTE with
+// `permission: read('courses.finance')`, so the route guard already resolves
+// role AND plan for it — and whether `courses.finance` is a paid feature is the
+// APP's call (its billing.ts), never the plugin's. Hardcoding a gate here would
+// bake one product's packaging into the SDK.
 export function FinancialPage() {
   const t = useTranslation()
   const [summary, setSummary] = React.useState<FinancialSummary | null>(null)