### Install Project Dependencies

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/cypress/README.md

Installs the necessary Node.js dependencies for the Qase JavaScript Cypress example project using npm.

```bash
npm install
```

--------------------------------

### Clone and Navigate Qase JavaScript Cypress Example

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/cypress/README.md

Clones the Qase JavaScript Cypress example repository and navigates into the project directory. Requires Git to be installed.

```bash
git clone https://github.com/qase-tms/qase-javascript.git
cd qase-js/examples/cypress
```

--------------------------------

### Install Dependencies for Jest Example

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/jest/README.md

Installs the necessary Node.js dependencies for the Jest example project using npm. This command ensures all required packages are available for running tests.

```bash
npm install
```

--------------------------------

### Get Started with Qase API v2 Client

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-v2-client/README.md

Provides a comprehensive example of how to initialize and use the Qase API v2 client to create a test run result. It covers configuration, authentication, and making the API call.

```typescript
import { ResultsApi, Configuration } from 'qase-api-v2-client';

// Defining the host is optional and defaults to https://api.qase.io/v2
// See configuration.ts for a list of all supported configuration parameters.
const configuration = new Configuration({
    basePath: "https://api.qase.io/v2"
});

// The client must configure the authentication and authorization parameters
// in accordance with the API server security policy.
// Examples for each auth method are provided below, use the example that
// satisfies your auth use case.

// Configure API key authorization: TokenAuth
configuration.apiKey = process.env.API_KEY;

// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// configuration.apiKeyPrefix = 'Bearer';

// Create an instance of the API class
const qaseApi = new ResultsApi(configuration);

// Create test run result
try {
    const result = await qaseApi.results.createResultV2('MP', 1, {
        title: 'Test Result',
        execution: {
            status: 'passed',
            duration: 1000
        },
        testops_id: 1,
        steps: [
            {
                position: 1,
                status: 'passed',
                comment: 'Step completed successfully'
            }
        ]
    });
    console.log(result);
} catch (error) {
    console.error('Error creating result:', error);
}
```

--------------------------------

### Clone and Navigate Project Repository

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/cypressCucumber/README.md

Clones the qase-javascript repository and navigates into the specific Cypress Cucumber example directory. Requires Git to be installed.

```bash
git clone https://github.com/qase-tms/qase-javascript.git
cd qase-js/examples/cypressCucubmer
```

--------------------------------

### Open Cypress Test Runner

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/cypress/README.md

Opens the Cypress Test Runner to manually execute tests locally. Requires Cypress to be installed as a project dependency.

```bash
npx cypress open
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/cypressCucumber/README.md

Installs all necessary Node.js dependencies for the project using npm. Requires Node.js and npm/yarn to be installed.

```bash
npm install
```

--------------------------------

### Clone and Navigate Jest Example Project

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/jest/README.md

Clones the qase-javascript repository and navigates into the Jest example directory. This is the first step to set up the project for testing.

```bash
git clone https://github.com/qase-tms/qase-javascript.git
cd qase-js/examples/jest
```

--------------------------------

### Open Cypress Test Runner

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/cypressCucumber/README.md

Opens the Cypress Test Runner application, allowing manual execution and debugging of tests. Requires Cypress to be installed as a project dependency.

```bash
npx cypress open
```

--------------------------------

### Install Cypress Qase Reporter

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-cypress/README.md

Installs the latest release version of the cypress-qase-reporter using npm.

```sh
npm install -D cypress-qase-reporter
```

--------------------------------

### Install qaseio Package

Source: https://github.com/qase-tms/qase-javascript/blob/main/qaseio/README.md

Installs the qaseio JavaScript package using npm. This is the first step to using the Qase API client in your project.

```bash
npm install qaseio
```

--------------------------------

### Install Qase API Client via npm

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/README.md

Installs the qase-api-client package using npm, a package manager for Node.js. This is the first step to using the Qase API client in your project.

```bash
npm install qase-api-client
```

--------------------------------

### Install TestCafe Qase Reporter

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-testcafe/README.md

Installs the latest version of the testcafe-reporter-qase package as a development dependency.

```sh
npm install -D testcafe-reporter-qase
```

--------------------------------

### Update Configuration in Qase API

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/ConfigurationsApi.md

Demonstrates how to update a specific configuration in the Qase TMS using the `qase-api-client` library. It shows the setup of the API client, the data payload for the update, and how to call the `updateConfiguration` method with project code, configuration ID, and update data. The example also includes basic response handling.

```typescript
import { ConfigurationsApi, Configuration } from 'qase-api-client';

