@harnessio/react-idp-service-client 0.59.0 → 0.60.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,6 +4,8 @@ import type { EntityRequestBodyRequestBody } from '../requestBodies/EntityReques
4
4
  import type { ResponseWithPagination } from '../helpers';
5
5
  import { FetcherOptions } from '../../../../fetcher/index.js';
6
6
  export interface CreateEntityMutationQueryParams {
7
+ orgIdentifier?: string;
8
+ projectIdentifier?: string;
7
9
  force_convert?: boolean;
8
10
  dry_run?: boolean;
9
11
  }
@@ -2,14 +2,21 @@ import { UseMutationOptions } from '@tanstack/react-query';
2
2
  import type { ResponseWithPagination } from '../helpers';
3
3
  import { FetcherOptions } from '../../../../fetcher/index.js';
4
4
  export interface DeleteEntityMutationPathParams {
5
- 'entity-ref': string;
5
+ kind: string;
6
+ scope: string;
7
+ identifier: string;
8
+ }
9
+ export interface DeleteEntityMutationQueryParams {
10
+ orgIdentifier?: string;
11
+ projectIdentifier?: string;
6
12
  }
7
13
  export interface DeleteEntityMutationHeaderParams {
8
14
  'Harness-Account'?: string;
9
15
  }
10
16
  export type DeleteEntityOkResponse = ResponseWithPagination<unknown>;
11
17
  export type DeleteEntityErrorResponse = unknown;
