@harnessio/react-rmg-service-client 0.91.0 → 0.92.1-beta.0

package/dist/rmg-service/src/services/hooks/useListPendingApprovalsQuery.d.ts

@@ -0,0 +1,34 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { PendingApprovalList } from '../schemas/PendingApprovalList';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface ListPendingApprovalsQueryQueryParams {
+    orgIdentifier?: string;
+    projectIdentifier?: string;
+    myApprovals?: boolean;
+    pendingOnMe?: boolean;
+    requestedBy?: string;
+    pendingOnUserId?: string;
+    pendingOnOthers?: boolean;
+    nextCursor?: string;
+    previousCursor?: string;
+    sort?: string;
+    /**
+     * @default 20
+     */
+    size?: number;
+}
+export interface ListPendingApprovalsQueryHeaderParams {
+    'Harness-Account': string;
+}
+export type ListPendingApprovalsOkResponse = ResponseWithPagination<PendingApprovalList>;
+export type ListPendingApprovalsErrorResponse = ErrorResponseResponse;
+export interface ListPendingApprovalsProps extends Omit<FetcherOptions<ListPendingApprovalsQueryQueryParams, unknown, ListPendingApprovalsQueryHeaderParams>, 'url'> {
+    queryParams: ListPendingApprovalsQueryQueryParams;
+}
+export declare function listPendingApprovals(props: ListPendingApprovalsProps): Promise<ListPendingApprovalsOkResponse>;
+/**
+ * Collects the pipeline plan execution IDs of every pipeline activity in the given scope that is waiting for a user action, and returns the approval instances currently pending on them. Scope matching is exact: with no orgIdentifier/projectIdentifier only account-level activities are considered. Results are cursor-paginated; pass the lastSeenId and lastSeenCreatedAt from the previous response to fetch the next page.
+ */
+export declare function useListPendingApprovalsQuery(props: ListPendingApprovalsProps, options?: Omit<UseQueryOptions<ListPendingApprovalsOkResponse, ListPendingApprovalsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListPendingApprovalsOkResponse, import("..").Error>;

package/dist/rmg-service/src/services/hooks/useListPendingApprovalsQuery.js

@@ -0,0 +1,14 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useQuery } from '@tanstack/react-query';
+import { fetcher } from '../../../../fetcher/index.js';
+export function listPendingApprovals(props) {
+    return fetcher(Object.assign({ url: `/approvals/pending`, method: 'GET' }, props));
+}
+/**
+ * Collects the pipeline plan execution IDs of every pipeline activity in the given scope that is waiting for a user action, and returns the approval instances currently pending on them. Scope matching is exact: with no orgIdentifier/projectIdentifier only account-level activities are considered. Results are cursor-paginated; pass the lastSeenId and lastSeenCreatedAt from the previous response to fetch the next page.
+ */
+export function useListPendingApprovalsQuery(props, options) {
+    return useQuery(['listPendingApprovals', props.queryParams], ({ signal }) => listPendingApprovals(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/rmg-service/src/services/hooks/useListPendingTasksQuery.d.ts

@@ -0,0 +1,34 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { PendingTaskList } from '../schemas/PendingTaskList';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface ListPendingTasksQueryQueryParams {
+    orgIdentifier?: string;
+    projectIdentifier?: string;
+    myTasks?: boolean;
+    pendingOnMe?: boolean;
+    requestedBy?: string;
+    pendingOnUserId?: string;
+    pendingOnOthers?: boolean;
+    nextCursor?: string;
+    previousCursor?: string;
+    sort?: string;
+    /**
+     * @default 20
+     */
+    size?: number;
+}
+export interface ListPendingTasksQueryHeaderParams {
+    'Harness-Account': string;
+}
+export type ListPendingTasksOkResponse = ResponseWithPagination<PendingTaskList>;
+export type ListPendingTasksErrorResponse = ErrorResponseResponse;
+export interface ListPendingTasksProps extends Omit<FetcherOptions<ListPendingTasksQueryQueryParams, unknown, ListPendingTasksQueryHeaderParams>, 'url'> {
+    queryParams: ListPendingTasksQueryQueryParams;
+}
+export declare function listPendingTasks(props: ListPendingTasksProps): Promise<ListPendingTasksOkResponse>;
+/**
+ * Returns manual activity tasks that are in a pending state (activity status RUNNING, ON_HOLD, or OUTPUT_WAITING) within the given scope. When myTasks is true, only tasks assigned to the calling user (via user_reference_id or user_groups membership) are returned.
+ */
+export declare function useListPendingTasksQuery(props: ListPendingTasksProps, options?: Omit<UseQueryOptions<ListPendingTasksOkResponse, ListPendingTasksErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListPendingTasksOkResponse, import("..").Error>;

package/dist/rmg-service/src/services/hooks/useListPendingTasksQuery.js

@@ -0,0 +1,14 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useQuery } from '@tanstack/react-query';
+import { fetcher } from '../../../../fetcher/index.js';
+export function listPendingTasks(props) {
+    return fetcher(Object.assign({ url: `/tasks/pending`, method: 'GET' }, props));
+}
+/**
+ * Returns manual activity tasks that are in a pending state (activity status RUNNING, ON_HOLD, or OUTPUT_WAITING) within the given scope. When myTasks is true, only tasks assigned to the calling user (via user_reference_id or user_groups membership) are returned.
+ */
+export function useListPendingTasksQuery(props, options) {
+    return useQuery(['listPendingTasks', props.queryParams], ({ signal }) => listPendingTasks(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/rmg-service/src/services/index.d.ts

@@ -157,6 +157,10 @@ export type { ListChangesetsErrorResponse, ListChangesetsOkResponse, ListChanges
 export { listChangesets, useListChangesetsQuery } from './hooks/useListChangesetsQuery';
 export type { ListIntegrationExecutionsErrorResponse, ListIntegrationExecutionsOkResponse, ListIntegrationExecutionsProps, ListIntegrationExecutionsQueryQueryParams, } from './hooks/useListIntegrationExecutionsQuery';
 export { listIntegrationExecutions, useListIntegrationExecutionsQuery, } from './hooks/useListIntegrationExecutionsQuery';
+export type { ListPendingApprovalsErrorResponse, ListPendingApprovalsOkResponse, ListPendingApprovalsProps, ListPendingApprovalsQueryQueryParams, } from './hooks/useListPendingApprovalsQuery';
+export { listPendingApprovals, useListPendingApprovalsQuery, } from './hooks/useListPendingApprovalsQuery';
+export type { ListPendingTasksErrorResponse, ListPendingTasksOkResponse, ListPendingTasksProps, ListPendingTasksQueryQueryParams, } from './hooks/useListPendingTasksQuery';
+export { listPendingTasks, useListPendingTasksQuery } from './hooks/useListPendingTasksQuery';
 export type { MoveOrchestrationActivityToGitErrorResponse, MoveOrchestrationActivityToGitMutationPathParams, MoveOrchestrationActivityToGitMutationQueryParams, MoveOrchestrationActivityToGitOkResponse, MoveOrchestrationActivityToGitProps, MoveOrchestrationActivityToGitRequestBody, } from './hooks/useMoveOrchestrationActivityToGitMutation';
 export { moveOrchestrationActivityToGit, useMoveOrchestrationActivityToGitMutation, } from './hooks/useMoveOrchestrationActivityToGitMutation';
 export type { MoveOrchestrationProcessInputToGitErrorResponse, MoveOrchestrationProcessInputToGitMutationPathParams, MoveOrchestrationProcessInputToGitMutationQueryParams, MoveOrchestrationProcessInputToGitOkResponse, MoveOrchestrationProcessInputToGitProps, MoveOrchestrationProcessInputToGitRequestBody, } from './hooks/useMoveOrchestrationProcessInputToGitMutation';
@@ -482,6 +486,12 @@ export type { OutputDataType } from './schemas/OutputDataType';
 export type { OutputVariable } from './schemas/OutputVariable';
 export type { Pageable } from './schemas/Pageable';
 export type { PageableSort } from './schemas/PageableSort';
+export type { PendingApproval } from './schemas/PendingApproval';
+export type { PendingApprovalExecutionContext } from './schemas/PendingApprovalExecutionContext';
+export type { PendingApprovalList } from './schemas/PendingApprovalList';
+export type { PendingTask } from './schemas/PendingTask';
+export type { PendingTaskExecutionContext } from './schemas/PendingTaskExecutionContext';
+export type { PendingTaskList } from './schemas/PendingTaskList';
 export type { PhaseActionRequest } from './schemas/PhaseActionRequest';
 export type { PhaseActionResponse } from './schemas/PhaseActionResponse';
 export type { PhaseArtifactUpdateDto } from './schemas/PhaseArtifactUpdateDto';

package/dist/rmg-service/src/services/index.js

@@ -77,6 +77,8 @@ export { listArtifacts, useListArtifactsQuery } from './hooks/useListArtifactsQu
 export { listChangesetCommits, useListChangesetCommitsQuery, } from './hooks/useListChangesetCommitsQuery';
 export { listChangesets, useListChangesetsQuery } from './hooks/useListChangesetsQuery';
 export { listIntegrationExecutions, useListIntegrationExecutionsQuery, } from './hooks/useListIntegrationExecutionsQuery';
+export { listPendingApprovals, useListPendingApprovalsQuery, } from './hooks/useListPendingApprovalsQuery';
+export { listPendingTasks, useListPendingTasksQuery } from './hooks/useListPendingTasksQuery';
 export { moveOrchestrationActivityToGit, useMoveOrchestrationActivityToGitMutation, } from './hooks/useMoveOrchestrationActivityToGitMutation';
 export { moveOrchestrationProcessInputToGit, useMoveOrchestrationProcessInputToGitMutation, } from './hooks/useMoveOrchestrationProcessInputToGitMutation';
 export { moveOrchestrationProcessToGit, useMoveOrchestrationProcessToGitMutation, } from './hooks/useMoveOrchestrationProcessToGitMutation';

package/dist/rmg-service/src/services/schemas/ArtifactTrackerSettings.d.ts

@@ -1,5 +1,9 @@
 import type { GitProviderType } from '../schemas/GitProviderType';
 export interface ArtifactTrackerSettings {
+    /**
+     * Docker connector the changeset pipeline pulls its images through when neither defaultDockerConnectorRef nor a service mapping override is set.
+     */
+    builtInDefaultDockerConnectorRef: string;
     /**
      * @format int64
      */

package/dist/rmg-service/src/services/schemas/PendingApproval.d.ts

@@ -0,0 +1,69 @@
+import type { PendingApprovalExecutionContext } from '../schemas/PendingApprovalExecutionContext';
+import type { TriggeredByDto } from '../schemas/TriggeredByDto';
+/**
+ * A pipeline approval that is waiting, together with the RMG execution it belongs to
+ */
+export interface PendingApproval {
+    /**
+     * Account the pipeline execution belongs to
+     */
+    accountIdentifier?: string;
+    /**
+     * Identifier of the approval instance in the pipeline service
+     */
+    approvalId: string;
+    approvalMessage?: string;
+    /**
+     * @format int64
+     */
+    createdAt?: number;
+    /**
+     * Epoch millis after which the approval expires
+     * @format int64
+     */
+    deadline?: number;
+    errorMessage?: string;
+    executionContext: PendingApprovalExecutionContext;
+    /**
+     * @format int64
+     */
+    lastModifiedAt?: number;
+    /**
+     * Node execution ID in the pipeline execution graph
+     */
+    nodeExecutionId?: string;
+    /**
+     * Organisation the pipeline execution belongs to
+     */
+    orgIdentifier?: string;
+    pipelineIdentifier?: string;
+    /**
+     * Pipeline plan execution the approval belongs to
+     */
+    planExecutionId: string;
+    /**
+     * Project the pipeline execution belongs to
+     */
+    projectIdentifier?: string;
+    /**
+     * Sequential run number of the pipeline execution
+     */
+    runSequence?: number;
+    /**
+     * Pipeline stage identifier containing the approval step
+     */
+    stageIdentifier?: string;
+    /**
+     * Approval instance status, e.g. WAITING
+     */
+    status: string;
+    /**
+     * Pipeline step identifier for the approval step
+     */
+    stepIdentifier?: string;
+    triggeredBy?: TriggeredByDto;
+    /**
+     * Approval type, e.g. HARNESS_APPROVAL, JIRA_APPROVAL
+     */
+    type: string;
+}

package/dist/rmg-service/src/services/schemas/PendingApproval.js

@@ -0,0 +1 @@
+export {};

package/dist/rmg-service/src/services/schemas/PendingApprovalExecutionContext.d.ts

@@ -0,0 +1,60 @@
+export interface PendingApprovalExecutionContext {
+    /**
+     * Activity execution that is waiting for the approval
+     */
+    activityExecutionId: string;
+    /**
+     * Identifier (slug) of the activity definition
+     */
+    activityId?: string;
+    /**
+     * Name of the activity
+     */
+    activityName?: string;
+    orgId?: string;
+    /**
+     * Parent activity execution, present only for grouped activities
+     */
+    parentActivityExecutionId?: string;
+    /**
+     * Parent phase execution, present only for nested phases
+     */
+    parentPhaseExecutionId?: string;
+    /**
+     * Phase execution the waiting activity belongs to
+     */
+    phaseExecutionId: string;
+    /**
+     * Identifier (slug) of the phase definition
+     */
+    phaseId?: string;
+    /**
+     * Name of the phase
+     */
+    phaseName?: string;
+    /**
+     * Process execution the waiting activity belongs to
+     */
+    processExecutionId: string;
+    /**
+     * Present when the activity belongs to a directly-triggered process (no release)
+     */
+    processId?: string;
+    /**
+     * Name of the process definition
+     */
+    processName?: string;
+    projectId?: string;
+    /**
+     * Present when the activity belongs to a release
+     */
+    releaseId?: string;
+    /**
+     * Human-readable name of the release
+     */
+    releaseName?: string;
+    /**
+     * Version label of the release
+     */
+    releaseVersion?: string;
+}

package/dist/rmg-service/src/services/schemas/PendingApprovalExecutionContext.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/dist/rmg-service/src/services/schemas/PendingApprovalList.d.ts

@@ -0,0 +1,23 @@
+import type { PendingApproval } from '../schemas/PendingApproval';
+/**
+ * Cursor-paginated list of pending approvals
+ */
+export interface PendingApprovalList {
+    content?: PendingApproval[];
+    /**
+     * Number of items in this page
+     */
+    currentSize?: number;
+    /**
+     * Whether additional pages are available
+     */
+    hasMore?: boolean;
+    /**
+     * Opaque forward cursor. Pass as nextCursor on the next request to continue pagination. Absent when hasMore is false.
+     */
+    nextCursor?: string;
+    /**
+     * Opaque cursor for the previous backward page. Pass as previousCursor on the next request to navigate backward. Absent when this is the first page.
+     */
+    prevCursor?: string;
+}

package/dist/rmg-service/src/services/schemas/PendingApprovalList.js

@@ -0,0 +1 @@
+export {};

package/dist/rmg-service/src/services/schemas/PendingTask.d.ts

@@ -0,0 +1,42 @@
+import type { PendingTaskExecutionContext } from '../schemas/PendingTaskExecutionContext';
+import type { FailureInfo } from '../schemas/FailureInfo';
+import type { StringOrBool } from '../schemas/StringOrBool';
+import type { ExecutionTaskStatus } from '../schemas/ExecutionTaskStatus';
+import type { TriggeredByDto } from '../schemas/TriggeredByDto';
+import type { StringOrStringArray } from '../schemas/StringOrStringArray';
+export interface PendingTask {
+    /**
+     * Actual duration taken for the task (e.g., "7h")
+     */
+    actualDuration?: string;
+    /**
+     * @format int64
+     */
+    createdAt?: number;
+    description?: string;
+    executionContext: PendingTaskExecutionContext;
+    /**
+     * Expected duration in milliseconds
+     * @format int64
+     */
+    expectedDuration: number;
+    failureInfo?: FailureInfo;
+    identifier: string;
+    /**
+     * @format int64
+     */
+    lastUpdatedAt?: number;
+    name: string;
+    required: StringOrBool;
+    status: ExecutionTaskStatus;
+    /**
+     * UUID of the task execution record
+     */
+    taskExecutionId?: string;
+    triggeredBy?: TriggeredByDto;
+    userGroups: StringOrStringArray;
+    /**
+     * Identifier of the user directly assigned to this task
+     */
+    userReferenceId?: string;
+}

package/dist/rmg-service/src/services/schemas/PendingTask.js

@@ -0,0 +1 @@
+export {};

package/dist/rmg-service/src/services/schemas/PendingTaskExecutionContext.d.ts

@@ -0,0 +1,43 @@
+export interface PendingTaskExecutionContext {
+    activityExecutionId: string;
+    /**
+     * Identifier (slug) of the activity definition
+     */
+    activityId?: string;
+    /**
+     * Name of the activity the task belongs to
+     */
+    activityName?: string;
+    orgId?: string;
+    phaseExecutionId: string;
+    /**
+     * Identifier (slug) of the phase definition
+     */
+    phaseId?: string;
+    /**
+     * Name of the phase
+     */
+    phaseName?: string;
+    processExecutionId: string;
+    /**
+     * Present when the task belongs to a directly-triggered process (no release)
+     */
+    processId?: string;
+    /**
+     * Name of the process definition
+     */
+    processName?: string;
+    projectId?: string;
+    /**
+     * Present when the task belongs to a release
+     */
+    releaseId?: string;
+    /**
+     * Human-readable name of the release
+     */
+    releaseName?: string;
+    /**
+     * Version label of the release
+     */
+    releaseVersion?: string;
+}

package/dist/rmg-service/src/services/schemas/PendingTaskExecutionContext.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/dist/rmg-service/src/services/schemas/PendingTaskList.d.ts

@@ -0,0 +1,23 @@
+import type { PendingTask } from '../schemas/PendingTask';
+/**
+ * Cursor-paginated list of pending manual activity tasks
+ */
+export interface PendingTaskList {
+    content?: PendingTask[];
+    /**
+     * Number of items in this page
+     */
+    currentSize?: number;
+    /**
+     * Whether additional pages are available
+     */
+    hasMore?: boolean;
+    /**
+     * Opaque forward cursor. Pass as nextCursor on the next request. Absent when hasMore is false.
+     */
+    nextCursor?: string;
+    /**
+     * Opaque backward cursor. Pass as previousCursor on the next request to navigate backward. Absent when this is the first page.
+     */
+    prevCursor?: string;
+}

package/dist/rmg-service/src/services/schemas/PendingTaskList.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/react-rmg-service-client",
-  "version": "0.91.0",
+  "version": "0.92.1-beta.0",
   "description": "Harness Release Management Service APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",