const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});
configuration.apiKey = process.env.API_KEY;

const api = new ConfigurationsApi(configuration);

// Update configuration
const updateData = {
    title: 'Updated Configuration Title',
    description: 'Updated description',
    group: 'Updated Group',
    is_active: false
};

const response = await api.updateConfiguration('PROJECT_CODE', 123, updateData);
if (response.status) {
    console.log('Configuration updated successfully');
}
```

--------------------------------

### Install Qase TMS Newman Reporter

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-newman/README.md

Install the latest version of the Qase TMS Newman reporter using npm.

```bash
npm install newman-reporter-qase
```

--------------------------------

### Configure Qase Cypress Reporter for Cucumber in cypress.config.js

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-cypress/README.md

This configuration example demonstrates setting up the Qase Cypress reporter for projects using Cucumber. It includes the necessary `cypress-cucumber-preprocessor` setup, Qase reporter options, and the `after:spec` hook. It also specifies the `specPattern` for `.feature` files.

```javascript
import cypress from 'cypress';
import { afterSpecHook } from 'cypress-qase-reporter/hooks';

const cucumber = require('cypress-cucumber-preprocessor').default;

module.exports = cypress.defineConfig({
  reporter: 'cypress-multi-reporters',
  reporterOptions: {
    reporterEnabled: 'cypress-mochawesome-reporter, cypress-qase-reporter',
    cypressMochawesomeReporterReporterOptions: {
      charts: true,
    },
    cypressQaseReporterReporterOptions: {
      debug: true,

      testops: {
        api: {
          token: 'api_key',
        },

        project: 'project_code',
        uploadAttachments: true,

        run: {
          complete: true,
        },
      },

      framework: {
        cypress: {
          screenshotsFolder: 'cypress/screenshots',
          videosFolder: 'cypress/videos',
          uploadDelay: 10, 
        },
      },
    },
  },
  video: false,
  e2e: {
    setupNodeEvents(on, config) {
      on('file:preprocessor', cucumber());
      require('cypress-qase-reporter/plugin')(on, config);
      require('cypress-qase-reporter/metadata')(on);
      on('after:spec', async (spec, results) => {
         await afterSpecHook(spec, config);
       });
    },
    specPattern: 'cypress/e2e/*.feature',
  },
});
```

--------------------------------

### Install wdio-qase-reporter

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-wdio/README.md

Installs the latest version of the wdio-qase-reporter package as a development dependency.

```sh
npm install -D wdio-qase-reporter
```

--------------------------------

### Install Qase API Client via yarn

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/README.md

Installs the qase-api-client package using yarn, an alternative package manager for Node.js. This command adds the client library to your project's dependencies.

```bash
yarn add qase-api-client
```

--------------------------------

### Install Qase JavaScript Commons

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-javascript-commons/README.md

This snippet shows the command to install the Qase JavaScript Commons package using npm. This package is an SDK for developing test reporters for Qase TMS.

```bash
npm install qase-javascript-commons
```

--------------------------------

### Install mocha-qase-reporter

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-mocha/README.md

Installs the latest version of the mocha-qase-reporter package as a development dependency.

```sh
npm install -D mocha-qase-reporter
```

--------------------------------

### Get Environments - TypeScript

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/EnvironmentsApi.md

Shows how to fetch all environments within a specified Qase project using the EnvironmentsApi. The example includes API client configuration and the call to getEnvironments with the project code. It then iterates through the returned environments, logging details such as total count, filtered count, and individual environment titles and IDs.

```typescript
import { EnvironmentsApi, Configuration } from 'qase-api-client';

const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});
configuration.apiKey = process.env.API_KEY;

const api = new EnvironmentsApi(configuration);

