@peerbit/shared-log 8.0.7 → 9.0.0-2bc15a6

package/{lib/esm → dist/src}/index.d.ts

@@ -1,25 +1,21 @@
-import { RequestContext, RPC } from "@peerbit/rpc";
-import { TransportMessage } from "./message.js";
-import { AppendOptions, Entry, Log, LogEvents, LogProperties } from "@peerbit/log";
-import { Program, ProgramEvents } from "@peerbit/program";
 import { PublicSignKey } from "@peerbit/crypto";
+import { type Index } from "@peerbit/indexer-interface";
+import { type AppendOptions, type Change, Entry, Log, type LogEvents, type LogProperties, ShallowEntry, type ShallowOrFullEntry } from "@peerbit/log";
+import { Program, type ProgramEvents } from "@peerbit/program";
 import { SubscriptionEvent, UnsubcriptionEvent } from "@peerbit/pubsub-interface";
-import { Observer, Replicator, Role } from "./role.js";
-import { AbsoluteReplicas, ReplicationLimits, ReplicatorRect } from "./replication.js";
-import yallist from "yallist";
+import { RPC, type RequestContext } from "@peerbit/rpc";
+import { type CPUUsage, CPUUsageIntervalLag } from "./cpu.js";
+import { TransportMessage } from "./message.js";
 import { PIDReplicationController } from "./pid.js";
+import { AbsoluteReplicas, type ReplicationLimits, ReplicationRange, ReplicationRangeIndexable } from "./replication.js";
 export * from "./replication.js";
-import { CPUUsage, CPUUsageIntervalLag } from "./cpu.js";
 export { type CPUUsage, CPUUsageIntervalLag };
-export { Observer, Replicator, Role };
 export declare const logger: import("pino").Logger<never>;
 export type ReplicationLimitsOptions = Partial<ReplicationLimits> | {
     min?: number;
     max?: number;
 };
