agntcy-dir 0.5.1 → 0.5.3

package/dist/agntcy-dir.d.ts

@@ -6,6 +6,7 @@ import type { GenMessage } from '@bufbuild/protobuf/codegenv2';
 import type { GenService } from '@bufbuild/protobuf/codegenv2';
 import type { JsonObject } from '@bufbuild/protobuf';
 import type { Message } from '@bufbuild/protobuf';
+import type { Timestamp } from '@bufbuild/protobuf/wkt';
 import { Transport } from '@connectrpc/connect';
 
 /**
@@ -55,9 +56,11 @@ export declare class Client {
     config: Config;
     storeClient: Client_2<typeof models_2.store_v1.StoreService>;
     routingClient: Client_2<typeof models_2.routing_v1.RoutingService>;
+    publicationClient: Client_2<typeof models_2.routing_v1.PublicationService>;
     searchClient: Client_2<typeof models_2.search_v1.SearchService>;
     signClient: Client_2<typeof models_2.sign_v1.SignService>;
     syncClient: Client_2<typeof models_2.store_v1.SyncService>;
+    eventClient: Client_2<typeof models_2.events_v1.EventService>;
     /**
      * Initialize the client with the given configuration.
      *
@@ -432,6 +435,56 @@ export declare class Client {
      * ```
      */
     delete_sync(request: models_2.store_v1.DeleteSyncRequest): Promise<models_2.store_v1.DeleteSyncResponse>;
+    /**
+     * Get events from the Event API matching the specified criteria.
+     *
+     * Retrieves a list of events that match the filtering and query criteria
+     * specified in the request.
+     *
+     * @param request - ListenRequest specifying filtering criteria, pagination, etc.
+     * @returns Promise that resolves to an array of ListenResponse objects matching the criteria
+     *
+     * @throws {Error} If the gRPC call fails or the get events operation fails
+     */
+    listen(request: models_2.events_v1.ListenRequest): AsyncIterable<models_2.events_v1.ListenResponse>;
+    /**
+     * CreatePublication creates a new publication request that will be processed by the PublicationWorker.
+     * The publication request can specify either a query, a list of specific CIDs,
+     * or all records to be announced to the DHT.
+     *
+     * @param request - PublishRequest containing record references and queries options.
+     *
+     * @returns CreatePublicationResponse returns the result of creating a publication request.
+     * This includes the publication ID and any relevant metadata.
+     *
+     * @throws {Error} If the gRPC call fails or the list operation fails
+     */
+    create_publication(request: models_2.routing_v1.PublishRequest): Promise<models_2.routing_v1.CreatePublicationResponse>;
+    /**
+     * ListPublications returns a stream of all publication requests in the system.
+     * This allows monitoring of pending, processing, and completed publication requests.
+     *
+     * @param request - ListPublicationsRequest contains optional filters for listing publication requests.
+     *
+     * @returns Promise that resolves to an array of ListPublicationsItem represents
+     * a single publication request in the list response.
+     * Contains publication details including ID, status, and creation timestamp.
+     *
+     * @throws {Error} If the gRPC call fails or the list operation fails
+     */
+    list_publication(request: models_2.routing_v1.ListPublicationsRequest): Promise<models_2.routing_v1.ListPublicationsItem[]>;
+    /**
+     * GetPublication retrieves details of a specific publication request by its identifier.
+     * This includes the current status and any associated metadata.
+     *
+     * @param request - GetPublicationRequest specifies which publication to retrieve by its identifier.
+     *
+     * @returns GetPublicationResponse contains the full details of a specific publication request.
+     * Includes status, progress information, and any error details if applicable.
+     *
+     * @throws {Error} If the gRPC call fails or the get operation fails
+     */
+    get_publication(request: models_2.routing_v1.GetPublicationRequest): Promise<models_2.routing_v1.GetPublicationResponse>;
     /**
      * Sign a record using a private key.
      *
@@ -643,11 +696,198 @@ declare type DeleteSyncResponse = Message<"agntcy.dir.store.v1.DeleteSyncRespons
  */
 declare const DeleteSyncResponseSchema: GenMessage<DeleteSyncResponse>;
 
