@pkcprotocol/pkc-js 0.0.11

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

@@ -0,0 +1,129 @@
+import Logger from "../../../logger.js";
+import { PKC } from "../../../pkc/pkc.js";
+import type { CreateNewLocalCommunityParsedOptions, InternalCommunityRecordBeforeFirstUpdateType, InternalCommunityRecordAfterFirstUpdateType, ParsedCommunityEditOptions, CommunityEditOptions, RpcInternalCommunityRecordBeforeFirstUpdateType, RpcInternalCommunityRecordAfterFirstUpdateType } from "../../../community/types.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 { SignerWithPublicKeyAddress } from "../../../signer/index.js";
+import { RpcLocalCommunity } from "../../../community/rpc-local-community.js";
+export declare class LocalCommunity extends RpcLocalCommunity implements CreateNewLocalCommunityParsedOptions {
+    signer: SignerWithPublicKeyAddress;
+    raw: RpcLocalCommunity["raw"];
+    private _postUpdatesBuckets;
+    private _defaultCommunityChallenges;
+    private _challengeAnswerPromises;
+    private _challengeAnswerResolveReject;
+    private _ongoingChallengeExchanges;
+    private _duplicatePublicationAttempts;
+    private _challengeExchangesFromLocalPublishers;
+    _cidsToUnPin: Set<string>;
+    _mfsPathsToRemove: Set<string>;
+    private _communityUpdateTrigger;
+    private _combinedHashOfPendingCommentsCids;
+    private _pageGenerator;
+    _dbHandler: DbHandler;
+    private _stopHasBeenCalled;
+    private _publishLoopPromise?;
+    private _updateLoopPromise?;
+    private _updateLoopAbortController?;
+    private _firstUpdateAfterStart;
+    private _internalStateUpdateId;
+    private _lastPubsubTopicRoutingProvideAt?;
+    private _mirroredStartedOrUpdatingCommunity?;
+    private _pendingEditProps;
+    _blocksToRm: string[];
+    constructor(pkc: PKC);
+    toJSONInternalAfterFirstUpdate(): InternalCommunityRecordAfterFirstUpdateType;
+    toJSONInternalBeforeFirstUpdate(): InternalCommunityRecordBeforeFirstUpdateType;
+    toJSONInternalRpcAfterFirstUpdate(): RpcInternalCommunityRecordAfterFirstUpdateType;
+    toJSONInternalRpcBeforeFirstUpdate(): RpcInternalCommunityRecordBeforeFirstUpdateType;
+    private _updateStartedValue;
+    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;
+    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>;
+    start(): Promise<void>;
+    private _initMirroringStartedOrUpdatingCommunity;
+    private _cleanUpMirroredStartedOrUpdatingCommunity;
+    private _updateOnce;
+    private _updateLoop;
+    update(): Promise<void>;
+    stop(): Promise<void>;
+    delete(): Promise<void>;
+}