@insignia-education/api-sdk-js 0.9.12 → 0.9.17

package/.github/hooks/pre-commit

@@ -1,13 +1,22 @@
 #!/bin/bash
+set -e
 
 PACKAGE=$(node -p "require('./package.json').name")
 VERSION=$(node -p "require('./package.json').version")
 
+echo "Running lint..."
+npm run lint
+
+echo "Running tests..."
+npm test
+
+echo "Checking if ${PACKAGE}@${VERSION} is already published..."
 STATUS=$(curl -s -o /dev/null -w "%{http_code}" "https://registry.npmjs.org/${PACKAGE}/${VERSION}")
+echo $STATUS
 if [ "$STATUS" = "200" ]; then
     echo "Error: ${PACKAGE}@${VERSION} is already published on NPM."
     echo "Bump the version in package.json before committing."
-    exit 1 
+    exit 1
 fi
 
 exit 0

package/.github/workflows/npm-publish-github-packages.yml

@@ -18,11 +18,12 @@ jobs:
           node-version: 25
           registry-url: 'https://registry.npmjs.org/'
 
-      - name: Install dependencies
-        run: npm install
-
-      - name: Run tests
-        run: npm test
+      # - name: Install dependencies
+      #   run: npm install
+      
+      # we remove tests until we have a beta env for the api
+      # - name: Run tests
+      #   run: npm test
 
       - name: Publish to NPM
         run: npm publish --access public

package/eslint.config.mjs

@@ -0,0 +1,19 @@
+import js from "@eslint/js";
+import globals from "globals";
+
+export default [
+    js.configs.recommended,
+    {
+        files: ["src/**/*.js"],
+        languageOptions: {
+            globals: {
+                ...globals.node,
+                fetch: "readonly",
+            },
+        },
+        rules: {
+            "no-unused-vars": "warn",
+            "no-console": "warn",
+        },
+    },
+];

package/index.js

@@ -1,4 +1,3 @@
-import InsigniaApiV1 from './src/v1/index.js';
+import Insignia from './src/index.js';
 
-export default InsigniaApiV1;
-export { InsigniaApiV1 };
+export default Insignia;

package/jest.config.mjs

