@pkcprotocol/pkc-js 0.0.11

package/dist/browser/pubsub-messages/schema.js

@@ -0,0 +1,98 @@
+import { z } from "zod";
+import { ChallengeAnswersSchema, CreatePublicationUserOptionsSchema, PKCTimestampSchema, ProtocolVersionSchema, UserAgentSchema } from "../schema/schema.js";
+import { VotePubsubMessagePublicationSchema } from "../publications/vote/schema.js";
+import { CommentEditPubsubMessagePublicationWithFlexibleAuthorSchema } from "../publications/comment-edit/schema.js";
+import { CommentIpfsSchema, CommentPubsubMessageWithFlexibleAuthorRefinementSchema, CommentUpdateForChallengeVerificationSchema } from "../publications/comment/schema.js";
+import { ChallengeFileSchema, ChallengeFromGetChallengeSchema } from "../community/schema.js";
+import * as remeda from "remeda";
+import { CommentModerationPubsubMessagePublicationSchema } from "../publications/comment-moderation/schema.js";
+import { CommunityEditPubsubMessagePublicationSchema } from "../publications/community-edit/schema.js";
+import { Uint8ArraySchema, nonNegativeIntStringSchema } from "../schema.js";
+const AcceptedChallengeTypeSchema = z.string().min(1);
+export const PubsubMessageSignatureSchema = z
+    .object({
+    signature: Uint8ArraySchema, // (byte string in cbor)
+    publicKey: Uint8ArraySchema, // (byte string in cbor) 32 bytes
+    type: z.string().min(1),
+    signedPropertyNames: z.string().array()
+})
+    .strict();
+const PubsubMessageBaseSchema = z.object({
+    challengeRequestId: Uint8ArraySchema, // (byte string in cbor) // multihash of pubsubmessage.signature.publicKey, each challengeRequestMessage must use a new public key
+    signature: PubsubMessageSignatureSchema,
+    protocolVersion: ProtocolVersionSchema,
+    userAgent: UserAgentSchema,
+    timestamp: PKCTimestampSchema
+});
+export const EncryptedSchema = z
+    .object({
+    // examples available at https://github.com/pkc/pkc-js/blob/master/docs/encryption.md
+    ciphertext: Uint8ArraySchema,
+    iv: Uint8ArraySchema,
+    tag: Uint8ArraySchema,
+    type: z.string().min(1)
+})
+    .strict();
+// publication with community author that are added by community when they respond to publication, or emit an event
+// Challenge Request message
+export const ChallengeRequestMessageSchema = PubsubMessageBaseSchema.extend({
+    type: z.literal("CHALLENGEREQUEST"),
+    encrypted: EncryptedSchema, // Will decrypt to DecryptedChallengeRequestSchema
+    acceptedChallengeTypes: AcceptedChallengeTypeSchema.array().optional()
+}).strict();
+export const DecryptedChallengeRequestPublicationSchema = z.object({
+    comment: CommentPubsubMessageWithFlexibleAuthorRefinementSchema.optional(),
+    vote: VotePubsubMessagePublicationSchema.loose().optional(),
+    commentEdit: CommentEditPubsubMessagePublicationWithFlexibleAuthorSchema.loose().optional(),
+    commentModeration: CommentModerationPubsubMessagePublicationSchema.loose().optional(),
+    communityEdit: CommunityEditPubsubMessagePublicationSchema.loose().optional()
+});
+// ChallengeRequestMessage.encrypted.ciphertext decrypts to JSON, with these props
+export const DecryptedChallengeRequestSchema = DecryptedChallengeRequestPublicationSchema.merge(CreatePublicationUserOptionsSchema.shape.challengeRequest.unwrap());
+export const ChallengeRequestMessageSignedPropertyNames = remeda.keys.strict(remeda.omit(ChallengeRequestMessageSchema.shape, ["signature"]));
+// Challenge message
+export const ChallengeInChallengePubsubMessageSchema = z
+    .object({
+    challenge: z.string(),
+    type: z.lazy(() => ChallengeFromGetChallengeSchema.shape.type),
+    caseInsensitive: z.lazy(() => ChallengeFileSchema.shape.caseInsensitive)
+})
+    .strict();
+export const ChallengeMessageSchema = PubsubMessageBaseSchema.extend({
+    type: z.literal("CHALLENGE"),
+    encrypted: EncryptedSchema // Will decrypt to DecryptedChallengeSchema
+}).strict();
+export const DecryptedChallengeSchema = z
+    .object({
+    challenges: ChallengeInChallengePubsubMessageSchema.array()
+})
+    .strict();
+export const ChallengeMessageSignedPropertyNames = remeda.keys.strict(remeda.omit(ChallengeMessageSchema.shape, ["signature"]));
+// Challenge answer
+export const ChallengeAnswerMessageSchema = PubsubMessageBaseSchema.extend({
+    type: z.literal("CHALLENGEANSWER"),
+    encrypted: EncryptedSchema // Will decrypt to DecryptedChallengeAnswerSchema
+}).strict();
+export const DecryptedChallengeAnswerSchema = z
+    .object({
+    challengeAnswers: ChallengeAnswersSchema // for example ['2+2=4', '1+7=8']
+})
+    .strict();
+export const ChallengeAnswerMessageSignedPropertyNames = remeda.keys.strict(remeda.omit(ChallengeAnswerMessageSchema.shape, ["signature"]));
+// Challenge Verification
+export const ChallengeVerificationMessageSchema = PubsubMessageBaseSchema.extend({
+    type: z.literal("CHALLENGEVERIFICATION"),
+    challengeSuccess: z.boolean(),
+    challengeErrors: z.record(nonNegativeIntStringSchema, z.string()).optional(), // challenge index => challenge error
+    reason: z.string().optional(),
+    encrypted: EncryptedSchema.optional() // Will decrypt to DecryptedChallengeVerificationSchema
+}).strict();
+export const DecryptedChallengeVerificationSchema = z
+    .object({
+    comment: CommentIpfsSchema.loose(),
+    commentUpdate: CommentUpdateForChallengeVerificationSchema.loose()
+})
+    .strict();
+export const ChallengeVerificationMessageSignedPropertyNames = remeda.keys.strict(remeda.omit(ChallengeVerificationMessageSchema.shape, ["signature"]));
+// Handling challenges for community
+//# sourceMappingURL=schema.js.map

