@pkcprotocol/pkc-js 0.0.11

package/dist/node/publications/comment/schema.js

@@ -0,0 +1,184 @@
+import { z } from "zod";
+import { FlairSchema, AuthorPubsubSchema, CidStringSchema, CreatePublicationUserOptionsSchema, JsonSignatureSchema, PKCTimestampSchema, ProtocolVersionSchema, PublicationBaseBeforeSigning, SignerWithAddressPublicKeySchema, CommunityAuthorSchema } from "../../schema/schema.js";
+import { CommentEditPubsubMessagePublicationWithFlexibleAuthorSchema } from "../comment-edit/schema.js";
+import * as remeda from "remeda";
+import { messages } from "../../errors.js";
+import { keysToOmitFromSignedPropertyNames } from "../../signer/constants.js";
+import { RepliesPagesIpfsSchema } from "../../pages/schema.js";
+// Comment schemas here
+const CommentContentSchema = z.string();
+// Create Comment schemas here
+// Need to validate if post.link is valid
+// Also add a limitation of 2000 characters to link
+// Need to have multiple types of schema for posts with or without link
+// link posts have no content
+export const CreateCommentOptionsSchema = z
+    .object({
+    flairs: FlairSchema.array().optional(), // Author chosen colored labels for the comment
+    spoiler: z.boolean().optional(), // Hide the comment thumbnail behind spoiler warning
+    nsfw: z.boolean().optional(),
+    content: CommentContentSchema.optional(),
+    title: z.string().optional(),
+    link: z.string().min(1).max(2000, messages.COMMENT_LINK_LENGTH_IS_OVER_LIMIT).optional(),
+    linkWidth: z.number().positive().optional(), // author can optionally provide dimensions of image/video link which helps UI clients with infinite scrolling feeds
+    linkHeight: z.number().positive().optional(),
+    linkHtmlTagName: z.string().min(1).optional(),
+    parentCid: CidStringSchema.optional(), // The parent comment CID
+    postCid: CidStringSchema.optional(), // the post cid, required if the comment is reply
+    quotedCids: z.array(CidStringSchema).optional() // CIDs of comments being quoted/referenced in this reply
+})
+    .merge(CreatePublicationUserOptionsSchema)
+    .strict();
+// This one is used for parsing user's input
+export const CreateCommentOptionsWithRefinementSchema = CreateCommentOptionsSchema.refine((arg) => arg.link || arg.content || arg.title, messages.ERR_COMMENT_HAS_NO_CONTENT_LINK_TITLE).refine((arg) => (arg.parentCid ? arg.postCid : true), messages.ERR_REPLY_HAS_NOT_DEFINED_POST_CID);
+// Below is what's used to initialize a local publication to be published
+export const CommentSignedPropertyNames = remeda.keys.strict(remeda.omit(CreateCommentOptionsSchema.shape, keysToOmitFromSignedPropertyNames));
+const commentPubsubKeys = (remeda.mapToObj([...CommentSignedPropertyNames, "signature"], (x) => [x, true]));
+export const CommentPubsubMessagePublicationSchema = CreateCommentOptionsSchema.merge(PublicationBaseBeforeSigning)
+    .extend({ signature: JsonSignatureSchema })
+    .pick(commentPubsubKeys)
+    .strict();
+export const CommentPubsubMessageWithFlexibleAuthorSchema = CommentPubsubMessagePublicationSchema.merge(z.object({ author: AuthorPubsubSchema.loose().optional() })).strict();
+// This is used by the community when parsing request.comment
+export const CommentPubsubMessageWithFlexibleAuthorRefinementSchema = CommentPubsubMessageWithFlexibleAuthorSchema.loose().refine((arg) => arg.link || arg.content || arg.title, messages.ERR_COMMENT_HAS_NO_CONTENT_LINK_TITLE);
+export const CommentPubsubMessageWithRefinementSchema = CommentPubsubMessagePublicationSchema.refine((arg) => arg.link || arg.content || arg.title, messages.ERR_COMMENT_HAS_NO_CONTENT_LINK_TITLE).refine((arg) => (arg.parentCid ? arg.postCid : true), messages.ERR_REPLY_HAS_NOT_DEFINED_POST_CID);
+export const CommentChallengeRequestToEncryptSchema = CreateCommentOptionsSchema.shape.challengeRequest
+    .unwrap()
+    .extend({
+    comment: CommentPubsubMessageWithFlexibleAuthorSchema.loose()
+})
+    .strict();
+// Remote comments
+// These are the props added by the community before adding the comment to ipfs
+export const CommentIpfsSchema = CommentPubsubMessageWithFlexibleAuthorSchema.extend({
+    depth: z.number().nonnegative().int(),
+    thumbnailUrl: z.string().min(1).optional(),
+    thumbnailUrlWidth: z.number().positive().optional(),
+    thumbnailUrlHeight: z.number().positive().optional(),
+    previousCid: CidStringSchema.optional(),
+    pseudonymityMode: z.enum(["per-post", "per-reply", "per-author"]).optional()
+}).strict();
+// This one should be used for parsing user's input or from gateway/p2p etc
+export const CommentIpfsWithRefinmentSchema = CommentIpfsSchema.refine((arg) => arg.link || arg.content || arg.title, messages.ERR_COMMENT_HAS_NO_CONTENT_LINK_TITLE);
+// Comment update schemas
+export const AuthorWithCommentUpdateSchema = CommentPubsubMessagePublicationSchema.shape.author
+    .unwrap()
+    .extend({
+    community: CommunityAuthorSchema.optional()
+})
+    .loose();
+export const CommentUpdateSchema = z
+    .object({
+    cid: CidStringSchema, // cid of the comment, need it in signature to prevent attack
+    upvoteCount: z.number().nonnegative().int(),
+    downvoteCount: z.number().nonnegative().int(),
+    replyCount: z.number().nonnegative().int(), // the total of reply trees underneath this comment, which includes direct and indirect children
+    childCount: z.number().nonnegative().int().optional(), // the total of direct children of the comment, does not include indirect children
+    number: z.number().int().positive().optional(),
+    postNumber: z.number().int().positive().optional(),
+    edit: CommentEditPubsubMessagePublicationWithFlexibleAuthorSchema.optional(), // most recent edit by comment author, commentUpdate.edit.content, commentUpdate.edit.deleted, commentUpdate.edit.flairs override Comment instance props. Validate commentUpdate.edit.signature
+    flairs: FlairSchema.array().optional(), // arbitrary colored strings to describe the comment, added by mods, override comment.flairs and comment.edit.flairs (which are added by author)
+    spoiler: z.boolean().optional(),
+    nsfw: z.boolean().optional(),
+    pinned: z.boolean().optional(),
+    locked: z.boolean().optional(), // mod locked a post
+    archived: z.boolean().optional(), // mod archived a post
+    removed: z.boolean().optional(), // mod deleted a comment
+    reason: z.string().optional(), // reason the mod took a mood action,
+    approved: z.boolean().optional(), // if comment was pending approval and it got approved or disapproved. Does not apply to comments pending approvals, you need to use moderation.pageCids.pendingApproval to fetch pending comments
+    updatedAt: PKCTimestampSchema, // timestamp in seconds the CommentUpdate was updated
+    author: AuthorWithCommentUpdateSchema.pick({ community: true }).optional(), // add commentUpdate.author.community to comment.author.community, override comment.author.flairs with commentUpdate.author.community.flairs if any
+    lastChildCid: CidStringSchema.optional(), // The cid of the most recent direct child of the comment
+    lastReplyTimestamp: PKCTimestampSchema.optional(), // The timestamp of the most recent direct or indirect child of the comment
+    signature: JsonSignatureSchema, // signature of the CommentUpdate by the community owner to protect against malicious gateway
+    protocolVersion: ProtocolVersionSchema,
+    get replies() {
+        return RepliesPagesIpfsSchema.optional();
+    }
+})
+    .strict();
+export const CommentUpdateSignedPropertyNames = remeda.keys.strict(remeda.omit(CommentUpdateSchema.shape, ["signature"]));
+export const CommentUpdateForDisapprovedPendingComment = CommentUpdateSchema.pick({
+    author: true,
+    cid: true,
+    signature: true,
+    protocolVersion: true,
+    reason: true,
+    removed: true,
+    nsfw: true,
+    locked: true,
+    archived: true,
+    spoiler: true,
+    flairs: true,
+    updatedAt: true,
+    approved: true
+}).strict();
+export const CommentUpdateForDisapprovedPendingCommentSignedPropertyNames = remeda.keys.strict(remeda.omit(CommentUpdateForDisapprovedPendingComment.shape, ["signature"]));
+export const CommentUpdateForChallengeVerificationSchema = CommentUpdateSchema.pick({
+    author: true,
+    cid: true,
+    signature: true,
+    protocolVersion: true,
+    number: true,
+    postNumber: true
+})
+    .merge(z.object({ pendingApproval: z.boolean().optional() }))
+    .strict();
+export const CommentUpdateForChallengeVerificationSignedPropertyNames = remeda.keys.strict(remeda.omit(CommentUpdateForChallengeVerificationSchema.shape, ["signature"]));
+// Comment table here
+export const CommentsTableRowSchema = CommentIpfsSchema.extend({
+    cid: CidStringSchema, // cid of CommentIpfs, cid v0
+    postCid: CidStringSchema,
+    insertedAt: PKCTimestampSchema,
+    authorSignerAddress: SignerWithAddressPublicKeySchema.shape.address,
+    originalCommentSignatureEncoded: CommentPubsubMessagePublicationSchema.shape.signature.shape.signature.optional(),
+    extraProps: z.looseObject({}).optional(),
+    pendingApproval: z.boolean().optional(),
+    number: z.number().int().positive().optional(),
+    postNumber: z.number().int().positive().optional()
+}).strict();
+export const CommentUpdateTableRowSchema = CommentUpdateSchema.extend({
+    insertedAt: PKCTimestampSchema,
+    postUpdatesBucket: z.int().nonnegative().optional(), // the post updates bucket of post CommentUpdate, not applicable to replies
+    publishedToPostUpdatesMFS: z.boolean() // whether the comment latest update has been published
+});
+// Comment pubsub reserved fields
+const additionalCommentReservedFields = [
+    "original",
+    "shortCid",
+    "shortCommunityAddress",
+    "shortCommunityAddress",
+    "communityPublicKey",
+    "communityName",
+    "deleted",
+    "raw",
+    "comment",
+    "commentUpdate",
+    "state",
+    "clients",
+    "publishingState",
+    "updatingState",
+    "rowid",
+    "nameResolved"
+];
+const commentReservedFieldCandidates = remeda.unique([
+    ...remeda.keys.strict(CommentIpfsSchema.shape),
+    ...remeda.keys.strict(CommentsTableRowSchema.shape),
+    ...remeda.keys.strict(CommentUpdateTableRowSchema.shape),
+    ...remeda.keys.strict(CommentChallengeRequestToEncryptSchema.shape),
+    ...remeda.keys.strict(CreateCommentOptionsSchema.shape),
+    ...CommentUpdateForChallengeVerificationSignedPropertyNames,
+    ...CommentUpdateSignedPropertyNames,
+    ...CommentUpdateForDisapprovedPendingCommentSignedPropertyNames,
+    ...additionalCommentReservedFields
+]);
+export const CommentPubsubMessageReservedFields = remeda.difference(commentReservedFieldCandidates, remeda.keys.strict(CommentPubsubMessagePublicationSchema.shape));
+// Reserved fields for CommentIpfs — CommentPubsubMessage reserved fields minus fields that are legitimate in CommentIpfs
+export const CommentIpfsReservedFields = remeda.difference(CommentPubsubMessageReservedFields, remeda.keys.strict(CommentIpfsSchema.shape));
+export const CommentUpdateReservedFields = remeda.difference(CommentPubsubMessageReservedFields, [
+    ...remeda.keys.strict(CommentUpdateSchema.shape),
+    ...remeda.keys.strict(CommentUpdateTableRowSchema.shape),
+    "pendingApproval"
+]);
+// CommentUpdates Table row here
+//# sourceMappingURL=schema.js.map

