@fayz-ai/plugin-courses 0.2.3 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dashboardWidgets.d.ts +8 -1
- package/dist/dashboardWidgets.d.ts.map +1 -1
- package/dist/index.cjs +36 -25
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +14 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +38 -27
- package/dist/index.js.map +1 -1
- package/package.json +9 -6
- package/src/dashboardWidgets.tsx +18 -5
- package/src/index.ts +47 -20
|
@@ -1,3 +1,10 @@
|
|
|
1
1
|
import type { DashboardWidgetDef } from '@fayz-ai/core';
|
|
2
|
-
|
|
2
|
+
/** Commerce KPIs are contributed only for the modules the host opted into —
|
|
3
|
+
* a host embedding courses as a lightweight members feature must not get
|
|
4
|
+
* revenue/MRR cards broadcast onto its home dashboard (FAY-1247 rule). */
|
|
5
|
+
export declare function createCoursesDashboardWidgets(modules?: {
|
|
6
|
+
sales?: boolean;
|
|
7
|
+
subscriptions?: boolean;
|
|
8
|
+
financial?: boolean;
|
|
9
|
+
}): DashboardWidgetDef[];
|
|
3
10
|
//# sourceMappingURL=dashboardWidgets.d.ts.map
|
|
@@ -1 +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,
|
|
1
|
+
{"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
CHANGED
|
@@ -974,12 +974,14 @@ function FeesKpi() {
|
|
|
974
974
|
const s = useSummary();
|
|
975
975
|
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 });
|
|
976
976
|
}
|
|
977
|
-
function createCoursesDashboardWidgets() {
|
|
977
|
+
function createCoursesDashboardWidgets(modules = {}) {
|
|
978
978
|
return [
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
979
|
+
...modules.sales ? [
|
|
980
|
+
ui.defineKpiWidget({ id: "courses.kpi.revenue", title: "courses.kpi.revenue", domain: "courses", defaultOrder: 0, component: RevenueKpi }),
|
|
981
|
+
ui.defineKpiWidget({ id: "courses.kpi.sales", title: "courses.kpi.sales", domain: "courses", defaultOrder: 1, component: SalesKpi })
|
|
982
|
+
] : [],
|
|
983
|
+
...modules.subscriptions ? [ui.defineKpiWidget({ id: "courses.kpi.mrr", title: "courses.kpi.mrr", domain: "courses", defaultOrder: 2, component: MrrKpi })] : [],
|
|
984
|
+
...modules.financial ? [ui.defineKpiWidget({ id: "courses.kpi.fees", title: "courses.kpi.fees", domain: "courses", defaultOrder: 3, component: FeesKpi })] : []
|
|
983
985
|
];
|
|
984
986
|
}
|
|
985
987
|
function createStripeConnector() {
|
|
@@ -1019,6 +1021,26 @@ function createCoursesPlugin(options) {
|
|
|
1019
1021
|
}
|
|
1020
1022
|
const base = options?.navPosition ?? 1;
|
|
1021
1023
|
const section = options?.navSection ?? "main";
|
|
1024
|
+
const modules = options?.modules ?? {};
|
|
1025
|
+
const navigation = [
|
|
1026
|
+
{ section, position: base, label: options?.navLabel ?? "Courses", route: "/courses", icon: "BookOpen", permission: read("courses") },
|
|
1027
|
+
...modules.membersArea ? [{ section, position: base + 1, label: "Members area", route: "/courses/members", icon: "GraduationCap", permission: read("courses") }] : [],
|
|
1028
|
+
...modules.sales ? [{ section, position: base + 2, label: "Sales", route: "/courses/sales", icon: "TrendingUp", permission: read("courses.sales") }] : [],
|
|
1029
|
+
...modules.subscriptions ? [{ section, position: base + 3, label: "Subscriptions", route: "/courses/subscriptions", icon: "Repeat", permission: read("courses.sales") }] : [],
|
|
1030
|
+
...modules.financial ? [{ section, position: base + 4, label: "Financial", route: "/courses/financial", icon: "CreditCard", permission: read("courses.finance") }] : [],
|
|
1031
|
+
...modules.reports ? [{ section, position: base + 5, label: "Reports", route: "/courses/reports", icon: "BarChart3", permission: read("courses.sales") }] : []
|
|
1032
|
+
];
|
|
1033
|
+
const routes = [
|
|
1034
|
+
// Static segments outscore the `:id` param in the saas router, so these
|
|
1035
|
+
// resolve before the editor route (AdminShell sorts by routeScore).
|
|
1036
|
+
{ path: "/courses", component: asComp(CoursesListPage), permission: read("courses") },
|
|
1037
|
+
...modules.membersArea ? [{ path: "/courses/members", component: asComp(MembersAreaPage), permission: read("courses") }] : [],
|
|
1038
|
+
...modules.sales ? [{ path: "/courses/sales", component: asComp(SalesPage), permission: read("courses.sales") }] : [],
|
|
1039
|
+
...modules.subscriptions ? [{ path: "/courses/subscriptions", component: asComp(SubscriptionsPage), permission: read("courses.sales") }] : [],
|
|
1040
|
+
...modules.financial ? [{ path: "/courses/financial", component: asComp(FinancialPage), permission: read("courses.finance") }] : [],
|
|
1041
|
+
...modules.reports ? [{ path: "/courses/reports", component: asComp(ReportsPage), permission: read("courses.sales") }] : [],
|
|
1042
|
+
{ path: "/courses/:id", component: asComp(CourseEditorPage) }
|
|
1043
|
+
];
|
|
1022
1044
|
return {
|
|
1023
1045
|
id: "courses",
|
|
1024
1046
|
name: options?.navLabel ?? "Courses",
|
|
@@ -1026,6 +1048,10 @@ function createCoursesPlugin(options) {
|
|
|
1026
1048
|
version: "1.0.0",
|
|
1027
1049
|
scope: options?.scope ?? "vertical",
|
|
1028
1050
|
verticalId: options?.verticalId,
|
|
1051
|
+
// LMS is its own business model with opt-in commerce modules
|
|
1052
|
+
// (members/sales/subscriptions — see modules.* below) — targets the
|
|
1053
|
+
// saas/admin Panel world rather than the ecommerce storefront.
|
|
1054
|
+
scaffolds: ["saas"],
|
|
1029
1055
|
defaultEnabled: true,
|
|
1030
1056
|
dependencies: [],
|
|
1031
1057
|
declaredFeatures: [
|
|
@@ -1033,27 +1059,12 @@ function createCoursesPlugin(options) {
|
|
|
1033
1059
|
{ id: "courses.sales", label: "Sales", group: "Courses" },
|
|
1034
1060
|
{ id: "courses.finance", label: "Financial", group: "Courses" }
|
|
1035
1061
|
],
|
|
1036
|
-
navigation
|
|
1037
|
-
|
|
1038
|
-
{ section, position: base + 1, label: "Members area", route: "/courses/members", icon: "GraduationCap", permission: read("courses") },
|
|
1039
|
-
{ section, position: base + 2, label: "Sales", route: "/courses/sales", icon: "TrendingUp", permission: read("courses.sales") },
|
|
1040
|
-
{ section, position: base + 3, label: "Subscriptions", route: "/courses/subscriptions", icon: "Repeat", permission: read("courses.sales") },
|
|
1041
|
-
{ section, position: base + 4, label: "Financial", route: "/courses/financial", icon: "CreditCard", permission: read("courses.finance") },
|
|
1042
|
-
{ section, position: base + 5, label: "Reports", route: "/courses/reports", icon: "BarChart3", permission: read("courses.sales") }
|
|
1043
|
-
],
|
|
1044
|
-
routes: [
|
|
1045
|
-
// Static segments outscore the `:id` param in the saas router, so these
|
|
1046
|
-
// resolve before the editor route (AdminShell sorts by routeScore).
|
|
1047
|
-
{ path: "/courses", component: asComp(CoursesListPage), permission: read("courses") },
|
|
1048
|
-
{ path: "/courses/members", component: asComp(MembersAreaPage), permission: read("courses") },
|
|
1049
|
-
{ path: "/courses/sales", component: asComp(SalesPage), permission: read("courses.sales") },
|
|
1050
|
-
{ path: "/courses/subscriptions", component: asComp(SubscriptionsPage), permission: read("courses.sales") },
|
|
1051
|
-
{ path: "/courses/financial", component: asComp(FinancialPage), permission: read("courses.finance") },
|
|
1052
|
-
{ path: "/courses/reports", component: asComp(ReportsPage), permission: read("courses.sales") },
|
|
1053
|
-
{ path: "/courses/:id", component: asComp(CourseEditorPage) }
|
|
1054
|
-
],
|
|
1062
|
+
navigation,
|
|
1063
|
+
routes,
|
|
1055
1064
|
widgets: [],
|
|
1056
|
-
|
|
1065
|
+
// Commerce KPIs on the shared 'home' surface follow the same opt-in rule:
|
|
1066
|
+
// no module enabled → no widgets broadcast into a host's dashboard.
|
|
1067
|
+
dashboardWidgets: createCoursesDashboardWidgets(modules),
|
|
1057
1068
|
connectors: [createStripeConnector()],
|
|
1058
1069
|
settings: [
|
|
1059
1070
|
{ id: "courses", label: "Courses", icon: "BookOpen", component: asComp(CoursesSettingsTab), order: 20, permission: read("courses") }
|