angles-javascript-client 1.0.47 → 3.0.1

package/dist/lib/models/manual/ManualStep.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManualStep = void 0;
+/**
+ * A single step of a manual test case.
+ *
+ * On a test case head, a step with `sharedStep` set is a placeholder: its own action and
+ * expected are ignored, and the shared step's steps are expanded in its place. A frozen
+ * version never carries `sharedStep` - it stores the expanded steps, each carrying
+ * `sharedStepRef`/`sharedStepVersion` for attribution only. That is what stops a later
+ * edit to a shared step rewriting what a historical execution shows.
+ */
+class ManualStep {
+}
+exports.ManualStep = ManualStep;
+//# sourceMappingURL=ManualStep.js.map

package/dist/lib/models/manual/ManualStep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManualStep.js","sourceRoot":"","sources":["../../../../src/lib/models/manual/ManualStep.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;GAQG;AACH,MAAa,UAAU;CAetB;AAfD,gCAeC"}

package/dist/lib/models/manual/ManualTestCase.d.ts

@@ -0,0 +1,31 @@
+import { ManualStep } from './ManualStep';
+import { ManualTestCaseStates } from '../enum/ManualTestCaseStates';
+import { ManualTestCasePriorities } from '../enum/ManualTestCasePriorities';
+import { Team } from '../Team';
+/**
+ * The mutable head of a manual test case - always the latest content. Every version that
+ * has existed is also stored immutably; executions bind to those, never to this.
+ */
+export declare class ManualTestCase {
+    _id: string;
+    team: Team | string;
+    component: string;
+    title: string;
+    description: string;
+    preconditions: string;
+    status: ManualTestCaseStates;
+    priority: ManualTestCasePriorities;
+    tags: string[];
+    steps: ManualStep[];
+    customFields: {
+        [key: string]: any;
+    };
+    /** Current content version. Incremented only when content changes. */
+    version: number;
+    createdBy: any;
+    updatedBy: any;
+    createdAt: Date;
+    updatedAt: Date;
+    /** Present when read with expand=true: shared steps resolved into their steps. */
+    expanded: boolean;
+}

package/dist/lib/models/manual/ManualTestCase.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManualTestCase = void 0;
+/**
+ * The mutable head of a manual test case - always the latest content. Every version that
+ * has existed is also stored immutably; executions bind to those, never to this.
+ */
+class ManualTestCase {
+}
+exports.ManualTestCase = ManualTestCase;
+//# sourceMappingURL=ManualTestCase.js.map

package/dist/lib/models/manual/ManualTestCase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManualTestCase.js","sourceRoot":"","sources":["../../../../src/lib/models/manual/ManualTestCase.ts"],"names":[],"mappings":";;;AAKA;;;GAGG;AACH,MAAa,cAAc;CAoB1B;AApBD,wCAoBC"}

package/dist/lib/models/manual/ManualTestCaseVersion.d.ts

@@ -0,0 +1,34 @@
+import { ManualStep } from './ManualStep';
+import { ManualTestCasePriorities } from '../enum/ManualTestCasePriorities';
+/** A frozen custom field definition, as it stood when a version was written. */
+export declare class CustomFieldDefinitionSnapshot {
+    key: string;
+    label: string;
+    type: string;
+    options: string[];
+}
+/**
+ * An immutable copy of one version of a manual test case. Never updated or deleted, which
+ * is what lets an execution bound to it always render the content it was run against.
+ */
+export declare class ManualTestCaseVersion {
+    _id: string;
+    testCase: string;
+    version: number;
+    team: string;
+    title: string;
+    description: string;
+    preconditions: string;
+    priority: ManualTestCasePriorities;
+    tags: string[];
+    /** Shared steps already expanded - a version never holds a reference. */
+    steps: ManualStep[];
+    customFields: {
+        [key: string]: any;
+    };
+    fieldDefinitions: CustomFieldDefinitionSnapshot[];
+    createdBy: any;
+    createdAt: Date;
+    /** Present only for a case predating version tracking; not guaranteed immutable. */
+    unversioned: boolean;
+}