package/dist/node/publications/comment/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../src/publications/comment/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACH,WAAW,EACX,kBAAkB,EAClB,eAAe,EACf,kCAAkC,EAClC,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,4BAA4B,EAC5B,gCAAgC,EAChC,qBAAqB,EACxB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,2DAA2D,EAAE,MAAM,2BAA2B,CAAC;AACxG,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,iCAAiC,EAAE,MAAM,2BAA2B,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAG/D,uBAAuB;AAEvB,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;AAExC,8BAA8B;AAE9B,yCAAyC;AACzC,mDAAmD;AACnD,uEAAuE;AACvE,6BAA6B;AAE7B,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACtC,MAAM,CAAC;IACJ,MAAM,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,+CAA+C;IACvF,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,oDAAoD;IACrF,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5B,OAAO,EAAE,oBAAoB,CAAC,QAAQ,EAAE;IACxC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,iCAAiC,CAAC,CAAC,QAAQ,EAAE;IACxF,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,oHAAoH;IACjK,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC5C,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC7C,SAAS,EAAE,eAAe,CAAC,QAAQ,EAAE,EAAE,yBAAyB;IAChE,OAAO,EAAE,eAAe,CAAC,QAAQ,EAAE,EAAE,iDAAiD;IACtF,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC,yDAAyD;CAC5G,CAAC;KACD,KAAK,CAAC,kCAAkC,CAAC;KACzC,MAAM,EAAE,CAAC;AAEd,4CAA4C;AAC5C,MAAM,CAAC,MAAM,wCAAwC,GAAG,0BAA0B,CAAC,MAAM,CACrF,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,KAAK,EAC7C,QAAQ,CAAC,qCAAqC,CACjD,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;AAErG,yEAAyE;AAEzE,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CACxD,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,KAAK,EAAE,iCAAiC,CAAC,CACnF,CAAC;AAEF,MAAM,iBAAiB,GAA4E,CAC/F,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,0BAA0B,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAClF,CAAC;AAEF,MAAM,CAAC,MAAM,qCAAqC,GAAG,0BAA0B,CAAC,KAAK,CAAC,4BAA4B,CAAC;KAC9G,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,CAAC;KAC1C,IAAI,CAAC,iBAAiB,CAAC;KACvB,MAAM,EAAE,CAAC;AAEd,MAAM,CAAC,MAAM,4CAA4C,GAAG,qCAAqC,CAAC,KAAK,CACnG,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAC9D,CAAC,MAAM,EAAE,CAAC;AAEX,6DAA6D;AAC7D,MAAM,CAAC,MAAM,sDAAsD,GAAG,4CAA4C,CAAC,KAAK,EAAE,CAAC,MAAM,CAC7H,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,KAAK,EAC7C,QAAQ,CAAC,qCAAqC,CACjD,CAAC;AAEF,MAAM,CAAC,MAAM,wCAAwC,GAAG,qCAAqC,CAAC,MAAM,CAChG,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,KAAK,EAC7C,QAAQ,CAAC,qCAAqC,CACjD,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,kCAAkC,CAAC,CAAC;AAErG,MAAM,CAAC,MAAM,sCAAsC,GAAG,0BAA0B,CAAC,KAAK,CAAC,gBAAgB;KAClG,MAAM,EAAE;KACR,MAAM,CAAC;IACJ,OAAO,EAAE,4CAA4C,CAAC,KAAK,EAAE;CAChE,CAAC;KACD,MAAM,EAAE,CAAC;AAEd,kBAAkB;AAElB,+EAA+E;AAC/E,MAAM,CAAC,MAAM,iBAAiB,GAAG,4CAA4C,CAAC,MAAM,CAAC;IACjF,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE;IACrC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC1C,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACnD,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACpD,WAAW,EAAE,eAAe,CAAC,QAAQ,EAAE;IACvC,gBAAgB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC/E,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,2EAA2E;AAC3E,MAAM,CAAC,MAAM,8BAA8B,GAAG,iBAAiB,CAAC,MAAM,CAClE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,KAAK,EAC7C,QAAQ,CAAC,qCAAqC,CACjD,CAAC;AAEF,yBAAyB;AAEzB,MAAM,CAAC,MAAM,6BAA6B,GAAG,qCAAqC,CAAC,KAAK,CAAC,MAAM;KAC1F,MAAM,EAAE;KACR,MAAM,CAAC;IACJ,SAAS,EAAE,qBAAqB,CAAC,QAAQ,EAAE;CAC9C,CAAC;KACD,KAAK,EAAE,CAAC;AAEb,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACJ,GAAG,EAAE,eAAe,EAAE,6DAA6D;IACnF,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE;IAC3C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE;IAC7C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,gGAAgG;IAC5I,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,EAAE,kFAAkF;IACzI,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC9C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAClD,IAAI,EAAE,2DAA2D,CAAC,QAAQ,EAAE,EAAE,+LAA+L;IAC7Q,MAAM,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,EAAE,gJAAgJ;IACxL,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5B,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC9B,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,oBAAoB;IACpD,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,sBAAsB;IACxD,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,wBAAwB;IACzD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAE,qCAAqC;IACpE,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,kMAAkM;IACpO,SAAS,EAAE,kBAAkB,EAAE,qDAAqD;IACpF,MAAM,EAAE,6BAA6B,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,mJAAmJ;IAC/N,YAAY,EAAE,eAAe,CAAC,QAAQ,EAAE,EAAE,yDAAyD;IACnG,kBAAkB,EAAE,kBAAkB,CAAC,QAAQ,EAAE,EAAE,2EAA2E;IAC9H,SAAS,EAAE,mBAAmB,EAAE,6FAA6F;IAC7H,eAAe,EAAE,qBAAqB;IACtC,IAAI,OAAO;QACP,OAAO,sBAAsB,CAAC,QAAQ,EAAE,CAAC;IAC7C,CAAC;CACJ,CAAC;KACD,MAAM,EAAE,CAAC;AAEd,MAAM,CAAC,MAAM,gCAAgC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;AAE1H,MAAM,CAAC,MAAM,yCAAyC,GAAG,mBAAmB,CAAC,IAAI,CAAC;IAC9E,MAAM,EAAE,IAAI;IACZ,GAAG,EAAE,IAAI;IACT,SAAS,EAAE,IAAI;IACf,eAAe,EAAE,IAAI;IACrB,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,IAAI;IACV,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,IAAI;IACZ,SAAS,EAAE,IAAI;IACf,QAAQ,EAAE,IAAI;CACjB,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,CAAC,MAAM,4DAA4D,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAC1F,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAC9E,CAAC;AAEF,MAAM,CAAC,MAAM,2CAA2C,GAAG,mBAAmB,CAAC,IAAI,CAAC;IAChF,MAAM,EAAE,IAAI;IACZ,GAAG,EAAE,IAAI;IACT,SAAS,EAAE,IAAI;IACf,eAAe,EAAE,IAAI;IACrB,MAAM,EAAE,IAAI;IACZ,UAAU,EAAE,IAAI;CACnB,CAAC;KACG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;KAC5D,MAAM,EAAE,CAAC;AAEd,MAAM,CAAC,MAAM,wDAAwD,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CACtF,MAAM,CAAC,IAAI,CAAC,2CAA2C,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAChF,CAAC;AAEF,qBAAqB;AAErB,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAC3D,GAAG,EAAE,eAAe,EAAE,6BAA6B;IACnD,OAAO,EAAE,eAAe;IACxB,UAAU,EAAE,kBAAkB;IAC9B,mBAAmB,EAAE,gCAAgC,CAAC,KAAK,CAAC,OAAO;IACnE,+BAA+B,EAAE,qCAAqC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,EAAE;IACjH,UAAU,EAAE,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IACxC,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACvC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC9C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACrD,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,CAAC,MAAM,2BAA2B,GAAG,mBAAmB,CAAC,MAAM,CAAC;IAClE,UAAU,EAAE,kBAAkB;IAC9B,iBAAiB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,EAAE,2EAA2E;IAChI,yBAAyB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,uDAAuD;CACjG,CAAC,CAAC;AAEH,iCAAiC;AAEjC,MAAM,+BAA+B,GAAG;IACpC,UAAU;IACV,UAAU;IACV,uBAAuB;IACvB,uBAAuB;IACvB,oBAAoB;IACpB,eAAe;IACf,SAAS;IACT,KAAK;IACL,SAAS;IACT,eAAe;IACf,OAAO;IACP,SAAS;IACT,iBAAiB;IACjB,eAAe;IACf,OAAO;IACP,cAAc;CACR,CAAC;AAeX,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAAgC;IAChF,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,KAAK,CAAC;IAC9C,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,KAAK,CAAC;IACnD,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,KAAK,CAAC;IACxD,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,sCAAsC,CAAC,KAAK,CAAC;IACnE,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,0BAA0B,CAAC,KAAK,CAAC;IACvD,GAAG,wDAAwD;IAC3D,GAAG,gCAAgC;IACnC,GAAG,4DAA4D;IAC/D,GAAG,+BAA+B;CACrC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kCAAkC,GAAG,MAAM,CAAC,UAAU,CAC/D,8BAA8B,EAC9B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,qCAAqC,CAAC,KAAK,CAAoC,CACrG,CAAC;AAYF,yHAAyH;AACzH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,UAAU,CACtD,kCAAkC,EAClC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,KAAK,CAA8C,CAC3F,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,MAAM,CAAC,UAAU,CAAC,kCAAkC,EAAE;IAC7F,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC;IAChD,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,KAAK,CAAC;IACxD,iBAAiB;CACpB,CAAC,CAAC;AAEH,gCAAgC"}