-type StringRoleOptions = "observer" | "replicator";
-export type AdaptiveReplicatorOptions = {
-    type: "replicator";
+export type DynamicReplicationOptions = {
     limits?: {
         storage?: number;
         cpu?: number | {
@@ -28,20 +24,17 @@ export type AdaptiveReplicatorOptions = {
         };
     };
 };
-export type FixedReplicatorOptions = {
-    type: "replicator";
+export type FixedReplicationOptions = {
     factor: number;
+    offset?: number;
 };
-export type ObserverType = {
-    type: "observer";
-};
-export type RoleOptions = StringRoleOptions | ObserverType | FixedReplicatorOptions | AdaptiveReplicatorOptions;
+export type ReplicationOptions = DynamicReplicationOptions | FixedReplicationOptions | number | boolean;
 export type SharedLogOptions<T> = {
-    role?: RoleOptions;
+    replicate?: ReplicationOptions;
     replicas?: ReplicationLimitsOptions;
     respondToIHaveTimeout?: number;
     canReplicate?: (publicKey: PublicSignKey) => Promise<boolean> | boolean;
-    sync?: (entry: Entry<T>) => boolean;
+    sync?: (entry: Entry<T> | ShallowEntry) => boolean;
     timeUntilRoleMaturity?: number;
     waitForReplicatorTimeout?: number;
     distributionDebounceTime?: number;
@@ -54,24 +47,30 @@ export type SharedAppendOptions<T> = AppendOptions<T> & {
     replicas?: AbsoluteReplicas | number;
     target?: "all" | "replicators";
 };
-type UpdateRoleEvent = {
+type ReplicatorJoinEvent = {
+    publicKey: PublicSignKey;
+};
+type ReplicatorLeaveEvent = {
+    publicKey: PublicSignKey;
+};
+type ReplicationChange = {
     publicKey: PublicSignKey;
-    role: Role;
 };
 export interface SharedLogEvents extends ProgramEvents {
-    role: CustomEvent<UpdateRoleEvent>;
+    "replicator:join": CustomEvent<ReplicatorJoinEvent>;
+    "replicator:leave": CustomEvent<ReplicatorLeaveEvent>;
+    "replication:change": CustomEvent<ReplicationChange>;
 }
 export declare class SharedLog<T = Uint8Array> extends Program<Args<T>, SharedLogEvents> {
     log: Log<T>;
     rpc: RPC<TransportMessage, TransportMessage>;
-    private _role;
-    private _roleConfig;
-    private _sortedPeersCache;
+    private _replicationSettings?;
+    private _replicationRangeIndex;
     private _totalParticipation;
     private _gidPeersHistory;
     private _onSubscriptionFn;
     private _onUnsubscriptionFn;
-    private _canReplicate?;
+    private _isTrustedReplicator?;
     private _logProperties?;
     private _closeController;
     private _gidParentCache;
@@ -95,83 +94,94 @@ export declare class SharedLog<T = Uint8Array> extends Program<Args<T>, SharedLo
     timeUntilRoleMaturity: number;
     waitForReplicatorTimeout: number;
     distributionDebounceTime: number;
+    replicationController: PIDReplicationController;
+    history: {
+        usedMemory: number;
+        factor: number;
+    }[];
+    private pq;
     constructor(properties?: {
         id?: Uint8Array;
     });
-    /**
-     * Returns the current role
-     */
-    get role(): Observer | Replicator;
     /**
      * Return the
      */
-    get roleConfig(): Observer | Replicator | AdaptiveReplicatorOptions;
+    get replicationSettings(): ReplicationOptions | undefined;
+    isReplicating(): Promise<boolean>;
     get totalParticipation(): number;
+    calculateTotalParticipation(): Promise<number>;
+    countReplicationSegments(): Promise<number>;
     private setupRebalanceDebounceFunction;
-    private setupRole;
-    updateRole(role: RoleOptions, onRoleChange?: boolean): Promise<"added" | "none" | "updated" | "removed">;
-    private _updateRole;
+    private setupReplicationSettings;
+    replicate(range?: ReplicationRange | ReplicationOptions): Promise<void>;
+    private removeReplicator;
+    private updateOldestTimestampFromIndex;
+    private removeReplicationRange;
+    private addReplicationRange;
+    startAnnounceReplicating(range: ReplicationRangeIndexable): Promise<void>;
     append(data: T, options?: SharedAppendOptions<T> | undefined): Promise<{
         entry: Entry<T>;
-        removed: Entry<T>[];
+        removed: ShallowOrFullEntry<T>[];
     }>;
     open(options?: Args<T>): Promise<void>;
     afterOpen(): Promise<void>;
+    reload(): Promise<void>;
     getMemoryUsage(): Promise<number>;
     get topic(): string;
+    onChange(change: Change<T>): Promise<void>;
+    canAppend(entry: Entry<T>): Promise<boolean>;
     private _close;
     close(from?: Program): Promise<boolean>;
     drop(from?: Program): Promise<boolean>;
     recover(): Promise<void>;
     _onMessage(msg: TransportMessage, context: RequestContext): Promise<TransportMessage | undefined>;
-    getReplicatorsSorted(): yallist<ReplicatorRect> | undefined;
-    waitForReplicator(...keys: PublicSignKey[]): Promise<boolean | void | undefined>;
+    getMyReplicationSegments(): Promise<ReplicationRangeIndexable[]>;
+    getTotalParticipation(): Promise<number>;
+    get replicationIndex(): Index<ReplicationRangeIndexable>;
+    /**
+     * TODO improve efficiency
+     */
+    getReplicators(): Promise<Set<unknown>>;
+    waitForReplicator(...keys: PublicSignKey[]): Promise<boolean | void>;
     isLeader(slot: {
         toString(): string;
     }, numberOfLeaders: number, options?: {
         candidates?: string[];
         roleAge?: number;
     }): Promise<boolean>;
-    private getReplicationOffset;
     private waitForIsLeader;
     findLeaders(subject: {
         toString(): string;
     }, numberOfLeaders: number, options?: {
         roleAge?: number;
     }): Promise<string[]>;
-    getDefaultMinRoleAge(): number;
+    getDefaultMinRoleAge(): Promise<number>;
     private findLeadersFromUniformNumber;
     /**
      *
      * @returns groups where at least one in any group will have the entry you are looking for
      */
-    getReplicatorUnion(roleAge?: number): string[];
-    replicator(entry: Entry<any>, options?: {
+    getReplicatorUnion(roleAge?: number): Promise<string[]>;
+    isReplicator(entry: Entry<any>, options?: {
         candidates?: string[];
         roleAge?: number;
     }): Promise<boolean>;
-    private onRoleChange;
-    private modifyReplicators;
-    private _modifyReplicators;
-    handleSubscriptionChange(publicKey: PublicSignKey, changes: string[], subscribed: boolean): Promise<void>;
-    prune(entries: Entry<any>[], options?: {
+    handleSubscriptionChange(publicKey: PublicSignKey, topics: string[], subscribed: boolean): Promise<void>;
+    prune(entries: (Entry<any> | ShallowEntry)[], options?: {
         timeout?: number;
         unchecked?: boolean;
     }): Promise<any>[];
-    distribute(): Promise<false | void>;
-    _distribute(): Promise<false | undefined>;
+    distribute(): Promise<boolean | void>;
+    _distribute(): Promise<boolean>;
     private requestSync;
     _onUnsubscription(evt: CustomEvent<UnsubcriptionEvent>): Promise<void>;
     _onSubscription(evt: CustomEvent<SubscriptionEvent>): Promise<void>;
-    replicationController: PIDReplicationController;
-    history: {
-        usedMemory: number;
-        factor: number;
-    }[];
     addToHistory(usedMemory: number, factor: number): Promise<void>;
     calculateTrend(): Promise<number>;
     rebalanceParticipation(onRoleChange?: boolean): Promise<boolean>;
+    getDynamicRange(): Promise<ReplicationRangeIndexable>;
     private clearSyncProcess;
     private onEntryAdded;
     onEntryRemoved(hash: string): void;
 }
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAEN,aAAa,EAIb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAKN,KAAK,KAAK,EAQV,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACN,KAAK,aAAa,EAClB,KAAK,MAAM,EACX,KAAK,EACL,GAAG,EACH,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,YAAY,EACZ,KAAK,kBAAkB,EACvB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EACN,iBAAiB,EACjB,kBAAkB,EAClB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,GAAG,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AAYxD,OAAO,EAAE,KAAK,QAAQ,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAU9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AAEpD,OAAO,EACN,gBAAgB,EAGhB,KAAK,iBAAiB,EACtB,gBAAgB,EAChB,yBAAyB,EASzB,MAAM,kBAAkB,CAAC;AAG1B,cAAc,kBAAkB,CAAC;AAEjC,OAAO,EAAE,KAAK,QAAQ,EAAE,mBAAmB,EAAE,CAAC;AAE9C,eAAO,MAAM,MAAM,8BAAqC,CAAC;AAwBzD,MAAM,MAAM,wBAAwB,GACjC,OAAO,CAAC,iBAAiB,CAAC,GAC1B;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAElC,MAAM,MAAM,yBAAyB,GAAG;IACvC,MAAM,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,GAAG;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,QAAQ,CAAA;SAAE,CAAC;KACnD,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAC3B,yBAAyB,GACzB,uBAAuB,GACvB,MAAM,GACN,OAAO,CAAC;AAiBX,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI;IACjC,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IACpC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,aAAa,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;IACxE,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,YAAY,KAAK,OAAO,CAAC;IACnD,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,wBAAwB,CAAC,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF,eAAO,MAAM,oBAAoB,IAAI,CAAC;AACtC,eAAO,MAAM,2BAA2B,OAAO,CAAC;AAChD,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAI3C,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAE5E,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG;IACvD,QAAQ,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACrC,MAAM,CAAC,EAAE,KAAK,GAAG,aAAa,CAAC;CAC/B,CAAC;AAEF,KAAK,mBAAmB,GAAG;IAAE,SAAS,EAAE,aAAa,CAAA;CAAE,CAAC;AACxD,KAAK,oBAAoB,GAAG;IAAE,SAAS,EAAE,aAAa,CAAA;CAAE,CAAC;AACzD,KAAK,iBAAiB,GAAG;IAAE,SAAS,EAAE,aAAa,CAAA;CAAE,CAAC;AAEtD,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACrD,iBAAiB,EAAE,WAAW,CAAC,mBAAmB,CAAC,CAAC;IACpD,kBAAkB,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAC;IACtD,oBAAoB,EAAE,WAAW,CAAC,iBAAiB,CAAC,CAAC;CACrD;AAED,qBACa,SAAS,CAAC,CAAC,GAAG,UAAU,CAAE,SAAQ,OAAO,CACrD,IAAI,CAAC,CAAC,CAAC,EACP,eAAe,CACf;IAEA,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAGZ,GAAG,EAAE,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;IAG7C,OAAO,CAAC,oBAAoB,CAAC,CAAqB;IAClD,OAAO,CAAC,sBAAsB,CAAoC;IAClE,OAAO,CAAC,mBAAmB,CAAU;IACrC,OAAO,CAAC,gBAAgB,CAA4B;IAEpD,OAAO,CAAC,iBAAiB,CAAqB;IAC9C,OAAO,CAAC,mBAAmB,CAAqB;IAEhD,OAAO,CAAC,oBAAoB,CAAC,CAEG;IAEhC,OAAO,CAAC,cAAc,CAAC,CAAkC;IACzD,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,OAAO,CAAC,eAAe,CAAuB;IAC9C,OAAO,CAAC,sBAAsB,CAAO;IACrC,OAAO,CAAC,eAAe,CAQrB;IAEF,OAAO,CAAC,aAAa,CAGnB;IAEF,OAAO,CAAC,kBAAkB,CAAuB;IAEjD,OAAO,CAAC,YAAY,CAAgB;IAEpC,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,cAAc,CAAU;IAEhC,OAAO,CAAC,IAAI,CAAC,CAA8C;IAG3D,OAAO,CAAC,+BAA+B,CAE1B;IAGb,OAAO,CAAC,kBAAkB,CAAkC;IAC5D,OAAO,CAAC,eAAe,CAAC,CAAS;IAGjC,OAAO,CAAC,gBAAgB,CAAC,CAAgC;IAGzD,OAAO,CAAC,iBAAiB,CAAgC;IACzD,OAAO,CAAC,yBAAyB,CAA4B;IAG7D,OAAO,CAAC,YAAY,CAAmD;IAEvE,QAAQ,EAAG,iBAAiB,CAAC;IAE7B,OAAO,CAAC,QAAQ,CAAC,CAAW;IAE5B,qBAAqB,EAAG,MAAM,CAAC;IAC/B,wBAAwB,EAAG,MAAM,CAAC;IAClC,wBAAwB,EAAG,MAAM,CAAC;IAElC,qBAAqB,EAAG,wBAAwB,CAAC;IACjD,OAAO,EAAG;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAEnD,OAAO,CAAC,EAAE,CAAc;gBAEZ,UAAU,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,UAAU,CAAA;KAAE;IAM5C;;OAEG;IACH,IAAI,mBAAmB,IAAI,kBAAkB,GAAG,SAAS,CAExD;IAEK,aAAa;IAcnB,IAAI,kBAAkB,IAAI,MAAM,CAE/B;IAEK,2BAA2B;IAO3B,wBAAwB;IAY9B,OAAO,CAAC,8BAA8B;YAaxB,wBAAwB;IA0EhC,SAAS,CAAC,KAAK,CAAC,EAAE,gBAAgB,GAAG,kBAAkB;YAyB/C,gBAAgB;YAkDhB,8BAA8B;YAgB9B,sBAAsB;YA2CtB,mBAAmB;IA0E3B,wBAAwB,CAAC,KAAK,EAAE,yBAAyB;IA6CzD,MAAM,CACX,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,SAAS,GAC1C,OAAO,CAAC;QACV,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;KACjC,CAAC;IAiFI,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAuKtC,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB1B,MAAM;IAIN,cAAc;IAKpB,IAAI,KAAK,WAER;IAEK,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAS1B,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YAyBjB,MAAM;IAwCd,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAUvC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAUtC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAKxB,UAAU,CACf,GAAG,EAAE,gBAAgB,EACrB,OAAO,EAAE,cAAc,GACrB,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC;IAgYlC,wBAAwB;IAexB,qBAAqB;IAQ3B,IAAI,gBAAgB,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAKvD;IAED;;OAEG;IACG,cAAc;IAad,iBAAiB,CAAC,GAAG,IAAI,EAAE,aAAa,EAAE;IA+B1C,QAAQ,CACb,IAAI,EAAE;QAAE,QAAQ,IAAI,MAAM,CAAA;KAAE,EAC5B,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE;QACT,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,GACC,OAAO,CAAC,OAAO,CAAC;YAOL,eAAe;IA4CvB,WAAW,CAChB,OAAO,EAAE;QAAE,QAAQ,IAAI,MAAM,CAAA;KAAE,EAC/B,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE;QACT,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,GACC,OAAO,CAAC,MAAM,EAAE,CAAC;IAmBd,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC;YAgB/B,4BAA4B;IAmB1C;;;OAGG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE,MAAM;IAoCnC,YAAY,CACjB,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EACjB,OAAO,CAAC,EAAE;QACT,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB;IASI,wBAAwB,CAC7B,SAAS,EAAE,aAAa,EACxB,MAAM,EAAE,MAAM,EAAE,EAChB,UAAU,EAAE,OAAO;IAiDpB,KAAK,CACJ,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,EAAE,EACtC,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GACjD,OAAO,CAAC,GAAG,CAAC,EAAE;IAyIX,UAAU;IAoBV,WAAW;YAqGH,WAAW;IAuBnB,iBAAiB,CAAC,GAAG,EAAE,WAAW,CAAC,kBAAkB,CAAC;IAqBtD,eAAe,CAAC,GAAG,EAAE,WAAW,CAAC,iBAAiB,CAAC;IAenD,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAU/C,cAAc;IAqBd,sBAAsB,CAAC,YAAY,UAAO;IAkE1C,eAAe;IAyCrB,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,YAAY;IASpB,cAAc,CAAC,IAAI,EAAE,MAAM;CAG3B"}