@welshman/app 0.14.0-pre4 → 0.14.0

package/dist/store/src/{repository.d.ts → derive.d.ts}

@@ -1,54 +1,53 @@
-import { Readable } from "svelte/store";
-import { Maybe, MaybeAsync } from "@welshman/lib";
-import { Filter, TrustedEvent } from "@welshman/util";
-import { Repository, Tracker } from "@welshman/net";
+import type { Maybe, MaybeAsync } from "@welshman/lib";
+import type { Filter, TrustedEvent } from "@welshman/util";
+import type { Readable, Unsubscriber } from "./svelte.js";
 import type { Projection } from "./misc.js";
+import type { Repository } from "./repository/core.js";
+/** A `Projection` whose value comes from a `Repository`, with `load` for a fresh read. */
+export type AsyncProjection<T> = Projection<T> & {
+    load: () => Promise<T>;
+};
+/** Build an `AsyncProjection` derived from another, whose `load` reads `src` fresh. */
+export declare const projectAsync: <S, U>(src: AsyncProjection<S>, read: ($: S) => U) => AsyncProjection<U>;
 export type EventsById = Map<string, TrustedEvent>;
 export type EventsByIdOptions = {
     filters: Filter[];
     repository: Repository;
     includeDeleted?: boolean;
 };
-export declare const getEventsById: ({ filters, repository, includeDeleted }: EventsByIdOptions) => Map<string, TrustedEvent>;
-export declare const deriveEventsById: (options: EventsByIdOptions) => Projection<EventsById>;
+export declare const getEventsById: ({ filters, repository, includeDeleted }: EventsByIdOptions) => Promise<Map<string, TrustedEvent>>;
+/** The events matching `filters`, kept current. It holds its last value until the read answers. */
+export declare const deriveEventsById: (options: EventsByIdOptions) => AsyncProjection<EventsById>;
+export type ObserveEventsByIdOptions = EventsByIdOptions & {
+    onEvents: (eventsById: EventsById) => void;
+};
+/** Calls `onEvents` with the matches once the read answers, then on each change, until stopped. */
+export declare const observeEventsById: ({ filters, repository, includeDeleted, onEvents, }: ObserveEventsByIdOptions) => Unsubscriber;
 export declare const deriveArray: <T>(itemsById: Projection<Map<string, T>>) => Projection<T[]>;
-export declare const deriveEventsAsc: (eventsById: Projection<EventsById>) => Projection<TrustedEvent[]>;
-export declare const deriveEventsDesc: (eventsById: Projection<EventsById>) => Projection<TrustedEvent[]>;
-export declare const deriveEvents: (options: EventsByIdOptions) => Projection<TrustedEvent[]>;
+export declare const deriveEventsArray: (eventsById: AsyncProjection<EventsById>) => AsyncProjection<TrustedEvent[]>;
+export declare const deriveEventsAsc: (eventsById: AsyncProjection<EventsById>) => AsyncProjection<TrustedEvent[]>;
+export declare const deriveEventsDesc: (eventsById: AsyncProjection<EventsById>) => AsyncProjection<TrustedEvent[]>;
+export declare const deriveEvents: (options: EventsByIdOptions) => AsyncProjection<TrustedEvent[]>;
 export type EventOptions = {
     repository: Repository;
     includeDeleted?: boolean;
     onDerive?: (filters: Filter[], ...args: any[]) => void;
 };
-export declare const makeDeriveEvent: ({ repository, includeDeleted, onDerive }: EventOptions) => (idOrAddress: string, ...args: any[]) => Projection<Maybe<TrustedEvent>>;
+export declare const makeDeriveEvent: ({ repository, includeDeleted, onDerive }: EventOptions) => (idOrAddress: string, ...args: any[]) => AsyncProjection<Maybe<TrustedEvent>>;
 export type EventsByIdByUrl = Map<string, EventsById>;
-export type EventsByIdByUrlOptions = EventsByIdOptions & {
-    tracker: Tracker;
-};
-export declare const getEventsByIdByUrl: ({ filters, tracker, repository, includeDeleted, }: EventsByIdByUrlOptions) => EventsByIdByUrl;
-export declare const deriveEventsByIdByUrl: (options: EventsByIdByUrlOptions) => Projection<EventsByIdByUrl>;
+export declare const getEventsByIdByUrl: ({ filters, repository, includeDeleted, }: EventsByIdOptions) => Promise<EventsByIdByUrl>;
+/** The events matching `filters`, grouped by each relay the tracker has seen them on. */
+export declare const deriveEventsByIdByUrl: (options: EventsByIdOptions) => AsyncProjection<EventsByIdByUrl>;
 export type EventsByIdForUrlOptions = EventsByIdOptions & {
     url: string;
-    tracker: Tracker;
 };