+/**
+ * Event represents a system event that occurred.
+ *
+ * @generated from message agntcy.dir.events.v1.Event
+ */
+declare type Event_2 = Message<"agntcy.dir.events.v1.Event"> & {
+    /**
+     * Unique event identifier (generated by the system).
+     *
+     * @generated from field: string id = 1;
+     */
+    id: string;
+
+    /**
+     * Type of event that occurred.
+     *
+     * @generated from field: agntcy.dir.events.v1.EventType type = 2;
+     */
+    type: EventType;
+
+    /**
+     * When the event occurred.
+     *
+     * @generated from field: google.protobuf.Timestamp timestamp = 3;
+     */
+    timestamp?: Timestamp;
+
+    /**
+     * Resource identifier (CID for records, sync_id for syncs, etc.).
+     *
+     * @generated from field: string resource_id = 4;
+     */
+    resourceId: string;
+
+    /**
+     * Optional labels associated with the record (for record events).
+     *
+     * @generated from field: repeated string labels = 5;
+     */
+    labels: string[];
+
+    /**
+     * Optional metadata for additional context.
+     * Used for flexible event-specific data that doesn't fit standard fields.
+     *
+     * @generated from field: map<string, string> metadata = 7;
+     */
+    metadata: { [key: string]: string };
+};
+
+export declare namespace events_v1 {
+    export {
+        file_agntcy_dir_events_v1_event_service,
+        ListenRequest,
+        ListenRequestSchema,
+        ListenResponse,
+        ListenResponseSchema,
+        Event_2 as Event,
+        EventSchema,
+        EventType,
+        EventTypeSchema,
+        EventService
+    }
+}
+
+/**
+ * Describes the message agntcy.dir.events.v1.Event.
+ * Use `create(EventSchema)` to create a new message.
+ */
+declare const EventSchema: GenMessage<Event_2>;
+
+/**
+ * EventService provides real-time event streaming for all system operations.
+ * Events are delivered from subscription time forward with no history or replay.
+ * This service enables external applications to react to system changes in real-time.
+ *
+ * @generated from service agntcy.dir.events.v1.EventService
+ */
+declare const EventService: GenService<{
+    /**
+     * Listen establishes a streaming connection to receive events.
+     * Events are only delivered while the stream is active.
+     * On disconnect, missed events are not recoverable.
+     *
+     * @generated from rpc agntcy.dir.events.v1.EventService.Listen
+     */
+    listen: {
+        methodKind: "server_streaming";
+        input: typeof ListenRequestSchema;
+        output: typeof ListenResponseSchema;
+    },
+}>;
+
+/**
+ * EventType represents all valid event types in the system.
+ * Each value represents a specific operation that can occur.
+ *
+ * Supported Events:
+ * - Store: RECORD_PUSHED, RECORD_PULLED, RECORD_DELETED
+ * - Routing: RECORD_PUBLISHED, RECORD_UNPUBLISHED
+ * - Sync: SYNC_CREATED, SYNC_COMPLETED, SYNC_FAILED
+ * - Sign: RECORD_SIGNED
+ *
+ * @generated from enum agntcy.dir.events.v1.EventType
+ */
+declare enum EventType {
+    /**
+     * Unknown/unspecified event type.
+     *
+     * @generated from enum value: EVENT_TYPE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+
+    /**
+     * A record was pushed to local storage.
+     *
+     * @generated from enum value: EVENT_TYPE_RECORD_PUSHED = 1;
+     */
+    RECORD_PUSHED = 1,
+
+    /**
+     * A record was pulled from storage.
+     *
+     * @generated from enum value: EVENT_TYPE_RECORD_PULLED = 2;
+     */
+    RECORD_PULLED = 2,
+
+    /**
+     * A record was deleted from storage.
+     *
+     * @generated from enum value: EVENT_TYPE_RECORD_DELETED = 3;
+     */
+    RECORD_DELETED = 3,
+
+    /**
+     * A record was published/announced to the network.
+     *
+     * @generated from enum value: EVENT_TYPE_RECORD_PUBLISHED = 4;
+     */
+    RECORD_PUBLISHED = 4,
+
+    /**
+     * A record was unpublished from the network.
+     *
+     * @generated from enum value: EVENT_TYPE_RECORD_UNPUBLISHED = 5;
+     */
+    RECORD_UNPUBLISHED = 5,
+
+    /**
+     * A sync operation was created/initiated.
+     *
+     * @generated from enum value: EVENT_TYPE_SYNC_CREATED = 6;
+     */
+    SYNC_CREATED = 6,
+
+    /**
+     * A sync operation completed successfully.
+     *
+     * @generated from enum value: EVENT_TYPE_SYNC_COMPLETED = 7;
+     */
+    SYNC_COMPLETED = 7,
+
+    /**
+     * A sync operation failed.
+     *
+     * @generated from enum value: EVENT_TYPE_SYNC_FAILED = 8;
+     */
+    SYNC_FAILED = 8,
+
+    /**
+     * A record was signed.
+     *
+     * @generated from enum value: EVENT_TYPE_RECORD_SIGNED = 9;
+     */
+    RECORD_SIGNED = 9,
+}
+
+/**
+ * Describes the enum agntcy.dir.events.v1.EventType.
+ */
+declare const EventTypeSchema: GenEnum<EventType>;
+
 /**
  * Describes the file agntcy/dir/core/v1/record.proto.
  */
 declare const file_agntcy_dir_core_v1_record: GenFile;
 
