@harnessio/react-har-service-client 0.53.0 → 0.55.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.
Files changed (20) hide show
  1. package/dist/har-service/src/services/hooks/useListFirewallExceptionsV3Query.d.ts +2 -0
  2. package/dist/har-service/src/services/hooks/useMigrateRegistryV3Mutation.d.ts +20 -0
  3. package/dist/har-service/src/services/hooks/useMigrateRegistryV3Mutation.js +14 -0
  4. package/dist/har-service/src/services/index.d.ts +3 -1
  5. package/dist/har-service/src/services/index.js +1 -0
  6. package/dist/har-service/src/services/schemas/ArtifactDetail.d.ts +2 -1
  7. package/dist/har-service/src/services/schemas/ArtifactMetadata.d.ts +5 -1
  8. package/dist/har-service/src/services/schemas/ArtifactScanV3.d.ts +6 -2
  9. package/dist/har-service/src/services/schemas/ArtifactVersionMetadata.d.ts +1 -1
  10. package/dist/har-service/src/services/schemas/ArtifactVersionSummary.d.ts +1 -1
  11. package/dist/har-service/src/services/schemas/FirewallModeV3.d.ts +1 -1
  12. package/dist/har-service/src/services/schemas/PackageType.d.ts +1 -1
  13. package/dist/har-service/src/services/schemas/PackageTypeV3.d.ts +1 -1
  14. package/dist/har-service/src/services/schemas/PuppetArtifactDetailConfig.d.ts +8 -0
  15. package/dist/har-service/src/services/schemas/UpstreamConfig.d.ts +1 -1
  16. package/dist/har-service/src/services/schemas/UpstreamProxyConfigFirewallMode.d.ts +1 -1
  17. package/dist/har-service/src/services/schemas/VersionMetadata.d.ts +5 -1
  18. package/package.json +1 -1
  19. package/dist/har-service/src/services/schemas/PolicySetsV3.d.ts +0 -13
  20. /package/dist/har-service/src/services/schemas/{PolicySetsV3.js → PuppetArtifactDetailConfig.js} +0 -0
