@kehto/services 0.13.2 → 0.15.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ServiceHandler, Signer } from '@kehto/runtime';
+import { ServiceHandler, Signer, RelayEventResult } from '@kehto/runtime';
 import { IdentityGetProfileMessage, IdentityGetProfileResultMessage, IdentityGetFollowsMessage, IdentityGetFollowsResultMessage, IdentityGetListMessage, IdentityGetListResultMessage, IdentityGetZapsMessage, IdentityGetZapsResultMessage, IdentityGetMutesMessage, IdentityGetMutesResultMessage, IdentityGetBlockedMessage, IdentityGetBlockedResultMessage, IdentityGetBadgesMessage, IdentityGetBadgesResultMessage } from '@napplet/nap/identity/types';
 import { NostrFilter, NostrEvent, EventTemplate, LinkOpenOptions, LinkOpenResult, ListSupport, ListRef, ListItem, ListOptions, ListMutationResult, SerialOpenRequest, SerialOpenResult, BleEvent, BleOpenRequest, BleOpenResult, BleService, BleAttribute, BleWriteOptions, WebrtcEvent, WebrtcOpenRequest, WebrtcOpenResult, CommonProfileTarget, CommonProfileResult, CommonFollowsResult, CommonActionResult, CommonReaction, CommonReportTarget, CommonReportReason } from '@napplet/core';
 import { MediaMetadata, MediaAction } from '@napplet/nap/media/types';
@@ -471,6 +471,46 @@ type HostCacheBridge = CacheServiceOptions;
  */
 declare function createCacheService(options: CacheServiceOptions): ServiceHandler;
 
