@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.
- package/dist/har-service/src/services/hooks/useEdgeAuthorizeV3Mutation.d.ts +19 -0
- package/dist/har-service/src/services/hooks/useEdgeAuthorizeV3Mutation.js +16 -0
- package/dist/har-service/src/services/hooks/useEdgeResolveV3Mutation.d.ts +19 -0
- package/dist/har-service/src/services/hooks/useEdgeResolveV3Mutation.js +16 -0
- package/dist/har-service/src/services/hooks/useListNodeChildrenV3Query.d.ts +3 -2
- package/dist/har-service/src/services/hooks/useListNodeChildrenV3Query.js +3 -2
- package/dist/har-service/src/services/hooks/useListRegistryNodesV3Query.d.ts +2 -2
- package/dist/har-service/src/services/hooks/useListRegistryNodesV3Query.js +2 -2
- package/dist/har-service/src/services/hooks/useListTreeRootsV3Query.d.ts +4 -7
- package/dist/har-service/src/services/hooks/useListTreeRootsV3Query.js +4 -7
- package/dist/har-service/src/services/hooks/useResolveTreePathV3Query.d.ts +48 -0
- package/dist/har-service/src/services/hooks/useResolveTreePathV3Query.js +28 -0
- package/dist/har-service/src/services/hooks/useSearchTreeV3Query.d.ts +49 -0
- package/dist/har-service/src/services/hooks/useSearchTreeV3Query.js +27 -0
- package/dist/har-service/src/services/hooks/useTriggerSemverBackfillV3Mutation.d.ts +19 -0
- package/dist/har-service/src/services/hooks/useTriggerSemverBackfillV3Mutation.js +17 -0
- package/dist/har-service/src/services/hooks/useUpsertAutoMetadataV3Mutation.d.ts +24 -0
- package/dist/har-service/src/services/hooks/useUpsertAutoMetadataV3Mutation.js +17 -0
- package/dist/har-service/src/services/index.d.ts +38 -0
- package/dist/har-service/src/services/index.js +6 -0
- package/dist/har-service/src/services/requestBodies/AutoMetadataRequestV3RequestBody.d.ts +2 -0
- package/dist/har-service/src/services/requestBodies/AutoMetadataRequestV3RequestBody.js +1 -0
- package/dist/har-service/src/services/responses/SearchTreeResponseV3Response.d.ts +2 -0
- package/dist/har-service/src/services/responses/SearchTreeResponseV3Response.js +1 -0
- package/dist/har-service/src/services/responses/TreeResolveResponseV3Response.d.ts +2 -0
- package/dist/har-service/src/services/responses/TreeResolveResponseV3Response.js +1 -0
- package/dist/har-service/src/services/schemas/AutoMetadataRequestInputV3.d.ts +38 -0
- package/dist/har-service/src/services/schemas/AutoMetadataRequestInputV3.js +1 -0
- package/dist/har-service/src/services/schemas/BackfillTriggerRequestInputV3.d.ts +7 -0
- package/dist/har-service/src/services/schemas/EdgeAuthorizeRequestV3.d.ts +9 -0
- package/dist/har-service/src/services/schemas/EdgeAuthorizeRequestV3.js +4 -0
- package/dist/har-service/src/services/schemas/EdgeAuthorizeResponseV3.d.ts +12 -0
- package/dist/har-service/src/services/schemas/EdgeAuthorizeResponseV3.js +1 -0
- package/dist/har-service/src/services/schemas/EdgeLocationV3.d.ts +5 -0
- package/dist/har-service/src/services/schemas/EdgeLocationV3.js +4 -0
- package/dist/har-service/src/services/schemas/EdgePrincipalV3.d.ts +4 -0
- package/dist/har-service/src/services/schemas/EdgePrincipalV3.js +4 -0
- package/dist/har-service/src/services/schemas/EdgeResolveRequestV3.d.ts +14 -0
- package/dist/har-service/src/services/schemas/EdgeResolveRequestV3.js +4 -0
- package/dist/har-service/src/services/schemas/EdgeResolveResponseV3.d.ts +28 -0
- package/dist/har-service/src/services/schemas/EdgeResolveResponseV3.js +1 -0
- package/dist/har-service/src/services/schemas/GenerateKeyRequestV3.d.ts +4 -12
- package/dist/har-service/src/services/schemas/GenerateKeyRequestV3.js +0 -3
- package/dist/har-service/src/services/schemas/ImportKeyRequestV3.d.ts +2 -6
- package/dist/har-service/src/services/schemas/ImportKeyRequestV3.js +0 -3
- package/dist/har-service/src/services/schemas/LifecycleRuleFilterConfigGenericV3.d.ts +2 -0
- package/dist/har-service/src/services/schemas/LifecycleRuleFilterConfigGenericV3.js +0 -3
- package/dist/har-service/src/services/schemas/LifecycleRuleFilterConfigMavenV3.d.ts +2 -0
- package/dist/har-service/src/services/schemas/LifecycleRuleFilterConfigMavenV3.js +0 -3
- package/dist/har-service/src/services/schemas/LifecycleRuleSemverOnlyV3.d.ts +5 -0
- package/dist/har-service/src/services/schemas/LifecycleRuleSemverOnlyV3.js +4 -0
- package/dist/har-service/src/services/schemas/SearchAncestorV3.d.ts +21 -0
- package/dist/har-service/src/services/schemas/SearchAncestorV3.js +4 -0
- package/dist/har-service/src/services/schemas/SearchFileItemV3.d.ts +46 -0
- package/dist/har-service/src/services/schemas/SearchFileItemV3.js +1 -0
- package/dist/har-service/src/services/schemas/SearchFilesGroupV3.d.ts +26 -0
- package/dist/har-service/src/services/schemas/SearchFilesGroupV3.js +1 -0
- package/dist/har-service/src/services/schemas/SearchPackageItemV3.d.ts +48 -0
- package/dist/har-service/src/services/schemas/SearchPackageItemV3.js +1 -0
- package/dist/har-service/src/services/schemas/SearchPackagesGroupV3.d.ts +26 -0
- package/dist/har-service/src/services/schemas/SearchPackagesGroupV3.js +1 -0
- package/dist/har-service/src/services/schemas/SearchRegistriesGroupV3.d.ts +26 -0
- package/dist/har-service/src/services/schemas/SearchRegistriesGroupV3.js +1 -0
- package/dist/har-service/src/services/schemas/SearchRegistryItemV3.d.ts +26 -0
- package/dist/har-service/src/services/schemas/SearchRegistryItemV3.js +4 -0
- package/dist/har-service/src/services/schemas/SearchTreeResponseBodyV3.d.ts +13 -0
- package/dist/har-service/src/services/schemas/SearchTreeResponseBodyV3.js +1 -0
- package/dist/har-service/src/services/schemas/SearchVersionItemV3.d.ts +70 -0
- package/dist/har-service/src/services/schemas/SearchVersionItemV3.js +1 -0
- package/dist/har-service/src/services/schemas/SearchVersionsGroupV3.d.ts +26 -0
- package/dist/har-service/src/services/schemas/SearchVersionsGroupV3.js +1 -0
- package/dist/har-service/src/services/schemas/SemverBackfillTriggerDataV3.d.ts +14 -0
- package/dist/har-service/src/services/schemas/SemverBackfillTriggerDataV3.js +4 -0
- package/dist/har-service/src/services/schemas/SigningKeyTypeV3.d.ts +6 -0
- package/dist/har-service/src/services/schemas/SigningKeyTypeV3.js +4 -0
- package/dist/har-service/src/services/schemas/SigningKeyV3.d.ts +2 -6
- package/dist/har-service/src/services/schemas/TreeEntityKindV3.d.ts +7 -0
- package/dist/har-service/src/services/schemas/TreeEntityKindV3.js +4 -0
- package/dist/har-service/src/services/schemas/TreeNodeItemV3.d.ts +42 -22
- package/dist/har-service/src/services/schemas/TreeNodeItemV3.js +0 -3
- package/dist/har-service/src/services/schemas/TreePaginationV3.d.ts +9 -13
- package/dist/har-service/src/services/schemas/TreePathStepV3.d.ts +29 -0
- package/dist/har-service/src/services/schemas/TreePathStepV3.js +1 -0
- package/dist/har-service/src/services/schemas/TreeResolveResponseBodyV3.d.ts +14 -0
- package/dist/har-service/src/services/schemas/TreeResolveResponseBodyV3.js +1 -0
- package/dist/har-service/src/services/schemas/TreeResponseBodyV3.d.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { MetadataItemInputV3 } from '../schemas/MetadataItemInputV3';
|
|
2
|
+
/**
|
|
3
|
+
* System-generated (AUTO) metadata to upsert. The target is chosen from the
|
|
4
|
+
* fields that are set, matching the public metadata API:
|
|
5
|
+
*
|
|
6
|
+
* 1. `package` and `version` attach the metadata to that version.
|
|
7
|
+
* 2. `package` alone attaches it to the package.
|
|
8
|
+
* 3. Neither attaches it to the registry.
|
|
9
|
+
*
|
|
10
|
+
* Existing MANUAL metadata on the same target is left unchanged.
|
|
11
|
+
*
|
|
12
|
+
*/
|
|
13
|
+
export interface AutoMetadataRequestInputV3 {
|
|
14
|
+
/**
|
|
15
|
+
* Extra coordinates that disambiguate a version for package types that
|
|
16
|
+
* need them, such as Debian (`architecture`, `distribution`, `component`).
|
|
17
|
+
*
|
|
18
|
+
*/
|
|
19
|
+
artifactKeyFilters?: {
|
|
20
|
+
[key: string]: string;
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Metadata key-value pairs to upsert as AUTO metadata.
|
|
24
|
+
*/
|
|
25
|
+
metadata: MetadataItemInputV3[];
|
|
26
|
+
/**
|
|
27
|
+
* Package name. Required when `version` is set.
|
|
28
|
+
*/
|
|
29
|
+
package?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Name of the registry the metadata applies to.
|
|
32
|
+
*/
|
|
33
|
+
registryName: string;
|
|
34
|
+
/**
|
|
35
|
+
* Version name. Attaches the metadata to this version of `package`.
|
|
36
|
+
*/
|
|
37
|
+
version?: string;
|
|
38
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -6,6 +6,13 @@ export interface BackfillTriggerRequestInputV3 {
|
|
|
6
6
|
* Entity types to backfill into Elasticsearch.
|
|
7
7
|
*/
|
|
8
8
|
entityTypes: Array<'FILE' | 'PACKAGE' | 'PACKAGE_VERSION' | 'REGISTRY'>;
|
|
9
|
+
/**
|
|
10
|
+
* If true, once a full pass of an entity type completes, delete the Elasticsearch documents of the
|
|
11
|
+
* account that the pass did not re-index (rows that no longer exist in Postgres). Requires
|
|
12
|
+
* reindexAll=true, because only a pass that started from the beginning has seen every row.
|
|
13
|
+
*
|
|
14
|
+
*/
|
|
15
|
+
pruneOrphans?: boolean;
|
|
9
16
|
/**
|
|
10
17
|
* If true, reset progress and re-index all rows from the beginning.
|
|
11
18
|
*/
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { EdgePrincipalV3 } from '../schemas/EdgePrincipalV3';
|
|
2
|
+
export interface EdgeAuthorizeResponseV3 {
|
|
3
|
+
decision: 'allow' | 'deny';
|
|
4
|
+
ip_allowlist?: string[];
|
|
5
|
+
package_type?: string;
|
|
6
|
+
principal?: EdgePrincipalV3;
|
|
7
|
+
registry_type?: string;
|
|
8
|
+
registry_uuid?: string;
|
|
9
|
+
status: number;
|
|
10
|
+
ttl_seconds: number;
|
|
11
|
+
www_authenticate?: string;
|
|
12
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export interface EdgeResolveRequestV3 {
|
|
2
|
+
account_identifier: string;
|
|
3
|
+
/**
|
|
4
|
+
* Package type of the route, RAW or MAVEN. Defaults to RAW when empty.
|
|
5
|
+
*/
|
|
6
|
+
package_type?: string;
|
|
7
|
+
/**
|
|
8
|
+
* File path inside the registry, URL-decoded, without a leading slash: the part after /files/ for RAW
|
|
9
|
+
* and after /maven/ for MAVEN.
|
|
10
|
+
*
|
|
11
|
+
*/
|
|
12
|
+
path: string;
|
|
13
|
+
registry_identifier: string;
|
|
14
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { EdgeLocationV3 } from '../schemas/EdgeLocationV3';
|
|
2
|
+
export interface EdgeResolveResponseV3 {
|
|
3
|
+
action: 'deny' | 'not_found' | 'pass' | 'serve';
|
|
4
|
+
cache_tags?: string[];
|
|
5
|
+
/**
|
|
6
|
+
* Hex MD5 of the file, served as x-checksum-md5 when present.
|
|
7
|
+
*/
|
|
8
|
+
checksum_md5?: string;
|
|
9
|
+
/**
|
|
10
|
+
* Hex SHA-1 of the file, served as x-checksum-sha1 when present.
|
|
11
|
+
*/
|
|
12
|
+
checksum_sha1?: string;
|
|
13
|
+
/**
|
|
14
|
+
* Hex SHA-512 of the file, served as x-checksum-sha512 when present.
|
|
15
|
+
*/
|
|
16
|
+
checksum_sha512?: string;
|
|
17
|
+
content_disposition?: string;
|
|
18
|
+
content_type?: string;
|
|
19
|
+
digest?: string;
|
|
20
|
+
location?: EdgeLocationV3;
|
|
21
|
+
message?: string;
|
|
22
|
+
/**
|
|
23
|
+
* @format int64
|
|
24
|
+
*/
|
|
25
|
+
size?: number;
|
|
26
|
+
status: number;
|
|
27
|
+
ttl_seconds: number;
|
|
28
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import type { SigningKeyAlgorithmV3 } from '../schemas/SigningKeyAlgorithmV3';
|
|
2
|
+
import type { SigningKeyTypeV3 } from '../schemas/SigningKeyTypeV3';
|
|
1
3
|
/**
|
|
2
4
|
* Request to generate a new signing key.
|
|
3
5
|
*
|
|
@@ -22,12 +24,7 @@
|
|
|
22
24
|
*
|
|
23
25
|
*/
|
|
24
26
|
export interface GenerateKeyRequestV3 {
|
|
25
|
-
|
|
26
|
-
* Underlying cryptographic algorithm of a signing key. Known values include: RSA, ED25519, ECDSA. This field is extensible; clients must handle unknown values. Note that only RSA and ED25519 can be generated; ECDSA is only observed on imported keys.
|
|
27
|
-
*
|
|
28
|
-
* @example "RSA"
|
|
29
|
-
*/
|
|
30
|
-
algorithm: string;
|
|
27
|
+
algorithm: SigningKeyAlgorithmV3;
|
|
31
28
|
/**
|
|
32
29
|
* Optional expiration timestamp in Unix milliseconds
|
|
33
30
|
* @format int64
|
|
@@ -37,10 +34,5 @@ export interface GenerateKeyRequestV3 {
|
|
|
37
34
|
* Human-readable name for the key
|
|
38
35
|
*/
|
|
39
36
|
name: string;
|
|
40
|
-
|
|
41
|
-
* 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.
|
|
42
|
-
*
|
|
43
|
-
* @example "GPG"
|
|
44
|
-
*/
|
|
45
|
-
type: string;
|
|
37
|
+
type: SigningKeyTypeV3;
|
|
46
38
|
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { SigningKeyTypeV3 } from '../schemas/SigningKeyTypeV3';
|
|
1
2
|
/**
|
|
2
3
|
* Request to import an existing signing key from secret manager. `type` is the cryptographic system of the key being imported.
|
|
3
4
|
*
|
|
@@ -40,10 +41,5 @@ export interface ImportKeyRequestV3 {
|
|
|
40
41
|
* Space path for the private key secret (e.g., "accountId/orgId/projectId")
|
|
41
42
|
*/
|
|
42
43
|
privateKeySecretSpacePath: string;
|
|
43
|
-
|
|
44
|
-
* 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.
|
|
45
|
-
*
|
|
46
|
-
* @example "GPG"
|
|
47
|
-
*/
|
|
48
|
-
type: string;
|
|
44
|
+
type: SigningKeyTypeV3;
|
|
49
45
|
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LifecycleRuleSemverOnlyV3 } from '../schemas/LifecycleRuleSemverOnlyV3';
|
|
1
2
|
/**
|
|
2
3
|
* Filter configuration for package types that support only name and version filtering: PYTHON, HELM, NPM, NUGET, RPM, CARGO, COMPOSER, GO, CONDA, DART, SWIFT, PUPPET, RUBY, RAW, GENERIC.
|
|
3
4
|
*
|
|
@@ -12,6 +13,7 @@ export interface LifecycleRuleFilterConfigGenericV3 {
|
|
|
12
13
|
*
|
|
13
14
|
*/
|
|
14
15
|
packageType: string;
|
|
16
|
+
semverOnly?: LifecycleRuleSemverOnlyV3;
|
|
15
17
|
/**
|
|
16
18
|
* Glob patterns for version strings to include.
|
|
17
19
|
*/
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { LifecycleRuleSemverOnlyV3 } from '../schemas/LifecycleRuleSemverOnlyV3';
|
|
1
2
|
/**
|
|
2
3
|
* Filter configuration for MAVEN package type.
|
|
3
4
|
*/
|
|
@@ -11,6 +12,7 @@ export interface LifecycleRuleFilterConfigMavenV3 {
|
|
|
11
12
|
*/
|
|
12
13
|
packageNameAllowedPattern?: string[];
|
|
13
14
|
packageType: 'MAVEN';
|
|
15
|
+
semverOnly?: LifecycleRuleSemverOnlyV3;
|
|
14
16
|
/**
|
|
15
17
|
* Glob patterns for version strings to include (e.g. "*-SNAPSHOT").
|
|
16
18
|
*/
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* When true, the rule only considers versions that parse as semantic versions (e.g. "1.2.3", "v2.0.0-rc.1"); all other versions are ignored by the rule and are never deleted by it. KEEP_LAST_N criteria then keep the N highest semantic versions instead of the N most recently uploaded; AGE_BASED and UNUSED_FOR criteria apply unchanged to the semver versions only. Supported only on DELETE (cleanup) rules; rejected on PROTECT rules.
|
|
3
|
+
*
|
|
4
|
+
*/
|
|
5
|
+
export type LifecycleRuleSemverOnlyV3 = boolean;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One crumb of a search hit's breadcrumb. Use these rather than splitting a `path`
|
|
3
|
+
* string, which cannot be split reliably (a package name may itself contain `/`).
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export interface SearchAncestorV3 {
|
|
7
|
+
/**
|
|
8
|
+
* Registry UUID when `type` is `registry`, otherwise the node UUID.
|
|
9
|
+
*/
|
|
10
|
+
id: string;
|
|
11
|
+
/**
|
|
12
|
+
* Display name of this crumb.
|
|
13
|
+
*/
|
|
14
|
+
name: string;
|
|
15
|
+
/**
|
|
16
|
+
* Which listing call expands this crumb's `id`: `registry` means
|
|
17
|
+
* `ListRegistryNodesV3`, `folder` means `ListNodeChildrenV3`.
|
|
18
|
+
*
|
|
19
|
+
*/
|
|
20
|
+
type: 'folder' | 'registry';
|
|
21
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { SearchAncestorV3 } from '../schemas/SearchAncestorV3';
|
|
2
|
+
import type { TreeEntityKindV3 } from '../schemas/TreeEntityKindV3';
|
|
3
|
+
/**
|
|
4
|
+
* One row of the Files group - files and folders alike. Always navigable.
|
|
5
|
+
*
|
|
6
|
+
*/
|
|
7
|
+
export interface SearchFileItemV3 {
|
|
8
|
+
/**
|
|
9
|
+
* Breadcrumb from the registry root down to this hit's immediate parent, shallowest
|
|
10
|
+
* first. Always starts with the registry, so a node directly under the registry root
|
|
11
|
+
* has exactly one entry.
|
|
12
|
+
*
|
|
13
|
+
*/
|
|
14
|
+
ancestors: SearchAncestorV3[];
|
|
15
|
+
/**
|
|
16
|
+
* Effective soft-deletion time in epoch milliseconds, as on `TreeNodeItemV3`; absent
|
|
17
|
+
* when live.
|
|
18
|
+
*
|
|
19
|
+
* @format int64
|
|
20
|
+
*/
|
|
21
|
+
deletedAt?: number;
|
|
22
|
+
/**
|
|
23
|
+
* UUID of the package or version this folder is; present exactly when `entityKind` is.
|
|
24
|
+
* Absent for files and plain folders.
|
|
25
|
+
*
|
|
26
|
+
* @format uuid
|
|
27
|
+
*/
|
|
28
|
+
entityId?: string;
|
|
29
|
+
entityKind?: TreeEntityKindV3;
|
|
30
|
+
/**
|
|
31
|
+
* Node UUID; expand a folder with `ListNodeChildrenV3`.
|
|
32
|
+
* @format uuid
|
|
33
|
+
*/
|
|
34
|
+
id: string;
|
|
35
|
+
isFile: boolean;
|
|
36
|
+
name: string;
|
|
37
|
+
/**
|
|
38
|
+
* Full path of this node within its registry.
|
|
39
|
+
*/
|
|
40
|
+
path: string;
|
|
41
|
+
/**
|
|
42
|
+
* @format uuid
|
|
43
|
+
*/
|
|
44
|
+
registryId: string;
|
|
45
|
+
registryName: string;
|
|
46
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type { SearchFileItemV3 } from '../schemas/SearchFileItemV3';
|
|
2
|
+
/**
|
|
3
|
+
* The Files group of a global grouped search result.
|
|
4
|
+
*/
|
|
5
|
+
export interface SearchFilesGroupV3 {
|
|
6
|
+
/**
|
|
7
|
+
* Count of files/folders 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: SearchFileItemV3[];
|
|
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 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import type { SearchAncestorV3 } from '../schemas/SearchAncestorV3';
|
|
2
|
+
/**
|
|
3
|
+
* One row of the Packages group. Covers every package type, not only Docker/Helm.
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export interface SearchPackageItemV3 {
|
|
7
|
+
/**
|
|
8
|
+
* Breadcrumb from the registry root down to this package's immediate parent, shallowest
|
|
9
|
+
* first. Present exactly when `nodeId` is.
|
|
10
|
+
*
|
|
11
|
+
*/
|
|
12
|
+
ancestors?: SearchAncestorV3[];
|
|
13
|
+
/**
|
|
14
|
+
* Soft-deletion time in epoch milliseconds; absent when the package is live. Only present
|
|
15
|
+
* when the request's `deleted_filter` is `include_deleted` or `only_deleted`.
|
|
16
|
+
*
|
|
17
|
+
* @format int64
|
|
18
|
+
*/
|
|
19
|
+
deletedAt?: number;
|
|
20
|
+
/**
|
|
21
|
+
* Package UUID.
|
|
22
|
+
* @format uuid
|
|
23
|
+
*/
|
|
24
|
+
id: string;
|
|
25
|
+
name: string;
|
|
26
|
+
/**
|
|
27
|
+
* Tree node of this package, to reveal the hit in the tree; expand it with
|
|
28
|
+
* `ListNodeChildrenV3`. Same format as `TreeNodeItemV3.id` - for Docker/Helm the
|
|
29
|
+
* synthetic `image:<registryUUID>:<packageUUID>` - hence a plain string.
|
|
30
|
+
*
|
|
31
|
+
* **Absent means the hit is not navigable; still render it**, as a non-navigable
|
|
32
|
+
* result. This is a normal state: e.g. an UPSTREAM proxy package whose files were never
|
|
33
|
+
* cached, HELM_HTTP and CRAN (no package folder in their layout), or a best-effort
|
|
34
|
+
* location lookup that did not complete.
|
|
35
|
+
*
|
|
36
|
+
*/
|
|
37
|
+
nodeId?: string;
|
|
38
|
+
/**
|
|
39
|
+
* Absent for package types that don't record one.
|
|
40
|
+
*/
|
|
41
|
+
packageKind?: string;
|
|
42
|
+
packageType: string;
|
|
43
|
+
/**
|
|
44
|
+
* @format uuid
|
|
45
|
+
*/
|
|
46
|
+
registryId: string;
|
|
47
|
+
registryName: string;
|
|
48
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type { SearchPackageItemV3 } from '../schemas/SearchPackageItemV3';
|
|
2
|
+
/**
|
|
3
|
+
* The Packages group of a global grouped search result.
|
|
4
|
+
*/
|
|
5
|
+
export interface SearchPackagesGroupV3 {
|
|
6
|
+
/**
|
|
7
|
+
* Count of packages 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: SearchPackageItemV3[];
|
|
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 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type { SearchRegistryItemV3 } from '../schemas/SearchRegistryItemV3';
|
|
2
|
+
/**
|
|
3
|
+
* The Registries group of a global grouped search result.
|
|
4
|
+
*/
|
|
5
|
+
export interface SearchRegistriesGroupV3 {
|
|
6
|
+
/**
|
|
7
|
+
* Count of registries 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: SearchRegistryItemV3[];
|
|
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 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* One row of the Registries group.
|
|
3
|
+
*/
|
|
4
|
+
export interface SearchRegistryItemV3 {
|
|
5
|
+
/**
|
|
6
|
+
* Soft-deletion time in epoch milliseconds; absent when the registry is live. Only present
|
|
7
|
+
* when the request's `deleted_filter` is `include_deleted` or `only_deleted`.
|
|
8
|
+
*
|
|
9
|
+
* @format int64
|
|
10
|
+
*/
|
|
11
|
+
deletedAt?: number;
|
|
12
|
+
/**
|
|
13
|
+
* Registry UUID; expand it with `ListRegistryNodesV3`.
|
|
14
|
+
* @format uuid
|
|
15
|
+
*/
|
|
16
|
+
id: string;
|
|
17
|
+
name: string;
|
|
18
|
+
packageType: string;
|
|
19
|
+
registryType: string;
|
|
20
|
+
/**
|
|
21
|
+
* Path of the space that owns the registry (e.g. `account/org/project`), which tells
|
|
22
|
+
* same-named registries in different spaces apart. Absent if it could not be resolved.
|
|
23
|
+
*
|
|
24
|
+
*/
|
|
25
|
+
spacePath?: string;
|
|
26
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { SearchFilesGroupV3 } from '../schemas/SearchFilesGroupV3';
|
|
2
|
+
import type { SearchPackagesGroupV3 } from '../schemas/SearchPackagesGroupV3';
|
|
3
|
+
import type { SearchRegistriesGroupV3 } from '../schemas/SearchRegistriesGroupV3';
|
|
4
|
+
import type { SearchVersionsGroupV3 } from '../schemas/SearchVersionsGroupV3';
|
|
5
|
+
/**
|
|
6
|
+
* Response body for the global grouped tree search endpoint.
|
|
7
|
+
*/
|
|
8
|
+
export interface SearchTreeResponseBodyV3 {
|
|
9
|
+
files: SearchFilesGroupV3;
|
|
10
|
+
packages: SearchPackagesGroupV3;
|
|
11
|
+
registries: SearchRegistriesGroupV3;
|
|
12
|
+
versions: SearchVersionsGroupV3;
|
|
13
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import type { SearchAncestorV3 } from '../schemas/SearchAncestorV3';
|
|
2
|
+
/**
|
|
3
|
+
* One row of the Versions group. Docker and Helm versions match on their tag names only - a
|
|
4
|
+
* digest is not searchable here - and every other package type matches on the version name.
|
|
5
|
+
* One row per version, not per tag: an OCI digest carrying several tags is a single row
|
|
6
|
+
* listing them all in `tags`.
|
|
7
|
+
*
|
|
8
|
+
*/
|
|
9
|
+
export interface SearchVersionItemV3 {
|
|
10
|
+
/**
|
|
11
|
+
* Breadcrumb from the registry root down to this version's immediate parent, shallowest
|
|
12
|
+
* first. Present exactly when `nodeId` is.
|
|
13
|
+
*
|
|
14
|
+
*/
|
|
15
|
+
ancestors?: SearchAncestorV3[];
|
|
16
|
+
/**
|
|
17
|
+
* Soft-deletion time in epoch milliseconds; absent when the version is live. Only present
|
|
18
|
+
* when the request's `deleted_filter` is `include_deleted` or `only_deleted`.
|
|
19
|
+
*
|
|
20
|
+
* @format int64
|
|
21
|
+
*/
|
|
22
|
+
deletedAt?: number;
|
|
23
|
+
/**
|
|
24
|
+
* Version UUID.
|
|
25
|
+
* @format uuid
|
|
26
|
+
*/
|
|
27
|
+
id: string;
|
|
28
|
+
/**
|
|
29
|
+
* The stored version. For Docker and Helm this is the manifest digest in an internal
|
|
30
|
+
* `<2-digit algorithm prefix><hex>` form, not `sha256:...` - display `tags` instead
|
|
31
|
+
* when present.
|
|
32
|
+
*
|
|
33
|
+
*/
|
|
34
|
+
name: string;
|
|
35
|
+
/**
|
|
36
|
+
* Tree node of this version, to reveal the hit in the tree. Same format as
|
|
37
|
+
* `TreeNodeItemV3.id`, hence a plain string. For HELM_HTTP and CRAN, which have no
|
|
38
|
+
* version folder, it is the version's archive *file* node; reveal it by expanding
|
|
39
|
+
* `ancestors`. For Docker and Helm it is the tag node (`tag:<registryId>:<tagId>`) of
|
|
40
|
+
* a tag whose name matches the term, else the first tag by name.
|
|
41
|
+
*
|
|
42
|
+
* **Absent means the hit is not navigable; still render it**, as a non-navigable
|
|
43
|
+
* result. Absent for Docker and Helm digests that carry no tag; otherwise for e.g. an
|
|
44
|
+
* UPSTREAM proxy version whose files were never cached, or a best-effort location
|
|
45
|
+
* lookup that did not complete.
|
|
46
|
+
*
|
|
47
|
+
*/
|
|
48
|
+
nodeId?: string;
|
|
49
|
+
/**
|
|
50
|
+
* @format uuid
|
|
51
|
+
*/
|
|
52
|
+
packageId: string;
|
|
53
|
+
/**
|
|
54
|
+
* Absent for package types that don't record one.
|
|
55
|
+
*/
|
|
56
|
+
packageKind?: string;
|
|
57
|
+
packageName: string;
|
|
58
|
+
packageType: string;
|
|
59
|
+
/**
|
|
60
|
+
* @format uuid
|
|
61
|
+
*/
|
|
62
|
+
registryId: string;
|
|
63
|
+
registryName: string;
|
|
64
|
+
/**
|
|
65
|
+
* Every tag pointing at this version's manifest, ordered by name. Absent for non-OCI
|
|
66
|
+
* package types and for untagged OCI digests.
|
|
67
|
+
*
|
|
68
|
+
*/
|
|
69
|
+
tags?: string[];
|
|
70
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|