@fayz-ai/plugin-courses 0.2.4 → 0.8.1

package/README.md

@@ -1,6 +1,6 @@
 # @fayz-ai/plugin-courses
 
-> **Status: experimental (incubating).** Not capability-complete — missing some or all of the capability bar (data-provider contract w/ supabase+mock pair, entity registries, settings, migrations; see `PLUGIN_PATTERNS.md`). Fine to explore in dogfoods; NOT ready for fresh installs or generated apps, and its API may change without notice.
+> **Status: experimental (incubating).** Not capability-complete — missing some or all of the capability bar (data-provider contract w/ supabase+mock pair, entity registries, settings, migrations; see `docs/PLUGIN-PATTERNS.md`). Fine to explore in dogfoods; NOT ready for fresh installs or generated apps, and its API may change without notice.
 
 > Drop a course-builder admin into any Fayz SaaS — courses, modules, lessons, enrollments.
 

package/dist/dashboardWidgets.d.ts

@@ -1,3 +1,10 @@
 import type { DashboardWidgetDef } from '@fayz-ai/core';
-export declare 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 declare function createCoursesDashboardWidgets(modules?: {
+    sales?: boolean;
+    subscriptions?: boolean;
+    financial?: boolean;
+}): DashboardWidgetDef[];
 //# sourceMappingURL=dashboardWidgets.d.ts.map

