@insignia-education/api-sdk-js 0.15.60 → 0.15.62

package/jest.config.mjs

@@ -14,6 +14,14 @@ const config = {
         }],
     ],
 
+    // Run via `npm test`, which invokes unit and integration as two separate
+    // `jest --selectProjects` calls (integration also with --runInBand)
+    // rather than one combined parallel run: Jest has a multi-project quirk
+    // where a later project's tests can silently fall back to the global
+    // 5000ms default instead of this project's own testTimeout when both
+    // projects run together in one process, and integration tests hit a
+    // single-threaded `php artisan serve` backend that serializes requests
+    // anyway — parallel workers just queue up and time out against it.
     projects: [
         {
             displayName: 'unit',
@@ -28,7 +36,10 @@ const config = {
             testMatch: ['<rootDir>/tests/integration/**/*.test.js'],
             transform: { '^.+\\.(js|jsx)$': 'babel-jest' },
             setupFiles: ['<rootDir>/tests/integration/loadEnv.js'],
-            testTimeout: 30000,
+            // Generous — amd64 emulation (api-sdk-js's Docker test env on
+            // Apple Silicon) occasionally makes an individual request take
+            // 10-20s+ under CPU contention.
+            testTimeout: 60000,
         },
     ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@insignia-education/api-sdk-js",
-  "version": "0.15.60",
+  "version": "0.15.62",
   "description": "JavaScript SDK for the Insignia Education API",
   "main": "index.js",
   "type": "module",
@@ -10,7 +10,7 @@
     "./api/v1": "./src/api/v1/index.js"
   },
   "scripts": {
-    "test": "jest",
+    "test": "jest --selectProjects unit && jest --selectProjects integration --runInBand --testTimeout=60000",
     "lint": "eslint src/"
   },
   "repository": {

package/src/Client.js

@@ -93,8 +93,11 @@ export default class InsigniaClient {
         if (this.#baseUrl.includes('ngrok')) headers['ngrok-skip-browser-warning'] = 'true';
         const cookie  = this.#cookieHeader();
         if (cookie) headers.Cookie = cookie;
+        // POST, not PUT: PHP only parses multipart/form-data bodies into $_FILES for
+        // POST requests — a PUT with the exact same body leaves $_FILES empty and the
+        // raw body unread, so `$request->file(...)` is always null server-side.
         const response = await fetch(`${this.#baseUrl}${path}`, {
-            method: 'PUT', headers, credentials: 'include', body: formData,
+            method: 'POST', headers, credentials: 'include', body: formData,
         });
         this.#storeCookies(response);
         if (!response.ok) {

package/src/api/v1/Coupons.js

@@ -16,4 +16,15 @@ export default class Coupons {
 
     /** Employee/sales-only: usage stats + full redemption history for one coupon. */
     stats(id) { return this.#client.get(`/coupons/${id}/stats`); }
+
+    /** Users explicitly granted access to redeem this coupon. */
+    users(id) {
+        const base = `/coupons/${id}/users`;
+        const client = this.#client;
+        return {
+            get:    ()                 => client.get(base),
+            add:    ({ email, reason }) => client.put(base, { email, reason }),
+            remove: (userId)           => client.del(`${base}/${userId}`),
+        };
+    }
 }

package/src/api/v1/Hashes.js

@@ -1,3 +1,6 @@
+// Read-only — hashes (password-reset/verify/phantom-login tokens etc.) are
+// created and deleted exclusively by their owning flows (forgot-password,
+// email-verify, admin phantom-login), never through a generic public API.
 export default class Hashes {
     #client;
 
@@ -6,6 +9,4 @@ export default class Hashes {
     }
 
     get(id = null)   { return id ? this.#client.get(`/hashes/${id}`) : this.#client.get('/hashes'); }
-    generate(data)   { return this.#client.put('/hashes/generate', data); }
-    delete(id)       { return this.#client.del(`/hashes/${id}`); }
 }

package/src/api/v1/index.js

@@ -2,9 +2,7 @@ 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';
 import Changelogs from './Changelogs.js';
-import Configs from './Configs.js';
 import ContactForms from './ContactForms.js';
 import ConversationalTopics from './ConversationalTopics.js';
 import Countries from './Countries.js';
@@ -57,9 +55,7 @@ export default class InsigniaApiV1 extends InsigniaApi {
         this.admin                = new Admin(this);
         this.auth                 = new Auth(this);
         this.accounts             = new Accounts(this);
-        this.categories           = new Categories(this);
         this.changelogs           = new Changelogs(this);
-        this.configs              = new Configs(this);
         this.contactForms         = new ContactForms(this);
         this.conversationalTopics = new ConversationalTopics(this);
         this.countries            = new Countries(this);

package/tests/integration/api/v1/accounts.test.js

@@ -5,21 +5,15 @@ import {
 } from '../../../helpers.js';
 
 describe('api/v1/accounts', () => {
+    // Client#request() throws on non-2xx (err.status, err.data) rather than
+    // resolving — assert against a rejected promise, not a resolved
+    // {success, status}.
     test('get | unauthenticated', async () => {
-        await api.accounts.get()
-            .then(response => {
-                expect(response.success).toBe(false);
-                expect(response.status).toBe(401);
-            });
+        await expect(api.accounts.get()).rejects.toMatchObject({ status: 401 });
     });
     test('get | authenticated but other type', async () => {
         await loginCustomer();
-        await api.accounts.get()
-            .then(response => {
-                console.log(response);
-                expect(response.success).toBe(false);
-                expect(response.status).toBe(403);
-            });
+        await expect(api.accounts.get()).rejects.toMatchObject({ status: 403 });
     });
     test('get | authenticated', async () => {
         await loginAdmin();

package/tests/integration/api/v1/auth/login.test.js

@@ -1,56 +1,40 @@
-import { 
-    api, 
-    loginCustomer,
+import {
+    api,
     loginAdmin,
-    logout,
 } from '../../../../helpers.js';
 
-
-
-
 describe('api/v1/auth/login', () => {
+    // Client#request() throws on non-2xx (err.status, err.data) rather than
+    // resolving — assert against a rejected promise, not a resolved
+    // {success, status, errors}. Also no logout() before these — a fresh
+    // `api` client (one per test file) starts out unauthenticated, and
+    // logout() itself throws 401 when there's no session to clear.
     test('POST | failure | no email validation', async () => {
         const password = process.env.TEST_PASSWORD;
-        logout()
-        .then(() => api.auth.login({ password })
-            .then(response => {
-                // here we have more info of the request because we have the errors
-                expect(response["success"]).toBeDefined();
-                expect(response["status"]).toBeDefined();
-                expect(response["status"]).toBe(422);
-                expect(response["errors"]).toBeDefined();
-                expect(Object.values(response["errors"]).length > 0).toBe(true);
-                expect(response["errors"]["email"]).toBeDefined();
-            }));
+        await expect(api.auth.login({ password })).rejects.toMatchObject({
+            status: 422,
+            data: { errors: expect.objectContaining({ email: expect.anything() }) },
+        });
     });
 
     test('POST | failure | no password validation', async () => {
         const email = process.env.TEST_EMAIL;
-        logout()
-        .then(() => api.auth.login({ email })
-            .then(response => {
-                // here we have more info of the request because we have the errors
-                expect(response["success"]).toBeDefined();
-                expect(response["errors"]).toBeDefined();
-                expect(response["status"]).toBeDefined();
-                expect(response["status"]).toBe(422);
-                expect(Object.values(response["errors"]).length > 0).toBe(true);
-                expect(response["errors"]["password"]).toBeDefined();
-            }));
-        
+        await expect(api.auth.login({ email })).rejects.toMatchObject({
+            status: 422,
+            data: { errors: expect.objectContaining({ password: expect.anything() }) },
+        });
     });
 
     test('POST | success', async () => {
-        logout()
-        .then(() => loginAdmin()
+        await loginAdmin()
             .then(response => {
                 expect(response["success"]).toBeDefined();
                 expect(response["success"]).toBe("ok");
-            }));
+            });
     });
 
     test('POST | double login', async () => {
-        loginAdmin()
+        await loginAdmin()
         .then(() => loginAdmin()
             .then(response => {
                 expect(response["success"]).toBeDefined();

package/tests/integration/api/v1/conversational-topics.test.js

@@ -1,18 +1,16 @@
-import InsigniaApiV1 from '../../../../src/api/v1/index.js';
-
-const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
+import { api, loginAdmin } from '../../../helpers.js';
 
 describe('api/v1/conversational-topics', () => {
     test('get', async () => {
+        await loginAdmin();
         await api.conversationalTopics.get()
             .then(response => {
                 response = Object.values(response);
                 expect(response.length > 0).toBe(true);
                 response.forEach(topic => {
                     expect(topic["id"]).toBeDefined();
-                    expect(topic["cod"]).toBeDefined();
                     expect(topic["title"]).toBeDefined();
-                    expect(topic["enabled"]).toBeDefined();
+                    expect(topic["date"]).toBeDefined();
                 });
             });
     });

package/tests/integration/api/v1/countries.test.js

@@ -5,7 +5,7 @@ const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
 
 describe('api/v1/countries', () => {
     test('get', async () => {
-        api.countries.get()
+        await api.countries.get()
         .then(response => {
             response = Object.values(response);
             expect(response.length > 0).toBe(true);

package/tests/integration/api/v1/coupons.test.js

@@ -1,15 +1,8 @@
-import InsigniaApiV1 from '../../../../src/api/v1/index.js';
-
-const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
-
-const login = () => api.auth.login({
-    email: process.env.TEST_EMAIL,
-    password: process.env.TEST_PASSWORD,
-});
+import { api, loginAdmin } from '../../../helpers.js';
 
 describe('api/v1/coupons', () => {
     test('get | authenticated', async () => {
-        await login();
+        await loginAdmin();
         await api.coupons.get()
             .then(response => {
                 response = Object.values(response);

package/tests/integration/api/v1/currencies/index.test.js

@@ -6,7 +6,7 @@ import {
 
 describe('api/v1/currencies', () => {
     test('get', async () => {
-        api.currencies.get()
+        await api.currencies.get()
         .then(response => {
             expect(response["1"]).toBeDefined();
             expect(response["1"]["id"]).toBeDefined();

package/tests/integration/api/v1/files.test.js

@@ -1,21 +1,24 @@
 import { Blob } from 'buffer';
-import InsigniaApiV1 from '../../../../src/api/v1/index.js';
+import { api, loginAdmin } from '../../../helpers.js';
 
-const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
-
-const login = () => api.auth.login({
-    email: process.env.TEST_EMAIL,
-    password: process.env.TEST_PASSWORD,
-});
+// A real 1x1 transparent PNG (67 bytes) — the upload endpoint sniffs actual
+// file content, not just the claimed Content-Type, so arbitrary text with an
+// 'image/png' MIME hint gets rejected with "Unsupported file type".
+const PNG_1X1 = Buffer.from(
+    'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=',
+    'base64'
+);
 
 describe('api/v1/files', () => {
-    test('get | authenticated', async () => {
-        await login();
-        await api.files.get()
+    // list() (paginated), not get() — get(id) requires an id and hits
+    // /files/{id}, unlike most other resources' get(id = null).
+    test('list | authenticated', async () => {
+        await loginAdmin();
+        await api.files.list()
             .then(response => {
-                response = Object.values(response);
-                expect(Array.isArray(response)).toBe(true);
-                response.forEach(file => {
+                const files = response["data"];
+                expect(Array.isArray(files)).toBe(true);
+                files.forEach(file => {
                     expect(file["id"]).toBeDefined();
                     expect(file["created_at"]).toBeDefined();
                     expect(file["updated_at"]).toBeDefined();
@@ -24,8 +27,8 @@ describe('api/v1/files', () => {
     });
 
     test('upload | authenticated', async () => {
-        await login();
-        const blob = new Blob(['test'], { type: 'image/png' });
+        await loginAdmin();
+        const blob = new Blob([PNG_1X1], { type: 'image/png' });
         const fd   = new FormData();
         fd.append('file', blob, 'test.png');
         fd.append('type', 'uploads');

package/tests/integration/api/v1/hashes.test.js

@@ -1,15 +1,8 @@
-import InsigniaApiV1 from '../../../../src/api/v1/index.js';
-
-const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
-
-const login = () => api.auth.login({
-    email: process.env.TEST_EMAIL,
-    password: process.env.TEST_PASSWORD,
-});
+import { api, loginAdmin } from '../../../helpers.js';
 
 describe('api/v1/hashes', () => {
     test('get | authenticated', async () => {
-        await login();
+        await loginAdmin();
         await api.hashes.get()
             .then(response => {
                 response = Object.values(response);
@@ -17,7 +10,6 @@ describe('api/v1/hashes', () => {
                 response.forEach(hash => {
                     expect(hash["id"]).toBeDefined();
                     expect(hash["hash"]).toBeDefined();
-                    expect(hash["purpose_id"]).toBeDefined();
                     expect(hash["created_at"]).toBeDefined();
                     expect(hash["updated_at"]).toBeDefined();
                 });

package/tests/integration/api/v1/mail-blacklist.test.js

@@ -1,15 +1,8 @@
-import InsigniaApiV1 from '../../../../src/api/v1/index.js';
-
-const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
-
-const login = () => api.auth.login({
-    email: process.env.TEST_EMAIL,
-    password: process.env.TEST_PASSWORD,
-});
+import { api, loginAdmin } from '../../../helpers.js';
 
 describe('api/v1/mail-blacklist', () => {
     test('get | authenticated', async () => {
-        await login();
+        await loginAdmin();
         await api.mailBlacklist.get()
             .then(response => {
                 response = Object.values(response);

package/tests/integration/api/v1/offers.test.js

@@ -1,15 +1,8 @@
-import InsigniaApiV1 from '../../../../src/api/v1/index.js';
-
-const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
-
-const login = () => api.auth.login({
-    email: process.env.TEST_EMAIL,
-    password: process.env.TEST_PASSWORD,
-});
+import { api, loginAdmin } from '../../../helpers.js';
 
 describe('api/v1/offers', () => {
     test('get | authenticated', async () => {
-        await login();
+        await loginAdmin();
         await api.offers.get()
             .then(response => {
                 response = Object.values(response);

package/tests/integration/api/v1/organizations.test.js

@@ -1,6 +1,6 @@
 import {
     api,
-    loginCustomer,
+    loginAdmin,
     logout,
 } from '../../../helpers.js';
 
@@ -17,7 +17,7 @@ describe('api/v1/organizations', () => {
     });
 
     test('create | employee-and-above', async () => {
-        await loginCustomer();
+        await loginAdmin();
         const response = await api.organizations.create({ nice_name: 'SDK Test Org' });
         expect(response["id"]).toBeDefined();
         expect(response["nice_name"]).toBe('SDK Test Org');
@@ -25,7 +25,7 @@ describe('api/v1/organizations', () => {
     });
 
     test('get(id) | shape', async () => {
-        await loginCustomer();
+        await loginAdmin();
         const created = await api.organizations.create({ nice_name: 'SDK Test Org 2' });
         const response = await api.organizations.get(created.id);
         expect(response["id"]).toBe(created.id);
@@ -38,28 +38,28 @@ describe('api/v1/organizations', () => {
     });
 
     test('edit', async () => {
-        await loginCustomer();
+        await loginAdmin();
         const created = await api.organizations.create({ nice_name: 'SDK Test Org 3' });
         const response = await api.organizations.edit(created.id, { nice_name: 'SDK Test Org 3 Edited' });
         expect(response["nice_name"]).toBe('SDK Test Org 3 Edited');
     });
 
     test('members(id).get() | empty for a freshly created organization', async () => {
-        await loginCustomer();
+        await loginAdmin();
         const created = await api.organizations.create({ nice_name: 'SDK Test Org 4' });
         const response = await api.organizations.members(created.id).get();
         expect(Object.values(response)).toEqual([]);
     });
 
     test('members(id).courses(userId) | rejects a non-member user_id', async () => {
-        await loginCustomer();
+        await loginAdmin();
         const created = await api.organizations.create({ nice_name: 'SDK Test Org 5' });
         await expect(api.organizations.members(created.id).courses(created.user_id))
             .rejects.toMatchObject({ status: 422 });
     });
 
     test('members(id).createPayment(userId, data) | reaches validation, not the OwnerOrStaff 403', async () => {
-        await loginCustomer();
+        await loginAdmin();
         const created = await api.organizations.create({ nice_name: 'SDK Test Org 6' });
         // Empty payload — asserts the route/method wiring bypasses OwnerOrStaff and lands
         // in UserPaymentCreateRequest validation (422), never a 403.
@@ -77,7 +77,7 @@ describe('api/v1/users/organization-owners', () => {
     });
 
     test('get | employee-and-above', async () => {
-        await loginCustomer();
+        await loginAdmin();
         const response = Object.values(await api.users.organizationOwners());
         expect(Array.isArray(response)).toBe(true);
         response.forEach(user => {

package/tests/integration/api/v1/quizzes/index.test.js

@@ -12,8 +12,6 @@ describe('api/v1/quizzes', () => {
                 expect(Array.isArray(response)).toBe(true);
                 response.forEach(quiz => {
                     expect(quiz["id"]).toBeDefined();
-                    expect(quiz["cod"]).toBeDefined();
-                    expect(quiz["enabled"]).toBeDefined();
                     expect(quiz["created_at"]).toBeDefined();
                     expect(quiz["updated_at"]).toBeDefined();
                 });

package/tests/integration/api/v1/short-links.test.js

@@ -1,15 +1,8 @@
-import InsigniaApiV1 from '../../../../src/api/v1/index.js';
-
-const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
-
-const login = () => api.auth.login({
-    email: process.env.TEST_EMAIL,
-    password: process.env.TEST_PASSWORD,
-});
+import { api, loginAdmin } from '../../../helpers.js';
 
 describe('api/v1/short-links', () => {
     test('get | authenticated', async () => {
-        await login();
+        await loginAdmin();
         await api.shortLinks.get()
             .then(response => {
                 response = Object.values(response);

package/tests/integration/api/v1/taxes.test.js

@@ -1,9 +1,8 @@
-import InsigniaApiV1 from '../../../../src/api/v1/index.js';
-
-const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
+import { api, loginAdmin } from '../../../helpers.js';
 
 describe('api/v1/taxes', () => {
     test('get', async () => {
+        await loginAdmin();
         await api.taxes.get()
             .then(response => {
                 response = Object.values(response);

package/tests/integration/api/v1/teacher/index.test.js

@@ -38,7 +38,7 @@ describe('api/v1/teacher/config-sets', () => {
 
 describe('api/v1/teacher/configs', () => {
     test('get | authenticated', async () => {
-        await login();
+        await loginAdmin();
         await api.teacher.configs().get()
             .then(response => {
                 response = Object.values(response);

package/tests/integration/api/v1/user-types.test.js

@@ -1,9 +1,8 @@
-import InsigniaApiV1 from '../../../../src/api/v1/index.js';
-
-const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
+import { api, loginAdmin } from '../../../helpers.js';
 
 describe('api/v1/user-types', () => {
     test('get', async () => {
+        await loginAdmin();
         await api.userTypes.get()
             .then(response => {
                 response = Object.values(response);
@@ -12,7 +11,6 @@ describe('api/v1/user-types', () => {
                     expect(userType["id"]).toBeDefined();
                     expect(userType["cod"]).toBeDefined();
                     expect(userType["title"]).toBeDefined();
-                    expect(userType["enabled"]).toBeDefined();
                 });
             });
     });

package/tests/integration/api/v1/users/index.test.js

@@ -5,29 +5,26 @@ import {
 } from '../../../../helpers.js';
 
 describe('api/v1/users', () => {
+    // get(id = null) with no id returns the authenticated user's own
+    // profile (UserController::get() -> auth()->user()), not a list.
     test('get | authenticated', async () => {
         await loginAdmin();
         await api.users.get()
             .then(response => {
-                response = Object.values(response);
-                expect(response.length > 0).toBe(true);
-                response.forEach(user => {
-                    expect(user["id"]).toBeDefined();
-                    expect(user["name"]).toBeDefined();
-                    expect(user["email"]).toBeDefined();
-                    expect(user["created_at"]).toBeDefined();
-                    expect(user["updated_at"]).toBeDefined();
-                });
+                expect(response["id"]).toBeDefined();
+                expect(response["name"]).toBeDefined();
+                expect(response["email"]).toBeDefined();
+                expect(response["created_at"]).toBeDefined();
+                expect(response["updated_at"]).toBeDefined();
             });
     });
 
     test('get by id | authenticated', async () => {
         await loginAdmin();
-        const users = await api.users.get().then(r => Object.values(r));
-        const id = users[0]["id"];
-        await api.users.get(id)
+        const me = await api.users.get();
+        await api.users.get(me["id"])
             .then(response => {
-                expect(response["id"]).toBe(id);
+                expect(response["id"]).toBe(me["id"]);
                 expect(response["name"]).toBeDefined();
                 expect(response["email"]).toBeDefined();
             });

package/tests/integration/api/v1/zoom.test.js

@@ -1,15 +1,8 @@
-import InsigniaApiV1 from '../../../../src/api/v1/index.js';
-
-const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
-
-const login = () => api.auth.login({
-    email: process.env.TEST_EMAIL,
-    password: process.env.TEST_PASSWORD,
-});
+import { api, loginAdmin } from '../../../helpers.js';
 
 describe('api/v1/zoom/meetings', () => {
     test('get | authenticated', async () => {
-        await login();
+        await loginAdmin();
         await api.zoom.meetings().get()
             .then(response => {
                 response = Object.values(response);

package/src/api/v1/Categories.js

@@ -1,12 +0,0 @@
-export default class Categories {
-    #client;
-
-    constructor(client) {
-        this.#client = client;
-    }
-
-    get(id = null)  { return id ? this.#client.get(`/categories/${id}`) : this.#client.get('/categories'); }
-    create(data)    { return this.#client.put('/categories', data); }
-    edit(id, data)  { return this.#client.patch(`/categories/${id}`, data); }
-    delete(id)      { return this.#client.del(`/categories/${id}`); }
-}

package/src/api/v1/Configs.js

@@ -1,12 +0,0 @@
-export default class Configs {
-    #client;
-
-    constructor(client) {
-        this.#client = client;
-    }
-
-    get(id = null)  { return id ? this.#client.get(`/configs/${id}`) : this.#client.get('/configs'); }
-    create(data)    { return this.#client.put('/configs', data); }
-    edit(id, data)  { return this.#client.patch(`/configs/${id}`, data); }
-    delete(id)      { return this.#client.del(`/configs/${id}`); }
-}

package/tests/integration/api/v1/categories.test.js

@@ -1,19 +0,0 @@
-import { 
-    api
-} from '../../../helpers.js';
-
-describe('api/v1/categories', () => {
-    test('get', async () => {
-        await api.categories.get()
-            .then(response => {
-                response = Object.values(response);
-                expect(response.length > 0).toBe(true);
-                response.forEach(category => {
-                    expect(category["id"]).toBeDefined();
-                    expect(category["cod"]).toBeDefined();
-                    expect(category["title"]).toBeDefined();
-                    expect(category["enabled"]).toBeDefined();
-                });
-            });
-    });
-});