@harnessio/react-har-service-client 0.98.0 → 0.99.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 (87) hide show
  1. package/dist/har-service/src/services/hooks/useEdgeAuthorizeV3Mutation.d.ts +19 -0
  2. package/dist/har-service/src/services/hooks/useEdgeAuthorizeV3Mutation.js +16 -0
  3. package/dist/har-service/src/services/hooks/useEdgeResolveV3Mutation.d.ts +19 -0
  4. package/dist/har-service/src/services/hooks/useEdgeResolveV3Mutation.js +16 -0
  5. package/dist/har-service/src/services/hooks/useListNodeChildrenV3Query.d.ts +3 -2
  6. package/dist/har-service/src/services/hooks/useListNodeChildrenV3Query.js +3 -2
  7. package/dist/har-service/src/services/hooks/useListRegistryNodesV3Query.d.ts +2 -2
  8. package/dist/har-service/src/services/hooks/useListRegistryNodesV3Query.js +2 -2
  9. package/dist/har-service/src/services/hooks/useListTreeRootsV3Query.d.ts +4 -7
  10. package/dist/har-service/src/services/hooks/useListTreeRootsV3Query.js +4 -7
  11. package/dist/har-service/src/services/hooks/useResolveTreePathV3Query.d.ts +48 -0
  12. package/dist/har-service/src/services/hooks/useResolveTreePathV3Query.js +28 -0
  13. package/dist/har-service/src/services/hooks/useSearchTreeV3Query.d.ts +49 -0
  14. package/dist/har-service/src/services/hooks/useSearchTreeV3Query.js +27 -0
  15. package/dist/har-service/src/services/hooks/useTriggerSemverBackfillV3Mutation.d.ts +19 -0
  16. package/dist/har-service/src/services/hooks/useTriggerSemverBackfillV3Mutation.js +17 -0
  17. package/dist/har-service/src/services/hooks/useUpsertAutoMetadataV3Mutation.d.ts +24 -0
  18. package/dist/har-service/src/services/hooks/useUpsertAutoMetadataV3Mutation.js +17 -0
  19. package/dist/har-service/src/services/index.d.ts +38 -0
  20. package/dist/har-service/src/services/index.js +6 -0
  21. package/dist/har-service/src/services/requestBodies/AutoMetadataRequestV3RequestBody.d.ts +2 -0
  22. package/dist/har-service/src/services/requestBodies/AutoMetadataRequestV3RequestBody.js +1 -0
  23. package/dist/har-service/src/services/responses/SearchTreeResponseV3Response.d.ts +2 -0
  24. package/dist/har-service/src/services/responses/SearchTreeResponseV3Response.js +1 -0
  25. package/dist/har-service/src/services/responses/TreeResolveResponseV3Response.d.ts +2 -0
  26. package/dist/har-service/src/services/responses/TreeResolveResponseV3Response.js +1 -0
  27. package/dist/har-service/src/services/schemas/AutoMetadataRequestInputV3.d.ts +38 -0
  28. package/dist/har-service/src/services/schemas/AutoMetadataRequestInputV3.js +1 -0
  29. package/dist/har-service/src/services/schemas/BackfillTriggerRequestInputV3.d.ts +7 -0
  30. package/dist/har-service/src/services/schemas/EdgeAuthorizeRequestV3.d.ts +9 -0
  31. package/dist/har-service/src/services/schemas/EdgeAuthorizeRequestV3.js +4 -0
  32. package/dist/har-service/src/services/schemas/EdgeAuthorizeResponseV3.d.ts +12 -0
  33. package/dist/har-service/src/services/schemas/EdgeAuthorizeResponseV3.js +1 -0
  34. package/dist/har-service/src/services/schemas/EdgeLocationV3.d.ts +5 -0
  35. package/dist/har-service/src/services/schemas/EdgeLocationV3.js +4 -0
  36. package/dist/har-service/src/services/schemas/EdgePrincipalV3.d.ts +4 -0
  37. package/dist/har-service/src/services/schemas/EdgePrincipalV3.js +4 -0
  38. package/dist/har-service/src/services/schemas/EdgeResolveRequestV3.d.ts +14 -0
  39. package/dist/har-service/src/services/schemas/EdgeResolveRequestV3.js +4 -0
  40. package/dist/har-service/src/services/schemas/EdgeResolveResponseV3.d.ts +28 -0
  41. package/dist/har-service/src/services/schemas/EdgeResolveResponseV3.js +1 -0
  42. package/dist/har-service/src/services/schemas/GenerateKeyRequestV3.d.ts +4 -12
  43. package/dist/har-service/src/services/schemas/GenerateKeyRequestV3.js +0 -3
  44. package/dist/har-service/src/services/schemas/ImportKeyRequestV3.d.ts +2 -6
  45. package/dist/har-service/src/services/schemas/ImportKeyRequestV3.js +0 -3
  46. package/dist/har-service/src/services/schemas/LifecycleRuleFilterConfigGenericV3.d.ts +2 -0
  47. package/dist/har-service/src/services/schemas/LifecycleRuleFilterConfigGenericV3.js +0 -3
  48. package/dist/har-service/src/services/schemas/LifecycleRuleFilterConfigMavenV3.d.ts +2 -0
  49. package/dist/har-service/src/services/schemas/LifecycleRuleFilterConfigMavenV3.js +0 -3
  50. package/dist/har-service/src/services/schemas/LifecycleRuleSemverOnlyV3.d.ts +5 -0
  51. package/dist/har-service/src/services/schemas/LifecycleRuleSemverOnlyV3.js +4 -0
  52. package/dist/har-service/src/services/schemas/SearchAncestorV3.d.ts +21 -0
  53. package/dist/har-service/src/services/schemas/SearchAncestorV3.js +4 -0
  54. package/dist/har-service/src/services/schemas/SearchFileItemV3.d.ts +46 -0
  55. package/dist/har-service/src/services/schemas/SearchFileItemV3.js +1 -0
  56. package/dist/har-service/src/services/schemas/SearchFilesGroupV3.d.ts +26 -0
  57. package/dist/har-service/src/services/schemas/SearchFilesGroupV3.js +1 -0
  58. package/dist/har-service/src/services/schemas/SearchPackageItemV3.d.ts +48 -0
  59. package/dist/har-service/src/services/schemas/SearchPackageItemV3.js +1 -0
  60. package/dist/har-service/src/services/schemas/SearchPackagesGroupV3.d.ts +26 -0
  61. package/dist/har-service/src/services/schemas/SearchPackagesGroupV3.js +1 -0
  62. package/dist/har-service/src/services/schemas/SearchRegistriesGroupV3.d.ts +26 -0
  63. package/dist/har-service/src/services/schemas/SearchRegistriesGroupV3.js +1 -0
  64. package/dist/har-service/src/services/schemas/SearchRegistryItemV3.d.ts +26 -0
  65. package/dist/har-service/src/services/schemas/SearchRegistryItemV3.js +4 -0
  66. package/dist/har-service/src/services/schemas/SearchTreeResponseBodyV3.d.ts +13 -0
  67. package/dist/har-service/src/services/schemas/SearchTreeResponseBodyV3.js +1 -0
  68. package/dist/har-service/src/services/schemas/SearchVersionItemV3.d.ts +70 -0
  69. package/dist/har-service/src/services/schemas/SearchVersionItemV3.js +1 -0
  70. package/dist/har-service/src/services/schemas/SearchVersionsGroupV3.d.ts +26 -0
  71. package/dist/har-service/src/services/schemas/SearchVersionsGroupV3.js +1 -0
  72. package/dist/har-service/src/services/schemas/SemverBackfillTriggerDataV3.d.ts +14 -0
  73. package/dist/har-service/src/services/schemas/SemverBackfillTriggerDataV3.js +4 -0
  74. package/dist/har-service/src/services/schemas/SigningKeyTypeV3.d.ts +6 -0
  75. package/dist/har-service/src/services/schemas/SigningKeyTypeV3.js +4 -0
  76. package/dist/har-service/src/services/schemas/SigningKeyV3.d.ts +2 -6
  77. package/dist/har-service/src/services/schemas/TreeEntityKindV3.d.ts +7 -0
  78. package/dist/har-service/src/services/schemas/TreeEntityKindV3.js +4 -0
  79. package/dist/har-service/src/services/schemas/TreeNodeItemV3.d.ts +42 -22
  80. package/dist/har-service/src/services/schemas/TreeNodeItemV3.js +0 -3
  81. package/dist/har-service/src/services/schemas/TreePaginationV3.d.ts +9 -13
  82. package/dist/har-service/src/services/schemas/TreePathStepV3.d.ts +29 -0
  83. package/dist/har-service/src/services/schemas/TreePathStepV3.js +1 -0
  84. package/dist/har-service/src/services/schemas/TreeResolveResponseBodyV3.d.ts +14 -0
  85. package/dist/har-service/src/services/schemas/TreeResolveResponseBodyV3.js +1 -0
  86. package/dist/har-service/src/services/schemas/TreeResponseBodyV3.d.ts +1 -1
  87. package/package.json +1 -1