package/dist/node/publications/comment/types.d.ts

@@ -0,0 +1,100 @@
+import { z } from "zod";
+import { CommentChallengeRequestToEncryptSchema, CommentIpfsSchema, CommentPubsubMessagePublicationSchema, CommentSignedPropertyNames, CommentsTableRowSchema, CommentUpdateForChallengeVerificationSchema, CommentUpdateForChallengeVerificationSignedPropertyNames, CommentUpdateForDisapprovedPendingComment, CommentUpdateSchema, CommentUpdateSignedPropertyNames, CommentUpdateTableRowSchema, CreateCommentOptionsSchema } from "./schema.js";
+import { CommunityAuthorSchema } from "../../schema/schema.js";
+import { RpcCommentEventResultSchema, RpcCommentUpdateResultSchema } from "../../clients/rpc-client/schema.js";
+import type { JsonOfClass, RuntimeAuthorWithCommentUpdateType } from "../../types.js";
+import { Comment } from "./comment.js";
+import type { RepliesPagesTypeJson } from "../../pages/types.js";
+import type { PublicationRpcErrorToTransmit, PublicationState } from "../types.js";
+import type { JsonSignature, SignerType } from "../../signer/types.js";
+import Publication from "../publication.js";
+export type CommunityAuthor = z.infer<typeof CommunityAuthorSchema>;
+export type CreateCommentOptions = z.infer<typeof CreateCommentOptionsSchema>;
+export type CommentPubsubMessagePublication = z.infer<typeof CommentPubsubMessagePublicationSchema>;
+export interface CommentOptionsToSign extends Omit<CommentPubsubMessagePublication, "signature"> {
+    signer: SignerType;
+    communityAddress: string;
+}
+export type CommentUpdateType = z.infer<typeof CommentUpdateSchema>;
+export type CommentUpdateForDisapprovedPendingComment = z.infer<typeof CommentUpdateForDisapprovedPendingComment>;
+export type CommentUpdateForChallengeVerification = z.infer<typeof CommentUpdateForChallengeVerificationSchema>;
+export type CommentIpfsType = z.infer<typeof CommentIpfsSchema>;
+export type CommentChallengeRequestToEncryptType = z.infer<typeof CommentChallengeRequestToEncryptSchema>;
+export type RpcCommentUpdateResultType = z.infer<typeof RpcCommentUpdateResultSchema>;
+export type RpcCommentResultType = z.infer<typeof RpcCommentEventResultSchema>;
+export interface CommentRawField extends Omit<Required<Publication["raw"]>, "pubsubMessageToPublish" | "unsignedPublicationOptions"> {
+    comment?: CommentIpfsType;
+    commentUpdate?: CommentUpdateType;
+    pubsubMessageToPublish?: CommentPubsubMessagePublication;
+    commentUpdateFromChallengeVerification?: CommentUpdateForChallengeVerification;
+    runtimeFieldsFromRpc?: Record<string, any>;
+}
+export type CommentJson = JsonOfClass<Comment>;
+type AuthorWithShortCommunityAddress = RuntimeAuthorWithCommentUpdateType & {
+    shortAddress: string;
+};
+export interface CommentIpfsWithCidDefined extends CommentIpfsType {
+    cid: string;
+}
+export interface CommentIpfsWithCidPostCidDefined extends CommentIpfsWithCidDefined {
+    postCid: string;
+}
+export interface CommentWithinRepliesPostsPageJson extends CommentIpfsWithCidPostCidDefined, Omit<CommentUpdateType, "replies"> {
+    communityAddress: string;
+    shortCid: string;
+    shortCommunityAddress: string;
+    author: AuthorWithShortCommunityAddress;
+    deleted?: boolean;
+    replies?: Omit<RepliesPagesTypeJson, "clients">;
+    raw: {
+        comment: CommentIpfsType;
+        commentUpdate: CommentUpdateType;
+    };
+}
+export interface CommentWithinModQueuePageJson extends CommentIpfsWithCidPostCidDefined, CommentUpdateForChallengeVerification {
+    communityAddress: string;
+    shortCid: string;
+    shortCommunityAddress: string;
+    author: AuthorWithShortCommunityAddress;
+    raw: {
+        comment: CommentIpfsType;
+        commentUpdate: CommentUpdateForChallengeVerification & {
+            pendingApproval: boolean;
+        };
+    };
+    pendingApproval: boolean;
+}
+export type CommentState = PublicationState | "updating";
+export type CommentUpdatingState = "stopped" | "resolving-author-name" | "fetching-ipfs" | "fetching-update-ipfs" | "resolving-community-name" | "fetching-community-ipns" | "fetching-community-ipfs" | "failed" | "succeeded" | "waiting-retry";
+export interface CommentPubsubMessageWithCommunityAuthor extends CommentPubsubMessagePublication {
+    author: RuntimeAuthorWithCommentUpdateType;
+}
+export interface PostPubsubMessageWithCommunityAuthor extends CommentPubsubMessageWithCommunityAuthor {
+    parentCid: undefined;
+}
+export interface ReplyPubsubMessageWithCommunityAuthor extends CommentPubsubMessageWithCommunityAuthor {
+    parentCid: string;
+}
+export interface CommentPubsubMessagPublicationSignature extends JsonSignature {
+    signedPropertyNames: typeof CommentSignedPropertyNames;
+}
+export interface CommentUpdateForChallengeVerificationSignature extends JsonSignature {
+    signedPropertyNames: typeof CommentUpdateForChallengeVerificationSignedPropertyNames;
+}
+export interface CommentUpdateSignature extends JsonSignature {
+    signedPropertyNames: typeof CommentUpdateSignedPropertyNames;
+}
+export type MinimumCommentFieldsToFetchPages = Pick<CommentIpfsWithCidDefined, "cid" | "depth" | "postCid"> & {
+    communityAddress: string;
+};
+export type CommentRpcErrorToTransmit = PublicationRpcErrorToTransmit & {
+    details?: PublicationRpcErrorToTransmit["details"] & {
+        newUpdatingState?: Comment["updatingState"];
+    };
+};
+export type CommentsTableRow = z.infer<typeof CommentsTableRowSchema>;
+export interface CommentsTableRowInsert extends Omit<CommentsTableRow, "rowid"> {
+}
+export type CommentUpdatesRow = z.infer<typeof CommentUpdateTableRowSchema>;
+export type CommentUpdatesTableRowInsert = CommentUpdatesRow;
+export {};