@@ -1,201 +1,26 @@
-/**
- * For a detailed explanation regarding each configuration property, visit:
- * https://jestjs.io/docs/configuration
- */
-
 /** @type {import('jest').Config} */
 const config = {
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
-
-  // Stop running tests after `n` failures
-  // bail: 0,
-
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/private/var/folders/dr/s_4jjf_x5wv7vc0bgx5j8pw80000gn/T/jest_dx",
-
-  // Automatically clear mock calls, instances, contexts and results before every test
-  // clearMocks: false,
-
-  // Indicates whether the coverage information should be collected while executing the test
-  collectCoverage: true,
-
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: undefined,
-
-  // The directory where Jest should output its coverage files
-  coverageDirectory: "coverage",
-
-  // An array of regexp pattern strings used to skip coverage collection
-  // coveragePathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: "v8",
-
-  // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
-  //   "json",
-  //   "text",
-  //   "lcov",
-  //   "clover"
-  // ],
-
-  // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
-
-  // A path to a custom dependency extractor
-  // dependencyExtractor: undefined,
-
-  // Make calling deprecated APIs throw helpful error messages
-  // errorOnDeprecated: false,
-
-  // The default configuration for fake timers
-  // fakeTimers: {
-  //   "enableGlobally": false
-  // },
-
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
-
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
-
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
-
-  // A set of global variables that need to be available in all test environments
-  // globals: {},
-
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
-
-  // An array of directory names to be searched recursively up from the requiring module's location
-  // moduleDirectories: [
-  //   "node_modules"
-  // ],
-
-  // An array of file extensions your modules use
-  // moduleFileExtensions: [
-  //   "js",
-  //   "mjs",
-  //   "cjs",
-  //   "jsx",
-  //   "ts",
-  //   "tsx",
-  //   "json",
-  //   "node"
-  // ],
-
-  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
-
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  // modulePathIgnorePatterns: [],
-
-  // Activates notifications for test results
-  // notify: false,
-
-  // An enum that specifies notification mode. Requires { notify: true }
-  // notifyMode: "failure-change",
-
-  // A preset that is used as a base for Jest's configuration
-  // preset: undefined,
-
-  // Run tests from one or more projects
-  // projects: undefined,
-
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
-
-  // Automatically reset mock state before every test
-  // resetMocks: false,
-
-  // Reset the module registry before running each individual test
-  // resetModules: false,
-
-  // A path to a custom resolver
-  // resolver: undefined,
-
-  // Automatically restore mock state and implementation before every test
-  // restoreMocks: false,
-
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: undefined,
-
-  // A list of paths to directories that Jest should use to search for files in
-  // roots: [
-  //   "<rootDir>"
-  // ],
-
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
-
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  // setupFiles: [],
-
-  // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  // setupFilesAfterEnv: [],
-
-  // The number of seconds after which a test is considered as slow and reported as such in the results.
-  // slowTestThreshold: 5,
-
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
-
-  // The test environment that will be used for testing
-  // testEnvironment: "jest-environment-node",
-
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
-
-  // Adds a location field to test results
-  // testLocationInResults: false,
-
-  // The glob patterns Jest uses to detect test files
-  // testMatch: [
-  //   "**/__tests__/**/*.[jt]s?(x)",
-  //   "**/?(*.)+(spec|test).[tj]s?(x)"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
-
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: undefined,
-
-  // This option allows use of a custom test runner
-  // testRunner: "jest-circus/runner",
-
-  // A map from regular expressions to paths to transformers
-  // transform: undefined,
-
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   "/node_modules/",
-  //   "\\.pnp\\.[^\\/]+$"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
-
-  // Indicates whether each individual test should be reported during the run
-  // verbose: undefined,
-
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
-
-  // Whether to use watchman for file crawling
-  // watchman: true,
-
-  transform: {
-    '^.+\\.(js|jsx)$': 'babel-jest',
-  }
+    collectCoverage: true,
+    coverageDirectory: 'coverage',
+    coverageProvider: 'v8',
+
+    projects: [
+        {
+            displayName: 'unit',
+            testMatch: [
+                '<rootDir>/tests/client.test.js',
+                '<rootDir>/tests/api/**/*.test.js',
+            ],
+            transform: { '^.+\\.(js|jsx)$': 'babel-jest' },
+        },
+        {
+            displayName: 'integration',
+            testMatch: ['<rootDir>/tests/integration/**/*.test.js'],
+            transform: { '^.+\\.(js|jsx)$': 'babel-jest' },
+            setupFiles: ['<rootDir>/tests/integration/loadEnv.js'],
+            testTimeout: 30000,
+        },
+    ],
 };
+
 export default config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@insignia-education/api-sdk-js",
-  "version": "0.9.12",
+  "version": "0.9.17",
   "description": "JavaScript SDK for the Insignia Education API",
   "main": "index.js",
   "type": "module",
