@harnessio/react-integration-manager-client 0.8.5 → 0.8.6

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.
Files changed (17) hide show
  1. package/dist/integration-manager/src/services/hooks/useGetEntityInputSchemaQuery.d.ts +23 -0
  2. package/dist/integration-manager/src/services/hooks/useGetEntityInputSchemaQuery.js +14 -0
  3. package/dist/integration-manager/src/services/hooks/useGetSampleRecordsQuery.d.ts +22 -0
  4. package/dist/integration-manager/src/services/hooks/useGetSampleRecordsQuery.js +14 -0
  5. package/dist/integration-manager/src/services/index.d.ts +7 -0
  6. package/dist/integration-manager/src/services/index.js +2 -0
  7. package/dist/integration-manager/src/services/schemas/IntegrationconfigMappingConfigInput.d.ts +8 -0
  8. package/dist/integration-manager/src/services/schemas/IntegrationconfigMappingConfigInput.js +1 -0
  9. package/dist/integration-manager/src/services/schemas/OpenapiCreateAirbyteIntegrationConfigOrgRequest.d.ts +2 -2
  10. package/dist/integration-manager/src/services/schemas/OpenapiCreateAirbyteIntegrationConfigProjectRequest.d.ts +2 -2
  11. package/dist/integration-manager/src/services/schemas/OpenapiCreateAirbyteIntegrationConfigRequest.d.ts +2 -2
  12. package/dist/integration-manager/src/services/schemas/TypesEntityInputSchemaResponse.d.ts +7 -0
  13. package/dist/integration-manager/src/services/schemas/TypesEntityInputSchemaResponse.js +4 -0
  14. package/dist/integration-manager/src/services/schemas/TypesMappingConfig.d.ts +0 -2
  15. package/dist/integration-manager/src/services/schemas/TypesSampleEntity.d.ts +12 -0
  16. package/dist/integration-manager/src/services/schemas/TypesSampleEntity.js +4 -0
  17. package/package.json +1 -1