const response = await api.getEnvironments('PROJECT_CODE');
console.log(`Total environments: ${response.result.total}`);
console.log(`Filtered: ${response.result.filtered}`);
console.log(`Count: ${response.result.count}`);

response.result.entities.forEach(environment => {
    console.log(`Title: ${environment.title}`);
    console.log(`ID: ${environment.id}`);
    console.log(`Host: ${environment.host}`);
    console.log('---');
});
```

--------------------------------

### Install Qase API Client via npm

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-v2-client/README.md

Installs the Qase API v2 client package using npm. This is a prerequisite for using the client in your Node.js or browser projects.

```bash
npm install qase-api-v2-client
```

--------------------------------

### Install Qase API Client via yarn

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-v2-client/README.md

Installs the Qase API v2 client package using yarn. This is an alternative to npm for package management.

```bash
yarn add qase-api-v2-client
```

--------------------------------

### Install Playwright Qase Reporter

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-playwright/README.md

Installs the latest version of the playwright-qase-reporter package as a development dependency using npm.

```sh
npm install -D playwright-qase-reporter
```

--------------------------------

### Install jest-qase-reporter

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-jest/README.md

Installs the latest version of the jest-qase-reporter package as a development dependency using npm.

```shell
npm install --save-dev jest-qase-reporter
```

--------------------------------

### Install Qase TMS JavaScript Client

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/playwright/test/attachments/test-file.txt

This snippet shows how to install the Qase TMS JavaScript client library using npm. This is a prerequisite for using the Qase TMS API in your JavaScript project.

```bash
npm install qase-javascript-client

```

--------------------------------

### Install Qase TMS JavaScript Client

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/playwright/test/attachments/test-file.txt

This snippet shows how to install the Qase TMS JavaScript client library using npm. This is a prerequisite for using the Qase TMS API in your JavaScript project.

```bash
npm install qase-javascript-client

```

--------------------------------

### Install Qase TMS JavaScript Client

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/jest/test/attachments/test-file.txt

This snippet shows how to install the Qase TMS JavaScript client library using npm. This is a prerequisite for using the Qase TMS API in your JavaScript project.

```bash
npm install qase-javascript-client

```

--------------------------------

### ResultStepExecution Model Example (TypeScript)

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-v2-client/docs/ResultStepExecution.md

An example demonstrating how to create a ResultStepExecution object with various properties like status, start time, end time, duration, comment, and attachments.

```typescript
const stepExecution: ResultStepExecution = {
    status: 'passed',
    start_time: 1678901234.567,
    end_time: 1678901235.678,
    duration: 1111,
    comment: 'Step executed successfully',
    attachments: ['abc123']
};
```

--------------------------------

### Create Qase Test Run

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/README.md

Provides a comprehensive example of using the Qase API client to create a test run. It shows how to configure the API client, set authentication, and define the test run parameters like title, description, cases, environment, milestone, and tags. Error handling is included.

```typescript
import { RunsApi, Configuration } from 'qase-api-client';

// Defining the host is optional and defaults to https://api.qase.io/v2
// See configuration.ts for a list of all supported configuration parameters.
const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});

// The client must configure the authentication and authorization parameters
// in accordance with the API server security policy.
// Examples for each auth method are provided below, use the example that
// satisfies your auth use case.

// Configure API key authorization: TokenAuth
configuration.apiKey = process.env.API_KEY;

// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// configuration.apiKeyPrefix = 'Bearer';

// Create an instance of the API class
const qaseApi = new RunsApi(configuration);