-/**
- * The events one relay has been seen to hold, narrowed by the filters. The filters choose the
- * index and the tracker answers provenance per event, so the cost tracks what the caller asked
- * for, and a limit counts only events on the relay.
- */
-export declare const getEventsByIdForUrl: ({ url, filters, tracker, repository, includeDeleted, }: EventsByIdForUrlOptions) => EventsById;
-export declare const deriveEventsByIdForUrl: (options: EventsByIdForUrlOptions) => Projection<EventsById>;
+/** The events one relay has been seen to hold, with any limit counting only those events. */
+export declare const getEventsByIdForUrl: ({ url, filters, repository, includeDeleted, }: EventsByIdForUrlOptions) => Promise<Map<string, TrustedEvent>>;
+export declare const deriveEventsByIdForUrl: (options: EventsByIdForUrlOptions) => AsyncProjection<EventsById>;
 export type ItemsByKey<T> = Map<string, T>;
 export type EventToItem<T> = (event: TrustedEvent) => MaybeAsync<Maybe<T>>;
 export type GetItem<T> = (key: string, ...args: any[]) => MaybeAsync<Maybe<T>>;
-/**
- * A keyed collection of items built from events: a `Projection` over an index, plus a
- * `read` that waits out the parses the index has outstanding.
- *
- * `eventToItem` returns a promise for any kind that decrypts, so the item an event
- * builds is committed after the event was read rather than with it. `read` is how a
- * caller gets an item the collection has seen the event for but not yet parsed.
- */
+/** Items keyed from events, with a `read` that waits out the query and parses still pending. */
 export type ItemCollection<T> = Projection<ItemsByKey<T>> & {
     read: (key: string) => MaybeAsync<Maybe<T>>;
 };
@@ -64,19 +63,12 @@ export type ItemsByKeyByUrlOptions<T> = {
     getKey: (item: T, url: string) => string | undefined;
     filters: Filter[];
     repository: Repository;
-    tracker: Tracker;
     eventToItem: EventToItem<T>;
     includeDeleted?: boolean;
     revalidateOn?: Readable<unknown>;
 };
-/**
- * Like `deriveItemsByKey`, but relay-scoped: an event is keyed once per relay
- * it has been seen on (via the tracker), using `getKey(item, url)`. This is the
- * substrate for relay-dependent collections — NIP-29 rooms, relay membership,
- * relay roles — where the same addressable coordinate can exist independently
- * on multiple relays.
- */
-export declare const deriveItemsByKeyByUrl: <T>({ getKey, filters, repository, tracker, eventToItem, includeDeleted, revalidateOn, }: ItemsByKeyByUrlOptions<T>) => ItemCollection<T>;
+/** Like `deriveItemsByKey`, but keying each event once per relay the tracker has seen it on. */
+export declare const deriveItemsByKeyByUrl: <T>({ getKey, filters, repository, eventToItem, includeDeleted, revalidateOn, }: ItemsByKeyByUrlOptions<T>) => ItemCollection<T>;
 export declare const deriveItems: <T>(itemsByKeyStore: Readable<ItemsByKey<T>>) => Readable<T[]>;
 export declare const deriveItemsSorted: <T>(sortFn: (item: T) => number, itemsStore: Readable<T[]>) => Readable<T[]>;
 export declare const makeDeriveItem: <T>(itemsByKeyStore: Readable<ItemsByKey<T>>, onDerive?: (key: string, ...args: any[]) => unknown) => (key?: string, ...args: any[]) => Readable<T | undefined>;
@@ -91,4 +83,4 @@ export type MakeLoadItemOptions = {
 };
 export declare const makeLoadItem: <T>(loadItem: LoadItem, getItem: GetItem<T>, options?: MakeLoadItemOptions) => (key: string, ...args: any[]) => Promise<Maybe<T>>;
 export declare const deriveIsDeleted: (repository: Repository, event: TrustedEvent) => Projection<boolean>;
-//# sourceMappingURL=repository.d.ts.map
+//# sourceMappingURL=derive.d.ts.map