@@ -10,7 +10,8 @@
     "./api/v1": "./src/api/v1/index.js"
   },
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "lint": "eslint src/"
   },
   "repository": {
     "type": "git",
@@ -30,6 +31,8 @@
   "devDependencies": {
     "@babel/preset-env": "^7.26.0",
     "babel-jest": "^30.3.0",
+    "@eslint/js": "^9.0.0",
+    "eslint": "^9.0.0",
     "jest": "^30.3.0",
     "jest-html-reporter": "^4.3.0"
   }

package/src/Client.js

@@ -1,39 +1,33 @@
 export default class InsigniaClient {
     #baseUrl;
-    #token;
 
-    constructor(baseUrl = null, token = null) {
-        const resolved = baseUrl
-            ?? process.env.INSIGNIA_EDUCATION_API_BASE_URL
-            ?? 'https://insigniaeducation.com';
-        this.#baseUrl = resolved.replace(/\/$/, '');
-        this.#token = token;
+    constructor(baseUrl) {
+        this.#baseUrl = InsigniaClient._resolve(baseUrl);
     }
 
-    setToken(token) {
-        this.#token = token;
-    }
-
-    getToken() {
-        return this.#token;
+    static _resolve(baseUrl) {
+        baseUrl = baseUrl 
+                    ?? process.env.INSIGNIA_EDUCATION_API_BASE_URL 
+                    ?? 'https://insigniaeducation.com';
+        baseUrl = baseUrl.replace(/\/$/, '')
+        return baseUrl;
     }
 
     #headers() {
-        const headers = { 'Content-Type': 'application/json' };
-        if (this.#token) headers['Authorization'] = `Bearer ${this.#token}`;
-        return headers;
+        return { 'Content-Type': 'application/json' };
     }
 
     async #request(method, path, body = null) {
-        const options = { method, headers: this.#headers() };
+        const options = { method, headers: this.#headers(), credentials: 'include' };
         if (body !== null) options.body = JSON.stringify(body);
         const response = await fetch(`${this.#baseUrl}${path}`, options);
-        return response.json();
+        const data = await response.json();
+        return data?.success ? data.response : data;
     }
 
-    get(path)              { return this.#request('GET',    path); }
-    post(path, body = null){ return this.#request('POST',   path, body); }
-    put(path, body = null) { return this.#request('PUT',    path, body); }
-    patch(path, body = null){ return this.#request('PATCH', path, body); }
-    del(path)              { return this.#request('DELETE', path); }
+    get(path)               { return this.#request('GET',    path); }
+    post(path, body = null) { return this.#request('POST',   path, body); }
+    put(path, body = null)  { return this.#request('PUT',    path, body); }
+    patch(path, body = null){ return this.#request('PATCH',  path, body); }
+    del(path)               { return this.#request('DELETE', path); }
 }

package/src/api/index.js

@@ -1,20 +1,9 @@
-import InsigniaClient from "../Client";
-import InsigniaApiV1 from "./v1";
+import Insignia from '../index.js';
 
- 
-export default class InsigniaApi {
-    #client;
-
-    constructor(baseUrl = null, token = null) {
-        this.#client = new InsigniaClient(baseUrl, token);
-        this.v1 = new InsigniaApiV1(baseUrl, token);
-    }
-
-    setToken(token) {
-        this.#client.setToken(token);
-    }
-
-    getToken() {
-        return this.#client.getToken();
+export default class InsigniaApi extends Insignia {
+    constructor(baseUrl = null) {
+        let url = InsigniaApi._resolve(baseUrl);
+        if (!/\/api(\/|$)/.test(url)) url += '/api';
+        super(url);
     }
 }

package/src/api/v1/index.js

@@ -1,4 +1,4 @@
-import InsigniaClient from '../../Client.js';
+import InsigniaApi from '../index.js';
 import Auth from './Auth.js';
 import Accounts from './Accounts.js';
 import Categories from './Categories.js';
@@ -28,47 +28,40 @@ import UserTypes from './UserTypes.js';
 import Users from './Users.js';
 import Zoom from './Zoom.js';
 
-export default class InsigniaApiV1 {
-    #client;
+export default class InsigniaApiV1 extends InsigniaApi {
+    constructor(baseUrl = null) {
+        let url = InsigniaApiV1._resolve(baseUrl);
+        if (!/\/api(\/|$)/.test(url)) url += '/api';
+        if (!/\/v1(\/|$)/.test(url)) url += '/v1';
+        super(url);
 
-    constructor(baseUrl = null, token = null) {
-        this.#client = new InsigniaClient(baseUrl, token);
-
-        this.auth                 = new Auth(this.#client);
-        this.accounts             = new Accounts(this.#client);
-        this.categories           = new Categories(this.#client);
-        this.changelogs           = new Changelogs(this.#client);
-        this.configs              = new Configs(this.#client);
-        this.contactForms         = new ContactForms(this.#client);
-        this.conversationalTopics = new ConversationalTopics(this.#client);
-        this.countries            = new Countries(this.#client);
-        this.coupons              = new Coupons(this.#client);
-        this.courses              = new Courses(this.#client);
-        this.currencies           = new Currencies(this.#client);
-        this.files                = new Files(this.#client);
-        this.forums               = new Forums(this.#client);
-        this.hashes               = new Hashes(this.#client);
-        this.insignias            = new Insignias(this.#client);
-        this.languages            = new Languages(this.#client);
-        this.mailBlacklist        = new MailBlacklist(this.#client);
-        this.organizations        = new Organizations(this.#client);
-        this.quizzes              = new Quizzes(this.#client);
-        this.shortLinks           = new ShortLinks(this.#client);
-        this.surveys              = new Surveys(this.#client);
-        this.tags                 = new Tags(this.#client);
-        this.taxes                = new Taxes(this.#client);
-        this.teacher              = new Teacher(this.#client);
-        this.translations         = new Translations(this.#client);
-        this.userTypes            = new UserTypes(this.#client);
-        this.users                = new Users(this.#client);
-        this.zoom                 = new Zoom(this.#client);
-    }
-
-    setToken(token) {
-        this.#client.setToken(token);
-    }
-
-    getToken() {
-        return this.#client.getToken();
+        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);
+        this.coupons              = new Coupons(this);
+        this.courses              = new Courses(this);
+        this.currencies           = new Currencies(this);
+        this.files                = new Files(this);
+        this.forums               = new Forums(this);
+        this.hashes               = new Hashes(this);
+        this.insignias            = new Insignias(this);
+        this.languages            = new Languages(this);
+        this.mailBlacklist        = new MailBlacklist(this);
+        this.organizations        = new Organizations(this);
+        this.quizzes              = new Quizzes(this);
+        this.shortLinks           = new ShortLinks(this);
+        this.surveys              = new Surveys(this);
+        this.tags                 = new Tags(this);
+        this.taxes                = new Taxes(this);
+        this.teacher              = new Teacher(this);
+        this.translations         = new Translations(this);
+        this.userTypes            = new UserTypes(this);
+        this.users                = new Users(this);
+        this.zoom                 = new Zoom(this);
     }
 }

package/src/index.js

@@ -1,21 +1,8 @@
-import InsigniaClient from "./Client";
-import InsigniaApi from "./api";
+import InsigniaClient from './Client.js';
 
- 
-export default class Insignia {
-    #client;
+export default class Insignia extends InsigniaClient {
 
-    constructor(baseUrl = null, token = null) {
-        this.#client = new InsigniaClient(baseUrl, token);
-        this.api = new InsigniaApi(baseUrl, token);
-    }
-
-    setToken(token) {
-        this.#client.setToken(token);
-    }
-
-    getToken() {
-        return this.#client.getToken();
+    constructor(baseUrl = null) {
+        super(Insignia._resolve(baseUrl));
     }
 }
-

package/tests/client.test.js

@@ -81,51 +81,6 @@ describe('baseUrl resolution', () => {
     });
 });
 
-// ─── token management ────────────────────────────────────────────────────────
-
-describe('token management', () => {
-    test('getToken returns null by default', () => {
-        const client = new InsigniaClient();
-        expect(client.getToken()).toBeNull();
-    });
-
-    test('getToken returns token passed to constructor', () => {
-        const client = new InsigniaClient(null, 'my-token');
-        expect(client.getToken()).toBe('my-token');
-    });
-
-    test('setToken updates the token', () => {
-        const client = new InsigniaClient();
-        client.setToken('new-token');
-        expect(client.getToken()).toBe('new-token');
-    });
-
-    test('Authorization header is set when token is present', async () => {
-        global.fetch = mockFetch();
-        const client = new InsigniaClient(null, 'bearer-token');
-        await client.get('/test');
-        const [, options] = global.fetch.mock.calls[0];
-        expect(options.headers['Authorization']).toBe('Bearer bearer-token');
-    });
-
-    test('Authorization header is absent when no token', async () => {
-        global.fetch = mockFetch();
-        const client = new InsigniaClient();
-        await client.get('/test');
-        const [, options] = global.fetch.mock.calls[0];
-        expect(options.headers['Authorization']).toBeUndefined();
-    });
-
-    test('Authorization header updates after setToken', async () => {
-        global.fetch = mockFetch();
-        const client = new InsigniaClient();
-        client.setToken('updated-token');
-        await client.get('/test');
-        const [, options] = global.fetch.mock.calls[0];
-        expect(options.headers['Authorization']).toBe('Bearer updated-token');
-    });
-});
-
 // ─── HTTP methods ─────────────────────────────────────────────────────────────
 
 describe('HTTP methods', () => {
@@ -203,6 +158,12 @@ describe('HTTP methods', () => {
         expect(options.headers['Content-Type']).toBe('application/json');
     });
 
+    test('credentials is always include', async () => {
+        await client.get('/path');
+        const [, options] = global.fetch.mock.calls[0];
+        expect(options.credentials).toBe('include');
+    });
+
     test('returns parsed JSON from response', async () => {
         global.fetch = jest.fn().mockResolvedValue({
             json: () => Promise.resolve({ id: 1, name: 'test' }),

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

@@ -0,0 +1,76 @@
+import './cookieJar.js';
+import InsigniaApiV1 from '../../src/api/v1/index.js';
+
+const api = new InsigniaApiV1(process.env.INSIGNIA_EDUCATION_API_BASE_URL);
+beforeAll(async () => {
+    const email = process.env.TEST_EMAIL;
+    const password = process.env.TEST_PASSWORD;
+    const login = await api.auth.login({ email, password });
+});
+
+afterAll(async () => {
+    await api.auth.logout();
+});
+
+// ─── Read-only endpoints ──────────────────────────────────────────────────────
+describe('Countries', () => {
+    test('get() returns a list', async () => {
+        api.countries.get()
+        .then(response => {
+            expect(response["11"]).toBeDefined();
+            expect(response["11"]["id"]).toBeDefined();
+            expect(response["11"]["cod"]).toBeDefined();
+            expect(response["11"]["domain"]).toBeDefined();
+            expect(response["11"]["phone_prefix"]).toBeDefined();
+        });
+    });
+});
+
+describe('Currencies', () => {
+    test('get() returns a list', async () => {
+        api.currencies.get()
+        .then(response => {
+            expect(response["1"]).toBeDefined();
+            expect(response["1"]["id"]).toBeDefined();
+            expect(response["1"]["country_id"]).toBeDefined();
+            expect(response["1"]["cod"]).toBeDefined();
+            expect(response["1"]["title"]).toBeDefined();
+            expect(response["1"]["enabled"]).toBeDefined();
+            expect(response["1"]["has_double_expression"]).toBeDefined();
+            expect(response["1"]["double_expression_by"]).toBeDefined();
+            expect(response["1"]["created_at"]).toBeDefined();
+            expect(response["1"]["updated_at"]).toBeDefined();
+            expect(response["1"]["deleted_at"]).toBeDefined();
+        });
+    });
+
+    test('getValues() returns exchange values', async () => {
+        const res = await api.currencies.getValues()
+        .then(response => {
+            expect(response["USD"]).toBeDefined();
+            expect(response["USD"]["id"]).toBeDefined();
+            expect(response["USD"]["currency_id"]).toBeDefined();
+            expect(response["USD"]["value"]).toBeDefined();
+            expect(response["USD"]["created_at"]).toBeDefined();
+            expect(response["USD"]["updated_at"]).toBeDefined();
+        });
+    });
+});
+
+describe('Languages', () => {
+    test('get() returns a list', async () => {
+        const res = await api.languages.get()
+        .then(response => {
+            expect(response["1"]).toBeDefined();
+            expect(response["1"]["id"]).toBeDefined();
+            expect(response["1"]["iso"]).toBeDefined();
+            expect(response["1"]["flag_emoji"]).toBeDefined();
+            expect(response["1"]["enabled"]).toBeDefined();
+            expect(response["1"]["default"]).toBeDefined();
+            expect(response["1"]["created_at"]).toBeDefined();
+            expect(response["1"]["updated_at"]).toBeDefined();
+            expect(response["1"]["deleted_at"]).toBeDefined();
+        });
+    });
+});
+