@pkcprotocol/pkc-js 0.0.15 → 0.0.17

package/dist/browser/rpc/src/index.d.ts

@@ -6,10 +6,9 @@ import WebSocket from "ws";
 import Publication from "../../publications/publication.js";
 import { LocalCommunity } from "../../runtime/browser/community/local-community.js";
 import type { CommentIpfsType } from "../../publications/comment/types.js";
-import type { RpcInternalCommunityRecordAfterFirstUpdateType, RpcInternalCommunityRecordBeforeFirstUpdateType } from "../../community/types.js";
-import { RpcPublishResult } from "../../publications/types.js";
+import type { RpcInternalCommunityRecordBeforeFirstUpdateType } from "../../community/types.js";
 import { TypedEmitter } from "tiny-typed-emitter";
-import type { ModQueuePageIpfs } from "../../pages/types.js";
+import type { RpcSubscriptionIdResult, RpcSuccessResult, RpcFetchCidResult, RpcResolveAuthorNameResult, RpcCommentPageResult, RpcCommunityPageResult, RpcLocalCommunityUpdateResultType } from "../../clients/rpc-client/types.js";
 declare class PKCWsServer extends TypedEmitter<PKCRpcServerEvents> {
     pkc: PKC;
     rpcWebsockets: RpcWebsocketsServer;
@@ -40,6 +39,7 @@ declare class PKCWsServer extends TypedEmitter<PKCRpcServerEvents> {
     private _rpcStateDb;
     constructor({ port, server, pkc, authKey, startStartedCommunitiesOnStartup }: PKCWsServerClassOptions);
     getStartedCommunity(address: string): Promise<LocalCommunity>;
+    private _findCommunityAddress;
     private _emitError;
     private _getRpcStateDb;
     private _updateCommunityState;
@@ -54,426 +54,40 @@ declare class PKCWsServer extends TypedEmitter<PKCRpcServerEvents> {
     private _retirePKCIfNeeded;
     _getPKCInstance(): Promise<PKC>;
     getComment(params: any): Promise<CommentIpfsType>;
-    getCommunityPage(params: any): Promise<{
-        page: {
-            comments: {
-                comment: {
-                    [x: string]: unknown;
-                    timestamp: number;
-                    signature: {
-                        type: string;
-                        signature: string;
-                        publicKey: string;
-                        signedPropertyNames: string[];
-                    };
-                    protocolVersion: string;
-                    depth: number;
-                    flairs?: {
-                        [x: string]: unknown;
-                        text: string;
-                        backgroundColor?: string | undefined;
-                        textColor?: string | undefined;
-                        expiresAt?: number | undefined;
-                    }[] | undefined;
-                    communityPublicKey?: string | undefined;
-                    communityName?: string | undefined;
-                    link?: string | undefined;
-                    spoiler?: boolean | undefined;
-                    nsfw?: boolean | undefined;
-                    content?: string | undefined;
-                    title?: string | undefined;
-                    linkWidth?: number | undefined;
-                    linkHeight?: number | undefined;
-                    linkHtmlTagName?: string | undefined;
-                    parentCid?: string | undefined;
-                    postCid?: string | undefined;
-                    quotedCids?: string[] | undefined;
-                    author?: {
-                        [x: string]: unknown;
-                        name?: string | undefined;
-                        previousCommentCid?: string | undefined;
-                        displayName?: string | undefined;
-                        wallets?: Record<string, {
-                            address: string;
-                            timestamp: number;
-                            signature: {
-                                signature: string;
-                                type: string;
-                            };
-                        }> | undefined;
-                        avatar?: {
-                            [x: string]: unknown;
-                            chainTicker: string;
-                            address: string;
-                            id: string;
-                            timestamp: number;
-                            signature: {
-                                signature: string;
-                                type: string;
-                            };
-                        } | undefined;
-                        flairs?: {
-                            [x: string]: unknown;
-                            text: string;
-                            backgroundColor?: string | undefined;
-                            textColor?: string | undefined;
-                            expiresAt?: number | undefined;
-                        }[] | undefined;
-                    } | undefined;
-                    thumbnailUrl?: string | undefined;
-                    thumbnailUrlWidth?: number | undefined;
-                    thumbnailUrlHeight?: number | undefined;
-                    previousCid?: string | undefined;
-                    pseudonymityMode?: "per-post" | "per-reply" | "per-author" | undefined;
-                };
-                commentUpdate: {
-                    [x: string]: unknown;
-                    cid: string;
-                    upvoteCount: number;
-                    downvoteCount: number;
-                    replyCount: number;
-                    updatedAt: number;
-                    signature: {
-                        type: string;
-                        signature: string;
-                        publicKey: string;
-                        signedPropertyNames: string[];
-                    };
-                    protocolVersion: string;
-                    childCount?: number | undefined;
-                    number?: number | undefined;
-                    postNumber?: number | undefined;
-                    edit?: {
-                        [x: string]: unknown;
-                        timestamp: number;
-                        signature: {
-                            type: string;
-                            signature: string;
-                            publicKey: string;
-                            signedPropertyNames: string[];
-                        };
-                        protocolVersion: string;
-                        commentCid: string;
-                        flairs?: {
-                            [x: string]: unknown;
-                            text: string;
-                            backgroundColor?: string | undefined;
-                            textColor?: string | undefined;
-                            expiresAt?: number | undefined;
-                        }[] | undefined;
-                        communityPublicKey?: string | undefined;
-                        communityName?: string | undefined;
-                        spoiler?: boolean | undefined;
-                        nsfw?: boolean | undefined;
-                        reason?: string | undefined;
-                        content?: string | undefined;
-                        deleted?: boolean | undefined;
-                        author?: {
-                            [x: string]: unknown;
-                            name?: string | undefined;
-                            previousCommentCid?: string | undefined;
-                            displayName?: string | undefined;
-                            wallets?: Record<string, {
-                                address: string;
-                                timestamp: number;
-                                signature: {
-                                    signature: string;
-                                    type: string;
-                                };
-                            }> | undefined;
-                            avatar?: {
-                                [x: string]: unknown;
-                                chainTicker: string;
-                                address: string;
-                                id: string;
-                                timestamp: number;
-                                signature: {
-                                    signature: string;
-                                    type: string;
-                                };
-                            } | undefined;
-                            flairs?: {
-                                [x: string]: unknown;
-                                text: string;
-                                backgroundColor?: string | undefined;
-                                textColor?: string | undefined;
-                                expiresAt?: number | undefined;
-                            }[] | undefined;
-                        } | undefined;
-                    } | undefined;
-                    flairs?: {
-                        [x: string]: unknown;
-                        text: string;
-                        backgroundColor?: string | undefined;
-                        textColor?: string | undefined;
-                        expiresAt?: number | undefined;
-                    }[] | undefined;
-                    spoiler?: boolean | undefined;
-                    nsfw?: boolean | undefined;
-                    pinned?: boolean | undefined;
-                    locked?: boolean | undefined;
-                    archived?: boolean | undefined;
-                    removed?: boolean | undefined;
-                    reason?: string | undefined;
-                    approved?: boolean | undefined;
-                    author?: {
-                        [x: string]: unknown;
-                        community?: {
-                            [x: string]: unknown;
-                            postScore: number;
-                            replyScore: number;
-                            firstCommentTimestamp: number;
-                            lastCommentCid: string;
-                            banExpiresAt?: number | undefined;
-                            flairs?: {
-                                [x: string]: unknown;
-                                text: string;
-                                backgroundColor?: string | undefined;
-                                textColor?: string | undefined;
-                                expiresAt?: number | undefined;
-                            }[] | undefined;
-                        } | undefined;
-                    } | undefined;
-                    lastChildCid?: string | undefined;
-                    lastReplyTimestamp?: number | undefined;
-                    replies?: {
-                        pages: Record<string, /*elided*/ any>;
-                        pageCids?: Record<string, string> | undefined;
-                    } | undefined;
-                };
-            }[];
-            nextCid?: string | undefined;
-        } | ModQueuePageIpfs;
-        runtimeFields: import("../../pages/util.js").PageRuntimeFields;
-    }>;
-    getCommentPage(params: any): Promise<{
-        page: {
-            comments: {
-                comment: {
-                    [x: string]: unknown;
-                    timestamp: number;
-                    signature: {
-                        type: string;
-                        signature: string;
-                        publicKey: string;
-                        signedPropertyNames: string[];
-                    };
-                    protocolVersion: string;
-                    depth: number;
-                    flairs?: {
-                        [x: string]: unknown;
-                        text: string;
-                        backgroundColor?: string | undefined;
-                        textColor?: string | undefined;
-                        expiresAt?: number | undefined;
-                    }[] | undefined;
-                    communityPublicKey?: string | undefined;
-                    communityName?: string | undefined;
-                    link?: string | undefined;
-                    spoiler?: boolean | undefined;
-                    nsfw?: boolean | undefined;
-                    content?: string | undefined;
-                    title?: string | undefined;
-                    linkWidth?: number | undefined;
-                    linkHeight?: number | undefined;
-                    linkHtmlTagName?: string | undefined;
-                    parentCid?: string | undefined;
-                    postCid?: string | undefined;
-                    quotedCids?: string[] | undefined;
-                    author?: {
-                        [x: string]: unknown;
-                        name?: string | undefined;
-                        previousCommentCid?: string | undefined;
-                        displayName?: string | undefined;
-                        wallets?: Record<string, {
-                            address: string;
-                            timestamp: number;
-                            signature: {
-                                signature: string;
-                                type: string;
-                            };
-                        }> | undefined;
-                        avatar?: {
-                            [x: string]: unknown;
-                            chainTicker: string;
-                            address: string;
-                            id: string;
-                            timestamp: number;
-                            signature: {
-                                signature: string;
-                                type: string;
-                            };
-                        } | undefined;
-                        flairs?: {
-                            [x: string]: unknown;
-                            text: string;
-                            backgroundColor?: string | undefined;
-                            textColor?: string | undefined;
-                            expiresAt?: number | undefined;
-                        }[] | undefined;
-                    } | undefined;
-                    thumbnailUrl?: string | undefined;
-                    thumbnailUrlWidth?: number | undefined;
-                    thumbnailUrlHeight?: number | undefined;
-                    previousCid?: string | undefined;
-                    pseudonymityMode?: "per-post" | "per-reply" | "per-author" | undefined;
-                };
-                commentUpdate: {
-                    [x: string]: unknown;
-                    cid: string;
-                    upvoteCount: number;
-                    downvoteCount: number;
-                    replyCount: number;
-                    updatedAt: number;
-                    signature: {
-                        type: string;
-                        signature: string;
-                        publicKey: string;
-                        signedPropertyNames: string[];
-                    };
-                    protocolVersion: string;
-                    childCount?: number | undefined;
-                    number?: number | undefined;
-                    postNumber?: number | undefined;
-                    edit?: {
-                        [x: string]: unknown;
-                        timestamp: number;
-                        signature: {
-                            type: string;
-                            signature: string;
-                            publicKey: string;
-                            signedPropertyNames: string[];
-                        };
-                        protocolVersion: string;
-                        commentCid: string;
-                        flairs?: {
-                            [x: string]: unknown;
-                            text: string;
-                            backgroundColor?: string | undefined;
-                            textColor?: string | undefined;
-                            expiresAt?: number | undefined;
-                        }[] | undefined;
-                        communityPublicKey?: string | undefined;
-                        communityName?: string | undefined;
-                        spoiler?: boolean | undefined;
-                        nsfw?: boolean | undefined;
-                        reason?: string | undefined;
-                        content?: string | undefined;
-                        deleted?: boolean | undefined;
-                        author?: {
-                            [x: string]: unknown;
-                            name?: string | undefined;
-                            previousCommentCid?: string | undefined;
-                            displayName?: string | undefined;
-                            wallets?: Record<string, {
-                                address: string;
-                                timestamp: number;
-                                signature: {
-                                    signature: string;
-                                    type: string;
-                                };
-                            }> | undefined;
-                            avatar?: {
-                                [x: string]: unknown;
-                                chainTicker: string;
-                                address: string;
-                                id: string;
-                                timestamp: number;
-                                signature: {
-                                    signature: string;
-                                    type: string;
-                                };
-                            } | undefined;
-                            flairs?: {
-                                [x: string]: unknown;
-                                text: string;
-                                backgroundColor?: string | undefined;
-                                textColor?: string | undefined;
-                                expiresAt?: number | undefined;
-                            }[] | undefined;
-                        } | undefined;
-                    } | undefined;
-                    flairs?: {
-                        [x: string]: unknown;
-                        text: string;
-                        backgroundColor?: string | undefined;
-                        textColor?: string | undefined;
-                        expiresAt?: number | undefined;
-                    }[] | undefined;
-                    spoiler?: boolean | undefined;
-                    nsfw?: boolean | undefined;
-                    pinned?: boolean | undefined;
-                    locked?: boolean | undefined;
-                    archived?: boolean | undefined;
-                    removed?: boolean | undefined;
-                    reason?: string | undefined;
-                    approved?: boolean | undefined;
-                    author?: {
-                        [x: string]: unknown;
-                        community?: {
-                            [x: string]: unknown;
-                            postScore: number;
-                            replyScore: number;
-                            firstCommentTimestamp: number;
-                            lastCommentCid: string;
-                            banExpiresAt?: number | undefined;
-                            flairs?: {
-                                [x: string]: unknown;
-                                text: string;
-                                backgroundColor?: string | undefined;
-                                textColor?: string | undefined;
-                                expiresAt?: number | undefined;
-                            }[] | undefined;
-                        } | undefined;
-                    } | undefined;
-                    lastChildCid?: string | undefined;
-                    lastReplyTimestamp?: number | undefined;
-                    replies?: {
-                        pages: Record<string, /*elided*/ any>;
-                        pageCids?: Record<string, string> | undefined;
-                    } | undefined;
-                };
-            }[];
-            nextCid?: string | undefined;
-        };
-        runtimeFields: import("../../pages/util.js").PageRuntimeFields;
-    }>;
+    getCommunityPage(params: any): Promise<RpcCommunityPageResult>;
+    getCommentPage(params: any): Promise<RpcCommentPageResult>;
     createCommunity(params: any): Promise<RpcInternalCommunityRecordBeforeFirstUpdateType>;
     private _trackCommunityListener;
     private _untrackCommunityListener;
     _setupStartedEvents(community: LocalCommunity, connectionId: string, subscriptionId: number): void;
-    startCommunity(params: any, connectionId: string): Promise<number>;
-    stopCommunity(params: any): Promise<boolean>;
+    startCommunity(params: any, connectionId: string): Promise<RpcSubscriptionIdResult>;
+    stopCommunity(params: any): Promise<RpcSuccessResult>;
     private _postStoppingOrDeleting;
-    editCommunity(params: any): Promise<RpcInternalCommunityRecordBeforeFirstUpdateType | RpcInternalCommunityRecordAfterFirstUpdateType>;
-    deleteCommunity(params: any): Promise<boolean>;
-    communitiesSubscribe(params: any, connectionId: string): Promise<number>;
-    fetchCid(params: any): Promise<{
-        content: string;
-    }>;
+    editCommunity(params: any): Promise<RpcLocalCommunityUpdateResultType>;
+    deleteCommunity(params: any): Promise<RpcSuccessResult>;
+    communitiesSubscribe(params: any, connectionId: string): Promise<RpcSubscriptionIdResult>;
+    fetchCid(params: any): Promise<RpcFetchCidResult>;
     private _serializeSettingsFromPKC;
-    settingsSubscribe(params: any, connectionId: string): Promise<number>;
+    settingsSubscribe(params: any, connectionId: string): Promise<RpcSubscriptionIdResult>;
     private _initPKC;
     private _createPKCInstanceFromSetSettings;
-    setSettings(params: any): Promise<boolean>;
-    commentUpdateSubscribe(params: any, connectionId: string): Promise<number>;
-    communityUpdateSubscribe(params: any, connectionId: string): Promise<number>;
+    setSettings(params: any): Promise<RpcSuccessResult>;
+    commentUpdateSubscribe(params: any, connectionId: string): Promise<RpcSubscriptionIdResult>;
+    communityUpdateSubscribe(params: any, connectionId: string): Promise<RpcSubscriptionIdResult>;
     private _bindCommunityUpdateSubscription;
     private _createCommentInstanceFromPublishCommentParams;
-    publishComment(params: any, connectionId: string): Promise<RpcPublishResult>;
+    publishComment(params: any, connectionId: string): Promise<RpcSubscriptionIdResult>;
     private _createVoteInstanceFromPublishVoteParams;
-    publishVote(params: any, connectionId: string): Promise<RpcPublishResult>;
+    publishVote(params: any, connectionId: string): Promise<RpcSubscriptionIdResult>;
     private _createCommunityEditInstanceFromPublishCommunityEditParams;
-    publishCommunityEdit(params: any, connectionId: string): Promise<RpcPublishResult>;
+    publishCommunityEdit(params: any, connectionId: string): Promise<RpcSubscriptionIdResult>;
     private _createCommentEditInstanceFromPublishCommentEditParams;
-    publishCommentEdit(params: any, connectionId: string): Promise<RpcPublishResult>;
+    publishCommentEdit(params: any, connectionId: string): Promise<RpcSubscriptionIdResult>;
     private _createCommentModerationInstanceFromPublishCommentModerationParams;
-    publishCommentModeration(params: any, connectionId: string): Promise<RpcPublishResult>;
-    publishChallengeAnswers(params: any): Promise<boolean>;
-    resolveAuthorName(params: any): Promise<{
-        resolvedAddress: string | null;
-    }>;
-    unsubscribe(params: any, connectionId: string): Promise<boolean>;
+    publishCommentModeration(params: any, connectionId: string): Promise<RpcSubscriptionIdResult>;
+    publishChallengeAnswers(params: any): Promise<RpcSuccessResult>;
+    resolveAuthorName(params: any): Promise<RpcResolveAuthorNameResult>;
+    unsubscribe(params: any, connectionId: string): Promise<RpcSuccessResult>;
     destroy(): Promise<void>;
 }
 declare const PKCRpc: {