@harnessio/react-rmg-service-client 0.0.3 → 0.1.0

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

@@ -0,0 +1,26 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { ReleaseActivitiesResponseResponse } from '../responses/ReleaseActivitiesResponseResponse';
+import type { ErrorResponseResponse } from '../responses/ErrorResponseResponse';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../fetcher/index.js';
+export interface GetReleaseActivitiesQueryPathParams {
+    releaseId: string;
+}
+export interface GetReleaseActivitiesQueryQueryParams {
+    orgIdentifier?: string;
+    startTs: number;
+    endTs: number;
+}
+export interface GetReleaseActivitiesQueryHeaderParams {
+    'Harness-Account': string;
+}
+export type GetReleaseActivitiesOkResponse = ResponseWithPagination<ReleaseActivitiesResponseResponse>;
+export type GetReleaseActivitiesErrorResponse = ErrorResponseResponse;
+export interface GetReleaseActivitiesProps extends GetReleaseActivitiesQueryPathParams, Omit<FetcherOptions<GetReleaseActivitiesQueryQueryParams, unknown, GetReleaseActivitiesQueryHeaderParams>, 'url'> {
+    queryParams: GetReleaseActivitiesQueryQueryParams;
+}
+export declare function getReleaseActivities(props: GetReleaseActivitiesProps): Promise<GetReleaseActivitiesOkResponse>;
+/**
+ * Fetch a list of activities based on the startTime, endTime and release Id.
+ */
+export declare function useGetReleaseActivitiesQuery(props: GetReleaseActivitiesProps, options?: Omit<UseQueryOptions<GetReleaseActivitiesOkResponse, GetReleaseActivitiesErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetReleaseActivitiesOkResponse, import("..").Error>;

package/dist/rmg-service/src/services/hooks/useGetReleaseActivitiesQuery.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 getReleaseActivities(props) {
+    return fetcher(Object.assign({ url: `/release/${props.releaseId}/activities`, method: 'GET' }, props));
+}
+/**
+ * Fetch a list of activities based on the startTime, endTime and release Id.
+ */
+export function useGetReleaseActivitiesQuery(props, options) {
+    return useQuery(['getReleaseActivities', props.releaseId, props.queryParams], ({ signal }) => getReleaseActivities(Object.assign(Object.assign({}, props), { signal })), options);
+}

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

@@ -1,6 +1,8 @@
 export type { GetPathParamsType, ResponseWithPagination } from './helpers';
 export type { DeleteReleaseGroupErrorResponse, DeleteReleaseGroupMutationPathParams, DeleteReleaseGroupMutationQueryParams, DeleteReleaseGroupOkResponse, DeleteReleaseGroupProps, } from './hooks/useDeleteReleaseGroupMutation';
 export { deleteReleaseGroup, useDeleteReleaseGroupMutation, } from './hooks/useDeleteReleaseGroupMutation';
+export type { GetReleaseActivitiesErrorResponse, GetReleaseActivitiesOkResponse, GetReleaseActivitiesProps, GetReleaseActivitiesQueryPathParams, GetReleaseActivitiesQueryQueryParams, } from './hooks/useGetReleaseActivitiesQuery';
+export { getReleaseActivities, useGetReleaseActivitiesQuery, } from './hooks/useGetReleaseActivitiesQuery';
 export type { GetReleaseGroupErrorResponse, GetReleaseGroupOkResponse, GetReleaseGroupProps, GetReleaseGroupQueryPathParams, GetReleaseGroupQueryQueryParams, } from './hooks/useGetReleaseGroupQuery';
 export { getReleaseGroup, useGetReleaseGroupQuery } from './hooks/useGetReleaseGroupQuery';
 export type { PostReleaseGroupErrorResponse, PostReleaseGroupMutationQueryParams, PostReleaseGroupOkResponse, PostReleaseGroupProps, PostReleaseGroupRequestBody, } from './hooks/usePostReleaseGroupMutation';
@@ -16,10 +18,14 @@ export type { CreateReleaseGroupResponseResponse } from './responses/CreateRelea
 export type { DeleteReleaseGroupResponseResponse } from './responses/DeleteReleaseGroupResponseResponse';
 export type { ErrorResponseResponse } from './responses/ErrorResponseResponse';
 export type { GetReleaseGroupResponseResponse } from './responses/GetReleaseGroupResponseResponse';
+export type { ReleaseActivitiesResponseResponse } from './responses/ReleaseActivitiesResponseResponse';
 export type { ReleaseSummaryResponseResponse } from './responses/ReleaseSummaryResponseResponse';
 export type { UpdateReleaseGroupResponseResponse } from './responses/UpdateReleaseGroupResponseResponse';
+export type { ActivityType } from './schemas/ActivityType';
 export type { Error } from './schemas/Error';
+export type { Freq } from './schemas/Freq';
 export type { GetReleaseGroupResponse } from './schemas/GetReleaseGroupResponse';
+export type { ReleaseActivity } from './schemas/ReleaseActivity';
 export type { ReleaseCadence } from './schemas/ReleaseCadence';
 export type { ReleaseComponent } from './schemas/ReleaseComponent';
 export type { ReleaseEntity } from './schemas/ReleaseEntity';
@@ -27,3 +33,7 @@ export type { ReleaseFrequency } from './schemas/ReleaseFrequency';
 export type { ReleaseGroupYaml } from './schemas/ReleaseGroupYaml';
 export type { ReleaseType } from './schemas/ReleaseType';
 export type { RepeatUnit } from './schemas/RepeatUnit';
+export type { StageInfoType } from './schemas/StageInfoType';
+export type { Status } from './schemas/Status';
+export type { StepInfoType } from './schemas/StepInfoType';
+export type { TriggerType } from './schemas/TriggerType';

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

@@ -1,4 +1,5 @@
 export { deleteReleaseGroup, useDeleteReleaseGroupMutation, } from './hooks/useDeleteReleaseGroupMutation';
+export { getReleaseActivities, useGetReleaseActivitiesQuery, } from './hooks/useGetReleaseActivitiesQuery';
 export { getReleaseGroup, useGetReleaseGroupQuery } from './hooks/useGetReleaseGroupQuery';
 export { postReleaseGroup, usePostReleaseGroupMutation } from './hooks/usePostReleaseGroupMutation';
 export { postReleaseSummary, usePostReleaseSummaryMutation, } from './hooks/usePostReleaseSummaryMutation';

package/dist/rmg-service/src/services/requestBodies/ReleaseSummaryRequestRequestBody.d.ts

@@ -1,12 +1,6 @@
-export type ReleaseSummaryRequestRequestBody = Array<{
-    /**
-     * End timestamp in milliseconds
-     * @example 1700600000000
-     */
-    endTime: number;
-    /**
-     * Start timestamp in milliseconds
-     * @example 1700000000000
-     */
-    startTime: number;
-}>;
+export interface ReleaseSummaryRequestRequestBody {
+    timeRanges?: Array<{
+        endTime: number;
+        startTime: number;
+    }>;
+}

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

@@ -0,0 +1,7 @@
+import type { ReleaseActivity } from '../schemas/ReleaseActivity';
+export interface ReleaseActivitiesResponseResponse {
+    /**
+     * List of activities.
+     */
+    activities?: ReleaseActivity[];
+}

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

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

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

@@ -1,2 +1,4 @@
 import type { ReleaseEntity } from '../schemas/ReleaseEntity';
-export type ReleaseSummaryResponseResponse = ReleaseEntity[];
+export interface ReleaseSummaryResponseResponse {
+    releases?: ReleaseEntity[];
+}

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

@@ -0,0 +1,4 @@
+/**
+ * Type of the activity (e.g., stage, step).
+ */
+export type ActivityType = 'stage' | 'step';

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

@@ -0,0 +1,4 @@
+/**
+ * Unit of time used for repeating releases.
+ */
+export type Freq = 'Daily' | 'Monthly' | 'Weekly';

package/dist/rmg-service/src/services/schemas/Freq.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

@@ -0,0 +1,163 @@
+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 { ActivityType } from '../schemas/ActivityType';
+export interface ReleaseActivity {
+    /**
+     * Account identifier.
+     */
+    accountId: string;
+    /**
+     * Unique identifier for the activity.
+     */
+    id: string;
+    /**
+     * Organization identifier.
+     */
+    orgIdentifier: string;
+    /**
+     * Pipeline identifier.
+     */
+    pipelineIdentifier: string;
+    /**
+     * Name of the pipeline.
+     */
+    pipelineName: string;
+    /**
+     * Plan execution identifier.
+     */
+    planExecutionId: string;
+    /**
+     * 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;
+    };
+    type: ActivityType;
+}

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

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

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

@@ -1,17 +1,27 @@
 import type { ReleaseFrequency } from '../schemas/ReleaseFrequency';
-import type { RepeatUnit } from '../schemas/RepeatUnit';
+import type { Freq } from '../schemas/Freq';
 export interface ReleaseCadence {
+    /**
+     * duration for the release cadence.
+     */
+    duration: string;
     /**
      * End date of the release cadence (YYYY-MM-DD).
      * @format date
      */
-    endDate?: string;
+    endDate: string;
     frequency: ReleaseFrequency;
-    /**
-     * Number of units between releases.
-     */
-    repeatInterval: number;
-    repeatUnit: RepeatUnit;
+    spec?: {
+        freq: Freq;
+        /**
+         * Number of units between releases.
+         */
+        interval: number;
+        /**
+         * weekday
+         */
+        weekday?: string;
+    };
     /**
      * Start date of the release cadence (YYYY-MM-DD).
      * @format date

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

@@ -1,22 +1,49 @@
 export interface ReleaseComponent {
     /**
-     * List of environment identifiers.
+     * Details about environments with filterType and refs.
      */
-    environments?: string[];
+    environments?: {
+        /**
+         * Type of filter applied for environments.
+         */
+        filterType?: 'All' | 'Equals';
+        /**
+         * List of environment identifiers.
+         */
+        refs?: string[];
+    };
     /**
      * Identifier for the organization.
      */
     orgIdentifier: string;
     /**
-     * List of pipeline identifiers.
+     * Details about pipelines with filterType and refs.
      */
-    pipelines?: string[];
+    pipelines?: {
+        /**
+         * Type of filter applied for pipelines.
+         */
+        filterType?: 'All' | 'Equals';
+        /**
+         * List of pipeline identifiers.
+         */
+        refs?: string[];
+    };
     /**
      * Identifier for the project.
      */
     projectIdentifier: string;
     /**
-     * List of service identifiers.
+     * Details about services with filterType and refs.
      */
-    services?: string[];
+    services?: {
+        /**
+         * Type of filter applied for services.
+         */
+        filterType?: 'All' | 'Equals';
+        /**
+         * List of service identifiers.
+         */
+        refs?: string[];
+    };
 }

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

@@ -1,4 +1,4 @@
 /**
  * Frequency of the release cadence.
  */
-export type ReleaseFrequency = 'Custom' | 'Daily' | 'Monthly' | 'Weekly';
+export type ReleaseFrequency = 'BiWeekly' | 'Custom' | 'Daily' | 'Monthly' | 'Weekly';

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

@@ -0,0 +1,4 @@
+/**
+ * Type of the stage (e.g., CD, custom)
+ */
+export type StageInfoType = 'CD' | 'Custom';

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

@@ -0,0 +1,4 @@
+/**
+ * Status of the stage.
+ */
+export type Status = 'ABORTED' | 'ABORTEDBYFREEZE' | 'APPROVALREJECTED' | 'APPROVALWAITING' | 'DISCONTINUING' | 'ERRORED' | 'EXPIRED' | 'FAILED' | 'IGNOREFAILED' | 'INPUTWAITING' | 'INTERVENTIONWAITING' | 'NOTSTARTED' | 'PAUSED' | 'PAUSING' | 'QUEUED' | 'QUEUED_EXECUTION_CONCURRENCY_REACHED' | 'QUEUED_LICENSE_LIMIT_REACHED' | 'RESOURCEWAITING' | 'SKIPPED' | 'SUCCESS' | 'SUSPENDED' | 'TIMEDWAITING' | 'UPLOADWAITING' | 'WAITSTEPRUNNING';

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * Unit of time used for repeating releases.
+ */
+export type TriggerType = 'ARTIFACT' | 'MANIFEST' | 'MANUAL' | 'SCHEDULER_CRON' | 'WEBHOOK' | 'WEBHOOK_CUSTOM';

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

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

package/package.json

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