package/dist/lib/models/manual/ManualTestCaseVersion.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManualTestCaseVersion = exports.CustomFieldDefinitionSnapshot = void 0;
+/** A frozen custom field definition, as it stood when a version was written. */
+class CustomFieldDefinitionSnapshot {
+}
+exports.CustomFieldDefinitionSnapshot = CustomFieldDefinitionSnapshot;
+/**
+ * An immutable copy of one version of a manual test case. Never updated or deleted, which
+ * is what lets an execution bound to it always render the content it was run against.
+ */
+class ManualTestCaseVersion {
+}
+exports.ManualTestCaseVersion = ManualTestCaseVersion;
+//# sourceMappingURL=ManualTestCaseVersion.js.map

package/dist/lib/models/manual/ManualTestCaseVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManualTestCaseVersion.js","sourceRoot":"","sources":["../../../../src/lib/models/manual/ManualTestCaseVersion.ts"],"names":[],"mappings":";;;AAGA,gFAAgF;AAChF,MAAa,6BAA6B;CAKzC;AALD,sEAKC;AAED;;;GAGG;AACH,MAAa,qBAAqB;CAkBjC;AAlBD,sDAkBC"}

package/dist/lib/models/manual/ManualTestRun.d.ts

@@ -0,0 +1,55 @@
+import { Platform } from '../Platform';
+import { ManualRunStates } from '../enum/ManualRunStates';
+import { ManualCaseResultStates } from '../enum/ManualCaseResultStates';
+import { ManualStepResultStates } from '../enum/ManualStepResultStates';
+import { ManualTestCaseVersion } from './ManualTestCaseVersion';
+export declare class ManualStepResult {
+    /** The _id of the step in the frozen version, so a later reorder cannot misbind it. */
+    stepId: string;
+    status: ManualStepResultStates;
+    actual: string;
+    notes: string;
+    attachments: string[];
+    timestamp: Date;
+}
+export declare class ManualRunTestCase {
+    testCase: string;
+    /** The frozen version being executed. Bound when added, never moved implicitly. */
+    testCaseVersion: string;
+    versionNumber: number;
+    snapshotTitle: string;
+    status: ManualCaseResultStates;
+    stepResults: ManualStepResult[];
+    execution: string;
+    executedBy: any;
+    notes: string;
+    start: Date;
+    end: Date;
+    /** Populated when the run is read with expand=true. */
+    version: ManualTestCaseVersion;
+}
+/**
+ * A planned or in-flight session of manual testing. Results are written as ordinary
+ * executions against a Build tagged `manual`, so they appear on the existing dashboards.
+ */
+export declare class ManualTestRun {
+    _id: string;
+    name: string;
+    description: string;
+    team: any;
+    component: string;
+    environment: any;
+    phase: any;
+    /** The manual-tagged build this run's executions are written into. */
+    build: string;
+    status: ManualRunStates;
+    assignedTo: any;
+    platforms: Platform[];
+    testCases: ManualRunTestCase[];
+    start: Date;
+    end: Date;
+    createdBy: any;
+    createdAt: Date;
+    updatedAt: Date;
+    expanded: boolean;
+}

package/dist/lib/models/manual/ManualTestRun.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManualTestRun = exports.ManualRunTestCase = exports.ManualStepResult = void 0;
+class ManualStepResult {
+}
+exports.ManualStepResult = ManualStepResult;
+class ManualRunTestCase {
+}
+exports.ManualRunTestCase = ManualRunTestCase;
+/**
+ * A planned or in-flight session of manual testing. Results are written as ordinary
+ * executions against a Build tagged `manual`, so they appear on the existing dashboards.
+ */
+class ManualTestRun {
+}
+exports.ManualTestRun = ManualTestRun;
+//# sourceMappingURL=ManualTestRun.js.map

package/dist/lib/models/manual/ManualTestRun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManualTestRun.js","sourceRoot":"","sources":["../../../../src/lib/models/manual/ManualTestRun.ts"],"names":[],"mappings":";;;AAMA,MAAa,gBAAgB;CAQ5B;AARD,4CAQC;AAED,MAAa,iBAAiB;CAe7B;AAfD,8CAeC;AAED;;;GAGG;AACH,MAAa,aAAa;CAoBzB;AApBD,sCAoBC"}

package/dist/lib/models/manual/SharedStep.d.ts

@@ -0,0 +1,15 @@
+import { ManualStep } from './ManualStep';
+/** A re-usable sequence of steps that many manual test cases can include. */
+export declare class SharedStep {
+    _id: string;
+    team: string;
+    name: string;
+    description: string;
+    steps: ManualStep[];
+    /** Incremented only when the steps change. */
+    version: number;
+    createdBy: any;
+    updatedBy: any;
+    createdAt: Date;
+    updatedAt: Date;
+}