// Create test run
try {
    const run = {
        title: 'Regression Test Run',
        description: 'Full regression testing before release',
        cases: [1, 2, 3, 4, 5],
        environment_id: 1,
        milestone_id: 1,
        tags: ['regression', 'release']
    };

    const response = await api.createRun('PROJECT_CODE', run);
    console.log(`Created test run with ID: ${response.result.id}`);
} catch (error) {
    console.error('Error creating run:', error);
}
```

--------------------------------

### ResultExecution Model Example (TypeScript)

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-v2-client/docs/ResultExecution.md

An example demonstrating how to create a ResultExecution object with properties like status, start time, end time, duration, stacktrace, and thread. This model is crucial for reporting test outcomes in Qase.

```typescript
const resultExecution: ResultExecution = {
    status: 'passed',
    start_time: 1678901234.567,
    end_time: 1678901235.678,
    duration: 1111,
    stacktrace: null,
    thread: 'main'
};
```

--------------------------------

### Run Cypress Tests with Qase Integration

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/cypress/README.md

Executes Cypress tests and uploads the results to Qase Test Management. Requires Qase API token and project code as environment variables.

```bash
npx cypress run --env qaseApiToken=YOUR_QASE_API_TOKEN,qaseProjectCode=YOUR_PROJECT_CODE
```

--------------------------------

### Import ResultApi from Qase API Client

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/README.md

Demonstrates how to import the ResultApi class from the qase-api-client package in TypeScript. This is typically done after installation to start using API functionalities.

```typescript
import { ResultApi } from 'qase-api-client';
```

--------------------------------

### Get All Milestones in Qase TMS

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/MilestonesApi.md

Provides an example of how to retrieve all milestones within a Qase TMS project using the JavaScript client. It supports filtering by status and due date, and returns total counts, filtered counts, and entity details.

```typescript
import { MilestonesApi, Configuration } from 'qase-api-client';

const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});
configuration.apiKey = process.env.API_KEY;

const api = new MilestonesApi(configuration);

// Get all milestones with filtering
const params = {
    limit: 10,
    offset: 0,
    filters: {
        status: ['active'],
        due_date: {
            from: '2024-01-01',
            to: '2024-12-31'
        }
    }
};

const response = await api.getMilestones('PROJECT_CODE', params);
console.log(`Total milestones: ${response.result.total}`);
console.log(`Filtered: ${response.result.filtered}`);
console.log(`Count: ${response.result.count}`);

response.result.entities.forEach(milestone => {
    console.log(`[${milestone.id}] ${milestone.title}`);
    console.log(`Due date: ${milestone.due_date}`);
    console.log(`Status: ${milestone.status}`);
    console.log('---');
});
```

--------------------------------

### Get Specific Defect in Qase API (TypeScript)

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/DefectsApi.md

Provides an example of retrieving a single defect's details from Qase using the project code and defect ID. The response includes the defect's title, description, severity, status, and attachments.

```typescript
import { DefectsApi, Configuration } from 'qase-api-client';

const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});
configuration.apiKey = process.env.API_KEY;

const api = new DefectsApi(configuration);

const response = await api.getDefect('PROJECT_CODE', 1);
console.log(`Defect title: ${response.result.title}`);
console.log(`Description: ${response.result.description}`);
console.log(`Severity: ${response.result.severity}`);
console.log(`Status: ${response.result.status}`);
console.log(`Attachments: ${JSON.stringify(response.result.attachments)}`);
```

--------------------------------

### Create Project with Qase JavaScript API

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/ProjectsApi.md

Demonstrates how to create a new project using the ProjectsApi in the Qase JavaScript client. It requires project details like title, code, description, access, and group. The API client needs a configuration with the base path and an API key.

```typescript
import { ProjectsApi, Configuration } from 'qase-api-client';

const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});
configuration.apiKey = process.env.API_KEY;

const api = new ProjectsApi(configuration);

// Create a new project
const projectData = {
    title: 'My Project',
    code: 'MP',
    description: 'Project description',
    access: 'all',
    group: 'Development'
};

const response = await api.createProject(projectData);
console.log(`Created project with code: ${response.result.code}`);
```

--------------------------------

### Delete Environment - TypeScript

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/EnvironmentsApi.md

Provides an example of deleting an environment from a Qase project using the EnvironmentsApi. It shows the necessary setup for the API client and how to call the deleteEnvironment method with the project code and environment ID. The response indicates whether the deletion was successful.

```typescript
import { EnvironmentsApi, Configuration } from 'qase-api-client';

const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});
configuration.apiKey = process.env.API_KEY;

const api = new EnvironmentsApi(configuration);

const response = await api.deleteEnvironment('PROJECT_CODE', 1);
console.log(`Environment deleted: ${response.result}`);
```

--------------------------------

### Get All Shared Steps in Qase TMS (TypeScript)

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/SharedStepsApi.md

Shows how to fetch all shared steps within a specified project in Qase TMS using the JavaScript client. The example logs the total count, filtered count, and iterates through each shared step to display its title, hash, and step count.

```typescript
import { SharedStepsApi, Configuration } from 'qase-api-client';

