testit-api-client 1.0.6 → 1.0.8

package/README.md

@@ -1,11 +1,11 @@
-# TestGear TMS API client for JavaScript
-![TestGear](https://raw.githubusercontent.com/testgear-tms/api-client-js/main/images/banner.png)
+# Test IT TMS API client for JavaScript
+![Test IT](https://raw.githubusercontent.com/testit-tms/api-client-js/master/images/banner.png)
 
 # Getting Started
 
 ## Installation
 ```
-npm install testgear-api-client
+npm install testit-api-client
 ```
 
 # Usage
@@ -23,7 +23,7 @@ const client = new Client({
 });
 ```
 
-After configuration is done you can access different clients from `Client` object and then use methods to control TestGear.
+After configuration is done you can access different clients from `Client` object and then use methods to control Test IT.
 
 ## Examples
 ```ts
@@ -40,12 +40,12 @@ await client.completeTestRun(testRunId);
 
 You can help to develop the project. Any contributions are **greatly appreciated**.
 
-* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/testgear-tms/api-client-js/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
+* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/testit-tms/api-client-js/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
 * Please make sure you check your spelling and grammar.
 * Create individual PR for each suggestion.
-* Please also read through the [Code Of Conduct](https://github.com/testgear-tms/api-client-js/blob/master/CODE_OF_CONDUCT.md) before posting your first idea as well.
+* Please also read through the [Code Of Conduct](https://github.com/testit-tms/api-client-js/blob/master/CODE_OF_CONDUCT.md) before posting your first idea as well.
 
 # License
 
-Distributed under the Apache-2.0 License. See [LICENSE](https://github.com/testgear-tms/api-client-js/blob/master/LICENSE.md) for more information.
+Distributed under the Apache-2.0 License. See [LICENSE](https://github.com/testit-tms/api-client-js/blob/master/LICENSE.md) for more information.
 

package/dist/client.d.ts

@@ -0,0 +1,24 @@
+import { Attachment, Autotest, AutotestPost, AutotestPut, AutotestQuery, AutotestResultsForTestRun, ClientConfig, ClientConfigWithFile, IClient, TestRunGet, TestRunPost, WorkItemId } from './types';
+export declare class Client implements IClient {
+    private readonly axios;
+    private config;
+    private readonly request;
+    constructor(config: Partial<ClientConfigWithFile>);
+    checkConnection(): Promise<void>;
+    getAutotest(query: AutotestQuery): Promise<Autotest[]>;
+    createAutotest(autotest: AutotestPost): Promise<Autotest>;
+    updateAutotest(autotest: AutotestPut): Promise<void>;
+    linkToWorkItem(autotestId: string, workItem: WorkItemId): Promise<void>;
+    getTestRun(testRunId: string): TestRunGet;
+    getTestRunById(testRunId: string): Promise<TestRunGet>;
+    createTestRun(testRun: TestRunPost): Promise<TestRunGet>;
+    startTestRun(testRunId: string): Promise<void>;
+    loadTestRunResults(testRunId: string, results: AutotestResultsForTestRun[]): Promise<string[]>;
+    completeTestRun(testRunId: string): Promise<void>;
+    getConfig(): ClientConfig;
+    loadAttachment(filePath: string): Promise<Attachment>;
+    private readCliConfig;
+    private readEnvConfig;
+    private readConfigFile;
+    static mergeConfig(oldConfig: Partial<ClientConfig>, newConfig: Partial<ClientConfig>): Partial<ClientConfig>;
+}

package/dist/client.js

@@ -0,0 +1,174 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const axios_1 = __importDefault(require("axios"));
+const minimist_1 = __importDefault(require("minimist"));
+const fs_1 = require("fs");
+const form_data_1 = __importDefault(require("form-data"));
+const path_1 = require("path");
+const validation_1 = require("./validation");
+// TODO: implement via the base client
+var XMLHttpRequest = require("xmlhttprequest").XMLHttpRequest;
+class Client {
+    constructor(config) {
+        const { configFile } = config, restConfig = __rest(config, ["configFile"]);
+        let finalConfig = restConfig;
+        if (configFile) {
+            finalConfig = Client.mergeConfig(finalConfig, this.readConfigFile(configFile));
+        }
+        finalConfig = Client.mergeConfig(finalConfig, this.readEnvConfig());
+        finalConfig = Client.mergeConfig(finalConfig, this.readCliConfig());
+        this.config = (0, validation_1.validateConfig)(config);
+        const baseURL = new URL('/api/v2', this.config.url).toString();
+        this.axios = axios_1.default.create({
+            baseURL,
+            headers: {
+                Authorization: `PrivateToken ${this.config.privateToken}`,
+            },
+        });
+        // TODO: implement via the base client
+        this.request = new XMLHttpRequest();
+    }
+    async checkConnection() {
+        try {
+            await axios_1.default.get(new URL('version.json', this.config.url).toString());
+        }
+        catch (err) {
+            throw new Error('Cannot connect to TMS');
+        }
+    }
+    // TODO: add query object
+    async getAutotest(query) {
+        const params = new URLSearchParams();
+        Object.keys(query).forEach((key) => {
+            const value = query[key];
+            if (value === undefined) {
+                return;
+            }
+            if (Array.isArray(value)) {
+                value.forEach((v) => params.append(key, v));
+            }
+            else {
+                params.append(key, value.toString());
+            }
+        });
+        return this.axios
+            .get(`/autoTests?${params.toString()}`)
+            .then((res) => res.data);
+    }
+    async createAutotest(autotest) {
+        return this.axios.post('/autoTests', autotest).then((res) => res.data);
+    }
+    async updateAutotest(autotest) {
+        return this.axios.put('/autoTests', autotest);
+    }
+    async linkToWorkItem(autotestId, workItem) {
+        return this.axios.post(`/autoTests/${autotestId}/workItems`, workItem);
+    }
+    // TODO: implement via the base client
+    getTestRun(testRunId) {
+        const baseURL = new URL('/api/v2', this.config.url).toString();
+        this.request.open("GET", `${baseURL}/testRuns/${testRunId}`, false);
+        this.request.setRequestHeader('Authorization', `PrivateToken ${this.config.privateToken}`);
+        this.request.send(null);
+        return JSON.parse(this.request.responseText);
+    }
+    async getTestRunById(testRunId) {
+        return this.axios
+            .get(`/testRuns/${testRunId}`)
+            .then((res) => res.data);
+    }
+    async createTestRun(testRun) {
+        return this.axios
+            .post('/testRuns', testRun)
+            .then((res) => res.data);
+    }
+    async startTestRun(testRunId) {
+        return this.axios.post(`/testRuns/${testRunId}/start`);
+    }
+    async loadTestRunResults(testRunId, results) {
+        return await this.axios
+            .post(`/testRuns/${testRunId}/testResults`, results)
+            .then((res) => res.data);
+    }
+    async completeTestRun(testRunId) {
+        return this.axios.post(`/testRuns/${testRunId}/complete`);
+    }
+    getConfig() {
+        return this.config;
+    }
+    async loadAttachment(filePath) {
+        const form = new form_data_1.default();
+        form.append('file', (0, fs_1.readFileSync)(filePath), (0, path_1.basename)(filePath));
+        return this.axios
+            .post('/Attachments', form, {
+            headers: form.getHeaders(),
+        })
+            .then((res) => res.data);
+    }
+    readCliConfig() {
+        const args = (0, minimist_1.default)(process.argv.slice(2));
+        let config = {};
+        if (args['tmsConfig']) {
+            config = this.readConfigFile(args['tmsConfig']);
+        }
+        return Client.mergeConfig(config, {
+            url: args['tmsUrl'],
+            privateToken: args['tmsPrivateToken'],
+            projectId: args['tmsProjectId'],
+            configurationId: args['tmsConfigurationId'],
+            testRunId: args['tmsTestRunId'],
+            automaticCreationTestCases: args['tmsAutomaticCreationTestCases'],
+        });
+    }
+    readEnvConfig() {
+        let config = {};
+        if (process.env['TMS_CONFIG_FILE']) {
+            config = this.readConfigFile(process.env['TMS_CONFIG_FILE']);
+        }
+        return Client.mergeConfig(config, {
+            url: process.env['TMS_URL'],
+            privateToken: process.env['TMS_PRIVATE_TOKEN'],
+            projectId: process.env['TMS_PROJECT_ID'],
+            configurationId: process.env['TMS_CONFIGURATION_ID'],
+            testRunId: process.env['TMS_TEST_RUN_ID'],
+            automaticCreationTestCases: process.env['TMS_CREATION_TEST_CASES'] === 'true',
+        });
+    }
+    readConfigFile(path) {
+        if (!(0, fs_1.existsSync)(path)) {
+            throw new Error('Config file not found');
+        }
+        const config = JSON.parse((0, fs_1.readFileSync)(path, { encoding: 'utf8' }));
+        if (config.privateToken) {
+            console.warn('Private token is in config file, it is not secure');
+        }
+        return config;
+    }
+    static mergeConfig(oldConfig, newConfig) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        return {
+            url: (_a = newConfig.url) !== null && _a !== void 0 ? _a : oldConfig.url,
+            privateToken: (_b = newConfig.privateToken) !== null && _b !== void 0 ? _b : oldConfig.privateToken,
+            projectId: (_c = newConfig.projectId) !== null && _c !== void 0 ? _c : oldConfig.projectId,
+            configurationId: (_d = newConfig.configurationId) !== null && _d !== void 0 ? _d : oldConfig.configurationId,
+            testRunId: (_e = newConfig.testRunId) !== null && _e !== void 0 ? _e : oldConfig.testRunId,
+            automaticCreationTestCases: (_g = (_f = newConfig.automaticCreationTestCases) !== null && _f !== void 0 ? _f : oldConfig.automaticCreationTestCases) !== null && _g !== void 0 ? _g : false,
+        };
+    }
+}
+exports.Client = Client;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './client';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client"), exports);
+__exportStar(require("./types"), exports);

package/dist/types/attachment.d.ts

@@ -0,0 +1,14 @@
+export interface AttachmentPut {
+    id: string;
+}
+export interface Attachment {
+    fileId: string;
+    type: string;
+    size: number;
+    name: string;
+    createDate?: string;
+    modifiedDate?: string;
+    createdById?: string;
+    modifiedById?: string;
+    id?: string;
+}

package/dist/types/attachment.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/autotest.d.ts

@@ -0,0 +1,98 @@
+import { LabelPost, LabelShort } from './label';
+import { Link, LinkPost, LinkPut } from './link';
+import { AutotestStep } from './autotestStep';
+export interface AutotestPost {
+    globalId?: number;
+    isDeleted?: boolean;
+    id?: string;
+    createdDate?: string;
+    modifiedDate?: string;
+    createdById?: string;
+    modifiedById?: string;
+    mustBeApproved?: boolean;
+    externalId: string;
+    links?: LinkPost[];
+    projectId: string;
+    name: string;
+    namespace?: string;
+    classname?: string;
+    steps?: AutotestStep[];
+    setup?: AutotestStep[];
+    teardown?: AutotestStep[];
+    title?: string;
+    description?: string;
+    labels?: LabelPost[];
+    shouldCreateWorkItem?: boolean;
+}
+export interface AutotestPut {
+    id?: string;
+    externalId: string;
+    links?: LinkPost[];
+    projectId: string;
+    name: string;
+    namespace?: string;
+    classname?: string;
+    steps?: AutotestStep[];
+    setup?: AutotestStep[];
+    teardown?: AutotestStep[];
+    title?: string;
+    description?: string;
+    labels?: LabelPost[];
+}
+export interface Autotest {
+    globalId?: number;
+    isDeleted?: boolean;
+    id?: string;
+    createdDate?: string;
+    modifiedDate?: string;
+    createdById?: string;
+    modifiedById?: string;
+    mustBeApproved?: boolean;
+    externalId: string;
+    links?: LinkPut[];
+    projectId: string;
+    name: string;
+    namespace?: string;
+    classname?: string;
+    steps?: AutotestStep[];
+    setup?: AutotestStep[];
+    teardown?: AutotestStep[];
+    title?: string;
+    description?: string;
+    labels?: LabelPost[];
+}
+export interface AutotestGet {
+    externalId?: string;
+    links?: Link[];
+    projectId?: string;
+    name?: string;
+    namespace?: string;
+    classname?: string;
+    steps?: AutotestStep[];
+    setup?: AutotestStep[];
+    teardown: AutotestStep[];
+    global?: number;
+    createdDate?: string;
+    modifiedDate?: string;
+    createdById?: string;
+    modifiedById?: string;
+    labels?: LabelShort[];
+    id?: string;
+    isDeleted?: boolean;
+}
+export interface AutotestQuery {
+    projectId?: string;
+    externalId?: string;
+    globalId?: number;
+    namespace?: string;
+    isNamespaceNull?: boolean;
+    classname?: string;
+    isClassnameNull?: boolean;
+    isDeleted?: boolean;
+    labels?: string[];
+    skip?: number;
+    take?: number;
+    orderBy?: string;
+    searchField?: string;
+    searchValue?: string;
+}

package/dist/types/autotest.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/autotestResults.d.ts

@@ -0,0 +1,22 @@
+import { AttachmentPut } from './attachment';
+import { LinkPost } from './link';
+import { OutcomeType } from './outcome';
+import { Parameters } from './parameters';
+import { AttachmentPutModelAutotestStepResults } from './stepResults';
+export interface AutotestResultsForTestRun {
+    configurationId: string;
+    links?: LinkPost[];
+    failureReasonName?: string;
+    autotestExternalId: string;
+    outcome: OutcomeType;
+    message?: string;
+    traces?: string;
+    startedOn?: string;
+    completedOn?: string;
+    duration?: number;
+    attachments?: AttachmentPut[];
+    parameters?: Parameters;
+    stepResults?: AttachmentPutModelAutotestStepResults[];
+    setupResults?: AttachmentPutModelAutotestStepResults[];
+    teardownResults?: AttachmentPutModelAutotestStepResults[];
+}

package/dist/types/autotestResults.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/autotestStep.d.ts

@@ -0,0 +1,5 @@
+export interface AutotestStep {
+    title: string;
+    description?: string;
+    steps?: AutotestStep[];
+}

package/dist/types/autotestStep.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/capabilities.d.ts

@@ -0,0 +1 @@
+export type Capabilities = Record<string, string>;

package/dist/types/capabilities.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/client.d.ts

@@ -0,0 +1,16 @@
+import { Attachment, Autotest, AutotestPost, AutotestPut, AutotestQuery, AutotestResultsForTestRun, ClientConfig, TestRunGet, TestRunPost, WorkItemId } from '.';
+export interface IClient {
+    checkConnection(): Promise<void>;
+    getAutotest(query: AutotestQuery): Promise<Autotest[]>;
+    createAutotest(autotest: AutotestPost): Promise<Autotest>;
+    updateAutotest(autotest: AutotestPut): Promise<void>;
+    linkToWorkItem(autotestId: string, workItem: WorkItemId): Promise<void>;
+    getTestRun(testRunId: string): TestRunGet;
+    getTestRunById(testRunId: string): Promise<TestRunGet>;
+    createTestRun(testRun: TestRunPost): Promise<TestRunGet>;
+    startTestRun(testRunId: string): Promise<void>;
+    loadTestRunResults(testRunId: string, results: AutotestResultsForTestRun[]): Promise<string[]>;
+    completeTestRun(testRunId: string): Promise<void>;
+    getConfig(): ClientConfig;
+    loadAttachment(fileName: string): Promise<Attachment>;
+}

package/dist/types/client.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/config.d.ts

@@ -0,0 +1,11 @@
+export interface ClientConfig {
+    url: string;
+    privateToken: string;
+    projectId: string;
+    configurationId: string;
+    testRunId?: string;
+    automaticCreationTestCases?: boolean;
+}
+export interface ClientConfigWithFile extends ClientConfig {
+    configFile?: string;
+}

package/dist/types/config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/configuration.d.ts

@@ -0,0 +1,16 @@
+import { Capabilities } from './capabilities';
+export interface Configuration {
+    description?: string;
+    isActive?: boolean;
+    capabilities: Capabilities;
+    projectId?: string;
+    isDefault?: boolean;
+    name?: string;
+    createdDate?: string;
+    modifiedDate?: string;
+    createdById?: string;
+    modifiedById?: string;
+    globalId?: number;
+    id?: number;
+    isDeleted?: boolean;
+}

package/dist/types/configuration.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -0,0 +1,18 @@
+export * from './attachment';
+export * from './autotest';
+export * from './autotestResults';
+export * from './autotestStep';
+export * from './capabilities';
+export * from './client';
+export * from './config';
+export * from './configuration';
+export * from './label';
+export * from './link';
+export * from './outcome';
+export * from './parameters';
+export * from './properties';
+export * from './stepResults';
+export * from './tag';
+export * from './testResult';
+export * from './testRun';
+export * from './workItem';

package/dist/types/index.js

@@ -0,0 +1,34 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./attachment"), exports);
+__exportStar(require("./autotest"), exports);
+__exportStar(require("./autotestResults"), exports);
+__exportStar(require("./autotestStep"), exports);
+__exportStar(require("./capabilities"), exports);
+__exportStar(require("./client"), exports);
+__exportStar(require("./config"), exports);
+__exportStar(require("./configuration"), exports);
+__exportStar(require("./label"), exports);
+__exportStar(require("./link"), exports);
+__exportStar(require("./outcome"), exports);
+__exportStar(require("./parameters"), exports);
+__exportStar(require("./properties"), exports);
+__exportStar(require("./stepResults"), exports);
+__exportStar(require("./tag"), exports);
+__exportStar(require("./testResult"), exports);
+__exportStar(require("./testRun"), exports);
+__exportStar(require("./workItem"), exports);

package/dist/types/label.d.ts

@@ -0,0 +1,7 @@
+export interface LabelShort {
+    globalId?: number;
+    name: string;
+}
+export interface LabelPost {
+    name: string;
+}

package/dist/types/label.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/link.d.ts

@@ -0,0 +1,24 @@
+export type LinkType = 'Related' | 'BlockedBy' | 'Defect' | 'Issue' | 'Requirement' | 'Repository';
+export interface LinkPost {
+    title?: string;
+    url: string;
+    description?: string;
+    type?: LinkType;
+    hasInfo?: boolean;
+}
+export interface LinkPut {
+    id?: string;
+    title?: string;
+    url: string;
+    description?: string;
+    type?: LinkType;
+    hasInfo?: boolean;
+}
+export interface Link {
+    id?: string;
+    title?: string;
+    url: string;
+    description?: string;
+    type?: LinkType;
+    hasInfo?: boolean;
+}

package/dist/types/link.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/outcome.d.ts

@@ -0,0 +1 @@
+export type OutcomeType = 'Passed' | 'Failed' | 'Pending' | 'Blocked' | 'Skipped';

package/dist/types/outcome.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/parameters.d.ts

@@ -0,0 +1 @@
+export type Parameters = Record<string, string>;

package/dist/types/parameters.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/properties.d.ts

@@ -0,0 +1 @@
+export type Properties = Record<string, string>;

package/dist/types/properties.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/stepResults.d.ts

@@ -0,0 +1,14 @@
+import { AttachmentPut } from './attachment';
+import { OutcomeType } from './outcome';
+import { Parameters } from './parameters';
+export interface AttachmentPutModelAutotestStepResults {
+    title?: string;
+    description?: string;
+    startedOn?: string;
+    completedOn?: string;
+    duration?: number;
+    outcome?: OutcomeType;
+    stepResults?: AttachmentPutModelAutotestStepResults[];
+    attachments?: AttachmentPut[];
+    parameters?: Parameters;
+}

package/dist/types/stepResults.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/tag.d.ts

@@ -0,0 +1,3 @@
+export interface TagShort {
+    name: string;
+}

package/dist/types/tag.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/testPoint.d.ts

@@ -0,0 +1,9 @@
+export interface TestPointShort {
+    testSuiteId?: string;
+    id?: string;
+    testerId?: string;
+    workItemId?: string;
+    configurationId?: string;
+    status?: string;
+    lastTestResultId?: string;
+}

package/dist/types/testPoint.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/testResult.d.ts

@@ -0,0 +1,31 @@
+import { Attachment } from './attachment';
+import { AutotestGet } from './autotest';
+import { Configuration } from './configuration';
+import { Link } from './link';
+import { OutcomeType } from './outcome';
+import { Parameters } from './parameters';
+import { Properties } from './properties';
+import { TestPointShort } from './testPoint';
+export interface TestResultGet {
+    configuration?: Configuration;
+    autoTest?: AutotestGet;
+    is?: string;
+    configurationId?: string;
+    workItemVersionId?: string;
+    autoTestId?: string;
+    message?: string;
+    traces?: string;
+    startedOn?: string;
+    completedOn?: string;
+    runByUserId?: string;
+    stoppedByUserId?: string;
+    testPointId?: string;
+    testPoint?: TestPointShort;
+    testRunId?: string;
+    outcome?: OutcomeType;
+    comment?: string;
+    links?: Link[];
+    attachments?: Attachment[];
+    parameters?: Parameters;
+    properties?: Properties;
+}

package/dist/types/testResult.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/testRun.d.ts

@@ -0,0 +1,20 @@
+import { TestResultGet } from './testResult';
+export type TestRunStateType = 'NotStarted' | 'InProgress' | 'Stopped' | 'Completed';
+export interface TestRunPost {
+    projectId: string;
+    name?: string;
+}
+export interface TestRunGet {
+    startedOn?: string;
+    completedOn?: string;
+    stateName?: TestRunStateType;
+    projectId?: string;
+    testPlanId?: string;
+    testResults?: TestResultGet[];
+    createdDate?: string;
+    modifiedDate?: string;
+    createById?: string;
+    modifiedById?: string;
+    id: string;
+    name: string;
+}

package/dist/types/testRun.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/workItem.d.ts

@@ -0,0 +1,3 @@
+export interface WorkItemId {
+    id: string;
+}

package/dist/types/workItem.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/validation.d.ts

@@ -0,0 +1,2 @@
+import { ClientConfig } from '.';
+export declare function validateConfig(config: Partial<ClientConfig>): ClientConfig;

package/dist/validation.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateConfig = void 0;
+const zod_1 = require("zod");
+const configSchema = zod_1.z.object({
+    configurationId: zod_1.z.string().uuid(),
+    privateToken: zod_1.z.string(),
+    projectId: zod_1.z.string().uuid(),
+    url: zod_1.z.string().url(),
+    testRunId: zod_1.z.string().uuid().optional(),
+    automaticCreationTestCases: zod_1.z.boolean().optional(),
+});
+function validateConfig(config) {
+    return configSchema.parse(config);
+}
+exports.validateConfig = validateConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testit-api-client",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Client provides methods for communication with TMS API.",
   "main": "dist/index.js",
   "scripts": {
@@ -31,8 +31,8 @@
     "form-data": "^4.0.0",
     "minimist": "^1.2.5",
     "querystring": "^0.2.1",
-    "zod": "^3.11.6",
-    "xmlhttprequest": "^1.8.0"
+    "xmlhttprequest": "^1.8.0",
+    "zod": "^3.11.6"
   },
   "files": [
     "dist"