package/dist/lib/models/manual/SharedStep.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SharedStep = void 0;
+/** A re-usable sequence of steps that many manual test cases can include. */
+class SharedStep {
+}
+exports.SharedStep = SharedStep;
+//# sourceMappingURL=SharedStep.js.map

package/dist/lib/models/manual/SharedStep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SharedStep.js","sourceRoot":"","sources":["../../../../src/lib/models/manual/SharedStep.ts"],"names":[],"mappings":";;;AAEA,6EAA6E;AAC7E,MAAa,UAAU;CAYtB;AAZD,gCAYC"}

package/dist/lib/models/requests/CreateCustomField.d.ts

@@ -0,0 +1,14 @@
+import { CustomFieldTypes } from '../enum/CustomFieldTypes';
+import { CustomFieldScopes } from '../enum/CustomFieldScopes';
+export declare class CreateCustomField {
+    team: string;
+    key: string;
+    label: string;
+    type: CustomFieldTypes;
+    options?: string[];
+    required?: boolean;
+    defaultValue?: any;
+    order?: number;
+    appliesTo?: CustomFieldScopes;
+    archived?: boolean;
+}

package/dist/lib/models/requests/CreateCustomField.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCustomField = void 0;
+class CreateCustomField {
+}
+exports.CreateCustomField = CreateCustomField;
+//# sourceMappingURL=CreateCustomField.js.map

package/dist/lib/models/requests/CreateCustomField.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreateCustomField.js","sourceRoot":"","sources":["../../../../src/lib/models/requests/CreateCustomField.ts"],"names":[],"mappings":";;;AAGA,MAAa,iBAAiB;CAW7B;AAXD,8CAWC"}

package/dist/lib/models/requests/CreateManualTestCase.d.ts

@@ -0,0 +1,27 @@
+import { ManualTestCaseStates } from '../enum/ManualTestCaseStates';
+import { ManualTestCasePriorities } from '../enum/ManualTestCasePriorities';
+export declare class CreateManualStep {
+    order?: number;
+    action: string;
+    expected?: string;
+    data?: string;
+    attachments?: string[];
+    /** Include a re-usable shared step in place of this step's own content. */
+    sharedStep?: string;
+}
+export declare class CreateManualTestCase {
+    team: string;
+    title: string;
+    component?: string;
+    description?: string;
+    preconditions?: string;
+    status?: ManualTestCaseStates;
+    priority?: ManualTestCasePriorities;
+    tags?: string[];
+    steps?: CreateManualStep[];
+    customFields?: {
+        [key: string]: any;
+    };
+    /** Optional reason, recorded on the change history entry. */
+    comment?: string;
+}

package/dist/lib/models/requests/CreateManualTestCase.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateManualTestCase = exports.CreateManualStep = void 0;
+class CreateManualStep {
+}
+exports.CreateManualStep = CreateManualStep;
+class CreateManualTestCase {
+}
+exports.CreateManualTestCase = CreateManualTestCase;
+//# sourceMappingURL=CreateManualTestCase.js.map

package/dist/lib/models/requests/CreateManualTestCase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreateManualTestCase.js","sourceRoot":"","sources":["../../../../src/lib/models/requests/CreateManualTestCase.ts"],"names":[],"mappings":";;;AAGA,MAAa,gBAAgB;CAQ5B;AARD,4CAQC;AAED,MAAa,oBAAoB;CAahC;AAbD,oDAaC"}

package/dist/lib/models/requests/CreateManualTestRun.d.ts

@@ -0,0 +1,15 @@
+import { Platform } from '../Platform';
+export declare class CreateManualTestRun {
+    name: string;
+    team: string;
+    /** Environment name, not id - matching POST /build. */
+    environment: string;
+    description?: string;
+    component?: string;
+    /** Phase name, not id. */
+    phase?: string;
+    assignedTo?: string;
+    platforms?: Platform[];
+    /** Each is bound to its current frozen version. A DEPRECATED case is rejected. */
+    testCaseIds?: string[];
+}

package/dist/lib/models/requests/CreateManualTestRun.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateManualTestRun = void 0;
+class CreateManualTestRun {
+}
+exports.CreateManualTestRun = CreateManualTestRun;
+//# sourceMappingURL=CreateManualTestRun.js.map