+/**
+ * Describes the file agntcy/dir/events/v1/event_service.proto.
+ */
+declare const file_agntcy_dir_events_v1_event_service: GenFile;
+
 /**
  * Describes the file agntcy/dir/routing/v1/peer.proto.
  */
@@ -835,6 +1075,65 @@ declare type GetSyncResponse = Message<"agntcy.dir.store.v1.GetSyncResponse"> &
  */
 declare const GetSyncResponseSchema: GenMessage<GetSyncResponse>;
 
+/**
+ * ListenRequest specifies filters for event subscription.
+ *
+ * @generated from message agntcy.dir.events.v1.ListenRequest
+ */
+declare type ListenRequest = Message<"agntcy.dir.events.v1.ListenRequest"> & {
+    /**
+     * Event types to subscribe to.
+     * If empty, subscribes to all event types.
+     *
+     * @generated from field: repeated agntcy.dir.events.v1.EventType event_types = 1;
+     */
+    eventTypes: EventType[];
+
+    /**
+     * Optional label filters (e.g., "/skills/AI", "/domains/research").
+     * Only events for records matching these labels are delivered.
+     * Uses substring matching.
+     *
+     * @generated from field: repeated string label_filters = 2;
+     */
+    labelFilters: string[];
+
+    /**
+     * Optional CID filters.
+     * Only events for specific CIDs are delivered.
+     *
+     * @generated from field: repeated string cid_filters = 3;
+     */
+    cidFilters: string[];
+};
+
+/**
+ * Describes the message agntcy.dir.events.v1.ListenRequest.
+ * Use `create(ListenRequestSchema)` to create a new message.
+ */
+declare const ListenRequestSchema: GenMessage<ListenRequest>;
+
+/**
+ * ListenResponse is the response message for the Listen RPC.
+ * Wraps the Event message to allow for future extensions without breaking the Event structure.
+ *
+ * @generated from message agntcy.dir.events.v1.ListenResponse
+ */
+declare type ListenResponse = Message<"agntcy.dir.events.v1.ListenResponse"> & {
+    /**
+     * The event that occurred.
+     *
+     * @generated from field: agntcy.dir.events.v1.Event event = 1;
+     */
+    event?: Event_2;
+};
+
+/**
+ * Describes the message agntcy.dir.events.v1.ListenResponse.
+ * Use `create(ListenResponseSchema)` to create a new message.
+ */
+declare const ListenResponseSchema: GenMessage<ListenResponse>;
+
 /**
  * ListPublicationsItem represents a single publication request in the list response.
  * Contains publication details including ID, status, and creation timestamp.
@@ -1025,7 +1324,8 @@ export declare namespace models {
         routing_v1,
         search_v1,
         sign_v1,
-        store_v1
+        store_v1,
+        events_v1
     }
 }
 
@@ -1035,7 +1335,8 @@ declare namespace models_2 {
         routing_v1,
         search_v1,
         sign_v1,
-        store_v1
+        store_v1,
+        events_v1
     }
 }
 

package/dist/index.cjs

@@ -4919,6 +4919,24 @@ function fileDesc(b64, imports) {
     return reg.getFile(root.name);
 }
 
+// Copyright 2021-2025 Buf Technologies, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+/**
+ * Describes the file google/protobuf/timestamp.proto.
+ */
+const file_google_protobuf_timestamp = /*@__PURE__*/ fileDesc("Ch9nb29nbGUvcHJvdG9idWYvdGltZXN0YW1wLnByb3RvEg9nb29nbGUucHJvdG9idWYiKwoJVGltZXN0YW1wEg8KB3NlY29uZHMYASABKAMSDQoFbmFub3MYAiABKAVChQEKE2NvbS5nb29nbGUucHJvdG9idWZCDlRpbWVzdGFtcFByb3RvUAFaMmdvb2dsZS5nb2xhbmcub3JnL3Byb3RvYnVmL3R5cGVzL2tub3duL3RpbWVzdGFtcHBi+AEBogIDR1BCqgIeR29vZ2xlLlByb3RvYnVmLldlbGxLbm93blR5cGVzYgZwcm90bzM");
+
 // Copyright 2021-2025 Buf Technologies, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -10250,9 +10268,86 @@ var store_v1 = /*#__PURE__*/Object.freeze({
 // Copyright AGNTCY Contributors (https://github.com/agntcy)
 // SPDX-License-Identifier: Apache-2.0
 
