@edx/frontend-app-subscription-manage 1.0.0 → 1.1.0

package/dist/constants.d.ts

@@ -1,2 +1,2 @@
 export declare const appId = "org.openedx.frontend.app.subscription.manage";
-export declare const templateRole = "org.openedx.frontend.role.subscription.manage";
+export declare const subscriptionManageRole = "org.openedx.frontend.role.subscription.manage";

package/dist/constants.js

@@ -1,3 +1,3 @@
 export const appId = 'org.openedx.frontend.app.subscription.manage';
-export const templateRole = 'org.openedx.frontend.role.subscription.manage';
+export const subscriptionManageRole = 'org.openedx.frontend.role.subscription.manage';
 //# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,KAAK,GAAG,8CAA8C,CAAC;AACpE,MAAM,CAAC,MAAM,YAAY,GAAG,+CAA+C,CAAC","sourcesContent":["export const appId = 'org.openedx.frontend.app.subscription.manage';\nexport const templateRole = 'org.openedx.frontend.role.subscription.manage';\n"]}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,KAAK,GAAG,8CAA8C,CAAC;AACpE,MAAM,CAAC,MAAM,sBAAsB,GAAG,+CAA+C,CAAC","sourcesContent":["export const appId = 'org.openedx.frontend.app.subscription.manage';\nexport const subscriptionManageRole = 'org.openedx.frontend.role.subscription.manage';\n"]}

package/dist/data/services/subs/urls.d.ts

@@ -0,0 +1,2 @@
+export function getApiUrl(): string;
+export function getSubsInitApiUrl(): string;

package/dist/data/services/subs/urls.js

@@ -0,0 +1,4 @@
+import { getSiteConfig } from '@openedx/frontend-base';
+export const getApiUrl = () => (`${getSiteConfig().lmsBaseUrl}/api`);
+export const getSubsInitApiUrl = () => (`${getApiUrl()}/subscription/init/`);
+//# sourceMappingURL=urls.js.map