package/dist/lib/models/requests/CreateManualTestRun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreateManualTestRun.js","sourceRoot":"","sources":["../../../../src/lib/models/requests/CreateManualTestRun.ts"],"names":[],"mappings":";;;AAEA,MAAa,mBAAmB;CAa/B;AAbD,kDAaC"}

package/dist/lib/models/requests/CreateSharedStep.d.ts

@@ -0,0 +1,9 @@
+import { CreateManualStep } from './CreateManualTestCase';
+export declare class CreateSharedStep {
+    team: string;
+    name: string;
+    description?: string;
+    /** Always literal - a shared step cannot include another shared step. */
+    steps: CreateManualStep[];
+    comment?: string;
+}

package/dist/lib/models/requests/CreateSharedStep.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateSharedStep = void 0;
+class CreateSharedStep {
+}
+exports.CreateSharedStep = CreateSharedStep;
+//# sourceMappingURL=CreateSharedStep.js.map

package/dist/lib/models/requests/CreateSharedStep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreateSharedStep.js","sourceRoot":"","sources":["../../../../src/lib/models/requests/CreateSharedStep.ts"],"names":[],"mappings":";;;AAEA,MAAa,gBAAgB;CAO5B;AAPD,4CAOC"}

package/dist/lib/models/requests/RecordManualResult.d.ts

@@ -0,0 +1,15 @@
+import { ManualCaseResultStates } from '../enum/ManualCaseResultStates';
+import { ManualStepResultStates } from '../enum/ManualStepResultStates';
+export declare class RecordManualStepResult {
+    stepId?: string;
+    status?: ManualStepResultStates;
+    actual?: string;
+    notes?: string;
+    attachments?: string[];
+    timestamp?: Date;
+}
+export declare class RecordManualResult {
+    status: ManualCaseResultStates;
+    notes?: string;
+    stepResults?: RecordManualStepResult[];
+}

package/dist/lib/models/requests/RecordManualResult.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecordManualResult = exports.RecordManualStepResult = void 0;
+class RecordManualStepResult {
+}
+exports.RecordManualStepResult = RecordManualStepResult;
+class RecordManualResult {
+}
+exports.RecordManualResult = RecordManualResult;
+//# sourceMappingURL=RecordManualResult.js.map

package/dist/lib/models/requests/RecordManualResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordManualResult.js","sourceRoot":"","sources":["../../../../src/lib/models/requests/RecordManualResult.ts"],"names":[],"mappings":";;;AAGA,MAAa,sBAAsB;CAOlC;AAPD,wDAOC;AAED,MAAa,kBAAkB;CAI9B;AAJD,gDAIC"}

package/dist/lib/models/response/ManualResponses.d.ts

@@ -0,0 +1,75 @@
+import { ManualTestCase } from '../manual/ManualTestCase';
+import { ManualTestCaseVersion } from '../manual/ManualTestCaseVersion';
+import { SharedStep } from '../manual/SharedStep';
+import { CustomFieldDefinition } from '../manual/CustomFieldDefinition';
+import { Attachment } from '../manual/Attachment';
+import { ManualTestRun } from '../manual/ManualTestRun';
+import { ManualChangeHistoryEntry } from '../manual/ManualChangeHistoryEntry';
+export declare class ManualTestCasesResponse {
+    testCases: ManualTestCase[];
+    metrics: {
+        totalTestCases: number;
+    };
+}
+export declare class ManualTestCaseVersionSummary {
+    _id: string;
+    version: number;
+    title: string;
+    createdBy: any;
+    createdAt: Date;
+}
+export declare class ManualTestCaseVersionsResponse {
+    versions: ManualTestCaseVersionSummary[];
+}
+export declare class SharedStepsResponse {
+    sharedSteps: SharedStep[];
+    metrics: {
+        totalSharedSteps: number;
+    };
+}
+export declare class SharedStepUsageResponse {
+    testCases: {
+        _id: string;
+        title: string;
+        status: string;
+        version: number;
+    }[];
+    metrics: {
+        totalTestCases: number;
+    };
+}
+/** A shared step update reports what it did to the cases that include it. */
+export declare class SharedStepUpdateResponse extends SharedStep {
+    cascade: {
+        testCasesVersioned: number;
+        failures: {
+            testCase: string;
+            error: string;
+        }[];
+    };
+}
+export declare class CustomFieldsResponse {
+    customFields: CustomFieldDefinition[];
+}
+/** Delete either removes the field or, if it is in use, archives it. */
+export declare class CustomFieldDeleteResponse {
+    message: string;
+    archived: boolean;
+    customField: CustomFieldDefinition;
+}
+export declare class AttachmentsResponse {
+    attachments: Attachment[];
+}
+export declare class ManualTestRunsResponse {
+    testRuns: ManualTestRun[];
+    metrics: {
+        totalTestRuns: number;
+    };
+}
+export declare class ManualChangeHistoryResponse {
+    history: ManualChangeHistoryEntry[];
+    metrics: {
+        totalEntries: number;
+    };
+}
+export { ManualTestCaseVersion };