12
- export interface DeleteEntityProps extends DeleteEntityMutationPathParams, Omit<FetcherOptions<unknown, unknown, DeleteEntityMutationHeaderParams>, 'url'> {
18
+ export interface DeleteEntityProps extends DeleteEntityMutationPathParams, Omit<FetcherOptions<DeleteEntityMutationQueryParams, unknown, DeleteEntityMutationHeaderParams>, 'url'> {
19
+ queryParams: DeleteEntityMutationQueryParams;
13
20
  }
14
21
  export declare function deleteEntity(props: DeleteEntityProps): Promise<DeleteEntityOkResponse>;
15
22
  /**
@@ -4,7 +4,7 @@
4
4
  import { useMutation } from '@tanstack/react-query';
5
5
  import { fetcher } from '../../../../fetcher/index.js';
6
6
  export function deleteEntity(props) {
7
- return fetcher(Object.assign({ url: `/v1/entities/${props['entity-ref']}`, method: 'DELETE' }, props));
7
+ return fetcher(Object.assign({ url: `/v1/entities/${props.kind}/${props.scope}/${props.identifier}`, method: 'DELETE' }, props));
8
8
  }
9
9
  /**
10
10
  * Delete an Entity.
@@ -4,7 +4,7 @@
4
4
  import { useQuery } from '@tanstack/react-query';
5
5
  import { fetcher } from '../../../../fetcher/index.js';
6
6
  export function getEntitiesFilters(props) {
7
- return fetcher(Object.assign({ url: `/v1/entities/get/filters`, method: 'GET' }, props));
7
+ return fetcher(Object.assign({ url: `/v1/entities/filters`, method: 'GET' }, props));
8
8
  }
9
9
  /**
10
10
  * Get Entities Filters.
@@ -4,7 +4,7 @@
4
4
  import { useQuery } from '@tanstack/react-query';
5
5
  import { fetcher } from '../../../../fetcher/index.js';
6
6
  export function getEntitiesKinds(props) {
7
- return fetcher(Object.assign({ url: `/v1/entities/get/kinds`, method: 'GET' }, props));
7
+ return fetcher(Object.assign({ url: `/v1/entities/kinds`, method: 'GET' }, props));
8
8
  }
9
9
  /**
10
10
  * Get Entities Kinds.
@@ -3,6 +3,8 @@ import type { EntityResponseBodyListResponse } from '../responses/EntityResponse
3
3
  import type { ResponseWithPagination } from '../helpers';
4
4
  import { FetcherOptions } from '../../../../fetcher/index.js';
5
5
  export interface GetEntitiesQueryQueryParams {
6
+ orgIdentifier?: string;
7
+ projectIdentifier?: string;
6
8
  page?: number;
7
9
  /**
8
10
  * @default 10
@@ -3,14 +3,21 @@ import type { EntityResponseBodyResponse } from '../responses/EntityResponseBody
3
3
  import type { ResponseWithPagination } from '../helpers';
4
4
  import { FetcherOptions } from '../../../../fetcher/index.js';
5
5
  export interface GetEntityQueryPathParams {
6
- 'entity-ref': string;
6
+ kind: string;
7
+ scope: string;
8
+ identifier: string;
9
+ }
10
+ export interface GetEntityQueryQueryParams {
11
+ orgIdentifier?: string;
12
+ projectIdentifier?: string;
7
13
  }
8
14
  export interface GetEntityQueryHeaderParams {
9
15
  'Harness-Account'?: string;
10
16
  }
11
17
  export type GetEntityOkResponse = ResponseWithPagination<EntityResponseBodyResponse>;
12
18
  export type GetEntityErrorResponse = unknown;
13
- export interface GetEntityProps extends GetEntityQueryPathParams, Omit<FetcherOptions<unknown, unknown, GetEntityQueryHeaderParams>, 'url'> {
19
+ export interface GetEntityProps extends GetEntityQueryPathParams, Omit<FetcherOptions<GetEntityQueryQueryParams, unknown, GetEntityQueryHeaderParams>, 'url'> {
20
+ queryParams: GetEntityQueryQueryParams;
14
21
  }
15
22
  export declare function getEntity(props: GetEntityProps): Promise<GetEntityOkResponse>;
16
23
  /**
@@ -4,11 +4,11 @@
4
4
  import { useQuery } from '@tanstack/react-query';
5
5
  import { fetcher } from '../../../../fetcher/index.js';
6
6
  export function getEntity(props) {
7
- return fetcher(Object.assign({ url: `/v1/entities/${props['entity-ref']}`, method: 'GET' }, props));
7
+ return fetcher(Object.assign({ url: `/v1/entities/${props.kind}/${props.scope}/${props.identifier}`, method: 'GET' }, props));
8
8
  }
9
9
  /**
10
10
  * Get Entity.
11
11
  */
12
12
  export function useGetEntityQuery(props, options) {
13
- return useQuery(['get-entity', props['entity-ref']], ({ signal }) => getEntity(Object.assign(Object.assign({}, props), { signal })), options);
13
+ return useQuery(['get-entity', props.kind, props.scope, props.identifier, props.queryParams], ({ signal }) => getEntity(Object.assign(Object.assign({}, props), { signal })), options);
14
14
  }
@@ -4,7 +4,13 @@ import type { EntityRequestBodyRequestBody } from '../requestBodies/EntityReques
4
4
  import type { ResponseWithPagination } from '../helpers';
5
5
  import { FetcherOptions } from '../../../../fetcher/index.js';
6
6
  export interface UpdateEntityMutationPathParams {
7
- 'entity-ref': string;
7
+ kind: string;
8
+ scope: string;
9
+ identifier: string;
10
+ }
11
+ export interface UpdateEntityMutationQueryParams {
12
+ orgIdentifier?: string;
13
+ projectIdentifier?: string;
8
14
  }
9
15
  export interface UpdateEntityMutationHeaderParams {
10
16
  'Harness-Account'?: string;
@@ -12,7 +18,8 @@ export interface UpdateEntityMutationHeaderParams {
12
18
  export type UpdateEntityRequestBody = EntityRequestBodyRequestBody;
13
19
  export type UpdateEntityOkResponse = ResponseWithPagination<EntityResponseBodyResponse>;
14
20
  export type UpdateEntityErrorResponse = unknown;
15
- export interface UpdateEntityProps extends UpdateEntityMutationPathParams, Omit<FetcherOptions<unknown, UpdateEntityRequestBody, UpdateEntityMutationHeaderParams>, 'url'> {
21
+ export interface UpdateEntityProps extends UpdateEntityMutationPathParams, Omit<FetcherOptions<UpdateEntityMutationQueryParams, UpdateEntityRequestBody, UpdateEntityMutationHeaderParams>, 'url'> {
22
+ queryParams: UpdateEntityMutationQueryParams;
16
23
  body: UpdateEntityRequestBody;
17
24
  }
18
25
  export declare function updateEntity(props: UpdateEntityProps): Promise<UpdateEntityOkResponse>;
@@ -4,7 +4,7 @@
4
4
  import { useMutation } from '@tanstack/react-query';
5
5
  import { fetcher } from '../../../../fetcher/index.js';
6
6
  export function updateEntity(props) {
7
- return fetcher(Object.assign({ url: `/v1/entities/${props['entity-ref']}`, method: 'PUT' }, props));
7
+ return fetcher(Object.assign({ url: `/v1/entities/${props.kind}/${props.scope}/${props.identifier}`, method: 'PUT' }, props));
8
8
  }
9
9
  /**
10
10
  * Update an Entity.
@@ -29,7 +29,7 @@ export type { DeleteCustomLinkCardQuickLinksErrorResponse, DeleteCustomLinkCardQ
29
29
  export { deleteCustomLinkCardQuickLinks, useDeleteCustomLinkCardQuickLinksMutation, } from './hooks/useDeleteCustomLinkCardQuickLinksMutation';
30
30
  export type { DeleteCustomPluginInfoErrorResponse, DeleteCustomPluginInfoMutationPathParams, DeleteCustomPluginInfoMutationQueryParams, DeleteCustomPluginInfoOkResponse, DeleteCustomPluginInfoProps, } from './hooks/useDeleteCustomPluginInfoMutation';
31
31
  export { deleteCustomPluginInfo, useDeleteCustomPluginInfoMutation, } from './hooks/useDeleteCustomPluginInfoMutation';
32
- export type { DeleteEntityErrorResponse, DeleteEntityMutationPathParams, DeleteEntityOkResponse, DeleteEntityProps, } from './hooks/useDeleteEntityMutation';
32
+ export type { DeleteEntityErrorResponse, DeleteEntityMutationPathParams, DeleteEntityMutationQueryParams, DeleteEntityOkResponse, DeleteEntityProps, } from './hooks/useDeleteEntityMutation';
33
33
  export { deleteEntity, useDeleteEntityMutation } from './hooks/useDeleteEntityMutation';
34
34
  export type { DeleteGroupErrorResponse, DeleteGroupMutationPathParams, DeleteGroupOkResponse, DeleteGroupProps, } from './hooks/useDeleteGroupMutation';
35
35
  export { deleteGroup, useDeleteGroupMutation } from './hooks/useDeleteGroupMutation';
@@ -75,8 +75,6 @@ export type { GetDataPointsForDataSourceErrorResponse, GetDataPointsForDataSourc
75
75
  export { getDataPointsForDataSource, useGetDataPointsForDataSourceQuery, } from './hooks/useGetDataPointsForDataSourceQuery';
76
76
  export type { GetDataSourcesDataPointsMapErrorResponse, GetDataSourcesDataPointsMapOkResponse, GetDataSourcesDataPointsMapProps, } from './hooks/useGetDataSourcesDataPointsMapQuery';
77
77
  export { getDataSourcesDataPointsMap, useGetDataSourcesDataPointsMapQuery, } from './hooks/useGetDataSourcesDataPointsMapQuery';
78
- export type { GetEntitiesFiltersByIdErrorResponse, GetEntitiesFiltersByIdOkResponse, GetEntitiesFiltersByIdProps, GetEntitiesFiltersByIdQueryPathParams, GetEntitiesFiltersByIdQueryQueryParams, } from './hooks/useGetEntitiesFiltersByIdQuery';
79
- export { getEntitiesFiltersById, useGetEntitiesFiltersByIdQuery, } from './hooks/useGetEntitiesFiltersByIdQuery';
80
78
  export type { GetEntitiesFiltersErrorResponse, GetEntitiesFiltersOkResponse, GetEntitiesFiltersProps, GetEntitiesFiltersQueryQueryParams, } from './hooks/useGetEntitiesFiltersQuery';
81
79
  export { getEntitiesFilters, useGetEntitiesFiltersQuery } from './hooks/useGetEntitiesFiltersQuery';
82
80
  export type { GetEntitiesKindsErrorResponse, GetEntitiesKindsOkResponse, GetEntitiesKindsProps, GetEntitiesKindsQueryQueryParams, } from './hooks/useGetEntitiesKindsQuery';
@@ -85,7 +83,7 @@ export type { GetEntitiesErrorResponse, GetEntitiesOkResponse, GetEntitiesProps,
85
83
  export { getEntities, useGetEntitiesQuery } from './hooks/useGetEntitiesQuery';
86
84
  export type { GetEntityFacetsErrorResponse, GetEntityFacetsOkResponse, GetEntityFacetsProps, GetEntityFacetsQueryQueryParams, } from './hooks/useGetEntityFacetsQuery';
87
85
  export { getEntityFacets, useGetEntityFacetsQuery } from './hooks/useGetEntityFacetsQuery';
88
- export type { GetEntityErrorResponse, GetEntityOkResponse, GetEntityProps, GetEntityQueryPathParams, } from './hooks/useGetEntityQuery';
86
+ export type { GetEntityErrorResponse, GetEntityOkResponse, GetEntityProps, GetEntityQueryPathParams, GetEntityQueryQueryParams, } from './hooks/useGetEntityQuery';
89
87
  export { getEntity, useGetEntityQuery } from './hooks/useGetEntityQuery';
90
88
  export type { GetEntityRefsErrorResponse, GetEntityRefsOkResponse, GetEntityRefsProps, GetEntityRefsQueryQueryParams, } from './hooks/useGetEntityRefsQuery';
91
89
  export { getEntityRefs, useGetEntityRefsQuery } from './hooks/useGetEntityRefsQuery';
@@ -165,7 +163,7 @@ export type { UpdateConfigurationEntitiesErrorResponse, UpdateConfigurationEntit
165
163
  export { updateConfigurationEntities, useUpdateConfigurationEntitiesMutation, } from './hooks/useUpdateConfigurationEntitiesMutation';
166
164
  export type { UpdateCustomPluginsInfoErrorResponse, UpdateCustomPluginsInfoMutationPathParams, UpdateCustomPluginsInfoOkResponse, UpdateCustomPluginsInfoProps, UpdateCustomPluginsInfoRequestBody, } from './hooks/useUpdateCustomPluginsInfoMutation';
167
165
  export { updateCustomPluginsInfo, useUpdateCustomPluginsInfoMutation, } from './hooks/useUpdateCustomPluginsInfoMutation';
168
- export type { UpdateEntityErrorResponse, UpdateEntityMutationPathParams, UpdateEntityOkResponse, UpdateEntityProps, UpdateEntityRequestBody, } from './hooks/useUpdateEntityMutation';
166
+ export type { UpdateEntityErrorResponse, UpdateEntityMutationPathParams, UpdateEntityMutationQueryParams, UpdateEntityOkResponse, UpdateEntityProps, UpdateEntityRequestBody, } from './hooks/useUpdateEntityMutation';
169
167
  export { updateEntity, useUpdateEntityMutation } from './hooks/useUpdateEntityMutation';
170
168
  export type { UpdateGroupsErrorResponse, UpdateGroupsOkResponse, UpdateGroupsProps, UpdateGroupsRequestBody, } from './hooks/useUpdateGroupsMutation';
171
169
  export { updateGroups, useUpdateGroupsMutation } from './hooks/useUpdateGroupsMutation';
@@ -216,7 +214,6 @@ export type { DatapointResponseResponse } from './responses/DatapointResponseRes
216
214
  export type { DefaultSaveResponseResponse } from './responses/DefaultSaveResponseResponse';
217
215
  export type { EntityConvertResponseBodyResponse } from './responses/EntityConvertResponseBodyResponse';
218
216
  export type { EntityFiltersResponseBodyListResponse } from './responses/EntityFiltersResponseBodyListResponse';
219
- export type { EntityFiltersResponseBodyPagedResponse } from './responses/EntityFiltersResponseBodyPagedResponse';
220
217
  export type { EntityKindsResponseBodyResponse } from './responses/EntityKindsResponseBodyResponse';
221
218
  export type { EntityRefsResponseResponse } from './responses/EntityRefsResponseResponse';
222
219
  export type { EntityResponseBodyListResponse } from './responses/EntityResponseBodyListResponse';
@@ -36,7 +36,6 @@ export { getCustomPluginStatusLogs, useGetCustomPluginStatusLogsQuery, } from '.
36
36
  export { getCustomPluginStatusPluginId, useGetCustomPluginStatusPluginIdQuery, } from './hooks/useGetCustomPluginStatusPluginIdQuery';
37
37
  export { getDataPointsForDataSource, useGetDataPointsForDataSourceQuery, } from './hooks/useGetDataPointsForDataSourceQuery';
38
38
  export { getDataSourcesDataPointsMap, useGetDataSourcesDataPointsMapQuery, } from './hooks/useGetDataSourcesDataPointsMapQuery';
39
- export { getEntitiesFiltersById, useGetEntitiesFiltersByIdQuery, } from './hooks/useGetEntitiesFiltersByIdQuery';
40
39
  export { getEntitiesFilters, useGetEntitiesFiltersQuery } from './hooks/useGetEntitiesFiltersQuery';
41
40
  export { getEntitiesKinds, useGetEntitiesKindsQuery } from './hooks/useGetEntitiesKindsQuery';
42
41
  export { getEntities, useGetEntitiesQuery } from './hooks/useGetEntitiesQuery';
@@ -3,5 +3,7 @@
3
3
  */
4
4
  export interface EntityFiltersResponse {
5
5
  filter?: string;
6
- values?: string[];
6
+ values?: {
7
+ [key: string]: any;
8
+ };
7
9
  }
@@ -4,6 +4,17 @@
4
4
  export interface EntityResponse {
5
5
  description?: string;
6
6
  entity_ref: string;
7
+ groups?: Array<{
8
+ group_description?: string;
9
+ group_icon?: string;
10
+ group_identifier?: string;
11
+ group_name?: string;
12
+ org_identifier?: string;
13
+ org_name?: string;
14
+ project_identifier?: string;
15
+ project_name?: string;
16
+ scope?: 'ACCOUNT' | 'ORGANIZATION' | 'PROJECT';
17
+ }>;
7
18
  identifier: string;
8
19
  kind: 'api' | 'component' | 'group' | 'resource' | 'user' | 'workflow';
9
20
  lifecycle?: string;
@@ -12,8 +23,10 @@ export interface EntityResponse {
12
23
  };
13
24
  name?: string;
14
25
  orgIdentifier?: string;
26
+ org_name?: string;
15
27
  owner?: string;
16
28
  projectIdentifier?: string;
29
+ project_name?: string;
17
30
  referenceType: 'GIT' | 'INLINE';
18
31
  scope: 'ACCOUNT' | 'ORGANIZATION' | 'PROJECT';
19
32
  scorecards?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harnessio/react-idp-service-client",
3
- "version": "0.59.0",
3
+ "version": "0.60.0",
4
4
  "description": "Harness React idp service client - IDP APIs integrated with react hooks",
5
5
  "author": "Harness Inc",
6
6
  "license": "MIT",
@@ -1,33 +0,0 @@
1
- import { UseQueryOptions } from '@tanstack/react-query';
2
- import type { EntityFiltersResponseBodyPagedResponse } from '../responses/EntityFiltersResponseBodyPagedResponse';
3
- import type { ResponseWithPagination } from '../helpers';
4
- import { FetcherOptions } from '../../../../fetcher/index.js';
5
- export interface GetEntitiesFiltersByIdQueryPathParams {
6
- identifier: string;
7
- }
8
- export interface GetEntitiesFiltersByIdQueryQueryParams {
9
- accountIdentifier: string;
10
- orgIdentifier?: string;
11
- projectIdentifier?: string;
12
- kind?: string;
13
- page?: number;
14
- /**
15
- * @default 10
16
- */
17
- limit?: number;
18
- sort?: string;
19
- search_term?: string;
20
- }
21
- export interface GetEntitiesFiltersByIdQueryHeaderParams {
22
- 'Harness-Account'?: string;
23
- }
24
- export type GetEntitiesFiltersByIdOkResponse = ResponseWithPagination<EntityFiltersResponseBodyPagedResponse>;
25
- export type GetEntitiesFiltersByIdErrorResponse = unknown;
26
- export interface GetEntitiesFiltersByIdProps extends GetEntitiesFiltersByIdQueryPathParams, Omit<FetcherOptions<GetEntitiesFiltersByIdQueryQueryParams, unknown, GetEntitiesFiltersByIdQueryHeaderParams>, 'url'> {
27
- queryParams: GetEntitiesFiltersByIdQueryQueryParams;
28
- }
29
- export declare function getEntitiesFiltersById(props: GetEntitiesFiltersByIdProps): Promise<GetEntitiesFiltersByIdOkResponse>;
30
- /**
31
- * Get Entities Filters By ID.
32
- */
33
- export declare function useGetEntitiesFiltersByIdQuery(props: GetEntitiesFiltersByIdProps, options?: Omit<UseQueryOptions<GetEntitiesFiltersByIdOkResponse, GetEntitiesFiltersByIdErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetEntitiesFiltersByIdOkResponse, unknown>;
@@ -1,14 +0,0 @@
1
- /* eslint-disable */
2
- // This code is autogenerated using @harnessio/oats-cli.
3
- // Please do not modify this code directly.
4
- import { useQuery } from '@tanstack/react-query';
5
- import { fetcher } from '../../../../fetcher/index.js';
6
- export function getEntitiesFiltersById(props) {
7
- return fetcher(Object.assign({ url: `/v1/entities/get/filters/${props.identifier}`, method: 'GET' }, props));
8
- }
9
- /**
10
- * Get Entities Filters By ID.
11
- */
12
- export function useGetEntitiesFiltersByIdQuery(props, options) {
13
- return useQuery(['get-entities-filters-by-id', props.identifier, props.queryParams], ({ signal }) => getEntitiesFiltersById(Object.assign(Object.assign({}, props), { signal })), options);
14
- }
@@ -1,2 +0,0 @@
1
- import type { EntityFiltersResponse } from '../schemas/EntityFiltersResponse';
2
- export type EntityFiltersResponseBodyPagedResponse = EntityFiltersResponse;