@harnessio/react-rmg-service-client 0.2.0 → 0.4.0

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

@@ -0,0 +1,29 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { ReleaseApprovalsResponseResponse } from '../responses/ReleaseApprovalsResponseResponse';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface GetReleaseReleaseIdApprovalsQueryPathParams {
+    releaseId: string;
+}
+export interface GetReleaseReleaseIdApprovalsQueryQueryParams {
+    orgIdentifier?: string;
+    searchTerm?: string;
+    status?: string[];
+    page?: number;
+    size?: number;
+    sort?: string[];
+}
+export interface GetReleaseReleaseIdApprovalsQueryHeaderParams {
+    'Harness-Account': string;
+}
+export type GetReleaseReleaseIdApprovalsOkResponse = ResponseWithPagination<ReleaseApprovalsResponseResponse>;
+export type GetReleaseReleaseIdApprovalsErrorResponse = ErrorResponseResponse;
+export interface GetReleaseReleaseIdApprovalsProps extends GetReleaseReleaseIdApprovalsQueryPathParams, Omit<FetcherOptions<GetReleaseReleaseIdApprovalsQueryQueryParams, unknown, GetReleaseReleaseIdApprovalsQueryHeaderParams>, 'url'> {
+    queryParams: GetReleaseReleaseIdApprovalsQueryQueryParams;
+}
+export declare function getReleaseReleaseIdApprovals(props: GetReleaseReleaseIdApprovalsProps): Promise<GetReleaseReleaseIdApprovalsOkResponse>;
+/**
+ * Fetch approvals activity for a release
+ */
+export declare function useGetReleaseReleaseIdApprovalsQuery(props: GetReleaseReleaseIdApprovalsProps, options?: Omit<UseQueryOptions<GetReleaseReleaseIdApprovalsOkResponse, GetReleaseReleaseIdApprovalsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetReleaseReleaseIdApprovalsOkResponse, import("..").Error>;

package/dist/rmg-service/src/services/hooks/useGetReleaseReleaseIdApprovalsQuery.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 getReleaseReleaseIdApprovals(props) {
+    return fetcher(Object.assign({ url: `/release/${props.releaseId}/approvals`, method: 'GET' }, props));
+}
+/**
+ * Fetch approvals activity for a release
+ */
+export function useGetReleaseReleaseIdApprovalsQuery(props, options) {
+    return useQuery(['get-release-releaseId-approvals', props.releaseId, props.queryParams], ({ signal }) => getReleaseReleaseIdApprovals(Object.assign(Object.assign({}, props), { signal })), options);
+}

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

@@ -9,6 +9,8 @@ export type { GetReleaseGroupSummaryErrorResponse, GetReleaseGroupSummaryOkRespo
 export { getReleaseGroupSummary, useGetReleaseGroupSummaryQuery, } from './hooks/useGetReleaseGroupSummaryQuery';
 export type { GetReleaseErrorResponse, GetReleaseOkResponse, GetReleaseProps, GetReleaseQueryPathParams, } from './hooks/useGetReleaseQuery';
 export { getRelease, useGetReleaseQuery } from './hooks/useGetReleaseQuery';
+export type { GetReleaseReleaseIdApprovalsErrorResponse, GetReleaseReleaseIdApprovalsOkResponse, GetReleaseReleaseIdApprovalsProps, GetReleaseReleaseIdApprovalsQueryPathParams, GetReleaseReleaseIdApprovalsQueryQueryParams, } from './hooks/useGetReleaseReleaseIdApprovalsQuery';
+export { getReleaseReleaseIdApprovals, useGetReleaseReleaseIdApprovalsQuery, } from './hooks/useGetReleaseReleaseIdApprovalsQuery';
 export type { GetReleaseReleaseIdEnvironmentDashboardErrorResponse, GetReleaseReleaseIdEnvironmentDashboardOkResponse, GetReleaseReleaseIdEnvironmentDashboardProps, GetReleaseReleaseIdEnvironmentDashboardQueryPathParams, GetReleaseReleaseIdEnvironmentDashboardQueryQueryParams, } from './hooks/useGetReleaseReleaseIdEnvironmentDashboardQuery';
 export { getReleaseReleaseIdEnvironmentDashboard, useGetReleaseReleaseIdEnvironmentDashboardQuery, } from './hooks/useGetReleaseReleaseIdEnvironmentDashboardQuery';
 export type { PostReleaseGroupErrorResponse, PostReleaseGroupMutationQueryParams, PostReleaseGroupOkResponse, PostReleaseGroupProps, PostReleaseGroupRequestBody, } from './hooks/usePostReleaseGroupMutation';
@@ -26,11 +28,14 @@ export type { EnvironmentDashboardResponseResponse } from './responses/Environme
 export type { ErrorResponseResponse } from './responses/ErrorResponseResponse';
 export type { GetReleaseGroupResponseResponse } from './responses/GetReleaseGroupResponseResponse';
 export type { ReleaseActivitiesResponseResponse } from './responses/ReleaseActivitiesResponseResponse';
+export type { ReleaseApprovalsResponseResponse } from './responses/ReleaseApprovalsResponseResponse';
 export type { ReleaseDetailsResponseResponse } from './responses/ReleaseDetailsResponseResponse';
 export type { ReleaseGroupSummaryResponseResponse } from './responses/ReleaseGroupSummaryResponseResponse';
 export type { ReleaseSummaryResponseResponse } from './responses/ReleaseSummaryResponseResponse';
 export type { UpdateReleaseGroupResponseResponse } from './responses/UpdateReleaseGroupResponseResponse';
 export type { ActivityType } from './schemas/ActivityType';
+export type { ApprovalInfoDto } from './schemas/ApprovalInfoDto';
+export type { ApprovedByDto } from './schemas/ApprovedByDto';
 export type { EnvironmentDashboardDto } from './schemas/EnvironmentDashboardDto';
 export type { EnvironmentType } from './schemas/EnvironmentType';
 export type { Error } from './schemas/Error';
@@ -39,6 +44,8 @@ export type { GetReleaseGroupResponse } from './schemas/GetReleaseGroupResponse'
 export type { Pageable } from './schemas/Pageable';
 export type { PageableSort } from './schemas/PageableSort';
 export type { ReleaseActivity } from './schemas/ReleaseActivity';
+export type { ReleaseApprovalDto } from './schemas/ReleaseApprovalDto';
+export type { ReleaseApprovalType } from './schemas/ReleaseApprovalType';
 export type { ReleaseCadence } from './schemas/ReleaseCadence';
 export type { ReleaseComponent } from './schemas/ReleaseComponent';
 export type { ReleaseEntity } from './schemas/ReleaseEntity';
@@ -48,7 +55,12 @@ export type { ReleaseGroupYaml } from './schemas/ReleaseGroupYaml';
 export type { ReleaseType } from './schemas/ReleaseType';
 export type { RepeatUnit } from './schemas/RepeatUnit';
 export type { ServiceInfoDto } from './schemas/ServiceInfoDto';
+export type { StageInfoDetailsDto } from './schemas/StageInfoDetailsDto';
+export type { StageInfoDto } from './schemas/StageInfoDto';
 export type { StageInfoType } from './schemas/StageInfoType';
 export type { Status } from './schemas/Status';
+export type { StepInfoDetailsDto } from './schemas/StepInfoDetailsDto';
+export type { StepInfoDto } from './schemas/StepInfoDto';
 export type { StepInfoType } from './schemas/StepInfoType';
 export type { TriggerType } from './schemas/TriggerType';
+export type { TriggeredByDto } from './schemas/TriggeredByDto';

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

@@ -3,6 +3,7 @@ export { getReleaseActivities, useGetReleaseActivitiesQuery, } from './hooks/use
 export { getReleaseGroup, useGetReleaseGroupQuery } from './hooks/useGetReleaseGroupQuery';
 export { getReleaseGroupSummary, useGetReleaseGroupSummaryQuery, } from './hooks/useGetReleaseGroupSummaryQuery';
 export { getRelease, useGetReleaseQuery } from './hooks/useGetReleaseQuery';
+export { getReleaseReleaseIdApprovals, useGetReleaseReleaseIdApprovalsQuery, } from './hooks/useGetReleaseReleaseIdApprovalsQuery';
 export { getReleaseReleaseIdEnvironmentDashboard, useGetReleaseReleaseIdEnvironmentDashboardQuery, } from './hooks/useGetReleaseReleaseIdEnvironmentDashboardQuery';
 export { postReleaseGroup, usePostReleaseGroupMutation } from './hooks/usePostReleaseGroupMutation';
 export { postReleaseSummary, usePostReleaseSummaryMutation, } from './hooks/usePostReleaseSummaryMutation';

package/dist/rmg-service/src/services/responses/ReleaseApprovalsResponseResponse.d.ts

@@ -0,0 +1,16 @@
+import type { ReleaseApprovalDto } from '../schemas/ReleaseApprovalDto';
+import type { Pageable } from '../schemas/Pageable';
+import type { PageableSort } from '../schemas/PageableSort';
+export interface ReleaseApprovalsResponseResponse {
+    content: ReleaseApprovalDto[];
+    empty: boolean;
+    first: boolean;
+    last: boolean;
+    number: number;
+    numberOfElements: number;
+    pageable: Pageable;
+    size: number;
+    sort: PageableSort;
+    totalElements: number;
+    totalPages: number;
+}

package/dist/rmg-service/src/services/responses/ReleaseApprovalsResponseResponse.js

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

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

@@ -0,0 +1,13 @@
+import type { ApprovedByDto } from '../schemas/ApprovedByDto';
+export interface ApprovalInfoDto {
+    /**
+     * Timestamp of the approval.
+     * @format int64
+     */
+    approvedAt: number;
+    approvedBy: ApprovedByDto;
+    /**
+     * Comments provided during the approval.
+     */
+    comments?: string;
+}

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

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

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

@@ -0,0 +1,10 @@
+export interface ApprovedByDto {
+    /**
+     * Email of the person who approved the step.
+     */
+    email: string;
+    /**
+     * Name of the person who approved the step.
+     */
+    name?: string;
+}

package/dist/rmg-service/src/services/schemas/ApprovedByDto.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/ReleaseActivity.d.ts

@@ -1,7 +1,6 @@
-import type { Status } from '../schemas/Status';
-import type { StageInfoType } from '../schemas/StageInfoType';
-import type { StepInfoType } from '../schemas/StepInfoType';
-import type { TriggerType } from '../schemas/TriggerType';
+import type { StageInfoDto } from '../schemas/StageInfoDto';
+import type { StepInfoDto } from '../schemas/StepInfoDto';
+import type { TriggeredByDto } from '../schemas/TriggeredByDto';
 import type { ActivityType } from '../schemas/ActivityType';
 export interface ReleaseActivity {
     /**
@@ -32,132 +31,8 @@ export interface ReleaseActivity {
      * Project identifier.
      */
     projectIdentifier: string;
-    /**
-     * Details about the stage activity (provided if type is stage).
-     */
-    stageInfo?: {
-        /**
-         * End timestamp of the stage.
-         */
-        endTs?: number;
-        /**
-         * Identifier of the stage.
-         */
-        identifier: string;
-        /**
-         * Info related to stage
-         */
-        info?: {
-            /**
-             * Display name of the artifact.
-             */
-            artifactDisplayName?: string;
-            /**
-             * Identifier of the environment.
-             */
-            envId?: string;
-            /**
-             * Name of the environment.
-             */
-            envName?: string;
-            /**
-             * Identifier of the service.
-             */
-            serviceId?: string;
-            /**
-             * Name of the service.
-             */
-            serviceName?: string;
-        } | null;
-        /**
-         * Name of the stage.
-         */
-        name: string;
-        /**
-         * Start timestamp of the stage.
-         */
-        startTs?: number;
-        status: Status;
-        type: StageInfoType;
-    } | null;
-    /**
-     * Details about the step activity (provided if type is step).
-     */
-    stepInfo?: {
-        /**
-         * End timestamp of the step.
-         */
-        endTs?: number;
-        /**
-         * Identifier of the step.
-         */
-        identifier: string;
-        /**
-         * Provided if `type` is Approval.
-         */
-        info?: {
-            /**
-             * Action taken for the approval.
-             */
-            approvalAction?: string;
-            /**
-             * Timestamp of the approval.
-             * @format int64
-             */
-            approvedAt?: number;
-            /**
-             * Email of the person who approved the step.
-             */
-            approvedByEmail?: string;
-            /**
-             * Name of the person who approved the step.
-             */
-            approvedByName?: string;
-            /**
-             * Comments provided during the approval.
-             */
-            comments?: string;
-            /**
-             * Type of the Jira issue.
-             */
-            issueType?: string;
-            /**
-             * URL of the Jira ticket.
-             */
-            jiraUrl?: string;
-            /**
-             * Status of the Jira ticket.
-             */
-            ticketStatus?: string;
-        } | null;
-        /**
-         * Name of the step.
-         */
-        name: string;
-        /**
-         * Start timestamp of the step.
-         */
-        startTs?: number;
-        status: Status;
-        type: StepInfoType;
-    } | null;
-    /**
-     * Details of the user who triggered the activity.
-     */
-    triggeredBy: {
-        /**
-         * Avatar URL of the person.
-         */
-        avatar?: string;
-        /**
-         * Identifier of the person who triggered the activity.
-         */
-        id?: string;
-        /**
-         * Name of the person who triggered the activity.
-         */
-        name?: string;
-        triggerType?: TriggerType;
-    };
+    stageInfo?: StageInfoDto;
+    stepInfo?: StepInfoDto;
+    triggeredBy: TriggeredByDto;
     type: ActivityType;
 }

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

@@ -0,0 +1,14 @@
+import type { ApprovalInfoDto } from '../schemas/ApprovalInfoDto';
+import type { Status } from '../schemas/Status';
+import type { ReleaseApprovalType } from '../schemas/ReleaseApprovalType';
+export interface ReleaseApprovalDto {
+    approvalInfo?: ApprovalInfoDto;
+    name: string;
+    orgIdentifier: string;
+    pipelineIdentifier: string;
+    planExecutionId: string;
+    projectIdentifier: string;
+    runSequenceId: number;
+    status: Status;
+    type: ReleaseApprovalType;
+}

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * Type of the step (e.g., Approval, JiraUpdate, JiraCreate, JiraApproval).
+ */
+export type ReleaseApprovalType = 'HarnessApproval' | 'JiraApproval';

package/dist/rmg-service/src/services/schemas/ReleaseApprovalType.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/StageInfoDetailsDto.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Info related to stage
+ */
+export interface StageInfoDetailsDto {
+    /**
+     * Display name of the artifact.
+     */
+    artifactDisplayName?: string;
+    /**
+     * Identifier of the environment.
+     */
+    envId?: string;
+    /**
+     * Name of the environment.
+     */
+    envName?: string;
+    /**
+     * Identifier of the service.
+     */
+    serviceId?: string;
+    /**
+     * Name of the service.
+     */
+    serviceName?: string;
+}

package/dist/rmg-service/src/services/schemas/StageInfoDetailsDto.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/StageInfoDto.d.ts

@@ -0,0 +1,27 @@
+import type { StageInfoDetailsDto } from '../schemas/StageInfoDetailsDto';
+import type { Status } from '../schemas/Status';
+import type { StageInfoType } from '../schemas/StageInfoType';
+/**
+ * Details about the stage activity (provided if type is stage).
+ */
+export interface StageInfoDto {
+    /**
+     * End timestamp of the stage.
+     */
+    endTs?: number;
+    /**
+     * Identifier of the stage.
+     */
+    identifier: string;
+    info: StageInfoDetailsDto;
+    /**
+     * Name of the stage.
+     */
+    name: string;
+    /**
+     * Start timestamp of the stage.
+     */
+    startTs: number;
+    status: Status;
+    type: StageInfoType;
+}

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

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

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

@@ -0,0 +1,38 @@
+/**
+ * Provided if `type` is Approval.
+ */
+export interface StepInfoDetailsDto {
+    /**
+     * Action taken for the approval.
+     */
+    approvalAction?: string;
+    /**
+     * Timestamp of the approval.
+     * @format integer
+     */
+    approvedAt?: number;
+    /**
+     * Email of the person who approved the step.
+     */
+    approvedByEmail?: string;
+    /**
+     * Name of the person who approved the step.
+     */
+    approvedByName?: string;
+    /**
+     * Comments provided during the approval.
+     */
+    comments?: string;
+    /**
+     * Type of the Jira issue.
+     */
+    issueType?: string;
+    /**
+     * URL of the Jira ticket.
+     */
+    jiraUrl?: string;
+    /**
+     * Status of the Jira ticket.
+     */
+    ticketStatus?: string;
+}

package/dist/rmg-service/src/services/schemas/StepInfoDetailsDto.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/StepInfoDto.d.ts

@@ -0,0 +1,27 @@
+import type { StepInfoDetailsDto } from '../schemas/StepInfoDetailsDto';
+import type { Status } from '../schemas/Status';
+import type { StepInfoType } from '../schemas/StepInfoType';
+/**
+ * Details about the step activity (provided if type is step).
+ */
+export interface StepInfoDto {
+    /**
+     * End timestamp of the step.
+     */
+    endTs?: number;
+    /**
+     * Identifier of the step.
+     */
+    identifier: string;
+    info: StepInfoDetailsDto;
+    /**
+     * Name of the step.
+     */
+    name: string;
+    /**
+     * Start timestamp of the step.
+     */
+    startTs: number;
+    status: Status;
+    type: StepInfoType;
+}

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

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

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

@@ -1,4 +1,4 @@
 /**
  * Type of the step (e.g., Approval, JiraUpdate, JiraCreate, JiraApproval).
  */
-export type StepInfoType = 'Approval' | 'JiraApproval' | 'JiraCreate' | 'JiraUpdate';
+export type StepInfoType = 'HarnessApproval' | 'JiraApproval' | 'JiraCreate' | 'JiraUpdate';

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

@@ -0,0 +1,19 @@
+import type { TriggerType } from '../schemas/TriggerType';
+/**
+ * Details of the user who triggered the activity.
+ */
+export interface TriggeredByDto {
+    /**
+     * Avatar URL of the person.
+     */
+    avatar?: string;
+    /**
+     * Identifier of the person who triggered the activity.
+     */
+    id?: string;
+    /**
+     * Name of the person who triggered the activity.
+     */
+    name?: string;
+    triggerType?: TriggerType;
+}

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

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

package/package.json

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