package/dist/lib/models/response/ManualResponses.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManualTestCaseVersion = exports.ManualChangeHistoryResponse = exports.ManualTestRunsResponse = exports.AttachmentsResponse = exports.CustomFieldDeleteResponse = exports.CustomFieldsResponse = exports.SharedStepUpdateResponse = exports.SharedStepUsageResponse = exports.SharedStepsResponse = exports.ManualTestCaseVersionsResponse = exports.ManualTestCaseVersionSummary = exports.ManualTestCasesResponse = void 0;
+const ManualTestCaseVersion_1 = require("../manual/ManualTestCaseVersion");
+Object.defineProperty(exports, "ManualTestCaseVersion", { enumerable: true, get: function () { return ManualTestCaseVersion_1.ManualTestCaseVersion; } });
+const SharedStep_1 = require("../manual/SharedStep");
+class ManualTestCasesResponse {
+}
+exports.ManualTestCasesResponse = ManualTestCasesResponse;
+class ManualTestCaseVersionSummary {
+}
+exports.ManualTestCaseVersionSummary = ManualTestCaseVersionSummary;
+class ManualTestCaseVersionsResponse {
+}
+exports.ManualTestCaseVersionsResponse = ManualTestCaseVersionsResponse;
+class SharedStepsResponse {
+}
+exports.SharedStepsResponse = SharedStepsResponse;
+class SharedStepUsageResponse {
+}
+exports.SharedStepUsageResponse = SharedStepUsageResponse;
+/** A shared step update reports what it did to the cases that include it. */
+class SharedStepUpdateResponse extends SharedStep_1.SharedStep {
+}
+exports.SharedStepUpdateResponse = SharedStepUpdateResponse;
+class CustomFieldsResponse {
+}
+exports.CustomFieldsResponse = CustomFieldsResponse;
+/** Delete either removes the field or, if it is in use, archives it. */
+class CustomFieldDeleteResponse {
+}
+exports.CustomFieldDeleteResponse = CustomFieldDeleteResponse;
+class AttachmentsResponse {
+}
+exports.AttachmentsResponse = AttachmentsResponse;
+class ManualTestRunsResponse {
+}
+exports.ManualTestRunsResponse = ManualTestRunsResponse;
+class ManualChangeHistoryResponse {
+}
+exports.ManualChangeHistoryResponse = ManualChangeHistoryResponse;
+//# sourceMappingURL=ManualResponses.js.map

package/dist/lib/models/response/ManualResponses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ManualResponses.js","sourceRoot":"","sources":["../../../../src/lib/models/response/ManualResponses.ts"],"names":[],"mappings":";;;AACA,2EAAwE;AAmE/D,sGAnEA,6CAAqB,OAmEA;AAlE9B,qDAAkD;AAMlD,MAAa,uBAAuB;CAGnC;AAHD,0DAGC;AAED,MAAa,4BAA4B;CAMxC;AAND,oEAMC;AAED,MAAa,8BAA8B;CAE1C;AAFD,wEAEC;AAED,MAAa,mBAAmB;CAG/B;AAHD,kDAGC;AAED,MAAa,uBAAuB;CAGnC;AAHD,0DAGC;AAED,6EAA6E;AAC7E,MAAa,wBAAyB,SAAQ,uBAAU;CAKvD;AALD,4DAKC;AAED,MAAa,oBAAoB;CAEhC;AAFD,oDAEC;AAED,wEAAwE;AACxE,MAAa,yBAAyB;CAIrC;AAJD,8DAIC;AAED,MAAa,mBAAmB;CAE/B;AAFD,kDAEC;AAED,MAAa,sBAAsB;CAGlC;AAHD,wDAGC;AAED,MAAa,2BAA2B;CAGvC;AAHD,kEAGC"}

