@pkcprotocol/pkc-js 0.0.34 → 0.0.36

package/dist/browser/runtime/node/community/local-community.d.ts

@@ -1,133 +1,96 @@
 import Logger from "../../../logger.js";
 import { PKC } from "../../../pkc/pkc.js";
-import type { CreateNewLocalCommunityParsedOptions, InternalCommunityRecordBeforeFirstUpdateType, InternalCommunityRecordAfterFirstUpdateType, ParsedCommunityEditOptions, CommunityChallengeSetting, CommunityEditOptions, RpcInternalCommunityRecordBeforeFirstUpdateType, RpcInternalCommunityRecordAfterFirstUpdateType } from "../../../community/types.js";
+import type { CommunityEditOptions, CreateNewLocalCommunityParsedOptions, InternalCommunityRecordBeforeFirstUpdateType, InternalCommunityRecordAfterFirstUpdateType, ParsedCommunityEditOptions, CommunityChallengeSetting, CommunityIpfsType, RpcInternalCommunityRecordBeforeFirstUpdateType, RpcInternalCommunityRecordAfterFirstUpdateType, CommunityEvents } from "../../../community/types.js";
+import { LRUCache } from "lru-cache";
+import { PageGenerator } from "./page-generator.js";
 import { DbHandler } from "./db-handler.js";
-import type { PurgedCommentTableRows } from "./db-handler-types.js";
-import type { ChallengeAnswerMessageType, ChallengeRequestMessageType } from "../../../pubsub-messages/types.js";
+import type { ChallengeAnswerMessageType, ChallengeRequestMessageType, DecryptedChallengeAnswer, DecryptedChallengeRequestMessageType } from "../../../pubsub-messages/types.js";
+import type { IpfsHttpClientPubsubMessage } from "../../../types.js";
 import { SignerWithPublicKeyAddress } from "../../../signer/index.js";
 import { RpcLocalCommunity } from "../../../community/rpc-local-community.js";
