agntcy-dir 0.3.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/README.md +119 -0
- package/dist/agntcy-dir.d.ts +2619 -0
- package/dist/index.cjs +10869 -0
- package/dist/index.mjs +10843 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +78 -0
|
@@ -0,0 +1,2619 @@
|
|
|
1
|
+
import { Client as Client_2 } from '@connectrpc/connect';
|
|
2
|
+
import type { EmptySchema } from '@bufbuild/protobuf/wkt';
|
|
3
|
+
import type { GenEnum } from '@bufbuild/protobuf/codegenv2';
|
|
4
|
+
import type { GenFile } from '@bufbuild/protobuf/codegenv2';
|
|
5
|
+
import type { GenMessage } from '@bufbuild/protobuf/codegenv2';
|
|
6
|
+
import type { GenService } from '@bufbuild/protobuf/codegenv2';
|
|
7
|
+
import type { JsonObject } from '@bufbuild/protobuf';
|
|
8
|
+
import type { Message } from '@bufbuild/protobuf';
|
|
9
|
+
import { Transport } from '@connectrpc/connect';
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Supporting credential type definitions
|
|
13
|
+
*
|
|
14
|
+
* @generated from message agntcy.dir.store.v1.BasicAuthCredentials
|
|
15
|
+
*/
|
|
16
|
+
declare type BasicAuthCredentials = Message<"agntcy.dir.store.v1.BasicAuthCredentials"> & {
|
|
17
|
+
/**
|
|
18
|
+
* @generated from field: string username = 1;
|
|
19
|
+
*/
|
|
20
|
+
username: string;
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* @generated from field: string password = 2;
|
|
24
|
+
*/
|
|
25
|
+
password: string;
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Describes the message agntcy.dir.store.v1.BasicAuthCredentials.
|
|
30
|
+
* Use `create(BasicAuthCredentialsSchema)` to create a new message.
|
|
31
|
+
*/
|
|
32
|
+
declare const BasicAuthCredentialsSchema: GenMessage<BasicAuthCredentials>;
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* High-level client for interacting with AGNTCY Directory services.
|
|
36
|
+
*
|
|
37
|
+
* This client provides a unified interface for operations across the Directory API.
|
|
38
|
+
* It handles gRPC communication and provides convenient methods for common operations
|
|
39
|
+
* including storage, routing, search, signing, and synchronization.
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```typescript
|
|
43
|
+
* // Create client with default configuration
|
|
44
|
+
* const client = new Client();
|
|
45
|
+
*
|
|
46
|
+
* // Create client with custom configuration
|
|
47
|
+
* const config = new Config('localhost:8888', '/usr/local/bin/dirctl');
|
|
48
|
+
* const client = new Client(config);
|
|
49
|
+
*
|
|
50
|
+
* // Use client for operations
|
|
51
|
+
* const records = await client.push([record]);
|
|
52
|
+
* ```
|
|
53
|
+
*/
|
|
54
|
+
export declare class Client {
|
|
55
|
+
config: Config;
|
|
56
|
+
storeClient: Client_2<typeof models_2.store_v1.StoreService>;
|
|
57
|
+
routingClient: Client_2<typeof models_2.routing_v1.RoutingService>;
|
|
58
|
+
searchClient: Client_2<typeof models_2.search_v1.SearchService>;
|
|
59
|
+
signClient: Client_2<typeof models_2.sign_v1.SignService>;
|
|
60
|
+
syncClient: Client_2<typeof models_2.store_v1.SyncService>;
|
|
61
|
+
/**
|
|
62
|
+
* Initialize the client with the given configuration.
|
|
63
|
+
*
|
|
64
|
+
* @param config - Optional client configuration. If null, loads from environment
|
|
65
|
+
* variables using Config.loadFromEnv()
|
|
66
|
+
* @param grpcTransport - Optional transport to use for gRPC communication.
|
|
67
|
+
* Can be created with Client.createGRPCTransport(config)
|
|
68
|
+
*
|
|
69
|
+
* @throws {Error} If unable to establish connection to the server or configuration is invalid
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* ```typescript
|
|
73
|
+
* // Load config from environment
|
|
74
|
+
* const client = new Client();
|
|
75
|
+
*
|
|
76
|
+
* // Use custom config
|
|
77
|
+
* const config = new Config('localhost:9999');
|
|
78
|
+
* const grpcTransport = await Client.createGRPCTransport(config);
|
|
79
|
+
* const client = new Client(config, grpcTransport);
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
constructor();
|
|
83
|
+
constructor(config?: Config);
|
|
84
|
+
constructor(config?: Config, grpcTransport?: Transport);
|
|
85
|
+
private static convertToPEM;
|
|
86
|
+
static createGRPCTransport(config: Config): Promise<Transport>;
|
|
87
|
+
/**
|
|
88
|
+
* Request generator helper function for streaming requests.
|
|
89
|
+
*/
|
|
90
|
+
private requestGenerator;
|
|
91
|
+
/**
|
|
92
|
+
* Push records to the Store API.
|
|
93
|
+
*
|
|
94
|
+
* Uploads one or more records to the content store, making them available
|
|
95
|
+
* for retrieval and reference. Each record is assigned a unique content
|
|
96
|
+
* identifier (CID) based on its content hash.
|
|
97
|
+
*
|
|
98
|
+
* @param records - Array of Record objects to push to the store
|
|
99
|
+
* @returns Promise that resolves to an array of RecordRef objects containing the CIDs of the pushed records
|
|
100
|
+
*
|
|
101
|
+
* @throws {Error} If the gRPC call fails or the push operation fails
|
|
102
|
+
*
|
|
103
|
+
* @example
|
|
104
|
+
* ```typescript
|
|
105
|
+
* const records = [createRecord("example")];
|
|
106
|
+
* const refs = await client.push(records);
|
|
107
|
+
* console.log(`Pushed with CID: ${refs[0].cid}`);
|
|
108
|
+
* ```
|
|
109
|
+
*/
|
|
110
|
+
push(records: models_2.core_v1.Record[]): Promise<models_2.core_v1.RecordRef[]>;
|
|
111
|
+
/**
|
|
112
|
+
* Push records with referrer metadata to the Store API.
|
|
113
|
+
*
|
|
114
|
+
* Uploads records along with optional artifacts and referrer information.
|
|
115
|
+
* This is useful for pushing complex objects that include additional
|
|
116
|
+
* metadata or associated artifacts.
|
|
117
|
+
*
|
|
118
|
+
* @param requests - Array of PushReferrerRequest objects containing records and optional artifacts
|
|
119
|
+
* @returns Promise that resolves to an array of PushReferrerResponse objects containing the details of pushed artifacts
|
|
120
|
+
*
|
|
121
|
+
* @throws {Error} If the gRPC call fails or the push operation fails
|
|
122
|
+
*
|
|
123
|
+
* @example
|
|
124
|
+
* ```typescript
|
|
125
|
+
* const requests = [new models.store_v1.PushReferrerRequest({record: record})];
|
|
126
|
+
* const responses = await client.push_referrer(requests);
|
|
127
|
+
* ```
|
|
128
|
+
*/
|
|
129
|
+
push_referrer(requests: models_2.store_v1.PushReferrerRequest[]): Promise<models_2.store_v1.PushReferrerResponse[]>;
|
|
130
|
+
/**
|
|
131
|
+
* Pull records from the Store API by their references.
|
|
132
|
+
*
|
|
133
|
+
* Retrieves one or more records from the content store using their
|
|
134
|
+
* content identifiers (CIDs).
|
|
135
|
+
*
|
|
136
|
+
* @param refs - Array of RecordRef objects containing the CIDs to retrieve
|
|
137
|
+
* @returns Promise that resolves to an array of Record objects retrieved from the store
|
|
138
|
+
*
|
|
139
|
+
* @throws {Error} If the gRPC call fails or the pull operation fails
|
|
140
|
+
*
|
|
141
|
+
* @example
|
|
142
|
+
* ```typescript
|
|
143
|
+
* const refs = [new models.core_v1.RecordRef({cid: "QmExample123"})];
|
|
144
|
+
* const records = await client.pull(refs);
|
|
145
|
+
* for (const record of records) {
|
|
146
|
+
* console.log(`Retrieved record: ${record}`);
|
|
147
|
+
* }
|
|
148
|
+
* ```
|
|
149
|
+
*/
|
|
150
|
+
pull(refs: models_2.core_v1.RecordRef[]): Promise<models_2.core_v1.Record[]>;
|
|
151
|
+
/**
|
|
152
|
+
* Pull records with referrer metadata from the Store API.
|
|
153
|
+
*
|
|
154
|
+
* Retrieves records along with their associated artifacts and referrer
|
|
155
|
+
* information. This provides access to complex objects that include
|
|
156
|
+
* additional metadata or associated artifacts.
|
|
157
|
+
*
|
|
158
|
+
* @param requests - Array of PullReferrerRequest objects containing records and optional artifacts for pull operations
|
|
159
|
+
* @returns Promise that resolves to an array of PullReferrerResponse objects containing the retrieved records
|
|
160
|
+
*
|
|
161
|
+
* @throws {Error} If the gRPC call fails or the pull operation fails
|
|
162
|
+
*
|
|
163
|
+
* @example
|
|
164
|
+
* ```typescript
|
|
165
|
+
* const requests = [new models.store_v1.PullReferrerRequest({ref: ref})];
|
|
166
|
+
* const responses = await client.pull_referrer(requests);
|
|
167
|
+
* for (const response of responses) {
|
|
168
|
+
* console.log(`Retrieved: ${response}`);
|
|
169
|
+
* }
|
|
170
|
+
* ```
|
|
171
|
+
*/
|
|
172
|
+
pull_referrer(requests: models_2.store_v1.PullReferrerRequest[]): Promise<models_2.store_v1.PullReferrerResponse[]>;
|
|
173
|
+
/**
|
|
174
|
+
* Search objects from the Store API matching the specified queries.
|
|
175
|
+
*
|
|
176
|
+
* Performs a search across the storage using the provided search queries
|
|
177
|
+
* and returns a list of matching results. Supports various
|
|
178
|
+
* search types including text, semantic, and structured queries.
|
|
179
|
+
*
|
|
180
|
+
* @param request - SearchRequest containing queries, filters, and search options
|
|
181
|
+
* @returns Promise that resolves to an array of SearchResponse objects matching the queries
|
|
182
|
+
*
|
|
183
|
+
* @throws {Error} If the gRPC call fails or the search operation fails
|
|
184
|
+
*
|
|
185
|
+
* @example
|
|
186
|
+
* ```typescript
|
|
187
|
+
* const request = new models.search_v1.SearchRequest({query: "python AI agent"});
|
|
188
|
+
* const responses = await client.search(request);
|
|
189
|
+
* for (const response of responses) {
|
|
190
|
+
* console.log(`Found: ${response.record.name}`);
|
|
191
|
+
* }
|
|
192
|
+
* ```
|
|
193
|
+
*/
|
|
194
|
+
search(request: models_2.search_v1.SearchRequest): Promise<models_2.search_v1.SearchResponse[]>;
|
|
195
|
+
/**
|
|
196
|
+
* Look up metadata for records in the Store API.
|
|
197
|
+
*
|
|
198
|
+
* Retrieves metadata information for one or more records without
|
|
199
|
+
* downloading the full record content. This is useful for checking
|
|
200
|
+
* if records exist and getting basic information about them.
|
|
201
|
+
*
|
|
202
|
+
* @param refs - Array of RecordRef objects containing the CIDs to look up
|
|
203
|
+
* @returns Promise that resolves to an array of RecordMeta objects containing metadata for the records
|
|
204
|
+
*
|
|
205
|
+
* @throws {Error} If the gRPC call fails or the lookup operation fails
|
|
206
|
+
*
|
|
207
|
+
* @example
|
|
208
|
+
* ```typescript
|
|
209
|
+
* const refs = [new models.core_v1.RecordRef({cid: "QmExample123"})];
|
|
210
|
+
* const metadatas = await client.lookup(refs);
|
|
211
|
+
* for (const meta of metadatas) {
|
|
212
|
+
* console.log(`Record size: ${meta.size}`);
|
|
213
|
+
* }
|
|
214
|
+
* ```
|
|
215
|
+
*/
|
|
216
|
+
lookup(refs: models_2.core_v1.RecordRef[]): Promise<models_2.core_v1.RecordMeta[]>;
|
|
217
|
+
/**
|
|
218
|
+
* List objects from the Routing API matching the specified criteria.
|
|
219
|
+
*
|
|
220
|
+
* Returns a list of objects that match the filtering and
|
|
221
|
+
* query criteria specified in the request.
|
|
222
|
+
*
|
|
223
|
+
* @param request - ListRequest specifying filtering criteria, pagination, etc.
|
|
224
|
+
* @returns Promise that resolves to an array of ListResponse objects matching the criteria
|
|
225
|
+
*
|
|
226
|
+
* @throws {Error} If the gRPC call fails or the list operation fails
|
|
227
|
+
*
|
|
228
|
+
* @example
|
|
229
|
+
* ```typescript
|
|
230
|
+
* const request = new models.routing_v1.ListRequest({limit: 10});
|
|
231
|
+
* const responses = await client.list(request);
|
|
232
|
+
* for (const response of responses) {
|
|
233
|
+
* console.log(`Found object: ${response.cid}`);
|
|
234
|
+
* }
|
|
235
|
+
* ```
|
|
236
|
+
*/
|
|
237
|
+
list(request: models_2.routing_v1.ListRequest): Promise<models_2.routing_v1.ListResponse[]>;
|
|
238
|
+
/**
|
|
239
|
+
* Publish objects to the Routing API matching the specified criteria.
|
|
240
|
+
*
|
|
241
|
+
* Makes the specified objects available for discovery and retrieval by other
|
|
242
|
+
* clients in the network. The objects must already exist in the store before
|
|
243
|
+
* they can be published.
|
|
244
|
+
*
|
|
245
|
+
* @param request - PublishRequest containing the query for the objects to publish
|
|
246
|
+
* @returns Promise that resolves when the publish operation is complete
|
|
247
|
+
*
|
|
248
|
+
* @throws {Error} If the gRPC call fails or the object cannot be published
|
|
249
|
+
*
|
|
250
|
+
* @example
|
|
251
|
+
* ```typescript
|
|
252
|
+
* const ref = new models.routing_v1.RecordRef({cid: "QmExample123"});
|
|
253
|
+
* const request = new models.routing_v1.PublishRequest({recordRefs: [ref]});
|
|
254
|
+
* await client.publish(request);
|
|
255
|
+
* ```
|
|
256
|
+
*/
|
|
257
|
+
publish(request: models_2.routing_v1.PublishRequest): Promise<void>;
|
|
258
|
+
/**
|
|
259
|
+
* Unpublish objects from the Routing API matching the specified criteria.
|
|
260
|
+
*
|
|
261
|
+
* Removes the specified objects from the public network, making them no
|
|
262
|
+
* longer discoverable by other clients. The objects remain in the local
|
|
263
|
+
* store but are not available for network discovery.
|
|
264
|
+
*
|
|
265
|
+
* @param request - UnpublishRequest containing the query for the objects to unpublish
|
|
266
|
+
* @returns Promise that resolves when the unpublish operation is complete
|
|
267
|
+
*
|
|
268
|
+
* @throws {Error} If the gRPC call fails or the objects cannot be unpublished
|
|
269
|
+
*
|
|
270
|
+
* @example
|
|
271
|
+
* ```typescript
|
|
272
|
+
* const ref = new models.routing_v1.RecordRef({cid: "QmExample123"});
|
|
273
|
+
* const request = new models.routing_v1.UnpublishRequest({recordRefs: [ref]});
|
|
274
|
+
* await client.unpublish(request);
|
|
275
|
+
* ```
|
|
276
|
+
*/
|
|
277
|
+
unpublish(request: models_2.routing_v1.UnpublishRequest): Promise<void>;
|
|
278
|
+
/**
|
|
279
|
+
* Delete records from the Store API.
|
|
280
|
+
*
|
|
281
|
+
* Permanently removes one or more records from the content store using
|
|
282
|
+
* their content identifiers (CIDs). This operation cannot be undone.
|
|
283
|
+
*
|
|
284
|
+
* @param refs - Array of RecordRef objects containing the CIDs to delete
|
|
285
|
+
* @returns Promise that resolves when the deletion is complete
|
|
286
|
+
*
|
|
287
|
+
* @throws {Error} If the gRPC call fails or the delete operation fails
|
|
288
|
+
*
|
|
289
|
+
* @example
|
|
290
|
+
* ```typescript
|
|
291
|
+
* const refs = [new models.core_v1.RecordRef({cid: "QmExample123"})];
|
|
292
|
+
* await client.delete(refs);
|
|
293
|
+
* ```
|
|
294
|
+
*/
|
|
295
|
+
delete(refs: models_2.core_v1.RecordRef[]): Promise<void>;
|
|
296
|
+
/**
|
|
297
|
+
* Sign a record with a cryptographic signature.
|
|
298
|
+
*
|
|
299
|
+
* Creates a cryptographic signature for a record using either a private
|
|
300
|
+
* key or OIDC-based signing. The signing process uses the external dirctl
|
|
301
|
+
* command-line tool to perform the actual cryptographic operations.
|
|
302
|
+
*
|
|
303
|
+
* @param req - SignRequest containing the record reference and signing provider
|
|
304
|
+
* configuration. The provider can specify either key-based signing
|
|
305
|
+
* (with a private key) or OIDC-based signing
|
|
306
|
+
* @param oidc_client_id - OIDC client identifier for OIDC-based signing. Defaults to "sigstore"
|
|
307
|
+
* @returns SignResponse containing the signature
|
|
308
|
+
*
|
|
309
|
+
* @throws {Error} If the signing operation fails or unsupported provider is supplied
|
|
310
|
+
*
|
|
311
|
+
* @example
|
|
312
|
+
* ```typescript
|
|
313
|
+
* const req = new models.sign_v1.SignRequest({
|
|
314
|
+
* recordRef: new models.core_v1.RecordRef({cid: "QmExample123"}),
|
|
315
|
+
* provider: new models.sign_v1.SignProvider({key: keyConfig})
|
|
316
|
+
* });
|
|
317
|
+
* const response = client.sign(req);
|
|
318
|
+
* console.log(`Signature: ${response.signature}`);
|
|
319
|
+
* ```
|
|
320
|
+
*/
|
|
321
|
+
sign(req: models_2.sign_v1.SignRequest, oidc_client_id?: string): void;
|
|
322
|
+
/**
|
|
323
|
+
* Verify a cryptographic signature on a record.
|
|
324
|
+
*
|
|
325
|
+
* Validates the cryptographic signature of a previously signed record
|
|
326
|
+
* to ensure its authenticity and integrity. This operation verifies
|
|
327
|
+
* that the record has not been tampered with since signing.
|
|
328
|
+
*
|
|
329
|
+
* @param request - VerifyRequest containing the record reference and verification parameters
|
|
330
|
+
* @returns Promise that resolves to a VerifyResponse containing the verification result and details
|
|
331
|
+
*
|
|
332
|
+
* @throws {Error} If the gRPC call fails or the verification operation fails
|
|
333
|
+
*
|
|
334
|
+
* @example
|
|
335
|
+
* ```typescript
|
|
336
|
+
* const request = new models.sign_v1.VerifyRequest({
|
|
337
|
+
* recordRef: new models.core_v1.RecordRef({cid: "QmExample123"})
|
|
338
|
+
* });
|
|
339
|
+
* const response = await client.verify(request);
|
|
340
|
+
* console.log(`Signature valid: ${response.valid}`);
|
|
341
|
+
* ```
|
|
342
|
+
*/
|
|
343
|
+
verify(request: models_2.sign_v1.VerifyRequest): Promise<models_2.sign_v1.VerifyResponse>;
|
|
344
|
+
/**
|
|
345
|
+
* Create a new synchronization configuration.
|
|
346
|
+
*
|
|
347
|
+
* Creates a new sync configuration that defines how data should be
|
|
348
|
+
* synchronized between different Directory servers. This allows for
|
|
349
|
+
* automated data replication and consistency across multiple locations.
|
|
350
|
+
*
|
|
351
|
+
* @param request - CreateSyncRequest containing the sync configuration details
|
|
352
|
+
* including source, target, and synchronization parameters
|
|
353
|
+
* @returns Promise that resolves to a CreateSyncResponse containing the created sync details
|
|
354
|
+
* including the sync ID and configuration
|
|
355
|
+
*
|
|
356
|
+
* @throws {Error} If the gRPC call fails or the sync creation fails
|
|
357
|
+
*
|
|
358
|
+
* @example
|
|
359
|
+
* ```typescript
|
|
360
|
+
* const request = new models.store_v1.CreateSyncRequest();
|
|
361
|
+
* const response = await client.create_sync(request);
|
|
362
|
+
* console.log(`Created sync with ID: ${response.syncId}`);
|
|
363
|
+
* ```
|
|
364
|
+
*/
|
|
365
|
+
create_sync(request: models_2.store_v1.CreateSyncRequest): Promise<models_2.store_v1.CreateSyncResponse>;
|
|
366
|
+
/**
|
|
367
|
+
* List existing synchronization configurations.
|
|
368
|
+
*
|
|
369
|
+
* Retrieves a list of all sync configurations that have been created,
|
|
370
|
+
* with optional filtering and pagination support. This allows you to
|
|
371
|
+
* monitor and manage multiple synchronization processes.
|
|
372
|
+
*
|
|
373
|
+
* @param request - ListSyncsRequest containing filtering criteria, pagination options,
|
|
374
|
+
* and other query parameters
|
|
375
|
+
* @returns Promise that resolves to an array of ListSyncsItem objects with
|
|
376
|
+
* their details including ID, name, status, and configuration parameters
|
|
377
|
+
*
|
|
378
|
+
* @throws {Error} If the gRPC call fails or the list operation fails
|
|
379
|
+
*
|
|
380
|
+
* @example
|
|
381
|
+
* ```typescript
|
|
382
|
+
* const request = new models.store_v1.ListSyncsRequest({limit: 10});
|
|
383
|
+
* const syncs = await client.list_syncs(request);
|
|
384
|
+
* for (const sync of syncs) {
|
|
385
|
+
* console.log(`Sync: ${sync}`);
|
|
386
|
+
* }
|
|
387
|
+
* ```
|
|
388
|
+
*/
|
|
389
|
+
list_syncs(request: models_2.store_v1.ListSyncsRequest): Promise<models_2.store_v1.ListSyncsItem[]>;
|
|
390
|
+
/**
|
|
391
|
+
* Retrieve detailed information about a specific synchronization configuration.
|
|
392
|
+
*
|
|
393
|
+
* Gets comprehensive details about a specific sync configuration including
|
|
394
|
+
* its current status, configuration parameters, performance metrics,
|
|
395
|
+
* and any recent errors or warnings.
|
|
396
|
+
*
|
|
397
|
+
* @param request - GetSyncRequest containing the sync ID or identifier to retrieve
|
|
398
|
+
* @returns Promise that resolves to a GetSyncResponse with detailed information about the sync configuration
|
|
399
|
+
* including status, metrics, configuration, and logs
|
|
400
|
+
*
|
|
401
|
+
* @throws {Error} If the gRPC call fails or the get operation fails
|
|
402
|
+
*
|
|
403
|
+
* @example
|
|
404
|
+
* ```typescript
|
|
405
|
+
* const request = new models.store_v1.GetSyncRequest({syncId: "sync-123"});
|
|
406
|
+
* const response = await client.get_sync(request);
|
|
407
|
+
* console.log(`Sync status: ${response.status}`);
|
|
408
|
+
* console.log(`Last update: ${response.lastUpdateTime}`);
|
|
409
|
+
* ```
|
|
410
|
+
*/
|
|
411
|
+
get_sync(request: models_2.store_v1.GetSyncRequest): Promise<models_2.store_v1.GetSyncResponse>;
|
|
412
|
+
/**
|
|
413
|
+
* Delete a synchronization configuration.
|
|
414
|
+
*
|
|
415
|
+
* Permanently removes a sync configuration and stops any ongoing
|
|
416
|
+
* synchronization processes. This operation cannot be undone and
|
|
417
|
+
* will halt all data synchronization for the specified configuration.
|
|
418
|
+
*
|
|
419
|
+
* @param request - DeleteSyncRequest containing the sync ID or identifier to delete
|
|
420
|
+
* @returns Promise that resolves to a DeleteSyncResponse when the deletion is complete
|
|
421
|
+
*
|
|
422
|
+
* @throws {Error} If the gRPC call fails or the delete operation fails
|
|
423
|
+
*
|
|
424
|
+
* @example
|
|
425
|
+
* ```typescript
|
|
426
|
+
* const request = new models.store_v1.DeleteSyncRequest({syncId: "sync-123"});
|
|
427
|
+
* await client.delete_sync(request);
|
|
428
|
+
* console.log("Sync deleted");
|
|
429
|
+
* ```
|
|
430
|
+
*/
|
|
431
|
+
delete_sync(request: models_2.store_v1.DeleteSyncRequest): Promise<models_2.store_v1.DeleteSyncResponse>;
|
|
432
|
+
/**
|
|
433
|
+
* Sign a record using a private key.
|
|
434
|
+
*
|
|
435
|
+
* This private method handles key-based signing by writing the private key
|
|
436
|
+
* to a temporary file and executing the dirctl command with the key file.
|
|
437
|
+
*
|
|
438
|
+
* @param cid - Content identifier of the record to sign
|
|
439
|
+
* @param req - SignWithKey request containing the private key
|
|
440
|
+
* @returns SignResponse containing the signature
|
|
441
|
+
*
|
|
442
|
+
* @throws {Error} If any error occurs during signing
|
|
443
|
+
*
|
|
444
|
+
* @private
|
|
445
|
+
*/
|
|
446
|
+
private __sign_with_key;
|
|
447
|
+
/**
|
|
448
|
+
* Sign a record using OIDC-based authentication.
|
|
449
|
+
*
|
|
450
|
+
* This private method handles OIDC-based signing by building the appropriate
|
|
451
|
+
* dirctl command with OIDC parameters and executing it.
|
|
452
|
+
*
|
|
453
|
+
* @param cid - Content identifier of the record to sign
|
|
454
|
+
* @param req - SignWithOIDC request containing the OIDC configuration
|
|
455
|
+
* @param oidc_client_id - OIDC client identifier for authentication
|
|
456
|
+
* @returns SignResponse containing the signature
|
|
457
|
+
*
|
|
458
|
+
* @throws {Error} If any error occurs during signing
|
|
459
|
+
*
|
|
460
|
+
* @private
|
|
461
|
+
*/
|
|
462
|
+
private __sign_with_oidc;
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
/**
|
|
466
|
+
* Configuration class for the AGNTCY Directory client.
|
|
467
|
+
*
|
|
468
|
+
* This class manages configuration settings for connecting to the Directory service
|
|
469
|
+
* and provides default values and environment-based configuration loading.
|
|
470
|
+
*/
|
|
471
|
+
export declare class Config {
|
|
472
|
+
static DEFAULT_SERVER_ADDRESS: string;
|
|
473
|
+
static DEFAULT_DIRCTL_PATH: string;
|
|
474
|
+
static DEFAULT_SPIFFE_ENDPOINT_SOCKET: string;
|
|
475
|
+
serverAddress: string;
|
|
476
|
+
dirctlPath: string;
|
|
477
|
+
spiffeEndpointSocket: string;
|
|
478
|
+
/**
|
|
479
|
+
* Creates a new Config instance.
|
|
480
|
+
*
|
|
481
|
+
* @param serverAddress - The server address to connect to. Defaults to '0.0.0.0:8888'
|
|
482
|
+
* @param dirctlPath - Path to the dirctl executable. Defaults to 'dirctl'
|
|
483
|
+
* @param spiffeEndpointSocket - Path to the spire server socket. Defaults to empty string.
|
|
484
|
+
*/
|
|
485
|
+
constructor(serverAddress?: string, dirctlPath?: string, spiffeEndpointSocket?: string);
|
|
486
|
+
/**
|
|
487
|
+
* Load configuration from environment variables.
|
|
488
|
+
*
|
|
489
|
+
* @param prefix - Environment variable prefix. Defaults to 'DIRECTORY_CLIENT_'
|
|
490
|
+
* @returns A new Config instance with values loaded from environment variables
|
|
491
|
+
*
|
|
492
|
+
* @example
|
|
493
|
+
* ```typescript
|
|
494
|
+
* // Load with default prefix
|
|
495
|
+
* const config = Config.loadFromEnv();
|
|
496
|
+
*
|
|
497
|
+
* // Load with custom prefix
|
|
498
|
+
* const config = Config.loadFromEnv("MY_APP_");
|
|
499
|
+
* ```
|
|
500
|
+
*/
|
|
501
|
+
static loadFromEnv(prefix?: string): Config;
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
export declare namespace core_v1 {
|
|
505
|
+
export {
|
|
506
|
+
file_agntcy_dir_core_v1_record,
|
|
507
|
+
RecordRef,
|
|
508
|
+
RecordRefSchema,
|
|
509
|
+
RecordMeta,
|
|
510
|
+
RecordMetaSchema,
|
|
511
|
+
Record_2 as Record,
|
|
512
|
+
RecordSchema
|
|
513
|
+
}
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
/**
|
|
517
|
+
* CreatePublicationResponse returns the result of creating a publication request.
|
|
518
|
+
* This includes the publication ID and any relevant metadata.
|
|
519
|
+
*
|
|
520
|
+
* @generated from message agntcy.dir.routing.v1.CreatePublicationResponse
|
|
521
|
+
*/
|
|
522
|
+
declare type CreatePublicationResponse = Message<"agntcy.dir.routing.v1.CreatePublicationResponse"> & {
|
|
523
|
+
/**
|
|
524
|
+
* Unique identifier of the publication operation.
|
|
525
|
+
*
|
|
526
|
+
* @generated from field: string publication_id = 1;
|
|
527
|
+
*/
|
|
528
|
+
publicationId: string;
|
|
529
|
+
};
|
|
530
|
+
|
|
531
|
+
/**
|
|
532
|
+
* Describes the message agntcy.dir.routing.v1.CreatePublicationResponse.
|
|
533
|
+
* Use `create(CreatePublicationResponseSchema)` to create a new message.
|
|
534
|
+
*/
|
|
535
|
+
declare const CreatePublicationResponseSchema: GenMessage<CreatePublicationResponse>;
|
|
536
|
+
|
|
537
|
+
/**
|
|
538
|
+
* CreateSyncRequest defines the parameters for creating a new synchronization operation.
|
|
539
|
+
*
|
|
540
|
+
* Currently supports basic synchronization of all objects from a remote Directory.
|
|
541
|
+
* Future versions may include additional options for filtering and scheduling capabilities.
|
|
542
|
+
*
|
|
543
|
+
* @generated from message agntcy.dir.store.v1.CreateSyncRequest
|
|
544
|
+
*/
|
|
545
|
+
declare type CreateSyncRequest = Message<"agntcy.dir.store.v1.CreateSyncRequest"> & {
|
|
546
|
+
/**
|
|
547
|
+
* URL of the remote Registry to synchronize from.
|
|
548
|
+
*
|
|
549
|
+
* This should be a complete URL including protocol and port if non-standard.
|
|
550
|
+
* Examples:
|
|
551
|
+
* - "https://directory.example.com"
|
|
552
|
+
* - "http://localhost:8080"
|
|
553
|
+
* - "https://directory.example.com:9443"
|
|
554
|
+
*
|
|
555
|
+
* @generated from field: string remote_directory_url = 1;
|
|
556
|
+
*/
|
|
557
|
+
remoteDirectoryUrl: string;
|
|
558
|
+
|
|
559
|
+
/**
|
|
560
|
+
* List of CIDs to synchronize from the remote Directory.
|
|
561
|
+
* If empty, all objects will be synchronized.
|
|
562
|
+
*
|
|
563
|
+
* @generated from field: repeated string cids = 2;
|
|
564
|
+
*/
|
|
565
|
+
cids: string[];
|
|
566
|
+
};
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* Describes the message agntcy.dir.store.v1.CreateSyncRequest.
|
|
570
|
+
* Use `create(CreateSyncRequestSchema)` to create a new message.
|
|
571
|
+
*/
|
|
572
|
+
declare const CreateSyncRequestSchema: GenMessage<CreateSyncRequest>;
|
|
573
|
+
|
|
574
|
+
/**
|
|
575
|
+
* CreateSyncResponse contains the result of creating a new synchronization operation.
|
|
576
|
+
*
|
|
577
|
+
* @generated from message agntcy.dir.store.v1.CreateSyncResponse
|
|
578
|
+
*/
|
|
579
|
+
declare type CreateSyncResponse = Message<"agntcy.dir.store.v1.CreateSyncResponse"> & {
|
|
580
|
+
/**
|
|
581
|
+
* Unique identifier for the created synchronization operation.
|
|
582
|
+
* This ID can be used with other SyncService RPCs to monitor and manage the sync.
|
|
583
|
+
*
|
|
584
|
+
* @generated from field: string sync_id = 1;
|
|
585
|
+
*/
|
|
586
|
+
syncId: string;
|
|
587
|
+
};
|
|
588
|
+
|
|
589
|
+
/**
|
|
590
|
+
* Describes the message agntcy.dir.store.v1.CreateSyncResponse.
|
|
591
|
+
* Use `create(CreateSyncResponseSchema)` to create a new message.
|
|
592
|
+
*/
|
|
593
|
+
declare const CreateSyncResponseSchema: GenMessage<CreateSyncResponse>;
|
|
594
|
+
|
|
595
|
+
/**
|
|
596
|
+
* DeleteSyncRequest specifies which synchronization to delete.
|
|
597
|
+
*
|
|
598
|
+
* @generated from message agntcy.dir.store.v1.DeleteSyncRequest
|
|
599
|
+
*/
|
|
600
|
+
declare type DeleteSyncRequest = Message<"agntcy.dir.store.v1.DeleteSyncRequest"> & {
|
|
601
|
+
/**
|
|
602
|
+
* Unique identifier of the synchronization operation to delete.
|
|
603
|
+
*
|
|
604
|
+
* @generated from field: string sync_id = 1;
|
|
605
|
+
*/
|
|
606
|
+
syncId: string;
|
|
607
|
+
};
|
|
608
|
+
|
|
609
|
+
/**
|
|
610
|
+
* Describes the message agntcy.dir.store.v1.DeleteSyncRequest.
|
|
611
|
+
* Use `create(DeleteSyncRequestSchema)` to create a new message.
|
|
612
|
+
*/
|
|
613
|
+
declare const DeleteSyncRequestSchema: GenMessage<DeleteSyncRequest>;
|
|
614
|
+
|
|
615
|
+
/**
|
|
616
|
+
* DeleteSyncResponse
|
|
617
|
+
*
|
|
618
|
+
* @generated from message agntcy.dir.store.v1.DeleteSyncResponse
|
|
619
|
+
*/
|
|
620
|
+
declare type DeleteSyncResponse = Message<"agntcy.dir.store.v1.DeleteSyncResponse"> & {
|
|
621
|
+
};
|
|
622
|
+
|
|
623
|
+
/**
|
|
624
|
+
* Describes the message agntcy.dir.store.v1.DeleteSyncResponse.
|
|
625
|
+
* Use `create(DeleteSyncResponseSchema)` to create a new message.
|
|
626
|
+
*/
|
|
627
|
+
declare const DeleteSyncResponseSchema: GenMessage<DeleteSyncResponse>;
|
|
628
|
+
|
|
629
|
+
/**
|
|
630
|
+
* Describes the file agntcy/dir/core/v1/record.proto.
|
|
631
|
+
*/
|
|
632
|
+
declare const file_agntcy_dir_core_v1_record: GenFile;
|
|
633
|
+
|
|
634
|
+
/**
|
|
635
|
+
* Describes the file agntcy/dir/routing/v1/peer.proto.
|
|
636
|
+
*/
|
|
637
|
+
declare const file_agntcy_dir_routing_v1_peer: GenFile;
|
|
638
|
+
|
|
639
|
+
/**
|
|
640
|
+
* Describes the file agntcy/dir/routing/v1/publication_service.proto.
|
|
641
|
+
*/
|
|
642
|
+
declare const file_agntcy_dir_routing_v1_publication_service: GenFile;
|
|
643
|
+
|
|
644
|
+
/**
|
|
645
|
+
* Describes the file agntcy/dir/routing/v1/record_query.proto.
|
|
646
|
+
*/
|
|
647
|
+
declare const file_agntcy_dir_routing_v1_record_query: GenFile;
|
|
648
|
+
|
|
649
|
+
/**
|
|
650
|
+
* Describes the file agntcy/dir/routing/v1/routing_service.proto.
|
|
651
|
+
*/
|
|
652
|
+
declare const file_agntcy_dir_routing_v1_routing_service: GenFile;
|
|
653
|
+
|
|
654
|
+
/**
|
|
655
|
+
* Describes the file agntcy/dir/search/v1/record_query.proto.
|
|
656
|
+
*/
|
|
657
|
+
declare const file_agntcy_dir_search_v1_record_query: GenFile;
|
|
658
|
+
|
|
659
|
+
/**
|
|
660
|
+
* Describes the file agntcy/dir/search/v1/search_service.proto.
|
|
661
|
+
*/
|
|
662
|
+
declare const file_agntcy_dir_search_v1_search_service: GenFile;
|
|
663
|
+
|
|
664
|
+
/**
|
|
665
|
+
* Describes the file agntcy/dir/sign/v1/sign_service.proto.
|
|
666
|
+
*/
|
|
667
|
+
declare const file_agntcy_dir_sign_v1_sign_service: GenFile;
|
|
668
|
+
|
|
669
|
+
/**
|
|
670
|
+
* Describes the file agntcy/dir/store/v1/store_service.proto.
|
|
671
|
+
*/
|
|
672
|
+
declare const file_agntcy_dir_store_v1_store_service: GenFile;
|
|
673
|
+
|
|
674
|
+
/**
|
|
675
|
+
* Describes the file agntcy/dir/store/v1/sync_service.proto.
|
|
676
|
+
*/
|
|
677
|
+
declare const file_agntcy_dir_store_v1_sync_service: GenFile;
|
|
678
|
+
|
|
679
|
+
/**
|
|
680
|
+
* GetPublicationRequest specifies which publication to retrieve by its identifier.
|
|
681
|
+
*
|
|
682
|
+
* @generated from message agntcy.dir.routing.v1.GetPublicationRequest
|
|
683
|
+
*/
|
|
684
|
+
declare type GetPublicationRequest = Message<"agntcy.dir.routing.v1.GetPublicationRequest"> & {
|
|
685
|
+
/**
|
|
686
|
+
* Unique identifier of the publication operation to query.
|
|
687
|
+
*
|
|
688
|
+
* @generated from field: string publication_id = 1;
|
|
689
|
+
*/
|
|
690
|
+
publicationId: string;
|
|
691
|
+
};
|
|
692
|
+
|
|
693
|
+
/**
|
|
694
|
+
* Describes the message agntcy.dir.routing.v1.GetPublicationRequest.
|
|
695
|
+
* Use `create(GetPublicationRequestSchema)` to create a new message.
|
|
696
|
+
*/
|
|
697
|
+
declare const GetPublicationRequestSchema: GenMessage<GetPublicationRequest>;
|
|
698
|
+
|
|
699
|
+
/**
|
|
700
|
+
* GetPublicationResponse contains the full details of a specific publication request.
|
|
701
|
+
* Includes status, progress information, and any error details if applicable.
|
|
702
|
+
*
|
|
703
|
+
* @generated from message agntcy.dir.routing.v1.GetPublicationResponse
|
|
704
|
+
*/
|
|
705
|
+
declare type GetPublicationResponse = Message<"agntcy.dir.routing.v1.GetPublicationResponse"> & {
|
|
706
|
+
/**
|
|
707
|
+
* Unique identifier of the publication operation.
|
|
708
|
+
*
|
|
709
|
+
* @generated from field: string publication_id = 1;
|
|
710
|
+
*/
|
|
711
|
+
publicationId: string;
|
|
712
|
+
|
|
713
|
+
/**
|
|
714
|
+
* Current status of the publication operation.
|
|
715
|
+
*
|
|
716
|
+
* @generated from field: agntcy.dir.routing.v1.PublicationStatus status = 2;
|
|
717
|
+
*/
|
|
718
|
+
status: PublicationStatus;
|
|
719
|
+
|
|
720
|
+
/**
|
|
721
|
+
* Timestamp when the publication operation was created in the RFC3339 format.
|
|
722
|
+
* Specs: https://www.rfc-editor.org/rfc/rfc3339.html
|
|
723
|
+
*
|
|
724
|
+
* @generated from field: string created_time = 3;
|
|
725
|
+
*/
|
|
726
|
+
createdTime: string;
|
|
727
|
+
|
|
728
|
+
/**
|
|
729
|
+
* Timestamp of the most recent status update for this publication in the RFC3339 format.
|
|
730
|
+
*
|
|
731
|
+
* @generated from field: string last_update_time = 4;
|
|
732
|
+
*/
|
|
733
|
+
lastUpdateTime: string;
|
|
734
|
+
};
|
|
735
|
+
|
|
736
|
+
/**
|
|
737
|
+
* Describes the message agntcy.dir.routing.v1.GetPublicationResponse.
|
|
738
|
+
* Use `create(GetPublicationResponseSchema)` to create a new message.
|
|
739
|
+
*/
|
|
740
|
+
declare const GetPublicationResponseSchema: GenMessage<GetPublicationResponse>;
|
|
741
|
+
|
|
742
|
+
/**
|
|
743
|
+
* GetSyncRequest specifies which synchronization status to retrieve.
|
|
744
|
+
*
|
|
745
|
+
* @generated from message agntcy.dir.store.v1.GetSyncRequest
|
|
746
|
+
*/
|
|
747
|
+
declare type GetSyncRequest = Message<"agntcy.dir.store.v1.GetSyncRequest"> & {
|
|
748
|
+
/**
|
|
749
|
+
* Unique identifier of the synchronization operation to query.
|
|
750
|
+
*
|
|
751
|
+
* @generated from field: string sync_id = 1;
|
|
752
|
+
*/
|
|
753
|
+
syncId: string;
|
|
754
|
+
};
|
|
755
|
+
|
|
756
|
+
/**
|
|
757
|
+
* Describes the message agntcy.dir.store.v1.GetSyncRequest.
|
|
758
|
+
* Use `create(GetSyncRequestSchema)` to create a new message.
|
|
759
|
+
*/
|
|
760
|
+
declare const GetSyncRequestSchema: GenMessage<GetSyncRequest>;
|
|
761
|
+
|
|
762
|
+
/**
|
|
763
|
+
* GetSyncResponse provides detailed information about a specific synchronization operation.
|
|
764
|
+
*
|
|
765
|
+
* @generated from message agntcy.dir.store.v1.GetSyncResponse
|
|
766
|
+
*/
|
|
767
|
+
declare type GetSyncResponse = Message<"agntcy.dir.store.v1.GetSyncResponse"> & {
|
|
768
|
+
/**
|
|
769
|
+
* Unique identifier of the synchronization operation.
|
|
770
|
+
*
|
|
771
|
+
* @generated from field: string sync_id = 1;
|
|
772
|
+
*/
|
|
773
|
+
syncId: string;
|
|
774
|
+
|
|
775
|
+
/**
|
|
776
|
+
* Current status of the synchronization operation.
|
|
777
|
+
*
|
|
778
|
+
* @generated from field: agntcy.dir.store.v1.SyncStatus status = 2;
|
|
779
|
+
*/
|
|
780
|
+
status: SyncStatus;
|
|
781
|
+
|
|
782
|
+
/**
|
|
783
|
+
* URL of the remote Directory node being synchronized from.
|
|
784
|
+
*
|
|
785
|
+
* @generated from field: string remote_directory_url = 3;
|
|
786
|
+
*/
|
|
787
|
+
remoteDirectoryUrl: string;
|
|
788
|
+
|
|
789
|
+
/**
|
|
790
|
+
* Timestamp when the synchronization operation was created in the RFC3339 format.
|
|
791
|
+
* Specs: https://www.rfc-editor.org/rfc/rfc3339.html
|
|
792
|
+
*
|
|
793
|
+
* @generated from field: string created_time = 4;
|
|
794
|
+
*/
|
|
795
|
+
createdTime: string;
|
|
796
|
+
|
|
797
|
+
/**
|
|
798
|
+
* Timestamp of the most recent status update for this synchronization in the RFC3339 format.
|
|
799
|
+
*
|
|
800
|
+
* @generated from field: string last_update_time = 5;
|
|
801
|
+
*/
|
|
802
|
+
lastUpdateTime: string;
|
|
803
|
+
};
|
|
804
|
+
|
|
805
|
+
/**
|
|
806
|
+
* Describes the message agntcy.dir.store.v1.GetSyncResponse.
|
|
807
|
+
* Use `create(GetSyncResponseSchema)` to create a new message.
|
|
808
|
+
*/
|
|
809
|
+
declare const GetSyncResponseSchema: GenMessage<GetSyncResponse>;
|
|
810
|
+
|
|
811
|
+
/**
|
|
812
|
+
* ListPublicationsItem represents a single publication request in the list response.
|
|
813
|
+
* Contains publication details including ID, status, and creation timestamp.
|
|
814
|
+
*
|
|
815
|
+
* @generated from message agntcy.dir.routing.v1.ListPublicationsItem
|
|
816
|
+
*/
|
|
817
|
+
declare type ListPublicationsItem = Message<"agntcy.dir.routing.v1.ListPublicationsItem"> & {
|
|
818
|
+
/**
|
|
819
|
+
* Unique identifier of the publication operation.
|
|
820
|
+
*
|
|
821
|
+
* @generated from field: string publication_id = 1;
|
|
822
|
+
*/
|
|
823
|
+
publicationId: string;
|
|
824
|
+
|
|
825
|
+
/**
|
|
826
|
+
* Current status of the publication operation.
|
|
827
|
+
*
|
|
828
|
+
* @generated from field: agntcy.dir.routing.v1.PublicationStatus status = 2;
|
|
829
|
+
*/
|
|
830
|
+
status: PublicationStatus;
|
|
831
|
+
|
|
832
|
+
/**
|
|
833
|
+
* Timestamp when the publication operation was created in the RFC3339 format.
|
|
834
|
+
* Specs: https://www.rfc-editor.org/rfc/rfc3339.html
|
|
835
|
+
*
|
|
836
|
+
* @generated from field: string created_time = 3;
|
|
837
|
+
*/
|
|
838
|
+
createdTime: string;
|
|
839
|
+
|
|
840
|
+
/**
|
|
841
|
+
* Timestamp of the most recent status update for this publication in the RFC3339 format.
|
|
842
|
+
*
|
|
843
|
+
* @generated from field: string last_update_time = 4;
|
|
844
|
+
*/
|
|
845
|
+
lastUpdateTime: string;
|
|
846
|
+
};
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* Describes the message agntcy.dir.routing.v1.ListPublicationsItem.
|
|
850
|
+
* Use `create(ListPublicationsItemSchema)` to create a new message.
|
|
851
|
+
*/
|
|
852
|
+
declare const ListPublicationsItemSchema: GenMessage<ListPublicationsItem>;
|
|
853
|
+
|
|
854
|
+
/**
|
|
855
|
+
* ListPublicationsRequest contains optional filters for listing publication requests.
|
|
856
|
+
*
|
|
857
|
+
* @generated from message agntcy.dir.routing.v1.ListPublicationsRequest
|
|
858
|
+
*/
|
|
859
|
+
declare type ListPublicationsRequest = Message<"agntcy.dir.routing.v1.ListPublicationsRequest"> & {
|
|
860
|
+
/**
|
|
861
|
+
* Optional limit on the number of results to return.
|
|
862
|
+
*
|
|
863
|
+
* @generated from field: optional uint32 limit = 2;
|
|
864
|
+
*/
|
|
865
|
+
limit?: number;
|
|
866
|
+
|
|
867
|
+
/**
|
|
868
|
+
* Optional offset for pagination of results.
|
|
869
|
+
*
|
|
870
|
+
* @generated from field: optional uint32 offset = 3;
|
|
871
|
+
*/
|
|
872
|
+
offset?: number;
|
|
873
|
+
};
|
|
874
|
+
|
|
875
|
+
/**
|
|
876
|
+
* Describes the message agntcy.dir.routing.v1.ListPublicationsRequest.
|
|
877
|
+
* Use `create(ListPublicationsRequestSchema)` to create a new message.
|
|
878
|
+
*/
|
|
879
|
+
declare const ListPublicationsRequestSchema: GenMessage<ListPublicationsRequest>;
|
|
880
|
+
|
|
881
|
+
/**
|
|
882
|
+
* @generated from message agntcy.dir.routing.v1.ListRequest
|
|
883
|
+
*/
|
|
884
|
+
declare type ListRequest = Message<"agntcy.dir.routing.v1.ListRequest"> & {
|
|
885
|
+
/**
|
|
886
|
+
* List of queries to match against the records.
|
|
887
|
+
* If set, all queries must match for the record to be returned.
|
|
888
|
+
*
|
|
889
|
+
* @generated from field: repeated agntcy.dir.routing.v1.RecordQuery queries = 1;
|
|
890
|
+
*/
|
|
891
|
+
queries: RecordQuery_2[];
|
|
892
|
+
|
|
893
|
+
/**
|
|
894
|
+
* Limit the number of results returned.
|
|
895
|
+
* If not set, it will return all records that this peer is providing.
|
|
896
|
+
*
|
|
897
|
+
* @generated from field: optional uint32 limit = 2;
|
|
898
|
+
*/
|
|
899
|
+
limit?: number;
|
|
900
|
+
};
|
|
901
|
+
|
|
902
|
+
/**
|
|
903
|
+
* Describes the message agntcy.dir.routing.v1.ListRequest.
|
|
904
|
+
* Use `create(ListRequestSchema)` to create a new message.
|
|
905
|
+
*/
|
|
906
|
+
declare const ListRequestSchema: GenMessage<ListRequest>;
|
|
907
|
+
|
|
908
|
+
/**
|
|
909
|
+
* @generated from message agntcy.dir.routing.v1.ListResponse
|
|
910
|
+
*/
|
|
911
|
+
declare type ListResponse = Message<"agntcy.dir.routing.v1.ListResponse"> & {
|
|
912
|
+
/**
|
|
913
|
+
* The record that matches the list queries.
|
|
914
|
+
*
|
|
915
|
+
* @generated from field: agntcy.dir.core.v1.RecordRef record_ref = 1;
|
|
916
|
+
*/
|
|
917
|
+
recordRef?: RecordRef;
|
|
918
|
+
|
|
919
|
+
/**
|
|
920
|
+
* Labels associated with this record (skills, domains, features)
|
|
921
|
+
* Derived from the record content for CLI display purposes
|
|
922
|
+
*
|
|
923
|
+
* @generated from field: repeated string labels = 2;
|
|
924
|
+
*/
|
|
925
|
+
labels: string[];
|
|
926
|
+
};
|
|
927
|
+
|
|
928
|
+
/**
|
|
929
|
+
* Describes the message agntcy.dir.routing.v1.ListResponse.
|
|
930
|
+
* Use `create(ListResponseSchema)` to create a new message.
|
|
931
|
+
*/
|
|
932
|
+
declare const ListResponseSchema: GenMessage<ListResponse>;
|
|
933
|
+
|
|
934
|
+
/**
|
|
935
|
+
* ListSyncItem represents a single synchronization in the list of all syncs.
|
|
936
|
+
*
|
|
937
|
+
* @generated from message agntcy.dir.store.v1.ListSyncsItem
|
|
938
|
+
*/
|
|
939
|
+
declare type ListSyncsItem = Message<"agntcy.dir.store.v1.ListSyncsItem"> & {
|
|
940
|
+
/**
|
|
941
|
+
* Unique identifier of the synchronization operation.
|
|
942
|
+
*
|
|
943
|
+
* @generated from field: string sync_id = 1;
|
|
944
|
+
*/
|
|
945
|
+
syncId: string;
|
|
946
|
+
|
|
947
|
+
/**
|
|
948
|
+
* Current status of the synchronization operation.
|
|
949
|
+
*
|
|
950
|
+
* @generated from field: agntcy.dir.store.v1.SyncStatus status = 2;
|
|
951
|
+
*/
|
|
952
|
+
status: SyncStatus;
|
|
953
|
+
|
|
954
|
+
/**
|
|
955
|
+
* URL of the remote Directory being synchronized from.
|
|
956
|
+
*
|
|
957
|
+
* @generated from field: string remote_directory_url = 3;
|
|
958
|
+
*/
|
|
959
|
+
remoteDirectoryUrl: string;
|
|
960
|
+
};
|
|
961
|
+
|
|
962
|
+
/**
|
|
963
|
+
* Describes the message agntcy.dir.store.v1.ListSyncsItem.
|
|
964
|
+
* Use `create(ListSyncsItemSchema)` to create a new message.
|
|
965
|
+
*/
|
|
966
|
+
declare const ListSyncsItemSchema: GenMessage<ListSyncsItem>;
|
|
967
|
+
|
|
968
|
+
/**
|
|
969
|
+
* ListSyncsRequest specifies parameters for listing synchronization operations.
|
|
970
|
+
*
|
|
971
|
+
* @generated from message agntcy.dir.store.v1.ListSyncsRequest
|
|
972
|
+
*/
|
|
973
|
+
declare type ListSyncsRequest = Message<"agntcy.dir.store.v1.ListSyncsRequest"> & {
|
|
974
|
+
/**
|
|
975
|
+
* Optional limit on the number of results to return.
|
|
976
|
+
*
|
|
977
|
+
* @generated from field: optional uint32 limit = 2;
|
|
978
|
+
*/
|
|
979
|
+
limit?: number;
|
|
980
|
+
|
|
981
|
+
/**
|
|
982
|
+
* Optional offset for pagination of results.
|
|
983
|
+
*
|
|
984
|
+
* @generated from field: optional uint32 offset = 3;
|
|
985
|
+
*/
|
|
986
|
+
offset?: number;
|
|
987
|
+
};
|
|
988
|
+
|
|
989
|
+
/**
|
|
990
|
+
* Describes the message agntcy.dir.store.v1.ListSyncsRequest.
|
|
991
|
+
* Use `create(ListSyncsRequestSchema)` to create a new message.
|
|
992
|
+
*/
|
|
993
|
+
declare const ListSyncsRequestSchema: GenMessage<ListSyncsRequest>;
|
|
994
|
+
|
|
995
|
+
export declare namespace models {
|
|
996
|
+
export {
|
|
997
|
+
core_v1,
|
|
998
|
+
routing_v1,
|
|
999
|
+
search_v1,
|
|
1000
|
+
sign_v1,
|
|
1001
|
+
store_v1
|
|
1002
|
+
}
|
|
1003
|
+
}
|
|
1004
|
+
|
|
1005
|
+
declare namespace models_2 {
|
|
1006
|
+
export {
|
|
1007
|
+
core_v1,
|
|
1008
|
+
routing_v1,
|
|
1009
|
+
search_v1,
|
|
1010
|
+
sign_v1,
|
|
1011
|
+
store_v1
|
|
1012
|
+
}
|
|
1013
|
+
}
|
|
1014
|
+
|
|
1015
|
+
/**
|
|
1016
|
+
* @generated from message agntcy.dir.routing.v1.Peer
|
|
1017
|
+
*/
|
|
1018
|
+
declare type Peer = Message<"agntcy.dir.routing.v1.Peer"> & {
|
|
1019
|
+
/**
|
|
1020
|
+
* ID of a given peer, typically described by a protocol.
|
|
1021
|
+
* For example:
|
|
1022
|
+
* - SPIFFE: "spiffe://example.org/service/foo"
|
|
1023
|
+
* - JWT: "jwt:sub=alice,iss=https://issuer.example.com"
|
|
1024
|
+
* - Tor: "onion:abcdefghijklmno.onion"
|
|
1025
|
+
* - DID: "did:example:123456789abcdefghi"
|
|
1026
|
+
* - IPFS: "ipfs:QmYwAPJzv5CZsnAzt8auVZRn2E6sD1c4x8pN5o6d5cW4D5"
|
|
1027
|
+
*
|
|
1028
|
+
* @generated from field: string id = 1;
|
|
1029
|
+
*/
|
|
1030
|
+
id: string;
|
|
1031
|
+
|
|
1032
|
+
/**
|
|
1033
|
+
* Multiaddrs for a given peer.
|
|
1034
|
+
* For example:
|
|
1035
|
+
* - "/ip4/127.0.0.1/tcp/4001"
|
|
1036
|
+
* - "/ip6/::1/tcp/4001"
|
|
1037
|
+
* - "/dns4/example.com/tcp/443/https"
|
|
1038
|
+
*
|
|
1039
|
+
* @generated from field: repeated string addrs = 2;
|
|
1040
|
+
*/
|
|
1041
|
+
addrs: string[];
|
|
1042
|
+
|
|
1043
|
+
/**
|
|
1044
|
+
* Additional metadata about the peer.
|
|
1045
|
+
*
|
|
1046
|
+
* @generated from field: map<string, string> annotations = 3;
|
|
1047
|
+
*/
|
|
1048
|
+
annotations: { [key: string]: string };
|
|
1049
|
+
|
|
1050
|
+
/**
|
|
1051
|
+
* Used to signal the sender's connection capabilities to the peer.
|
|
1052
|
+
*
|
|
1053
|
+
* @generated from field: agntcy.dir.routing.v1.PeerConnectionType connection = 4;
|
|
1054
|
+
*/
|
|
1055
|
+
connection: PeerConnectionType;
|
|
1056
|
+
};
|
|
1057
|
+
|
|
1058
|
+
/**
|
|
1059
|
+
* @generated from enum agntcy.dir.routing.v1.PeerConnectionType
|
|
1060
|
+
*/
|
|
1061
|
+
declare enum PeerConnectionType {
|
|
1062
|
+
/**
|
|
1063
|
+
* Sender does not have a connection to peer, and no extra information (default)
|
|
1064
|
+
*
|
|
1065
|
+
* @generated from enum value: PEER_CONNECTION_TYPE_NOT_CONNECTED = 0;
|
|
1066
|
+
*/
|
|
1067
|
+
NOT_CONNECTED = 0,
|
|
1068
|
+
|
|
1069
|
+
/**
|
|
1070
|
+
* Sender has a live connection to peer.
|
|
1071
|
+
*
|
|
1072
|
+
* @generated from enum value: PEER_CONNECTION_TYPE_CONNECTED = 1;
|
|
1073
|
+
*/
|
|
1074
|
+
CONNECTED = 1,
|
|
1075
|
+
|
|
1076
|
+
/**
|
|
1077
|
+
* Sender recently connected to peer.
|
|
1078
|
+
*
|
|
1079
|
+
* @generated from enum value: PEER_CONNECTION_TYPE_CAN_CONNECT = 2;
|
|
1080
|
+
*/
|
|
1081
|
+
CAN_CONNECT = 2,
|
|
1082
|
+
|
|
1083
|
+
/**
|
|
1084
|
+
* Sender made strong effort to connect to peer repeatedly but failed.
|
|
1085
|
+
*
|
|
1086
|
+
* @generated from enum value: PEER_CONNECTION_TYPE_CANNOT_CONNECT = 3;
|
|
1087
|
+
*/
|
|
1088
|
+
CANNOT_CONNECT = 3,
|
|
1089
|
+
}
|
|
1090
|
+
|
|
1091
|
+
/**
|
|
1092
|
+
* Describes the enum agntcy.dir.routing.v1.PeerConnectionType.
|
|
1093
|
+
*/
|
|
1094
|
+
declare const PeerConnectionTypeSchema: GenEnum<PeerConnectionType>;
|
|
1095
|
+
|
|
1096
|
+
/**
|
|
1097
|
+
* Describes the message agntcy.dir.routing.v1.Peer.
|
|
1098
|
+
* Use `create(PeerSchema)` to create a new message.
|
|
1099
|
+
*/
|
|
1100
|
+
declare const PeerSchema: GenMessage<Peer>;
|
|
1101
|
+
|
|
1102
|
+
/**
|
|
1103
|
+
* PublicationService manages publication requests for announcing records to the DHT.
|
|
1104
|
+
*
|
|
1105
|
+
* Publications are stored in the database and processed by a worker that runs every hour.
|
|
1106
|
+
* The publication workflow:
|
|
1107
|
+
* 1. Publications are created via routing's Publish RPC by specifying either a query, a list of CIDs, or all records
|
|
1108
|
+
* 2. Publication requests are added to the database
|
|
1109
|
+
* 3. PublicationWorker queries the data using the publication request from the database to get the list of CIDs to be published
|
|
1110
|
+
* 4. PublicationWorker announces the records with these CIDs to the DHT
|
|
1111
|
+
*
|
|
1112
|
+
* @generated from service agntcy.dir.routing.v1.PublicationService
|
|
1113
|
+
*/
|
|
1114
|
+
declare const PublicationService: GenService<{
|
|
1115
|
+
/**
|
|
1116
|
+
* CreatePublication creates a new publication request that will be processed by the PublicationWorker.
|
|
1117
|
+
* The publication request can specify either a query, a list of specific CIDs, or all records to be announced to the DHT.
|
|
1118
|
+
*
|
|
1119
|
+
* @generated from rpc agntcy.dir.routing.v1.PublicationService.CreatePublication
|
|
1120
|
+
*/
|
|
1121
|
+
createPublication: {
|
|
1122
|
+
methodKind: "unary";
|
|
1123
|
+
input: typeof PublishRequestSchema;
|
|
1124
|
+
output: typeof CreatePublicationResponseSchema;
|
|
1125
|
+
},
|
|
1126
|
+
/**
|
|
1127
|
+
* ListPublications returns a stream of all publication requests in the system.
|
|
1128
|
+
* This allows monitoring of pending, processing, and completed publication requests.
|
|
1129
|
+
*
|
|
1130
|
+
* @generated from rpc agntcy.dir.routing.v1.PublicationService.ListPublications
|
|
1131
|
+
*/
|
|
1132
|
+
listPublications: {
|
|
1133
|
+
methodKind: "server_streaming";
|
|
1134
|
+
input: typeof ListPublicationsRequestSchema;
|
|
1135
|
+
output: typeof ListPublicationsItemSchema;
|
|
1136
|
+
},
|
|
1137
|
+
/**
|
|
1138
|
+
* GetPublication retrieves details of a specific publication request by its identifier.
|
|
1139
|
+
* This includes the current status and any associated metadata.
|
|
1140
|
+
*
|
|
1141
|
+
* @generated from rpc agntcy.dir.routing.v1.PublicationService.GetPublication
|
|
1142
|
+
*/
|
|
1143
|
+
getPublication: {
|
|
1144
|
+
methodKind: "unary";
|
|
1145
|
+
input: typeof GetPublicationRequestSchema;
|
|
1146
|
+
output: typeof GetPublicationResponseSchema;
|
|
1147
|
+
},
|
|
1148
|
+
}>;
|
|
1149
|
+
|
|
1150
|
+
/**
|
|
1151
|
+
* PublicationStatus represents the current state of a publication request.
|
|
1152
|
+
* Publications progress from pending to processing to completed or failed states.
|
|
1153
|
+
*
|
|
1154
|
+
* @generated from enum agntcy.dir.routing.v1.PublicationStatus
|
|
1155
|
+
*/
|
|
1156
|
+
declare enum PublicationStatus {
|
|
1157
|
+
/**
|
|
1158
|
+
* Default/unset status - should not be used in practice
|
|
1159
|
+
*
|
|
1160
|
+
* @generated from enum value: PUBLICATION_STATUS_UNSPECIFIED = 0;
|
|
1161
|
+
*/
|
|
1162
|
+
UNSPECIFIED = 0,
|
|
1163
|
+
|
|
1164
|
+
/**
|
|
1165
|
+
* Sync operation has been created but not yet started
|
|
1166
|
+
*
|
|
1167
|
+
* @generated from enum value: PUBLICATION_STATUS_PENDING = 1;
|
|
1168
|
+
*/
|
|
1169
|
+
PENDING = 1,
|
|
1170
|
+
|
|
1171
|
+
/**
|
|
1172
|
+
* Sync operation is actively discovering and transferring objects
|
|
1173
|
+
*
|
|
1174
|
+
* @generated from enum value: PUBLICATION_STATUS_IN_PROGRESS = 2;
|
|
1175
|
+
*/
|
|
1176
|
+
IN_PROGRESS = 2,
|
|
1177
|
+
|
|
1178
|
+
/**
|
|
1179
|
+
* Sync operation has been successfully completed
|
|
1180
|
+
*
|
|
1181
|
+
* @generated from enum value: PUBLICATION_STATUS_COMPLETED = 3;
|
|
1182
|
+
*/
|
|
1183
|
+
COMPLETED = 3,
|
|
1184
|
+
|
|
1185
|
+
/**
|
|
1186
|
+
* Sync operation encountered an error and stopped
|
|
1187
|
+
*
|
|
1188
|
+
* @generated from enum value: PUBLICATION_STATUS_FAILED = 4;
|
|
1189
|
+
*/
|
|
1190
|
+
FAILED = 4,
|
|
1191
|
+
}
|
|
1192
|
+
|
|
1193
|
+
/**
|
|
1194
|
+
* Describes the enum agntcy.dir.routing.v1.PublicationStatus.
|
|
1195
|
+
*/
|
|
1196
|
+
declare const PublicationStatusSchema: GenEnum<PublicationStatus>;
|
|
1197
|
+
|
|
1198
|
+
/**
|
|
1199
|
+
* @generated from message agntcy.dir.routing.v1.PublishRequest
|
|
1200
|
+
*/
|
|
1201
|
+
declare type PublishRequest = Message<"agntcy.dir.routing.v1.PublishRequest"> & {
|
|
1202
|
+
/**
|
|
1203
|
+
* @generated from oneof agntcy.dir.routing.v1.PublishRequest.request
|
|
1204
|
+
*/
|
|
1205
|
+
request: {
|
|
1206
|
+
/**
|
|
1207
|
+
* References to the records to be published.
|
|
1208
|
+
*
|
|
1209
|
+
* @generated from field: agntcy.dir.routing.v1.RecordRefs record_refs = 1;
|
|
1210
|
+
*/
|
|
1211
|
+
value: RecordRefs;
|
|
1212
|
+
case: "recordRefs";
|
|
1213
|
+
} | {
|
|
1214
|
+
/**
|
|
1215
|
+
* Queries to match against the records to be published.
|
|
1216
|
+
*
|
|
1217
|
+
* @generated from field: agntcy.dir.routing.v1.RecordQueries queries = 2;
|
|
1218
|
+
*/
|
|
1219
|
+
value: RecordQueries;
|
|
1220
|
+
case: "queries";
|
|
1221
|
+
} | { case: undefined; value?: undefined };
|
|
1222
|
+
};
|
|
1223
|
+
|
|
1224
|
+
/**
|
|
1225
|
+
* Describes the message agntcy.dir.routing.v1.PublishRequest.
|
|
1226
|
+
* Use `create(PublishRequestSchema)` to create a new message.
|
|
1227
|
+
*/
|
|
1228
|
+
declare const PublishRequestSchema: GenMessage<PublishRequest>;
|
|
1229
|
+
|
|
1230
|
+
/**
|
|
1231
|
+
* PullReferrerRequest represents a record with optional OCI artifacts for pull operations.
|
|
1232
|
+
*
|
|
1233
|
+
* @generated from message agntcy.dir.store.v1.PullReferrerRequest
|
|
1234
|
+
*/
|
|
1235
|
+
declare type PullReferrerRequest = Message<"agntcy.dir.store.v1.PullReferrerRequest"> & {
|
|
1236
|
+
/**
|
|
1237
|
+
* Record reference
|
|
1238
|
+
*
|
|
1239
|
+
* @generated from field: agntcy.dir.core.v1.RecordRef record_ref = 1;
|
|
1240
|
+
*/
|
|
1241
|
+
recordRef?: RecordRef;
|
|
1242
|
+
|
|
1243
|
+
/**
|
|
1244
|
+
* @generated from oneof agntcy.dir.store.v1.PullReferrerRequest.options
|
|
1245
|
+
*/
|
|
1246
|
+
options: {
|
|
1247
|
+
/**
|
|
1248
|
+
* Pull signature referrer
|
|
1249
|
+
*
|
|
1250
|
+
* @generated from field: bool pull_signature = 2;
|
|
1251
|
+
*/
|
|
1252
|
+
value: boolean;
|
|
1253
|
+
case: "pullSignature";
|
|
1254
|
+
} | {
|
|
1255
|
+
/**
|
|
1256
|
+
* Pull public key referrer
|
|
1257
|
+
*
|
|
1258
|
+
* @generated from field: bool pull_public_key = 3;
|
|
1259
|
+
*/
|
|
1260
|
+
value: boolean;
|
|
1261
|
+
case: "pullPublicKey";
|
|
1262
|
+
} | { case: undefined; value?: undefined };
|
|
1263
|
+
};
|
|
1264
|
+
|
|
1265
|
+
/**
|
|
1266
|
+
* Describes the message agntcy.dir.store.v1.PullReferrerRequest.
|
|
1267
|
+
* Use `create(PullReferrerRequestSchema)` to create a new message.
|
|
1268
|
+
*/
|
|
1269
|
+
declare const PullReferrerRequestSchema: GenMessage<PullReferrerRequest>;
|
|
1270
|
+
|
|
1271
|
+
/**
|
|
1272
|
+
* PullReferrerResponse is returned after successfully fetching a record referrer.
|
|
1273
|
+
*
|
|
1274
|
+
* @generated from message agntcy.dir.store.v1.PullReferrerResponse
|
|
1275
|
+
*/
|
|
1276
|
+
declare type PullReferrerResponse = Message<"agntcy.dir.store.v1.PullReferrerResponse"> & {
|
|
1277
|
+
/**
|
|
1278
|
+
* @generated from oneof agntcy.dir.store.v1.PullReferrerResponse.response
|
|
1279
|
+
*/
|
|
1280
|
+
response: {
|
|
1281
|
+
/**
|
|
1282
|
+
* Signature to be fetched as a referrer
|
|
1283
|
+
*
|
|
1284
|
+
* @generated from field: agntcy.dir.sign.v1.Signature signature = 1;
|
|
1285
|
+
*/
|
|
1286
|
+
value: Signature;
|
|
1287
|
+
case: "signature";
|
|
1288
|
+
} | {
|
|
1289
|
+
/**
|
|
1290
|
+
* Public key to be fetched as a referrer
|
|
1291
|
+
*
|
|
1292
|
+
* @generated from field: string public_key = 2;
|
|
1293
|
+
*/
|
|
1294
|
+
value: string;
|
|
1295
|
+
case: "publicKey";
|
|
1296
|
+
} | { case: undefined; value?: undefined };
|
|
1297
|
+
};
|
|
1298
|
+
|
|
1299
|
+
/**
|
|
1300
|
+
* Describes the message agntcy.dir.store.v1.PullReferrerResponse.
|
|
1301
|
+
* Use `create(PullReferrerResponseSchema)` to create a new message.
|
|
1302
|
+
*/
|
|
1303
|
+
declare const PullReferrerResponseSchema: GenMessage<PullReferrerResponse>;
|
|
1304
|
+
|
|
1305
|
+
/**
|
|
1306
|
+
* PushReferrerRequest represents a record with optional OCI artifacts for push operations.
|
|
1307
|
+
*
|
|
1308
|
+
* @generated from message agntcy.dir.store.v1.PushReferrerRequest
|
|
1309
|
+
*/
|
|
1310
|
+
declare type PushReferrerRequest = Message<"agntcy.dir.store.v1.PushReferrerRequest"> & {
|
|
1311
|
+
/**
|
|
1312
|
+
* Record reference
|
|
1313
|
+
*
|
|
1314
|
+
* @generated from field: agntcy.dir.core.v1.RecordRef record_ref = 1;
|
|
1315
|
+
*/
|
|
1316
|
+
recordRef?: RecordRef;
|
|
1317
|
+
|
|
1318
|
+
/**
|
|
1319
|
+
* Push referrer options
|
|
1320
|
+
*
|
|
1321
|
+
* @generated from oneof agntcy.dir.store.v1.PushReferrerRequest.options
|
|
1322
|
+
*/
|
|
1323
|
+
options: {
|
|
1324
|
+
/**
|
|
1325
|
+
* Signature to be stored as a referrer for the record
|
|
1326
|
+
*
|
|
1327
|
+
* @generated from field: agntcy.dir.sign.v1.Signature signature = 2;
|
|
1328
|
+
*/
|
|
1329
|
+
value: Signature;
|
|
1330
|
+
case: "signature";
|
|
1331
|
+
} | {
|
|
1332
|
+
/**
|
|
1333
|
+
* Public key to be stored as a referrer for the record and uploaded as a file to zot for verification
|
|
1334
|
+
*
|
|
1335
|
+
* @generated from field: string public_key = 3;
|
|
1336
|
+
*/
|
|
1337
|
+
value: string;
|
|
1338
|
+
case: "publicKey";
|
|
1339
|
+
} | { case: undefined; value?: undefined };
|
|
1340
|
+
};
|
|
1341
|
+
|
|
1342
|
+
/**
|
|
1343
|
+
* Describes the message agntcy.dir.store.v1.PushReferrerRequest.
|
|
1344
|
+
* Use `create(PushReferrerRequestSchema)` to create a new message.
|
|
1345
|
+
*/
|
|
1346
|
+
declare const PushReferrerRequestSchema: GenMessage<PushReferrerRequest>;
|
|
1347
|
+
|
|
1348
|
+
/**
|
|
1349
|
+
* PushReferrerResponse
|
|
1350
|
+
*
|
|
1351
|
+
* @generated from message agntcy.dir.store.v1.PushReferrerResponse
|
|
1352
|
+
*/
|
|
1353
|
+
declare type PushReferrerResponse = Message<"agntcy.dir.store.v1.PushReferrerResponse"> & {
|
|
1354
|
+
/**
|
|
1355
|
+
* The push process result
|
|
1356
|
+
*
|
|
1357
|
+
* @generated from field: bool success = 1;
|
|
1358
|
+
*/
|
|
1359
|
+
success: boolean;
|
|
1360
|
+
|
|
1361
|
+
/**
|
|
1362
|
+
* Optional error message if push failed
|
|
1363
|
+
*
|
|
1364
|
+
* @generated from field: optional string error_message = 2;
|
|
1365
|
+
*/
|
|
1366
|
+
errorMessage?: string;
|
|
1367
|
+
};
|
|
1368
|
+
|
|
1369
|
+
/**
|
|
1370
|
+
* Describes the message agntcy.dir.store.v1.PushReferrerResponse.
|
|
1371
|
+
* Use `create(PushReferrerResponseSchema)` to create a new message.
|
|
1372
|
+
*/
|
|
1373
|
+
declare const PushReferrerResponseSchema: GenMessage<PushReferrerResponse>;
|
|
1374
|
+
|
|
1375
|
+
/**
|
|
1376
|
+
* Record is a generic object that encapsulates data of different Record types.
|
|
1377
|
+
*
|
|
1378
|
+
* Supported schemas:
|
|
1379
|
+
*
|
|
1380
|
+
* v0.3.1: https://schema.oasf.outshift.com/0.3.1/objects/agent
|
|
1381
|
+
* v0.7.0: https://schema.oasf.outshift.com/0.7.0/objects/record
|
|
1382
|
+
*
|
|
1383
|
+
* @generated from message agntcy.dir.core.v1.Record
|
|
1384
|
+
*/
|
|
1385
|
+
declare type Record_2 = Message<"agntcy.dir.core.v1.Record"> & {
|
|
1386
|
+
/**
|
|
1387
|
+
* @generated from field: google.protobuf.Struct data = 1;
|
|
1388
|
+
*/
|
|
1389
|
+
data?: JsonObject;
|
|
1390
|
+
};
|
|
1391
|
+
|
|
1392
|
+
/**
|
|
1393
|
+
* Defines metadata about a record.
|
|
1394
|
+
*
|
|
1395
|
+
* @generated from message agntcy.dir.core.v1.RecordMeta
|
|
1396
|
+
*/
|
|
1397
|
+
declare type RecordMeta = Message<"agntcy.dir.core.v1.RecordMeta"> & {
|
|
1398
|
+
/**
|
|
1399
|
+
* CID of the record.
|
|
1400
|
+
*
|
|
1401
|
+
* @generated from field: string cid = 1;
|
|
1402
|
+
*/
|
|
1403
|
+
cid: string;
|
|
1404
|
+
|
|
1405
|
+
/**
|
|
1406
|
+
* Annotations attached to the record.
|
|
1407
|
+
*
|
|
1408
|
+
* @generated from field: map<string, string> annotations = 2;
|
|
1409
|
+
*/
|
|
1410
|
+
annotations: { [key: string]: string };
|
|
1411
|
+
|
|
1412
|
+
/**
|
|
1413
|
+
* Schema version of the record.
|
|
1414
|
+
*
|
|
1415
|
+
* @generated from field: string schema_version = 3;
|
|
1416
|
+
*/
|
|
1417
|
+
schemaVersion: string;
|
|
1418
|
+
|
|
1419
|
+
/**
|
|
1420
|
+
* Creation timestamp of the record in the RFC3339 format.
|
|
1421
|
+
* Specs: https://www.rfc-editor.org/rfc/rfc3339.html
|
|
1422
|
+
*
|
|
1423
|
+
* @generated from field: string created_at = 4;
|
|
1424
|
+
*/
|
|
1425
|
+
createdAt: string;
|
|
1426
|
+
};
|
|
1427
|
+
|
|
1428
|
+
/**
|
|
1429
|
+
* Describes the message agntcy.dir.core.v1.RecordMeta.
|
|
1430
|
+
* Use `create(RecordMetaSchema)` to create a new message.
|
|
1431
|
+
*/
|
|
1432
|
+
declare const RecordMetaSchema: GenMessage<RecordMeta>;
|
|
1433
|
+
|
|
1434
|
+
/**
|
|
1435
|
+
* @generated from message agntcy.dir.routing.v1.RecordQueries
|
|
1436
|
+
*/
|
|
1437
|
+
declare type RecordQueries = Message<"agntcy.dir.routing.v1.RecordQueries"> & {
|
|
1438
|
+
/**
|
|
1439
|
+
* @generated from field: repeated agntcy.dir.search.v1.RecordQuery queries = 1;
|
|
1440
|
+
*/
|
|
1441
|
+
queries: RecordQuery[];
|
|
1442
|
+
};
|
|
1443
|
+
|
|
1444
|
+
/**
|
|
1445
|
+
* Describes the message agntcy.dir.routing.v1.RecordQueries.
|
|
1446
|
+
* Use `create(RecordQueriesSchema)` to create a new message.
|
|
1447
|
+
*/
|
|
1448
|
+
declare const RecordQueriesSchema: GenMessage<RecordQueries>;
|
|
1449
|
+
|
|
1450
|
+
/**
|
|
1451
|
+
* A query to match the record against during discovery.
|
|
1452
|
+
* For example:
|
|
1453
|
+
* Exact match: { type: RECORD_QUERY_TYPE_NAME, value: "my-agent" }
|
|
1454
|
+
* Wildcard match: { type: RECORD_QUERY_TYPE_NAME, value: "web*" }
|
|
1455
|
+
* Pattern match: { type: RECORD_QUERY_TYPE_SKILL_NAME, value: "*machine*learning*" }
|
|
1456
|
+
* Question mark: { type: RECORD_QUERY_TYPE_VERSION, value: "v1.0.?" }
|
|
1457
|
+
* List wildcards: { type: RECORD_QUERY_TYPE_NAME, value: "agent-[0-9]" }
|
|
1458
|
+
* Complex match: { type: RECORD_QUERY_TYPE_LOCATOR, value: "docker-image:https://*.example.com/*" }
|
|
1459
|
+
*
|
|
1460
|
+
* @generated from message agntcy.dir.search.v1.RecordQuery
|
|
1461
|
+
*/
|
|
1462
|
+
declare type RecordQuery = Message<"agntcy.dir.search.v1.RecordQuery"> & {
|
|
1463
|
+
/**
|
|
1464
|
+
* The type of the query to match against.
|
|
1465
|
+
*
|
|
1466
|
+
* @generated from field: agntcy.dir.search.v1.RecordQueryType type = 1;
|
|
1467
|
+
*/
|
|
1468
|
+
type: RecordQueryType;
|
|
1469
|
+
|
|
1470
|
+
/**
|
|
1471
|
+
* The query value to match against.
|
|
1472
|
+
* Supports wildcard patterns:
|
|
1473
|
+
* '*' - matches zero or more characters
|
|
1474
|
+
* '?' - matches exactly one character
|
|
1475
|
+
* '[]' - matches any character within brackets (e.g., [0-9], [a-z], [abc])
|
|
1476
|
+
*
|
|
1477
|
+
* @generated from field: string value = 2;
|
|
1478
|
+
*/
|
|
1479
|
+
value: string;
|
|
1480
|
+
};
|
|
1481
|
+
|
|
1482
|
+
/**
|
|
1483
|
+
* A query to match the record against during discovery.
|
|
1484
|
+
* For example:
|
|
1485
|
+
* { type: RECORD_QUERY_TYPE_SKILL, value: "Natural Language Processing" }
|
|
1486
|
+
* { type: RECORD_QUERY_TYPE_LOCATOR, value: "helm-chart" }
|
|
1487
|
+
* { type: RECORD_QUERY_TYPE_DOMAIN, value: "research" }
|
|
1488
|
+
* { type: RECORD_QUERY_TYPE_FEATURE, value: "runtime/language" }
|
|
1489
|
+
*
|
|
1490
|
+
* @generated from message agntcy.dir.routing.v1.RecordQuery
|
|
1491
|
+
*/
|
|
1492
|
+
declare type RecordQuery_2 = Message<"agntcy.dir.routing.v1.RecordQuery"> & {
|
|
1493
|
+
/**
|
|
1494
|
+
* The type of the query to match against.
|
|
1495
|
+
*
|
|
1496
|
+
* @generated from field: agntcy.dir.routing.v1.RecordQueryType type = 1;
|
|
1497
|
+
*/
|
|
1498
|
+
type: RecordQueryType_2;
|
|
1499
|
+
|
|
1500
|
+
/**
|
|
1501
|
+
* The query value to match against.
|
|
1502
|
+
*
|
|
1503
|
+
* @generated from field: string value = 2;
|
|
1504
|
+
*/
|
|
1505
|
+
value: string;
|
|
1506
|
+
};
|
|
1507
|
+
|
|
1508
|
+
/**
|
|
1509
|
+
* Describes the message agntcy.dir.routing.v1.RecordQuery.
|
|
1510
|
+
* Use `create(RecordQuerySchema)` to create a new message.
|
|
1511
|
+
*/
|
|
1512
|
+
declare const RecordQuerySchema: GenMessage<RecordQuery_2>;
|
|
1513
|
+
|
|
1514
|
+
/**
|
|
1515
|
+
* Describes the message agntcy.dir.search.v1.RecordQuery.
|
|
1516
|
+
* Use `create(RecordQuerySchema)` to create a new message.
|
|
1517
|
+
*/
|
|
1518
|
+
declare const RecordQuerySchema_2: GenMessage<RecordQuery>;
|
|
1519
|
+
|
|
1520
|
+
/**
|
|
1521
|
+
* Defines a list of supported record query types.
|
|
1522
|
+
*
|
|
1523
|
+
* @generated from enum agntcy.dir.search.v1.RecordQueryType
|
|
1524
|
+
*/
|
|
1525
|
+
declare enum RecordQueryType {
|
|
1526
|
+
/**
|
|
1527
|
+
* Unspecified query type.
|
|
1528
|
+
*
|
|
1529
|
+
* @generated from enum value: RECORD_QUERY_TYPE_UNSPECIFIED = 0;
|
|
1530
|
+
*/
|
|
1531
|
+
UNSPECIFIED = 0,
|
|
1532
|
+
|
|
1533
|
+
/**
|
|
1534
|
+
* Query for a record name.
|
|
1535
|
+
* Supports wildcard patterns: "web*", "*service", "api-*-v2", "???api", "agent-[0-9]"
|
|
1536
|
+
*
|
|
1537
|
+
* @generated from enum value: RECORD_QUERY_TYPE_NAME = 1;
|
|
1538
|
+
*/
|
|
1539
|
+
NAME = 1,
|
|
1540
|
+
|
|
1541
|
+
/**
|
|
1542
|
+
* Query for a record version.
|
|
1543
|
+
* Supports wildcard patterns: "v1.*", "v2.*", "*-beta", "v1.0.?", "v[0-9].*"
|
|
1544
|
+
*
|
|
1545
|
+
* @generated from enum value: RECORD_QUERY_TYPE_VERSION = 2;
|
|
1546
|
+
*/
|
|
1547
|
+
VERSION = 2,
|
|
1548
|
+
|
|
1549
|
+
/**
|
|
1550
|
+
* Query for a skill ID.
|
|
1551
|
+
* Numeric field - exact match only, no wildcard support.
|
|
1552
|
+
*
|
|
1553
|
+
* @generated from enum value: RECORD_QUERY_TYPE_SKILL_ID = 3;
|
|
1554
|
+
*/
|
|
1555
|
+
SKILL_ID = 3,
|
|
1556
|
+
|
|
1557
|
+
/**
|
|
1558
|
+
* Query for a skill name.
|
|
1559
|
+
* Supports wildcard patterns: "python*", "*script", "*machine*learning*", "Pytho?", "[A-M]*"
|
|
1560
|
+
*
|
|
1561
|
+
* @generated from enum value: RECORD_QUERY_TYPE_SKILL_NAME = 4;
|
|
1562
|
+
*/
|
|
1563
|
+
SKILL_NAME = 4,
|
|
1564
|
+
|
|
1565
|
+
/**
|
|
1566
|
+
* Query for a locator type.
|
|
1567
|
+
* Supports wildcard patterns: "http*", "ftp*", "*docker*", "[hf]tt[ps]*"
|
|
1568
|
+
*
|
|
1569
|
+
* @generated from enum value: RECORD_QUERY_TYPE_LOCATOR = 5;
|
|
1570
|
+
*/
|
|
1571
|
+
LOCATOR = 5,
|
|
1572
|
+
|
|
1573
|
+
/**
|
|
1574
|
+
* Query for an extension.
|
|
1575
|
+
* Supports wildcard patterns: "*-plugin", "*-extension", "core*", "ext-?", "plugin-[0-9]"
|
|
1576
|
+
*
|
|
1577
|
+
* @generated from enum value: RECORD_QUERY_TYPE_EXTENSION = 6;
|
|
1578
|
+
*/
|
|
1579
|
+
EXTENSION = 6,
|
|
1580
|
+
}
|
|
1581
|
+
|
|
1582
|
+
/**
|
|
1583
|
+
* Defines a list of supported record query types.
|
|
1584
|
+
*
|
|
1585
|
+
* @generated from enum agntcy.dir.routing.v1.RecordQueryType
|
|
1586
|
+
*/
|
|
1587
|
+
declare enum RecordQueryType_2 {
|
|
1588
|
+
/**
|
|
1589
|
+
* Unspecified query type.
|
|
1590
|
+
*
|
|
1591
|
+
* @generated from enum value: RECORD_QUERY_TYPE_UNSPECIFIED = 0;
|
|
1592
|
+
*/
|
|
1593
|
+
UNSPECIFIED = 0,
|
|
1594
|
+
|
|
1595
|
+
/**
|
|
1596
|
+
* Query for a skill name.
|
|
1597
|
+
*
|
|
1598
|
+
* @generated from enum value: RECORD_QUERY_TYPE_SKILL = 1;
|
|
1599
|
+
*/
|
|
1600
|
+
SKILL = 1,
|
|
1601
|
+
|
|
1602
|
+
/**
|
|
1603
|
+
* Query for a locator type.
|
|
1604
|
+
*
|
|
1605
|
+
* @generated from enum value: RECORD_QUERY_TYPE_LOCATOR = 2;
|
|
1606
|
+
*/
|
|
1607
|
+
LOCATOR = 2,
|
|
1608
|
+
|
|
1609
|
+
/**
|
|
1610
|
+
* Query for a domain name.
|
|
1611
|
+
*
|
|
1612
|
+
* @generated from enum value: RECORD_QUERY_TYPE_DOMAIN = 3;
|
|
1613
|
+
*/
|
|
1614
|
+
DOMAIN = 3,
|
|
1615
|
+
|
|
1616
|
+
/**
|
|
1617
|
+
* Query for a feature name.
|
|
1618
|
+
*
|
|
1619
|
+
* @generated from enum value: RECORD_QUERY_TYPE_FEATURE = 4;
|
|
1620
|
+
*/
|
|
1621
|
+
FEATURE = 4,
|
|
1622
|
+
}
|
|
1623
|
+
|
|
1624
|
+
/**
|
|
1625
|
+
* Describes the enum agntcy.dir.routing.v1.RecordQueryType.
|
|
1626
|
+
*/
|
|
1627
|
+
declare const RecordQueryTypeSchema: GenEnum<RecordQueryType_2>;
|
|
1628
|
+
|
|
1629
|
+
/**
|
|
1630
|
+
* Describes the enum agntcy.dir.search.v1.RecordQueryType.
|
|
1631
|
+
*/
|
|
1632
|
+
declare const RecordQueryTypeSchema_2: GenEnum<RecordQueryType>;
|
|
1633
|
+
|
|
1634
|
+
/**
|
|
1635
|
+
* Defines a reference or a globally unique content identifier of a record.
|
|
1636
|
+
*
|
|
1637
|
+
* @generated from message agntcy.dir.core.v1.RecordRef
|
|
1638
|
+
*/
|
|
1639
|
+
declare type RecordRef = Message<"agntcy.dir.core.v1.RecordRef"> & {
|
|
1640
|
+
/**
|
|
1641
|
+
* Globally-unique content identifier (CID) of the record.
|
|
1642
|
+
* Specs: https://github.com/multiformats/cid
|
|
1643
|
+
*
|
|
1644
|
+
* @generated from field: string cid = 1;
|
|
1645
|
+
*/
|
|
1646
|
+
cid: string;
|
|
1647
|
+
};
|
|
1648
|
+
|
|
1649
|
+
/**
|
|
1650
|
+
* @generated from message agntcy.dir.routing.v1.RecordRefs
|
|
1651
|
+
*/
|
|
1652
|
+
declare type RecordRefs = Message<"agntcy.dir.routing.v1.RecordRefs"> & {
|
|
1653
|
+
/**
|
|
1654
|
+
* @generated from field: repeated agntcy.dir.core.v1.RecordRef refs = 1;
|
|
1655
|
+
*/
|
|
1656
|
+
refs: RecordRef[];
|
|
1657
|
+
};
|
|
1658
|
+
|
|
1659
|
+
/**
|
|
1660
|
+
* Describes the message agntcy.dir.core.v1.RecordRef.
|
|
1661
|
+
* Use `create(RecordRefSchema)` to create a new message.
|
|
1662
|
+
*/
|
|
1663
|
+
declare const RecordRefSchema: GenMessage<RecordRef>;
|
|
1664
|
+
|
|
1665
|
+
/**
|
|
1666
|
+
* Describes the message agntcy.dir.routing.v1.RecordRefs.
|
|
1667
|
+
* Use `create(RecordRefsSchema)` to create a new message.
|
|
1668
|
+
*/
|
|
1669
|
+
declare const RecordRefsSchema: GenMessage<RecordRefs>;
|
|
1670
|
+
|
|
1671
|
+
/**
|
|
1672
|
+
* Describes the message agntcy.dir.core.v1.Record.
|
|
1673
|
+
* Use `create(RecordSchema)` to create a new message.
|
|
1674
|
+
*/
|
|
1675
|
+
declare const RecordSchema: GenMessage<Record_2>;
|
|
1676
|
+
|
|
1677
|
+
/**
|
|
1678
|
+
* @generated from message agntcy.dir.store.v1.RequestRegistryCredentialsRequest
|
|
1679
|
+
*/
|
|
1680
|
+
declare type RequestRegistryCredentialsRequest = Message<"agntcy.dir.store.v1.RequestRegistryCredentialsRequest"> & {
|
|
1681
|
+
/**
|
|
1682
|
+
* Identity of the requesting node
|
|
1683
|
+
* For example: spiffe://example.org/service/foo
|
|
1684
|
+
*
|
|
1685
|
+
* @generated from field: string requesting_node_id = 1;
|
|
1686
|
+
*/
|
|
1687
|
+
requestingNodeId: string;
|
|
1688
|
+
};
|
|
1689
|
+
|
|
1690
|
+
/**
|
|
1691
|
+
* Describes the message agntcy.dir.store.v1.RequestRegistryCredentialsRequest.
|
|
1692
|
+
* Use `create(RequestRegistryCredentialsRequestSchema)` to create a new message.
|
|
1693
|
+
*/
|
|
1694
|
+
declare const RequestRegistryCredentialsRequestSchema: GenMessage<RequestRegistryCredentialsRequest>;
|
|
1695
|
+
|
|
1696
|
+
/**
|
|
1697
|
+
* @generated from message agntcy.dir.store.v1.RequestRegistryCredentialsResponse
|
|
1698
|
+
*/
|
|
1699
|
+
declare type RequestRegistryCredentialsResponse = Message<"agntcy.dir.store.v1.RequestRegistryCredentialsResponse"> & {
|
|
1700
|
+
/**
|
|
1701
|
+
* Success status of the credential negotiation
|
|
1702
|
+
*
|
|
1703
|
+
* @generated from field: bool success = 1;
|
|
1704
|
+
*/
|
|
1705
|
+
success: boolean;
|
|
1706
|
+
|
|
1707
|
+
/**
|
|
1708
|
+
* Error message if negotiation failed
|
|
1709
|
+
*
|
|
1710
|
+
* @generated from field: string error_message = 2;
|
|
1711
|
+
*/
|
|
1712
|
+
errorMessage: string;
|
|
1713
|
+
|
|
1714
|
+
/**
|
|
1715
|
+
* URL of the remote Registry being synchronized from.
|
|
1716
|
+
*
|
|
1717
|
+
* @generated from field: string remote_registry_url = 3;
|
|
1718
|
+
*/
|
|
1719
|
+
remoteRegistryUrl: string;
|
|
1720
|
+
|
|
1721
|
+
/**
|
|
1722
|
+
* Registry credentials (oneof based on credential type)
|
|
1723
|
+
*
|
|
1724
|
+
* @generated from oneof agntcy.dir.store.v1.RequestRegistryCredentialsResponse.credentials
|
|
1725
|
+
*/
|
|
1726
|
+
credentials: {
|
|
1727
|
+
/**
|
|
1728
|
+
* CertificateCredentials certificate = 5;
|
|
1729
|
+
*
|
|
1730
|
+
* @generated from field: agntcy.dir.store.v1.BasicAuthCredentials basic_auth = 4;
|
|
1731
|
+
*/
|
|
1732
|
+
value: BasicAuthCredentials;
|
|
1733
|
+
case: "basicAuth";
|
|
1734
|
+
} | { case: undefined; value?: undefined };
|
|
1735
|
+
};
|
|
1736
|
+
|
|
1737
|
+
/**
|
|
1738
|
+
* Describes the message agntcy.dir.store.v1.RequestRegistryCredentialsResponse.
|
|
1739
|
+
* Use `create(RequestRegistryCredentialsResponseSchema)` to create a new message.
|
|
1740
|
+
*/
|
|
1741
|
+
declare const RequestRegistryCredentialsResponseSchema: GenMessage<RequestRegistryCredentialsResponse>;
|
|
1742
|
+
|
|
1743
|
+
export declare namespace routing_v1 {
|
|
1744
|
+
export {
|
|
1745
|
+
file_agntcy_dir_routing_v1_peer,
|
|
1746
|
+
Peer,
|
|
1747
|
+
PeerSchema,
|
|
1748
|
+
PeerConnectionType,
|
|
1749
|
+
PeerConnectionTypeSchema,
|
|
1750
|
+
file_agntcy_dir_routing_v1_publication_service,
|
|
1751
|
+
CreatePublicationResponse,
|
|
1752
|
+
CreatePublicationResponseSchema,
|
|
1753
|
+
ListPublicationsRequest,
|
|
1754
|
+
ListPublicationsRequestSchema,
|
|
1755
|
+
ListPublicationsItem,
|
|
1756
|
+
ListPublicationsItemSchema,
|
|
1757
|
+
GetPublicationRequest,
|
|
1758
|
+
GetPublicationRequestSchema,
|
|
1759
|
+
GetPublicationResponse,
|
|
1760
|
+
GetPublicationResponseSchema,
|
|
1761
|
+
PublicationStatus,
|
|
1762
|
+
PublicationStatusSchema,
|
|
1763
|
+
PublicationService,
|
|
1764
|
+
file_agntcy_dir_routing_v1_record_query,
|
|
1765
|
+
RecordQuery_2 as RecordQuery,
|
|
1766
|
+
RecordQuerySchema,
|
|
1767
|
+
RecordQueryType_2 as RecordQueryType,
|
|
1768
|
+
RecordQueryTypeSchema,
|
|
1769
|
+
file_agntcy_dir_routing_v1_routing_service,
|
|
1770
|
+
PublishRequest,
|
|
1771
|
+
PublishRequestSchema,
|
|
1772
|
+
UnpublishRequest,
|
|
1773
|
+
UnpublishRequestSchema,
|
|
1774
|
+
RecordRefs,
|
|
1775
|
+
RecordRefsSchema,
|
|
1776
|
+
RecordQueries,
|
|
1777
|
+
RecordQueriesSchema,
|
|
1778
|
+
SearchRequest,
|
|
1779
|
+
SearchRequestSchema,
|
|
1780
|
+
SearchResponse,
|
|
1781
|
+
SearchResponseSchema,
|
|
1782
|
+
ListRequest,
|
|
1783
|
+
ListRequestSchema,
|
|
1784
|
+
ListResponse,
|
|
1785
|
+
ListResponseSchema,
|
|
1786
|
+
RoutingService
|
|
1787
|
+
}
|
|
1788
|
+
}
|
|
1789
|
+
|
|
1790
|
+
/**
|
|
1791
|
+
* Defines an interface for announcement and discovery
|
|
1792
|
+
* of records across interconnected network.
|
|
1793
|
+
*
|
|
1794
|
+
* Middleware should be used to control who can perform these RPCs.
|
|
1795
|
+
* Policies for the middleware can be handled via separate service.
|
|
1796
|
+
*
|
|
1797
|
+
* @generated from service agntcy.dir.routing.v1.RoutingService
|
|
1798
|
+
*/
|
|
1799
|
+
declare const RoutingService: GenService<{
|
|
1800
|
+
/**
|
|
1801
|
+
* Announce to the network that this peer is providing a given record.
|
|
1802
|
+
* This enables other peers to discover this record and retrieve it
|
|
1803
|
+
* from this peer. Listeners can use this event to perform custom operations,
|
|
1804
|
+
* for example by cloning the record.
|
|
1805
|
+
*
|
|
1806
|
+
* Items need to be periodically republished (eg. 24h) to the network
|
|
1807
|
+
* to avoid stale data. Republication should be done in the background.
|
|
1808
|
+
*
|
|
1809
|
+
* @generated from rpc agntcy.dir.routing.v1.RoutingService.Publish
|
|
1810
|
+
*/
|
|
1811
|
+
publish: {
|
|
1812
|
+
methodKind: "unary";
|
|
1813
|
+
input: typeof PublishRequestSchema;
|
|
1814
|
+
output: typeof EmptySchema;
|
|
1815
|
+
},
|
|
1816
|
+
/**
|
|
1817
|
+
* Stop serving this record to the network. If other peers try
|
|
1818
|
+
* to retrieve this record, the peer will refuse the request.
|
|
1819
|
+
*
|
|
1820
|
+
* @generated from rpc agntcy.dir.routing.v1.RoutingService.Unpublish
|
|
1821
|
+
*/
|
|
1822
|
+
unpublish: {
|
|
1823
|
+
methodKind: "unary";
|
|
1824
|
+
input: typeof UnpublishRequestSchema;
|
|
1825
|
+
output: typeof EmptySchema;
|
|
1826
|
+
},
|
|
1827
|
+
/**
|
|
1828
|
+
* Search records based on the request across the network.
|
|
1829
|
+
* This will search the network for the record with the given parameters.
|
|
1830
|
+
*
|
|
1831
|
+
* It is possible that the records are stale or that they do not exist.
|
|
1832
|
+
* Some records may be provided by multiple peers.
|
|
1833
|
+
*
|
|
1834
|
+
* Results from the search can be used as an input
|
|
1835
|
+
* to Pull operation to retrieve the records.
|
|
1836
|
+
*
|
|
1837
|
+
* @generated from rpc agntcy.dir.routing.v1.RoutingService.Search
|
|
1838
|
+
*/
|
|
1839
|
+
search: {
|
|
1840
|
+
methodKind: "server_streaming";
|
|
1841
|
+
input: typeof SearchRequestSchema;
|
|
1842
|
+
output: typeof SearchResponseSchema;
|
|
1843
|
+
},
|
|
1844
|
+
/**
|
|
1845
|
+
* List all records that this peer is currently providing
|
|
1846
|
+
* that match the given parameters.
|
|
1847
|
+
* This operation does not interact with the network.
|
|
1848
|
+
*
|
|
1849
|
+
* @generated from rpc agntcy.dir.routing.v1.RoutingService.List
|
|
1850
|
+
*/
|
|
1851
|
+
list: {
|
|
1852
|
+
methodKind: "server_streaming";
|
|
1853
|
+
input: typeof ListRequestSchema;
|
|
1854
|
+
output: typeof ListResponseSchema;
|
|
1855
|
+
},
|
|
1856
|
+
}>;
|
|
1857
|
+
|
|
1858
|
+
export declare namespace search_v1 {
|
|
1859
|
+
export {
|
|
1860
|
+
file_agntcy_dir_search_v1_record_query,
|
|
1861
|
+
RecordQuery,
|
|
1862
|
+
RecordQuerySchema_2 as RecordQuerySchema,
|
|
1863
|
+
RecordQueryType,
|
|
1864
|
+
RecordQueryTypeSchema_2 as RecordQueryTypeSchema,
|
|
1865
|
+
file_agntcy_dir_search_v1_search_service,
|
|
1866
|
+
SearchRequest_2 as SearchRequest,
|
|
1867
|
+
SearchRequestSchema_2 as SearchRequestSchema,
|
|
1868
|
+
SearchResponse_2 as SearchResponse,
|
|
1869
|
+
SearchResponseSchema_2 as SearchResponseSchema,
|
|
1870
|
+
SearchService
|
|
1871
|
+
}
|
|
1872
|
+
}
|
|
1873
|
+
|
|
1874
|
+
/**
|
|
1875
|
+
* @generated from message agntcy.dir.routing.v1.SearchRequest
|
|
1876
|
+
*/
|
|
1877
|
+
declare type SearchRequest = Message<"agntcy.dir.routing.v1.SearchRequest"> & {
|
|
1878
|
+
/**
|
|
1879
|
+
* List of queries to match against the records.
|
|
1880
|
+
*
|
|
1881
|
+
* @generated from field: repeated agntcy.dir.routing.v1.RecordQuery queries = 1;
|
|
1882
|
+
*/
|
|
1883
|
+
queries: RecordQuery_2[];
|
|
1884
|
+
|
|
1885
|
+
/**
|
|
1886
|
+
* Minimal target query match score.
|
|
1887
|
+
* For example, if min_match_score=2, it will return records that match
|
|
1888
|
+
* at least two of the queries.
|
|
1889
|
+
* If not set, it will return records that match at least one query.
|
|
1890
|
+
*
|
|
1891
|
+
* @generated from field: optional uint32 min_match_score = 2;
|
|
1892
|
+
*/
|
|
1893
|
+
minMatchScore?: number;
|
|
1894
|
+
|
|
1895
|
+
/**
|
|
1896
|
+
* Limit the number of results returned.
|
|
1897
|
+
* If not set, it will return all discovered records.
|
|
1898
|
+
* Note that this is a soft limit, as the search may return more results
|
|
1899
|
+
* than the limit if there are multiple peers providing the same record.
|
|
1900
|
+
*
|
|
1901
|
+
* @generated from field: optional uint32 limit = 3;
|
|
1902
|
+
*/
|
|
1903
|
+
limit?: number;
|
|
1904
|
+
};
|
|
1905
|
+
|
|
1906
|
+
/**
|
|
1907
|
+
* @generated from message agntcy.dir.search.v1.SearchRequest
|
|
1908
|
+
*/
|
|
1909
|
+
declare type SearchRequest_2 = Message<"agntcy.dir.search.v1.SearchRequest"> & {
|
|
1910
|
+
/**
|
|
1911
|
+
* List of queries to match against the records.
|
|
1912
|
+
*
|
|
1913
|
+
* @generated from field: repeated agntcy.dir.search.v1.RecordQuery queries = 1;
|
|
1914
|
+
*/
|
|
1915
|
+
queries: RecordQuery[];
|
|
1916
|
+
|
|
1917
|
+
/**
|
|
1918
|
+
* Optional limit on the number of results to return.
|
|
1919
|
+
*
|
|
1920
|
+
* @generated from field: optional uint32 limit = 2;
|
|
1921
|
+
*/
|
|
1922
|
+
limit?: number;
|
|
1923
|
+
|
|
1924
|
+
/**
|
|
1925
|
+
* Optional offset for pagination of results.
|
|
1926
|
+
*
|
|
1927
|
+
* @generated from field: optional uint32 offset = 3;
|
|
1928
|
+
*/
|
|
1929
|
+
offset?: number;
|
|
1930
|
+
};
|
|
1931
|
+
|
|
1932
|
+
/**
|
|
1933
|
+
* Describes the message agntcy.dir.routing.v1.SearchRequest.
|
|
1934
|
+
* Use `create(SearchRequestSchema)` to create a new message.
|
|
1935
|
+
*/
|
|
1936
|
+
declare const SearchRequestSchema: GenMessage<SearchRequest>;
|
|
1937
|
+
|
|
1938
|
+
/**
|
|
1939
|
+
* Describes the message agntcy.dir.search.v1.SearchRequest.
|
|
1940
|
+
* Use `create(SearchRequestSchema)` to create a new message.
|
|
1941
|
+
*/
|
|
1942
|
+
declare const SearchRequestSchema_2: GenMessage<SearchRequest_2>;
|
|
1943
|
+
|
|
1944
|
+
/**
|
|
1945
|
+
* @generated from message agntcy.dir.routing.v1.SearchResponse
|
|
1946
|
+
*/
|
|
1947
|
+
declare type SearchResponse = Message<"agntcy.dir.routing.v1.SearchResponse"> & {
|
|
1948
|
+
/**
|
|
1949
|
+
* The record that matches the search query.
|
|
1950
|
+
*
|
|
1951
|
+
* @generated from field: agntcy.dir.core.v1.RecordRef record_ref = 1;
|
|
1952
|
+
*/
|
|
1953
|
+
recordRef?: RecordRef;
|
|
1954
|
+
|
|
1955
|
+
/**
|
|
1956
|
+
* The peer that provided the record.
|
|
1957
|
+
*
|
|
1958
|
+
* @generated from field: agntcy.dir.routing.v1.Peer peer = 2;
|
|
1959
|
+
*/
|
|
1960
|
+
peer?: Peer;
|
|
1961
|
+
|
|
1962
|
+
/**
|
|
1963
|
+
* The queries that were matched.
|
|
1964
|
+
*
|
|
1965
|
+
* @generated from field: repeated agntcy.dir.routing.v1.RecordQuery match_queries = 3;
|
|
1966
|
+
*/
|
|
1967
|
+
matchQueries: RecordQuery_2[];
|
|
1968
|
+
|
|
1969
|
+
/**
|
|
1970
|
+
* The score of the search match.
|
|
1971
|
+
*
|
|
1972
|
+
* @generated from field: uint32 match_score = 4;
|
|
1973
|
+
*/
|
|
1974
|
+
matchScore: number;
|
|
1975
|
+
};
|
|
1976
|
+
|
|
1977
|
+
/**
|
|
1978
|
+
* @generated from message agntcy.dir.search.v1.SearchResponse
|
|
1979
|
+
*/
|
|
1980
|
+
declare type SearchResponse_2 = Message<"agntcy.dir.search.v1.SearchResponse"> & {
|
|
1981
|
+
/**
|
|
1982
|
+
* The CID of the record that matches the search criteria.
|
|
1983
|
+
*
|
|
1984
|
+
* @generated from field: string record_cid = 1;
|
|
1985
|
+
*/
|
|
1986
|
+
recordCid: string;
|
|
1987
|
+
};
|
|
1988
|
+
|
|
1989
|
+
/**
|
|
1990
|
+
* Describes the message agntcy.dir.routing.v1.SearchResponse.
|
|
1991
|
+
* Use `create(SearchResponseSchema)` to create a new message.
|
|
1992
|
+
*/
|
|
1993
|
+
declare const SearchResponseSchema: GenMessage<SearchResponse>;
|
|
1994
|
+
|
|
1995
|
+
/**
|
|
1996
|
+
* Describes the message agntcy.dir.search.v1.SearchResponse.
|
|
1997
|
+
* Use `create(SearchResponseSchema)` to create a new message.
|
|
1998
|
+
*/
|
|
1999
|
+
declare const SearchResponseSchema_2: GenMessage<SearchResponse_2>;
|
|
2000
|
+
|
|
2001
|
+
/**
|
|
2002
|
+
* @generated from service agntcy.dir.search.v1.SearchService
|
|
2003
|
+
*/
|
|
2004
|
+
declare const SearchService: GenService<{
|
|
2005
|
+
/**
|
|
2006
|
+
* List records that this peer is currently providing that match the given parameters.
|
|
2007
|
+
* This operation does not interact with the network.
|
|
2008
|
+
*
|
|
2009
|
+
* @generated from rpc agntcy.dir.search.v1.SearchService.Search
|
|
2010
|
+
*/
|
|
2011
|
+
search: {
|
|
2012
|
+
methodKind: "server_streaming";
|
|
2013
|
+
input: typeof SearchRequestSchema_2;
|
|
2014
|
+
output: typeof SearchResponseSchema_2;
|
|
2015
|
+
},
|
|
2016
|
+
}>;
|
|
2017
|
+
|
|
2018
|
+
export declare namespace sign_v1 {
|
|
2019
|
+
export {
|
|
2020
|
+
file_agntcy_dir_sign_v1_sign_service,
|
|
2021
|
+
SignRequest,
|
|
2022
|
+
SignRequestSchema,
|
|
2023
|
+
SignRequestProvider,
|
|
2024
|
+
SignRequestProviderSchema,
|
|
2025
|
+
SignWithOIDC,
|
|
2026
|
+
SignWithOIDCSchema,
|
|
2027
|
+
SignWithOIDC_SignOpts,
|
|
2028
|
+
SignWithOIDC_SignOptsSchema,
|
|
2029
|
+
SignWithKey,
|
|
2030
|
+
SignWithKeySchema,
|
|
2031
|
+
SignResponse,
|
|
2032
|
+
SignResponseSchema,
|
|
2033
|
+
VerifyRequest,
|
|
2034
|
+
VerifyRequestSchema,
|
|
2035
|
+
VerifyResponse,
|
|
2036
|
+
VerifyResponseSchema,
|
|
2037
|
+
Signature,
|
|
2038
|
+
SignatureSchema,
|
|
2039
|
+
SignService
|
|
2040
|
+
}
|
|
2041
|
+
}
|
|
2042
|
+
|
|
2043
|
+
/**
|
|
2044
|
+
* @generated from message agntcy.dir.sign.v1.Signature
|
|
2045
|
+
*/
|
|
2046
|
+
declare type Signature = Message<"agntcy.dir.sign.v1.Signature"> & {
|
|
2047
|
+
/**
|
|
2048
|
+
* Metadata associated with the signature.
|
|
2049
|
+
*
|
|
2050
|
+
* @generated from field: map<string, string> annotations = 1;
|
|
2051
|
+
*/
|
|
2052
|
+
annotations: { [key: string]: string };
|
|
2053
|
+
|
|
2054
|
+
/**
|
|
2055
|
+
* Signing timestamp of the record in the RFC3339 format.
|
|
2056
|
+
* Specs: https://www.rfc-editor.org/rfc/rfc3339.html
|
|
2057
|
+
*
|
|
2058
|
+
* @generated from field: string signed_at = 2;
|
|
2059
|
+
*/
|
|
2060
|
+
signedAt: string;
|
|
2061
|
+
|
|
2062
|
+
/**
|
|
2063
|
+
* The signature algorithm used (e.g., "ECDSA_P256_SHA256").
|
|
2064
|
+
*
|
|
2065
|
+
* @generated from field: string algorithm = 3;
|
|
2066
|
+
*/
|
|
2067
|
+
algorithm: string;
|
|
2068
|
+
|
|
2069
|
+
/**
|
|
2070
|
+
* Base64-encoded signature.
|
|
2071
|
+
*
|
|
2072
|
+
* @generated from field: string signature = 4;
|
|
2073
|
+
*/
|
|
2074
|
+
signature: string;
|
|
2075
|
+
|
|
2076
|
+
/**
|
|
2077
|
+
* Base64-encoded signing certificate.
|
|
2078
|
+
*
|
|
2079
|
+
* @generated from field: string certificate = 5;
|
|
2080
|
+
*/
|
|
2081
|
+
certificate: string;
|
|
2082
|
+
|
|
2083
|
+
/**
|
|
2084
|
+
* Type of the signature content bundle.
|
|
2085
|
+
*
|
|
2086
|
+
* @generated from field: string content_type = 6;
|
|
2087
|
+
*/
|
|
2088
|
+
contentType: string;
|
|
2089
|
+
|
|
2090
|
+
/**
|
|
2091
|
+
* Base64-encoded signature bundle produced by the signer.
|
|
2092
|
+
* It is up to the client to interpret the content of the bundle.
|
|
2093
|
+
*
|
|
2094
|
+
* @generated from field: string content_bundle = 7;
|
|
2095
|
+
*/
|
|
2096
|
+
contentBundle: string;
|
|
2097
|
+
};
|
|
2098
|
+
|
|
2099
|
+
/**
|
|
2100
|
+
* Describes the message agntcy.dir.sign.v1.Signature.
|
|
2101
|
+
* Use `create(SignatureSchema)` to create a new message.
|
|
2102
|
+
*/
|
|
2103
|
+
declare const SignatureSchema: GenMessage<Signature>;
|
|
2104
|
+
|
|
2105
|
+
/**
|
|
2106
|
+
* @generated from message agntcy.dir.sign.v1.SignRequest
|
|
2107
|
+
*/
|
|
2108
|
+
declare type SignRequest = Message<"agntcy.dir.sign.v1.SignRequest"> & {
|
|
2109
|
+
/**
|
|
2110
|
+
* Record reference to be signed
|
|
2111
|
+
*
|
|
2112
|
+
* @generated from field: agntcy.dir.core.v1.RecordRef record_ref = 1;
|
|
2113
|
+
*/
|
|
2114
|
+
recordRef?: RecordRef;
|
|
2115
|
+
|
|
2116
|
+
/**
|
|
2117
|
+
* Signing provider to use
|
|
2118
|
+
*
|
|
2119
|
+
* @generated from field: agntcy.dir.sign.v1.SignRequestProvider provider = 2;
|
|
2120
|
+
*/
|
|
2121
|
+
provider?: SignRequestProvider;
|
|
2122
|
+
};
|
|
2123
|
+
|
|
2124
|
+
/**
|
|
2125
|
+
* @generated from message agntcy.dir.sign.v1.SignRequestProvider
|
|
2126
|
+
*/
|
|
2127
|
+
declare type SignRequestProvider = Message<"agntcy.dir.sign.v1.SignRequestProvider"> & {
|
|
2128
|
+
/**
|
|
2129
|
+
* @generated from oneof agntcy.dir.sign.v1.SignRequestProvider.request
|
|
2130
|
+
*/
|
|
2131
|
+
request: {
|
|
2132
|
+
/**
|
|
2133
|
+
* Sign with OIDC provider
|
|
2134
|
+
*
|
|
2135
|
+
* @generated from field: agntcy.dir.sign.v1.SignWithOIDC oidc = 1;
|
|
2136
|
+
*/
|
|
2137
|
+
value: SignWithOIDC;
|
|
2138
|
+
case: "oidc";
|
|
2139
|
+
} | {
|
|
2140
|
+
/**
|
|
2141
|
+
* Sign with PEM-encoded public key
|
|
2142
|
+
*
|
|
2143
|
+
* @generated from field: agntcy.dir.sign.v1.SignWithKey key = 2;
|
|
2144
|
+
*/
|
|
2145
|
+
value: SignWithKey;
|
|
2146
|
+
case: "key";
|
|
2147
|
+
} | { case: undefined; value?: undefined };
|
|
2148
|
+
};
|
|
2149
|
+
|
|
2150
|
+
/**
|
|
2151
|
+
* Describes the message agntcy.dir.sign.v1.SignRequestProvider.
|
|
2152
|
+
* Use `create(SignRequestProviderSchema)` to create a new message.
|
|
2153
|
+
*/
|
|
2154
|
+
declare const SignRequestProviderSchema: GenMessage<SignRequestProvider>;
|
|
2155
|
+
|
|
2156
|
+
/**
|
|
2157
|
+
* Describes the message agntcy.dir.sign.v1.SignRequest.
|
|
2158
|
+
* Use `create(SignRequestSchema)` to create a new message.
|
|
2159
|
+
*/
|
|
2160
|
+
declare const SignRequestSchema: GenMessage<SignRequest>;
|
|
2161
|
+
|
|
2162
|
+
/**
|
|
2163
|
+
* @generated from message agntcy.dir.sign.v1.SignResponse
|
|
2164
|
+
*/
|
|
2165
|
+
declare type SignResponse = Message<"agntcy.dir.sign.v1.SignResponse"> & {
|
|
2166
|
+
/**
|
|
2167
|
+
* Cryptographic signature of the record
|
|
2168
|
+
*
|
|
2169
|
+
* @generated from field: agntcy.dir.sign.v1.Signature signature = 1;
|
|
2170
|
+
*/
|
|
2171
|
+
signature?: Signature;
|
|
2172
|
+
};
|
|
2173
|
+
|
|
2174
|
+
/**
|
|
2175
|
+
* Describes the message agntcy.dir.sign.v1.SignResponse.
|
|
2176
|
+
* Use `create(SignResponseSchema)` to create a new message.
|
|
2177
|
+
*/
|
|
2178
|
+
declare const SignResponseSchema: GenMessage<SignResponse>;
|
|
2179
|
+
|
|
2180
|
+
/**
|
|
2181
|
+
* @generated from service agntcy.dir.sign.v1.SignService
|
|
2182
|
+
*/
|
|
2183
|
+
declare const SignService: GenService<{
|
|
2184
|
+
/**
|
|
2185
|
+
* Sign record using keyless OIDC based provider or using PEM-encoded private key with an optional passphrase
|
|
2186
|
+
*
|
|
2187
|
+
* @generated from rpc agntcy.dir.sign.v1.SignService.Sign
|
|
2188
|
+
*/
|
|
2189
|
+
sign: {
|
|
2190
|
+
methodKind: "unary";
|
|
2191
|
+
input: typeof SignRequestSchema;
|
|
2192
|
+
output: typeof SignResponseSchema;
|
|
2193
|
+
},
|
|
2194
|
+
/**
|
|
2195
|
+
* Verify signed record using keyless OIDC based provider or using PEM-encoded formatted PEM public key encrypted
|
|
2196
|
+
*
|
|
2197
|
+
* @generated from rpc agntcy.dir.sign.v1.SignService.Verify
|
|
2198
|
+
*/
|
|
2199
|
+
verify: {
|
|
2200
|
+
methodKind: "unary";
|
|
2201
|
+
input: typeof VerifyRequestSchema;
|
|
2202
|
+
output: typeof VerifyResponseSchema;
|
|
2203
|
+
},
|
|
2204
|
+
}>;
|
|
2205
|
+
|
|
2206
|
+
/**
|
|
2207
|
+
* @generated from message agntcy.dir.sign.v1.SignWithKey
|
|
2208
|
+
*/
|
|
2209
|
+
declare type SignWithKey = Message<"agntcy.dir.sign.v1.SignWithKey"> & {
|
|
2210
|
+
/**
|
|
2211
|
+
* Private key used for signing
|
|
2212
|
+
*
|
|
2213
|
+
* @generated from field: bytes private_key = 1;
|
|
2214
|
+
*/
|
|
2215
|
+
privateKey: Uint8Array;
|
|
2216
|
+
|
|
2217
|
+
/**
|
|
2218
|
+
* Password to unlock the private key
|
|
2219
|
+
*
|
|
2220
|
+
* @generated from field: optional bytes password = 2;
|
|
2221
|
+
*/
|
|
2222
|
+
password?: Uint8Array;
|
|
2223
|
+
};
|
|
2224
|
+
|
|
2225
|
+
/**
|
|
2226
|
+
* Describes the message agntcy.dir.sign.v1.SignWithKey.
|
|
2227
|
+
* Use `create(SignWithKeySchema)` to create a new message.
|
|
2228
|
+
*/
|
|
2229
|
+
declare const SignWithKeySchema: GenMessage<SignWithKey>;
|
|
2230
|
+
|
|
2231
|
+
/**
|
|
2232
|
+
* @generated from message agntcy.dir.sign.v1.SignWithOIDC
|
|
2233
|
+
*/
|
|
2234
|
+
declare type SignWithOIDC = Message<"agntcy.dir.sign.v1.SignWithOIDC"> & {
|
|
2235
|
+
/**
|
|
2236
|
+
* Token for OIDC provider
|
|
2237
|
+
*
|
|
2238
|
+
* @generated from field: string id_token = 1;
|
|
2239
|
+
*/
|
|
2240
|
+
idToken: string;
|
|
2241
|
+
|
|
2242
|
+
/**
|
|
2243
|
+
* Signing options for OIDC
|
|
2244
|
+
*
|
|
2245
|
+
* @generated from field: agntcy.dir.sign.v1.SignWithOIDC.SignOpts options = 2;
|
|
2246
|
+
*/
|
|
2247
|
+
options?: SignWithOIDC_SignOpts;
|
|
2248
|
+
};
|
|
2249
|
+
|
|
2250
|
+
/**
|
|
2251
|
+
* List of sign options for OIDC
|
|
2252
|
+
*
|
|
2253
|
+
* @generated from message agntcy.dir.sign.v1.SignWithOIDC.SignOpts
|
|
2254
|
+
*/
|
|
2255
|
+
declare type SignWithOIDC_SignOpts = Message<"agntcy.dir.sign.v1.SignWithOIDC.SignOpts"> & {
|
|
2256
|
+
/**
|
|
2257
|
+
* Fulcio authority access URL (default value: https://fulcio.sigstage.dev)
|
|
2258
|
+
*
|
|
2259
|
+
* @generated from field: optional string fulcio_url = 1;
|
|
2260
|
+
*/
|
|
2261
|
+
fulcioUrl?: string;
|
|
2262
|
+
|
|
2263
|
+
/**
|
|
2264
|
+
* Rekor validator access URL (default value: https://rekor.sigstage.dev)
|
|
2265
|
+
*
|
|
2266
|
+
* @generated from field: optional string rekor_url = 2;
|
|
2267
|
+
*/
|
|
2268
|
+
rekorUrl?: string;
|
|
2269
|
+
|
|
2270
|
+
/**
|
|
2271
|
+
* Timestamp authority access URL (default value: https://timestamp.sigstage.dev/api/v1/timestamp)
|
|
2272
|
+
*
|
|
2273
|
+
* @generated from field: optional string timestamp_url = 3;
|
|
2274
|
+
*/
|
|
2275
|
+
timestampUrl?: string;
|
|
2276
|
+
|
|
2277
|
+
/**
|
|
2278
|
+
* OIDC provider access URL (default value: https://oauth2.sigstage.dev/auth)
|
|
2279
|
+
*
|
|
2280
|
+
* @generated from field: optional string oidc_provider_url = 4;
|
|
2281
|
+
*/
|
|
2282
|
+
oidcProviderUrl?: string;
|
|
2283
|
+
};
|
|
2284
|
+
|
|
2285
|
+
/**
|
|
2286
|
+
* Describes the message agntcy.dir.sign.v1.SignWithOIDC.SignOpts.
|
|
2287
|
+
* Use `create(SignWithOIDC_SignOptsSchema)` to create a new message.
|
|
2288
|
+
*/
|
|
2289
|
+
declare const SignWithOIDC_SignOptsSchema: GenMessage<SignWithOIDC_SignOpts>;
|
|
2290
|
+
|
|
2291
|
+
/**
|
|
2292
|
+
* Describes the message agntcy.dir.sign.v1.SignWithOIDC.
|
|
2293
|
+
* Use `create(SignWithOIDCSchema)` to create a new message.
|
|
2294
|
+
*/
|
|
2295
|
+
declare const SignWithOIDCSchema: GenMessage<SignWithOIDC>;
|
|
2296
|
+
|
|
2297
|
+
export declare namespace store_v1 {
|
|
2298
|
+
export {
|
|
2299
|
+
file_agntcy_dir_store_v1_store_service,
|
|
2300
|
+
PushReferrerRequest,
|
|
2301
|
+
PushReferrerRequestSchema,
|
|
2302
|
+
PushReferrerResponse,
|
|
2303
|
+
PushReferrerResponseSchema,
|
|
2304
|
+
PullReferrerRequest,
|
|
2305
|
+
PullReferrerRequestSchema,
|
|
2306
|
+
PullReferrerResponse,
|
|
2307
|
+
PullReferrerResponseSchema,
|
|
2308
|
+
StoreService,
|
|
2309
|
+
file_agntcy_dir_store_v1_sync_service,
|
|
2310
|
+
CreateSyncRequest,
|
|
2311
|
+
CreateSyncRequestSchema,
|
|
2312
|
+
CreateSyncResponse,
|
|
2313
|
+
CreateSyncResponseSchema,
|
|
2314
|
+
ListSyncsRequest,
|
|
2315
|
+
ListSyncsRequestSchema,
|
|
2316
|
+
ListSyncsItem,
|
|
2317
|
+
ListSyncsItemSchema,
|
|
2318
|
+
GetSyncRequest,
|
|
2319
|
+
GetSyncRequestSchema,
|
|
2320
|
+
GetSyncResponse,
|
|
2321
|
+
GetSyncResponseSchema,
|
|
2322
|
+
DeleteSyncRequest,
|
|
2323
|
+
DeleteSyncRequestSchema,
|
|
2324
|
+
DeleteSyncResponse,
|
|
2325
|
+
DeleteSyncResponseSchema,
|
|
2326
|
+
RequestRegistryCredentialsRequest,
|
|
2327
|
+
RequestRegistryCredentialsRequestSchema,
|
|
2328
|
+
RequestRegistryCredentialsResponse,
|
|
2329
|
+
RequestRegistryCredentialsResponseSchema,
|
|
2330
|
+
BasicAuthCredentials,
|
|
2331
|
+
BasicAuthCredentialsSchema,
|
|
2332
|
+
SyncStatus,
|
|
2333
|
+
SyncStatusSchema,
|
|
2334
|
+
SyncService
|
|
2335
|
+
}
|
|
2336
|
+
}
|
|
2337
|
+
|
|
2338
|
+
/**
|
|
2339
|
+
* Defines an interface for content-addressable storage
|
|
2340
|
+
* service for objects.
|
|
2341
|
+
*
|
|
2342
|
+
* Max object size: 4MB (to fully fit in a single request)
|
|
2343
|
+
* Max metadata size: 100KB
|
|
2344
|
+
*
|
|
2345
|
+
* Store service can be implemented by various storage backends,
|
|
2346
|
+
* such as local file system, OCI registry, etc.
|
|
2347
|
+
*
|
|
2348
|
+
* Middleware should be used to control who can perform these RPCs.
|
|
2349
|
+
* Policies for the middleware can be handled via separate service.
|
|
2350
|
+
*
|
|
2351
|
+
* Each operation is performed sequentially, meaning that
|
|
2352
|
+
* for the N-th request, N-th response will be returned.
|
|
2353
|
+
* If an error occurs, the stream will be cancelled.
|
|
2354
|
+
*
|
|
2355
|
+
* @generated from service agntcy.dir.store.v1.StoreService
|
|
2356
|
+
*/
|
|
2357
|
+
declare const StoreService: GenService<{
|
|
2358
|
+
/**
|
|
2359
|
+
* Push performs write operation for given records.
|
|
2360
|
+
*
|
|
2361
|
+
* @generated from rpc agntcy.dir.store.v1.StoreService.Push
|
|
2362
|
+
*/
|
|
2363
|
+
push: {
|
|
2364
|
+
methodKind: "bidi_streaming";
|
|
2365
|
+
input: typeof RecordSchema;
|
|
2366
|
+
output: typeof RecordRefSchema;
|
|
2367
|
+
},
|
|
2368
|
+
/**
|
|
2369
|
+
* Pull performs read operation for given records.
|
|
2370
|
+
*
|
|
2371
|
+
* @generated from rpc agntcy.dir.store.v1.StoreService.Pull
|
|
2372
|
+
*/
|
|
2373
|
+
pull: {
|
|
2374
|
+
methodKind: "bidi_streaming";
|
|
2375
|
+
input: typeof RecordRefSchema;
|
|
2376
|
+
output: typeof RecordSchema;
|
|
2377
|
+
},
|
|
2378
|
+
/**
|
|
2379
|
+
* Lookup resolves basic metadata for the records.
|
|
2380
|
+
*
|
|
2381
|
+
* @generated from rpc agntcy.dir.store.v1.StoreService.Lookup
|
|
2382
|
+
*/
|
|
2383
|
+
lookup: {
|
|
2384
|
+
methodKind: "bidi_streaming";
|
|
2385
|
+
input: typeof RecordRefSchema;
|
|
2386
|
+
output: typeof RecordMetaSchema;
|
|
2387
|
+
},
|
|
2388
|
+
/**
|
|
2389
|
+
* Remove performs delete operation for the records.
|
|
2390
|
+
*
|
|
2391
|
+
* @generated from rpc agntcy.dir.store.v1.StoreService.Delete
|
|
2392
|
+
*/
|
|
2393
|
+
delete: {
|
|
2394
|
+
methodKind: "client_streaming";
|
|
2395
|
+
input: typeof RecordRefSchema;
|
|
2396
|
+
output: typeof EmptySchema;
|
|
2397
|
+
},
|
|
2398
|
+
/**
|
|
2399
|
+
* PushReferrer performs write operation for record referrers.
|
|
2400
|
+
*
|
|
2401
|
+
* @generated from rpc agntcy.dir.store.v1.StoreService.PushReferrer
|
|
2402
|
+
*/
|
|
2403
|
+
pushReferrer: {
|
|
2404
|
+
methodKind: "bidi_streaming";
|
|
2405
|
+
input: typeof PushReferrerRequestSchema;
|
|
2406
|
+
output: typeof PushReferrerResponseSchema;
|
|
2407
|
+
},
|
|
2408
|
+
/**
|
|
2409
|
+
* PullReferrer performs read operation for record referrers.
|
|
2410
|
+
*
|
|
2411
|
+
* @generated from rpc agntcy.dir.store.v1.StoreService.PullReferrer
|
|
2412
|
+
*/
|
|
2413
|
+
pullReferrer: {
|
|
2414
|
+
methodKind: "bidi_streaming";
|
|
2415
|
+
input: typeof PullReferrerRequestSchema;
|
|
2416
|
+
output: typeof PullReferrerResponseSchema;
|
|
2417
|
+
},
|
|
2418
|
+
}>;
|
|
2419
|
+
|
|
2420
|
+
/**
|
|
2421
|
+
* SyncService provides functionality for synchronizing objects between Directory nodes.
|
|
2422
|
+
*
|
|
2423
|
+
* This service enables one-way synchronization from a remote Directory node to the local node,
|
|
2424
|
+
* allowing distributed Directory instances to share and replicate objects. The service supports
|
|
2425
|
+
* both on-demand synchronization and tracking of sync operations through their lifecycle.
|
|
2426
|
+
*
|
|
2427
|
+
* @generated from service agntcy.dir.store.v1.SyncService
|
|
2428
|
+
*/
|
|
2429
|
+
declare const SyncService: GenService<{
|
|
2430
|
+
/**
|
|
2431
|
+
* CreateSync initiates a new synchronization operation from a remote Directory node.
|
|
2432
|
+
*
|
|
2433
|
+
* The operation is non-blocking and returns immediately with a sync ID that can be used
|
|
2434
|
+
* to track progress and manage the sync operation.
|
|
2435
|
+
*
|
|
2436
|
+
* @generated from rpc agntcy.dir.store.v1.SyncService.CreateSync
|
|
2437
|
+
*/
|
|
2438
|
+
createSync: {
|
|
2439
|
+
methodKind: "unary";
|
|
2440
|
+
input: typeof CreateSyncRequestSchema;
|
|
2441
|
+
output: typeof CreateSyncResponseSchema;
|
|
2442
|
+
},
|
|
2443
|
+
/**
|
|
2444
|
+
* ListSyncs returns a stream of all sync operations known to the system.
|
|
2445
|
+
*
|
|
2446
|
+
* This includes active, completed, and failed synchronizations.
|
|
2447
|
+
*
|
|
2448
|
+
* @generated from rpc agntcy.dir.store.v1.SyncService.ListSyncs
|
|
2449
|
+
*/
|
|
2450
|
+
listSyncs: {
|
|
2451
|
+
methodKind: "server_streaming";
|
|
2452
|
+
input: typeof ListSyncsRequestSchema;
|
|
2453
|
+
output: typeof ListSyncsItemSchema;
|
|
2454
|
+
},
|
|
2455
|
+
/**
|
|
2456
|
+
* GetSync retrieves detailed status information for a specific synchronization.
|
|
2457
|
+
*
|
|
2458
|
+
* @generated from rpc agntcy.dir.store.v1.SyncService.GetSync
|
|
2459
|
+
*/
|
|
2460
|
+
getSync: {
|
|
2461
|
+
methodKind: "unary";
|
|
2462
|
+
input: typeof GetSyncRequestSchema;
|
|
2463
|
+
output: typeof GetSyncResponseSchema;
|
|
2464
|
+
},
|
|
2465
|
+
/**
|
|
2466
|
+
* DeleteSync removes a synchronization operation from the system.
|
|
2467
|
+
*
|
|
2468
|
+
* @generated from rpc agntcy.dir.store.v1.SyncService.DeleteSync
|
|
2469
|
+
*/
|
|
2470
|
+
deleteSync: {
|
|
2471
|
+
methodKind: "unary";
|
|
2472
|
+
input: typeof DeleteSyncRequestSchema;
|
|
2473
|
+
output: typeof DeleteSyncResponseSchema;
|
|
2474
|
+
},
|
|
2475
|
+
/**
|
|
2476
|
+
* RequestRegistryCredentials requests registry credentials between two Directory nodes.
|
|
2477
|
+
*
|
|
2478
|
+
* This RPC allows a requesting node to authenticate with this node and obtain
|
|
2479
|
+
* temporary registry credentials for secure Zot-based synchronization.
|
|
2480
|
+
*
|
|
2481
|
+
* @generated from rpc agntcy.dir.store.v1.SyncService.RequestRegistryCredentials
|
|
2482
|
+
*/
|
|
2483
|
+
requestRegistryCredentials: {
|
|
2484
|
+
methodKind: "unary";
|
|
2485
|
+
input: typeof RequestRegistryCredentialsRequestSchema;
|
|
2486
|
+
output: typeof RequestRegistryCredentialsResponseSchema;
|
|
2487
|
+
},
|
|
2488
|
+
}>;
|
|
2489
|
+
|
|
2490
|
+
/**
|
|
2491
|
+
* SyncStatus enumeration defines the possible states of a synchronization operation.
|
|
2492
|
+
*
|
|
2493
|
+
* @generated from enum agntcy.dir.store.v1.SyncStatus
|
|
2494
|
+
*/
|
|
2495
|
+
declare enum SyncStatus {
|
|
2496
|
+
/**
|
|
2497
|
+
* Default/unset status - should not be used in practice
|
|
2498
|
+
*
|
|
2499
|
+
* @generated from enum value: SYNC_STATUS_UNSPECIFIED = 0;
|
|
2500
|
+
*/
|
|
2501
|
+
UNSPECIFIED = 0,
|
|
2502
|
+
|
|
2503
|
+
/**
|
|
2504
|
+
* Sync operation has been created but not yet started
|
|
2505
|
+
*
|
|
2506
|
+
* @generated from enum value: SYNC_STATUS_PENDING = 1;
|
|
2507
|
+
*/
|
|
2508
|
+
PENDING = 1,
|
|
2509
|
+
|
|
2510
|
+
/**
|
|
2511
|
+
* Sync operation is actively discovering and transferring objects
|
|
2512
|
+
*
|
|
2513
|
+
* @generated from enum value: SYNC_STATUS_IN_PROGRESS = 2;
|
|
2514
|
+
*/
|
|
2515
|
+
IN_PROGRESS = 2,
|
|
2516
|
+
|
|
2517
|
+
/**
|
|
2518
|
+
* Sync operation encountered an error and stopped
|
|
2519
|
+
*
|
|
2520
|
+
* @generated from enum value: SYNC_STATUS_FAILED = 3;
|
|
2521
|
+
*/
|
|
2522
|
+
FAILED = 3,
|
|
2523
|
+
|
|
2524
|
+
/**
|
|
2525
|
+
* Sync operation has been marked for deletion but cleanup not yet started
|
|
2526
|
+
*
|
|
2527
|
+
* @generated from enum value: SYNC_STATUS_DELETE_PENDING = 4;
|
|
2528
|
+
*/
|
|
2529
|
+
DELETE_PENDING = 4,
|
|
2530
|
+
|
|
2531
|
+
/**
|
|
2532
|
+
* Sync operation has been successfully deleted and cleaned up
|
|
2533
|
+
*
|
|
2534
|
+
* @generated from enum value: SYNC_STATUS_DELETED = 5;
|
|
2535
|
+
*/
|
|
2536
|
+
DELETED = 5,
|
|
2537
|
+
}
|
|
2538
|
+
|
|
2539
|
+
/**
|
|
2540
|
+
* Describes the enum agntcy.dir.store.v1.SyncStatus.
|
|
2541
|
+
*/
|
|
2542
|
+
declare const SyncStatusSchema: GenEnum<SyncStatus>;
|
|
2543
|
+
|
|
2544
|
+
/**
|
|
2545
|
+
* @generated from message agntcy.dir.routing.v1.UnpublishRequest
|
|
2546
|
+
*/
|
|
2547
|
+
declare type UnpublishRequest = Message<"agntcy.dir.routing.v1.UnpublishRequest"> & {
|
|
2548
|
+
/**
|
|
2549
|
+
* @generated from oneof agntcy.dir.routing.v1.UnpublishRequest.request
|
|
2550
|
+
*/
|
|
2551
|
+
request: {
|
|
2552
|
+
/**
|
|
2553
|
+
* References to the records to be unpublished.
|
|
2554
|
+
*
|
|
2555
|
+
* @generated from field: agntcy.dir.routing.v1.RecordRefs record_refs = 1;
|
|
2556
|
+
*/
|
|
2557
|
+
value: RecordRefs;
|
|
2558
|
+
case: "recordRefs";
|
|
2559
|
+
} | {
|
|
2560
|
+
/**
|
|
2561
|
+
* Queries to match against the records to be unpublished.
|
|
2562
|
+
*
|
|
2563
|
+
* @generated from field: agntcy.dir.routing.v1.RecordQueries queries = 2;
|
|
2564
|
+
*/
|
|
2565
|
+
value: RecordQueries;
|
|
2566
|
+
case: "queries";
|
|
2567
|
+
} | { case: undefined; value?: undefined };
|
|
2568
|
+
};
|
|
2569
|
+
|
|
2570
|
+
/**
|
|
2571
|
+
* Describes the message agntcy.dir.routing.v1.UnpublishRequest.
|
|
2572
|
+
* Use `create(UnpublishRequestSchema)` to create a new message.
|
|
2573
|
+
*/
|
|
2574
|
+
declare const UnpublishRequestSchema: GenMessage<UnpublishRequest>;
|
|
2575
|
+
|
|
2576
|
+
/**
|
|
2577
|
+
* @generated from message agntcy.dir.sign.v1.VerifyRequest
|
|
2578
|
+
*/
|
|
2579
|
+
declare type VerifyRequest = Message<"agntcy.dir.sign.v1.VerifyRequest"> & {
|
|
2580
|
+
/**
|
|
2581
|
+
* Record reference to be verified
|
|
2582
|
+
*
|
|
2583
|
+
* @generated from field: agntcy.dir.core.v1.RecordRef record_ref = 1;
|
|
2584
|
+
*/
|
|
2585
|
+
recordRef?: RecordRef;
|
|
2586
|
+
};
|
|
2587
|
+
|
|
2588
|
+
/**
|
|
2589
|
+
* Describes the message agntcy.dir.sign.v1.VerifyRequest.
|
|
2590
|
+
* Use `create(VerifyRequestSchema)` to create a new message.
|
|
2591
|
+
*/
|
|
2592
|
+
declare const VerifyRequestSchema: GenMessage<VerifyRequest>;
|
|
2593
|
+
|
|
2594
|
+
/**
|
|
2595
|
+
* @generated from message agntcy.dir.sign.v1.VerifyResponse
|
|
2596
|
+
*/
|
|
2597
|
+
declare type VerifyResponse = Message<"agntcy.dir.sign.v1.VerifyResponse"> & {
|
|
2598
|
+
/**
|
|
2599
|
+
* The verify process result
|
|
2600
|
+
*
|
|
2601
|
+
* @generated from field: bool success = 1;
|
|
2602
|
+
*/
|
|
2603
|
+
success: boolean;
|
|
2604
|
+
|
|
2605
|
+
/**
|
|
2606
|
+
* Optional error message if verification failed
|
|
2607
|
+
*
|
|
2608
|
+
* @generated from field: optional string error_message = 2;
|
|
2609
|
+
*/
|
|
2610
|
+
errorMessage?: string;
|
|
2611
|
+
};
|
|
2612
|
+
|
|
2613
|
+
/**
|
|
2614
|
+
* Describes the message agntcy.dir.sign.v1.VerifyResponse.
|
|
2615
|
+
* Use `create(VerifyResponseSchema)` to create a new message.
|
|
2616
|
+
*/
|
|
2617
|
+
declare const VerifyResponseSchema: GenMessage<VerifyResponse>;
|
|
2618
|
+
|
|
2619
|
+
export { }
|