package/dist/lib/requests/AttachmentRequests.d.ts

@@ -0,0 +1,39 @@
+import { AxiosInstance } from 'axios';
+import { BaseRequests } from './BaseRequests';
+import { Attachment } from '../models/manual/Attachment';
+import { AttachmentsResponse } from '../models/response/ManualResponses';
+import { DefaultResponse } from '../models/response/DefaultResponse';
+/** Exactly one owner must be supplied. */
+export interface AttachmentOwner {
+    testCaseId?: string;
+    sharedStepId?: string;
+    executionId?: string;
+}
+export declare class AttachmentRequests extends BaseRequests {
+    constructor(axiosInstance: AxiosInstance);
+    /**
+     * Uploads an image from the browser.
+     *
+     * Takes a File/Blob and builds a native FormData, unlike ScreenshotRequests.saveScreenshot
+     * which reads from disk with `fs` and is therefore Node-only. Attachments are captured by
+     * a QA in the browser, so that path is unusable here. The Content-Type header is
+     * deliberately not set: the browser has to add its own multipart boundary.
+     */
+    uploadAttachment(file: Blob, owner: AttachmentOwner, fileName?: string): Promise<Attachment>;
+    getAttachments(owner: AttachmentOwner): Promise<AttachmentsResponse>;
+    getAttachment(attachmentId: string): Promise<Attachment>;
+    /**
+     * The URL of the full-size image. Returned rather than fetched so it can be used
+     * directly as an <img src>, which is how the markdown `attachment:<id>` references in a
+     * step's expected result are resolved.
+     */
+    getAttachmentUrl(attachmentId: string): string;
+    /** The thumbnail URL. Falls back to the original server-side, so it never 404s. */
+    getThumbnailUrl(attachmentId: string): string;
+    /**
+     * Deletes an attachment. Rejected with 409 while any frozen test case version still
+     * references it - the file is the only copy of what that version's tester saw. Remove
+     * the image from the test case instead.
+     */
+    deleteAttachment(attachmentId: string): Promise<DefaultResponse>;
+}

package/dist/lib/requests/AttachmentRequests.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentRequests = void 0;
+const BaseRequests_1 = require("./BaseRequests");
+class AttachmentRequests extends BaseRequests_1.BaseRequests {
+    constructor(axiosInstance) {
+        super(axiosInstance);
+    }
+    /**
+     * Uploads an image from the browser.
+     *
+     * Takes a File/Blob and builds a native FormData, unlike ScreenshotRequests.saveScreenshot
+     * which reads from disk with `fs` and is therefore Node-only. Attachments are captured by
+     * a QA in the browser, so that path is unusable here. The Content-Type header is
+     * deliberately not set: the browser has to add its own multipart boundary.
+     */
+    uploadAttachment(file, owner, fileName) {
+        const formData = new FormData();
+        if (owner.testCaseId)
+            formData.append('testCaseId', owner.testCaseId);
+        if (owner.sharedStepId)
+            formData.append('sharedStepId', owner.sharedStepId);
+        if (owner.executionId)
+            formData.append('executionId', owner.executionId);
+        if (fileName) {
+            formData.append('attachment', file, fileName);
+        }
+        else {
+            formData.append('attachment', file);
+        }
+        return this.post('attachment', formData);
+    }
+    getAttachments(owner) {
+        const params = {};
+        if (owner.testCaseId)
+            params.testCaseId = owner.testCaseId;
+        if (owner.sharedStepId)
+            params.sharedStepId = owner.sharedStepId;
+        return this.get('attachment', { params });
+    }
+    getAttachment(attachmentId) {
+        return this.get(`attachment/${attachmentId}`);
+    }
+    /**
+     * The URL of the full-size image. Returned rather than fetched so it can be used
+     * directly as an <img src>, which is how the markdown `attachment:<id>` references in a
+     * step's expected result are resolved.
+     */
+    getAttachmentUrl(attachmentId) {
+        return `${this.axios.defaults.baseURL || ''}attachment/${attachmentId}/file`;
+    }
+    /** The thumbnail URL. Falls back to the original server-side, so it never 404s. */
+    getThumbnailUrl(attachmentId) {
+        return `${this.axios.defaults.baseURL || ''}attachment/${attachmentId}/thumbnail`;
+    }
+    /**
+     * Deletes an attachment. Rejected with 409 while any frozen test case version still
+     * references it - the file is the only copy of what that version's tester saw. Remove
+     * the image from the test case instead.
+     */
+    deleteAttachment(attachmentId) {
+        return this.delete(`attachment/${attachmentId}`);
+    }
+}
+exports.AttachmentRequests = AttachmentRequests;
+//# sourceMappingURL=AttachmentRequests.js.map