package/dist/browser/pubsub-messages/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../src/pubsub-messages/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACH,sBAAsB,EACtB,kCAAkC,EAClC,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,kCAAkC,EAAE,MAAM,gCAAgC,CAAC;AACpF,OAAO,EAAE,2DAA2D,EAAE,MAAM,wCAAwC,CAAC;AACrH,OAAO,EACH,iBAAiB,EACjB,sDAAsD,EACtD,2CAA2C,EAC9C,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAC;AAC9F,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,+CAA+C,EAAE,MAAM,8CAA8C,CAAC;AAC/G,OAAO,EAAE,2CAA2C,EAAE,MAAM,0CAA0C,CAAC;AACvG,OAAO,EAAE,gBAAgB,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE5E,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAEtD,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC;KACxC,MAAM,CAAC;IACJ,SAAS,EAAE,gBAAgB,EAAE,wBAAwB;IACrD,SAAS,EAAE,gBAAgB,EAAE,iCAAiC;IAC9D,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE;CAC1C,CAAC;KACD,MAAM,EAAE,CAAC;AAEd,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,kBAAkB,EAAE,gBAAgB,EAAE,kIAAkI;IACxK,SAAS,EAAE,4BAA4B;IACvC,eAAe,EAAE,qBAAqB;IACtC,SAAS,EAAE,eAAe;IAC1B,SAAS,EAAE,kBAAkB;CAChC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC3B,MAAM,CAAC;IACJ,qFAAqF;IACrF,UAAU,EAAE,gBAAgB;IAC5B,EAAE,EAAE,gBAAgB;IACpB,GAAG,EAAE,gBAAgB;IACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC1B,CAAC;KACD,MAAM,EAAE,CAAC;AAEd,mHAAmH;AAEnH,4BAA4B;AAE5B,MAAM,CAAC,MAAM,6BAA6B,GAAG,uBAAuB,CAAC,MAAM,CAAC;IACxE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;IACnC,SAAS,EAAE,eAAe,EAAE,kDAAkD;IAC9E,sBAAsB,EAAE,2BAA2B,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;CACzE,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,CAAC,MAAM,0CAA0C,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/D,OAAO,EAAE,sDAAsD,CAAC,QAAQ,EAAE;IAC1E,IAAI,EAAE,kCAAkC,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IAC3D,WAAW,EAAE,2DAA2D,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IAC3F,iBAAiB,EAAE,+CAA+C,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;IACrF,aAAa,EAAE,2CAA2C,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;CAChF,CAAC,CAAC;AAEH,kFAAkF;AAClF,MAAM,CAAC,MAAM,+BAA+B,GAAG,0CAA0C,CAAC,KAAK,CAC3F,kCAAkC,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,EAAE,CACrE,CAAC;AAEF,MAAM,CAAC,MAAM,0CAA0C,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CACxE,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAClE,CAAC;AACF,oBAAoB;AAEpB,MAAM,CAAC,MAAM,uCAAuC,GAAG,CAAC;KACnD,MAAM,CAAC;IACJ,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,+BAA+B,CAAC,KAAK,CAAC,IAAI,CAAC;IAC9D,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,eAAe,CAAC;CAC3E,CAAC;KACD,MAAM,EAAE,CAAC;AAEd,MAAM,CAAC,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,MAAM,CAAC;IACjE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAC5B,SAAS,EAAE,eAAe,CAAC,2CAA2C;CACzE,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACpC,MAAM,CAAC;IACJ,UAAU,EAAE,uCAAuC,CAAC,KAAK,EAAE;CAC9D,CAAC;KACD,MAAM,EAAE,CAAC;AACd,MAAM,CAAC,MAAM,mCAAmC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;AAEhI,mBAAmB;AAEnB,MAAM,CAAC,MAAM,4BAA4B,GAAG,uBAAuB,CAAC,MAAM,CAAC;IACvE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAClC,SAAS,EAAE,eAAe,CAAC,iDAAiD;CAC/E,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC1C,MAAM,CAAC;IACJ,gBAAgB,EAAE,sBAAsB,CAAC,iCAAiC;CAC7E,CAAC;KACD,MAAM,EAAE,CAAC;AAEd,MAAM,CAAC,MAAM,yCAAyC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;AAE5I,yBAAyB;AAEzB,MAAM,CAAC,MAAM,kCAAkC,GAAG,uBAAuB,CAAC,MAAM,CAAC;IAC7E,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,uBAAuB,CAAC;IACxC,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC7B,eAAe,EAAE,CAAC,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,qCAAqC;IACnH,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,SAAS,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC,uDAAuD;CAChG,CAAC,CAAC,MAAM,EAAE,CAAC;AAEZ,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC;KAChD,MAAM,CAAC;IACJ,OAAO,EAAE,iBAAiB,CAAC,KAAK,EAAE;IAClC,aAAa,EAAE,2CAA2C,CAAC,KAAK,EAAE;CACrE,CAAC;KACD,MAAM,EAAE,CAAC;AAEd,MAAM,CAAC,MAAM,+CAA+C,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAC7E,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC,CACvE,CAAC;AAEF,oCAAoC"}