@@ -0,0 +1,26 @@
1
+ import type { SearchVersionItemV3 } from '../schemas/SearchVersionItemV3';
2
+ /**
3
+ * The Versions group of a global grouped search result.
4
+ */
5
+ export interface SearchVersionsGroupV3 {
6
+ /**
7
+ * Count of versions matching the request, independent of pagination. Exact up to 1000;
8
+ * 1001 means "more than 1000" and should be rendered as "1000+".
9
+ *
10
+ * @format int64
11
+ */
12
+ count: number;
13
+ hasMore: boolean;
14
+ items: SearchVersionItemV3[];
15
+ /**
16
+ * Opaque cursor for this group's next page, to send as this group's cursor parameter. Present only when `hasMore` is true.
17
+ */
18
+ nextCursor?: string;
19
+ /**
20
+ * Present and true when this group's queries exceeded the server's time budget. The
21
+ * group is then served empty - `items` is `[]` and `count` is 0, which is not a real
22
+ * zero - while the other groups are returned as normal. Retry, or narrow the search.
23
+ *
24
+ */
25
+ timedOut?: boolean;
26
+ }
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Response payload returned when a semver backfill is successfully triggered.
3
+ */
4
+ export interface SemverBackfillTriggerDataV3 {
5
+ /**
6
+ * Numeric identifier of the CDC job row created for this backfill.
7
+ * @format int64
8
+ */
9
+ jobId: number;
10
+ /**
11
+ * Human-readable status message.
12
+ */
13
+ message: string;
14
+ }
@@ -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 {};
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Cryptographic system of a signing key. Known values include: GPG (for Debian, RPM, Alpine), RSA (for direct signing operations). This field is extensible; clients must handle unknown values.
3
+ *
4
+ * @example "GPG"
5
+ */
6
+ export type SigningKeyTypeV3 = string;
@@ -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 {};
@@ -3,6 +3,7 @@ import type { CreatedAtMsV3 } from '../schemas/CreatedAtMsV3';
3
3
  import type { UserInfoV3 } from '../schemas/UserInfoV3';
