@insignia-education/api-sdk-js 0.15.36 → 0.15.40

package/AGENTS.md

@@ -60,6 +60,13 @@ api.users.cashReceivers();
 2. Register it in `src/api/v1/index.js`
 3. Write integration tests in `tests/integration/api/v1/resource-name.test.js`
 
+## Testing coverage requirements
+
+Same pattern as `api`'s endpoint tests (see its `AGENTS.md`), applied per SDK method:
+
+- **Missing/malformed params** — call each method with required params omitted and with wrong-format values; confirm the SDK surfaces the API's validation error correctly rather than swallowing it or throwing something unrelated.
+- **Permissions** — exercise each method as every relevant user role (including unauthenticated) against the API and confirm the SDK surfaces 401/403 correctly — not just the happy-path success response for the one role the method was built for.
+
 ## Internationalisation (i18n)
 The SDK is language-neutral — it must never contain human-readable strings.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@insignia-education/api-sdk-js",
-  "version": "0.15.36",
+  "version": "0.15.40",
   "description": "JavaScript SDK for the Insignia Education API",
   "main": "index.js",
   "type": "module",

package/src/api/v1/Admin.js

@@ -0,0 +1,12 @@
+export default class Admin {
+    #client;
+
+    constructor(client) {
+        this.#client = client;
+    }
+
+    /** Paginated list of courses with their currently-active course_dates. */
+    courseDates({ page, perPage } = {}) {
+        return this.#client.get('/admin/courses/current-dates', { page, per_page: perPage });
+    }
+}

package/src/api/v1/Courses.js

@@ -27,6 +27,9 @@ export default class Courses {
     /** Users enrolled on this course as a teacher (user_courses.teacher = 1). */
     teachers(courseId) { return this.#client.get(`/courses/${courseId}/teachers`); }
 
+    /** Customer-facing session-credit pricing (no commission fields) for self-checkout. */
+    sessionsPricing(courseId) { return this.#client.get(`/courses/${courseId}/sessions/pricing`); }
+
     dates(courseId) {
         const base = `/courses/${courseId}/dates`;
         return {

package/src/api/v1/Dashboard.js

@@ -0,0 +1,10 @@
+export default class Dashboard {
+    #client;
+
+    constructor(client) {
+        this.#client = client;
+    }
+
+    /** Which dashboard modules the current user should see: { teacher, education_center, organization }. */
+    modules() { return this.#client.get('/dashboard/modules'); }
+}

package/src/api/v1/EducationCenter.js

@@ -0,0 +1,10 @@
+export default class EducationCenter {
+    #client;
+
+    constructor(client) {
+        this.#client = client;
+    }
+
+    /** Per-course stats (enrolled count, completion rate, revenue) for courses owned by the current user. */
+    coursesStats() { return this.#client.get('/education-center/courses/stats'); }
+}

package/src/api/v1/Sales.js

@@ -0,0 +1,10 @@
+export default class Sales {
+    #client;
+
+    constructor(client) {
+        this.#client = client;
+    }
+
+    /** Options for the UTM link generator: courses, session types, active coupons, known utm source/medium/campaign values. */
+    utmGeneratorOptions() { return this.#client.get('/sales/utm-generator/options'); }
+}

package/src/api/v1/Teacher.js

@@ -42,4 +42,18 @@ export default class Teacher {
             delete: (id)        => this.#client.del(`${base}/${id}`),
         };
     }
+
+    dashboard() {
+        const base = '/teacher/dashboard';
+        return {
+            /** Own scheduled sessions for a given date (YYYY-MM-DD). */
+            sessions: (date) => this.#client.get(`${base}/sessions`, { date }),
+            /** Ungraded quiz submissions grouped by course, for every course this teacher teaches. */
+            ungradedQuizzes: () => this.#client.get(`${base}/quizzes/ungraded`),
+            /** Mark a student's attendance (present: true/false) on one of this teacher's own sessions. */
+            markAttendance: (sessionId, present) => this.#client.patch(`${base}/sessions/${sessionId}/attendance`, { present }),
+            /** Attendance/substitution totals. Pass { from, to } (YYYY-MM-DD) to filter, omit for all-time. */
+            stats: ({ from, to } = {}) => this.#client.get(`${base}/stats`, { from, to }),
+        };
+    }
 }

package/src/api/v1/index.js

@@ -1,4 +1,5 @@
 import InsigniaApi from '../index.js';
+import Admin from './Admin.js';
 import Auth from './Auth.js';
 import Accounts from './Accounts.js';
 import Categories from './Categories.js';
@@ -10,6 +11,8 @@ import Countries from './Countries.js';
 import Coupons from './Coupons.js';
 import Courses from './Courses.js';
 import Currencies from './Currencies.js';
+import Dashboard from './Dashboard.js';
+import EducationCenter from './EducationCenter.js';
 import Files from './Files.js';
 import Forums from './Forums.js';
 import Hashes from './Hashes.js';
@@ -21,6 +24,7 @@ import Organizations from './Organizations.js';
 import PaymentMethods from './PaymentMethods.js';
 import Payments from './Payments.js';
 import Quizzes from './Quizzes.js';
+import Sales from './Sales.js';
 import Search from './Search.js';
 import ShortLinks from './ShortLinks.js';
 import Surveys from './Surveys.js';
@@ -48,6 +52,7 @@ export default class InsigniaApiV1 extends InsigniaApi {
         let url = InsigniaApiV1._resolve(baseUrl);
         super(url);
 
+        this.admin                = new Admin(this);
         this.auth                 = new Auth(this);
         this.accounts             = new Accounts(this);
         this.categories           = new Categories(this);
@@ -59,6 +64,8 @@ export default class InsigniaApiV1 extends InsigniaApi {
         this.coupons              = new Coupons(this);
         this.courses              = new Courses(this);
         this.currencies           = new Currencies(this);
+        this.dashboard            = new Dashboard(this);
+        this.educationCenter      = new EducationCenter(this);
         this.files                = new Files(this);
         this.forums               = new Forums(this);
         this.hashes               = new Hashes(this);
@@ -70,6 +77,7 @@ export default class InsigniaApiV1 extends InsigniaApi {
         this.paymentMethods       = new PaymentMethods(this);
         this.payments             = new Payments(this);
         this.quizzes              = new Quizzes(this);
+        this.sales                = new Sales(this);
         this.search               = new Search(this);
         this.shortLinks           = new ShortLinks(this);
         this.surveys              = new Surveys(this);