@@ -14,6 +14,8 @@ export interface ListFirewallExceptionsV3QueryQueryParams {
14
14
  package_name?: string;
15
15
  version?: string;
16
16
  package_types?: string[];
17
+ registry_ids?: string[];
18
+ exception_id?: string;
17
19
  search_term?: string;
18
20
  /**
19
21
  * @format int64
@@ -0,0 +1,20 @@
1
+ import { UseMutationOptions } from '@tanstack/react-query';
2
+ import type { ErrorV3 } from '../schemas/ErrorV3';
3
+ import type { ResponseWithPagination } from '../helpers';
4
+ import { FetcherOptions } from '../../../../fetcher/index.js';
5
+ export interface MigrateRegistryV3MutationPathParams {
6
+ id: string;
7
+ }
8
+ export interface MigrateRegistryV3MutationQueryParams {
9
+ account_identifier: string;
10
+ }
11
+ export type MigrateRegistryV3OkResponse = ResponseWithPagination<unknown>;
12
+ export type MigrateRegistryV3ErrorResponse = ErrorV3;
13
+ export interface MigrateRegistryV3Props extends MigrateRegistryV3MutationPathParams, Omit<FetcherOptions<MigrateRegistryV3MutationQueryParams, unknown>, 'url'> {
14
+ queryParams: MigrateRegistryV3MutationQueryParams;
15
+ }
16
+ export declare function migrateRegistryV3(props: MigrateRegistryV3Props): Promise<MigrateRegistryV3OkResponse>;
17
+ /**
18
+ * Migrate a generic registry to raw registry type. This will change the registry type from GENERIC to RAW and delete all images associated with the registry.
19
+ */
20
+ export declare function useMigrateRegistryV3Mutation(options?: Omit<UseMutationOptions<MigrateRegistryV3OkResponse, MigrateRegistryV3ErrorResponse, MigrateRegistryV3Props>, 'mutationKey' | 'mutationFn'>): import("@tanstack/react-query").UseMutationResult<MigrateRegistryV3OkResponse, ErrorV3, MigrateRegistryV3Props, unknown>;
@@ -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 { useMutation } from '@tanstack/react-query';
5
+ import { fetcher } from '../../../../fetcher/index.js';
6
+ export function migrateRegistryV3(props) {
7
+ return fetcher(Object.assign({ url: `/v3/registries/${props.id}/migrate`, method: 'POST' }, props));
8
+ }
9
+ /**
10
+ * Migrate a generic registry to raw registry type. This will change the registry type from GENERIC to RAW and delete all images associated with the registry.
11
+ */
12
+ export function useMigrateRegistryV3Mutation(options) {
13
+ return useMutation((mutateProps) => migrateRegistryV3(mutateProps), options);
14
+ }
@@ -181,6 +181,8 @@ export type { ListWebhookExecutionsErrorResponse, ListWebhookExecutionsOkRespons
181
181
  export { listWebhookExecutions, useListWebhookExecutionsQuery, } from './hooks/useListWebhookExecutionsQuery';
182
182
  export type { ListWebhooksErrorResponse, ListWebhooksOkResponse, ListWebhooksProps, ListWebhooksQueryPathParams, ListWebhooksQueryQueryParams, } from './hooks/useListWebhooksQuery';
183
183
  export { listWebhooks, useListWebhooksQuery } from './hooks/useListWebhooksQuery';
184
+ export type { MigrateRegistryV3ErrorResponse, MigrateRegistryV3MutationPathParams, MigrateRegistryV3MutationQueryParams, MigrateRegistryV3OkResponse, MigrateRegistryV3Props, } from './hooks/useMigrateRegistryV3Mutation';
185
+ export { migrateRegistryV3, useMigrateRegistryV3Mutation, } from './hooks/useMigrateRegistryV3Mutation';
184
186
  export type { ModifyRegistryErrorResponse, ModifyRegistryMutationPathParams, ModifyRegistryOkResponse, ModifyRegistryProps, ModifyRegistryRequestBody, } from './hooks/useModifyRegistryMutation';
185
187
  export { modifyRegistry, useModifyRegistryMutation } from './hooks/useModifyRegistryMutation';
186
188
  export type { QuarantineFilePathErrorResponse, QuarantineFilePathMutationPathParams, QuarantineFilePathOkResponse, QuarantineFilePathProps, QuarantineFilePathRequestBody, } from './hooks/useQuarantineFilePathMutation';
@@ -466,7 +468,7 @@ export type { PageInfoV3 } from './schemas/PageInfoV3';
466
468
  export type { PolicyFailureDetailCategoryV3 } from './schemas/PolicyFailureDetailCategoryV3';
467
469
  export type { PolicyFailureDetailV3 } from './schemas/PolicyFailureDetailV3';
468
470
  export type { PolicySetFailureDetailV3 } from './schemas/PolicySetFailureDetailV3';
469
- export type { PolicySetsV3 } from './schemas/PolicySetsV3';
471
+ export type { PuppetArtifactDetailConfig } from './schemas/PuppetArtifactDetailConfig';
470
472
  export type { PythonArtifactDetailConfig } from './schemas/PythonArtifactDetailConfig';
471
473
  export type { QuarantinePath } from './schemas/QuarantinePath';
472
474
  export type { QuarantineRequest } from './schemas/QuarantineRequest';
@@ -89,6 +89,7 @@ export { listVersions, useListVersionsQuery } from './hooks/useListVersionsQuery
89
89
  export { listVersionsV3, useListVersionsV3Query } from './hooks/useListVersionsV3Query';
90
90
  export { listWebhookExecutions, useListWebhookExecutionsQuery, } from './hooks/useListWebhookExecutionsQuery';
91
91
  export { listWebhooks, useListWebhooksQuery } from './hooks/useListWebhooksQuery';
92
+ export { migrateRegistryV3, useMigrateRegistryV3Mutation, } from './hooks/useMigrateRegistryV3Mutation';
92
93
  export { modifyRegistry, useModifyRegistryMutation } from './hooks/useModifyRegistryMutation';
93
94
  export { quarantineFilePath, useQuarantineFilePathMutation, } from './hooks/useQuarantineFilePathMutation';
94
95
  export { reTriggerWebhookExecution, useReTriggerWebhookExecutionQuery, } from './hooks/useReTriggerWebhookExecutionQuery';
@@ -13,12 +13,13 @@ import type { CondaArtifactDetailConfig } from '../schemas/CondaArtifactDetailCo
13
13
  import type { DartArtifactDetailConfig } from '../schemas/DartArtifactDetailConfig';
14
14
  import type { ComposerArtifactDetailConfig } from '../schemas/ComposerArtifactDetailConfig';
15
15
  import type { SwiftArtifactDetailConfig } from '../schemas/SwiftArtifactDetailConfig';
16
+ import type { PuppetArtifactDetailConfig } from '../schemas/PuppetArtifactDetailConfig';
16
17
  import type { ArtifactType } from '../schemas/ArtifactType';
17
18
  import type { PackageType } from '../schemas/PackageType';
18
19
  /**
19
20
  * Artifact Detail
20
21
  */
21
- export type ArtifactDetail = (DockerArtifactDetailConfig | HelmArtifactDetailConfig | GenericArtifactDetailConfig | MavenArtifactDetailConfig | PythonArtifactDetailConfig | NpmArtifactDetailConfig | RpmArtifactDetailConfig | NugetArtifactDetailConfig | CargoArtifactDetailConfig | GoArtifactDetailConfig | HuggingFaceArtifactDetailConfig | CondaArtifactDetailConfig | DartArtifactDetailConfig | ComposerArtifactDetailConfig | SwiftArtifactDetailConfig) & {
22
+ export type ArtifactDetail = (DockerArtifactDetailConfig | HelmArtifactDetailConfig | GenericArtifactDetailConfig | MavenArtifactDetailConfig | PythonArtifactDetailConfig | NpmArtifactDetailConfig | RpmArtifactDetailConfig | NugetArtifactDetailConfig | CargoArtifactDetailConfig | GoArtifactDetailConfig | HuggingFaceArtifactDetailConfig | CondaArtifactDetailConfig | DartArtifactDetailConfig | ComposerArtifactDetailConfig | SwiftArtifactDetailConfig | PuppetArtifactDetailConfig) & {
22
23
  artifactType?: ArtifactType;
23
24
  createdAt?: string;
24
25
  createdBy?: string;
@@ -19,7 +19,7 @@ export interface ArtifactMetadata {
19
19
  */
20
20
  downloadsCount?: number;
21
21
  fileCount?: number;
22
- firewallMode?: 'ALLOW' | 'BLOCK' | 'WARN';
22
+ firewallMode?: 'ALLOW' | 'ENABLED' | 'QUARANTINE';
23
23
  isQuarantined?: boolean;
24
24
  labels?: string[];
25
25
  lastModified?: string;
@@ -29,6 +29,10 @@ export interface ArtifactMetadata {
29
29
  name: string;
30
30
  packageType: PackageType;
31
31
  pullCommand?: string;
32
+ /**
33
+ * Package URL (PURL) identifying the package version.
34
+ */
35
+ purl?: string;
32
36
  quarantineReason?: string;
33
37
  registryIdentifier: string;
34
38
  registryPath: string;
@@ -1,5 +1,5 @@
1
1
  import type { PackageTypeV3 } from '../schemas/PackageTypeV3';
2
- import type { PolicySetsV3 } from '../schemas/PolicySetsV3';
2
+ import type { PolicySetFailureDetailV3 } from '../schemas/PolicySetFailureDetailV3';
3
3
  export interface ArtifactScanV3 {
4
4
  id: string;
5
5
  lastEvaluatedAt?: string;
@@ -9,7 +9,11 @@ export interface ArtifactScanV3 {
9
9
  */
10
10
  packageName: string;
11
11
  packageType: PackageTypeV3;
12
- policySets: PolicySetsV3;
12
+ policySets: PolicySetFailureDetailV3[];
13
+ /**
14
+ * Package URL (PURL) identifying the package version
15
+ */
16
+ purl: string;
13
17
  /**
14
18
  * Registry name
15
19
  */
@@ -25,7 +25,7 @@ export interface ArtifactVersionMetadata {
25
25
  * @format int64
26
26
  */
27
27
  fileCount?: number;
28
- firewallMode?: 'ALLOW' | 'BLOCK' | 'WARN';
28
+ firewallMode?: 'ALLOW' | 'ENABLED' | 'QUARANTINE';
29
29
  isQuarantined?: boolean;
30
30
  lastModified?: string;
31
31
  lastScannedAt?: string;
@@ -10,7 +10,7 @@ export interface ArtifactVersionSummary {
10
10
  * Timestamp in milliseconds when the artifact was soft deleted. Null if not deleted.
11
11
  */
12
12
  deletedAt?: string;
13
- firewallMode?: 'ALLOW' | 'BLOCK' | 'WARN';
13
+ firewallMode?: 'ALLOW' | 'ENABLED' | 'QUARANTINE';
14
14
  imageName: string;
15
15
  isQuarantined?: boolean;
16
16
  lastScannedAt?: string;
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * Firewall mode
3
3
  */
4
- export type FirewallModeV3 = 'ALLOW' | 'BLOCK' | 'WARN';
4
+ export type FirewallModeV3 = 'ALLOW' | 'ENABLED' | 'QUARANTINE';
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * refers to package
3
3
  */
4
- export type PackageType = 'CARGO' | 'COMPOSER' | 'CONDA' | 'DART' | 'DOCKER' | 'GENERIC' | 'GO' | 'HELM' | 'HUGGINGFACE' | 'MAVEN' | 'NPM' | 'NUGET' | 'PYTHON' | 'RAW' | 'RPM' | 'SWIFT';
4
+ export type PackageType = 'CARGO' | 'COMPOSER' | 'CONDA' | 'DART' | 'DOCKER' | 'GENERIC' | 'GO' | 'HELM' | 'HUGGINGFACE' | 'MAVEN' | 'NPM' | 'NUGET' | 'PUPPET' | 'PYTHON' | 'RAW' | 'RPM' | 'SWIFT';
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT, RAW. This field is extensible; clients must handle unknown values.
2
+ * Package type. Known values include: DOCKER, MAVEN, PYTHON, GENERIC, HELM, NUGET, NPM, RPM, CARGO, COMPOSER, GO, HUGGINGFACE, CONDA, DART, SWIFT, PUPPET, RAW. This field is extensible; clients must handle unknown values.
3
3
  *
4
4
  * @example "DOCKER"
5
5
  */
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Config for puppet artifact details
3
+ */
4
+ export interface PuppetArtifactDetailConfig {
5
+ metadata?: {
6
+ [key: string]: any;
7
+ };
8
+ }
@@ -15,6 +15,6 @@ export interface UpstreamConfig {
15
15
  *
16
16
  */
17
17
  remoteUrlSuffix?: string;
18
- source?: 'Anaconda' | 'AwsEcr' | 'Crates' | 'Custom' | 'Dockerhub' | 'GoProxy' | 'HuggingFace' | 'MavenCentral' | 'NpmJs' | 'NugetOrg' | 'Packagist' | 'Pubdev' | 'PyPi';
18
+ source?: 'Anaconda' | 'AwsEcr' | 'Crates' | 'Custom' | 'Dockerhub' | 'GoProxy' | 'HuggingFace' | 'MavenCentral' | 'NpmJs' | 'NugetOrg' | 'Packagist' | 'Pubdev' | 'PuppetForge' | 'PyPi';
19
19
  url?: string;
20
20
  }
@@ -1,4 +1,4 @@
1
1
  /**
2
2
  * Firewall mode applied to an upstream proxy.
3
3
  */
4
- export type UpstreamProxyConfigFirewallMode = 'ALLOW' | 'BLOCK' | 'WARN';
4
+ export type UpstreamProxyConfigFirewallMode = 'ALLOW' | 'ENABLED' | 'QUARANTINE';
@@ -22,7 +22,7 @@ export interface VersionMetadata {
22
22
  */
23
23
  downloadsCount?: number;
24
24
  fileCount?: number;
25
- firewallMode?: 'ALLOW' | 'BLOCK' | 'WARN';
25
+ firewallMode?: 'ALLOW' | 'ENABLED' | 'QUARANTINE';
26
26
  isQuarantined?: boolean;
27
27
  lastModified: string;
28
28
  lastScannedAt?: string;
@@ -30,6 +30,10 @@ export interface VersionMetadata {
30
30
  package: string;
31
31
  packageType: PackageType;
32
32
  pullCommand?: string;
33
+ /**
34
+ * Package URL (PURL) for this artifact version when supported for the package type.
35
+ */
36
+ purl?: string;
33
37
  quarantineReason?: string;
34
38
  registryIdentifier: string;
35
39
  registryType?: RegistryType;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harnessio/react-har-service-client",
3
- "version": "0.53.0",
3
+ "version": "0.55.0",
4
4
  "description": "Harness HAR Service APIs integrated with react hooks",
5
5
  "author": "Harness Inc",
6
6
  "license": "MIT",
@@ -1,13 +0,0 @@
1
- /**
2
- * List of opa policy sets.
3
- */
4
- export type PolicySetsV3 = Array<{
5
- /**
6
- * Policy Set name
7
- */
8
- policySetName: string;
9
- /**
10
- * Unique reference for the opa policy set. Example: `my-policy` or `account.my-policy`
11
- */
12
- policySetRef: string;
13
- }>;