4
4
  import type { ModifiedAtMsV3 } from '../schemas/ModifiedAtMsV3';
5
5
  import type { SigningKeyStatusV3 } from '../schemas/SigningKeyStatusV3';
6
+ import type { SigningKeyTypeV3 } from '../schemas/SigningKeyTypeV3';
6
7
  /**
7
8
  * A signing key used for repository metadata signing (Debian, Alpine, etc.)
8
9
  */
@@ -47,11 +48,6 @@ export interface SigningKeyV3 {
47
48
  */
48
49
  source: 'GENERATED' | 'IMPORTED';
49
50
  status: SigningKeyStatusV3;
50
- /**
51
- * Cryptographic system of a signing key. Known values include: GPG (for Debian, RPM, Alpine), RSA (for direct signing operations). This field is extensible; clients must handle unknown values.
52
- *
53
- * @example "GPG"
54
- */
55
- type: string;
51
+ type: SigningKeyTypeV3;
56
52
  updatedBy?: UserInfoV3;
57
53
  }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * What a tree node or search hit is: a registry, a package or a version. Absent for plain
3
+ * folders and files. A Docker/Helm platform row is a `folder` whose entity is its own
4
+ * manifest's version.
5
+ *
6
+ */
7
+ export type TreeEntityKindV3 = 'PACKAGE' | 'REGISTRY' | 'VERSION';
@@ -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,54 +1,74 @@
1
+ import type { TreeEntityKindV3 } from '../schemas/TreeEntityKindV3';
1
2
  /**
2
3
  * A node in the tree view representing a registry, package, version, folder, or file
3
4
  */
