Qase API JavaScript Client

Common errors

• Error: Request failed with status code 401

  cause The Qase API token provided is missing or invalid, leading to an authentication failure.
  fix Ensure the `token` passed to `new QaseApi()` is a valid API token obtained from your Qase TMS account (personal API tokens page or app integrations page) and that it has the necessary permissions. Use environment variables like `process.env.QASE_API_TOKEN` to manage tokens securely.

• Cannot read properties of undefined (reading 'data')

  cause This often occurs when an API call fails, and the `res` object (AxiosResponse) does not contain the expected `data` property, or the `res.data` itself is not the expected structure.
  fix Wrap API calls in `try...catch` blocks. Inspect the `error.response` object in the catch block to get details like status code and error messages from the API (`error.response.data`). This helps in debugging unexpected API responses.

• TypeError: ProjectCreate is not a constructor

  cause Attempting to use `ProjectCreate` (or similar models) without importing it from the correct subpath.
  fix Ensure you are importing models from the specific `qaseio.models` subpath: `import { ProjectCreate } from 'qaseio.models';`

Warnings

• deprecated The `qaseio` package itself is explicitly marked as deprecated within the Qase JavaScript monorepo (e.g., in `qase-javascript-commons-v2.6.2` changelog). Users should consider migrating to specific reporter packages or newer API clients if available.
  Fix: Review Qase TMS official documentation for the recommended API client or reporter for new projects. For existing projects, evaluate the impact of deprecation.
• gotcha For integrating with common testing frameworks (e.g., Jest, Cypress, Playwright, Mocha), Qase recommends using their dedicated framework-specific reporter packages (e.g., `@qase-tms/qase-jest`, `@qase-tms/qase-cypress`) instead of the generic `qaseio` client. This package is intended for custom integrations and specialized reporters.
  Fix: Install the appropriate Qase reporter package for your testing framework (e.g., `npm install @qase-tms/qase-jest`) and follow its specific configuration instructions.
• gotcha The package requires Node.js version 14 or higher. Running in older Node.js environments may lead to unexpected errors or unsupported features.
  Fix: Upgrade your Node.js environment to version 14 or later. Use a Node.js version manager like `nvm` to easily switch versions.

Install

• npm install qaseio npm
• yarn add qaseio yarn
• pnpm add qaseio pnpm

Imports

• QaseApi
  wrong:

  const { QaseApi } = require('qaseio');

  correct:

  import { QaseApi } from 'qaseio';

  While CommonJS `require` might work, ESM `import` is the preferred modern syntax and provides better TypeScript support.
• ProjectCreate
  wrong:

  import { ProjectCreate } from 'qaseio';

  correct:

  import { ProjectCreate } from 'qaseio.models';

  Models like `ProjectCreate` are exposed via a specific subpath `qaseio.models` rather than the root package entry.
• QaseApi

  const qaseio = require('qaseio'); const qase = new qaseio.QaseApi({ ... });

  For CommonJS environments, the library exports QaseApi directly on the root object. Avoid destructuring directly from `require('qaseio')` as shown in the wrong example for ESM.

Quickstart

This example demonstrates how to initialize the Qase API client, fetch all available projects, create a new project, and check for its existence using environment variables for authentication.

import { QaseApi, ProjectCreate } from 'qaseio';

const QASE_API_TOKEN = process.env.QASE_API_TOKEN ?? '';
const PROJECT_CODE = process.env.QASE_PROJECT_CODE ?? 'PRJCODE';

const qase = new QaseApi({
    token: QASE_API_TOKEN,
});

async function manageQaseProjects() {
  if (!QASE_API_TOKEN) {
    console.error('QASE_API_TOKEN environment variable is not set.');
    return;
  }

  try {
    console.log('Fetching all projects...');
    const allProjects = await qase.projects.getAll();
    console.log('All Projects Data:', allProjects.data);

    const newProjectTitle = `My New Project ${Date.now()}`;
    const newProjectCode = `NPRJ${Date.now().toString().slice(-4)}`;
    console.log(`Creating a new project: ${newProjectTitle} (${newProjectCode})...`);
    const prj = new ProjectCreate(newProjectTitle, newProjectCode);
    const createdProject = await qase.projects.create(prj);
    console.log('Created Project:', createdProject.data);

    console.log(`Checking if project ${newProjectCode} exists...`);
    const projectExists = await qase.projects.exists(newProjectCode);
    console.log(`Project ${newProjectCode} exists:`, projectExists);

  } catch (error) {
    console.error('An error occurred:', error.response ? error.response.data : error.message);
  }
}

manageQaseProjects();