package/dist/node/publications/comment/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/node/publications/comment/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/publications/comment/types.ts"],"names":[],"mappings":""}

package/dist/node/publications/comment-edit/comment-edit.d.ts

@@ -0,0 +1,41 @@
+import { PKC } from "../../pkc/pkc.js";
+import Publication from "../publication.js";
+import type { CommentEditPubsubMessagePublication, CreateCommentEditOptions } from "./types.js";
+import type { PublicationTypeName } from "../../types.js";
+import type { SignerType } from "../../signer/types.js";
+import type { CreatePublicationOptions } from "../../types.js";
+export declare class CommentEdit extends Publication implements CommentEditPubsubMessagePublication {
+    commentCid: CommentEditPubsubMessagePublication["commentCid"];
+    content?: CommentEditPubsubMessagePublication["content"];
+    reason?: CommentEditPubsubMessagePublication["reason"];
+    deleted?: CommentEditPubsubMessagePublication["deleted"];
+    flairs?: CommentEditPubsubMessagePublication["flairs"];
+    spoiler?: CommentEditPubsubMessagePublication["spoiler"];
+    nsfw?: CommentEditPubsubMessagePublication["nsfw"];
+    signature: CommentEditPubsubMessagePublication["signature"];
+    raw: {
+        pubsubMessageToPublish?: CommentEditPubsubMessagePublication;
+    };
+    challengeRequest?: CreateCommentEditOptions["challengeRequest"];
+    constructor(pkc: PKC);
+    _initUnsignedLocalProps<T extends {
+        signer: SignerType;
+        communityAddress: string;
+        timestamp: number;
+        protocolVersion: string;
+        author?: Record<string, unknown>;
+    }>(opts: {
+        unsignedOptions: T;
+        challengeRequest?: CreatePublicationOptions["challengeRequest"];
+    }): void;
+    _initLocalProps(props: {
+        commentEdit: CommentEditPubsubMessagePublication;
+        signer?: SignerType;
+        challengeRequest?: CreateCommentEditOptions["challengeRequest"];
+    }): void;
+    protected _signPublicationOptionsToPublish(cleanedPublication: unknown): Promise<CommentEditPubsubMessagePublication["signature"]>;
+    _initPubsubPublicationProps(props: CommentEditPubsubMessagePublication): void;
+    getType(): PublicationTypeName;
+    protected _validateSignatureHook(): Promise<void>;
+    publish(): Promise<void>;
+}