package/dist/data/services/subs/urls.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"urls.js","sourceRoot":"","sources":["../../../../src/data/services/subs/urls.js"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,CAAC,GAAG,aAAa,EAAE,CAAC,UAAU,MAAM,CAAC,CAAC;AAErE,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAAC,CAAC,GAAG,SAAS,EAAE,qBAAqB,CAAC,CAAC","sourcesContent":["import { getSiteConfig } from '@openedx/frontend-base';\n\nexport const getApiUrl = () => (`${getSiteConfig().lmsBaseUrl}/api`);\n\nexport const getSubsInitApiUrl = () => (`${getApiUrl()}/subscription/init/`);\n"]}

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { default as templateApp } from './app';
-export { default as templateRoutes } from './routes';
+export { default as subscriptionManageApp } from './app';
+export { default as subscriptionManageRoutes } from './routes';

package/dist/index.js

@@ -1,3 +1,3 @@
-export { default as templateApp } from './app';
-export { default as templateRoutes } from './routes';
+export { default as subscriptionManageApp } from './app';
+export { default as subscriptionManageRoutes } from './routes';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,OAAO,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,UAAU,CAAC","sourcesContent":["export { default as templateApp } from './app';\nexport { default as templateRoutes } from './routes';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,OAAO,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,wBAAwB,EAAE,MAAM,UAAU,CAAC","sourcesContent":["export { default as subscriptionManageApp } from './app';\nexport { default as subscriptionManageRoutes } from './routes';\n"]}

package/dist/routes.d.ts

@@ -1,6 +1,7 @@
 declare const routes: {
     id: string;
     path: string;
+    loader: (args: any) => Promise<null>;
     handle: {
         roles: string[];
     };

package/dist/routes.js

@@ -7,17 +7,44 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { templateRole } from './constants';
+import { authenticatedLoader, getAuthenticatedHttpClient } from '@openedx/frontend-base';
+import { redirect } from 'react-router-dom';
+import { getSubsInitApiUrl } from './data/services/subs/urls';
+import { subscriptionManageRole } from './constants';
+// loader to check if the user has subscription access
+const subscriptionAccessLoader = () => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const { data } = yield getAuthenticatedHttpClient().get(getSubsInitApiUrl());
+        if (!(data === null || data === void 0 ? void 0 : data.userSubscription) || !data.userSubscription.isSubscriber) {
+            throw redirect('/learner-dashboard'); // redirect to learner dashboard if user does not have subscription access
+        }
+        return null;
+    }
+    catch (error) {
+        // Let redirect responses bubble up
+        if (error instanceof Response) {
+            throw error;
+        }
+        throw redirect('/learner-dashboard'); // redirect to learner dashboard if an error occurs
+    }
+});
+// composed loader that checks for authentication and subscription access
+const protectedLoader = (args) => __awaiter(void 0, void 0, void 0, function* () {
+    yield authenticatedLoader(args);
+    yield subscriptionAccessLoader();
+    return null;
+});
 const routes = [
     {
-        id: 'org.openedx.frontend.route.template.main',
-        path: 'template',
+        id: 'org.openedx.frontend.route.subscription.manage.main',
+        path: 'subscription-manage',
+        loader: protectedLoader,
         handle: {
-            roles: [templateRole],
+            roles: [subscriptionManageRole],
         },
         lazy() {
             return __awaiter(this, void 0, void 0, function* () {
-                const module = yield import(/* webpackChunkName: "template-main" */ './Main');
+                const module = yield import(/* webpackChunkName: "subscription-manage-main" */ './Main');
                 return { Component: module.default };
             });
         },
@@ -26,7 +53,7 @@ const routes = [
                 index: true,
                 lazy() {
                     return __awaiter(this, void 0, void 0, function* () {
-                        const module = yield import(/* webpackChunkName: "template-example" */ './example/ExamplePage');
+                        const module = yield import(/* webpackChunkName: "subscription-manage-example" */ './example/ExamplePage');
                         return { Component: module.default };
                     });
                 },

package/dist/routes.js.map

@@ -1 +1 @@
-{"version":3,"file":"routes.js","sourceRoot":"","sources":["../src/routes.tsx"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,MAAM,MAAM,GAAG;IACb;QACE,EAAE,EAAE,0CAA0C;QAC9C,IAAI,EAAE,UAAU;QAChB,MAAM,EAAE;YACN,KAAK,EAAE,CAAC,YAAY,CAAC;SACtB;QACK,IAAI;;gBACR,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,uCAAuC,CAAC,QAAQ,CAAC,CAAC;gBAC9E,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;YACvC,CAAC;SAAA;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,IAAI;gBACL,IAAI;;wBACR,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,0CAA0C,CAAC,uBAAuB,CAAC,CAAC;wBAChG,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;oBACvC,CAAC;iBAAA;aACF;SACF;KACF;CACF,CAAC;AAEF,eAAe,MAAM,CAAC","sourcesContent":["import { templateRole } from './constants';\n\nconst routes = [\n  {\n    id: 'org.openedx.frontend.route.template.main',\n    path: 'template',\n    handle: {\n      roles: [templateRole],\n    },\n    async lazy() {\n      const module = await import(/* webpackChunkName: \"template-main\" */ './Main');\n      return { Component: module.default };\n    },\n    children: [\n      {\n        index: true,\n        async lazy() {\n          const module = await import(/* webpackChunkName: \"template-example\" */ './example/ExamplePage');\n          return { Component: module.default };\n        },\n      },\n    ],\n  },\n];\n\nexport default routes;\n"]}
+{"version":3,"file":"routes.js","sourceRoot":"","sources":["../src/routes.tsx"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACzF,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD,sDAAsD;AACtD,MAAM,wBAAwB,GAAG,GAAS,EAAE;IAC1C,IAAI,CAAC;QACH,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,0BAA0B,EAAE,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAC;QAE7E,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,CAAA,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;YACnE,MAAM,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC,0EAA0E;QAClH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,mCAAmC;QACnC,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;YAC9B,MAAM,KAAK,CAAC;QACd,CAAC;QAED,MAAM,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC,mDAAmD;IAC3F,CAAC;AACH,CAAC,CAAA,CAAC;AAEF,yEAAyE;AACzE,MAAM,eAAe,GAAG,CAAO,IAAI,EAAE,EAAE;IACrC,MAAM,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,wBAAwB,EAAE,CAAC;IAEjC,OAAO,IAAI,CAAC;AACd,CAAC,CAAA,CAAC;AAEF,MAAM,MAAM,GAAG;IACb;QACE,EAAE,EAAE,qDAAqD;QACzD,IAAI,EAAE,qBAAqB;QAC3B,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE;YACN,KAAK,EAAE,CAAC,sBAAsB,CAAC;SAChC;QACK,IAAI;;gBACR,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,kDAAkD,CAAC,QAAQ,CAAC,CAAC;gBACzF,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;YACvC,CAAC;SAAA;QACD,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,IAAI;gBACL,IAAI;;wBACR,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,qDAAqD,CAAC,uBAAuB,CAAC,CAAC;wBAC3G,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;oBACvC,CAAC;iBAAA;aACF;SACF;KACF;CACF,CAAC;AAEF,eAAe,MAAM,CAAC","sourcesContent":["import { authenticatedLoader, getAuthenticatedHttpClient } from '@openedx/frontend-base';\nimport { redirect } from 'react-router-dom';\n\nimport { getSubsInitApiUrl } from './data/services/subs/urls';\nimport { subscriptionManageRole } from './constants';\n\n// loader to check if the user has subscription access\nconst subscriptionAccessLoader = async () => {\n  try {\n    const { data } = await getAuthenticatedHttpClient().get(getSubsInitApiUrl());\n\n    if (!data?.userSubscription || !data.userSubscription.isSubscriber) {\n      throw redirect('/learner-dashboard'); // redirect to learner dashboard if user does not have subscription access\n    }\n\n    return null;\n  } catch (error) {\n    // Let redirect responses bubble up\n    if (error instanceof Response) {\n      throw error;\n    }\n\n    throw redirect('/learner-dashboard'); // redirect to learner dashboard if an error occurs\n  }\n};\n\n// composed loader that checks for authentication and subscription access\nconst protectedLoader = async (args) => {\n  await authenticatedLoader(args);\n  await subscriptionAccessLoader();\n\n  return null;\n};\n\nconst routes = [\n  {\n    id: 'org.openedx.frontend.route.subscription.manage.main',\n    path: 'subscription-manage',\n    loader: protectedLoader,\n    handle: {\n      roles: [subscriptionManageRole],\n    },\n    async lazy() {\n      const module = await import(/* webpackChunkName: \"subscription-manage-main\" */ './Main');\n      return { Component: module.default };\n    },\n    children: [\n      {\n        index: true,\n        async lazy() {\n          const module = await import(/* webpackChunkName: \"subscription-manage-example\" */ './example/ExamplePage');\n          return { Component: module.default };\n        },\n      },\n    ],\n  },\n];\n\nexport default routes;\n"]}

package/dist/widgets/ExampleHeader/app.js

@@ -1,6 +1,6 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { LinkMenuItem, WidgetOperationTypes } from '@openedx/frontend-base';
-import { templateRole } from '../../constants';
+import { subscriptionManageRole } from '../../constants';
 const app = {
     appId: 'org.openedx.frontend.app.template.exampleHeader',
     slots: [
@@ -8,9 +8,9 @@ const app = {
             slotId: 'org.openedx.frontend.slot.header.primaryLinks.v1',
             id: 'org.openedx.frontend.widget.template.exampleHeaderLink.v1',
             op: WidgetOperationTypes.APPEND,
-            element: (_jsx(LinkMenuItem, { label: "Example Menu", role: templateRole, variant: "navLink" })),
+            element: (_jsx(LinkMenuItem, { label: "Example Menu", role: subscriptionManageRole, variant: "navLink" })),
             condition: {
-                active: [templateRole],
+                active: [subscriptionManageRole],
             },
         },
     ],

package/dist/widgets/ExampleHeader/app.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.js","sourceRoot":"","sources":["../../../src/widgets/ExampleHeader/app.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAO,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEjF,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,MAAM,GAAG,GAAQ;IACf,KAAK,EAAE,iDAAiD;IACxD,KAAK,EAAE;QACL;YACE,MAAM,EAAE,kDAAkD;YAC1D,EAAE,EAAE,2DAA2D;YAC/D,EAAE,EAAE,oBAAoB,CAAC,MAAM;YAC/B,OAAO,EAAE,CACP,KAAC,YAAY,IACX,KAAK,EAAC,cAAc,EACpB,IAAI,EAAE,YAAY,EAClB,OAAO,EAAC,SAAS,GACjB,CACH;YACD,SAAS,EAAE;gBACT,MAAM,EAAE,CAAC,YAAY,CAAC;aACvB;SACF;KACF;CACF,CAAC;AAEF,eAAe,GAAG,CAAC","sourcesContent":["import { App, LinkMenuItem, WidgetOperationTypes } from '@openedx/frontend-base';\n\nimport { templateRole } from '../../constants';\n\nconst app: App = {\n  appId: 'org.openedx.frontend.app.template.exampleHeader',\n  slots: [\n    {\n      slotId: 'org.openedx.frontend.slot.header.primaryLinks.v1',\n      id: 'org.openedx.frontend.widget.template.exampleHeaderLink.v1',\n      op: WidgetOperationTypes.APPEND,\n      element: (\n        <LinkMenuItem\n          label=\"Example Menu\"\n          role={templateRole}\n          variant=\"navLink\"\n        />\n      ),\n      condition: {\n        active: [templateRole],\n      },\n    },\n  ],\n};\n\nexport default app;\n"]}
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../../src/widgets/ExampleHeader/app.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAO,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEjF,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,MAAM,GAAG,GAAQ;IACf,KAAK,EAAE,iDAAiD;IACxD,KAAK,EAAE;QACL;YACE,MAAM,EAAE,kDAAkD;YAC1D,EAAE,EAAE,2DAA2D;YAC/D,EAAE,EAAE,oBAAoB,CAAC,MAAM;YAC/B,OAAO,EAAE,CACP,KAAC,YAAY,IACX,KAAK,EAAC,cAAc,EACpB,IAAI,EAAE,sBAAsB,EAC5B,OAAO,EAAC,SAAS,GACjB,CACH;YACD,SAAS,EAAE;gBACT,MAAM,EAAE,CAAC,sBAAsB,CAAC;aACjC;SACF;KACF;CACF,CAAC;AAEF,eAAe,GAAG,CAAC","sourcesContent":["import { App, LinkMenuItem, WidgetOperationTypes } from '@openedx/frontend-base';\n\nimport { subscriptionManageRole } from '../../constants';\n\nconst app: App = {\n  appId: 'org.openedx.frontend.app.template.exampleHeader',\n  slots: [\n    {\n      slotId: 'org.openedx.frontend.slot.header.primaryLinks.v1',\n      id: 'org.openedx.frontend.widget.template.exampleHeaderLink.v1',\n      op: WidgetOperationTypes.APPEND,\n      element: (\n        <LinkMenuItem\n          label=\"Example Menu\"\n          role={subscriptionManageRole}\n          variant=\"navLink\"\n        />\n      ),\n      condition: {\n        active: [subscriptionManageRole],\n      },\n    },\n  ],\n};\n\nexport default app;\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@edx/frontend-app-subscription-manage",
-  "version": "1.0.0",
-  "description": "Frontend application template",
+  "version": "1.1.0",
+  "description": "Subscription Manage Frontend application",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/edx/frontend-app-subscription-manage.git"
@@ -34,7 +34,7 @@
     "build:packages": "make build-packages",
     "clean": "make clean",
     "clean:packages": "make clean-packages",
-    "dev": "PORT=8080 PUBLIC_PATH=/template openedx dev",
+    "dev": "PORT=8080 PUBLIC_PATH=/subscription-manage openedx dev",
     "dev:site": "make dev-site",
     "dev:packages": "make dev-packages",
     "i18n_extract": "openedx formatjs extract",