@harnessio/react-idp-service-client 0.5.0 → 0.7.0

package/dist/services/hooks/useCreateLayoutMutation.d.ts

@@ -1,16 +1,19 @@
 import { UseMutationOptions } from '@tanstack/react-query';
-import type { GeneralResponseResponse } from '../responses/GeneralResponseResponse';
+import type { LayoutResponseResponse } from '../responses/LayoutResponseResponse';
+import type { LayoutRequest } from '../schemas/LayoutRequest';
 import { FetcherOptions } from './../../fetcher';
 export interface CreateLayoutMutationHeaderParams {
     'Harness-Account'?: string;
 }
-export type CreateLayoutOkResponse = GeneralResponseResponse;
+export type CreateLayoutRequestBody = LayoutRequest;
+export type CreateLayoutOkResponse = LayoutResponseResponse;
 export type CreateLayoutErrorResponse = unknown;
-export interface CreateLayoutProps extends Omit<FetcherOptions<unknown, unknown, CreateLayoutMutationHeaderParams>, 'url'> {
+export interface CreateLayoutProps extends Omit<FetcherOptions<unknown, CreateLayoutRequestBody, CreateLayoutMutationHeaderParams>, 'url'> {
+    body: CreateLayoutRequestBody;
 }
 export declare function createLayout(props: CreateLayoutProps): Promise<CreateLayoutOkResponse>;
 export type CreateLayoutMutationProps<T extends keyof CreateLayoutProps> = Omit<CreateLayoutProps, T> & Partial<Pick<CreateLayoutProps, T>>;
 /**
  * Create layout
  */
-export declare function useCreateLayoutMutation<T extends keyof CreateLayoutProps>(props: Pick<Partial<CreateLayoutProps>, T>, options?: Omit<UseMutationOptions<CreateLayoutOkResponse, CreateLayoutErrorResponse, CreateLayoutMutationProps<T>>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<import("..").GeneralResponse, unknown, CreateLayoutMutationProps<T>, unknown>;
+export declare function useCreateLayoutMutation<T extends keyof CreateLayoutProps>(props: Pick<Partial<CreateLayoutProps>, T>, options?: Omit<UseMutationOptions<CreateLayoutOkResponse, CreateLayoutErrorResponse, CreateLayoutMutationProps<T>>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<import("..").LayoutResponse, unknown, CreateLayoutMutationProps<T>, unknown>;

package/dist/services/hooks/useGetAllLayoutsQuery.d.ts

@@ -1,10 +1,10 @@
 import { UseQueryOptions } from '@tanstack/react-query';
-import type { GeneralResponseResponse } from '../responses/GeneralResponseResponse';
+import type { LayoutResponseResponse } from '../responses/LayoutResponseResponse';
 import { FetcherOptions } from './../../fetcher';
 export interface GetAllLayoutsQueryHeaderParams {
     'Harness-Account'?: string;
 }
-export type GetAllLayoutsOkResponse = GeneralResponseResponse;
+export type GetAllLayoutsOkResponse = LayoutResponseResponse;
 export type GetAllLayoutsErrorResponse = unknown;
 export interface GetAllLayoutsProps extends Omit<FetcherOptions<unknown, unknown, GetAllLayoutsQueryHeaderParams>, 'url'> {
 }
@@ -12,4 +12,4 @@ export declare function getAllLayouts(props: GetAllLayoutsProps): Promise<GetAll
 /**
  * Get all layouts
  */
-export declare function useGetAllLayoutsQuery(props: GetAllLayoutsProps, options?: Omit<UseQueryOptions<GetAllLayoutsOkResponse, GetAllLayoutsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<import("..").GeneralResponse, unknown>;
+export declare function useGetAllLayoutsQuery(props: GetAllLayoutsProps, options?: Omit<UseQueryOptions<GetAllLayoutsOkResponse, GetAllLayoutsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<import("..").LayoutResponse, unknown>;

package/dist/services/hooks/useGetHarnessEntitiesQuery.d.ts

@@ -0,0 +1,23 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { HarnessEntitiesResponseResponse } from '../responses/HarnessEntitiesResponseResponse';
+import { FetcherOptions } from './../../fetcher';
+export interface GetHarnessEntitiesQueryQueryParams {
+    page?: number;
+    limit?: number;
+    sort?: string;
+    order?: string;
+    search_term?: string;
+}
+export interface GetHarnessEntitiesQueryHeaderParams {
+    'Harness-Account'?: string;
+}
+export type GetHarnessEntitiesOkResponse = HarnessEntitiesResponseResponse;
+export type GetHarnessEntitiesErrorResponse = unknown;
+export interface GetHarnessEntitiesProps extends Omit<FetcherOptions<GetHarnessEntitiesQueryQueryParams, unknown, GetHarnessEntitiesQueryHeaderParams>, 'url'> {
+    queryParams: GetHarnessEntitiesQueryQueryParams;
+}
+export declare function getHarnessEntities(props: GetHarnessEntitiesProps): Promise<GetHarnessEntitiesOkResponse>;
+/**
+ * Get Harness Entities
+ */
+export declare function useGetHarnessEntitiesQuery(props: GetHarnessEntitiesProps, options?: Omit<UseQueryOptions<GetHarnessEntitiesOkResponse, GetHarnessEntitiesErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<import("..").HarnessEntitiesResponse, unknown>;

package/dist/services/hooks/useGetHarnessEntitiesQuery.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';
+export function getHarnessEntities(props) {
+    return fetcher(Object.assign({ url: `/v1/onboarding/harness-entities`, method: 'GET' }, props));
+}
+/**
+ * Get Harness Entities
+ */
+export function useGetHarnessEntitiesQuery(props, options) {
+    return useQuery(['get-harness-entities', props.queryParams], ({ signal }) => getHarnessEntities(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/services/hooks/useGetLayoutQuery.d.ts

@@ -1,5 +1,5 @@
 import { UseQueryOptions } from '@tanstack/react-query';
-import type { GeneralResponseResponse } from '../responses/GeneralResponseResponse';
+import type { LayoutResponseResponse } from '../responses/LayoutResponseResponse';
 import { FetcherOptions } from './../../fetcher';
 export interface GetLayoutQueryPathParams {
     'layout-identifier': string;
@@ -7,7 +7,7 @@ export interface GetLayoutQueryPathParams {
 export interface GetLayoutQueryHeaderParams {
     'Harness-Account'?: string;
 }
-export type GetLayoutOkResponse = GeneralResponseResponse;
+export type GetLayoutOkResponse = LayoutResponseResponse;
 export type GetLayoutErrorResponse = unknown;
 export interface GetLayoutProps extends GetLayoutQueryPathParams, Omit<FetcherOptions<unknown, unknown, GetLayoutQueryHeaderParams>, 'url'> {
 }
@@ -15,4 +15,4 @@ export declare function getLayout(props: GetLayoutProps): Promise<GetLayoutOkRes
 /**
  * Get Layout
  */
-export declare function useGetLayoutQuery(props: GetLayoutProps, options?: Omit<UseQueryOptions<GetLayoutOkResponse, GetLayoutErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<import("..").GeneralResponse, unknown>;
+export declare function useGetLayoutQuery(props: GetLayoutProps, options?: Omit<UseQueryOptions<GetLayoutOkResponse, GetLayoutErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<import("..").LayoutResponse, unknown>;

package/dist/services/hooks/useImportHarnessEntitiesMutation.d.ts

@@ -0,0 +1,19 @@
+import { UseMutationOptions } from '@tanstack/react-query';
+import type { ImportEntitiesResponseResponse } from '../responses/ImportEntitiesResponseResponse';
+import type { ImportHarnessEntitiesRequestRequestBody } from '../requestBodies/ImportHarnessEntitiesRequestRequestBody';
+import { FetcherOptions } from './../../fetcher';
+export interface ImportHarnessEntitiesMutationHeaderParams {
+    'Harness-Account'?: string;
+}
+export type ImportHarnessEntitiesRequestBody = ImportHarnessEntitiesRequestRequestBody;
+export type ImportHarnessEntitiesOkResponse = ImportEntitiesResponseResponse;
+export type ImportHarnessEntitiesErrorResponse = unknown;
+export interface ImportHarnessEntitiesProps extends Omit<FetcherOptions<unknown, ImportHarnessEntitiesRequestBody, ImportHarnessEntitiesMutationHeaderParams>, 'url'> {
+    body: ImportHarnessEntitiesRequestBody;
+}
+export declare function importHarnessEntities(props: ImportHarnessEntitiesProps): Promise<ImportHarnessEntitiesOkResponse>;
+export type ImportHarnessEntitiesMutationProps<T extends keyof ImportHarnessEntitiesProps> = Omit<ImportHarnessEntitiesProps, T> & Partial<Pick<ImportHarnessEntitiesProps, T>>;
+/**
+ * Import Harness Entities to IDP
+ */
+export declare function useImportHarnessEntitiesMutation<T extends keyof ImportHarnessEntitiesProps>(props: Pick<Partial<ImportHarnessEntitiesProps>, T>, options?: Omit<UseMutationOptions<ImportHarnessEntitiesOkResponse, ImportHarnessEntitiesErrorResponse, ImportHarnessEntitiesMutationProps<T>>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<import("..").ImportEntitiesResponse, unknown, ImportHarnessEntitiesMutationProps<T>, unknown>;

package/dist/services/hooks/useImportHarnessEntitiesMutation.js

@@ -0,0 +1,14 @@
+/* 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 './../../fetcher';
+export function importHarnessEntities(props) {
+    return fetcher(Object.assign({ url: `/v1/onboarding/import-harness-entities`, method: 'POST' }, props));
+}
+/**
+ * Import Harness Entities to IDP
+ */
+export function useImportHarnessEntitiesMutation(props, options) {
+    return useMutation((mutateProps) => importHarnessEntities(Object.assign(Object.assign({}, props), mutateProps)), options);
+}

package/dist/services/hooks/useOnboardingAccessCheckQuery.d.ts

@@ -0,0 +1,15 @@
+import { UseQueryOptions } from '@tanstack/react-query';
+import type { OnboardingAccessCheckResponseResponse } from '../responses/OnboardingAccessCheckResponseResponse';
+import { FetcherOptions } from './../../fetcher';
+export interface OnboardingAccessCheckQueryHeaderParams {
+    'Harness-Account'?: string;
+}
+export type OnboardingAccessCheckOkResponse = OnboardingAccessCheckResponseResponse;
+export type OnboardingAccessCheckErrorResponse = unknown;
+export interface OnboardingAccessCheckProps extends Omit<FetcherOptions<unknown, unknown, OnboardingAccessCheckQueryHeaderParams>, 'url'> {
+}
+export declare function onboardingAccessCheck(props: OnboardingAccessCheckProps): Promise<OnboardingAccessCheckOkResponse>;
+/**
+ * Check if User is allowed to perform IDP onboarding workflow
+ */
+export declare function useOnboardingAccessCheckQuery(props: OnboardingAccessCheckProps, options?: Omit<UseQueryOptions<OnboardingAccessCheckOkResponse, OnboardingAccessCheckErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<import("..").OnboardingAccessCheckResponse, unknown>;

package/dist/services/hooks/useOnboardingAccessCheckQuery.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';
+export function onboardingAccessCheck(props) {
+    return fetcher(Object.assign({ url: `/v1/onboarding/access-check`, method: 'GET' }, props));
+}
+/**
+ * Check if User is allowed to perform IDP onboarding workflow
+ */
+export function useOnboardingAccessCheckQuery(props, options) {
+    return useQuery(['onboarding-access-check'], ({ signal }) => onboardingAccessCheck(Object.assign(Object.assign({}, props), { signal })), options);
+}

package/dist/services/index.d.ts

@@ -1,29 +1,36 @@
 export type { CreateBackstagePermissionsErrorResponse, CreateBackstagePermissionsMutationProps, CreateBackstagePermissionsOkResponse, CreateBackstagePermissionsProps, CreateBackstagePermissionsRequestBody, } from './hooks/useCreateBackstagePermissionsMutation';
 export { createBackstagePermissions, useCreateBackstagePermissionsMutation, } from './hooks/useCreateBackstagePermissionsMutation';
-export type { CreateLayoutErrorResponse, CreateLayoutMutationProps, CreateLayoutOkResponse, CreateLayoutProps, } from './hooks/useCreateLayoutMutation';
+export type { CreateLayoutErrorResponse, CreateLayoutMutationProps, CreateLayoutOkResponse, CreateLayoutProps, CreateLayoutRequestBody, } from './hooks/useCreateLayoutMutation';
 export { createLayout, useCreateLayoutMutation } from './hooks/useCreateLayoutMutation';
 export type { GetAllLayoutsErrorResponse, GetAllLayoutsOkResponse, GetAllLayoutsProps, } from './hooks/useGetAllLayoutsQuery';
 export { getAllLayouts, useGetAllLayoutsQuery } from './hooks/useGetAllLayoutsQuery';
 export type { GetBackstagePermissionsErrorResponse, GetBackstagePermissionsOkResponse, GetBackstagePermissionsProps, } from './hooks/useGetBackstagePermissionsQuery';
 export { getBackstagePermissions, useGetBackstagePermissionsQuery, } from './hooks/useGetBackstagePermissionsQuery';
+export type { GetHarnessEntitiesErrorResponse, GetHarnessEntitiesOkResponse, GetHarnessEntitiesProps, GetHarnessEntitiesQueryQueryParams, } from './hooks/useGetHarnessEntitiesQuery';
+export { getHarnessEntities, useGetHarnessEntitiesQuery } from './hooks/useGetHarnessEntitiesQuery';
 export type { GetLayoutErrorResponse, GetLayoutOkResponse, GetLayoutProps, GetLayoutQueryPathParams, } from './hooks/useGetLayoutQuery';
 export { getLayout, useGetLayoutQuery } from './hooks/useGetLayoutQuery';
 export type { GetStatusInfoByTypeErrorResponse, GetStatusInfoByTypeOkResponse, GetStatusInfoByTypeProps, GetStatusInfoByTypeQueryPathParams, } from './hooks/useGetStatusInfoByTypeQuery';
 export { getStatusInfoByType, useGetStatusInfoByTypeQuery, } from './hooks/useGetStatusInfoByTypeQuery';
+export type { ImportHarnessEntitiesErrorResponse, ImportHarnessEntitiesMutationProps, ImportHarnessEntitiesOkResponse, ImportHarnessEntitiesProps, ImportHarnessEntitiesRequestBody, } from './hooks/useImportHarnessEntitiesMutation';
+export { importHarnessEntities, useImportHarnessEntitiesMutation, } from './hooks/useImportHarnessEntitiesMutation';
+export type { OnboardingAccessCheckErrorResponse, OnboardingAccessCheckOkResponse, OnboardingAccessCheckProps, } from './hooks/useOnboardingAccessCheckQuery';
+export { onboardingAccessCheck, useOnboardingAccessCheckQuery, } from './hooks/useOnboardingAccessCheckQuery';
 export type { UpdateBackstagePermissionsErrorResponse, UpdateBackstagePermissionsMutationProps, UpdateBackstagePermissionsOkResponse, UpdateBackstagePermissionsProps, UpdateBackstagePermissionsRequestBody, } from './hooks/useUpdateBackstagePermissionsMutation';
 export { updateBackstagePermissions, useUpdateBackstagePermissionsMutation, } from './hooks/useUpdateBackstagePermissionsMutation';
 export type { BackstagePermissionsRequestRequestBody } from './requestBodies/BackstagePermissionsRequestRequestBody';
 export type { EnvironmentSecretRequestListRequestBody } from './requestBodies/EnvironmentSecretRequestListRequestBody';
 export type { EnvironmentSecretRequestRequestBody } from './requestBodies/EnvironmentSecretRequestRequestBody';
 export type { ImportHarnessEntitiesRequestRequestBody } from './requestBodies/ImportHarnessEntitiesRequestRequestBody';
+export type { LayoutRequestRequestBody } from './requestBodies/LayoutRequestRequestBody';
 export type { ManualImportEntityRequestRequestBody } from './requestBodies/ManualImportEntityRequestRequestBody';
 export type { StatusInfoRequestRequestBody } from './requestBodies/StatusInfoRequestRequestBody';
 export type { BackstagePermissionsResponseResponse } from './responses/BackstagePermissionsResponseResponse';
 export type { EnvironmentSecretResponseListResponse } from './responses/EnvironmentSecretResponseListResponse';
 export type { EnvironmentSecretResponseResponse } from './responses/EnvironmentSecretResponseResponse';
-export type { GeneralResponseResponse } from './responses/GeneralResponseResponse';
 export type { HarnessEntitiesResponseResponse } from './responses/HarnessEntitiesResponseResponse';
 export type { ImportEntitiesResponseResponse } from './responses/ImportEntitiesResponseResponse';
+export type { LayoutResponseResponse } from './responses/LayoutResponseResponse';
 export type { NamespaceResponseResponse } from './responses/NamespaceResponseResponse';
 export type { OnboardingAccessCheckResponseResponse } from './responses/OnboardingAccessCheckResponseResponse';
 export type { StatusInfoResponseResponse } from './responses/StatusInfoResponseResponse';
@@ -36,11 +43,12 @@ export type { EntitiesForImport } from './schemas/EntitiesForImport';
 export type { EnvironmentSecret } from './schemas/EnvironmentSecret';
 export type { EnvironmentSecretRequest } from './schemas/EnvironmentSecretRequest';
 export type { EnvironmentSecretResponse } from './schemas/EnvironmentSecretResponse';
-export type { GeneralResponse } from './schemas/GeneralResponse';
 export type { HarnessBackstageEntities } from './schemas/HarnessBackstageEntities';
 export type { HarnessEntitiesResponse } from './schemas/HarnessEntitiesResponse';
 export type { ImportEntitiesResponse } from './schemas/ImportEntitiesResponse';
 export type { ImportHarnessEntitiesRequest } from './schemas/ImportHarnessEntitiesRequest';
+export type { LayoutRequest } from './schemas/LayoutRequest';
+export type { LayoutResponse } from './schemas/LayoutResponse';
 export type { ManualImportEntityRequest } from './schemas/ManualImportEntityRequest';
 export type { NamepsaceResponse } from './schemas/NamepsaceResponse';
 export type { NamespaceInfo } from './schemas/NamespaceInfo';

package/dist/services/index.js

@@ -2,6 +2,9 @@ export { createBackstagePermissions, useCreateBackstagePermissionsMutation, } fr
 export { createLayout, useCreateLayoutMutation } from './hooks/useCreateLayoutMutation';
 export { getAllLayouts, useGetAllLayoutsQuery } from './hooks/useGetAllLayoutsQuery';
 export { getBackstagePermissions, useGetBackstagePermissionsQuery, } from './hooks/useGetBackstagePermissionsQuery';
+export { getHarnessEntities, useGetHarnessEntitiesQuery } from './hooks/useGetHarnessEntitiesQuery';
 export { getLayout, useGetLayoutQuery } from './hooks/useGetLayoutQuery';
 export { getStatusInfoByType, useGetStatusInfoByTypeQuery, } from './hooks/useGetStatusInfoByTypeQuery';
+export { importHarnessEntities, useImportHarnessEntitiesMutation, } from './hooks/useImportHarnessEntitiesMutation';
+export { onboardingAccessCheck, useOnboardingAccessCheckQuery, } from './hooks/useOnboardingAccessCheckQuery';
 export { updateBackstagePermissions, useUpdateBackstagePermissionsMutation, } from './hooks/useUpdateBackstagePermissionsMutation';

package/dist/services/requestBodies/LayoutRequestRequestBody.d.ts

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

package/dist/services/responses/LayoutResponseResponse.d.ts

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

package/dist/services/responses/LayoutResponseResponse.js

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

package/dist/services/schemas/LayoutRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * LayoutRequest
+ */
+export interface LayoutRequest {
+    defaultYaml?: string;
+    displayName?: string;
+    id?: string;
+    name?: string;
+    type?: string;
+    yaml?: string;
+}

package/dist/services/schemas/LayoutResponse.d.ts

@@ -0,0 +1,3 @@
+export interface LayoutResponse {
+    [key: string]: any;
+}

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

package/dist/services/responses/GeneralResponseResponse.d.ts

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

package/dist/services/schemas/GeneralResponse.d.ts

@@ -1,3 +0,0 @@
-export interface GeneralResponse {
-    [key: string]: any;
-}