package/dist/dashboardWidgets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dashboardWidgets.d.ts","sourceRoot":"","sources":["../src/dashboardWidgets.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AA0CvD,wBAAgB,6BAA6B,IAAI,kBAAkB,EAAE,CAOpE"}
+{"version":3,"file":"dashboardWidgets.d.ts","sourceRoot":"","sources":["../src/dashboardWidgets.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AA0CvD;;2EAE2E;AAC3E,wBAAgB,6BAA6B,CAC3C,OAAO,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAAO,GAC9E,kBAAkB,EAAE,CAetB"}

package/dist/index.cjs

@@ -336,6 +336,8 @@ function CoursesListPage() {
   const shellOwnsHeader = ui.useModuleLayout() === "tabs";
   const [courses$1, setCourses] = React2__namespace.useState(null);
   const [creating, setCreating] = React2__namespace.useState(false);
+  const guardCourses = saas.useLimitGuard("courses");
+  const can = saas.usePermissionOptional();
   const load = React2__namespace.useCallback(async () => {
     setCourses(await courses.getCoursesProvider().listCourses());
   }, []);
@@ -343,24 +345,27 @@ function CoursesListPage() {
     void load();
   }, [load]);
   async function onCreate() {
+    if (!can("courses", "create")) return;
+    if (await guardCourses() === "blocked") return;
     setCreating(true);
     try {
       const course = await courses.getCoursesProvider().createCourse({
         title: t("courses.editor.untitledCourse") || "Untitled course",
         status: "draft"
       });
+      saas.invalidateLimit("courses");
       navigateTo(`/courses/${course.id}`);
     } finally {
       setCreating(false);
     }
   }
   return /* @__PURE__ */ jsxRuntime.jsxs("div", { className: "mx-auto max-w-6xl p-6 md:p-8", children: [
-    shellOwnsHeader ? /* @__PURE__ */ jsxRuntime.jsx(ui.PageHeaderActions, { children: /* @__PURE__ */ jsxRuntime.jsx(ui.Button, { onClick: onCreate, disabled: creating, children: t("courses.new") || "New course" }) }) : /* @__PURE__ */ jsxRuntime.jsxs("div", { className: "mb-6 flex items-center justify-between", children: [
+    shellOwnsHeader ? /* @__PURE__ */ jsxRuntime.jsx(ui.PageHeaderActions, { children: /* @__PURE__ */ jsxRuntime.jsx(saas.PermissionGate, { feature: "courses", action: "create", children: /* @__PURE__ */ jsxRuntime.jsx(ui.Button, { onClick: onCreate, disabled: creating, children: t("courses.new") || "New course" }) }) }) : /* @__PURE__ */ jsxRuntime.jsxs("div", { className: "mb-6 flex items-center justify-between", children: [
       /* @__PURE__ */ jsxRuntime.jsxs("div", { children: [
         /* @__PURE__ */ jsxRuntime.jsx("h1", { className: "text-2xl font-bold text-foreground", children: t("courses.title") || "Courses" }),
         courses$1 && /* @__PURE__ */ jsxRuntime.jsx("p", { className: "mt-1 text-sm text-muted-foreground", children: (t("courses.count") || "{count} courses").replace("{count}", String(courses$1.length)) })
       ] }),
-      /* @__PURE__ */ jsxRuntime.jsx(ui.Button, { onClick: onCreate, disabled: creating, children: t("courses.new") || "New course" })
+      /* @__PURE__ */ jsxRuntime.jsx(saas.PermissionGate, { feature: "courses", action: "create", children: /* @__PURE__ */ jsxRuntime.jsx(ui.Button, { onClick: onCreate, disabled: creating, children: t("courses.new") || "New course" }) })
     ] }),
     courses$1 && courses$1.length === 0 && /* @__PURE__ */ jsxRuntime.jsx("div", { className: "rounded-xl border border-dashed border-border p-12 text-center text-muted-foreground", children: t("courses.empty") || "No courses yet. Create your first one." }),
     /* @__PURE__ */ jsxRuntime.jsx("div", { className: "grid grid-cols-1 gap-4 sm:grid-cols-2 lg:grid-cols-3", children: courses$1?.map((course) => /* @__PURE__ */ jsxRuntime.jsxs(
@@ -974,12 +979,14 @@ function FeesKpi() {
   const s = useSummary();
   return /* @__PURE__ */ jsxRuntime.jsx(ui.KpiCard, { label: t("courses.kpi.fees") || "Platform fees", icon: "Percent", loading: !s, value: s ? formatMoney(s.platformFeeTotal, s.currency) : void 0 });
 }
-function createCoursesDashboardWidgets() {
+function createCoursesDashboardWidgets(modules = {}) {
   return [
-    ui.defineKpiWidget({ id: "courses.kpi.revenue", title: "courses.kpi.revenue", domain: "courses", defaultOrder: 0, component: RevenueKpi }),
-    ui.defineKpiWidget({ id: "courses.kpi.sales", title: "courses.kpi.sales", domain: "courses", defaultOrder: 1, component: SalesKpi }),
-    ui.defineKpiWidget({ id: "courses.kpi.mrr", title: "courses.kpi.mrr", domain: "courses", defaultOrder: 2, component: MrrKpi }),
-    ui.defineKpiWidget({ id: "courses.kpi.fees", title: "courses.kpi.fees", domain: "courses", defaultOrder: 3, component: FeesKpi })
+    ...modules.sales ? [
+      ui.defineKpiWidget({ id: "courses.kpi.revenue", title: "courses.kpi.revenue", domain: "courses", defaultOrder: 0, component: RevenueKpi }),
+      ui.defineKpiWidget({ id: "courses.kpi.sales", title: "courses.kpi.sales", domain: "courses", defaultOrder: 1, component: SalesKpi })
+    ] : [],
+    ...modules.subscriptions ? [ui.defineKpiWidget({ id: "courses.kpi.mrr", title: "courses.kpi.mrr", domain: "courses", defaultOrder: 2, component: MrrKpi })] : [],
+    ...modules.financial ? [ui.defineKpiWidget({ id: "courses.kpi.fees", title: "courses.kpi.fees", domain: "courses", defaultOrder: 3, component: FeesKpi })] : []
   ];
 }
 function createStripeConnector() {
@@ -1019,6 +1026,27 @@ function createCoursesPlugin(options) {
   }
   const base = options?.navPosition ?? 1;
   const section = options?.navSection ?? "main";
+  const modules = options?.modules ?? {};
+  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",
     name: options?.navLabel ?? "Courses",
@@ -1026,6 +1054,10 @@ function createCoursesPlugin(options) {
     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: [
@@ -1033,27 +1065,15 @@ function createCoursesPlugin(options) {
       { 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") }