+interface CountRequest {
+    /** NIP-01 filters with NIP-45 COUNT OR semantics. */
+    readonly filters: NostrFilter[];
+    /** Optional runtime-owned count policy hints. */
+    readonly options?: Record<string, unknown>;
+    /** Window requesting the count. */
+    readonly windowId: string;
+}
+interface CountResult {
+    readonly ok: boolean;
+    readonly count?: number;
+    readonly approximate?: boolean;
+    readonly hll?: string;
+    readonly relays?: readonly string[];
+    readonly error?: string;
+    readonly reason?: string;
+}
+interface CountServiceOptions {
+    /**
+     * Count matching events without returning event payloads.
+     *
+     * @param request - Validated count request.
+     * @returns Exact/approximate count metadata, or a number for an exact count.
+     */
+    count(request: CountRequest): CountResult | number | Promise<CountResult | number>;
+    /**
+     * Optional refusal policy for unsupported or too-expensive filters.
+     *
+     * Return `true` to allow the filter, `false` for a generic refusal, or a
+     * string with the refusal reason.
+     *
+     * @param filter - Filter being evaluated.
+     * @param index - Filter index in the OR filter set.
+     */
+    isFilterSupported?(filter: NostrFilter, index: number): boolean | string;
+    /** Maximum number of OR filters accepted before refusing the request. */
+    maxFilters?: number;
+}
+declare function createCountService(options: CountServiceOptions): ServiceHandler;
+
 /**
  * Options for creating a coordinated relay service.
  *
@@ -1595,7 +1635,7 @@ declare function createResourceService(options: ResourceServiceOptions): Resourc
  *   Inbound:  outbox.getEvent, outbox.query, outbox.subscribe, outbox.close,
  *             outbox.publish, outbox.resolveRelays
  *   Outbound: outbox.getEvent.result, outbox.query.result, outbox.event,
- *             outbox.eose, outbox.closed, outbox.publish.result,
+ *             outbox.closed, outbox.publish.result,
  *             outbox.resolveRelays.result
  *
  * The shell owns relay discovery, routing, fallback, deduplication, signature
@@ -1680,10 +1720,8 @@ interface OutboxRelayPlan {
 }
 /** Outcome of a single-event outbox lookup. */
 interface OutboxEventResult {
-    /** The signature-validated event matching the requested event id, when found. */
-    event?: NostrEvent;
-    /** Relay URLs where the shell observed the event. */
-    relays: string[];
+    /** The signature-validated event result matching the requested event id, when found. */
+    result?: RelayEventResult;
     /** True when some relay lists or connections failed and the lookup was partial. */
     incomplete?: boolean;
     /** Error reason when the lookup could not complete or did not find the event. */
@@ -1691,10 +1729,8 @@ interface OutboxEventResult {
 }
 /** Outcome of an outbox query, as returned by the {@link OutboxRouter}. */
 interface OutboxResult {
-    /** Deduplicated, signature-validated events. */
-    events: NostrEvent[];
-    /** Map of event id -> relay URLs where the shell observed the event. */
-    relays: Record<string, string[]>;
+    /** Deduplicated, signature-validated event results. */
+    events: RelayEventResult[];
     /** True when some relay lists or connections failed and results are partial. */
     incomplete?: boolean;
     /** Error reason when the query could not complete. */
@@ -1715,10 +1751,8 @@ interface OutboxPublishResult {
 }
 /** Sink an {@link OutboxRouter} streams subscription lifecycle through. */
 interface OutboxSubscriptionSink {
-    /** Deliver a matching event; `relay` is the relay it was observed on, when known. */
-    event(event: NostrEvent, relay?: string): void;
-    /** Signal end-of-stored-events. */
-    eose(): void;
+    /** Deliver a matching event result. */
+    event(result: RelayEventResult): void;
     /** Signal that the subscription was closed upstream; `reason` is optional. */
     closed(reason?: string): void;
 }
@@ -2987,4 +3021,4 @@ declare function createCordnRelayCoordinatorClient(options: CordnRelayCoordinato
 /** Create a Cordn/ContextVM-backed NAP-DM adapter. */
 declare function createCordnDmAdapter(options: CordnDmAdapterOptions): DmAdapter;
 
-export { type AudioServiceOptions, type AudioSource, type BleServiceContext, type BleServiceOptions, type CacheServiceOptions, type CatalogIntentResolver, type CatalogIntentResolverOptions, type CommonServiceContext, type CommonServiceOptions, type ConfigSchemaValidation, type ConfigService, type ConfigServiceOptions, type CoordinatedRelayOptions, type CordnCodecResult, type CordnCoordinatorClient, type CordnCoordinatorSubscription, type CordnDmAdapterOptions, type CordnDmClient, type CordnGroupMessage, type CordnRelayCoordinatorOptions, type DmAdapter, type DmConversation, type DmConversationPage, type DmConversationQuery, type DmHexPubkey, DmMemoryStore, type DmMessage, type DmMessagePage, type DmMessageQuery, type DmMessageStatus, type DmOk, type DmPeer, type DmRelayPool, type DmSendRequest, type DmSendResult, type DmService, type DmServiceOptions, type DmStatus, type DmSubscribeRequest, type DmSubscription, type DmTimestamp, type HostCacheBridge, type HostKeyEvent, type HostKeysBridge, type HostMediaBridge, type HttpUploaderOptions, type HttpUploaderRails, type IdentityServiceOptions, type IntentArchetypeSupport, type IntentAvailability, type IntentBehavior, type IntentCandidate, type IntentCatalogEntry, type IntentHandlerPreference, type IntentOpenParams, type IntentRequest, type IntentResolver, type IntentResolverContext, type IntentResult, type IntentServiceOptions, type IntentWindowController, type KeysServiceOptions, type LinkOpenContext, type LinkServiceOptions, type ListsServiceContext, type ListsServiceOptions, type ManifestArchetypeInput, type MaybePromise, type MediaMetadataLike, type MediaPlaybackOwner, type MediaServiceOptions, type MediaSessionCreateOptions, type MediaSessionTarget, type MediaSourceRef, type NdrDmAdapterOptions, type NdrRelayTransport, type NdrRelayTransportOptions, type NdrRumorLike, type NdrRuntimeLike, type Nip17DmAdapterOptions, type NostrTag, type Notification, type NotificationServiceOptions, type NotifyServiceOptions, type OutboxEventOptions, type OutboxEventResult, type OutboxPublishOptions, type OutboxPublishResult, type OutboxQueryOptions, type OutboxRelayPlan, type OutboxRelayPool, type OutboxResult, type OutboxRouter, type OutboxRouterSubscription, type OutboxServiceOptions, type OutboxStrategy, type OutboxSubscribeOptions, type OutboxSubscriptionSink, type OutboxTarget, type RailServerConfig, type RelayListEntry, type RelayPoolOutboxRouterOptions, type RelayPoolServiceOptions, type ResourceInfo, type ResourceInfoContext, type ResourceInfoProvider, type ResourceSchemeInfo, type ResourceService, type ResourceServiceOptions, type SerialServiceContext, type SerialServiceOptions, type SignEvent, type ThemeService, type ThemeServiceOptions, type UploadDimensions, type UploadInfo, type UploadInfoContext, type UploadInfoProvider, type UploadRail, type UploadRailInfo, type UploadRequest, type UploadResult, type UploadServiceOptions, type UploadState, type UploadStatus, type Uploader, type UploaderContext, type WebrtcServiceContext, type WebrtcServiceOptions, createAudioService, createBleService, createBrowserMediaBridge, createCacheService, createCatalogIntentResolver, createCommonService, createConfigService, createCoordinatedRelay, createCordnDmAdapter, createCordnRelayCoordinatorClient, createDmService, createHttpUploader, createIdentityService, createIntentService, createKeysService, createLinkService, createListsService, createMediaService, createNdrDmAdapter, createNdrRelayTransport, createNip17DmAdapter, createNotificationService, createNotifyService, createOutboxService, createRelayPoolOutboxRouter, createRelayPoolService, createResourceService, createSerialService, createThemeService, createUploadService, createWebrtcService, manifestToIntentCatalogEntry };
+export { type AudioServiceOptions, type AudioSource, type BleServiceContext, type BleServiceOptions, type CacheServiceOptions, type CatalogIntentResolver, type CatalogIntentResolverOptions, type CommonServiceContext, type CommonServiceOptions, type ConfigSchemaValidation, type ConfigService, type ConfigServiceOptions, type CoordinatedRelayOptions, type CordnCodecResult, type CordnCoordinatorClient, type CordnCoordinatorSubscription, type CordnDmAdapterOptions, type CordnDmClient, type CordnGroupMessage, type CordnRelayCoordinatorOptions, type CountRequest, type CountResult, type CountServiceOptions, type DmAdapter, type DmConversation, type DmConversationPage, type DmConversationQuery, type DmHexPubkey, DmMemoryStore, type DmMessage, type DmMessagePage, type DmMessageQuery, type DmMessageStatus, type DmOk, type DmPeer, type DmRelayPool, type DmSendRequest, type DmSendResult, type DmService, type DmServiceOptions, type DmStatus, type DmSubscribeRequest, type DmSubscription, type DmTimestamp, type HostCacheBridge, type HostKeyEvent, type HostKeysBridge, type HostMediaBridge, type HttpUploaderOptions, type HttpUploaderRails, type IdentityServiceOptions, type IntentArchetypeSupport, type IntentAvailability, type IntentBehavior, type IntentCandidate, type IntentCatalogEntry, type IntentHandlerPreference, type IntentOpenParams, type IntentRequest, type IntentResolver, type IntentResolverContext, type IntentResult, type IntentServiceOptions, type IntentWindowController, type KeysServiceOptions, type LinkOpenContext, type LinkServiceOptions, type ListsServiceContext, type ListsServiceOptions, type ManifestArchetypeInput, type MaybePromise, type MediaMetadataLike, type MediaPlaybackOwner, type MediaServiceOptions, type MediaSessionCreateOptions, type MediaSessionTarget, type MediaSourceRef, type NdrDmAdapterOptions, type NdrRelayTransport, type NdrRelayTransportOptions, type NdrRumorLike, type NdrRuntimeLike, type Nip17DmAdapterOptions, type NostrTag, type Notification, type NotificationServiceOptions, type NotifyServiceOptions, type OutboxEventOptions, type OutboxEventResult, type OutboxPublishOptions, type OutboxPublishResult, type OutboxQueryOptions, type OutboxRelayPlan, type OutboxRelayPool, type OutboxResult, type OutboxRouter, type OutboxRouterSubscription, type OutboxServiceOptions, type OutboxStrategy, type OutboxSubscribeOptions, type OutboxSubscriptionSink, type OutboxTarget, type RailServerConfig, type RelayListEntry, type RelayPoolOutboxRouterOptions, type RelayPoolServiceOptions, type ResourceInfo, type ResourceInfoContext, type ResourceInfoProvider, type ResourceSchemeInfo, type ResourceService, type ResourceServiceOptions, type SerialServiceContext, type SerialServiceOptions, type SignEvent, type ThemeService, type ThemeServiceOptions, type UploadDimensions, type UploadInfo, type UploadInfoContext, type UploadInfoProvider, type UploadRail, type UploadRailInfo, type UploadRequest, type UploadResult, type UploadServiceOptions, type UploadState, type UploadStatus, type Uploader, type UploaderContext, type WebrtcServiceContext, type WebrtcServiceOptions, createAudioService, createBleService, createBrowserMediaBridge, createCacheService, createCatalogIntentResolver, createCommonService, createConfigService, createCoordinatedRelay, createCordnDmAdapter, createCordnRelayCoordinatorClient, createCountService, createDmService, createHttpUploader, createIdentityService, createIntentService, createKeysService, createLinkService, createListsService, createMediaService, createNdrDmAdapter, createNdrRelayTransport, createNip17DmAdapter, createNotificationService, createNotifyService, createOutboxService, createRelayPoolOutboxRouter, createRelayPoolService, createResourceService, createSerialService, createThemeService, createUploadService, createWebrtcService, manifestToIntentCatalogEntry };