4
5
  export interface TreeNodeItemV3 {
5
6
  /**
6
- * Creation timestamp in milliseconds
7
+ * Creation time in epoch milliseconds. Absent when unknown.
7
8
  * @format int64
8
9
  */
9
10
  createdAt?: number;
10
11
  /**
11
- * Deletion timestamp in milliseconds (if soft-deleted)
12
+ * Soft-deletion time in epoch milliseconds; absent when the node is live. This is the
13
+ * effective state: the node's own entity's, else its package's, else its registry's, so
14
+ * a file under a deleted version reads as deleted. Plain folders and files that belong to
15
+ * no resolvable package carry their registry's state.
16
+ *
12
17
  * @format int64
13
18
  */
14
19
  deletedAt?: number;
15
20
  /**
16
- * Whether this node has child nodes
21
+ * UUID of the registry, package or version this node is; present exactly when
22
+ * `entityKind` is. Pass it to the matching details API (`/registries/{id}/metadata`,
23
+ * `/packages/{id}/metadata`, `/versions/{id}/metadata`).
24
+ *
25
+ * @format uuid
17
26
  */
18
- hasChildren: boolean;
27
+ entityId?: string;
28
+ entityKind?: TreeEntityKindV3;
19
29
  /**
20
- * Unique identifier (UUID for nodes, registry_id for root registries)
30
+ * Whether expanding this node returns at least one child.
21
31
  */
22
- id: string;
32
+ hasChildren: boolean;
23
33
  /**
24
- * Whether this node is soft-deleted. Tree levels below the root return both active and
25
- * soft-deleted nodes, so clients must use this flag to render deleted state rather than
26
- * assuming every returned node is live.
27
- *
28
- * Omitted when soft-delete state cannot be determined for the node's level: the version
29
- * and platform levels of OCI (Docker/Helm) registries come from
30
- * `tags`/`manifests`/`manifest_references`, none of which have a soft-delete column,
31
- * and all nodes of non-OCI registries come from `nodes`, whose `node_deleted_at` column
32
- * is not populated by any write path. Only the root (`registries`) and Docker/Helm
33
- * package (`images`) levels can answer this. An omitted value means "unknown" - it must
34
- * not be read as "not deleted".
34
+ * Identifier to expand this node with. The registry UUID for a registry (pass it to
35
+ * `ListRegistryNodesV3`); otherwise pass it to `ListNodeChildrenV3`. Below the root it is
36
+ * a node UUID, or for Docker/Helm registries a synthetic `<kind>:<registryUUID>:<innerId>`
37
+ * id - hence a plain string rather than a UUID. Treat it as opaque.
35
38
  *
36
39
  */
37
- isDeleted?: boolean;
40
+ id: string;
38
41
  /**
39
- * Display name of the node
42
+ * Display name. A collapsed `compact` row joins its segments with `/`; the Docker/Helm
43
+ * untagged group reads `Untagged (n)`, with n shown as `1000+` past 1000.
44
+ *
40
45
  */
41
46
  name: string;
42
47
  /**
43
- * Package type (for registries/packages)
48
+ * Package type of the registry this node belongs to. Set on every level.
44
49
  */
45
50
  packageType?: string;
46
51
  /**
47
- * Full path to this node
52
+ * Display path of this node within its registry; the registry name for a registry.
53
+ * For display only - do not split it to derive ancestor ids.
54
+ *
48
55
  */
49
56
  path?: string;
50
57
  /**
51
- * Type of the node
58
+ * Canonical, readable address of this node: put it in a shareable URL and pass it as `path`
59
+ * to `ResolveTreePathV3` to get the node's ids back. Unlike `path`, it is unique and stable across responses. Absent when
60
+ * the node cannot be addressed by path (a platform below a nested Docker/Helm manifest
61
+ * list).
62
+ *
63
+ */
64
+ treePath?: string;
65
+ /**
66
+ * Type of the node. Docker/Helm registries expose `package` (image), `version` (tag or
67
+ * untagged manifest) and `folder` (the untagged group and per-platform manifests). Other
68
+ * package types expose `package` and `version` for folders that are one, and `folder`
69
+ * and `file` otherwise; Debian, CRAN, Conan, Wolfi and HELM_HTTP expose only `folder`
70
+ * and `file`.
71
+ *
52
72
  */
53
73
  type: 'file' | 'folder' | 'package' | 'registry' | 'version';
54
74
  }
@@ -1,4 +1 @@
1
- /* eslint-disable */
2
- // This code is autogenerated using @harnessio/oats-cli.
3
- // Please do not modify this code directly.
4
1
  export {};
@@ -3,31 +3,27 @@
3
3
  */