package/dist/node/publications/comment-edit/comment-edit.js

@@ -0,0 +1,63 @@
+import Publication from "../publication.js";
+import { signCommentEdit, verifyCommentEdit } from "../../signer/signatures.js";
+import { hideClassPrivateProps, isIpfsCid } from "../../util.js";
+import { PKCError } from "../../pkc-error.js";
+export class CommentEdit extends Publication {
+    constructor(pkc) {
+        super(pkc);
+        this.raw = {};
+        // public method should be bound
+        this.publish = this.publish.bind(this);
+        hideClassPrivateProps(this);
+    }
+    _initUnsignedLocalProps(opts) {
+        super._initUnsignedLocalProps(opts);
+        const o = opts.unsignedOptions;
+        this.commentCid = o.commentCid;
+        this.content = o.content;
+        this.reason = o.reason;
+        this.deleted = o.deleted;
+        this.flairs = o.flairs;
+        this.spoiler = o.spoiler;
+        this.nsfw = o.nsfw;
+    }
+    _initLocalProps(props) {
+        this._initPubsubPublicationProps(props.commentEdit);
+        this.challengeRequest = props.challengeRequest;
+        this.signer = props.signer;
+    }
+    async _signPublicationOptionsToPublish(cleanedPublication) {
+        return signCommentEdit({ edit: cleanedPublication, pkc: this._pkc });
+    }
+    _initPubsubPublicationProps(props) {
+        this.raw.pubsubMessageToPublish = props;
+        super._initBaseRemoteProps(props);
+        this.commentCid = props.commentCid;
+        this.content = props.content;
+        this.reason = props.reason;
+        this.deleted = props.deleted;
+        this.flairs = props.flairs;
+        this.spoiler = props.spoiler;
+        this.nsfw = props.nsfw;
+    }
+    getType() {
+        return "commentEdit";
+    }
+    async _validateSignatureHook() {
+        const editObj = JSON.parse(JSON.stringify(this.raw.pubsubMessageToPublish));
+        const signatureValidity = await verifyCommentEdit({
+            edit: editObj,
+            resolveAuthorNames: this._pkc.resolveAuthorNames,
+            clientsManager: this._clientsManager
+        });
+        if (!signatureValidity.valid)
+            throw new PKCError("ERR_SIGNATURE_IS_INVALID", { signatureValidity });
+    }
+    async publish() {
+        // TODO if publishing with content,reason, deleted, verify that publisher is original author
+        if (!isIpfsCid(this.commentCid))
+            throw new PKCError("ERR_CID_IS_INVALID", { commentCid: this.commentCid });
+        return super.publish();
+    }
+}
+//# sourceMappingURL=comment-edit.js.map