package/dist/lib/requests/AttachmentRequests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AttachmentRequests.js","sourceRoot":"","sources":["../../../src/lib/requests/AttachmentRequests.ts"],"names":[],"mappings":";;;AACA,iDAA8C;AAY9C,MAAa,kBAAmB,SAAQ,2BAAY;IAElD,YAAmB,aAA4B;QAC7C,KAAK,CAAC,aAAa,CAAC,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,IAAU,EAAE,KAAsB,EAAE,QAAiB;QAC3E,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,IAAI,KAAK,CAAC,UAAU;YAAE,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QACtE,IAAI,KAAK,CAAC,YAAY;YAAE,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5E,IAAI,KAAK,CAAC,WAAW;YAAE,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;QACzE,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;SAC/C;aAAM;YACL,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,CAAC,IAAI,CAAa,YAAY,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;IAEM,cAAc,CAAC,KAAsB;QAC1C,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,IAAI,KAAK,CAAC,UAAU;YAAE,MAAM,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QAC3D,IAAI,KAAK,CAAC,YAAY;YAAE,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACjE,OAAO,IAAI,CAAC,GAAG,CAAsB,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACjE,CAAC;IAEM,aAAa,CAAC,YAAoB;QACvC,OAAO,IAAI,CAAC,GAAG,CAAa,cAAc,YAAY,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,YAAoB;QAC1C,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,cAAc,YAAY,OAAO,CAAC;IAC/E,CAAC;IAED,mFAAmF;IAC5E,eAAe,CAAC,YAAoB;QACzC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,cAAc,YAAY,YAAY,CAAC;IACpF,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,YAAoB;QAC1C,OAAO,IAAI,CAAC,MAAM,CAAkB,cAAc,YAAY,EAAE,CAAC,CAAC;IACpE,CAAC;CAEF;AA7DD,gDA6DC"}

package/dist/lib/requests/BuildRequests.d.ts

@@ -6,6 +6,7 @@ import { Build } from '../models/Build';
 import { Artifact } from '../models/Artifact';
 import { BuildsResponse } from '../models/response/BuildsResponse';
 import { DefaultResponse } from '../models/response/DefaultResponse';
+import { ExecutionTypes } from '../models/enum/ExecutionTypes';
 export declare class BuildRequests extends BaseRequests {
     constructor(axiosInstance: AxiosInstance);
     createBuild(request: CreateBuild): Promise<Build>;
@@ -18,8 +19,12 @@ export declare class BuildRequests extends BaseRequests {
      * @param {boolean} [returnExecutionDetails=false]
      */
     getBuilds(teamId: string, buildIds: string[], returnExecutionDetails: boolean): Promise<BuildsResponse>;
-    getBuildsWithFilters(teamId: string, filterEnvironments: string[], filterComponents: string[], skip: number, limit: number): Promise<BuildsResponse>;
-    getBuildsWithDateFilters(teamId: string, filterEnvironments: string[], filterComponents: string[], skip: number, limit: number, fromDate: Date, toDate: Date): Promise<BuildsResponse>;
+    /**
+     * @param {ExecutionTypes=} executionType - narrow to automated or manual builds. Omit
+     * for both, preserving the behaviour every existing caller relies on.
+     */
+    getBuildsWithFilters(teamId: string, filterEnvironments: string[], filterComponents: string[], skip: number, limit: number, executionType?: ExecutionTypes): Promise<BuildsResponse>;
+    getBuildsWithDateFilters(teamId: string, filterEnvironments: string[], filterComponents: string[], skip: number, limit: number, fromDate: Date, toDate: Date, executionType?: ExecutionTypes): Promise<BuildsResponse>;
     /**
      * This function will remove builds by age (including executions and screenshots).
      * NOTE: this can not be reversed, once deleted all builds and assets will have been removed.