4
4
  export interface TreePaginationV3 {
5
5
  /**
6
- * Whether there are more pages
6
+ * Whether another page exists.
7
7
  */
8
8
  hasMore: boolean;
9
9
  /**
10
- * Cursor for next page (base64 encoded)
10
+ * Opaque cursor for the next page, to send as `cursor`. Present only when `hasMore` is true.
11
11
  */
12
12
  nextCursor?: string;
13
13
  /**
14
- * Page size
14
+ * The page size applied to this request.
15
15
  * @format int32
16
16
  */
17
17
  size: number;
18
18
  /**
19
- * Total number of items matching the request across all pages, independent of
20
- * pagination.
19
+ * Total number of children matching the request, independent of pagination.
21
20
  *
22
- * Exact at the root (registry) level, where the filtered set is small enough to
23
- * count cheaply. Below the root it is **capped** (currently at 1000): child fanout
24
- * is unbounded, and an exact count of a wide parent is far more expensive than the
25
- * page itself. A value at the cap means "at least this many", not necessarily
26
- * exact - use `hasMore` to drive "Load More" rather than comparing against `total`.
21
+ * * Root (`ListTreeRootsV3`): exact, and returned **on the first page only** - it is
22
+ * absent when a `cursor` is sent, so keep the first page's value.
23
+ * * Below the root: returned on every page, exact up to 1000. Any value above 1000
24
+ * means "more than 1000" and should be rendered as "1000+".
27
25
  *
28
- * Optional, and **absent on root-level pages fetched with a `cursor`**: the total
29
- * does not change while paging through a fixed filter set, so it is computed once on
30
- * the first page and the client is expected to hold it across Load More.
26
+ * Drive "Load More" from `hasMore`, not from `total`.
31
27
  *
32
28
  * @format int64
33
29
  */
@@ -0,0 +1,29 @@
1
+ import type { TreeEntityKindV3 } from '../schemas/TreeEntityKindV3';
2
+ /**
3
+ * One node along a resolved path. `id` matches the row's `id` in the tree listings, so the
4
+ * client can find and expand it. Steps are never collapsed: with `compact=true` a listed row
5
+ * stands for every step from its first folder to its last, and its `id` is the last one's.
6
+ *
7
+ */
8
+ export interface TreePathStepV3 {
9
+ /**
10
+ * UUID of the registry, package or version this node is, as for `TreeNodeItemV3`. Use it
11
+ * for the details APIs; a file's details take its `id`.
12
+ *
13
+ * @format uuid
14
+ */
15
+ entityId?: string;
16
+ entityKind?: TreeEntityKindV3;
17
+ /**
18
+ * The node's tree id: a registry UUID, a node UUID, or an opaque Docker/Helm id that is
19
+ * only meaningful to the tree endpoints.
20
+ *
21
+ */
22
+ id: string;
23
+ name: string;
24
+ treePath: string;
25
+ /**
26
+ * The node's type, as `TreeNodeItemV3.type` reports it.
27
+ */
28
+ type: 'file' | 'folder' | 'package' | 'registry' | 'version';
29
+ }
@@ -0,0 +1,14 @@
1
+ import type { TreeResponseBodyV3 } from '../schemas/TreeResponseBodyV3';
2
+ import type { TreePathStepV3 } from '../schemas/TreePathStepV3';
3
+ /**
4
+ * Response body for `ResolveTreePathV3`
5
+ */
6
+ export interface TreeResolveResponseBodyV3 {
7
+ children: TreeResponseBodyV3;
8
+ /**
9
+ * Every node along the path, registry first, as the tree listings return them. The last
10
+ * step is the requested node; the others are its ancestors.
11
+ *
12
+ */
13
+ steps: TreePathStepV3[];
14
+ }
@@ -5,7 +5,7 @@ import type { TreePaginationV3 } from '../schemas/TreePaginationV3';
5
5
  */
6
6
  export interface TreeResponseBodyV3 {
7
7
  /**
8
- * List of tree nodes
8
+ * Immediate children of the requested level, in display order.
9
9
  */
10
10
  items: TreeNodeItemV3[];
11
11
  pagination: TreePaginationV3;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@harnessio/react-har-service-client",
3
- "version": "0.98.0",
3
+ "version": "0.99.0",
4
4
  "description": "Harness HAR Service APIs integrated with react hooks",
5
5
  "author": "Harness Inc",
6
6
  "license": "MIT",