const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});
configuration.apiKey = process.env.API_KEY;

const api = new SharedStepsApi(configuration);

const response = await api.getSharedSteps('PROJECT_CODE');
console.log(`Total shared steps: ${response.result.total}`);
console.log(`Filtered: ${response.result.filtered}`);
console.log(`Count: ${response.result.count}`);

response.result.entities.forEach(sharedStep => {
    console.log(`Title: ${sharedStep.title}`);
    console.log(`Hash: ${sharedStep.hash}`);
    console.log(`Steps count: ${sharedStep.steps.length}`);
    console.log('---');
});
```

--------------------------------

### Get Environment - TypeScript

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/EnvironmentsApi.md

Illustrates how to retrieve a specific environment's details from a Qase project using the EnvironmentsApi. The example demonstrates configuring the API client and calling getEnvironment with the project code and environment ID. The output logs the retrieved environment's title, description, host, and variables.

```typescript
import { EnvironmentsApi, Configuration } from 'qase-api-client';

const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});
configuration.apiKey = process.env.API_KEY;

const api = new EnvironmentsApi(configuration);

const response = await api.getEnvironment('PROJECT_CODE', 1);
console.log(`Environment title: ${response.result.title}`);
console.log(`Description: ${response.result.description}`);
console.log(`Host: ${response.result.host}`);
console.log(`Variables: ${JSON.stringify(response.result.variables)}`);
```

--------------------------------

### Run Jest Tests and Upload Results to Qase

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/jest/README.md

Executes Jest tests in band and uploads the results to Qase Test Management. This command requires a `qase.config.json` file to be configured.

```bash
npx jest --runInBand
```

--------------------------------

### Create Environment - TypeScript

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/EnvironmentsApi.md

Demonstrates how to create a new environment in a Qase project using the EnvironmentsApi. It includes setting up the API client configuration, defining environment details like title, description, host, and variables, and making the API call. The response contains the ID of the newly created environment.

```typescript
import { EnvironmentsApi, Configuration } from 'qase-api-client';

const configuration = new Configuration({
    basePath: "https://api.qase.io/v2"
});
configuration.apiKey = process.env.API_KEY;

const api = new EnvironmentsApi(configuration);

const environment = {
    title: 'Staging Environment',
    description: 'Staging environment for testing',
    host: 'staging.example.com',
    variables: {
        API_URL: 'https://api.staging.example.com',
        DB_HOST: 'db.staging.example.com'
    }
};

const response = await api.createEnvironment('PROJECT_CODE', environment);
console.log(`Created environment with ID: ${response.result.id}`);
```

--------------------------------

### Create Configuration - JavaScript/TypeScript

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/ConfigurationsApi.md

Demonstrates how to create a new configuration within a Qase project using the JavaScript client. It requires project code and configuration data including title, description, group, and active status.

```typescript
import { ConfigurationsApi, Configuration } from 'qase-api-client';

const configuration = new Configuration({
    basePath: "https://api.qase.io/v1"
});
configuration.apiKey = process.env.API_KEY;

const api = new ConfigurationsApi(configuration);

// Create a new configuration
const configData = {
    title: 'Production Environment',
    description: 'Production environment configuration',
    group: 'Environments',
    is_active: true
};