+import type { CommentsTableRow } from "../../../publications/comment/types.js";
+import { AllPageCids } from "../../../pages/types.js";
+import { createNewLocalCommunityDb, updateDbInternalState, updateInstancePropsWithStartedCommunityOrDb } from "./local-community/db-state.js";
+export { createNewLocalCommunityDb, updateInstancePropsWithStartedCommunityOrDb };
+import { publishChallengeVerification, publishIdempotentDuplicateVerification } from "./local-community/challenges.js";
+import { checkPublicationValidity } from "./local-community/publication-validation.js";
+import { calculateLocalMfsPathForCommentUpdate } from "./local-community/comment-updates.js";
+import { addOldPageCidsToCidsToUnpin, updateCommunityIpnsIfNeeded } from "./local-community/ipns-publishing.js";
 export declare class LocalCommunity extends RpcLocalCommunity implements CreateNewLocalCommunityParsedOptions {
     signer: SignerWithPublicKeyAddress;
     raw: RpcLocalCommunity["raw"];
-    private _postUpdatesBuckets;
-    private static _defaultChallengeQuestionText;
-    static _generateDefaultChallenges(answer?: string): CommunityChallengeSetting[];
-    static _isDefaultChallengeStructure(challenges: CommunityChallengeSetting[] | undefined): boolean;
+    _postUpdatesBuckets: number[];
     _defaultCommunityChallenges: CommunityChallengeSetting[];
-    private _challengeAnswerPromises;
-    private _challengeAnswerResolveReject;
-    private _ongoingChallengeExchanges;
-    private _duplicatePublicationAttempts;
-    private _challengeExchangesFromLocalPublishers;
+    _challengeAnswerPromises: LRUCache<string, Promise<DecryptedChallengeAnswer["challengeAnswers"]>>;
+    _challengeAnswerResolveReject: LRUCache<string, {
+        resolve: (answers: DecryptedChallengeAnswer["challengeAnswers"]) => void;
+        reject: (error: Error) => void;
+    }>;
+    _ongoingChallengeExchanges: LRUCache<string, boolean>;
+    _duplicatePublicationAttempts: LRUCache<string, number>;
+    _challengeExchangesFromLocalPublishers: Record<string, boolean>;
     _cidsToUnPin: Set<string>;
     _mfsPathsToRemove: Set<string>;
-    private _communityUpdateTrigger;
-    private _combinedHashOfPendingCommentsCids;
-    private _pageGenerator;
+    _communityUpdateTrigger: boolean;
+    _combinedHashOfPendingCommentsCids: string;
+    _pageGenerator: PageGenerator;
     _dbHandler: DbHandler;
-    private _stopHasBeenCalled;
-    private _publishLoopPromise?;
-    private _updateLoopPromise?;
-    private _updateLoopAbortController?;
-    private _firstUpdateAfterStart;
-    private _internalStateUpdateId;
-    private _lastPubsubTopicRoutingProvideAt?;
-    private _mirroredStartedOrUpdatingCommunity?;
-    private _pendingEditProps;
+    _stopHasBeenCalled: boolean;
+    _publishLoopPromise?: Promise<void>;
+    _updateLoopPromise?: Promise<void>;
+    _updateLoopAbortController?: AbortController;
+    _firstUpdateAfterStart: boolean;
+    _internalStateUpdateId: InternalCommunityRecordBeforeFirstUpdateType["_internalStateUpdateId"];
+    _lastPubsubTopicRoutingProvideAt?: number;
+    _mirroredStartedOrUpdatingCommunity?: {
+        community: LocalCommunity;
+    } & Pick<CommunityEvents, "error" | "updatingstatechange" | "update" | "statechange" | "startedstatechange" | "challengerequest" | "challengeverification" | "challenge" | "challengeanswer">;
+    _pendingEditProps: Partial<ParsedCommunityEditOptions & {
+        editId: string;
+    }>[];
     _blocksToRm: string[];
-    private _postsAllPageCids;
+    _postsAllPageCids: AllPageCids | undefined;
     constructor(pkc: PKC);
     toJSONInternalAfterFirstUpdate(): InternalCommunityRecordAfterFirstUpdateType;
     toJSONInternalBeforeFirstUpdate(): InternalCommunityRecordBeforeFirstUpdateType;
     toJSONInternalRpcAfterFirstUpdate(): RpcInternalCommunityRecordAfterFirstUpdateType;
     toJSONInternalRpcBeforeFirstUpdate(): RpcInternalCommunityRecordBeforeFirstUpdateType;
-    private _updateStartedValue;
+    _updateStartedValue(): Promise<void>;
     initNewLocalCommunityPropsNoMerge(newProps: CreateNewLocalCommunityParsedOptions): Promise<void>;
     initInternalCommunityAfterFirstUpdateNoMerge(newProps: InternalCommunityRecordAfterFirstUpdateType): Promise<void>;
     initInternalCommunityBeforeFirstUpdateNoMerge(newProps: InternalCommunityRecordBeforeFirstUpdateType): Promise<void>;
-    private initDbHandlerIfNeeded;
-    _updateInstancePropsWithStartedCommunityOrDb(): Promise<void>;
-    private _importCommunitySignerIntoIpfsIfNeeded;
-    _updateDbInternalState(props: Partial<InternalCommunityRecordBeforeFirstUpdateType | InternalCommunityRecordAfterFirstUpdateType>): Promise<InternalCommunityRecordBeforeFirstUpdateType | InternalCommunityRecordAfterFirstUpdateType>;
-    private _getDbInternalState;
-    private _updateInstanceStateWithDbState;
-    _setChallengesToDefaultIfNotDefined(log: Logger): Promise<void>;
-    _createNewLocalCommunityDb(): Promise<void>;
-    private _calculateNewPostUpdates;
-    private _calculateLatestUpdateTrigger;
-    private _requireCommunityUpdateIfModQueueChanged;
-    _resolveIpnsAndLogIfPotentialProblematicSequence(): Promise<void>;
-    private _addOldPageCidsToCidsToUnpin;
-    private updateCommunityIpnsIfNeeded;
-    private shouldResolveDomainForVerification;
-    private _validateCommunitySizeSchemaAndSignatureBeforePublishing;
-    private storeCommentEdit;
-    private storeCommentModeration;
-    private storeVote;
-    private storeCommunityEditPublication;
-    private isPublicationReply;
-    private isPublicationPost;
-    private _calculateLinkProps;
-    private _calculateLatestPostProps;
-    private _calculateReplyProps;
-    private _resolveAliasPrivateKeyForCommentPublication;
-    private _prepareCommentWithAnonymity;
-    private _prepareCommentEditWithAlias;
-    private storeComment;
-    private storePublication;
-    private _decryptOrRespondWithFailure;
-    private _respondWithErrorIfSignatureOfPublicationIsInvalid;
-    private _publishChallenges;
-    private _publishFailedChallengeVerification;
-    private _publishIdempotentDuplicateVerification;
-    private _storePublicationAndEncryptForChallengeVerification;
-    private _publishChallengeVerification;
-    private _isPublicationAuthorPartOfRoles;
-    private _checkPublicationValidity;
-    private _parseChallengeRequestPublicationOrRespondWithFailure;
-    private _buildRuntimeChallengeRequestPublication;
-    private _buildRuntimeChallengeRequest;
+    initDbHandlerIfNeeded(): Promise<void>;
+    _validateCommunitySizeSchemaAndSignatureBeforePublishing(recordToPublishRaw: CommunityIpfsType): Promise<void>;
     handleChallengeRequest(request: ChallengeRequestMessageType, isLocalPublisher: boolean): Promise<void>;
-    private _cleanUpChallengeAnswerPromise;
-    private _isFlairInAllowedList;
-    private _parseChallengeAnswerOrRespondWithFailure;
     handleChallengeAnswer(challengeAnswer: ChallengeAnswerMessageType): Promise<void>;
-    private handleChallengeExchange;
-    private _calculateLocalMfsPathForCommentUpdate;
-    private _calculateNewCommentUpdate;
-    private _validateCommentUpdateSignature;
-    private _listenToIncomingRequests;
-    private _movePostUpdatesFolderToNewAddress;
-    private _updateCommentsThatNeedToBeUpdated;
-    private _addCommentRowToIPFS;
-    private _repinCommentsIPFSIfNeeded;
-    private _unpinStaleCids;
-    private _rmUnneededMfsPaths;
-    private pubsubTopicWithfallback;
-    private _repinCommentUpdateIfNeeded;
-    private _syncPostUpdatesWithIpfs;
-    private _adjustPostUpdatesBucketsIfNeeded;
-    private _cleanUpIpfsRepoRarely;
-    private _providePubsubTopicRoutingCidsIfNeeded;
-    _addAllCidsUnderPurgedCommentToBeRemoved(purgedCommentAndCommentUpdate: PurgedCommentTableRows): Promise<void>;
-    private _purgeDisapprovedCommentsOlderThan;
-    private syncIpnsWithDb;
-    private _assertDomainResolvesCorrectly;
-    private _initSignerProps;
-    private _publishLoop;
-    private _initBeforeStarting;
-    private _parseRolesToEdit;
-    private _parseChallengesToEdit;
-    _validateNewAddressBeforeEditing(newAddress: string, log: Logger): Promise<void>;
-    _editPropsOnStartedCommunity(parsedEditOptions: ParsedCommunityEditOptions): Promise<typeof this>;
-    _editPropsOnNotStartedCommunity(parsedEditOptions: ParsedCommunityEditOptions): Promise<typeof this>;
-    edit(newCommunityOptions: CommunityEditOptions): Promise<typeof this>;
+    handleChallengeExchange(pubsubMsg: IpfsHttpClientPubsubMessage): Promise<void>;
+    _addCommentRowToIPFS(unpinnedCommentRow: CommentsTableRow, log: Logger): Promise<void>;
+    _assertDomainResolvesCorrectly(newAddressAsDomain: string): Promise<void>;
     start(): Promise<void>;
-    private _initMirroringStartedOrUpdatingCommunity;
-    private _cleanUpMirroredStartedOrUpdatingCommunity;
-    private _updateOnce;
-    private _updateLoop;
     update(): Promise<void>;
     stop(): Promise<void>;
     delete(): Promise<void>;
+    edit(newCommunityOptions: CommunityEditOptions): Promise<typeof this>;
+    _getDbInternalState(includeMutable?: boolean): Promise<InternalCommunityRecordBeforeFirstUpdateType | InternalCommunityRecordAfterFirstUpdateType>;
+    _listenToIncomingRequests(): Promise<void>;
+    _repinCommentsIPFSIfNeeded(): Promise<void>;
+    storePublication(request: DecryptedChallengeRequestMessageType, pendingApproval?: boolean): Promise<{
+        comment: import("../../../publications/comment/types.js").CommentIpfsType;
+        cid: import("../../../publications/comment/types.js").CommentUpdateType["cid"];
+    } | undefined>;
+    updateCommunityIpnsIfNeeded(args: {
+        commentUpdateRowsToPublishToIpfs: Parameters<typeof updateCommunityIpnsIfNeeded>[1];
+    }): Promise<void>;
+    _addOldPageCidsToCidsToUnpin(curPages: Parameters<typeof addOldPageCidsToCidsToUnpin>[1], newPages: Parameters<typeof addOldPageCidsToCidsToUnpin>[2], addToBlockRm?: boolean): Promise<void>;
+    private shouldResolveDomainForVerification;
+    _calculateNewPostUpdates(): Promise<Record<string, string> | undefined>;
+    _calculateLatestUpdateTrigger(): void;
+    _resolveIpnsAndLogIfPotentialProblematicSequence(): Promise<void>;
+    _updateDbInternalState(props: Parameters<typeof updateDbInternalState>[1]): Promise<InternalCommunityRecordBeforeFirstUpdateType | InternalCommunityRecordAfterFirstUpdateType>;
+    _updateCommentsThatNeedToBeUpdated(): Promise<import("./local-community/defaults.js").CommentUpdateToWriteToDbAndPublishToIpfs[]>;
+    _purgeDisapprovedCommentsOlderThan(): Promise<void>;
+    _publishChallengeVerification(challengeResult: Parameters<typeof publishChallengeVerification>[1], request: Parameters<typeof publishChallengeVerification>[2]): Promise<void>;
+    _publishIdempotentDuplicateVerification(...args: Parameters<typeof publishIdempotentDuplicateVerification> extends [unknown, ...infer Rest] ? Rest : never): Promise<void>;
+    _checkPublicationValidity(...args: Parameters<typeof checkPublicationValidity> extends [unknown, ...infer Rest] ? Rest : never): Promise<import("../../../errors.js").messages | undefined>;
+    _calculateLocalMfsPathForCommentUpdate(...args: Parameters<typeof calculateLocalMfsPathForCommentUpdate> extends [unknown, ...infer Rest] ? Rest : never): string;
 }