testit-api-client 1.0.4 → 2.0.0

package/package.json

@@ -1,52 +1,34 @@
 {
   "name": "testit-api-client",
-  "version": "1.0.4",
-  "description": "Client provides methods for communication with Test IT API.",
+  "version": "2.0.0",
+  "description": "OpenAPI client for testit-api-client",
+  "author": "OpenAPI-Generator Contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/testit-tms/api-client-js"
+  },
+  "keywords": [
+    "axios",
+    "typescript",
+    "openapi-client",
+    "openapi-generator",
+    "testit-api-client"
+  ],
+  "license": "Unlicense",
   "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "jest",
     "build": "tsc",
     "prebuild": "rimraf dist"
   },
-  "keywords": [],
-  "author": "Andrey Kiselev",
-  "license": "Apache-2.0",
-  "devDependencies": {
-    "@babel/core": "^7.15.8",
-    "@babel/preset-env": "^7.15.8",
-    "@babel/preset-typescript": "^7.15.0",
-    "@types/jest": "^27.0.2",
-    "@types/minimist": "^1.2.2",
-    "@types/node": "^16.10.2",
-    "@types/uuid": "^8.3.1",
-    "babel-jest": "^27.2.5",
-    "jest": "^27.2.5",
-    "rimraf": "^3.0.2",
-    "ts-node": "^10.2.1",
-    "typescript": "^4.5.5",
-    "uuid": "^8.3.2"
-  },
   "dependencies": {
-    "axios": "^0.22.0",
-    "form-data": "^4.0.0",
-    "minimist": "^1.2.5",
-    "querystring": "^0.2.1",
-    "zod": "^3.11.6",
-    "xmlhttprequest": "^1.8.0"
+    "axios": "^0.26.1"
+  },
+  "devDependencies": {
+    "@types/node": "^12.11.5",
+    "typescript": "^4.0"
   },
   "files": [
     "dist"
-  ],
-  "bugs": {
-    "url": "https://github.com/testit-tms/api-client-js/issues"
-  },
-  "homepage": "https://github.com/testit-tms/api-client-js",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/testit-tms/api-client-js.git"
-  },
-  "types": "./dist\\index.d.ts",
-  "directories": {
-    "test": "test"
-  }
+  ]
 }

package/dist/client.d.ts

@@ -1,23 +0,0 @@
-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;
-    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

@@ -1,166 +0,0 @@
-"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
-const 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)(finalConfig);
-        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 TestIt');
-        }
-    }
-    // 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 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['testitConfig']) {
-            config = this.readConfigFile(args['testitConfig']);
-        }
-        return Client.mergeConfig(config, {
-            url: args['testitUrl'],
-            privateToken: args['testitPrivateToken'],
-            projectId: args['testitProjectId'],
-            configurationId: args['testitConfigurationId'],
-            testRunId: args['testitTestRunId'],
-        });
-    }
-    readEnvConfig() {
-        let config = {};
-        if (process.env['TESTIT_CONFIG_FILE']) {
-            config = this.readConfigFile(process.env['TESTIT_CONFIG_FILE']);
-        }
-        return Client.mergeConfig(config, {
-            url: process.env['TESTIT_URL'],
-            privateToken: process.env['TESTIT_PRIVATE_TOKEN'],
-            projectId: process.env['TESTIT_PROJECT_ID'],
-            configurationId: process.env['TESTIT_CONFIGURATION_ID'],
-            testRunId: process.env['TESTIT_TEST_RUN_ID'],
-        });
-    }
-    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;
-        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,
-        };
-    }
-}
-exports.Client = Client;

package/dist/types/attachment.d.ts

@@ -1,14 +0,0 @@
-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

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

package/dist/types/autotest.d.ts

@@ -1,97 +0,0 @@
-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[];
-}
-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

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

package/dist/types/autotestResults.d.ts

@@ -1,22 +0,0 @@
-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;
-    completeOn?: string;
-    duration?: number;
-    attachments?: AttachmentPut[];
-    parameters?: Parameters;
-    stepResults?: AttachmentPutModelAutotestStepResults[];
-    setupResults?: AttachmentPutModelAutotestStepResults[];
-    teardownResults?: AttachmentPutModelAutotestStepResults[];
-}

package/dist/types/autotestResults.js

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

package/dist/types/autotestStep.d.ts

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

package/dist/types/autotestStep.js

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

package/dist/types/capabilities.d.ts

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

package/dist/types/capabilities.js

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

package/dist/types/client.d.ts

@@ -1,15 +0,0 @@
-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;
-    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

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

package/dist/types/config.d.ts

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

package/dist/types/config.js

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

package/dist/types/configuration.d.ts

@@ -1,16 +0,0 @@
-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

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

package/dist/types/index.d.ts

@@ -1,18 +0,0 @@
-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

@@ -1,30 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (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

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

package/dist/types/label.js

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

package/dist/types/link.d.ts

@@ -1,24 +0,0 @@
-export declare 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

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

package/dist/types/outcome.d.ts

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

package/dist/types/outcome.js

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

package/dist/types/parameters.d.ts

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

package/dist/types/parameters.js

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

package/dist/types/properties.d.ts

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

package/dist/types/properties.js

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

package/dist/types/stepResults.d.ts

@@ -1,14 +0,0 @@
-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

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

package/dist/types/tag.d.ts

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

package/dist/types/tag.js

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

package/dist/types/testPoint.d.ts

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

package/dist/types/testPoint.js

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