@@ -0,0 +1,23 @@
1
+ import { UseQueryOptions } from '@tanstack/react-query';
2
+ import type { TypesEntityInputSchemaResponse } from '../schemas/TypesEntityInputSchemaResponse';
3
+ import type { ApierrorsErrorResponse } from '../schemas/ApierrorsErrorResponse';
4
+ import type { ResponseWithPagination } from '../helpers';
5
+ import { FetcherOptions } from '../../../../fetcher/index.js';
6
+ export interface GetEntityInputSchemaQueryPathParams {
7
+ accountIdentifier: string;
8
+ }
9
+ export interface GetEntityInputSchemaQueryQueryParams {
10
+ integration_type?: string;
11
+ kind?: string;
12
+ version?: string;
13
+ }
14
+ export type GetEntityInputSchemaOkResponse = ResponseWithPagination<TypesEntityInputSchemaResponse>;
15
+ export type GetEntityInputSchemaErrorResponse = ApierrorsErrorResponse;
16
+ export interface GetEntityInputSchemaProps extends GetEntityInputSchemaQueryPathParams, Omit<FetcherOptions<GetEntityInputSchemaQueryQueryParams, unknown>, 'url'> {
17
+ queryParams: GetEntityInputSchemaQueryQueryParams;
18
+ }
19
+ export declare function getEntityInputSchema(props: GetEntityInputSchemaProps): Promise<GetEntityInputSchemaOkResponse>;
20
+ /**
21
+ * Returns the JSON schema of the default entity spec for one (integration_type, kind) — the input root that customer-authored mapping jq runs against (spec-as-root). Query 'integration_type' and 'kind' are required; optional 'version' pins to a specific default schema version. The schema is returned verbatim (complete and not depth-limited); the mapping editor walks it to derive referenceable '.spec.*' paths.
22
+ */
23
+ export declare function useGetEntityInputSchemaQuery(props: GetEntityInputSchemaProps, options?: Omit<UseQueryOptions<GetEntityInputSchemaOkResponse, GetEntityInputSchemaErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetEntityInputSchemaOkResponse, ApierrorsErrorResponse>;
@@ -0,0 +1,14 @@
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 getEntityInputSchema(props) {
7
+ return fetcher(Object.assign({ url: `/api/v1/accounts/${props.accountIdentifier}/integration/input-schema`, method: 'GET' }, props));
8
+ }
9
+ /**
10
+ * Returns the JSON schema of the default entity spec for one (integration_type, kind) — the input root that customer-authored mapping jq runs against (spec-as-root). Query 'integration_type' and 'kind' are required; optional 'version' pins to a specific default schema version. The schema is returned verbatim (complete and not depth-limited); the mapping editor walks it to derive referenceable '.spec.*' paths.
11
+ */
12
+ export function useGetEntityInputSchemaQuery(props, options) {
13
+ return useQuery(['getEntityInputSchema', props.accountIdentifier, props.queryParams], ({ signal }) => getEntityInputSchema(Object.assign(Object.assign({}, props), { signal })), options);
14
+ }
@@ -0,0 +1,22 @@
1
+ import { UseQueryOptions } from '@tanstack/react-query';
2
+ import type { TypesSampleEntity } from '../schemas/TypesSampleEntity';
3
+ import type { ApierrorsErrorResponse } from '../schemas/ApierrorsErrorResponse';
4
+ import type { ResponseWithPagination } from '../helpers';
5
+ import { FetcherOptions } from '../../../../fetcher/index.js';
6
+ export interface GetSampleRecordsQueryPathParams {
7
+ accountIdentifier: string;
8
+ }
9
+ export interface GetSampleRecordsQueryQueryParams {
10
+ integration_type?: string;
11
+ kind?: string;
12
+ }
13
+ export type GetSampleRecordsOkResponse = ResponseWithPagination<TypesSampleEntity[]>;
14
+ export type GetSampleRecordsErrorResponse = ApierrorsErrorResponse;
15
+ export interface GetSampleRecordsProps extends GetSampleRecordsQueryPathParams, Omit<FetcherOptions<GetSampleRecordsQueryQueryParams, unknown>, 'url'> {
16
+ queryParams: GetSampleRecordsQueryQueryParams;
17
+ }
18
+ export declare function getSampleRecords(props: GetSampleRecordsProps): Promise<GetSampleRecordsOkResponse>;
19
+ /**
20
+ * Returns curated sample records for a (integration_type, kind), mapped through the default schema_mapping into entity.Spec shape. No integration config is required. Query 'integration_type' is required. Query 'kind' is optional; when omitted, results are aggregated across every kind that has curated fixtures for that integration type.
21
+ */
22
+ export declare function useGetSampleRecordsQuery(props: GetSampleRecordsProps, options?: Omit<UseQueryOptions<GetSampleRecordsOkResponse, GetSampleRecordsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<GetSampleRecordsOkResponse, ApierrorsErrorResponse>;
@@ -0,0 +1,14 @@
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 getSampleRecords(props) {
7
+ return fetcher(Object.assign({ url: `/api/v1/accounts/${props.accountIdentifier}/integration/sample-records`, method: 'GET' }, props));
8
+ }
9
+ /**
10
+ * Returns curated sample records for a (integration_type, kind), mapped through the default schema_mapping into entity.Spec shape. No integration config is required. Query 'integration_type' is required. Query 'kind' is optional; when omitted, results are aggregated across every kind that has curated fixtures for that integration type.
11
+ */
12
+ export function useGetSampleRecordsQuery(props, options) {
13
+ return useQuery(['getSampleRecords', props.accountIdentifier, props.queryParams], ({ signal }) => getSampleRecords(Object.assign(Object.assign({}, props), { signal })), options);
14
+ }
@@ -75,6 +75,8 @@ export type { GetEntitiesOrgErrorResponse, GetEntitiesOrgMutationPathParams, Get
75
75
  export { getEntitiesOrg, useGetEntitiesOrgMutation } from './hooks/useGetEntitiesOrgMutation';
76
76
  export type { GetEntitiesProjectErrorResponse, GetEntitiesProjectMutationPathParams, GetEntitiesProjectOkResponse, GetEntitiesProjectProps, GetEntitiesProjectRequestBody, } from './hooks/useGetEntitiesProjectMutation';
77
77
  export { getEntitiesProject, useGetEntitiesProjectMutation, } from './hooks/useGetEntitiesProjectMutation';
78
+ export type { GetEntityInputSchemaErrorResponse, GetEntityInputSchemaOkResponse, GetEntityInputSchemaProps, GetEntityInputSchemaQueryPathParams, GetEntityInputSchemaQueryQueryParams, } from './hooks/useGetEntityInputSchemaQuery';
79
+ export { getEntityInputSchema, useGetEntityInputSchemaQuery, } from './hooks/useGetEntityInputSchemaQuery';
78
80
  export type { GetHealthErrorResponse, GetHealthOkResponse, GetHealthProps, } from './hooks/useGetHealthQuery';
79
81
  export { getHealth, useGetHealthQuery } from './hooks/useGetHealthQuery';
80
82
  export type { GetIntegrationConfigOrgErrorResponse, GetIntegrationConfigOrgOkResponse, GetIntegrationConfigOrgProps, GetIntegrationConfigOrgQueryPathParams, } from './hooks/useGetIntegrationConfigOrgQuery';
@@ -95,6 +97,8 @@ export type { GetMetricTimeseriesProjectErrorResponse, GetMetricTimeseriesProjec
95
97
  export { getMetricTimeseriesProject, useGetMetricTimeseriesProjectQuery, } from './hooks/useGetMetricTimeseriesProjectQuery';
96
98
  export type { GetMetricTimeseriesErrorResponse, GetMetricTimeseriesOkResponse, GetMetricTimeseriesProps, GetMetricTimeseriesQueryPathParams, GetMetricTimeseriesQueryQueryParams, } from './hooks/useGetMetricTimeseriesQuery';
97
99
  export { getMetricTimeseries, useGetMetricTimeseriesQuery, } from './hooks/useGetMetricTimeseriesQuery';
100
+ export type { GetSampleRecordsErrorResponse, GetSampleRecordsOkResponse, GetSampleRecordsProps, GetSampleRecordsQueryPathParams, GetSampleRecordsQueryQueryParams, } from './hooks/useGetSampleRecordsQuery';
101
+ export { getSampleRecords, useGetSampleRecordsQuery } from './hooks/useGetSampleRecordsQuery';
98
102
  export type { ListDefaultMappingFieldsErrorResponse, ListDefaultMappingFieldsOkResponse, ListDefaultMappingFieldsProps, ListDefaultMappingFieldsQueryPathParams, ListDefaultMappingFieldsQueryQueryParams, } from './hooks/useListDefaultMappingFieldsQuery';
99
103
  export { listDefaultMappingFields, useListDefaultMappingFieldsQuery, } from './hooks/useListDefaultMappingFieldsQuery';
100
104
  export type { ListDefaultSchemasErrorResponse, ListDefaultSchemasOkResponse, ListDefaultSchemasProps, ListDefaultSchemasQueryPathParams, ListDefaultSchemasQueryQueryParams, } from './hooks/useListDefaultSchemasQuery';
@@ -199,6 +203,7 @@ export type { EnumOperator } from './schemas/EnumOperator';
199
203
  export type { EnumSyncResponseStatus } from './schemas/EnumSyncResponseStatus';
200
204
  export type { EnumSyncStatus } from './schemas/EnumSyncStatus';
201
205
  export type { IntegrationconfigAirbyteIntegrationResponse } from './schemas/IntegrationconfigAirbyteIntegrationResponse';
206
+ export type { IntegrationconfigMappingConfigInput } from './schemas/IntegrationconfigMappingConfigInput';
202
207
  export type { IntegrationconfigSchemaValidationError } from './schemas/IntegrationconfigSchemaValidationError';
203
208
  export type { IntegrationconfigValidateCustomSchemaResponse } from './schemas/IntegrationconfigValidateCustomSchemaResponse';
204
209
  export type { IntegrationeventIntegrationEventResponse } from './schemas/IntegrationeventIntegrationEventResponse';
@@ -262,6 +267,7 @@ export type { TypesDefaultMappingField } from './schemas/TypesDefaultMappingFiel
262
267
  export type { TypesDefaultRelationEnd } from './schemas/TypesDefaultRelationEnd';
263
268
  export type { TypesDockerConnectorSettings } from './schemas/TypesDockerConnectorSettings';
264
269
  export type { TypesEntity } from './schemas/TypesEntity';
270
+ export type { TypesEntityInputSchemaResponse } from './schemas/TypesEntityInputSchemaResponse';
265
271
  export type { TypesEntityMapping } from './schemas/TypesEntityMapping';
266
272
  export type { TypesEntityMappingSpec } from './schemas/TypesEntityMappingSpec';
267
273
  export type { TypesEntitySchema } from './schemas/TypesEntitySchema';
@@ -289,6 +295,7 @@ export type { TypesMetricConfiguration } from './schemas/TypesMetricConfiguratio
289
295
  export type { TypesMetricDataPoint } from './schemas/TypesMetricDataPoint';
290
296
  export type { TypesMetricErrors } from './schemas/TypesMetricErrors';
291
297
  export type { TypesReevalState } from './schemas/TypesReevalState';
298
+ export type { TypesSampleEntity } from './schemas/TypesSampleEntity';
292
299
  export type { TypesSchemaMapping } from './schemas/TypesSchemaMapping';
293
300
  export type { TypesScope } from './schemas/TypesScope';
294
301
  export type { TypesScopeConfig } from './schemas/TypesScopeConfig';
@@ -36,6 +36,7 @@ export { getCustomEntitiesTypeProject, useGetCustomEntitiesTypeProjectMutation,
36
36
  export { getEntities, useGetEntitiesMutation } from './hooks/useGetEntitiesMutation';
37
37
  export { getEntitiesOrg, useGetEntitiesOrgMutation } from './hooks/useGetEntitiesOrgMutation';
38
38
  export { getEntitiesProject, useGetEntitiesProjectMutation, } from './hooks/useGetEntitiesProjectMutation';
39
+ export { getEntityInputSchema, useGetEntityInputSchemaQuery, } from './hooks/useGetEntityInputSchemaQuery';
39
40
  export { getHealth, useGetHealthQuery } from './hooks/useGetHealthQuery';
40
41
  export { getIntegrationConfigOrg, useGetIntegrationConfigOrgQuery, } from './hooks/useGetIntegrationConfigOrgQuery';
41
42
  export { getIntegrationConfigProject, useGetIntegrationConfigProjectQuery, } from './hooks/useGetIntegrationConfigProjectQuery';
@@ -46,6 +47,7 @@ export { getMetricConfig, useGetMetricConfigQuery } from './hooks/useGetMetricCo
46
47
  export { getMetricTimeseriesOrg, useGetMetricTimeseriesOrgQuery, } from './hooks/useGetMetricTimeseriesOrgQuery';
47
48
  export { getMetricTimeseriesProject, useGetMetricTimeseriesProjectQuery, } from './hooks/useGetMetricTimeseriesProjectQuery';
48
49
  export { getMetricTimeseries, useGetMetricTimeseriesQuery, } from './hooks/useGetMetricTimeseriesQuery';
50
+ export { getSampleRecords, useGetSampleRecordsQuery } from './hooks/useGetSampleRecordsQuery';
49
51
  export { listDefaultMappingFields, useListDefaultMappingFieldsQuery, } from './hooks/useListDefaultMappingFieldsQuery';
50
52
  export { listDefaultSchemas, useListDefaultSchemasQuery } from './hooks/useListDefaultSchemasQuery';
51
53
  export { listIntegrationConfigsOrg, useListIntegrationConfigsOrgQuery, } from './hooks/useListIntegrationConfigsOrgQuery';
@@ -0,0 +1,8 @@
1
+ import type { TypesCorrelationMapping } from '../schemas/TypesCorrelationMapping';
2
+ export interface IntegrationconfigMappingConfigInput {
3
+ correlation_mapping?: TypesCorrelationMapping;
4
+ display_name_field?: string;
5
+ idp_kind?: string;
6
+ idp_type?: string;
7
+ unique_identifier_field?: string;
8
+ }
@@ -2,7 +2,7 @@ import type { EnumAction } from '../schemas/EnumAction';
2
2
  import type { TypesAirbyteCatalogDiscovered } from '../schemas/TypesAirbyteCatalogDiscovered';
3
3
  import type { TypesFieldMapping } from '../schemas/TypesFieldMapping';
4
4
  import type { EnumIntegrationType } from '../schemas/EnumIntegrationType';
5
- import type { TypesMappingConfig } from '../schemas/TypesMappingConfig';
5
+ import type { IntegrationconfigMappingConfigInput } from '../schemas/IntegrationconfigMappingConfigInput';
6
6
  import type { EnumAirbyteSyncMode } from '../schemas/EnumAirbyteSyncMode';
7
7
  export interface OpenapiCreateAirbyteIntegrationConfigOrgRequest {
8
8
  action_per_kind?: {
@@ -22,7 +22,7 @@ export interface OpenapiCreateAirbyteIntegrationConfigOrgRequest {
22
22
  integration_type?: EnumIntegrationType;
23
23
  kinds?: string[] | null;
24
24
  mapping_config_per_kind?: {
25
- [key: string]: TypesMappingConfig;
25
+ [key: string]: IntegrationconfigMappingConfigInput;
26
26
  };
27
27
  name?: string;
28
28
  replication_mode_per_kind?: {
@@ -2,7 +2,7 @@ import type { EnumAction } from '../schemas/EnumAction';
2
2
  import type { TypesAirbyteCatalogDiscovered } from '../schemas/TypesAirbyteCatalogDiscovered';
3
3
  import type { TypesFieldMapping } from '../schemas/TypesFieldMapping';
4
4
  import type { EnumIntegrationType } from '../schemas/EnumIntegrationType';
5
- import type { TypesMappingConfig } from '../schemas/TypesMappingConfig';
5
+ import type { IntegrationconfigMappingConfigInput } from '../schemas/IntegrationconfigMappingConfigInput';
6
6
  import type { EnumAirbyteSyncMode } from '../schemas/EnumAirbyteSyncMode';
7
7
  export interface OpenapiCreateAirbyteIntegrationConfigProjectRequest {
8
8
  action_per_kind?: {
@@ -22,7 +22,7 @@ export interface OpenapiCreateAirbyteIntegrationConfigProjectRequest {
22
22
  integration_type?: EnumIntegrationType;
23
23
  kinds?: string[] | null;
24
24
  mapping_config_per_kind?: {
25
- [key: string]: TypesMappingConfig;
25
+ [key: string]: IntegrationconfigMappingConfigInput;
26
26
  };
27
27
  name?: string;
28
28
  replication_mode_per_kind?: {
@@ -2,7 +2,7 @@ import type { EnumAction } from '../schemas/EnumAction';
2
2
  import type { TypesAirbyteCatalogDiscovered } from '../schemas/TypesAirbyteCatalogDiscovered';
3
3
  import type { TypesFieldMapping } from '../schemas/TypesFieldMapping';
4
4
  import type { EnumIntegrationType } from '../schemas/EnumIntegrationType';
5
- import type { TypesMappingConfig } from '../schemas/TypesMappingConfig';
5
+ import type { IntegrationconfigMappingConfigInput } from '../schemas/IntegrationconfigMappingConfigInput';
6
6
  import type { EnumAirbyteSyncMode } from '../schemas/EnumAirbyteSyncMode';
7
7
  export interface OpenapiCreateAirbyteIntegrationConfigRequest {
8
8
  action_per_kind?: {
@@ -22,7 +22,7 @@ export interface OpenapiCreateAirbyteIntegrationConfigRequest {
22
22
  integration_type?: EnumIntegrationType;
23
23
  kinds?: string[] | null;
24
24
  mapping_config_per_kind?: {
25
- [key: string]: TypesMappingConfig;
25
+ [key: string]: IntegrationconfigMappingConfigInput;
26
26
  };
27
27
  name?: string;
28
28
  replication_mode_per_kind?: {
@@ -0,0 +1,7 @@
1
+ export interface TypesEntityInputSchemaResponse {
2
+ kind?: string;
3
+ schema?: {
4
+ [key: string]: any;
5
+ } | null;
6
+ version?: string;
7
+ }
@@ -0,0 +1,4 @@
1
+ /* eslint-disable */
2
+ // This code is autogenerated using @harnessio/oats-cli.
3
+ // Please do not modify this code directly.
4
+ export {};
@@ -1,8 +1,6 @@
1
1
  import type { TypesCorrelationMapping } from '../schemas/TypesCorrelationMapping';
2
2
  export interface TypesMappingConfig {
3
3
  correlation_mapping?: TypesCorrelationMapping;
4
- display_name_field?: string;
5
4
  idp_kind?: string;
6
5
  idp_type?: string;
7
- unique_identifier_field?: string;
8
6
  }
@@ -0,0 +1,12 @@
1
+ export interface TypesSampleEntity {
2
+ identifier?: string;
3
+ integration_type?: string;
4
+ kind?: string;
5
+ metadata?: {
6
+ [key: string]: any;
7
+ } | null;
8
+ spec?: {
9
+ [key: string]: any;
10
+ } | null;
11
+ version?: string;
12
+ }
@@ -0,0 +1,4 @@
1
+ /* eslint-disable */
2
+ // This code is autogenerated using @harnessio/oats-cli.
3
+ // Please do not modify this code directly.
4
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harnessio/react-integration-manager-client",
3
- "version": "0.8.5",
3
+ "version": "0.8.6",
4
4
  "description": "Harness React integration manager client - Integration Manager APIs integrated with react hooks",
5
5
  "author": "Harness Inc",
6
6
  "license": "MIT",