package/dist/browser/pubsub-messages/types.d.ts

@@ -0,0 +1,81 @@
+import type { CommentEditPubsubMessagePublication, CommentEditPubsubMessagePublicationWithCommunityAuthor } from "../publications/comment-edit/types.js";
+import type { CommentModerationPubsubMessagePublication, CommentModerationPubsubMessagePublicationWithCommunityAuthor } from "../publications/comment-moderation/types.js";
+import type { CommentPubsubMessagePublication, CommentPubsubMessageWithCommunityAuthor, PostPubsubMessageWithCommunityAuthor, ReplyPubsubMessageWithCommunityAuthor } from "../publications/comment/types.js";
+import type { CommunityEditPublicationPubsubMessageWithCommunityAuthor, CommunityEditPubsubMessagePublication } from "../publications/community-edit/types.js";
+import type { VotePubsubMessagePublication, VotePubsubMessageWithCommunityAuthor } from "../publications/vote/types.js";
+import type { PubsubSignature } from "../signer/types.js";
+import type { RuntimeAuthorWithCommentUpdateType } from "../types.js";
+import { ChallengeAnswerMessageSchema, ChallengeAnswerMessageSignedPropertyNames, ChallengeInChallengePubsubMessageSchema, ChallengeMessageSchema, ChallengeMessageSignedPropertyNames, ChallengeRequestMessageSchema, ChallengeRequestMessageSignedPropertyNames, ChallengeVerificationMessageSchema, ChallengeVerificationMessageSignedPropertyNames, DecryptedChallengeAnswerSchema, DecryptedChallengeRequestPublicationSchema, DecryptedChallengeRequestSchema, DecryptedChallengeSchema, DecryptedChallengeVerificationSchema } from "./schema.js";
+import { z } from "zod";
+export type ChallengeRequestMessageType = z.infer<typeof ChallengeRequestMessageSchema>;
+export type DecryptedChallengeRequestPublication = z.infer<typeof DecryptedChallengeRequestPublicationSchema>;
+export type DecryptedChallengeRequest = z.infer<typeof DecryptedChallengeRequestSchema>;
+export type DecryptedChallengeRequestMessageType = DecryptedChallengeRequest & ChallengeRequestMessageType;
+export interface DecryptedChallengeRequestMessageTypeWithCommunityAuthor extends Omit<DecryptedChallengeRequestMessageType, "comment" | "vote" | "commentEdit" | "commentModeration" | "communityEdit"> {
+    vote?: VotePubsubMessageWithCommunityAuthor;
+    comment?: CommentPubsubMessageWithCommunityAuthor;
+    commentEdit?: CommentEditPubsubMessagePublicationWithCommunityAuthor;
+    commentModeration?: CommentModerationPubsubMessagePublicationWithCommunityAuthor;
+    communityEdit?: CommunityEditPublicationPubsubMessageWithCommunityAuthor;
+}
+export type PublicationFromDecryptedChallengeRequest = NonNullable<VotePubsubMessagePublication | CommentPubsubMessagePublication | CommentEditPubsubMessagePublication | CommentModerationPubsubMessagePublication | CommunityEditPubsubMessagePublication>;
+export type PublicationWithCommunityAuthorFromDecryptedChallengeRequest = PublicationFromDecryptedChallengeRequest & {
+    author: RuntimeAuthorWithCommentUpdateType;
+};
+export interface DecryptedChallengeRequestMessageWithReplyCommunityAuthor extends DecryptedChallengeRequestMessageTypeWithCommunityAuthor {
+    comment: ReplyPubsubMessageWithCommunityAuthor;
+}
+export interface DecryptedChallengeRequestMessageWithPostCommunityAuthor extends DecryptedChallengeRequestMessageTypeWithCommunityAuthor {
+    comment: PostPubsubMessageWithCommunityAuthor;
+}
+export type ChallengeType = z.infer<typeof ChallengeInChallengePubsubMessageSchema>;
+export type ChallengeMessageType = z.infer<typeof ChallengeMessageSchema>;
+export type DecryptedChallenge = z.infer<typeof DecryptedChallengeSchema>;
+export type DecryptedChallengeMessageType = ChallengeMessageType & DecryptedChallenge;
+export type ChallengeAnswerMessageType = z.infer<typeof ChallengeAnswerMessageSchema>;
+export type DecryptedChallengeAnswer = z.infer<typeof DecryptedChallengeAnswerSchema>;
+export type DecryptedChallengeAnswerMessageType = ChallengeAnswerMessageType & DecryptedChallengeAnswer;
+export type ChallengeVerificationMessageType = z.infer<typeof ChallengeVerificationMessageSchema>;
+export type DecryptedChallengeVerification = z.infer<typeof DecryptedChallengeVerificationSchema>;
+export type DecryptedChallengeVerificationMessageType = ChallengeVerificationMessageType & Partial<DecryptedChallengeVerification>;
+export type PubsubMessage = ChallengeRequestMessageType | ChallengeMessageType | ChallengeAnswerMessageType | ChallengeVerificationMessageType;
+export type EncryptedEncoded = {
+    ciphertext: string;
+    iv: string;
+    tag: string;
+    type: string;
+};
+export interface EncodedPubsubSignature extends Omit<PubsubSignature, "signature" | "publicKey"> {
+    signature: string;
+    publicKey: string;
+}
+export interface BaseEncodedPubsubMessage {
+    challengeRequestId: string;
+    signature: EncodedPubsubSignature;
+}
+export interface EncodedDecryptedChallengeRequestMessageType extends Omit<DecryptedChallengeRequestMessageType, "challengeRequestId" | "encrypted" | "signature">, BaseEncodedPubsubMessage {
+    encrypted: EncryptedEncoded;
+}
+export interface EncodedDecryptedChallengeRequestMessageTypeWithCommunityAuthor extends Omit<EncodedDecryptedChallengeRequestMessageType, keyof DecryptedChallengeRequestPublication>, Pick<DecryptedChallengeRequestMessageTypeWithCommunityAuthor, keyof DecryptedChallengeRequestPublication> {
+}
+export interface EncodedDecryptedChallengeMessageType extends Omit<DecryptedChallengeMessageType, "challengeRequestId" | "encrypted" | "signature">, BaseEncodedPubsubMessage {
+    encrypted: EncryptedEncoded;
+}
+export interface EncodedDecryptedChallengeAnswerMessageType extends Omit<DecryptedChallengeAnswerMessageType, "challengeRequestId" | "encrypted" | "signature">, BaseEncodedPubsubMessage {
+    encrypted: EncryptedEncoded;
+}
+export interface EncodedDecryptedChallengeVerificationMessageType extends Omit<DecryptedChallengeVerificationMessageType, "challengeRequestId" | "encrypted" | "signature">, BaseEncodedPubsubMessage {
+    encrypted?: EncryptedEncoded;
+}
+export interface ChallengeRequestMessageSignature extends PubsubSignature {
+    signedPropertyNames: typeof ChallengeRequestMessageSignedPropertyNames;
+}
+export interface ChallengeMessageSignature extends PubsubSignature {
+    signedPropertyNames: typeof ChallengeMessageSignedPropertyNames;
+}
+export interface ChallengeAnswerMessageSignature extends PubsubSignature {
+    signedPropertyNames: typeof ChallengeAnswerMessageSignedPropertyNames;
+}
+export interface ChallengeVerificationMessageSignature extends PubsubSignature {
+    signedPropertyNames: typeof ChallengeVerificationMessageSignedPropertyNames;
+}

package/dist/browser/pubsub-messages/types.js

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

package/dist/browser/pubsub-messages/types.js.map

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