@harnessio/react-idp-service-client 0.103.0 → 0.103.1

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

@@ -0,0 +1,26 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { GraphTraversalResponseResponse } from '../responses/GraphTraversalResponseResponse';
+import type { ResponseWithPagination } from '../helpers';
+import { FetcherOptions } from '../../../../custom-idp-fetcher/index.js';
+export interface TraverseEntityGraphQueryQueryParams {
+    entityRef: string;
+    relationshipType?: string[];
+    kind?: string[];
+    /**
+     * @default 1
+     */
+    depth?: number;
+}
+export interface TraverseEntityGraphQueryHeaderParams {
+    'Harness-Account'?: string;
+}
+export type TraverseEntityGraphOkResponse = ResponseWithPagination<GraphTraversalResponseResponse>;
+export type TraverseEntityGraphErrorResponse = unknown;
+export interface TraverseEntityGraphProps extends Omit<FetcherOptions<TraverseEntityGraphQueryQueryParams, unknown, TraverseEntityGraphQueryHeaderParams>, 'url'> {
+    queryParams: TraverseEntityGraphQueryQueryParams;
+}
+export declare function traverseEntityGraph(props: TraverseEntityGraphProps): Promise<TraverseEntityGraphOkResponse>;
+/**
+ * Traverse the catalog entity graph starting from a given entity, following relationships up to a specified depth. Returns a graph structure with nodes and edges.
+ */
+export declare function useTraverseEntityGraphQuery(props: TraverseEntityGraphProps, options?: Omit<UseQueryOptions<TraverseEntityGraphOkResponse, TraverseEntityGraphErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<TraverseEntityGraphOkResponse, unknown>;

package/dist/idp-service/src/services/hooks/useTraverseEntityGraphQuery.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 '../../../../custom-idp-fetcher/index.js';
+export function traverseEntityGraph(props) {
+    return fetcher(Object.assign({ url: `/v1/graph/traverse`, method: 'GET' }, props));
+}
+/**
+ * Traverse the catalog entity graph starting from a given entity, following relationships up to a specified depth. Returns a graph structure with nodes and edges.
+ */
+export function useTraverseEntityGraphQuery(props, options) {
+    return useQuery(['traverse-entity-graph', props.queryParams], ({ signal }) => traverseEntityGraph(Object.assign(Object.assign({}, props), { signal })), options);
+}

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

@@ -245,6 +245,8 @@ export type { ScorecardRecalibrateErrorResponse, ScorecardRecalibrateOkResponse,
 export { scorecardRecalibrate, useScorecardRecalibrateMutation, } from './hooks/useScorecardRecalibrateMutation';
 export type { TogglePluginForAccountErrorResponse, TogglePluginForAccountMutationPathParams, TogglePluginForAccountMutationQueryParams, TogglePluginForAccountOkResponse, TogglePluginForAccountProps, } from './hooks/useTogglePluginForAccountMutation';
 export { togglePluginForAccount, useTogglePluginForAccountMutation, } from './hooks/useTogglePluginForAccountMutation';
+export type { TraverseEntityGraphErrorResponse, TraverseEntityGraphOkResponse, TraverseEntityGraphProps, TraverseEntityGraphQueryQueryParams, } from './hooks/useTraverseEntityGraphQuery';
+export { traverseEntityGraph, useTraverseEntityGraphQuery, } from './hooks/useTraverseEntityGraphQuery';
 export type { TriggerAggregationRuleComputationErrorResponse, TriggerAggregationRuleComputationMutationPathParams, TriggerAggregationRuleComputationOkResponse, TriggerAggregationRuleComputationProps, } from './hooks/useTriggerAggregationRuleComputationMutation';
 export { triggerAggregationRuleComputation, useTriggerAggregationRuleComputationMutation, } from './hooks/useTriggerAggregationRuleComputationMutation';
 export type { UnlinkIntegrationEntitiesErrorResponse, UnlinkIntegrationEntitiesMutationPathParams, UnlinkIntegrationEntitiesMutationQueryParams, UnlinkIntegrationEntitiesOkResponse, UnlinkIntegrationEntitiesProps, UnlinkIntegrationEntitiesRequestBody, } from './hooks/useUnlinkIntegrationEntitiesMutation';
@@ -361,6 +363,7 @@ export type { EntityVersionResponseBodyListResponse } from './responses/EntityVe
 export type { EntityVersionResponseBodyResponse } from './responses/EntityVersionResponseBodyResponse';
 export type { EnvironmentBlueprintInfoResponseResponse } from './responses/EnvironmentBlueprintInfoResponseResponse';
 export type { GenerateYamlResponseResponse } from './responses/GenerateYamlResponseResponse';
+export type { GraphTraversalResponseResponse } from './responses/GraphTraversalResponseResponse';
 export type { GroupResponseListResponse } from './responses/GroupResponseListResponse';
 export type { GroupResponseResponse } from './responses/GroupResponseResponse';
 export type { HarnessEntitiesCountResponseResponse } from './responses/HarnessEntitiesCountResponseResponse';
@@ -507,6 +510,10 @@ export type { GitIntegrationRequest } from './schemas/GitIntegrationRequest';
 export type { GitMetadataUpdateRequest } from './schemas/GitMetadataUpdateRequest';
 export type { GitMoveDetails } from './schemas/GitMoveDetails';
 export type { GitUpdateDetails } from './schemas/GitUpdateDetails';
+export type { GraphEdge } from './schemas/GraphEdge';
+export type { GraphMetadata } from './schemas/GraphMetadata';
+export type { GraphNode } from './schemas/GraphNode';
+export type { GraphTraversalResponse } from './schemas/GraphTraversalResponse';
 export type { Group } from './schemas/Group';
 export type { GroupRequest } from './schemas/GroupRequest';
 export type { GroupResponse } from './schemas/GroupResponse';

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

@@ -121,6 +121,7 @@ export { saveHomePageLayoutInfo, useSaveHomePageLayoutInfoMutation, } from './ho
 export { saveOrUpdatePluginAppConfig, useSaveOrUpdatePluginAppConfigMutation, } from './hooks/useSaveOrUpdatePluginAppConfigMutation';
 export { scorecardRecalibrate, useScorecardRecalibrateMutation, } from './hooks/useScorecardRecalibrateMutation';
 export { togglePluginForAccount, useTogglePluginForAccountMutation, } from './hooks/useTogglePluginForAccountMutation';
+export { traverseEntityGraph, useTraverseEntityGraphQuery, } from './hooks/useTraverseEntityGraphQuery';
 export { triggerAggregationRuleComputation, useTriggerAggregationRuleComputationMutation, } from './hooks/useTriggerAggregationRuleComputationMutation';
 export { unlinkIntegrationEntities, useUnlinkIntegrationEntitiesMutation, } from './hooks/useUnlinkIntegrationEntitiesMutation';
 export { updateAggregationRule, useUpdateAggregationRuleMutation, } from './hooks/useUpdateAggregationRuleMutation';

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

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

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

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

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

@@ -0,0 +1,30 @@
+/**
+ * Represents a directed edge in the catalog entity graph
+ */
+export interface GraphEdge {
+    /**
+     * BFS traversal depth at which this edge was discovered
+     * @example 1
+     */
+    depth: number;
+    /**
+     * Relationship type (dependsOn, providesApi, consumesApi, ownedBy, etc.)
+     * @example "dependsOn"
+     */
+    relation: string;
+    /**
+     * The reverse/inverse of the relation type (e.g., dependsOn → dependencyOf)
+     * @example "dependencyOf"
+     */
+    reverseRelation?: string;
+    /**
+     * Source entity reference (matches GraphNode.entityRef)
+     * @example "component:account/payment-service"
+     */
+    source: string;
+    /**
+     * Target entity reference (matches GraphNode.entityRef)
+     * @example "component:account/order-service"
+     */
+    target: string;
+}

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

@@ -0,0 +1,20 @@
+/**
+ * Metadata about the graph traversal results
+ */
+export interface GraphMetadata {
+    /**
+     * The starting entity reference for the traversal
+     * @example "component:account/payment-service"
+     */
+    baseEntityRef: string;
+    /**
+     * Maximum depth reached during traversal
+     * @example 2
+     */
+    maxDepthReached: number;
+    /**
+     * Total number of edges in the result
+     * @example 15
+     */
+    totalEdges: number;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * Represents a node in the catalog entity graph
+ */
+export interface GraphNode {
+    /**
+     * Unique entity reference in format kind:account[.org[.project]]/identifier
+     * @example "component:account/payment-service"
+     */
+    entityRef: string;
+    /**
+     * Entity kind (component, api, resource, group, etc.)
+     * @example "component"
+     */
+    kind: string;
+    /**
+     * Human-readable entity name
+     * @example "payment-service"
+     */
+    name: string;
+    /**
+     * Entity type (service, library, website, openapi, etc.)
+     * @example "service"
+     */
+    type?: string;
+}

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

@@ -0,0 +1,17 @@
+import type { GraphEdge } from '../schemas/GraphEdge';
+import type { GraphMetadata } from '../schemas/GraphMetadata';
+import type { GraphNode } from '../schemas/GraphNode';
+/**
+ * Response containing the graph traversal results with a normalized structure of nodes and edges
+ */
+export interface GraphTraversalResponse {
+    /**
+     * List of edges connecting the nodes
+     */
+    edges: GraphEdge[];
+    metadata: GraphMetadata;
+    /**
+     * List of unique nodes discovered during traversal
+     */
+    nodes: GraphNode[];
+}

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/react-idp-service-client",
-  "version": "0.103.0",
+  "version": "0.103.1",
   "description": "Harness React idp service client - IDP APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",