@pkcprotocol/pkc-js 0.0.106 → 0.0.108

package/dist/node/rpc/src/schema.js

@@ -1,6 +1,6 @@
 import { z } from "zod";
 import { NameResolverSerializedSchema, PKCParsedOptionsSchema, PKCUserOptionBaseSchema } from "../../schema.js";
-import { ChallengeFileSchema } from "../../community/schema.js";
+import { ChallengeFileSchema, PageSortFileSchema } from "../../community/schema.js";
 // Setting up WS
 const WsServerClassOptions = z.object({
     // 0 asks the OS for an ephemeral port (no reserve-then-rebind race); read the bound port from
@@ -39,6 +39,10 @@ export const PKCWsServerSettingsSerializedSchema = z.object({
     challenges: z.record(z.string(), 
     // getChallenge is omitted to avoid throwing because of a recursive dependency; validateChallengeSettings
     // is omitted because it is a function that cannot cross the wire and only ever runs community-side.
-    ChallengeFileSchema.omit({ getChallenge: true, validateChallengeSettings: true }))
+    ChallengeFileSchema.omit({ getChallenge: true, validateChallengeSettings: true })),
+    // The page sorts the server can resolve settings.pages[].name against (issue #73), minus their functions, so
+    // a client can render a picker and reject an unknown name before the round trip. Optional: an older server
+    // does not send it.
+    pageSorts: z.record(z.string(), PageSortFileSchema.omit({ score: true, validatePageSortSettings: true })).optional()
 });
 //# sourceMappingURL=schema.js.map

package/dist/node/rpc/src/schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../src/rpc/src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,4BAA4B,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAGhH,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAGhE,gBAAgB;AAEhB,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,8FAA8F;IAC9F,uDAAuD;IACvD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IAC/C,MAAM,EAAE,CAAC,CAAC,MAAM,EAA4B,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC1C,MAAM,CAAC;IACJ,UAAU,EAAE,CAAC,CAAC,MAAM,EAAmB,CAAC,QAAQ,EAAE,EAAE,+DAA+D;IACnH,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,gCAAgC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACxD,sEAAsE;IACtE,6DAA6D;IAC7D,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IAC/D,uFAAuF;IACvF,6FAA6F;IAC7F,qBAAqB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7C,6FAA6F;IAC7F,uFAAuF;IACvF,+EAA+E;IAC/E,4FAA4F;IAC5F,2BAA2B;IAC3B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;CAChE,CAAC;KACD,KAAK,CAAC,oBAAoB,CAAC;KAC3B,KAAK,EAAE,CAAC;AAEb,SAAS;AAET,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,UAAU,EAAE,uBAAuB,CAAC,MAAM,CAAC;QACvC,aAAa,EAAE,4BAA4B,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;KACjE,CAAC,CAAC,KAAK,EAAE;CACb,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,UAAU,EAAE,sBAAsB,CAAC,KAAK,EAAE;IAC1C,UAAU,EAAE,CAAC,CAAC,MAAM,CAChB,CAAC,CAAC,MAAM,EAAE;IACV,yGAAyG;IACzG,oGAAoG;IACpG,mBAAmB,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,yBAAyB,EAAE,IAAI,EAAE,CAAC,CACpF;CACJ,CAAC,CAAC"}
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../src/rpc/src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,4BAA4B,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAGhH,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAGpF,gBAAgB;AAEhB,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,8FAA8F;IAC9F,uDAAuD;IACvD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IAC/C,MAAM,EAAE,CAAC,CAAC,MAAM,EAA4B,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC1C,MAAM,CAAC;IACJ,UAAU,EAAE,CAAC,CAAC,MAAM,EAAmB,CAAC,QAAQ,EAAE,EAAE,+DAA+D;IACnH,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,gCAAgC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACxD,sEAAsE;IACtE,6DAA6D;IAC7D,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;IAC/D,uFAAuF;IACvF,6FAA6F;IAC7F,qBAAqB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC7C,6FAA6F;IAC7F,uFAAuF;IACvF,+EAA+E;IAC/E,4FAA4F;IAC5F,2BAA2B;IAC3B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;CAChE,CAAC;KACD,KAAK,CAAC,oBAAoB,CAAC;KAC3B,KAAK,EAAE,CAAC;AAEb,SAAS;AAET,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,UAAU,EAAE,uBAAuB,CAAC,MAAM,CAAC;QACvC,aAAa,EAAE,4BAA4B,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;KACjE,CAAC,CAAC,KAAK,EAAE;CACb,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,UAAU,EAAE,sBAAsB,CAAC,KAAK,EAAE;IAC1C,UAAU,EAAE,CAAC,CAAC,MAAM,CAChB,CAAC,CAAC,MAAM,EAAE;IACV,yGAAyG;IACzG,oGAAoG;IACpG,mBAAmB,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,yBAAyB,EAAE,IAAI,EAAE,CAAC,CACpF;IACD,6GAA6G;IAC7G,2GAA2G;IAC3G,oBAAoB;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,kBAAkB,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CACvH,CAAC,CAAC"}

package/dist/node/runtime/browser/community/page-sorts/index.d.ts

@@ -0,0 +1 @@
+export { pkcJsPageSorts } from "../../../../pages/pkc-js-page-sorts/index.js";

package/dist/node/runtime/browser/community/page-sorts/index.js

@@ -0,0 +1,6 @@
+// Browser build of src/runtime/node/community/page-sorts/index.ts. Resolving a sort by `path` and generating pages are
+// community-side and need the database, so none of that exists here; the built-in registry is shared, since the
+// scorers are pure, so a browser client re-sorting a page (docs/protocol/page-sorts.md, "Client side") finds the same
+// built-ins under `pageSorts` that a community generates with.
+export { pkcJsPageSorts } from "../../../../pages/pkc-js-page-sorts/index.js";
+//# sourceMappingURL=index.js.map

package/dist/node/runtime/browser/community/page-sorts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/runtime/browser/community/page-sorts/index.ts"],"names":[],"mappings":"AAAA,uHAAuH;AACvH,gHAAgH;AAChH,sHAAsH;AACtH,+DAA+D;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,8CAA8C,CAAC"}

package/dist/node/runtime/node/community/db-handler.d.ts

@@ -7,6 +7,16 @@ import type { PageIpfs } from "../../../pages/types.js";
 import type { CommentModerationsTableRowInsert, CommentModerationTableRow } from "../../../publications/comment-moderation/types.js";
 import type { VotesTableRow, VotesTableRowInsert } from "../../../publications/vote/types.js";
 import type { PseudonymityAliasRow, PurgedCommentTableRows } from "./db-handler-types.js";
+import type { PageSortReplyEntry } from "../../../pages/types.js";
+export type CalculatedCommentUpdate = Omit<CommentUpdateType, "signature" | "updatedAt" | "replies" | "protocolVersion">;
+export type CommentUpdateCalculationInput = Pick<CommentsTableRow, "cid" | "authorSignerAddress" | "timestamp"> & {
+    challengeCommentUpdate?: Record<string, unknown>;
+};
+export type CommunityAuthorMemo = {
+    writeGeneration: number;
+    authors: Map<string, CommunityAuthor | undefined>;
+};
+export declare const createCommunityAuthorMemo: () => CommunityAuthorMemo;
 export declare class DbHandler {
     _db: BetterSqlite3Database;
     private _community;
@@ -15,8 +25,11 @@ export declare class DbHandler {
     private _keyv;
     private _createdTables;
     private _columnNamesByTable;
+    private _positionalMappers;
+    private _publicationWriteGeneration;
+    private _preparedStatements;
     constructor(community: DbHandler["_community"]);
-    private _parsePrefixedComment;
+    private _prepareCached;
     private _parseCommentsTableRow;
     private _parseCommentUpdatesRow;
     private _parseCommentEditsRow;
@@ -40,10 +53,12 @@ export declare class DbHandler {
     rollbackAllTransactions(): Promise<void>;
     private _createCommentsTable;
     private _createCommentUpdatesTable;
+    private _createCommentsIndexes;
     private _createVotesTable;
     private _createCommentEditsTable;
     private _createCommentModerationsTable;
     private _createPseudonymityAliasesTable;
+    private _createAuthorIndexes;
     getDbVersion(): number;
     _migrateOldSettings(oldSettings: InternalCommunityRecordBeforeFirstUpdateType["settings"]): {
         fetchThumbnailUrls?: boolean | undefined;
@@ -89,6 +104,22 @@ export declare class DbHandler {
         maxPendingApprovalCount?: number | undefined;
         purgeDisapprovedCommentsOlderThan?: number | undefined;
         disablePubsubChallengeExchange?: boolean | undefined;
+        pages?: {
+            posts?: {
+                path?: string | undefined;
+                name?: string | undefined;
+                options?: Record<string, string> | undefined;
+                preloaded?: boolean | undefined;
+                privateOptions?: string[] | undefined;
+            }[] | undefined;
+            replies?: {
+                path?: string | undefined;
+                name?: string | undefined;
+                options?: Record<string, string> | undefined;
+                preloaded?: boolean | undefined;
+                privateOptions?: string[] | undefined;
+            }[] | undefined;
+        } | undefined;
     };
     _createOrMigrateTablesIfNeeded(): Promise<void>;
     private _tableExists;
@@ -118,10 +149,17 @@ export declare class DbHandler {
     private _communityAddressClause;
     private _communityAddressClauseNamed;
     private _buildPageQueryParts;
-    queryMaximumTimestampUnderComment(comment: Pick<CommentsTableRow, "cid">): number | undefined;
+    private _pageEntryMapper;
+    private _positionalMapperFor;
     queryPageComments(options: Omit<PageOptions, "firstPageSizeBytes">): PageIpfs["comments"];
+    private _assembleReplyTrees;
     queryPageCommentsWithResolvedReplies(options: Omit<PageOptions, "firstPageSizeBytes">): PageIpfs["comments"];
+    private _entryHasDbReplies;
+    private _forEachCidBatch;
+    queryRepliesUnderPosts(postCids: string[]): PageIpfs["comments"];
     resolveRepliesCidRefsForEntries(entries: PageIpfs["comments"]): PageIpfs["comments"];
+    private _assembleReplyTreesFromCidRefs;
+    private _rebuildEntriesFromTrees;
     queryCommentAndCommentUpdateByCids(cids: string[], opts: {
         commentUpdateCols: string[];
         commentIpfsCols: string[];
@@ -142,7 +180,13 @@ export declare class DbHandler {
     hasCommentEditWithSignatureEncoded(signatureEncoded: string): boolean;
     queryParentsCids(rootComment: Pick<CommentsTableRow, "parentCid">): Pick<CommentsTableRow, "cid">[];
     queryCommentsPendingApproval(): CommentsTableRow[];
-    queryCommentsToBeUpdated(): CommentsTableRow[];
+    private _buildWindowedReplySortArms;
+    private _collectCommentsToBeUpdated;
+    private _withCommentsToBeUpdated;
+    private _selectCommentsToBeUpdated;
+    queryCommentsToBeUpdated(): Pick<CommentsTableRow, "cid" | "depth">[];
+    queryCidsToBeUpdatedByDepth(): Map<number, string[]>;
+    queryCommentsByCids(cids: string[]): CommentsTableRow[];
     queryCommunityStats(): CommunityStats;
     queryCommentsUnderComment(parentCid: string | null): CommentsTableRow[];
     queryFirstCommentWithDepth(commentDepth: number): CommentsTableRow | undefined;
@@ -153,7 +197,6 @@ export declare class DbHandler {
     queryPseudonymityAliasForPost(originalAuthorPublicKey: string, postCid: string): PseudonymityAliasRow | undefined;
     queryPseudonymityAliasForAuthor(originalAuthorPublicKey: string): PseudonymityAliasRow | undefined;
     private _queryCommentAuthorAndParentWithoutParsing;
-    private _queryCommentCounts;
     queryPostsWithOutdatedBuckets(buckets: number[]): {
         cid: string;
         timestamp: number;
@@ -181,24 +224,37 @@ export declare class DbHandler {
         postUpdatesBucket?: number;
         purgedTableRows: PurgedCommentTableRows[];
     }[] | undefined;
-    private _queryLatestModeratorReason;
     queryCommentFlagsSetByMod(cid: string): Pick<CommentUpdateType, "spoiler" | "pinned" | "locked" | "archived" | "removed" | "nsfw">;
     queryAuthorEditDeleted(cid: string): Pick<CommentEditsTableRow, "deleted"> | undefined;
-    private _queryModCommentFlairs;
-    private _queryLastChildCidAndLastReplyTimestamp;
     _queryIsCommentApproved(comment: Pick<CommentsTableRow, "cid" | "authorSignerAddress" | "timestamp">): {
         approved: boolean;
     } | undefined;
-    private _calculateCommentNumbers;
     queryCalculatedCommentUpdate(opts: {
-        comment: Pick<CommentsTableRow, "cid" | "authorSignerAddress" | "timestamp"> & {
-            challengeCommentUpdate?: Record<string, unknown>;
-        };
+        comment: CommentUpdateCalculationInput;
         authorDomain?: string;
-    }): Omit<CommentUpdateType, "signature" | "updatedAt" | "replies" | "protocolVersion">;
+    }): CalculatedCommentUpdate;
+    queryCalculatedCommentUpdates(opts: {
+        comments: (CommentUpdateCalculationInput & Pick<CommentsTableRow, "author">)[];
+        authorMemo?: CommunityAuthorMemo;
+    }): Map<string, CalculatedCommentUpdate>;
+    private _calculateCommentUpdates;
+    private _cidChunks;
+    private _queryVoteCountsByCids;
+    private _queryReplyCountsByParentCids;
+    private _queryLastReplyTimestampsByParentCids;
+    private _queryLastChildCidsByParentCids;
+    private _queryModerationSummariesByCids;
+    private _queryLatestAuthorEditsByCids;
+    private _queryCommentNumbersByCids;
+    private _queryCommunityAuthorsForCommentUpdates;
+    private _queryPseudonymityAliasesByCommentCids;
+    private _queryAliasExpandedAddressSets;
+    private _queryAuthorAggregatesByAddresses;
+    private _queryAuthorModEditRows;
+    queryCommentUpdateTimestampBucketRepliesByCids(cids: string[]): Map<string, Pick<CommentUpdatesRow, "updatedAt" | "postUpdatesBucket" | "replies">>;
     queryLatestPostCid(): Pick<CommentsTableRow, "cid"> | undefined;
     queryLatestCommentCid(): Pick<CommentsTableRow, "cid"> | undefined;
-    queryAllCommentsOrderedByIdAsc(): CommentsTableRow[];
+    iterateAllCommentsOrderedByIdAsc(batchSize: number): Generator<CommentsTableRow[], void>;
     queryAuthorModEdits(opts: {
         authorSignerAddresses: string[];
         authorDomain?: string;
@@ -222,11 +278,6 @@ export declare class DbHandler {
      * We query karma for ONLY the alias address (no lookup to other aliases like queryCommunityAuthor does),
      * but include mod edits from both alias and original author.
      */
-    queryCommunityAuthorForCommentUpdate(opts: {
-        authorSignerAddress: string;
-        commentCid: string;
-        authorDomain?: string;
-    }): CommunityAuthor | undefined;
     private _getAllDescendantCids;
     purgeComment(cid: string, isNestedCall?: boolean): PurgedCommentTableRows[];
     changeDbFilename(oldDbName: string, newDbName: string): Promise<void>;
@@ -239,13 +290,20 @@ export declare class DbHandler {
     markCommentsAsPublishedToPostUpdates(commentCids: string[]): void;
     forceUpdateOnAllComments(): void;
     forceUpdateOnAllCommentsWithCid(commentCids: string[]): void;
-    queryAllCommentCidsAndTheirReplies(): {
+    private _runForEachCidBatch;
+    iterateCommentCidsAndTheirPageCids(sliceSize: number): Generator<{
         cid: string;
         allPageCids: string[];
-    }[];
+    }[]>;
+    queryPosts(pageOptions: Omit<PageOptions, "pageSize" | "preloadedPage" | "baseTimestamp" | "firstPageSizeBytes">): PageIpfs["comments"];
     queryPostsWithActiveScore(pageOptions: Omit<PageOptions, "pageSize" | "preloadedPage" | "baseTimestamp" | "firstPageSizeBytes">): (PageIpfs["comments"][0] & {
         activeScore: number;
     })[];
+    queryAllRepliesForPageSort(opts?: {
+        postCid?: string;
+        postCids?: string[];
+    }): PageSortReplyEntry[];
+    private _queryRepliesForPageSort;
     private _processRecordsForDbBeforeInsert;
     private _spreadExtraProps;
 }