package/dist/node/publications/comment-edit/comment-edit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment-edit.js","sourceRoot":"","sources":["../../../../src/publications/comment-edit/comment-edit.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAM9C,MAAM,OAAO,WAAY,SAAQ,WAAW;IAcxC,YAAY,GAAQ;QAChB,KAAK,CAAC,GAAG,CAAC,CAAC;QAJN,QAAG,GAAqE,EAAE,CAAC;QAMhF,gCAAgC;QAChC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEvC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEQ,uBAAuB,CAQ9B,IAA6F;QAC3F,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,CAAC,GAAG,IAAI,CAAC,eAAsD,CAAC;QACtE,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,eAAe,CAAC,KAIf;QACG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC/B,CAAC;IAEkB,KAAK,CAAC,gCAAgC,CACrD,kBAA2B;QAE3B,OAAO,eAAe,CAAC,EAAE,IAAI,EAAE,kBAA8C,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IACrG,CAAC;IAED,2BAA2B,CAAC,KAA0C;QAClE,IAAI,CAAC,GAAG,CAAC,sBAAsB,GAAG,KAAK,CAAC;QACxC,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;IAC3B,CAAC;IAEQ,OAAO;QACZ,OAAO,aAAa,CAAC;IACzB,CAAC;IAEkB,KAAK,CAAC,sBAAsB;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAuB,CAAC,CAAC,CAAC;QAC7E,MAAM,iBAAiB,GAAG,MAAM,iBAAiB,CAAC;YAC9C,IAAI,EAAE,OAAO;YACb,kBAAkB,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB;YAChD,cAAc,EAAE,IAAI,CAAC,eAAe;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,iBAAiB,CAAC,KAAK;YAAE,MAAM,IAAI,QAAQ,CAAC,0BAA0B,EAAE,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACxG,CAAC;IAEQ,KAAK,CAAC,OAAO;QAClB,4FAA4F;QAC5F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC;YAAE,MAAM,IAAI,QAAQ,CAAC,oBAAoB,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;QAE3G,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;CACJ"}