@harnessio/react-idp-service-client 0.106.0 → 0.107.1

package/dist/idp-service/src/services/hooks/useGetComparisonByHierarchyCardDataMutation.d.ts

@@ -0,0 +1,23 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { ComparisonByHierarchyCardDataResponseResponse } from '../responses/ComparisonByHierarchyCardDataResponseResponse';
+import type { ComparisonByHierarchyCardDataRequestRequestBody } from '../requestBodies/ComparisonByHierarchyCardDataRequestRequestBody';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../custom-idp-fetcher/index.js';
+export interface GetComparisonByHierarchyCardDataMutationPathParams {
+    'persona-view-id': string;
+}
+export interface GetComparisonByHierarchyCardDataMutationHeaderParams {
+    'Harness-Account'?: string;
+}
+export type GetComparisonByHierarchyCardDataRequestBody = ComparisonByHierarchyCardDataRequestRequestBody;
+export type GetComparisonByHierarchyCardDataOkResponse = ResponseWithPagination<ComparisonByHierarchyCardDataResponseResponse>;
+export type GetComparisonByHierarchyCardDataErrorResponse = unknown;
+export interface GetComparisonByHierarchyCardDataProps extends GetComparisonByHierarchyCardDataMutationPathParams, Omit<FetcherOptions<unknown, GetComparisonByHierarchyCardDataRequestBody, GetComparisonByHierarchyCardDataMutationHeaderParams>, 'url'> {
+    body: GetComparisonByHierarchyCardDataRequestBody;
+}
+export declare function getComparisonByHierarchyCardData(props: GetComparisonByHierarchyCardDataProps): Promise<GetComparisonByHierarchyCardDataOkResponse>;
+/**
+ * Returns one row per hierarchy node at the requested `scope`. With `scope=ORG` the rows are every Org in the account; with `scope=PROJECT` the rows are every Project in the account. Each row carries values for the requested aggregation rules and Gold/Silver/Bronze scorecard compliance counts.
+ *
+ */
+export declare function useGetComparisonByHierarchyCardDataMutation(options?: Omit<UseMutationOptions<GetComparisonByHierarchyCardDataOkResponse, GetComparisonByHierarchyCardDataErrorResponse, GetComparisonByHierarchyCardDataProps>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<GetComparisonByHierarchyCardDataOkResponse, unknown, GetComparisonByHierarchyCardDataProps, unknown>;

package/dist/idp-service/src/services/hooks/useGetComparisonByHierarchyCardDataMutation.js

@@ -0,0 +1,15 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+import { useMutation } from '@tanstack/react-query';
+import { fetcher } from '../../../../custom-idp-fetcher/index.js';
+export function getComparisonByHierarchyCardData(props) {
+    return fetcher(Object.assign({ url: `/v1/persona-views/${props['persona-view-id']}/cards/comparison-by-hierarchy`, method: 'POST' }, props));
+}
+/**
+ * Returns one row per hierarchy node at the requested `scope`. With `scope=ORG` the rows are every Org in the account; with `scope=PROJECT` the rows are every Project in the account. Each row carries values for the requested aggregation rules and Gold/Silver/Bronze scorecard compliance counts.
+ *
+ */
+export function useGetComparisonByHierarchyCardDataMutation(options) {
+    return useMutation((mutateProps) => getComparisonByHierarchyCardData(mutateProps), options);
+}

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

@@ -103,6 +103,8 @@ export type { GetCheckTagsErrorResponse, GetCheckTagsOkResponse, GetCheckTagsPro
 export { getCheckTags, useGetCheckTagsQuery } from './hooks/useGetCheckTagsQuery';
 export type { GetChecksErrorResponse, GetChecksOkResponse, GetChecksProps, GetChecksQueryQueryParams, } from './hooks/useGetChecksQuery';
 export { getChecks, useGetChecksQuery } from './hooks/useGetChecksQuery';
+export type { GetComparisonByHierarchyCardDataErrorResponse, GetComparisonByHierarchyCardDataMutationPathParams, GetComparisonByHierarchyCardDataOkResponse, GetComparisonByHierarchyCardDataProps, GetComparisonByHierarchyCardDataRequestBody, } from './hooks/useGetComparisonByHierarchyCardDataMutation';
+export { getComparisonByHierarchyCardData, useGetComparisonByHierarchyCardDataMutation, } from './hooks/useGetComparisonByHierarchyCardDataMutation';
 export type { GetConnectorInfoErrorResponse, GetConnectorInfoOkResponse, GetConnectorInfoProps, } from './hooks/useGetConnectorInfoQuery';
 export { getConnectorInfo, useGetConnectorInfoQuery } from './hooks/useGetConnectorInfoQuery';
 export type { GetCustomPluginStatusLogsErrorResponse, GetCustomPluginStatusLogsOkResponse, GetCustomPluginStatusLogsProps, GetCustomPluginStatusLogsQueryQueryParams, } from './hooks/useGetCustomPluginStatusLogsQuery';
@@ -292,6 +294,7 @@ export { useValidateComplexCheckMutation, validateComplexCheck, } from './hooks/
 export type { AppConfigRequestRequestBody } from './requestBodies/AppConfigRequestRequestBody';
 export type { BackstageEnvVariableBatchRequestRequestBody } from './requestBodies/BackstageEnvVariableBatchRequestRequestBody';
 export type { BackstagePermissionsRequestRequestBody } from './requestBodies/BackstagePermissionsRequestRequestBody';
+export type { ComparisonByHierarchyCardDataRequestRequestBody } from './requestBodies/ComparisonByHierarchyCardDataRequestRequestBody';
 export type { ConfigurationEntitiesRequestRequestBody } from './requestBodies/ConfigurationEntitiesRequestRequestBody';
 export type { ConnectorInfoRequestRequestBody } from './requestBodies/ConnectorInfoRequestRequestBody';
 export type { CustomPluginCreateRequestRequestBody } from './requestBodies/CustomPluginCreateRequestRequestBody';
@@ -346,6 +349,7 @@ export type { CheckGraphResponseResponse } from './responses/CheckGraphResponseR
 export type { CheckResponseListResponse } from './responses/CheckResponseListResponse';
 export type { CheckStatsResponseResponse } from './responses/CheckStatsResponseResponse';
 export type { ChecksTagsResponseResponse } from './responses/ChecksTagsResponseResponse';
+export type { ComparisonByHierarchyCardDataResponseResponse } from './responses/ComparisonByHierarchyCardDataResponseResponse';
 export type { ConfigurationEntitiesResponseResponse } from './responses/ConfigurationEntitiesResponseResponse';
 export type { ConnectorInfoResponseResponse } from './responses/ConnectorInfoResponseResponse';
 export type { CustomPluginInfoResponseResponse } from './responses/CustomPluginInfoResponseResponse';
@@ -458,6 +462,12 @@ export type { CheckStats } from './schemas/CheckStats';
 export type { CheckStatsResponse } from './schemas/CheckStatsResponse';
 export type { CheckStatus } from './schemas/CheckStatus';
 export type { ChecksTags } from './schemas/ChecksTags';
+export type { ComparisonByHierarchyCardDataRequest } from './schemas/ComparisonByHierarchyCardDataRequest';
+export type { ComparisonByHierarchyCardDataResponse } from './schemas/ComparisonByHierarchyCardDataResponse';
+export type { ComparisonByHierarchyColumn } from './schemas/ComparisonByHierarchyColumn';
+export type { ComparisonByHierarchyNode } from './schemas/ComparisonByHierarchyNode';
+export type { ComparisonByHierarchyRow } from './schemas/ComparisonByHierarchyRow';
+export type { ComparisonByHierarchyScope } from './schemas/ComparisonByHierarchyScope';
 export type { ConfigurationEntities } from './schemas/ConfigurationEntities';
 export type { ConnectorDetails } from './schemas/ConnectorDetails';
 export type { ConnectorInfoRequest } from './schemas/ConnectorInfoRequest';
@@ -586,6 +596,7 @@ export type { SavePersonaViewRequest } from './schemas/SavePersonaViewRequest';
 export type { Scorecard } from './schemas/Scorecard';
 export type { ScorecardChecks } from './schemas/ScorecardChecks';
 export type { ScorecardChecksDetails } from './schemas/ScorecardChecksDetails';
+export type { ScorecardComplianceCounts } from './schemas/ScorecardComplianceCounts';
 export type { ScorecardDetails } from './schemas/ScorecardDetails';
 export type { ScorecardDetailsRequest } from './schemas/ScorecardDetailsRequest';
 export type { ScorecardDetailsResponse } from './schemas/ScorecardDetailsResponse';

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

@@ -50,6 +50,7 @@ export { getCheck, useGetCheckQuery } from './hooks/useGetCheckQuery';
 export { getCheckStats, useGetCheckStatsQuery } from './hooks/useGetCheckStatsQuery';
 export { getCheckTags, useGetCheckTagsQuery } from './hooks/useGetCheckTagsQuery';
 export { getChecks, useGetChecksQuery } from './hooks/useGetChecksQuery';
+export { getComparisonByHierarchyCardData, useGetComparisonByHierarchyCardDataMutation, } from './hooks/useGetComparisonByHierarchyCardDataMutation';
 export { getConnectorInfo, useGetConnectorInfoQuery } from './hooks/useGetConnectorInfoQuery';
 export { getCustomPluginStatusLogs, useGetCustomPluginStatusLogsQuery, } from './hooks/useGetCustomPluginStatusLogsQuery';
 export { getCustomPluginStatusPluginId, useGetCustomPluginStatusPluginIdQuery, } from './hooks/useGetCustomPluginStatusPluginIdQuery';

package/dist/idp-service/src/services/requestBodies/ComparisonByHierarchyCardDataRequestRequestBody.d.ts

@@ -0,0 +1,2 @@
+import type { ComparisonByHierarchyCardDataRequest } from '../schemas/ComparisonByHierarchyCardDataRequest';
+export type ComparisonByHierarchyCardDataRequestRequestBody = ComparisonByHierarchyCardDataRequest;

package/dist/idp-service/src/services/requestBodies/ComparisonByHierarchyCardDataRequestRequestBody.js

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

package/dist/idp-service/src/services/responses/ComparisonByHierarchyCardDataResponseResponse.d.ts

@@ -0,0 +1,2 @@
+import type { ComparisonByHierarchyCardDataResponse } from '../schemas/ComparisonByHierarchyCardDataResponse';
+export type ComparisonByHierarchyCardDataResponseResponse = ComparisonByHierarchyCardDataResponse;

package/dist/idp-service/src/services/responses/ComparisonByHierarchyCardDataResponseResponse.js

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

package/dist/idp-service/src/services/schemas/ComparisonByHierarchyCardDataRequest.d.ts

@@ -0,0 +1,13 @@
+import type { ComparisonByHierarchyScope } from '../schemas/ComparisonByHierarchyScope';
+/**
+ * Inputs for the Comparison by Hierarchy card. `scope` picks the level of hierarchy node to list as rows.
+ *
+ */
+export interface ComparisonByHierarchyCardDataRequest {
+    /**
+     * Ordered list of aggregation rule identifiers, one per numeric column to display. If omitted or empty, defaults to the first 5 aggregation rules of the account by createdAt ASC. Order in the response `columns` matches the request order.
+     *
+     */
+    aggregation_rule_ids?: string[];
+    scope: ComparisonByHierarchyScope;
+}

package/dist/idp-service/src/services/schemas/ComparisonByHierarchyCardDataRequest.js

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

package/dist/idp-service/src/services/schemas/ComparisonByHierarchyCardDataResponse.d.ts

@@ -0,0 +1,12 @@
+import type { ComparisonByHierarchyColumn } from '../schemas/ComparisonByHierarchyColumn';
+import type { ComparisonByHierarchyRow } from '../schemas/ComparisonByHierarchyRow';
+export interface ComparisonByHierarchyCardDataResponse {
+    /**
+     * Aggregation-rule columns, in the same order as requested.
+     */
+    columns: ComparisonByHierarchyColumn[];
+    /**
+     * One row per hierarchy node at the requested scope.
+     */
+    rows: ComparisonByHierarchyRow[];
+}

package/dist/idp-service/src/services/schemas/ComparisonByHierarchyCardDataResponse.js

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

package/dist/idp-service/src/services/schemas/ComparisonByHierarchyColumn.d.ts

@@ -0,0 +1,10 @@
+export interface ComparisonByHierarchyColumn {
+    /**
+     * Aggregation rule identifier (used as the key inside `row.values`).
+     */
+    id: string;
+    /**
+     * Display label for the column (derived from the rule's name).
+     */
+    name: string;
+}

package/dist/idp-service/src/services/schemas/ComparisonByHierarchyColumn.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/idp-service/src/services/schemas/ComparisonByHierarchyNode.d.ts

@@ -0,0 +1,14 @@
+export interface ComparisonByHierarchyNode {
+    /**
+     * Hierarchy node identifier (org or project identifier).
+     */
+    identifier: string;
+    /**
+     * Display name of the node.
+     */
+    name: string;
+    /**
+     * Node type, used by the client to route the name link.
+     */
+    type: 'ORG' | 'PROJECT';
+}

package/dist/idp-service/src/services/schemas/ComparisonByHierarchyNode.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/idp-service/src/services/schemas/ComparisonByHierarchyRow.d.ts

@@ -0,0 +1,13 @@
+import type { ComparisonByHierarchyNode } from '../schemas/ComparisonByHierarchyNode';
+import type { ScorecardComplianceCounts } from '../schemas/ScorecardComplianceCounts';
+export interface ComparisonByHierarchyRow {
+    node: ComparisonByHierarchyNode;
+    scorecard_compliance: ScorecardComplianceCounts;
+    /**
+     * Aggregated values keyed by aggregation rule identifier. A key may be absent (or null) when the rule has no computed value for the node.
+     *
+     */
+    values: {
+        [key: string]: number | null;
+    };
+}

package/dist/idp-service/src/services/schemas/ComparisonByHierarchyRow.js

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

package/dist/idp-service/src/services/schemas/ComparisonByHierarchyScope.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Level of hierarchy node returned as rows.
+ */
+export type ComparisonByHierarchyScope = 'ORG' | 'PROJECT';

package/dist/idp-service/src/services/schemas/ComparisonByHierarchyScope.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/idp-service/src/services/schemas/ScorecardComplianceCounts.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Counts of entities under the node grouped by scorecard tier. Returns zero for all tiers when tier evaluation is not yet available.
+ *
+ */
+export interface ScorecardComplianceCounts {
+    /**
+     * @format int32
+     */
+    bronze: number;
+    /**
+     * @format int32
+     */
+    gold: number;
+    /**
+     * @format int32
+     */
+    silver: number;
+}

package/dist/idp-service/src/services/schemas/ScorecardComplianceCounts.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-idp-service-client",
-  "version": "0.106.0",
+  "version": "0.107.1",
   "description": "Harness React idp service client - IDP APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",