@tiden/reporter-commons 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## 0.1.0
+
+Initial Tiden fork release of `@tiden/reporter-commons`.
+
+- Forked from [`qase-javascript-commons`](https://github.com/qase-tms/qase-javascript) at commit
+  [`d77a157`](https://github.com/qase-tms/qase-javascript/commit/d77a157020fea088ea323050a36b9bf874ad089d)
+  (Apache-2.0); wire transport retargeted from Qase TestOps to Tiden's Test Runs API.
+- **JSON API calls use a purpose-built reporter transport.** `CreateTestRun`, `ReportResults`
+  and `CompleteTestRun` share the axios instance from `tiden-http.ts`, so baseURL,
+  `Authorization`, and the 30s timeout stay in one place without pulling the full generated API
+  client into every reporter installation.
+  - Reporter DTOs follow the generated models: lowerCamelCase JSON (`testopsIds`, `paramGroups`,
+    `suitePath`, `clientMeta`, step `expectedResult`/`inputData`) and int64 `duration` as a string.
+    A compile-time test checks them against the private generated OpenAPI snapshot, and wire tests
+    verify the paths and serialization.
+  - The local `report`-mode file format is unchanged — it keeps its own snake_case contract.
+  - Attachment upload stays hand-written: `POST /v1/products/{product}/attachments:upload` is a
+    multipart route absent from the OpenAPI spec, so no generated operation exists. It shares the
+    same axios instance, and retries/backoff are unchanged.
+  - `@tiden/api-client` is not a runtime dependency and is not published to npm. The generated
+    workspace is marked private and serves only as a repository-local contract snapshot.
+- See the [root README](../README.md#lineage) for full fork lineage, and this package's
+  [README](./README.md) for the current shared config/env layer this package provides.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2026 Qase Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,34 @@
+# @tiden/reporter-commons
+
+Shared reporter core for Tiden's JavaScript test framework reporters: config loading
+(`tiden.config.json`), environment-variable resolution (`TIDEN_*`), the narrow Tiden API transport, result
+formatting, status mapping/filtering, and the HTTP network profiler.
+
+See the [root README](https://github.com/qase-tms/tiden-javascript/blob/main/README.md#lineage) for this package's fork lineage.
+
+## Who uses this
+
+This package is **not meant to be installed or configured directly** in a test project — it's a
+dependency of framework-specific reporters (currently [`@tiden/playwright-reporter`](https://github.com/qase-tms/tiden-javascript/blob/main/playwright/README.md)).
+Install and configure the reporter for your framework instead; it composes this package's config
+loader, env resolver, and API transport internally.
+
+## Configuration & environment variables
+
+The `tiden.config.json` schema and the full `TIDEN_*` environment variable table (which this
+package's `env-enum.ts` defines and every consuming reporter shares) are documented once, in the
+consumer-facing [`playwright/README.md`](https://github.com/qase-tms/tiden-javascript/blob/main/playwright/README.md#configuration) — see that file
+for the config example, the env-var reference table, and the note on how these variables line up
+with the `tiden` CLI's own environment variables.
+
+## If you're building a new reporter
+
+If you're adding a reporter for another framework, this package provides the pieces you'll wire
+up: `ConfigLoader` (file), `envToConfig`/`envValidationSchema` (env), `TidenReporter` (orchestrator
+with fallback handling), `RunReporter` / `ReportReporter` (the two reporting modes), and
+`TidenApiClient` (the reporter-facing Tiden Test Runs transport). Read the source under `src/` — there is no
+separate contributor guide yet.
+
+## License
+
+Apache License 2.0. See [LICENSE](https://github.com/qase-tms/tiden-javascript/blob/main/LICENSE) for details.

package/dist/client/interface.d.ts

@@ -0,0 +1,8 @@
+import { Attachment, TestResultType } from "../models";
+export interface IClient {
+    createRun(): Promise<number>;
+    completeRun(runId: number): Promise<void>;
+    uploadResults(runId: number, results: TestResultType[]): Promise<void>;
+    uploadAttachment(attachment: Attachment): Promise<string>;
+    enablePublicReport(runId: number): Promise<void>;
+}

package/dist/client/interface.js

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

package/dist/client/reporter-api-models.d.ts

@@ -0,0 +1,96 @@
+/**
+ * The reporter-facing slice of the Tiden public API contract.
+ *
+ * These types intentionally live in reporter-commons so installing a reporter
+ * does not pull the full generated API client into the user's dependency tree.
+ * `commons/test/client/reporter-api-contract.test.ts` checks this slice against
+ * the generated OpenAPI models kept in this repository.
+ */
+export interface CreateTestRunBody {
+    title?: string;
+    description?: string;
+    environment?: string;
+    branch?: string;
+    configurations?: Record<string, string>;
+    buildSha?: string;
+    startedAt?: string;
+    clientMeta?: Record<string, string>;
+}
+export interface ReporterTestRun {
+    seqNum?: number;
+}
+export interface CreateTestRunResponse {
+    run?: ReporterTestRun;
+}
+export interface ParamGroup {
+    names?: string[];
+}
+export interface ResultExecution {
+    status?: string;
+    startTime?: number;
+    endTime?: number;
+    duration?: string;
+    stacktrace?: string;
+    thread?: string;
+}
+export interface ResultStepData {
+    action?: string;
+    expectedResult?: string;
+    inputData?: string;
+    attachments?: string[];
+}
+export interface ResultStepExecution {
+    status?: string;
+    startTime?: number;
+    endTime?: number;
+    duration?: string;
+    comment?: string;
+    attachments?: string[];
+}
+export interface StepCode {
+    file?: string;
+    line?: number;
+}
+export interface ResultStep {
+    type?: string;
+    data?: ResultStepData;
+    execution?: ResultStepExecution;
+    code?: StepCode;
+    steps?: ResultStep[];
+}
+export interface SuiteSegment {
+    title?: string;
+    externalId?: string;
+}
+export interface ResultCreate {
+    id?: string;
+    title?: string;
+    signature?: string;
+    externalId?: string;
+    testopsIds?: number[];
+    execution?: ResultExecution;
+    fields?: Record<string, string>;
+    attachments?: string[];
+    steps?: ResultStep[];
+    stepsType?: string;
+    params?: Record<string, string>;
+    paramGroups?: ParamGroup[];
+    suitePath?: SuiteSegment[];
+    message?: string;
+    defect?: boolean;
+}
+export interface ReportResultsBody {
+    results?: ResultCreate[];
+}
+export interface ReportError {
+    index?: number;
+    resultId?: string;
+    code?: string;
+    message?: string;
+}
+export interface ReportResultsResponse {
+    status?: boolean;
+    accepted?: string;
+    duplicates?: string;
+    errors?: ReportError[];
+}

package/dist/client/reporter-api-models.js

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

package/dist/client/reporter-api.d.ts

@@ -0,0 +1,14 @@
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import type { CreateTestRunBody, CreateTestRunResponse, ReportResultsBody, ReportResultsResponse } from './reporter-api-models';
+/**
+ * Purpose-built transport for the three JSON operations used by reporters.
+ * Authentication, base URL and timeout are owned by the injected axios
+ * instance; this layer owns only the OpenAPI paths and request/response DTOs.
+ */
+export declare class ReporterApi {
+    private readonly http;
+    constructor(http: AxiosInstance);
+    createTestRun(productId: string, body: CreateTestRunBody): Promise<AxiosResponse<CreateTestRunResponse>>;
+    completeTestRun(productId: string, runSeq: number): Promise<AxiosResponse<unknown>>;
+    reportResults(productId: string, runSeq: number, body: ReportResultsBody): Promise<AxiosResponse<ReportResultsResponse>>;
+}

package/dist/client/reporter-api.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReporterApi = void 0;
+const pathSegment = (value) => encodeURIComponent(String(value));
+/**
+ * Purpose-built transport for the three JSON operations used by reporters.
+ * Authentication, base URL and timeout are owned by the injected axios
+ * instance; this layer owns only the OpenAPI paths and request/response DTOs.
+ */
+class ReporterApi {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    createTestRun(productId, body) {
+        return this.http.post(`/v1/products/${pathSegment(productId)}/runs`, body);
+    }
+    completeTestRun(productId, runSeq) {
+        return this.http.post(`/v1/products/${pathSegment(productId)}/runs/${pathSegment(runSeq)}:complete`, {});
+    }
+    reportResults(productId, runSeq, body) {
+        return this.http.post(`/v1/products/${pathSegment(productId)}/runs/${pathSegment(runSeq)}/results:report`, body);
+    }
+}
+exports.ReporterApi = ReporterApi;

package/dist/client/services/api-error-handler.d.ts

@@ -0,0 +1,10 @@
+import { TidenError } from '../../utils/tiden-error';
+export declare enum ApiErrorCode {
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    BAD_REQUEST = 400,
+    UNPROCESSABLE_ENTITY = 422
+}
+export declare function processError(error: unknown, message: string, model?: object): TidenError;
+export declare function getErrorMessage(error: unknown): string;

package/dist/client/services/api-error-handler.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiErrorCode = void 0;
+exports.processError = processError;
+exports.getErrorMessage = getErrorMessage;
+const is_axios_error_1 = require("../../utils/is-axios-error");
+const tiden_error_1 = require("../../utils/tiden-error");
+var ApiErrorCode;
+(function (ApiErrorCode) {
+    ApiErrorCode[ApiErrorCode["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
+    ApiErrorCode[ApiErrorCode["FORBIDDEN"] = 403] = "FORBIDDEN";
+    ApiErrorCode[ApiErrorCode["NOT_FOUND"] = 404] = "NOT_FOUND";
+    ApiErrorCode[ApiErrorCode["BAD_REQUEST"] = 400] = "BAD_REQUEST";
+    ApiErrorCode[ApiErrorCode["UNPROCESSABLE_ENTITY"] = 422] = "UNPROCESSABLE_ENTITY";
+})(ApiErrorCode || (exports.ApiErrorCode = ApiErrorCode = {}));
+function processError(error, message, model) {
+    if (!(0, is_axios_error_1.isAxiosError)(error)) {
+        return new tiden_error_1.TidenError(message, { cause: error });
+    }
+    const err = error;
+    const errorData = err.response?.data;
+    const status = err.response?.status;
+    switch (status) {
+        case ApiErrorCode.UNAUTHORIZED:
+            return new tiden_error_1.TidenError(`${message}: Unauthorized. Please check your API token.`);
+        case ApiErrorCode.FORBIDDEN:
+            return new tiden_error_1.TidenError(`${message}: ${errorData?.errorMessage ?? 'Forbidden'}`);
+        case ApiErrorCode.NOT_FOUND:
+            return new tiden_error_1.TidenError(`${message}: Not found.`);
+        case ApiErrorCode.BAD_REQUEST:
+        case ApiErrorCode.UNPROCESSABLE_ENTITY:
+            return new tiden_error_1.TidenError(`${message}: Bad request\n${JSON.stringify(errorData)}\nBody: ${JSON.stringify(model)}`);
+        default:
+            return new tiden_error_1.TidenError(message, { cause: err });
+    }
+}
+function getErrorMessage(error) {
+    if ((0, is_axios_error_1.isAxiosError)(error)) {
+        const err = error;
+        const errorData = err.response?.data;
+        return errorData?.errorMessage ?? errorData?.error ?? errorData?.message ?? 'Unknown API error';
+    }
+    return error instanceof Error ? error.message : 'Unknown error';
+}

package/dist/client/services/attachment-service.d.ts

@@ -0,0 +1,29 @@
+import { AxiosInstance } from 'axios';
+import { Attachment } from '../../models';
+import { LoggerInterface } from '../../utils/logger';
+export declare class AttachmentService {
+    private readonly logger;
+    private readonly http;
+    constructor(logger: LoggerInterface, http: AxiosInstance);
+    uploadAttachment(projectCode: string, attachment: Attachment): Promise<string>;
+    uploadAttachments(projectCode: string, attachments: Attachment[], uploadEnabled: boolean): Promise<string[]>;
+    private groupIntoBatches;
+    /** POST one multipart batch to Tiden. Returns the upstream-shaped
+     *  `{data: {result: [{hash}]}}` envelope so callers stay unchanged
+     *  (Tiden's response body is `{status, result: [{hash, ...}]}`).
+     *
+     *  Hand-written on purpose: `POST /v1/products/{product}/attachments:upload`
+     *  is a multipart route that is NOT in the OpenAPI spec, so
+     *  The generated OpenAPI snapshot has no operation for it (the path appears
+     *  there only inside a doc comment on testRunServiceGetRunAttachment). It
+     *  still goes over the same axios instance as the reporter JSON calls, so
+     *  baseURL/auth/timeout stay shared; only the request building is local.
+     *  If the route is ever added to the spec, replace this with the generated
+     *  operation. */
+    private postAttachmentBatch;
+    private uploadWithRetry;
+    private getRetryAfter;
+    private delay;
+    private ensureAttachmentSize;
+    private prepareAttachmentData;
+}