@welshman/app 0.0.20 → 0.0.21

package/build/src/router.d.ts

@@ -1,6 +1,5 @@
-import { Tags } from '@welshman/util';
-import type { TrustedEvent, Filter } from '@welshman/util';
-import type { RelaysAndFilters } from '@welshman/net';
+import type { TrustedEvent, Filter } from "@welshman/util";
+import type { RelaysAndFilters } from "@welshman/net";
 export declare const INDEXED_KINDS: number[];
 export declare enum RelayMode {
     Read = "read",
@@ -13,18 +12,6 @@ export type RouterOptions = {
      * @returns The user's public key as a string, or null if not available.
      */
     getUserPubkey?: () => string | null;
-    /**
-     * Retrieves group relays for the specified community.
-     * @param address - The address to retrieve group relays for.
-     * @returns An array of group relay URLs as strings.
-     */
-    getGroupRelays?: (address: string) => string[];
-    /**
-     * Retrieves relays for the specified community.
-     * @param address - The address to retrieve community relays for.
-     * @returns An array of community relay URLs as strings.
-     */
-    getCommunityRelays?: (address: string) => string[];
     /**
      * Retrieves relays for the specified public key and mode.
      * @param pubkey - The public key to retrieve relays for.
@@ -53,11 +40,6 @@ export type RouterOptions = {
      * @returns The quality of the relay as a number between 0 and 1 inclusive.
      */
     getRelayQuality?: (url: string) => number;
-    /**
-     * Retrieves the redundancy setting, which is how many relays to use per selection value.
-     * @returns The redundancy setting as a number.
-     */
-    getRedundancy?: () => number;
     /**
      * Retrieves the limit setting, which is the maximum number of relays that should be
      * returned from getUrls and getSelections.
@@ -65,135 +47,141 @@ export type RouterOptions = {
      */
     getLimit?: () => number;
 };
-export type ValuesByRelay = Map<string, string[]>;
-export type RelayValues = {
-    relay: string;
-    values: string[];
-};
-export type ValueRelays = {
-    value: string;
+export type Selection = {
+    weight: number;
     relays: string[];
 };
 export type FallbackPolicy = (count: number, limit: number) => number;
-export declare const addNoFallbacks: (count: number, redundancy: number) => number;
-export declare const addMinimalFallbacks: (count: number, redundancy: number) => 0 | 1;
-export declare const addMaximalFallbacks: (count: number, redundancy: number) => number;
+export declare const addNoFallbacks: (count: number, limit: number) => number;
+export declare const addMinimalFallbacks: (count: number, limit: number) => 0 | 1;
+export declare const addMaximalFallbacks: (count: number, limit: number) => number;
 export declare class Router {
     readonly options: RouterOptions;
     constructor(options: RouterOptions);
-    getPubkeySelection: (pubkey: string, mode?: RelayMode) => {
-        value: string;
-        relays: string[];
-    };
-    getPubkeySelections: (pubkeys: string[], mode?: RelayMode) => {
-        value: string;
-        relays: string[];
-    }[];
-    getUserSelections: (mode?: RelayMode) => {
-        value: string;
-        relays: string[];
-    }[];
-    getContextSelections: (tags: Tags) => {
-        value: string;
-        relays: string[];
-    }[];
-    selection: (value: string, relays: Iterable<string>) => {
-        value: string;
-        relays: string[];
-    };
-    selections: (values: string[], relays: string[]) => {
-        value: string;
-        relays: string[];
-    }[];
-    forceValue: (value: string, selections: ValueRelays[]) => {
-        value: string;
-        relays: string[];
-    }[];
-    relaySelectionsFromMap: (valuesByRelay: ValuesByRelay) => {
-        relay: string;
-        values: string[];
-    }[];
-    scoreRelaySelection: ({ values, relay }: RelayValues) => number;
-    sortRelaySelections: (relaySelections: RelayValues[]) => RelayValues[];
-    scenario: (selections: ValueRelays[]) => RouterScenario;
+    getRelaysForPubkey: (pubkey: string, mode?: RelayMode) => string[];
+    getRelaysForPubkeys: (pubkeys: string[], mode?: RelayMode) => string[][];
+    getRelaysForUser: (mode?: RelayMode) => string[];
+    scenario: (selections: Selection[]) => RouterScenario;
     merge: (scenarios: RouterScenario[]) => RouterScenario;
-    product: (values: string[], relays: string[]) => RouterScenario;
-    fromRelays: (relays: string[]) => RouterScenario;
-    User: () => RouterScenario;
-    ReadRelays: () => RouterScenario;
-    WriteRelays: () => RouterScenario;
-    InboxRelays: () => RouterScenario;
-    Messages: (pubkeys: string[]) => RouterScenario;
-    PublishMessage: (pubkey: string) => RouterScenario;
+    FromRelays: (relays: string[]) => RouterScenario;
+    ForUser: () => RouterScenario;
+    FromUser: () => RouterScenario;
+    UserInbox: () => RouterScenario;
+    ForPubkey: (pubkey: string) => RouterScenario;
+    FromPubkey: (pubkey: string) => RouterScenario;
+    PubkeyInbox: (pubkey: string) => RouterScenario;
+    ForPubkeys: (pubkeys: string[]) => RouterScenario;
+    FromPubkeys: (pubkeys: string[]) => RouterScenario;
+    PubkeyInboxes: (pubkeys: string[]) => RouterScenario;
     Event: (event: TrustedEvent) => RouterScenario;
-    EventChildren: (event: TrustedEvent) => RouterScenario;
+    Replies: (event: TrustedEvent) => RouterScenario;
+    Quote: (event: TrustedEvent, value: string, relays?: never[]) => RouterScenario;
     EventAncestors: (event: TrustedEvent, type: "mentions" | "replies" | "roots") => RouterScenario;
     EventMentions: (event: TrustedEvent) => RouterScenario;
     EventParents: (event: TrustedEvent) => RouterScenario;
     EventRoots: (event: TrustedEvent) => RouterScenario;
     PublishEvent: (event: TrustedEvent) => RouterScenario;
-    FromPubkeys: (pubkeys: string[]) => RouterScenario;
-    ForPubkeys: (pubkeys: string[]) => RouterScenario;
-    WithinGroup: (address: string, relays?: string) => RouterScenario;
-    WithinCommunity: (address: string) => RouterScenario;
-    WithinContext: (address: string) => RouterScenario;
-    WithinMultipleContexts: (addresses: string[]) => RouterScenario;
-    Search: (term: string, relays?: string[]) => RouterScenario;
 }
 export type RouterScenarioOptions = {
-    redundancy?: number;
     policy?: FallbackPolicy;
     limit?: number;
 };
 export declare class RouterScenario {
     readonly router: Router;
-    readonly selections: ValueRelays[];
+    readonly selections: Selection[];
     readonly options: RouterScenarioOptions;
-    constructor(router: Router, selections: ValueRelays[], options?: RouterScenarioOptions);
+    constructor(router: Router, selections: Selection[], options?: RouterScenarioOptions);
     clone: (options: RouterScenarioOptions) => RouterScenario;
-    filter: (f: (selection: ValueRelays) => boolean) => RouterScenario;
-    update: (f: (selection: ValueRelays) => ValueRelays) => RouterScenario;
-    redundancy: (redundancy: number) => RouterScenario;
+    filter: (f: (selection: Selection) => boolean) => RouterScenario;
+    update: (f: (selection: Selection) => Selection) => RouterScenario;
     policy: (policy: FallbackPolicy) => RouterScenario;
     limit: (limit: number) => RouterScenario;
-    getRedundancy: () => number;
-    getPolicy: () => (count: number, redundancy: number) => number;
+    weight: (scale: number) => RouterScenario;
+    getPolicy: () => (count: number, limit: number) => number;
     getLimit: () => number;
-    getSelections: () => {
-        relay: string;
-        values: string[];
-    }[];
     getUrls: () => string[];
     getUrl: () => string;
 }
-export declare const getRelayQuality: (url: string) => number;
+export declare const getRelayQuality: (url: string) => 0 | 1;
 export declare const getPubkeyRelays: (pubkey: string, mode?: string) => string[];
 export declare const getIndexerRelays: () => string[];
 export declare const getFallbackRelays: () => string[];
 export declare const getSearchRelays: () => string[];
 export declare const makeRouter: (options?: Partial<RouterOptions>) => Router;
-export type FilterSelection = {
-    id: string;
+type FilterScenario = {
     filter: Filter;
     scenario: RouterScenario;
 };
-type FilterSelectionRuleState = {
+type FilterSelectionRule = (filter: Filter) => FilterScenario[];
+export declare const getFilterSelectionsForSearch: (filter: Filter) => {
     filter: Filter;
-    selections: FilterSelection[];
-};
-type FilterSelectionRule = (state: FilterSelectionRuleState) => boolean;
-export declare const makeFilterSelection: (id: string, filter: Filter, scenario: RouterScenario) => {
-    id: string;
+    scenario: RouterScenario;
+}[];
+export declare const getFilterSelectionsForWraps: (filter: Filter) => {
+    filter: {
+        kinds: number[];
+        ids?: string[] | undefined;
+        authors?: string[] | undefined;
+        since?: number | undefined;
+        until?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+    };
+    scenario: RouterScenario;
+}[];
+export declare const getFilterSelectionsForIndexedKinds: (filter: Filter) => {
+    filter: {
+        kinds: number[];
+        ids?: string[] | undefined;
+        authors?: string[] | undefined;
+        since?: number | undefined;
+        until?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+    };
+    scenario: RouterScenario;
+}[];
+export declare const getFilterSelectionsForAuthors: (filter: Filter) => {
+    filter: {
+        authors: string[];
+        ids?: string[] | undefined;
+        kinds?: number[] | undefined;
+        since?: number | undefined;
+        until?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+    };
+    scenario: RouterScenario;
+}[];
+export declare const getFilterSelectionsForUser: (filter: Filter) => {
     filter: Filter;
     scenario: RouterScenario;
-};
-export declare const getFilterSelectionsForLocalRelay: (state: FilterSelectionRuleState) => boolean;
-export declare const getFilterSelectionsForSearch: (state: FilterSelectionRuleState) => boolean;
-export declare const getFilterSelectionsForContext: (state: FilterSelectionRuleState) => boolean;
-export declare const getFilterSelectionsForWraps: (state: FilterSelectionRuleState) => boolean;
-export declare const getFilterSelectionsForIndexedKinds: (state: FilterSelectionRuleState) => boolean;
-export declare const getFilterSelectionsForAuthors: (state: FilterSelectionRuleState) => boolean;
-export declare const getFilterSelectionsForUser: (state: FilterSelectionRuleState) => boolean;
-export declare const defaultFilterSelectionRules: ((state: FilterSelectionRuleState) => boolean)[];
+}[];
+export declare const defaultFilterSelectionRules: (((filter: Filter) => {
+    filter: Filter;
+    scenario: RouterScenario;
+}[]) | ((filter: Filter) => {
+    filter: {
+        kinds: number[];
+        ids?: string[] | undefined;
+        authors?: string[] | undefined;
+        since?: number | undefined;
+        until?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+    };
+    scenario: RouterScenario;
+}[]) | ((filter: Filter) => {
+    filter: {
+        authors: string[];
+        ids?: string[] | undefined;
+        kinds?: number[] | undefined;
+        since?: number | undefined;
+        until?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+    };
+    scenario: RouterScenario;
+}[]))[];
 export declare const getFilterSelections: (filters: Filter[], rules?: FilterSelectionRule[]) => RelaysAndFilters[];
 export {};