const response = await api.createConfiguration('PROJECT_CODE', configData);
console.log(`Created configuration ID: ${response.result.id}`);
```

--------------------------------

### Run Cypress Tests with Qase Integration

Source: https://github.com/qase-tms/qase-javascript/blob/main/examples/cypressCucumber/README.md

Executes Cypress tests and uploads the results to Qase Test Management. Requires Qase API token and project code as environment variables.

```bash
npx cypress run --env qaseApiToken=YOUR_QASE_API_TOKEN,qaseProjectCode=YOUR_PROJECT_CODE
```

--------------------------------

### Run Cypress Tests with Qase Reporter

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-cypress/README.md

Commands to execute Cypress tests and report results to Qase.io using environment variables or npm scripts.

```bash
QASE_MODE=testops npx cypress run
```

```bash
npm test
```

--------------------------------

### Install Cucumber JS Qase Reporter

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-cucumberjs/README.md

Installs the latest version of the cucumberjs-qase-reporter package as a development dependency using npm.

```sh
npm install -D cucumberjs-qase-reporter
```

--------------------------------

### JavaScript PlanCreate Model

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-client/docs/PlanCreate.md

Defines the structure for creating a test plan in Qase TMS using JavaScript. It includes required fields like title and cases, and an optional description.

```javascript
class PlanCreate {
    constructor(title, cases, description) {
        this.title = title;
        this.cases = cases;
        this.description = description;
    }
}
```

--------------------------------

### ResultStep Model Example (TypeScript)

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-v2-client/docs/ResultStep.md

This example demonstrates how to construct a ResultStep object, including nested steps, execution details, and data, conforming to the Qase JavaScript API.

```typescript
const resultStep: ResultStep = {
    execution: {
        duration: 1000,
        status: 'passed'
    },
    data: {
        action: 'Click on the login button',
        expected_result: 'User is logged in',
        actual_result: 'User was successfully logged in'
    },
    steps: [
        {
            data: {
                action: 'Enter username',
                expected_result: 'Username is entered'
            },
            execution: {
                status: 'passed',
                duration: 500
            }
        },
        {
            data: {
                action: 'Enter password',
                expected_result: 'Password is entered'
            },
            execution: {
                status: 'passed',
                duration: 500
            }
        }
    ]
};
```

--------------------------------

### Qase TMS Configuration (JSON)

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-javascript-commons/README.md

Example of a qase.config.json file for configuring Qase TMS integration. It includes settings for mode, reporting, API credentials, test run details, defect management, project code, batch size, and configuration values.

```json
{
  "mode": "testops",
  "fallback": "report",
  "debug": false,
  "environment": "local",
  "captureLogs": false,
  "report": {
    "driver": "local",
    "connection": {
      "local": {
        "path": "./build/qase-report",
        "format": "json"
      }
    }
  },
  "testops": {
    "api": {
      "token": "<token>",
      "host": "qase.io"
    },
    "run": {
      "title": "Regress run",
      "description": "Regress run description",
      "complete": true,
      "tags": ["tag1", "tag2"],
      "externalLink": {
        "type": "jiraCloud",
        "link": "PROJ-123"
      }
    },
    "defect": false,
    "project": "<project_code>",
    "batch": {
      "size": 100
    },
    "configurations": {
      "values": [
        {
          "name": "group1",
          "value": "value1"
        },
        {
          "name": "group2", 
          "value": "value2"
        }
      ],
      "createIfNotExists": true
    }
  }
}
```

--------------------------------

### Create Result Fields Example

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-api-v2-client/docs/ResultCreateFields.md

Demonstrates how to instantiate and populate the ResultCreateFields model with standard and dynamic properties for a test result.

```typescript
const fields: ResultCreateFields = {
    author: 'john.doe@example.com',
    description: 'Test case for user login functionality',
    preconditions: 'User account exists',
    postconditions: 'User is logged in',
    layer: 'UI',
    severity: 'high',
    priority: 'medium',
    behavior: 'positive',
    type: 'functional',
    muted: 'false',
    is_flaky: 'false',
    executed_by: 'jane.doe@example.com',
    // Dynamic fields
    'custom_field_1': 'value1',
    'custom_field_2': 'value2'
};
```

--------------------------------

### Qase TMS Environment Variables (Bash)

Source: https://github.com/qase-tms/qase-javascript/blob/main/qase-javascript-commons/README.md

Examples of setting environment variables for Qase TMS integration using Bash. Demonstrates how to configure external links for Jira Cloud and Jira Server.

```bash
# Set external link for Jira Cloud
export QASE_TESTOPS_RUN_EXTERNAL_LINK='{"type":"jiraCloud","link":"PROJ-123"}'

# Set external link for Jira Server
export QASE_TESTOPS_RUN_EXTERNAL_LINK='{"type":"jiraServer","link":"PROJ-456"}'
```