+
+/**
+ * Describes the file agntcy/dir/events/v1/event_service.proto.
+ */
+const file_agntcy_dir_events_v1_event_service = /*@__PURE__*/
+  fileDesc("CihhZ250Y3kvZGlyL2V2ZW50cy92MS9ldmVudF9zZXJ2aWNlLnByb3RvEhRhZ250Y3kuZGlyLmV2ZW50cy52MSJxCg1MaXN0ZW5SZXF1ZXN0EjQKC2V2ZW50X3R5cGVzGAEgAygOMh8uYWdudGN5LmRpci5ldmVudHMudjEuRXZlbnRUeXBlEhUKDWxhYmVsX2ZpbHRlcnMYAiADKAkSEwoLY2lkX2ZpbHRlcnMYAyADKAkiPAoOTGlzdGVuUmVzcG9uc2USKgoFZXZlbnQYASABKAsyGy5hZ250Y3kuZGlyLmV2ZW50cy52MS5FdmVudCKEAgoFRXZlbnQSCgoCaWQYASABKAkSLQoEdHlwZRgCIAEoDjIfLmFnbnRjeS5kaXIuZXZlbnRzLnYxLkV2ZW50VHlwZRItCgl0aW1lc3RhbXAYAyABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEhMKC3Jlc291cmNlX2lkGAQgASgJEg4KBmxhYmVscxgFIAMoCRI7CghtZXRhZGF0YRgHIAMoCzIpLmFnbnRjeS5kaXIuZXZlbnRzLnYxLkV2ZW50Lk1ldGFkYXRhRW50cnkaLwoNTWV0YWRhdGFFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBKrwCCglFdmVudFR5cGUSGgoWRVZFTlRfVFlQRV9VTlNQRUNJRklFRBAAEhwKGEVWRU5UX1RZUEVfUkVDT1JEX1BVU0hFRBABEhwKGEVWRU5UX1RZUEVfUkVDT1JEX1BVTExFRBACEh0KGUVWRU5UX1RZUEVfUkVDT1JEX0RFTEVURUQQAxIfChtFVkVOVF9UWVBFX1JFQ09SRF9QVUJMSVNIRUQQBBIhCh1FVkVOVF9UWVBFX1JFQ09SRF9VTlBVQkxJU0hFRBAFEhsKF0VWRU5UX1RZUEVfU1lOQ19DUkVBVEVEEAYSHQoZRVZFTlRfVFlQRV9TWU5DX0NPTVBMRVRFRBAHEhoKFkVWRU5UX1RZUEVfU1lOQ19GQUlMRUQQCBIcChhFVkVOVF9UWVBFX1JFQ09SRF9TSUdORUQQCTJlCgxFdmVudFNlcnZpY2USVQoGTGlzdGVuEiMuYWdudGN5LmRpci5ldmVudHMudjEuTGlzdGVuUmVxdWVzdBokLmFnbnRjeS5kaXIuZXZlbnRzLnYxLkxpc3RlblJlc3BvbnNlMAFCxQEKGGNvbS5hZ250Y3kuZGlyLmV2ZW50cy52MUIRRXZlbnRTZXJ2aWNlUHJvdG9QAVojZ2l0aHViLmNvbS9hZ250Y3kvZGlyL2FwaS9ldmVudHMvdjGiAgNBREWqAhRBZ250Y3kuRGlyLkV2ZW50cy5WMcoCFEFnbnRjeVxEaXJcRXZlbnRzXFYx4gIgQWdudGN5XERpclxFdmVudHNcVjFcR1BCTWV0YWRhdGHqAhdBZ250Y3k6OkRpcjo6RXZlbnRzOjpWMWIGcHJvdG8z", [file_google_protobuf_timestamp]);
+
+/**
+ * Describes the message agntcy.dir.events.v1.ListenRequest.
+ * Use `create(ListenRequestSchema)` to create a new message.
+ */
+const ListenRequestSchema = /*@__PURE__*/
+  messageDesc(file_agntcy_dir_events_v1_event_service, 0);
+
+/**
+ * Describes the message agntcy.dir.events.v1.ListenResponse.
+ * Use `create(ListenResponseSchema)` to create a new message.
+ */
+const ListenResponseSchema = /*@__PURE__*/
+  messageDesc(file_agntcy_dir_events_v1_event_service, 1);
+
+/**
+ * Describes the message agntcy.dir.events.v1.Event.
+ * Use `create(EventSchema)` to create a new message.
+ */
+const EventSchema = /*@__PURE__*/
+  messageDesc(file_agntcy_dir_events_v1_event_service, 2);
+
+/**
+ * Describes the enum agntcy.dir.events.v1.EventType.
+ */
+const EventTypeSchema = /*@__PURE__*/
+  enumDesc(file_agntcy_dir_events_v1_event_service, 0);
+
+/**
+ * EventType represents all valid event types in the system.
+ * Each value represents a specific operation that can occur.
+ *
+ * Supported Events:
+ * - Store: RECORD_PUSHED, RECORD_PULLED, RECORD_DELETED
+ * - Routing: RECORD_PUBLISHED, RECORD_UNPUBLISHED
+ * - Sync: SYNC_CREATED, SYNC_COMPLETED, SYNC_FAILED
+ * - Sign: RECORD_SIGNED
+ *
+ * @generated from enum agntcy.dir.events.v1.EventType
+ */
+const EventType = /*@__PURE__*/
+  tsEnum(EventTypeSchema);
+
+/**
+ * EventService provides real-time event streaming for all system operations.
+ * Events are delivered from subscription time forward with no history or replay.
+ * This service enables external applications to react to system changes in real-time.
+ *
+ * @generated from service agntcy.dir.events.v1.EventService
+ */
+const EventService = /*@__PURE__*/
+  serviceDesc(file_agntcy_dir_events_v1_event_service, 0);
+
+// Copyright AGNTCY Contributors (https://github.com/agntcy)
+// SPDX-License-Identifier: Apache-2.0
+
+var events_v1 = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    EventSchema: EventSchema,
+    EventService: EventService,
+    EventType: EventType,
+    EventTypeSchema: EventTypeSchema,
+    ListenRequestSchema: ListenRequestSchema,
+    ListenResponseSchema: ListenResponseSchema,
+    file_agntcy_dir_events_v1_event_service: file_agntcy_dir_events_v1_event_service
+});
+
+// Copyright AGNTCY Contributors (https://github.com/agntcy)
+// SPDX-License-Identifier: Apache-2.0
+
 var index = /*#__PURE__*/Object.freeze({
     __proto__: null,
     core_v1: core_v1,
+    events_v1: events_v1,
     routing_v1: routing_v1,
     search_v1: search_v1,
     sign_v1: sign_v1,
@@ -10372,9 +10467,11 @@ class Client {
         // Set clients for all services
         this.storeClient = createClient(StoreService, grpcTransport);
         this.routingClient = createClient(RoutingService, grpcTransport);
+        this.publicationClient = createClient(PublicationService, grpcTransport);
         this.searchClient = createClient(SearchService, grpcTransport);
         this.signClient = createClient(SignService, grpcTransport);
         this.syncClient = createClient(SyncService, grpcTransport);
+        this.eventClient = createClient(EventService, grpcTransport);
     }
     static convertToPEM(bytes, label) {
         // Convert Uint8Array to base64 string
@@ -10957,6 +11054,68 @@ class Client {
     async delete_sync(request) {
         return await this.syncClient.deleteSync(request);
     }
+    /**
+     * Get events from the Event API matching the specified criteria.
+     *
+     * Retrieves a list of events that match the filtering and query criteria
+     * specified in the request.
+     *
+     * @param request - ListenRequest specifying filtering criteria, pagination, etc.
+     * @returns Promise that resolves to an array of ListenResponse objects matching the criteria
+     *
+     * @throws {Error} If the gRPC call fails or the get events operation fails
+     */
+    listen(request) {
+        return this.eventClient.listen(request);
+    }
+    /**
+     * CreatePublication creates a new publication request that will be processed by the PublicationWorker.
+     * The publication request can specify either a query, a list of specific CIDs,
+     * or all records to be announced to the DHT.
+     *
+     * @param request - PublishRequest containing record references and queries options.
+     *
+     * @returns CreatePublicationResponse returns the result of creating a publication request.
+     * This includes the publication ID and any relevant metadata.
+     *
+     * @throws {Error} If the gRPC call fails or the list operation fails
+     */
+    async create_publication(request) {
+        return await this.publicationClient.createPublication(request);
+    }
+    /**
+     * ListPublications returns a stream of all publication requests in the system.
+     * This allows monitoring of pending, processing, and completed publication requests.
+     *
+     * @param request - ListPublicationsRequest contains optional filters for listing publication requests.
+     *
+     * @returns Promise that resolves to an array of ListPublicationsItem represents
+     * a single publication request in the list response.
+     * Contains publication details including ID, status, and creation timestamp.
+     *
+     * @throws {Error} If the gRPC call fails or the list operation fails
+     */
+    async list_publication(request) {
+        const results = [];
+        for await (const response of this.publicationClient.listPublications(request)) {
+            results.push(response);
+        }
+        return results;
+    }
+    /**
+     * GetPublication retrieves details of a specific publication request by its identifier.
+     * This includes the current status and any associated metadata.
+     *
+     * @param request - GetPublicationRequest specifies which publication to retrieve by its identifier.
+     *
+     * @returns GetPublicationResponse contains the full details of a specific publication request.
+     * Includes status, progress information, and any error details if applicable.
+     *
+     * @throws {Error} If the gRPC call fails or the get operation fails
+     */
+    async get_publication(request) {
+        return await this.publicationClient.getPublication(request);
+    }
     /**
      * Sign a record using a private key.
      *