package/dist/store/src/derive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"derive.d.ts","sourceRoot":"","sources":["../../../../store/src/derive.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAC,KAAK,EAAE,UAAU,EAAC,MAAM,eAAe,CAAA;AAEpD,OAAO,KAAK,EAAC,MAAM,EAAE,YAAY,EAAC,MAAM,gBAAgB,CAAA;AAExD,OAAO,KAAK,EAAC,QAAQ,EAAE,YAAY,EAAC,MAAM,aAAa,CAAA;AAEvD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,WAAW,CAAA;AACzC,OAAO,KAAK,EAAiB,UAAU,EAAmB,MAAM,sBAAsB,CAAA;AAEtF,0FAA0F;AAC1F,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG;IAC/C,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAA;CACvB,CAAA;AAED,uFAAuF;AACvF,eAAO,MAAM,YAAY,GAAI,CAAC,EAAE,CAAC,EAC/B,KAAK,eAAe,CAAC,CAAC,CAAC,EACvB,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAChB,eAAe,CAAC,CAAC,CAA4E,CAAA;AAWhG,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;AAElD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,UAAU,EAAE,UAAU,CAAA;IACtB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,aAAa,GAAU,yCAAuC,iBAAiB,uCAI3F,CAAA;AAkCD,mGAAmG;AACnG,eAAO,MAAM,gBAAgB,GAAI,SAAS,iBAAiB,KAAG,eAAe,CAAC,UAAU,CASvF,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,GAAG;IACzD,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAA;CAC3C,CAAA;AAED,mGAAmG;AACnG,eAAO,MAAM,iBAAiB,GAAI,oDAK/B,wBAAwB,KAAG,YAmB7B,CAAA;AAID,eAAO,MAAM,WAAW,GAAI,CAAC,EAAE,WAAW,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,oBACnC,CAAA;AAEjC,eAAO,MAAM,iBAAiB,GAAI,YAAY,eAAe,CAAC,UAAU,CAAC,oCACtC,CAAA;AAEnC,eAAO,MAAM,eAAe,GAAI,YAAY,eAAe,CAAC,UAAU,CAAC,oCACO,CAAA;AAE9E,eAAO,MAAM,gBAAgB,GAAI,YAAY,eAAe,CAAC,UAAU,CAAC,oCACO,CAAA;AAE/E,eAAO,MAAM,YAAY,GAAI,SAAS,iBAAiB,oCACT,CAAA;AAE9C,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,EAAE,UAAU,CAAA;IACtB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;CACvD,CAAA;AAED,eAAO,MAAM,eAAe,GAAI,0CAAgD,YAAY,MAClF,aAAa,MAAM,EAAE,GAAG,MAAM,GAAG,EAAE,KAAG,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,CAmClF,CAAA;AAID,MAAM,MAAM,eAAe,GAAG,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;AAErD,eAAO,MAAM,kBAAkB,GAAU,0CAItC,iBAAiB,6BAkBnB,CAAA;AAED,yFAAyF;AACzF,eAAO,MAAM,qBAAqB,GAChC,SAAS,iBAAiB,KACzB,eAAe,CAAC,eAAe,CAuHjC,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,GAAG;IACxD,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,6FAA6F;AAC7F,eAAO,MAAM,mBAAmB,GAAU,+CAKvC,uBAAuB,uCAIzB,CAAA;AAKD,eAAO,MAAM,sBAAsB,GACjC,SAAS,uBAAuB,KAC/B,eAAe,CAAC,UAAU,CAqG5B,CAAA;AAID,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;AAE1C,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,KAAK,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAE1E,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAE9E,gGAAgG;AAChG,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG;IAC1D,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C,CAAA;AAuHD,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IACjC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAA;IAC3B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,UAAU,EAAE,UAAU,CAAA;IACtB,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IAC3B,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,gBAAgB,GAAI,CAAC,EAAE,+DAMjC,iBAAiB,CAAC,CAAC,CAAC,KAAG,cAAc,CAAC,CAAC,CAsFzC,CAAA;AAID,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI;IAMtC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAA;IACpD,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,UAAU,EAAE,UAAU,CAAA;IACtB,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;IAC3B,cAAc,CAAC,EAAE,OAAO,CAAA;IAIxB,YAAY,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;CACjC,CAAA;AAED,gGAAgG;AAChG,eAAO,MAAM,qBAAqB,GAAI,CAAC,EAAE,6EAOtC,sBAAsB,CAAC,CAAC,CAAC,KAAG,cAAc,CAAC,CAAC,CAwM9C,CAAA;AAED,eAAO,MAAM,WAAW,GAAI,CAAC,EAAE,iBAAiB,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,kBACE,CAAA;AAEzE,eAAO,MAAM,iBAAiB,GAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,EAAE,YAAY,QAAQ,CAAC,CAAC,EAAE,CAAC,kBACtC,CAAA;AAErD,eAAO,MAAM,cAAc,GAAI,CAAC,EAC9B,iBAAiB,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EACxC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,MAE3C,MAAM,MAAM,EAAE,GAAG,MAAM,GAAG,EAAE,4BAQrC,CAAA;AAID,MAAM,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;AAExE,eAAO,MAAM,iBAAiB,GAAI,CAAC,EAAE,UAAU,QAAQ,EAAE,SAAS,OAAO,CAAC,CAAC,CAAC,MAC5D,KAAK,MAAM,EAAE,GAAG,MAAM,GAAG,EAAE,sBAK1C,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAA;IACpC,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IAC9C,SAAS,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAA;IACtC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,eAAO,MAAM,YAAY,GAAI,CAAC,EAC5B,UAAU,QAAQ,EAClB,SAAS,OAAO,CAAC,CAAC,CAAC,EACnB,UAAS,mBAAwB,MAYnB,KAAK,MAAM,EAAE,GAAG,MAAM,GAAG,EAAE,KAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CA8C7D,CAAA;AAID,eAAO,MAAM,eAAe,GAAI,YAAY,UAAU,EAAE,OAAO,YAAY,KAAG,UAAU,CAAC,OAAO,CAyB7F,CAAA"}